GCC Middle and Back End API Reference
input.h
Go to the documentation of this file.
1 /* Declarations for variables relating to reading the source file.
2  Used by parsers, lexical analyzers, and error message routines.
3  Copyright (C) 1993-2013 Free Software Foundation, Inc.
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_INPUT_H
22 #define GCC_INPUT_H
23 
24 #include "line-map.h"
25 
26 extern GTY(()) struct line_maps *line_table;
27 
28 /* A value which will never be used to represent a real location. */
29 #define UNKNOWN_LOCATION ((source_location) 0)
30 
31 /* The location for declarations in "<built-in>" */
32 #define BUILTINS_LOCATION ((source_location) 1)
33 
34 /* line-map.c reserves RESERVED_LOCATION_COUNT to the user. Ensure
35  both UNKNOWN_LOCATION and BUILTINS_LOCATION fit into that. */
37  < RESERVED_LOCATION_COUNT) ? 1 : -1];
38 
39 extern expanded_location expand_location (source_location);
40 extern const char *location_get_source_line (expanded_location xloc);
41 extern expanded_location expand_location_to_spelling_point (source_location);
42 extern source_location expansion_point_location_if_in_system_header (source_location);
43 
44 /* Historically GCC used location_t, while cpp used source_location.
45  This could be removed but it hardly seems worth the effort. */
46 typedef source_location location_t;
47 
48 extern location_t input_location;
49 
50 #define LOCATION_FILE(LOC) ((expand_location (LOC)).file)
51 #define LOCATION_LINE(LOC) ((expand_location (LOC)).line)
52 #define LOCATION_COLUMN(LOC)((expand_location (LOC)).column)
53 #define LOCATION_LOCUS(LOC) \
54  ((IS_ADHOC_LOC (LOC)) ? get_location_from_adhoc_loc (line_table, LOC) \
55  : (LOC))
56 #define LOCATION_BLOCK(LOC) \
57  ((tree) ((IS_ADHOC_LOC (LOC)) ? get_data_from_adhoc_loc (line_table, (LOC)) \
58  : NULL))
59 
60 #define input_line LOCATION_LINE (input_location)
61 #define input_filename LOCATION_FILE (input_location)
62 #define in_system_header_at(LOC) \
63  ((linemap_location_in_system_header_p (line_table, LOC)))
64 #define in_system_header (in_system_header_at (input_location))
65 
67 
68 #endif