1 /* Copyright (C) 1998,2000,2001,2002, 2003, 2004, 2006 Free Software Foundation, Inc.
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 #include "libguile/_scm.h"
25 #include "libguile/eval.h"
26 #include "libguile/smob.h"
27 #include "libguile/procprop.h"
28 #include "libguile/vectors.h"
29 #include "libguile/hashtab.h"
30 #include "libguile/struct.h"
31 #include "libguile/variable.h"
32 #include "libguile/fluids.h"
33 #include "libguile/deprecation.h"
35 #include "libguile/modules.h"
37 int scm_module_system_booted_p
= 0;
39 scm_t_bits scm_module_tag
;
41 static SCM the_module
;
43 SCM_DEFINE (scm_current_module
, "current-module", 0, 0, 0,
45 "Return the current module.")
46 #define FUNC_NAME s_scm_current_module
48 return scm_fluid_ref (the_module
);
52 static void scm_post_boot_init_modules (void);
54 SCM_DEFINE (scm_set_current_module
, "set-current-module", 1, 0, 0,
56 "Set the current module to @var{module} and return\n"
57 "the previous current module.")
58 #define FUNC_NAME s_scm_set_current_module
62 if (!scm_module_system_booted_p
)
63 scm_post_boot_init_modules ();
65 SCM_VALIDATE_MODULE (SCM_ARG1
, module
);
67 old
= scm_current_module ();
68 scm_fluid_set_x (the_module
, module
);
74 SCM_DEFINE (scm_interaction_environment
, "interaction-environment", 0, 0, 0,
76 "Return a specifier for the environment that contains\n"
77 "implementation--defined bindings, typically a superset of those\n"
78 "listed in the report. The intent is that this procedure will\n"
79 "return the environment in which the implementation would\n"
80 "evaluate expressions dynamically typed by the user.")
81 #define FUNC_NAME s_scm_interaction_environment
83 return scm_current_module ();
88 scm_c_call_with_current_module (SCM module
,
89 SCM (*func
)(void *), void *data
)
91 return scm_c_with_fluid (the_module
, module
, func
, data
);
95 scm_dynwind_current_module (SCM module
)
97 scm_dynwind_fluid (the_module
, module
);
101 convert "A B C" to scheme list (A B C)
104 convert_module_name (const char *name
)
115 while (*ptr
&& *ptr
!= ' ')
119 SCM sym
= scm_from_locale_symboln (name
, ptr
-name
);
120 *tail
= scm_cons (sym
, SCM_EOL
);
121 tail
= SCM_CDRLOC (*tail
);
129 static SCM process_define_module_var
;
130 static SCM process_use_modules_var
;
131 static SCM resolve_module_var
;
134 scm_c_resolve_module (const char *name
)
136 return scm_resolve_module (convert_module_name (name
));
140 scm_resolve_module (SCM name
)
142 return scm_call_1 (SCM_VARIABLE_REF (resolve_module_var
), name
);
146 scm_c_define_module (const char *name
,
147 void (*init
)(void *), void *data
)
149 SCM module
= scm_call_1 (SCM_VARIABLE_REF (process_define_module_var
),
150 scm_list_1 (convert_module_name (name
)));
152 scm_c_call_with_current_module (module
, (SCM (*)(void*))init
, data
);
157 scm_c_use_module (const char *name
)
159 scm_call_1 (SCM_VARIABLE_REF (process_use_modules_var
),
160 scm_list_1 (scm_list_1 (convert_module_name (name
))));
163 static SCM module_export_x_var
;
167 TODO: should export this function? --hwn.
170 scm_export (SCM module
, SCM namelist
)
172 return scm_call_2 (SCM_VARIABLE_REF (module_export_x_var
),
178 @code{scm_c_export}(@var{name-list})
180 @code{scm_c_export} exports the named bindings from the current
181 module, making them visible to users of the module. This function
182 takes a list of string arguments, terminated by NULL, e.g.
185 scm_c_export ("add-double-record", "bamboozle-money", NULL);
189 scm_c_export (const char *name
, ...)
194 SCM names
= scm_cons (scm_from_locale_symbol (name
), SCM_EOL
);
195 SCM
*tail
= SCM_CDRLOC (names
);
199 const char *n
= va_arg (ap
, const char *);
202 *tail
= scm_cons (scm_from_locale_symbol (n
), SCM_EOL
);
203 tail
= SCM_CDRLOC (*tail
);
206 scm_export (scm_current_module(), names
);
214 scm_top_level_env (SCM thunk
)
219 return scm_cons (thunk
, SCM_EOL
);
223 scm_env_top_level (SCM env
)
225 while (scm_is_pair (env
))
227 SCM car_env
= SCM_CAR (env
);
228 if (!scm_is_pair (car_env
) && scm_is_true (scm_procedure_p (car_env
)))
235 SCM_SYMBOL (sym_module
, "module");
237 static SCM the_root_module_var
;
242 if (scm_module_system_booted_p
)
243 return SCM_VARIABLE_REF (the_root_module_var
);
249 scm_lookup_closure_module (SCM proc
)
251 if (scm_is_false (proc
))
252 return the_root_module ();
253 else if (SCM_EVAL_CLOSURE_P (proc
))
254 return SCM_PACK (SCM_SMOB_DATA (proc
));
257 SCM mod
= scm_procedure_property (proc
, sym_module
);
258 if (scm_is_false (mod
))
259 mod
= the_root_module ();
264 SCM_DEFINE (scm_env_module
, "env-module", 1, 0, 0,
266 "Return the module of @var{ENV}, a lexical environment.")
267 #define FUNC_NAME s_scm_env_module
269 return scm_lookup_closure_module (scm_env_top_level (env
));
274 * C level implementation of the standard eval closure
276 * This increases loading speed substantially.
277 * The code will be replaced by the low-level environments in next release.
280 static SCM module_make_local_var_x_var
;
283 module_variable (SCM module
, SCM sym
)
285 #define SCM_BOUND_THING_P(b) \
288 /* 1. Check module obarray */
289 SCM b
= scm_hashq_ref (SCM_MODULE_OBARRAY (module
), sym
, SCM_UNDEFINED
);
290 if (SCM_BOUND_THING_P (b
))
293 SCM binder
= SCM_MODULE_BINDER (module
);
294 if (scm_is_true (binder
))
295 /* 2. Custom binder */
297 b
= scm_call_3 (binder
, module
, sym
, SCM_BOOL_F
);
298 if (SCM_BOUND_THING_P (b
))
303 /* 3. Search the use list */
304 SCM uses
= SCM_MODULE_USES (module
);
305 while (scm_is_pair (uses
))
307 b
= module_variable (SCM_CAR (uses
), sym
);
308 if (SCM_BOUND_THING_P (b
))
310 uses
= SCM_CDR (uses
);
314 #undef SCM_BOUND_THING_P
317 scm_t_bits scm_tc16_eval_closure
;
319 #define SCM_F_EVAL_CLOSURE_INTERFACE (1<<16)
320 #define SCM_EVAL_CLOSURE_INTERFACE_P(e) \
321 (SCM_CELL_WORD_0 (e) & SCM_F_EVAL_CLOSURE_INTERFACE)
323 /* NOTE: This function may be called by a smob application
324 or from another C function directly. */
326 scm_eval_closure_lookup (SCM eclo
, SCM sym
, SCM definep
)
328 SCM module
= SCM_PACK (SCM_SMOB_DATA (eclo
));
329 if (scm_is_true (definep
))
331 if (SCM_EVAL_CLOSURE_INTERFACE_P (eclo
))
333 return scm_call_2 (SCM_VARIABLE_REF (module_make_local_var_x_var
),
337 return module_variable (module
, sym
);
340 SCM_DEFINE (scm_standard_eval_closure
, "standard-eval-closure", 1, 0, 0,
342 "Return an eval closure for the module @var{module}.")
343 #define FUNC_NAME s_scm_standard_eval_closure
345 SCM_RETURN_NEWSMOB (scm_tc16_eval_closure
, SCM_UNPACK (module
));
350 SCM_DEFINE (scm_standard_interface_eval_closure
,
351 "standard-interface-eval-closure", 1, 0, 0,
353 "Return a interface eval closure for the module @var{module}. "
354 "Such a closure does not allow new bindings to be added.")
355 #define FUNC_NAME s_scm_standard_interface_eval_closure
357 SCM_RETURN_NEWSMOB (scm_tc16_eval_closure
| SCM_F_EVAL_CLOSURE_INTERFACE
,
358 SCM_UNPACK (module
));
363 scm_module_lookup_closure (SCM module
)
365 if (scm_is_false (module
))
368 return SCM_MODULE_EVAL_CLOSURE (module
);
372 scm_current_module_lookup_closure ()
374 if (scm_module_system_booted_p
)
375 return scm_module_lookup_closure (scm_current_module ());
381 scm_module_transformer (SCM module
)
383 if (scm_is_false (module
))
386 return SCM_MODULE_TRANSFORMER (module
);
390 scm_current_module_transformer ()
392 if (scm_module_system_booted_p
)
393 return scm_module_transformer (scm_current_module ());
398 SCM_DEFINE (scm_module_import_interface
, "module-import-interface", 2, 0, 0,
399 (SCM module
, SCM sym
),
401 #define FUNC_NAME s_scm_module_import_interface
403 #define SCM_BOUND_THING_P(b) (scm_is_true (b))
405 SCM_VALIDATE_MODULE (SCM_ARG1
, module
);
406 /* Search the use list */
407 uses
= SCM_MODULE_USES (module
);
408 while (scm_is_pair (uses
))
410 SCM _interface
= SCM_CAR (uses
);
411 /* 1. Check module obarray */
412 SCM b
= scm_hashq_ref (SCM_MODULE_OBARRAY (_interface
), sym
, SCM_BOOL_F
);
413 if (SCM_BOUND_THING_P (b
))
416 SCM binder
= SCM_MODULE_BINDER (_interface
);
417 if (scm_is_true (binder
))
418 /* 2. Custom binder */
420 b
= scm_call_3 (binder
, _interface
, sym
, SCM_BOOL_F
);
421 if (SCM_BOUND_THING_P (b
))
425 /* 3. Search use list recursively. */
426 _interface
= scm_module_import_interface (_interface
, sym
);
427 if (scm_is_true (_interface
))
429 uses
= SCM_CDR (uses
);
437 * looks up the variable bound to SYM according to PROC. PROC should be
438 * a `eval closure' of some module.
440 * When no binding exists, and DEFINEP is true, create a new binding
441 * with a initial value of SCM_UNDEFINED. Return `#f' when DEFINEP as
442 * false and no binding exists.
444 * When PROC is `#f', it is ignored and the binding is searched for in
445 * the scm_pre_modules_obarray (a `eq' hash table).
448 SCM scm_pre_modules_obarray
;
451 scm_sym2var (SCM sym
, SCM proc
, SCM definep
)
452 #define FUNC_NAME "scm_sym2var"
458 if (SCM_EVAL_CLOSURE_P (proc
))
460 /* Bypass evaluator in the standard case. */
461 var
= scm_eval_closure_lookup (proc
, sym
, definep
);
464 var
= scm_call_2 (proc
, sym
, definep
);
470 if (scm_is_false (definep
))
471 var
= scm_hashq_ref (scm_pre_modules_obarray
, sym
, SCM_BOOL_F
);
474 handle
= scm_hashq_create_handle_x (scm_pre_modules_obarray
,
476 var
= SCM_CDR (handle
);
477 if (scm_is_false (var
))
479 var
= scm_make_variable (SCM_UNDEFINED
);
480 SCM_SETCDR (handle
, var
);
485 if (scm_is_true (var
) && !SCM_VARIABLEP (var
))
486 SCM_MISC_ERROR ("~S is not bound to a variable", scm_list_1 (sym
));
493 scm_c_module_lookup (SCM module
, const char *name
)
495 return scm_module_lookup (module
, scm_from_locale_symbol (name
));
499 scm_module_lookup (SCM module
, SCM sym
)
500 #define FUNC_NAME "module-lookup"
503 SCM_VALIDATE_MODULE (1, module
);
505 var
= scm_sym2var (sym
, scm_module_lookup_closure (module
), SCM_BOOL_F
);
506 if (scm_is_false (var
))
507 SCM_MISC_ERROR ("unbound variable: ~S", scm_list_1 (sym
));
513 scm_c_lookup (const char *name
)
515 return scm_lookup (scm_from_locale_symbol (name
));
522 scm_sym2var (sym
, scm_current_module_lookup_closure (), SCM_BOOL_F
);
523 if (scm_is_false (var
))
524 scm_misc_error ("scm_lookup", "unbound variable: ~S", scm_list_1 (sym
));
529 scm_c_module_define (SCM module
, const char *name
, SCM value
)
531 return scm_module_define (module
, scm_from_locale_symbol (name
), value
);
535 scm_module_define (SCM module
, SCM sym
, SCM value
)
536 #define FUNC_NAME "module-define"
539 SCM_VALIDATE_MODULE (1, module
);
541 var
= scm_sym2var (sym
, scm_module_lookup_closure (module
), SCM_BOOL_T
);
542 SCM_VARIABLE_SET (var
, value
);
548 scm_c_define (const char *name
, SCM value
)
550 return scm_define (scm_from_locale_symbol (name
), value
);
554 scm_define (SCM sym
, SCM value
)
557 scm_sym2var (sym
, scm_current_module_lookup_closure (), SCM_BOOL_T
);
558 SCM_VARIABLE_SET (var
, value
);
563 scm_module_reverse_lookup (SCM module
, SCM variable
)
564 #define FUNC_NAME "module-reverse-lookup"
569 if (scm_is_false (module
))
570 obarray
= scm_pre_modules_obarray
;
573 SCM_VALIDATE_MODULE (1, module
);
574 obarray
= SCM_MODULE_OBARRAY (module
);
577 if (!SCM_HASHTABLE_P (obarray
))
580 /* XXX - We do not use scm_hash_fold here to avoid searching the
581 whole obarray. We should have a scm_hash_find procedure. */
583 n
= SCM_HASHTABLE_N_BUCKETS (obarray
);
584 for (i
= 0; i
< n
; ++i
)
586 SCM ls
= SCM_HASHTABLE_BUCKET (obarray
, i
), handle
;
587 while (!scm_is_null (ls
))
589 handle
= SCM_CAR (ls
);
590 if (SCM_CDR (handle
) == variable
)
591 return SCM_CAR (handle
);
596 /* Try the `uses' list.
599 SCM uses
= SCM_MODULE_USES (module
);
600 while (scm_is_pair (uses
))
602 SCM sym
= scm_module_reverse_lookup (SCM_CAR (uses
), variable
);
603 if (scm_is_true (sym
))
605 uses
= SCM_CDR (uses
);
613 SCM_DEFINE (scm_get_pre_modules_obarray
, "%get-pre-modules-obarray", 0, 0, 0,
615 "Return the obarray that is used for all new bindings before "
616 "the module system is booted. The first call to "
617 "@code{set-current-module} will boot the module system.")
618 #define FUNC_NAME s_scm_get_pre_modules_obarray
620 return scm_pre_modules_obarray
;
624 SCM_SYMBOL (scm_sym_system_module
, "system-module");
627 scm_system_module_env_p (SCM env
)
629 SCM proc
= scm_env_top_level (env
);
630 if (scm_is_false (proc
))
632 return ((scm_is_true (scm_procedure_property (proc
,
633 scm_sym_system_module
)))
639 scm_modules_prehistory ()
641 scm_pre_modules_obarray
642 = scm_permanent_object (scm_c_make_hash_table (1533));
648 #include "libguile/modules.x"
649 module_make_local_var_x_var
= scm_c_define ("module-make-local-var!",
651 scm_tc16_eval_closure
= scm_make_smob_type ("eval-closure", 0);
652 scm_set_smob_mark (scm_tc16_eval_closure
, scm_markcdr
);
653 scm_set_smob_apply (scm_tc16_eval_closure
, scm_eval_closure_lookup
, 2, 0, 0);
655 the_module
= scm_permanent_object (scm_make_fluid ());
659 scm_post_boot_init_modules ()
661 #define PERM(x) scm_permanent_object(x)
663 SCM module_type
= SCM_VARIABLE_REF (scm_c_lookup ("module-type"));
664 scm_module_tag
= (SCM_CELL_WORD_1 (module_type
) + scm_tc3_struct
);
666 resolve_module_var
= PERM (scm_c_lookup ("resolve-module"));
667 process_define_module_var
= PERM (scm_c_lookup ("process-define-module"));
668 process_use_modules_var
= PERM (scm_c_lookup ("process-use-modules"));
669 module_export_x_var
= PERM (scm_c_lookup ("module-export!"));
670 the_root_module_var
= PERM (scm_c_lookup ("the-root-module"));
672 scm_module_system_booted_p
= 1;