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, 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 cpp_token *prev; /* Previous token. */
36 const cpp_token *source; /* Source token for spacing. */
37 int src_line; /* Line number currently being written. */
38 unsigned char printed; /* Nonzero if something output at line. */
41 /* General output routines. */
42 static void scan_translation_unit (cpp_reader *);
43 static void scan_translation_unit_trad (cpp_reader *);
44 static void account_for_newlines (const unsigned char *, size_t);
45 static int dump_macro (cpp_reader *, cpp_hashnode *, void *);
47 static void print_line (source_location, const char *);
48 static void maybe_print_line (source_location);
50 /* Callback routines for the parser. Most of these are active only
52 static void cb_line_change (cpp_reader *, const cpp_token *, int);
53 static void cb_define (cpp_reader *, fileline, cpp_hashnode *);
54 static void cb_undef (cpp_reader *, fileline, cpp_hashnode *);
55 static void cb_include (cpp_reader *, fileline, const unsigned char *,
57 static void cb_ident (cpp_reader *, fileline, const cpp_string *);
58 static void cb_def_pragma (cpp_reader *, fileline);
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;
108 if (flag_dump_macros == 'N' || flag_dump_macros == 'D')
110 cb->define = cb_define;
111 cb->undef = cb_undef;
114 /* Initialize the print structure. Setting print.src_line to -1 here is
115 a trick to guarantee that the first token of the file will cause
116 a linemarker to be output by maybe_print_line. */
120 print.outf = out_stream;
123 /* Writes out the preprocessed file, handling spacing and paste
126 scan_translation_unit (cpp_reader *pfile)
128 bool avoid_paste = false;
133 const cpp_token *token = cpp_get_token (pfile);
135 if (token->type == CPP_PADDING)
138 if (print.source == NULL
139 || (!(print.source->flags & PREV_WHITE)
140 && token->val.source == NULL))
141 print.source = token->val.source;
145 if (token->type == CPP_EOF)
148 /* Subtle logic to output a space if and only if necessary. */
151 if (print.source == NULL)
152 print.source = token;
153 if (print.source->flags & PREV_WHITE
155 && cpp_avoid_paste (pfile, print.prev, token))
156 || (print.prev == NULL && token->type == CPP_HASH))
157 putc (' ', print.outf);
159 else if (token->flags & PREV_WHITE)
160 putc (' ', print.outf);
165 cpp_output_token (token, print.outf);
167 if (token->type == CPP_COMMENT)
168 account_for_newlines (token->val.str.text, token->val.str.len);
172 /* Adjust print.src_line for newlines embedded in output. */
174 account_for_newlines (const unsigned char *str, size_t len)
181 /* Writes out a traditionally preprocessed file. */
183 scan_translation_unit_trad (cpp_reader *pfile)
185 while (_cpp_read_logical_line_trad (pfile))
187 size_t len = pfile->out.cur - pfile->out.base;
188 maybe_print_line (pfile->out.first_line);
189 fwrite (pfile->out.base, 1, len, print.outf);
191 if (!CPP_OPTION (pfile, discard_comments))
192 account_for_newlines (pfile->out.base, len);
196 /* If the token read on logical line LINE needs to be output on a
197 different line to the current one, output the required newlines or
198 a line marker, and return 1. Otherwise return 0. */
200 maybe_print_line (source_location src_loc)
202 const struct line_map *map = linemap_lookup (&line_table, src_loc);
203 int src_line = SOURCE_LINE (map, src_loc);
204 /* End the previous line of text. */
207 putc ('\n', print.outf);
212 if (src_line >= print.src_line && src_line < print.src_line + 8)
214 while (src_line > print.src_line)
216 putc ('\n', print.outf);
221 print_line (src_loc, "");
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 (source_location src_loc, const char *special_flags)
229 /* End any previous line of text. */
231 putc ('\n', print.outf);
234 if (!flag_no_line_commands)
236 const struct line_map *map = linemap_lookup (&line_table, src_loc);
238 size_t to_file_len = strlen (map->to_file);
239 unsigned char *to_file_quoted = alloca (to_file_len * 4 + 1);
242 print.src_line = SOURCE_LINE (map, src_loc);
244 /* cpp_quote_string does not nul-terminate, so we have to do it
246 p = cpp_quote_string (to_file_quoted,
247 (unsigned char *)map->to_file, to_file_len);
249 fprintf (print.outf, "# %u \"%s\"%s", print.src_line,
250 to_file_quoted, special_flags);
253 fputs (" 3 4", print.outf);
254 else if (map->sysp == 1)
255 fputs (" 3", print.outf);
257 putc ('\n', print.outf);
261 /* Called when a line of output is started. TOKEN is the first token
262 of the line, and at end of file will be CPP_EOF. */
264 cb_line_change (cpp_reader *pfile, const cpp_token *token,
267 source_location src_loc = token->src_loc;
269 if (token->type == CPP_EOF || parsing_args)
272 maybe_print_line (src_loc);
276 /* Supply enough spaces to put this token in its original column,
277 one space per column greater than 2, since scan_translation_unit
278 will provide a space if PREV_WHITE. Don't bother trying to
279 reconstruct tabs; we can't get it right in general, and nothing
280 ought to care. Some things do care; the fault lies with them. */
281 if (!CPP_OPTION (pfile, traditional))
283 const struct line_map *map = linemap_lookup (&line_table, src_loc);
284 int spaces = SOURCE_COLUMN (map, src_loc) - 2;
287 while (-- spaces >= 0)
288 putc (' ', print.outf);
293 cb_ident (cpp_reader *pfile ATTRIBUTE_UNUSED, fileline line,
294 const cpp_string *str)
296 maybe_print_line (line);
297 fprintf (print.outf, "#ident \"%s\"\n", str->text);
302 cb_define (cpp_reader *pfile, fileline line, cpp_hashnode *node)
304 maybe_print_line (line);
305 fputs ("#define ", print.outf);
307 /* 'D' is whole definition; 'N' is name only. */
308 if (flag_dump_macros == 'D')
309 fputs ((const char *) cpp_macro_definition (pfile, node),
312 fputs ((const char *) NODE_NAME (node), print.outf);
314 putc ('\n', print.outf);
319 cb_undef (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
322 maybe_print_line (line);
323 fprintf (print.outf, "#undef %s\n", NODE_NAME (node));
328 cb_include (cpp_reader *pfile ATTRIBUTE_UNUSED, source_location line,
329 const unsigned char *dir, const char *header, int angle_brackets)
331 maybe_print_line (line);
333 fprintf (print.outf, "#%s <%s>\n", dir, header);
335 fprintf (print.outf, "#%s \"%s\"\n", dir, header);
339 /* Callback called when -fworking-director and -E to emit working
340 directory in cpp output file. */
343 pp_dir_change (cpp_reader *pfile ATTRIBUTE_UNUSED, const char *dir)
345 size_t to_file_len = strlen (dir);
346 unsigned char *to_file_quoted = alloca (to_file_len * 4 + 1);
349 /* cpp_quote_string does not nul-terminate, so we have to do it ourselves. */
350 p = cpp_quote_string (to_file_quoted, (unsigned char *) dir, to_file_len);
352 fprintf (print.outf, "# 1 \"%s//\"\n", to_file_quoted);
355 /* The file name, line number or system header flags have changed, as
359 pp_file_change (const struct line_map *map)
361 const char *flags = "";
363 if (flag_no_line_commands || flag_no_output)
369 if (MAIN_FILE_P (map))
371 /* Avoid printing foo.i when the main file is foo.c. */
372 if (!cpp_get_options (parse_in)->preprocessed)
373 print_line (map->start_location, flags);
377 /* Bring current file to correct line when entering a new file. */
378 if (map->reason == LC_ENTER)
380 const struct line_map *from = INCLUDED_FROM (&line_table, map);
381 maybe_print_line (LAST_SOURCE_LINE_LOCATION (from));
383 if (map->reason == LC_ENTER)
385 else if (map->reason == LC_LEAVE)
387 print_line (map->start_location, flags);
392 /* Copy a #pragma directive to the preprocessed output. */
394 cb_def_pragma (cpp_reader *pfile, fileline line)
396 maybe_print_line (line);
397 fputs ("#pragma ", print.outf);
398 cpp_output_line (pfile, print.outf);
402 /* Dump out the hash table. */
404 dump_macro (cpp_reader *pfile, cpp_hashnode *node, void *v ATTRIBUTE_UNUSED)
406 if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
408 fputs ("#define ", print.outf);
409 fputs ((const char *) cpp_macro_definition (pfile, node),
411 putc ('\n', print.outf);