autocompile -> auto-compile
[bpt/guile.git] / libguile / load.c
index e2c0dbf..cec59d1 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006, 2009 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006, 2008, 2009, 2010, 2011 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
@@ -27,6 +27,7 @@
 #include <stdio.h>
 
 #include "libguile/_scm.h"
+#include "libguile/private-gc.h" /* scm_getenv_int */
 #include "libguile/libpath.h"
 #include "libguile/fports.h"
 #include "libguile/read.h"
@@ -37,7 +38,6 @@
 #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"
 
@@ -62,6 +62,8 @@
 #define R_OK 4
 #endif
 
+#include <stat-time.h>
+
 \f
 /* Loading a file, given an absolute filename.  */
 
@@ -71,7 +73,7 @@ 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),
@@ -98,22 +100,21 @@ SCM_DEFINE (scm_primitive_load, "primitive-load", 1, 0, 0,
     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);
-    encoding = scm_scan_for_encoding (port);
+
+    encoding = scm_i_scan_for_encoding (port);
     if (encoding)
-      {
-       scm_i_set_port_encoding_x (port, encoding);
-       free (encoding);
-      }
+      scm_i_set_port_encoding_x (port, encoding);
     else
-      /* The file has no encoding declaraed.  We'll presume Latin-1.  */
+      /* The file has no encoding declared.  We'll presume Latin-1.  */
       scm_i_set_port_encoding_x (port, NULL);
+
     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);
+       reader = scm_fluid_ref (the_reader);
        if (reader == SCM_BOOL_F)
          form = scm_read (port);
        else
