gcc/input.h

   1 /* Declarations for variables relating to reading the source file.
   2    Used by parsers, lexical analyzers, and error message routines.
   3    Copyright (C) 1993-2015 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.  */
  36 extern char builtins_location_check[(BUILTINS_LOCATION
  37                                      < RESERVED_LOCATION_COUNT) ? 1 : -1];
  38
  39 extern bool is_location_from_builtin_token (source_location);
  40 extern expanded_location expand_location (source_location);
  41 extern const char *location_get_source_line (expanded_location xloc,
  42                                              int *line_size);
  43 extern expanded_location expand_location_to_spelling_point (source_location);
  44 extern source_location expansion_point_location_if_in_system_header (source_location);
  45
  46 /* Historically GCC used location_t, while cpp used source_location.
  47    This could be removed but it hardly seems worth the effort.  */
  48 typedef source_location location_t;
  49
  50 extern location_t input_location;
  51
  52 #define LOCATION_FILE(LOC) ((expand_location (LOC)).file)
  53 #define LOCATION_LINE(LOC) ((expand_location (LOC)).line)
  54 #define LOCATION_COLUMN(LOC)((expand_location (LOC)).column)
  55 #define LOCATION_LOCUS(LOC) \
  56   ((IS_ADHOC_LOC (LOC)) ? get_location_from_adhoc_loc (line_table, LOC) \
  57    : (LOC))
  58 #define LOCATION_BLOCK(LOC) \
  59   ((tree) ((IS_ADHOC_LOC (LOC)) ? get_data_from_adhoc_loc (line_table, (LOC)) \
  60    : NULL))
  61
  62 /* Return a positive value if LOCATION is the locus of a token that is
  63    located in a system header, O otherwise. It returns 1 if LOCATION
  64    is the locus of a token that is located in a system header, and 2
  65    if LOCATION is the locus of a token located in a C system header
  66    that therefore needs to be extern "C" protected in C++.
  67
  68    Note that this function returns 1 if LOCATION belongs to a token
  69    that is part of a macro replacement-list defined in a system
  70    header, but expanded in a non-system file.  */
  71 #define in_system_header_at(LOC) \
  72   (linemap_location_in_system_header_p (line_table, LOC))
  73 /* Return a positive value if LOCATION is the locus of a token that
  74    comes from a macro expansion, O otherwise.  */
  75 #define from_macro_expansion_at(LOC) \
  76   ((linemap_location_from_macro_expansion_p (line_table, LOC)))
  77
  78 void dump_line_table_statistics (void);
  79
  80 void dump_location_info (FILE *stream);
  81
  82 void diagnostics_file_cache_fini (void);
  83
  84 #endif