primitive-load returns the value(s) of the last expression
[bpt/guile.git] / libguile / load.c
CommitLineData
4a655e50 1/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
0f2d19dd 2 *
73be1d9e 3 * This library is free software; you can redistribute it and/or
53befeb7
NJ
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.
0f2d19dd 7 *
53befeb7
NJ
8 * This library is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e
MV
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
0f2d19dd 12 *
73be1d9e
MV
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
53befeb7
NJ
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16 * 02110-1301 USA
73be1d9e 17 */
1bbd0b84 18
1bbd0b84 19
0f2d19dd
JB
20\f
21
dbb605f5 22#ifdef HAVE_CONFIG_H
cbd41c89
RB
23# include <config.h>
24#endif
25
13070bd3 26#include <string.h>
7d04d68b 27#include <stdio.h>
13070bd3 28
a0599745 29#include "libguile/_scm.h"
655aadf4 30#include "libguile/private-gc.h" /* scm_getenv_int */
a0599745
MD
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"
f33b174d 40#include "libguile/modules.h"
7d04d68b 41#include "libguile/chars.h"
c44ca4fe 42#include "libguile/srfi-13.h"
a0599745
MD
43
44#include "libguile/validate.h"
45#include "libguile/load.h"
ec3a8ace 46#include "libguile/fluids.h"
06721500 47
22f4ee48
AW
48#include "libguile/vm.h" /* for load-compiled/vm */
49
06721500
JB
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
5b197db8
AW
57#ifdef HAVE_PWD_H
58#include <pwd.h>
59#endif /* HAVE_PWD_H */
60
06721500
JB
61#ifndef R_OK
62#define R_OK 4
63#endif
0f2d19dd 64
abca59fe
LC
65#include <stat-time.h>
66
0f2d19dd 67\f
06721500 68/* Loading a file, given an absolute filename. */
0f2d19dd 69
26544b96
JB
70/* Hook to run when we load a file, perhaps to announce the fact somewhere.
71 Applied to the full name of the file. */
72static SCM *scm_loc_load_hook;
73
ec3a8ace
NJ
74/* The current reader (a fluid). */
75static SCM the_reader = SCM_BOOL_F;
8b039053 76
ec3a8ace 77
3b3b36dd 78SCM_DEFINE (scm_primitive_load, "primitive-load", 1, 0, 0,
1bbd0b84 79 (SCM filename),
67e8151b
MG
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.")
1bbd0b84 87#define FUNC_NAME s_scm_primitive_load
0f2d19dd 88{
26544b96 89 SCM hook = *scm_loc_load_hook;
017eb4a6 90 SCM ret = SCM_UNSPECIFIED;
889975e5 91 char *encoding;
017eb4a6 92
a6d9e5ab 93 SCM_VALIDATE_STRING (1, filename);
bc36d050 94 if (scm_is_true (hook) && scm_is_false (scm_procedure_p (hook)))
2ade72d7
DH
95 SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
96 SCM_EOL);
26544b96 97
bc36d050 98 if (!scm_is_false (hook))
fdc28395 99 scm_call_1 (hook, filename);
26544b96 100
017eb4a6
AW
101 {
102 SCM port;
103
104 port = scm_open_file (filename, scm_from_locale_string ("r"));
661ae7ab
MV
105 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE);
106 scm_i_dynwind_current_load_port (port);
f8a1c9a8
LC
107
108 encoding = scm_i_scan_for_encoding (port);
889975e5 109 if (encoding)
f8a1c9a8 110 scm_i_set_port_encoding_x (port, encoding);
889975e5 111 else
eb7a16a9
AW
112 /* The file has no encoding declared. We'll presume UTF-8, like
113 compile-file does. */
114 scm_i_set_port_encoding_x (port, "UTF-8");
f8a1c9a8 115
b5623573
MV
116 while (1)
117 {
ec3a8ace
NJ
118 SCM reader, form;
119
120 /* Lookup and use the current reader to read the next
121 expression. */
8b039053 122 reader = scm_fluid_ref (the_reader);
393baa8a 123 if (scm_is_false (reader))
ec3a8ace
NJ
124 form = scm_read (port);
125 else
126 form = scm_call_1 (reader, port);
127
b5623573
MV
128 if (SCM_EOF_OBJECT_P (form))
129 break;
ec3a8ace 130
017eb4a6 131 ret = scm_primitive_eval_x (form);
b5623573
MV
132 }
133
661ae7ab 134 scm_dynwind_end ();
0f2d19dd
JB
135 scm_close_port (port);
136 }
017eb4a6 137 return ret;
0f2d19dd 138}
1bbd0b84 139#undef FUNC_NAME
0f2d19dd 140
c519b272
MV
141SCM
142scm_c_primitive_load (const char *filename)
143{
cc95e00a 144 return scm_primitive_load (scm_from_locale_string (filename));
c519b272
MV
145}
146
0f2d19dd 147\f
3feedb00
MD
148/* Builtin path to scheme library files. */
149#ifdef SCM_PKGDATA_DIR
a1ec6916 150SCM_DEFINE (scm_sys_package_data_dir, "%package-data-dir", 0, 0, 0,
1bbd0b84 151 (),
b380b885
MD
152 "Return the name of the directory where Scheme packages, modules and\n"
153 "libraries are kept. On most Unix systems, this will be\n"
154 "@samp{/usr/local/share/guile}.")
1bbd0b84 155#define FUNC_NAME s_scm_sys_package_data_dir
3feedb00 156{
cc95e00a 157 return scm_from_locale_string (SCM_PKGDATA_DIR);
3feedb00 158}
1bbd0b84 159#undef FUNC_NAME
3feedb00
MD
160#endif /* SCM_PKGDATA_DIR */
161
e8e9b690 162#ifdef SCM_LIBRARY_DIR
a1ec6916 163SCM_DEFINE (scm_sys_library_dir, "%library-dir", 0,0,0,
e8e9b690 164 (),
b380b885
MD
165 "Return the directory where the Guile Scheme library files are installed.\n"
166 "E.g., may return \"/usr/share/guile/1.3.5\".")
e8e9b690
GB
167#define FUNC_NAME s_scm_sys_library_dir
168{
cc95e00a 169 return scm_from_locale_string (SCM_LIBRARY_DIR);
e8e9b690
GB
170}
171#undef FUNC_NAME
172#endif /* SCM_LIBRARY_DIR */
173
174#ifdef SCM_SITE_DIR
a1ec6916 175SCM_DEFINE (scm_sys_site_dir, "%site-dir", 0,0,0,
e8e9b690 176 (),
bc325e76
AW
177 "Return the directory where users should install Scheme code for use\n"
178 "with this version of Guile.\n\n"
179 "E.g., may return \"/usr/share/guile/site/" SCM_EFFECTIVE_VERSION "\".")
e8e9b690
GB
180#define FUNC_NAME s_scm_sys_site_dir
181{
cc95e00a 182 return scm_from_locale_string (SCM_SITE_DIR);
e8e9b690
GB
183}
184#undef FUNC_NAME
185#endif /* SCM_SITE_DIR */
186
bc325e76
AW
187#ifdef SCM_GLOBAL_SITE_DIR
188SCM_DEFINE (scm_sys_global_site_dir, "%global-site-dir", 0,0,0,
189 (),
190 "Return the directory where users should install Scheme code for use\n"
191 "with all versions of Guile.\n\n"
192 "E.g., may return \"/usr/share/guile/site\".")
193#define FUNC_NAME s_scm_sys_global_site_dir
194{
195 return scm_from_locale_string (SCM_GLOBAL_SITE_DIR);
196}
197#undef FUNC_NAME
198#endif /* SCM_GLOBAL_SITE_DIR */
e8e9b690
GB
199
200
3feedb00 201\f
06721500 202/* Initializing the load path, and searching it. */
0f2d19dd 203
26544b96 204/* List of names of directories we search for files to load. */
06721500
JB
205static SCM *scm_loc_load_path;
206
26544b96
JB
207/* List of extensions we try adding to the filenames. */
208static SCM *scm_loc_load_extensions;
209
5b197db8
AW
210/* Like %load-path and %load-extensions, but for compiled files. */
211static SCM *scm_loc_load_compiled_path;
22f4ee48
AW
212static SCM *scm_loc_load_compiled_extensions;
213
ee001750 214/* Whether we should try to auto-compile. */
6f06e8d3 215static SCM *scm_loc_load_should_auto_compile;
01cddfc1 216
1e56cff2
AW
217/* Whether to treat all auto-compiled files as stale. */
218static SCM *scm_loc_fresh_auto_compile;
219
6f06e8d3 220/* The fallback path for auto-compilation */
5ea401bf 221static SCM *scm_loc_compile_fallback_path;
01cddfc1 222
a1ec6916 223SCM_DEFINE (scm_parse_path, "parse-path", 1, 1, 0,
1bbd0b84 224 (SCM path, SCM tail),
d91788cb
MG
225 "Parse @var{path}, which is expected to be a colon-separated\n"
226 "string, into a list and return the resulting list with\n"
227 "@var{tail} appended. If @var{path} is @code{#f}, @var{tail}\n"
228 "is returned.")
1bbd0b84 229#define FUNC_NAME s_scm_parse_path
04e8fb0a 230{
7d04d68b
MV
231#ifdef __MINGW32__
232 SCM sep = SCM_MAKE_CHAR (';');
233#else
234 SCM sep = SCM_MAKE_CHAR (':');
235#endif
236
04e8fb0a
MD
237 if (SCM_UNBNDP (tail))
238 tail = SCM_EOL;
7888309b 239 return (scm_is_false (path)
04e8fb0a 240 ? tail
7d04d68b 241 : scm_append_x (scm_list_2 (scm_string_split (path, sep), tail)));
04e8fb0a 242}
1bbd0b84 243#undef FUNC_NAME
04e8fb0a
MD
244
245
06721500 246/* Initialize the global variable %load-path, given the value of the
3feedb00 247 SCM_SITE_DIR and SCM_LIBRARY_DIR preprocessor symbols and the
01cddfc1 248 GUILE_LOAD_PATH environment variable. */
0f2d19dd 249void
06721500
JB
250scm_init_load_path ()
251{
11c5e0bf 252 char *env;
06721500 253 SCM path = SCM_EOL;
5b197db8 254 SCM cpath = SCM_EOL;
06721500 255
3feedb00 256#ifdef SCM_LIBRARY_DIR
02b84691
AW
257 env = getenv ("GUILE_SYSTEM_PATH");
258 if (env && strcmp (env, "") == 0)
259 /* special-case interpret system-path=="" as meaning no system path instead
260 of '("") */
261 ;
262 else if (env)
263 path = scm_parse_path (scm_from_locale_string (env), path);
264 else
bc325e76 265 path = scm_list_4 (scm_from_locale_string (SCM_LIBRARY_DIR),
3c98a49c 266 scm_from_locale_string (SCM_SITE_DIR),
bc325e76 267 scm_from_locale_string (SCM_GLOBAL_SITE_DIR),
02b84691 268 scm_from_locale_string (SCM_PKGDATA_DIR));
5b197db8
AW
269
270 env = getenv ("GUILE_SYSTEM_COMPILED_PATH");
271 if (env && strcmp (env, "") == 0)
272 /* like above */
273 ;
274 else if (env)
275 cpath = scm_parse_path (scm_from_locale_string (env), cpath);
276 else
9957641b
AW
277 {
278 cpath = scm_list_2 (scm_from_locale_string (SCM_CCACHE_DIR),
279 scm_from_locale_string (SCM_SITE_CCACHE_DIR));
280 }
3c997c4b 281
3feedb00 282#endif /* SCM_LIBRARY_DIR */
06721500 283
3c997c4b 284 {
179fe336
AW
285 char cachedir[1024];
286 char *e;
287#ifdef HAVE_GETPWENT
288 struct passwd *pwd;
289#endif
5b197db8 290
6e5c02b8
AW
291#define FALLBACK_DIR \
292 "guile/ccache/" SCM_EFFECTIVE_VERSION "-" SCM_OBJCODE_MACHINE_VERSION_STRING
179fe336
AW
293
294 if ((e = getenv ("XDG_CACHE_HOME")))
48a0fe4d 295 snprintf (cachedir, sizeof(cachedir), "%s/" FALLBACK_DIR, e);
179fe336
AW
296 else if ((e = getenv ("HOME")))
297 snprintf (cachedir, sizeof(cachedir), "%s/.cache/" FALLBACK_DIR, e);
5b197db8 298#ifdef HAVE_GETPWENT
179fe336
AW
299 else if ((pwd = getpwuid (getuid ())) && pwd->pw_dir)
300 snprintf (cachedir, sizeof(cachedir), "%s/.cache/" FALLBACK_DIR,
301 pwd->pw_dir);
5b197db8 302#endif /* HAVE_GETPWENT */
284019a2
JN
303#ifdef __MINGW32__
304 else if ((e = getenv ("LOCALAPPDATA")))
305 snprintf (cachedir, sizeof (cachedir), "%s/.cache/" FALLBACK_DIR, e);
306 else if ((e = getenv ("APPDATA")))
307 snprintf (cachedir, sizeof (cachedir), "%s/.cache/" FALLBACK_DIR, e);
308#endif /* __MINGW32__ */
179fe336
AW
309 else
310 cachedir[0] = 0;
311
312 if (cachedir[0])
313 *scm_loc_compile_fallback_path = scm_from_locale_string (cachedir);
3c997c4b 314 }
06721500 315
11c5e0bf
MV
316 env = getenv ("GUILE_LOAD_PATH");
317 if (env)
318 path = scm_parse_path (scm_from_locale_string (env), path);
01cddfc1 319
5b197db8
AW
320 env = getenv ("GUILE_LOAD_COMPILED_PATH");
321 if (env)
322 cpath = scm_parse_path (scm_from_locale_string (env), cpath);
323
06721500 324 *scm_loc_load_path = path;
5b197db8 325 *scm_loc_load_compiled_path = cpath;
06721500
JB
326}
327
04e8fb0a 328SCM scm_listofnullstr;
06721500 329
7d04d68b
MV
330/* Utility functions for assembling C strings in a buffer.
331 */
332
333struct stringbuf {
334 char *buf, *ptr;
335 size_t buf_len;
336};
337
338static void
339stringbuf_free (void *data)
340{
341 struct stringbuf *buf = (struct stringbuf *)data;
342 free (buf->buf);
343}
344
345static void
346stringbuf_grow (struct stringbuf *buf)
347{
348 size_t ptroff = buf->ptr - buf->buf;
349 buf->buf_len *= 2;
7d04d68b
MV
350 buf->buf = scm_realloc (buf->buf, buf->buf_len);
351 buf->ptr = buf->buf + ptroff;
352}
353
354static void
355stringbuf_cat_locale_string (struct stringbuf *buf, SCM str)
356{
357 size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
358 size_t len = scm_to_locale_stringbuf (str, buf->ptr, max_len);
359 if (len > max_len)
360 {
361 /* buffer is too small, double its size and try again.
362 */
363 stringbuf_grow (buf);
364 stringbuf_cat_locale_string (buf, str);
365 }
366 else
367 {
368 /* string fits, terminate it and check for embedded '\0'.
369 */
370 buf->ptr[len] = '\0';
371 if (strlen (buf->ptr) != len)
372 scm_misc_error (NULL,
373 "string contains #\\nul character: ~S",
374 scm_list_1 (str));
375 buf->ptr += len;
376 }
377}
378
379static void
380stringbuf_cat (struct stringbuf *buf, char *str)
381{
382 size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
383 size_t len = strlen (str);
384 if (len > max_len)
385 {
386 /* buffer is too small, double its size and try again.
387 */
388 stringbuf_grow (buf);
389 stringbuf_cat (buf, str);
390 }
391 else
392 {
393 /* string fits, copy it into buffer.
394 */
395 strcpy (buf->ptr, str);
396 buf->ptr += len;
397 }
398}
399
400
22f4ee48
AW
401static int
402scm_c_string_has_an_ext (char *str, size_t len, SCM extensions)
403{
404 for (; !scm_is_null (extensions); extensions = SCM_CDR (extensions))
405 {
406 char *ext;
407 size_t extlen;
408 int match;
409 ext = scm_to_locale_string (SCM_CAR (extensions));
410 extlen = strlen (ext);
411 match = (len > extlen && str[len - extlen - 1] == '.'
412 && strncmp (str + (len - extlen), ext, extlen) == 0);
413 free (ext);
414 if (match)
415 return 1;
416 }
417 return 0;
418}
419
04e8fb0a 420/* Search PATH for a directory containing a file named FILENAME.
06721500 421 The file must be readable, and not a directory.
26544b96 422 If we find one, return its full filename; otherwise, return #f.
56384176
JB
423 If FILENAME is absolute, return it unchanged.
424 If given, EXTENSIONS is a list of strings; for each directory
425 in PATH, we search for FILENAME concatenated with each EXTENSION. */
a6e1e050
AW
426static SCM
427search_path (SCM path, SCM filename, SCM extensions, SCM require_exts,
428 struct stat *stat_buf)
06721500 429{
7d04d68b 430 struct stringbuf buf;
56384176 431 char *filename_chars;
7d04d68b
MV
432 size_t filename_len;
433 SCM result = SCM_BOOL_F;
06721500 434
a6e1e050
AW
435 if (scm_ilength (path) < 0)
436 scm_misc_error ("%search-path", "path is not a proper list: ~a",
437 scm_list_1 (path));
438 if (scm_ilength (extensions) < 0)
439 scm_misc_error ("%search-path", "bad extensions list: ~a",
440 scm_list_1 (extensions));
22f4ee48 441
661ae7ab 442 scm_dynwind_begin (0);
7d04d68b
MV
443
444 filename_chars = scm_to_locale_string (filename);
445 filename_len = strlen (filename_chars);
661ae7ab 446 scm_dynwind_free (filename_chars);
06721500 447
26544b96 448 /* If FILENAME is absolute, return it unchanged. */
2e945bcc
SJ
449#ifdef __MINGW32__
450 if (((filename_len >= 1) &&
451 (filename_chars[0] == '/' || filename_chars[0] == '\\')) ||
452 ((filename_len >= 3) && filename_chars[1] == ':' &&
453 ((filename_chars[0] >= 'a' && filename_chars[0] <= 'z') ||
454 (filename_chars[0] >= 'A' && filename_chars[0] <= 'Z')) &&
455 (filename_chars[2] == '/' || filename_chars[2] == '\\')))
456#else
56384176 457 if (filename_len >= 1 && filename_chars[0] == '/')
2e945bcc 458#endif
7d04d68b 459 {
22f4ee48
AW
460 SCM res = filename;
461 if (scm_is_true (require_exts) &&
462 !scm_c_string_has_an_ext (filename_chars, filename_len,
463 extensions))
464 res = SCM_BOOL_F;
465
661ae7ab 466 scm_dynwind_end ();
22f4ee48 467 return res;
7d04d68b 468 }
26544b96 469
56384176
JB
470 /* If FILENAME has an extension, don't try to add EXTENSIONS to it. */
471 {
472 char *endp;
473
474 for (endp = filename_chars + filename_len - 1;
475 endp >= filename_chars;
476 endp--)
477 {
478 if (*endp == '.')
479 {
22f4ee48
AW
480 if (scm_is_true (require_exts) &&
481 !scm_c_string_has_an_ext (filename_chars, filename_len,
482 extensions))
483 {
484 /* This filename has an extension, but not one of the right
485 ones... */
486 scm_dynwind_end ();
487 return SCM_BOOL_F;
488 }
56384176
JB
489 /* This filename already has an extension, so cancel the
490 list of extensions. */
491 extensions = SCM_EOL;
492 break;
493 }
2e945bcc
SJ
494#ifdef __MINGW32__
495 else if (*endp == '/' || *endp == '\\')
496#else
56384176 497 else if (*endp == '/')
2e945bcc 498#endif
56384176
JB
499 /* This filename has no extension, so keep the current list
500 of extensions. */
501 break;
502 }
503 }
504
7d04d68b
MV
505 /* This simplifies the loop below a bit.
506 */
d2e53ed6 507 if (scm_is_null (extensions))
7d04d68b 508 extensions = scm_listofnullstr;
06721500 509
7d04d68b
MV
510 buf.buf_len = 512;
511 buf.buf = scm_malloc (buf.buf_len);
661ae7ab 512 scm_dynwind_unwind_handler (stringbuf_free, &buf, SCM_F_WIND_EXPLICITLY);
0a74e31d 513
7d04d68b
MV
514 /* Try every path element.
515 */
d2e53ed6 516 for (; scm_is_pair (path); path = SCM_CDR (path))
7d04d68b
MV
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
2e945bcc 527#ifdef __MINGW32__
5a6d139b 528 if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/') && (buf.ptr[-1] != '\\'))
2e945bcc 529#else
5a6d139b 530 if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/'))
2e945bcc 531#endif
7d04d68b
MV
532 stringbuf_cat (&buf, "/");
533
534 stringbuf_cat (&buf, filename_chars);
535 sans_ext_len = buf.ptr - buf.buf;
536
537 /* Try every extension. */
d2e53ed6 538 for (exts = extensions; scm_is_pair (exts); exts = SCM_CDR (exts))
7d04d68b
MV
539 {
540 SCM ext = SCM_CAR (exts);
7d04d68b
MV
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
a6e1e050
AW
548 if (stat (buf.buf, stat_buf) == 0
549 && ! (stat_buf->st_mode & S_IFDIR))
7d04d68b
MV
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 }
56384176 559
7d04d68b
MV
560 if (!SCM_NULL_OR_NIL_P (path))
561 scm_wrong_type_arg_msg (NULL, 0, path, "proper list");
56384176 562
7d04d68b 563 end:
661ae7ab 564 scm_dynwind_end ();
7d04d68b 565 return result;
06721500 566}
a6e1e050
AW
567
568SCM_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{extensions} is a list of strings; for each\n"
575 "directory in @var{path}, we search for @var{filename}\n"
576 "concatenated with each @var{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}
1bbd0b84 623#undef FUNC_NAME
06721500
JB
624
625
04e8fb0a
MD
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. */
3b3b36dd 630SCM_DEFINE (scm_sys_search_load_path, "%search-load-path", 1, 0, 0,
67e8151b
MG
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.")
1bbd0b84 639#define FUNC_NAME s_scm_sys_search_load_path
04e8fb0a 640{
a6e1e050
AW
641 struct stat stat_buf;
642
a6d9e5ab 643 SCM_VALIDATE_STRING (1, filename);
1bbd0b84 644
a6e1e050
AW
645 return search_path (*scm_loc_load_path, filename, *scm_loc_load_extensions,
646 SCM_BOOL_F, &stat_buf);
04e8fb0a 647}
1bbd0b84 648#undef FUNC_NAME
04e8fb0a
MD
649
650
abca59fe 651/* Return true if COMPILED_FILENAME is newer than source file
a6e1e050 652 FULL_FILENAME, false otherwise. */
1d022387 653static int
a6e1e050
AW
654compiled_is_fresh (SCM full_filename, SCM compiled_filename,
655 struct stat *stat_source, struct stat *stat_compiled)
1d022387 656{
722a4fb9 657 int compiled_is_newer;
a6e1e050 658 struct timespec source_mtime, compiled_mtime;
1d022387 659
a6e1e050
AW
660 source_mtime = get_stat_mtime (stat_source);
661 compiled_mtime = get_stat_mtime (stat_compiled);
fefd60ba 662
a6e1e050
AW
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
1d022387 668 {
a6e1e050
AW
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 ());
1d022387 675 }
abca59fe
LC
676
677 return compiled_is_newer;
1d022387
AW
678}
679
87c595c7 680SCM_KEYWORD (kw_env, "env");
5a79300f
LC
681SCM_KEYWORD (kw_opts, "opts");
682
683SCM_SYMBOL (sym_compile_file, "compile-file");
684SCM_SYMBOL (sym_auto_compilation_options, "%auto-compilation-options");
87c595c7 685
1d022387 686static SCM
6f06e8d3 687do_try_auto_compile (void *data)
1d022387 688{
3c997c4b
AW
689 SCM source = PTR2SCM (data);
690 SCM comp_mod, compile_file;
ee001750
AW
691
692 scm_puts (";;; compiling ", scm_current_error_port ());
3c997c4b 693 scm_display (source, scm_current_error_port ());
ee001750
AW
694 scm_newline (scm_current_error_port ());
695
696 comp_mod = scm_c_resolve_module ("system base compile");
5a79300f 697 compile_file = scm_module_variable (comp_mod, sym_compile_file);
ee001750 698
3c997c4b
AW
699 if (scm_is_true (compile_file))
700 {
87c595c7 701 /* Auto-compile in the context of the current module. */
5a79300f
LC
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
3c997c4b
AW
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 ());
6f06e8d3 730 scm_puts ("\n;;; is part of the compiler; skipping auto-compilation\n",
3c997c4b
AW
731 scm_current_error_port ());
732 return SCM_BOOL_F;
733 }
ee001750
AW
734}
735
736static SCM
6f06e8d3 737auto_compile_catch_handler (void *data, SCM tag, SCM throw_args)
ee001750 738{
3c997c4b 739 SCM source = PTR2SCM (data);
669ea4eb
AW
740 SCM oport, lines;
741
742 oport = scm_open_output_string ();
743 scm_print_exception (oport, SCM_BOOL_F, tag, throw_args);
744
2c27dd57
AW
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 ());
669ea4eb
AW
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 {
2c27dd57
AW
754 scm_puts (";;; ", scm_current_warning_port ());
755 scm_display (scm_car (lines), scm_current_warning_port ());
756 scm_newline (scm_current_warning_port ());
669ea4eb
AW
757 }
758
759 scm_close_port (oport);
760
1d022387
AW
761 return SCM_BOOL_F;
762}
763
6f06e8d3 764SCM_DEFINE (scm_sys_warn_auto_compilation_enabled, "%warn-auto-compilation-enabled", 0, 0, 0,
9591a2b0 765 (void), "")
6f06e8d3 766#define FUNC_NAME s_scm_sys_warn_auto_compilation_enabled
ee001750
AW
767{
768 static int message_shown = 0;
ee001750
AW
769
770 if (!message_shown)
771 {
6f06e8d3
AW
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",
2c27dd57 774 scm_current_warning_port ());
ee001750
AW
775 message_shown = 1;
776 }
777
9591a2b0
AW
778 return SCM_UNSPECIFIED;
779}
15058484 780#undef FUNC_NAME
9591a2b0 781
9591a2b0 782static SCM
6f06e8d3 783scm_try_auto_compile (SCM source)
9591a2b0 784{
6f06e8d3 785 if (scm_is_false (*scm_loc_load_should_auto_compile))
9591a2b0
AW
786 return SCM_BOOL_F;
787
6f06e8d3 788 scm_sys_warn_auto_compilation_enabled ();
ee001750 789 return scm_c_catch (SCM_BOOL_T,
6f06e8d3 790 do_try_auto_compile,
3c997c4b 791 SCM2PTR (source),
6f06e8d3 792 auto_compile_catch_handler,
3c997c4b 793 SCM2PTR (source),
ee001750
AW
794 NULL, NULL);
795}
796
6934d9e7
AW
797/* See also (system base compile):compiled-file-name. */
798static SCM
e4f6e855 799canonical_suffix (SCM fname)
6934d9e7 800{
e4f6e855
AW
801 SCM canon;
802 size_t len;
803
804 canon = scm_canonicalize_path (fname);
805 len = scm_c_string_length (canon);
6934d9e7
AW
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
31ab99de
LC
817SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 0, 0, 1,
818 (SCM args),
67e8151b
MG
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"
0fb81f95
AW
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.")
1bbd0b84 825#define FUNC_NAME s_scm_primitive_load_path
06721500 826{
31ab99de 827 SCM filename, exception_on_not_found;
22f4ee48 828 SCM full_filename, compiled_filename;
628132c5 829 int compiled_is_fallback = 0;
dcada7d8 830 SCM hook = *scm_loc_load_hook;
a6e1e050 831 struct stat stat_source, stat_compiled;
dcada7d8
AW
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);
26544b96 836
31ab99de
LC
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
0fb81f95
AW
860 if (SCM_UNBNDP (exception_on_not_found))
861 exception_on_not_found = SCM_BOOL_T;
26544b96 862
a6e1e050
AW
863 full_filename = search_path (*scm_loc_load_path, filename,
864 *scm_loc_load_extensions, SCM_BOOL_F,
865 &stat_source);
eba5ea7a 866
88cbb421 867 compiled_filename =
a6e1e050
AW
868 search_path (*scm_loc_load_compiled_path, filename,
869 *scm_loc_load_compiled_extensions, SCM_BOOL_T,
870 &stat_compiled);
88cbb421 871
5ea401bf
AW
872 if (scm_is_false (compiled_filename)
873 && scm_is_true (full_filename)
3c997c4b 874 && scm_is_true (*scm_loc_compile_fallback_path)
1e56cff2 875 && scm_is_false (*scm_loc_fresh_auto_compile)
3c997c4b
AW
876 && scm_is_pair (*scm_loc_load_compiled_extensions)
877 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions)))
5ea401bf 878 {
a6e1e050
AW
879 SCM fallback;
880 char *fallback_chars;
881
882 fallback = scm_string_append
3c997c4b 883 (scm_list_3 (*scm_loc_compile_fallback_path,
e4f6e855 884 canonical_suffix (full_filename),
3c997c4b 885 scm_car (*scm_loc_load_compiled_extensions)));
a6e1e050
AW
886
887 fallback_chars = scm_to_locale_string (fallback);
888 if (stat (fallback_chars, &stat_compiled) == 0)
628132c5
AW
889 {
890 compiled_filename = fallback;
891 compiled_is_fallback = 1;
892 }
a6e1e050 893 free (fallback_chars);
5ea401bf
AW
894 }
895
22f4ee48 896 if (scm_is_false (full_filename) && scm_is_false (compiled_filename))
0fb81f95
AW
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 }
22f4ee48 904
dcada7d8
AW
905 if (!scm_is_false (hook))
906 scm_call_1 (hook, (scm_is_true (full_filename)
907 ? full_filename : compiled_filename));
908
1d022387
AW
909 if (scm_is_false (full_filename)
910 || (scm_is_true (compiled_filename)
a6e1e050
AW
911 && compiled_is_fresh (full_filename, compiled_filename,
912 &stat_source, &stat_compiled)))
22f4ee48
AW
913 return scm_load_compiled_with_vm (compiled_filename);
914
628132c5
AW
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)
1e56cff2 920 && scm_is_false (*scm_loc_fresh_auto_compile)
628132c5
AW
921 && scm_is_pair (*scm_loc_load_compiled_extensions)
922 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions)))
923 {
a6e1e050
AW
924 SCM fallback;
925 char *fallback_chars;
926 int stat_ret;
927
928 fallback = scm_string_append
628132c5 929 (scm_list_3 (*scm_loc_compile_fallback_path,
e4f6e855 930 canonical_suffix (full_filename),
628132c5 931 scm_car (*scm_loc_load_compiled_extensions)));
a6e1e050
AW
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))
628132c5 939 {
2c27dd57
AW
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 ());
5950cc3f 943 return scm_load_compiled_with_vm (fallback);
628132c5 944 }
3c997c4b 945 }
628132c5
AW
946
947 /* Otherwise, we bottom out here. */
22f4ee48 948 {
6f06e8d3 949 SCM freshly_compiled = scm_try_auto_compile (full_filename);
22f4ee48 950
628132c5
AW
951 if (scm_is_true (freshly_compiled))
952 return scm_load_compiled_with_vm (freshly_compiled);
22f4ee48 953 else
628132c5 954 return scm_primitive_load (full_filename);
22f4ee48 955 }
06721500 956}
1bbd0b84 957#undef FUNC_NAME
06721500 958
c519b272
MV
959SCM
960scm_c_primitive_load_path (const char *filename)
961{
31ab99de 962 return scm_primitive_load_path (scm_from_locale_string (filename));
c519b272
MV
963}
964
5f161164
AW
965void
966scm_init_eval_in_scheme (void)
967{
968 SCM eval_scm, eval_go;
a6e1e050
AW
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);
5f161164
AW
977
978 if (scm_is_true (eval_scm) && scm_is_true (eval_go)
a6e1e050
AW
979 && compiled_is_fresh (eval_scm, eval_go,
980 &stat_source, &stat_compiled))
5f161164 981 scm_load_compiled_with_vm (eval_go);
ed1bf2c8
AW
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;
5f161164
AW
985}
986
06721500 987\f
e151bee6 988/* Information about the build environment. */
06721500 989
d7a22073
LC
990SCM_VARIABLE_INIT (sys_host_type, "%host-type",
991 scm_from_locale_string (HOST_TYPE));
992
993
e151bee6
JB
994/* Initialize the scheme variable %guile-build-info, based on data
995 provided by the Makefile, via libpath.h. */
996static void
997init_build_info ()
998{
999 static struct { char *name; char *value; } info[] = SCM_BUILD_INFO;
86d31dfe 1000 SCM *loc = SCM_VARIABLE_LOC (scm_c_define ("%guile-build-info", SCM_EOL));
c014a02e 1001 unsigned long i;
e151bee6
JB
1002
1003 for (i = 0; i < (sizeof (info) / sizeof (info[0])); i++)
cc95e00a
MV
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 }
26ac1e3f
AW
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
e151bee6
JB
1024}
1025
e151bee6 1026\f
0f2d19dd
JB
1027void
1028scm_init_load ()
0f2d19dd 1029{
f39448c5 1030 scm_listofnullstr = scm_list_1 (scm_nullstr);
86d31dfe 1031 scm_loc_load_path = SCM_VARIABLE_LOC (scm_c_define ("%load-path", SCM_EOL));
26544b96 1032 scm_loc_load_extensions
86d31dfe 1033 = SCM_VARIABLE_LOC (scm_c_define ("%load-extensions",
cc95e00a
MV
1034 scm_list_2 (scm_from_locale_string (".scm"),
1035 scm_nullstr)));
5b197db8
AW
1036 scm_loc_load_compiled_path
1037 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-path", SCM_EOL));
22f4ee48
AW
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"))));
86d31dfe 1041 scm_loc_load_hook = SCM_VARIABLE_LOC (scm_c_define ("%load-hook", SCM_BOOL_F));
06721500 1042
5ea401bf
AW
1043 scm_loc_compile_fallback_path
1044 = SCM_VARIABLE_LOC (scm_c_define ("%compile-fallback-path", SCM_BOOL_F));
6f06e8d3
AW
1045 scm_loc_load_should_auto_compile
1046 = SCM_VARIABLE_LOC (scm_c_define ("%load-should-auto-compile", SCM_BOOL_F));
1e56cff2
AW
1047 scm_loc_fresh_auto_compile
1048 = SCM_VARIABLE_LOC (scm_c_define ("%fresh-auto-compile", SCM_BOOL_F));
5ea401bf 1049
c81c2ad3 1050 the_reader = scm_make_fluid_with_default (SCM_BOOL_F);
ec3a8ace
NJ
1051 scm_c_define("current-reader", the_reader);
1052
a6029b97
AW
1053 scm_c_define ("load-compiled",
1054 scm_c_make_gsubr ("load-compiled/vm", 1, 0, 0,
1055 scm_load_compiled_with_vm));
1056
e151bee6
JB
1057 init_build_info ();
1058
a0599745 1059#include "libguile/load.x"
0f2d19dd 1060}
89e00824 1061
6128f34c 1062void
6f06e8d3 1063scm_init_load_should_auto_compile ()
6128f34c 1064{
1e56cff2
AW
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 }
6128f34c
AW
1083}
1084
1085
1086
89e00824
ML
1087/*
1088 Local Variables:
1089 c-file-style: "gnu"
1090 End:
1091*/