Less verbose fix-it hints for missing header files (PR 87091)
[official-gcc.git] / gcc / gcc-rich-location.c
blob81beb61661c6a81dce0060a578f5f692e4a4114a
1 /* Implementation of gcc_rich_location class
2 Copyright (C) 2014-2018 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 for more details.
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
20 #include "config.h"
21 #include "system.h"
22 #include "coretypes.h"
23 #include "tm.h"
24 #include "rtl.h"
25 #include "hash-set.h"
26 #include "vec.h"
27 #include "input.h"
28 #include "alias.h"
29 #include "symtab.h"
30 #include "inchash.h"
31 #include "tree-core.h"
32 #include "tree.h"
33 #include "diagnostic-core.h"
34 #include "gcc-rich-location.h"
35 #include "print-tree.h"
36 #include "pretty-print.h"
37 #include "intl.h"
38 #include "cpplib.h"
39 #include "diagnostic.h"
41 /* Add a range to the rich_location, covering expression EXPR,
42 using LABEL if non-NULL. */
44 void
45 gcc_rich_location::add_expr (tree expr, range_label *label)
47 gcc_assert (expr);
49 if (CAN_HAVE_RANGE_P (expr))
50 add_range (EXPR_LOCATION (expr), SHOW_RANGE_WITHOUT_CARET, label);
53 /* If T is an expression, add a range for it to the rich_location,
54 using LABEL if non-NULL. */
56 void
57 gcc_rich_location::maybe_add_expr (tree t, range_label *label)
59 if (EXPR_P (t))
60 add_expr (t, label);
63 /* Add a fixit hint suggesting replacing the range at MISSPELLED_TOKEN_LOC
64 with the identifier HINT_ID. */
66 void
67 gcc_rich_location::add_fixit_misspelled_id (location_t misspelled_token_loc,
68 tree hint_id)
70 gcc_assert (TREE_CODE (hint_id) == IDENTIFIER_NODE);
72 add_fixit_replace (misspelled_token_loc, IDENTIFIER_POINTER (hint_id));
75 /* Return true if there is nothing on LOC's line before LOC. */
77 static bool
78 blank_line_before_p (location_t loc)
80 expanded_location exploc = expand_location (loc);
81 char_span line = location_get_source_line (exploc.file, exploc.line);
82 if (!line)
83 return false;
84 if (line.length () < (size_t)exploc.column)
85 return false;
86 /* Columns are 1-based. */
87 for (int column = 1; column < exploc.column; ++column)
88 if (!ISSPACE (line[column - 1]))
89 return false;
90 return true;
93 /* Subroutine of gcc_rich_location::add_fixit_insert_formatted.
94 Return true if we should add the content on its own line,
95 false otherwise.
96 If true is returned then *OUT_START_OF_LINE is written to. */
98 static bool
99 use_new_line (location_t insertion_point, location_t indent,
100 location_t *out_start_of_line)
102 if (indent == UNKNOWN_LOCATION)
103 return false;
104 const line_map *indent_map = linemap_lookup (line_table, indent);
105 if (linemap_macro_expansion_map_p (indent_map))
106 return false;
108 if (!blank_line_before_p (insertion_point))
109 return false;
111 /* Locate the start of the line containing INSERTION_POINT. */
112 const line_map *insertion_point_map
113 = linemap_lookup (line_table, insertion_point);
114 if (linemap_macro_expansion_map_p (insertion_point_map))
115 return false;
116 const line_map_ordinary *ordmap
117 = linemap_check_ordinary (insertion_point_map);
118 expanded_location exploc_insertion_point = expand_location (insertion_point);
119 location_t start_of_line
120 = linemap_position_for_line_and_column (line_table, ordmap,
121 exploc_insertion_point.line, 1);
122 *out_start_of_line = start_of_line;
123 return true;
126 /* Add a fix-it hint suggesting the insertion of CONTENT before
127 INSERTION_POINT.
129 Attempt to handle formatting: if INSERTION_POINT is the first thing on
130 its line, and INDENT is sufficiently sane, then add CONTENT on its own
131 line, using the indentation of INDENT.
132 Otherwise, add CONTENT directly before INSERTION_POINT.
134 For example, adding "CONTENT;" with the closing brace as the insertion
135 point and "INDENT;" as the indentation point:
137 if ()
139 INDENT;
142 would lead to:
144 if ()
146 INDENT;
147 CONTENT;
150 but adding it to:
152 if () {INDENT;}
154 would lead to:
156 if () {INDENT;CONTENT;}
159 void
160 gcc_rich_location::add_fixit_insert_formatted (const char *content,
161 location_t insertion_point,
162 location_t indent)
164 location_t start_of_line;
165 if (use_new_line (insertion_point, indent, &start_of_line))
167 /* Add CONTENT on its own line, using the indentation of INDENT. */
169 /* Generate an insertion string, indenting by the amount INDENT
170 was indented. */
171 int indent_column = LOCATION_COLUMN (get_start (indent));
172 pretty_printer tmp_pp;
173 pretty_printer *pp = &tmp_pp;
174 /* Columns are 1-based. */
175 for (int column = 1; column < indent_column; ++column)
176 pp_space (pp);
177 pp_string (pp, content);
178 pp_newline (pp);
180 add_fixit_insert_before (start_of_line, pp_formatted_text (pp));
182 else
183 add_fixit_insert_before (insertion_point, content);