Branch data Line data Source code
1 : : /* Additional metadata about a client for a diagnostic context.
2 : : Copyright (C) 2022-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_CLIENT_DATA_HOOKS_H
22 : : #define GCC_DIAGNOSTIC_CLIENT_DATA_HOOKS_H
23 : :
24 : : class sarif_object;
25 : : class client_version_info;
26 : :
27 : : /* A bundle of additional metadata, owned by the diagnostic_context,
28 : : for querying things about the client, like version data. */
29 : :
30 : 334503 : class diagnostic_client_data_hooks
31 : : {
32 : : public:
33 : : virtual ~diagnostic_client_data_hooks () {}
34 : :
35 : : /* Get version info for this client, or NULL. */
36 : : virtual const client_version_info *get_any_version_info () const = 0;
37 : :
38 : : /* Get the current logical_location for this client, or NULL. */
39 : : virtual const logical_location *get_current_logical_location () const = 0;
40 : :
41 : : /* Get a sourceLanguage value for FILENAME, or return NULL.
42 : : See SARIF v2.1.0 Appendix J for suggested values. */
43 : : virtual const char *
44 : : maybe_get_sarif_source_language (const char *filename) const = 0;
45 : :
46 : : /* Hook to allow client to populate a SARIF "invocation" object with
47 : : a custom property bag (see SARIF v2.1.0 section 3.8). */
48 : : virtual void
49 : : add_sarif_invocation_properties (sarif_object &invocation_obj) const = 0;
50 : : };
51 : :
52 : : /* Factory function for making an instance of diagnostic_client_data_hooks
53 : : for use in the compiler (i.e. with knowledge of "tree", access to
54 : : langhooks, etc). */
55 : :
56 : : extern std::unique_ptr<diagnostic_client_data_hooks> make_compiler_data_hooks ();
57 : :
58 : : class diagnostic_client_plugin_info;
59 : :
60 : : /* Abstract base class for a diagnostic_context to get at
61 : : version information about the client. */
62 : :
63 : 334503 : class client_version_info
64 : : {
65 : : public:
66 : 92 : class plugin_visitor
67 : : {
68 : : public:
69 : : virtual void on_plugin (const diagnostic_client_plugin_info &) = 0;
70 : : };
71 : :
72 : : virtual ~client_version_info () {}
73 : :
74 : : /* Get a string suitable for use as the value of the "name" property
75 : : (SARIF v2.1.0 section 3.19.8). */
76 : : virtual const char *get_tool_name () const = 0;
77 : :
78 : : /* Create a string suitable for use as the value of the "fullName" property
79 : : (SARIF v2.1.0 section 3.19.9). */
80 : : virtual char *maybe_make_full_name () const = 0;
81 : :
82 : : /* Get a string suitable for use as the value of the "version" property
83 : : (SARIF v2.1.0 section 3.19.13). */
84 : : virtual const char *get_version_string () const = 0;
85 : :
86 : : /* Create a string suitable for use as the value of the "informationUri"
87 : : property (SARIF v2.1.0 section 3.19.17). */
88 : : virtual char *maybe_make_version_url () const = 0;
89 : :
90 : : virtual void for_each_plugin (plugin_visitor &v) const = 0;
91 : : };
92 : :
93 : : /* Abstract base class for a diagnostic_context to get at
94 : : information about a specific plugin within a client. */
95 : :
96 : 8 : class diagnostic_client_plugin_info
97 : : {
98 : : public:
99 : : /* For use e.g. by SARIF "name" property (SARIF v2.1.0 section 3.19.8). */
100 : : virtual const char *get_short_name () const = 0;
101 : :
102 : : /* For use e.g. by SARIF "fullName" property
103 : : (SARIF v2.1.0 section 3.19.9). */
104 : : virtual const char *get_full_name () const = 0;
105 : :
106 : : /* For use e.g. by SARIF "version" property
107 : : (SARIF v2.1.0 section 3.19.13). */
108 : : virtual const char *get_version () const = 0;
109 : : };
110 : :
111 : : #endif /* ! GCC_DIAGNOSTIC_CLIENT_DATA_HOOKS_H */
|
