1 /* CPP main program, using CPP Library.
2 Copyright (C) 1995, 1997, 1998, 1999, 2000, 2001, 2002
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 /* Construct a reader with default language GNU C89. */
80 pfile
= cpp_create_reader (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
))
121 cpp_fatal (pfile
, "invalid option %s", argv
[argi
]);
125 cpp_post_options (pfile
);
126 if (CPP_FATAL_ERRORS (pfile
))
129 /* If cpp_handle_options saw --help or --version on the command
130 line, it will have set pfile->help_only to indicate this. Exit
131 successfully. [The library does not exit itself, because
132 e.g. cc1 needs to print its own --help message at this point.] */
133 if (options
->help_only
)
136 /* Initialize the printer structure. Setting print.line to -1 here
137 is a trick to guarantee that the first token of the file will
138 cause a linemarker to be output by maybe_print_line. */
139 print
.line
= (unsigned int) -1;
144 /* Open the output now. We must do so even if no_output is on,
145 because there may be other output than from the actual
146 preprocessing (e.g. from -dM). */
147 if (options
->out_fname
[0] == '\0')
151 print
.outf
= fopen (options
->out_fname
, "w");
152 if (print
.outf
== NULL
)
154 cpp_notice_from_errno (pfile
, options
->out_fname
);
161 if (cpp_read_main_file (pfile
, options
->in_fname
, NULL
))
163 cpp_finish_options (pfile
);
165 /* A successful cpp_read_main_file guarantees that we can call
166 cpp_scan_nooutput or cpp_get_token next. */
167 if (options
->no_output
)
168 cpp_scan_nooutput (pfile
);
170 scan_translation_unit (pfile
);
172 /* -dM command line option. Should this be in cpp_finish? */
173 if (options
->dump_macros
== dump_only
)
174 cpp_forall_identifiers (pfile
, dump_macro
, NULL
);
179 /* Flush any pending output. */
181 putc ('\n', print
.outf
);
183 if (ferror (print
.outf
) || fclose (print
.outf
))
184 cpp_notice_from_errno (pfile
, options
->out_fname
);
187 /* Set up the callbacks as appropriate. */
191 cpp_callbacks
*cb
= cpp_get_callbacks (pfile
);
193 if (! options
->no_output
)
195 cb
->line_change
= cb_line_change
;
196 /* Don't emit #pragma or #ident directives if we are processing
197 assembly language; the assembler may choke on them. */
198 if (options
->lang
!= CLK_ASM
)
200 cb
->ident
= cb_ident
;
201 cb
->def_pragma
= cb_def_pragma
;
203 if (! options
->no_line_commands
)
204 cb
->file_change
= cb_file_change
;
207 if (options
->dump_includes
)
208 cb
->include
= cb_include
;
210 if (options
->dump_macros
== dump_names
211 || options
->dump_macros
== dump_definitions
)
213 cb
->define
= cb_define
;
214 cb
->undef
= cb_undef
;
218 /* Writes out the preprocessed file, handling spacing and paste
221 scan_translation_unit (pfile
)
224 bool avoid_paste
= false;
229 const cpp_token
*token
= cpp_get_token (pfile
);
231 if (token
->type
== CPP_PADDING
)
234 if (print
.source
== NULL
235 || (!(print
.source
->flags
& PREV_WHITE
)
236 && token
->val
.source
== NULL
))
237 print
.source
= token
->val
.source
;
241 if (token
->type
== CPP_EOF
)
244 /* Subtle logic to output a space if and only if necessary. */
247 if (print
.source
== NULL
)
248 print
.source
= token
;
249 if (print
.source
->flags
& PREV_WHITE
250 || (print
.prev
&& cpp_avoid_paste (pfile
, print
.prev
, token
))
251 || (print
.prev
== NULL
&& token
->type
== CPP_HASH
))
252 putc (' ', print
.outf
);
254 else if (token
->flags
& PREV_WHITE
)
255 putc (' ', print
.outf
);
260 cpp_output_token (token
, print
.outf
);
262 if (token
->type
== CPP_STRING
|| token
->type
== CPP_WSTRING
263 || token
->type
== CPP_COMMENT
)
264 check_multiline_token (&token
->val
.str
);
268 /* Adjust print.line for newlines embedded in tokens. */
270 check_multiline_token (str
)
271 const cpp_string
*str
;
275 for (i
= 0; i
< str
->len
; i
++)
276 if (str
->text
[i
] == '\n')
280 /* If the token read on logical line LINE needs to be output on a
281 different line to the current one, output the required newlines or
282 a line marker, and return 1. Otherwise return 0. */
284 maybe_print_line (map
, line
)
285 const struct line_map
*map
;
288 /* End the previous line of text. */
291 putc ('\n', print
.outf
);
296 if (line
>= print
.line
&& line
< print
.line
+ 8)
298 while (line
> print
.line
)
300 putc ('\n', print
.outf
);
305 print_line (map
, line
, "");
308 /* Output a line marker for logical line LINE. Special flags are "1"
309 or "2" indicating entering or leaving a file. */
311 print_line (map
, line
, special_flags
)
312 const struct line_map
*map
;
314 const char *special_flags
;
316 /* End any previous line of text. */
318 putc ('\n', print
.outf
);
322 if (! options
->no_line_commands
)
324 fprintf (print
.outf
, "# %u \"%s\"%s",
325 SOURCE_LINE (map
, print
.line
), map
->to_file
, special_flags
);
328 fputs (" 3 4", print
.outf
);
329 else if (map
->sysp
== 1)
330 fputs (" 3", print
.outf
);
332 putc ('\n', print
.outf
);
336 /* Called when a line of output is started. TOKEN is the first token
337 of the line, and at end of file will be CPP_EOF. */
339 cb_line_change (pfile
, token
, parsing_args
)
340 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
341 const cpp_token
*token
;
344 if (token
->type
== CPP_EOF
|| parsing_args
)
347 maybe_print_line (print
.map
, token
->line
);
352 /* Supply enough spaces to put this token in its original column,
353 one space per column greater than 2, since scan_translation_unit
354 will provide a space if PREV_WHITE. Don't bother trying to
355 reconstruct tabs; we can't get it right in general, and nothing
356 ought to care. Some things do care; the fault lies with them. */
359 unsigned int spaces
= token
->col
- 2;
362 putc (' ', print
.outf
);
367 cb_ident (pfile
, line
, str
)
368 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
370 const cpp_string
* str
;
372 maybe_print_line (print
.map
, line
);
373 fprintf (print
.outf
, "#ident \"%s\"\n", str
->text
);
378 cb_define (pfile
, line
, node
)
383 maybe_print_line (print
.map
, line
);
384 fputs ("#define ", print
.outf
);
386 /* -dD command line option. */
387 if (options
->dump_macros
== dump_definitions
)
388 fputs ((const char *) cpp_macro_definition (pfile
, node
), print
.outf
);
390 fputs ((const char *) NODE_NAME (node
), print
.outf
);
392 putc ('\n', print
.outf
);
397 cb_undef (pfile
, line
, node
)
398 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
402 maybe_print_line (print
.map
, line
);
403 fprintf (print
.outf
, "#undef %s\n", NODE_NAME (node
));
408 cb_include (pfile
, line
, dir
, header
)
411 const unsigned char *dir
;
412 const cpp_token
*header
;
414 maybe_print_line (print
.map
, line
);
415 fprintf (print
.outf
, "#%s %s\n", dir
, cpp_token_as_text (pfile
, header
));
419 /* The file name, line number or system header flags have changed, as
420 described in MAP. From this point on, the old print.map might be
421 pointing to freed memory, and so must not be dereferenced. */
424 cb_file_change (pfile
, map
)
425 cpp_reader
*pfile ATTRIBUTE_UNUSED
;
426 const struct line_map
*map
;
428 const char *flags
= "";
431 if (print
.map
== NULL
)
433 /* Avoid printing foo.i when the main file is foo.c. */
434 if (!options
->preprocessed
)
435 print_line (map
, map
->from_line
, flags
);
439 /* Bring current file to correct line when entering a new file. */
440 if (map
->reason
== LC_ENTER
)
441 maybe_print_line (map
- 1, map
->from_line
- 1);
443 if (map
->reason
== LC_ENTER
)
445 else if (map
->reason
== LC_LEAVE
)
447 print_line (map
, map
->from_line
, flags
);
453 /* Copy a #pragma directive to the preprocessed output. */
455 cb_def_pragma (pfile
, line
)
459 maybe_print_line (print
.map
, line
);
460 fputs ("#pragma ", print
.outf
);
461 cpp_output_line (pfile
, print
.outf
);
465 /* Dump out the hash table. */
467 dump_macro (pfile
, node
, v
)
470 void *v ATTRIBUTE_UNUSED
;
472 if (node
->type
== NT_MACRO
&& !(node
->flags
& NODE_BUILTIN
))
474 fputs ("#define ", print
.outf
);
475 fputs ((const char *) cpp_macro_definition (pfile
, node
), print
.outf
);
476 putc ('\n', print
.outf
);