1 /* Copyright (C) 1998,2000,2001,2002,2003,2004,2006,2007,2008 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
26 #include "libguile/_scm.h"
28 #include "libguile/eval.h"
29 #include "libguile/smob.h"
30 #include "libguile/procprop.h"
31 #include "libguile/vectors.h"
32 #include "libguile/hashtab.h"
33 #include "libguile/struct.h"
34 #include "libguile/variable.h"
35 #include "libguile/fluids.h"
36 #include "libguile/deprecation.h"
38 #include "libguile/modules.h"
40 int scm_module_system_booted_p
= 0;
42 scm_t_bits scm_module_tag
;
44 static SCM the_module
;
46 static SCM the_root_module_var
;
51 if (scm_module_system_booted_p
)
52 return SCM_VARIABLE_REF (the_root_module_var
);
57 SCM_DEFINE (scm_current_module
, "current-module", 0, 0, 0,
59 "Return the current module.")
60 #define FUNC_NAME s_scm_current_module
62 SCM curr
= scm_fluid_ref (the_module
);
64 return scm_is_true (curr
) ? curr
: the_root_module ();
68 static void scm_post_boot_init_modules (void);
70 SCM_DEFINE (scm_set_current_module
, "set-current-module", 1, 0, 0,
72 "Set the current module to @var{module} and return\n"
73 "the previous current module.")
74 #define FUNC_NAME s_scm_set_current_module
78 if (!scm_module_system_booted_p
)
79 scm_post_boot_init_modules ();
81 SCM_VALIDATE_MODULE (SCM_ARG1
, module
);
83 old
= scm_current_module ();
84 scm_fluid_set_x (the_module
, module
);
90 SCM_DEFINE (scm_interaction_environment
, "interaction-environment", 0, 0, 0,
92 "Return a specifier for the environment that contains\n"
93 "implementation--defined bindings, typically a superset of those\n"
94 "listed in the report. The intent is that this procedure will\n"
95 "return the environment in which the implementation would\n"
96 "evaluate expressions dynamically typed by the user.")
97 #define FUNC_NAME s_scm_interaction_environment
99 return scm_current_module ();
104 scm_c_call_with_current_module (SCM module
,
105 SCM (*func
)(void *), void *data
)
107 return scm_c_with_fluid (the_module
, module
, func
, data
);
111 scm_dynwind_current_module (SCM module
)
113 scm_dynwind_fluid (the_module
, module
);
117 convert "A B C" to scheme list (A B C)
120 convert_module_name (const char *name
)
131 while (*ptr
&& *ptr
!= ' ')
135 SCM sym
= scm_from_locale_symboln (name
, ptr
-name
);
136 *tail
= scm_cons (sym
, SCM_EOL
);
137 tail
= SCM_CDRLOC (*tail
);
145 static SCM process_define_module_var
;
146 static SCM process_use_modules_var
;
147 static SCM resolve_module_var
;
150 scm_c_resolve_module (const char *name
)
152 return scm_resolve_module (convert_module_name (name
));
156 scm_resolve_module (SCM name
)
158 return scm_call_1 (SCM_VARIABLE_REF (resolve_module_var
), name
);
162 scm_c_define_module (const char *name
,
163 void (*init
)(void *), void *data
)
165 SCM module
= scm_call_1 (SCM_VARIABLE_REF (process_define_module_var
),
166 scm_list_1 (convert_module_name (name
)));
168 scm_c_call_with_current_module (module
, (SCM (*)(void*))init
, data
);
173 scm_c_use_module (const char *name
)
175 scm_call_1 (SCM_VARIABLE_REF (process_use_modules_var
),
176 scm_list_1 (scm_list_1 (convert_module_name (name
))));
179 static SCM module_export_x_var
;
182 scm_module_export (SCM module
, SCM namelist
)
184 return scm_call_2 (SCM_VARIABLE_REF (module_export_x_var
),
190 @code{scm_c_export}(@var{name-list})
192 @code{scm_c_export} exports the named bindings from the current
193 module, making them visible to users of the module. This function
194 takes a list of string arguments, terminated by NULL, e.g.
197 scm_c_export ("add-double-record", "bamboozle-money", NULL);
201 scm_c_export (const char *name
, ...)
206 SCM names
= scm_cons (scm_from_locale_symbol (name
), SCM_EOL
);
207 SCM
*tail
= SCM_CDRLOC (names
);
211 const char *n
= va_arg (ap
, const char *);
214 *tail
= scm_cons (scm_from_locale_symbol (n
), SCM_EOL
);
215 tail
= SCM_CDRLOC (*tail
);
218 scm_module_export (scm_current_module (), names
);
226 scm_top_level_env (SCM thunk
)
231 return scm_cons (thunk
, SCM_EOL
);
235 scm_env_top_level (SCM env
)
237 while (scm_is_pair (env
))
239 SCM car_env
= SCM_CAR (env
);
240 if (!scm_is_pair (car_env
) && scm_is_true (scm_procedure_p (car_env
)))
247 SCM_SYMBOL (sym_module
, "module");
250 scm_lookup_closure_module (SCM proc
)
252 if (scm_is_false (proc
))
253 return the_root_module ();
254 else if (SCM_EVAL_CLOSURE_P (proc
))
255 return SCM_PACK (SCM_SMOB_DATA (proc
));
258 SCM mod
= scm_procedure_property (proc
, sym_module
);
259 if (scm_is_false (mod
))
260 mod
= the_root_module ();
265 SCM_DEFINE (scm_env_module
, "env-module", 1, 0, 0,
267 "Return the module of @var{ENV}, a lexical environment.")
268 #define FUNC_NAME s_scm_env_module
270 return scm_lookup_closure_module (scm_env_top_level (env
));
275 * C level implementation of the standard eval closure
277 * This increases loading speed substantially. The code may be
278 * replaced by something based on environments.[ch], in a future
282 /* The `module-make-local-var!' variable. */
283 static SCM module_make_local_var_x_var
= SCM_UNSPECIFIED
;
285 /* The `default-duplicate-binding-procedures' variable. */
286 static SCM default_duplicate_binding_procedures_var
= SCM_UNSPECIFIED
;
288 /* Return the list of default duplicate binding handlers (procedures). */
290 default_duplicate_binding_handlers (void)
294 get_handlers
= SCM_VARIABLE_REF (default_duplicate_binding_procedures_var
);
296 return (scm_call_0 (get_handlers
));
299 /* Resolve the import of SYM in MODULE, where SYM is currently provided by
300 both IFACE1 as VAR1 and IFACE2 as VAR2. Return the variable chosen by the
301 duplicate binding handlers or `#f'. */
303 resolve_duplicate_binding (SCM module
, SCM sym
,
304 SCM iface1
, SCM var1
,
305 SCM iface2
, SCM var2
)
307 SCM result
= SCM_BOOL_F
;
309 if (!scm_is_eq (var1
, var2
))
312 SCM handlers
, h
, handler_args
;
314 val1
= SCM_VARIABLE_REF (var1
);
315 val2
= SCM_VARIABLE_REF (var2
);
317 val1
= (val1
== SCM_UNSPECIFIED
) ? SCM_BOOL_F
: val1
;
318 val2
= (val2
== SCM_UNSPECIFIED
) ? SCM_BOOL_F
: val2
;
320 handlers
= SCM_MODULE_DUPLICATE_HANDLERS (module
);
321 if (scm_is_false (handlers
))
322 handlers
= default_duplicate_binding_handlers ();
324 handler_args
= scm_list_n (module
, sym
,
325 iface1
, val1
, iface2
, val2
,
330 scm_is_pair (h
) && scm_is_false (result
);
333 result
= scm_apply (SCM_CAR (h
), handler_args
, SCM_EOL
);
342 /* Lookup SYM as an imported variable of MODULE. */
344 module_imported_variable (SCM module
, SCM sym
)
346 #define SCM_BOUND_THING_P scm_is_true
347 register SCM var
, imports
;
349 /* Search cached imported bindings. */
350 imports
= SCM_MODULE_IMPORT_OBARRAY (module
);
351 var
= scm_hashq_ref (imports
, sym
, SCM_UNDEFINED
);
352 if (SCM_BOUND_THING_P (var
))
356 /* Search the use list for yet uncached imported bindings, possibly
357 resolving duplicates as needed and caching the result in the import
360 SCM found_var
= SCM_BOOL_F
, found_iface
= SCM_BOOL_F
;
362 for (uses
= SCM_MODULE_USES (module
);
364 uses
= SCM_CDR (uses
))
368 iface
= SCM_CAR (uses
);
369 var
= scm_module_variable (iface
, sym
);
371 if (SCM_BOUND_THING_P (var
))
373 if (SCM_BOUND_THING_P (found_var
))
375 /* SYM is a duplicate binding (imported more than once) so we
376 need to resolve it. */
377 found_var
= resolve_duplicate_binding (module
, sym
,
378 found_iface
, found_var
,
380 if (scm_is_eq (found_var
, var
))
384 /* Keep track of the variable we found and check for other
385 occurences of SYM in the use list. */
386 found_var
= var
, found_iface
= iface
;
390 if (SCM_BOUND_THING_P (found_var
))
392 /* Save the lookup result for future reference. */
393 (void) scm_hashq_set_x (imports
, sym
, found_var
);
399 #undef SCM_BOUND_THING_P
402 SCM_DEFINE (scm_module_local_variable
, "module-local-variable", 2, 0, 0,
403 (SCM module
, SCM sym
),
404 "Return the variable bound to @var{sym} in @var{module}. Return "
405 "@code{#f} is @var{sym} is not bound locally in @var{module}.")
406 #define FUNC_NAME s_scm_module_local_variable
408 #define SCM_BOUND_THING_P(b) \
413 /* SCM_MODULE_TAG is not initialized yet when `boot-9.scm' is being
415 if (scm_module_system_booted_p
)
416 SCM_VALIDATE_MODULE (1, module
);
418 SCM_VALIDATE_SYMBOL (2, sym
);
421 /* 1. Check module obarray */
422 b
= scm_hashq_ref (SCM_MODULE_OBARRAY (module
), sym
, SCM_UNDEFINED
);
423 if (SCM_BOUND_THING_P (b
))
426 /* 2. Search imported bindings. In order to be consistent with
427 `module-variable', the binder gets called only when no imported binding
429 b
= module_imported_variable (module
, sym
);
430 if (SCM_BOUND_THING_P (b
))
434 /* 3. Query the custom binder. */
435 SCM binder
= SCM_MODULE_BINDER (module
);
437 if (scm_is_true (binder
))
439 b
= scm_call_3 (binder
, module
, sym
, SCM_BOOL_F
);
440 if (SCM_BOUND_THING_P (b
))
447 #undef SCM_BOUND_THING_P
451 SCM_DEFINE (scm_module_variable
, "module-variable", 2, 0, 0,
452 (SCM module
, SCM sym
),
453 "Return the variable bound to @var{sym} in @var{module}. This "
454 "may be both a local variable or an imported variable. Return "
455 "@code{#f} is @var{sym} is not bound in @var{module}.")
456 #define FUNC_NAME s_scm_module_variable
458 #define SCM_BOUND_THING_P(b) \
463 if (scm_module_system_booted_p
)
464 SCM_VALIDATE_MODULE (1, module
);
466 SCM_VALIDATE_SYMBOL (2, sym
);
468 /* 1. Check module obarray */
469 var
= scm_hashq_ref (SCM_MODULE_OBARRAY (module
), sym
, SCM_UNDEFINED
);
470 if (SCM_BOUND_THING_P (var
))
473 /* 2. Search among the imported variables. */
474 var
= module_imported_variable (module
, sym
);
475 if (SCM_BOUND_THING_P (var
))
479 /* 3. Query the custom binder. */
482 binder
= SCM_MODULE_BINDER (module
);
483 if (scm_is_true (binder
))
485 var
= scm_call_3 (binder
, module
, sym
, SCM_BOOL_F
);
486 if (SCM_BOUND_THING_P (var
))
493 #undef SCM_BOUND_THING_P
497 scm_t_bits scm_tc16_eval_closure
;
499 #define SCM_F_EVAL_CLOSURE_INTERFACE (1<<16)
500 #define SCM_EVAL_CLOSURE_INTERFACE_P(e) \
501 (SCM_CELL_WORD_0 (e) & SCM_F_EVAL_CLOSURE_INTERFACE)
503 /* NOTE: This function may be called by a smob application
504 or from another C function directly. */
506 scm_eval_closure_lookup (SCM eclo
, SCM sym
, SCM definep
)
508 SCM module
= SCM_PACK (SCM_SMOB_DATA (eclo
));
509 if (scm_is_true (definep
))
511 if (SCM_EVAL_CLOSURE_INTERFACE_P (eclo
))
513 return scm_call_2 (SCM_VARIABLE_REF (module_make_local_var_x_var
),
517 return scm_module_variable (module
, sym
);
520 SCM_DEFINE (scm_standard_eval_closure
, "standard-eval-closure", 1, 0, 0,
522 "Return an eval closure for the module @var{module}.")
523 #define FUNC_NAME s_scm_standard_eval_closure
525 SCM_RETURN_NEWSMOB (scm_tc16_eval_closure
, SCM_UNPACK (module
));
530 SCM_DEFINE (scm_standard_interface_eval_closure
,
531 "standard-interface-eval-closure", 1, 0, 0,
533 "Return a interface eval closure for the module @var{module}. "
534 "Such a closure does not allow new bindings to be added.")
535 #define FUNC_NAME s_scm_standard_interface_eval_closure
537 SCM_RETURN_NEWSMOB (scm_tc16_eval_closure
| SCM_F_EVAL_CLOSURE_INTERFACE
,
538 SCM_UNPACK (module
));
543 scm_module_lookup_closure (SCM module
)
545 if (scm_is_false (module
))
548 return SCM_MODULE_EVAL_CLOSURE (module
);
552 scm_current_module_lookup_closure ()
554 if (scm_module_system_booted_p
)
555 return scm_module_lookup_closure (scm_current_module ());
561 scm_module_transformer (SCM module
)
563 if (scm_is_false (module
))
566 return SCM_MODULE_TRANSFORMER (module
);
570 scm_current_module_transformer ()
572 if (scm_module_system_booted_p
)
573 return scm_module_transformer (scm_current_module ());
578 SCM_DEFINE (scm_module_import_interface
, "module-import-interface", 2, 0, 0,
579 (SCM module
, SCM sym
),
580 "Return the module or interface from which @var{sym} is imported "
581 "in @var{module}. If @var{sym} is not imported (i.e., it is not "
582 "defined in @var{module} or it is a module-local binding instead "
583 "of an imported one), then @code{#f} is returned.")
584 #define FUNC_NAME s_scm_module_import_interface
586 SCM var
, result
= SCM_BOOL_F
;
588 SCM_VALIDATE_MODULE (1, module
);
589 SCM_VALIDATE_SYMBOL (2, sym
);
591 var
= scm_module_variable (module
, sym
);
592 if (scm_is_true (var
))
594 /* Look for the module that provides VAR. */
597 local_var
= scm_hashq_ref (SCM_MODULE_OBARRAY (module
), sym
,
599 if (scm_is_eq (local_var
, var
))
603 /* Look for VAR among the used modules. */
604 SCM uses
, imported_var
;
606 for (uses
= SCM_MODULE_USES (module
);
607 scm_is_pair (uses
) && scm_is_false (result
);
608 uses
= SCM_CDR (uses
))
610 imported_var
= scm_module_variable (SCM_CAR (uses
), sym
);
611 if (scm_is_eq (imported_var
, var
))
612 result
= SCM_CAR (uses
);
623 * looks up the variable bound to SYM according to PROC. PROC should be
624 * a `eval closure' of some module.
626 * When no binding exists, and DEFINEP is true, create a new binding
627 * with a initial value of SCM_UNDEFINED. Return `#f' when DEFINEP as
628 * false and no binding exists.
630 * When PROC is `#f', it is ignored and the binding is searched for in
631 * the scm_pre_modules_obarray (a `eq' hash table).
634 SCM scm_pre_modules_obarray
;
637 scm_sym2var (SCM sym
, SCM proc
, SCM definep
)
638 #define FUNC_NAME "scm_sym2var"
644 if (SCM_EVAL_CLOSURE_P (proc
))
646 /* Bypass evaluator in the standard case. */
647 var
= scm_eval_closure_lookup (proc
, sym
, definep
);
650 var
= scm_call_2 (proc
, sym
, definep
);
656 if (scm_is_false (definep
))
657 var
= scm_hashq_ref (scm_pre_modules_obarray
, sym
, SCM_BOOL_F
);
660 handle
= scm_hashq_create_handle_x (scm_pre_modules_obarray
,
662 var
= SCM_CDR (handle
);
663 if (scm_is_false (var
))
665 var
= scm_make_variable (SCM_UNDEFINED
);
666 SCM_SETCDR (handle
, var
);
671 if (scm_is_true (var
) && !SCM_VARIABLEP (var
))
672 SCM_MISC_ERROR ("~S is not bound to a variable", scm_list_1 (sym
));
679 scm_c_module_lookup (SCM module
, const char *name
)
681 return scm_module_lookup (module
, scm_from_locale_symbol (name
));
685 scm_module_lookup (SCM module
, SCM sym
)
686 #define FUNC_NAME "module-lookup"
689 SCM_VALIDATE_MODULE (1, module
);
691 var
= scm_sym2var (sym
, scm_module_lookup_closure (module
), SCM_BOOL_F
);
692 if (scm_is_false (var
))
693 SCM_MISC_ERROR ("unbound variable: ~S", scm_list_1 (sym
));
699 scm_c_lookup (const char *name
)
701 return scm_lookup (scm_from_locale_symbol (name
));
708 scm_sym2var (sym
, scm_current_module_lookup_closure (), SCM_BOOL_F
);
709 if (scm_is_false (var
))
710 scm_misc_error ("scm_lookup", "unbound variable: ~S", scm_list_1 (sym
));
715 scm_c_module_define (SCM module
, const char *name
, SCM value
)
717 return scm_module_define (module
, scm_from_locale_symbol (name
), value
);
721 scm_module_define (SCM module
, SCM sym
, SCM value
)
722 #define FUNC_NAME "module-define"
725 SCM_VALIDATE_MODULE (1, module
);
727 var
= scm_sym2var (sym
, scm_module_lookup_closure (module
), SCM_BOOL_T
);
728 SCM_VARIABLE_SET (var
, value
);
734 scm_c_define (const char *name
, SCM value
)
736 return scm_define (scm_from_locale_symbol (name
), value
);
740 scm_define (SCM sym
, SCM value
)
743 scm_sym2var (sym
, scm_current_module_lookup_closure (), SCM_BOOL_T
);
744 SCM_VARIABLE_SET (var
, value
);
748 SCM_DEFINE (scm_module_reverse_lookup
, "module-reverse-lookup", 2, 0, 0,
749 (SCM module
, SCM variable
),
750 "Return the symbol under which @var{variable} is bound in "
751 "@var{module} or @var{#f} if @var{variable} is not visible "
752 "from @var{module}. If @var{module} is @code{#f}, then the "
753 "pre-module obarray is used.")
754 #define FUNC_NAME s_scm_module_reverse_lookup
759 if (scm_is_false (module
))
760 obarray
= scm_pre_modules_obarray
;
763 SCM_VALIDATE_MODULE (1, module
);
764 obarray
= SCM_MODULE_OBARRAY (module
);
767 if (!SCM_HASHTABLE_P (obarray
))
770 /* XXX - We do not use scm_hash_fold here to avoid searching the
771 whole obarray. We should have a scm_hash_find procedure. */
773 n
= SCM_HASHTABLE_N_BUCKETS (obarray
);
774 for (i
= 0; i
< n
; ++i
)
776 SCM ls
= SCM_HASHTABLE_BUCKET (obarray
, i
), handle
;
777 while (!scm_is_null (ls
))
779 handle
= SCM_CAR (ls
);
780 if (SCM_CDR (handle
) == variable
)
781 return SCM_CAR (handle
);
786 /* Try the `uses' list. */
788 SCM uses
= SCM_MODULE_USES (module
);
789 while (scm_is_pair (uses
))
791 SCM sym
= scm_module_reverse_lookup (SCM_CAR (uses
), variable
);
792 if (scm_is_true (sym
))
794 uses
= SCM_CDR (uses
);
802 SCM_DEFINE (scm_get_pre_modules_obarray
, "%get-pre-modules-obarray", 0, 0, 0,
804 "Return the obarray that is used for all new bindings before "
805 "the module system is booted. The first call to "
806 "@code{set-current-module} will boot the module system.")
807 #define FUNC_NAME s_scm_get_pre_modules_obarray
809 return scm_pre_modules_obarray
;
813 SCM_SYMBOL (scm_sym_system_module
, "system-module");
816 scm_system_module_env_p (SCM env
)
818 SCM proc
= scm_env_top_level (env
);
819 if (scm_is_false (proc
))
821 return ((scm_is_true (scm_procedure_property (proc
,
822 scm_sym_system_module
)))
828 scm_modules_prehistory ()
830 scm_pre_modules_obarray
831 = scm_permanent_object (scm_c_make_hash_table (1533));
837 #include "libguile/modules.x"
838 module_make_local_var_x_var
= scm_c_define ("module-make-local-var!",
840 scm_tc16_eval_closure
= scm_make_smob_type ("eval-closure", 0);
841 scm_set_smob_mark (scm_tc16_eval_closure
, scm_markcdr
);
842 scm_set_smob_apply (scm_tc16_eval_closure
, scm_eval_closure_lookup
, 2, 0, 0);
844 the_module
= scm_permanent_object (scm_make_fluid ());
848 scm_post_boot_init_modules ()
850 #define PERM(x) scm_permanent_object(x)
852 SCM module_type
= SCM_VARIABLE_REF (scm_c_lookup ("module-type"));
853 scm_module_tag
= (SCM_CELL_WORD_1 (module_type
) + scm_tc3_struct
);
855 resolve_module_var
= PERM (scm_c_lookup ("resolve-module"));
856 process_define_module_var
= PERM (scm_c_lookup ("process-define-module"));
857 process_use_modules_var
= PERM (scm_c_lookup ("process-use-modules"));
858 module_export_x_var
= PERM (scm_c_lookup ("module-export!"));
859 the_root_module_var
= PERM (scm_c_lookup ("the-root-module"));
860 default_duplicate_binding_procedures_var
=
861 PERM (scm_c_lookup ("default-duplicate-binding-procedures"));
863 scm_module_system_booted_p
= 1;