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 fileline 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 (cpp_reader
*);
44 static void scan_translation_unit_trad (cpp_reader
*);
45 static void account_for_newlines (const unsigned char *, size_t);
46 static int dump_macro (cpp_reader
*, cpp_hashnode
*, void *);
48 static void print_line (const struct line_map
*, fileline
, const char *);
49 static void maybe_print_line (const struct line_map
*, fileline
);
51 /* Callback routines for the parser. Most of these are active only
53 static void cb_line_change (cpp_reader
*, const cpp_token
*, int);
54 static void cb_define (cpp_reader
*, fileline
, cpp_hashnode
*);
55 static void cb_undef (cpp_reader
*, fileline
, cpp_hashnode
*);
56 static void cb_include (cpp_reader
*, fileline
, const unsigned char *,
58 static void cb_ident (cpp_reader
*, fileline
, const cpp_string
*);
59 static void cb_def_pragma (cpp_reader
*, fileline
);
61 /* Preprocess and output. */
63 preprocess_file (cpp_reader
*pfile
)
65 /* A successful cpp_read_main_file guarantees that we can call
66 cpp_scan_nooutput or cpp_get_token next. */
69 /* Scan -included buffers, then the main file. */
70 while (pfile
->buffer
->prev
)
71 cpp_scan_nooutput (pfile
);
72 cpp_scan_nooutput (pfile
);
74 else if (cpp_get_options (pfile
)->traditional
)
75 scan_translation_unit_trad (pfile
);
77 scan_translation_unit (pfile
);
79 /* -dM command line option. Should this be elsewhere? */
80 if (flag_dump_macros
== 'M')
81 cpp_forall_identifiers (pfile
, dump_macro
, NULL
);
83 /* Flush any pending output. */
85 putc ('\n', print
.outf
);
88 /* Set up the callbacks as appropriate. */
90 init_pp_output (FILE *out_stream
)
92 cpp_callbacks
*cb
= cpp_get_callbacks (parse_in
);
96 cb
->line_change
= cb_line_change
;
97 /* Don't emit #pragma or #ident directives if we are processing
98 assembly language; the assembler may choke on them. */
99 if (cpp_get_options (parse_in
)->lang
!= CLK_ASM
)
101 cb
->ident
= cb_ident
;
102 cb
->def_pragma
= cb_def_pragma
;
106 if (flag_dump_includes
)
107 cb
->include
= cb_include
;
109 if (flag_dump_macros
== 'N' || flag_dump_macros
== 'D')
111 cb
->define
= cb_define
;
112 cb
->undef
= cb_undef
;
115 /* Initialize the print structure. Setting print.line to -1 here is
116 a trick to guarantee that the first token of the file will cause
117 a linemarker to be output by maybe_print_line. */
118 print
.line
= (fileline
) -1;
122 print
.outf
= out_stream
;
125 /* Writes out the preprocessed file, handling spacing and paste
128 scan_translation_unit (cpp_reader
*pfile
)
130 bool avoid_paste
= false;
135 const cpp_token
*token
= cpp_get_token (pfile
);
137 if (token
->type
== CPP_PADDING
)
140 if (print
.source
== NULL
141 || (!(print
.source
->flags
& PREV_WHITE
)
142 && token
->val
.source
== NULL
))
143 print
.source
= token
->val
.source
;
147 if (token
->type
== CPP_EOF
)
150 /* Subtle logic to output a space if and only if necessary. */
153 if (print
.source
== NULL
)
154 print
.source
= token
;
155 if (print
.source
->flags
& PREV_WHITE
157 && cpp_avoid_paste (pfile
, print
.prev
, token
))
158 || (print
.prev
== NULL
&& token
->type
== CPP_HASH
))
159 putc (' ', print
.outf
);
161 else if (token
->flags
& PREV_WHITE
)
162 putc (' ', print
.outf
);
167 cpp_output_token (token
, print
.outf
);
169 if (token
->type
== CPP_COMMENT
)
170 account_for_newlines (token
->val
.str
.text
, token
->val
.str
.len
);
174 /* Adjust print.line for newlines embedded in output. */
176 account_for_newlines (const unsigned char *str
, size_t len
)
183 /* Writes out a traditionally preprocessed file. */
185 scan_translation_unit_trad (cpp_reader
*pfile
)
187 while (_cpp_read_logical_line_trad (pfile
))
189 size_t len
= pfile
->out
.cur
- pfile
->out
.base
;
190 maybe_print_line (print
.map
, pfile
->out
.first_line
);
191 fwrite (pfile
->out
.base
, 1, len
, print
.outf
);
193 if (!CPP_OPTION (pfile
, discard_comments
))
194 account_for_newlines (pfile
->out
.base
, len
);
198 /* If the token read on logical line LINE needs to be output on a
199 different line to the current one, output the required newlines or
200 a line marker, and return 1. Otherwise return 0. */
202 maybe_print_line (const struct line_map
*map
, fileline line
)
204 /* End the previous line of text. */
207 putc ('\n', print
.outf
);
212 if (line
>= print
.line
&& line
< print
.line
+ 8)
214 while (line
> print
.line
)
216 putc ('\n', print
.outf
);
221 print_line (map
, line
, "");
224 /* Output a line marker for logical line LINE. Special flags are "1"
225 or "2" indicating entering or leaving a file. */
227 print_line (const struct line_map
*map
, fileline line
, const char *special_flags
)
229 /* End any previous line of text. */
231 putc ('\n', print
.outf
);
235 if (!flag_no_line_commands
)
237 size_t to_file_len
= strlen (map
->to_file
);
238 unsigned char *to_file_quoted
= alloca (to_file_len
* 4 + 1);
241 /* cpp_quote_string does not nul-terminate, so we have to do it
243 p
= cpp_quote_string (to_file_quoted
,
244 (unsigned char *)map
->to_file
, to_file_len
);
246 fprintf (print
.outf
, "# %u \"%s\"%s",
247 SOURCE_LINE (map
, print
.line
),
248 to_file_quoted
, special_flags
);
251 fputs (" 3 4", print
.outf
);
252 else if (map
->sysp
== 1)
253 fputs (" 3", print
.outf
);
255 putc ('\n', print
.outf
);
259 /* Called when a line of output is started. TOKEN is the first token
260 of the line, and at end of file will be CPP_EOF. */
262 cb_line_change (cpp_reader
*pfile
, const cpp_token
*token
,
265 if (token
->type
== CPP_EOF
|| parsing_args
)
268 maybe_print_line (print
.map
, token
->line
);
272 /* Supply enough spaces to put this token in its original column,
273 one space per column greater than 2, since scan_translation_unit
274 will provide a space if PREV_WHITE. Don't bother trying to
275 reconstruct tabs; we can't get it right in general, and nothing
276 ought to care. Some things do care; the fault lies with them. */
277 if (!CPP_OPTION (pfile
, traditional
))
282 unsigned int spaces
= token
->col
- 2;
285 putc (' ', print
.outf
);
291 cb_ident (cpp_reader
*pfile ATTRIBUTE_UNUSED
, fileline line
,
292 const cpp_string
*str
)
294 maybe_print_line (print
.map
, line
);
295 fprintf (print
.outf
, "#ident \"%s\"\n", str
->text
);
300 cb_define (cpp_reader
*pfile
, fileline line
, cpp_hashnode
*node
)
302 maybe_print_line (print
.map
, line
);
303 fputs ("#define ", print
.outf
);
305 /* 'D' is whole definition; 'N' is name only. */
306 if (flag_dump_macros
== 'D')
307 fputs ((const char *) cpp_macro_definition (pfile
, node
),
310 fputs ((const char *) NODE_NAME (node
), print
.outf
);
312 putc ('\n', print
.outf
);
317 cb_undef (cpp_reader
*pfile ATTRIBUTE_UNUSED
, fileline line
,
320 maybe_print_line (print
.map
, line
);
321 fprintf (print
.outf
, "#undef %s\n", NODE_NAME (node
));
326 cb_include (cpp_reader
*pfile ATTRIBUTE_UNUSED
, fileline line
,
327 const unsigned char *dir
, const char *header
, int angle_brackets
)
329 maybe_print_line (print
.map
, line
);
331 fprintf (print
.outf
, "#%s <%s>\n", dir
, header
);
333 fprintf (print
.outf
, "#%s \"%s\"\n", dir
, header
);
337 /* Callback called when -fworking-director and -E to emit working
338 diretory in cpp output file. */
341 pp_dir_change (cpp_reader
*pfile ATTRIBUTE_UNUSED
, const char *dir
)
343 size_t to_file_len
= strlen (dir
);
344 unsigned char *to_file_quoted
= alloca (to_file_len
* 4 + 1);
347 /* cpp_quote_string does not nul-terminate, so we have to do it ourselves. */
348 p
= cpp_quote_string (to_file_quoted
, (unsigned char *) dir
, to_file_len
);
350 fprintf (print
.outf
, "# 1 \"%s//\"\n", to_file_quoted
);
353 /* The file name, line number or system header flags have changed, as
354 described in MAP. From this point on, the old print.map might be
355 pointing to freed memory, and so must not be dereferenced. */
358 pp_file_change (const struct line_map
*map
)
360 const char *flags
= "";
362 if (flag_no_line_commands
|| flag_no_output
)
368 if (print
.map
== NULL
)
370 /* Avoid printing foo.i when the main file is foo.c. */
371 if (!cpp_get_options (parse_in
)->preprocessed
)
372 print_line (map
, map
->from_line
, flags
);
376 /* Bring current file to correct line when entering a new file. */
377 if (map
->reason
== LC_ENTER
)
378 maybe_print_line (map
- 1, map
->from_line
- 1);
380 if (map
->reason
== LC_ENTER
)
382 else if (map
->reason
== LC_LEAVE
)
384 print_line (map
, map
->from_line
, flags
);
391 /* Copy a #pragma directive to the preprocessed output. */
393 cb_def_pragma (cpp_reader
*pfile
, fileline line
)
395 maybe_print_line (print
.map
, line
);
396 fputs ("#pragma ", print
.outf
);
397 cpp_output_line (pfile
, print
.outf
);
401 /* Dump out the hash table. */
403 dump_macro (cpp_reader
*pfile
, cpp_hashnode
*node
, void *v ATTRIBUTE_UNUSED
)
405 if (node
->type
== NT_MACRO
&& !(node
->flags
& NODE_BUILTIN
))
407 fputs ("#define ", print
.outf
);
408 fputs ((const char *) cpp_macro_definition (pfile
, node
),
410 putc ('\n', print
.outf
);