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
);
106 /* Handle switches, preprocess and output. */
108 do_preprocessing (argc
, argv
)
112 int argi
= 1; /* Next argument to handle. */
114 argi
+= cpp_handle_options (pfile
, argc
- argi
, argv
+ argi
);
115 if (CPP_FATAL_ERRORS (pfile
))
119 cpp_fatal (pfile
, "Invalid option %s", argv
[argi
]);
121 cpp_post_options (pfile
);
123 if (CPP_FATAL_ERRORS (pfile
))
126 /* If cpp_handle_options saw --help or --version on the command
127 line, it will have set pfile->help_only to indicate this. Exit
128 successfully. [The library does not exit itself, because
129 e.g. cc1 needs to print its own --help message at this point.] */
130 if (options
->help_only
)
133 /* Initialize the printer structure. Setting print.line to -1 here
134 is a trick to guarantee that the first token of the file will
135 cause a linemarker to be output by maybe_print_line. */
136 print
.line
= (unsigned int) -1;
141 /* Open the output now. We must do so even if no_output is on,
142 because there may be other output than from the actual
143 preprocessing (e.g. from -dM). */
144 if (options
->out_fname
[0] == '\0')
148 print
.outf
= fopen (options
->out_fname
, "w");
149 if (print
.outf
== NULL
)
151 cpp_notice_from_errno (pfile
, options
->out_fname
);
158 if (cpp_start_read (pfile
, options
->in_fname
))
160 /* A successful cpp_start_read guarantees that we can call
161 cpp_scan_nooutput or cpp_get_token next. */
162 if (options
->no_output
)
163 cpp_scan_nooutput (pfile
);
165 scan_translation_unit (pfile
);
167 /* -dM command line option. Should this be in cpp_finish? */
168 if (options
->dump_macros
== dump_only
)
169 cpp_forall_identifiers (pfile
, dump_macro
, NULL
);
174 /* Flush any pending output. */
176 putc ('\n', print
.outf
);
178 if (ferror (print
.outf
) || fclose (print
.outf
))
179 cpp_notice_from_errno (pfile
, options
->out_fname
);
182 /* Set up the callbacks as appropriate. */
186 cpp_callbacks
*cb
= cpp_get_callbacks (pfile
);
188 if (! options
->no_output
)
190 cb
->line_change
= cb_line_change
;
191 cb
->ident
= cb_ident
;
192 cb
->def_pragma
= cb_def_pragma
;
193 if (! options
->no_line_commands
)
194 cb
->file_change
= cb_file_change
;
197 if (options
->dump_includes
)
198 cb
->include
= cb_include
;
200 if (options
->dump_macros
== dump_names
201 || options
->dump_macros
== dump_definitions
)
203 cb
->define
= cb_define
;
204 cb
->undef
= cb_undef
;
208 /* Writes out the preprocessed file, handling spacing and paste
211 scan_translation_unit (pfile
)
214 bool avoid_paste
= false;
219 const cpp_token
*token
= cpp_get_token (pfile
);
221 if (token
->type
== CPP_PADDING
)
224 if (print
.source
== NULL
225 || (!(print
.source
->flags
& PREV_WHITE
)
226 && token
->val
.source
== NULL
))
227 print
.source
= token
->val
.source
;
231 if (token
->type
== CPP_EOF
)
234 /* Subtle logic to output a space if and only if necessary. */
237 if (print
.source
== NULL
)
238 print
.source
= token
;
239 if (print
.source
->flags
& PREV_WHITE
240 || (print
.prev
&& cpp_avoid_paste (pfile
, print
.prev
, token
))
241 || (print
.prev
== NULL
&& token
->type
== CPP_HASH
))
242 putc (' ', print
.outf
);
244 else if (token
->flags
& PREV_WHITE
)
245 putc (' ', print
.outf
);
250 cpp_output_token (token
, print
.outf
);
252 if (token
->type
== CPP_STRING
|| token
->type
== CPP_WSTRING
253 || token
->type
== CPP_COMMENT
)
254 check_multiline_token (&token
->val
.str
);
258 /* Adjust print.line for newlines embedded in tokens. */
260 check_multiline_token (str
)
261 const cpp_string
*str
;
265 for (i
= 0; i
< str
->len
; i
++)
266 if (str
->text
[i
] == '\n')
270 /* If the token read on logical line LINE needs to be output on a
271 different line to the current one, output the required newlines or
272 a line marker, and return 1. Otherwise return 0. */
275 maybe_print_line (map
, line
)
276 const struct line_map
*map
;
279 /* End the previous line of text. */
282 putc ('\n', print
.outf
);
287 if (line
>= print
.line
&& line
< print
.line
+ 8)
289 while (line
> print
.line
)
291 putc ('\n', print
.outf
);
296 print_line (map
, line
, "");
299 /* Output a line marker for logical line LINE. Special flags are "1"
300 or "2" indicating entering or leaving a file. */
302 print_line (map
, line
, special_flags
)
303 const struct line_map
*map
;
305 const char *special_flags
;
307 /* End any previous line of text. */
309 putc ('\n', print
.outf
);
313 if (! options
->no_line_commands
)
315 fprintf (print
.outf
, "# %u \"%s\"%s",
316 SOURCE_LINE (map
, print
.line
), map
->to_file
, special_flags
);
319 fputs (" 3 4", print
.outf
);
320 else if (map
->sysp
== 1)
321 fputs (" 3", print
.outf
);
323 putc ('\n', print
.outf
);
327 /* Called when a line of output is started. TOKEN is the first token
328 of the line, and may be CPP_EOF. */
331 cb_line_change (pfile
, token
, parsing_args
)
332 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
333 const cpp_token
*token
;
336 if (token
->type
== CPP_EOF
|| parsing_args
)
339 maybe_print_line (print
.map
, token
->line
);
344 /* Supply enough spaces to put this token in its original column,
345 one space per column greater than 2, since scan_translation_unit
346 will provide a space if PREV_WHITE. Don't bother trying to
347 reconstruct tabs; we can't get it right in general, and nothing
348 ought to care. Some things do care; the fault lies with them. */
351 unsigned int spaces
= token
->col
- 2;
354 putc (' ', print
.outf
);
359 cb_ident (pfile
, line
, str
)
360 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
362 const cpp_string
* str
;
364 maybe_print_line (print
.map
, line
);
365 fprintf (print
.outf
, "#ident \"%s\"\n", str
->text
);
370 cb_define (pfile
, line
, node
)
375 maybe_print_line (print
.map
, line
);
376 fputs ("#define ", print
.outf
);
378 /* -dD command line option. */
379 if (options
->dump_macros
== dump_definitions
)
380 fputs ((const char *) cpp_macro_definition (pfile
, node
), print
.outf
);
382 fputs ((const char *) NODE_NAME (node
), print
.outf
);
384 putc ('\n', print
.outf
);
389 cb_undef (pfile
, line
, node
)
390 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
394 maybe_print_line (print
.map
, line
);
395 fprintf (print
.outf
, "#undef %s\n", NODE_NAME (node
));
400 cb_include (pfile
, line
, dir
, header
)
403 const unsigned char *dir
;
404 const cpp_token
*header
;
406 maybe_print_line (print
.map
, line
);
407 fprintf (print
.outf
, "#%s %s\n", dir
, cpp_token_as_text (pfile
, header
));
411 /* The file name, line number or system header flags have changed, as
412 described in MAP. From this point on, the old print.map might be
413 pointing to freed memory, and so must not be dereferenced. */
416 cb_file_change (pfile
, map
)
417 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
418 const struct line_map
*map
;
420 const char *flags
= "";
423 if (print
.map
== NULL
)
425 /* Avoid printing foo.i when the main file is foo.c. */
426 if (!options
->preprocessed
)
427 print_line (map
, map
->from_line
, flags
);
431 /* Bring current file to correct line when entering a new file. */
432 if (map
->reason
== LC_ENTER
)
433 maybe_print_line (map
- 1, map
->from_line
- 1);
435 if (map
->reason
== LC_ENTER
)
437 else if (map
->reason
== LC_LEAVE
)
439 print_line (map
, map
->from_line
, flags
);
445 /* Copy a #pragma directive to the preprocessed output. */
447 cb_def_pragma (pfile
, line
)
451 maybe_print_line (print
.map
, line
);
452 fputs ("#pragma ", print
.outf
);
453 cpp_output_line (pfile
, print
.outf
);
457 /* Dump out the hash table. */
459 dump_macro (pfile
, node
, v
)
462 void *v ATTRIBUTE_UNUSED
;
464 if (node
->type
== NT_MACRO
&& !(node
->flags
& NODE_BUILTIN
))
466 fputs ("#define ", print
.outf
);
467 fputs ((const char *) cpp_macro_definition (pfile
, node
), print
.outf
);
468 putc ('\n', print
.outf
);