1 /* Preprocess only, using cpplib.
2 Copyright (C) 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 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 2, 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; if not, write to the Free Software
18 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
22 #include "coretypes.h"
27 #include "c-common.h" /* For flags. */
28 #include "c-pragma.h" /* For parse_in. */
30 /* Encapsulates state used to convert a stream of tokens into a text
34 FILE *outf
; /* Stream to write to. */
35 const struct line_map
*map
; /* Logical to physical line mappings. */
36 const cpp_token
*prev
; /* Previous token. */
37 const cpp_token
*source
; /* Source token for spacing. */
38 unsigned int line
; /* Line currently being written. */
39 unsigned char printed
; /* Nonzero if something output at line. */
42 /* General output routines. */
43 static void scan_translation_unit
PARAMS ((cpp_reader
*));
44 static void scan_translation_unit_trad
PARAMS ((cpp_reader
*));
45 static void account_for_newlines
PARAMS ((const uchar
*, size_t));
46 static int dump_macro
PARAMS ((cpp_reader
*, cpp_hashnode
*, void *));
48 static void print_line
PARAMS ((const struct line_map
*, unsigned int,
50 static void maybe_print_line
PARAMS ((const struct line_map
*, unsigned int));
52 /* Callback routines for the parser. Most of these are active only
54 static void cb_line_change
PARAMS ((cpp_reader
*, const cpp_token
*, int));
55 static void cb_define
PARAMS ((cpp_reader
*, unsigned int, cpp_hashnode
*));
56 static void cb_undef
PARAMS ((cpp_reader
*, unsigned int, cpp_hashnode
*));
57 static void cb_include
PARAMS ((cpp_reader
*, unsigned int,
58 const unsigned char *, const cpp_token
*));
59 static void cb_ident
PARAMS ((cpp_reader
*, unsigned int,
61 static void cb_def_pragma
PARAMS ((cpp_reader
*, unsigned int));
63 /* Preprocess and output. */
65 preprocess_file (pfile
)
68 /* A successful cpp_read_main_file guarantees that we can call
69 cpp_scan_nooutput or cpp_get_token next. */
72 /* Scan -included buffers, then the main file. */
73 while (pfile
->buffer
->prev
)
74 cpp_scan_nooutput (pfile
);
75 cpp_scan_nooutput (pfile
);
77 else if (cpp_get_options (pfile
)->traditional
)
78 scan_translation_unit_trad (pfile
);
80 scan_translation_unit (pfile
);
82 /* -dM command line option. Should this be elsewhere? */
83 if (flag_dump_macros
== 'M')
84 cpp_forall_identifiers (pfile
, dump_macro
, NULL
);
86 /* Flush any pending output. */
88 putc ('\n', print
.outf
);
91 /* Set up the callbacks as appropriate. */
93 init_pp_output (out_stream
)
96 cpp_callbacks
*cb
= cpp_get_callbacks (parse_in
);
100 cb
->line_change
= cb_line_change
;
101 /* Don't emit #pragma or #ident directives if we are processing
102 assembly language; the assembler may choke on them. */
103 if (cpp_get_options (parse_in
)->lang
!= CLK_ASM
)
105 cb
->ident
= cb_ident
;
106 cb
->def_pragma
= cb_def_pragma
;
110 if (flag_dump_includes
)
111 cb
->include
= cb_include
;
113 if (flag_dump_macros
== 'N' || flag_dump_macros
== 'D')
115 cb
->define
= cb_define
;
116 cb
->undef
= cb_undef
;
119 /* Initialize the print structure. Setting print.line to -1 here is
120 a trick to guarantee that the first token of the file will cause
121 a linemarker to be output by maybe_print_line. */
122 print
.line
= (unsigned int) -1;
126 print
.outf
= out_stream
;
129 /* Writes out the preprocessed file, handling spacing and paste
132 scan_translation_unit (pfile
)
135 bool avoid_paste
= false;
140 const cpp_token
*token
= cpp_get_token (pfile
);
142 if (token
->type
== CPP_PADDING
)
145 if (print
.source
== NULL
146 || (!(print
.source
->flags
& PREV_WHITE
)
147 && token
->val
.source
== NULL
))
148 print
.source
= token
->val
.source
;
152 if (token
->type
== CPP_EOF
)
155 /* Subtle logic to output a space if and only if necessary. */
158 if (print
.source
== NULL
)
159 print
.source
= token
;
160 if (print
.source
->flags
& PREV_WHITE
162 && cpp_avoid_paste (pfile
, print
.prev
, token
))
163 || (print
.prev
== NULL
&& token
->type
== CPP_HASH
))
164 putc (' ', print
.outf
);
166 else if (token
->flags
& PREV_WHITE
)
167 putc (' ', print
.outf
);
172 cpp_output_token (token
, print
.outf
);
174 if (token
->type
== CPP_COMMENT
)
175 account_for_newlines (token
->val
.str
.text
, token
->val
.str
.len
);
179 /* Adjust print.line for newlines embedded in output. */
181 account_for_newlines (str
, len
)
190 /* Writes out a traditionally preprocessed file. */
192 scan_translation_unit_trad (pfile
)
195 while (_cpp_read_logical_line_trad (pfile
))
197 size_t len
= pfile
->out
.cur
- pfile
->out
.base
;
198 maybe_print_line (print
.map
, pfile
->out
.first_line
);
199 fwrite (pfile
->out
.base
, 1, len
, print
.outf
);
201 if (!CPP_OPTION (pfile
, discard_comments
))
202 account_for_newlines (pfile
->out
.base
, len
);
206 /* If the token read on logical line LINE needs to be output on a
207 different line to the current one, output the required newlines or
208 a line marker, and return 1. Otherwise return 0. */
210 maybe_print_line (map
, line
)
211 const struct line_map
*map
;
214 /* End the previous line of text. */
217 putc ('\n', print
.outf
);
222 if (line
>= print
.line
&& line
< print
.line
+ 8)
224 while (line
> print
.line
)
226 putc ('\n', print
.outf
);
231 print_line (map
, line
, "");
234 /* Output a line marker for logical line LINE. Special flags are "1"
235 or "2" indicating entering or leaving a file. */
237 print_line (map
, line
, special_flags
)
238 const struct line_map
*map
;
240 const char *special_flags
;
242 /* End any previous line of text. */
244 putc ('\n', print
.outf
);
248 if (!flag_no_line_commands
)
250 size_t to_file_len
= strlen (map
->to_file
);
251 unsigned char *to_file_quoted
= alloca (to_file_len
* 4 + 1);
254 /* cpp_quote_string does not nul-terminate, so we have to do it
256 p
= cpp_quote_string (to_file_quoted
,
257 (unsigned char *)map
->to_file
, to_file_len
);
259 fprintf (print
.outf
, "# %u \"%s\"%s",
260 SOURCE_LINE (map
, print
.line
),
261 to_file_quoted
, special_flags
);
264 fputs (" 3 4", print
.outf
);
265 else if (map
->sysp
== 1)
266 fputs (" 3", print
.outf
);
268 putc ('\n', print
.outf
);
272 /* Called when a line of output is started. TOKEN is the first token
273 of the line, and at end of file will be CPP_EOF. */
275 cb_line_change (pfile
, token
, parsing_args
)
277 const cpp_token
*token
;
280 if (token
->type
== CPP_EOF
|| parsing_args
)
283 maybe_print_line (print
.map
, token
->line
);
287 /* Supply enough spaces to put this token in its original column,
288 one space per column greater than 2, since scan_translation_unit
289 will provide a space if PREV_WHITE. Don't bother trying to
290 reconstruct tabs; we can't get it right in general, and nothing
291 ought to care. Some things do care; the fault lies with them. */
292 if (!CPP_OPTION (pfile
, traditional
))
297 unsigned int spaces
= token
->col
- 2;
300 putc (' ', print
.outf
);
306 cb_ident (pfile
, line
, str
)
307 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
309 const cpp_string
* str
;
311 maybe_print_line (print
.map
, line
);
312 fprintf (print
.outf
, "#ident \"%s\"\n", str
->text
);
317 cb_define (pfile
, line
, node
)
322 maybe_print_line (print
.map
, line
);
323 fputs ("#define ", print
.outf
);
325 /* 'D' is whole definition; 'N' is name only. */
326 if (flag_dump_macros
== 'D')
327 fputs ((const char *) cpp_macro_definition (pfile
, node
),
330 fputs ((const char *) NODE_NAME (node
), print
.outf
);
332 putc ('\n', print
.outf
);
337 cb_undef (pfile
, line
, node
)
338 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
342 maybe_print_line (print
.map
, line
);
343 fprintf (print
.outf
, "#undef %s\n", NODE_NAME (node
));
348 cb_include (pfile
, line
, dir
, header
)
351 const unsigned char *dir
;
352 const cpp_token
*header
;
354 maybe_print_line (print
.map
, line
);
355 fprintf (print
.outf
, "#%s %s\n", dir
,
356 cpp_token_as_text (pfile
, header
));
360 /* The file name, line number or system header flags have changed, as
361 described in MAP. From this point on, the old print.map might be
362 pointing to freed memory, and so must not be dereferenced. */
366 const struct line_map
*map
;
368 const char *flags
= "";
370 if (flag_no_line_commands
|| flag_no_output
)
374 if (print
.map
== NULL
)
376 /* Avoid printing foo.i when the main file is foo.c. */
377 if (!cpp_get_options (parse_in
)->preprocessed
)
378 print_line (map
, map
->from_line
, flags
);
382 /* Bring current file to correct line when entering a new file. */
383 if (map
->reason
== LC_ENTER
)
384 maybe_print_line (map
- 1, map
->from_line
- 1);
386 if (map
->reason
== LC_ENTER
)
388 else if (map
->reason
== LC_LEAVE
)
390 print_line (map
, map
->from_line
, flags
);
396 /* Copy a #pragma directive to the preprocessed output. */
398 cb_def_pragma (pfile
, line
)
402 maybe_print_line (print
.map
, line
);
403 fputs ("#pragma ", print
.outf
);
404 cpp_output_line (pfile
, print
.outf
);
408 /* Dump out the hash table. */
410 dump_macro (pfile
, node
, v
)
413 void *v ATTRIBUTE_UNUSED
;
415 if (node
->type
== NT_MACRO
&& !(node
->flags
& NODE_BUILTIN
))
417 fputs ("#define ", print
.outf
);
418 fputs ((const char *) cpp_macro_definition (pfile
, node
),
420 putc ('\n', print
.outf
);