1 /* Declarations for variables relating to reading the source file. 2 Used by parsers, lexical analyzers, and error message routines. 3 Copyright (C) 1993-2018 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 extern GTY(()) struct line_maps *saved_line_table; 28 29 /* A value which will never be used to represent a real location. */ 30 #define UNKNOWN_LOCATION ((source_location) 0) 31 32 /* The location for declarations in "<built-in>" */ 33 #define BUILTINS_LOCATION ((source_location) 1) 34 35 /* line-map.c reserves RESERVED_LOCATION_COUNT to the user. Ensure 36 both UNKNOWN_LOCATION and BUILTINS_LOCATION fit into that. */ 37 extern char builtins_location_check[(BUILTINS_LOCATION 38 < RESERVED_LOCATION_COUNT) ? 1 : -1]; 39 40 extern bool is_location_from_builtin_token (source_location); 41 extern expanded_location expand_location (source_location); 42 extern const char *location_get_source_line (const char *file_path, int line, 43 int *line_size); 44 extern bool location_missing_trailing_newline (const char *file_path); 45 extern expanded_location expand_location_to_spelling_point (source_location); 46 extern source_location expansion_point_location_if_in_system_header (source_location); 47 extern source_location expansion_point_location (source_location); 48 49 /* Historically GCC used location_t, while cpp used source_location. 50 This could be removed but it hardly seems worth the effort. */ 51 typedef source_location location_t; 52 53 extern location_t input_location; 54 55 #define LOCATION_FILE(LOC) ((expand_location (LOC)).file) 56 #define LOCATION_LINE(LOC) ((expand_location (LOC)).line) 57 #define LOCATION_COLUMN(LOC)((expand_location (LOC)).column) 58 #define LOCATION_LOCUS(LOC) \ 59 ((IS_ADHOC_LOC (LOC)) ? get_location_from_adhoc_loc (line_table, LOC) \ 60 : (LOC)) 61 #define LOCATION_BLOCK(LOC) \ 62 ((tree) ((IS_ADHOC_LOC (LOC)) ? get_data_from_adhoc_loc (line_table, (LOC)) \ 63 : NULL)) 64 #define RESERVED_LOCATION_P(LOC) \ 65 (LOCATION_LOCUS (LOC) < RESERVED_LOCATION_COUNT) 66 67 /* Return a positive value if LOCATION is the locus of a token that is 68 located in a system header, O otherwise. It returns 1 if LOCATION 69 is the locus of a token that is located in a system header, and 2 70 if LOCATION is the locus of a token located in a C system header 71 that therefore needs to be extern "C" protected in C++. 72 73 Note that this function returns 1 if LOCATION belongs to a token 74 that is part of a macro replacement-list defined in a system 75 header, but expanded in a non-system file. */ 76 #define in_system_header_at(LOC) \ 77 (linemap_location_in_system_header_p (line_table, LOC)) 78 /* Return a positive value if LOCATION is the locus of a token that 79 comes from a macro expansion, O otherwise. */ 80 #define from_macro_expansion_at(LOC) \ 81 ((linemap_location_from_macro_expansion_p (line_table, LOC))) 82 /* Return a positive value if LOCATION is the locus of a token that comes from 83 a macro definition, O otherwise. This differs from from_macro_expansion_at 84 in its treatment of macro arguments, for which this returns false. */ 85 #define from_macro_definition_at(LOC) \ 86 ((linemap_location_from_macro_definition_p (line_table, LOC))) 87 88 static inline location_t 89 get_pure_location (location_t loc) 90 { 91 return get_pure_location (line_table, loc); 92 } 93 94 /* Get the start of any range encoded within location LOC. */ 95 96 static inline location_t 97 get_start (location_t loc) 98 { 99 return get_range_from_loc (line_table, loc).m_start; 100 } 101 102 /* Get the endpoint of any range encoded within location LOC. */ 103 104 static inline location_t 105 get_finish (location_t loc) 106 { 107 return get_range_from_loc (line_table, loc).m_finish; 108 } 109 110 extern location_t make_location (location_t caret, 111 location_t start, location_t finish); 112 extern location_t make_location (location_t caret, source_range src_range); 113 114 void dump_line_table_statistics (void); 115 116 void dump_location_info (FILE *stream); 117 118 void diagnostics_file_cache_fini (void); 119 120 void diagnostics_file_cache_forcibly_evict_file (const char *file_path); 121 122 struct GTY(()) string_concat 123 { 124 string_concat (int num, location_t *locs); 125 126 int m_num; 127 location_t * GTY ((atomic)) m_locs; 128 }; 129 130 struct location_hash : int_hash <location_t, UNKNOWN_LOCATION> { }; 131 132 class GTY(()) string_concat_db 133 { 134 public: 135 string_concat_db (); 136 void record_string_concatenation (int num, location_t *locs); 137 138 bool get_string_concatenation (location_t loc, 139 int *out_num, 140 location_t **out_locs); 141 142 private: 143 static location_t get_key_loc (location_t loc); 144 145 /* For the fields to be private, we must grant access to the 146 generated code in gtype-desc.c. */ 147 148 friend void ::gt_ggc_mx_string_concat_db (void *x_p); 149 friend void ::gt_pch_nx_string_concat_db (void *x_p); 150 friend void ::gt_pch_p_16string_concat_db (void *this_obj, void *x_p, 151 gt_pointer_operator op, 152 void *cookie); 153 154 hash_map <location_hash, string_concat *> *m_table; 155 }; 156 157 #endif 158