1 /* Map logical line numbers to (source file, line number) pairs.
2 Copyright (C) 2001, 2003, 2004
3 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the
7 Free Software Foundation; either version 2, or (at your option) any
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 In other words, you are welcome to use, share and improve this program.
20 You are forbidden to forbid anyone else to use, share and improve
21 what you give them. Help stamp out software-hoarding! */
28 static void trace_include (const struct line_maps *, const struct line_map *);
30 /* Initialize a line map set. */
33 linemap_init (struct line_maps *set)
38 set->last_listed = -1;
39 set->trace_includes = false;
44 /* Free a line map set. */
47 linemap_free (struct line_maps *set)
53 /* Depending upon whether we are handling preprocessed input or
54 not, this can be a user error or an ICE. */
55 for (map = CURRENT_LINE_MAP (set); ! MAIN_FILE_P (map);
56 map = INCLUDED_FROM (set, map))
57 fprintf (stderr, "line-map.c: file \"%s\" entered but not left\n",
64 /* Add a mapping of logical source line to physical source file and
67 The text pointed to by TO_FILE must have a lifetime
68 at least as long as the final call to lookup_line (). An empty
69 TO_FILE means standard input. If reason is LC_LEAVE, and
70 TO_FILE is NULL, then TO_FILE, TO_LINE and SYSP are given their
71 natural values considering the file we are returning to.
73 FROM_LINE should be monotonic increasing across calls to this
74 function. A call to this function can relocate the previous set of
75 maps, so any stored line_map pointers should not be used. */
77 const struct line_map *
78 linemap_add (struct line_maps *set, enum lc_reason reason,
79 unsigned int sysp, source_location from_line,
80 const char *to_file, unsigned int to_line)
84 if (set->used && from_line < set->maps[set->used - 1].from_line)
87 if (set->used == set->allocated)
89 set->allocated = 2 * set->allocated + 256;
90 set->maps = xrealloc (set->maps, set->allocated * sizeof (struct line_map));
93 map = &set->maps[set->used];
95 if (to_file && *to_file == '\0')
98 /* If we don't keep our line maps consistent, we can easily
99 segfault. Don't rely on the client to do it for us. */
102 else if (reason == LC_LEAVE)
104 struct line_map *from;
107 if (MAIN_FILE_P (map - 1))
120 from = INCLUDED_FROM (set, map - 1);
121 error = to_file && strcmp (from->to_file, to_file);
124 /* Depending upon whether we are handling preprocessed input or
125 not, this can be a user error or an ICE. */
127 fprintf (stderr, "line-map.c: file \"%s\" left but not entered\n",
130 /* A TO_FILE of NULL is special - we use the natural values. */
131 if (error || to_file == NULL)
133 to_file = from->to_file;
134 to_line = LAST_SOURCE_LINE (from) + 1;
139 map->reason = reason;
141 map->from_line = from_line;
142 map->to_file = to_file;
143 map->to_line = to_line;
144 set->cache = set->used++;
146 if (reason == LC_ENTER)
148 map->included_from = set->depth == 0 ? -1 : (int) (set->used - 2);
150 if (set->trace_includes)
151 trace_include (set, map);
153 else if (reason == LC_RENAME)
154 map->included_from = map[-1].included_from;
155 else if (reason == LC_LEAVE)
158 map->included_from = INCLUDED_FROM (set, map - 1)->included_from;
164 /* Given a logical line, returns the map from which the corresponding
165 (source file, line) pair can be deduced. Since the set is built
166 chronologically, the logical lines are monotonic increasing, and so
167 the list is sorted and we can use a binary search. */
169 const struct line_map *
170 linemap_lookup (struct line_maps *set, source_location line)
172 unsigned int md, mn, mx;
173 const struct line_map *cached;
178 cached = &set->maps[mn];
179 /* We should get a segfault if no line_maps have been added yet. */
180 if (line >= cached->from_line)
182 if (mn + 1 == mx || line < cached[1].from_line)
194 if (set->maps[md].from_line > line)
201 return &set->maps[mn];
204 /* Print the file names and line numbers of the #include commands
205 which led to the map MAP, if any, to stderr. Nothing is output if
206 the most recently listed stack is the same as the current one. */
209 linemap_print_containing_files (struct line_maps *set,
210 const struct line_map *map)
212 if (MAIN_FILE_P (map) || set->last_listed == map->included_from)
215 set->last_listed = map->included_from;
216 map = INCLUDED_FROM (set, map);
218 fprintf (stderr, _("In file included from %s:%u"),
219 map->to_file, LAST_SOURCE_LINE (map));
221 while (! MAIN_FILE_P (map))
223 map = INCLUDED_FROM (set, map);
224 /* Translators note: this message is used in conjunction
225 with "In file included from %s:%ld" and some other
226 tricks. We want something like this:
228 | In file included from sys/select.h:123,
229 | from sys/types.h:234,
230 | from userfile.c:31:
231 | bits/select.h:45: <error message here>
233 with all the "from"s lined up.
234 The trailing comma is at the beginning of this message,
235 and the trailing colon is not translated. */
236 fprintf (stderr, _(",\n from %s:%u"),
237 map->to_file, LAST_SOURCE_LINE (map));
240 fputs (":\n", stderr);
243 /* Print an include trace, for e.g. the -H option of the preprocessor. */
246 trace_include (const struct line_maps *set, const struct line_map *map)
248 unsigned int i = set->depth;
252 fprintf (stderr, " %s\n", map->to_file);