1 /* classes: h_files */ 2 3 #ifndef SCM_ENVIRONMENTS_H 4 #define SCM_ENVIRONMENTS_H 5 6 /* Copyright (C) 1999,2000, 2006 Free Software Foundation, Inc. 7 * 8 * This library is free software; you can redistribute it and/or 9 * modify it under the terms of the GNU Lesser General Public 10 * License as published by the Free Software Foundation; either 11 * version 2.1 of the License, or (at your option) any later version. 12 * 13 * This library is distributed in the hope that it will be useful, 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16 * Lesser General Public License for more details. 17 * 18 * You should have received a copy of the GNU Lesser General Public 19 * License along with this library; if not, write to the Free Software 20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 21 */ 22 23 24 25 #include "libguile/__scm.h" 26 27 28 29 /* The type for folding functions written in C. A function meant to be passed 30 * to scm_c_environment_fold should have the type scm_environment_folder. 31 */ 32 typedef SCM (*scm_environment_folder) (SCM data, SCM sym, SCM val, SCM tail); 33 34 35 /* The type for observer functions written in C. A function meant to be 36 * passed to scm_c_environment_observe should have the type 37 * scm_environment_observer. 38 */ 39 typedef void (*scm_environment_observer) (SCM env, SCM data); 40 41 42 struct scm_environment_funcs { 43 SCM (*ref) (SCM self, SCM symbol); 44 SCM (*fold) (SCM self, scm_environment_folder proc, SCM data, SCM init); 45 46 SCM (*define) (SCM self, SCM symbol, SCM value); 47 SCM (*undefine) (SCM self, SCM symbol); 48 SCM (*set) (SCM self, SCM symbol, SCM value); 49 50 SCM (*cell) (SCM self, SCM symbol, int for_write); 51 SCM (*observe) (SCM self, scm_environment_observer proc, SCM data, int weak_p); 52 void (*unobserve) (SCM self, SCM token); 53 54 SCM (*mark) (SCM self); 55 void (*free) (SCM self); 56 int (*print) (SCM self, SCM port, scm_print_state *pstate); 57 }; 58 59 60 61 #define SCM_ENVIRONMENT_SUCCESS SCM_BOOL_T 62 #define SCM_ENVIRONMENT_BINDING_IMMUTABLE scm_from_int (0) 63 #define SCM_ENVIRONMENT_LOCATION_IMMUTABLE scm_from_int (1) 64 #define SCM_ENVIRONMENT_LOCATION_NO_CELL SCM_BOOL_F 65 66 SCM_API scm_t_bits scm_tc16_environment; 67 68 #define SCM_ENVIRONMENT_P(x) \ 69 (!SCM_IMP (x) && SCM_CELL_TYPE (x) == scm_tc16_environment) 70 #define SCM_ENVIRONMENT_FUNCS(env) \ 71 (*((struct scm_environment_funcs **) SCM_CELL_WORD_1 (env))) 72 #define SCM_ENVIRONMENT_BOUND_P(env, symbol) \ 73 (!SCM_UNBNDP (SCM_ENVIRONMENT_REF (env, symbol))) 74 #define SCM_ENVIRONMENT_REF(env, symbol) \ 75 ((*(SCM_ENVIRONMENT_FUNCS (env)->ref)) (env, symbol)) 76 #define SCM_ENVIRONMENT_FOLD(env, proc, data, init) \ 77 ((*(SCM_ENVIRONMENT_FUNCS (env)->fold)) (env, proc, data, init)) 78 #define SCM_ENVIRONMENT_DEFINE(env, symbol, value) \ 79 ((*(SCM_ENVIRONMENT_FUNCS (env)->define)) (env, symbol, value)) 80 #define SCM_ENVIRONMENT_UNDEFINE(env, symbol) \ 81 ((*(SCM_ENVIRONMENT_FUNCS (env)->undefine)) (env, symbol)) 82 #define SCM_ENVIRONMENT_SET(env, symbol, value) \ 83 ((*(SCM_ENVIRONMENT_FUNCS (env)->set)) (env, symbol, value)) 84 #define SCM_ENVIRONMENT_CELL(env, symbol, for_write) \ 85 ((*(SCM_ENVIRONMENT_FUNCS (env)->cell)) (env, symbol, for_write)) 86 #define SCM_ENVIRONMENT_OBSERVE(env, proc, data, weak_p) \ 87 ((*(SCM_ENVIRONMENT_FUNCS (env)->observe)) (env, proc, data, weak_p)) 88 #define SCM_ENVIRONMENT_UNOBSERVE(env, token) \ 89 ((*(SCM_ENVIRONMENT_FUNCS (env)->unobserve)) (env, token)) 90 91 SCM_API scm_t_bits scm_tc16_observer; 92 93 #define SCM_OBSERVER_P(x) \ 94 (!SCM_IMP (x) && (SCM_CELL_TYPE (x) == scm_tc16_observer)) 95 #define SCM_OBSERVER_ENVIRONMENT(x) \ 96 (SCM_CELL_OBJECT_1 (x)) 97 #define SCM_OBSERVER_DATA(x) \ 98 (SCM_CELL_OBJECT_2 (x)) 99 #define SCM_OBSERVER_PROC(x) \ 100 ((scm_environment_observer) SCM_CELL_WORD_3 (x)) 101 102 SCM_API SCM scm_system_environment; 103 104 SCM_API void scm_error_environment_unbound (const char *, SCM, SCM) SCM_NORETURN; 105 SCM_API void scm_error_environment_immutable_binding (const char *, SCM, SCM) SCM_NORETURN; 106 SCM_API void scm_error_environment_immutable_location (const char *, SCM, SCM) SCM_NORETURN; 107 108 SCM_API SCM scm_make_environment (void *type); 109 SCM_API SCM scm_environment_p (SCM env); 110 SCM_API SCM scm_environment_bound_p (SCM env, SCM sym); 111 SCM_API SCM scm_environment_ref (SCM env, SCM sym); 112 SCM_API SCM scm_c_environment_ref (SCM env, SCM sym); 113 SCM_API SCM scm_environment_fold (SCM env, SCM proc, SCM init); 114 SCM_API SCM scm_c_environment_fold (SCM env, scm_environment_folder proc, SCM data, SCM init); 115 SCM_API SCM scm_environment_define (SCM env, SCM sym, SCM val); 116 SCM_API SCM scm_environment_undefine (SCM env, SCM sym); 117 SCM_API SCM scm_environment_set_x (SCM env, SCM sym, SCM val); 118 SCM_API SCM scm_environment_cell (SCM env, SCM sym, SCM for_write); 119 SCM_API SCM scm_c_environment_cell (SCM env, SCM sym, int for_write); 120 SCM_API SCM scm_environment_observe (SCM env, SCM proc); 121 SCM_API SCM scm_environment_observe_weak (SCM env, SCM proc); 122 SCM_API SCM scm_c_environment_observe (SCM env, scm_environment_observer proc, SCM data, int weak_p); 123 SCM_API SCM scm_environment_unobserve (SCM token); 124 125 SCM_API void scm_environments_prehistory (void); 126 SCM_API void scm_init_environments (void); 127 128 129 130 SCM_API void *scm_type_leaf_environment; 131 132 #define SCM_LEAF_ENVIRONMENT_P(env) \ 133 (SCM_ENVIRONMENT_P (env) \ 134 && SCM_ENVIRONMENT_FUNCS (env) == scm_type_leaf_environment) 135 136 SCM_API SCM scm_make_leaf_environment (void); 137 SCM_API SCM scm_leaf_environment_p (SCM env); 138 139 140 141 SCM_API void *scm_type_eval_environment; 142 143 #define SCM_EVAL_ENVIRONMENT_P(env) \ 144 (SCM_ENVIRONMENT_P (env) \ 145 && SCM_ENVIRONMENT_FUNCS (env) == scm_type_eval_environment) 146 147 SCM_API SCM scm_make_eval_environment (SCM local, SCM imported); 148 SCM_API SCM scm_eval_environment_p (SCM env); 149 SCM_API SCM scm_eval_environment_local (SCM env); 150 SCM_API SCM scm_eval_environment_set_local_x (SCM env, SCM local); 151 SCM_API SCM scm_eval_environment_imported (SCM env); 152 SCM_API SCM scm_eval_environment_set_imported_x (SCM env, SCM imported); 153 154 155 156 SCM_API void *scm_type_import_environment; 157 158 #define SCM_IMPORT_ENVIRONMENT_P(env) \ 159 (SCM_ENVIRONMENT_P (env) \ 160 && SCM_ENVIRONMENT_FUNCS (env) == scm_type_import_environment) 161 162 SCM_API SCM scm_make_import_environment (SCM imports, SCM conflict_proc); 163 SCM_API SCM scm_import_environment_p (SCM env); 164 SCM_API SCM scm_import_environment_imports (SCM env); 165 SCM_API SCM scm_import_environment_set_imports_x (SCM env, SCM imports); 166 167 168 169 SCM_API void *scm_type_export_environment; 170 171 #define SCM_EXPORT_ENVIRONMENT_P(env) \ 172 (SCM_ENVIRONMENT_P (env) \ 173 && SCM_ENVIRONMENT_FUNCS (env) == scm_type_export_environment) 174 175 SCM_API SCM scm_make_export_environment (SCM private, SCM signature); 176 SCM_API SCM scm_export_environment_p (SCM env); 177 SCM_API SCM scm_export_environment_private (SCM env); 178 SCM_API SCM scm_export_environment_set_private_x (SCM env, SCM private); 179 SCM_API SCM scm_export_environment_signature (SCM env); 180 SCM_API SCM scm_export_environment_set_signature_x (SCM env, SCM signature); 181 182 #endif /* SCM_ENVIRONMENTS_H */ 183 184 /* 185 Local Variables: 186 c-file-style: "gnu" 187 End: 188 */ 189