GCC Middle and Back End API Reference
logical-location.h
Go to the documentation of this file.
1/* Logical location support, without knowledge of "tree".
2 Copyright (C) 2022-2024 Free Software Foundation, Inc.
3 Contributed by David Malcolm <dmalcolm@redhat.com>.
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify it under
8the terms of the GNU General Public License as published by the Free
9Software Foundation; either version 3, or (at your option) any later
10version.
11
12GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or
14FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef GCC_LOGICAL_LOCATION_H
22#define GCC_LOGICAL_LOCATION_H
23
24#include "label-text.h"
25
26/* An enum for discriminating between different kinds of logical location
27 for a diagnostic.
28
29 Roughly corresponds to logicalLocation's "kind" property in SARIF v2.1.0
30 (section 3.33.7). */
31
45
46/* Abstract base class for passing around logical locations in the
47 diagnostics subsystem, such as:
48 - "within function 'foo'", or
49 - "within method 'bar'",
50 but *without* requiring knowledge of trees
51 (see tree-logical-location.h for concrete subclasses relating to trees,
52 and selftest-logical-location.h for a concrete subclass for selftests). */
53
55{
56public:
57 virtual ~logical_location () {}
58
59 /* Get a string (or NULL) suitable for use by the SARIF logicalLocation
60 "name" property (SARIF v2.1.0 section 3.33.4). */
61 virtual const char *get_short_name () const = 0;
62
63 /* Get a string (or NULL) suitable for use by the SARIF logicalLocation
64 "fullyQualifiedName" property (SARIF v2.1.0 section 3.33.5). */
65 virtual const char *get_name_with_scope () const = 0;
66
67 /* Get a string (or NULL) suitable for use by the SARIF logicalLocation
68 "decoratedName" property (SARIF v2.1.0 section 3.33.6). */
69 virtual const char *get_internal_name () const = 0;
70
71 /* Get what kind of SARIF logicalLocation this is (if any). */
72 virtual enum logical_location_kind get_kind () const = 0;
73
74 /* Get a string for this location in a form suitable for path output. */
75 virtual label_text get_name_for_path_output () const = 0;
76
77 bool function_p () const;
78};
79
80#endif /* GCC_LOGICAL_LOCATION_H. */
Definition logical-location.h:55
virtual const char * get_name_with_scope() const =0
virtual const char * get_internal_name() const =0
virtual const char * get_short_name() const =0
bool function_p() const
Definition diagnostic.cc:892
virtual ~logical_location()
Definition logical-location.h:57
virtual label_text get_name_for_path_output() const =0
virtual enum logical_location_kind get_kind() const =0
logical_location_kind
Definition logical-location.h:33
@ LOGICAL_LOCATION_KIND_VARIABLE
Definition logical-location.h:43
@ LOGICAL_LOCATION_KIND_UNKNOWN
Definition logical-location.h:34
@ LOGICAL_LOCATION_KIND_MEMBER
Definition logical-location.h:37
@ LOGICAL_LOCATION_KIND_MODULE
Definition logical-location.h:38
@ LOGICAL_LOCATION_KIND_NAMESPACE
Definition logical-location.h:39
@ LOGICAL_LOCATION_KIND_RETURN_TYPE
Definition logical-location.h:41
@ LOGICAL_LOCATION_KIND_FUNCTION
Definition logical-location.h:36
@ LOGICAL_LOCATION_KIND_TYPE
Definition logical-location.h:40
@ LOGICAL_LOCATION_KIND_PARAMETER
Definition logical-location.h:42