Eliminate source_location in favor of location_t
[official-gcc.git] / gcc / c-family / c-ppoutput.c
blobbb5d99650c72b80b6bb3687e500b164e790e2f1c
1 /* Preprocess only, using cpplib.
2 Copyright (C) 1995-2018 Free Software Foundation, Inc.
3 Written by Per Bothner, 1994-95.
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 3, or (at your option) any
8 later version.
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; see the file COPYING3. If not see
17 <http://www.gnu.org/licenses/>. */
19 #include "config.h"
20 #include "system.h"
21 #include "coretypes.h"
22 #include "c-common.h" /* For flags. */
23 #include "../libcpp/internal.h"
24 #include "c-pragma.h" /* For parse_in. */
25 #include "file-prefix-map.h" /* remap_macro_filename() */
27 /* Encapsulates state used to convert a stream of tokens into a text
28 file. */
29 static struct
31 FILE *outf; /* Stream to write to. */
32 const cpp_token *prev; /* Previous token. */
33 const cpp_token *source; /* Source token for spacing. */
34 int src_line; /* Line number currently being written. */
35 bool printed; /* True if something output at line. */
36 bool first_time; /* pp_file_change hasn't been called yet. */
37 bool prev_was_system_token; /* True if the previous token was a
38 system token.*/
39 const char *src_file; /* Current source file. */
40 } print;
42 /* Defined and undefined macros being queued for output with -dU at
43 the next newline. */
44 struct macro_queue
46 struct macro_queue *next; /* Next macro in the list. */
47 char *macro; /* The name of the macro if not
48 defined, the full definition if
49 defined. */
51 static macro_queue *define_queue, *undef_queue;
53 /* General output routines. */
54 static void scan_translation_unit (cpp_reader *);
55 static void print_lines_directives_only (int, const void *, size_t);
56 static void scan_translation_unit_directives_only (cpp_reader *);
57 static void scan_translation_unit_trad (cpp_reader *);
58 static void account_for_newlines (const unsigned char *, size_t);
59 static int dump_macro (cpp_reader *, cpp_hashnode *, void *);
60 static void dump_queued_macros (cpp_reader *);
62 static bool print_line_1 (location_t, const char*, FILE *);
63 static bool print_line (location_t, const char *);
64 static bool maybe_print_line_1 (location_t, FILE *);
65 static bool maybe_print_line (location_t);
66 static bool do_line_change (cpp_reader *, const cpp_token *,
67 location_t, int);
69 /* Callback routines for the parser. Most of these are active only
70 in specific modes. */
71 static void cb_line_change (cpp_reader *, const cpp_token *, int);
72 static void cb_define (cpp_reader *, location_t, cpp_hashnode *);
73 static void cb_undef (cpp_reader *, location_t, cpp_hashnode *);
74 static void cb_used_define (cpp_reader *, location_t, cpp_hashnode *);
75 static void cb_used_undef (cpp_reader *, location_t, cpp_hashnode *);
76 static void cb_include (cpp_reader *, location_t, const unsigned char *,
77 const char *, int, const cpp_token **);
78 static void cb_ident (cpp_reader *, location_t, const cpp_string *);
79 static void cb_def_pragma (cpp_reader *, location_t);
80 static void cb_read_pch (cpp_reader *pfile, const char *name,
81 int fd, const char *orig_name);
83 /* Preprocess and output. */
84 void
85 preprocess_file (cpp_reader *pfile)
87 /* A successful cpp_read_main_file guarantees that we can call
88 cpp_scan_nooutput or cpp_get_token next. */
89 if (flag_no_output && pfile->buffer)
91 /* Scan -included buffers, then the main file. */
92 while (pfile->buffer->prev)
93 cpp_scan_nooutput (pfile);
94 cpp_scan_nooutput (pfile);
96 else if (cpp_get_options (pfile)->traditional)
97 scan_translation_unit_trad (pfile);
98 else if (cpp_get_options (pfile)->directives_only
99 && !cpp_get_options (pfile)->preprocessed)
100 scan_translation_unit_directives_only (pfile);
101 else
102 scan_translation_unit (pfile);
104 /* -dM command line option. Should this be elsewhere? */
105 if (flag_dump_macros == 'M')
106 cpp_forall_identifiers (pfile, dump_macro, NULL);
108 /* Flush any pending output. */
109 if (print.printed)
110 putc ('\n', print.outf);
113 /* Set up the callbacks as appropriate. */
114 void
115 init_pp_output (FILE *out_stream)
117 cpp_callbacks *cb = cpp_get_callbacks (parse_in);
119 if (!flag_no_output)
121 cb->line_change = cb_line_change;
122 /* Don't emit #pragma or #ident directives if we are processing
123 assembly language; the assembler may choke on them. */
124 if (cpp_get_options (parse_in)->lang != CLK_ASM)
126 cb->ident = cb_ident;
127 cb->def_pragma = cb_def_pragma;
131 if (flag_dump_includes)
132 cb->include = cb_include;
134 if (flag_pch_preprocess)
136 cb->valid_pch = c_common_valid_pch;
137 cb->read_pch = cb_read_pch;
140 if (flag_dump_macros == 'N' || flag_dump_macros == 'D')
142 cb->define = cb_define;
143 cb->undef = cb_undef;
146 if (flag_dump_macros == 'U')
148 cb->before_define = dump_queued_macros;
149 cb->used_define = cb_used_define;
150 cb->used_undef = cb_used_undef;
153 cb->has_attribute = c_common_has_attribute;
154 cb->get_source_date_epoch = cb_get_source_date_epoch;
155 cb->remap_filename = remap_macro_filename;
157 /* Initialize the print structure. */
158 print.src_line = 1;
159 print.printed = false;
160 print.prev = 0;
161 print.outf = out_stream;
162 print.first_time = 1;
163 print.src_file = "";
164 print.prev_was_system_token = false;
167 /* Writes out the preprocessed file, handling spacing and paste
168 avoidance issues. */
169 static void
170 scan_translation_unit (cpp_reader *pfile)
172 bool avoid_paste = false;
173 bool do_line_adjustments
174 = cpp_get_options (parse_in)->lang != CLK_ASM
175 && !flag_no_line_commands;
176 bool in_pragma = false;
177 bool line_marker_emitted = false;
179 print.source = NULL;
180 for (;;)
182 location_t loc;
183 const cpp_token *token = cpp_get_token_with_location (pfile, &loc);
185 if (token->type == CPP_PADDING)
187 avoid_paste = true;
188 if (print.source == NULL
189 || (!(print.source->flags & PREV_WHITE)
190 && token->val.source == NULL))
191 print.source = token->val.source;
192 continue;
195 if (token->type == CPP_EOF)
196 break;
198 /* Subtle logic to output a space if and only if necessary. */
199 if (avoid_paste)
201 int src_line = LOCATION_LINE (loc);
203 if (print.source == NULL)
204 print.source = token;
206 if (src_line != print.src_line
207 && do_line_adjustments
208 && !in_pragma)
210 line_marker_emitted = do_line_change (pfile, token, loc, false);
211 putc (' ', print.outf);
212 print.printed = true;
214 else if (print.source->flags & PREV_WHITE
215 || (print.prev
216 && cpp_avoid_paste (pfile, print.prev, token))
217 || (print.prev == NULL && token->type == CPP_HASH))
219 putc (' ', print.outf);
220 print.printed = true;
223 else if (token->flags & PREV_WHITE)
225 int src_line = LOCATION_LINE (loc);
227 if (src_line != print.src_line
228 && do_line_adjustments
229 && !in_pragma)
230 line_marker_emitted = do_line_change (pfile, token, loc, false);
231 putc (' ', print.outf);
232 print.printed = true;
235 avoid_paste = false;
236 print.source = NULL;
237 print.prev = token;
238 if (token->type == CPP_PRAGMA)
240 const char *space;
241 const char *name;
243 line_marker_emitted = maybe_print_line (token->src_loc);
244 fputs ("#pragma ", print.outf);
245 c_pp_lookup_pragma (token->val.pragma, &space, &name);
246 if (space)
247 fprintf (print.outf, "%s %s", space, name);
248 else
249 fprintf (print.outf, "%s", name);
250 print.printed = true;
251 in_pragma = true;
253 else if (token->type == CPP_PRAGMA_EOL)
255 maybe_print_line (token->src_loc);
256 in_pragma = false;
258 else
260 if (cpp_get_options (parse_in)->debug)
261 linemap_dump_location (line_table, token->src_loc, print.outf);
263 if (do_line_adjustments
264 && !in_pragma
265 && !line_marker_emitted
266 && print.prev_was_system_token != !!in_system_header_at (loc)
267 && !is_location_from_builtin_token (loc))
268 /* The system-ness of this token is different from the one
269 of the previous token. Let's emit a line change to
270 mark the new system-ness before we emit the token. */
272 do_line_change (pfile, token, loc, false);
273 print.prev_was_system_token = !!in_system_header_at (loc);
275 cpp_output_token (token, print.outf);
276 line_marker_emitted = false;
277 print.printed = true;
280 /* CPP_COMMENT tokens and raw-string literal tokens can
281 have embedded new-line characters. Rather than enumerating
282 all the possible token types just check if token uses
283 val.str union member. */
284 if (cpp_token_val_index (token) == CPP_TOKEN_FLD_STR)
285 account_for_newlines (token->val.str.text, token->val.str.len);
289 static void
290 print_lines_directives_only (int lines, const void *buf, size_t size)
292 print.src_line += lines;
293 fwrite (buf, 1, size, print.outf);
296 /* Writes out the preprocessed file, handling spacing and paste
297 avoidance issues. */
298 static void
299 scan_translation_unit_directives_only (cpp_reader *pfile)
301 struct _cpp_dir_only_callbacks cb;
303 cb.print_lines = print_lines_directives_only;
304 cb.maybe_print_line = maybe_print_line;
306 _cpp_preprocess_dir_only (pfile, &cb);
309 /* Adjust print.src_line for newlines embedded in output. */
310 static void
311 account_for_newlines (const unsigned char *str, size_t len)
313 while (len--)
314 if (*str++ == '\n')
315 print.src_line++;
318 /* Writes out a traditionally preprocessed file. */
319 static void
320 scan_translation_unit_trad (cpp_reader *pfile)
322 while (_cpp_read_logical_line_trad (pfile))
324 size_t len = pfile->out.cur - pfile->out.base;
325 maybe_print_line (pfile->out.first_line);
326 fwrite (pfile->out.base, 1, len, print.outf);
327 print.printed = true;
328 if (!CPP_OPTION (pfile, discard_comments))
329 account_for_newlines (pfile->out.base, len);
333 /* If the token read on logical line LINE needs to be output on a
334 different line to the current one, output the required newlines or
335 a line marker. If a line marker was emitted, return TRUE otherwise
336 return FALSE. */
338 static bool
339 maybe_print_line_1 (location_t src_loc, FILE *stream)
341 bool emitted_line_marker = false;
342 int src_line = LOCATION_LINE (src_loc);
343 const char *src_file = LOCATION_FILE (src_loc);
345 /* End the previous line of text. */
346 if (print.printed)
348 putc ('\n', stream);
349 print.src_line++;
350 print.printed = false;
353 if (!flag_no_line_commands
354 && src_line >= print.src_line
355 && src_line < print.src_line + 8
356 && strcmp (src_file, print.src_file) == 0)
358 while (src_line > print.src_line)
360 putc ('\n', stream);
361 print.src_line++;
364 else
365 emitted_line_marker = print_line_1 (src_loc, "", stream);
367 return emitted_line_marker;
370 /* If the token read on logical line LINE needs to be output on a
371 different line to the current one, output the required newlines or
372 a line marker. If a line marker was emitted, return TRUE otherwise
373 return FALSE. */
375 static bool
376 maybe_print_line (location_t src_loc)
378 if (cpp_get_options (parse_in)->debug)
379 linemap_dump_location (line_table, src_loc,
380 print.outf);
381 return maybe_print_line_1 (src_loc, print.outf);
384 /* Output a line marker for logical line LINE. Special flags are "1"
385 or "2" indicating entering or leaving a file. If the line marker
386 was effectively emitted, return TRUE otherwise return FALSE. */
388 static bool
389 print_line_1 (location_t src_loc, const char *special_flags, FILE *stream)
391 bool emitted_line_marker = false;
393 /* End any previous line of text. */
394 if (print.printed)
395 putc ('\n', stream);
396 print.printed = false;
398 if (!flag_no_line_commands)
400 const char *file_path = LOCATION_FILE (src_loc);
401 int sysp;
402 size_t to_file_len = strlen (file_path);
403 unsigned char *to_file_quoted =
404 (unsigned char *) alloca (to_file_len * 4 + 1);
405 unsigned char *p;
407 print.src_line = LOCATION_LINE (src_loc);
408 print.src_file = file_path;
410 /* cpp_quote_string does not nul-terminate, so we have to do it
411 ourselves. */
412 p = cpp_quote_string (to_file_quoted,
413 (const unsigned char *) file_path,
414 to_file_len);
415 *p = '\0';
416 fprintf (stream, "# %u \"%s\"%s",
417 print.src_line == 0 ? 1 : print.src_line,
418 to_file_quoted, special_flags);
420 sysp = in_system_header_at (src_loc);
421 if (sysp == 2)
422 fputs (" 3 4", stream);
423 else if (sysp == 1)
424 fputs (" 3", stream);
426 putc ('\n', stream);
427 emitted_line_marker = true;
430 return emitted_line_marker;
433 /* Output a line marker for logical line LINE. Special flags are "1"
434 or "2" indicating entering or leaving a file. Return TRUE if a
435 line marker was effectively emitted, FALSE otherwise. */
437 static bool
438 print_line (location_t src_loc, const char *special_flags)
440 if (cpp_get_options (parse_in)->debug)
441 linemap_dump_location (line_table, src_loc,
442 print.outf);
443 return print_line_1 (src_loc, special_flags, print.outf);
446 /* Helper function for cb_line_change and scan_translation_unit.
447 Return TRUE if a line marker is emitted, FALSE otherwise. */
448 static bool
449 do_line_change (cpp_reader *pfile, const cpp_token *token,
450 location_t src_loc, int parsing_args)
452 bool emitted_line_marker = false;
453 if (define_queue || undef_queue)
454 dump_queued_macros (pfile);
456 if (token->type == CPP_EOF || parsing_args)
457 return false;
459 emitted_line_marker = maybe_print_line (src_loc);
460 print.prev = 0;
461 print.source = 0;
463 /* Supply enough spaces to put this token in its original column,
464 one space per column greater than 2, since scan_translation_unit
465 will provide a space if PREV_WHITE. Don't bother trying to
466 reconstruct tabs; we can't get it right in general, and nothing
467 ought to care. Some things do care; the fault lies with them. */
468 if (!CPP_OPTION (pfile, traditional))
470 int spaces = LOCATION_COLUMN (src_loc) - 2;
471 print.printed = true;
473 while (-- spaces >= 0)
474 putc (' ', print.outf);
477 return emitted_line_marker;
480 /* Called when a line of output is started. TOKEN is the first token
481 of the line, and at end of file will be CPP_EOF. */
482 static void
483 cb_line_change (cpp_reader *pfile, const cpp_token *token,
484 int parsing_args)
486 do_line_change (pfile, token, token->src_loc, parsing_args);
489 static void
490 cb_ident (cpp_reader *pfile ATTRIBUTE_UNUSED, location_t line,
491 const cpp_string *str)
493 maybe_print_line (line);
494 fprintf (print.outf, "#ident %s\n", str->text);
495 print.src_line++;
498 static void
499 cb_define (cpp_reader *pfile, location_t line, cpp_hashnode *node)
501 const line_map_ordinary *map;
503 maybe_print_line (line);
504 fputs ("#define ", print.outf);
506 /* 'D' is whole definition; 'N' is name only. */
507 if (flag_dump_macros == 'D')
508 fputs ((const char *) cpp_macro_definition (pfile, node),
509 print.outf);
510 else
511 fputs ((const char *) NODE_NAME (node), print.outf);
513 putc ('\n', print.outf);
514 print.printed = false;
515 linemap_resolve_location (line_table, line,
516 LRK_MACRO_DEFINITION_LOCATION,
517 &map);
518 if (LINEMAP_LINE (map) != 0)
519 print.src_line++;
522 static void
523 cb_undef (cpp_reader *pfile ATTRIBUTE_UNUSED, location_t line,
524 cpp_hashnode *node)
526 maybe_print_line (line);
527 fprintf (print.outf, "#undef %s\n", NODE_NAME (node));
528 print.src_line++;
531 static void
532 cb_used_define (cpp_reader *pfile, location_t line ATTRIBUTE_UNUSED,
533 cpp_hashnode *node)
535 if (cpp_user_macro_p (node))
537 macro_queue *q;
538 q = XNEW (macro_queue);
539 q->macro = xstrdup ((const char *) cpp_macro_definition (pfile, node));
540 q->next = define_queue;
541 define_queue = q;
545 static void
546 cb_used_undef (cpp_reader *pfile ATTRIBUTE_UNUSED,
547 location_t line ATTRIBUTE_UNUSED,
548 cpp_hashnode *node)
550 macro_queue *q;
551 q = XNEW (macro_queue);
552 q->macro = xstrdup ((const char *) NODE_NAME (node));
553 q->next = undef_queue;
554 undef_queue = q;
557 static void
558 dump_queued_macros (cpp_reader *pfile ATTRIBUTE_UNUSED)
560 macro_queue *q;
562 /* End the previous line of text. */
563 if (print.printed)
565 putc ('\n', print.outf);
566 print.src_line++;
567 print.printed = false;
570 for (q = define_queue; q;)
572 macro_queue *oq;
573 fputs ("#define ", print.outf);
574 fputs (q->macro, print.outf);
575 putc ('\n', print.outf);
576 print.printed = false;
577 print.src_line++;
578 oq = q;
579 q = q->next;
580 free (oq->macro);
581 free (oq);
583 define_queue = NULL;
584 for (q = undef_queue; q;)
586 macro_queue *oq;
587 fprintf (print.outf, "#undef %s\n", q->macro);
588 print.src_line++;
589 oq = q;
590 q = q->next;
591 free (oq->macro);
592 free (oq);
594 undef_queue = NULL;
597 static void
598 cb_include (cpp_reader *pfile ATTRIBUTE_UNUSED, location_t line,
599 const unsigned char *dir, const char *header, int angle_brackets,
600 const cpp_token **comments)
602 maybe_print_line (line);
603 if (angle_brackets)
604 fprintf (print.outf, "#%s <%s>", dir, header);
605 else
606 fprintf (print.outf, "#%s \"%s\"", dir, header);
608 if (comments != NULL)
610 while (*comments != NULL)
612 if ((*comments)->flags & PREV_WHITE)
613 putc (' ', print.outf);
614 cpp_output_token (*comments, print.outf);
615 ++comments;
619 putc ('\n', print.outf);
620 print.printed = false;
621 print.src_line++;
624 /* Callback called when -fworking-director and -E to emit working
625 directory in cpp output file. */
627 void
628 pp_dir_change (cpp_reader *pfile ATTRIBUTE_UNUSED, const char *dir)
630 size_t to_file_len = strlen (dir);
631 unsigned char *to_file_quoted =
632 (unsigned char *) alloca (to_file_len * 4 + 1);
633 unsigned char *p;
635 /* cpp_quote_string does not nul-terminate, so we have to do it ourselves. */
636 p = cpp_quote_string (to_file_quoted, (const unsigned char *) dir, to_file_len);
637 *p = '\0';
638 fprintf (print.outf, "# 1 \"%s//\"\n", to_file_quoted);
641 /* The file name, line number or system header flags have changed, as
642 described in MAP. */
644 void
645 pp_file_change (const line_map_ordinary *map)
647 const char *flags = "";
649 if (flag_no_line_commands)
650 return;
652 if (map != NULL)
654 input_location = map->start_location;
655 if (print.first_time)
657 /* Avoid printing foo.i when the main file is foo.c. */
658 if (!cpp_get_options (parse_in)->preprocessed)
659 print_line (map->start_location, flags);
660 print.first_time = 0;
662 else
664 /* Bring current file to correct line when entering a new file. */
665 if (map->reason == LC_ENTER)
667 maybe_print_line (linemap_included_from (map));
668 flags = " 1";
670 else if (map->reason == LC_LEAVE)
671 flags = " 2";
672 print_line (map->start_location, flags);
677 /* Copy a #pragma directive to the preprocessed output. */
678 static void
679 cb_def_pragma (cpp_reader *pfile, location_t line)
681 maybe_print_line (line);
682 fputs ("#pragma ", print.outf);
683 cpp_output_line (pfile, print.outf);
684 print.printed = false;
685 print.src_line++;
688 /* Dump out the hash table. */
689 static int
690 dump_macro (cpp_reader *pfile, cpp_hashnode *node, void *v ATTRIBUTE_UNUSED)
692 if (cpp_user_macro_p (node))
694 fputs ("#define ", print.outf);
695 fputs ((const char *) cpp_macro_definition (pfile, node),
696 print.outf);
697 putc ('\n', print.outf);
698 print.printed = false;
699 print.src_line++;
702 return 1;
705 /* Load in the PCH file NAME, open on FD. It was originally searched for
706 by ORIG_NAME. Also, print out a #include command so that the PCH
707 file can be loaded when the preprocessed output is compiled. */
709 static void
710 cb_read_pch (cpp_reader *pfile, const char *name,
711 int fd, const char *orig_name ATTRIBUTE_UNUSED)
713 c_common_read_pch (pfile, name, fd, orig_name);
715 fprintf (print.outf, "#pragma GCC pch_preprocess \"%s\"\n", name);
716 print.src_line++;