2001-01-23 Alexandre Petit-Bianco <apbianco@cygnus.com>
[official-gcc.git] / gcc / cppfiles.c
blobc480cb456c034ff1bbdce4c013cdb9aecb6c169f
1 /* Part of CPP library. (include file handling)
2 Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1998,
3 1999, 2000, 2001 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 "cpplib.h"
26 #include "cpphash.h"
27 #include "intl.h"
28 #include "mkdeps.h"
29 #include "splay-tree.h"
31 #ifdef HAVE_MMAP_FILE
32 # include <sys/mman.h>
33 # ifndef MMAP_THRESHOLD
34 # define MMAP_THRESHOLD 3 /* Minimum page count to mmap the file. */
35 # endif
37 #else /* No MMAP_FILE */
38 # undef MMAP_THRESHOLD
39 # define MMAP_THRESHOLD 0
40 #endif
42 #ifndef O_BINARY
43 # define O_BINARY 0
44 #endif
46 #ifndef INCLUDE_LEN_FUDGE
47 # define INCLUDE_LEN_FUDGE 0
48 #endif
50 /* If errno is inspected immediately after a system call fails, it will be
51 nonzero, and no error number will ever be zero. */
52 #ifndef ENOENT
53 # define ENOENT 0
54 #endif
55 #ifndef ENOTDIR
56 # define ENOTDIR 0
57 #endif
58 #ifndef ENOMEM
59 # define ENOMEM 0
60 #endif
62 /* Suppress warning about function macros used w/o arguments in traditional
63 C. It is unlikely that glibc's strcmp macro helps this file at all. */
64 #undef strcmp
66 /* This structure is used for the table of all includes. */
67 struct include_file
69 const char *name; /* actual path name of file */
70 const cpp_hashnode *cmacro; /* macro, if any, preventing reinclusion. */
71 const struct file_name_list *foundhere;
72 /* location in search path where file was
73 found, for #include_next and sysp. */
74 const unsigned char *buffer; /* pointer to cached file contents */
75 struct stat st; /* copy of stat(2) data for file */
76 int fd; /* fd open on file (short term storage only) */
77 unsigned short include_count; /* number of times file has been read */
78 unsigned short refcnt; /* number of stacked buffers using this file */
79 unsigned char mapped; /* file buffer is mmapped */
80 unsigned char defined; /* cmacro prevents inclusion in this state */
83 /* The cmacro works like this: If it's NULL, the file is to be
84 included again. If it's NEVER_REREAD, the file is never to be
85 included again. Otherwise it is a macro hashnode, and the file is
86 to be included again if the macro is defined or not as specified by
87 DEFINED. */
88 #define NEVER_REREAD ((const cpp_hashnode *)-1)
89 #define DO_NOT_REREAD(inc) \
90 ((inc)->cmacro && ((inc)->cmacro == NEVER_REREAD \
91 || ((inc)->cmacro->type == NT_MACRO) == (inc)->defined))
93 static struct file_name_map *read_name_map
94 PARAMS ((cpp_reader *, const char *));
95 static char *read_filename_string PARAMS ((int, FILE *));
96 static char *remap_filename PARAMS ((cpp_reader *, char *,
97 struct file_name_list *));
98 static struct file_name_list *actual_directory
99 PARAMS ((cpp_reader *, const char *));
100 static struct include_file *find_include_file
101 PARAMS ((cpp_reader *, const char *,
102 struct file_name_list *));
103 static struct include_file *open_file PARAMS ((cpp_reader *, const char *));
104 static void read_include_file PARAMS ((cpp_reader *, struct include_file *));
105 static void stack_include_file PARAMS ((cpp_reader *, struct include_file *));
106 static void purge_cache PARAMS ((struct include_file *));
107 static void destroy_include_file_node PARAMS ((splay_tree_value));
108 static int report_missing_guard PARAMS ((splay_tree_node, void *));
110 /* We use a splay tree to store information about all the include
111 files seen in this compilation. The key of each tree node is the
112 physical path to the file. The value is 0 if the file does not
113 exist, or a struct include_file pointer. */
115 static void
116 destroy_include_file_node (v)
117 splay_tree_value v;
119 struct include_file *f = (struct include_file *)v;
121 if (f)
123 purge_cache (f);
124 free (f); /* The tree is registered with free to free f->name. */
128 void
129 _cpp_init_includes (pfile)
130 cpp_reader *pfile;
132 pfile->all_include_files
133 = splay_tree_new ((splay_tree_compare_fn) strcmp,
134 (splay_tree_delete_key_fn) free,
135 destroy_include_file_node);
138 void
139 _cpp_cleanup_includes (pfile)
140 cpp_reader *pfile;
142 splay_tree_delete (pfile->all_include_files);
145 /* Mark a file to not be reread (e.g. #import, read failure). */
146 void
147 _cpp_never_reread (file)
148 struct include_file *file;
150 file->cmacro = NEVER_REREAD;
153 /* Put a file name in the splay tree, for the sake of cpp_included ().
154 Assume that FNAME has already had its path simplified. */
155 void
156 _cpp_fake_include (pfile, fname)
157 cpp_reader *pfile;
158 const char *fname;
160 splay_tree_node nd;
162 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) fname);
163 if (! nd)
165 struct include_file *file = xcnew (struct include_file);
166 file->name = xstrdup (fname);
167 splay_tree_insert (pfile->all_include_files,
168 (splay_tree_key) file->name,
169 (splay_tree_value) file);
173 /* Given a file name, look it up in the cache; if there is no entry,
174 create one with a non-NULL value (regardless of success in opening
175 the file). If the file doesn't exist or is inaccessible, this
176 entry is flagged so we don't attempt to open it again in the
177 future. If the file isn't open, open it.
179 Returns an include_file structure with an open file descriptor on
180 success, or NULL on failure. */
182 static struct include_file *
183 open_file (pfile, filename)
184 cpp_reader *pfile;
185 const char *filename;
187 splay_tree_node nd;
188 struct include_file *file;
190 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) filename);
192 if (nd)
194 file = (struct include_file *) nd->value;
196 /* Don't retry opening if we failed previously. */
197 if (file->fd == -2)
198 return 0;
200 /* Don't reopen an idempotent file. */
201 if (DO_NOT_REREAD (file))
202 return file;
204 /* Don't reopen one which is already loaded. */
205 if (file->buffer != NULL)
206 return file;
208 else
210 /* In particular, this clears foundhere. */
211 file = xcnew (struct include_file);
212 file->name = xstrdup (filename);
213 splay_tree_insert (pfile->all_include_files,
214 (splay_tree_key) file->name,
215 (splay_tree_value) file);
218 /* We used to open files in nonblocking mode, but that caused more
219 problems than it solved. Do take care not to acquire a
220 controlling terminal by mistake (this can't happen on sane
221 systems, but paranoia is a virtue).
223 Use the three-argument form of open even though we aren't
224 specifying O_CREAT, to defend against broken system headers.
226 O_BINARY tells some runtime libraries (notably DJGPP) not to do
227 newline translation; we can handle DOS line breaks just fine
228 ourselves.
230 Special case: the empty string is translated to stdin. */
232 if (filename[0] == '\0')
233 file->fd = 0;
234 else
235 file->fd = open (filename, O_RDONLY | O_NOCTTY | O_BINARY, 0666);
237 if (file->fd != -1 && fstat (file->fd, &file->st) == 0)
239 /* Mark a regular, zero-length file never-reread now. */
240 if (S_ISREG (file->st.st_mode) && file->st.st_size == 0)
242 _cpp_never_reread (file);
243 close (file->fd);
244 file->fd = -1;
247 return file;
250 /* Don't issue an error message if the file doesn't exist. */
251 if (errno != ENOENT && errno != ENOTDIR)
252 cpp_error_from_errno (pfile, filename);
254 /* Create a negative node for this path, and return null. */
255 file->fd = -2;
257 return 0;
260 /* Place the file referenced by INC into a new buffer on PFILE's
261 stack. If there are errors, or the file should not be re-included,
262 a null buffer is pushed. */
264 static void
265 stack_include_file (pfile, inc)
266 cpp_reader *pfile;
267 struct include_file *inc;
269 size_t len = 0;
270 cpp_buffer *fp;
272 /* Not in cache? */
273 if (! inc->buffer)
274 read_include_file (pfile, inc);
276 if (! DO_NOT_REREAD (inc))
277 len = inc->st.st_size;
279 /* Push a buffer. */
280 fp = cpp_push_buffer (pfile, inc->buffer, len, BUF_FILE, inc->name);
281 fp->inc = inc;
282 fp->inc->refcnt++;
283 if (inc->foundhere)
284 fp->sysp = inc->foundhere->sysp;
286 /* The ->actual_dir field is only used when ignore_srcdir is not in effect;
287 see do_include */
288 if (!CPP_OPTION (pfile, ignore_srcdir))
289 fp->actual_dir = actual_directory (pfile, inc->name);
291 /* Initialise controlling macro state. */
292 pfile->mi_state = MI_OUTSIDE;
293 pfile->mi_cmacro = 0;
294 pfile->include_depth++;
296 /* Generate the call back. */
297 fp->lineno = 0;
298 _cpp_do_file_change (pfile, FC_ENTER, 0, 0);
299 fp->lineno = 1;
302 /* Read the file referenced by INC into the file cache.
304 If fd points to a plain file, we might be able to mmap it; we can
305 definitely allocate the buffer all at once. If fd is a pipe or
306 terminal, we can't do either. If fd is something weird, like a
307 block device or a directory, we don't want to read it at all.
309 Unfortunately, different systems use different st.st_mode values
310 for pipes: some have S_ISFIFO, some S_ISSOCK, some are buggy and
311 zero the entire struct stat except a couple fields. Hence we don't
312 even try to figure out what something is, except for plain files,
313 directories, and block devices.
315 FIXME: Flush file cache and try again if we run out of memory. */
317 static void
318 read_include_file (pfile, inc)
319 cpp_reader *pfile;
320 struct include_file *inc;
322 ssize_t size, offset, count;
323 U_CHAR *buf;
324 #if MMAP_THRESHOLD
325 static int pagesize = -1;
326 #endif
328 if (DO_NOT_REREAD (inc))
329 return;
331 if (S_ISREG (inc->st.st_mode))
333 /* off_t might have a wider range than ssize_t - in other words,
334 the max size of a file might be bigger than the address
335 space. We can't handle a file that large. (Anyone with
336 a single source file bigger than 2GB needs to rethink
337 their coding style.) Some systems (e.g. AIX 4.1) define
338 SSIZE_MAX to be much smaller than the actual range of the
339 type. Use INTTYPE_MAXIMUM unconditionally to ensure this
340 does not bite us. */
341 if (inc->st.st_size > INTTYPE_MAXIMUM (ssize_t))
343 cpp_error (pfile, "%s is too large", inc->name);
344 goto fail;
346 size = inc->st.st_size;
348 inc->mapped = 0;
349 #if MMAP_THRESHOLD
350 if (pagesize == -1)
351 pagesize = getpagesize ();
353 if (size / pagesize >= MMAP_THRESHOLD)
355 buf = (U_CHAR *) mmap (0, size, PROT_READ, MAP_PRIVATE, inc->fd, 0);
356 if (buf == (U_CHAR *)-1)
357 goto perror_fail;
358 inc->mapped = 1;
360 else
361 #endif
363 buf = (U_CHAR *) xmalloc (size);
364 offset = 0;
365 while (offset < size)
367 count = read (inc->fd, buf + offset, size - offset);
368 if (count < 0)
369 goto perror_fail;
370 if (count == 0)
372 cpp_warning (pfile, "%s is shorter than expected", inc->name);
373 break;
375 offset += count;
379 else if (S_ISBLK (inc->st.st_mode))
381 cpp_error (pfile, "%s is a block device", inc->name);
382 goto fail;
384 else if (S_ISDIR (inc->st.st_mode))
386 cpp_error (pfile, "%s is a directory", inc->name);
387 goto fail;
389 else
391 /* 8 kilobytes is a sensible starting size. It ought to be
392 bigger than the kernel pipe buffer, and it's definitely
393 bigger than the majority of C source files. */
394 size = 8 * 1024;
396 buf = (U_CHAR *) xmalloc (size);
397 offset = 0;
398 while ((count = read (inc->fd, buf + offset, size - offset)) > 0)
400 offset += count;
401 if (offset == size)
402 buf = xrealloc (buf, (size *= 2));
404 if (count < 0)
405 goto perror_fail;
407 if (offset < size)
408 buf = xrealloc (buf, offset);
409 inc->st.st_size = offset;
412 close (inc->fd);
413 inc->buffer = buf;
414 inc->fd = -1;
415 return;
417 perror_fail:
418 cpp_error_from_errno (pfile, inc->name);
419 fail:
420 /* Do not try to read this file again. */
421 close (inc->fd);
422 inc->fd = -1;
423 _cpp_never_reread (inc);
424 return;
427 static void
428 purge_cache (inc)
429 struct include_file *inc;
431 if (inc->buffer)
433 #if MMAP_THRESHOLD
434 if (inc->mapped)
435 munmap ((PTR) inc->buffer, inc->st.st_size);
436 else
437 #endif
438 free ((PTR) inc->buffer);
439 inc->buffer = NULL;
443 /* Return 1 if the file named by FNAME has been included before in
444 any context, 0 otherwise. */
446 cpp_included (pfile, fname)
447 cpp_reader *pfile;
448 const char *fname;
450 struct file_name_list *path;
451 char *name;
452 splay_tree_node nd;
454 if (IS_ABSOLUTE_PATHNAME (fname))
456 /* Just look it up. */
457 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) fname);
458 return (nd && nd->value);
461 /* Search directory path for the file. */
462 name = (char *) alloca (strlen (fname) + pfile->max_include_len
463 + 2 + INCLUDE_LEN_FUDGE);
464 for (path = CPP_OPTION (pfile, quote_include); path; path = path->next)
466 memcpy (name, path->name, path->nlen);
467 name[path->nlen] = '/';
468 strcpy (&name[path->nlen+1], fname);
469 _cpp_simplify_pathname (name);
470 if (CPP_OPTION (pfile, remap))
471 name = remap_filename (pfile, name, path);
473 nd = splay_tree_lookup (pfile->all_include_files, (splay_tree_key) name);
474 if (nd && nd->value)
475 return 1;
477 return 0;
480 /* Search for include file FNAME in the include chain starting at
481 SEARCH_START. Return 0 if there is no such file (or it's un-openable),
482 otherwise an include_file structure. */
484 static struct include_file *
485 find_include_file (pfile, fname, search_start)
486 cpp_reader *pfile;
487 const char *fname;
488 struct file_name_list *search_start;
490 struct file_name_list *path;
491 char *name;
492 struct include_file *file;
494 if (IS_ABSOLUTE_PATHNAME (fname))
495 return open_file (pfile, fname);
497 /* Search directory path for the file. */
498 name = (char *) alloca (strlen (fname) + pfile->max_include_len
499 + 2 + INCLUDE_LEN_FUDGE);
500 for (path = search_start; path; path = path->next)
502 memcpy (name, path->name, path->nlen);
503 name[path->nlen] = '/';
504 strcpy (&name[path->nlen+1], fname);
505 _cpp_simplify_pathname (name);
506 if (CPP_OPTION (pfile, remap))
507 name = remap_filename (pfile, name, path);
509 file = open_file (pfile, name);
510 if (file)
512 file->foundhere = path;
513 return file;
516 return 0;
519 /* Not everyone who wants to set system-header-ness on a buffer can
520 see the details of a buffer. This is an exported interface because
521 fix-header needs it. */
522 void
523 cpp_make_system_header (pfile, syshdr, externc)
524 cpp_reader *pfile;
525 int syshdr, externc;
527 int flags = 0;
529 /* 1 = system header, 2 = system header to be treated as C. */
530 if (syshdr)
531 flags = 1 + (externc != 0);
532 pfile->buffer->sysp = flags;
535 /* Report on all files that might benefit from a multiple include guard.
536 Triggered by -H. */
537 void
538 _cpp_report_missing_guards (pfile)
539 cpp_reader *pfile;
541 int banner = 0;
542 splay_tree_foreach (pfile->all_include_files, report_missing_guard,
543 (PTR) &banner);
546 static int
547 report_missing_guard (n, b)
548 splay_tree_node n;
549 void *b;
551 struct include_file *f = (struct include_file *) n->value;
552 int *bannerp = (int *)b;
554 if (f && f->cmacro == 0 && f->include_count == 1)
556 if (*bannerp == 0)
558 fputs (_("Multiple include guards may be useful for:\n"), stderr);
559 *bannerp = 1;
561 fputs (f->name, stderr);
562 putc ('\n', stderr);
564 return 0;
567 #define PRINT_THIS_DEP(p, b) (CPP_PRINT_DEPS(p) > (b||p->system_include_depth))
568 void
569 _cpp_execute_include (pfile, header, no_reinclude, include_next)
570 cpp_reader *pfile;
571 const cpp_token *header;
572 int no_reinclude;
573 int include_next;
575 struct file_name_list *search_start = 0;
576 unsigned int len = header->val.str.len;
577 unsigned int angle_brackets = header->type == CPP_HEADER_NAME;
578 struct include_file *inc;
579 char *fname;
581 /* Help protect #include or similar from recursion. */
582 if (pfile->buffer_stack_depth >= CPP_STACK_MAX)
584 cpp_fatal (pfile, "#include nested too deeply");
585 return;
588 /* Check we've tidied up #include before entering the buffer. */
589 if (pfile->context->prev)
591 cpp_ice (pfile, "attempt to push file buffer with contexts stacked");
592 return;
595 /* For #include_next, skip in the search path past the dir in which
596 the current file was found. If this is the last directory in the
597 search path, don't include anything. If the current file was
598 specified with an absolute path, use the normal search logic. If
599 this is the primary source file, use the normal search logic and
600 generate a warning. */
601 if (include_next)
603 if (! pfile->buffer->prev)
604 cpp_warning (pfile, "#include_next in primary source file");
605 else
607 if (pfile->buffer->inc->foundhere)
609 search_start = pfile->buffer->inc->foundhere->next;
610 if (! search_start)
611 return;
616 fname = alloca (len + 1);
617 memcpy (fname, header->val.str.text, len);
618 fname[len] = '\0';
620 if (!search_start)
622 if (angle_brackets)
623 search_start = CPP_OPTION (pfile, bracket_include);
624 else if (CPP_OPTION (pfile, ignore_srcdir))
625 search_start = CPP_OPTION (pfile, quote_include);
626 else
627 search_start = CPP_BUFFER (pfile)->actual_dir;
629 if (!search_start)
631 cpp_error (pfile, "No include path in which to find %s", fname);
632 return;
636 inc = find_include_file (pfile, fname, search_start);
638 if (inc)
640 /* For -M, add the file to the dependencies on its first inclusion. */
641 if (!inc->include_count && PRINT_THIS_DEP (pfile, angle_brackets))
642 deps_add_dep (pfile->deps, inc->name);
643 inc->include_count++;
645 /* Actually process the file. */
646 stack_include_file (pfile, inc);
648 if (angle_brackets)
649 pfile->system_include_depth++;
651 if (! DO_NOT_REREAD (inc))
653 if (no_reinclude)
654 _cpp_never_reread (inc);
656 /* Handle -H option. */
657 if (CPP_OPTION (pfile, print_include_names))
659 cpp_buffer *fp = CPP_BUFFER (pfile);
660 while ((fp = CPP_PREV_BUFFER (fp)) != NULL)
661 putc ('.', stderr);
662 fprintf (stderr, " %s\n", inc->name);
666 return;
669 if (CPP_OPTION (pfile, print_deps_missing_files)
670 && PRINT_THIS_DEP (pfile, angle_brackets))
672 if (!angle_brackets || IS_ABSOLUTE_PATHNAME (fname))
673 deps_add_dep (pfile->deps, fname);
674 else
676 char *p;
677 struct file_name_list *ptr;
678 int len;
680 /* If requested as a system header, assume it belongs in
681 the first system header directory. */
682 if (CPP_OPTION (pfile, bracket_include))
683 ptr = CPP_OPTION (pfile, bracket_include);
684 else
685 ptr = CPP_OPTION (pfile, quote_include);
687 len = strlen (ptr->name);
688 p = (char *) alloca (len + strlen (fname) + 2);
689 if (len)
691 memcpy (p, ptr->name, len);
692 p[len++] = '/';
694 strcpy (p + len, fname);
695 _cpp_simplify_pathname (p);
696 deps_add_dep (pfile->deps, p);
699 /* If -M was specified, and this header file won't be added to
700 the dependency list, then don't count this as an error,
701 because we can still produce correct output. Otherwise, we
702 can't produce correct output, because there may be
703 dependencies we need inside the missing file, and we don't
704 know what directory this missing file exists in. */
705 else if (CPP_PRINT_DEPS (pfile)
706 && ! PRINT_THIS_DEP (pfile, angle_brackets))
707 cpp_warning (pfile, "No include path in which to find %s", fname);
708 else
709 cpp_error_from_errno (pfile, fname);
712 /* Locate file F, and determine whether it is newer than PFILE. Return -1,
713 if F cannot be located or dated, 1, if it is newer and 0 if older. */
715 _cpp_compare_file_date (pfile, f)
716 cpp_reader *pfile;
717 const cpp_token *f;
719 unsigned int len = f->val.str.len;
720 char *fname;
721 struct file_name_list *search_start;
722 struct include_file *inc;
724 if (f->type == CPP_HEADER_NAME)
725 search_start = CPP_OPTION (pfile, bracket_include);
726 else if (CPP_OPTION (pfile, ignore_srcdir))
727 search_start = CPP_OPTION (pfile, quote_include);
728 else
729 search_start = CPP_BUFFER (pfile)->actual_dir;
731 fname = alloca (len + 1);
732 memcpy (fname, f->val.str.text, len);
733 fname[len] = '\0';
734 inc = find_include_file (pfile, fname, search_start);
736 if (!inc)
737 return -1;
738 if (inc->fd > 0)
740 close (inc->fd);
741 inc->fd = -1;
744 return inc->st.st_mtime > CPP_BUFFER (pfile)->inc->st.st_mtime;
748 /* Push an input buffer and load it up with the contents of FNAME.
749 If FNAME is "" or NULL, read standard input. */
751 _cpp_read_file (pfile, fname)
752 cpp_reader *pfile;
753 const char *fname;
755 struct include_file *f;
757 if (fname == NULL)
758 fname = "";
760 f = open_file (pfile, fname);
762 if (f == NULL)
764 cpp_error_from_errno (pfile, fname);
765 return 0;
768 stack_include_file (pfile, f);
769 return 1;
772 /* Do appropriate cleanup when a file buffer is popped off the input
773 stack. */
774 void
775 _cpp_pop_file_buffer (pfile, buf)
776 cpp_reader *pfile;
777 cpp_buffer *buf;
779 struct include_file *inc = buf->inc;
781 if (pfile->system_include_depth)
782 pfile->system_include_depth--;
783 if (pfile->include_depth)
784 pfile->include_depth--;
786 /* Record the inclusion-preventing macro and its definedness. */
787 if (pfile->mi_state == MI_OUTSIDE && inc->cmacro != NEVER_REREAD)
789 /* This could be NULL meaning no controlling macro. */
790 inc->cmacro = pfile->mi_cmacro;
791 inc->defined = 1;
794 /* Invalidate control macros in the #including file. */
795 pfile->mi_state = MI_FAILED;
797 inc->refcnt--;
798 if (inc->refcnt == 0 && DO_NOT_REREAD (inc))
799 purge_cache (inc);
802 /* The file_name_map structure holds a mapping of file names for a
803 particular directory. This mapping is read from the file named
804 FILE_NAME_MAP_FILE in that directory. Such a file can be used to
805 map filenames on a file system with severe filename restrictions,
806 such as DOS. The format of the file name map file is just a series
807 of lines with two tokens on each line. The first token is the name
808 to map, and the second token is the actual name to use. */
810 struct file_name_map
812 struct file_name_map *map_next;
813 char *map_from;
814 char *map_to;
817 #define FILE_NAME_MAP_FILE "header.gcc"
819 /* Read a space delimited string of unlimited length from a stdio
820 file. */
822 static char *
823 read_filename_string (ch, f)
824 int ch;
825 FILE *f;
827 char *alloc, *set;
828 int len;
830 len = 20;
831 set = alloc = xmalloc (len + 1);
832 if (! is_space(ch))
834 *set++ = ch;
835 while ((ch = getc (f)) != EOF && ! is_space(ch))
837 if (set - alloc == len)
839 len *= 2;
840 alloc = xrealloc (alloc, len + 1);
841 set = alloc + len / 2;
843 *set++ = ch;
846 *set = '\0';
847 ungetc (ch, f);
848 return alloc;
851 /* This structure holds a linked list of file name maps, one per directory. */
853 struct file_name_map_list
855 struct file_name_map_list *map_list_next;
856 char *map_list_name;
857 struct file_name_map *map_list_map;
860 /* Read the file name map file for DIRNAME. */
862 static struct file_name_map *
863 read_name_map (pfile, dirname)
864 cpp_reader *pfile;
865 const char *dirname;
867 register struct file_name_map_list *map_list_ptr;
868 char *name;
869 FILE *f;
871 /* Check the cache of directories, and mappings in their remap file. */
872 for (map_list_ptr = CPP_OPTION (pfile, map_list); map_list_ptr;
873 map_list_ptr = map_list_ptr->map_list_next)
874 if (! strcmp (map_list_ptr->map_list_name, dirname))
875 return map_list_ptr->map_list_map;
877 map_list_ptr = ((struct file_name_map_list *)
878 xmalloc (sizeof (struct file_name_map_list)));
879 map_list_ptr->map_list_name = xstrdup (dirname);
881 /* The end of the list ends in NULL. */
882 map_list_ptr->map_list_map = NULL;
884 name = (char *) alloca (strlen (dirname) + strlen (FILE_NAME_MAP_FILE) + 2);
885 strcpy (name, dirname);
886 if (*dirname)
887 strcat (name, "/");
888 strcat (name, FILE_NAME_MAP_FILE);
889 f = fopen (name, "r");
891 /* Silently return NULL if we cannot open. */
892 if (f)
894 int ch;
895 int dirlen = strlen (dirname);
897 while ((ch = getc (f)) != EOF)
899 char *from, *to;
900 struct file_name_map *ptr;
902 if (is_space(ch))
903 continue;
904 from = read_filename_string (ch, f);
905 while ((ch = getc (f)) != EOF && is_hspace(ch))
907 to = read_filename_string (ch, f);
909 ptr = ((struct file_name_map *)
910 xmalloc (sizeof (struct file_name_map)));
911 ptr->map_from = from;
913 /* Make the real filename absolute. */
914 if (IS_ABSOLUTE_PATHNAME (to))
915 ptr->map_to = to;
916 else
918 ptr->map_to = xmalloc (dirlen + strlen (to) + 2);
919 strcpy (ptr->map_to, dirname);
920 ptr->map_to[dirlen] = '/';
921 strcpy (ptr->map_to + dirlen + 1, to);
922 free (to);
925 ptr->map_next = map_list_ptr->map_list_map;
926 map_list_ptr->map_list_map = ptr;
928 while ((ch = getc (f)) != '\n')
929 if (ch == EOF)
930 break;
932 fclose (f);
935 /* Add this information to the cache. */
936 map_list_ptr->map_list_next = CPP_OPTION (pfile, map_list);
937 CPP_OPTION (pfile, map_list) = map_list_ptr;
939 return map_list_ptr->map_list_map;
942 /* Remap NAME based on the file_name_map (if any) for LOC. */
944 static char *
945 remap_filename (pfile, name, loc)
946 cpp_reader *pfile;
947 char *name;
948 struct file_name_list *loc;
950 struct file_name_map *map;
951 const char *from, *p;
952 char *dir;
954 if (! loc->name_map)
956 loc->name_map = read_name_map (pfile, loc->name ? loc->name : ".");
957 if (! loc->name_map)
958 return name;
961 from = name + strlen (loc->name) + 1;
963 for (map = loc->name_map; map; map = map->map_next)
964 if (!strcmp (map->map_from, from))
965 return map->map_to;
967 /* Try to find a mapping file for the particular directory we are
968 looking in. Thus #include <sys/types.h> will look up sys/types.h
969 in /usr/include/header.gcc and look up types.h in
970 /usr/include/sys/header.gcc. */
971 p = strrchr (name, '/');
972 if (!p)
973 return name;
975 /* We know p != name as absolute paths don't call remap_filename. */
976 if (p == name)
977 cpp_ice (pfile, "absolute file name in remap_filename");
979 dir = (char *) alloca (p - name + 1);
980 memcpy (dir, name, p - name);
981 dir[p - name] = '\0';
982 from = p + 1;
984 for (map = read_name_map (pfile, dir); map; map = map->map_next)
985 if (! strcmp (map->map_from, from))
986 return map->map_to;
988 return name;
991 /* Given a path FNAME, extract the directory component and place it
992 onto the actual_dirs list. Return a pointer to the allocated
993 file_name_list structure. These structures are used to implement
994 current-directory "" include searching. */
996 static struct file_name_list *
997 actual_directory (pfile, fname)
998 cpp_reader *pfile;
999 const char *fname;
1001 char *last_slash, *dir;
1002 size_t dlen;
1003 struct file_name_list *x;
1005 dir = xstrdup (fname);
1006 last_slash = strrchr (dir, '/');
1007 if (last_slash)
1009 if (last_slash == dir)
1011 dlen = 1;
1012 last_slash[1] = '\0';
1014 else
1016 dlen = last_slash - dir;
1017 *last_slash = '\0';
1020 else
1022 free (dir);
1023 dir = xstrdup (".");
1024 dlen = 1;
1027 if (dlen > pfile->max_include_len)
1028 pfile->max_include_len = dlen;
1030 for (x = pfile->actual_dirs; x; x = x->alloc)
1031 if (!strcmp (x->name, dir))
1033 free (dir);
1034 return x;
1037 /* Not found, make a new one. */
1038 x = (struct file_name_list *) xmalloc (sizeof (struct file_name_list));
1039 x->name = dir;
1040 x->nlen = dlen;
1041 x->next = CPP_OPTION (pfile, quote_include);
1042 x->alloc = pfile->actual_dirs;
1043 x->sysp = pfile->buffer->sysp;
1044 x->name_map = NULL;
1046 pfile->actual_dirs = x;
1047 return x;
1050 /* Simplify a path name in place, deleting redundant components. This
1051 reduces OS overhead and guarantees that equivalent paths compare
1052 the same (modulo symlinks).
1054 Transforms made:
1055 foo/bar/../quux foo/quux
1056 foo/./bar foo/bar
1057 foo//bar foo/bar
1058 /../quux /quux
1059 //quux //quux (POSIX allows leading // as a namespace escape)
1061 Guarantees no trailing slashes. All transforms reduce the length
1062 of the string.
1064 void
1065 _cpp_simplify_pathname (path)
1066 char *path;
1068 char *from, *to;
1069 char *base;
1070 int absolute = 0;
1072 #if defined (HAVE_DOS_BASED_FILE_SYSTEM)
1073 /* Convert all backslashes to slashes. */
1074 for (from = path; *from; from++)
1075 if (*from == '\\') *from = '/';
1077 /* Skip over leading drive letter if present. */
1078 if (ISALPHA (path[0]) && path[1] == ':')
1079 from = to = &path[2];
1080 else
1081 from = to = path;
1082 #else
1083 from = to = path;
1084 #endif
1086 /* Remove redundant initial /s. */
1087 if (*from == '/')
1089 absolute = 1;
1090 to++;
1091 from++;
1092 if (*from == '/')
1094 if (*++from == '/')
1095 /* 3 or more initial /s are equivalent to 1 /. */
1096 while (*++from == '/');
1097 else
1098 /* On some hosts // differs from /; Posix allows this. */
1099 to++;
1102 base = to;
1104 for (;;)
1106 while (*from == '/')
1107 from++;
1109 if (from[0] == '.' && from[1] == '/')
1110 from += 2;
1111 else if (from[0] == '.' && from[1] == '\0')
1112 goto done;
1113 else if (from[0] == '.' && from[1] == '.' && from[2] == '/')
1115 if (base == to)
1117 if (absolute)
1118 from += 3;
1119 else
1121 *to++ = *from++;
1122 *to++ = *from++;
1123 *to++ = *from++;
1124 base = to;
1127 else
1129 to -= 2;
1130 while (to > base && *to != '/') to--;
1131 if (*to == '/')
1132 to++;
1133 from += 3;
1136 else if (from[0] == '.' && from[1] == '.' && from[2] == '\0')
1138 if (base == to)
1140 if (!absolute)
1142 *to++ = *from++;
1143 *to++ = *from++;
1146 else
1148 to -= 2;
1149 while (to > base && *to != '/') to--;
1150 if (*to == '/')
1151 to++;
1153 goto done;
1155 else
1156 /* Copy this component and trailing /, if any. */
1157 while ((*to++ = *from++) != '/')
1159 if (!to[-1])
1161 to--;
1162 goto done;
1168 done:
1169 /* Trim trailing slash */
1170 if (to[0] == '/' && (!absolute || to > path+1))
1171 to--;
1173 /* Change the empty string to "." so that stat() on the result
1174 will always work. */
1175 if (to == path)
1176 *to++ = '.';
1178 *to = '\0';
1180 return;