Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
3 | #ifndef PROCSH | |
4 | #define PROCSH | |
78a0461a | 5 | /* Copyright (C) 1995, 1996, 1998, 1999 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 | ||
58 | typedef struct scm_subr | |
59 | { | |
60 | long sname; | |
61 | SCM (*cproc) (); | |
62 | } scm_subr; | |
63 | ||
64 | typedef struct scm_iproc | |
65 | { | |
66 | char *scm_string; | |
67 | SCM (*cproc) (); | |
68 | } scm_iproc; | |
69 | ||
70 | typedef struct scm_dsubr | |
71 | { | |
72 | long sname; | |
73 | double (*dproc) (); | |
74 | } scm_dsubr; | |
75 | ||
9de33deb MD |
76 | typedef struct |
77 | { | |
78 | SCM handle; /* link back to procedure object */ | |
79 | SCM name; | |
80 | SCM *generic; /* 0 if no generic support | |
81 | * *generic == 0 until first method | |
82 | */ | |
83 | SCM properties; /* procedure properties */ | |
84 | SCM documentation; | |
85 | } scm_subr_entry; | |
86 | ||
c209c88e | 87 | #define SCM_SUBRNUM(subr) (SCM_CARW (subr) >> 8) |
9de33deb MD |
88 | #define SCM_SET_SUBRNUM(subr, num) \ |
89 | SCM_SETCAR (subr, (num >> 8) + SCM_TYP7 (subr)) | |
90 | #define SCM_SUBR_ENTRY(x) (scm_subr_table[SCM_SUBRNUM (x)]) | |
91 | #define SCM_SNAME(x) (SCM_SUBR_ENTRY (x).name) | |
0f2d19dd JB |
92 | #define SCM_SUBRF(x) (((scm_subr *)(SCM2PTR(x)))->cproc) |
93 | #define SCM_DSUBRF(x) (((scm_dsubr *)(SCM2PTR(x)))->dproc) | |
94 | #define SCM_CCLO_SUBR(x) (SCM_VELTS(x)[0]) | |
95 | ||
9de33deb MD |
96 | #define SCM_SUBR_GENERIC(x) (SCM_SUBR_ENTRY (x).generic) |
97 | #define SCM_SUBR_PROPS(x) (SCM_SUBR_ENTRY (x).properties) | |
98 | #define SCM_SUBR_DOC(x) (SCM_SUBR_ENTRY (x).documentation) | |
99 | ||
0f2d19dd JB |
100 | /* Closures |
101 | */ | |
102 | ||
d3a6bc94 | 103 | #define SCM_CLOSUREP(x) (SCM_NIMP(x) && (SCM_TYP3(x)==scm_tc3_closure)) |
0f2d19dd JB |
104 | #define SCM_CLOSCAR(x) (SCM_CAR(x)-scm_tc3_closure) |
105 | #define SCM_CODE(x) SCM_CAR(SCM_CLOSCAR (x)) | |
106 | #define SCM_PROCPROPS(x) SCM_CDR(SCM_CLOSCAR (x)) | |
a6c64c3c MD |
107 | #define SCM_SETPROCPROPS(x, p) SCM_SETCDR(SCM_CLOSCAR (x), p) |
108 | #define SCM_SETCODE(x, e) (SCM_SETCAR (x, scm_cons ((e), SCM_EOL) + scm_tc3_closure)) | |
0f2d19dd | 109 | #define SCM_ENV(x) SCM_CDR(x) |
a6c64c3c | 110 | #define SCM_SETENV(x, e) SCM_SETCDR (x, e) |
0f2d19dd JB |
111 | #define SCM_TOP_LEVEL(SCM_ENV) (SCM_NULLP(SCM_ENV) || (SCM_BOOL_T == scm_procedure_p (SCM_CAR (SCM_ENV)))) |
112 | ||
03f27074 JB |
113 | /* Procedure-with-setter |
114 | ||
115 | Four representations for procedure-with-setters were | |
116 | considered before selecting this one: | |
117 | ||
118 | 1. A closure where the CODE and ENV slots are used to represent | |
119 | the getter and a new SETTER slot is used for the setter. The | |
120 | original getter is stored as a `getter' procedure property. For | |
121 | closure getters, the CODE and ENV slots contains a copy of the | |
122 | getter's CODE and ENV slots. For subr getters, the CODE contains | |
123 | a call to the subr. | |
124 | ||
125 | 2. A compiled closure with a call to the getter in the cclo | |
126 | procedure. The getter and setter are stored in slots 1 and 2. | |
127 | ||
128 | 3. An entity (i.e. a struct with an associated procedure) with a | |
129 | call to the getter in the entity procedure and the setter stored | |
130 | in slot 0. The original getter is stored in slot 1. | |
131 | ||
132 | 4. A new primitive procedure type supported in the evaluator. The | |
133 | getter and setter are stored in a GETTER and SETTER slot. A call | |
134 | to this procedure type results in a retrieval of the getter and a | |
135 | jump back to the correct eval dispatcher. | |
136 | ||
137 | Representation 4 was selected because of efficiency and | |
138 | simplicity. | |
139 | ||
140 | Rep 1 has the advantage that there is zero penalty for closure | |
141 | getters, but primitive getters will get considerable overhead | |
142 | because the procedure-with-getter will be a closure which calls | |
143 | the getter. | |
144 | ||
145 | Rep 3 has the advantage that a GOOPS accessor can be a subclass of | |
146 | <procedure-with-setter>, but together with rep 2 it suffers from a | |
147 | three level dispatch for non-GOOPS getters: | |
148 | ||
149 | cclo/struct --> dispatch proc --> getter | |
150 | ||
151 | This is because the dispatch procedure must take an extra initial | |
152 | argument (cclo for rep 2, struct for rep 3). | |
153 | ||
154 | Rep 4 has the single disadvantage that it uses up one tc7 type | |
155 | code, but the plan for uniform vectors will very likely free tc7 | |
156 | codes, so this is probably no big problem. Also note that the | |
157 | GETTER and SETTER slots can live directly on the heap, using the | |
158 | new four-word cells. */ | |
159 | ||
d3a6bc94 | 160 | #define SCM_PROCEDURE_WITH_SETTER_P(obj) (SCM_NIMP(obj) && (SCM_TYP7 (obj) == scm_tc7_pws)) |
64c4580b MD |
161 | #define SCM_PROCEDURE(obj) SCM_CADR (obj) |
162 | #define SCM_SETTER(obj) SCM_CDDR (obj) | |
163 | ||
9de33deb MD |
164 | extern scm_subr_entry *scm_subr_table; |
165 | extern int scm_subr_table_size; | |
166 | extern int scm_subr_table_room; | |
167 | ||
0f2d19dd JB |
168 | \f |
169 | ||
9de33deb MD |
170 | extern void scm_mark_subr_table (void); |
171 | extern void scm_free_subr_entry (SCM subr); | |
7866a09b | 172 | extern SCM scm_make_subr (const char *name, int type, SCM (*fcn) ()); |
9de33deb MD |
173 | extern SCM scm_make_subr_with_generic (const char *name, |
174 | int type, | |
175 | SCM (*fcn) (), | |
176 | SCM *gf); | |
7866a09b GB |
177 | extern SCM scm_make_subr_opt (const char *name, |
178 | int type, | |
179 | SCM (*fcn) (), | |
180 | int set); | |
181 | extern SCM scm_makcclo (SCM proc, long len); | |
182 | extern SCM scm_procedure_p (SCM obj); | |
183 | extern SCM scm_closure_p (SCM obj); | |
184 | extern SCM scm_thunk_p (SCM obj); | |
9de33deb | 185 | extern int scm_subr_p (SCM obj); |
7866a09b GB |
186 | extern SCM scm_procedure_documentation (SCM proc); |
187 | extern SCM scm_procedure_with_setter_p (SCM obj); | |
188 | extern SCM scm_make_procedure_with_setter (SCM procedure, SCM setter); | |
189 | extern SCM scm_procedure (SCM proc); | |
190 | extern SCM scm_setter (SCM proc); | |
191 | extern void scm_init_iprocs (const scm_iproc *subra, int type); | |
9de33deb | 192 | extern void scm_init_subr_table (void); |
7866a09b | 193 | extern void scm_init_procs (void); |
0f2d19dd | 194 | |
f3667f52 | 195 | #ifdef GUILE_DEBUG |
7866a09b | 196 | extern SCM scm_make_cclo (SCM proc, SCM len); |
f3667f52 JB |
197 | #endif /*GUILE_DEBUG*/ |
198 | ||
1cc91f1b | 199 | \f |
0f2d19dd | 200 | #endif /* PROCSH */ |