fix unnecessary call to canonicalize_path in load-path fast case
[bpt/guile.git] / libguile / load.c
1 /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
2 *
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public License
5 * as published by the Free Software Foundation; either version 3 of
6 * the License, or (at your option) any later version.
7 *
8 * This library is distributed in the hope that it will be useful, but
9 * 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.
12 *
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
16 * 02110-1301 USA
17 */
18
19
20 \f
21
22 #ifdef HAVE_CONFIG_H
23 # include <config.h>
24 #endif
25
26 #include <string.h>
27 #include <stdio.h>
28
29 #include "libguile/_scm.h"
30 #include "libguile/private-gc.h" /* scm_getenv_int */
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"
43
44 #include "libguile/validate.h"
45 #include "libguile/load.h"
46 #include "libguile/fluids.h"
47
48 #include "libguile/vm.h" /* for load-compiled/vm */
49
50 #include <sys/types.h>
51 #include <sys/stat.h>
52
53 #ifdef HAVE_UNISTD_H
54 #include <unistd.h>
55 #endif /* HAVE_UNISTD_H */
56
57 #ifdef HAVE_PWD_H
58 #include <pwd.h>
59 #endif /* HAVE_PWD_H */
60
61 #ifndef R_OK
62 #define R_OK 4
63 #endif
64
65 #include <stat-time.h>
66
67 \f
68 /* Loading a file, given an absolute filename. */
69
70 /* Hook to run when we load a file, perhaps to announce the fact somewhere.
71 Applied to the full name of the file. */
72 static SCM *scm_loc_load_hook;
73
74 /* The current reader (a fluid). */
75 static SCM the_reader = SCM_BOOL_F;
76
77
78 SCM_DEFINE (scm_primitive_load, "primitive-load", 1, 0, 0,
79 (SCM filename),
80 "Load the file named @var{filename} and evaluate its contents in\n"
81 "the top-level environment. The load paths are not searched;\n"
82 "@var{filename} must either be a full pathname or be a pathname\n"
83 "relative to the current directory. If the variable\n"
84 "@code{%load-hook} is defined, it should be bound to a procedure\n"
85 "that will be called before any code is loaded. See the\n"
86 "documentation for @code{%load-hook} later in this section.")
87 #define FUNC_NAME s_scm_primitive_load
88 {
89 SCM hook = *scm_loc_load_hook;
90 char *encoding;
91 SCM_VALIDATE_STRING (1, filename);
92 if (scm_is_true (hook) && scm_is_false (scm_procedure_p (hook)))
93 SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
94 SCM_EOL);
95
96 if (!scm_is_false (hook))
97 scm_call_1 (hook, filename);
98
99 { /* scope */
100 SCM port = scm_open_file (filename, scm_from_locale_string ("r"));
101 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE);
102 scm_i_dynwind_current_load_port (port);
103
104 encoding = scm_i_scan_for_encoding (port);
105 if (encoding)
106 scm_i_set_port_encoding_x (port, encoding);
107 else
108 /* The file has no encoding declared. We'll presume UTF-8, like
109 compile-file does. */
110 scm_i_set_port_encoding_x (port, "UTF-8");
111
112 while (1)
113 {
114 SCM reader, form;
115
116 /* Lookup and use the current reader to read the next
117 expression. */
118 reader = scm_fluid_ref (the_reader);
119 if (scm_is_false (reader))
120 form = scm_read (port);
121 else
122 form = scm_call_1 (reader, port);
123
124 if (SCM_EOF_OBJECT_P (form))
125 break;
126
127 scm_primitive_eval_x (form);
128 }
129
130 scm_dynwind_end ();
131 scm_close_port (port);
132 }
133 return SCM_UNSPECIFIED;
134 }
135 #undef FUNC_NAME
136
137 SCM
138 scm_c_primitive_load (const char *filename)
139 {
140 return scm_primitive_load (scm_from_locale_string (filename));
141 }
142
143 \f
144 /* Builtin path to scheme library files. */
145 #ifdef SCM_PKGDATA_DIR
146 SCM_DEFINE (scm_sys_package_data_dir, "%package-data-dir", 0, 0, 0,
147 (),
148 "Return the name of the directory where Scheme packages, modules and\n"
149 "libraries are kept. On most Unix systems, this will be\n"
150 "@samp{/usr/local/share/guile}.")
151 #define FUNC_NAME s_scm_sys_package_data_dir
152 {
153 return scm_from_locale_string (SCM_PKGDATA_DIR);
154 }
155 #undef FUNC_NAME
156 #endif /* SCM_PKGDATA_DIR */
157
158 #ifdef SCM_LIBRARY_DIR
159 SCM_DEFINE (scm_sys_library_dir, "%library-dir", 0,0,0,
160 (),
161 "Return the directory where the Guile Scheme library files are installed.\n"
162 "E.g., may return \"/usr/share/guile/1.3.5\".")
163 #define FUNC_NAME s_scm_sys_library_dir
164 {
165 return scm_from_locale_string (SCM_LIBRARY_DIR);
166 }
167 #undef FUNC_NAME
168 #endif /* SCM_LIBRARY_DIR */
169
170 #ifdef SCM_SITE_DIR
171 SCM_DEFINE (scm_sys_site_dir, "%site-dir", 0,0,0,
172 (),
173 "Return the directory where users should install Scheme code for use\n"
174 "with this version of Guile.\n\n"
175 "E.g., may return \"/usr/share/guile/site/" SCM_EFFECTIVE_VERSION "\".")
176 #define FUNC_NAME s_scm_sys_site_dir
177 {
178 return scm_from_locale_string (SCM_SITE_DIR);
179 }
180 #undef FUNC_NAME
181 #endif /* SCM_SITE_DIR */
182
183 #ifdef SCM_GLOBAL_SITE_DIR
184 SCM_DEFINE (scm_sys_global_site_dir, "%global-site-dir", 0,0,0,
185 (),
186 "Return the directory where users should install Scheme code for use\n"
187 "with all versions of Guile.\n\n"
188 "E.g., may return \"/usr/share/guile/site\".")
189 #define FUNC_NAME s_scm_sys_global_site_dir
190 {
191 return scm_from_locale_string (SCM_GLOBAL_SITE_DIR);
192 }
193 #undef FUNC_NAME
194 #endif /* SCM_GLOBAL_SITE_DIR */
195
196
197 \f
198 /* Initializing the load path, and searching it. */
199
200 /* List of names of directories we search for files to load. */
201 static SCM *scm_loc_load_path;
202
203 /* List of extensions we try adding to the filenames. */
204 static SCM *scm_loc_load_extensions;
205
206 /* Like %load-path and %load-extensions, but for compiled files. */
207 static SCM *scm_loc_load_compiled_path;
208 static SCM *scm_loc_load_compiled_extensions;
209
210 /* Whether we should try to auto-compile. */
211 static SCM *scm_loc_load_should_auto_compile;
212
213 /* Whether to treat all auto-compiled files as stale. */
214 static SCM *scm_loc_fresh_auto_compile;
215
216 /* The fallback path for auto-compilation */
217 static SCM *scm_loc_compile_fallback_path;
218
219 SCM_DEFINE (scm_parse_path, "parse-path", 1, 1, 0,
220 (SCM path, SCM tail),
221 "Parse @var{path}, which is expected to be a colon-separated\n"
222 "string, into a list and return the resulting list with\n"
223 "@var{tail} appended. If @var{path} is @code{#f}, @var{tail}\n"
224 "is returned.")
225 #define FUNC_NAME s_scm_parse_path
226 {
227 #ifdef __MINGW32__
228 SCM sep = SCM_MAKE_CHAR (';');
229 #else
230 SCM sep = SCM_MAKE_CHAR (':');
231 #endif
232
233 if (SCM_UNBNDP (tail))
234 tail = SCM_EOL;
235 return (scm_is_false (path)
236 ? tail
237 : scm_append_x (scm_list_2 (scm_string_split (path, sep), tail)));
238 }
239 #undef FUNC_NAME
240
241
242 /* Initialize the global variable %load-path, given the value of the
243 SCM_SITE_DIR and SCM_LIBRARY_DIR preprocessor symbols and the
244 GUILE_LOAD_PATH environment variable. */
245 void
246 scm_init_load_path ()
247 {
248 char *env;
249 SCM path = SCM_EOL;
250 SCM cpath = SCM_EOL;
251
252 #ifdef SCM_LIBRARY_DIR
253 env = getenv ("GUILE_SYSTEM_PATH");
254 if (env && strcmp (env, "") == 0)
255 /* special-case interpret system-path=="" as meaning no system path instead
256 of '("") */
257 ;
258 else if (env)
259 path = scm_parse_path (scm_from_locale_string (env), path);
260 else
261 path = scm_list_4 (scm_from_locale_string (SCM_LIBRARY_DIR),
262 scm_from_locale_string (SCM_SITE_DIR),
263 scm_from_locale_string (SCM_GLOBAL_SITE_DIR),
264 scm_from_locale_string (SCM_PKGDATA_DIR));
265
266 env = getenv ("GUILE_SYSTEM_COMPILED_PATH");
267 if (env && strcmp (env, "") == 0)
268 /* like above */
269 ;
270 else if (env)
271 cpath = scm_parse_path (scm_from_locale_string (env), cpath);
272 else
273 {
274 cpath = scm_list_2 (scm_from_locale_string (SCM_CCACHE_DIR),
275 scm_from_locale_string (SCM_SITE_CCACHE_DIR));
276 }
277
278 #endif /* SCM_LIBRARY_DIR */
279
280 {
281 char cachedir[1024];
282 char *e;
283 #ifdef HAVE_GETPWENT
284 struct passwd *pwd;
285 #endif
286
287 #define FALLBACK_DIR \
288 "guile/ccache/" SCM_EFFECTIVE_VERSION "-" SCM_OBJCODE_MACHINE_VERSION_STRING
289
290 if ((e = getenv ("XDG_CACHE_HOME")))
291 snprintf (cachedir, sizeof(cachedir), "%s/" FALLBACK_DIR, e);
292 else if ((e = getenv ("HOME")))
293 snprintf (cachedir, sizeof(cachedir), "%s/.cache/" FALLBACK_DIR, e);
294 #ifdef HAVE_GETPWENT
295 else if ((pwd = getpwuid (getuid ())) && pwd->pw_dir)
296 snprintf (cachedir, sizeof(cachedir), "%s/.cache/" FALLBACK_DIR,
297 pwd->pw_dir);
298 #endif /* HAVE_GETPWENT */
299 #ifdef __MINGW32__
300 else if ((e = getenv ("LOCALAPPDATA")))
301 snprintf (cachedir, sizeof (cachedir), "%s/.cache/" FALLBACK_DIR, e);
302 else if ((e = getenv ("APPDATA")))
303 snprintf (cachedir, sizeof (cachedir), "%s/.cache/" FALLBACK_DIR, e);
304 #endif /* __MINGW32__ */
305 else
306 cachedir[0] = 0;
307
308 if (cachedir[0])
309 *scm_loc_compile_fallback_path = scm_from_locale_string (cachedir);
310 }
311
312 env = getenv ("GUILE_LOAD_PATH");
313 if (env)
314 path = scm_parse_path (scm_from_locale_string (env), path);
315
316 env = getenv ("GUILE_LOAD_COMPILED_PATH");
317 if (env)
318 cpath = scm_parse_path (scm_from_locale_string (env), cpath);
319
320 *scm_loc_load_path = path;
321 *scm_loc_load_compiled_path = cpath;
322 }
323
324 SCM scm_listofnullstr;
325
326 /* Utility functions for assembling C strings in a buffer.
327 */
328
329 struct stringbuf {
330 char *buf, *ptr;
331 size_t buf_len;
332 };
333
334 static void
335 stringbuf_free (void *data)
336 {
337 struct stringbuf *buf = (struct stringbuf *)data;
338 free (buf->buf);
339 }
340
341 static void
342 stringbuf_grow (struct stringbuf *buf)
343 {
344 size_t ptroff = buf->ptr - buf->buf;
345 buf->buf_len *= 2;
346 buf->buf = scm_realloc (buf->buf, buf->buf_len);
347 buf->ptr = buf->buf + ptroff;
348 }
349
350 static void
351 stringbuf_cat_locale_string (struct stringbuf *buf, SCM str)
352 {
353 size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
354 size_t len = scm_to_locale_stringbuf (str, buf->ptr, max_len);
355 if (len > max_len)
356 {
357 /* buffer is too small, double its size and try again.
358 */
359 stringbuf_grow (buf);
360 stringbuf_cat_locale_string (buf, str);
361 }
362 else
363 {
364 /* string fits, terminate it and check for embedded '\0'.
365 */
366 buf->ptr[len] = '\0';
367 if (strlen (buf->ptr) != len)
368 scm_misc_error (NULL,
369 "string contains #\\nul character: ~S",
370 scm_list_1 (str));
371 buf->ptr += len;
372 }
373 }
374
375 static void
376 stringbuf_cat (struct stringbuf *buf, char *str)
377 {
378 size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
379 size_t len = strlen (str);
380 if (len > max_len)
381 {
382 /* buffer is too small, double its size and try again.
383 */
384 stringbuf_grow (buf);
385 stringbuf_cat (buf, str);
386 }
387 else
388 {
389 /* string fits, copy it into buffer.
390 */
391 strcpy (buf->ptr, str);
392 buf->ptr += len;
393 }
394 }
395
396
397 static int
398 scm_c_string_has_an_ext (char *str, size_t len, SCM extensions)
399 {
400 for (; !scm_is_null (extensions); extensions = SCM_CDR (extensions))
401 {
402 char *ext;
403 size_t extlen;
404 int match;
405 ext = scm_to_locale_string (SCM_CAR (extensions));
406 extlen = strlen (ext);
407 match = (len > extlen && str[len - extlen - 1] == '.'
408 && strncmp (str + (len - extlen), ext, extlen) == 0);
409 free (ext);
410 if (match)
411 return 1;
412 }
413 return 0;
414 }
415
416 /* Search PATH for a directory containing a file named FILENAME.
417 The file must be readable, and not a directory.
418 If we find one, return its full filename; otherwise, return #f.
419 If FILENAME is absolute, return it unchanged.
420 If given, EXTENSIONS is a list of strings; for each directory
421 in PATH, we search for FILENAME concatenated with each EXTENSION. */
422 SCM_DEFINE (scm_search_path, "search-path", 2, 0, 1,
423 (SCM path, SCM filename, SCM rest),
424 "Search @var{path} for a directory containing a file named\n"
425 "@var{filename}. The file must be readable, and not a directory.\n"
426 "If we find one, return its full filename; otherwise, return\n"
427 "@code{#f}. If @var{filename} is absolute, return it unchanged.\n"
428 "If given, @var{extensions} is a list of strings; for each\n"
429 "directory in @var{path}, we search for @var{filename}\n"
430 "concatenated with each @var{extension}.")
431 #define FUNC_NAME s_scm_search_path
432 {
433 struct stringbuf buf;
434 char *filename_chars;
435 size_t filename_len;
436 SCM extensions, require_exts;
437 SCM result = SCM_BOOL_F;
438
439 if (SCM_UNBNDP (rest) || scm_is_null (rest))
440 {
441 /* Called either by Scheme code that didn't provide the optional
442 arguments, or C code that used the Guile 1.8 signature (2 required,
443 1 optional arg) and passed '() or nothing as the EXTENSIONS
444 argument. */
445 extensions = SCM_EOL;
446 require_exts = SCM_UNDEFINED;
447 }
448 else
449 {
450 if (scm_is_null (SCM_CAR (rest)) || scm_is_pair (SCM_CAR (rest)))
451 {
452 /* Called by Scheme code written for 1.9. */
453 extensions = SCM_CAR (rest);
454 if (scm_is_null (SCM_CDR (rest)))
455 require_exts = SCM_UNDEFINED;
456 else
457 {
458 require_exts = SCM_CADR (rest);
459 if (SCM_UNLIKELY (!scm_is_null (SCM_CDDR (rest))))
460 scm_wrong_num_args (scm_from_locale_string (FUNC_NAME));
461 }
462 }
463 else
464 {
465 /* Called by C code that uses the 1.8 signature, i.e., which
466 expects the 3rd argument to be EXTENSIONS. */
467 extensions = rest;
468 require_exts = SCM_UNDEFINED;
469 }
470 }
471
472 if (SCM_UNBNDP (extensions))
473 extensions = SCM_EOL;
474
475 SCM_VALIDATE_LIST (3, extensions);
476
477 if (SCM_UNBNDP (require_exts))
478 require_exts = SCM_BOOL_F;
479
480 scm_dynwind_begin (0);
481
482 filename_chars = scm_to_locale_string (filename);
483 filename_len = strlen (filename_chars);
484 scm_dynwind_free (filename_chars);
485
486 /* If FILENAME is absolute, return it unchanged. */
487 #ifdef __MINGW32__
488 if (((filename_len >= 1) &&
489 (filename_chars[0] == '/' || filename_chars[0] == '\\')) ||
490 ((filename_len >= 3) && filename_chars[1] == ':' &&
491 ((filename_chars[0] >= 'a' && filename_chars[0] <= 'z') ||
492 (filename_chars[0] >= 'A' && filename_chars[0] <= 'Z')) &&
493 (filename_chars[2] == '/' || filename_chars[2] == '\\')))
494 #else
495 if (filename_len >= 1 && filename_chars[0] == '/')
496 #endif
497 {
498 SCM res = filename;
499 if (scm_is_true (require_exts) &&
500 !scm_c_string_has_an_ext (filename_chars, filename_len,
501 extensions))
502 res = SCM_BOOL_F;
503
504 scm_dynwind_end ();
505 return res;
506 }
507
508 /* If FILENAME has an extension, don't try to add EXTENSIONS to it. */
509 {
510 char *endp;
511
512 for (endp = filename_chars + filename_len - 1;
513 endp >= filename_chars;
514 endp--)
515 {
516 if (*endp == '.')
517 {
518 if (scm_is_true (require_exts) &&
519 !scm_c_string_has_an_ext (filename_chars, filename_len,
520 extensions))
521 {
522 /* This filename has an extension, but not one of the right
523 ones... */
524 scm_dynwind_end ();
525 return SCM_BOOL_F;
526 }
527 /* This filename already has an extension, so cancel the
528 list of extensions. */
529 extensions = SCM_EOL;
530 break;
531 }
532 #ifdef __MINGW32__
533 else if (*endp == '/' || *endp == '\\')
534 #else
535 else if (*endp == '/')
536 #endif
537 /* This filename has no extension, so keep the current list
538 of extensions. */
539 break;
540 }
541 }
542
543 /* This simplifies the loop below a bit.
544 */
545 if (scm_is_null (extensions))
546 extensions = scm_listofnullstr;
547
548 buf.buf_len = 512;
549 buf.buf = scm_malloc (buf.buf_len);
550 scm_dynwind_unwind_handler (stringbuf_free, &buf, SCM_F_WIND_EXPLICITLY);
551
552 /* Try every path element.
553 */
554 for (; scm_is_pair (path); path = SCM_CDR (path))
555 {
556 SCM dir = SCM_CAR (path);
557 SCM exts;
558 size_t sans_ext_len;
559
560 buf.ptr = buf.buf;
561 stringbuf_cat_locale_string (&buf, dir);
562
563 /* Concatenate the path name and the filename. */
564
565 #ifdef __MINGW32__
566 if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/') && (buf.ptr[-1] != '\\'))
567 #else
568 if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/'))
569 #endif
570 stringbuf_cat (&buf, "/");
571
572 stringbuf_cat (&buf, filename_chars);
573 sans_ext_len = buf.ptr - buf.buf;
574
575 /* Try every extension. */
576 for (exts = extensions; scm_is_pair (exts); exts = SCM_CDR (exts))
577 {
578 SCM ext = SCM_CAR (exts);
579 struct stat mode;
580
581 buf.ptr = buf.buf + sans_ext_len;
582 stringbuf_cat_locale_string (&buf, ext);
583
584 /* If the file exists at all, we should return it. If the
585 file is inaccessible, then that's an error. */
586
587 if (stat (buf.buf, &mode) == 0
588 && ! (mode.st_mode & S_IFDIR))
589 {
590 result = scm_from_locale_string (buf.buf);
591 goto end;
592 }
593 }
594
595 if (!SCM_NULL_OR_NIL_P (exts))
596 scm_wrong_type_arg_msg (NULL, 0, extensions, "proper list");
597 }
598
599 if (!SCM_NULL_OR_NIL_P (path))
600 scm_wrong_type_arg_msg (NULL, 0, path, "proper list");
601
602 end:
603 scm_dynwind_end ();
604 return result;
605 }
606 #undef FUNC_NAME
607
608
609 /* Search %load-path for a directory containing a file named FILENAME.
610 The file must be readable, and not a directory.
611 If we find one, return its full filename; otherwise, return #f.
612 If FILENAME is absolute, return it unchanged. */
613 SCM_DEFINE (scm_sys_search_load_path, "%search-load-path", 1, 0, 0,
614 (SCM filename),
615 "Search @var{%load-path} for the file named @var{filename},\n"
616 "which must be readable by the current user. If @var{filename}\n"
617 "is found in the list of paths to search or is an absolute\n"
618 "pathname, return its full pathname. Otherwise, return\n"
619 "@code{#f}. Filenames may have any of the optional extensions\n"
620 "in the @code{%load-extensions} list; @code{%search-load-path}\n"
621 "will try each extension automatically.")
622 #define FUNC_NAME s_scm_sys_search_load_path
623 {
624 SCM path = *scm_loc_load_path;
625 SCM exts = *scm_loc_load_extensions;
626 SCM_VALIDATE_STRING (1, filename);
627
628 if (scm_ilength (path) < 0)
629 SCM_MISC_ERROR ("%load-path is not a proper list", SCM_EOL);
630 if (scm_ilength (exts) < 0)
631 SCM_MISC_ERROR ("%load-extension list is not a proper list", SCM_EOL);
632 return scm_search_path (path, filename, exts);
633 }
634 #undef FUNC_NAME
635
636
637 /* Return true if COMPILED_FILENAME is newer than source file
638 FULL_FILENAME, false otherwise. Also return false if one of the
639 files cannot be stat'd. */
640 static int
641 compiled_is_fresh (SCM full_filename, SCM compiled_filename)
642 {
643 char *source, *compiled;
644 struct stat stat_source, stat_compiled;
645 int compiled_is_newer;
646
647 source = scm_to_locale_string (full_filename);
648 compiled = scm_to_locale_string (compiled_filename);
649
650 if (stat (source, &stat_source) == 0
651 && stat (compiled, &stat_compiled) == 0)
652 {
653 struct timespec source_mtime, compiled_mtime;
654
655 source_mtime = get_stat_mtime (&stat_source);
656 compiled_mtime = get_stat_mtime (&stat_compiled);
657
658 if (source_mtime.tv_sec < compiled_mtime.tv_sec
659 || (source_mtime.tv_sec == compiled_mtime.tv_sec
660 && source_mtime.tv_nsec <= compiled_mtime.tv_nsec))
661 compiled_is_newer = 1;
662 else
663 {
664 compiled_is_newer = 0;
665 scm_puts (";;; note: source file ", scm_current_error_port ());
666 scm_puts (source, scm_current_error_port ());
667 scm_puts ("\n;;; newer than compiled ", scm_current_error_port ());
668 scm_puts (compiled, scm_current_error_port ());
669 scm_puts ("\n", scm_current_error_port ());
670 }
671 }
672 else
673 /* At least one of the files isn't accessible. */
674 compiled_is_newer = 0;
675
676 free (source);
677 free (compiled);
678
679 return compiled_is_newer;
680 }
681
682 SCM_KEYWORD (kw_env, "env");
683 SCM_KEYWORD (kw_opts, "opts");
684
685 SCM_SYMBOL (sym_compile_file, "compile-file");
686 SCM_SYMBOL (sym_auto_compilation_options, "%auto-compilation-options");
687
688 static SCM
689 do_try_auto_compile (void *data)
690 {
691 SCM source = PTR2SCM (data);
692 SCM comp_mod, compile_file;
693
694 scm_puts (";;; compiling ", scm_current_error_port ());
695 scm_display (source, scm_current_error_port ());
696 scm_newline (scm_current_error_port ());
697
698 comp_mod = scm_c_resolve_module ("system base compile");
699 compile_file = scm_module_variable (comp_mod, sym_compile_file);
700
701 if (scm_is_true (compile_file))
702 {
703 /* Auto-compile in the context of the current module. */
704 SCM res, opts;
705 SCM args[5];
706
707 opts = scm_module_variable (scm_the_root_module (),
708 sym_auto_compilation_options);
709 if (SCM_VARIABLEP (opts))
710 opts = SCM_VARIABLE_REF (opts);
711 else
712 opts = SCM_EOL;
713
714 args[0] = source;
715 args[1] = kw_opts;
716 args[2] = opts;
717 args[3] = kw_env;
718 args[4] = scm_current_module ();
719
720 /* Assume `*current-warning-prefix*' has an appropriate value. */
721 res = scm_call_n (scm_variable_ref (compile_file), args, 5);
722
723 scm_puts (";;; compiled ", scm_current_error_port ());
724 scm_display (res, scm_current_error_port ());
725 scm_newline (scm_current_error_port ());
726 return res;
727 }
728 else
729 {
730 scm_puts (";;; it seems ", scm_current_error_port ());
731 scm_display (source, scm_current_error_port ());
732 scm_puts ("\n;;; is part of the compiler; skipping auto-compilation\n",
733 scm_current_error_port ());
734 return SCM_BOOL_F;
735 }
736 }
737
738 static SCM
739 auto_compile_catch_handler (void *data, SCM tag, SCM throw_args)
740 {
741 SCM source = PTR2SCM (data);
742 SCM oport, lines;
743
744 oport = scm_open_output_string ();
745 scm_print_exception (oport, SCM_BOOL_F, tag, throw_args);
746
747 scm_puts (";;; WARNING: compilation of ", scm_current_error_port ());
748 scm_display (source, scm_current_error_port ());
749 scm_puts (" failed:\n", scm_current_error_port ());
750
751 lines = scm_string_split (scm_get_output_string (oport),
752 SCM_MAKE_CHAR ('\n'));
753 for (; scm_is_pair (lines); lines = scm_cdr (lines))
754 if (scm_c_string_length (scm_car (lines)))
755 {
756 scm_puts (";;; ", scm_current_error_port ());
757 scm_display (scm_car (lines), scm_current_error_port ());
758 scm_newline (scm_current_error_port ());
759 }
760
761 scm_close_port (oport);
762
763 return SCM_BOOL_F;
764 }
765
766 SCM_DEFINE (scm_sys_warn_auto_compilation_enabled, "%warn-auto-compilation-enabled", 0, 0, 0,
767 (void), "")
768 #define FUNC_NAME s_scm_sys_warn_auto_compilation_enabled
769 {
770 static int message_shown = 0;
771
772 if (!message_shown)
773 {
774 scm_puts (";;; note: auto-compilation is enabled, set GUILE_AUTO_COMPILE=0\n"
775 ";;; or pass the --no-auto-compile argument to disable.\n",
776 scm_current_error_port ());
777 message_shown = 1;
778 }
779
780 return SCM_UNSPECIFIED;
781 }
782 #undef FUNC_NAME
783
784 static SCM
785 scm_try_auto_compile (SCM source)
786 {
787 if (scm_is_false (*scm_loc_load_should_auto_compile))
788 return SCM_BOOL_F;
789
790 scm_sys_warn_auto_compilation_enabled ();
791 return scm_c_catch (SCM_BOOL_T,
792 do_try_auto_compile,
793 SCM2PTR (source),
794 auto_compile_catch_handler,
795 SCM2PTR (source),
796 NULL, NULL);
797 }
798
799 /* See also (system base compile):compiled-file-name. */
800 static SCM
801 canonical_suffix (SCM fname)
802 {
803 SCM canon;
804 size_t len;
805
806 canon = scm_canonicalize_path (fname);
807 len = scm_c_string_length (canon);
808
809 if (len > 1 && scm_is_eq (scm_c_string_ref (canon, 0), SCM_MAKE_CHAR ('/')))
810 return canon;
811 else if (len > 2 && scm_is_eq (scm_c_string_ref (canon, 1), SCM_MAKE_CHAR (':')))
812 return scm_string_append (scm_list_3 (scm_from_latin1_string ("/"),
813 scm_c_substring (canon, 0, 1),
814 scm_c_substring (canon, 2, len)));
815 else
816 return canon;
817 }
818
819 SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 0, 0, 1,
820 (SCM args),
821 "Search @var{%load-path} for the file named @var{filename} and\n"
822 "load it into the top-level environment. If @var{filename} is a\n"
823 "relative pathname and is not found in the list of search paths,\n"
824 "an error is signalled, unless the optional argument\n"
825 "@var{exception_on_not_found} is @code{#f}, in which case\n"
826 "@code{#f} is returned instead.")
827 #define FUNC_NAME s_scm_primitive_load_path
828 {
829 SCM filename, exception_on_not_found;
830 SCM full_filename, compiled_filename;
831 int compiled_is_fallback = 0;
832 SCM hook = *scm_loc_load_hook;
833
834 if (scm_is_true (hook) && scm_is_false (scm_procedure_p (hook)))
835 SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
836 SCM_EOL);
837
838 if (scm_is_string (args))
839 {
840 /* C code written for 1.8 and earlier expects this function to take a
841 single argument (the file name). */
842 filename = args;
843 exception_on_not_found = SCM_UNDEFINED;
844 }
845 else
846 {
847 /* Starting from 1.9, this function takes 1 required and 1 optional
848 argument. */
849 long len;
850
851 SCM_VALIDATE_LIST_COPYLEN (SCM_ARG1, args, len);
852 if (len < 1 || len > 2)
853 scm_error_num_args_subr (FUNC_NAME);
854
855 filename = SCM_CAR (args);
856 SCM_VALIDATE_STRING (SCM_ARG1, filename);
857
858 exception_on_not_found = len > 1 ? SCM_CADR (args) : SCM_UNDEFINED;
859 }
860
861 if (SCM_UNBNDP (exception_on_not_found))
862 exception_on_not_found = SCM_BOOL_T;
863
864 full_filename = scm_sys_search_load_path (filename);
865
866 compiled_filename =
867 scm_search_path (*scm_loc_load_compiled_path,
868 filename,
869 scm_list_2 (*scm_loc_load_compiled_extensions,
870 SCM_BOOL_T));
871
872 if (scm_is_false (compiled_filename)
873 && scm_is_true (full_filename)
874 && scm_is_true (*scm_loc_compile_fallback_path)
875 && scm_is_false (*scm_loc_fresh_auto_compile)
876 && scm_is_pair (*scm_loc_load_compiled_extensions)
877 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions)))
878 {
879 SCM fallback = scm_string_append
880 (scm_list_3 (*scm_loc_compile_fallback_path,
881 canonical_suffix (full_filename),
882 scm_car (*scm_loc_load_compiled_extensions)));
883 if (scm_is_true (scm_stat (fallback, SCM_BOOL_F)))
884 {
885 compiled_filename = fallback;
886 compiled_is_fallback = 1;
887 }
888 }
889
890 if (scm_is_false (full_filename) && scm_is_false (compiled_filename))
891 {
892 if (scm_is_true (exception_on_not_found))
893 SCM_MISC_ERROR ("Unable to find file ~S in load path",
894 scm_list_1 (filename));
895 else
896 return SCM_BOOL_F;
897 }
898
899 if (!scm_is_false (hook))
900 scm_call_1 (hook, (scm_is_true (full_filename)
901 ? full_filename : compiled_filename));
902
903 if (scm_is_false (full_filename)
904 || (scm_is_true (compiled_filename)
905 && compiled_is_fresh (full_filename, compiled_filename)))
906 return scm_load_compiled_with_vm (compiled_filename);
907
908 /* Perhaps there was the installed .go that was stale, but our fallback is
909 fresh. Let's try that. Duplicating code, but perhaps that's OK. */
910
911 if (!compiled_is_fallback
912 && scm_is_true (*scm_loc_compile_fallback_path)
913 && scm_is_false (*scm_loc_fresh_auto_compile)
914 && scm_is_pair (*scm_loc_load_compiled_extensions)
915 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions)))
916 {
917 SCM fallback = scm_string_append
918 (scm_list_3 (*scm_loc_compile_fallback_path,
919 canonical_suffix (full_filename),
920 scm_car (*scm_loc_load_compiled_extensions)));
921 if (scm_is_true (scm_stat (fallback, SCM_BOOL_F))
922 && compiled_is_fresh (full_filename, fallback))
923 {
924 scm_puts (";;; found fresh local cache at ", scm_current_error_port ());
925 scm_display (fallback, scm_current_error_port ());
926 scm_newline (scm_current_error_port ());
927 return scm_load_compiled_with_vm (fallback);
928 }
929 }
930
931 /* Otherwise, we bottom out here. */
932 {
933 SCM freshly_compiled = scm_try_auto_compile (full_filename);
934
935 if (scm_is_true (freshly_compiled))
936 return scm_load_compiled_with_vm (freshly_compiled);
937 else
938 return scm_primitive_load (full_filename);
939 }
940 }
941 #undef FUNC_NAME
942
943 SCM
944 scm_c_primitive_load_path (const char *filename)
945 {
946 return scm_primitive_load_path (scm_from_locale_string (filename));
947 }
948
949 void
950 scm_init_eval_in_scheme (void)
951 {
952 SCM eval_scm, eval_go;
953 eval_scm = scm_search_path (*scm_loc_load_path,
954 scm_from_locale_string ("ice-9/eval.scm"),
955 SCM_EOL);
956 eval_go = scm_search_path (*scm_loc_load_compiled_path,
957 scm_from_locale_string ("ice-9/eval.go"),
958 SCM_EOL);
959
960 if (scm_is_true (eval_scm) && scm_is_true (eval_go)
961 && compiled_is_fresh (eval_scm, eval_go))
962 scm_load_compiled_with_vm (eval_go);
963 else
964 /* if we have no eval.go, we shouldn't load any compiled code at all */
965 *scm_loc_load_compiled_path = SCM_EOL;
966 }
967
968 \f
969 /* Information about the build environment. */
970
971 SCM_VARIABLE_INIT (sys_host_type, "%host-type",
972 scm_from_locale_string (HOST_TYPE));
973
974
975 /* Initialize the scheme variable %guile-build-info, based on data
976 provided by the Makefile, via libpath.h. */
977 static void
978 init_build_info ()
979 {
980 static struct { char *name; char *value; } info[] = SCM_BUILD_INFO;
981 SCM *loc = SCM_VARIABLE_LOC (scm_c_define ("%guile-build-info", SCM_EOL));
982 unsigned long i;
983
984 for (i = 0; i < (sizeof (info) / sizeof (info[0])); i++)
985 {
986 SCM key = scm_from_locale_symbol (info[i].name);
987 SCM val = scm_from_locale_string (info[i].value);
988 *loc = scm_acons (key, val, *loc);
989 }
990 #ifdef PACKAGE_PACKAGER
991 *loc = scm_acons (scm_from_latin1_symbol ("packager"),
992 scm_from_latin1_string (PACKAGE_PACKAGER),
993 *loc);
994 #endif
995 #ifdef PACKAGE_PACKAGER_VERSION
996 *loc = scm_acons (scm_from_latin1_symbol ("packager-version"),
997 scm_from_latin1_string (PACKAGE_PACKAGER_VERSION),
998 *loc);
999 #endif
1000 #ifdef PACKAGE_PACKAGER_BUG_REPORTS
1001 *loc = scm_acons (scm_from_latin1_symbol ("packager-bug-reports"),
1002 scm_from_latin1_string (PACKAGE_PACKAGER_BUG_REPORTS),
1003 *loc);
1004 #endif
1005 }
1006
1007 \f
1008 void
1009 scm_init_load ()
1010 {
1011 scm_listofnullstr = scm_list_1 (scm_nullstr);
1012 scm_loc_load_path = SCM_VARIABLE_LOC (scm_c_define ("%load-path", SCM_EOL));
1013 scm_loc_load_extensions
1014 = SCM_VARIABLE_LOC (scm_c_define ("%load-extensions",
1015 scm_list_2 (scm_from_locale_string (".scm"),
1016 scm_nullstr)));
1017 scm_loc_load_compiled_path
1018 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-path", SCM_EOL));
1019 scm_loc_load_compiled_extensions
1020 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-extensions",
1021 scm_list_1 (scm_from_locale_string (".go"))));
1022 scm_loc_load_hook = SCM_VARIABLE_LOC (scm_c_define ("%load-hook", SCM_BOOL_F));
1023
1024 scm_loc_compile_fallback_path
1025 = SCM_VARIABLE_LOC (scm_c_define ("%compile-fallback-path", SCM_BOOL_F));
1026 scm_loc_load_should_auto_compile
1027 = SCM_VARIABLE_LOC (scm_c_define ("%load-should-auto-compile", SCM_BOOL_F));
1028 scm_loc_fresh_auto_compile
1029 = SCM_VARIABLE_LOC (scm_c_define ("%fresh-auto-compile", SCM_BOOL_F));
1030
1031 the_reader = scm_make_fluid ();
1032 scm_fluid_set_x (the_reader, SCM_BOOL_F);
1033 scm_c_define("current-reader", the_reader);
1034
1035 scm_c_define ("load-compiled",
1036 scm_c_make_gsubr ("load-compiled/vm", 1, 0, 0,
1037 scm_load_compiled_with_vm));
1038
1039 init_build_info ();
1040
1041 #include "libguile/load.x"
1042 }
1043
1044 void
1045 scm_init_load_should_auto_compile ()
1046 {
1047 char *auto_compile = getenv ("GUILE_AUTO_COMPILE");
1048
1049 if (auto_compile && strcmp (auto_compile, "0") == 0)
1050 {
1051 *scm_loc_load_should_auto_compile = SCM_BOOL_F;
1052 *scm_loc_fresh_auto_compile = SCM_BOOL_F;
1053 }
1054 /* Allow "freshen" also. */
1055 else if (auto_compile && strncmp (auto_compile, "fresh", 5) == 0)
1056 {
1057 *scm_loc_load_should_auto_compile = SCM_BOOL_T;
1058 *scm_loc_fresh_auto_compile = SCM_BOOL_T;
1059 }
1060 else
1061 {
1062 *scm_loc_load_should_auto_compile = SCM_BOOL_T;
1063 *scm_loc_fresh_auto_compile = SCM_BOOL_F;
1064 }
1065 }
1066
1067
1068
1069 /*
1070 Local Variables:
1071 c-file-style: "gnu"
1072 End:
1073 */