1 /* Utility to update paths from internal to external forms.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3 2007 Free Software Foundation, Inc.
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU Library General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or (at
10 your option) any later version.
12 GCC 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 GNU
15 Library General Public License for more details.
17 You should have received a copy of the GNU Library General Public
18 License along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
21 /* This file contains routines to update a path, both to canonicalize
22 the directory format and to handle any prefix translation.
24 This file must be compiled with -DPREFIX= to specify the "prefix"
25 value used by configure. If a filename does not begin with this
26 prefix, it will not be affected other than by directory canonicalization.
28 Each caller of 'update_path' may specify both a filename and
29 a translation prefix and consist of the name of the package that contains
30 the file ("@GCC", "@BINUTIL", "@GNU", etc).
32 If the prefix is not specified, the filename will only undergo
33 directory canonicalization.
35 If it is specified, the string given by PREFIX will be replaced
36 by the specified prefix (with a '@' in front unless the prefix begins
37 with a '$') and further translation will be done as follows
38 until none of the two conditions below are met:
40 1) If the filename begins with '@', the string between the '@' and
41 the end of the name or the first '/' or directory separator will
42 be considered a "key" and looked up as follows:
44 -- If this is a Win32 OS, then the Registry will be examined for
47 HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\<KEY>
49 if found, that value will be used. <KEY> defaults to GCC version
50 string, but can be overridden at configuration time.
52 -- If not found (or not a Win32 OS), the environment variable
53 key_ROOT (the value of "key" concatenated with the constant "_ROOT")
54 is tried. If that fails, then PREFIX (see above) is used.
56 2) If the filename begins with a '$', the rest of the string up
57 to the end or the first '/' or directory separator will be used
58 as an environment variable, whose value will be returned.
60 Once all this is done, any '/' will be converted to DIR_SEPARATOR,
61 if they are different.
63 NOTE: using resolve_keyed_path under Win32 requires linking with
69 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
74 static const char *std_prefix = PREFIX;
76 static const char *get_key_value (char *);
77 static char *translate_name (char *);
78 static char *save_string (const char *, int);
79 static void tr (char *, int, int);
81 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
82 static char *lookup_key (char *);
83 static HKEY reg_key = (HKEY) INVALID_HANDLE_VALUE;
86 /* Given KEY, as above, return its value. */
89 get_key_value (char *key)
91 const char *prefix = 0;
94 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
95 prefix = lookup_key (key);
99 prefix = getenv (temp = concat (key, "_ROOT", NULL));
110 /* Return a copy of a string that has been placed in the heap. */
113 save_string (const char *s, int len)
115 char *result = XNEWVEC (char, len + 1);
117 memcpy (result, s, len);
122 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
124 #ifndef WIN32_REGISTRY_KEY
125 # define WIN32_REGISTRY_KEY BASEVER
128 /* Look up "key" in the registry, as above. */
131 lookup_key (char *key)
138 if (reg_key == (HKEY) INVALID_HANDLE_VALUE)
140 res = RegOpenKeyExA (HKEY_LOCAL_MACHINE, "SOFTWARE", 0,
143 if (res == ERROR_SUCCESS)
144 res = RegOpenKeyExA (reg_key, "Free Software Foundation", 0,
147 if (res == ERROR_SUCCESS)
148 res = RegOpenKeyExA (reg_key, WIN32_REGISTRY_KEY, 0,
151 if (res != ERROR_SUCCESS)
153 reg_key = (HKEY) INVALID_HANDLE_VALUE;
159 dst = xmalloc (size);
161 res = RegQueryValueExA (reg_key, key, 0, &type, (LPBYTE) dst, &size);
162 if (res == ERROR_MORE_DATA && type == REG_SZ)
164 dst = xrealloc (dst, size);
165 res = RegQueryValueExA (reg_key, key, 0, &type, (LPBYTE) dst, &size);
168 if (type != REG_SZ || res != ERROR_SUCCESS)
178 /* If NAME, a malloc-ed string, starts with a '@' or '$', apply the
179 translation rules above and return a newly malloc-ed name.
180 Otherwise, return the given name. */
183 translate_name (char *name)
186 char *key, *old_name;
193 if (code != '@' && code != '$')
197 (name[keylen + 1] != 0 && !IS_DIR_SEPARATOR (name[keylen + 1]));
201 key = (char *) alloca (keylen + 1);
202 strncpy (key, &name[1], keylen);
207 prefix = get_key_value (key);
212 prefix = getenv (key);
217 /* We used to strip trailing DIR_SEPARATORs here, but that can
218 sometimes yield a result with no separator when one was coded
219 and intended by the user, causing two path components to run
223 name = concat (prefix, &name[keylen + 1], NULL);
230 /* In a NUL-terminated STRING, replace character C1 with C2 in-place. */
232 tr (char *string, int c1, int c2)
242 /* Update PATH using KEY if PATH starts with PREFIX as a directory.
243 The returned string is always malloc-ed, and the caller is
244 responsible for freeing it. */
247 update_path (const char *path, const char *key)
250 const int len = strlen (std_prefix);
252 if (! strncmp (path, std_prefix, len)
253 && (IS_DIR_SEPARATOR(path[len])
254 || path[len] == '\0')
257 bool free_key = false;
261 key = concat ("@", key, NULL);
265 result = concat (key, &path[len], NULL);
267 free (CONST_CAST (char *, key));
268 result = translate_name (result);
271 result = xstrdup (path);
273 #ifndef ALWAYS_STRIP_DOTDOT
274 #define ALWAYS_STRIP_DOTDOT 0
285 /* Look for `/../' */
287 && IS_DIR_SEPARATOR (p[2])
288 && (p != result && IS_DIR_SEPARATOR (p[-1])))
291 if (!ALWAYS_STRIP_DOTDOT && access (result, X_OK) == 0)
298 /* We can't access the dir, so we won't be able to
299 access dir/.. either. Strip out `dir/../'. If `dir'
300 turns out to be `.', strip one more path component. */
305 while (dest != result && IS_DIR_SEPARATOR (*dest))
307 while (dest != result && !IS_DIR_SEPARATOR (dest[-1]))
310 while (dest != result && *dest == '.');
311 /* If we have something like `./..' or `/..', don't
312 strip anything more. */
313 if (*dest == '.' || IS_DIR_SEPARATOR (*dest))
319 while (IS_DIR_SEPARATOR (*src))
322 while ((*dest++ = *src++) != 0)
330 #ifdef UPDATE_PATH_HOST_CANONICALIZE
331 /* Perform host dependent canonicalization when needed. */
332 UPDATE_PATH_HOST_CANONICALIZE (result);
335 #ifdef DIR_SEPARATOR_2
336 /* Convert DIR_SEPARATOR_2 to DIR_SEPARATOR. */
337 if (DIR_SEPARATOR_2 != DIR_SEPARATOR)
338 tr (result, DIR_SEPARATOR_2, DIR_SEPARATOR);
341 #if defined (DIR_SEPARATOR) && !defined (DIR_SEPARATOR_2)
342 if (DIR_SEPARATOR != '/')
343 tr (result, '/', DIR_SEPARATOR);
349 /* Reset the standard prefix. */
351 set_std_prefix (const char *prefix, int len)
353 std_prefix = save_string (prefix, len);