]>
Commit | Line | Data |
---|---|---|
d7f6896a RK |
1 | /* Declarations for variables relating to reading the source file. |
2 | Used by parsers, lexical analyzers, and error message routines. | |
7adcbafe | 3 | Copyright (C) 1993-2022 Free Software Foundation, Inc. |
d7f6896a | 4 | |
1322177d | 5 | This file is part of GCC. |
d7f6896a | 6 | |
1322177d LB |
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 | |
9dcd6f09 | 9 | Software Foundation; either version 3, or (at your option) any later |
1322177d | 10 | version. |
d7f6896a | 11 | |
1322177d LB |
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. | |
d7f6896a RK |
16 | |
17 | You should have received a copy of the GNU General Public License | |
9dcd6f09 NC |
18 | along with GCC; see the file COPYING3. If not see |
19 | <http://www.gnu.org/licenses/>. */ | |
d7f6896a | 20 | |
6060edcb NS |
21 | #ifndef GCC_INPUT_H |
22 | #define GCC_INPUT_H | |
1fa2d22f | 23 | |
c1667470 | 24 | #include "line-map.h" |
2d593c86 | 25 | |
99b1c316 MS |
26 | extern GTY(()) class line_maps *line_table; |
27 | extern GTY(()) class line_maps *saved_line_table; | |
50f59cd7 | 28 | |
2d593c86 | 29 | /* A value which will never be used to represent a real location. */ |
620e594b | 30 | #define UNKNOWN_LOCATION ((location_t) 0) |
2d593c86 | 31 | |
c1667470 | 32 | /* The location for declarations in "<built-in>" */ |
620e594b | 33 | #define BUILTINS_LOCATION ((location_t) 1) |
96c169e1 | 34 | |
e53b6e56 | 35 | /* line-map.cc reserves RESERVED_LOCATION_COUNT to the user. Ensure |
96c169e1 | 36 | both UNKNOWN_LOCATION and BUILTINS_LOCATION fit into that. */ |
fee69672 | 37 | STATIC_ASSERT (BUILTINS_LOCATION < RESERVED_LOCATION_COUNT); |
c1667470 | 38 | |
088199e5 TS |
39 | /* Hasher for 'location_t' values satisfying '!RESERVED_LOCATION_P', thus able |
40 | to use 'UNKNOWN_LOCATION'/'BUILTINS_LOCATION' as spare values for | |
41 | 'Empty'/'Deleted'. */ | |
42 | /* Per PR103157 "'gengtype': 'typedef' causing infinite-recursion code to be | |
43 | generated", don't use | |
44 | typedef int_hash<location_t, UNKNOWN_LOCATION, BUILTINS_LOCATION> | |
45 | location_hash; | |
46 | here. | |
47 | ||
48 | It works for a single-use case, but when using a 'struct'-based variant | |
49 | struct location_hash | |
50 | : int_hash<location_t, UNKNOWN_LOCATION, BUILTINS_LOCATION> {}; | |
51 | in more than one place, 'gengtype' generates duplicate functions (thus: | |
52 | "error: redefinition of 'void gt_ggc_mx(location_hash&)'" etc.). | |
53 | Attempting to mark that one up with GTY options, we run into a 'gengtype' | |
54 | "parse error: expected '{', have '<'", which probably falls into category | |
55 | "understanding of C++ is limited", as documented in 'gcc/doc/gty.texi'. | |
56 | ||
57 | Thus, use a plain ol' '#define': | |
58 | */ | |
59 | #define location_hash int_hash<location_t, UNKNOWN_LOCATION, BUILTINS_LOCATION> | |
60 | ||
620e594b DM |
61 | extern bool is_location_from_builtin_token (location_t); |
62 | extern expanded_location expand_location (location_t); | |
004bb936 | 63 | |
bd5e882c DM |
64 | class cpp_char_column_policy; |
65 | ||
66 | extern int | |
67 | location_compute_display_column (expanded_location exploc, | |
68 | const cpp_char_column_policy &policy); | |
7761dfbe DM |
69 | |
70 | /* A class capturing the bounds of a buffer, to allow for run-time | |
71 | bounds-checking in a checked build. */ | |
72 | ||
73 | class char_span | |
74 | { | |
75 | public: | |
76 | char_span (const char *ptr, size_t n_elts) : m_ptr (ptr), m_n_elts (n_elts) {} | |
77 | ||
78 | /* Test for a non-NULL pointer. */ | |
79 | operator bool() const { return m_ptr; } | |
80 | ||
81 | /* Get length, not including any 0-terminator (which may not be, | |
82 | in fact, present). */ | |
83 | size_t length () const { return m_n_elts; } | |
84 | ||
85 | const char *get_buffer () const { return m_ptr; } | |
86 | ||
87 | char operator[] (int idx) const | |
88 | { | |
89 | gcc_assert (idx >= 0); | |
90 | gcc_assert ((size_t)idx < m_n_elts); | |
91 | return m_ptr[idx]; | |
92 | } | |
93 | ||
94 | char_span subspan (int offset, int n_elts) const | |
95 | { | |
96 | gcc_assert (offset >= 0); | |
97 | gcc_assert (offset < (int)m_n_elts); | |
98 | gcc_assert (n_elts >= 0); | |
99 | gcc_assert (offset + n_elts <= (int)m_n_elts); | |
100 | return char_span (m_ptr + offset, n_elts); | |
101 | } | |
102 | ||
103 | char *xstrdup () const | |
104 | { | |
105 | return ::xstrndup (m_ptr, m_n_elts); | |
106 | } | |
107 | ||
108 | private: | |
109 | const char *m_ptr; | |
110 | size_t m_n_elts; | |
111 | }; | |
112 | ||
113 | extern char_span location_get_source_line (const char *file_path, int line); | |
114 | ||
c65236d6 | 115 | extern bool location_missing_trailing_newline (const char *file_path); |
b544c348 DM |
116 | |
117 | /* Forward decl of slot within file_cache, so that the definition doesn't | |
118 | need to be in this header. */ | |
119 | class file_cache_slot; | |
120 | ||
121 | /* A cache of source files for use when emitting diagnostics | |
122 | (and in a few places in the C/C++ frontends). | |
123 | ||
124 | Results are only valid until the next call to the cache, as | |
125 | slots can be evicted. | |
126 | ||
127 | Filenames are stored by pointer, and so must outlive the cache | |
128 | instance. */ | |
129 | ||
130 | class file_cache | |
131 | { | |
132 | public: | |
133 | file_cache (); | |
134 | ~file_cache (); | |
135 | ||
136 | file_cache_slot *lookup_or_add_file (const char *file_path); | |
137 | void forcibly_evict_file (const char *file_path); | |
138 | ||
3ac6b5cf LH |
139 | /* See comments in diagnostic.h about the input conversion context. */ |
140 | struct input_context | |
141 | { | |
142 | diagnostic_input_charset_callback ccb; | |
143 | bool should_skip_bom; | |
144 | }; | |
145 | void initialize_input_context (diagnostic_input_charset_callback ccb, | |
146 | bool should_skip_bom); | |
147 | ||
b544c348 DM |
148 | private: |
149 | file_cache_slot *evicted_cache_tab_entry (unsigned *highest_use_count); | |
150 | file_cache_slot *add_file (const char *file_path); | |
151 | file_cache_slot *lookup_file (const char *file_path); | |
152 | ||
153 | private: | |
154 | static const size_t num_file_slots = 16; | |
155 | file_cache_slot *m_file_slots; | |
3ac6b5cf | 156 | input_context in_context; |
b544c348 DM |
157 | }; |
158 | ||
0d48e877 | 159 | extern expanded_location |
620e594b | 160 | expand_location_to_spelling_point (location_t, |
0d48e877 DM |
161 | enum location_aspect aspect |
162 | = LOCATION_ASPECT_CARET); | |
620e594b DM |
163 | extern location_t expansion_point_location_if_in_system_header (location_t); |
164 | extern location_t expansion_point_location (location_t); | |
1fa2d22f | 165 | |
6060edcb | 166 | extern location_t input_location; |
c1667470 PB |
167 | |
168 | #define LOCATION_FILE(LOC) ((expand_location (LOC)).file) | |
169 | #define LOCATION_LINE(LOC) ((expand_location (LOC)).line) | |
46427374 | 170 | #define LOCATION_COLUMN(LOC)((expand_location (LOC)).column) |
5368224f | 171 | #define LOCATION_LOCUS(LOC) \ |
c3284718 RS |
172 | ((IS_ADHOC_LOC (LOC)) ? get_location_from_adhoc_loc (line_table, LOC) \ |
173 | : (LOC)) | |
5368224f DC |
174 | #define LOCATION_BLOCK(LOC) \ |
175 | ((tree) ((IS_ADHOC_LOC (LOC)) ? get_data_from_adhoc_loc (line_table, (LOC)) \ | |
c3284718 | 176 | : NULL)) |
bebe0086 ML |
177 | #define RESERVED_LOCATION_P(LOC) \ |
178 | (LOCATION_LOCUS (LOC) < RESERVED_LOCATION_COUNT) | |
c1667470 | 179 | |
86d2cad9 MLI |
180 | /* Return a positive value if LOCATION is the locus of a token that is |
181 | located in a system header, O otherwise. It returns 1 if LOCATION | |
182 | is the locus of a token that is located in a system header, and 2 | |
183 | if LOCATION is the locus of a token located in a C system header | |
184 | that therefore needs to be extern "C" protected in C++. | |
185 | ||
186 | Note that this function returns 1 if LOCATION belongs to a token | |
187 | that is part of a macro replacement-list defined in a system | |
188 | header, but expanded in a non-system file. */ | |
3b67d7e6 DM |
189 | |
190 | static inline int | |
191 | in_system_header_at (location_t loc) | |
192 | { | |
193 | return linemap_location_in_system_header_p (line_table, loc); | |
194 | } | |
195 | ||
196 | /* Return true if LOCATION is the locus of a token that | |
197 | comes from a macro expansion, false otherwise. */ | |
198 | ||
199 | static inline bool | |
200 | from_macro_expansion_at (location_t loc) | |
201 | { | |
202 | return linemap_location_from_macro_expansion_p (line_table, loc); | |
203 | } | |
204 | ||
205 | /* Return true if LOCATION is the locus of a token that comes from | |
206 | a macro definition, false otherwise. This differs from from_macro_expansion_at | |
63cb3926 | 207 | in its treatment of macro arguments, for which this returns false. */ |
3b67d7e6 DM |
208 | |
209 | static inline bool | |
210 | from_macro_definition_at (location_t loc) | |
211 | { | |
212 | return linemap_location_from_macro_definition_p (line_table, loc); | |
213 | } | |
1fa2d22f | 214 | |
2aa51413 DM |
215 | static inline location_t |
216 | get_pure_location (location_t loc) | |
217 | { | |
218 | return get_pure_location (line_table, loc); | |
219 | } | |
a01fc549 | 220 | |
9144eabb DM |
221 | /* Get the start of any range encoded within location LOC. */ |
222 | ||
223 | static inline location_t | |
224 | get_start (location_t loc) | |
225 | { | |
226 | return get_range_from_loc (line_table, loc).m_start; | |
227 | } | |
228 | ||
a01fc549 DM |
229 | /* Get the endpoint of any range encoded within location LOC. */ |
230 | ||
231 | static inline location_t | |
232 | get_finish (location_t loc) | |
233 | { | |
234 | return get_range_from_loc (line_table, loc).m_finish; | |
235 | } | |
236 | ||
237 | extern location_t make_location (location_t caret, | |
238 | location_t start, location_t finish); | |
a32c8316 | 239 | extern location_t make_location (location_t caret, source_range src_range); |
a01fc549 | 240 | |
64a1a422 TT |
241 | void dump_line_table_statistics (void); |
242 | ||
ba4ad400 DM |
243 | void dump_location_info (FILE *stream); |
244 | ||
7ecc3eb9 DS |
245 | void diagnostics_file_cache_fini (void); |
246 | ||
f89b03b6 DM |
247 | void diagnostics_file_cache_forcibly_evict_file (const char *file_path); |
248 | ||
6c1dae73 | 249 | class GTY(()) string_concat |
88fa5555 | 250 | { |
6c1dae73 | 251 | public: |
88fa5555 DM |
252 | string_concat (int num, location_t *locs); |
253 | ||
254 | int m_num; | |
255 | location_t * GTY ((atomic)) m_locs; | |
256 | }; | |
257 | ||
88fa5555 DM |
258 | class GTY(()) string_concat_db |
259 | { | |
260 | public: | |
261 | string_concat_db (); | |
262 | void record_string_concatenation (int num, location_t *locs); | |
263 | ||
264 | bool get_string_concatenation (location_t loc, | |
265 | int *out_num, | |
266 | location_t **out_locs); | |
267 | ||
268 | private: | |
269 | static location_t get_key_loc (location_t loc); | |
270 | ||
271 | /* For the fields to be private, we must grant access to the | |
e53b6e56 | 272 | generated code in gtype-desc.cc. */ |
88fa5555 DM |
273 | |
274 | friend void ::gt_ggc_mx_string_concat_db (void *x_p); | |
275 | friend void ::gt_pch_nx_string_concat_db (void *x_p); | |
276 | friend void ::gt_pch_p_16string_concat_db (void *this_obj, void *x_p, | |
277 | gt_pointer_operator op, | |
278 | void *cookie); | |
279 | ||
280 | hash_map <location_hash, string_concat *> *m_table; | |
281 | }; | |
282 | ||
6060edcb | 283 | #endif |