1 /* Copyright (C) 1995, 1996, 1998, 1999, 2000, 2001, 2004, 2006, 2008,
2 * 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public License
6 * as published by the Free Software Foundation; either version 3 of
7 * the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
30 #include "libguile/_scm.h"
31 #include "libguile/libpath.h"
32 #include "libguile/fports.h"
33 #include "libguile/read.h"
34 #include "libguile/eval.h"
35 #include "libguile/throw.h"
36 #include "libguile/alist.h"
37 #include "libguile/dynwind.h"
38 #include "libguile/root.h"
39 #include "libguile/strings.h"
40 #include "libguile/modules.h"
41 #include "libguile/chars.h"
42 #include "libguile/srfi-13.h"
44 #include "libguile/validate.h"
45 #include "libguile/load.h"
46 #include "libguile/fluids.h"
48 #include "libguile/vm.h" /* for load-compiled/vm */
50 #include <sys/types.h>
56 #endif /* HAVE_PWD_H */
62 #include <stat-time.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
;
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 ret
= SCM_UNSPECIFIED
;
89 SCM_VALIDATE_STRING (1, filename
);
90 if (scm_is_true (hook
) && scm_is_false (scm_procedure_p (hook
)))
91 SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
94 if (!scm_is_false (hook
))
95 scm_call_1 (hook
, filename
);
100 port
= scm_open_file_with_encoding (filename
,
101 scm_from_latin1_string ("r"),
102 SCM_BOOL_T
, /* guess_encoding */
103 scm_from_latin1_string ("UTF-8"));
105 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE
);
106 scm_i_dynwind_current_load_port (port
);
112 /* Lookup and use the current reader to read the next
114 reader
= scm_fluid_ref (the_reader
);
115 if (scm_is_false (reader
))
116 form
= scm_read (port
);
118 form
= scm_call_1 (reader
, port
);
120 if (SCM_EOF_OBJECT_P (form
))
123 ret
= scm_primitive_eval_x (form
);
127 scm_close_port (port
);
134 scm_c_primitive_load (const char *filename
)
136 return scm_primitive_load (scm_from_locale_string (filename
));
140 /* Builtin path to scheme library files. */
141 #ifdef SCM_PKGDATA_DIR
142 SCM_DEFINE (scm_sys_package_data_dir
, "%package-data-dir", 0, 0, 0,
144 "Return the name of the directory where Scheme packages, modules and\n"
145 "libraries are kept. On most Unix systems, this will be\n"
146 "@samp{/usr/local/share/guile}.")
147 #define FUNC_NAME s_scm_sys_package_data_dir
149 return scm_from_locale_string (SCM_PKGDATA_DIR
);
152 #endif /* SCM_PKGDATA_DIR */
154 #ifdef SCM_LIBRARY_DIR
155 SCM_DEFINE (scm_sys_library_dir
, "%library-dir", 0,0,0,
157 "Return the directory where the Guile Scheme library files are installed.\n"
158 "E.g., may return \"/usr/share/guile/1.3.5\".")
159 #define FUNC_NAME s_scm_sys_library_dir
161 return scm_from_locale_string (SCM_LIBRARY_DIR
);
164 #endif /* SCM_LIBRARY_DIR */
167 SCM_DEFINE (scm_sys_site_dir
, "%site-dir", 0,0,0,
169 "Return the directory where users should install Scheme code for use\n"
170 "with this version of Guile.\n\n"
171 "E.g., may return \"/usr/share/guile/site/" SCM_EFFECTIVE_VERSION
"\".")
172 #define FUNC_NAME s_scm_sys_site_dir
174 return scm_from_locale_string (SCM_SITE_DIR
);
177 #endif /* SCM_SITE_DIR */
179 #ifdef SCM_GLOBAL_SITE_DIR
180 SCM_DEFINE (scm_sys_global_site_dir
, "%global-site-dir", 0,0,0,
182 "Return the directory where users should install Scheme code for use\n"
183 "with all versions of Guile.\n\n"
184 "E.g., may return \"/usr/share/guile/site\".")
185 #define FUNC_NAME s_scm_sys_global_site_dir
187 return scm_from_locale_string (SCM_GLOBAL_SITE_DIR
);
190 #endif /* SCM_GLOBAL_SITE_DIR */
192 #ifdef SCM_SITE_CCACHE_DIR
193 SCM_DEFINE (scm_sys_site_ccache_dir
, "%site-ccache-dir", 0,0,0,
195 "Return the directory where users should install compiled\n"
196 "@code{.go} files for use with this version of Guile.\n\n"
197 "E.g., may return \"/usr/lib/guile/" SCM_EFFECTIVE_VERSION
"/site-ccache\".")
198 #define FUNC_NAME s_scm_sys_site_ccache_dir
200 return scm_from_locale_string (SCM_SITE_CCACHE_DIR
);
203 #endif /* SCM_SITE_CCACHE_DIR */
207 /* Initializing the load path, and searching it. */
209 /* List of names of directories we search for files to load. */
210 static SCM
*scm_loc_load_path
;
212 /* List of extensions we try adding to the filenames. */
213 static SCM
*scm_loc_load_extensions
;
215 /* Like %load-path and %load-extensions, but for compiled files. */
216 static SCM
*scm_loc_load_compiled_path
;
217 static SCM
*scm_loc_load_compiled_extensions
;
219 /* Whether we should try to auto-compile. */
220 static SCM
*scm_loc_load_should_auto_compile
;
222 /* Whether to treat all auto-compiled files as stale. */
223 static SCM
*scm_loc_fresh_auto_compile
;
225 /* The fallback path for auto-compilation */
226 static SCM
*scm_loc_compile_fallback_path
;
228 /* Ellipsis: "..." */
229 static SCM scm_ellipsis
;
231 SCM_DEFINE (scm_parse_path
, "parse-path", 1, 1, 0,
232 (SCM path
, SCM tail
),
233 "Parse @var{path}, which is expected to be a colon-separated\n"
234 "string, into a list and return the resulting list with\n"
235 "@var{tail} appended. If @var{path} is @code{#f}, @var{tail}\n"
237 #define FUNC_NAME s_scm_parse_path
240 SCM sep
= SCM_MAKE_CHAR (';');
242 SCM sep
= SCM_MAKE_CHAR (':');
245 if (SCM_UNBNDP (tail
))
247 return (scm_is_false (path
)
249 : scm_append_x (scm_list_2 (scm_string_split (path
, sep
), tail
)));
253 SCM_DEFINE (scm_parse_path_with_ellipsis
, "parse-path-with-ellipsis", 2, 0, 0,
254 (SCM path
, SCM base
),
255 "Parse @var{path}, which is expected to be a colon-separated\n"
256 "string, into a list and return the resulting list with\n"
257 "@var{base} (a list) spliced in place of the @code{...} path\n"
258 "component, if present, or else @var{base} is added to the end.\n"
259 "If @var{path} is @code{#f}, @var{base} is returned.")
260 #define FUNC_NAME s_scm_parse_path_with_ellipsis
262 SCM lst
= scm_parse_path (path
, SCM_EOL
);
266 while (!scm_is_null (walk
) &&
267 scm_is_false (scm_equal_p (scm_car (walk
), scm_ellipsis
)))
269 prev
= SCM_CDRLOC (walk
);
272 *prev
= scm_is_null (walk
)
274 : scm_append (scm_list_2 (base
, scm_cdr (walk
)));
279 /* On Posix hosts, just return PATH unaltered. On Windows,
280 destructively replace all backslashes in PATH with Unix-style
281 forward slashes, so that Scheme code always gets d:/foo/bar style
282 file names. This avoids multiple subtle problems with comparing
283 file names as strings, and with redirections in /bin/sh command
286 Note that, if PATH is result of a call to 'getenv', this
287 destructively modifies the environment variables, so both
288 scm_getenv and subprocesses will afterwards see the values with
289 forward slashes. That is OK as long as applied to Guile-specific
290 environment variables, since having scm_getenv return the same
291 value as used by the callers of this function is good for
292 consistency and file-name comparison. Avoid using this function on
293 values returned by 'getenv' for general-purpose environment
294 variables; instead, make a copy of the value and work on that. */
296 scm_i_mirror_backslashes (char *path
)
315 /* Initialize the global variable %load-path, given the value of the
316 SCM_SITE_DIR and SCM_LIBRARY_DIR preprocessor symbols and the
317 GUILE_LOAD_PATH environment variable. */
319 scm_init_load_path ()
325 #ifdef SCM_LIBRARY_DIR
326 env
= scm_i_mirror_backslashes (getenv ("GUILE_SYSTEM_PATH"));
327 if (env
&& strcmp (env
, "") == 0)
328 /* special-case interpret system-path=="" as meaning no system path instead
332 path
= scm_parse_path (scm_from_locale_string (env
), path
);
334 path
= scm_list_4 (scm_from_locale_string (SCM_LIBRARY_DIR
),
335 scm_from_locale_string (SCM_SITE_DIR
),
336 scm_from_locale_string (SCM_GLOBAL_SITE_DIR
),
337 scm_from_locale_string (SCM_PKGDATA_DIR
));
339 env
= scm_i_mirror_backslashes (getenv ("GUILE_SYSTEM_COMPILED_PATH"));
340 if (env
&& strcmp (env
, "") == 0)
344 cpath
= scm_parse_path (scm_from_locale_string (env
), cpath
);
347 cpath
= scm_list_2 (scm_from_locale_string (SCM_CCACHE_DIR
),
348 scm_from_locale_string (SCM_SITE_CCACHE_DIR
));
351 #endif /* SCM_LIBRARY_DIR */
360 #define FALLBACK_DIR \
361 "guile/ccache/" SCM_EFFECTIVE_VERSION "-" SCM_OBJCODE_MACHINE_VERSION_STRING
363 if ((e
= getenv ("XDG_CACHE_HOME")))
364 snprintf (cachedir
, sizeof(cachedir
), "%s/" FALLBACK_DIR
, e
);
365 else if ((e
= getenv ("HOME")))
366 snprintf (cachedir
, sizeof(cachedir
), "%s/.cache/" FALLBACK_DIR
, e
);
368 else if ((pwd
= getpwuid (getuid ())) && pwd
->pw_dir
)
369 snprintf (cachedir
, sizeof(cachedir
), "%s/.cache/" FALLBACK_DIR
,
371 #endif /* HAVE_GETPWENT */
373 else if ((e
= getenv ("LOCALAPPDATA")))
374 snprintf (cachedir
, sizeof (cachedir
), "%s/.cache/" FALLBACK_DIR
, e
);
375 else if ((e
= getenv ("APPDATA")))
376 snprintf (cachedir
, sizeof (cachedir
), "%s/.cache/" FALLBACK_DIR
, e
);
377 #endif /* __MINGW32__ */
383 scm_i_mirror_backslashes (cachedir
);
384 *scm_loc_compile_fallback_path
= scm_from_locale_string (cachedir
);
388 env
= scm_i_mirror_backslashes (getenv ("GUILE_LOAD_PATH"));
390 path
= scm_parse_path_with_ellipsis (scm_from_locale_string (env
), path
);
392 env
= scm_i_mirror_backslashes (getenv ("GUILE_LOAD_COMPILED_PATH"));
394 cpath
= scm_parse_path_with_ellipsis (scm_from_locale_string (env
), cpath
);
396 *scm_loc_load_path
= path
;
397 *scm_loc_load_compiled_path
= cpath
;
400 SCM scm_listofnullstr
;
402 /* Utility functions for assembling C strings in a buffer.
412 stringbuf_grow (struct stringbuf
*buf
)
414 size_t ptroff
, prev_len
;
415 void *prev_buf
= buf
->buf
;
417 prev_len
= buf
->buf_len
;
418 ptroff
= buf
->ptr
- buf
->buf
;
421 buf
->buf
= scm_gc_malloc_pointerless (buf
->buf_len
, "search-path");
422 memcpy (buf
->buf
, prev_buf
, prev_len
);
423 buf
->ptr
= buf
->buf
+ ptroff
;
427 stringbuf_cat_locale_string (struct stringbuf
*buf
, SCM str
)
429 size_t max_len
= buf
->buf_len
- (buf
->ptr
- buf
->buf
) - 1;
430 size_t len
= scm_to_locale_stringbuf (str
, buf
->ptr
, max_len
);
433 /* buffer is too small, double its size and try again.
435 stringbuf_grow (buf
);
436 stringbuf_cat_locale_string (buf
, str
);
440 /* string fits, terminate it and check for embedded '\0'.
442 buf
->ptr
[len
] = '\0';
443 if (strlen (buf
->ptr
) != len
)
444 scm_misc_error (NULL
,
445 "string contains #\\nul character: ~S",
452 stringbuf_cat (struct stringbuf
*buf
, char *str
)
454 size_t max_len
= buf
->buf_len
- (buf
->ptr
- buf
->buf
) - 1;
455 size_t len
= strlen (str
);
458 /* buffer is too small, double its size and try again.
460 stringbuf_grow (buf
);
461 stringbuf_cat (buf
, str
);
465 /* string fits, copy it into buffer.
467 strcpy (buf
->ptr
, str
);
472 /* Return non-zero if STR is suffixed by a dot followed by one of
475 string_has_an_ext (SCM str
, SCM extensions
)
477 for (; !scm_is_null (extensions
); extensions
= SCM_CDR (extensions
))
481 extension
= SCM_CAR (extensions
);
482 if (scm_is_true (scm_string_suffix_p (extension
, str
,
483 SCM_UNDEFINED
, SCM_UNDEFINED
,
484 SCM_UNDEFINED
, SCM_UNDEFINED
)))
491 /* Defined as "/" for Unix and Windows alike, so that file names
492 constructed by the functions in this module wind up with Unix-style
493 forward slashes as directory separators. */
494 #define FILE_NAME_SEPARATOR_STRING "/"
497 is_file_name_separator (SCM c
)
499 if (scm_is_eq (c
, SCM_MAKE_CHAR ('/')))
502 if (scm_is_eq (c
, SCM_MAKE_CHAR ('\\')))
509 is_drive_letter (SCM c
)
512 if (SCM_CHAR (c
) >= 'a' && SCM_CHAR (c
) <= 'z')
514 else if (SCM_CHAR (c
) >= 'A' && SCM_CHAR (c
) <= 'Z')
521 is_absolute_file_name (SCM filename
)
523 size_t filename_len
= scm_c_string_length (filename
);
525 if (filename_len
>= 1
526 && is_file_name_separator (scm_c_string_ref (filename
, 0))
528 /* On Windows, one initial separator indicates a drive-relative
529 path. Two separators indicate a Universal Naming Convention
530 (UNC) path. UNC paths are always absolute. */
532 && is_file_name_separator (scm_c_string_ref (filename
, 1))
536 if (filename_len
>= 3
537 && is_drive_letter (scm_c_string_ref (filename
, 0))
538 && scm_is_eq (scm_c_string_ref (filename
, 1), SCM_MAKE_CHAR (':'))
539 && is_file_name_separator (scm_c_string_ref (filename
, 2)))
544 /* Search PATH for a directory containing a file named FILENAME.
545 The file must be readable, and not a directory.
546 If we find one, return its full pathname; otherwise, return #f.
547 If FILENAME is absolute, return it unchanged.
548 We also fill *stat_buf corresponding to the returned pathname.
549 If given, EXTENSIONS is a list of strings; for each directory
550 in PATH, we search for FILENAME concatenated with each EXTENSION. */
552 search_path (SCM path
, SCM filename
, SCM extensions
, SCM require_exts
,
553 struct stat
*stat_buf
)
555 struct stringbuf buf
;
556 char *filename_chars
;
558 SCM result
= SCM_BOOL_F
;
559 char initial_buffer
[256];
561 if (scm_ilength (path
) < 0)
562 scm_misc_error ("%search-path", "path is not a proper list: ~a",
564 if (scm_ilength (extensions
) < 0)
565 scm_misc_error ("%search-path", "bad extensions list: ~a",
566 scm_list_1 (extensions
));
568 scm_dynwind_begin (0);
570 filename_chars
= scm_to_locale_string (filename
);
571 filename_len
= strlen (filename_chars
);
572 scm_dynwind_free (filename_chars
);
574 /* If FILENAME is absolute and is still valid, return it unchanged. */
575 if (is_absolute_file_name (filename
))
577 if ((scm_is_false (require_exts
) ||
578 string_has_an_ext (filename
, extensions
))
579 && stat (filename_chars
, stat_buf
) == 0
580 && !(stat_buf
->st_mode
& S_IFDIR
))
585 /* If FILENAME has an extension, don't try to add EXTENSIONS to it. */
589 for (endp
= filename_chars
+ filename_len
- 1;
590 endp
>= filename_chars
;
595 if (scm_is_true (require_exts
) &&
596 !string_has_an_ext (filename
, extensions
))
598 /* This filename has an extension, but not one of the right
602 /* This filename already has an extension, so cancel the
603 list of extensions. */
604 extensions
= SCM_EOL
;
607 else if (is_file_name_separator (SCM_MAKE_CHAR (*endp
)))
608 /* This filename has no extension, so keep the current list
614 /* This simplifies the loop below a bit.
616 if (scm_is_null (extensions
))
617 extensions
= scm_listofnullstr
;
619 buf
.buf_len
= sizeof initial_buffer
;
620 buf
.buf
= initial_buffer
;
622 /* Try every path element.
624 for (; scm_is_pair (path
); path
= SCM_CDR (path
))
626 SCM dir
= SCM_CAR (path
);
631 stringbuf_cat_locale_string (&buf
, dir
);
633 /* Concatenate the path name and the filename. */
635 if (buf
.ptr
> buf
.buf
636 && !is_file_name_separator (SCM_MAKE_CHAR (buf
.ptr
[-1])))
637 stringbuf_cat (&buf
, FILE_NAME_SEPARATOR_STRING
);
639 stringbuf_cat (&buf
, filename_chars
);
640 sans_ext_len
= buf
.ptr
- buf
.buf
;
642 /* Try every extension. */
643 for (exts
= extensions
; scm_is_pair (exts
); exts
= SCM_CDR (exts
))
645 SCM ext
= SCM_CAR (exts
);
647 buf
.ptr
= buf
.buf
+ sans_ext_len
;
648 stringbuf_cat_locale_string (&buf
, ext
);
650 /* If the file exists at all, we should return it. If the
651 file is inaccessible, then that's an error. */
653 if (stat (buf
.buf
, stat_buf
) == 0
654 && ! (stat_buf
->st_mode
& S_IFDIR
))
657 scm_from_locale_string (scm_i_mirror_backslashes (buf
.buf
));
662 if (!SCM_NULL_OR_NIL_P (exts
))
663 scm_wrong_type_arg_msg (NULL
, 0, extensions
, "proper list");
666 if (!SCM_NULL_OR_NIL_P (path
))
667 scm_wrong_type_arg_msg (NULL
, 0, path
, "proper list");
674 SCM_DEFINE (scm_search_path
, "search-path", 2, 0, 1,
675 (SCM path
, SCM filename
, SCM rest
),
676 "Search @var{path} for a directory containing a file named\n"
677 "@var{filename}. The file must be readable, and not a directory.\n"
678 "If we find one, return its full filename; otherwise, return\n"
679 "@code{#f}. If @var{filename} is absolute, return it unchanged.\n"
680 "If given, @var{rest} is a list of extension strings; for each\n"
681 "directory in @var{path}, we search for @var{filename}\n"
682 "concatenated with each extension.")
683 #define FUNC_NAME s_scm_search_path
685 SCM extensions
, require_exts
;
686 struct stat stat_buf
;
688 if (SCM_UNBNDP (rest
) || scm_is_null (rest
))
690 /* Called either by Scheme code that didn't provide the optional
691 arguments, or C code that used the Guile 1.8 signature (2 required,
692 1 optional arg) and passed '() or nothing as the EXTENSIONS
694 extensions
= SCM_EOL
;
695 require_exts
= SCM_UNDEFINED
;
699 if (scm_is_null (SCM_CAR (rest
)) || scm_is_pair (SCM_CAR (rest
)))
701 /* Called by Scheme code written for 1.9. */
702 extensions
= SCM_CAR (rest
);
703 if (scm_is_null (SCM_CDR (rest
)))
704 require_exts
= SCM_UNDEFINED
;
707 require_exts
= SCM_CADR (rest
);
708 if (SCM_UNLIKELY (!scm_is_null (SCM_CDDR (rest
))))
709 scm_wrong_num_args (scm_from_locale_string (FUNC_NAME
));
714 /* Called by C code that uses the 1.8 signature, i.e., which
715 expects the 3rd argument to be EXTENSIONS. */
717 require_exts
= SCM_UNDEFINED
;
721 if (SCM_UNBNDP (extensions
))
722 extensions
= SCM_EOL
;
724 if (SCM_UNBNDP (require_exts
))
725 require_exts
= SCM_BOOL_F
;
727 return search_path (path
, filename
, extensions
, require_exts
, &stat_buf
);
732 /* Search %load-path for a directory containing a file named FILENAME.
733 The file must be readable, and not a directory.
734 If we find one, return its full filename; otherwise, return #f.
735 If FILENAME is absolute, return it unchanged. */
736 SCM_DEFINE (scm_sys_search_load_path
, "%search-load-path", 1, 0, 0,
738 "Search @var{%load-path} for the file named @var{filename},\n"
739 "which must be readable by the current user. If @var{filename}\n"
740 "is found in the list of paths to search or is an absolute\n"
741 "pathname, return its full pathname. Otherwise, return\n"
742 "@code{#f}. Filenames may have any of the optional extensions\n"
743 "in the @code{%load-extensions} list; @code{%search-load-path}\n"
744 "will try each extension automatically.")
745 #define FUNC_NAME s_scm_sys_search_load_path
747 struct stat stat_buf
;
749 SCM_VALIDATE_STRING (1, filename
);
751 return search_path (*scm_loc_load_path
, filename
, *scm_loc_load_extensions
,
752 SCM_BOOL_F
, &stat_buf
);
757 /* Return true if COMPILED_FILENAME is newer than source file
758 FULL_FILENAME, false otherwise. */
760 compiled_is_fresh (SCM full_filename
, SCM compiled_filename
,
761 struct stat
*stat_source
, struct stat
*stat_compiled
)
763 int compiled_is_newer
;
764 struct timespec source_mtime
, compiled_mtime
;
766 source_mtime
= get_stat_mtime (stat_source
);
767 compiled_mtime
= get_stat_mtime (stat_compiled
);
769 if (source_mtime
.tv_sec
< compiled_mtime
.tv_sec
770 || (source_mtime
.tv_sec
== compiled_mtime
.tv_sec
771 && source_mtime
.tv_nsec
<= compiled_mtime
.tv_nsec
))
772 compiled_is_newer
= 1;
775 compiled_is_newer
= 0;
776 scm_puts_unlocked (";;; note: source file ", scm_current_error_port ());
777 scm_display (full_filename
, scm_current_error_port ());
778 scm_puts_unlocked ("\n;;; newer than compiled ", scm_current_error_port ());
779 scm_display (compiled_filename
, scm_current_error_port ());
780 scm_puts_unlocked ("\n", scm_current_error_port ());
783 return compiled_is_newer
;
786 SCM_KEYWORD (kw_env
, "env");
787 SCM_KEYWORD (kw_opts
, "opts");
789 SCM_SYMBOL (sym_compile_file
, "compile-file");
790 SCM_SYMBOL (sym_auto_compilation_options
, "%auto-compilation-options");
793 do_try_auto_compile (void *data
)
795 SCM source
= SCM_PACK_POINTER (data
);
796 SCM comp_mod
, compile_file
;
798 scm_puts_unlocked (";;; compiling ", scm_current_error_port ());
799 scm_display (source
, scm_current_error_port ());
800 scm_newline (scm_current_error_port ());
802 comp_mod
= scm_c_resolve_module ("system base compile");
803 compile_file
= scm_module_variable (comp_mod
, sym_compile_file
);
805 if (scm_is_true (compile_file
))
807 /* Auto-compile in the context of the current module. */
811 opts
= scm_module_variable (scm_the_root_module (),
812 sym_auto_compilation_options
);
813 if (SCM_VARIABLEP (opts
))
814 opts
= SCM_VARIABLE_REF (opts
);
822 args
[4] = scm_current_module ();
824 /* Assume `*current-warning-prefix*' has an appropriate value. */
825 res
= scm_call_n (scm_variable_ref (compile_file
), args
, 5);
827 scm_puts_unlocked (";;; compiled ", scm_current_error_port ());
828 scm_display (res
, scm_current_error_port ());
829 scm_newline (scm_current_error_port ());
834 scm_puts_unlocked (";;; it seems ", scm_current_error_port ());
835 scm_display (source
, scm_current_error_port ());
836 scm_puts_unlocked ("\n;;; is part of the compiler; skipping auto-compilation\n",
837 scm_current_error_port ());
843 auto_compile_catch_handler (void *data
, SCM tag
, SCM throw_args
)
845 SCM source
= SCM_PACK_POINTER (data
);
848 oport
= scm_open_output_string ();
849 scm_print_exception (oport
, SCM_BOOL_F
, tag
, throw_args
);
851 scm_puts_unlocked (";;; WARNING: compilation of ", scm_current_warning_port ());
852 scm_display (source
, scm_current_warning_port ());
853 scm_puts_unlocked (" failed:\n", scm_current_warning_port ());
855 lines
= scm_string_split (scm_get_output_string (oport
),
856 SCM_MAKE_CHAR ('\n'));
857 for (; scm_is_pair (lines
); lines
= scm_cdr (lines
))
858 if (scm_c_string_length (scm_car (lines
)))
860 scm_puts_unlocked (";;; ", scm_current_warning_port ());
861 scm_display (scm_car (lines
), scm_current_warning_port ());
862 scm_newline (scm_current_warning_port ());
865 scm_close_port (oport
);
870 SCM_DEFINE (scm_sys_warn_auto_compilation_enabled
, "%warn-auto-compilation-enabled", 0, 0, 0,
872 #define FUNC_NAME s_scm_sys_warn_auto_compilation_enabled
874 static int message_shown
= 0;
878 scm_puts_unlocked (";;; note: auto-compilation is enabled, set GUILE_AUTO_COMPILE=0\n"
879 ";;; or pass the --no-auto-compile argument to disable.\n",
880 scm_current_warning_port ());
884 return SCM_UNSPECIFIED
;
889 scm_try_auto_compile (SCM source
)
891 if (scm_is_false (*scm_loc_load_should_auto_compile
))
894 scm_sys_warn_auto_compilation_enabled ();
895 return scm_c_catch (SCM_BOOL_T
,
897 SCM_UNPACK_POINTER (source
),
898 auto_compile_catch_handler
,
899 SCM_UNPACK_POINTER (source
),
903 /* The auto-compilation code will residualize a .go file in the cache
904 dir: by default, $HOME/.cache/guile/2.0/ccache/PATH.go. This
905 function determines the PATH to use as a key into the compilation
906 cache. See also (system base compile):compiled-file-name. */
908 canonical_suffix (SCM fname
)
912 /* CANON should be absolute. */
913 canon
= scm_canonicalize_path (fname
);
917 size_t len
= scm_c_string_length (canon
);
919 /* On Windows, an absolute file name that doesn't start with a
920 separator starts with a drive component. Transform the drive
921 component to a file name element: c:\foo -> \c\foo. */
923 && is_absolute_file_name (canon
)
924 && !is_file_name_separator (scm_c_string_ref (canon
, 0)))
925 return scm_string_append
926 (scm_list_3 (scm_from_latin1_string (FILE_NAME_SEPARATOR_STRING
),
927 scm_c_substring (canon
, 0, 1),
928 scm_c_substring (canon
, 2, len
)));
935 SCM_DEFINE (scm_primitive_load_path
, "primitive-load-path", 0, 0, 1,
937 "Search @var{%load-path} for the file named @var{filename} and\n"
938 "load it into the top-level environment.\n\n"
939 "If @var{filename} is a relative pathname and is not found in\n"
940 "the list of search paths, one of three things may happen,\n"
941 "depending on the optional second argument,\n"
942 "@var{exception_on_not_found}. If it is @code{#f}, @code{#f}\n"
943 "will be returned. If it is a procedure, it will be called\n"
944 "with no arguments. Otherwise an error is signalled.")
945 #define FUNC_NAME s_scm_primitive_load_path
947 SCM filename
, exception_on_not_found
;
948 SCM full_filename
, compiled_filename
;
949 int compiled_is_fallback
= 0;
950 SCM hook
= *scm_loc_load_hook
;
951 struct stat stat_source
, stat_compiled
;
953 if (scm_is_true (hook
) && scm_is_false (scm_procedure_p (hook
)))
954 SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
957 if (scm_is_string (args
))
959 /* C code written for 1.8 and earlier expects this function to take a
960 single argument (the file name). */
962 exception_on_not_found
= SCM_UNDEFINED
;
966 /* Starting from 1.9, this function takes 1 required and 1 optional
970 SCM_VALIDATE_LIST_COPYLEN (SCM_ARG1
, args
, len
);
971 if (len
< 1 || len
> 2)
972 scm_error_num_args_subr (FUNC_NAME
);
974 filename
= SCM_CAR (args
);
975 SCM_VALIDATE_STRING (SCM_ARG1
, filename
);
977 exception_on_not_found
= len
> 1 ? SCM_CADR (args
) : SCM_UNDEFINED
;
980 if (SCM_UNBNDP (exception_on_not_found
))
981 exception_on_not_found
= SCM_BOOL_T
;
983 full_filename
= search_path (*scm_loc_load_path
, filename
,
984 *scm_loc_load_extensions
, SCM_BOOL_F
,
988 search_path (*scm_loc_load_compiled_path
, filename
,
989 *scm_loc_load_compiled_extensions
, SCM_BOOL_T
,
992 if (scm_is_false (compiled_filename
)
993 && scm_is_true (full_filename
)
994 && scm_is_true (*scm_loc_compile_fallback_path
)
995 && scm_is_false (*scm_loc_fresh_auto_compile
)
996 && scm_is_pair (*scm_loc_load_compiled_extensions
)
997 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions
)))
1000 char *fallback_chars
;
1002 fallback
= scm_string_append
1003 (scm_list_3 (*scm_loc_compile_fallback_path
,
1004 canonical_suffix (full_filename
),
1005 scm_car (*scm_loc_load_compiled_extensions
)));
1007 fallback_chars
= scm_to_locale_string (fallback
);
1008 if (stat (fallback_chars
, &stat_compiled
) == 0)
1010 compiled_filename
= fallback
;
1011 compiled_is_fallback
= 1;
1013 free (fallback_chars
);
1016 if (scm_is_false (full_filename
) && scm_is_false (compiled_filename
))
1018 if (scm_is_true (scm_procedure_p (exception_on_not_found
)))
1019 return scm_call_0 (exception_on_not_found
);
1020 else if (scm_is_false (exception_on_not_found
))
1023 SCM_MISC_ERROR ("Unable to find file ~S in load path",
1024 scm_list_1 (filename
));
1027 if (!scm_is_false (hook
))
1028 scm_call_1 (hook
, (scm_is_true (full_filename
)
1029 ? full_filename
: compiled_filename
));
1031 if (scm_is_false (full_filename
)
1032 || (scm_is_true (compiled_filename
)
1033 && compiled_is_fresh (full_filename
, compiled_filename
,
1034 &stat_source
, &stat_compiled
)))
1035 return scm_load_compiled_with_vm (compiled_filename
);
1037 /* Perhaps there was the installed .go that was stale, but our fallback is
1038 fresh. Let's try that. Duplicating code, but perhaps that's OK. */
1040 if (!compiled_is_fallback
1041 && scm_is_true (*scm_loc_compile_fallback_path
)
1042 && scm_is_false (*scm_loc_fresh_auto_compile
)
1043 && scm_is_pair (*scm_loc_load_compiled_extensions
)
1044 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions
)))
1047 char *fallback_chars
;
1050 fallback
= scm_string_append
1051 (scm_list_3 (*scm_loc_compile_fallback_path
,
1052 canonical_suffix (full_filename
),
1053 scm_car (*scm_loc_load_compiled_extensions
)));
1055 fallback_chars
= scm_to_locale_string (fallback
);
1056 stat_ret
= stat (fallback_chars
, &stat_compiled
);
1057 free (fallback_chars
);
1059 if (stat_ret
== 0 && compiled_is_fresh (full_filename
, fallback
,
1060 &stat_source
, &stat_compiled
))
1062 scm_puts_unlocked (";;; found fresh local cache at ", scm_current_warning_port ());
1063 scm_display (fallback
, scm_current_warning_port ());
1064 scm_newline (scm_current_warning_port ());
1065 return scm_load_compiled_with_vm (fallback
);
1069 /* Otherwise, we bottom out here. */
1071 SCM freshly_compiled
= scm_try_auto_compile (full_filename
);
1073 if (scm_is_true (freshly_compiled
))
1074 return scm_load_compiled_with_vm (freshly_compiled
);
1076 return scm_primitive_load (full_filename
);
1082 scm_c_primitive_load_path (const char *filename
)
1084 return scm_primitive_load_path (scm_from_locale_string (filename
));
1088 scm_init_eval_in_scheme (void)
1090 SCM eval_scm
, eval_go
;
1091 struct stat stat_source
, stat_compiled
;
1093 eval_scm
= search_path (*scm_loc_load_path
,
1094 scm_from_locale_string ("ice-9/eval.scm"),
1095 SCM_EOL
, SCM_BOOL_F
, &stat_source
);
1096 eval_go
= search_path (*scm_loc_load_compiled_path
,
1097 scm_from_locale_string ("ice-9/eval.go"),
1098 SCM_EOL
, SCM_BOOL_F
, &stat_compiled
);
1100 if (scm_is_true (eval_scm
) && scm_is_true (eval_go
)
1101 && compiled_is_fresh (eval_scm
, eval_go
,
1102 &stat_source
, &stat_compiled
))
1103 scm_load_compiled_with_vm (eval_go
);
1105 /* if we have no eval.go, we shouldn't load any compiled code at all */
1106 *scm_loc_load_compiled_path
= SCM_EOL
;
1110 /* Information about the build environment. */
1112 SCM_VARIABLE_INIT (sys_host_type
, "%host-type",
1113 scm_from_locale_string (HOST_TYPE
));
1116 /* Initialize the scheme variable %guile-build-info, based on data
1117 provided by the Makefile, via libpath.h. */
1121 static struct { char *name
; char *value
; } info
[] = SCM_BUILD_INFO
;
1122 SCM
*loc
= SCM_VARIABLE_LOC (scm_c_define ("%guile-build-info", SCM_EOL
));
1125 for (i
= 0; i
< (sizeof (info
) / sizeof (info
[0])); i
++)
1127 SCM key
= scm_from_utf8_symbol (info
[i
].name
);
1128 SCM val
= scm_from_locale_string (info
[i
].value
);
1129 *loc
= scm_acons (key
, val
, *loc
);
1131 #ifdef PACKAGE_PACKAGER
1132 *loc
= scm_acons (scm_from_latin1_symbol ("packager"),
1133 scm_from_latin1_string (PACKAGE_PACKAGER
),
1136 #ifdef PACKAGE_PACKAGER_VERSION
1137 *loc
= scm_acons (scm_from_latin1_symbol ("packager-version"),
1138 scm_from_latin1_string (PACKAGE_PACKAGER_VERSION
),
1141 #ifdef PACKAGE_PACKAGER_BUG_REPORTS
1142 *loc
= scm_acons (scm_from_latin1_symbol ("packager-bug-reports"),
1143 scm_from_latin1_string (PACKAGE_PACKAGER_BUG_REPORTS
),
1152 scm_listofnullstr
= scm_list_1 (scm_nullstr
);
1153 scm_loc_load_path
= SCM_VARIABLE_LOC (scm_c_define ("%load-path", SCM_EOL
));
1154 scm_loc_load_extensions
1155 = SCM_VARIABLE_LOC (scm_c_define ("%load-extensions",
1156 scm_list_2 (scm_from_locale_string (".scm"),
1158 scm_loc_load_compiled_path
1159 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-path", SCM_EOL
));
1160 scm_loc_load_compiled_extensions
1161 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-extensions",
1162 scm_list_1 (scm_from_locale_string (".go"))));
1163 scm_loc_load_hook
= SCM_VARIABLE_LOC (scm_c_define ("%load-hook", SCM_BOOL_F
));
1165 scm_loc_compile_fallback_path
1166 = SCM_VARIABLE_LOC (scm_c_define ("%compile-fallback-path", SCM_BOOL_F
));
1167 scm_loc_load_should_auto_compile
1168 = SCM_VARIABLE_LOC (scm_c_define ("%load-should-auto-compile", SCM_BOOL_F
));
1169 scm_loc_fresh_auto_compile
1170 = SCM_VARIABLE_LOC (scm_c_define ("%fresh-auto-compile", SCM_BOOL_F
));
1172 scm_ellipsis
= scm_from_latin1_string ("...");
1174 the_reader
= scm_make_fluid_with_default (SCM_BOOL_F
);
1175 scm_c_define("current-reader", the_reader
);
1177 scm_c_define ("load-compiled",
1178 scm_c_make_gsubr ("load-compiled/vm", 1, 0, 0,
1179 scm_load_compiled_with_vm
));
1183 #include "libguile/load.x"
1187 scm_init_load_should_auto_compile ()
1189 char *auto_compile
= getenv ("GUILE_AUTO_COMPILE");
1191 if (auto_compile
&& strcmp (auto_compile
, "0") == 0)
1193 *scm_loc_load_should_auto_compile
= SCM_BOOL_F
;
1194 *scm_loc_fresh_auto_compile
= SCM_BOOL_F
;
1196 /* Allow "freshen" also. */
1197 else if (auto_compile
&& strncmp (auto_compile
, "fresh", 5) == 0)
1199 *scm_loc_load_should_auto_compile
= SCM_BOOL_T
;
1200 *scm_loc_fresh_auto_compile
= SCM_BOOL_T
;
1204 *scm_loc_load_should_auto_compile
= SCM_BOOL_T
;
1205 *scm_loc_fresh_auto_compile
= SCM_BOOL_F
;