input.h 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  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. This file is part of GCC.
  5. GCC is free software; you can redistribute it and/or modify it under
  6. the terms of the GNU General Public License as published by the Free
  7. Software Foundation; either version 3, or (at your option) any later
  8. version.
  9. GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  10. WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11. FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  12. for more details.
  13. You should have received a copy of the GNU General Public License
  14. along with GCC; see the file COPYING3. If not see
  15. <http://www.gnu.org/licenses/>. */
  16. #ifndef GCC_INPUT_H
  17. #define GCC_INPUT_H
  18. #include "line-map.h"
  19. extern GTY(()) struct line_maps *line_table;
  20. extern GTY(()) struct line_maps *saved_line_table;
  21. /* A value which will never be used to represent a real location. */
  22. #define UNKNOWN_LOCATION ((source_location) 0)
  23. /* The location for declarations in "<built-in>" */
  24. #define BUILTINS_LOCATION ((source_location) 1)
  25. /* line-map.c reserves RESERVED_LOCATION_COUNT to the user. Ensure
  26. both UNKNOWN_LOCATION and BUILTINS_LOCATION fit into that. */
  27. extern char builtins_location_check[(BUILTINS_LOCATION
  28. < RESERVED_LOCATION_COUNT) ? 1 : -1];
  29. extern bool is_location_from_builtin_token (source_location);
  30. extern expanded_location expand_location (source_location);
  31. extern const char *location_get_source_line (const char *file_path, int line,
  32. int *line_size);
  33. extern bool location_missing_trailing_newline (const char *file_path);
  34. extern expanded_location expand_location_to_spelling_point (source_location);
  35. extern source_location expansion_point_location_if_in_system_header (source_location);
  36. extern source_location expansion_point_location (source_location);
  37. /* Historically GCC used location_t, while cpp used source_location.
  38. This could be removed but it hardly seems worth the effort. */
  39. typedef source_location location_t;
  40. extern location_t input_location;
  41. #define LOCATION_FILE(LOC) ((expand_location (LOC)).file)
  42. #define LOCATION_LINE(LOC) ((expand_location (LOC)).line)
  43. #define LOCATION_COLUMN(LOC)((expand_location (LOC)).column)
  44. #define LOCATION_LOCUS(LOC) \
  45. ((IS_ADHOC_LOC (LOC)) ? get_location_from_adhoc_loc (line_table, LOC) \
  46. : (LOC))
  47. #define LOCATION_BLOCK(LOC) \
  48. ((tree) ((IS_ADHOC_LOC (LOC)) ? get_data_from_adhoc_loc (line_table, (LOC)) \
  49. : NULL))
  50. #define RESERVED_LOCATION_P(LOC) \
  51. (LOCATION_LOCUS (LOC) < RESERVED_LOCATION_COUNT)
  52. /* Return a positive value if LOCATION is the locus of a token that is
  53. located in a system header, O otherwise. It returns 1 if LOCATION
  54. is the locus of a token that is located in a system header, and 2
  55. if LOCATION is the locus of a token located in a C system header
  56. that therefore needs to be extern "C" protected in C++.
  57. Note that this function returns 1 if LOCATION belongs to a token
  58. that is part of a macro replacement-list defined in a system
  59. header, but expanded in a non-system file. */
  60. #define in_system_header_at(LOC) \
  61. (linemap_location_in_system_header_p (line_table, LOC))
  62. /* Return a positive value if LOCATION is the locus of a token that
  63. comes from a macro expansion, O otherwise. */
  64. #define from_macro_expansion_at(LOC) \
  65. ((linemap_location_from_macro_expansion_p (line_table, LOC)))
  66. /* Return a positive value if LOCATION is the locus of a token that comes from
  67. a macro definition, O otherwise. This differs from from_macro_expansion_at
  68. in its treatment of macro arguments, for which this returns false. */
  69. #define from_macro_definition_at(LOC) \
  70. ((linemap_location_from_macro_definition_p (line_table, LOC)))
  71. static inline location_t
  72. get_pure_location (location_t loc)
  73. {
  74. return get_pure_location (line_table, loc);
  75. }
  76. /* Get the start of any range encoded within location LOC. */
  77. static inline location_t
  78. get_start (location_t loc)
  79. {
  80. return get_range_from_loc (line_table, loc).m_start;
  81. }
  82. /* Get the endpoint of any range encoded within location LOC. */
  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. extern location_t make_location (location_t caret,
  89. location_t start, location_t finish);
  90. extern location_t make_location (location_t caret, source_range src_range);
  91. void dump_line_table_statistics (void);
  92. void dump_location_info (FILE *stream);
  93. void diagnostics_file_cache_fini (void);
  94. void diagnostics_file_cache_forcibly_evict_file (const char *file_path);
  95. struct GTY(()) string_concat
  96. {
  97. string_concat (int num, location_t *locs);
  98. int m_num;
  99. location_t * GTY ((atomic)) m_locs;
  100. };
  101. struct location_hash : int_hash <location_t, UNKNOWN_LOCATION> { };
  102. class GTY(()) string_concat_db
  103. {
  104. public:
  105. string_concat_db ();
  106. void record_string_concatenation (int num, location_t *locs);
  107. bool get_string_concatenation (location_t loc,
  108. int *out_num,
  109. location_t **out_locs);
  110. private:
  111. static location_t get_key_loc (location_t loc);
  112. /* For the fields to be private, we must grant access to the
  113. generated code in gtype-desc.c. */
  114. friend void ::gt_ggc_mx_string_concat_db (void *x_p);
  115. friend void ::gt_pch_nx_string_concat_db (void *x_p);
  116. friend void ::gt_pch_p_16string_concat_db (void *this_obj, void *x_p,
  117. gt_pointer_operator op,
  118. void *cookie);
  119. hash_map <location_hash, string_concat *> *m_table;
  120. };
  121. #endif