1 /* Utility to update paths from internal to external forms.
2 Copyright (C) 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
4 This file is part of GCC.
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU Library General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or (at
9 your option) any later version.
11 GCC is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with GCC; see the file COPYING. If not, write to the Free
18 Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
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 PARAMS ((char *));
77 static char *translate_name PARAMS ((char *));
78 static char *save_string PARAMS ((const char *, int));
79 static void tr PARAMS ((char *, int, int));
80 char *concat VPARAMS ((const char *first, ...));
82 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
83 static char *lookup_key PARAMS ((char *));
84 static HKEY reg_key = (HKEY) INVALID_HANDLE_VALUE;
87 /* Given KEY, as above, return its value. */
93 const char *prefix = 0;
96 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
97 prefix = lookup_key (key);
101 prefix = getenv (temp = concat (key, "_ROOT", NULL));
112 /* Return a copy of a string that has been placed in the heap. */
119 char *result = xmalloc (len + 1);
121 memcpy (result, s, len);
126 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
128 /* Look up "key" in the registry, as above. */
139 if (reg_key == (HKEY) INVALID_HANDLE_VALUE)
141 res = RegOpenKeyExA (HKEY_LOCAL_MACHINE, "SOFTWARE", 0,
144 if (res == ERROR_SUCCESS)
145 res = RegOpenKeyExA (reg_key, "Free Software Foundation", 0,
148 if (res == ERROR_SUCCESS)
149 res = RegOpenKeyExA (reg_key, WIN32_REGISTRY_KEY, 0,
152 if (res != ERROR_SUCCESS)
154 reg_key = (HKEY) INVALID_HANDLE_VALUE;
160 dst = (char *) xmalloc (size);
162 res = RegQueryValueExA (reg_key, key, 0, &type, dst, &size);
163 if (res == ERROR_MORE_DATA && type == REG_SZ)
165 dst = (char *) xrealloc (dst, size);
166 res = RegQueryValueExA (reg_key, key, 0, &type, dst, &size);
169 if (type != REG_SZ || res != ERROR_SUCCESS)
179 /* If NAME, a malloc-ed string, starts with a '@' or '$', apply the
180 translation rules above and return a newly malloc-ed name.
181 Otherwise, return the given name. */
184 translate_name (name)
188 char *key, *old_name;
195 if (code != '@' && code != '$')
199 (name[keylen + 1] != 0 && !IS_DIR_SEPARATOR (name[keylen + 1]));
203 key = (char *) alloca (keylen + 1);
204 strncpy (key, &name[1], keylen);
209 prefix = get_key_value (key);
214 prefix = getenv (key);
219 /* We used to strip trailing DIR_SEPARATORs here, but that can
220 sometimes yield a result with no separator when one was coded
221 and intended by the user, causing two path components to run
225 name = concat (prefix, &name[keylen + 1], NULL);
232 /* In a NUL-terminated STRING, replace character C1 with C2 in-place. */
246 /* Update PATH using KEY if PATH starts with PREFIX. The returned
247 string is always malloc-ed, and the caller is responsible for
251 update_path (path, key)
257 if (! strncmp (path, std_prefix, strlen (std_prefix)) && key != 0)
259 bool free_key = false;
263 key = concat ("@", key, NULL);
267 result = concat (key, &path[strlen (std_prefix)], NULL);
270 result = translate_name (result);
273 result = xstrdup (path);
275 #ifdef UPDATE_PATH_HOST_CANONICALIZE
276 /* Perform host dependent canonicalization when needed. */
277 UPDATE_PATH_HOST_CANONICALIZE (path);
280 #ifdef DIR_SEPARATOR_2
281 /* Convert DIR_SEPARATOR_2 to DIR_SEPARATOR. */
282 if (DIR_SEPARATOR_2 != DIR_SEPARATOR)
283 tr (result, DIR_SEPARATOR_2, DIR_SEPARATOR);
286 #if defined (DIR_SEPARATOR) && !defined (DIR_SEPARATOR_2)
287 if (DIR_SEPARATOR != '/')
288 tr (result, '/', DIR_SEPARATOR);
294 /* Reset the standard prefix */
296 set_std_prefix (prefix, len)
300 std_prefix = save_string (prefix, len);