gcc/diagnostic-format-sarif.h

   1 /* SARIF output for diagnostics.
   2    Copyright (C) 2023-2024 Free Software Foundation, Inc.
   3    Contributed by David Malcolm <dmalcolm@redhat.com>.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GCC_DIAGNOSTIC_FORMAT_SARIF_H
  22 #define GCC_DIAGNOSTIC_FORMAT_SARIF_H
  23
  24 #include "json.h"
  25
  26 class logical_location;
  27
  28 /* Concrete subclass of json::object for SARIF property bags
  29    (SARIF v2.1.0 section 3.8).  */
  30
  31 class sarif_property_bag : public json::object
  32 {
  33 };
  34
  35 /* Concrete subclass of json::object for SARIF objects that can
  36    contain property bags (as per SARIF v2.1.0 section 3.8.1, which has:
  37    "In addition to those properties that are explicitly documented, every
  38    object defined in this document MAY contain a property named properties
  39    whose value is a property bag.")  */
  40
  41 class sarif_object : public json::object
  42 {
  43 public:
  44   sarif_property_bag &get_or_create_properties ();
  45 };
  46
  47 extern json::object *
  48 make_sarif_logical_location_object (const logical_location &logical_loc);
  49
  50 #endif /* ! GCC_DIAGNOSTIC_FORMAT_SARIF_H */