more care regarding SCM_PACK and SCM_UNPACK
[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;
889975e5 90 char *encoding;
a6d9e5ab 91 SCM_VALIDATE_STRING (1, filename);
bc36d050 92 if (scm_is_true (hook) && scm_is_false (scm_procedure_p (hook)))
2ade72d7
DH
93 SCM_MISC_ERROR ("value of %load-hook is neither a procedure nor #f",
94 SCM_EOL);
26544b96 95
bc36d050 96 if (!scm_is_false (hook))
fdc28395 97 scm_call_1 (hook, filename);
26544b96 98
1bbd0b84 99 { /* scope */
b5623573 100 SCM port = scm_open_file (filename, scm_from_locale_string ("r"));
661ae7ab
MV
101 scm_dynwind_begin (SCM_F_DYNWIND_REWINDABLE);
102 scm_i_dynwind_current_load_port (port);
f8a1c9a8
LC
103
104 encoding = scm_i_scan_for_encoding (port);
889975e5 105 if (encoding)
f8a1c9a8 106 scm_i_set_port_encoding_x (port, encoding);
889975e5 107 else
eb7a16a9
AW
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");
f8a1c9a8 111
b5623573
MV
112 while (1)
113 {
ec3a8ace
NJ
114 SCM reader, form;
115
116 /* Lookup and use the current reader to read the next
117 expression. */
8b039053 118 reader = scm_fluid_ref (the_reader);
ec3a8ace
NJ
119 if (reader == SCM_BOOL_F)
120 form = scm_read (port);
121 else
122 form = scm_call_1 (reader, port);
123
b5623573
MV
124 if (SCM_EOF_OBJECT_P (form))
125 break;
ec3a8ace 126
b5623573
MV
127 scm_primitive_eval_x (form);
128 }
129
661ae7ab 130 scm_dynwind_end ();
0f2d19dd
JB
131 scm_close_port (port);
132 }
b59b97ba 133 return SCM_UNSPECIFIED;
0f2d19dd 134}
1bbd0b84 135#undef FUNC_NAME
0f2d19dd 136
c519b272
MV
137SCM
138scm_c_primitive_load (const char *filename)
139{
cc95e00a 140 return scm_primitive_load (scm_from_locale_string (filename));
c519b272
MV
141}
142
0f2d19dd 143\f
3feedb00
MD
144/* Builtin path to scheme library files. */
145#ifdef SCM_PKGDATA_DIR
a1ec6916 146SCM_DEFINE (scm_sys_package_data_dir, "%package-data-dir", 0, 0, 0,
1bbd0b84 147 (),
b380b885
MD
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}.")
1bbd0b84 151#define FUNC_NAME s_scm_sys_package_data_dir
3feedb00 152{
cc95e00a 153 return scm_from_locale_string (SCM_PKGDATA_DIR);
3feedb00 154}
1bbd0b84 155#undef FUNC_NAME
3feedb00
MD
156#endif /* SCM_PKGDATA_DIR */
157
e8e9b690 158#ifdef SCM_LIBRARY_DIR
a1ec6916 159SCM_DEFINE (scm_sys_library_dir, "%library-dir", 0,0,0,
e8e9b690 160 (),
b380b885
MD
161 "Return the directory where the Guile Scheme library files are installed.\n"
162 "E.g., may return \"/usr/share/guile/1.3.5\".")
e8e9b690
GB
163#define FUNC_NAME s_scm_sys_library_dir
164{
cc95e00a 165 return scm_from_locale_string (SCM_LIBRARY_DIR);
e8e9b690
GB
166}
167#undef FUNC_NAME
168#endif /* SCM_LIBRARY_DIR */
169
170#ifdef SCM_SITE_DIR
a1ec6916 171SCM_DEFINE (scm_sys_site_dir, "%site-dir", 0,0,0,
e8e9b690 172 (),
bc325e76
AW
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 "\".")
e8e9b690
GB
176#define FUNC_NAME s_scm_sys_site_dir
177{
cc95e00a 178 return scm_from_locale_string (SCM_SITE_DIR);
e8e9b690
GB
179}
180#undef FUNC_NAME
181#endif /* SCM_SITE_DIR */
182
bc325e76
AW
183#ifdef SCM_GLOBAL_SITE_DIR
184SCM_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 */
e8e9b690
GB
195
196
3feedb00 197\f
06721500 198/* Initializing the load path, and searching it. */
0f2d19dd 199
26544b96 200/* List of names of directories we search for files to load. */
06721500
JB
201static SCM *scm_loc_load_path;
202
26544b96
JB
203/* List of extensions we try adding to the filenames. */
204static SCM *scm_loc_load_extensions;
205
5b197db8
AW
206/* Like %load-path and %load-extensions, but for compiled files. */
207static SCM *scm_loc_load_compiled_path;
22f4ee48
AW
208static SCM *scm_loc_load_compiled_extensions;
209
ee001750 210/* Whether we should try to auto-compile. */
6f06e8d3 211static SCM *scm_loc_load_should_auto_compile;
01cddfc1 212
1e56cff2
AW
213/* Whether to treat all auto-compiled files as stale. */
214static SCM *scm_loc_fresh_auto_compile;
215
6f06e8d3 216/* The fallback path for auto-compilation */
5ea401bf 217static SCM *scm_loc_compile_fallback_path;
01cddfc1 218
a1ec6916 219SCM_DEFINE (scm_parse_path, "parse-path", 1, 1, 0,
1bbd0b84 220 (SCM path, SCM tail),
d91788cb
MG
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.")
1bbd0b84 225#define FUNC_NAME s_scm_parse_path
04e8fb0a 226{
7d04d68b
MV
227#ifdef __MINGW32__
228 SCM sep = SCM_MAKE_CHAR (';');
229#else
230 SCM sep = SCM_MAKE_CHAR (':');
231#endif
232
04e8fb0a
MD
233 if (SCM_UNBNDP (tail))
234 tail = SCM_EOL;
7888309b 235 return (scm_is_false (path)
04e8fb0a 236 ? tail
7d04d68b 237 : scm_append_x (scm_list_2 (scm_string_split (path, sep), tail)));
04e8fb0a 238}
1bbd0b84 239#undef FUNC_NAME
04e8fb0a
MD
240
241
06721500 242/* Initialize the global variable %load-path, given the value of the
3feedb00 243 SCM_SITE_DIR and SCM_LIBRARY_DIR preprocessor symbols and the
01cddfc1 244 GUILE_LOAD_PATH environment variable. */
0f2d19dd 245void
06721500
JB
246scm_init_load_path ()
247{
11c5e0bf 248 char *env;
06721500 249 SCM path = SCM_EOL;
5b197db8 250 SCM cpath = SCM_EOL;
06721500 251
3feedb00 252#ifdef SCM_LIBRARY_DIR
02b84691
AW
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
bc325e76 261 path = scm_list_4 (scm_from_locale_string (SCM_LIBRARY_DIR),
3c98a49c 262 scm_from_locale_string (SCM_SITE_DIR),
bc325e76 263 scm_from_locale_string (SCM_GLOBAL_SITE_DIR),
02b84691 264 scm_from_locale_string (SCM_PKGDATA_DIR));
5b197db8
AW
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
3c997c4b
AW
273 cpath = scm_cons (scm_from_locale_string (SCM_CCACHE_DIR), cpath);
274
3feedb00 275#endif /* SCM_LIBRARY_DIR */
06721500 276
3c997c4b 277 {
179fe336
AW
278 char cachedir[1024];
279 char *e;
280#ifdef HAVE_GETPWENT
281 struct passwd *pwd;
282#endif
5b197db8 283
6e5c02b8
AW
284#define FALLBACK_DIR \
285 "guile/ccache/" SCM_EFFECTIVE_VERSION "-" SCM_OBJCODE_MACHINE_VERSION_STRING
179fe336
AW
286
287 if ((e = getenv ("XDG_CACHE_HOME")))
48a0fe4d 288 snprintf (cachedir, sizeof(cachedir), "%s/" FALLBACK_DIR, e);
179fe336
AW
289 else if ((e = getenv ("HOME")))
290 snprintf (cachedir, sizeof(cachedir), "%s/.cache/" FALLBACK_DIR, e);
5b197db8 291#ifdef HAVE_GETPWENT
179fe336
AW
292 else if ((pwd = getpwuid (getuid ())) && pwd->pw_dir)
293 snprintf (cachedir, sizeof(cachedir), "%s/.cache/" FALLBACK_DIR,
294 pwd->pw_dir);
5b197db8 295#endif /* HAVE_GETPWENT */
179fe336
AW
296 else
297 cachedir[0] = 0;
298
299 if (cachedir[0])
300 *scm_loc_compile_fallback_path = scm_from_locale_string (cachedir);
3c997c4b 301 }
06721500 302
11c5e0bf
MV
303 env = getenv ("GUILE_LOAD_PATH");
304 if (env)
305 path = scm_parse_path (scm_from_locale_string (env), path);
01cddfc1 306
5b197db8
AW
307 env = getenv ("GUILE_LOAD_COMPILED_PATH");
308 if (env)
309 cpath = scm_parse_path (scm_from_locale_string (env), cpath);
310
06721500 311 *scm_loc_load_path = path;
5b197db8 312 *scm_loc_load_compiled_path = cpath;
06721500
JB
313}
314
04e8fb0a 315SCM scm_listofnullstr;
06721500 316
7d04d68b
MV
317/* Utility functions for assembling C strings in a buffer.
318 */
319
320struct stringbuf {
321 char *buf, *ptr;
322 size_t buf_len;
323};
324
325static void
326stringbuf_free (void *data)
327{
328 struct stringbuf *buf = (struct stringbuf *)data;
329 free (buf->buf);
330}
331
332static void
333stringbuf_grow (struct stringbuf *buf)
334{
335 size_t ptroff = buf->ptr - buf->buf;
336 buf->buf_len *= 2;
7d04d68b
MV
337 buf->buf = scm_realloc (buf->buf, buf->buf_len);
338 buf->ptr = buf->buf + ptroff;
339}
340
341static void
342stringbuf_cat_locale_string (struct stringbuf *buf, SCM str)
343{
344 size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
345 size_t len = scm_to_locale_stringbuf (str, buf->ptr, max_len);
346 if (len > max_len)
347 {
348 /* buffer is too small, double its size and try again.
349 */
350 stringbuf_grow (buf);
351 stringbuf_cat_locale_string (buf, str);
352 }
353 else
354 {
355 /* string fits, terminate it and check for embedded '\0'.
356 */
357 buf->ptr[len] = '\0';
358 if (strlen (buf->ptr) != len)
359 scm_misc_error (NULL,
360 "string contains #\\nul character: ~S",
361 scm_list_1 (str));
362 buf->ptr += len;
363 }
364}
365
366static void
367stringbuf_cat (struct stringbuf *buf, char *str)
368{
369 size_t max_len = buf->buf_len - (buf->ptr - buf->buf) - 1;
370 size_t len = strlen (str);
371 if (len > max_len)
372 {
373 /* buffer is too small, double its size and try again.
374 */
375 stringbuf_grow (buf);
376 stringbuf_cat (buf, str);
377 }
378 else
379 {
380 /* string fits, copy it into buffer.
381 */
382 strcpy (buf->ptr, str);
383 buf->ptr += len;
384 }
385}
386
387
22f4ee48
AW
388static int
389scm_c_string_has_an_ext (char *str, size_t len, SCM extensions)
390{
391 for (; !scm_is_null (extensions); extensions = SCM_CDR (extensions))
392 {
393 char *ext;
394 size_t extlen;
395 int match;
396 ext = scm_to_locale_string (SCM_CAR (extensions));
397 extlen = strlen (ext);
398 match = (len > extlen && str[len - extlen - 1] == '.'
399 && strncmp (str + (len - extlen), ext, extlen) == 0);
400 free (ext);
401 if (match)
402 return 1;
403 }
404 return 0;
405}
406
04e8fb0a 407/* Search PATH for a directory containing a file named FILENAME.
06721500 408 The file must be readable, and not a directory.
26544b96 409 If we find one, return its full filename; otherwise, return #f.
56384176
JB
410 If FILENAME is absolute, return it unchanged.
411 If given, EXTENSIONS is a list of strings; for each directory
412 in PATH, we search for FILENAME concatenated with each EXTENSION. */
88cbb421
LC
413SCM_DEFINE (scm_search_path, "search-path", 2, 0, 1,
414 (SCM path, SCM filename, SCM rest),
d91788cb
MG
415 "Search @var{path} for a directory containing a file named\n"
416 "@var{filename}. The file must be readable, and not a directory.\n"
417 "If we find one, return its full filename; otherwise, return\n"
418 "@code{#f}. If @var{filename} is absolute, return it unchanged.\n"
419 "If given, @var{extensions} is a list of strings; for each\n"
420 "directory in @var{path}, we search for @var{filename}\n"
421 "concatenated with each @var{extension}.")
1bbd0b84 422#define FUNC_NAME s_scm_search_path
06721500 423{
7d04d68b 424 struct stringbuf buf;
56384176 425 char *filename_chars;
7d04d68b 426 size_t filename_len;
88cbb421 427 SCM extensions, require_exts;
7d04d68b 428 SCM result = SCM_BOOL_F;
06721500 429
e29dcaf3 430 if (SCM_UNBNDP (rest) || scm_is_null (rest))
88cbb421
LC
431 {
432 /* Called either by Scheme code that didn't provide the optional
433 arguments, or C code that used the Guile 1.8 signature (2 required,
e29dcaf3
LC
434 1 optional arg) and passed '() or nothing as the EXTENSIONS
435 argument. */
88cbb421
LC
436 extensions = SCM_EOL;
437 require_exts = SCM_UNDEFINED;
438 }
439 else
440 {
441 if (scm_is_null (SCM_CAR (rest)) || scm_is_pair (SCM_CAR (rest)))
442 {
443 /* Called by Scheme code written for 1.9. */
444 extensions = SCM_CAR (rest);
445 if (scm_is_null (SCM_CDR (rest)))
446 require_exts = SCM_UNDEFINED;
447 else
448 {
449 require_exts = SCM_CADR (rest);
450 if (SCM_UNLIKELY (!scm_is_null (SCM_CDDR (rest))))
451 scm_wrong_num_args (scm_from_locale_string (FUNC_NAME));
452 }
453 }
454 else
455 {
456 /* Called by C code that uses the 1.8 signature, i.e., which
457 expects the 3rd argument to be EXTENSIONS. */
458 extensions = rest;
459 require_exts = SCM_UNDEFINED;
460 }
461 }
462
04e8fb0a 463 if (SCM_UNBNDP (extensions))
56384176 464 extensions = SCM_EOL;
56384176 465
88cbb421
LC
466 SCM_VALIDATE_LIST (3, extensions);
467
22f4ee48
AW
468 if (SCM_UNBNDP (require_exts))
469 require_exts = SCM_BOOL_F;
470
661ae7ab 471 scm_dynwind_begin (0);
7d04d68b
MV
472
473 filename_chars = scm_to_locale_string (filename);
474 filename_len = strlen (filename_chars);
661ae7ab 475 scm_dynwind_free (filename_chars);
06721500 476
26544b96 477 /* If FILENAME is absolute, return it unchanged. */
2e945bcc
SJ
478#ifdef __MINGW32__
479 if (((filename_len >= 1) &&
480 (filename_chars[0] == '/' || filename_chars[0] == '\\')) ||
481 ((filename_len >= 3) && filename_chars[1] == ':' &&
482 ((filename_chars[0] >= 'a' && filename_chars[0] <= 'z') ||
483 (filename_chars[0] >= 'A' && filename_chars[0] <= 'Z')) &&
484 (filename_chars[2] == '/' || filename_chars[2] == '\\')))
485#else
56384176 486 if (filename_len >= 1 && filename_chars[0] == '/')
2e945bcc 487#endif
7d04d68b 488 {
22f4ee48
AW
489 SCM res = filename;
490 if (scm_is_true (require_exts) &&
491 !scm_c_string_has_an_ext (filename_chars, filename_len,
492 extensions))
493 res = SCM_BOOL_F;
494
661ae7ab 495 scm_dynwind_end ();
22f4ee48 496 return res;
7d04d68b 497 }
26544b96 498
56384176
JB
499 /* If FILENAME has an extension, don't try to add EXTENSIONS to it. */
500 {
501 char *endp;
502
503 for (endp = filename_chars + filename_len - 1;
504 endp >= filename_chars;
505 endp--)
506 {
507 if (*endp == '.')
508 {
22f4ee48
AW
509 if (scm_is_true (require_exts) &&
510 !scm_c_string_has_an_ext (filename_chars, filename_len,
511 extensions))
512 {
513 /* This filename has an extension, but not one of the right
514 ones... */
515 scm_dynwind_end ();
516 return SCM_BOOL_F;
517 }
56384176
JB
518 /* This filename already has an extension, so cancel the
519 list of extensions. */
520 extensions = SCM_EOL;
521 break;
522 }
2e945bcc
SJ
523#ifdef __MINGW32__
524 else if (*endp == '/' || *endp == '\\')
525#else
56384176 526 else if (*endp == '/')
2e945bcc 527#endif
56384176
JB
528 /* This filename has no extension, so keep the current list
529 of extensions. */
530 break;
531 }
532 }
533
7d04d68b
MV
534 /* This simplifies the loop below a bit.
535 */
d2e53ed6 536 if (scm_is_null (extensions))
7d04d68b 537 extensions = scm_listofnullstr;
06721500 538
7d04d68b
MV
539 buf.buf_len = 512;
540 buf.buf = scm_malloc (buf.buf_len);
661ae7ab 541 scm_dynwind_unwind_handler (stringbuf_free, &buf, SCM_F_WIND_EXPLICITLY);
0a74e31d 542
7d04d68b
MV
543 /* Try every path element.
544 */
d2e53ed6 545 for (; scm_is_pair (path); path = SCM_CDR (path))
7d04d68b
MV
546 {
547 SCM dir = SCM_CAR (path);
548 SCM exts;
549 size_t sans_ext_len;
550
551 buf.ptr = buf.buf;
552 stringbuf_cat_locale_string (&buf, dir);
553
554 /* Concatenate the path name and the filename. */
555
2e945bcc 556#ifdef __MINGW32__
5a6d139b 557 if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/') && (buf.ptr[-1] != '\\'))
2e945bcc 558#else
5a6d139b 559 if ((buf.ptr > buf.buf) && (buf.ptr[-1] != '/'))
2e945bcc 560#endif
7d04d68b
MV
561 stringbuf_cat (&buf, "/");
562
563 stringbuf_cat (&buf, filename_chars);
564 sans_ext_len = buf.ptr - buf.buf;
565
566 /* Try every extension. */
d2e53ed6 567 for (exts = extensions; scm_is_pair (exts); exts = SCM_CDR (exts))
7d04d68b
MV
568 {
569 SCM ext = SCM_CAR (exts);
570 struct stat mode;
571
572 buf.ptr = buf.buf + sans_ext_len;
573 stringbuf_cat_locale_string (&buf, ext);
574
575 /* If the file exists at all, we should return it. If the
576 file is inaccessible, then that's an error. */
577
7d04d68b
MV
578 if (stat (buf.buf, &mode) == 0
579 && ! (mode.st_mode & S_IFDIR))
580 {
581 result = scm_from_locale_string (buf.buf);
582 goto end;
583 }
584 }
585
586 if (!SCM_NULL_OR_NIL_P (exts))
587 scm_wrong_type_arg_msg (NULL, 0, extensions, "proper list");
588 }
56384176 589
7d04d68b
MV
590 if (!SCM_NULL_OR_NIL_P (path))
591 scm_wrong_type_arg_msg (NULL, 0, path, "proper list");
56384176 592
7d04d68b 593 end:
661ae7ab 594 scm_dynwind_end ();
7d04d68b 595 return result;
06721500 596}
1bbd0b84 597#undef FUNC_NAME
06721500
JB
598
599
04e8fb0a
MD
600/* Search %load-path for a directory containing a file named FILENAME.
601 The file must be readable, and not a directory.
602 If we find one, return its full filename; otherwise, return #f.
603 If FILENAME is absolute, return it unchanged. */
3b3b36dd 604SCM_DEFINE (scm_sys_search_load_path, "%search-load-path", 1, 0, 0,
67e8151b
MG
605 (SCM filename),
606 "Search @var{%load-path} for the file named @var{filename},\n"
607 "which must be readable by the current user. If @var{filename}\n"
608 "is found in the list of paths to search or is an absolute\n"
609 "pathname, return its full pathname. Otherwise, return\n"
610 "@code{#f}. Filenames may have any of the optional extensions\n"
611 "in the @code{%load-extensions} list; @code{%search-load-path}\n"
612 "will try each extension automatically.")
1bbd0b84 613#define FUNC_NAME s_scm_sys_search_load_path
04e8fb0a
MD
614{
615 SCM path = *scm_loc_load_path;
616 SCM exts = *scm_loc_load_extensions;
a6d9e5ab 617 SCM_VALIDATE_STRING (1, filename);
1bbd0b84 618
2ade72d7
DH
619 if (scm_ilength (path) < 0)
620 SCM_MISC_ERROR ("%load-path is not a proper list", SCM_EOL);
621 if (scm_ilength (exts) < 0)
622 SCM_MISC_ERROR ("%load-extension list is not a proper list", SCM_EOL);
88cbb421 623 return scm_search_path (path, filename, exts);
04e8fb0a 624}
1bbd0b84 625#undef FUNC_NAME
04e8fb0a
MD
626
627
abca59fe
LC
628/* Return true if COMPILED_FILENAME is newer than source file
629 FULL_FILENAME, false otherwise. Also return false if one of the
630 files cannot be stat'd. */
1d022387 631static int
535fb833 632compiled_is_fresh (SCM full_filename, SCM compiled_filename)
1d022387
AW
633{
634 char *source, *compiled;
635 struct stat stat_source, stat_compiled;
722a4fb9 636 int compiled_is_newer;
1d022387
AW
637
638 source = scm_to_locale_string (full_filename);
639 compiled = scm_to_locale_string (compiled_filename);
fefd60ba 640
1d022387 641 if (stat (source, &stat_source) == 0
abca59fe 642 && stat (compiled, &stat_compiled) == 0)
1d022387 643 {
abca59fe
LC
644 struct timespec source_mtime, compiled_mtime;
645
646 source_mtime = get_stat_mtime (&stat_source);
647 compiled_mtime = get_stat_mtime (&stat_compiled);
648
649 if (source_mtime.tv_sec < compiled_mtime.tv_sec
650 || (source_mtime.tv_sec == compiled_mtime.tv_sec
651 && source_mtime.tv_nsec <= compiled_mtime.tv_nsec))
652 compiled_is_newer = 1;
722a4fb9
LC
653 else
654 {
655 compiled_is_newer = 0;
656 scm_puts (";;; note: source file ", scm_current_error_port ());
657 scm_puts (source, scm_current_error_port ());
658 scm_puts ("\n;;; newer than compiled ", scm_current_error_port ());
659 scm_puts (compiled, scm_current_error_port ());
660 scm_puts ("\n", scm_current_error_port ());
661 }
1d022387 662 }
722a4fb9
LC
663 else
664 /* At least one of the files isn't accessible. */
665 compiled_is_newer = 0;
3c997c4b 666
1d022387
AW
667 free (source);
668 free (compiled);
abca59fe
LC
669
670 return compiled_is_newer;
1d022387
AW
671}
672
87c595c7 673SCM_KEYWORD (kw_env, "env");
5a79300f
LC
674SCM_KEYWORD (kw_opts, "opts");
675
676SCM_SYMBOL (sym_compile_file, "compile-file");
677SCM_SYMBOL (sym_auto_compilation_options, "%auto-compilation-options");
87c595c7 678
1d022387 679static SCM
6f06e8d3 680do_try_auto_compile (void *data)
1d022387 681{
3c997c4b
AW
682 SCM source = PTR2SCM (data);
683 SCM comp_mod, compile_file;
ee001750
AW
684
685 scm_puts (";;; compiling ", scm_current_error_port ());
3c997c4b 686 scm_display (source, scm_current_error_port ());
ee001750
AW
687 scm_newline (scm_current_error_port ());
688
689 comp_mod = scm_c_resolve_module ("system base compile");
5a79300f 690 compile_file = scm_module_variable (comp_mod, sym_compile_file);
ee001750 691
3c997c4b
AW
692 if (scm_is_true (compile_file))
693 {
87c595c7 694 /* Auto-compile in the context of the current module. */
5a79300f
LC
695 SCM res, opts;
696 SCM args[5];
697
698 opts = scm_module_variable (scm_the_root_module (),
699 sym_auto_compilation_options);
700 if (SCM_VARIABLEP (opts))
701 opts = SCM_VARIABLE_REF (opts);
702 else
703 opts = SCM_EOL;
704
705 args[0] = source;
706 args[1] = kw_opts;
707 args[2] = opts;
708 args[3] = kw_env;
709 args[4] = scm_current_module ();
710
711 /* Assume `*current-warning-prefix*' has an appropriate value. */
712 res = scm_call_n (scm_variable_ref (compile_file), args, 5);
713
3c997c4b
AW
714 scm_puts (";;; compiled ", scm_current_error_port ());
715 scm_display (res, scm_current_error_port ());
716 scm_newline (scm_current_error_port ());
717 return res;
718 }
719 else
720 {
721 scm_puts (";;; it seems ", scm_current_error_port ());
722 scm_display (source, scm_current_error_port ());
6f06e8d3 723 scm_puts ("\n;;; is part of the compiler; skipping auto-compilation\n",
3c997c4b
AW
724 scm_current_error_port ());
725 return SCM_BOOL_F;
726 }
ee001750
AW
727}
728
729static SCM
6f06e8d3 730auto_compile_catch_handler (void *data, SCM tag, SCM throw_args)
ee001750 731{
3c997c4b 732 SCM source = PTR2SCM (data);
ee001750 733 scm_puts (";;; WARNING: compilation of ", scm_current_error_port ());
3c997c4b 734 scm_display (source, scm_current_error_port ());
6fd367e7 735 scm_puts (" failed:\n", scm_current_error_port ());
ee001750
AW
736 scm_puts (";;; key ", scm_current_error_port ());
737 scm_write (tag, scm_current_error_port ());
738 scm_puts (", throw args ", scm_current_error_port ());
739 scm_write (throw_args, scm_current_error_port ());
740 scm_newline (scm_current_error_port ());
1d022387
AW
741 return SCM_BOOL_F;
742}
743
6f06e8d3 744SCM_DEFINE (scm_sys_warn_auto_compilation_enabled, "%warn-auto-compilation-enabled", 0, 0, 0,
9591a2b0 745 (void), "")
6f06e8d3 746#define FUNC_NAME s_scm_sys_warn_auto_compilation_enabled
ee001750
AW
747{
748 static int message_shown = 0;
ee001750
AW
749
750 if (!message_shown)
751 {
6f06e8d3
AW
752 scm_puts (";;; note: auto-compilation is enabled, set GUILE_AUTO_COMPILE=0\n"
753 ";;; or pass the --no-auto-compile argument to disable.\n",
ee001750
AW
754 scm_current_error_port ());
755 message_shown = 1;
756 }
757
9591a2b0
AW
758 return SCM_UNSPECIFIED;
759}
15058484 760#undef FUNC_NAME
9591a2b0 761
9591a2b0 762static SCM
6f06e8d3 763scm_try_auto_compile (SCM source)
9591a2b0 764{
6f06e8d3 765 if (scm_is_false (*scm_loc_load_should_auto_compile))
9591a2b0
AW
766 return SCM_BOOL_F;
767
6f06e8d3 768 scm_sys_warn_auto_compilation_enabled ();
ee001750 769 return scm_c_catch (SCM_BOOL_T,
6f06e8d3 770 do_try_auto_compile,
3c997c4b 771 SCM2PTR (source),
6f06e8d3 772 auto_compile_catch_handler,
3c997c4b 773 SCM2PTR (source),
ee001750
AW
774 NULL, NULL);
775}
776
31ab99de
LC
777SCM_DEFINE (scm_primitive_load_path, "primitive-load-path", 0, 0, 1,
778 (SCM args),
67e8151b
MG
779 "Search @var{%load-path} for the file named @var{filename} and\n"
780 "load it into the top-level environment. If @var{filename} is a\n"
781 "relative pathname and is not found in the list of search paths,\n"
0fb81f95
AW
782 "an error is signalled, unless the optional argument\n"
783 "@var{exception_on_not_found} is @code{#f}, in which case\n"
784 "@code{#f} is returned instead.")
1bbd0b84 785#define FUNC_NAME s_scm_primitive_load_path
06721500 786{
31ab99de 787 SCM filename, exception_on_not_found;
22f4ee48 788 SCM full_filename, compiled_filename;
628132c5 789 int compiled_is_fallback = 0;
26544b96 790
31ab99de
LC
791 if (scm_is_string (args))
792 {
793 /* C code written for 1.8 and earlier expects this function to take a
794 single argument (the file name). */
795 filename = args;
796 exception_on_not_found = SCM_UNDEFINED;
797 }
798 else
799 {
800 /* Starting from 1.9, this function takes 1 required and 1 optional
801 argument. */
802 long len;
803
804 SCM_VALIDATE_LIST_COPYLEN (SCM_ARG1, args, len);
805 if (len < 1 || len > 2)
806 scm_error_num_args_subr (FUNC_NAME);
807
808 filename = SCM_CAR (args);
809 SCM_VALIDATE_STRING (SCM_ARG1, filename);
810
811 exception_on_not_found = len > 1 ? SCM_CADR (args) : SCM_UNDEFINED;
812 }
813
0fb81f95
AW
814 if (SCM_UNBNDP (exception_on_not_found))
815 exception_on_not_found = SCM_BOOL_T;
26544b96 816
26544b96 817 full_filename = scm_sys_search_load_path (filename);
eba5ea7a
LC
818 if (scm_is_string (full_filename))
819 full_filename = scm_canonicalize_path (full_filename);
820
88cbb421
LC
821 compiled_filename =
822 scm_search_path (*scm_loc_load_compiled_path,
823 filename,
824 scm_list_2 (*scm_loc_load_compiled_extensions,
825 SCM_BOOL_T));
826
5ea401bf
AW
827 if (scm_is_false (compiled_filename)
828 && scm_is_true (full_filename)
3c997c4b 829 && scm_is_true (*scm_loc_compile_fallback_path)
1e56cff2 830 && scm_is_false (*scm_loc_fresh_auto_compile)
3c997c4b
AW
831 && scm_is_pair (*scm_loc_load_compiled_extensions)
832 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions)))
5ea401bf 833 {
3c997c4b
AW
834 SCM fallback = scm_string_append
835 (scm_list_3 (*scm_loc_compile_fallback_path,
836 full_filename,
837 scm_car (*scm_loc_load_compiled_extensions)));
838 if (scm_is_true (scm_stat (fallback, SCM_BOOL_F)))
628132c5
AW
839 {
840 compiled_filename = fallback;
841 compiled_is_fallback = 1;
842 }
5ea401bf
AW
843 }
844
22f4ee48 845 if (scm_is_false (full_filename) && scm_is_false (compiled_filename))
0fb81f95
AW
846 {
847 if (scm_is_true (exception_on_not_found))
848 SCM_MISC_ERROR ("Unable to find file ~S in load path",
849 scm_list_1 (filename));
850 else
851 return SCM_BOOL_F;
852 }
22f4ee48 853
1d022387
AW
854 if (scm_is_false (full_filename)
855 || (scm_is_true (compiled_filename)
535fb833 856 && compiled_is_fresh (full_filename, compiled_filename)))
22f4ee48
AW
857 return scm_load_compiled_with_vm (compiled_filename);
858
628132c5
AW
859 /* Perhaps there was the installed .go that was stale, but our fallback is
860 fresh. Let's try that. Duplicating code, but perhaps that's OK. */
861
862 if (!compiled_is_fallback
863 && scm_is_true (*scm_loc_compile_fallback_path)
1e56cff2 864 && scm_is_false (*scm_loc_fresh_auto_compile)
628132c5
AW
865 && scm_is_pair (*scm_loc_load_compiled_extensions)
866 && scm_is_string (scm_car (*scm_loc_load_compiled_extensions)))
867 {
868 SCM fallback = scm_string_append
869 (scm_list_3 (*scm_loc_compile_fallback_path,
870 full_filename,
871 scm_car (*scm_loc_load_compiled_extensions)));
872 if (scm_is_true (scm_stat (fallback, SCM_BOOL_F))
535fb833 873 && compiled_is_fresh (full_filename, fallback))
628132c5
AW
874 {
875 scm_puts (";;; found fresh local cache at ", scm_current_error_port ());
876 scm_display (fallback, scm_current_error_port ());
877 scm_newline (scm_current_error_port ());
5950cc3f 878 return scm_load_compiled_with_vm (fallback);
628132c5 879 }
3c997c4b 880 }
628132c5
AW
881
882 /* Otherwise, we bottom out here. */
22f4ee48 883 {
6f06e8d3 884 SCM freshly_compiled = scm_try_auto_compile (full_filename);
22f4ee48 885
628132c5
AW
886 if (scm_is_true (freshly_compiled))
887 return scm_load_compiled_with_vm (freshly_compiled);
22f4ee48 888 else
628132c5 889 return scm_primitive_load (full_filename);
22f4ee48 890 }
06721500 891}
1bbd0b84 892#undef FUNC_NAME
06721500 893
c519b272
MV
894SCM
895scm_c_primitive_load_path (const char *filename)
896{
31ab99de 897 return scm_primitive_load_path (scm_from_locale_string (filename));
c519b272
MV
898}
899
5f161164
AW
900void
901scm_init_eval_in_scheme (void)
902{
903 SCM eval_scm, eval_go;
904 eval_scm = scm_search_path (*scm_loc_load_path,
905 scm_from_locale_string ("ice-9/eval.scm"),
906 SCM_EOL);
907 eval_go = scm_search_path (*scm_loc_load_compiled_path,
908 scm_from_locale_string ("ice-9/eval.go"),
909 SCM_EOL);
910
911 if (scm_is_true (eval_scm) && scm_is_true (eval_go)
912 && compiled_is_fresh (eval_scm, eval_go))
913 scm_load_compiled_with_vm (eval_go);
ed1bf2c8
AW
914 else
915 /* if we have no eval.go, we shouldn't load any compiled code at all */
916 *scm_loc_load_compiled_path = SCM_EOL;
5f161164
AW
917}
918
06721500 919\f
e151bee6 920/* Information about the build environment. */
06721500 921
d7a22073
LC
922SCM_VARIABLE_INIT (sys_host_type, "%host-type",
923 scm_from_locale_string (HOST_TYPE));
924
925
e151bee6
JB
926/* Initialize the scheme variable %guile-build-info, based on data
927 provided by the Makefile, via libpath.h. */
928static void
929init_build_info ()
930{
931 static struct { char *name; char *value; } info[] = SCM_BUILD_INFO;
86d31dfe 932 SCM *loc = SCM_VARIABLE_LOC (scm_c_define ("%guile-build-info", SCM_EOL));
c014a02e 933 unsigned long i;
e151bee6
JB
934
935 for (i = 0; i < (sizeof (info) / sizeof (info[0])); i++)
cc95e00a
MV
936 {
937 SCM key = scm_from_locale_symbol (info[i].name);
938 SCM val = scm_from_locale_string (info[i].value);
939 *loc = scm_acons (key, val, *loc);
940 }
26ac1e3f
AW
941#ifdef PACKAGE_PACKAGER
942 *loc = scm_acons (scm_from_latin1_symbol ("packager"),
943 scm_from_latin1_string (PACKAGE_PACKAGER),
944 *loc);
945#endif
946#ifdef PACKAGE_PACKAGER_VERSION
947 *loc = scm_acons (scm_from_latin1_symbol ("packager-version"),
948 scm_from_latin1_string (PACKAGE_PACKAGER_VERSION),
949 *loc);
950#endif
951#ifdef PACKAGE_PACKAGER_BUG_REPORTS
952 *loc = scm_acons (scm_from_latin1_symbol ("packager-bug-reports"),
953 scm_from_latin1_string (PACKAGE_PACKAGER_BUG_REPORTS),
954 *loc);
955#endif
e151bee6
JB
956}
957
e151bee6 958\f
0f2d19dd
JB
959void
960scm_init_load ()
0f2d19dd 961{
f39448c5 962 scm_listofnullstr = scm_list_1 (scm_nullstr);
86d31dfe 963 scm_loc_load_path = SCM_VARIABLE_LOC (scm_c_define ("%load-path", SCM_EOL));
26544b96 964 scm_loc_load_extensions
86d31dfe 965 = SCM_VARIABLE_LOC (scm_c_define ("%load-extensions",
cc95e00a
MV
966 scm_list_2 (scm_from_locale_string (".scm"),
967 scm_nullstr)));
5b197db8
AW
968 scm_loc_load_compiled_path
969 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-path", SCM_EOL));
22f4ee48
AW
970 scm_loc_load_compiled_extensions
971 = SCM_VARIABLE_LOC (scm_c_define ("%load-compiled-extensions",
972 scm_list_1 (scm_from_locale_string (".go"))));
86d31dfe 973 scm_loc_load_hook = SCM_VARIABLE_LOC (scm_c_define ("%load-hook", SCM_BOOL_F));
06721500 974
5ea401bf
AW
975 scm_loc_compile_fallback_path
976 = SCM_VARIABLE_LOC (scm_c_define ("%compile-fallback-path", SCM_BOOL_F));
6f06e8d3
AW
977 scm_loc_load_should_auto_compile
978 = SCM_VARIABLE_LOC (scm_c_define ("%load-should-auto-compile", SCM_BOOL_F));
1e56cff2
AW
979 scm_loc_fresh_auto_compile
980 = SCM_VARIABLE_LOC (scm_c_define ("%fresh-auto-compile", SCM_BOOL_F));
5ea401bf 981
ec3a8ace 982 the_reader = scm_make_fluid ();
8b039053 983 scm_fluid_set_x (the_reader, SCM_BOOL_F);
ec3a8ace
NJ
984 scm_c_define("current-reader", the_reader);
985
a6029b97
AW
986 scm_c_define ("load-compiled",
987 scm_c_make_gsubr ("load-compiled/vm", 1, 0, 0,
988 scm_load_compiled_with_vm));
989
e151bee6
JB
990 init_build_info ();
991
a0599745 992#include "libguile/load.x"
0f2d19dd 993}
89e00824 994
6128f34c 995void
6f06e8d3 996scm_init_load_should_auto_compile ()
6128f34c 997{
1e56cff2
AW
998 char *auto_compile = getenv ("GUILE_AUTO_COMPILE");
999
1000 if (auto_compile && strcmp (auto_compile, "0") == 0)
1001 {
1002 *scm_loc_load_should_auto_compile = SCM_BOOL_F;
1003 *scm_loc_fresh_auto_compile = SCM_BOOL_F;
1004 }
1005 /* Allow "freshen" also. */
1006 else if (auto_compile && strncmp (auto_compile, "fresh", 5) == 0)
1007 {
1008 *scm_loc_load_should_auto_compile = SCM_BOOL_T;
1009 *scm_loc_fresh_auto_compile = SCM_BOOL_T;
1010 }
1011 else
1012 {
1013 *scm_loc_load_should_auto_compile = SCM_BOOL_T;
1014 *scm_loc_fresh_auto_compile = SCM_BOOL_F;
1015 }
6128f34c
AW
1016}
1017
1018
1019
89e00824
ML
1020/*
1021 Local Variables:
1022 c-file-style: "gnu"
1023 End:
1024*/