Update the required version of gettext to get new bugfix macros.
[make.git] / vpath.c
blob35664e6747879f588136d4405fa171da85f29d52
1 /* Implementation of pattern-matching file search paths for GNU Make.
2 Copyright (C) 1988-2012 Free Software Foundation, Inc.
3 This file is part of GNU Make.
5 GNU Make is free software; you can redistribute it and/or modify it under the
6 terms of the GNU General Public License as published by the Free Software
7 Foundation; either version 3 of the License, or (at your option) any later
8 version.
10 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
11 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License along with
15 this program. If not, see <http://www.gnu.org/licenses/>. */
17 #include "make.h"
18 #include "filedef.h"
19 #include "variable.h"
20 #ifdef WINDOWS32
21 #include "pathstuff.h"
22 #endif
25 /* Structure used to represent a selective VPATH searchpath. */
27 struct vpath
29 struct vpath *next; /* Pointer to next struct in the linked list. */
30 const char *pattern;/* The pattern to match. */
31 const char *percent;/* Pointer into 'pattern' where the '%' is. */
32 unsigned int patlen;/* Length of the pattern. */
33 const char **searchpath; /* Null-terminated list of directories. */
34 unsigned int maxlen;/* Maximum length of any entry in the list. */
37 /* Linked-list of all selective VPATHs. */
39 static struct vpath *vpaths;
41 /* Structure for the general VPATH given in the variable. */
43 static struct vpath *general_vpath;
45 /* Structure for GPATH given in the variable. */
47 static struct vpath *gpaths;
50 /* Reverse the chain of selective VPATH lists so they will be searched in the
51 order given in the makefiles and construct the list from the VPATH
52 variable. */
54 void
55 build_vpath_lists ()
57 register struct vpath *new = 0;
58 register struct vpath *old, *nexto;
59 register char *p;
61 /* Reverse the chain. */
62 for (old = vpaths; old != 0; old = nexto)
64 nexto = old->next;
65 old->next = new;
66 new = old;
69 vpaths = new;
71 /* If there is a VPATH variable with a nonnull value, construct the
72 general VPATH list from it. We use variable_expand rather than just
73 calling lookup_variable so that it will be recursively expanded. */
76 /* Turn off --warn-undefined-variables while we expand SHELL and IFS. */
77 int save = warn_undefined_variables_flag;
78 warn_undefined_variables_flag = 0;
80 p = variable_expand ("$(strip $(VPATH))");
82 warn_undefined_variables_flag = save;
85 if (*p != '\0')
87 /* Save the list of vpaths. */
88 struct vpath *save_vpaths = vpaths;
89 char gp[] = "%";
91 /* Empty 'vpaths' so the new one will have no next, and 'vpaths'
92 will still be nil if P contains no existing directories. */
93 vpaths = 0;
95 /* Parse P. */
96 construct_vpath_list (gp, p);
98 /* Store the created path as the general path,
99 and restore the old list of vpaths. */
100 general_vpath = vpaths;
101 vpaths = save_vpaths;
104 /* If there is a GPATH variable with a nonnull value, construct the
105 GPATH list from it. We use variable_expand rather than just
106 calling lookup_variable so that it will be recursively expanded. */
109 /* Turn off --warn-undefined-variables while we expand SHELL and IFS. */
110 int save = warn_undefined_variables_flag;
111 warn_undefined_variables_flag = 0;
113 p = variable_expand ("$(strip $(GPATH))");
115 warn_undefined_variables_flag = save;
118 if (*p != '\0')
120 /* Save the list of vpaths. */
121 struct vpath *save_vpaths = vpaths;
122 char gp[] = "%";
124 /* Empty 'vpaths' so the new one will have no next, and 'vpaths'
125 will still be nil if P contains no existing directories. */
126 vpaths = 0;
128 /* Parse P. */
129 construct_vpath_list (gp, p);
131 /* Store the created path as the GPATH,
132 and restore the old list of vpaths. */
133 gpaths = vpaths;
134 vpaths = save_vpaths;
138 /* Construct the VPATH listing for the PATTERN and DIRPATH given.
140 This function is called to generate selective VPATH lists and also for
141 the general VPATH list (which is in fact just a selective VPATH that
142 is applied to everything). The returned pointer is either put in the
143 linked list of all selective VPATH lists or in the GENERAL_VPATH
144 variable.
146 If DIRPATH is nil, remove all previous listings with the same
147 pattern. If PATTERN is nil, remove all VPATH listings. Existing
148 and readable directories that are not "." given in the DIRPATH
149 separated by the path element separator (defined in make.h) are
150 loaded into the directory hash table if they are not there already
151 and put in the VPATH searchpath for the given pattern with trailing
152 slashes stripped off if present (and if the directory is not the
153 root, "/"). The length of the longest entry in the list is put in
154 the structure as well. The new entry will be at the head of the
155 VPATHS chain. */
157 void
158 construct_vpath_list (char *pattern, char *dirpath)
160 unsigned int elem;
161 char *p;
162 const char **vpath;
163 unsigned int maxvpath;
164 unsigned int maxelem;
165 const char *percent = NULL;
167 if (pattern != 0)
168 percent = find_percent (pattern);
170 if (dirpath == 0)
172 /* Remove matching listings. */
173 struct vpath *path, *lastpath;
175 lastpath = 0;
176 path = vpaths;
177 while (path != 0)
179 struct vpath *next = path->next;
181 if (pattern == 0
182 || (((percent == 0 && path->percent == 0)
183 || (percent - pattern == path->percent - path->pattern))
184 && streq (pattern, path->pattern)))
186 /* Remove it from the linked list. */
187 if (lastpath == 0)
188 vpaths = path->next;
189 else
190 lastpath->next = next;
192 /* Free its unused storage. */
193 /* MSVC erroneously warns without a cast here. */
194 free ((void *)path->searchpath);
195 free (path);
197 else
198 lastpath = path;
200 path = next;
203 return;
206 #ifdef WINDOWS32
207 convert_vpath_to_windows32(dirpath, ';');
208 #endif
210 /* Skip over any initial separators and blanks. */
211 while (*dirpath == PATH_SEPARATOR_CHAR || isblank ((unsigned char)*dirpath))
212 ++dirpath;
214 /* Figure out the maximum number of VPATH entries and put it in
215 MAXELEM. We start with 2, one before the first separator and one
216 nil (the list terminator) and increment our estimated number for
217 each separator or blank we find. */
218 maxelem = 2;
219 p = dirpath;
220 while (*p != '\0')
221 if (*p++ == PATH_SEPARATOR_CHAR || isblank ((unsigned char)*p))
222 ++maxelem;
224 vpath = xmalloc (maxelem * sizeof (const char *));
225 maxvpath = 0;
227 elem = 0;
228 p = dirpath;
229 while (*p != '\0')
231 char *v;
232 unsigned int len;
234 /* Find the end of this entry. */
235 v = p;
236 while (*p != '\0'
237 #if defined(HAVE_DOS_PATHS) && (PATH_SEPARATOR_CHAR == ':')
238 /* Platforms whose PATH_SEPARATOR_CHAR is ':' and which
239 also define HAVE_DOS_PATHS would like us to recognize
240 colons after the drive letter in the likes of
241 "D:/foo/bar:C:/xyzzy". */
242 && (*p != PATH_SEPARATOR_CHAR
243 || (p == v + 1 && (p[1] == '/' || p[1] == '\\')))
244 #else
245 && *p != PATH_SEPARATOR_CHAR
246 #endif
247 && !isblank ((unsigned char)*p))
248 ++p;
250 len = p - v;
251 /* Make sure there's no trailing slash,
252 but still allow "/" as a directory. */
253 #if defined(__MSDOS__) || defined(__EMX__) || defined(HAVE_DOS_PATHS)
254 /* We need also to leave alone a trailing slash in "d:/". */
255 if (len > 3 || (len > 1 && v[1] != ':'))
256 #endif
257 if (len > 1 && p[-1] == '/')
258 --len;
260 /* Put the directory on the vpath list. */
261 if (len > 1 || *v != '.')
263 vpath[elem++] = dir_name (strcache_add_len (v, len));
264 if (len > maxvpath)
265 maxvpath = len;
268 /* Skip over separators and blanks between entries. */
269 while (*p == PATH_SEPARATOR_CHAR || isblank ((unsigned char)*p))
270 ++p;
273 if (elem > 0)
275 struct vpath *path;
276 /* ELEM is now incremented one element past the last
277 entry, to where the nil-pointer terminator goes.
278 Usually this is maxelem - 1. If not, shrink down. */
279 if (elem < (maxelem - 1))
280 vpath = xrealloc (vpath, (elem+1) * sizeof (const char *));
282 /* Put the nil-pointer terminator on the end of the VPATH list. */
283 vpath[elem] = NULL;
285 /* Construct the vpath structure and put it into the linked list. */
286 path = xmalloc (sizeof (struct vpath));
287 path->searchpath = vpath;
288 path->maxlen = maxvpath;
289 path->next = vpaths;
290 vpaths = path;
292 /* Set up the members. */
293 path->pattern = strcache_add (pattern);
294 path->patlen = strlen (pattern);
295 path->percent = percent ? path->pattern + (percent - pattern) : 0;
297 else
298 /* There were no entries, so free whatever space we allocated. */
299 /* MSVC erroneously warns without a cast here. */
300 free ((void *)vpath);
303 /* Search the GPATH list for a pathname string that matches the one passed
304 in. If it is found, return 1. Otherwise we return 0. */
307 gpath_search (const char *file, unsigned int len)
309 const char **gp;
311 if (gpaths && (len <= gpaths->maxlen))
312 for (gp = gpaths->searchpath; *gp != NULL; ++gp)
313 if (strneq (*gp, file, len) && (*gp)[len] == '\0')
314 return 1;
316 return 0;
320 /* Search the given VPATH list for a directory where the name pointed to by
321 FILE exists. If it is found, we return a cached name of the existing file
322 and set *MTIME_PTR (if MTIME_PTR is not NULL) to its modtime (or zero if no
323 stat call was done). Also set the matching directory index in PATH_INDEX
324 if it is not NULL. Otherwise we return NULL. */
326 static const char *
327 selective_vpath_search (struct vpath *path, const char *file,
328 FILE_TIMESTAMP *mtime_ptr, unsigned int* path_index)
330 int not_target;
331 char *name;
332 const char *n;
333 const char *filename;
334 const char **vpath = path->searchpath;
335 unsigned int maxvpath = path->maxlen;
336 unsigned int i;
337 unsigned int flen, vlen, name_dplen;
338 int exists = 0;
340 /* Find out if *FILE is a target.
341 If and only if it is NOT a target, we will accept prospective
342 files that don't exist but are mentioned in a makefile. */
344 struct file *f = lookup_file (file);
345 not_target = f == 0 || !f->is_target;
348 flen = strlen (file);
350 /* Split *FILE into a directory prefix and a name-within-directory.
351 NAME_DPLEN gets the length of the prefix; FILENAME gets the pointer to
352 the name-within-directory and FLEN is its length. */
354 n = strrchr (file, '/');
355 #ifdef HAVE_DOS_PATHS
356 /* We need the rightmost slash or backslash. */
358 const char *bslash = strrchr(file, '\\');
359 if (!n || bslash > n)
360 n = bslash;
362 #endif
363 name_dplen = n != 0 ? n - file : 0;
364 filename = name_dplen > 0 ? n + 1 : file;
365 if (name_dplen > 0)
366 flen -= name_dplen + 1;
368 /* Get enough space for the biggest VPATH entry, a slash, the directory
369 prefix that came with FILE, another slash (although this one may not
370 always be necessary), the filename, and a null terminator. */
371 name = alloca (maxvpath + 1 + name_dplen + 1 + flen + 1);
373 /* Try each VPATH entry. */
374 for (i = 0; vpath[i] != 0; ++i)
376 int exists_in_cache = 0;
377 char *p;
379 p = name;
381 /* Put the next VPATH entry into NAME at P and increment P past it. */
382 vlen = strlen (vpath[i]);
383 memcpy (p, vpath[i], vlen);
384 p += vlen;
386 /* Add the directory prefix already in *FILE. */
387 if (name_dplen > 0)
389 #ifndef VMS
390 *p++ = '/';
391 #endif
392 memcpy (p, file, name_dplen);
393 p += name_dplen;
396 #ifdef HAVE_DOS_PATHS
397 /* Cause the next if to treat backslash and slash alike. */
398 if (p != name && p[-1] == '\\' )
399 p[-1] = '/';
400 #endif
401 /* Now add the name-within-directory at the end of NAME. */
402 #ifndef VMS
403 if (p != name && p[-1] != '/')
405 *p = '/';
406 memcpy (p + 1, filename, flen + 1);
408 else
409 #endif
410 memcpy (p, filename, flen + 1);
412 /* Check if the file is mentioned in a makefile. If *FILE is not
413 a target, that is enough for us to decide this file exists.
414 If *FILE is a target, then the file must be mentioned in the
415 makefile also as a target to be chosen.
417 The restriction that *FILE must not be a target for a
418 makefile-mentioned file to be chosen was added by an
419 inadequately commented change in July 1990; I am not sure off
420 hand what problem it fixes.
422 In December 1993 I loosened this restriction to allow a file
423 to be chosen if it is mentioned as a target in a makefile. This
424 seem logical.
426 Special handling for -W / -o: make sure we preserve the special
427 values here. Actually this whole thing is a little bogus: I think
428 we should ditch the name/hname thing and look into the renamed
429 capability that already exists for files: that is, have a new struct
430 file* entry for the VPATH-found file, and set the renamed field if
431 we use it.
434 struct file *f = lookup_file (name);
435 if (f != 0)
437 exists = not_target || f->is_target;
438 if (exists && mtime_ptr
439 && (f->last_mtime == OLD_MTIME || f->last_mtime == NEW_MTIME))
441 *mtime_ptr = f->last_mtime;
442 mtime_ptr = 0;
447 if (!exists)
449 /* That file wasn't mentioned in the makefile.
450 See if it actually exists. */
452 #ifdef VMS
453 exists_in_cache = exists = dir_file_exists_p (vpath[i], filename);
454 #else
455 /* Clobber a null into the name at the last slash.
456 Now NAME is the name of the directory to look in. */
457 *p = '\0';
459 /* We know the directory is in the hash table now because either
460 construct_vpath_list or the code just above put it there.
461 Does the file we seek exist in it? */
462 exists_in_cache = exists = dir_file_exists_p (name, filename);
463 #endif
466 if (exists)
468 /* The file is in the directory cache.
469 Now check that it actually exists in the filesystem.
470 The cache may be out of date. When vpath thinks a file
471 exists, but stat fails for it, confusion results in the
472 higher levels. */
474 struct stat st;
476 #ifndef VMS
477 /* Put the slash back in NAME. */
478 *p = '/';
479 #endif
481 if (exists_in_cache) /* Makefile-mentioned file need not exist. */
483 int e;
485 EINTRLOOP (e, stat (name, &st)); /* Does it really exist? */
486 if (e != 0)
488 exists = 0;
489 continue;
492 /* Store the modtime into *MTIME_PTR for the caller. */
493 if (mtime_ptr != 0)
495 *mtime_ptr = FILE_TIMESTAMP_STAT_MODTIME (name, st);
496 mtime_ptr = 0;
500 /* We have found a file.
501 If we get here and mtime_ptr hasn't been set, record
502 UNKNOWN_MTIME to indicate this. */
503 if (mtime_ptr != 0)
504 *mtime_ptr = UNKNOWN_MTIME;
506 /* Store the name we found and return it. */
508 if (path_index)
509 *path_index = i;
511 return strcache_add_len (name, (p + 1 - name) + flen);
515 return 0;
519 /* Search the VPATH list whose pattern matches FILE for a directory where FILE
520 exists. If it is found, return the cached name of an existing file, and
521 set *MTIME_PTR (if MTIME_PTR is not NULL) to its modtime (or zero if no
522 stat call was done). Also set the matching directory index in VPATH_INDEX
523 and PATH_INDEX if they are not NULL. Otherwise we return 0. */
525 const char *
526 vpath_search (const char *file, FILE_TIMESTAMP *mtime_ptr,
527 unsigned int* vpath_index, unsigned int* path_index)
529 struct vpath *v;
531 /* If there are no VPATH entries or FILENAME starts at the root,
532 there is nothing we can do. */
534 if (file[0] == '/'
535 #ifdef HAVE_DOS_PATHS
536 || file[0] == '\\' || file[1] == ':'
537 #endif
538 || (vpaths == 0 && general_vpath == 0))
539 return 0;
541 if (vpath_index)
543 *vpath_index = 0;
544 *path_index = 0;
547 for (v = vpaths; v != 0; v = v->next)
549 if (pattern_matches (v->pattern, v->percent, file))
551 const char *p = selective_vpath_search (
552 v, file, mtime_ptr, path_index);
553 if (p)
554 return p;
557 if (vpath_index)
558 ++*vpath_index;
562 if (general_vpath != 0)
564 const char *p = selective_vpath_search (
565 general_vpath, file, mtime_ptr, path_index);
566 if (p)
567 return p;
570 return 0;
576 /* Print the data base of VPATH search paths. */
578 void
579 print_vpath_data_base (void)
581 unsigned int nvpaths;
582 struct vpath *v;
584 puts (_("\n# VPATH Search Paths\n"));
586 nvpaths = 0;
587 for (v = vpaths; v != 0; v = v->next)
589 register unsigned int i;
591 ++nvpaths;
593 printf ("vpath %s ", v->pattern);
595 for (i = 0; v->searchpath[i] != 0; ++i)
596 printf ("%s%c", v->searchpath[i],
597 v->searchpath[i + 1] == 0 ? '\n' : PATH_SEPARATOR_CHAR);
600 if (vpaths == 0)
601 puts (_("# No 'vpath' search paths."));
602 else
603 printf (_("\n# %u 'vpath' search paths.\n"), nvpaths);
605 if (general_vpath == 0)
606 puts (_("\n# No general ('VPATH' variable) search path."));
607 else
609 const char **path = general_vpath->searchpath;
610 unsigned int i;
612 fputs (_("\n# General ('VPATH' variable) search path:\n# "), stdout);
614 for (i = 0; path[i] != 0; ++i)
615 printf ("%s%c", path[i],
616 path[i + 1] == 0 ? '\n' : PATH_SEPARATOR_CHAR);