libguile/load.c

   1 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  43    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  44
  45 \f
  46
  47 #include <string.h>
  48
  49 #include "libguile/_scm.h"
  50 #include "libguile/libpath.h"
  51 #include "libguile/fports.h"
  52 #include "libguile/read.h"
  53 #include "libguile/eval.h"
  54 #include "libguile/throw.h"
  55 #include "libguile/alist.h"
  56 #include "libguile/dynwind.h"
  57 #include "libguile/root.h"
  58 #include "libguile/strings.h"
  59 #include "libguile/modules.h"
  60
  61 #include "libguile/validate.h"
  62 #include "libguile/load.h"
  63
  64 #include <sys/types.h>
  65 #include <sys/stat.h>
  66
  67 #ifdef HAVE_UNISTD_H
  68 #include <unistd.h>
  69 #endif /* HAVE_UNISTD_H */
  70
  71 #ifndef R_OK
  72 #define R_OK 4
  73 #endif
  74
  75 \f
  76 /* Loading a file, given an absolute filename.  */
  77
  78 /* Hook to run when we load a file, perhaps to announce the fact somewhere.
  79    Applied to the full name of the file.  */
  80 static SCM *scm_loc_load_hook;
  81
  82 static void
  83 swap_port (void *data)
  84 {
  85   SCM *save_port = data, tmp = scm_cur_loadp;
  86   scm_cur_loadp = *save_port;
  87   *save_port = tmp;
  88 }
  89
  90 static SCM
  91 load (void *data)
  92 {
  93   SCM port = SCM_PACK (data);
  94   while (1)
  95     {
  96       SCM form = scm_read (port);
  97       if (SCM_EOF_OBJECT_P (form))
  98         break;
  99       scm_primitive_eval_x (form);
 100     }
 101   return SCM_UNSPECIFIED;
 102 }
 103
 104 SCM_DEFINE (scm_primitive_load, "primitive-load", 1, 0, 0,
 105            (SCM filename),
 106             "Load the file named @var{filename} and evaluate its contents in\n"
 107             "the top-level environment. The load paths are not searched;\n"
 108             "@var{filename} must either be a full pathname or be a pathname\n"
 109             "relative to the current directory.  If the  variable\n"
 110             "@code{%load-hook} is defined, it should be bound to a procedure\n"
 111             "that will be called before any code is loaded.  See the\n"
 112             "documentation for @code{%load-hook} later in this section.")
 113 #define FUNC_NAME s_scm_primitive_load
 114 {
 115   SCM hook = *scm_loc_load_hook;
 116   SCM_VALIDATE_STRING (1, filename);
 117   if (!SCM_FALSEP (hook) && !SCM_EQ_P (scm_procedure_p (hook), SCM_BOOL_T))
 118     SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
 119                     SCM_EOL);
 120
 121   if (! SCM_FALSEP (hook))
 122     scm_call_1 (hook, filename);
 123
 124   { /* scope */
 125     SCM port, save_port;
 126     port = scm_open_file (filename, scm_mem2string ("r", sizeof (char)));
 127     save_port = port;
 128     scm_internal_dynamic_wind (swap_port,
 129                                load,
 130                                swap_port,
 131                                (void *) SCM_UNPACK (port),
 132                                &save_port);
 133     scm_close_port (port);
 134   }
 135   return SCM_UNSPECIFIED;
 136 }
 137 #undef FUNC_NAME
 138
 139 SCM
 140 scm_c_primitive_load (const char *filename)
 141 {
 142   return scm_primitive_load (scm_makfrom0str (filename));
 143 }
 144
 145 \f
 146 /* Builtin path to scheme library files. */
 147 #ifdef SCM_PKGDATA_DIR
 148 SCM_DEFINE (scm_sys_package_data_dir, "%package-data-dir", 0, 0, 0,
 149             (),
 150             "Return the name of the directory where Scheme packages, modules and\n"
 151             "libraries are kept.  On most Unix systems, this will be\n"
 152             "@samp{/usr/local/share/guile}.")
 153 #define FUNC_NAME s_scm_sys_package_data_dir
 154 {
 155   return scm_makfrom0str (SCM_PKGDATA_DIR);
 156 }
 157 #undef FUNC_NAME
 158 #endif /* SCM_PKGDATA_DIR */
 159
 160 #ifdef SCM_LIBRARY_DIR
 161 SCM_DEFINE (scm_sys_library_dir, "%library-dir", 0,0,0,
 162             (),
 163             "Return the directory where the Guile Scheme library files are installed.\n"
 164             "E.g., may return \"/usr/share/guile/1.3.5\".")
 165 #define FUNC_NAME s_scm_sys_library_dir
 166 {
 167   return scm_makfrom0str(SCM_LIBRARY_DIR);
 168 }
 169 #undef FUNC_NAME
 170 #endif /* SCM_LIBRARY_DIR */
 171
 172 #ifdef SCM_SITE_DIR
 173 SCM_DEFINE (scm_sys_site_dir, "%site-dir", 0,0,0,
 174             (),
 175             "Return the directory where the Guile site files are installed.\n"
 176             "E.g., may return \"/usr/share/guile/site\".")
 177 #define FUNC_NAME s_scm_sys_site_dir
 178 {
 179   return scm_makfrom0str(SCM_SITE_DIR);
 180 }
 181 #undef FUNC_NAME
 182 #endif /* SCM_SITE_DIR */
 183
 184
 185
 186 \f
 187 /* Initializing the load path, and searching it.  */
 188
 189 /* List of names of directories we search for files to load.  */
 190 static SCM *scm_loc_load_path;
 191
 192 /* List of extensions we try adding to the filenames.  */
 193 static SCM *scm_loc_load_extensions;
 194
 195
 196 /* Parse the null-terminated string PATH as if it were a standard path
 197    environment variable (i.e. a colon-separated list of strings), and
 198    prepend the elements to TAIL.  */
 199 SCM
 200 scm_internal_parse_path (char *path, SCM tail)
 201 {
 202   if (path && path[0] != '\0')
 203     {
 204       char *scan, *elt_end;
 205
 206       /* Scan backwards from the end of the string, to help
 207          construct the list in the right order.  */
 208       scan = elt_end = path + strlen (path);
 209       do {
 210         /* Scan back to the beginning of the current element.  */
 211         do scan--;
 212         while (scan >= path && *scan != ':');
 213         tail = scm_cons (scm_mem2string (scan + 1, elt_end - (scan + 1)),
 214                          tail);
 215         elt_end = scan;
 216       } while (scan >= path);
 217     }
 218
 219   return tail;
 220 }
 221
 222
 223 SCM_DEFINE (scm_parse_path, "parse-path", 1, 1, 0,
 224             (SCM path, SCM tail),
 225             "Parse @var{path}, which is expected to be a colon-separated\n"
 226             "string, into a list and return the resulting list with\n"
 227             "@var{tail} appended. If @var{path} is @code{#f}, @var{tail}\n"
 228             "is returned.")
 229 #define FUNC_NAME s_scm_parse_path
 230 {
 231   SCM_ASSERT (SCM_FALSEP (path) || (SCM_STRINGP (path)),
 232               path,
 233               SCM_ARG1, FUNC_NAME);
 234   if (SCM_UNBNDP (tail))
 235     tail = SCM_EOL;
 236   return (SCM_FALSEP (path)
 237           ? tail
 238           : scm_internal_parse_path (SCM_STRING_CHARS (path), tail));
 239 }
 240 #undef FUNC_NAME
 241
 242
 243 /* Initialize the global variable %load-path, given the value of the
 244    SCM_SITE_DIR and SCM_LIBRARY_DIR preprocessor symbols and the
 245    GUILE_LOAD_PATH environment variable.  */
 246 void
 247 scm_init_load_path ()
 248 {
 249   SCM path = SCM_EOL;
 250
 251 #ifdef SCM_LIBRARY_DIR
 252   path = scm_list_3 (scm_makfrom0str (SCM_SITE_DIR),
 253                      scm_makfrom0str (SCM_LIBRARY_DIR),
 254                      scm_makfrom0str (SCM_PKGDATA_DIR));
 255 #endif /* SCM_LIBRARY_DIR */
 256
 257   path = scm_internal_parse_path (getenv ("GUILE_LOAD_PATH"), path);
 258
 259   *scm_loc_load_path = path;
 260 }
 261
 262 SCM scm_listofnullstr;
 263
 264 /* Search PATH for a directory containing a file named FILENAME.
 265    The file must be readable, and not a directory.
 266    If we find one, return its full filename; otherwise, return #f.
 267    If FILENAME is absolute, return it unchanged.
 268    If given, EXTENSIONS is a list of strings; for each directory
 269    in PATH, we search for FILENAME concatenated with each EXTENSION.  */
 270 SCM_DEFINE (scm_search_path, "search-path", 2, 1, 0,
 271            (SCM path, SCM filename, SCM extensions),
 272             "Search @var{path} for a directory containing a file named\n"
 273             "@var{filename}. The file must be readable, and not a directory.\n"
 274             "If we find one, return its full filename; otherwise, return\n"
 275             "@code{#f}.  If @var{filename} is absolute, return it unchanged.\n"
 276             "If given, @var{extensions} is a list of strings; for each\n"
 277             "directory in @var{path}, we search for @var{filename}\n"
 278             "concatenated with each @var{extension}.")
 279 #define FUNC_NAME s_scm_search_path
 280 {
 281   char *filename_chars;
 282   int filename_len;
 283   size_t max_path_len;          /* maximum length of any PATH element */
 284   size_t max_ext_len;           /* maximum length of any EXTENSIONS element */
 285
 286   SCM_VALIDATE_LIST (1,path);
 287   SCM_VALIDATE_STRING (2, filename);
 288   if (SCM_UNBNDP (extensions))
 289     extensions = SCM_EOL;
 290   else
 291     SCM_VALIDATE_LIST (3,extensions);
 292
 293   filename_chars = SCM_STRING_CHARS (filename);
 294   filename_len = SCM_STRING_LENGTH (filename);
 295
 296   /* If FILENAME is absolute, return it unchanged.  */
 297   if (filename_len >= 1 && filename_chars[0] == '/')
 298     return filename;
 299
 300   /* Find the length of the longest element of path.  */
 301   {
 302     SCM walk;
 303
 304     max_path_len = 0;
 305     for (walk = path; !SCM_NULLP (walk); walk = SCM_CDR (walk))
 306       {
 307         SCM elt = SCM_CAR (walk);
 308         SCM_ASSERT_TYPE (SCM_STRINGP (elt), path, 1, FUNC_NAME,
 309                          "list of strings");
 310         if (SCM_STRING_LENGTH (elt) > max_path_len)
 311           max_path_len = SCM_STRING_LENGTH (elt);
 312       }
 313   }
 314
 315   /* If FILENAME has an extension, don't try to add EXTENSIONS to it.  */
 316   {
 317     char *endp;
 318
 319     for (endp = filename_chars + filename_len - 1;
 320          endp >= filename_chars;
 321          endp--)
 322       {
 323         if (*endp == '.')
 324           {
 325             /* This filename already has an extension, so cancel the
 326                list of extensions.  */
 327             extensions = SCM_EOL;
 328             break;
 329           }
 330         else if (*endp == '/')
 331           /* This filename has no extension, so keep the current list
 332              of extensions.  */
 333           break;
 334       }
 335   }
 336
 337   /* Find the length of the longest element of the load extensions
 338      list.  */
 339   { /* scope */
 340     SCM walk;
 341
 342     max_ext_len = 0;
 343     for (walk = extensions; !SCM_NULLP (walk); walk = SCM_CDR (walk))
 344       {
 345         SCM elt = SCM_CAR (walk);
 346         SCM_ASSERT_TYPE (SCM_STRINGP (elt), elt, 3, FUNC_NAME,
 347                          "list of strings");
 348         if (SCM_STRING_LENGTH (elt) > max_ext_len)
 349           max_ext_len = SCM_STRING_LENGTH (elt);
 350       }
 351   }
 352
 353   SCM_DEFER_INTS;
 354
 355   { /* scope */
 356     SCM result = SCM_BOOL_F;
 357     size_t buf_size = max_path_len + 1 + filename_len + max_ext_len + 1;
 358     char *buf = SCM_MUST_MALLOC (buf_size);
 359
 360     /* This simplifies the loop below a bit.  */
 361     if (SCM_NULLP (extensions))
 362       extensions = scm_listofnullstr;
 363
 364     /* Try every path element.  At this point, we know the path is a
 365        proper list of strings.  */
 366     for (; !SCM_NULLP (path); path = SCM_CDR (path))
 367       {
 368         size_t len;
 369         SCM dir = SCM_CAR (path);
 370         SCM exts;
 371
 372         /* Concatenate the path name and the filename. */
 373         len = SCM_STRING_LENGTH (dir);
 374         memcpy (buf, SCM_STRING_CHARS (dir), len);
 375         if (len >= 1 && buf[len - 1] != '/')
 376           buf[len++] = '/';
 377         memcpy (buf + len, filename_chars, filename_len);
 378         len += filename_len;
 379
 380         /* Try every extension.  At this point, we know the extension
 381            list is a proper, nonempty list of strings.  */
 382         for (exts = extensions; !SCM_NULLP (exts); exts = SCM_CDR (exts))
 383           {
 384             SCM ext = SCM_CAR (exts);
 385             size_t ext_len = SCM_STRING_LENGTH (ext);
 386             struct stat mode;
 387
 388             /* Concatenate the extension. */
 389             memcpy (buf + len, SCM_STRING_CHARS (ext), ext_len);
 390             buf[len + ext_len] = '\0';
 391
 392             /* If the file exists at all, we should return it.  If the
 393                file is inaccessible, then that's an error.  */
 394             if (stat (buf, &mode) == 0
 395                 && ! (mode.st_mode & S_IFDIR))
 396               {
 397                 result = scm_mem2string (buf, len + ext_len);
 398                 goto end;
 399               }
 400           }
 401       }
 402
 403   end:
 404     scm_must_free (buf);
 405     scm_done_free (buf_size);
 406     SCM_ALLOW_INTS;
 407     return result;
 408   }
 409 }
 410 #undef FUNC_NAME
 411
 412
 413 /* Search %load-path for a directory containing a file named FILENAME.
 414    The file must be readable, and not a directory.
 415    If we find one, return its full filename; otherwise, return #f.
 416    If FILENAME is absolute, return it unchanged.  */
 417 SCM_DEFINE (scm_sys_search_load_path, "%search-load-path", 1, 0, 0,
 418             (SCM filename),
 419             "Search @var{%load-path} for the file named @var{filename},\n"
 420             "which must be readable by the current user.  If @var{filename}\n"
 421             "is found in the list of paths to search or is an absolute\n"
 422             "pathname, return its full pathname.  Otherwise, return\n"
 423             "@code{#f}.  Filenames may have any of the optional extensions\n"
 424             "in the @code{%load-extensions} list; @code{%search-load-path}\n"
 425             "will try each extension automatically.")
 426 #define FUNC_NAME s_scm_sys_search_load_path
 427 {
 428   SCM path = *scm_loc_load_path;
 429   SCM exts = *scm_loc_load_extensions;
 430   SCM_VALIDATE_STRING (1, filename);
 431
 432   if (scm_ilength (path) < 0)
 433     SCM_MISC_ERROR ("%load-path is not a proper list", SCM_EOL);
 434   if (scm_ilength (exts) < 0)
 435     SCM_MISC_ERROR ("%load-extension list is not a proper list", SCM_EOL);
 436   return scm_search_path (path, filename, exts);
 437 }
 438 #undef FUNC_NAME
 439
 440
 441 SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 1, 0, 0,
 442             (SCM filename),
 443             "Search @var{%load-path} for the file named @var{filename} and\n"
 444             "load it into the top-level environment.  If @var{filename} is a\n"
 445             "relative pathname and is not found in the list of search paths,\n"
 446             "an error is signalled.")
 447 #define FUNC_NAME s_scm_primitive_load_path
 448 {
 449   SCM full_filename;
 450
 451   SCM_VALIDATE_STRING (1, filename);
 452
 453   full_filename = scm_sys_search_load_path (filename);
 454
 455   if (SCM_FALSEP (full_filename))
 456     {
 457       int absolute = (SCM_STRING_LENGTH (filename) >= 1
 458                       && SCM_STRING_CHARS (filename)[0] == '/');
 459       SCM_MISC_ERROR ((absolute
 460                        ? "Unable to load file ~S"
 461                        : "Unable to find file ~S in load path"),
 462                       scm_list_1 (filename));
 463     }
 464
 465   return scm_primitive_load (full_filename);
 466 }
 467 #undef FUNC_NAME
 468
 469 SCM
 470 scm_c_primitive_load_path (const char *filename)
 471 {
 472   return scm_primitive_load_path (scm_makfrom0str (filename));
 473 }
 474
 475 #if SCM_DEBUG_DEPRECATED == 0
 476
 477 /* Eval now copies source properties, so this function is no longer required.
 478  */
 479
 480 SCM_SYMBOL (scm_end_of_file_key, "end-of-file");
 481
 482 SCM_DEFINE (scm_read_and_eval_x, "read-and-eval!", 0, 1, 0,
 483             (SCM port),
 484             "Read a form from @var{port} (standard input by default), and evaluate it\n"
 485             "(memoizing it in the process) in the top-level environment.  If no data\n"
 486             "is left to be read from @var{port}, an @code{end-of-file} error is\n"
 487             "signalled.")
 488 #define FUNC_NAME s_scm_read_and_eval_x
 489 {
 490   SCM form = scm_read (port);
 491   if (SCM_EOF_OBJECT_P (form))
 492     scm_ithrow (scm_end_of_file_key, SCM_EOL, 1);
 493   return scm_eval_x (form, scm_current_module ());
 494 }
 495 #undef FUNC_NAME
 496
 497 #endif
 498
 499 \f
 500 /* Information about the build environment.  */
 501
 502 /* Initialize the scheme variable %guile-build-info, based on data
 503    provided by the Makefile, via libpath.h.  */
 504 static void
 505 init_build_info ()
 506 {
 507   static struct { char *name; char *value; } info[] = SCM_BUILD_INFO;
 508   SCM *loc = SCM_VARIABLE_LOC (scm_c_define ("%guile-build-info", SCM_EOL));
 509   unsigned long i;
 510
 511   for (i = 0; i < (sizeof (info) / sizeof (info[0])); i++)
 512     *loc = scm_acons (scm_str2symbol (info[i].name),
 513                       scm_makfrom0str (info[i].value),
 514                       *loc);
 515 }
 516
 517
 518 \f
 519 void
 520 scm_init_load ()
 521 {
 522   scm_listofnullstr = scm_permanent_object (scm_list_1 (scm_nullstr));
 523   scm_loc_load_path = SCM_VARIABLE_LOC (scm_c_define ("%load-path", SCM_EOL));
 524   scm_loc_load_extensions
 525     = SCM_VARIABLE_LOC (scm_c_define ("%load-extensions",
 526                                     scm_list_2 (scm_makfrom0str (".scm"),
 527                                                 scm_nullstr)));
 528   scm_loc_load_hook = SCM_VARIABLE_LOC (scm_c_define ("%load-hook", SCM_BOOL_F));
 529
 530   init_build_info ();
 531
 532 #ifndef SCM_MAGIC_SNARFER
 533 #include "libguile/load.x"
 534 #endif
 535 }
 536
 537 /*
 538   Local Variables:
 539   c-file-style: "gnu"
 540   End:
 541 */