Commit | Line | Data |
---|---|---|
5d3e2388 DH |
1 | /* classes: h_files */ |
2 | ||
0527e687 DH |
3 | #ifndef SCM_ENVIRONMENTS_H |
4 | #define SCM_ENVIRONMENTS_H | |
5 | ||
102dbb6f | 6 | /* Copyright (C) 1999,2000, 2006, 2008 Free Software Foundation, Inc. |
5d3e2388 | 7 | * |
73be1d9e MV |
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. | |
5d3e2388 | 12 | * |
73be1d9e | 13 | * This library is distributed in the hope that it will be useful, |
5d3e2388 | 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
73be1d9e MV |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
16 | * Lesser General Public License for more details. | |
5d3e2388 | 17 | * |
73be1d9e MV |
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 | |
92205699 | 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 21 | */ |
0527e687 | 22 | |
5d3e2388 DH |
23 | \f |
24 | ||
25 | #include "libguile/__scm.h" | |
26 | ||
27 | \f | |
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 | ||
5d3e2388 DH |
54 | int (*print) (SCM self, SCM port, scm_print_state *pstate); |
55 | }; | |
56 | ||
57 | \f | |
58 | ||
59 | #define SCM_ENVIRONMENT_SUCCESS SCM_BOOL_T | |
93ccaef0 MV |
60 | #define SCM_ENVIRONMENT_BINDING_IMMUTABLE scm_from_int (0) |
61 | #define SCM_ENVIRONMENT_LOCATION_IMMUTABLE scm_from_int (1) | |
5d3e2388 DH |
62 | #define SCM_ENVIRONMENT_LOCATION_NO_CELL SCM_BOOL_F |
63 | ||
33b001fd | 64 | SCM_API scm_t_bits scm_tc16_environment; |
5d3e2388 DH |
65 | |
66 | #define SCM_ENVIRONMENT_P(x) \ | |
67 | (!SCM_IMP (x) && SCM_CELL_TYPE (x) == scm_tc16_environment) | |
68 | #define SCM_ENVIRONMENT_FUNCS(env) \ | |
69 | (*((struct scm_environment_funcs **) SCM_CELL_WORD_1 (env))) | |
70 | #define SCM_ENVIRONMENT_BOUND_P(env, symbol) \ | |
71 | (!SCM_UNBNDP (SCM_ENVIRONMENT_REF (env, symbol))) | |
72 | #define SCM_ENVIRONMENT_REF(env, symbol) \ | |
73 | ((*(SCM_ENVIRONMENT_FUNCS (env)->ref)) (env, symbol)) | |
74 | #define SCM_ENVIRONMENT_FOLD(env, proc, data, init) \ | |
75 | ((*(SCM_ENVIRONMENT_FUNCS (env)->fold)) (env, proc, data, init)) | |
76 | #define SCM_ENVIRONMENT_DEFINE(env, symbol, value) \ | |
77 | ((*(SCM_ENVIRONMENT_FUNCS (env)->define)) (env, symbol, value)) | |
78 | #define SCM_ENVIRONMENT_UNDEFINE(env, symbol) \ | |
79 | ((*(SCM_ENVIRONMENT_FUNCS (env)->undefine)) (env, symbol)) | |
80 | #define SCM_ENVIRONMENT_SET(env, symbol, value) \ | |
81 | ((*(SCM_ENVIRONMENT_FUNCS (env)->set)) (env, symbol, value)) | |
82 | #define SCM_ENVIRONMENT_CELL(env, symbol, for_write) \ | |
83 | ((*(SCM_ENVIRONMENT_FUNCS (env)->cell)) (env, symbol, for_write)) | |
84 | #define SCM_ENVIRONMENT_OBSERVE(env, proc, data, weak_p) \ | |
85 | ((*(SCM_ENVIRONMENT_FUNCS (env)->observe)) (env, proc, data, weak_p)) | |
86 | #define SCM_ENVIRONMENT_UNOBSERVE(env, token) \ | |
87 | ((*(SCM_ENVIRONMENT_FUNCS (env)->unobserve)) (env, token)) | |
88 | ||
33b001fd | 89 | SCM_API scm_t_bits scm_tc16_observer; |
5d3e2388 DH |
90 | |
91 | #define SCM_OBSERVER_P(x) \ | |
92 | (!SCM_IMP (x) && (SCM_CELL_TYPE (x) == scm_tc16_observer)) | |
93 | #define SCM_OBSERVER_ENVIRONMENT(x) \ | |
94 | (SCM_CELL_OBJECT_1 (x)) | |
95 | #define SCM_OBSERVER_DATA(x) \ | |
96 | (SCM_CELL_OBJECT_2 (x)) | |
97 | #define SCM_OBSERVER_PROC(x) \ | |
98 | ((scm_environment_observer) SCM_CELL_WORD_3 (x)) | |
99 | ||
33b001fd MV |
100 | SCM_API SCM scm_system_environment; |
101 | ||
102 | SCM_API void scm_error_environment_unbound (const char *, SCM, SCM) SCM_NORETURN; | |
103 | SCM_API void scm_error_environment_immutable_binding (const char *, SCM, SCM) SCM_NORETURN; | |
104 | SCM_API void scm_error_environment_immutable_location (const char *, SCM, SCM) SCM_NORETURN; | |
105 | ||
106 | SCM_API SCM scm_make_environment (void *type); | |
107 | SCM_API SCM scm_environment_p (SCM env); | |
108 | SCM_API SCM scm_environment_bound_p (SCM env, SCM sym); | |
109 | SCM_API SCM scm_environment_ref (SCM env, SCM sym); | |
110 | SCM_API SCM scm_c_environment_ref (SCM env, SCM sym); | |
111 | SCM_API SCM scm_environment_fold (SCM env, SCM proc, SCM init); | |
112 | SCM_API SCM scm_c_environment_fold (SCM env, scm_environment_folder proc, SCM data, SCM init); | |
113 | SCM_API SCM scm_environment_define (SCM env, SCM sym, SCM val); | |
114 | SCM_API SCM scm_environment_undefine (SCM env, SCM sym); | |
115 | SCM_API SCM scm_environment_set_x (SCM env, SCM sym, SCM val); | |
116 | SCM_API SCM scm_environment_cell (SCM env, SCM sym, SCM for_write); | |
117 | SCM_API SCM scm_c_environment_cell (SCM env, SCM sym, int for_write); | |
118 | SCM_API SCM scm_environment_observe (SCM env, SCM proc); | |
119 | SCM_API SCM scm_environment_observe_weak (SCM env, SCM proc); | |
120 | SCM_API SCM scm_c_environment_observe (SCM env, scm_environment_observer proc, SCM data, int weak_p); | |
121 | SCM_API SCM scm_environment_unobserve (SCM token); | |
122 | ||
102dbb6f LC |
123 | SCM_INTERNAL void scm_environments_prehistory (void); |
124 | SCM_INTERNAL void scm_init_environments (void); | |
5d3e2388 DH |
125 | |
126 | \f | |
127 | ||
33b001fd | 128 | SCM_API void *scm_type_leaf_environment; |
5d3e2388 DH |
129 | |
130 | #define SCM_LEAF_ENVIRONMENT_P(env) \ | |
131 | (SCM_ENVIRONMENT_P (env) \ | |
132 | && SCM_ENVIRONMENT_FUNCS (env) == scm_type_leaf_environment) | |
133 | ||
33b001fd MV |
134 | SCM_API SCM scm_make_leaf_environment (void); |
135 | SCM_API SCM scm_leaf_environment_p (SCM env); | |
5d3e2388 DH |
136 | |
137 | \f | |
138 | ||
33b001fd | 139 | SCM_API void *scm_type_eval_environment; |
5d3e2388 DH |
140 | |
141 | #define SCM_EVAL_ENVIRONMENT_P(env) \ | |
142 | (SCM_ENVIRONMENT_P (env) \ | |
143 | && SCM_ENVIRONMENT_FUNCS (env) == scm_type_eval_environment) | |
144 | ||
33b001fd MV |
145 | SCM_API SCM scm_make_eval_environment (SCM local, SCM imported); |
146 | SCM_API SCM scm_eval_environment_p (SCM env); | |
147 | SCM_API SCM scm_eval_environment_local (SCM env); | |
148 | SCM_API SCM scm_eval_environment_set_local_x (SCM env, SCM local); | |
149 | SCM_API SCM scm_eval_environment_imported (SCM env); | |
150 | SCM_API SCM scm_eval_environment_set_imported_x (SCM env, SCM imported); | |
5d3e2388 DH |
151 | |
152 | \f | |
153 | ||
33b001fd | 154 | SCM_API void *scm_type_import_environment; |
5d3e2388 DH |
155 | |
156 | #define SCM_IMPORT_ENVIRONMENT_P(env) \ | |
4c199a26 DH |
157 | (SCM_ENVIRONMENT_P (env) \ |
158 | && SCM_ENVIRONMENT_FUNCS (env) == scm_type_import_environment) | |
5d3e2388 | 159 | |
33b001fd MV |
160 | SCM_API SCM scm_make_import_environment (SCM imports, SCM conflict_proc); |
161 | SCM_API SCM scm_import_environment_p (SCM env); | |
162 | SCM_API SCM scm_import_environment_imports (SCM env); | |
163 | SCM_API SCM scm_import_environment_set_imports_x (SCM env, SCM imports); | |
5d3e2388 DH |
164 | |
165 | \f | |
166 | ||
33b001fd | 167 | SCM_API void *scm_type_export_environment; |
5d3e2388 DH |
168 | |
169 | #define SCM_EXPORT_ENVIRONMENT_P(env) \ | |
4c199a26 DH |
170 | (SCM_ENVIRONMENT_P (env) \ |
171 | && SCM_ENVIRONMENT_FUNCS (env) == scm_type_export_environment) | |
5d3e2388 | 172 | |
33b001fd MV |
173 | SCM_API SCM scm_make_export_environment (SCM private, SCM signature); |
174 | SCM_API SCM scm_export_environment_p (SCM env); | |
175 | SCM_API SCM scm_export_environment_private (SCM env); | |
176 | SCM_API SCM scm_export_environment_set_private_x (SCM env, SCM private); | |
177 | SCM_API SCM scm_export_environment_signature (SCM env); | |
178 | SCM_API SCM scm_export_environment_set_signature_x (SCM env, SCM signature); | |
5d3e2388 | 179 | |
0527e687 | 180 | #endif /* SCM_ENVIRONMENTS_H */ |
5d3e2388 DH |
181 | |
182 | /* | |
183 | Local Variables: | |
184 | c-file-style: "gnu" | |
185 | End: | |
186 | */ |