1 /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library 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 GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
28 #include "libguile/_scm.h"
29 #include "libguile/libpath.h"
30 #include "libguile/fports.h"
31 #include "libguile/read.h"
32 #include "libguile/eval.h"
33 #include "libguile/throw.h"
34 #include "libguile/alist.h"
35 #include "libguile/dynwind.h"
36 #include "libguile/root.h"
37 #include "libguile/strings.h"
38 #include "libguile/modules.h"
39 #include "libguile/lang.h"
40 #include "libguile/chars.h"
41 #include "libguile/srfi-13.h"
43 #include "libguile/validate.h"
44 #include "libguile/load.h"
45 #include "libguile/fluids.h"
47 #include "libguile/vm.h" /* for load-compiled/vm */
49 #include <sys/types.h>
54 #endif /* HAVE_UNISTD_H */
58 #endif /* HAVE_PWD_H */
65 /* Loading a file, given an absolute filename. */
67 /* Hook to run when we load a file, perhaps to announce the fact somewhere.
68 Applied to the full name of the file. */
69 static SCM
*scm_loc_load_hook
;
71 /* The current reader (a fluid). */
72 static SCM the_reader
= SCM_BOOL_F
;
73 static size_t the_reader_fluid_num
= 0;
75 SCM_DEFINE (scm_primitive_load
, "primitive-load", 1, 0, 0,
77 "Load the file named @var{filename} and evaluate its contents in\n"
78 "the top-level environment. The load paths are not searched;\n"
79 "@var{filename} must either be a full pathname or be a pathname\n"
80 "relative to the current directory. If the variable\n"
81 "@code{%load-hook} is defined, it should be bound to a procedure\n"
82 "that will be called before any code is loaded. See the\n"
83 "documentation for @code{%load-hook} later in this section.")
84 #define FUNC_NAME s_scm_primitive_load
86 SCM hook
= *scm_loc_load_hook
;
87 SCM_VALIDATE_STRING (1, filename
);
88 if (scm_is_true (hook
) && scm_is_false (scm_procedure_p (hook
)))
89 SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
92 if (!scm_is_false (hook
))
93 scm_call_1 (hook
, filename
);
96 SCM port
= scm_open_file (filename
, scm_from_locale_string ("r"));
97 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
98 scm_i_dynwind_current_load_port (port
);
104 /* Lookup and use the current reader to read the next
106 reader
= SCM_FAST_FLUID_REF (the_reader_fluid_num
);
107 if (reader
== SCM_BOOL_F
)
108 form
= scm_read (port
);
110 form
= scm_call_1 (reader
, port
);
112 if (SCM_EOF_OBJECT_P (form
))
115 scm_primitive_eval_x (form
);
119 scm_close_port (port
);
121 return SCM_UNSPECIFIED
;
126 scm_c_primitive_load (const char *filename
)
128 return scm_primitive_load (scm_from_locale_string (filename
));
132 /* Builtin path to scheme library files. */
133 #ifdef SCM_PKGDATA_DIR
134 SCM_DEFINE (scm_sys_package_data_dir
, "%package-data-dir", 0, 0, 0,
136 "Return the name of the directory where Scheme packages, modules and\n"
137 "libraries are kept. On most Unix systems, this will be\n"
138 "@samp{/usr/local/share/guile}.")
139 #define FUNC_NAME s_scm_sys_package_data_dir
141 return scm_from_locale_string (SCM_PKGDATA_DIR
);
144 #endif /* SCM_PKGDATA_DIR */
146 #ifdef SCM_LIBRARY_DIR
147 SCM_DEFINE (scm_sys_library_dir
, "%library-dir", 0,0,0,
149 "Return the directory where the Guile Scheme library files are installed.\n"
150 "E.g., may return \"/usr/share/guile/1.3.5\".")
151 #define FUNC_NAME s_scm_sys_library_dir
153 return scm_from_locale_string (SCM_LIBRARY_DIR
);
156 #endif /* SCM_LIBRARY_DIR */
159 SCM_DEFINE (scm_sys_site_dir
, "%site-dir", 0,0,0,
161 "Return the directory where the Guile site files are installed.\n"
162 "E.g., may return \"/usr/share/guile/site\".")
163 #define FUNC_NAME s_scm_sys_site_dir
165 return scm_from_locale_string (SCM_SITE_DIR
);
168 #endif /* SCM_SITE_DIR */
173 /* Initializing the load path, and searching it. */
175 /* List of names of directories we search for files to load. */
176 static SCM
*scm_loc_load_path
;
178 /* List of extensions we try adding to the filenames. */
179 static SCM
*scm_loc_load_extensions
;
181 /* Like %load-path and %load-extensions, but for compiled files. */
182 static SCM
*scm_loc_load_compiled_path
;
183 static SCM
*scm_loc_load_compiled_extensions
;
185 /* Whether we should try to auto-compile. */
186 static SCM
*scm_loc_load_should_autocompile
;
188 SCM_DEFINE (scm_parse_path
, "parse-path", 1, 1, 0,
189 (SCM path
, SCM tail
),
190 "Parse @var{path}, which is expected to be a colon-separated\n"
191 "string, into a list and return the resulting list with\n"
192 "@var{tail} appended. If @var{path} is @code{#f}, @var{tail}\n"
194 #define FUNC_NAME s_scm_parse_path
197 SCM sep
= SCM_MAKE_CHAR (';');
199 SCM sep
= SCM_MAKE_CHAR (':');
202 if (SCM_UNBNDP (tail
))
204 return (scm_is_false (path
)
206 : scm_append_x (scm_list_2 (scm_string_split (path
, sep
), tail
)));
211 /* Initialize the global variable %load-path, given the value of the
212 SCM_SITE_DIR and SCM_LIBRARY_DIR preprocessor symbols and the
213 GUILE_LOAD_PATH environment variable. */
215 scm_init_load_path ()
221 #ifdef SCM_LIBRARY_DIR
222 env
= getenv ("GUILE_SYSTEM_PATH");
223 if (env
&& strcmp (env
, "") == 0)
224 /* special-case interpret system-path=="" as meaning no system path instead
228 path
= scm_parse_path (scm_from_locale_string (env
), path
);
230 path
= scm_list_3 (scm_from_locale_string (SCM_SITE_DIR
),
231 scm_from_locale_string (SCM_LIBRARY_DIR
),
232 scm_from_locale_string (SCM_PKGDATA_DIR
));
234 env
= getenv ("GUILE_SYSTEM_COMPILED_PATH");
235 if (env
&& strcmp (env
, "") == 0)
239 cpath
= scm_parse_path (scm_from_locale_string (env
), cpath
);
244 home
= getenv ("HOME");
249 pwd
= getpwuid (getuid ());
253 #endif /* HAVE_GETPWENT */
256 snprintf (buf
, sizeof(buf
),
257 "%s/.guile-ccache/" SCM_EFFECTIVE_VERSION
, home
);
258 cpath
= scm_cons (scm_from_locale_string (buf
), cpath
);
261 cpath
= scm_cons (scm_from_locale_string (SCM_CCACHE_DIR
), cpath
);
263 #endif /* SCM_LIBRARY_DIR */
265 env
= getenv ("GUILE_LOAD_PATH");
267 path
= scm_parse_path (scm_from_locale_string (env
), path
);
269 env
= getenv ("GUILE_LOAD_COMPILED_PATH");
271 cpath
= scm_parse_path (scm_from_locale_string (env
), cpath
);
273 *scm_loc_load_path
= path
;
274 *scm_loc_load_compiled_path
= cpath
;
277 SCM scm_listofnullstr
;
279 /* Utility functions for assembling C strings in a buffer.
288 stringbuf_free (void *data
)
290 struct stringbuf
*buf
= (struct stringbuf
*)data
;
295 stringbuf_grow (struct stringbuf
*buf
)
297 size_t ptroff
= buf
->ptr
- buf
->buf
;
299 buf
->buf
= scm_realloc (buf
->buf
, buf
->buf_len
);
300 buf
->ptr
= buf
->buf
+ ptroff
;
304 stringbuf_cat_locale_string (struct stringbuf
*buf
, SCM str
)
306 size_t max_len
= buf
->buf_len
- (buf
->ptr
- buf
->buf
) - 1;
307 size_t len
= scm_to_locale_stringbuf (str
, buf
->ptr
, max_len
);
310 /* buffer is too small, double its size and try again.
312 stringbuf_grow (buf
);
313 stringbuf_cat_locale_string (buf
, str
);
317 /* string fits, terminate it and check for embedded '\0'.
319 buf
->ptr
[len
] = '\0';
320 if (strlen (buf
->ptr
) != len
)
321 scm_misc_error (NULL
,
322 "string contains #\\nul character: ~S",
329 stringbuf_cat (struct stringbuf
*buf
, char *str
)
331 size_t max_len
= buf
->buf_len
- (buf
->ptr
- buf
->buf
) - 1;
332 size_t len
= strlen (str
);
335 /* buffer is too small, double its size and try again.
337 stringbuf_grow (buf
);
338 stringbuf_cat (buf
, str
);
342 /* string fits, copy it into buffer.
344 strcpy (buf
->ptr
, str
);
351 scm_c_string_has_an_ext (char *str
, size_t len
, SCM extensions
)
353 for (; !scm_is_null (extensions
); extensions
= SCM_CDR (extensions
))
358 ext
= scm_to_locale_string (SCM_CAR (extensions
));
359 extlen
= strlen (ext
);
360 match
= (len
> extlen
&& str
[len
- extlen
- 1] == '.'
361 && strncmp (str
+ (len
- extlen
), ext
, extlen
) == 0);
369 /* Search PATH for a directory containing a file named FILENAME.
370 The file must be readable, and not a directory.
371 If we find one, return its full filename; otherwise, return #f.
372 If FILENAME is absolute, return it unchanged.
373 If given, EXTENSIONS is a list of strings; for each directory
374 in PATH, we search for FILENAME concatenated with each EXTENSION. */
375 SCM_DEFINE (scm_search_path
, "search-path", 2, 2, 0,
376 (SCM path
, SCM filename
, SCM extensions
, SCM require_exts
),
377 "Search @var{path} for a directory containing a file named\n"
378 "@var{filename}. The file must be readable, and not a directory.\n"
379 "If we find one, return its full filename; otherwise, return\n"
380 "@code{#f}. If @var{filename} is absolute, return it unchanged.\n"
381 "If given, @var{extensions} is a list of strings; for each\n"
382 "directory in @var{path}, we search for @var{filename}\n"
383 "concatenated with each @var{extension}.")
384 #define FUNC_NAME s_scm_search_path
386 struct stringbuf buf
;
387 char *filename_chars
;
389 SCM result
= SCM_BOOL_F
;
391 if (SCM_UNBNDP (extensions
))
392 extensions
= SCM_EOL
;
394 if (SCM_UNBNDP (require_exts
))
395 require_exts
= SCM_BOOL_F
;
397 scm_dynwind_begin (0);
399 filename_chars
= scm_to_locale_string (filename
);
400 filename_len
= strlen (filename_chars
);
401 scm_dynwind_free (filename_chars
);
403 /* If FILENAME is absolute, return it unchanged. */
405 if (((filename_len
>= 1) &&
406 (filename_chars
[0] == '/' || filename_chars
[0] == '\\')) ||
407 ((filename_len
>= 3) && filename_chars
[1] == ':' &&
408 ((filename_chars
[0] >= 'a' && filename_chars
[0] <= 'z') ||
409 (filename_chars
[0] >= 'A' && filename_chars
[0] <= 'Z')) &&
410 (filename_chars
[2] == '/' || filename_chars
[2] == '\\')))
412 if (filename_len
>= 1 && filename_chars
[0] == '/')
416 if (scm_is_true (require_exts
) &&
417 !scm_c_string_has_an_ext (filename_chars
, filename_len
,
425 /* If FILENAME has an extension, don't try to add EXTENSIONS to it. */
429 for (endp
= filename_chars
+ filename_len
- 1;
430 endp
>= filename_chars
;
435 if (scm_is_true (require_exts
) &&
436 !scm_c_string_has_an_ext (filename_chars
, filename_len
,
439 /* This filename has an extension, but not one of the right
444 /* This filename already has an extension, so cancel the
445 list of extensions. */
446 extensions
= SCM_EOL
;
450 else if (*endp
== '/' || *endp
== '\\')
452 else if (*endp
== '/')
454 /* This filename has no extension, so keep the current list
460 /* This simplifies the loop below a bit.
462 if (scm_is_null (extensions
))
463 extensions
= scm_listofnullstr
;
466 buf
.buf
= scm_malloc (buf
.buf_len
);
467 scm_dynwind_unwind_handler (stringbuf_free
, &buf
, SCM_F_WIND_EXPLICITLY
);
469 /* Try every path element.
471 for (; scm_is_pair (path
); path
= SCM_CDR (path
))
473 SCM dir
= SCM_CAR (path
);
478 stringbuf_cat_locale_string (&buf
, dir
);
480 /* Concatenate the path name and the filename. */
483 if ((buf
.ptr
> buf
.buf
) && (buf
.ptr
[-1] != '/') && (buf
.ptr
[-1] != '\\'))
485 if ((buf
.ptr
> buf
.buf
) && (buf
.ptr
[-1] != '/'))
487 stringbuf_cat (&buf
, "/");
489 stringbuf_cat (&buf
, filename_chars
);
490 sans_ext_len
= buf
.ptr
- buf
.buf
;
492 /* Try every extension. */
493 for (exts
= extensions
; scm_is_pair (exts
); exts
= SCM_CDR (exts
))
495 SCM ext
= SCM_CAR (exts
);
498 buf
.ptr
= buf
.buf
+ sans_ext_len
;
499 stringbuf_cat_locale_string (&buf
, ext
);
501 /* If the file exists at all, we should return it. If the
502 file is inaccessible, then that's an error. */
504 if (stat (buf
.buf
, &mode
) == 0
505 && ! (mode
.st_mode
& S_IFDIR
))
507 result
= scm_from_locale_string (buf
.buf
);
512 if (!SCM_NULL_OR_NIL_P (exts
))
513 scm_wrong_type_arg_msg (NULL
, 0, extensions
, "proper list");
516 if (!SCM_NULL_OR_NIL_P (path
))
517 scm_wrong_type_arg_msg (NULL
, 0, path
, "proper list");
526 /* Search %load-path for a directory containing a file named FILENAME.
527 The file must be readable, and not a directory.
528 If we find one, return its full filename; otherwise, return #f.
529 If FILENAME is absolute, return it unchanged. */
530 SCM_DEFINE (scm_sys_search_load_path
, "%search-load-path", 1, 0, 0,
532 "Search @var{%load-path} for the file named @var{filename},\n"
533 "which must be readable by the current user. If @var{filename}\n"
534 "is found in the list of paths to search or is an absolute\n"
535 "pathname, return its full pathname. Otherwise, return\n"
536 "@code{#f}. Filenames may have any of the optional extensions\n"
537 "in the @code{%load-extensions} list; @code{%search-load-path}\n"
538 "will try each extension automatically.")
539 #define FUNC_NAME s_scm_sys_search_load_path
541 SCM path
= *scm_loc_load_path
;
542 SCM exts
= *scm_loc_load_extensions
;
543 SCM_VALIDATE_STRING (1, filename
);
545 if (scm_ilength (path
) < 0)
546 SCM_MISC_ERROR ("%load-path is not a proper list", SCM_EOL
);
547 if (scm_ilength (exts
) < 0)
548 SCM_MISC_ERROR ("%load-extension list is not a proper list", SCM_EOL
);
549 return scm_search_path (path
, filename
, exts
, SCM_UNDEFINED
);
555 compiled_is_newer (SCM full_filename
, SCM compiled_filename
)
557 char *source
, *compiled
;
558 struct stat stat_source
, stat_compiled
;
561 source
= scm_to_locale_string (full_filename
);
562 compiled
= scm_to_locale_string (compiled_filename
);
564 if (stat (source
, &stat_source
) == 0
565 && stat (compiled
, &stat_compiled
) == 0
566 && stat_source
.st_mtime
<= stat_compiled
.st_mtime
)
572 scm_puts (";;; note: source file ", scm_current_error_port ());
573 scm_puts (source
, scm_current_error_port ());
574 scm_puts ("\n;;; newer than compiled ", scm_current_error_port ());
575 scm_puts (compiled
, scm_current_error_port ());
576 scm_puts ("\n", scm_current_error_port ());
585 SCM_KEYWORD (k_output_file
, "output-file");
588 do_try_autocompile (void *data
)
590 SCM pair
= PTR2SCM (data
);
591 SCM comp_mod
, compile_file
, res
;
593 scm_puts (";;; compiling ", scm_current_error_port ());
594 scm_display (scm_car (pair
), scm_current_error_port ());
595 scm_newline (scm_current_error_port ());
597 comp_mod
= scm_c_resolve_module ("system base compile");
598 compile_file
= scm_c_module_lookup (comp_mod
, "compile-file");
599 res
= scm_call_3 (scm_variable_ref (compile_file
), scm_car (pair
),
600 k_output_file
, scm_cdr (pair
));
602 scm_puts (";;; compiled ", scm_current_error_port ());
603 scm_display (res
, scm_current_error_port ());
604 scm_newline (scm_current_error_port ());
610 autocompile_catch_handler (void *data
, SCM tag
, SCM throw_args
)
612 SCM pair
= PTR2SCM (data
);
613 scm_puts (";;; WARNING: compilation of ", scm_current_error_port ());
614 scm_display (scm_car (pair
), scm_current_error_port ());
615 scm_puts ("\n;;; to ", scm_current_error_port ());
616 scm_display (scm_cdr (pair
), scm_current_error_port ());
617 scm_puts (" failed:\n", scm_current_error_port ());
618 scm_puts (";;; key ", scm_current_error_port ());
619 scm_write (tag
, scm_current_error_port ());
620 scm_puts (", throw args ", scm_current_error_port ());
621 scm_write (throw_args
, scm_current_error_port ());
622 scm_newline (scm_current_error_port ());
627 scm_try_autocompile (SCM source
, SCM stale_compiled
)
629 static int message_shown
= 0;
630 SCM comp_mod
, compiled_file_name
, new_compiled
, pair
;
632 if (scm_is_false (*scm_loc_load_should_autocompile
))
637 scm_puts (";;; note: autocompilation is enabled, set GUILE_AUTO_COMPILE=0\n"
638 ";;; or pass the --no-autocompile argument to disable.\n",
639 scm_current_error_port ());
643 comp_mod
= scm_c_resolve_module ("system base compile");
645 scm_module_variable (comp_mod
,
646 scm_from_locale_symbol ("compiled-file-name"));
648 if (scm_is_false (compiled_file_name
))
650 scm_puts (";;; it seems ", scm_current_error_port ());
651 scm_display (source
, scm_current_error_port ());
652 scm_puts ("\n;;; is part of the compiler; skipping autocompilation\n",
653 scm_current_error_port ());
657 new_compiled
= scm_call_1 (scm_variable_ref (compiled_file_name
), source
);
659 if (scm_is_false (new_compiled
))
661 else if (!scm_is_true (scm_equal_p (new_compiled
, stale_compiled
))
662 && scm_is_true (scm_stat (new_compiled
, SCM_BOOL_F
))
663 && compiled_is_newer (source
, new_compiled
))
665 scm_puts (";;; found compiled file elsewhere: ",
666 scm_current_error_port ());
667 scm_display (new_compiled
, scm_current_error_port ());
668 scm_newline (scm_current_error_port ());
672 pair
= scm_cons (source
, new_compiled
);
673 return scm_c_catch (SCM_BOOL_T
,
676 autocompile_catch_handler
,
681 SCM_DEFINE (scm_primitive_load_path
, "primitive-load-path", 1, 1, 0,
682 (SCM filename
, SCM exception_on_not_found
),
683 "Search @var{%load-path} for the file named @var{filename} and\n"
684 "load it into the top-level environment. If @var{filename} is a\n"
685 "relative pathname and is not found in the list of search paths,\n"
686 "an error is signalled, unless the optional argument\n"
687 "@var{exception_on_not_found} is @code{#f}, in which case\n"
688 "@code{#f} is returned instead.")
689 #define FUNC_NAME s_scm_primitive_load_path
691 SCM full_filename
, compiled_filename
;
693 if (SCM_UNBNDP (exception_on_not_found
))
694 exception_on_not_found
= SCM_BOOL_T
;
696 full_filename
= scm_sys_search_load_path (filename
);
697 compiled_filename
= scm_search_path (*scm_loc_load_compiled_path
,
699 *scm_loc_load_compiled_extensions
,
702 if (scm_is_false (full_filename
) && scm_is_false (compiled_filename
))
704 if (scm_is_true (exception_on_not_found
))
705 SCM_MISC_ERROR ("Unable to find file ~S in load path",
706 scm_list_1 (filename
));
711 if (scm_is_false (full_filename
)
712 || (scm_is_true (compiled_filename
)
713 && compiled_is_newer (full_filename
, compiled_filename
)))
714 return scm_load_compiled_with_vm (compiled_filename
);
716 compiled_filename
= scm_try_autocompile (full_filename
, compiled_filename
);
717 if (scm_is_true (compiled_filename
))
718 return scm_load_compiled_with_vm (compiled_filename
);
720 return scm_primitive_load (full_filename
);
725 scm_c_primitive_load_path (const char *filename
)
727 return scm_primitive_load_path (scm_from_locale_string (filename
),
732 /* Information about the build environment. */
734 /* Initialize the scheme variable %guile-build-info, based on data
735 provided by the Makefile, via libpath.h. */
739 static struct { char *name
; char *value
; } info
[] = SCM_BUILD_INFO
;
740 SCM
*loc
= SCM_VARIABLE_LOC (scm_c_define ("%guile-build-info", SCM_EOL
));
743 for (i
= 0; i
< (sizeof (info
) / sizeof (info
[0])); i
++)
745 SCM key
= scm_from_locale_symbol (info
[i
].name
);
746 SCM val
= scm_from_locale_string (info
[i
].value
);
747 *loc
= scm_acons (key
, val
, *loc
);
755 scm_listofnullstr
= scm_permanent_object (scm_list_1 (scm_nullstr
));
756 scm_loc_load_path
= SCM_VARIABLE_LOC (scm_c_define ("%load-path", SCM_EOL
));
757 scm_loc_load_extensions
758 = SCM_VARIABLE_LOC (scm_c_define ("%load-extensions",
759 scm_list_2 (scm_from_locale_string (".scm"),
761 scm_loc_load_compiled_path
762 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-path", SCM_EOL
));
763 scm_loc_load_compiled_extensions
764 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-extensions",
765 scm_list_1 (scm_from_locale_string (".go"))));
766 scm_loc_load_hook
= SCM_VARIABLE_LOC (scm_c_define ("%load-hook", SCM_BOOL_F
));
768 scm_loc_load_should_autocompile
769 = SCM_VARIABLE_LOC (scm_c_define ("%load-should-autocompile", SCM_BOOL_F
));
771 the_reader
= scm_make_fluid ();
772 the_reader_fluid_num
= SCM_FLUID_NUM (the_reader
);
773 SCM_FAST_FLUID_SET_X (the_reader_fluid_num
, SCM_BOOL_F
);
774 scm_c_define("current-reader", the_reader
);
778 #include "libguile/load.x"