1 /* CPP main program, using CPP Library.
2 Copyright (C) 1995, 1997, 1998, 1999, 2000, 2001
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.
20 In other words, you are welcome to use, share and improve this program.
21 You are forbidden to forbid anyone else to use, share and improve
22 what you give them. Help stamp out software-hoarding! */
29 /* Encapsulates state used to convert the stream of tokens coming from
30 cpp_get_token back into a text file. */
33 FILE *outf; /* Stream to write to. */
34 const struct line_map *map; /* Logical to physical line mappings. */
35 const cpp_token *prev; /* Previous token. */
36 const cpp_token *source; /* Source token for spacing. */
37 unsigned int line; /* Line currently being written. */
38 unsigned char printed; /* Nonzero if something output at line. */
41 int main PARAMS ((int, char **));
42 static void general_init PARAMS ((const char *));
43 static void do_preprocessing PARAMS ((int, char **));
44 static void setup_callbacks PARAMS ((void));
46 /* General output routines. */
47 static void scan_translation_unit PARAMS ((cpp_reader *));
48 static void check_multiline_token PARAMS ((const cpp_string *));
49 static int dump_macro PARAMS ((cpp_reader *, cpp_hashnode *, void *));
51 static void print_line PARAMS ((const struct line_map *, unsigned int,
53 static void maybe_print_line PARAMS ((const struct line_map *, unsigned int));
55 /* Callback routines for the parser. Most of these are active only
57 static void cb_line_change PARAMS ((cpp_reader *, const cpp_token *, int));
58 static void cb_define PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
59 static void cb_undef PARAMS ((cpp_reader *, unsigned int, cpp_hashnode *));
60 static void cb_include PARAMS ((cpp_reader *, unsigned int,
61 const unsigned char *, const cpp_token *));
62 static void cb_ident PARAMS ((cpp_reader *, unsigned int,
64 static void cb_file_change PARAMS ((cpp_reader *, const struct line_map *));
65 static void cb_def_pragma PARAMS ((cpp_reader *, unsigned int));
67 const char *progname; /* Needs to be global. */
68 static cpp_reader *pfile; /* An opaque handle. */
69 static cpp_options *options; /* Options of pfile. */
70 static struct printer print;
77 general_init (argv[0]);
79 /* Contruct a reader with default language GNU C89. */
80 pfile = cpp_create_reader (NULL, CLK_GNUC89);
81 options = cpp_get_options (pfile);
83 do_preprocessing (argc, argv);
85 if (cpp_destroy (pfile))
86 return FATAL_EXIT_CODE;
88 return SUCCESS_EXIT_CODE;
91 /* Store the program name, and set the locale. */
96 progname = argv0 + strlen (argv0);
98 while (progname != argv0 && ! IS_DIR_SEPARATOR (progname[-1]))
101 xmalloc_set_program_name (progname);
107 /* Handle switches, preprocess and output. */
109 do_preprocessing (argc, argv)
113 int argi = 1; /* Next argument to handle. */
115 argi += cpp_handle_options (pfile, argc - argi , argv + argi);
116 if (CPP_FATAL_ERRORS (pfile))
120 cpp_fatal (pfile, "Invalid option %s", argv[argi]);
122 cpp_post_options (pfile);
124 if (CPP_FATAL_ERRORS (pfile))
127 /* If cpp_handle_options saw --help or --version on the command
128 line, it will have set pfile->help_only to indicate this. Exit
129 successfully. [The library does not exit itself, because
130 e.g. cc1 needs to print its own --help message at this point.] */
131 if (options->help_only)
134 /* Initialize the printer structure. Setting print.line to -1 here
135 is a trick to guarantee that the first token of the file will
136 cause a linemarker to be output by maybe_print_line. */
137 print.line = (unsigned int) -1;
142 /* Open the output now. We must do so even if no_output is on,
143 because there may be other output than from the actual
144 preprocessing (e.g. from -dM). */
145 if (options->out_fname[0] == '\0')
149 print.outf = fopen (options->out_fname, "w");
150 if (print.outf == NULL)
152 cpp_notice_from_errno (pfile, options->out_fname);
159 if (cpp_start_read (pfile, options->in_fname))
161 /* A successful cpp_start_read guarantees that we can call
162 cpp_scan_nooutput or cpp_get_token next. */
163 if (options->no_output)
164 cpp_scan_nooutput (pfile);
166 scan_translation_unit (pfile);
168 /* -dM command line option. Should this be in cpp_finish? */
169 if (options->dump_macros == dump_only)
170 cpp_forall_identifiers (pfile, dump_macro, NULL);
175 /* Flush any pending output. */
177 putc ('\n', print.outf);
179 if (ferror (print.outf) || fclose (print.outf))
180 cpp_notice_from_errno (pfile, options->out_fname);
183 /* Set up the callbacks as appropriate. */
187 cpp_callbacks *cb = cpp_get_callbacks (pfile);
189 if (! options->no_output)
191 cb->line_change = cb_line_change;
192 cb->ident = cb_ident;
193 cb->def_pragma = cb_def_pragma;
194 if (! options->no_line_commands)
195 cb->file_change = cb_file_change;
198 if (options->dump_includes)
199 cb->include = cb_include;
201 if (options->dump_macros == dump_names
202 || options->dump_macros == dump_definitions)
204 cb->define = cb_define;
205 cb->undef = cb_undef;
209 /* Writes out the preprocessed file, handling spacing and paste
212 scan_translation_unit (pfile)
215 bool avoid_paste = false;
220 const cpp_token *token = cpp_get_token (pfile);
222 if (token->type == CPP_PADDING)
225 if (print.source == NULL
226 || (!(print.source->flags & PREV_WHITE)
227 && token->val.source == NULL))
228 print.source = token->val.source;
232 if (token->type == CPP_EOF)
235 /* Subtle logic to output a space if and only if necessary. */
238 if (print.source == NULL)
239 print.source = token;
240 if (print.source->flags & PREV_WHITE
241 || (print.prev && cpp_avoid_paste (pfile, print.prev, token))
242 || (print.prev == NULL && token->type == CPP_HASH))
243 putc (' ', print.outf);
245 else if (token->flags & PREV_WHITE)
246 putc (' ', print.outf);
251 cpp_output_token (token, print.outf);
253 if (token->type == CPP_STRING || token->type == CPP_WSTRING
254 || token->type == CPP_COMMENT)
255 check_multiline_token (&token->val.str);
259 /* Adjust print.line for newlines embedded in tokens. */
261 check_multiline_token (str)
262 const cpp_string *str;
266 for (i = 0; i < str->len; i++)
267 if (str->text[i] == '\n')
271 /* If the token read on logical line LINE needs to be output on a
272 different line to the current one, output the required newlines or
273 a line marker, and return 1. Otherwise return 0. */
276 maybe_print_line (map, line)
277 const struct line_map *map;
280 /* End the previous line of text. */
283 putc ('\n', print.outf);
288 if (line >= print.line && line < print.line + 8)
290 while (line > print.line)
292 putc ('\n', print.outf);
297 print_line (map, line, "");
300 /* Output a line marker for logical line LINE. Special flags are "1"
301 or "2" indicating entering or leaving a file. */
303 print_line (map, line, special_flags)
304 const struct line_map *map;
306 const char *special_flags;
308 /* End any previous line of text. */
310 putc ('\n', print.outf);
314 if (! options->no_line_commands)
316 fprintf (print.outf, "# %u \"%s\"%s",
317 SOURCE_LINE (map, print.line), map->to_file, special_flags);
320 fputs (" 3 4", print.outf);
321 else if (map->sysp == 1)
322 fputs (" 3", print.outf);
324 putc ('\n', print.outf);
328 /* Called when a line of output is started. TOKEN is the first token
329 of the line, and may be CPP_EOF. */
332 cb_line_change (pfile, token, parsing_args)
333 cpp_reader *pfile ATTRIBUTE_UNUSED;
334 const cpp_token *token;
337 if (token->type == CPP_EOF || parsing_args)
340 maybe_print_line (print.map, token->line);
345 /* Supply enough spaces to put this token in its original column,
346 one space per column greater than 2, since scan_translation_unit
347 will provide a space if PREV_WHITE. Don't bother trying to
348 reconstruct tabs; we can't get it right in general, and nothing
349 ought to care. Some things do care; the fault lies with them. */
352 unsigned int spaces = token->col - 2;
355 putc (' ', print.outf);
360 cb_ident (pfile, line, str)
361 cpp_reader *pfile ATTRIBUTE_UNUSED;
363 const cpp_string * str;
365 maybe_print_line (print.map, line);
366 fprintf (print.outf, "#ident \"%s\"\n", str->text);
371 cb_define (pfile, line, node)
376 maybe_print_line (print.map, line);
377 fputs ("#define ", print.outf);
379 /* -dD command line option. */
380 if (options->dump_macros == dump_definitions)
381 fputs ((const char *) cpp_macro_definition (pfile, node), print.outf);
383 fputs ((const char *) NODE_NAME (node), print.outf);
385 putc ('\n', print.outf);
390 cb_undef (pfile, line, node)
391 cpp_reader *pfile ATTRIBUTE_UNUSED;
395 maybe_print_line (print.map, line);
396 fprintf (print.outf, "#undef %s\n", NODE_NAME (node));
401 cb_include (pfile, line, dir, header)
404 const unsigned char *dir;
405 const cpp_token *header;
407 maybe_print_line (print.map, line);
408 fprintf (print.outf, "#%s %s\n", dir, cpp_token_as_text (pfile, header));
412 /* The file name, line number or system header flags have changed, as
413 described in MAP. From this point on, the old print.map might be
414 pointing to freed memory, and so must not be dereferenced. */
417 cb_file_change (pfile, map)
418 cpp_reader *pfile ATTRIBUTE_UNUSED;
419 const struct line_map *map;
421 const char *flags = "";
424 if (print.map == NULL)
426 /* Avoid printing foo.i when the main file is foo.c. */
427 if (!options->preprocessed)
428 print_line (map, map->from_line, flags);
432 /* Bring current file to correct line when entering a new file. */
433 if (map->reason == LC_ENTER)
434 maybe_print_line (map - 1, map->from_line - 1);
436 if (map->reason == LC_ENTER)
438 else if (map->reason == LC_LEAVE)
440 print_line (map, map->from_line, flags);
446 /* Copy a #pragma directive to the preprocessed output. */
448 cb_def_pragma (pfile, line)
452 maybe_print_line (print.map, line);
453 fputs ("#pragma ", print.outf);
454 cpp_output_line (pfile, print.outf);
458 /* Dump out the hash table. */
460 dump_macro (pfile, node, v)
463 void *v ATTRIBUTE_UNUSED;
465 if (node->type == NT_MACRO && !(node->flags & NODE_BUILTIN))
467 fputs ("#define ", print.outf);
468 fputs ((const char *) cpp_macro_definition (pfile, node), print.outf);
469 putc ('\n', print.outf);