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