]> git.ipfire.org Git - thirdparty/gcc.git/blob - gcc/c-family/c-ppoutput.c
Update copyright years.
[thirdparty/gcc.git] / gcc / c-family / c-ppoutput.c
1 /* Preprocess only, using cpplib.
2 Copyright (C) 1995-2016 Free Software Foundation, Inc.
3 Written by Per Bothner, 1994-95.
4
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.
9
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.
14
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/>. */
18
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
26 /* Encapsulates state used to convert a stream of tokens into a text
27 file. */
28 static struct
29 {
30 FILE *outf; /* Stream to write to. */
31 const cpp_token *prev; /* Previous token. */
32 const cpp_token *source; /* Source token for spacing. */
33 int src_line; /* Line number currently being written. */
34 bool printed; /* True if something output at line. */
35 bool first_time; /* pp_file_change hasn't been called yet. */
36 bool prev_was_system_token; /* True if the previous token was a
37 system token.*/
38 const char *src_file; /* Current source file. */
39 } print;
40
41 /* Defined and undefined macros being queued for output with -dU at
42 the next newline. */
43 struct macro_queue
44 {
45 struct macro_queue *next; /* Next macro in the list. */
46 char *macro; /* The name of the macro if not
47 defined, the full definition if
48 defined. */
49 };
50 static macro_queue *define_queue, *undef_queue;
51
52 /* General output routines. */
53 static void scan_translation_unit (cpp_reader *);
54 static void print_lines_directives_only (int, const void *, size_t);
55 static void scan_translation_unit_directives_only (cpp_reader *);
56 static void scan_translation_unit_trad (cpp_reader *);
57 static void account_for_newlines (const unsigned char *, size_t);
58 static int dump_macro (cpp_reader *, cpp_hashnode *, void *);
59 static void dump_queued_macros (cpp_reader *);
60
61 static bool print_line_1 (source_location, const char*, FILE *);
62 static bool print_line (source_location, const char *);
63 static bool maybe_print_line_1 (source_location, FILE *);
64 static bool maybe_print_line (source_location);
65 static bool do_line_change (cpp_reader *, const cpp_token *,
66 source_location, int);
67
68 /* Callback routines for the parser. Most of these are active only
69 in specific modes. */
70 static void cb_line_change (cpp_reader *, const cpp_token *, int);
71 static void cb_define (cpp_reader *, source_location, cpp_hashnode *);
72 static void cb_undef (cpp_reader *, source_location, cpp_hashnode *);
73 static void cb_used_define (cpp_reader *, source_location, cpp_hashnode *);
74 static void cb_used_undef (cpp_reader *, source_location, cpp_hashnode *);
75 static void cb_include (cpp_reader *, source_location, const unsigned char *,
76 const char *, int, const cpp_token **);
77 static void cb_ident (cpp_reader *, source_location, const cpp_string *);
78 static void cb_def_pragma (cpp_reader *, source_location);
79 static void cb_read_pch (cpp_reader *pfile, const char *name,
80 int fd, const char *orig_name);
81
82 /* Preprocess and output. */
83 void
84 preprocess_file (cpp_reader *pfile)
85 {
86 /* A successful cpp_read_main_file guarantees that we can call
87 cpp_scan_nooutput or cpp_get_token next. */
88 if (flag_no_output && pfile->buffer)
89 {
90 /* Scan -included buffers, then the main file. */
91 while (pfile->buffer->prev)
92 cpp_scan_nooutput (pfile);
93 cpp_scan_nooutput (pfile);
94 }
95 else if (cpp_get_options (pfile)->traditional)
96 scan_translation_unit_trad (pfile);
97 else if (cpp_get_options (pfile)->directives_only
98 && !cpp_get_options (pfile)->preprocessed)
99 scan_translation_unit_directives_only (pfile);
100 else
101 scan_translation_unit (pfile);
102
103 /* -dM command line option. Should this be elsewhere? */
104 if (flag_dump_macros == 'M')
105 cpp_forall_identifiers (pfile, dump_macro, NULL);
106
107 /* Flush any pending output. */
108 if (print.printed)
109 putc ('\n', print.outf);
110 }
111
112 /* Set up the callbacks as appropriate. */
113 void
114 init_pp_output (FILE *out_stream)
115 {
116 cpp_callbacks *cb = cpp_get_callbacks (parse_in);
117
118 if (!flag_no_output)
119 {
120 cb->line_change = cb_line_change;
121 /* Don't emit #pragma or #ident directives if we are processing
122 assembly language; the assembler may choke on them. */
123 if (cpp_get_options (parse_in)->lang != CLK_ASM)
124 {
125 cb->ident = cb_ident;
126 cb->def_pragma = cb_def_pragma;
127 }
128 }
129
130 if (flag_dump_includes)
131 cb->include = cb_include;
132
133 if (flag_pch_preprocess)
134 {
135 cb->valid_pch = c_common_valid_pch;
136 cb->read_pch = cb_read_pch;
137 }
138
139 if (flag_dump_macros == 'N' || flag_dump_macros == 'D')
140 {
141 cb->define = cb_define;
142 cb->undef = cb_undef;
143 }
144
145 if (flag_dump_macros == 'U')
146 {
147 cb->before_define = dump_queued_macros;
148 cb->used_define = cb_used_define;
149 cb->used_undef = cb_used_undef;
150 }
151
152 cb->has_attribute = c_common_has_attribute;
153
154 /* Initialize the print structure. */
155 print.src_line = 1;
156 print.printed = false;
157 print.prev = 0;
158 print.outf = out_stream;
159 print.first_time = 1;
160 print.src_file = "";
161 print.prev_was_system_token = false;
162 }
163
164 /* Writes out the preprocessed file, handling spacing and paste
165 avoidance issues. */
166 static void
167 scan_translation_unit (cpp_reader *pfile)
168 {
169 bool avoid_paste = false;
170 bool do_line_adjustments
171 = cpp_get_options (parse_in)->lang != CLK_ASM
172 && !flag_no_line_commands;
173 bool in_pragma = false;
174 bool line_marker_emitted = false;
175
176 print.source = NULL;
177 for (;;)
178 {
179 source_location loc;
180 const cpp_token *token = cpp_get_token_with_location (pfile, &loc);
181
182 if (token->type == CPP_PADDING)
183 {
184 avoid_paste = true;
185 if (print.source == NULL
186 || (!(print.source->flags & PREV_WHITE)
187 && token->val.source == NULL))
188 print.source = token->val.source;
189 continue;
190 }
191
192 if (token->type == CPP_EOF)
193 break;
194
195 /* Subtle logic to output a space if and only if necessary. */
196 if (avoid_paste)
197 {
198 int src_line = LOCATION_LINE (loc);
199
200 if (print.source == NULL)
201 print.source = token;
202
203 if (src_line != print.src_line
204 && do_line_adjustments
205 && !in_pragma)
206 {
207 line_marker_emitted = do_line_change (pfile, token, loc, false);
208 putc (' ', print.outf);
209 print.printed = true;
210 }
211 else if (print.source->flags & PREV_WHITE
212 || (print.prev
213 && cpp_avoid_paste (pfile, print.prev, token))
214 || (print.prev == NULL && token->type == CPP_HASH))
215 {
216 putc (' ', print.outf);
217 print.printed = true;
218 }
219 }
220 else if (token->flags & PREV_WHITE)
221 {
222 int src_line = LOCATION_LINE (loc);
223
224 if (src_line != print.src_line
225 && do_line_adjustments
226 && !in_pragma)
227 line_marker_emitted = do_line_change (pfile, token, loc, false);
228 putc (' ', print.outf);
229 print.printed = true;
230 }
231
232 avoid_paste = false;
233 print.source = NULL;
234 print.prev = token;
235 if (token->type == CPP_PRAGMA)
236 {
237 const char *space;
238 const char *name;
239
240 line_marker_emitted = maybe_print_line (token->src_loc);
241 fputs ("#pragma ", print.outf);
242 c_pp_lookup_pragma (token->val.pragma, &space, &name);
243 if (space)
244 fprintf (print.outf, "%s %s", space, name);
245 else
246 fprintf (print.outf, "%s", name);
247 print.printed = true;
248 in_pragma = true;
249 }
250 else if (token->type == CPP_PRAGMA_EOL)
251 {
252 maybe_print_line (token->src_loc);
253 in_pragma = false;
254 }
255 else
256 {
257 if (cpp_get_options (parse_in)->debug)
258 linemap_dump_location (line_table, token->src_loc, print.outf);
259
260 if (do_line_adjustments
261 && !in_pragma
262 && !line_marker_emitted
263 && print.prev_was_system_token != !!in_system_header_at (loc)
264 && !is_location_from_builtin_token (loc))
265 /* The system-ness of this token is different from the one
266 of the previous token. Let's emit a line change to
267 mark the new system-ness before we emit the token. */
268 {
269 do_line_change (pfile, token, loc, false);
270 print.prev_was_system_token = !!in_system_header_at (loc);
271 }
272 cpp_output_token (token, print.outf);
273 line_marker_emitted = false;
274 print.printed = true;
275 }
276
277 /* CPP_COMMENT tokens and raw-string literal tokens can
278 have embedded new-line characters. Rather than enumerating
279 all the possible token types just check if token uses
280 val.str union member. */
281 if (cpp_token_val_index (token) == CPP_TOKEN_FLD_STR)
282 account_for_newlines (token->val.str.text, token->val.str.len);
283 }
284 }
285
286 static void
287 print_lines_directives_only (int lines, const void *buf, size_t size)
288 {
289 print.src_line += lines;
290 fwrite (buf, 1, size, print.outf);
291 }
292
293 /* Writes out the preprocessed file, handling spacing and paste
294 avoidance issues. */
295 static void
296 scan_translation_unit_directives_only (cpp_reader *pfile)
297 {
298 struct _cpp_dir_only_callbacks cb;
299
300 cb.print_lines = print_lines_directives_only;
301 cb.maybe_print_line = (void (*) (source_location)) maybe_print_line;
302
303 _cpp_preprocess_dir_only (pfile, &cb);
304 }
305
306 /* Adjust print.src_line for newlines embedded in output. */
307 static void
308 account_for_newlines (const unsigned char *str, size_t len)
309 {
310 while (len--)
311 if (*str++ == '\n')
312 print.src_line++;
313 }
314
315 /* Writes out a traditionally preprocessed file. */
316 static void
317 scan_translation_unit_trad (cpp_reader *pfile)
318 {
319 while (_cpp_read_logical_line_trad (pfile))
320 {
321 size_t len = pfile->out.cur - pfile->out.base;
322 maybe_print_line (pfile->out.first_line);
323 fwrite (pfile->out.base, 1, len, print.outf);
324 print.printed = true;
325 if (!CPP_OPTION (pfile, discard_comments))
326 account_for_newlines (pfile->out.base, len);
327 }
328 }
329
330 /* If the token read on logical line LINE needs to be output on a
331 different line to the current one, output the required newlines or
332 a line marker. If a line marker was emitted, return TRUE otherwise
333 return FALSE. */
334
335 static bool
336 maybe_print_line_1 (source_location src_loc, FILE *stream)
337 {
338 bool emitted_line_marker = false;
339 int src_line = LOCATION_LINE (src_loc);
340 const char *src_file = LOCATION_FILE (src_loc);
341
342 /* End the previous line of text. */
343 if (print.printed)
344 {
345 putc ('\n', stream);
346 print.src_line++;
347 print.printed = false;
348 }
349
350 if (!flag_no_line_commands
351 && src_line >= print.src_line
352 && src_line < print.src_line + 8
353 && strcmp (src_file, print.src_file) == 0)
354 {
355 while (src_line > print.src_line)
356 {
357 putc ('\n', stream);
358 print.src_line++;
359 }
360 }
361 else
362 emitted_line_marker = print_line_1 (src_loc, "", stream);
363
364 return emitted_line_marker;
365 }
366
367 /* If the token read on logical line LINE needs to be output on a
368 different line to the current one, output the required newlines or
369 a line marker. If a line marker was emitted, return TRUE otherwise
370 return FALSE. */
371
372 static bool
373 maybe_print_line (source_location src_loc)
374 {
375 if (cpp_get_options (parse_in)->debug)
376 linemap_dump_location (line_table, src_loc,
377 print.outf);
378 return maybe_print_line_1 (src_loc, print.outf);
379 }
380
381 /* Output a line marker for logical line LINE. Special flags are "1"
382 or "2" indicating entering or leaving a file. If the line marker
383 was effectively emitted, return TRUE otherwise return FALSE. */
384
385 static bool
386 print_line_1 (source_location src_loc, const char *special_flags, FILE *stream)
387 {
388 bool emitted_line_marker = false;
389
390 /* End any previous line of text. */
391 if (print.printed)
392 putc ('\n', stream);
393 print.printed = false;
394
395 if (!flag_no_line_commands)
396 {
397 const char *file_path = LOCATION_FILE (src_loc);
398 int sysp;
399 size_t to_file_len = strlen (file_path);
400 unsigned char *to_file_quoted =
401 (unsigned char *) alloca (to_file_len * 4 + 1);
402 unsigned char *p;
403
404 print.src_line = LOCATION_LINE (src_loc);
405 print.src_file = file_path;
406
407 /* cpp_quote_string does not nul-terminate, so we have to do it
408 ourselves. */
409 p = cpp_quote_string (to_file_quoted,
410 (const unsigned char *) file_path,
411 to_file_len);
412 *p = '\0';
413 fprintf (stream, "# %u \"%s\"%s",
414 print.src_line == 0 ? 1 : print.src_line,
415 to_file_quoted, special_flags);
416
417 sysp = in_system_header_at (src_loc);
418 if (sysp == 2)
419 fputs (" 3 4", stream);
420 else if (sysp == 1)
421 fputs (" 3", stream);
422
423 putc ('\n', stream);
424 emitted_line_marker = true;
425 }
426
427 return emitted_line_marker;
428 }
429
430 /* Output a line marker for logical line LINE. Special flags are "1"
431 or "2" indicating entering or leaving a file. Return TRUE if a
432 line marker was effectively emitted, FALSE otherwise. */
433
434 static bool
435 print_line (source_location src_loc, const char *special_flags)
436 {
437 if (cpp_get_options (parse_in)->debug)
438 linemap_dump_location (line_table, src_loc,
439 print.outf);
440 return print_line_1 (src_loc, special_flags, print.outf);
441 }
442
443 /* Helper function for cb_line_change and scan_translation_unit.
444 Return TRUE if a line marker is emitted, FALSE otherwise. */
445 static bool
446 do_line_change (cpp_reader *pfile, const cpp_token *token,
447 source_location src_loc, int parsing_args)
448 {
449 bool emitted_line_marker = false;
450 if (define_queue || undef_queue)
451 dump_queued_macros (pfile);
452
453 if (token->type == CPP_EOF || parsing_args)
454 return false;
455
456 emitted_line_marker = maybe_print_line (src_loc);
457 print.prev = 0;
458 print.source = 0;
459
460 /* Supply enough spaces to put this token in its original column,
461 one space per column greater than 2, since scan_translation_unit
462 will provide a space if PREV_WHITE. Don't bother trying to
463 reconstruct tabs; we can't get it right in general, and nothing
464 ought to care. Some things do care; the fault lies with them. */
465 if (!CPP_OPTION (pfile, traditional))
466 {
467 int spaces = LOCATION_COLUMN (src_loc) - 2;
468 print.printed = true;
469
470 while (-- spaces >= 0)
471 putc (' ', print.outf);
472 }
473
474 return emitted_line_marker;
475 }
476
477 /* Called when a line of output is started. TOKEN is the first token
478 of the line, and at end of file will be CPP_EOF. */
479 static void
480 cb_line_change (cpp_reader *pfile, const cpp_token *token,
481 int parsing_args)
482 {
483 do_line_change (pfile, token, token->src_loc, parsing_args);
484 }
485
486 static void
487 cb_ident (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
488 const cpp_string *str)
489 {
490 maybe_print_line (line);
491 fprintf (print.outf, "#ident %s\n", str->text);
492 print.src_line++;
493 }
494
495 static void
496 cb_define (cpp_reader *pfile, source_location line, cpp_hashnode *node)
497 {
498 const line_map_ordinary *map;
499
500 maybe_print_line (line);
501 fputs ("#define ", print.outf);
502
503 /* 'D' is whole definition; 'N' is name only. */
504 if (flag_dump_macros == 'D')
505 fputs ((const char *) cpp_macro_definition (pfile, node),
506 print.outf);
507 else
508 fputs ((const char *) NODE_NAME (node), print.outf);
509
510 putc ('\n', print.outf);
511 print.printed = false;
512 linemap_resolve_location (line_table, line,
513 LRK_MACRO_DEFINITION_LOCATION,
514 &map);
515 if (LINEMAP_LINE (map) != 0)
516 print.src_line++;
517 }
518
519 static void
520 cb_undef (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
521 cpp_hashnode *node)
522 {
523 maybe_print_line (line);
524 fprintf (print.outf, "#undef %s\n", NODE_NAME (node));
525 print.src_line++;
526 }
527
528 static void
529 cb_used_define (cpp_reader *pfile, source_location line ATTRIBUTE_UNUSED,
530 cpp_hashnode *node)
531 {
532 macro_queue *q;
533 if (node->flags & NODE_BUILTIN)
534 return;
535 q = XNEW (macro_queue);
536 q->macro = xstrdup ((const char *) cpp_macro_definition (pfile, node));
537 q->next = define_queue;
538 define_queue = q;
539 }
540
541 static void
542 cb_used_undef (cpp_reader *pfile ATTRIBUTE_UNUSED,
543 source_location line ATTRIBUTE_UNUSED,
544 cpp_hashnode *node)
545 {
546 macro_queue *q;
547 q = XNEW (macro_queue);
548 q->macro = xstrdup ((const char *) NODE_NAME (node));
549 q->next = undef_queue;
550 undef_queue = q;
551 }
552
553 static void
554 dump_queued_macros (cpp_reader *pfile ATTRIBUTE_UNUSED)
555 {
556 macro_queue *q;
557
558 /* End the previous line of text. */
559 if (print.printed)
560 {
561 putc ('\n', print.outf);
562 print.src_line++;
563 print.printed = false;
564 }
565
566 for (q = define_queue; q;)
567 {
568 macro_queue *oq;
569 fputs ("#define ", print.outf);
570 fputs (q->macro, print.outf);
571 putc ('\n', print.outf);
572 print.printed = false;
573 print.src_line++;
574 oq = q;
575 q = q->next;
576 free (oq->macro);
577 free (oq);
578 }
579 define_queue = NULL;
580 for (q = undef_queue; q;)
581 {
582 macro_queue *oq;
583 fprintf (print.outf, "#undef %s\n", q->macro);
584 print.src_line++;
585 oq = q;
586 q = q->next;
587 free (oq->macro);
588 free (oq);
589 }
590 undef_queue = NULL;
591 }
592
593 static void
594 cb_include (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
595 const unsigned char *dir, const char *header, int angle_brackets,
596 const cpp_token **comments)
597 {
598 maybe_print_line (line);
599 if (angle_brackets)
600 fprintf (print.outf, "#%s <%s>", dir, header);
601 else
602 fprintf (print.outf, "#%s \"%s\"", dir, header);
603
604 if (comments != NULL)
605 {
606 while (*comments != NULL)
607 {
608 if ((*comments)->flags & PREV_WHITE)
609 putc (' ', print.outf);
610 cpp_output_token (*comments, print.outf);
611 ++comments;
612 }
613 }
614
615 putc ('\n', print.outf);
616 print.printed = false;
617 print.src_line++;
618 }
619
620 /* Callback called when -fworking-director and -E to emit working
621 directory in cpp output file. */
622
623 void
624 pp_dir_change (cpp_reader *pfile ATTRIBUTE_UNUSED, const char *dir)
625 {
626 size_t to_file_len = strlen (dir);
627 unsigned char *to_file_quoted =
628 (unsigned char *) alloca (to_file_len * 4 + 1);
629 unsigned char *p;
630
631 /* cpp_quote_string does not nul-terminate, so we have to do it ourselves. */
632 p = cpp_quote_string (to_file_quoted, (const unsigned char *) dir, to_file_len);
633 *p = '\0';
634 fprintf (print.outf, "# 1 \"%s//\"\n", to_file_quoted);
635 }
636
637 /* The file name, line number or system header flags have changed, as
638 described in MAP. */
639
640 void
641 pp_file_change (const line_map_ordinary *map)
642 {
643 const char *flags = "";
644
645 if (flag_no_line_commands)
646 return;
647
648 if (map != NULL)
649 {
650 input_location = map->start_location;
651 if (print.first_time)
652 {
653 /* Avoid printing foo.i when the main file is foo.c. */
654 if (!cpp_get_options (parse_in)->preprocessed)
655 print_line (map->start_location, flags);
656 print.first_time = 0;
657 }
658 else
659 {
660 /* Bring current file to correct line when entering a new file. */
661 if (map->reason == LC_ENTER)
662 {
663 const line_map_ordinary *from = INCLUDED_FROM (line_table, map);
664 maybe_print_line (LAST_SOURCE_LINE_LOCATION (from));
665 }
666 if (map->reason == LC_ENTER)
667 flags = " 1";
668 else if (map->reason == LC_LEAVE)
669 flags = " 2";
670 print_line (map->start_location, flags);
671 }
672 }
673 }
674
675 /* Copy a #pragma directive to the preprocessed output. */
676 static void
677 cb_def_pragma (cpp_reader *pfile, source_location line)
678 {
679 maybe_print_line (line);
680 fputs ("#pragma ", print.outf);
681 cpp_output_line (pfile, print.outf);
682 print.printed = false;
683 print.src_line++;
684 }
685
686 /* Dump out the hash table. */
687 static int
688 dump_macro (cpp_reader *pfile, cpp_hashnode *node, void *v ATTRIBUTE_UNUSED)
689 {
690 if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
691 {
692 fputs ("#define ", print.outf);
693 fputs ((const char *) cpp_macro_definition (pfile, node),
694 print.outf);
695 putc ('\n', print.outf);
696 print.printed = false;
697 print.src_line++;
698 }
699
700 return 1;
701 }
702
703 /* Load in the PCH file NAME, open on FD. It was originally searched for
704 by ORIG_NAME. Also, print out a #include command so that the PCH
705 file can be loaded when the preprocessed output is compiled. */
706
707 static void
708 cb_read_pch (cpp_reader *pfile, const char *name,
709 int fd, const char *orig_name ATTRIBUTE_UNUSED)
710 {
711 c_common_read_pch (pfile, name, fd, orig_name);
712
713 fprintf (print.outf, "#pragma GCC pch_preprocess \"%s\"\n", name);
714 print.src_line++;
715 }