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, 1997, 1998, 2000, 2003, 2004, 2007, 2008, 2009, 2010
   4    Free Software Foundation, Inc.
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 #ifndef GCC_INPUT_H
  23 #define GCC_INPUT_H
  24
  25 #include "line-map.h"
  26
  27 extern GTY(()) struct line_maps *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 expanded_location expand_location (source_location);
  41 extern const char * location_get_source_line(expanded_location xloc);
  42 extern expanded_location expand_location_to_spelling_point (source_location);
  43 extern source_location expansion_point_location_if_in_system_header (source_location);
  44
  45 /* Historically GCC used location_t, while cpp used source_location.
  46    This could be removed but it hardly seems worth the effort.  */
  47 typedef source_location location_t;
  48
  49 extern location_t input_location;
  50
  51 #define LOCATION_FILE(LOC) ((expand_location (LOC)).file)
  52 #define LOCATION_LINE(LOC) ((expand_location (LOC)).line)
  53 #define LOCATION_COLUMN(LOC)((expand_location (LOC)).column)
  54 #define LOCATION_LOCUS(LOC) \
  55   ((IS_ADHOC_LOC(LOC)) ? get_location_from_adhoc_loc (line_table, LOC) : (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
  66 void dump_line_table_statistics (void);
  67
  68 #endif