2 Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
4 Contributed by Per Bothner, 1994-95.
5 Based on CCCP program by Paul Rubin, June 1986
6 Adapted to ANSI C, Richard Stallman, Jan 1987
8 This program is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
29 #include "cppdefault.h"
31 /* Windows does not natively support inodes, and neither does MSDOS.
32 Cygwin's emulation can generate non-unique inodes, so don't use it.
33 VMS has non-numeric inodes. */
35 # define INO_T_EQ(A, B) (!memcmp (&(A), &(B), sizeof (A)))
36 # define INO_T_COPY(DEST, SRC) memcpy(&(DEST), &(SRC), sizeof (SRC))
38 # if (defined _WIN32 && ! defined (_UWIN)) || defined __MSDOS__
39 # define INO_T_EQ(A, B) 0
41 # define INO_T_EQ(A, B) ((A) == (B))
43 # define INO_T_COPY(DEST, SRC) (DEST) = (SRC)
46 /* Internal structures and prototypes. */
48 /* A `struct pending_option' remembers one -D, -A, -U, -include, or
50 typedef void (* cl_directive_handler) PARAMS ((cpp_reader *, const char *));
53 struct pending_option *next;
55 cl_directive_handler handler;
58 /* The `pending' structure accumulates all the options that are not
59 actually processed until we hit cpp_read_main_file. It consists of
60 several lists, one for each type of option. We keep both head and
61 tail pointers for quick insertion. */
64 struct pending_option *directive_head, *directive_tail;
66 struct search_path *quote_head, *quote_tail;
67 struct search_path *brack_head, *brack_tail;
68 struct search_path *systm_head, *systm_tail;
69 struct search_path *after_head, *after_tail;
71 struct pending_option *imacros_head, *imacros_tail;
72 struct pending_option *include_head, *include_tail;
76 #define APPEND(pend, list, elt) \
77 do { if (!(pend)->list##_head) (pend)->list##_head = (elt); \
78 else (pend)->list##_tail->next = (elt); \
79 (pend)->list##_tail = (elt); \
82 #define APPEND(pend, list, elt) \
83 do { if (!(pend)->list/**/_head) (pend)->list/**/_head = (elt); \
84 else (pend)->list/**/_tail->next = (elt); \
85 (pend)->list/**/_tail = (elt); \
89 static void path_include PARAMS ((cpp_reader *,
91 static void init_library PARAMS ((void));
92 static void init_builtins PARAMS ((cpp_reader *));
93 static void mark_named_operators PARAMS ((cpp_reader *));
94 static void append_include_chain PARAMS ((cpp_reader *,
96 static struct search_path * remove_dup_dir PARAMS ((cpp_reader *,
98 struct search_path **));
99 static struct search_path * remove_dup_nonsys_dirs PARAMS ((cpp_reader *,
100 struct search_path **,
101 struct search_path *));
102 static struct search_path * remove_dup_dirs PARAMS ((cpp_reader *,
103 struct search_path **));
104 static void merge_include_chains PARAMS ((cpp_reader *));
105 static bool push_include PARAMS ((cpp_reader *,
106 struct pending_option *));
107 static void free_chain PARAMS ((struct pending_option *));
108 static void init_standard_includes PARAMS ((cpp_reader *));
109 static void read_original_filename PARAMS ((cpp_reader *));
110 static void new_pending_directive PARAMS ((struct cpp_pending *,
112 cl_directive_handler));
113 static int parse_option PARAMS ((const char *));
114 static void post_options PARAMS ((cpp_reader *));
116 /* Fourth argument to append_include_chain: chain to use.
117 Note it's never asked to append to the quote chain. */
118 enum { BRACKET = 0, SYSTEM, AFTER };
120 /* If we have designated initializers (GCC >2.7) these tables can be
121 initialized, constant data. Otherwise, they have to be filled in at
123 #if HAVE_DESIGNATED_INITIALIZERS
125 #define init_trigraph_map() /* Nothing. */
126 #define TRIGRAPH_MAP \
127 __extension__ const uchar _cpp_trigraph_map[UCHAR_MAX + 1] = {
130 #define s(p, v) [p] = v,
134 #define TRIGRAPH_MAP uchar _cpp_trigraph_map[UCHAR_MAX + 1] = { 0 }; \
135 static void init_trigraph_map PARAMS ((void)) { \
136 unsigned char *x = _cpp_trigraph_map;
139 #define s(p, v) x[p] = v;
144 s('=', '#') s(')', ']') s('!', '|')
145 s('(', '[') s('\'', '^') s('>', '}')
146 s('/', '\\') s('<', '{') s('-', '~')
153 /* Given a colon-separated list of file names PATH,
154 add all the names to the search path for include files. */
156 path_include (pfile, list, path)
167 /* Find the end of this name. */
169 while (*q != 0 && *q != PATH_SEPARATOR) q++;
172 /* An empty name in the path stands for the current directory. */
173 name = (char *) xmalloc (2);
179 /* Otherwise use the directory that is named. */
180 name = (char *) xmalloc (q - p + 1);
181 memcpy (name, p, q - p);
185 append_include_chain (pfile, name, path, path == SYSTEM);
187 /* Advance past this name. */
195 /* Append DIR to include path PATH. DIR must be allocated on the
196 heap; this routine takes responsibility for freeing it. CXX_AWARE
197 is non-zero if the header contains extern "C" guards for C++,
198 otherwise it is zero. */
200 append_include_chain (pfile, dir, path, cxx_aware)
206 struct cpp_pending *pend = CPP_OPTION (pfile, pending);
207 struct search_path *new;
216 _cpp_simplify_pathname (dir);
220 /* Dirs that don't exist are silently ignored. */
222 cpp_errno (pfile, DL_ERROR, dir);
223 else if (CPP_OPTION (pfile, verbose))
224 fprintf (stderr, _("ignoring nonexistent directory \"%s\"\n"), dir);
229 if (!S_ISDIR (st.st_mode))
231 cpp_error_with_line (pfile, DL_ERROR, 0, 0, "%s: Not a directory", dir);
237 if (len > pfile->max_include_len)
238 pfile->max_include_len = len;
240 new = (struct search_path *) xmalloc (sizeof (struct search_path));
243 INO_T_COPY (new->ino, st.st_ino);
244 new->dev = st.st_dev;
245 /* Both systm and after include file lists should be treated as system
246 include files since these two lists are really just a concatenation
247 of one "system" list. */
248 if (path == SYSTEM || path == AFTER)
249 new->sysp = cxx_aware ? 1 : 2;
252 new->name_map = NULL;
257 case BRACKET: APPEND (pend, brack, new); break;
258 case SYSTEM: APPEND (pend, systm, new); break;
259 case AFTER: APPEND (pend, after, new); break;
263 /* Handle a duplicated include path. PREV is the link in the chain
264 before the duplicate, or NULL if the duplicate is at the head of
265 the chain. The duplicate is removed from the chain and freed.
267 static struct search_path *
268 remove_dup_dir (pfile, prev, head_ptr)
270 struct search_path *prev;
271 struct search_path **head_ptr;
273 struct search_path *cur;
278 prev->next = cur->next;
283 *head_ptr = cur->next;
286 if (CPP_OPTION (pfile, verbose))
287 fprintf (stderr, _("ignoring duplicate directory \"%s\"\n"), cur->name);
289 free ((PTR) cur->name);
295 /* Remove duplicate non-system directories for which there is an equivalent
296 system directory latter in the chain. The range for removal is between
297 *HEAD_PTR and END. Returns the directory before END, or NULL if none.
298 This algorithm is quadratic in the number system directories, which is
299 acceptable since there aren't usually that many of them. */
300 static struct search_path *
301 remove_dup_nonsys_dirs (pfile, head_ptr, end)
303 struct search_path **head_ptr;
304 struct search_path *end;
306 struct search_path *prev, *cur, *other;
308 for (cur = *head_ptr; cur; cur = cur->next)
312 for (other = *head_ptr, prev = NULL;
314 other = other ? other->next : *head_ptr)
317 && INO_T_EQ (cur->ino, other->ino)
318 && cur->dev == other->dev)
320 other = remove_dup_dir (pfile, prev, head_ptr);
321 if (CPP_OPTION (pfile, verbose))
323 _(" as it is a non-system directory that duplicates a system directory\n"));
333 /* Remove duplicate directories from a chain. Returns the tail of the
334 chain, or NULL if the chain is empty. This algorithm is quadratic
335 in the number of -I switches, which is acceptable since there
336 aren't usually that many of them. */
337 static struct search_path *
338 remove_dup_dirs (pfile, head_ptr)
340 struct search_path **head_ptr;
342 struct search_path *prev = NULL, *cur, *other;
344 for (cur = *head_ptr; cur; cur = cur->next)
346 for (other = *head_ptr; other != cur; other = other->next)
347 if (INO_T_EQ (cur->ino, other->ino) && cur->dev == other->dev)
349 cur = remove_dup_dir (pfile, prev, head_ptr);
358 /* Merge the four include chains together in the order quote, bracket,
359 system, after. Remove duplicate dirs (as determined by
360 INO_T_EQ()). The system_include and after_include chains are never
361 referred to again after this function; all access is through the
362 bracket_include path. */
364 merge_include_chains (pfile)
367 struct search_path *quote, *brack, *systm, *qtail;
369 struct cpp_pending *pend = CPP_OPTION (pfile, pending);
371 quote = pend->quote_head;
372 brack = pend->brack_head;
373 systm = pend->systm_head;
374 qtail = pend->quote_tail;
376 /* Paste together bracket, system, and after include chains. */
378 pend->systm_tail->next = pend->after_head;
380 systm = pend->after_head;
383 pend->brack_tail->next = systm;
387 /* This is a bit tricky. First we drop non-system dupes of system
388 directories from the merged bracket-include list. Next we drop
389 dupes from the bracket and quote include lists. Then we drop
390 non-system dupes from the merged quote-include list. Finally,
391 if qtail and brack are the same directory, we cut out brack and
392 move brack up to point to qtail.
394 We can't just merge the lists and then uniquify them because
395 then we may lose directories from the <> search path that should
396 be there; consider -Ifoo -Ibar -I- -Ifoo -Iquux. It is however
397 safe to treat -Ibar -Ifoo -I- -Ifoo -Iquux as if written
398 -Ibar -I- -Ifoo -Iquux. */
400 remove_dup_nonsys_dirs (pfile, &brack, systm);
401 remove_dup_dirs (pfile, &brack);
405 qtail = remove_dup_dirs (pfile, "e);
408 qtail = remove_dup_nonsys_dirs (pfile, "e, brack);
410 /* If brack == qtail, remove brack as it's simpler. */
411 if (qtail && brack && INO_T_EQ (qtail->ino, brack->ino)
412 && qtail->dev == brack->dev)
413 brack = remove_dup_dir (pfile, qtail, "e);
418 CPP_OPTION (pfile, quote_include) = quote;
419 CPP_OPTION (pfile, bracket_include) = brack;
422 /* A set of booleans indicating what CPP features each source language
428 char extended_numbers;
430 char dollars_in_ident;
431 char cplusplus_comments;
435 /* ??? Enable $ in identifiers in assembly? */
436 static const struct lang_flags lang_defaults[] =
437 { /* c99 c++ xnum std dollar c++comm digr */
438 /* GNUC89 */ { 0, 0, 1, 0, 1, 1, 1 },
439 /* GNUC99 */ { 1, 0, 1, 0, 1, 1, 1 },
440 /* STDC89 */ { 0, 0, 0, 1, 0, 0, 0 },
441 /* STDC94 */ { 0, 0, 0, 1, 0, 0, 1 },
442 /* STDC99 */ { 1, 0, 1, 1, 0, 1, 1 },
443 /* GNUCXX */ { 0, 1, 1, 0, 1, 1, 1 },
444 /* CXX98 */ { 0, 1, 1, 1, 0, 1, 1 },
445 /* ASM */ { 0, 0, 1, 0, 0, 1, 0 }
448 /* Sets internal flags correctly for a given language. */
450 cpp_set_lang (pfile, lang)
454 const struct lang_flags *l = &lang_defaults[(int) lang];
456 CPP_OPTION (pfile, lang) = lang;
458 CPP_OPTION (pfile, c99) = l->c99;
459 CPP_OPTION (pfile, cplusplus) = l->cplusplus;
460 CPP_OPTION (pfile, extended_numbers) = l->extended_numbers;
461 CPP_OPTION (pfile, std) = l->std;
462 CPP_OPTION (pfile, trigraphs) = l->std;
463 CPP_OPTION (pfile, dollars_in_ident) = l->dollars_in_ident;
464 CPP_OPTION (pfile, cplusplus_comments) = l->cplusplus_comments;
465 CPP_OPTION (pfile, digraphs) = l->digraphs;
469 static int opt_comp PARAMS ((const void *, const void *));
471 /* Run-time sorting of options array. */
476 return strcmp (((struct cl_option *) p1)->opt_text,
477 ((struct cl_option *) p2)->opt_text);
481 /* init initializes library global state. It might not need to
482 do anything depending on the platform and compiler. */
486 static int initialized = 0;
493 /* For non-ASCII hosts, the cl_options array needs to be sorted at
495 qsort (cl_options, N_OPTS, sizeof (struct cl_option), opt_comp);
498 /* Set up the trigraph map. This doesn't need to do anything if
499 we were compiled with a compiler that supports C99 designated
501 init_trigraph_map ();
505 /* Initialize a cpp_reader structure. */
507 cpp_create_reader (lang)
512 /* Initialise this instance of the library if it hasn't been already. */
515 pfile = (cpp_reader *) xcalloc (1, sizeof (cpp_reader));
517 cpp_set_lang (pfile, lang);
518 CPP_OPTION (pfile, warn_import) = 1;
519 CPP_OPTION (pfile, warn_multichar) = 1;
520 CPP_OPTION (pfile, discard_comments) = 1;
521 CPP_OPTION (pfile, discard_comments_in_macro_exp) = 1;
522 CPP_OPTION (pfile, show_column) = 1;
523 CPP_OPTION (pfile, tabstop) = 8;
524 CPP_OPTION (pfile, operator_names) = 1;
525 CPP_OPTION (pfile, warn_endif_labels) = 1;
526 CPP_OPTION (pfile, warn_long_long) = !CPP_OPTION (pfile, c99);
528 CPP_OPTION (pfile, pending) =
529 (struct cpp_pending *) xcalloc (1, sizeof (struct cpp_pending));
531 /* Default CPP arithmetic to something sensible for the host for the
532 benefit of dumb users like fix-header. */
533 CPP_OPTION (pfile, precision) = CHAR_BIT * sizeof (long);
534 CPP_OPTION (pfile, char_precision) = CHAR_BIT;
535 CPP_OPTION (pfile, wchar_precision) = CHAR_BIT * sizeof (int);
536 CPP_OPTION (pfile, int_precision) = CHAR_BIT * sizeof (int);
537 CPP_OPTION (pfile, unsigned_char) = 0;
538 CPP_OPTION (pfile, unsigned_wchar) = 1;
540 /* Initialise the line map. Start at logical line 1, so we can use
541 a line number of zero for special states. */
542 init_line_maps (&pfile->line_maps);
545 /* Initialize lexer state. */
546 pfile->state.save_comments = ! CPP_OPTION (pfile, discard_comments);
548 /* Set up static tokens. */
549 pfile->avoid_paste.type = CPP_PADDING;
550 pfile->avoid_paste.val.source = NULL;
551 pfile->eof.type = CPP_EOF;
552 pfile->eof.flags = 0;
554 /* Create a token buffer for the lexer. */
555 _cpp_init_tokenrun (&pfile->base_run, 250);
556 pfile->cur_run = &pfile->base_run;
557 pfile->cur_token = pfile->base_run.base;
559 /* Initialise the base context. */
560 pfile->context = &pfile->base_context;
561 pfile->base_context.macro = 0;
562 pfile->base_context.prev = pfile->base_context.next = 0;
564 /* Aligned and unaligned storage. */
565 pfile->a_buff = _cpp_get_buff (pfile, 0);
566 pfile->u_buff = _cpp_get_buff (pfile, 0);
568 /* The expression parser stack. */
569 _cpp_expand_op_stack (pfile);
571 /* Initialise the buffer obstack. */
572 gcc_obstack_init (&pfile->buffer_ob);
574 _cpp_init_includes (pfile);
579 /* Free resources used by PFILE. Accessing PFILE after this function
580 returns leads to undefined behaviour. Returns the error count. */
585 struct search_path *dir, *dirn;
586 cpp_context *context, *contextn;
587 tokenrun *run, *runn;
589 free_chain (CPP_OPTION (pfile, pending)->include_head);
590 free (CPP_OPTION (pfile, pending));
591 free (pfile->op_stack);
593 while (CPP_BUFFER (pfile) != NULL)
594 _cpp_pop_buffer (pfile);
597 free (pfile->out.base);
599 if (pfile->macro_buffer)
601 free ((PTR) pfile->macro_buffer);
602 pfile->macro_buffer = NULL;
603 pfile->macro_buffer_len = 0;
607 deps_free (pfile->deps);
608 obstack_free (&pfile->buffer_ob, 0);
610 _cpp_destroy_hashtable (pfile);
611 _cpp_cleanup_includes (pfile);
613 _cpp_free_buff (pfile->a_buff);
614 _cpp_free_buff (pfile->u_buff);
615 _cpp_free_buff (pfile->free_buffs);
617 for (run = &pfile->base_run; run; run = runn)
621 if (run != &pfile->base_run)
625 for (dir = CPP_OPTION (pfile, quote_include); dir; dir = dirn)
628 free ((PTR) dir->name);
632 for (context = pfile->base_context.next; context; context = contextn)
634 contextn = context->next;
638 free_line_maps (&pfile->line_maps);
642 /* This structure defines one built-in identifier. A node will be
643 entered in the hash table under the name NAME, with value VALUE.
645 There are two tables of these. builtin_array holds all the
646 "builtin" macros: these are handled by builtin_macro() in
647 cppmacro.c. Builtin is somewhat of a misnomer -- the property of
648 interest is that these macros require special code to compute their
649 expansions. The value is a "builtin_type" enumerator.
651 operator_array holds the C++ named operators. These are keywords
652 which act as aliases for punctuators. In C++, they cannot be
653 altered through #define, and #if recognizes them as operators. In
654 C, these are not entered into the hash table at all (but see
655 <iso646.h>). The value is a token-type enumerator. */
660 unsigned short value;
663 #define B(n, t) { DSC(n), t }
664 static const struct builtin builtin_array[] =
666 B("__TIME__", BT_TIME),
667 B("__DATE__", BT_DATE),
668 B("__FILE__", BT_FILE),
669 B("__BASE_FILE__", BT_BASE_FILE),
670 B("__LINE__", BT_SPECLINE),
671 B("__INCLUDE_LEVEL__", BT_INCLUDE_LEVEL),
672 /* Keep builtins not used for -traditional-cpp at the end, and
673 update init_builtins() if any more are added. */
674 B("_Pragma", BT_PRAGMA),
675 B("__STDC__", BT_STDC),
678 static const struct builtin operator_array[] =
680 B("and", CPP_AND_AND),
681 B("and_eq", CPP_AND_EQ),
682 B("bitand", CPP_AND),
684 B("compl", CPP_COMPL),
686 B("not_eq", CPP_NOT_EQ),
688 B("or_eq", CPP_OR_EQ),
690 B("xor_eq", CPP_XOR_EQ)
694 /* Mark the C++ named operators in the hash table. */
696 mark_named_operators (pfile)
699 const struct builtin *b;
701 for (b = operator_array;
702 b < (operator_array + ARRAY_SIZE (operator_array));
705 cpp_hashnode *hp = cpp_lookup (pfile, b->name, b->len);
706 hp->flags |= NODE_OPERATOR;
707 hp->value.operator = b->value;
711 /* Subroutine of cpp_read_main_file; reads the builtins table above and
712 enters them, and language-specific macros, into the hash table. */
714 init_builtins (pfile)
717 const struct builtin *b;
718 size_t n = ARRAY_SIZE (builtin_array);
720 if (CPP_OPTION (pfile, traditional))
723 for(b = builtin_array; b < builtin_array + n; b++)
725 cpp_hashnode *hp = cpp_lookup (pfile, b->name, b->len);
727 hp->flags |= NODE_BUILTIN | NODE_WARN;
728 hp->value.builtin = b->value;
731 if (CPP_OPTION (pfile, cplusplus))
732 _cpp_define_builtin (pfile, "__cplusplus 1");
733 else if (CPP_OPTION (pfile, lang) == CLK_ASM)
734 _cpp_define_builtin (pfile, "__ASSEMBLER__ 1");
735 else if (CPP_OPTION (pfile, lang) == CLK_STDC94)
736 _cpp_define_builtin (pfile, "__STDC_VERSION__ 199409L");
737 else if (CPP_OPTION (pfile, c99))
738 _cpp_define_builtin (pfile, "__STDC_VERSION__ 199901L");
740 if (CPP_OPTION (pfile, objc))
741 _cpp_define_builtin (pfile, "__OBJC__ 1");
743 if (pfile->cb.register_builtins)
744 (*pfile->cb.register_builtins) (pfile);
747 /* And another subroutine. This one sets up the standard include path. */
749 init_standard_includes (pfile)
753 const struct default_include *p;
754 const char *specd_prefix = CPP_OPTION (pfile, include_prefix);
756 /* Several environment variables may add to the include search path.
757 CPATH specifies an additional list of directories to be searched
758 as if specified with -I, while C_INCLUDE_PATH, CPLUS_INCLUDE_PATH,
759 etc. specify an additional list of directories to be searched as
760 if specified with -isystem, for the language indicated. */
762 GET_ENVIRONMENT (path, "CPATH");
763 if (path != 0 && *path != 0)
764 path_include (pfile, path, BRACKET);
766 switch ((CPP_OPTION (pfile, objc) << 1) + CPP_OPTION (pfile, cplusplus))
769 GET_ENVIRONMENT (path, "C_INCLUDE_PATH");
772 GET_ENVIRONMENT (path, "CPLUS_INCLUDE_PATH");
775 GET_ENVIRONMENT (path, "OBJC_INCLUDE_PATH");
778 GET_ENVIRONMENT (path, "OBJCPLUS_INCLUDE_PATH");
781 if (path != 0 && *path != 0)
782 path_include (pfile, path, SYSTEM);
784 /* Search "translated" versions of GNU directories.
785 These have /usr/local/lib/gcc... replaced by specd_prefix. */
786 if (specd_prefix != 0 && cpp_GCC_INCLUDE_DIR_len)
788 /* Remove the `include' from /usr/local/lib/gcc.../include.
789 GCC_INCLUDE_DIR will always end in /include. */
790 int default_len = cpp_GCC_INCLUDE_DIR_len;
791 char *default_prefix = (char *) alloca (default_len + 1);
792 int specd_len = strlen (specd_prefix);
794 memcpy (default_prefix, cpp_GCC_INCLUDE_DIR, default_len);
795 default_prefix[default_len] = '\0';
797 for (p = cpp_include_defaults; p->fname; p++)
799 /* Some standard dirs are only for C++. */
801 || (CPP_OPTION (pfile, cplusplus)
802 && !CPP_OPTION (pfile, no_standard_cplusplus_includes)))
804 /* Does this dir start with the prefix? */
805 if (!memcmp (p->fname, default_prefix, default_len))
807 /* Yes; change prefix and add to search list. */
808 int flen = strlen (p->fname);
809 int this_len = specd_len + flen - default_len;
810 char *str = (char *) xmalloc (this_len + 1);
811 memcpy (str, specd_prefix, specd_len);
812 memcpy (str + specd_len,
813 p->fname + default_len,
814 flen - default_len + 1);
816 append_include_chain (pfile, str, SYSTEM, p->cxx_aware);
822 /* Search ordinary names for GNU include directories. */
823 for (p = cpp_include_defaults; p->fname; p++)
825 /* Some standard dirs are only for C++. */
827 || (CPP_OPTION (pfile, cplusplus)
828 && !CPP_OPTION (pfile, no_standard_cplusplus_includes)))
830 char *str = update_path (p->fname, p->component);
831 append_include_chain (pfile, str, SYSTEM, p->cxx_aware);
836 /* Pushes a command line -imacro and -include file indicated by P onto
837 the buffer stack. Returns non-zero if successful. */
839 push_include (pfile, p)
841 struct pending_option *p;
845 /* Later: maybe update this to use the #include "" search path
846 if cpp_read_file fails. */
847 header.type = CPP_STRING;
848 header.val.str.text = (const unsigned char *) p->arg;
849 header.val.str.len = strlen (p->arg);
850 /* Make the command line directive take up a line. */
853 return _cpp_execute_include (pfile, &header, IT_CMDLINE);
856 /* Frees a pending_option chain. */
859 struct pending_option *head;
861 struct pending_option *next;
871 /* Sanity-checks are dependent on command-line options, so it is
872 called as a subroutine of cpp_read_main_file (). */
874 static void sanity_checks PARAMS ((cpp_reader *));
875 static void sanity_checks (pfile)
879 size_t max_precision = 2 * CHAR_BIT * sizeof (cpp_num_part);
881 /* Sanity checks for assumptions about CPP arithmetic and target
882 type precisions made by cpplib. */
885 cpp_error (pfile, DL_ICE, "cppchar_t must be an unsigned type");
887 if (CPP_OPTION (pfile, precision) > max_precision)
888 cpp_error (pfile, DL_ICE,
889 "preprocessor arithmetic has maximum precision of %lu bits; target requires %lu bits",
890 (unsigned long) max_precision,
891 (unsigned long) CPP_OPTION (pfile, precision));
893 if (CPP_OPTION (pfile, precision) < CPP_OPTION (pfile, int_precision))
894 cpp_error (pfile, DL_ICE,
895 "CPP arithmetic must be at least as precise as a target int");
897 if (CPP_OPTION (pfile, char_precision) < 8)
898 cpp_error (pfile, DL_ICE, "target char is less than 8 bits wide");
900 if (CPP_OPTION (pfile, wchar_precision) < CPP_OPTION (pfile, char_precision))
901 cpp_error (pfile, DL_ICE,
902 "target wchar_t is narrower than target char");
904 if (CPP_OPTION (pfile, int_precision) < CPP_OPTION (pfile, char_precision))
905 cpp_error (pfile, DL_ICE,
906 "target int is narrower than target char");
908 /* This is assumed in eval_token() and could be fixed if necessary. */
909 if (sizeof (cppchar_t) > sizeof (cpp_num_part))
910 cpp_error (pfile, DL_ICE, "CPP half-integer narrower than CPP character");
912 if (CPP_OPTION (pfile, wchar_precision) > BITS_PER_CPPCHAR_T)
913 cpp_error (pfile, DL_ICE,
914 "CPP on this host cannot handle wide character constants over %lu bits, but the target requires %lu bits",
915 (unsigned long) BITS_PER_CPPCHAR_T,
916 (unsigned long) CPP_OPTION (pfile, wchar_precision));
919 # define sanity_checks(PFILE)
922 /* Add a dependency target. Can be called any number of times before
923 cpp_read_main_file(). If no targets have been added before
924 cpp_read_main_file(), then the default target is used. */
926 cpp_add_dependency_target (pfile, target, quote)
932 pfile->deps = deps_init ();
934 deps_add_target (pfile->deps, target, quote);
937 /* This is called after options have been parsed, and partially
938 processed. Setup for processing input from the file named FNAME,
939 or stdin if it is the empty string. Return the original filename
940 on success (e.g. foo.i->foo.c), or NULL on failure. */
942 cpp_read_main_file (pfile, fname, table)
947 sanity_checks (pfile);
949 post_options (pfile);
951 /* The front ends don't set up the hash table until they have
952 finished processing the command line options, so initializing the
953 hashtable is deferred until now. */
954 _cpp_init_hashtable (pfile, table);
956 /* Set up the include search path now. */
957 if (! CPP_OPTION (pfile, no_standard_includes))
958 init_standard_includes (pfile);
960 merge_include_chains (pfile);
962 /* With -v, print the list of dirs to search. */
963 if (CPP_OPTION (pfile, verbose))
965 struct search_path *l;
966 fprintf (stderr, _("#include \"...\" search starts here:\n"));
967 for (l = CPP_OPTION (pfile, quote_include); l; l = l->next)
969 if (l == CPP_OPTION (pfile, bracket_include))
970 fprintf (stderr, _("#include <...> search starts here:\n"));
971 fprintf (stderr, " %s\n", l->name);
973 fprintf (stderr, _("End of search list.\n"));
976 if (CPP_OPTION (pfile, deps.style) != DEPS_NONE)
979 pfile->deps = deps_init ();
981 /* Set the default target (if there is none already). */
982 deps_add_default_target (pfile->deps, fname);
985 /* Open the main input file. */
986 if (!_cpp_read_file (pfile, fname))
989 /* Set this here so the client can change the option if it wishes,
990 and after stacking the main file so we don't trace the main
992 pfile->line_maps.trace_includes = CPP_OPTION (pfile, print_include_names);
994 /* For foo.i, read the original filename foo.c now, for the benefit
995 of the front ends. */
996 if (CPP_OPTION (pfile, preprocessed))
997 read_original_filename (pfile);
999 return pfile->map->to_file;
1002 /* For preprocessed files, if the first tokens are of the form # NUM.
1003 handle the directive so we know the original file name. This will
1004 generate file_change callbacks, which the front ends must handle
1005 appropriately given their state of initialization. */
1007 read_original_filename (pfile)
1010 const cpp_token *token, *token1;
1012 /* Lex ahead; if the first tokens are of the form # NUM, then
1013 process the directive, otherwise back up. */
1014 token = _cpp_lex_direct (pfile);
1015 if (token->type == CPP_HASH)
1017 token1 = _cpp_lex_direct (pfile);
1018 _cpp_backup_tokens (pfile, 1);
1020 /* If it's a #line directive, handle it. */
1021 if (token1->type == CPP_NUMBER)
1023 _cpp_handle_directive (pfile, token->flags & PREV_WHITE);
1028 /* Backup as if nothing happened. */
1029 _cpp_backup_tokens (pfile, 1);
1032 /* Handle pending command line options: -D, -U, -A, -imacros and
1033 -include. This should be called after debugging has been properly
1034 set up in the front ends. */
1036 cpp_finish_options (pfile)
1039 /* Mark named operators before handling command line macros. */
1040 if (CPP_OPTION (pfile, cplusplus) && CPP_OPTION (pfile, operator_names))
1041 mark_named_operators (pfile);
1043 /* Install builtins and process command line macros etc. in the order
1044 they appeared, but only if not already preprocessed. */
1045 if (! CPP_OPTION (pfile, preprocessed))
1047 struct pending_option *p;
1049 _cpp_do_file_change (pfile, LC_RENAME, _("<built-in>"), 1, 0);
1050 init_builtins (pfile);
1051 _cpp_do_file_change (pfile, LC_RENAME, _("<command line>"), 1, 0);
1052 for (p = CPP_OPTION (pfile, pending)->directive_head; p; p = p->next)
1053 (*p->handler) (pfile, p->arg);
1055 /* Scan -imacros files after -D, -U, but before -include.
1056 pfile->next_include_file is NULL, so _cpp_pop_buffer does not
1057 push -include files. */
1058 for (p = CPP_OPTION (pfile, pending)->imacros_head; p; p = p->next)
1059 if (push_include (pfile, p))
1060 cpp_scan_nooutput (pfile);
1062 pfile->next_include_file = &CPP_OPTION (pfile, pending)->include_head;
1063 _cpp_maybe_push_include_file (pfile);
1066 pfile->first_unused_line = pfile->line;
1068 free_chain (CPP_OPTION (pfile, pending)->imacros_head);
1069 free_chain (CPP_OPTION (pfile, pending)->directive_head);
1072 /* Push the next buffer on the stack given by -include, if any. */
1074 _cpp_maybe_push_include_file (pfile)
1077 if (pfile->next_include_file)
1079 struct pending_option *head = *pfile->next_include_file;
1081 while (head && !push_include (pfile, head))
1085 pfile->next_include_file = &head->next;
1088 /* All done; restore the line map from <command line>. */
1089 _cpp_do_file_change (pfile, LC_RENAME,
1090 pfile->line_maps.maps[0].to_file, 1, 0);
1091 /* Don't come back here again. */
1092 pfile->next_include_file = NULL;
1097 /* This is called at the end of preprocessing. It pops the last
1098 buffer and writes dependency output, and returns the number of
1101 Maybe it should also reset state, such that you could call
1102 cpp_start_read with a new filename to restart processing. */
1104 cpp_finish (pfile, deps_stream)
1108 /* Warn about unused macros before popping the final buffer. */
1109 if (CPP_OPTION (pfile, warn_unused_macros))
1110 cpp_forall_identifiers (pfile, _cpp_warn_if_unused_macro, NULL);
1112 /* cpplex.c leaves the final buffer on the stack. This it so that
1113 it returns an unending stream of CPP_EOFs to the client. If we
1114 popped the buffer, we'd dereference a NULL buffer pointer and
1115 segfault. It's nice to allow the client to do worry-free excess
1116 cpp_get_token calls. */
1117 while (pfile->buffer)
1118 _cpp_pop_buffer (pfile);
1120 /* Don't write the deps file if there are errors. */
1121 if (CPP_OPTION (pfile, deps.style) != DEPS_NONE
1122 && deps_stream && pfile->errors == 0)
1124 deps_write (pfile->deps, deps_stream, 72);
1126 if (CPP_OPTION (pfile, deps.phony_targets))
1127 deps_phony_targets (pfile->deps, deps_stream);
1130 /* Report on headers that could use multiple include guards. */
1131 if (CPP_OPTION (pfile, print_include_names))
1132 _cpp_report_missing_guards (pfile);
1134 return pfile->errors;
1137 /* Add a directive to be handled later in the initialization phase. */
1139 new_pending_directive (pend, text, handler)
1140 struct cpp_pending *pend;
1142 cl_directive_handler handler;
1144 struct pending_option *o = (struct pending_option *)
1145 xmalloc (sizeof (struct pending_option));
1149 o->handler = handler;
1150 APPEND (pend, directive, o);
1153 /* Irix6 "cc -n32" and OSF4 cc have problems with char foo[] = ("string");
1154 I.e. a const string initializer with parens around it. That is
1155 what N_("string") resolves to, so we make no_* be macros instead. */
1156 #define no_ass N_("assertion missing after %s")
1157 #define no_dir N_("directory name missing after %s")
1158 #define no_fil N_("file name missing after %s")
1159 #define no_mac N_("macro name missing after %s")
1160 #define no_pth N_("path name missing after %s")
1162 /* This is the list of all command line options, with the leading
1163 "-" removed. It must be sorted in ASCII collating order. */
1164 #define COMMAND_LINE_OPTIONS \
1165 DEF_OPT("A", no_ass, OPT_A) \
1166 DEF_OPT("D", no_mac, OPT_D) \
1167 DEF_OPT("I", no_dir, OPT_I) \
1168 DEF_OPT("U", no_mac, OPT_U) \
1169 DEF_OPT("idirafter", no_dir, OPT_idirafter) \
1170 DEF_OPT("imacros", no_fil, OPT_imacros) \
1171 DEF_OPT("include", no_fil, OPT_include) \
1172 DEF_OPT("iprefix", no_pth, OPT_iprefix) \
1173 DEF_OPT("isystem", no_dir, OPT_isystem) \
1174 DEF_OPT("iwithprefix", no_dir, OPT_iwithprefix) \
1175 DEF_OPT("iwithprefixbefore", no_dir, OPT_iwithprefixbefore)
1177 #define DEF_OPT(text, msg, code) code,
1180 COMMAND_LINE_OPTIONS
1187 const char *opt_text;
1190 enum opt_code opt_code;
1193 #define DEF_OPT(text, msg, code) { text, msg, sizeof(text) - 1, code },
1195 static struct cl_option cl_options[] =
1197 static const struct cl_option cl_options[] =
1200 COMMAND_LINE_OPTIONS
1203 #undef COMMAND_LINE_OPTIONS
1205 /* Perform a binary search to find which, if any, option the given
1206 command-line matches. Returns its index in the option array,
1207 negative on failure. Complications arise since some options can be
1208 suffixed with an argument, and multiple complete matches can occur,
1209 e.g. -pedantic and -pedantic-errors. */
1211 parse_option (input)
1214 unsigned int md, mn, mx;
1225 opt_len = cl_options[md].opt_len;
1226 comp = memcmp (input, cl_options[md].opt_text, opt_len);
1234 if (input[opt_len] == '\0')
1236 /* We were passed more text. If the option takes an argument,
1237 we may match a later option or we may have been passed the
1238 argument. The longest possible option match succeeds.
1239 If the option takes no arguments we have not matched and
1240 continue the search (e.g. input="stdc++" match was "stdc"). */
1242 if (cl_options[md].msg)
1244 /* Scan forwards. If we get an exact match, return it.
1245 Otherwise, return the longest option-accepting match.
1246 This loops no more than twice with current options. */
1248 for (; mn < (unsigned int) N_OPTS; mn++)
1250 opt_len = cl_options[mn].opt_len;
1251 if (memcmp (input, cl_options[mn].opt_text, opt_len))
1253 if (input[opt_len] == '\0')
1255 if (cl_options[mn].msg)
1266 /* Handle one command-line option in (argc, argv).
1267 Can be called multiple times, to handle multiple sets of options.
1268 Returns number of strings consumed. */
1270 cpp_handle_option (pfile, argc, argv)
1276 struct cpp_pending *pend = CPP_OPTION (pfile, pending);
1279 enum opt_code opt_code;
1281 const char *arg = 0;
1283 /* Skip over '-'. */
1284 opt_index = parse_option (&argv[i][1]);
1288 opt_code = cl_options[opt_index].opt_code;
1289 if (cl_options[opt_index].msg)
1291 arg = &argv[i][cl_options[opt_index].opt_len + 1];
1297 cpp_error (pfile, DL_ERROR,
1298 cl_options[opt_index].msg, argv[i - 1]);
1306 case N_OPTS: /* Shut GCC up. */
1310 new_pending_directive (pend, arg, cpp_define);
1313 CPP_OPTION (pfile, include_prefix) = arg;
1314 CPP_OPTION (pfile, include_prefix_len) = strlen (arg);
1320 /* -A with an argument beginning with '-' acts as
1321 #unassert on whatever immediately follows the '-'.
1322 If "-" is the whole argument, we eliminate all
1323 predefined macros and assertions, including those
1324 that were specified earlier on the command line.
1325 That way we can get rid of any that were passed
1326 automatically in from GCC. */
1330 free_chain (pend->directive_head);
1331 pend->directive_head = NULL;
1332 pend->directive_tail = NULL;
1335 new_pending_directive (pend, arg + 1, cpp_unassert);
1338 new_pending_directive (pend, arg, cpp_assert);
1341 new_pending_directive (pend, arg, cpp_undef);
1343 case OPT_I: /* Add directory to path for includes. */
1344 if (!strcmp (arg, "-"))
1347 Use the preceding -I directories for #include "..."
1348 but not #include <...>.
1349 Don't search the directory of the present file
1350 for #include "...". (Note that -I. -I- is not the same as
1351 the default setup; -I. uses the compiler's working dir.) */
1352 if (! CPP_OPTION (pfile, ignore_srcdir))
1354 pend->quote_head = pend->brack_head;
1355 pend->quote_tail = pend->brack_tail;
1356 pend->brack_head = 0;
1357 pend->brack_tail = 0;
1358 CPP_OPTION (pfile, ignore_srcdir) = 1;
1362 cpp_error (pfile, DL_ERROR, "-I- specified twice");
1367 append_include_chain (pfile, xstrdup (arg), BRACKET, 0);
1370 /* Add directory to beginning of system include path, as a system
1371 include directory. */
1372 append_include_chain (pfile, xstrdup (arg), SYSTEM, 0);
1377 struct pending_option *o = (struct pending_option *)
1378 xmalloc (sizeof (struct pending_option));
1382 if (opt_code == OPT_include)
1383 APPEND (pend, include, o);
1385 APPEND (pend, imacros, o);
1388 case OPT_iwithprefix:
1389 /* Add directory to end of path for includes,
1390 with the default prefix at the front of its name. */
1392 case OPT_iwithprefixbefore:
1393 /* Add directory to main path for includes,
1394 with the default prefix at the front of its name. */
1401 if (CPP_OPTION (pfile, include_prefix) != 0)
1403 size_t ipl = CPP_OPTION (pfile, include_prefix_len);
1404 fname = xmalloc (ipl + len + 1);
1405 memcpy (fname, CPP_OPTION (pfile, include_prefix), ipl);
1406 memcpy (fname + ipl, arg, len + 1);
1408 else if (cpp_GCC_INCLUDE_DIR_len)
1410 fname = xmalloc (cpp_GCC_INCLUDE_DIR_len + len + 1);
1411 memcpy (fname, cpp_GCC_INCLUDE_DIR, cpp_GCC_INCLUDE_DIR_len);
1412 memcpy (fname + cpp_GCC_INCLUDE_DIR_len, arg, len + 1);
1415 fname = xstrdup (arg);
1417 append_include_chain (pfile, fname,
1418 opt_code == OPT_iwithprefix ? SYSTEM: BRACKET, 0);
1422 /* Add directory to end of path for includes. */
1423 append_include_chain (pfile, xstrdup (arg), AFTER, 0);
1430 /* Handle command-line options in (argc, argv).
1431 Can be called multiple times, to handle multiple sets of options.
1432 Returns if an unrecognized option is seen.
1433 Returns number of strings consumed. */
1435 cpp_handle_options (pfile, argc, argv)
1441 int strings_processed;
1443 for (i = 0; i < argc; i += strings_processed)
1445 strings_processed = cpp_handle_option (pfile, argc - i, argv + i);
1446 if (strings_processed == 0)
1454 post_options (pfile)
1457 /* -Wtraditional is not useful in C++ mode. */
1458 if (CPP_OPTION (pfile, cplusplus))
1459 CPP_OPTION (pfile, warn_traditional) = 0;
1461 /* Permanently disable macro expansion if we are rescanning
1462 preprocessed text. Read preprocesed source in ISO mode. */
1463 if (CPP_OPTION (pfile, preprocessed))
1465 pfile->state.prevent_expansion = 1;
1466 CPP_OPTION (pfile, traditional) = 0;
1469 /* Traditional CPP does not accurately track column information. */
1470 if (CPP_OPTION (pfile, traditional))
1471 CPP_OPTION (pfile, show_column) = 0;