Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
22a52da1 DH |
3 | #ifndef SCM_PROCS_H |
4 | #define SCM_PROCS_H | |
5 | /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc. | |
0f2d19dd JB |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License as published by | |
9 | * the Free Software Foundation; either version 2, or (at your option) | |
10 | * any later version. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | * GNU General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License | |
18 | * along with this software; see the file COPYING. If not, write to | |
82892bed JB |
19 | * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, |
20 | * Boston, MA 02111-1307 USA | |
0f2d19dd JB |
21 | * |
22 | * As a special exception, the Free Software Foundation gives permission | |
23 | * for additional uses of the text contained in its release of GUILE. | |
24 | * | |
25 | * The exception is that, if you link the GUILE library with other files | |
26 | * to produce an executable, this does not by itself cause the | |
27 | * resulting executable to be covered by the GNU General Public License. | |
28 | * Your use of that executable is in no way restricted on account of | |
29 | * linking the GUILE library code into it. | |
30 | * | |
31 | * This exception does not however invalidate any other reasons why | |
32 | * the executable file might be covered by the GNU General Public License. | |
33 | * | |
34 | * This exception applies only to the code released by the | |
35 | * Free Software Foundation under the name GUILE. If you copy | |
36 | * code from other Free Software Foundation releases into a copy of | |
37 | * GUILE, as the General Public License permits, the exception does | |
38 | * not apply to the code that you add in this way. To avoid misleading | |
39 | * anyone as to the status of such modified files, you must delete | |
40 | * this exception notice from them. | |
41 | * | |
42 | * If you write modifications of your own for GUILE, it is your choice | |
43 | * whether to permit this exception to apply to your modifications. | |
82892bed | 44 | * If you do not wish that, delete this exception notice. */ |
d3a6bc94 GB |
45 | |
46 | /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999, | |
47 | gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */ | |
0f2d19dd JB |
48 | \f |
49 | ||
b4309c3c | 50 | #include "libguile/__scm.h" |
0f2d19dd JB |
51 | |
52 | \f | |
53 | ||
54 | ||
55 | /* Subrs | |
56 | */ | |
57 | ||
9de33deb MD |
58 | typedef struct |
59 | { | |
60 | SCM handle; /* link back to procedure object */ | |
61 | SCM name; | |
62 | SCM *generic; /* 0 if no generic support | |
63 | * *generic == 0 until first method | |
64 | */ | |
23a62df4 | 65 | SCM properties; /* procedure properties */ |
9de33deb MD |
66 | } scm_subr_entry; |
67 | ||
54778cd3 | 68 | #define SCM_SUBRNUM(subr) (SCM_CELL_WORD_0 (subr) >> 8) |
9de33deb | 69 | #define SCM_SET_SUBRNUM(subr, num) \ |
54778cd3 | 70 | SCM_SET_CELL_WORD_0 (subr, (num << 8) + SCM_TYP7 (subr)) |
9de33deb MD |
71 | #define SCM_SUBR_ENTRY(x) (scm_subr_table[SCM_SUBRNUM (x)]) |
72 | #define SCM_SNAME(x) (SCM_SUBR_ENTRY (x).name) | |
e59bb516 | 73 | #define SCM_SUBRF(x) ((SCM (*)()) SCM_CELL_WORD_1 (x)) |
2d9cdf4e | 74 | #define SCM_SET_SUBRF(x, v) (SCM_SET_CELL_WORD_1 ((x), (v))) |
e59bb516 | 75 | #define SCM_DSUBRF(x) ((double (*)()) SCM_CELL_WORD_1 (x)) |
23a62df4 | 76 | #define SCM_SUBR_PROPS(x) (SCM_SUBR_ENTRY (x).properties) |
54a33a61 | 77 | #define SCM_SUBR_GENERIC(x) (SCM_SUBR_ENTRY (x).generic) |
74cc8503 DH |
78 | |
79 | #define SCM_CCLO_LENGTH(x) (SCM_CELL_WORD_0 (x) >> 8) | |
80 | #define SCM_SET_CCLO_LENGTH(x, v) (SCM_SET_CELL_WORD_0 ((x), ((v) << 8) + scm_tc7_cclo)) | |
81 | #define SCM_CCLO_BASE(x) ((scm_bits_t *) SCM_CELL_WORD_1 (x)) | |
82 | #define SCM_SET_CCLO_BASE(x, v) (SCM_SET_CELL_WORD_1 ((x), (v))) | |
83 | ||
84 | #define SCM_CCLO_REF(x, i) (SCM_PACK (SCM_CCLO_BASE (x) [i])) | |
85 | #define SCM_CCLO_SET(x, i, v) (SCM_CCLO_BASE (x) [i] = SCM_UNPACK (v)) | |
86 | ||
87 | #define SCM_CCLO_SUBR(x) (SCM_CCLO_REF ((x), 0)) | |
88 | #define SCM_SET_CCLO_SUBR(x, v) (SCM_CCLO_SET ((x), 0, (v))) | |
0f2d19dd JB |
89 | |
90 | /* Closures | |
91 | */ | |
92 | ||
a54367e2 | 93 | #define SCM_CLOSUREP(x) (SCM_NIMP(x) && (SCM_TYP3 (x) == scm_tc3_closure)) |
f9a64404 | 94 | #define SCM_CLOSCAR(x) SCM_PACK (SCM_CELL_WORD_0 (x) - scm_tc3_closure) |
a54367e2 MD |
95 | #define SCM_CODE(x) SCM_CAR (SCM_CLOSCAR (x)) |
96 | #define SCM_PROCPROPS(x) SCM_CDR (SCM_CLOSCAR (x)) | |
97 | #define SCM_SETPROCPROPS(x, p) SCM_SETCDR (SCM_CLOSCAR (x), p) | |
3201d763 | 98 | #define SCM_SETCODE(x, e) (SCM_SET_CELL_WORD_0 (x, SCM_UNPACK (scm_cons ((e), SCM_EOL)) \ |
a54367e2 | 99 | + scm_tc3_closure)) |
22a52da1 DH |
100 | #define SCM_ENV(x) SCM_CELL_OBJECT_1 (x) |
101 | #define SCM_SETENV(x, e) SCM_SET_CELL_OBJECT_1 ((x), (e)) | |
9a09deb1 | 102 | #define SCM_TOP_LEVEL(ENV) (SCM_NULLP (ENV) || (SCM_EQ_P (scm_procedure_p (SCM_CAR (ENV)), SCM_BOOL_T))) |
0f2d19dd | 103 | |
03f27074 JB |
104 | /* Procedure-with-setter |
105 | ||
106 | Four representations for procedure-with-setters were | |
107 | considered before selecting this one: | |
108 | ||
109 | 1. A closure where the CODE and ENV slots are used to represent | |
110 | the getter and a new SETTER slot is used for the setter. The | |
111 | original getter is stored as a `getter' procedure property. For | |
112 | closure getters, the CODE and ENV slots contains a copy of the | |
113 | getter's CODE and ENV slots. For subr getters, the CODE contains | |
114 | a call to the subr. | |
115 | ||
116 | 2. A compiled closure with a call to the getter in the cclo | |
117 | procedure. The getter and setter are stored in slots 1 and 2. | |
118 | ||
119 | 3. An entity (i.e. a struct with an associated procedure) with a | |
120 | call to the getter in the entity procedure and the setter stored | |
121 | in slot 0. The original getter is stored in slot 1. | |
122 | ||
123 | 4. A new primitive procedure type supported in the evaluator. The | |
124 | getter and setter are stored in a GETTER and SETTER slot. A call | |
125 | to this procedure type results in a retrieval of the getter and a | |
126 | jump back to the correct eval dispatcher. | |
127 | ||
128 | Representation 4 was selected because of efficiency and | |
129 | simplicity. | |
130 | ||
131 | Rep 1 has the advantage that there is zero penalty for closure | |
132 | getters, but primitive getters will get considerable overhead | |
133 | because the procedure-with-getter will be a closure which calls | |
134 | the getter. | |
135 | ||
136 | Rep 3 has the advantage that a GOOPS accessor can be a subclass of | |
137 | <procedure-with-setter>, but together with rep 2 it suffers from a | |
138 | three level dispatch for non-GOOPS getters: | |
139 | ||
140 | cclo/struct --> dispatch proc --> getter | |
141 | ||
142 | This is because the dispatch procedure must take an extra initial | |
143 | argument (cclo for rep 2, struct for rep 3). | |
144 | ||
145 | Rep 4 has the single disadvantage that it uses up one tc7 type | |
146 | code, but the plan for uniform vectors will very likely free tc7 | |
147 | codes, so this is probably no big problem. Also note that the | |
148 | GETTER and SETTER slots can live directly on the heap, using the | |
149 | new four-word cells. */ | |
150 | ||
d3a6bc94 | 151 | #define SCM_PROCEDURE_WITH_SETTER_P(obj) (SCM_NIMP(obj) && (SCM_TYP7 (obj) == scm_tc7_pws)) |
0cbaaf0b DH |
152 | #define SCM_PROCEDURE(obj) SCM_CELL_OBJECT_1 (obj) |
153 | #define SCM_SETTER(obj) SCM_CELL_OBJECT_2 (obj) | |
64c4580b | 154 | |
9de33deb MD |
155 | extern scm_subr_entry *scm_subr_table; |
156 | extern int scm_subr_table_size; | |
157 | extern int scm_subr_table_room; | |
158 | ||
0f2d19dd JB |
159 | \f |
160 | ||
9de33deb MD |
161 | extern void scm_mark_subr_table (void); |
162 | extern void scm_free_subr_entry (SCM subr); | |
7866a09b | 163 | extern SCM scm_make_subr (const char *name, int type, SCM (*fcn) ()); |
9de33deb MD |
164 | extern SCM scm_make_subr_with_generic (const char *name, |
165 | int type, | |
166 | SCM (*fcn) (), | |
167 | SCM *gf); | |
7866a09b GB |
168 | extern SCM scm_make_subr_opt (const char *name, |
169 | int type, | |
170 | SCM (*fcn) (), | |
171 | int set); | |
172 | extern SCM scm_makcclo (SCM proc, long len); | |
173 | extern SCM scm_procedure_p (SCM obj); | |
174 | extern SCM scm_closure_p (SCM obj); | |
175 | extern SCM scm_thunk_p (SCM obj); | |
9de33deb | 176 | extern int scm_subr_p (SCM obj); |
7866a09b GB |
177 | extern SCM scm_procedure_documentation (SCM proc); |
178 | extern SCM scm_procedure_with_setter_p (SCM obj); | |
179 | extern SCM scm_make_procedure_with_setter (SCM procedure, SCM setter); | |
180 | extern SCM scm_procedure (SCM proc); | |
181 | extern SCM scm_setter (SCM proc); | |
9de33deb | 182 | extern void scm_init_subr_table (void); |
7866a09b | 183 | extern void scm_init_procs (void); |
0f2d19dd | 184 | |
f3667f52 | 185 | #ifdef GUILE_DEBUG |
7866a09b | 186 | extern SCM scm_make_cclo (SCM proc, SCM len); |
f3667f52 JB |
187 | #endif /*GUILE_DEBUG*/ |
188 | ||
1cc91f1b | 189 | \f |
c9c01b11 DH |
190 | |
191 | #if (SCM_DEBUG_DEPRECATED == 0) | |
192 | ||
193 | #define SCM_SUBR_DOC(x) SCM_BOOL_F | |
194 | ||
195 | #endif /* SCM_DEBUG_DEPRECATED == 0 */ | |
196 | ||
22a52da1 | 197 | #endif /* SCM_PROCS_H */ |
89e00824 ML |
198 | |
199 | /* | |
200 | Local Variables: | |
201 | c-file-style: "gnu" | |
202 | End: | |
203 | */ |