* __scm.h, stackchk.h, stackchk.c: Guile now performs stack
[bpt/guile.git] / libguile / __scm.h
1 /* classes: h_files */
2
3 #ifndef __SCMH
4 #define __SCMH
5 /* Copyright (C) 1995, 1996 Free Software Foundation, Inc.
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
19 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
20 *
21 * As a special exception, the Free Software Foundation gives permission
22 * for additional uses of the text contained in its release of GUILE.
23 *
24 * The exception is that, if you link the GUILE library with other files
25 * to produce an executable, this does not by itself cause the
26 * resulting executable to be covered by the GNU General Public License.
27 * Your use of that executable is in no way restricted on account of
28 * linking the GUILE library code into it.
29 *
30 * This exception does not however invalidate any other reasons why
31 * the executable file might be covered by the GNU General Public License.
32 *
33 * This exception applies only to the code released by the
34 * Free Software Foundation under the name GUILE. If you copy
35 * code from other Free Software Foundation releases into a copy of
36 * GUILE, as the General Public License permits, the exception does
37 * not apply to the code that you add in this way. To avoid misleading
38 * anyone as to the status of such modified files, you must delete
39 * this exception notice from them.
40 *
41 * If you write modifications of your own for GUILE, it is your choice
42 * whether to permit this exception to apply to your modifications.
43 * If you do not wish that, delete this exception notice.
44 */
45 \f
46 /* {Supported Options}
47 *
48 * These may be defined or undefined.
49 */
50
51 /* If the compile FLAG `CAUTIOUS' is #defined then the number of
52 * arguments is always checked for application of closures. If the
53 * compile FLAG `RECKLESS' is #defined then they are not checked.
54 * Otherwise, number of argument checks for closures are made only when
55 * the function position (whose value is the closure) of a combination is
56 * not an ILOC or GLOC. When the function position of a combination is a
57 * symbol it will be checked only the first time it is evaluated because
58 * it will then be replaced with an ILOC or GLOC.
59 */
60 #undef RECKLESS
61 #define CAUTIOUS
62
63 /* After looking up a local for the first time, rewrite the
64 * code graph, caching its position.
65 */
66 #define MEMOIZE_LOCALS
67
68 /* All the number support there is.
69 */
70 #define SCM_FLOATS
71 #define BIGNUMS
72
73 /* GC should relinquish empty cons-pair arenas.
74 */
75 #define GC_FREE_SEGMENTS
76
77 /* Provide a scheme-accessible count-down timer that
78 * generates a pseudo-interrupt.
79 */
80 #define TICKS
81
82
83 /* Use engineering notation when converting numbers strings?
84 */
85 #undef ENGNOT
86
87 /* Include support for uniform arrays?
88 *
89 * Possibly some of the initialization code depends on this
90 * being defined, but that is a bug and should be fixed.
91 */
92 #define ARRAYS
93
94 #undef SCM_CAREFUL_INTS
95 \f
96 /* {Unsupported Options}
97 *
98 * These must be defined.
99 */
100
101
102 #define CCLO
103 #define SICP
104
105 \f
106
107 /* Random options (not yet supported or in final form). */
108
109 #define STACK_CHECKING
110 #undef NO_CEVAL_STACK_CHECKING
111 #undef LONGLONGS
112
113 /* Some auto-generated .h files contain unused prototypes
114 * that need these typedefs.
115 */
116 typedef long long_long;
117 typedef unsigned long ulong_long;
118
119
120 \f
121 /* What did the configure script discover about the outside world? */
122 #include <scmconfig.h>
123
124 \f
125 /* Write prototype declarations like this:
126 int foo PROTO(int a, int b);
127 At definitions, use K&R style declarations, but make sure there's a
128 declarative prototype (as above) in scope. This will give you
129 argument type checking, when available, and be harmless otherwise. */
130 #ifdef __STDC__
131 # define PROTO(x) x
132 #else
133 # define PROTO(x) (x)
134 #endif
135
136 \f
137
138 /* Define
139 *
140 * SCM_CHAR_SCM_CODE_LIMIT == UCHAR_MAX + 1
141 * SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
142 * SCM_MOST_NEGATIVE_FIXNUM == SCM_SRS((long)LONG_MIN, 2)
143 */
144
145 #ifdef HAVE_LIMITS_H
146 # include <limits.h>
147 # ifdef UCHAR_MAX
148 # define SCM_CHAR_SCM_CODE_LIMIT (UCHAR_MAX+1L)
149 # else
150 # define SCM_CHAR_SCM_CODE_LIMIT 256L
151 # endif /* def UCHAR_MAX */
152 # define SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
153 # ifdef _UNICOS /* Stupid cray bug */
154 # define SCM_MOST_NEGATIVE_FIXNUM ((long)LONG_MIN/4)
155 # else
156 # define SCM_MOST_NEGATIVE_FIXNUM SCM_SRS((long)LONG_MIN, 2)
157 # endif /* UNICOS */
158 #else
159 # define SCM_CHAR_SCM_CODE_LIMIT 256L
160 # define SCM_MOST_POSITIVE_FIXNUM ((long)((unsigned long)~0L>>3))
161 # if (0 != ~0)
162 # define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
163 # else
164 # define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM)
165 # endif /* (0 != ~0) */
166 #endif /* def HAVE_LIMITS_H */
167 \f
168
169 #include "tags.h"
170
171 \f
172 #ifdef vms
173 # ifndef CHEAP_CONTINUATIONS
174 typedef int jmp_buf[17];
175 extern int setjump(jmp_buf env);
176 extern int longjump(jmp_buf env, int ret);
177 # define setjmp setjump
178 # define longjmp longjump
179 # else
180 # include <setjmp.h>
181 # endif
182 #else /* ndef vms */
183 # ifdef _CRAY1
184 typedef int jmp_buf[112];
185 extern int setjump(jmp_buf env);
186 extern int longjump(jmp_buf env, int ret);
187 # define setjmp setjump
188 # define longjmp longjump
189 # else /* ndef _CRAY1 */
190 # include <setjmp.h>
191 # endif /* ndef _CRAY1 */
192 #endif /* ndef vms */
193
194 /* James Clark came up with this neat one instruction fix for
195 * continuations on the SPARC. It flushes the register windows so
196 * that all the state of the process is contained in the stack.
197 */
198
199 #ifdef sparc
200 # define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
201 #else
202 # define SCM_FLUSH_REGISTER_WINDOWS /* empty */
203 #endif
204
205 /* If stack is not longword aligned then
206 */
207
208 /* #define SHORT_ALIGN */
209 #ifdef THINK_C
210 # define SHORT_ALIGN
211 #endif
212 #ifdef MSDOS
213 # define SHORT_ALIGN
214 #endif
215 #ifdef atarist
216 # define SHORT_ALIGN
217 #endif
218
219 #ifdef SHORT_ALIGN
220 typedef short SCM_STACKITEM;
221 #else
222 typedef long SCM_STACKITEM;
223 #endif
224 \f
225
226 extern unsigned int scm_async_clock;
227 #define SCM_ASYNC_TICK if (0 == --scm_async_clock) scm_async_click ()
228
229 #ifdef SCM_CAREFUL_INTS
230 #define SCM_CHECK_NOT_DISABLED \
231 if (scm_ints_disabled) \
232 fputs("ints already disabled\n", stderr); \
233
234 #define SCM_CHECK_NOT_ENABLED \
235 if (!scm_ints_disabled) \
236 fputs("ints already enabled\n", stderr); \
237
238 #else
239 #define SCM_CHECK_NOT_DISABLED
240 #define SCM_CHECK_NOT_ENABLED
241 #endif
242
243
244 #define SCM_DEFER_INTS \
245 { \
246 SCM_CHECK_NOT_DISABLED; \
247 scm_ints_disabled = 1; \
248 } \
249
250
251 #define SCM_ALLOW_INTS_ONLY \
252 { \
253 scm_ints_disabled = 0; \
254 } \
255
256
257 #define SCM_ALLOW_INTS \
258 { \
259 SCM_CHECK_NOT_ENABLED; \
260 scm_ints_disabled = 0; \
261 SCM_ASYNC_TICK; \
262 } \
263
264
265 #define SCM_REDEFER_INTS \
266 { \
267 ++scm_ints_disabled; \
268 } \
269
270
271 #define SCM_REALLOW_INTS \
272 { \
273 --scm_ints_disabled; \
274 if (!scm_ints_disabled) \
275 SCM_ASYNC_TICK; \
276 } \
277
278
279
280 \f
281
282 /** SCM_ASSERT
283 **
284 **/
285
286
287 #ifdef SCM_RECKLESS
288 #define SCM_ASSERT(_cond, _arg, _pos, _subr)
289 #define SCM_ASRTGO(_cond, _label)
290 #else
291 #define SCM_ASSERT(_cond, _arg, _pos, _subr) \
292 if (!(_cond)) \
293 scm_wta(_arg, (char *)(_pos), _subr)
294 #define SCM_ASRTGO(_cond, _label) \
295 if (!(_cond)) \
296 goto _label
297 #endif
298
299 #define SCM_SYSERROR(_subr) \
300 scm_everr (SCM_UNDEFINED, SCM_EOL, SCM_UNDEFINED, \
301 strerror (errno), _subr)
302
303 /* equivalent to:
304 scm_throw (system_error_sym, \
305 scm_listify (scm_makfrom0str (strerror (errno)), \
306 scm_makfrom0str (_subr), \
307 SCM_UNDEFINED));
308 */
309 #ifdef ENOSYS
310 # define SCM_SYSMISSING(_subr) \
311 scm_everr (SCM_UNDEFINED, SCM_EOL, SCM_UNDEFINED, \
312 strerror (ENOSYS), _subr)
313 #else
314 # define SCM_SYSMISSING(_subr) \
315 scm_everr (SCM_UNDEFINED, SCM_EOL, SCM_UNDEFINED, \
316 "missing function", _subr)
317 #endif
318 #define SCM_ARGn 0
319 #define SCM_ARG1 1
320 #define SCM_ARG2 2
321 #define SCM_ARG3 3
322 #define SCM_ARG4 4
323 #define SCM_ARG5 5
324 #define SCM_ARG6 6
325 #define SCM_ARG7 7
326 #define SCM_ARGERR(X) ((X) < SCM_WNA \
327 ? (char *)(X) \
328 : "wrong type argument")
329
330 /* Following must match entry indexes in scm_errmsgs[].
331 * Also, SCM_WNA must follow the last SCM_ARGn in sequence.
332 */
333 #define SCM_WNA 8
334 #define SCM_OVSCM_FLOW 9
335 #define SCM_OUTOFRANGE 10
336 #define SCM_NALLOC 11
337 #define SCM_STACK_OVFLOW 12
338 #define SCM_EXIT 13
339
340
341 /* (...still matching scm_errmsgs) These
342 * are signals. Signals may become errors
343 * but are distinguished because they first
344 * try to invoke a handler that can resume
345 * the interrupted routine.
346 */
347 #define SCM_HUP_SIGNAL 14
348 #define SCM_INT_SIGNAL 15
349 #define SCM_FPE_SIGNAL 16
350 #define SCM_BUS_SIGNAL 17
351 #define SCM_SEGV_SIGNAL 18
352 #define SCM_ALRM_SIGNAL 19
353 #define SCM_GC_SIGNAL 20
354 #define SCM_TICK_SIGNAL 21
355
356 #define SCM_SIG_ORD(X) ((X) - SCM_HUP_SIGNAL)
357 #define SCM_ORD_SIG(X) ((X) + SCM_HUP_SIGNAL)
358 #define SCM_NUM_SIGS (SCM_SIG_ORD (SCM_TICK_SIGNAL) + 1)
359
360 struct errdesc
361 {
362 char *msg;
363 char *s_response;
364 short parent_err;
365 };
366
367
368 extern struct errdesc scm_errmsgs[];
369
370 \f
371
372 /* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
373 * were encountered. SCM_EXIT_FAILURE is the default code to return from
374 * SCM if errors were encountered. The return code can be explicitly
375 * specified in a SCM program with (scm_quit <n>).
376 */
377
378 #ifndef SCM_EXIT_SUCCESS
379 #ifdef vms
380 #define SCM_EXIT_SUCCESS 1
381 #else
382 #define SCM_EXIT_SUCCESS 0
383 #endif /* def vms */
384 #endif /* ndef SCM_EXIT_SUCCESS */
385 #ifndef SCM_EXIT_FAILURE
386 #ifdef vms
387 #define SCM_EXIT_FAILURE 2
388 #else
389 #define SCM_EXIT_FAILURE 1
390 #endif /* def vms */
391 #endif /* ndef SCM_EXIT_FAILURE */
392
393
394
395 \f
396 #ifdef __STDC__
397
398 #else /* STDC */
399
400 #endif /* STDC */
401
402
403 #endif /* __SCMH */