Makefile.in (stmp-docobjdir): New target; ensure $docobjdir exists.
[official-gcc.git] / gcc / cppfiles.c
blob9b0d5d05eb3daecb0c586c30e6d66e2b8c770e04
1 /* Part of CPP library. (include file handling)
2 Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1998,
3 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
4 Written by Per Bothner, 1994.
5 Based on CCCP program by Paul Rubin, June 1986
6 Adapted to ANSI C, Richard Stallman, Jan 1987
7 Split out of cpplib.c, Zack Weinberg, Oct 1998
9 This program is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
12 later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
23 #include "config.h"
24 #include "system.h"
25 #include <dirent.h>
26 #include "cpplib.h"
27 #include "cpphash.h"
28 #include "intl.h"
29 #include "mkdeps.h"
30 #include "splay-tree.h"
32 #ifndef O_BINARY
33 # define O_BINARY 0
34 #endif
36 /* If errno is inspected immediately after a system call fails, it will be
37 nonzero, and no error number will ever be zero. */
38 #ifndef ENOENT
39 # define ENOENT 0
40 #endif
41 #ifndef ENOTDIR
42 # define ENOTDIR 0
43 #endif
45 /* This structure is used for the table of all includes. */
46 struct include_file {
47 const char *name; /* actual path name of file */
48 const char *header_name; /* the original header found */
49 const cpp_hashnode *cmacro; /* macro, if any, preventing reinclusion. */
50 const struct cpp_path *foundhere;
51 /* location in search path where file was
52 found, for #include_next and sysp. */
53 const unsigned char *buffer; /* pointer to cached file contents */
54 struct stat st; /* copy of stat(2) data for file */
55 int fd; /* fd open on file (short term storage only) */
56 int err_no; /* errno obtained if opening a file failed */
57 unsigned short include_count; /* number of times file has been read */
58 unsigned char pch; /* 0: file not known to be a PCH.
59 1: file is a PCH
60 (on return from find_include_file).
61 2: file is not and never will be a valid
62 precompiled header.
63 3: file is always a valid precompiled
64 header. */
67 /* Variable length record files on VMS will have a stat size that includes
68 record control characters that won't be included in the read size. */
69 #ifdef VMS
70 # define FAB_C_VAR 2 /* variable length records (see Starlet fabdef.h) */
71 # define STAT_SIZE_TOO_BIG(ST) ((ST).st_fab_rfm == FAB_C_VAR)
72 #else
73 # define STAT_SIZE_TOO_BIG(ST) 0
74 #endif
76 /* The cmacro works like this: If it's NULL, the file is to be
77 included again. If it's NEVER_REREAD, the file is never to be
78 included again. Otherwise it is a macro hashnode, and the file is
79 to be included again if the macro is defined. */
80 #define NEVER_REREAD ((const cpp_hashnode *) -1)
81 #define DO_NOT_REREAD(inc) \
82 ((inc)->cmacro && ((inc)->cmacro == NEVER_REREAD \
83 || (inc)->cmacro->type == NT_MACRO))
84 #define NO_INCLUDE_PATH ((struct include_file *) -1)
85 #define INCLUDE_PCH_P(F) (((F)->pch & 1) != 0)
87 static struct file_name_map *read_name_map (cpp_reader *, const char *);
88 static char *read_filename_string (int, FILE *);
89 static char *remap_filename (cpp_reader *, char *, struct cpp_path *);
90 static struct cpp_path *search_from (cpp_reader *, enum include_type);
91 static struct include_file *find_include_file (cpp_reader *, const char *,
92 int, enum include_type);
93 static struct include_file *open_file (cpp_reader *, const char *);
94 static struct include_file *validate_pch (cpp_reader *, const char *,
95 const char *);
96 static struct include_file *open_file_pch (cpp_reader *, const char *);
97 static int read_include_file (cpp_reader *, struct include_file *);
98 static bool stack_include_file (cpp_reader *, struct include_file *);
99 static void purge_cache (struct include_file *);
100 static void destroy_node (splay_tree_value);
101 static int report_missing_guard (splay_tree_node, void *);
102 static splay_tree_node find_or_create_entry (cpp_reader *, const char *);
103 static void handle_missing_header (cpp_reader *, const char *, int);
104 static int remove_component_p (const char *);
106 /* Set up the splay tree we use to store information about all the
107 file names seen in this compilation. We also have entries for each
108 file we tried to open but failed; this saves system calls since we
109 don't try to open it again in future.
111 The key of each node is the file name, after processing by
112 cpp_simplify_path. The path name may or may not be absolute.
113 The path string has been malloced, as is automatically freed by
114 registering free () as the splay tree key deletion function.
116 A node's value is a pointer to a struct include_file, and is never
117 NULL. */
118 void
119 _cpp_init_includes (cpp_reader *pfile)
121 pfile->all_include_files
122 = splay_tree_new ((splay_tree_compare_fn) strcmp,
123 (splay_tree_delete_key_fn) free,
124 destroy_node);
127 /* Tear down the splay tree. */
128 void
129 _cpp_cleanup_includes (cpp_reader *pfile)
131 splay_tree_delete (pfile->all_include_files);
134 /* Free a node. The path string is automatically freed. */
135 static void
136 destroy_node (splay_tree_value v)
138 struct include_file *f = (struct include_file *) v;
140 if (f)
142 purge_cache (f);
143 free (f);
147 /* Mark a file to not be reread (e.g. #import, read failure). */
148 void
149 _cpp_never_reread (struct include_file *file)
151 file->cmacro = NEVER_REREAD;
154 /* Lookup a filename, which is simplified after making a copy, and
155 create an entry if none exists. */
156 static splay_tree_node
157 find_or_create_entry (cpp_reader *pfile, const char *fname)
159 splay_tree_node node;
160 struct include_file *file;
161 char *name = xstrdup (fname);
162 int saved_errno;
164 cpp_simplify_path (name);
165 saved_errno = errno;
166 node = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) name);
167 if (node)
168 free (name);
169 else
171 file = xcnew (struct include_file);
172 file->name = name;
173 file->header_name = name;
174 file->err_no = saved_errno;
175 node = splay_tree_insert (pfile->all_include_files,
176 (splay_tree_key) file->name,
177 (splay_tree_value) file);
180 return node;
183 /* Enter a file name in the splay tree, for the sake of cpp_included. */
184 void
185 _cpp_fake_include (cpp_reader *pfile, const char *fname)
187 find_or_create_entry (pfile, fname);
190 /* Given a file name, look it up in the cache; if there is no entry,
191 create one with a non-NULL value (regardless of success in opening
192 the file). If the file doesn't exist or is inaccessible, this
193 entry is flagged so we don't attempt to open it again in the
194 future. If the file isn't open, open it. The empty string is
195 interpreted as stdin.
197 Returns an include_file structure with an open file descriptor on
198 success, or NULL on failure. */
199 static struct include_file *
200 open_file (cpp_reader *pfile, const char *filename)
202 splay_tree_node nd = find_or_create_entry (pfile, filename);
203 struct include_file *file = (struct include_file *) nd->value;
205 if (file->err_no)
207 /* Ugh. handle_missing_header () needs errno to be set. */
208 errno = file->err_no;
209 return 0;
212 /* Don't reopen an idempotent file. */
213 if (DO_NOT_REREAD (file))
214 return file;
216 /* Don't reopen one which is already loaded. */
217 if (0 && file->buffer != NULL)
218 return file;
220 /* We used to open files in nonblocking mode, but that caused more
221 problems than it solved. Do take care not to acquire a
222 controlling terminal by mistake (this can't happen on sane
223 systems, but paranoia is a virtue).
225 Use the three-argument form of open even though we aren't
226 specifying O_CREAT, to defend against broken system headers.
228 O_BINARY tells some runtime libraries (notably DJGPP) not to do
229 newline translation; we can handle DOS line breaks just fine
230 ourselves.
232 Special case: the empty string is translated to stdin. */
234 if (filename[0] == '\0')
236 file->fd = 0;
237 #ifdef __DJGPP__
238 /* For DJGPP redirected input is opened in text mode. Change it
239 to binary mode. */
240 if (! isatty (file->fd))
241 setmode (file->fd, O_BINARY);
242 #endif
244 else
245 file->fd = open (file->name, O_RDONLY | O_NOCTTY | O_BINARY, 0666);
247 if (file->fd != -1 && fstat (file->fd, &file->st) == 0)
249 if (!S_ISDIR (file->st.st_mode))
250 return file;
252 /* If it's a directory, we return null and continue the search
253 as the file we're looking for may appear elsewhere in the
254 search path. */
255 errno = ENOENT;
256 close (file->fd);
257 file->fd = -1;
260 file->err_no = errno;
261 return 0;
264 static struct include_file *
265 validate_pch (cpp_reader *pfile, const char *filename, const char *pchname)
267 struct include_file * file;
269 file = open_file (pfile, pchname);
270 if (file == NULL)
271 return NULL;
272 if ((file->pch & 2) == 0)
273 file->pch = pfile->cb.valid_pch (pfile, pchname, file->fd);
274 if (CPP_OPTION (pfile, print_include_names))
276 unsigned int i;
277 for (i = 1; i < pfile->line_maps.depth; i++)
278 putc ('.', stderr);
279 fprintf (stderr, "%c %s\n", INCLUDE_PCH_P (file) ? '!' : 'x', pchname);
281 if (INCLUDE_PCH_P (file))
283 char *f = xstrdup (filename);
284 cpp_simplify_path (f);
285 file->header_name = f;
286 return file;
288 close (file->fd);
289 file->fd = -1;
290 return NULL;
294 /* Like open_file, but also look for a precompiled header if (a) one exists
295 and (b) it is valid. */
296 static struct include_file *
297 open_file_pch (cpp_reader *pfile, const char *filename)
299 if (filename[0] != '\0'
300 && pfile->cb.valid_pch != NULL)
302 size_t namelen = strlen (filename);
303 char *pchname = alloca (namelen + 5);
304 struct include_file *file = NULL;
305 struct stat st;
307 memcpy (pchname, filename, namelen);
308 memcpy (pchname + namelen, ".gch", 5);
309 cpp_simplify_path (pchname);
311 if (stat (pchname, &st) == 0 && S_ISDIR (st.st_mode))
313 DIR * thedir;
314 struct dirent *d;
315 size_t subname_len = namelen + 64;
316 char *subname = xmalloc (subname_len);
318 thedir = opendir (pchname);
319 if (thedir == NULL)
320 return NULL;
321 memcpy (subname, pchname, namelen + 4);
322 subname[namelen+4] = '/';
323 while ((d = readdir (thedir)) != NULL)
325 if (strlen (d->d_name) + namelen + 7 > subname_len)
327 subname_len = strlen (d->d_name) + namelen + 64;
328 subname = xrealloc (subname, subname_len);
330 strcpy (subname + namelen + 5, d->d_name);
331 file = validate_pch (pfile, filename, subname);
332 if (file)
333 break;
335 closedir (thedir);
336 free (subname);
338 else
339 file = validate_pch (pfile, filename, pchname);
341 if (file)
342 return file;
345 return open_file (pfile, filename);
348 /* Place the file referenced by INC into a new buffer on the buffer
349 stack, unless there are errors, or the file is not re-included
350 because of e.g. multiple-include guards. Returns true if a buffer
351 is stacked. */
352 static bool
353 stack_include_file (cpp_reader *pfile, struct include_file *inc)
355 cpp_buffer *fp;
356 int sysp;
357 const char *filename;
359 if (DO_NOT_REREAD (inc))
360 return false;
362 sysp = MAX ((pfile->map ? pfile->map->sysp : 0),
363 (inc->foundhere ? inc->foundhere->sysp : 0));
365 /* Add the file to the dependencies on its first inclusion. */
366 if (CPP_OPTION (pfile, deps.style) > !!sysp && !inc->include_count)
368 if (pfile->buffer || CPP_OPTION (pfile, deps.ignore_main_file) == 0)
369 deps_add_dep (pfile->deps, inc->name);
372 /* PCH files get dealt with immediately. */
373 if (INCLUDE_PCH_P (inc))
375 pfile->cb.read_pch (pfile, inc->name, inc->fd, inc->header_name);
376 close (inc->fd);
377 inc->fd = -1;
378 return false;
381 /* Not in cache? */
382 if (1 || ! inc->buffer)
384 if (read_include_file (pfile, inc))
386 /* If an error occurs, do not try to read this file again. */
387 _cpp_never_reread (inc);
388 return false;
390 /* Mark a regular, zero-length file never-reread. We read it,
391 NUL-terminate it, and stack it once, so preprocessing a main
392 file of zero length does not raise an error. */
393 if (S_ISREG (inc->st.st_mode) && inc->st.st_size == 0)
394 _cpp_never_reread (inc);
395 close (inc->fd);
396 inc->fd = -1;
399 if (pfile->buffer)
400 /* We don't want MI guard advice for the main file. */
401 inc->include_count++;
403 /* Push a buffer. */
404 fp = cpp_push_buffer (pfile, inc->buffer, inc->st.st_size,
405 /* from_stage3 */ CPP_OPTION (pfile, preprocessed), 0);
406 fp->inc = inc;
408 /* Initialize controlling macro state. */
409 pfile->mi_valid = true;
410 pfile->mi_cmacro = 0;
412 /* Generate the call back. */
413 filename = inc->name;
414 if (*filename == '\0')
415 filename = "<stdin>";
416 _cpp_do_file_change (pfile, LC_ENTER, filename, 1, sysp);
418 return true;
421 /* Read the file referenced by INC into the file cache.
423 If fd points to a plain file, we might be able to mmap it; we can
424 definitely allocate the buffer all at once. If fd is a pipe or
425 terminal, we can't do either. If fd is something weird, like a
426 block device, we don't want to read it at all.
428 Unfortunately, different systems use different st.st_mode values
429 for pipes: some have S_ISFIFO, some S_ISSOCK, some are buggy and
430 zero the entire struct stat except a couple fields. Hence we don't
431 even try to figure out what something is, except for plain files
432 and block devices.
434 FIXME: Flush file cache and try again if we run out of memory. */
435 static int
436 read_include_file (cpp_reader *pfile, struct include_file *inc)
438 ssize_t size, offset, count;
439 uchar *buf;
441 if (S_ISREG (inc->st.st_mode))
443 /* off_t might have a wider range than ssize_t - in other words,
444 the max size of a file might be bigger than the address
445 space. We can't handle a file that large. (Anyone with
446 a single source file bigger than 2GB needs to rethink
447 their coding style.) Some systems (e.g. AIX 4.1) define
448 SSIZE_MAX to be much smaller than the actual range of the
449 type. Use INTTYPE_MAXIMUM unconditionally to ensure this
450 does not bite us. */
451 if (inc->st.st_size > INTTYPE_MAXIMUM (ssize_t))
453 cpp_error (pfile, DL_ERROR, "%s is too large", inc->name);
454 goto fail;
456 size = inc->st.st_size;
459 buf = xmalloc (size + 1);
460 offset = 0;
461 while (offset < size)
463 count = read (inc->fd, buf + offset, size - offset);
464 if (count < 0)
465 goto perror_fail;
466 if (count == 0)
468 if (!STAT_SIZE_TOO_BIG (inc->st))
469 cpp_error (pfile, DL_WARNING,
470 "%s is shorter than expected", inc->name);
471 size = offset;
472 buf = xrealloc (buf, size + 1);
473 inc->st.st_size = size;
474 break;
476 offset += count;
478 /* The lexer requires that the buffer be \n-terminated. */
479 buf[size] = '\n';
482 else if (S_ISBLK (inc->st.st_mode))
484 cpp_error (pfile, DL_ERROR, "%s is a block device", inc->name);
485 goto fail;
487 else
489 /* 8 kilobytes is a sensible starting size. It ought to be
490 bigger than the kernel pipe buffer, and it's definitely
491 bigger than the majority of C source files. */
492 size = 8 * 1024;
494 buf = xmalloc (size + 1);
495 offset = 0;
496 while ((count = read (inc->fd, buf + offset, size - offset)) > 0)
498 offset += count;
499 if (offset == size)
501 size *= 2;
502 buf = xrealloc (buf, size + 1);
505 if (count < 0)
506 goto perror_fail;
508 if (offset + 1 < size)
509 buf = xrealloc (buf, offset + 1);
511 /* The lexer requires that the buffer be \n-terminated. */
512 buf[offset] = '\n';
513 inc->st.st_size = offset;
516 inc->buffer = buf;
517 return 0;
519 perror_fail:
520 cpp_errno (pfile, DL_ERROR, inc->name);
521 fail:
522 return 1;
525 /* Drop INC's buffer from memory. */
526 static void
527 purge_cache (struct include_file *inc)
529 if (inc->buffer)
531 free ((void *) inc->buffer);
532 inc->buffer = NULL;
536 /* Return 1 if the file named by FNAME has been included before in
537 any context, 0 otherwise. */
539 cpp_included (cpp_reader *pfile, const char *fname)
541 struct cpp_path *path;
542 char *name, *n;
543 splay_tree_node nd;
545 if (IS_ABSOLUTE_PATH (fname))
547 /* Just look it up. */
548 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) fname);
549 return (nd && nd->value);
552 /* Search directory path for the file. */
553 name = alloca (strlen (fname) + pfile->max_include_len + 2);
554 for (path = pfile->quote_include; path; path = path->next)
556 memcpy (name, path->name, path->len);
557 name[path->len] = '/';
558 strcpy (&name[path->len + 1], fname);
559 if (CPP_OPTION (pfile, remap))
560 n = remap_filename (pfile, name, path);
561 else
562 n = name;
564 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) n);
565 if (nd && nd->value)
566 return 1;
568 return 0;
571 /* Search for FNAME. Return 0 if there is no such file (or it's
572 un-openable), in which case an error code will be in errno. If
573 there is no include path to use it returns NO_INCLUDE_PATH,
574 otherwise an include_file structure. If this request originates
575 from a directive of TYPE #include_next, set INCLUDE_NEXT to true. */
576 static struct include_file *
577 find_include_file (cpp_reader *pfile, const char *fname, int angle_brackets,
578 enum include_type type)
580 struct cpp_path *path;
581 struct include_file *file;
582 char *name, *n;
584 if (*fname == '\0')
586 cpp_error (pfile, DL_ERROR, "empty file name");
587 return NO_INCLUDE_PATH;
590 if (IS_ABSOLUTE_PATH (fname))
591 return open_file_pch (pfile, fname);
593 /* For #include_next, skip in the search path past the dir in which
594 the current file was found, but if it was found via an absolute
595 path use the normal search logic. */
596 if (type == IT_INCLUDE_NEXT && pfile->buffer->inc->foundhere)
597 path = pfile->buffer->inc->foundhere->next;
598 else if (angle_brackets)
599 path = pfile->bracket_include;
600 else
601 path = search_from (pfile, type);
603 if (path == NULL)
605 cpp_error (pfile, DL_ERROR, "no include path in which to find %s",
606 fname);
607 return NO_INCLUDE_PATH;
610 /* Search directory path for the file. */
611 name = alloca (strlen (fname) + pfile->max_include_len + 2);
612 for (; path; path = path->next)
614 int len = path->len;
615 memcpy (name, path->name, len);
616 /* Don't turn / into // or // into ///; // may be a namespace
617 escape. */
618 if (name[len-1] == '/')
619 len--;
620 name[len] = '/';
621 strcpy (&name[len + 1], fname);
622 if (CPP_OPTION (pfile, remap))
623 n = remap_filename (pfile, name, path);
624 else
625 n = name;
627 file = open_file_pch (pfile, n);
628 if (file)
630 file->foundhere = path;
631 return file;
635 return 0;
638 /* Not everyone who wants to set system-header-ness on a buffer can
639 see the details of a buffer. This is an exported interface because
640 fix-header needs it. */
641 void
642 cpp_make_system_header (cpp_reader *pfile, int syshdr, int externc)
644 int flags = 0;
646 /* 1 = system header, 2 = system header to be treated as C. */
647 if (syshdr)
648 flags = 1 + (externc != 0);
649 _cpp_do_file_change (pfile, LC_RENAME, pfile->map->to_file,
650 SOURCE_LINE (pfile->map, pfile->line), flags);
653 /* Allow the client to change the current file. Used by the front end
654 to achieve pseudo-file names like <built-in>.
655 If REASON is LC_LEAVE, then NEW_NAME must be NULL. */
656 void
657 cpp_change_file (cpp_reader *pfile, enum lc_reason reason,
658 const char *new_name)
660 _cpp_do_file_change (pfile, reason, new_name, 1, 0);
663 /* Report on all files that might benefit from a multiple include guard.
664 Triggered by -H. */
665 void
666 _cpp_report_missing_guards (cpp_reader *pfile)
668 int banner = 0;
669 splay_tree_foreach (pfile->all_include_files, report_missing_guard, &banner);
672 /* Callback function for splay_tree_foreach(). */
673 static int
674 report_missing_guard (splay_tree_node n, void *b)
676 struct include_file *f = (struct include_file *) n->value;
677 int *bannerp = (int *) b;
679 if (f && f->cmacro == 0 && f->include_count == 1)
681 if (*bannerp == 0)
683 fputs (_("Multiple include guards may be useful for:\n"), stderr);
684 *bannerp = 1;
686 fputs (f->name, stderr);
687 putc ('\n', stderr);
689 return 0;
692 /* Create a dependency for file FNAME, or issue an error message as
693 appropriate. ANGLE_BRACKETS is nonzero if the file was bracketed
694 like <..>. */
695 static void
696 handle_missing_header (cpp_reader *pfile, const char *fname,
697 int angle_brackets)
699 bool print_dep
700 = CPP_OPTION (pfile, deps.style) > (angle_brackets || pfile->map->sysp);
702 if (CPP_OPTION (pfile, deps.missing_files) && print_dep)
703 deps_add_dep (pfile->deps, fname);
704 /* If -M was specified, then don't count this as an error, because
705 we can still produce correct output. Otherwise, we can't produce
706 correct output, because there may be dependencies we need inside
707 the missing file, and we don't know what directory this missing
708 file exists in. */
709 else
710 cpp_errno (pfile, CPP_OPTION (pfile, deps.style) && ! print_dep
711 ? DL_WARNING: DL_ERROR, fname);
714 /* Handles #include-family directives (distinguished by TYPE),
715 including HEADER, and the command line -imacros and -include.
716 Returns true if a buffer was stacked. */
717 bool
718 _cpp_execute_include (cpp_reader *pfile, const char *fname, int angle_brackets,
719 enum include_type type)
721 bool stacked = false;
722 struct include_file *inc;
724 inc = find_include_file (pfile, fname, angle_brackets, type);
725 if (inc == 0)
726 handle_missing_header (pfile, fname, angle_brackets);
727 else if (inc != NO_INCLUDE_PATH)
729 stacked = stack_include_file (pfile, inc);
731 if (type == IT_IMPORT)
732 _cpp_never_reread (inc);
735 return stacked;
738 /* Locate HEADER, and determine whether it is newer than the current
739 file. If it cannot be located or dated, return -1, if it is
740 newer, return 1, otherwise 0. */
742 _cpp_compare_file_date (cpp_reader *pfile, const char *fname,
743 int angle_brackets)
745 struct include_file *inc;
747 inc = find_include_file (pfile, fname, angle_brackets, IT_INCLUDE);
748 if (inc == NULL || inc == NO_INCLUDE_PATH)
749 return -1;
751 if (inc->fd > 0)
753 close (inc->fd);
754 inc->fd = -1;
757 return inc->st.st_mtime > pfile->buffer->inc->st.st_mtime;
761 /* Push an input buffer and load it up with the contents of FNAME. If
762 FNAME is "", read standard input. Return true if a buffer was
763 stacked. */
764 bool
765 _cpp_read_file (cpp_reader *pfile, const char *fname)
767 /* This uses open_file, because we don't allow a PCH to be used as
768 the toplevel compilation (that would prevent re-compiling an
769 existing PCH without deleting it first). */
770 struct include_file *f = open_file (pfile, fname);
772 if (f == NULL)
774 cpp_errno (pfile, DL_ERROR, fname);
775 return false;
778 return stack_include_file (pfile, f);
781 /* Pushes the given file onto the buffer stack. Returns nonzero if
782 successful. */
783 bool
784 cpp_push_include (cpp_reader *pfile, const char *filename)
786 /* Make the command line directive take up a line. */
787 pfile->line++;
788 return _cpp_execute_include (pfile, filename, false, IT_CMDLINE);
791 /* Do appropriate cleanup when a file INC's buffer is popped off the
792 input stack. */
793 void
794 _cpp_pop_file_buffer (cpp_reader *pfile, struct include_file *inc)
796 /* Record the inclusion-preventing macro, which could be NULL
797 meaning no controlling macro. */
798 if (pfile->mi_valid && inc->cmacro == NULL)
799 inc->cmacro = pfile->mi_cmacro;
801 /* Invalidate control macros in the #including file. */
802 pfile->mi_valid = false;
804 purge_cache (inc);
807 /* Returns the first place in the include chain to start searching for
808 "" includes. This involves stripping away the basename of the
809 current file, unless -I- was specified.
811 If we're handling -include or -imacros, use the "" chain, but with
812 the preprocessor's cwd prepended. */
813 static struct cpp_path *
814 search_from (cpp_reader *pfile, enum include_type type)
816 cpp_buffer *buffer = pfile->buffer;
817 unsigned int dlen;
819 /* Command line uses the cwd, and does not cache the result. */
820 if (type == IT_CMDLINE)
821 goto use_cwd;
823 /* Ignore the current file's directory? */
824 if (pfile->quote_ignores_source_dir)
825 return pfile->quote_include;
827 if (! buffer->search_cached)
829 buffer->search_cached = 1;
831 dlen = lbasename (buffer->inc->name) - buffer->inc->name;
833 if (dlen)
835 /* We don't guarantee NAME is null-terminated. This saves
836 allocating and freeing memory. Drop a trailing '/'. */
837 buffer->dir.name = (char *) buffer->inc->name;
838 if (dlen > 1)
839 dlen--;
841 else
843 use_cwd:
844 buffer->dir.name = (char *) ".";
845 dlen = 1;
848 if (dlen > pfile->max_include_len)
849 pfile->max_include_len = dlen;
851 buffer->dir.len = dlen;
852 buffer->dir.next = pfile->quote_include;
853 buffer->dir.sysp = pfile->map->sysp;
856 return &buffer->dir;
859 /* The file_name_map structure holds a mapping of file names for a
860 particular directory. This mapping is read from the file named
861 FILE_NAME_MAP_FILE in that directory. Such a file can be used to
862 map filenames on a file system with severe filename restrictions,
863 such as DOS. The format of the file name map file is just a series
864 of lines with two tokens on each line. The first token is the name
865 to map, and the second token is the actual name to use. */
866 struct file_name_map {
867 struct file_name_map *map_next;
868 char *map_from;
869 char *map_to;
872 #define FILE_NAME_MAP_FILE "header.gcc"
874 /* Read a space delimited string of unlimited length from a stdio
875 file F. */
876 static char *
877 read_filename_string (int ch, FILE *f)
879 char *alloc, *set;
880 int len;
882 len = 20;
883 set = alloc = xmalloc (len + 1);
884 if (! is_space (ch))
886 *set++ = ch;
887 while ((ch = getc (f)) != EOF && ! is_space (ch))
889 if (set - alloc == len)
891 len *= 2;
892 alloc = xrealloc (alloc, len + 1);
893 set = alloc + len / 2;
895 *set++ = ch;
898 *set = '\0';
899 ungetc (ch, f);
900 return alloc;
903 /* This structure holds a linked list of file name maps, one per directory. */
904 struct file_name_map_list {
905 struct file_name_map_list *map_list_next;
906 char *map_list_name;
907 struct file_name_map *map_list_map;
910 /* Read the file name map file for DIRNAME. */
911 static struct file_name_map *
912 read_name_map (cpp_reader *pfile, const char *dirname)
914 struct file_name_map_list *map_list_ptr;
915 char *name;
916 FILE *f;
918 /* Check the cache of directories, and mappings in their remap file. */
919 for (map_list_ptr = CPP_OPTION (pfile, map_list); map_list_ptr;
920 map_list_ptr = map_list_ptr->map_list_next)
921 if (! strcmp (map_list_ptr->map_list_name, dirname))
922 return map_list_ptr->map_list_map;
924 map_list_ptr = xmalloc (sizeof (struct file_name_map_list));
925 map_list_ptr->map_list_name = xstrdup (dirname);
927 /* The end of the list ends in NULL. */
928 map_list_ptr->map_list_map = NULL;
930 name = alloca (strlen (dirname) + strlen (FILE_NAME_MAP_FILE) + 2);
931 strcpy (name, dirname);
932 if (*dirname)
933 strcat (name, "/");
934 strcat (name, FILE_NAME_MAP_FILE);
935 f = fopen (name, "r");
937 /* Silently return NULL if we cannot open. */
938 if (f)
940 int ch;
942 while ((ch = getc (f)) != EOF)
944 char *from, *to;
945 struct file_name_map *ptr;
947 if (is_space (ch))
948 continue;
949 from = read_filename_string (ch, f);
950 while ((ch = getc (f)) != EOF && is_hspace (ch))
952 to = read_filename_string (ch, f);
954 ptr = xmalloc (sizeof (struct file_name_map));
955 ptr->map_from = from;
957 /* Make the real filename absolute. */
958 if (IS_ABSOLUTE_PATH (to))
959 ptr->map_to = to;
960 else
962 ptr->map_to = concat (dirname, "/", to, NULL);
963 free (to);
966 ptr->map_next = map_list_ptr->map_list_map;
967 map_list_ptr->map_list_map = ptr;
969 while ((ch = getc (f)) != '\n')
970 if (ch == EOF)
971 break;
973 fclose (f);
976 /* Add this information to the cache. */
977 map_list_ptr->map_list_next = CPP_OPTION (pfile, map_list);
978 CPP_OPTION (pfile, map_list) = map_list_ptr;
980 return map_list_ptr->map_list_map;
983 /* Remap an unsimplified path NAME based on the file_name_map (if any)
984 for LOC. */
985 static char *
986 remap_filename (cpp_reader *pfile, char *name, struct cpp_path *loc)
988 struct file_name_map *map;
989 const char *from, *p;
990 char *dir;
992 if (! loc->name_map)
994 /* Get a null-terminated path. */
995 char *dname = alloca (loc->len + 1);
996 memcpy (dname, loc->name, loc->len);
997 dname[loc->len] = '\0';
999 loc->name_map = read_name_map (pfile, dname);
1000 if (! loc->name_map)
1001 return name;
1004 /* This works since NAME has not been simplified yet. */
1005 from = name + loc->len + 1;
1007 for (map = loc->name_map; map; map = map->map_next)
1008 if (!strcmp (map->map_from, from))
1009 return map->map_to;
1011 /* Try to find a mapping file for the particular directory we are
1012 looking in. Thus #include <sys/types.h> will look up sys/types.h
1013 in /usr/include/header.gcc and look up types.h in
1014 /usr/include/sys/header.gcc. */
1015 p = strrchr (name, '/');
1016 if (!p)
1017 return name;
1019 /* We know p != name as absolute paths don't call remap_filename. */
1020 if (p == name)
1021 cpp_error (pfile, DL_ICE, "absolute file name in remap_filename");
1023 dir = alloca (p - name + 1);
1024 memcpy (dir, name, p - name);
1025 dir[p - name] = '\0';
1026 from = p + 1;
1028 for (map = read_name_map (pfile, dir); map; map = map->map_next)
1029 if (! strcmp (map->map_from, from))
1030 return map->map_to;
1032 return name;
1035 /* Set the include chain for "" to QUOTE, for <> to BRACKET. If
1036 QUOTE_IGNORES_SOURCE_DIR, then "" includes do not look in the
1037 directory of the including file.
1039 If BRACKET does not lie in the QUOTE chain, it is set to QUOTE. */
1040 void
1041 cpp_set_include_chains (cpp_reader *pfile, cpp_path *quote, cpp_path *bracket,
1042 int quote_ignores_source_dir)
1044 pfile->quote_include = quote;
1045 pfile->bracket_include = quote;
1046 pfile->quote_ignores_source_dir = quote_ignores_source_dir;
1047 pfile->max_include_len = 0;
1049 for (; quote; quote = quote->next)
1051 quote->name_map = NULL;
1052 quote->len = strlen (quote->name);
1053 if (quote->len > pfile->max_include_len)
1054 pfile->max_include_len = quote->len;
1055 if (quote == bracket)
1056 pfile->bracket_include = bracket;
1060 /* Returns true if it is safe to remove the final component of path,
1061 when it is followed by a ".." component. We use lstat to avoid
1062 symlinks if we have it. If not, we can still catch errors with
1063 stat (). */
1064 static int
1065 remove_component_p (const char *path)
1067 struct stat s;
1068 int result;
1070 #ifdef HAVE_LSTAT
1071 result = lstat (path, &s);
1072 #else
1073 result = stat (path, &s);
1074 #endif
1076 /* There's no guarantee that errno will be unchanged, even on
1077 success. Cygwin's lstat(), for example, will often set errno to
1078 ENOSYS. In case of success, reset errno to zero. */
1079 if (result == 0)
1080 errno = 0;
1082 return result == 0 && S_ISDIR (s.st_mode);
1085 /* Simplify a path name in place, deleting redundant components. This
1086 reduces OS overhead and guarantees that equivalent paths compare
1087 the same (modulo symlinks).
1089 Transforms made:
1090 foo/bar/../quux foo/quux
1091 foo/./bar foo/bar
1092 foo//bar foo/bar
1093 /../quux /quux
1094 //quux //quux (POSIX allows leading // as a namespace escape)
1096 Guarantees no trailing slashes. All transforms reduce the length
1097 of the string. Returns PATH. errno is 0 if no error occurred;
1098 nonzero if an error occurred when using stat () or lstat (). */
1099 void
1100 cpp_simplify_path (char *path ATTRIBUTE_UNUSED)
1102 #ifndef VMS
1103 char *from, *to;
1104 char *base, *orig_base;
1105 int absolute = 0;
1107 errno = 0;
1108 /* Don't overflow the empty path by putting a '.' in it below. */
1109 if (*path == '\0')
1110 return;
1112 #if defined (HAVE_DOS_BASED_FILE_SYSTEM)
1113 /* Convert all backslashes to slashes. */
1114 for (from = path; *from; from++)
1115 if (*from == '\\') *from = '/';
1117 /* Skip over leading drive letter if present. */
1118 if (ISALPHA (path[0]) && path[1] == ':')
1119 from = to = &path[2];
1120 else
1121 from = to = path;
1122 #else
1123 from = to = path;
1124 #endif
1126 /* Remove redundant leading /s. */
1127 if (*from == '/')
1129 absolute = 1;
1130 to++;
1131 from++;
1132 if (*from == '/')
1134 if (*++from == '/')
1135 /* 3 or more initial /s are equivalent to 1 /. */
1136 while (*++from == '/');
1137 else
1138 /* On some hosts // differs from /; Posix allows this. */
1139 to++;
1143 base = orig_base = to;
1144 for (;;)
1146 int move_base = 0;
1148 while (*from == '/')
1149 from++;
1151 if (*from == '\0')
1152 break;
1154 if (*from == '.')
1156 if (from[1] == '\0')
1157 break;
1158 if (from[1] == '/')
1160 from += 2;
1161 continue;
1163 else if (from[1] == '.' && (from[2] == '/' || from[2] == '\0'))
1165 /* Don't simplify if there was no previous component. */
1166 if (absolute && orig_base == to)
1168 from += 2;
1169 continue;
1171 /* Don't simplify if the previous component was "../",
1172 or if an error has already occurred with (l)stat. */
1173 if (base != to && errno == 0)
1175 /* We don't back up if it's a symlink. */
1176 *to = '\0';
1177 if (remove_component_p (path))
1179 while (to > base && *to != '/')
1180 to--;
1181 from += 2;
1182 continue;
1185 move_base = 1;
1189 /* Add the component separator. */
1190 if (to > orig_base)
1191 *to++ = '/';
1193 /* Copy this component until the trailing null or '/'. */
1194 while (*from != '\0' && *from != '/')
1195 *to++ = *from++;
1197 if (move_base)
1198 base = to;
1201 /* Change the empty string to "." so that it is not treated as stdin.
1202 Null terminate. */
1203 if (to == path)
1204 *to++ = '.';
1205 *to = '\0';
1206 #else /* VMS */
1207 errno = 0;
1208 #endif /* !VMS */