1 /* Set up combined include path chain for the preprocessor.
2 Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
5 Broken out of cppinit.c and cppfiles.c and rewritten Mar 2003.
7 This program is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
23 #include "coretypes.h"
30 #include "c-incpath.h"
31 #include "cppdefault.h"
33 /* Windows does not natively support inodes, and neither does MSDOS.
34 Cygwin's emulation can generate non-unique inodes, so don't use it.
35 VMS has non-numeric inodes. */
37 # define INO_T_EQ(A, B) (!memcmp (&(A), &(B), sizeof (A)))
38 # define INO_T_COPY(DEST, SRC) memcpy(&(DEST), &(SRC), sizeof (SRC))
40 # if (defined _WIN32 && ! defined (_UWIN)) || defined __MSDOS__
41 # define INO_T_EQ(A, B) 0
43 # define INO_T_EQ(A, B) ((A) == (B))
45 # define INO_T_COPY(DEST, SRC) (DEST) = (SRC)
48 static void add_env_var_paths (const char *, int);
49 static void add_standard_paths (const char *, const char *, int);
50 static void free_path (struct cpp_dir
*, int);
51 static void merge_include_chains (cpp_reader
*, int);
52 static struct cpp_dir
*remove_duplicates (cpp_reader
*, struct cpp_dir
*,
54 struct cpp_dir
*, int);
56 /* Include chains heads and tails. */
57 static struct cpp_dir
*heads
[4];
58 static struct cpp_dir
*tails
[4];
59 static bool quote_ignores_source_dir
;
60 enum { REASON_QUIET
= 0, REASON_NOENT
, REASON_DUP
, REASON_DUP_SYS
};
62 /* Free an element of the include chain, possibly giving a reason. */
64 free_path (struct cpp_dir
*path
, int reason
)
70 fprintf (stderr
, _("ignoring duplicate directory \"%s\"\n"), path
->name
);
71 if (reason
== REASON_DUP_SYS
)
73 _(" as it is a non-system directory that duplicates a system directory\n"));
77 fprintf (stderr
, _("ignoring nonexistent directory \"%s\"\n"),
90 /* Read ENV_VAR for a PATH_SEPARATOR-separated list of file names; and
91 append all the names to the search path CHAIN. */
93 add_env_var_paths (const char *env_var
, int chain
)
97 GET_ENVIRONMENT (q
, env_var
);
102 for (p
= q
; *q
; p
= q
+ 1)
105 while (*q
!= 0 && *q
!= PATH_SEPARATOR
)
109 path
= xstrdup (".");
112 path
= xmalloc (q
- p
+ 1);
113 memcpy (path
, p
, q
- p
);
117 add_path (path
, chain
, chain
== SYSTEM
);
121 /* Append the standard include chain defined in cppdefault.c. */
123 add_standard_paths (const char *sysroot
, const char *iprefix
, int cxx_stdinc
)
125 const struct default_include
*p
;
128 if (iprefix
&& (len
= cpp_GCC_INCLUDE_DIR_len
) != 0)
130 /* Look for directories that start with the standard prefix.
131 "Translate" them, ie. replace /usr/local/lib/gcc... with
132 IPREFIX and search them first. */
133 for (p
= cpp_include_defaults
; p
->fname
; p
++)
135 if (!p
->cplusplus
|| cxx_stdinc
)
137 /* Should we be translating sysrooted dirs too? Assume
138 that iprefix and sysroot are mutually exclusive, for
140 if (sysroot
&& p
->add_sysroot
)
142 if (!strncmp (p
->fname
, cpp_GCC_INCLUDE_DIR
, len
))
144 char *str
= concat (iprefix
, p
->fname
+ len
, NULL
);
145 add_path (str
, SYSTEM
, p
->cxx_aware
);
151 for (p
= cpp_include_defaults
; p
->fname
; p
++)
153 if (!p
->cplusplus
|| cxx_stdinc
)
157 /* Should this directory start with the sysroot? */
158 if (sysroot
&& p
->add_sysroot
)
159 str
= concat (sysroot
, p
->fname
, NULL
);
161 str
= update_path (p
->fname
, p
->component
);
163 add_path (str
, SYSTEM
, p
->cxx_aware
);
168 /* For each duplicate path in chain HEAD, keep just the first one.
169 Remove each path in chain HEAD that also exists in chain SYSTEM.
170 Set the NEXT pointer of the last path in the resulting chain to
171 JOIN, unless it duplicates JOIN in which case the last path is
172 removed. Return the head of the resulting chain. Any of HEAD,
173 JOIN and SYSTEM can be NULL. */
174 static struct cpp_dir
*
175 remove_duplicates (cpp_reader
*pfile
, struct cpp_dir
*head
,
176 struct cpp_dir
*system
, struct cpp_dir
*join
,
179 struct cpp_dir
**pcur
, *tmp
, *cur
;
182 for (pcur
= &head
; *pcur
; )
184 int reason
= REASON_QUIET
;
188 if (stat (cur
->name
, &st
))
190 /* Dirs that don't exist are silently ignored, unless verbose. */
192 cpp_errno (pfile
, CPP_DL_ERROR
, cur
->name
);
194 reason
= REASON_NOENT
;
196 else if (!S_ISDIR (st
.st_mode
))
197 cpp_error_with_line (pfile
, CPP_DL_ERROR
, 0, 0,
198 "%s: not a directory", cur
->name
);
201 INO_T_COPY (cur
->ino
, st
.st_ino
);
202 cur
->dev
= st
.st_dev
;
204 /* Remove this one if it is in the system chain. */
205 reason
= REASON_DUP_SYS
;
206 for (tmp
= system
; tmp
; tmp
= tmp
->next
)
207 if (INO_T_EQ (tmp
->ino
, cur
->ino
) && tmp
->dev
== cur
->dev
)
212 /* Duplicate of something earlier in the same chain? */
214 for (tmp
= head
; tmp
!= cur
; tmp
= tmp
->next
)
215 if (INO_T_EQ (cur
->ino
, tmp
->ino
) && cur
->dev
== tmp
->dev
)
219 /* Last in the chain and duplicate of JOIN? */
220 && !(cur
->next
== NULL
&& join
221 && INO_T_EQ (cur
->ino
, join
->ino
)
222 && cur
->dev
== join
->dev
))
224 /* Unique, so keep this directory. */
231 /* Remove this entry from the chain. */
233 free_path (cur
, verbose
? reason
: REASON_QUIET
);
240 /* Merge the four include chains together in the order quote, bracket,
241 system, after. Remove duplicate dirs (as determined by
244 We can't just merge the lists and then uniquify them because then
245 we may lose directories from the <> search path that should be
246 there; consider -Ifoo -Ibar -I- -Ifoo -Iquux. It is however safe
247 to treat -Ibar -Ifoo -I- -Ifoo -Iquux as if written -Ibar -I- -Ifoo
250 merge_include_chains (cpp_reader
*pfile
, int verbose
)
252 /* Join the SYSTEM and AFTER chains. Remove duplicates in the
253 resulting SYSTEM chain. */
255 tails
[SYSTEM
]->next
= heads
[AFTER
];
257 heads
[SYSTEM
] = heads
[AFTER
];
258 heads
[SYSTEM
] = remove_duplicates (pfile
, heads
[SYSTEM
], 0, 0, verbose
);
260 /* Remove duplicates from BRACKET that are in itself or SYSTEM, and
261 join it to SYSTEM. */
262 heads
[BRACKET
] = remove_duplicates (pfile
, heads
[BRACKET
], heads
[SYSTEM
],
263 heads
[SYSTEM
], verbose
);
265 /* Remove duplicates from QUOTE that are in itself or SYSTEM, and
266 join it to BRACKET. */
267 heads
[QUOTE
] = remove_duplicates (pfile
, heads
[QUOTE
], heads
[SYSTEM
],
268 heads
[BRACKET
], verbose
);
270 /* If verbose, print the list of dirs to search. */
275 fprintf (stderr
, _("#include \"...\" search starts here:\n"));
276 for (p
= heads
[QUOTE
];; p
= p
->next
)
278 if (p
== heads
[BRACKET
])
279 fprintf (stderr
, _("#include <...> search starts here:\n"));
282 fprintf (stderr
, " %s\n", p
->name
);
284 fprintf (stderr
, _("End of search list.\n"));
288 /* Use given -I paths for #include "..." but not #include <...>, and
289 don't search the directory of the present file for #include "...".
290 (Note that -I. -I- is not the same as the default setup; -I. uses
291 the compiler's working dir.) */
293 split_quote_chain (void)
295 heads
[QUOTE
] = heads
[BRACKET
];
296 tails
[QUOTE
] = tails
[BRACKET
];
297 heads
[BRACKET
] = NULL
;
298 tails
[BRACKET
] = NULL
;
299 /* This is NOT redundant. */
300 quote_ignores_source_dir
= true;
303 /* Add P to the chain specified by CHAIN. */
306 add_cpp_dir_path (cpp_dir
*p
, int chain
)
309 tails
[chain
]->next
= p
;
315 /* Add PATH to the include chain CHAIN. PATH must be malloc-ed and
318 add_path (char *path
, int chain
, int cxx_aware
)
322 p
= xmalloc (sizeof (cpp_dir
));
325 if (chain
== SYSTEM
|| chain
== AFTER
)
326 p
->sysp
= 1 + !cxx_aware
;
332 tails
[chain
]->next
= p
;
338 /* Exported function to handle include chain merging, duplicate
339 removal, and registration with cpplib. */
341 register_include_chains (cpp_reader
*pfile
, const char *sysroot
,
342 const char *iprefix
, int stdinc
, int cxx_stdinc
,
345 static const char *const lang_env_vars
[] =
346 { "C_INCLUDE_PATH", "CPLUS_INCLUDE_PATH",
347 "OBJC_INCLUDE_PATH", "OBJCPLUS_INCLUDE_PATH" };
348 cpp_options
*cpp_opts
= cpp_get_options (pfile
);
349 size_t idx
= (cpp_opts
->objc
? 2: 0);
351 if (cpp_opts
->cplusplus
)
356 /* CPATH and language-dependent environment variables may add to the
358 add_env_var_paths ("CPATH", BRACKET
);
359 add_env_var_paths (lang_env_vars
[idx
], SYSTEM
);
361 /* Finally chain on the standard directories. */
363 add_standard_paths (sysroot
, iprefix
, cxx_stdinc
);
365 target_c_incpath
.extra_includes (stdinc
);
367 merge_include_chains (pfile
, verbose
);
369 cpp_set_include_chains (pfile
, heads
[QUOTE
], heads
[BRACKET
],
370 quote_ignores_source_dir
);
373 #ifndef TARGET_EXTRA_INCLUDES
374 static void hook_void_int(int u ATTRIBUTE_UNUSED
) { }
376 struct target_c_incpath_s target_c_incpath
= { hook_void_int
};