Daily bump.
[official-gcc.git] / gcc / prefix.c
blob88906731bfd55f94a19c8550dd3e1a2cdc6730d8
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
45 an entry of "key" in
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
64 advapi32.dll. */
67 #include "config.h"
68 #include "system.h"
69 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
70 #include <windows.h>
71 #endif
72 #include "prefix.h"
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));
81 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
82 static char *lookup_key PARAMS ((char *));
83 static HKEY reg_key = (HKEY) INVALID_HANDLE_VALUE;
84 #endif
86 /* Given KEY, as above, return its value. */
88 static const char *
89 get_key_value (key)
90 char *key;
92 const char *prefix = 0;
93 char *temp = 0;
95 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
96 prefix = lookup_key (key);
97 #endif
99 if (prefix == 0)
100 prefix = getenv (temp = concat (key, "_ROOT", NULL));
102 if (prefix == 0)
103 prefix = std_prefix;
105 if (temp)
106 free (temp);
108 return prefix;
111 /* Return a copy of a string that has been placed in the heap. */
113 static char *
114 save_string (s, len)
115 const char *s;
116 int len;
118 char *result = xmalloc (len + 1);
120 memcpy (result, s, len);
121 result[len] = 0;
122 return result;
125 #if defined(_WIN32) && defined(ENABLE_WIN32_REGISTRY)
127 /* Look up "key" in the registry, as above. */
129 static char *
130 lookup_key (key)
131 char *key;
133 char *dst;
134 DWORD size;
135 DWORD type;
136 LONG res;
138 if (reg_key == (HKEY) INVALID_HANDLE_VALUE)
140 res = RegOpenKeyExA (HKEY_LOCAL_MACHINE, "SOFTWARE", 0,
141 KEY_READ, &reg_key);
143 if (res == ERROR_SUCCESS)
144 res = RegOpenKeyExA (reg_key, "Free Software Foundation", 0,
145 KEY_READ, &reg_key);
147 if (res == ERROR_SUCCESS)
148 res = RegOpenKeyExA (reg_key, WIN32_REGISTRY_KEY, 0,
149 KEY_READ, &reg_key);
151 if (res != ERROR_SUCCESS)
153 reg_key = (HKEY) INVALID_HANDLE_VALUE;
154 return 0;
158 size = 32;
159 dst = (char *) xmalloc (size);
161 res = RegQueryValueExA (reg_key, key, 0, &type, dst, &size);
162 if (res == ERROR_MORE_DATA && type == REG_SZ)
164 dst = (char *) xrealloc (dst, size);
165 res = RegQueryValueExA (reg_key, key, 0, &type, dst, &size);
168 if (type != REG_SZ || res != ERROR_SUCCESS)
170 free (dst);
171 dst = 0;
174 return dst;
176 #endif
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. */
182 static char *
183 translate_name (name)
184 char *name;
186 char code;
187 char *key, *old_name;
188 const char *prefix;
189 int keylen;
191 for (;;)
193 code = name[0];
194 if (code != '@' && code != '$')
195 break;
197 for (keylen = 0;
198 (name[keylen + 1] != 0 && !IS_DIR_SEPARATOR (name[keylen + 1]));
199 keylen++)
202 key = (char *) alloca (keylen + 1);
203 strncpy (key, &name[1], keylen);
204 key[keylen] = 0;
206 if (code == '@')
208 prefix = get_key_value (key);
209 if (prefix == 0)
210 prefix = std_prefix;
212 else
213 prefix = getenv (key);
215 if (prefix == 0)
216 prefix = PREFIX;
218 /* We used to strip trailing DIR_SEPARATORs here, but that can
219 sometimes yield a result with no separator when one was coded
220 and intended by the user, causing two path components to run
221 together. */
223 old_name = name;
224 name = concat (prefix, &name[keylen + 1], NULL);
225 free (old_name);
228 return name;
231 /* In a NUL-terminated STRING, replace character C1 with C2 in-place. */
232 static void
233 tr (string, c1, c2)
234 char *string;
235 int c1, c2;
239 if (*string == c1)
240 *string = c2;
242 while (*string++);
245 /* Update PATH using KEY if PATH starts with PREFIX. The returned
246 string is always malloc-ed, and the caller is responsible for
247 freeing it. */
249 char *
250 update_path (path, key)
251 const char *path;
252 const char *key;
254 char *result;
256 if (! strncmp (path, std_prefix, strlen (std_prefix)) && key != 0)
258 bool free_key = false;
260 if (key[0] != '$')
262 key = concat ("@", key, NULL);
263 free_key = true;
266 result = concat (key, &path[strlen (std_prefix)], NULL);
267 if (free_key)
268 free ((char *) key);
269 result = translate_name (result);
271 else
272 result = xstrdup (path);
274 #ifdef UPDATE_PATH_HOST_CANONICALIZE
275 /* Perform host dependent canonicalization when needed. */
276 UPDATE_PATH_HOST_CANONICALIZE (path);
277 #endif
279 #ifdef DIR_SEPARATOR_2
280 /* Convert DIR_SEPARATOR_2 to DIR_SEPARATOR. */
281 if (DIR_SEPARATOR_2 != DIR_SEPARATOR)
282 tr (result, DIR_SEPARATOR_2, DIR_SEPARATOR);
283 #endif
285 #if defined (DIR_SEPARATOR) && !defined (DIR_SEPARATOR_2)
286 if (DIR_SEPARATOR != '/')
287 tr (result, '/', DIR_SEPARATOR);
288 #endif
290 return result;
293 /* Reset the standard prefix */
294 void
295 set_std_prefix (prefix, len)
296 const char *prefix;
297 int len;
299 std_prefix = save_string (prefix, len);