]> git.donarmstrong.com Git - lilypond.git/blobdiff - guile18/libguile/load.c
Import guile-1.8 as multiple upstream tarball component
[lilypond.git] / guile18 / libguile / load.c
diff --git a/guile18/libguile/load.c b/guile18/libguile/load.c
new file mode 100644 (file)
index 0000000..5ca4e07
--- /dev/null
@@ -0,0 +1,533 @@
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006 Free Software Foundation, Inc.
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+
+\f
+
+#ifdef HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
+#include <string.h>
+#include <stdio.h>
+
+#include "libguile/_scm.h"
+#include "libguile/libpath.h"
+#include "libguile/fports.h"
+#include "libguile/read.h"
+#include "libguile/eval.h"
+#include "libguile/throw.h"
+#include "libguile/alist.h"
+#include "libguile/dynwind.h"
+#include "libguile/root.h"
+#include "libguile/strings.h"
+#include "libguile/modules.h"
+#include "libguile/lang.h"
+#include "libguile/chars.h"
+#include "libguile/srfi-13.h"
+
+#include "libguile/validate.h"
+#include "libguile/load.h"
+#include "libguile/fluids.h"
+
+#include <sys/types.h>
+#include <sys/stat.h>
+
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif /* HAVE_UNISTD_H */
+
+#ifndef R_OK
+#define R_OK 4
+#endif
+
+\f
+/* Loading a file, given an absolute filename.  */
+
+/* Hook to run when we load a file, perhaps to announce the fact somewhere.
+   Applied to the full name of the file.  */
+static SCM *scm_loc_load_hook;
+
+/* The current reader (a fluid).  */
+static SCM the_reader = SCM_BOOL_F;
+static size_t the_reader_fluid_num = 0;
+
+SCM_DEFINE (scm_primitive_load, "primitive-load", 1, 0, 0, 
+           (SCM filename),
+           "Load the file named @var{filename} and evaluate its contents in\n"
+           "the top-level environment. The load paths are not searched;\n"
+           "@var{filename} must either be a full pathname or be a pathname\n"
+           "relative to the current directory.  If the  variable\n"
+           "@code{%load-hook} is defined, it should be bound to a procedure\n"
+           "that will be called before any code is loaded.  See the\n"
+           "documentation for @code{%load-hook} later in this section.")
+#define FUNC_NAME s_scm_primitive_load
+{
+  SCM hook = *scm_loc_load_hook;
+  SCM_VALIDATE_STRING (1, filename);
+  if (scm_is_true (hook) && scm_is_false (scm_procedure_p (hook)))
+    SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
+                   SCM_EOL);
+
+  if (!scm_is_false (hook))
+    scm_call_1 (hook, filename);
+
+  { /* scope */
+    SCM port = scm_open_file (filename, scm_from_locale_string ("r"));
+    scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE);
+    scm_i_dynwind_current_load_port (port);
+
+    while (1)
+      {
+       SCM reader, form;
+
+       /* Lookup and use the current reader to read the next
+          expression. */
+       reader = SCM_FAST_FLUID_REF (the_reader_fluid_num);
+       if (reader == SCM_BOOL_F)
+         form = scm_read (port);
+       else
+         form = scm_call_1 (reader, port);
+
+       if (SCM_EOF_OBJECT_P (form))
+         break;
+
+       scm_primitive_eval_x (form);
+      }
+
+    scm_dynwind_end ();
+    scm_close_port (port);
+  }
+  return SCM_UNSPECIFIED;
+}
+#undef FUNC_NAME
+
+SCM
+scm_c_primitive_load (const char *filename)
+{
+  return scm_primitive_load (scm_from_locale_string (filename));
+}
+
+\f
+/* Builtin path to scheme library files. */
+#ifdef SCM_PKGDATA_DIR
+SCM_DEFINE (scm_sys_package_data_dir, "%package-data-dir", 0, 0, 0, 
+            (),
+           "Return the name of the directory where Scheme packages, modules and\n"
+           "libraries are kept.  On most Unix systems, this will be\n"
+           "@samp{/usr/local/share/guile}.")
+#define FUNC_NAME s_scm_sys_package_data_dir
+{
+  return scm_from_locale_string (SCM_PKGDATA_DIR);
+}
+#undef FUNC_NAME
+#endif /* SCM_PKGDATA_DIR */
+
+#ifdef SCM_LIBRARY_DIR
+SCM_DEFINE (scm_sys_library_dir, "%library-dir", 0,0,0,
+            (),
+           "Return the directory where the Guile Scheme library files are installed.\n"
+           "E.g., may return \"/usr/share/guile/1.3.5\".")
+#define FUNC_NAME s_scm_sys_library_dir
+{
+  return scm_from_locale_string (SCM_LIBRARY_DIR);
+}
+#undef FUNC_NAME
+#endif /* SCM_LIBRARY_DIR */
+
+#ifdef SCM_SITE_DIR
+SCM_DEFINE (scm_sys_site_dir, "%site-dir", 0,0,0,
+            (),
+           "Return the directory where the Guile site files are installed.\n"
+           "E.g., may return \"/usr/share/guile/site\".")
+#define FUNC_NAME s_scm_sys_site_dir
+{
+  return scm_from_locale_string (SCM_SITE_DIR);
+}
+#undef FUNC_NAME
+#endif /* SCM_SITE_DIR */
+
+
+
+\f
+/* Initializing the load path, and searching it.  */
+
+/* List of names of directories we search for files to load.  */
+static SCM *scm_loc_load_path;
+
+/* List of extensions we try adding to the filenames.  */
+static SCM *scm_loc_load_extensions;
+
+
+SCM_DEFINE (scm_parse_path, "parse-path", 1, 1, 0, 
+            (SCM path, SCM tail),
+           "Parse @var{path}, which is expected to be a colon-separated\n"
+           "string, into a list and return the resulting list with\n"
+           "@var{tail} appended. If @var{path} is @code{#f}, @var{tail}\n"
+           "is returned.")
+#define FUNC_NAME s_scm_parse_path
+{
+#ifdef __MINGW32__
+  SCM sep = SCM_MAKE_CHAR (';');
+#else
+  SCM sep = SCM_MAKE_CHAR (':');
+#endif
+  
+  if (SCM_UNBNDP (tail))
+    tail = SCM_EOL;
+  return (scm_is_false (path)
+         ? tail
+         : scm_append_x (scm_list_2 (scm_string_split (path, sep), tail)));
+}
+#undef FUNC_NAME
+
+
+/* Initialize the global variable %load-path, given the value of the
+   SCM_SITE_DIR and SCM_LIBRARY_DIR preprocessor symbols and the
+   GUILE_LOAD_PATH environment variable.  */
+void
+scm_init_load_path ()
+{
+  char *env;
+  SCM path = SCM_EOL;
+
+#ifdef SCM_LIBRARY_DIR
+  path = scm_list_3 (scm_from_locale_string (SCM_SITE_DIR),
+                    scm_from_locale_string (SCM_LIBRARY_DIR),
+                    scm_from_locale_string (SCM_PKGDATA_DIR));
+#endif /* SCM_LIBRARY_DIR */
+
+  env = getenv ("GUILE_LOAD_PATH");
+  if (env)
+    path = scm_parse_path (scm_from_locale_string (env), path);
+
+  *scm_loc_load_path = path;
+}
+
+SCM scm_listofnullstr;
+
+/* Utility functions for assembling C strings in a buffer.
+ */
+
+struct stringbuf {
+  char *buf, *ptr;
+  size_t buf_len;
+};
+
+static void
+stringbuf_free (void *data)
+{
+  struct stringbuf *buf = (struct stringbuf *)data;
+  free (buf->buf);
+}
+
+static void
+stringbuf_grow (struct stringbuf *buf)
+{
+  size_t ptroff = buf->ptr - buf->buf;
+  buf->buf_len *= 2; 
+  buf->buf = scm_realloc (buf->buf, buf->buf_len);
+  buf->ptr = buf->buf + ptroff;
+}
+
+static void
+stringbuf_cat_locale_string (struct stringbuf *buf, SCM str)
+{
+  size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
+  size_t len = scm_to_locale_stringbuf (str, buf->ptr, max_len);
+  if (len > max_len)
+    {
+      /* buffer is too small, double its size and try again. 
+       */
+      stringbuf_grow (buf);
+      stringbuf_cat_locale_string (buf, str);
+    }
+  else
+    {
+      /* string fits, terminate it and check for embedded '\0'.
+       */
+      buf->ptr[len] = '\0';
+      if (strlen (buf->ptr) != len)
+       scm_misc_error (NULL,
+                       "string contains #\\nul character: ~S",
+                       scm_list_1 (str));
+      buf->ptr += len;
+    }
+}
+
+static void
+stringbuf_cat (struct stringbuf *buf, char *str)
+{
+  size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
+  size_t len = strlen (str);
+  if (len > max_len)
+    {
+      /* buffer is too small, double its size and try again. 
+       */
+      stringbuf_grow (buf);
+      stringbuf_cat (buf, str);
+    }
+  else
+    {
+      /* string fits, copy it into buffer.
+       */
+      strcpy (buf->ptr, str);
+      buf->ptr += len;
+    }
+}
+
+  
+/* Search PATH for a directory containing a file named FILENAME.
+   The file must be readable, and not a directory.
+   If we find one, return its full filename; otherwise, return #f.
+   If FILENAME is absolute, return it unchanged.
+   If given, EXTENSIONS is a list of strings; for each directory 
+   in PATH, we search for FILENAME concatenated with each EXTENSION.  */
+SCM_DEFINE (scm_search_path, "search-path", 2, 1, 0,
+           (SCM path, SCM filename, SCM extensions),
+           "Search @var{path} for a directory containing a file named\n"
+           "@var{filename}. The file must be readable, and not a directory.\n"
+           "If we find one, return its full filename; otherwise, return\n"
+           "@code{#f}.  If @var{filename} is absolute, return it unchanged.\n"
+           "If given, @var{extensions} is a list of strings; for each\n"
+           "directory in @var{path}, we search for @var{filename}\n"
+           "concatenated with each @var{extension}.")
+#define FUNC_NAME s_scm_search_path
+{
+  struct stringbuf buf;
+  char *filename_chars;
+  size_t filename_len;
+  SCM result = SCM_BOOL_F;
+
+  if (SCM_UNBNDP (extensions))
+    extensions = SCM_EOL;
+
+  scm_dynwind_begin (0);
+
+  filename_chars = scm_to_locale_string (filename);
+  filename_len = strlen (filename_chars);
+  scm_dynwind_free (filename_chars);
+
+  /* If FILENAME is absolute, return it unchanged.  */
+#ifdef __MINGW32__
+  if (((filename_len >= 1) && 
+       (filename_chars[0] == '/' || filename_chars[0] == '\\')) ||
+      ((filename_len >= 3) && filename_chars[1] == ':' &&
+       ((filename_chars[0] >= 'a' && filename_chars[0] <= 'z') ||
+       (filename_chars[0] >= 'A' && filename_chars[0] <= 'Z')) &&
+       (filename_chars[2] == '/' || filename_chars[2] == '\\')))
+#else
+  if (filename_len >= 1 && filename_chars[0] == '/')
+#endif
+    {
+      scm_dynwind_end ();
+      return filename;
+    }
+
+  /* If FILENAME has an extension, don't try to add EXTENSIONS to it.  */
+  {
+    char *endp;
+
+    for (endp = filename_chars + filename_len - 1;
+        endp >= filename_chars;
+        endp--)
+      {
+       if (*endp == '.')
+         {
+           /* This filename already has an extension, so cancel the
+               list of extensions.  */
+           extensions = SCM_EOL;
+           break;
+         }
+#ifdef __MINGW32__
+       else if (*endp == '/' || *endp == '\\')
+#else
+       else if (*endp == '/')
+#endif
+         /* This filename has no extension, so keep the current list
+             of extensions.  */
+         break;
+      }
+  }
+
+  /* This simplifies the loop below a bit.
+   */
+  if (scm_is_null (extensions))
+    extensions = scm_listofnullstr;
+
+  buf.buf_len = 512;
+  buf.buf = scm_malloc (buf.buf_len);
+  scm_dynwind_unwind_handler (stringbuf_free, &buf, SCM_F_WIND_EXPLICITLY);
+
+  /* Try every path element.
+   */
+  for (; scm_is_pair (path); path = SCM_CDR (path))
+    {
+      SCM dir = SCM_CAR (path);
+      SCM exts;
+      size_t sans_ext_len;
+
+      buf.ptr = buf.buf;
+      stringbuf_cat_locale_string (&buf, dir);
+       
+      /* Concatenate the path name and the filename. */
+      
+#ifdef __MINGW32__
+      if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/') && (buf.ptr[-1] != '\\'))
+#else
+      if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/'))
+#endif
+       stringbuf_cat (&buf, "/");
+
+      stringbuf_cat (&buf, filename_chars);
+      sans_ext_len = buf.ptr - buf.buf;
+
+      /* Try every extension. */
+      for (exts = extensions; scm_is_pair (exts); exts = SCM_CDR (exts))
+       {
+         SCM ext = SCM_CAR (exts);
+         struct stat mode;
+         
+         buf.ptr = buf.buf + sans_ext_len;
+         stringbuf_cat_locale_string (&buf, ext);
+         
+         /* If the file exists at all, we should return it.  If the
+            file is inaccessible, then that's an error.  */
+
+         if (stat (buf.buf, &mode) == 0
+             && ! (mode.st_mode & S_IFDIR))
+           {
+             result = scm_from_locale_string (buf.buf);
+             goto end;
+           }
+       }
+      
+      if (!SCM_NULL_OR_NIL_P (exts))
+       scm_wrong_type_arg_msg (NULL, 0, extensions, "proper list");
+    }
+
+  if (!SCM_NULL_OR_NIL_P (path))
+    scm_wrong_type_arg_msg (NULL, 0, path, "proper list");
+
+ end:
+  scm_dynwind_end ();
+  return result;
+}
+#undef FUNC_NAME
+
+
+/* Search %load-path for a directory containing a file named FILENAME.
+   The file must be readable, and not a directory.
+   If we find one, return its full filename; otherwise, return #f.
+   If FILENAME is absolute, return it unchanged.  */
+SCM_DEFINE (scm_sys_search_load_path, "%search-load-path", 1, 0, 0, 
+           (SCM filename),
+           "Search @var{%load-path} for the file named @var{filename},\n"
+           "which must be readable by the current user.  If @var{filename}\n"
+           "is found in the list of paths to search or is an absolute\n"
+           "pathname, return its full pathname.  Otherwise, return\n"
+           "@code{#f}.  Filenames may have any of the optional extensions\n"
+           "in the @code{%load-extensions} list; @code{%search-load-path}\n"
+           "will try each extension automatically.")
+#define FUNC_NAME s_scm_sys_search_load_path
+{
+  SCM path = *scm_loc_load_path;
+  SCM exts = *scm_loc_load_extensions;
+  SCM_VALIDATE_STRING (1, filename);
+
+  if (scm_ilength (path) < 0)
+    SCM_MISC_ERROR ("%load-path is not a proper list", SCM_EOL);
+  if (scm_ilength (exts) < 0)
+    SCM_MISC_ERROR ("%load-extension list is not a proper list", SCM_EOL);
+  return scm_search_path (path, filename, exts);
+}
+#undef FUNC_NAME
+
+
+SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 1, 0, 0, 
+           (SCM filename),
+           "Search @var{%load-path} for the file named @var{filename} and\n"
+           "load it into the top-level environment.  If @var{filename} is a\n"
+           "relative pathname and is not found in the list of search paths,\n"
+           "an error is signalled.")
+#define FUNC_NAME s_scm_primitive_load_path
+{
+  SCM full_filename;
+
+  full_filename = scm_sys_search_load_path (filename);
+
+  if (scm_is_false (full_filename))
+    SCM_MISC_ERROR ("Unable to find file ~S in load path",
+                   scm_list_1 (filename));
+
+  return scm_primitive_load (full_filename);
+}
+#undef FUNC_NAME
+
+SCM
+scm_c_primitive_load_path (const char *filename)
+{
+  return scm_primitive_load_path (scm_from_locale_string (filename));
+}
+
+\f
+/* Information about the build environment.  */
+
+/* Initialize the scheme variable %guile-build-info, based on data
+   provided by the Makefile, via libpath.h.  */
+static void
+init_build_info ()
+{
+  static struct { char *name; char *value; } info[] = SCM_BUILD_INFO;
+  SCM *loc = SCM_VARIABLE_LOC (scm_c_define ("%guile-build-info", SCM_EOL));
+  unsigned long i;
+
+  for (i = 0; i < (sizeof (info) / sizeof (info[0])); i++)
+    {
+      SCM key = scm_from_locale_symbol (info[i].name);
+      SCM val = scm_from_locale_string (info[i].value);
+      *loc = scm_acons (key, val, *loc);
+    }
+}
+
+\f
+void
+scm_init_load ()
+{
+  scm_listofnullstr = scm_permanent_object (scm_list_1 (scm_nullstr));
+  scm_loc_load_path = SCM_VARIABLE_LOC (scm_c_define ("%load-path", SCM_EOL));
+  scm_loc_load_extensions
+    = SCM_VARIABLE_LOC (scm_c_define ("%load-extensions",
+                                     scm_list_2 (scm_from_locale_string (".scm"),
+                                                 scm_nullstr)));
+  scm_loc_load_hook = SCM_VARIABLE_LOC (scm_c_define ("%load-hook", SCM_BOOL_F));
+
+  the_reader = scm_make_fluid ();
+  the_reader_fluid_num = SCM_FLUID_NUM (the_reader);
+  SCM_FAST_FLUID_SET_X (the_reader_fluid_num, SCM_BOOL_F);
+  scm_c_define("current-reader", the_reader);
+
+  init_build_info ();
+
+#include "libguile/load.x"
+}
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/