@@ -168,8 +169,9 @@ SCM_DEFINE (scm_sys_library_dir, "%library-dir", 0,0,0,
 #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\".")
+           "Return the directory where users should install Scheme code for use\n"
+            "with this version of Guile.\n\n"
+           "E.g., may return \"/usr/share/guile/site/" SCM_EFFECTIVE_VERSION "\".")
 #define FUNC_NAME s_scm_sys_site_dir
 {
   return scm_from_locale_string (SCM_SITE_DIR);
@@ -177,6 +179,18 @@ SCM_DEFINE (scm_sys_site_dir, "%site-dir", 0,0,0,
 #undef FUNC_NAME
 #endif /* SCM_SITE_DIR */
 
+#ifdef SCM_GLOBAL_SITE_DIR
+SCM_DEFINE (scm_sys_global_site_dir, "%global-site-dir", 0,0,0,
+            (),
+           "Return the directory where users should install Scheme code for use\n"
+            "with all versions of Guile.\n\n"
+           "E.g., may return \"/usr/share/guile/site\".")
+#define FUNC_NAME s_scm_sys_global_site_dir
+{
+  return scm_from_locale_string (SCM_GLOBAL_SITE_DIR);
+}
+#undef FUNC_NAME
+#endif /* SCM_GLOBAL_SITE_DIR */
 
 
 \f
@@ -193,9 +207,9 @@ static SCM *scm_loc_load_compiled_path;
 static SCM *scm_loc_load_compiled_extensions;
 
 /* Whether we should try to auto-compile. */
-static SCM *scm_loc_load_should_autocompile;
+static SCM *scm_loc_load_should_auto_compile;
 
-/* The fallback path for autocompilation */
+/* The fallback path for auto-compilation */
 static SCM *scm_loc_compile_fallback_path;
 
 SCM_DEFINE (scm_parse_path, "parse-path", 1, 1, 0, 
@@ -240,8 +254,9 @@ scm_init_load_path ()
   else if (env)
     path = scm_parse_path (scm_from_locale_string (env), path);
   else
-    path = scm_list_3 (scm_from_locale_string (SCM_SITE_DIR),
-                       scm_from_locale_string (SCM_LIBRARY_DIR),
+    path = scm_list_4 (scm_from_locale_string (SCM_LIBRARY_DIR),
+                       scm_from_locale_string (SCM_SITE_DIR),
+                       scm_from_locale_string (SCM_GLOBAL_SITE_DIR),
                        scm_from_locale_string (SCM_PKGDATA_DIR));
 
   env = getenv ("GUILE_SYSTEM_COMPILED_PATH");
@@ -391,8 +406,8 @@ scm_c_string_has_an_ext (char *str, size_t len, SCM extensions)
    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, 2, 0,
-            (SCM path, SCM filename, SCM extensions, SCM require_exts),
+SCM_DEFINE (scm_search_path, "search-path", 2, 0, 1,
+            (SCM path, SCM filename, SCM rest),
            "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"
@@ -405,11 +420,47 @@ SCM_DEFINE (scm_search_path, "search-path", 2, 2, 0,
   struct stringbuf buf;
   char *filename_chars;
   size_t filename_len;
+  SCM extensions, require_exts;
   SCM result = SCM_BOOL_F;
 
+  if (SCM_UNBNDP (rest) || scm_is_null (rest))
+    {
+      /* Called either by Scheme code that didn't provide the optional
+         arguments, or C code that used the Guile 1.8 signature (2 required,
+         1 optional arg) and passed '() or nothing as the EXTENSIONS
+        argument.  */
+      extensions = SCM_EOL;
+      require_exts = SCM_UNDEFINED;
+    }
+  else
+    {
+      if (scm_is_null (SCM_CAR (rest)) || scm_is_pair (SCM_CAR (rest)))
+       {
+         /* Called by Scheme code written for 1.9.  */
+         extensions = SCM_CAR (rest);
+         if (scm_is_null (SCM_CDR (rest)))
+           require_exts = SCM_UNDEFINED;
+         else
+           {
+             require_exts = SCM_CADR (rest);
+             if (SCM_UNLIKELY (!scm_is_null (SCM_CDDR (rest))))
+               scm_wrong_num_args (scm_from_locale_string (FUNC_NAME));
+           }
+       }
+      else
+       {
+         /* Called by C code that uses the 1.8 signature, i.e., which
+            expects the 3rd argument to be EXTENSIONS.  */
+         extensions = rest;
+         require_exts = SCM_UNDEFINED;
+       }
+    }
+
   if (SCM_UNBNDP (extensions))
     extensions = SCM_EOL;
 
+  SCM_VALIDATE_LIST (3, extensions);
+
   if (SCM_UNBNDP (require_exts))
     require_exts = SCM_BOOL_F;
 
@@ -565,44 +616,60 @@ SCM_DEFINE (scm_sys_search_load_path, "%search-load-path", 1, 0, 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, SCM_UNDEFINED);
+  return scm_search_path (path, filename, exts);
 }
 #undef FUNC_NAME
 
 
+/* Return true if COMPILED_FILENAME is newer than source file
+   FULL_FILENAME, false otherwise.  Also return false if one of the
+   files cannot be stat'd.  */
 static int
 compiled_is_fresh (SCM full_filename, SCM compiled_filename)
 {
   char *source, *compiled;
   struct stat stat_source, stat_compiled;
-  int res;
+  int compiled_is_newer;
 
   source = scm_to_locale_string (full_filename);
   compiled = scm_to_locale_string (compiled_filename);
-    
+
   if (stat (source, &stat_source) == 0
-      && stat (compiled, &stat_compiled) == 0
-      && stat_source.st_mtime == stat_compiled.st_mtime) 
+      && stat (compiled, &stat_compiled) == 0)
     {
-      res = 1;
+      struct timespec source_mtime, compiled_mtime;
+
+      source_mtime = get_stat_mtime (&stat_source);
+      compiled_mtime = get_stat_mtime (&stat_compiled);
+
+      if (source_mtime.tv_sec < compiled_mtime.tv_sec
+         || (source_mtime.tv_sec == compiled_mtime.tv_sec
+             && source_mtime.tv_nsec <= compiled_mtime.tv_nsec))
+       compiled_is_newer = 1;
+      else
+       {
+         compiled_is_newer = 0;
+         scm_puts (";;; note: source file ", scm_current_error_port ());
+         scm_puts (source, scm_current_error_port ());
+         scm_puts ("\n;;;       newer than compiled ", scm_current_error_port ());
+         scm_puts (compiled, scm_current_error_port ());
+         scm_puts ("\n", scm_current_error_port ());
+       }
     }
   else
-    {
-      scm_puts (";;; note: source file ", scm_current_error_port ());
-      scm_puts (source, scm_current_error_port ());
-      scm_puts ("\n;;;       newer than compiled ", scm_current_error_port ());
-      scm_puts (compiled, scm_current_error_port ());
-      scm_puts ("\n", scm_current_error_port ());
-      res = 0;
-    }
+    /* At least one of the files isn't accessible.  */
+    compiled_is_newer = 0;
 
   free (source);
   free (compiled);
-  return res;
+
+  return compiled_is_newer;
 }
 
+SCM_KEYWORD (kw_env, "env");
+
 static SCM
-do_try_autocompile (void *data)
+do_try_auto_compile (void *data)
 {
   SCM source = PTR2SCM (data);
   SCM comp_mod, compile_file;
@@ -613,11 +680,13 @@ do_try_autocompile (void *data)
 
   comp_mod = scm_c_resolve_module ("system base compile");
   compile_file = scm_module_variable
-    (comp_mod, scm_from_locale_symbol ("compile-file"));
+    (comp_mod, scm_from_latin1_symbol ("compile-file"));
 
   if (scm_is_true (compile_file))
     {
-      SCM res = scm_call_1 (scm_variable_ref (compile_file), source);
+      /* Auto-compile in the context of the current module.  */
+      SCM res = scm_call_3 (scm_variable_ref (compile_file), source,
+                           kw_env, scm_current_module ());
       scm_puts (";;; compiled ", scm_current_error_port ());
       scm_display (res, scm_current_error_port ());
       scm_newline (scm_current_error_port ());
@@ -627,14 +696,14 @@ do_try_autocompile (void *data)
     {
       scm_puts (";;; it seems ", scm_current_error_port ());
       scm_display (source, scm_current_error_port ());
-      scm_puts ("\n;;; is part of the compiler; skipping autocompilation\n",
+      scm_puts ("\n;;; is part of the compiler; skipping auto-compilation\n",
                 scm_current_error_port ());
       return SCM_BOOL_F;
     }
 }
 
 static SCM
-autocompile_catch_handler (void *data, SCM tag, SCM throw_args)
+auto_compile_catch_handler (void *data, SCM tag, SCM throw_args)
 {
   SCM source = PTR2SCM (data);
   scm_puts (";;; WARNING: compilation of ", scm_current_error_port ());
@@ -648,40 +717,41 @@ autocompile_catch_handler (void *data, SCM tag, SCM throw_args)
   return SCM_BOOL_F;
 }
 
-SCM_DEFINE (scm_sys_warn_autocompilation_enabled, "%warn-autocompilation-enabled", 0, 0, 0,
+SCM_DEFINE (scm_sys_warn_auto_compilation_enabled, "%warn-auto-compilation-enabled", 0, 0, 0,
            (void), "")
+#define FUNC_NAME s_scm_sys_warn_auto_compilation_enabled
 {
   static int message_shown = 0;
-  
+
   if (!message_shown)
     {
-      scm_puts (";;; note: autocompilation is enabled, set GUILE_AUTO_COMPILE=0\n"
-                ";;;       or pass the --no-autocompile argument to disable.\n",
+      scm_puts (";;; note: auto-compilation is enabled, set GUILE_AUTO_COMPILE=0\n"
+                ";;;       or pass the --no-auto-compile argument to disable.\n",
                 scm_current_error_port ());
       message_shown = 1;
     }
 
   return SCM_UNSPECIFIED;
 }
+#undef FUNC_NAME
 
-  
 static SCM
-scm_try_autocompile (SCM source)
+scm_try_auto_compile (SCM source)
 {
-  if (scm_is_false (*scm_loc_load_should_autocompile))
+  if (scm_is_false (*scm_loc_load_should_auto_compile))
     return SCM_BOOL_F;
 
-  scm_sys_warn_autocompilation_enabled ();
+  scm_sys_warn_auto_compilation_enabled ();
   return scm_c_catch (SCM_BOOL_T,
-                      do_try_autocompile,
+                      do_try_auto_compile,
                       SCM2PTR (source),
-                      autocompile_catch_handler,
+                      auto_compile_catch_handler,
                       SCM2PTR (source),
                       NULL, NULL);
 }
 
-SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 1, 1, 0, 
-           (SCM filename, SCM exception_on_not_found),
+SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 0, 0, 1,
+           (SCM args),
            "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"
@@ -690,18 +760,46 @@ SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 1, 1, 0,
             "@code{#f} is returned instead.")
 #define FUNC_NAME s_scm_primitive_load_path
 {
+  SCM filename, exception_on_not_found;
   SCM full_filename, compiled_filename;
   int compiled_is_fallback = 0;
 
+  if (scm_is_string (args))
+    {
+      /* C code written for 1.8 and earlier expects this function to take a
+        single argument (the file name).  */
+      filename = args;
+      exception_on_not_found = SCM_UNDEFINED;
+    }
+  else
+    {
+      /* Starting from 1.9, this function takes 1 required and 1 optional
+        argument.  */
+      long len;
+
+      SCM_VALIDATE_LIST_COPYLEN (SCM_ARG1, args, len);
+      if (len < 1 || len > 2)
+       scm_error_num_args_subr (FUNC_NAME);
+
+      filename = SCM_CAR (args);
+      SCM_VALIDATE_STRING (SCM_ARG1, filename);
+
+      exception_on_not_found = len > 1 ? SCM_CADR (args) : SCM_UNDEFINED;
+    }
+
   if (SCM_UNBNDP (exception_on_not_found))
     exception_on_not_found = SCM_BOOL_T;
 
   full_filename = scm_sys_search_load_path (filename);
-  compiled_filename = scm_search_path (*scm_loc_load_compiled_path,
-                                       filename,
-                                       *scm_loc_load_compiled_extensions,
-                                       SCM_BOOL_T);
-  
+  if (scm_is_string (full_filename))
+    full_filename = scm_canonicalize_path (full_filename);
+
+  compiled_filename =
+    scm_search_path (*scm_loc_load_compiled_path,
+                    filename,
+                    scm_list_2 (*scm_loc_load_compiled_extensions,
+                                SCM_BOOL_T));
+
   if (scm_is_false (compiled_filename)
       && scm_is_true (full_filename)
       && scm_is_true (*scm_loc_compile_fallback_path)
@@ -751,13 +849,13 @@ SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 1, 1, 0,
           scm_puts (";;; found fresh local cache at ", scm_current_error_port ());
           scm_display (fallback, scm_current_error_port ());
           scm_newline (scm_current_error_port ());
-          return scm_load_compiled_with_vm (compiled_filename);
+          return scm_load_compiled_with_vm (fallback);
         }
     }
 
   /* Otherwise, we bottom out here. */
   {
-    SCM freshly_compiled = scm_try_autocompile (full_filename);
+    SCM freshly_compiled = scm_try_auto_compile (full_filename);
 
     if (scm_is_true (freshly_compiled))
       return scm_load_compiled_with_vm (freshly_compiled);
@@ -770,13 +868,35 @@ SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 1, 1, 0,
 SCM
 scm_c_primitive_load_path (const char *filename)
 {
-  return scm_primitive_load_path (scm_from_locale_string (filename),
-                                  SCM_BOOL_T);
+  return scm_primitive_load_path (scm_from_locale_string (filename));
+}
+
+void
+scm_init_eval_in_scheme (void)
+{
+  SCM eval_scm, eval_go;
+  eval_scm = scm_search_path (*scm_loc_load_path,
+                              scm_from_locale_string ("ice-9/eval.scm"),
+                              SCM_EOL);
+  eval_go = scm_search_path (*scm_loc_load_compiled_path,
+                             scm_from_locale_string ("ice-9/eval.go"),
+                             SCM_EOL);
+  
+  if (scm_is_true (eval_scm) && scm_is_true (eval_go)
+      && compiled_is_fresh (eval_scm, eval_go))
+    scm_load_compiled_with_vm (eval_go);
+  else
+    /* if we have no eval.go, we shouldn't load any compiled code at all */
+    *scm_loc_load_compiled_path = SCM_EOL;
 }
 
 \f
 /* Information about the build environment.  */
 
+SCM_VARIABLE_INIT (sys_host_type, "%host-type",
+                  scm_from_locale_string (HOST_TYPE));
+
+
 /* Initialize the scheme variable %guile-build-info, based on data
    provided by the Makefile, via libpath.h.  */
 static void
@@ -798,7 +918,7 @@ init_build_info ()
 void
 scm_init_load ()
 {
-  scm_listofnullstr = scm_permanent_object (scm_list_1 (scm_nullstr));
+  scm_listofnullstr = 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",
@@ -813,20 +933,31 @@ scm_init_load ()
 
   scm_loc_compile_fallback_path
     = SCM_VARIABLE_LOC (scm_c_define ("%compile-fallback-path", SCM_BOOL_F));
-
-  scm_loc_load_should_autocompile
-    = SCM_VARIABLE_LOC (scm_c_define ("%load-should-autocompile", SCM_BOOL_F));
+  scm_loc_load_should_auto_compile
+    = SCM_VARIABLE_LOC (scm_c_define ("%load-should-auto-compile", 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_fluid_set_x (the_reader, SCM_BOOL_F);
   scm_c_define("current-reader", the_reader);
 
+  scm_c_define ("load-compiled",
+                scm_c_make_gsubr ("load-compiled/vm", 1, 0, 0,
+                                  scm_load_compiled_with_vm));
+
   init_build_info ();
 
 #include "libguile/load.x"
 }
 
+void
+scm_init_load_should_auto_compile ()
+{
+  *scm_loc_load_should_auto_compile =
+    scm_from_bool (scm_getenv_int ("GUILE_AUTO_COMPILE", 1));
+}
+  
+  
+
 /*
   Local Variables:
   c-file-style: "gnu"