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-2016 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 (const char *file_path, int line,
  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 extern source_location expansion_point_location (source_location);
  46
  47 /* Historically GCC used location_t, while cpp used source_location.
  48    This could be removed but it hardly seems worth the effort.  */
  49 typedef source_location location_t;
  50
  51 extern location_t input_location;
  52
  53 #define LOCATION_FILE(LOC) ((expand_location (LOC)).file)
  54 #define LOCATION_LINE(LOC) ((expand_location (LOC)).line)
  55 #define LOCATION_COLUMN(LOC)((expand_location (LOC)).column)
  56 #define LOCATION_LOCUS(LOC) \
  57   ((IS_ADHOC_LOC (LOC)) ? get_location_from_adhoc_loc (line_table, LOC) \
  58    : (LOC))
  59 #define LOCATION_BLOCK(LOC) \
  60   ((tree) ((IS_ADHOC_LOC (LOC)) ? get_data_from_adhoc_loc (line_table, (LOC)) \
  61    : NULL))
  62
  63 /* Return a positive value if LOCATION is the locus of a token that is
  64    located in a system header, O otherwise. It returns 1 if LOCATION
  65    is the locus of a token that is located in a system header, and 2
  66    if LOCATION is the locus of a token located in a C system header
  67    that therefore needs to be extern "C" protected in C++.
  68
  69    Note that this function returns 1 if LOCATION belongs to a token
  70    that is part of a macro replacement-list defined in a system
  71    header, but expanded in a non-system file.  */
  72 #define in_system_header_at(LOC) \
  73   (linemap_location_in_system_header_p (line_table, LOC))
  74 /* Return a positive value if LOCATION is the locus of a token that
  75    comes from a macro expansion, O otherwise.  */
  76 #define from_macro_expansion_at(LOC) \
  77   ((linemap_location_from_macro_expansion_p (line_table, LOC)))
  78
  79 extern location_t get_pure_location (location_t loc);
  80
  81 /* Get the endpoint of any range encoded within location LOC.  */
  82
  83 static inline location_t
  84 get_finish (location_t loc)
  85 {
  86   return get_range_from_loc (line_table, loc).m_finish;
  87 }
  88
  89 extern location_t make_location (location_t caret,
  90                                  location_t start, location_t finish);
  91
  92 void dump_line_table_statistics (void);
  93
  94 void dump_location_info (FILE *stream);
  95
  96 void diagnostics_file_cache_fini (void);
  97
  98 struct GTY(()) string_concat
  99 {
 100   string_concat (int num, location_t *locs);
 101
 102   int m_num;
 103   location_t * GTY ((atomic)) m_locs;
 104 };
 105
 106 struct location_hash : int_hash <location_t, UNKNOWN_LOCATION> { };
 107
 108 class GTY(()) string_concat_db
 109 {
 110  public:
 111   string_concat_db ();
 112   void record_string_concatenation (int num, location_t *locs);
 113
 114   bool get_string_concatenation (location_t loc,
 115                                  int *out_num,
 116                                  location_t **out_locs);
 117
 118  private:
 119   static location_t get_key_loc (location_t loc);
 120
 121   /* For the fields to be private, we must grant access to the
 122      generated code in gtype-desc.c.  */
 123
 124   friend void ::gt_ggc_mx_string_concat_db (void *x_p);
 125   friend void ::gt_pch_nx_string_concat_db (void *x_p);
 126   friend void ::gt_pch_p_16string_concat_db (void *this_obj, void *x_p,
 127                                              gt_pointer_operator op,
 128                                              void *cookie);
 129
 130   hash_map <location_hash, string_concat *> *m_table;
 131 };
 132
 133 #endif