1 /* Preprocess only, using cpplib.
2 Copyright (C) 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
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, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
23 #include "../libcpp/internal.h"
25 /* Encapsulates state used to convert a stream of tokens into a text
29 FILE *outf; /* Stream to write to. */
30 const cpp_token *prev; /* Previous token. */
31 const cpp_token *source; /* Source token for spacing. */
32 int src_line; /* Line number currently being written. */
33 unsigned char printed; /* Nonzero if something output at line. */
34 bool first_time; /* pp_file_change hasn't been called yet. */
37 /* General output routines. */
38 static void scan_translation_unit (cpp_reader *);
39 static void scan_translation_unit_trad (cpp_reader *);
40 static void account_for_newlines (const unsigned char *, size_t);
41 static int dump_macro (cpp_reader *, cpp_hashnode *, void *);
43 static void print_line (source_location, const char *);
44 static void maybe_print_line (source_location);
46 /* Callback routines for the parser. Most of these are active only
48 static void cb_line_change (cpp_reader *, const cpp_token *, int);
49 static void cb_define (cpp_reader *, source_location, cpp_hashnode *);
50 static void cb_undef (cpp_reader *, source_location, cpp_hashnode *);
51 static void cb_include (cpp_reader *, source_location, const unsigned char *,
52 const char *, int, const cpp_token **);
53 static void cb_ident (cpp_reader *, source_location, const cpp_string *);
54 static void cb_def_pragma (cpp_reader *, source_location);
56 static void cb_read_pch (cpp_reader *pfile, const char *name,
57 int fd, const char *orig_name);
60 /* Preprocess and output. */
62 preprocess_file (cpp_reader *pfile)
64 /* A successful cpp_read_main_file guarantees that we can call
65 cpp_scan_nooutput or cpp_get_token next. */
68 /* Scan -included buffers, then the main file. */
69 while (pfile->buffer->prev)
70 cpp_scan_nooutput (pfile);
71 cpp_scan_nooutput (pfile);
73 else if (cpp_get_options (pfile)->traditional)
74 scan_translation_unit_trad (pfile);
76 scan_translation_unit (pfile);
78 /* -dM command line option. Should this be elsewhere? */
79 if (flag_dump_macros == 'M')
80 cpp_forall_identifiers (pfile, dump_macro, NULL);
82 /* Flush any pending output. */
84 putc ('\n', print.outf);
87 /* Set up the callbacks as appropriate. */
89 init_pp_output (FILE *out_stream)
91 cpp_callbacks *cb = cpp_get_callbacks (parse_in);
95 cb->line_change = cb_line_change;
96 /* Don't emit #pragma or #ident directives if we are processing
97 assembly language; the assembler may choke on them. */
98 if (cpp_get_options (parse_in)->lang != CLK_ASM)
100 cb->ident = cb_ident;
101 cb->def_pragma = cb_def_pragma;
105 if (flag_dump_includes)
106 cb->include = cb_include;
109 if (flag_pch_preprocess)
111 cb->valid_pch = c_common_valid_pch;
112 cb->read_pch = cb_read_pch;
116 if (flag_dump_macros == 'N' || flag_dump_macros == 'D')
118 cb->define = cb_define;
119 cb->undef = cb_undef;
122 /* Initialize the print structure. Setting print.src_line to -1 here is
123 a trick to guarantee that the first token of the file will cause
124 a linemarker to be output by maybe_print_line. */
128 print.outf = out_stream;
129 print.first_time = 1;
132 /* Writes out the preprocessed file, handling spacing and paste
135 scan_translation_unit (cpp_reader *pfile)
137 bool avoid_paste = false;
142 const cpp_token *token = cpp_get_token (pfile);
144 if (token->type == CPP_PADDING)
147 if (print.source == NULL
148 || (!(print.source->flags & PREV_WHITE)
149 && token->val.source == NULL))
150 print.source = token->val.source;
154 if (token->type == CPP_EOF)
157 /* Subtle logic to output a space if and only if necessary. */
160 if (print.source == NULL)
161 print.source = token;
162 if (print.source->flags & PREV_WHITE
164 && cpp_avoid_paste (pfile, print.prev, token))
165 || (print.prev == NULL && token->type == CPP_HASH))
166 putc (' ', print.outf);
168 else if (token->flags & PREV_WHITE)
169 putc (' ', print.outf);
174 cpp_output_token (token, print.outf);
176 if (token->type == CPP_COMMENT)
177 account_for_newlines (token->val.str.text, token->val.str.len);
181 /* Adjust print.src_line for newlines embedded in output. */
183 account_for_newlines (const unsigned char *str, size_t len)
190 /* Writes out a traditionally preprocessed file. */
192 scan_translation_unit_trad (cpp_reader *pfile)
194 while (_cpp_read_logical_line_trad (pfile))
196 size_t len = pfile->out.cur - pfile->out.base;
197 maybe_print_line (pfile->out.first_line);
198 fwrite (pfile->out.base, 1, len, print.outf);
200 if (!CPP_OPTION (pfile, discard_comments))
201 account_for_newlines (pfile->out.base, len);
205 /* If the token read on logical line LINE needs to be output on a
206 different line to the current one, output the required newlines or
207 a line marker, and return 1. Otherwise return 0. */
209 maybe_print_line (source_location src_loc)
211 const struct line_map *map = linemap_lookup (&line_table, src_loc);
212 int src_line = SOURCE_LINE (map, src_loc);
213 /* End the previous line of text. */
216 putc ('\n', print.outf);
221 if (src_line >= print.src_line && src_line < print.src_line + 8)
223 while (src_line > print.src_line)
225 putc ('\n', print.outf);
230 print_line (src_loc, "");
233 /* Output a line marker for logical line LINE. Special flags are "1"
234 or "2" indicating entering or leaving a file. */
236 print_line (source_location src_loc, const char *special_flags)
238 /* End any previous line of text. */
240 putc ('\n', print.outf);
243 if (!flag_no_line_commands)
245 const struct line_map *map = linemap_lookup (&line_table, src_loc);
247 size_t to_file_len = strlen (map->to_file);
248 unsigned char *to_file_quoted = alloca (to_file_len * 4 + 1);
251 print.src_line = SOURCE_LINE (map, src_loc);
253 /* cpp_quote_string does not nul-terminate, so we have to do it
255 p = cpp_quote_string (to_file_quoted,
256 (unsigned char *) map->to_file, to_file_len);
258 fprintf (print.outf, "# %u \"%s\"%s",
259 print.src_line == 0 ? 1 : print.src_line,
260 to_file_quoted, special_flags);
263 fputs (" 3 4", print.outf);
264 else if (map->sysp == 1)
265 fputs (" 3", print.outf);
267 putc ('\n', print.outf);
271 /* Called when a line of output is started. TOKEN is the first token
272 of the line, and at end of file will be CPP_EOF. */
274 cb_line_change (cpp_reader *pfile, const cpp_token *token,
277 source_location src_loc = token->src_loc;
279 if (token->type == CPP_EOF || parsing_args)
282 maybe_print_line (src_loc);
286 /* Supply enough spaces to put this token in its original column,
287 one space per column greater than 2, since scan_translation_unit
288 will provide a space if PREV_WHITE. Don't bother trying to
289 reconstruct tabs; we can't get it right in general, and nothing
290 ought to care. Some things do care; the fault lies with them. */
291 if (!CPP_OPTION (pfile, traditional))
293 const struct line_map *map = linemap_lookup (&line_table, src_loc);
294 int spaces = SOURCE_COLUMN (map, src_loc) - 2;
297 while (-- spaces >= 0)
298 putc (' ', print.outf);
303 cb_ident (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
304 const cpp_string *str)
306 maybe_print_line (line);
307 fprintf (print.outf, "#ident %s\n", str->text);
312 cb_define (cpp_reader *pfile, source_location line, cpp_hashnode *node)
314 maybe_print_line (line);
315 fputs ("#define ", print.outf);
317 /* 'D' is whole definition; 'N' is name only. */
318 if (flag_dump_macros == 'D')
319 fputs ((const char *) cpp_macro_definition (pfile, node),
322 fputs ((const char *) NODE_NAME (node), print.outf);
324 putc ('\n', print.outf);
329 cb_undef (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
332 maybe_print_line (line);
333 fprintf (print.outf, "#undef %s\n", NODE_NAME (node));
338 cb_include (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
339 const unsigned char *dir, const char *header, int angle_brackets,
340 const cpp_token **comments)
342 maybe_print_line (line);
344 fprintf (print.outf, "#%s <%s>", dir, header);
346 fprintf (print.outf, "#%s \"%s\"", dir, header);
348 if (comments != NULL)
350 while (*comments != NULL)
352 if ((*comments)->flags & PREV_WHITE)
353 putc (' ', print.outf);
354 cpp_output_token (*comments, print.outf);
359 putc ('\n', print.outf);
363 /* Callback called when -fworking-director and -E to emit working
364 directory in cpp output file. */
367 pp_dir_change (cpp_reader *pfile ATTRIBUTE_UNUSED, const char *dir)
369 size_t to_file_len = strlen (dir);
370 unsigned char *to_file_quoted = alloca (to_file_len * 4 + 1);
373 /* cpp_quote_string does not nul-terminate, so we have to do it ourselves. */
374 p = cpp_quote_string (to_file_quoted, (unsigned char *) dir, to_file_len);
376 fprintf (print.outf, "# 1 \"%s//\"\n", to_file_quoted);
379 /* The file name, line number or system header flags have changed, as
383 pp_file_change (const struct line_map *map)
385 const char *flags = "";
387 if (flag_no_line_commands)
392 if (print.first_time)
394 /* Avoid printing foo.i when the main file is foo.c. */
395 if (!cpp_get_options (parse_in)->preprocessed)
396 print_line (map->start_location, flags);
397 print.first_time = 0;
401 /* Bring current file to correct line when entering a new file. */
402 if (map->reason == LC_ENTER)
404 const struct line_map *from = INCLUDED_FROM (&line_table, map);
405 maybe_print_line (LAST_SOURCE_LINE_LOCATION (from));
407 if (map->reason == LC_ENTER)
409 else if (map->reason == LC_LEAVE)
411 print_line (map->start_location, flags);
416 /* Copy a #pragma directive to the preprocessed output. */
418 cb_def_pragma (cpp_reader *pfile, source_location line)
420 maybe_print_line (line);
421 fputs ("#pragma ", print.outf);
422 cpp_output_line (pfile, print.outf);
426 /* Dump out the hash table. */
428 dump_macro (cpp_reader *pfile, cpp_hashnode *node, void *v ATTRIBUTE_UNUSED)
430 if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
432 fputs ("#define ", print.outf);
433 fputs ((const char *) cpp_macro_definition (pfile, node),
435 putc ('\n', print.outf);
443 /* Load in the PCH file NAME, open on FD. It was originally searched for
444 by ORIG_NAME. Also, print out a #include command so that the PCH
445 file can be loaded when the preprocessed output is compiled. */
448 cb_read_pch (cpp_reader *pfile, const char *name,
449 int fd, const char *orig_name ATTRIBUTE_UNUSED)
451 c_common_read_pch (pfile, name, fd, orig_name);
453 fprintf (print.outf, "#pragma GCC pch_preprocess \"%s\"\n", name);