1 /* Preprocess only, using cpplib.
2 Copyright (C) 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007,
3 2008, 2009, 2010 Free Software Foundation, Inc.
4 Written by Per Bothner, 1994-95.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 3, or (at your option) any
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; see the file COPYING3. If not see
18 <http://www.gnu.org/licenses/>. */
22 #include "coretypes.h"
24 #include "../libcpp/internal.h"
26 #include "c-common.h" /* For flags. */
27 #include "c-pragma.h" /* For parse_in. */
29 /* Encapsulates state used to convert a stream of tokens into a text
33 FILE *outf; /* Stream to write to. */
34 const cpp_token *prev; /* Previous token. */
35 const cpp_token *source; /* Source token for spacing. */
36 int src_line; /* Line number currently being written. */
37 unsigned char printed; /* Nonzero if something output at line. */
38 bool first_time; /* pp_file_change hasn't been called yet. */
39 const char *src_file; /* Current source file. */
42 /* Defined and undefined macros being queued for output with -dU at
44 typedef 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
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 void print_line (source_location, const char *);
63 static void maybe_print_line (source_location);
64 static void do_line_change (cpp_reader *, const cpp_token *,
65 source_location, int);
67 /* Callback routines for the parser. Most of these are active only
69 static void cb_line_change (cpp_reader *, const cpp_token *, int);
70 static void cb_define (cpp_reader *, source_location, cpp_hashnode *);
71 static void cb_undef (cpp_reader *, source_location, cpp_hashnode *);
72 static void cb_used_define (cpp_reader *, source_location, cpp_hashnode *);
73 static void cb_used_undef (cpp_reader *, source_location, cpp_hashnode *);
74 static void cb_include (cpp_reader *, source_location, const unsigned char *,
75 const char *, int, const cpp_token **);
76 static void cb_ident (cpp_reader *, source_location, const cpp_string *);
77 static void cb_def_pragma (cpp_reader *, source_location);
78 static void cb_read_pch (cpp_reader *pfile, const char *name,
79 int fd, const char *orig_name);
81 /* Preprocess and output. */
83 preprocess_file (cpp_reader *pfile)
85 /* A successful cpp_read_main_file guarantees that we can call
86 cpp_scan_nooutput or cpp_get_token next. */
89 /* Scan -included buffers, then the main file. */
90 while (pfile->buffer->prev)
91 cpp_scan_nooutput (pfile);
92 cpp_scan_nooutput (pfile);
94 else if (cpp_get_options (pfile)->traditional)
95 scan_translation_unit_trad (pfile);
96 else if (cpp_get_options (pfile)->directives_only
97 && !cpp_get_options (pfile)->preprocessed)
98 scan_translation_unit_directives_only (pfile);
100 scan_translation_unit (pfile);
102 /* -dM command line option. Should this be elsewhere? */
103 if (flag_dump_macros == 'M')
104 cpp_forall_identifiers (pfile, dump_macro, NULL);
106 /* Flush any pending output. */
108 putc ('\n', print.outf);
111 /* Set up the callbacks as appropriate. */
113 init_pp_output (FILE *out_stream)
115 cpp_callbacks *cb = cpp_get_callbacks (parse_in);
119 cb->line_change = cb_line_change;
120 /* Don't emit #pragma or #ident directives if we are processing
121 assembly language; the assembler may choke on them. */
122 if (cpp_get_options (parse_in)->lang != CLK_ASM)
124 cb->ident = cb_ident;
125 cb->def_pragma = cb_def_pragma;
129 if (flag_dump_includes)
130 cb->include = cb_include;
132 if (flag_pch_preprocess)
134 cb->valid_pch = c_common_valid_pch;
135 cb->read_pch = cb_read_pch;
138 if (flag_dump_macros == 'N' || flag_dump_macros == 'D')
140 cb->define = cb_define;
141 cb->undef = cb_undef;
144 if (flag_dump_macros == 'U')
146 cb->before_define = dump_queued_macros;
147 cb->used_define = cb_used_define;
148 cb->used_undef = cb_used_undef;
151 /* Initialize the print structure. */
155 print.outf = out_stream;
156 print.first_time = 1;
160 /* Writes out the preprocessed file, handling spacing and paste
163 scan_translation_unit (cpp_reader *pfile)
165 bool avoid_paste = false;
166 bool do_line_adjustments
167 = cpp_get_options (parse_in)->lang != CLK_ASM
168 && !flag_no_line_commands;
169 bool in_pragma = false;
175 const cpp_token *token = cpp_get_token_with_location (pfile, &loc);
177 if (token->type == CPP_PADDING)
180 if (print.source == NULL
181 || (!(print.source->flags & PREV_WHITE)
182 && token->val.source == NULL))
183 print.source = token->val.source;
187 if (token->type == CPP_EOF)
190 /* Subtle logic to output a space if and only if necessary. */
193 int src_line = LOCATION_LINE (loc);
195 if (print.source == NULL)
196 print.source = token;
198 if (src_line != print.src_line
199 && do_line_adjustments
202 do_line_change (pfile, token, loc, false);
203 putc (' ', print.outf);
205 else if (print.source->flags & PREV_WHITE
207 && cpp_avoid_paste (pfile, print.prev, token))
208 || (print.prev == NULL && token->type == CPP_HASH))
209 putc (' ', print.outf);
211 else if (token->flags & PREV_WHITE)
213 int src_line = LOCATION_LINE (loc);
215 if (src_line != print.src_line
216 && do_line_adjustments
218 do_line_change (pfile, token, loc, false);
219 putc (' ', print.outf);
225 if (token->type == CPP_PRAGMA)
230 maybe_print_line (token->src_loc);
231 fputs ("#pragma ", print.outf);
232 c_pp_lookup_pragma (token->val.pragma, &space, &name);
234 fprintf (print.outf, "%s %s", space, name);
236 fprintf (print.outf, "%s", name);
240 else if (token->type == CPP_PRAGMA_EOL)
242 maybe_print_line (token->src_loc);
246 cpp_output_token (token, print.outf);
248 if (token->type == CPP_COMMENT)
249 account_for_newlines (token->val.str.text, token->val.str.len);
254 print_lines_directives_only (int lines, const void *buf, size_t size)
256 print.src_line += lines;
257 fwrite (buf, 1, size, print.outf);
260 /* Writes out the preprocessed file, handling spacing and paste
263 scan_translation_unit_directives_only (cpp_reader *pfile)
265 struct _cpp_dir_only_callbacks cb;
267 cb.print_lines = print_lines_directives_only;
268 cb.maybe_print_line = maybe_print_line;
270 _cpp_preprocess_dir_only (pfile, &cb);
273 /* Adjust print.src_line for newlines embedded in output. */
275 account_for_newlines (const unsigned char *str, size_t len)
282 /* Writes out a traditionally preprocessed file. */
284 scan_translation_unit_trad (cpp_reader *pfile)
286 while (_cpp_read_logical_line_trad (pfile))
288 size_t len = pfile->out.cur - pfile->out.base;
289 maybe_print_line (pfile->out.first_line);
290 fwrite (pfile->out.base, 1, len, print.outf);
292 if (!CPP_OPTION (pfile, discard_comments))
293 account_for_newlines (pfile->out.base, len);
297 /* If the token read on logical line LINE needs to be output on a
298 different line to the current one, output the required newlines or
299 a line marker, and return 1. Otherwise return 0. */
301 maybe_print_line (source_location src_loc)
303 int src_line = LOCATION_LINE (src_loc);
304 const char *src_file = LOCATION_FILE (src_loc);
306 /* End the previous line of text. */
309 putc ('\n', print.outf);
314 if (!flag_no_line_commands
315 && src_line >= print.src_line
316 && src_line < print.src_line + 8
317 && strcmp (src_file, print.src_file) == 0)
319 while (src_line > print.src_line)
321 putc ('\n', print.outf);
326 print_line (src_loc, "");
329 /* Output a line marker for logical line LINE. Special flags are "1"
330 or "2" indicating entering or leaving a file. */
332 print_line (source_location src_loc, const char *special_flags)
334 /* End any previous line of text. */
336 putc ('\n', print.outf);
339 if (!flag_no_line_commands)
341 const char *file_path = LOCATION_FILE (src_loc);
343 size_t to_file_len = strlen (file_path);
344 unsigned char *to_file_quoted =
345 (unsigned char *) alloca (to_file_len * 4 + 1);
348 print.src_line = LOCATION_LINE (src_loc);
349 print.src_file = file_path;
351 /* cpp_quote_string does not nul-terminate, so we have to do it
353 p = cpp_quote_string (to_file_quoted,
354 (const unsigned char *) file_path,
357 fprintf (print.outf, "# %u \"%s\"%s",
358 print.src_line == 0 ? 1 : print.src_line,
359 to_file_quoted, special_flags);
361 sysp = in_system_header_at (src_loc);
363 fputs (" 3 4", print.outf);
365 fputs (" 3", print.outf);
367 putc ('\n', print.outf);
371 /* Helper function for cb_line_change and scan_translation_unit. */
373 do_line_change (cpp_reader *pfile, const cpp_token *token,
374 source_location src_loc, int parsing_args)
376 if (define_queue || undef_queue)
377 dump_queued_macros (pfile);
379 if (token->type == CPP_EOF || parsing_args)
382 maybe_print_line (src_loc);
386 /* Supply enough spaces to put this token in its original column,
387 one space per column greater than 2, since scan_translation_unit
388 will provide a space if PREV_WHITE. Don't bother trying to
389 reconstruct tabs; we can't get it right in general, and nothing
390 ought to care. Some things do care; the fault lies with them. */
391 if (!CPP_OPTION (pfile, traditional))
393 int spaces = LOCATION_COLUMN (src_loc) - 2;
396 while (-- spaces >= 0)
397 putc (' ', print.outf);
401 /* Called when a line of output is started. TOKEN is the first token
402 of the line, and at end of file will be CPP_EOF. */
404 cb_line_change (cpp_reader *pfile, const cpp_token *token,
407 do_line_change (pfile, token, token->src_loc, parsing_args);
411 cb_ident (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
412 const cpp_string *str)
414 maybe_print_line (line);
415 fprintf (print.outf, "#ident %s\n", str->text);
420 cb_define (cpp_reader *pfile, source_location line, cpp_hashnode *node)
422 const struct line_map *map;
424 maybe_print_line (line);
425 fputs ("#define ", print.outf);
427 /* 'D' is whole definition; 'N' is name only. */
428 if (flag_dump_macros == 'D')
429 fputs ((const char *) cpp_macro_definition (pfile, node),
432 fputs ((const char *) NODE_NAME (node), print.outf);
434 putc ('\n', print.outf);
435 linemap_resolve_location (line_table, line,
436 LRK_MACRO_DEFINITION_LOCATION,
438 if (LINEMAP_LINE (map) != 0)
443 cb_undef (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
446 maybe_print_line (line);
447 fprintf (print.outf, "#undef %s\n", NODE_NAME (node));
452 cb_used_define (cpp_reader *pfile, source_location line ATTRIBUTE_UNUSED,
456 if (node->flags & NODE_BUILTIN)
458 q = XNEW (macro_queue);
459 q->macro = xstrdup ((const char *) cpp_macro_definition (pfile, node));
460 q->next = define_queue;
465 cb_used_undef (cpp_reader *pfile ATTRIBUTE_UNUSED,
466 source_location line ATTRIBUTE_UNUSED,
470 q = XNEW (macro_queue);
471 q->macro = xstrdup ((const char *) NODE_NAME (node));
472 q->next = undef_queue;
477 dump_queued_macros (cpp_reader *pfile ATTRIBUTE_UNUSED)
481 /* End the previous line of text. */
484 putc ('\n', print.outf);
489 for (q = define_queue; q;)
492 fputs ("#define ", print.outf);
493 fputs (q->macro, print.outf);
494 putc ('\n', print.outf);
502 for (q = undef_queue; q;)
505 fprintf (print.outf, "#undef %s\n", q->macro);
516 cb_include (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
517 const unsigned char *dir, const char *header, int angle_brackets,
518 const cpp_token **comments)
520 maybe_print_line (line);
522 fprintf (print.outf, "#%s <%s>", dir, header);
524 fprintf (print.outf, "#%s \"%s\"", dir, header);
526 if (comments != NULL)
528 while (*comments != NULL)
530 if ((*comments)->flags & PREV_WHITE)
531 putc (' ', print.outf);
532 cpp_output_token (*comments, print.outf);
537 putc ('\n', print.outf);
541 /* Callback called when -fworking-director and -E to emit working
542 directory in cpp output file. */
545 pp_dir_change (cpp_reader *pfile ATTRIBUTE_UNUSED, const char *dir)
547 size_t to_file_len = strlen (dir);
548 unsigned char *to_file_quoted =
549 (unsigned char *) alloca (to_file_len * 4 + 1);
552 /* cpp_quote_string does not nul-terminate, so we have to do it ourselves. */
553 p = cpp_quote_string (to_file_quoted, (const unsigned char *) dir, to_file_len);
555 fprintf (print.outf, "# 1 \"%s//\"\n", to_file_quoted);
558 /* The file name, line number or system header flags have changed, as
562 pp_file_change (const struct line_map *map)
564 const char *flags = "";
566 if (flag_no_line_commands)
571 input_location = map->start_location;
572 if (print.first_time)
574 /* Avoid printing foo.i when the main file is foo.c. */
575 if (!cpp_get_options (parse_in)->preprocessed)
576 print_line (map->start_location, flags);
577 print.first_time = 0;
581 /* Bring current file to correct line when entering a new file. */
582 if (map->reason == LC_ENTER)
584 const struct line_map *from = INCLUDED_FROM (line_table, map);
585 maybe_print_line (LAST_SOURCE_LINE_LOCATION (from));
587 if (map->reason == LC_ENTER)
589 else if (map->reason == LC_LEAVE)
591 print_line (map->start_location, flags);
596 /* Copy a #pragma directive to the preprocessed output. */
598 cb_def_pragma (cpp_reader *pfile, source_location line)
600 maybe_print_line (line);
601 fputs ("#pragma ", print.outf);
602 cpp_output_line (pfile, print.outf);
606 /* Dump out the hash table. */
608 dump_macro (cpp_reader *pfile, cpp_hashnode *node, void *v ATTRIBUTE_UNUSED)
610 if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
612 fputs ("#define ", print.outf);
613 fputs ((const char *) cpp_macro_definition (pfile, node),
615 putc ('\n', print.outf);
622 /* Load in the PCH file NAME, open on FD. It was originally searched for
623 by ORIG_NAME. Also, print out a #include command so that the PCH
624 file can be loaded when the preprocessed output is compiled. */
627 cb_read_pch (cpp_reader *pfile, const char *name,
628 int fd, const char *orig_name ATTRIBUTE_UNUSED)
630 c_common_read_pch (pfile, name, fd, orig_name);
632 fprintf (print.outf, "#pragma GCC pch_preprocess \"%s\"\n", name);