1 /* Preprocess only, using cpplib.
2 Copyright (C) 1995-2014 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
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/>. */
21 #include "coretypes.h"
23 #include "../libcpp/internal.h"
25 #include "c-common.h" /* For flags. */
26 #include "c-pragma.h" /* For parse_in. */
28 /* Encapsulates state used to convert a stream of tokens into a text
32 FILE *outf
; /* Stream to write to. */
33 const cpp_token
*prev
; /* Previous token. */
34 const cpp_token
*source
; /* Source token for spacing. */
35 int src_line
; /* Line number currently being written. */
36 unsigned char printed
; /* Nonzero if something output at line. */
37 bool first_time
; /* pp_file_change hasn't been called yet. */
38 const char *src_file
; /* Current source file. */
39 bool prev_was_system_token
; /* True if the previous token was a
43 /* Defined and undefined macros being queued for output with -dU at
45 typedef struct macro_queue
47 struct macro_queue
*next
; /* Next macro in the list. */
48 char *macro
; /* The name of the macro if not
49 defined, the full definition if
52 static macro_queue
*define_queue
, *undef_queue
;
54 /* General output routines. */
55 static void scan_translation_unit (cpp_reader
*);
56 static void print_lines_directives_only (int, const void *, size_t);
57 static void scan_translation_unit_directives_only (cpp_reader
*);
58 static void scan_translation_unit_trad (cpp_reader
*);
59 static void account_for_newlines (const unsigned char *, size_t);
60 static int dump_macro (cpp_reader
*, cpp_hashnode
*, void *);
61 static void dump_queued_macros (cpp_reader
*);
63 static bool print_line_1 (source_location
, const char*, FILE *);
64 static bool print_line (source_location
, const char *);
65 static bool maybe_print_line_1 (source_location
, FILE *);
66 static bool maybe_print_line (source_location
);
67 static bool do_line_change (cpp_reader
*, const cpp_token
*,
68 source_location
, int);
70 /* Callback routines for the parser. Most of these are active only
72 static void cb_line_change (cpp_reader
*, const cpp_token
*, int);
73 static void cb_define (cpp_reader
*, source_location
, cpp_hashnode
*);
74 static void cb_undef (cpp_reader
*, source_location
, cpp_hashnode
*);
75 static void cb_used_define (cpp_reader
*, source_location
, cpp_hashnode
*);
76 static void cb_used_undef (cpp_reader
*, source_location
, cpp_hashnode
*);
77 static void cb_include (cpp_reader
*, source_location
, const unsigned char *,
78 const char *, int, const cpp_token
**);
79 static void cb_ident (cpp_reader
*, source_location
, const cpp_string
*);
80 static void cb_def_pragma (cpp_reader
*, source_location
);
81 static void cb_read_pch (cpp_reader
*pfile
, const char *name
,
82 int fd
, const char *orig_name
);
84 /* Preprocess and output. */
86 preprocess_file (cpp_reader
*pfile
)
88 /* A successful cpp_read_main_file guarantees that we can call
89 cpp_scan_nooutput or cpp_get_token next. */
90 if (flag_no_output
&& pfile
->buffer
)
92 /* Scan -included buffers, then the main file. */
93 while (pfile
->buffer
->prev
)
94 cpp_scan_nooutput (pfile
);
95 cpp_scan_nooutput (pfile
);
97 else if (cpp_get_options (pfile
)->traditional
)
98 scan_translation_unit_trad (pfile
);
99 else if (cpp_get_options (pfile
)->directives_only
100 && !cpp_get_options (pfile
)->preprocessed
)
101 scan_translation_unit_directives_only (pfile
);
103 scan_translation_unit (pfile
);
105 /* -dM command line option. Should this be elsewhere? */
106 if (flag_dump_macros
== 'M')
107 cpp_forall_identifiers (pfile
, dump_macro
, NULL
);
109 /* Flush any pending output. */
111 putc ('\n', print
.outf
);
114 /* Set up the callbacks as appropriate. */
116 init_pp_output (FILE *out_stream
)
118 cpp_callbacks
*cb
= cpp_get_callbacks (parse_in
);
122 cb
->line_change
= cb_line_change
;
123 /* Don't emit #pragma or #ident directives if we are processing
124 assembly language; the assembler may choke on them. */
125 if (cpp_get_options (parse_in
)->lang
!= CLK_ASM
)
127 cb
->ident
= cb_ident
;
128 cb
->def_pragma
= cb_def_pragma
;
132 if (flag_dump_includes
)
133 cb
->include
= cb_include
;
135 if (flag_pch_preprocess
)
137 cb
->valid_pch
= c_common_valid_pch
;
138 cb
->read_pch
= cb_read_pch
;
141 if (flag_dump_macros
== 'N' || flag_dump_macros
== 'D')
143 cb
->define
= cb_define
;
144 cb
->undef
= cb_undef
;
147 if (flag_dump_macros
== 'U')
149 cb
->before_define
= dump_queued_macros
;
150 cb
->used_define
= cb_used_define
;
151 cb
->used_undef
= cb_used_undef
;
154 cb
->has_attribute
= c_common_has_attribute
;
156 /* Initialize the print structure. */
160 print
.outf
= out_stream
;
161 print
.first_time
= 1;
163 print
.prev_was_system_token
= false;
166 /* Writes out the preprocessed file, handling spacing and paste
169 scan_translation_unit (cpp_reader
*pfile
)
171 bool avoid_paste
= false;
172 bool do_line_adjustments
173 = cpp_get_options (parse_in
)->lang
!= CLK_ASM
174 && !flag_no_line_commands
;
175 bool in_pragma
= false;
176 bool line_marker_emitted
= false;
182 const cpp_token
*token
= cpp_get_token_with_location (pfile
, &loc
);
184 if (token
->type
== CPP_PADDING
)
187 if (print
.source
== NULL
188 || (!(print
.source
->flags
& PREV_WHITE
)
189 && token
->val
.source
== NULL
))
190 print
.source
= token
->val
.source
;
194 if (token
->type
== CPP_EOF
)
197 /* Subtle logic to output a space if and only if necessary. */
200 int src_line
= LOCATION_LINE (loc
);
202 if (print
.source
== NULL
)
203 print
.source
= token
;
205 if (src_line
!= print
.src_line
206 && do_line_adjustments
209 line_marker_emitted
= do_line_change (pfile
, token
, loc
, false);
210 putc (' ', print
.outf
);
212 else if (print
.source
->flags
& PREV_WHITE
214 && cpp_avoid_paste (pfile
, print
.prev
, token
))
215 || (print
.prev
== NULL
&& token
->type
== CPP_HASH
))
216 putc (' ', print
.outf
);
218 else if (token
->flags
& PREV_WHITE
)
220 int src_line
= LOCATION_LINE (loc
);
222 if (src_line
!= print
.src_line
223 && do_line_adjustments
225 line_marker_emitted
= do_line_change (pfile
, token
, loc
, false);
226 putc (' ', print
.outf
);
232 if (token
->type
== CPP_PRAGMA
)
237 line_marker_emitted
= maybe_print_line (token
->src_loc
);
238 fputs ("#pragma ", print
.outf
);
239 c_pp_lookup_pragma (token
->val
.pragma
, &space
, &name
);
241 fprintf (print
.outf
, "%s %s", space
, name
);
243 fprintf (print
.outf
, "%s", name
);
247 else if (token
->type
== CPP_PRAGMA_EOL
)
249 maybe_print_line (token
->src_loc
);
254 if (cpp_get_options (parse_in
)->debug
)
255 linemap_dump_location (line_table
, token
->src_loc
,
258 if (do_line_adjustments
260 && !line_marker_emitted
261 && print
.prev_was_system_token
!= !!in_system_header_at(loc
)
262 && !is_location_from_builtin_token (loc
))
263 /* The system-ness of this token is different from the one
264 of the previous token. Let's emit a line change to
265 mark the new system-ness before we emit the token. */
267 do_line_change (pfile
, token
, loc
, false);
268 print
.prev_was_system_token
= !!in_system_header_at(loc
);
270 cpp_output_token (token
, print
.outf
);
271 line_marker_emitted
= false;
274 /* CPP_COMMENT tokens and raw-string literal tokens can
275 have embedded new-line characters. Rather than enumerating
276 all the possible token types just check if token uses
277 val.str union member. */
278 if (cpp_token_val_index (token
) == CPP_TOKEN_FLD_STR
)
279 account_for_newlines (token
->val
.str
.text
, token
->val
.str
.len
);
284 print_lines_directives_only (int lines
, const void *buf
, size_t size
)
286 print
.src_line
+= lines
;
287 fwrite (buf
, 1, size
, print
.outf
);
290 /* Writes out the preprocessed file, handling spacing and paste
293 scan_translation_unit_directives_only (cpp_reader
*pfile
)
295 struct _cpp_dir_only_callbacks cb
;
297 cb
.print_lines
= print_lines_directives_only
;
298 cb
.maybe_print_line
= (void (*) (source_location
)) maybe_print_line
;
300 _cpp_preprocess_dir_only (pfile
, &cb
);
303 /* Adjust print.src_line for newlines embedded in output. */
305 account_for_newlines (const unsigned char *str
, size_t len
)
312 /* Writes out a traditionally preprocessed file. */
314 scan_translation_unit_trad (cpp_reader
*pfile
)
316 while (_cpp_read_logical_line_trad (pfile
))
318 size_t len
= pfile
->out
.cur
- pfile
->out
.base
;
319 maybe_print_line (pfile
->out
.first_line
);
320 fwrite (pfile
->out
.base
, 1, len
, print
.outf
);
322 if (!CPP_OPTION (pfile
, discard_comments
))
323 account_for_newlines (pfile
->out
.base
, len
);
327 /* If the token read on logical line LINE needs to be output on a
328 different line to the current one, output the required newlines or
329 a line marker. If a line marker was emitted, return TRUE otherwise
333 maybe_print_line_1 (source_location src_loc
, FILE *stream
)
335 bool emitted_line_marker
= false;
336 int src_line
= LOCATION_LINE (src_loc
);
337 const char *src_file
= LOCATION_FILE (src_loc
);
339 /* End the previous line of text. */
347 if (!flag_no_line_commands
348 && src_line
>= print
.src_line
349 && src_line
< print
.src_line
+ 8
350 && strcmp (src_file
, print
.src_file
) == 0)
352 while (src_line
> print
.src_line
)
359 emitted_line_marker
= print_line_1 (src_loc
, "", stream
);
361 return emitted_line_marker
;
364 /* If the token read on logical line LINE needs to be output on a
365 different line to the current one, output the required newlines or
366 a line marker. If a line marker was emitted, return TRUE otherwise
370 maybe_print_line (source_location src_loc
)
372 if (cpp_get_options (parse_in
)->debug
)
373 linemap_dump_location (line_table
, src_loc
,
375 return maybe_print_line_1 (src_loc
, print
.outf
);
378 /* Output a line marker for logical line LINE. Special flags are "1"
379 or "2" indicating entering or leaving a file. If the line marker
380 was effectively emitted, return TRUE otherwise return FALSE. */
383 print_line_1 (source_location src_loc
, const char *special_flags
, FILE *stream
)
385 bool emitted_line_marker
= false;
387 /* End any previous line of text. */
392 if (!flag_no_line_commands
)
394 const char *file_path
= LOCATION_FILE (src_loc
);
396 size_t to_file_len
= strlen (file_path
);
397 unsigned char *to_file_quoted
=
398 (unsigned char *) alloca (to_file_len
* 4 + 1);
401 print
.src_line
= LOCATION_LINE (src_loc
);
402 print
.src_file
= file_path
;
404 /* cpp_quote_string does not nul-terminate, so we have to do it
406 p
= cpp_quote_string (to_file_quoted
,
407 (const unsigned char *) file_path
,
410 fprintf (stream
, "# %u \"%s\"%s",
411 print
.src_line
== 0 ? 1 : print
.src_line
,
412 to_file_quoted
, special_flags
);
414 sysp
= in_system_header_at (src_loc
);
416 fputs (" 3 4", stream
);
418 fputs (" 3", stream
);
421 emitted_line_marker
= true;
424 return emitted_line_marker
;
427 /* Output a line marker for logical line LINE. Special flags are "1"
428 or "2" indicating entering or leaving a file. Return TRUE if a
429 line marker was effectively emitted, FALSE otherwise. */
432 print_line (source_location src_loc
, const char *special_flags
)
434 if (cpp_get_options (parse_in
)->debug
)
435 linemap_dump_location (line_table
, src_loc
,
437 return print_line_1 (src_loc
, special_flags
, print
.outf
);
440 /* Helper function for cb_line_change and scan_translation_unit.
441 Return TRUE if a line marker is emitted, FALSE otherwise. */
443 do_line_change (cpp_reader
*pfile
, const cpp_token
*token
,
444 source_location src_loc
, int parsing_args
)
446 bool emitted_line_marker
= false;
447 if (define_queue
|| undef_queue
)
448 dump_queued_macros (pfile
);
450 if (token
->type
== CPP_EOF
|| parsing_args
)
453 emitted_line_marker
= maybe_print_line (src_loc
);
457 /* Supply enough spaces to put this token in its original column,
458 one space per column greater than 2, since scan_translation_unit
459 will provide a space if PREV_WHITE. Don't bother trying to
460 reconstruct tabs; we can't get it right in general, and nothing
461 ought to care. Some things do care; the fault lies with them. */
462 if (!CPP_OPTION (pfile
, traditional
))
464 int spaces
= LOCATION_COLUMN (src_loc
) - 2;
467 while (-- spaces
>= 0)
468 putc (' ', print
.outf
);
471 return emitted_line_marker
;
474 /* Called when a line of output is started. TOKEN is the first token
475 of the line, and at end of file will be CPP_EOF. */
477 cb_line_change (cpp_reader
*pfile
, const cpp_token
*token
,
480 do_line_change (pfile
, token
, token
->src_loc
, parsing_args
);
484 cb_ident (cpp_reader
*pfile ATTRIBUTE_UNUSED
, source_location line
,
485 const cpp_string
*str
)
487 maybe_print_line (line
);
488 fprintf (print
.outf
, "#ident %s\n", str
->text
);
493 cb_define (cpp_reader
*pfile
, source_location line
, cpp_hashnode
*node
)
495 const struct line_map
*map
;
497 maybe_print_line (line
);
498 fputs ("#define ", print
.outf
);
500 /* 'D' is whole definition; 'N' is name only. */
501 if (flag_dump_macros
== 'D')
502 fputs ((const char *) cpp_macro_definition (pfile
, node
),
505 fputs ((const char *) NODE_NAME (node
), print
.outf
);
507 putc ('\n', print
.outf
);
508 linemap_resolve_location (line_table
, line
,
509 LRK_MACRO_DEFINITION_LOCATION
,
511 if (LINEMAP_LINE (map
) != 0)
516 cb_undef (cpp_reader
*pfile ATTRIBUTE_UNUSED
, source_location line
,
519 maybe_print_line (line
);
520 fprintf (print
.outf
, "#undef %s\n", NODE_NAME (node
));
525 cb_used_define (cpp_reader
*pfile
, source_location line ATTRIBUTE_UNUSED
,
529 if (node
->flags
& NODE_BUILTIN
)
531 q
= XNEW (macro_queue
);
532 q
->macro
= xstrdup ((const char *) cpp_macro_definition (pfile
, node
));
533 q
->next
= define_queue
;
538 cb_used_undef (cpp_reader
*pfile ATTRIBUTE_UNUSED
,
539 source_location line ATTRIBUTE_UNUSED
,
543 q
= XNEW (macro_queue
);
544 q
->macro
= xstrdup ((const char *) NODE_NAME (node
));
545 q
->next
= undef_queue
;
550 dump_queued_macros (cpp_reader
*pfile ATTRIBUTE_UNUSED
)
554 /* End the previous line of text. */
557 putc ('\n', print
.outf
);
562 for (q
= define_queue
; q
;)
565 fputs ("#define ", print
.outf
);
566 fputs (q
->macro
, print
.outf
);
567 putc ('\n', print
.outf
);
575 for (q
= undef_queue
; q
;)
578 fprintf (print
.outf
, "#undef %s\n", q
->macro
);
589 cb_include (cpp_reader
*pfile ATTRIBUTE_UNUSED
, source_location line
,
590 const unsigned char *dir
, const char *header
, int angle_brackets
,
591 const cpp_token
**comments
)
593 maybe_print_line (line
);
595 fprintf (print
.outf
, "#%s <%s>", dir
, header
);
597 fprintf (print
.outf
, "#%s \"%s\"", dir
, header
);
599 if (comments
!= NULL
)
601 while (*comments
!= NULL
)
603 if ((*comments
)->flags
& PREV_WHITE
)
604 putc (' ', print
.outf
);
605 cpp_output_token (*comments
, print
.outf
);
610 putc ('\n', print
.outf
);
614 /* Callback called when -fworking-director and -E to emit working
615 directory in cpp output file. */
618 pp_dir_change (cpp_reader
*pfile ATTRIBUTE_UNUSED
, const char *dir
)
620 size_t to_file_len
= strlen (dir
);
621 unsigned char *to_file_quoted
=
622 (unsigned char *) alloca (to_file_len
* 4 + 1);
625 /* cpp_quote_string does not nul-terminate, so we have to do it ourselves. */
626 p
= cpp_quote_string (to_file_quoted
, (const unsigned char *) dir
, to_file_len
);
628 fprintf (print
.outf
, "# 1 \"%s//\"\n", to_file_quoted
);
631 /* The file name, line number or system header flags have changed, as
635 pp_file_change (const struct line_map
*map
)
637 const char *flags
= "";
639 if (flag_no_line_commands
)
644 input_location
= map
->start_location
;
645 if (print
.first_time
)
647 /* Avoid printing foo.i when the main file is foo.c. */
648 if (!cpp_get_options (parse_in
)->preprocessed
)
649 print_line (map
->start_location
, flags
);
650 print
.first_time
= 0;
654 /* Bring current file to correct line when entering a new file. */
655 if (map
->reason
== LC_ENTER
)
657 const struct line_map
*from
= INCLUDED_FROM (line_table
, map
);
658 maybe_print_line (LAST_SOURCE_LINE_LOCATION (from
));
660 if (map
->reason
== LC_ENTER
)
662 else if (map
->reason
== LC_LEAVE
)
664 print_line (map
->start_location
, flags
);
669 /* Copy a #pragma directive to the preprocessed output. */
671 cb_def_pragma (cpp_reader
*pfile
, source_location line
)
673 maybe_print_line (line
);
674 fputs ("#pragma ", print
.outf
);
675 cpp_output_line (pfile
, print
.outf
);
679 /* Dump out the hash table. */
681 dump_macro (cpp_reader
*pfile
, cpp_hashnode
*node
, void *v ATTRIBUTE_UNUSED
)
683 if (node
->type
== NT_MACRO
&& !(node
->flags
& NODE_BUILTIN
))
685 fputs ("#define ", print
.outf
);
686 fputs ((const char *) cpp_macro_definition (pfile
, node
),
688 putc ('\n', print
.outf
);
695 /* Load in the PCH file NAME, open on FD. It was originally searched for
696 by ORIG_NAME. Also, print out a #include command so that the PCH
697 file can be loaded when the preprocessed output is compiled. */
700 cb_read_pch (cpp_reader
*pfile
, const char *name
,
701 int fd
, const char *orig_name ATTRIBUTE_UNUSED
)
703 c_common_read_pch (pfile
, name
, fd
, orig_name
);
705 fprintf (print
.outf
, "#pragma GCC pch_preprocess \"%s\"\n", name
);