1 files changed, 124 insertions, 0 deletions
diff --git a/gcc/diagnostics/metadata.h b/gcc/diagnostics/metadata.h
new file mode 100644
index 0000000..c28f982
--- /dev/null
+++ b/gcc/diagnostics/metadata.h
@@ -0,0 +1,124 @@
+/* Additional metadata for a diagnostic.
+   Copyright (C) 2019-2025 Free Software Foundation, Inc.
+   Contributed by David Malcolm <dmalcolm@redhat.com>
+
+This file is part of GCC.
+
+GCC is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 3, or (at your option) any later
+version.
+
+GCC is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with GCC; see the file COPYING3.  If not see
+<http://www.gnu.org/licenses/>.  */
+
+#ifndef GCC_DIAGNOSTICS_METADATA_H
+#define GCC_DIAGNOSTICS_METADATA_H
+
+#include "lazily-created.h"
+
+namespace diagnostics {
+
+  class sarif_object;
+  namespace digraphs { class digraph; }
+
+/* A bundle of additional metadata that can be associated with a
+   diagnostic.
+
+   This supports an optional CWE identifier, and zero or more
+   "rules".
+
+   Additionally, this provides a place to associate a diagnostic
+   with zero or more directed graphs.  */
+
+class metadata
+{
+ public:
+  using lazy_digraphs
+  = lazily_created<std::vector<std::unique_ptr<digraphs::digraph>>>;
+
+  /* Abstract base class for referencing a rule that has been violated,
+     such as within a coding standard, or within a specification.  */
+  class rule
+  {
+  public:
+    virtual char *make_description () const = 0;
+    virtual char *make_url () const = 0;
+  };
+
+  /* Concrete subclass.  */
+  class precanned_rule : public rule
+  {
+  public:
+    precanned_rule (const char *desc, const char *url)
+    : m_desc (desc), m_url (url)
+    {}
+
+    char *make_description () const final override
+    {
+      return m_desc ? xstrdup (m_desc) : NULL;
+    }
+
+    char *make_url () const final override
+    {
+      return m_url ? xstrdup (m_url) : NULL;
+    }
+
+  private:
+    const char *m_desc;
+    const char *m_url;
+  };
+
+  metadata () : m_cwe (0), m_lazy_digraphs (nullptr) {}
+  virtual ~metadata () {}
+
+  /* Hook for SARIF output to allow for adding diagnostic-specific
+     properties to  the result object's property bag.  */
+  virtual void
+  maybe_add_sarif_properties (sarif_object &/*result_obj*/) const
+  {
+  }
+
+  void add_cwe (int cwe) { m_cwe = cwe; }
+  int get_cwe () const { return m_cwe; }
+
+  /* Associate R with the diagnostic.  R must outlive
+     the metadata.  */
+  void add_rule (const rule &r)
+  {
+    m_rules.safe_push (&r);
+  }
+
+  unsigned get_num_rules () const { return m_rules.length (); }
+  const rule &get_rule (unsigned idx) const { return *(m_rules[idx]); }
+
+  void
+  set_lazy_digraphs (const lazy_digraphs *lazy_digraphs_)
+  {
+    m_lazy_digraphs = lazy_digraphs_;
+  }
+
+  const lazy_digraphs *
+  get_lazy_digraphs () const
+  {
+    return m_lazy_digraphs;
+  }
+
+ private:
+  int m_cwe;
+  auto_vec<const rule *> m_rules;
+
+  /* An optional way to create directed graphs associated with the
+     diagnostic, for the sinks that support this (e.g. SARIF).  */
+  const lazy_digraphs *m_lazy_digraphs;
+};
+
+} // namespace diagnostics
+
+#endif /* ! GCC_DIAGNOSTICS_METADATA_H */