X-Git-Url: http://git.hcoop.net/bpt/guile.git/blobdiff_plain/86c991c2a202c1d06caa5f01ec5d36a07a19bb96..ddea3325ebe6c1453fa7969ae27bde1a3e4e5327:/libguile/environments.c diff --git a/libguile/environments.c b/libguile/environments.c index 55fd610d3..541427641 100644 --- a/libguile/environments.c +++ b/libguile/environments.c @@ -1,4 +1,4 @@ -/* Copyright (C) 1999, 2000 Free Software Foundation, Inc. +/* Copyright (C) 1999,2000,2001 Free Software Foundation, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -56,8 +56,11 @@ -long scm_tc16_environment; -long scm_tc16_observer; +scm_t_bits scm_tc16_environment; +scm_t_bits scm_tc16_observer; +#define DEFAULT_OBARRAY_SIZE 137 + +SCM scm_system_environment; @@ -128,7 +131,8 @@ scm_make_environment (void *type) SCM_DEFINE (scm_environment_p, "environment?", 1, 0, 0, (SCM obj), - "Return #t if OBJ is an environment, or #f otherwise.") + "Return @code{#t} if @var{obj} is an environment, or @code{#f}\n" + "otherwise.") #define FUNC_NAME s_scm_environment_p { return SCM_BOOL (SCM_ENVIRONMENT_P (obj)); @@ -138,7 +142,8 @@ SCM_DEFINE (scm_environment_p, "environment?", 1, 0, 0, SCM_DEFINE (scm_environment_bound_p, "environment-bound?", 2, 0, 0, (SCM env, SCM sym), - "Return #t if SYM is bound in ENV, or #f otherwise.") + "Return @code{#t} if @var{sym} is bound in @var{env}, or\n" + "@code{#f} otherwise.") #define FUNC_NAME s_scm_environment_bound_p { SCM_ASSERT (SCM_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -151,9 +156,9 @@ SCM_DEFINE (scm_environment_bound_p, "environment-bound?", 2, 0, 0, SCM_DEFINE (scm_environment_ref, "environment-ref", 2, 0, 0, (SCM env, SCM sym), - "Return the value of the location bound to SYM in ENV.\n" - "If SYM is unbound in ENV, signal an environment:unbound\n" - "error.") + "Return the value of the location bound to @var{sym} in\n" + "@var{env}. If @var{sym} is unbound in @var{env}, signal an\n" + "@code{environment:unbound} error.") #define FUNC_NAME s_scm_environment_ref { SCM val; @@ -193,30 +198,37 @@ environment_default_folder (SCM proc, SCM symbol, SCM value, SCM tail) SCM_DEFINE (scm_environment_fold, "environment-fold", 3, 0, 0, (SCM env, SCM proc, SCM init), - "Iterate over all the bindings in ENV, accumulating some value.\n" - "For each binding in ENV, apply PROC to the symbol bound, its\n" - "value, and the result from the previous application of PROC.\n" - "Use INIT as PROC's third argument the first time PROC is\n" - "applied.\n" - "If ENV contains no bindings, this function simply returns INIT.\n" - "If ENV binds the symbol sym1 to the value val1, sym2 to val2,\n" - "and so on, then this procedure computes:\n" + "Iterate over all the bindings in @var{env}, accumulating some\n" + "value.\n" + "For each binding in @var{env}, apply @var{proc} to the symbol\n" + "bound, its value, and the result from the previous application\n" + "of @var{proc}.\n" + "Use @var{init} as @var{proc}'s third argument the first time\n" + "@var{proc} is applied.\n" + "If @var{env} contains no bindings, this function simply returns\n" + "@var{init}.\n" + "If @var{env} binds the symbol sym1 to the value val1, sym2 to\n" + "val2, and so on, then this procedure computes:\n" + "@lisp\n" " (proc sym1 val1\n" " (proc sym2 val2\n" " ...\n" " (proc symn valn\n" " init)))\n" - "Each binding in ENV will be processed exactly once.\n" - "environment-fold makes no guarantees about the order in which\n" - "the bindings are processed.\n" + "@end lisp\n" + "Each binding in @var{env} will be processed exactly once.\n" + "@code{environment-fold} makes no guarantees about the order in\n" + "which the bindings are processed.\n" "Here is a function which, given an environment, constructs an\n" "association list representing that environment's bindings,\n" "using environment-fold:\n" + "@lisp\n" " (define (environment->alist env)\n" " (environment-fold env\n" " (lambda (sym val tail)\n" " (cons (cons sym val) tail))\n" - " '()))") + " '()))\n" + "@end lisp") #define FUNC_NAME s_scm_environment_fold { SCM_ASSERT (SCM_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -245,12 +257,13 @@ scm_c_environment_fold (SCM env, scm_environment_folder proc, SCM data, SCM init SCM_DEFINE (scm_environment_define, "environment-define", 3, 0, 0, (SCM env, SCM sym, SCM val), - "Bind SYM to a new location containing VAL in ENV. If SYM is\n" - "already bound to another location in ENV and the binding is\n" - "mutable, that binding is replaced. The new binding and\n" - "location are both mutable. The return value is unspecified.\n" - "If SYM is already bound in ENV, and the binding is immutable,\n" - "signal an environment:immutable-binding error.") + "Bind @var{sym} to a new location containing @var{val} in\n" + "@var{env}. If @var{sym} is already bound to another location\n" + "in @var{env} and the binding is mutable, that binding is\n" + "replaced. The new binding and location are both mutable. The\n" + "return value is unspecified.\n" + "If @var{sym} is already bound in @var{env}, and the binding is\n" + "immutable, signal an @code{environment:immutable-binding} error.") #define FUNC_NAME s_scm_environment_define { SCM status; @@ -272,10 +285,11 @@ SCM_DEFINE (scm_environment_define, "environment-define", 3, 0, 0, SCM_DEFINE (scm_environment_undefine, "environment-undefine", 2, 0, 0, (SCM env, SCM sym), - "Remove any binding for SYM from ENV. If SYM is unbound in ENV,\n" - "do nothing. The return value is unspecified.\n" - "If SYM is already bound in ENV, and the binding is immutable,\n" - "signal an environment:immutable-binding error.") + "Remove any binding for @var{sym} from @var{env}. If @var{sym}\n" + "is unbound in @var{env}, do nothing. The return value is\n" + "unspecified.\n" + "If @var{sym} is already bound in @var{env}, and the binding is\n" + "immutable, signal an @code{environment:immutable-binding} error.") #define FUNC_NAME s_scm_environment_undefine { SCM status; @@ -297,11 +311,13 @@ SCM_DEFINE (scm_environment_undefine, "environment-undefine", 2, 0, 0, SCM_DEFINE (scm_environment_set_x, "environment-set!", 3, 0, 0, (SCM env, SCM sym, SCM val), - "If ENV binds SYM to some location, change that location's\n" - "value to VAL. The return value is unspecified.\n" - "If SYM is not bound in ENV, signal an environment:unbound\n" - "error. If ENV binds SYM to an immutable location, signal an\n" - "environment:immutable-location error.") + "If @var{env} binds @var{sym} to some location, change that\n" + "location's value to @var{val}. The return value is\n" + "unspecified.\n" + "If @var{sym} is not bound in @var{env}, signal an\n" + "@code{environment:unbound} error. If @var{env} binds @var{sym}\n" + "to an immutable location, signal an\n" + "@code{environment:immutable-location} error.") #define FUNC_NAME s_scm_environment_set_x { SCM status; @@ -325,16 +341,18 @@ SCM_DEFINE (scm_environment_set_x, "environment-set!", 3, 0, 0, SCM_DEFINE (scm_environment_cell, "environment-cell", 3, 0, 0, (SCM env, SCM sym, SCM for_write), - "Return the value cell which ENV binds to SYM, or #f if the\n" - "binding does not live in a value cell.\n" - "The argument FOR-WRITE indicates whether the caller intends\n" - "to modify the variable's value by mutating the value cell. If\n" - "the variable is immutable, then environment-cell signals an\n" - "environment:immutable-location error.\n" - "If SYM is unbound in ENV, signal an environment:unbound error.\n" + "Return the value cell which @var{env} binds to @var{sym}, or\n" + "@code{#f} if the binding does not live in a value cell.\n" + "The argument @var{for-write} indicates whether the caller\n" + "intends to modify the variable's value by mutating the value\n" + "cell. If the variable is immutable, then\n" + "@code{environment-cell} signals an\n" + "@code{environment:immutable-location} error.\n" + "If @var{sym} is unbound in @var{env}, signal an\n" + "@code{environment:unbound} error.\n" "If you use this function, you should consider using\n" - "environment-observe, to be notified when SYM gets re-bound to\n" - "a new value cell, or becomes undefined.") + "@code{environment-observe}, to be notified when @var{sym} gets\n" + "re-bound to a new value cell, or becomes undefined.") #define FUNC_NAME s_scm_environment_cell { SCM location; @@ -381,11 +399,12 @@ environment_default_observer (SCM env, SCM proc) SCM_DEFINE (scm_environment_observe, "environment-observe", 2, 0, 0, (SCM env, SCM proc), - "Whenever ENV's bindings change, apply PROC to ENV.\n" + "Whenever @var{env}'s bindings change, apply @var{proc} to\n" + "@var{env}.\n" "This function returns an object, token, which you can pass to\n" - "environment-unobserve to remove PROC from the set of\n" - "procedures observing ENV. The type and value of token is\n" - "unspecified.") + "@code{environment-unobserve} to remove @var{proc} from the set\n" + "of procedures observing @var{env}. The type and value of\n" + "token is unspecified.") #define FUNC_NAME s_scm_environment_observe { SCM_ASSERT (SCM_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -398,9 +417,10 @@ SCM_DEFINE (scm_environment_observe, "environment-observe", 2, 0, 0, SCM_DEFINE (scm_environment_observe_weak, "environment-observe-weak", 2, 0, 0, (SCM env, SCM proc), "This function is the same as environment-observe, except that\n" - "the reference ENV retains to PROC is a weak reference. This\n" - "means that, if there are no other live, non-weak references\n" - "to PROC, it will be garbage-collected, and dropped from ENV's\n" + "the reference @var{env} retains to @var{proc} is a weak\n" + "reference. This means that, if there are no other live,\n" + "non-weak references to @var{proc}, it will be\n" + "garbage-collected, and dropped from @var{env}'s\n" "list of observing procedures.") #define FUNC_NAME s_scm_environment_observe_weak { @@ -433,10 +453,11 @@ scm_c_environment_observe (SCM env, scm_environment_observer proc, SCM data, int SCM_DEFINE (scm_environment_unobserve, "environment-unobserve", 1, 0, 0, (SCM token), "Cancel the observation request which returned the value\n" - "TOKEN. The return value is unspecified.\n" - "If a call (environment-observe env proc) returns token, then\n" - "the call (environment-unobserve token) will cause proc to no\n" - "longer be called when env's bindings change.") + "@var{token}. The return value is unspecified.\n" + "If a call @code{(environment-observe env proc)} returns\n" + "@var{token}, then the call @code{(environment-unobserve token)}\n" + "will cause @var{proc} to no longer be called when @var{env}'s\n" + "bindings change.") #define FUNC_NAME s_scm_environment_unobserve { SCM env; @@ -452,21 +473,21 @@ SCM_DEFINE (scm_environment_unobserve, "environment-unobserve", 1, 0, 0, static SCM -mark_environment (SCM env) +environment_mark (SCM env) { return (*(SCM_ENVIRONMENT_FUNCS (env)->mark)) (env); } -static scm_sizet -free_environment (SCM env) +static size_t +environment_free (SCM env) { return (*(SCM_ENVIRONMENT_FUNCS (env)->free)) (env); } static int -print_environment (SCM env, SCM port, scm_print_state *pstate) +environment_print (SCM env, SCM port, scm_print_state *pstate) { return (*(SCM_ENVIRONMENT_FUNCS (env)->print)) (env, port, pstate); } @@ -476,7 +497,7 @@ print_environment (SCM env, SCM port, scm_print_state *pstate) /* observers */ static SCM -mark_observer (SCM observer) +observer_mark (SCM observer) { scm_gc_mark (SCM_OBSERVER_ENVIRONMENT (observer)); scm_gc_mark (SCM_OBSERVER_DATA (observer)); @@ -484,15 +505,8 @@ mark_observer (SCM observer) } -static scm_sizet -free_observer (SCM observer_smob) -{ - return 0; -} - - static int -print_observer (SCM type, SCM port, scm_print_state *pstate) +observer_print (SCM type, SCM port, scm_print_state *pstate SCM_UNUSED) { SCM address = scm_ulong2num (SCM_UNPACK (type)); SCM base16 = scm_number_to_string (address, SCM_MAKINUM (16)); @@ -521,7 +535,7 @@ print_observer (SCM type, SCM port, scm_print_state *pstate) static SCM obarray_enter (SCM obarray, SCM symbol, SCM data) { - scm_sizet hash = SCM_SYMBOL_HASH (symbol) % SCM_LENGTH (obarray); + size_t hash = SCM_SYMBOL_HASH (symbol) % SCM_VECTOR_LENGTH (obarray); SCM entry = scm_cons (symbol, data); SCM slot = scm_cons (entry, SCM_VELTS (obarray)[hash]); SCM_VELTS (obarray)[hash] = slot; @@ -537,7 +551,7 @@ obarray_enter (SCM obarray, SCM symbol, SCM data) static SCM obarray_replace (SCM obarray, SCM symbol, SCM data) { - scm_sizet hash = SCM_SYMBOL_HASH (symbol) % SCM_LENGTH (obarray); + size_t hash = SCM_SYMBOL_HASH (symbol) % SCM_VECTOR_LENGTH (obarray); SCM new_entry = scm_cons (symbol, data); SCM lsym; SCM slot; @@ -545,7 +559,7 @@ obarray_replace (SCM obarray, SCM symbol, SCM data) for (lsym = SCM_VELTS (obarray)[hash]; !SCM_NULLP (lsym); lsym = SCM_CDR (lsym)) { SCM old_entry = SCM_CAR (lsym); - if (SCM_CAR (old_entry) == symbol) + if (SCM_EQ_P (SCM_CAR (old_entry), symbol)) { SCM_SETCAR (lsym, new_entry); return old_entry; @@ -565,13 +579,13 @@ obarray_replace (SCM obarray, SCM symbol, SCM data) static SCM obarray_retrieve (SCM obarray, SCM sym) { - scm_sizet hash = SCM_SYMBOL_HASH (sym) % SCM_LENGTH (obarray); + size_t hash = SCM_SYMBOL_HASH (sym) % SCM_VECTOR_LENGTH (obarray); SCM lsym; for (lsym = SCM_VELTS (obarray)[hash]; !SCM_NULLP (lsym); lsym = SCM_CDR (lsym)) { SCM entry = SCM_CAR (lsym); - if (SCM_CAR (entry) == sym) + if (SCM_EQ_P (SCM_CAR (entry), sym)) return entry; } @@ -586,7 +600,7 @@ obarray_retrieve (SCM obarray, SCM sym) static SCM obarray_remove (SCM obarray, SCM sym) { - scm_sizet hash = SCM_SYMBOL_HASH (sym) % SCM_LENGTH (obarray); + size_t hash = SCM_SYMBOL_HASH (sym) % SCM_VECTOR_LENGTH (obarray); SCM lsym; SCM *lsymp; @@ -596,7 +610,7 @@ obarray_remove (SCM obarray, SCM sym) lsym = *(lsymp = SCM_CDRLOC (lsym))) { SCM entry = SCM_CAR (lsym); - if (SCM_CAR (entry) == sym) + if (SCM_EQ_P (SCM_CAR (entry), sym)) { *lsymp = SCM_CDR (lsym); return entry; @@ -609,8 +623,8 @@ obarray_remove (SCM obarray, SCM sym) static void obarray_remove_all (SCM obarray) { - scm_sizet size = SCM_LENGTH (obarray); - scm_sizet i; + size_t size = SCM_VECTOR_LENGTH (obarray); + size_t i; for (i = 0; i < size; i++) { @@ -738,7 +752,7 @@ core_environments_mark (SCM env) static void -core_environments_finalize (SCM env) +core_environments_finalize (SCM env SCM_UNUSED) { } @@ -802,7 +816,7 @@ update_catch_handler (void *ptr, SCM tag, SCM args) SCM observer = data->observer; SCM message = scm_makfrom0str ("Observer `~A' signals `~A' error: ~S"); - return scm_cons (message, scm_listify (observer, tag, args, SCM_UNDEFINED)); + return scm_cons (message, scm_list_3 (observer, tag, args)); } @@ -892,11 +906,11 @@ leaf_environment_ref (SCM env, SCM sym) static SCM leaf_environment_fold (SCM env, scm_environment_folder proc, SCM data, SCM init) { - scm_sizet i; + size_t i; SCM result = init; SCM obarray = LEAF_ENVIRONMENT (env)->obarray; - for (i = 0; i < SCM_LENGTH (obarray); i++) + for (i = 0; i < SCM_VECTOR_LENGTH (obarray); i++) { SCM l; for (l = SCM_VELTS (obarray)[i]; !SCM_NULLP (l); l = SCM_CDR (l)) @@ -961,7 +975,7 @@ leaf_environment_set_x (SCM env, SCM sym, SCM val) static SCM -leaf_environment_cell(SCM env, SCM sym, int for_write) +leaf_environment_cell (SCM env, SCM sym, int for_write SCM_UNUSED) { SCM obarray = LEAF_ENVIRONMENT (env)->obarray; SCM binding = obarray_retrieve (obarray, sym); @@ -970,15 +984,15 @@ leaf_environment_cell(SCM env, SCM sym, int for_write) static SCM -mark_leaf_environment (SCM env) +leaf_environment_mark (SCM env) { scm_gc_mark (LEAF_ENVIRONMENT (env)->obarray); return core_environments_mark (env); } -static scm_sizet -free_leaf_environment (SCM env) +static size_t +leaf_environment_free (SCM env) { core_environments_finalize (env); @@ -988,7 +1002,7 @@ free_leaf_environment (SCM env) static int -print_leaf_environment (SCM type, SCM port, scm_print_state *pstate) +leaf_environment_print (SCM type, SCM port, scm_print_state *pstate SCM_UNUSED) { SCM address = scm_ulong2num (SCM_UNPACK (type)); SCM base16 = scm_number_to_string (address, SCM_MAKINUM (16)); @@ -1010,9 +1024,9 @@ static struct scm_environment_funcs leaf_environment_funcs = { leaf_environment_cell, core_environments_observe, core_environments_unobserve, - mark_leaf_environment, - free_leaf_environment, - print_leaf_environment + leaf_environment_mark, + leaf_environment_free, + leaf_environment_print }; @@ -1026,7 +1040,7 @@ SCM_DEFINE (scm_make_leaf_environment, "make-leaf-environment", 0, 0, 0, "will be mutable.") #define FUNC_NAME s_scm_make_leaf_environment { - scm_sizet size = sizeof (struct leaf_environment); + size_t size = sizeof (struct leaf_environment); struct leaf_environment *body = scm_must_malloc (size, FUNC_NAME); SCM env; @@ -1036,7 +1050,7 @@ SCM_DEFINE (scm_make_leaf_environment, "make-leaf-environment", 0, 0, 0, env = scm_make_environment (body); core_environments_init (&body->base, &leaf_environment_funcs); - body->obarray = scm_make_vector (SCM_MAKINUM (scm_symhash_dim), SCM_EOL); + body->obarray = scm_c_make_hash_table (DEFAULT_OBARRAY_SIZE); return env; } @@ -1045,7 +1059,8 @@ SCM_DEFINE (scm_make_leaf_environment, "make-leaf-environment", 0, 0, 0, SCM_DEFINE (scm_leaf_environment_p, "leaf-environment?", 1, 0, 0, (SCM object), - "Return #t if object is a leaf environment, or #f otherwise.") + "Return @code{#t} if object is a leaf environment, or @code{#f}\n" + "otherwise.") #define FUNC_NAME s_scm_leaf_environment_p { return SCM_BOOL (SCM_LEAF_ENVIRONMENT_P (object)); @@ -1231,7 +1246,7 @@ eval_environment_folder (SCM extended_data, SCM symbol, SCM value, SCM tail) if (!SCM_ENVIRONMENT_BOUND_P (local, symbol)) { SCM proc_as_nr = SCM_CADR (extended_data); - unsigned long int proc_as_ul = scm_num2ulong (proc_as_nr, NULL, NULL); + unsigned long int proc_as_ul = scm_num2ulong (proc_as_nr, 0, NULL); scm_environment_folder proc = (scm_environment_folder) proc_as_ul; SCM data = SCM_CDDR (extended_data); @@ -1323,7 +1338,7 @@ eval_environment_cell (SCM env, SCM sym, int for_write) static SCM -mark_eval_environment (SCM env) +eval_environment_mark (SCM env) { struct eval_environment *body = EVAL_ENVIRONMENT (env); @@ -1337,8 +1352,8 @@ mark_eval_environment (SCM env) } -static scm_sizet -free_eval_environment (SCM env) +static size_t +eval_environment_free (SCM env) { core_environments_finalize (env); @@ -1348,7 +1363,7 @@ free_eval_environment (SCM env) static int -print_eval_environment (SCM type, SCM port, scm_print_state *pstate) +eval_environment_print (SCM type, SCM port, scm_print_state *pstate SCM_UNUSED) { SCM address = scm_ulong2num (SCM_UNPACK (type)); SCM base16 = scm_number_to_string (address, SCM_MAKINUM (16)); @@ -1370,9 +1385,9 @@ static struct scm_environment_funcs eval_environment_funcs = { eval_environment_cell, core_environments_observe, core_environments_unobserve, - mark_eval_environment, - free_eval_environment, - print_eval_environment + eval_environment_mark, + eval_environment_free, + eval_environment_print }; @@ -1380,7 +1395,7 @@ void *scm_type_eval_environment = &eval_environment_funcs; static void -eval_environment_observer (SCM caller, SCM eval_env) +eval_environment_observer (SCM caller SCM_UNUSED, SCM eval_env) { SCM obarray = EVAL_ENVIRONMENT (eval_env)->obarray; @@ -1392,22 +1407,26 @@ eval_environment_observer (SCM caller, SCM eval_env) SCM_DEFINE (scm_make_eval_environment, "make-eval-environment", 2, 0, 0, (SCM local, SCM imported), "Return a new environment object eval whose bindings are the\n" - "union of the bindings in the environments local and imported,\n" - "with bindings from local taking precedence. Definitions made\n" - "in eval are placed in local.\n" - "Applying environment-define or environment-undefine to eval\n" - "has the same effect as applying the procedure to local.\n" - "Note that eval incorporates local and imported by reference:\n" + "union of the bindings in the environments @var{local} and\n" + "@var{imported}, with bindings from @var{local} taking\n" + "precedence. Definitions made in eval are placed in @var{local}.\n" + "Applying @code{environment-define} or\n" + "@code{environment-undefine} to eval has the same effect as\n" + "applying the procedure to @var{local}.\n" + "Note that eval incorporates @var{local} and @var{imported} by\n" + "reference:\n" "If, after creating eval, the program changes the bindings of\n" - "local or imported, those changes will be visible in eval.\n" + "@var{local} or @var{imported}, those changes will be visible\n" + "in eval.\n" "Since most Scheme evaluation takes place in eval environments,\n" - "they transparenty cache the bindings received from local and\n" - "imported. Thus, the first time the program looks up a symbol\n" - "in eval, eval may make calls to local or imported to find\n" - "their bindings, but subsequent references to that symbol will\n" - "be as fast as references to bindings in finite environments.\n" - "In typical use, local will be a finite environment, and\n" - "imported will be an import environment") + "they transparently cache the bindings received from @var{local}\n" + "and @var{imported}. Thus, the first time the program looks up\n" + "a symbol in eval, eval may make calls to @var{local} or\n" + "@var{imported} to find their bindings, but subsequent\n" + "references to that symbol will be as fast as references to\n" + "bindings in finite environments.\n" + "In typical use, @var{local} will be a finite environment, and\n" + "@var{imported} will be an import environment") #define FUNC_NAME s_scm_make_eval_environment { SCM env; @@ -1428,7 +1447,7 @@ SCM_DEFINE (scm_make_eval_environment, "make-eval-environment", 2, 0, 0, env = scm_make_environment (body); core_environments_init (&body->base, &eval_environment_funcs); - body->obarray = scm_make_vector (SCM_MAKINUM (scm_symhash_dim), SCM_EOL); + body->obarray = scm_c_make_hash_table (DEFAULT_OBARRAY_SIZE); body->imported = imported; body->imported_observer = SCM_ENVIRONMENT_OBSERVE (imported, eval_environment_observer, env, 1); @@ -1443,7 +1462,8 @@ SCM_DEFINE (scm_make_eval_environment, "make-eval-environment", 2, 0, 0, SCM_DEFINE (scm_eval_environment_p, "eval-environment?", 1, 0, 0, (SCM object), - "Return #t if object is an eval environment, or #f otherwise.") + "Return @code{#t} if object is an eval environment, or @code{#f}\n" + "otherwise.") #define FUNC_NAME s_scm_eval_environment_p { return SCM_BOOL (SCM_EVAL_ENVIRONMENT_P (object)); @@ -1453,7 +1473,7 @@ SCM_DEFINE (scm_eval_environment_p, "eval-environment?", 1, 0, 0, SCM_DEFINE (scm_eval_environment_local, "eval-environment-local", 1, 0, 0, (SCM env), - "Return the local environment of eval environment env.") + "Return the local environment of eval environment @var{env}.") #define FUNC_NAME s_scm_eval_environment_local { SCM_ASSERT (SCM_EVAL_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -1465,7 +1485,7 @@ SCM_DEFINE (scm_eval_environment_local, "eval-environment-local", 1, 0, 0, SCM_DEFINE (scm_eval_environment_set_local_x, "eval-environment-set-local!", 2, 0, 0, (SCM env, SCM local), - "Change env's local environment to LOCAL.") + "Change @var{env}'s local environment to @var{local}.") #define FUNC_NAME s_scm_eval_environment_set_local_x { struct eval_environment *body; @@ -1491,7 +1511,7 @@ SCM_DEFINE (scm_eval_environment_set_local_x, "eval-environment-set-local!", 2, SCM_DEFINE (scm_eval_environment_imported, "eval-environment-imported", 1, 0, 0, (SCM env), - "Return the imported environment of eval environment env.") + "Return the imported environment of eval environment @var{env}.") #define FUNC_NAME s_scm_eval_environment_imported { SCM_ASSERT (SCM_EVAL_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -1503,7 +1523,7 @@ SCM_DEFINE (scm_eval_environment_imported, "eval-environment-imported", 1, 0, 0, SCM_DEFINE (scm_eval_environment_set_imported_x, "eval-environment-set-imported!", 2, 0, 0, (SCM env, SCM imported), - "Change env's imported environment to IMPORTED.") + "Change @var{env}'s imported environment to @var{imported}.") #define FUNC_NAME s_scm_eval_environment_set_imported_x { struct eval_environment *body; @@ -1593,7 +1613,7 @@ import_environment_conflict (SCM env, SCM sym, SCM imports) SCM conflict_proc = IMPORT_ENVIRONMENT (env)->conflict_proc; SCM args = scm_cons2 (env, sym, scm_cons (imports, SCM_EOL)); - return scm_apply (conflict_proc, args, SCM_EOL); + return scm_apply_0 (conflict_proc, args); } @@ -1632,7 +1652,7 @@ import_environment_folder (SCM extended_data, SCM symbol, SCM value, SCM tail) SCM imported_env = SCM_CADR (extended_data); SCM owner = import_environment_lookup (import_env, symbol); SCM proc_as_nr = SCM_CADDR (extended_data); - unsigned long int proc_as_ul = scm_num2ulong (proc_as_nr, NULL, NULL); + unsigned long int proc_as_ul = scm_num2ulong (proc_as_nr, 0, NULL); scm_environment_folder proc = (scm_environment_folder) proc_as_ul; SCM data = SCM_CDDDR (extended_data); @@ -1667,7 +1687,9 @@ import_environment_fold (SCM env, scm_environment_folder proc, SCM data, SCM ini static SCM -import_environment_define (SCM env, SCM sym, SCM val) +import_environment_define (SCM env SCM_UNUSED, + SCM sym SCM_UNUSED, + SCM val SCM_UNUSED) #define FUNC_NAME "import_environment_define" { return SCM_ENVIRONMENT_BINDING_IMMUTABLE; @@ -1676,7 +1698,8 @@ import_environment_define (SCM env, SCM sym, SCM val) static SCM -import_environment_undefine (SCM env, SCM sym) +import_environment_undefine (SCM env SCM_UNUSED, + SCM sym SCM_UNUSED) #define FUNC_NAME "import_environment_undefine" { return SCM_ENVIRONMENT_BINDING_IMMUTABLE; @@ -1739,7 +1762,7 @@ import_environment_cell (SCM env, SCM sym, int for_write) static SCM -mark_import_environment (SCM env) +import_environment_mark (SCM env) { scm_gc_mark (IMPORT_ENVIRONMENT (env)->imports); scm_gc_mark (IMPORT_ENVIRONMENT (env)->import_observers); @@ -1748,8 +1771,8 @@ mark_import_environment (SCM env) } -static scm_sizet -free_import_environment (SCM env) +static size_t +import_environment_free (SCM env) { core_environments_finalize (env); @@ -1759,7 +1782,8 @@ free_import_environment (SCM env) static int -print_import_environment (SCM type, SCM port, scm_print_state *pstate) +import_environment_print (SCM type, SCM port, + scm_print_state *pstate SCM_UNUSED) { SCM address = scm_ulong2num (SCM_UNPACK (type)); SCM base16 = scm_number_to_string (address, SCM_MAKINUM (16)); @@ -1781,9 +1805,9 @@ static struct scm_environment_funcs import_environment_funcs = { import_environment_cell, core_environments_observe, core_environments_unobserve, - mark_import_environment, - free_import_environment, - print_import_environment + import_environment_mark, + import_environment_free, + import_environment_print }; @@ -1791,7 +1815,7 @@ void *scm_type_import_environment = &import_environment_funcs; static void -import_environment_observer (SCM caller, SCM import_env) +import_environment_observer (SCM caller SCM_UNUSED, SCM import_env) { core_environments_broadcast (import_env); } @@ -1799,31 +1823,34 @@ import_environment_observer (SCM caller, SCM import_env) SCM_DEFINE (scm_make_import_environment, "make-import-environment", 2, 0, 0, (SCM imports, SCM conflict_proc), - "Return a new environment imp whose bindings are the union of\n" - "the bindings from the environments in imports; imports must\n" - "be a list of environments. That is, imp binds symbol to\n" - "location when some element of imports does.\n" - "If two different elements of imports have a binding for the\n" - "same symbol, the conflict-proc is called with the following\n" - "parameters: the import environment, the symbol and the list\n" - "of the imported environments that bind the symbol. If the\n" - "conflict-proc returns an environment env, the conflict is\n" - "considered as resolved and the binding from env is used. If\n" - "the conflict-proc returns some non-environment object, the\n" - "conflict is considered unresolved and the symbol is treated\n" - "as unspecified in the import environment.\n" - "The checking for conflicts may be performed lazily, i. e. at\m" + "Return a new environment @var{imp} whose bindings are the union\n" + "of the bindings from the environments in @var{imports};\n" + "@var{imports} must be a list of environments. That is,\n" + "@var{imp} binds a symbol to a location when some element of\n" + "@var{imports} does.\n" + "If two different elements of @var{imports} have a binding for\n" + "the same symbol, the @var{conflict-proc} is called with the\n" + "following parameters: the import environment, the symbol and\n" + "the list of the imported environments that bind the symbol.\n" + "If the @var{conflict-proc} returns an environment @var{env},\n" + "the conflict is considered as resolved and the binding from\n" + "@var{env} is used. If the @var{conflict-proc} returns some\n" + "non-environment object, the conflict is considered unresolved\n" + "and the symbol is treated as unspecified in the import\n" + "environment.\n" + "The checking for conflicts may be performed lazily, i. e. at\n" "the moment when a value or binding for a certain symbol is\n" "requested instead of the moment when the environment is\n" "created or the bindings of the imports change.\n" - "All bindings in imp are immutable. If you apply\n" - "environment-define or environment-undefine to imp, Guile\n" - "will signal an environment:immutable-binding error. However,\n" - "notice that the set of bindings in imp may still change, if\n" - "one of its imported environments changes.") + "All bindings in @var{imp} are immutable. If you apply\n" + "@code{environment-define} or @code{environment-undefine} to\n" + "@var{imp}, Guile will signal an\n" + " @code{environment:immutable-binding} error. However,\n" + "notice that the set of bindings in @var{imp} may still change,\n" + "if one of its imported environments changes.") #define FUNC_NAME s_scm_make_import_environment { - scm_sizet size = sizeof (struct import_environment); + size_t size = sizeof (struct import_environment); struct import_environment *body = scm_must_malloc (size, FUNC_NAME); SCM env; @@ -1848,7 +1875,8 @@ SCM_DEFINE (scm_make_import_environment, "make-import-environment", 2, 0, 0, SCM_DEFINE (scm_import_environment_p, "import-environment?", 1, 0, 0, (SCM object), - "Return #t if object is an import environment, or #f otherwise.") + "Return @code{#t} if object is an import environment, or\n" + "@code{#f} otherwise.") #define FUNC_NAME s_scm_import_environment_p { return SCM_BOOL (SCM_IMPORT_ENVIRONMENT_P (object)); @@ -1858,7 +1886,8 @@ SCM_DEFINE (scm_import_environment_p, "import-environment?", 1, 0, 0, SCM_DEFINE (scm_import_environment_imports, "import-environment-imports", 1, 0, 0, (SCM env), - "Return the list of environments imported by the import environment env.") + "Return the list of environments imported by the import\n" + "environment @var{env}.") #define FUNC_NAME s_scm_import_environment_imports { SCM_ASSERT (SCM_IMPORT_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -1870,7 +1899,8 @@ SCM_DEFINE (scm_import_environment_imports, "import-environment-imports", 1, 0, SCM_DEFINE (scm_import_environment_set_imports_x, "import-environment-set-imports!", 2, 0, 0, (SCM env, SCM imports), - "Change env's list of imported environments to imports, and check for conflicts.") + "Change @var{env}'s list of imported environments to\n" + "@var{imports}, and check for conflicts.") #define FUNC_NAME s_scm_import_environment_set_imports_x { struct import_environment *body = IMPORT_ENVIRONMENT (env); @@ -1881,9 +1911,9 @@ SCM_DEFINE (scm_import_environment_set_imports_x, "import-environment-set-import for (l = imports; SCM_CONSP (l); l = SCM_CDR (l)) { SCM obj = SCM_CAR (l); - SCM_ASSERT (SCM_ENVIRONMENT_P (obj), imports, SCM_ARG1, FUNC_NAME); + SCM_ASSERT (SCM_ENVIRONMENT_P (obj), imports, SCM_ARG2, FUNC_NAME); } - SCM_ASSERT (SCM_NULLP (l), imports, SCM_ARG1, FUNC_NAME); + SCM_ASSERT (SCM_NULLP (l), imports, SCM_ARG2, FUNC_NAME); for (l = body->import_observers; !SCM_NULLP (l); l = SCM_CDR (l)) { @@ -1971,7 +2001,9 @@ export_environment_fold (SCM env, scm_environment_folder proc, SCM data, SCM ini static SCM -export_environment_define (SCM env, SCM sym, SCM val) +export_environment_define (SCM env SCM_UNUSED, + SCM sym SCM_UNUSED, + SCM val SCM_UNUSED) #define FUNC_NAME "export_environment_define" { return SCM_ENVIRONMENT_BINDING_IMMUTABLE; @@ -1980,7 +2012,7 @@ export_environment_define (SCM env, SCM sym, SCM val) static SCM -export_environment_undefine (SCM env, SCM sym) +export_environment_undefine (SCM env SCM_UNUSED, SCM sym SCM_UNUSED) #define FUNC_NAME "export_environment_undefine" { return SCM_ENVIRONMENT_BINDING_IMMUTABLE; @@ -2033,7 +2065,7 @@ export_environment_cell (SCM env, SCM sym, int for_write) static SCM -mark_export_environment (SCM env) +export_environment_mark (SCM env) { struct export_environment *body = EXPORT_ENVIRONMENT (env); @@ -2045,8 +2077,8 @@ mark_export_environment (SCM env) } -static scm_sizet -free_export_environment (SCM env) +static size_t +export_environment_free (SCM env) { core_environments_finalize (env); @@ -2056,7 +2088,8 @@ free_export_environment (SCM env) static int -print_export_environment (SCM type, SCM port, scm_print_state *pstate) +export_environment_print (SCM type, SCM port, + scm_print_state *pstate SCM_UNUSED) { SCM address = scm_ulong2num (SCM_UNPACK (type)); SCM base16 = scm_number_to_string (address, SCM_MAKINUM (16)); @@ -2078,9 +2111,9 @@ static struct scm_environment_funcs export_environment_funcs = { export_environment_cell, core_environments_observe, core_environments_unobserve, - mark_export_environment, - free_export_environment, - print_export_environment + export_environment_mark, + export_environment_free, + export_environment_print }; @@ -2088,7 +2121,7 @@ void *scm_type_export_environment = &export_environment_funcs; static void -export_environment_observer (SCM caller, SCM export_env) +export_environment_observer (SCM caller SCM_UNUSED, SCM export_env) { core_environments_broadcast (export_env); } @@ -2096,43 +2129,49 @@ export_environment_observer (SCM caller, SCM export_env) SCM_DEFINE (scm_make_export_environment, "make-export-environment", 2, 0, 0, (SCM private, SCM signature), - "Return a new environment exp containing only those bindings\n" - "in private whose symbols are present in signature. The\n" - "private argument must be an environment.\n\n" - "The environment exp binds symbol to location when env does,\n" - "and symbol is exported by signature.\n\n" - "Signature is a list specifying which of the bindings in\n" - "private should be visible in exp. Each element of signature\n" - "should be a list of the form:\n" + "Return a new environment @var{exp} containing only those\n" + "bindings in private whose symbols are present in\n" + "@var{signature}. The @var{private} argument must be an\n" + "environment.\n\n" + "The environment @var{exp} binds symbol to location when\n" + "@var{env} does, and symbol is exported by @var{signature}.\n\n" + "@var{signature} is a list specifying which of the bindings in\n" + "@var{private} should be visible in @var{exp}. Each element of\n" + "@var{signature} should be a list of the form:\n" " (symbol attribute ...)\n" "where each attribute is one of the following:\n" - "* the symbol mutable-location exp should treat the location\n" - " bound to symbol as mutable. That is, exp will pass calls\n" - " to env-set! or environment-cell directly through to\n" - " private.\n" - "* the symbol immutable-location exp should treat the\n" - " location bound to symbol as immutable. If the program\n" - " applies environment-set! to exp and symbol, or calls\n" - " environment-cell to obtain a writable value cell,\n" - " environment-set! will signal an\n" - " environment:immutable-location error. Note that, even if\n" - " an export environment treats a location as immutable, the\n" + "@table @asis\n" + "@item the symbol @code{mutable-location}\n" + " @var{exp} should treat the\n" + " location bound to symbol as mutable. That is, @var{exp}\n" + " will pass calls to @code{environment-set!} or\n" + " @code{environment-cell} directly through to private.\n" + "@item the symbol @code{immutable-location}\n" + " @var{exp} should treat\n" + " the location bound to symbol as immutable. If the program\n" + " applies @code{environment-set!} to @var{exp} and symbol, or\n" + " calls @code{environment-cell} to obtain a writable value\n" + " cell, @code{environment-set!} will signal an\n" + " @code{environment:immutable-location} error. Note that, even\n" + " if an export environment treats a location as immutable, the\n" " underlying environment may treat it as mutable, so its\n" " value may change.\n" + "@end table\n" "It is an error for an element of signature to specify both\n" - "mutable-location and immutable-location. If neither is\n" - "specified, immutable-location is assumed.\n\n" + "@code{mutable-location} and @code{immutable-location}. If\n" + "neither is specified, @code{immutable-location} is assumed.\n\n" "As a special case, if an element of signature is a lone\n" - "symbol sym, it is equivalent to an element of the form\n" - "(sym).\n\n" - "All bindings in exp are immutable. If you apply\n" - "environment-define or environment-undefine to exp, Guile\n" - "will signal an environment:immutable-binding error. However,\n" - "notice that the set of bindings in exp may still change, if\n" - "the bindings in private change.") + "symbol @var{sym}, it is equivalent to an element of the form\n" + "@code{(sym)}.\n\n" + "All bindings in @var{exp} are immutable. If you apply\n" + "@code{environment-define} or @code{environment-undefine} to\n" + "@var{exp}, Guile will signal an\n" + "@code{environment:immutable-binding} error. However,\n" + "notice that the set of bindings in @var{exp} may still change,\n" + "if the bindings in private change.") #define FUNC_NAME s_scm_make_export_environment { - scm_sizet size; + size_t size; struct export_environment *body; SCM env; @@ -2163,7 +2202,8 @@ SCM_DEFINE (scm_make_export_environment, "make-export-environment", 2, 0, 0, SCM_DEFINE (scm_export_environment_p, "export-environment?", 1, 0, 0, (SCM object), - "Return #t if object is an export environment, or #f otherwise.") + "Return @code{#t} if object is an export environment, or\n" + "@code{#f} otherwise.") #define FUNC_NAME s_scm_export_environment_p { return SCM_BOOL (SCM_EXPORT_ENVIRONMENT_P (object)); @@ -2173,7 +2213,7 @@ SCM_DEFINE (scm_export_environment_p, "export-environment?", 1, 0, 0, SCM_DEFINE (scm_export_environment_private, "export-environment-private", 1, 0, 0, (SCM env), - "Return the private environment of export environment env.") + "Return the private environment of export environment @var{env}.") #define FUNC_NAME s_scm_export_environment_private { SCM_ASSERT (SCM_EXPORT_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -2185,7 +2225,7 @@ SCM_DEFINE (scm_export_environment_private, "export-environment-private", 1, 0, SCM_DEFINE (scm_export_environment_set_private_x, "export-environment-set-private!", 2, 0, 0, (SCM env, SCM private), - "Change the private environment of export environment env.") + "Change the private environment of export environment @var{env}.") #define FUNC_NAME s_scm_export_environment_set_private_x { struct export_environment *body; @@ -2207,7 +2247,7 @@ SCM_DEFINE (scm_export_environment_set_private_x, "export-environment-set-privat SCM_DEFINE (scm_export_environment_signature, "export-environment-signature", 1, 0, 0, (SCM env), - "Return the signature of export environment env.") + "Return the signature of export environment @var{env}.") #define FUNC_NAME s_scm_export_environment_signature { SCM_ASSERT (SCM_EXPORT_ENVIRONMENT_P (env), env, SCM_ARG1, FUNC_NAME); @@ -2281,7 +2321,7 @@ export_environment_parse_signature (SCM signature, const char* caller) SCM_DEFINE (scm_export_environment_set_signature_x, "export-environment-set-signature!", 2, 0, 0, (SCM env, SCM signature), - "Change the signature of export environment env.") + "Change the signature of export environment @var{env}.") #define FUNC_NAME s_scm_export_environment_set_signature_x { SCM parsed_sig; @@ -2302,22 +2342,27 @@ scm_environments_prehistory () { /* create environment smob */ scm_tc16_environment = scm_make_smob_type ("environment", 0); - scm_set_smob_mark (scm_tc16_environment, mark_environment); - scm_set_smob_free (scm_tc16_environment, free_environment); - scm_set_smob_print (scm_tc16_environment, print_environment); + scm_set_smob_mark (scm_tc16_environment, environment_mark); + scm_set_smob_free (scm_tc16_environment, environment_free); + scm_set_smob_print (scm_tc16_environment, environment_print); /* create observer smob */ scm_tc16_observer = scm_make_smob_type ("observer", 0); - scm_set_smob_mark (scm_tc16_observer, mark_observer); - scm_set_smob_free (scm_tc16_observer, free_observer); - scm_set_smob_print (scm_tc16_observer, print_observer); + scm_set_smob_mark (scm_tc16_observer, observer_mark); + scm_set_smob_print (scm_tc16_observer, observer_print); + + /* create system environment */ + scm_system_environment = scm_make_leaf_environment (); + scm_permanent_object (scm_system_environment); } void scm_init_environments () { +#ifndef SCM_MAGIC_SNARFER #include "libguile/environments.x" +#endif }