gcc/prefix.c

   1 /* Utility to update paths from internal to external forms.
   2    Copyright (C) 1997 Free Software Foundation, Inc.
   3
   4 This file is part of GNU CC.
   5
   6 GNU CC is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU Library General Public
   8 License as published by the Free Software Foundation; either
   9 version 2 of the License, or (at your option) any later version.
  10
  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.
  15
  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.  */
  20
  21 /* This file contains routines to update a path, both to canonicalize
  22    the directory format and to handle any prefix translation.
  23
  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.
  27
  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).
  31
  32    If the prefix is not specified, the filename will only undergo
  33    directory canonicalization.
  34
  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:
  39
  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:
  43
  44    -- If this is a Win32 OS, then the Registry will be examined for
  45       an entry of "key" in
  46
  47       HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\
  48
  49       if found, that value will be used.
  50
  51    -- If not found (or not a Win32 OS), the environment variable
  52       key_ROOT (the value of "key" concatenated with the constant "_ROOT")
  53       is tried.  If that fails, then PREFIX (see above) is used.
  54
  55    2) If the filename begins with a '$', the rest of the string up
  56    to the end or the first '/' or directory separator will be used
  57    as an environment variable, whose value will be returned.
  58
  59    Once all this is done, any '/' will be converted to DIR_SEPARATOR,
  60    if they are different.
  61
  62    NOTE:  using resolve_keyed_path under Win32 requires linking with
  63    advapi32.dll.  */
  64
  65
  66 #include "config.h"
  67 #include "gansidecl.h"
  68 #ifdef __STDC__
  69 #include <stdarg.h>
  70 #else
  71 #include <varargs.h>
  72 #endif
  73
  74 #ifdef _WIN32
  75 #include <windows.h>
  76 #endif
  77
  78 static char *get_key_value      PROTO((char *));
  79 static char *translate_name     PROTO((char *));
  80 static char *concat             PVPROTO((char *, ...));
  81 static char *save_string        PROTO((char *, int));
  82
  83 #ifdef _WIN32
  84 static char *lookup_key         PROTO((char *));
  85 static HKEY reg_key = (HKEY) INVALID_HANDLE_VALUE;
  86 #endif
  87
  88 extern char *getenv ();
  89
  90 /* Given KEY, as above, return its value.  */
  91
  92 static char *
  93 get_key_value (key)
  94      char *key;
  95 {
  96   char *prefix = 0;
  97
  98 #ifdef _WIN32
  99   prefix = lookup_key (key);
 100 #endif
 101
 102   if (prefix == 0)
 103     prefix = getenv (concat (key, "_ROOT", NULL_PTR));
 104
 105   if (prefix == 0)
 106     prefix = PREFIX;
 107
 108   return prefix;
 109 }
 110
 111 /* Concatenate a sequence of strings, returning the result.
 112
 113    This function is based on the one in libiberty.  */
 114
 115 static char *
 116 concat VPROTO((char *first, ...))
 117 {
 118   register int length;
 119   register char *newstr;
 120   register char *end;
 121   register char *arg;
 122   va_list args;
 123 #ifndef __STDC__
 124   char *first;
 125 #endif
 126
 127   /* First compute the size of the result and get sufficient memory.  */
 128
 129   VA_START (args, first);
 130 #ifndef __STDC__
 131   first = va_arg (args, char *);
 132 #endif
 133
 134   arg = first;
 135   length = 0;
 136
 137   while (arg != 0)
 138     {
 139       length += strlen (arg);
 140       arg = va_arg (args, char *);
 141     }
 142
 143   newstr = (char *) malloc (length + 1);
 144   va_end (args);
 145
 146   /* Now copy the individual pieces to the result string.  */
 147
 148   VA_START (args, first);
 149 #ifndef __STDC__
 150   first = va_arg (args, char *);
 151 #endif
 152
 153   end = newstr;
 154   arg = first;
 155   while (arg != 0)
 156     {
 157       while (*arg)
 158         *end++ = *arg++;
 159       arg = va_arg (args, char *);
 160     }
 161   *end = '\000';
 162   va_end (args);
 163
 164   return (newstr);
 165 }
 166
 167 /* Return a copy of a string that has been placed in the heap.  */
 168
 169 static char *
 170 save_string (s, len)
 171      char *s;
 172      int len;
 173 {
 174   register char *result = (char *) malloc (len + 1);
 175
 176   bcopy (s, result, len);
 177   result[len] = 0;
 178   return result;
 179 }
 180
 181 #ifdef _WIN32
 182
 183 /* Look up "key" in the registry, as above.  */
 184
 185 static char *
 186 lookup_key (key)
 187      char *key;
 188 {
 189   char *dst;
 190   DWORD size;
 191   DWORD type;
 192   LONG res;
 193
 194   if (reg_key == (HKEY) INVALID_HANDLE_VALUE)
 195     {
 196       res = RegOpenKeyExA (HKEY_LOCAL_MACHINE, "SOFTWARE", 0,
 197                            KEY_READ, &reg_key);
 198
 199       if (res == ERROR_SUCCESS)
 200         res = RegOpenKeyExA (reg_key, "Free Software Foundation", 0,
 201                              KEY_READ, &reg_key);
 202
 203       if (res != ERROR_SUCCESS)
 204         {
 205           reg_key = (HKEY) INVALID_HANDLE_VALUE;
 206           return 0;
 207         }
 208     }
 209
 210   size = 32;
 211   dst = (char *) malloc (size);
 212
 213   res = RegQueryValueExA (reg_key, key, 0, &type, dst, &size);
 214   if (res == ERROR_MORE_DATA && type == REG_SZ)
 215     {
 216       dst = (char *) realloc (dst, size);
 217       res = RegQueryValueExA (reg_key, key, 0, &type, dst, &size);
 218     }
 219
 220   if (type != REG_SZ || res != ERROR_SUCCESS)
 221     {
 222       free (dst);
 223       dst = 0;
 224     }
 225
 226   return dst;
 227 }
 228 #endif
 229
 230 /* If NAME starts with a '@' or '$', apply the translation rules above
 231    and return a new name.  Otherwise, return the given name.  */
 232
 233 static char *
 234 translate_name (name)
 235      char *name;
 236 {
 237   char code = name[0];
 238   char *key, *prefix;
 239   int keylen;
 240
 241   if (code != '@' && code != '$')
 242     return name;
 243
 244   for (keylen = 0;
 245        (name[keylen + 1] != 0 && name[keylen + 1] != '/'
 246 #ifdef DIR_SEPARATOR
 247         && name[keylen + 1] != DIR_SEPARATOR
 248 #endif
 249         );
 250        keylen++)
 251     ;
 252
 253   key = alloca (keylen + 1);
 254   strncpy (key, &name[1], keylen);
 255   key[keylen] = 0;
 256
 257   name = &name[keylen + 1];
 258
 259   if (code == '@')
 260     {
 261       prefix = get_key_value (key);
 262       if (prefix == 0)
 263         prefix = PREFIX;
 264     }
 265   else
 266     {
 267       prefix = getenv (key);
 268       if (prefix == 0)
 269         prefix = concat ("$", key, NULL_PTR);
 270     }
 271
 272   /* Remove any trailing directory separator from what we got.  */
 273   if (prefix[strlen (prefix) - 1] == '/'
 274 #ifdef DIR_SEPARATOR
 275       || prefix[strlen (prefix) - 1] == DIR_SEPARATOR
 276 #endif
 277       )
 278     {
 279       prefix = save_string (prefix, strlen (prefix));
 280       prefix[strlen (prefix) - 1] = 0;
 281     }
 282
 283   return concat (prefix, name, NULL_PTR);
 284 }
 285
 286 /* Update PATH using KEY if PATH starts with PREFIX.  */
 287
 288 char *
 289 update_path (path, key)
 290      char *path;
 291      char *key;
 292 {
 293   if (! strncmp (path, PREFIX, strlen (PREFIX)) && key != 0)
 294     {
 295       if (key[0] != '$')
 296         key = concat ("@", key, NULL_PTR);
 297
 298       path = concat (key, &path[strlen (PREFIX)], NULL_PTR);
 299
 300       while (path[0] == '@' || path[0] == '$')
 301         path = translate_name (path);
 302     }
 303
 304 #ifdef DIR_SEPARATOR
 305   if (DIR_SEPARATOR != '/')
 306     {
 307       int i;
 308       int len = strlen (path);
 309
 310       path = save_string (path, len);
 311       for (i = 0; i < len; i++)
 312         if (path[i] == '/')
 313           path[i] = DIR_SEPARATOR;
 314     }
 315 #endif
 316
 317   return path;
 318 }