5 /* Copyright (C) 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
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)
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.
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, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307 USA
22 * As a special exception, the Free Software Foundation gives permission
23 * for additional uses of the text contained in its release of GUILE.
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.
31 * This exception does not however invalidate any other reasons why
32 * the executable file might be covered by the GNU General Public License.
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.
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.
44 * If you do not wish that, delete this exception notice. */
47 /* "What's the difference between _scm.h and __scm.h?"
49 _scm.h is not installed; it's only visible to the libguile sources
52 __scm.h is installed, and is #included by <libguile.h>. If both
53 the client and libguile need some piece of information, and it
54 doesn't fit well into the header file for any particular module, it
55 should go in __scm.h. */
58 /* {Supported Options}
60 * These may be defined or undefined.
63 /* Old async mechanism */
64 /* #define GUILE_OLD_ASYNC_CLICK */
66 /* New scheme for garbage collection */
67 #define GUILE_NEW_GC_SCHEME
69 /* #define GUILE_DEBUG_FREELIST */
71 /* If the compile FLAG `SCM_CAUTIOUS' is #defined then the number of
72 * arguments is always checked for application of closures. If the
73 * compile FLAG `SCM_RECKLESS' is #defined then they are not checked.
74 * Otherwise, number of argument checks for closures are made only when
75 * the function position (whose value is the closure) of a combination is
76 * not an ILOC or GLOC. When the function position of a combination is a
77 * symbol it will be checked only the first time it is evaluated because
78 * it will then be replaced with an ILOC or GLOC.
83 /* After looking up a local for the first time, rewrite the
84 * code graph, caching its position.
86 #define MEMOIZE_LOCALS
88 /* All the number support there is.
92 /* GC should relinquish empty cons-pair arenas.
94 #ifndef GUILE_NEW_GC_SCHEME
95 #define GC_FREE_SEGMENTS
98 /* Provide a scheme-accessible count-down timer that
99 * generates a pseudo-interrupt.
104 /* Use engineering notation when converting numbers strings?
108 #undef SCM_CAREFUL_INTS
110 /* {Unsupported Options}
112 * These must be defined as given here.
118 /* Guile Scheme supports the #f/() distinction; Guile Lisp won't. We
119 have horrible plans for their unification. */
124 /* Random options (not yet supported or in final form). */
126 #define STACK_CHECKING
127 #undef NO_CEVAL_STACK_CHECKING
131 /* What did the configure script discover about the outside world? */
132 #include "libguile/scmconfig.h"
136 /* {Debugging Options}
138 * These compile time options determine whether to include code that is only
139 * useful for debugging guile itself or C level extensions to guile. The
140 * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
141 * guaranteed that a macro named SCM_DEBUG_XXX is defined to be either 0 or 1,
142 * i. e. there is no need to test for the undefined case. This allows to use
143 * these definitions comfortably in macro code, as in the following example:
144 * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
145 * Any sane compiler will remove the unused branch without any performance
146 * penalty for the resulting code.
148 * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
149 * To change the value of such options you will have to edit this header
150 * file or give suitable options to make, like:
151 * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
155 /* The value of SCM_DEBUG determines the default for most of the not yet
156 * defined debugging options. This allows, for example, to enable most of the
157 * debugging options by simply defining SCM_DEBUG as 1.
163 /* If SCM_DEBUG_DEPRECATED is set to 1, deprecated code is not compiled. This
164 * can be used by developers to get rid of references to deprecated code.
166 #ifndef SCM_DEBUG_DEPRECATED
167 #define SCM_DEBUG_DEPRECATED SCM_DEBUG
170 /* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
171 * will check whether the rest arguments are actually passed as a proper list.
172 * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
173 * arguments will take it for granted that these are passed as a proper list.
175 #ifndef SCM_DEBUG_REST_ARGUMENT
176 #define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
179 /* Use this for _compile time_ type checking only, since the compiled result
180 * will be quite inefficient. The right way to make use of this option is to
181 * do a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=1', fix your
182 * errors, and then do 'make clean; make'.
184 #ifndef SCM_DEBUG_TYPING_STRICTNESS
185 #define SCM_DEBUG_TYPING_STRICTNESS 0
190 #ifdef HAVE_LONG_LONGS
192 /* Some auto-generated .h files contain unused prototypes
193 * that need these typedefs.
195 typedef long long long_long
;
196 typedef unsigned long long ulong_long
;
198 #endif /* HAVE_LONG_LONGS */
204 * SCM_CHAR_CODE_LIMIT == UCHAR_MAX + 1
205 * SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
206 * SCM_MOST_NEGATIVE_FIXNUM == SCM_SRS((long)LONG_MIN, 2)
212 # define SCM_CHAR_CODE_LIMIT (UCHAR_MAX+1L)
214 # define SCM_CHAR_CODE_LIMIT 256L
215 # endif /* def UCHAR_MAX */
216 # define SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
217 # ifdef _UNICOS /* Stupid cray bug */
218 # define SCM_MOST_NEGATIVE_FIXNUM ((long)LONG_MIN/4)
220 # define SCM_MOST_NEGATIVE_FIXNUM SCM_SRS((long)LONG_MIN, 2)
223 # define SCM_CHAR_CODE_LIMIT 256L
224 # define SCM_MOST_POSITIVE_FIXNUM ((long)((unsigned long)~0L>>3))
226 # define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
228 # define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM)
229 # endif /* (0 != ~0) */
230 #endif /* def HAVE_LIMITS_H */
237 # endif /* def AMIGA */
238 # define scm_sizet size_t
241 # define scm_sizet size_t
243 # define scm_sizet unsigned int
244 # endif /* def _SIZE_T */
245 #endif /* def STDC_HEADERS */
249 #include "libguile/tags.h"
253 # ifndef CHEAP_CONTINUATIONS
254 typedef int jmp_buf[17];
255 extern int setjump(jmp_buf env
);
256 extern int longjump(jmp_buf env
, int ret
);
257 # define setjmp setjump
258 # define longjmp longjump
264 typedef int jmp_buf[112];
265 extern int setjump(jmp_buf env
);
266 extern int longjump(jmp_buf env
, int ret
);
267 # define setjmp setjump
268 # define longjmp longjump
269 # else /* ndef _CRAY1 */
271 # endif /* ndef _CRAY1 */
272 #endif /* ndef vms */
274 /* James Clark came up with this neat one instruction fix for
275 * continuations on the SPARC. It flushes the register windows so
276 * that all the state of the process is contained in the stack.
280 # define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
282 # define SCM_FLUSH_REGISTER_WINDOWS /* empty */
285 /* If stack is not longword aligned then
288 /* #define SHORT_ALIGN */
300 typedef short SCM_STACKITEM
;
302 typedef long SCM_STACKITEM
;
307 #define SCM_THREAD_DEFER
308 #define SCM_THREAD_ALLOW
309 #define SCM_THREAD_REDEFER
310 #define SCM_THREAD_SWITCHING_CODE
313 #ifdef GUILE_OLD_ASYNC_CLICK
314 extern unsigned int scm_async_clock
;
316 #define SCM_ASYNC_TICK \
318 if (0 == --scm_async_clock) \
319 scm_async_click (); \
322 extern int scm_asyncs_pending_p
;
324 #define SCM_ASYNC_TICK /*fixme* should change names */ \
326 if (scm_asyncs_pending_p) \
327 scm_async_click (); \
331 #ifdef SCM_CAREFUL_INTS
332 #define SCM_CHECK_NOT_DISABLED \
333 if (scm_ints_disabled) \
334 fputs("ints already disabled\n", stderr); \
336 #define SCM_CHECK_NOT_ENABLED \
337 if (!scm_ints_disabled) \
338 fputs("ints already enabled\n", stderr); \
341 #define SCM_CHECK_NOT_DISABLED
342 #define SCM_CHECK_NOT_ENABLED
346 /* Anthony Green writes:
347 When the compiler sees...
351 ...it doesn't actually promise to keep the critical code within the
352 boundries of the DEFER/ALLOW_INTS instructions. It may very well
353 schedule it outside of the magic defined in those macros.
355 However, GCC's volatile asm feature forms a barrier over which code is
356 never moved. So if you add...
358 ...to each of the DEFER_INTS and ALLOW_INTS macros, the critical
359 code will always remain in place. asm's without inputs or outputs
360 are implicitly volatile. */
362 #define SCM_FENCE asm /* volatile */ ("")
367 #define SCM_DEFER_INTS \
370 SCM_CHECK_NOT_DISABLED; \
373 scm_ints_disabled = 1; \
378 #define SCM_ALLOW_INTS_ONLY \
381 scm_ints_disabled = 0; \
385 #define SCM_ALLOW_INTS \
388 SCM_CHECK_NOT_ENABLED; \
389 SCM_THREAD_SWITCHING_CODE; \
391 scm_ints_disabled = 0; \
398 #define SCM_REDEFER_INTS \
401 SCM_THREAD_REDEFER; \
402 ++scm_ints_disabled; \
407 #define SCM_REALLOW_INTS \
410 SCM_THREAD_SWITCHING_CODE; \
412 --scm_ints_disabled; \
426 /* Classification of critical sections
428 * When Guile moves to POSIX threads, it won't be possible to prevent
429 * context switching. In fact, the whole idea of context switching is
430 * bogus if threads are run by different processors. Therefore, we
431 * must ultimately eliminate all critical sections or enforce them by
434 * All instances of SCM_DEFER_INTS and SCM_ALLOW_INTS should therefore
435 * be classified and replaced by one of the delimiters below. If you
436 * understand what this is all about, I'd like to encourage you to
437 * help with this task. The set of classes below must of course be
438 * incrementally augmented.
440 * MDJ 980419 <djurfeldt@nada.kth.se>
445 * Allocation of a cell with type tag in the CAR.
447 * With POSIX threads, each thread will have a private pool of free
448 * cells. Therefore, this type of section can be removed. But! It
449 * is important that the CDR is initialized first (with the CAR still
450 * indicating a free cell) so that we can guarantee a consistent heap
454 #ifdef SCM_POSIX_THREADS
455 #define SCM_ENTER_A_SECTION
456 #define SCM_EXIT_A_SECTION
458 #define SCM_ENTER_A_SECTION SCM_DEFER_INTS
459 #define SCM_EXIT_A_SECTION SCM_ALLOW_INTS
470 #define SCM_ASSERT(_cond, _arg, _pos, _subr)
471 #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr)
472 #define SCM_ASRTGO(_cond, _label)
474 #define SCM_ASSERT(_cond, _arg, _pos, _subr) \
476 scm_wta(_arg, (char *)(_pos), _subr)
477 #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
479 scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg)
480 #define SCM_ASRTGO(_cond, _label) \
489 /* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that
490 * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value
491 * like SCM_BOOL_F or SCM_UNDEFINED was chosen.
494 extern SCM
scm_call_generic_0 (SCM gf
);
496 #define SCM_WTA_DISPATCH_0(gf, arg, pos, subr) \
497 return (SCM_UNPACK (gf) \
498 ? scm_call_generic_0 ((gf)) \
499 : scm_wta ((arg), (char *) (pos), (subr)))
500 #define SCM_GASSERT0(cond, gf, arg, pos, subr) \
501 if (!(cond)) SCM_WTA_DISPATCH_0((gf), (arg), (pos), (subr))
503 extern SCM
scm_call_generic_1 (SCM gf
, SCM a1
);
505 #define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
506 return (SCM_UNPACK (gf) \
507 ? scm_call_generic_1 ((gf), (a1)) \
508 : scm_wta ((a1), (char *) (pos), (subr)))
509 #define SCM_GASSERT1(cond, gf, a1, pos, subr) \
510 if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
512 extern SCM
scm_call_generic_2 (SCM gf
, SCM a1
, SCM a2
);
514 #define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
515 return (SCM_UNPACK (gf) \
516 ? scm_call_generic_2 ((gf), (a1), (a2)) \
517 : scm_wta ((pos) == SCM_ARG1 ? (a1) : (a2), (char *) (pos), (subr)))
518 #define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
519 if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
521 extern SCM
scm_apply_generic (SCM gf
, SCM args
);
523 #define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
524 return (SCM_UNPACK (gf) \
525 ? scm_apply_generic ((gf), (args)) \
526 : scm_wta (scm_list_ref ((args), SCM_MAKINUM ((pos) - 1)), \
529 #define SCM_GASSERTn(cond, gf, args, pos, subr) \
530 if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
532 #ifndef SCM_MAGIC_SNARFER
533 /* Let these macros pass through if
534 we are snarfing; thus we can tell the
535 difference between the use of an actual
536 number vs. the use of one of these macros --
537 actual numbers in SCM_VALIDATE_* and SCM_ASSERT
538 constructs must match the formal argument name,
539 but using SCM_ARG* avoids the test */
549 /* #define SCM_ARGERR(X) ((X) < SCM_WNA \
551 : "wrong type argument")
554 /* Following must match entry indexes in scm_errmsgs[].
555 * Also, SCM_WNA must follow the last SCM_ARGn in sequence.
558 /* #define SCM_OVSCM_FLOW 9 */
559 #define SCM_OUTOFRANGE 10
560 #define SCM_NALLOC 11
561 /* #define SCM_STACK_OVFLOW 12 */
562 /* #define SCM_EXIT 13 */
564 #endif /* SCM_MAGIC_SNARFER */
566 /* (...still matching scm_errmsgs) These
567 * are signals. Signals may become errors
568 * but are distinguished because they first
569 * try to invoke a handler that can resume
570 * the interrupted routine.
572 #define SCM_HUP_SIGNAL 14
573 #define SCM_INT_SIGNAL 15
574 #define SCM_FPE_SIGNAL 16
575 #define SCM_BUS_SIGNAL 17
576 #define SCM_SEGV_SIGNAL 18
577 #define SCM_ALRM_SIGNAL 19
578 #define SCM_GC_SIGNAL 20
579 #define SCM_TICK_SIGNAL 21
581 #define SCM_SIG_ORD(X) ((X) - SCM_HUP_SIGNAL)
582 #define SCM_ORD_SIG(X) ((X) + SCM_HUP_SIGNAL)
583 #define SCM_NUM_SIGS (SCM_SIG_ORD (SCM_TICK_SIGNAL) + 1)
594 extern struct errdesc scm_errmsgs
[];
599 /* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
600 * were encountered. SCM_EXIT_FAILURE is the default code to return from
601 * SCM if errors were encountered. The return code can be explicitly
602 * specified in a SCM program with (scm_quit <n>).
605 #ifndef SCM_EXIT_SUCCESS
607 #define SCM_EXIT_SUCCESS 1
609 #define SCM_EXIT_SUCCESS 0
611 #endif /* ndef SCM_EXIT_SUCCESS */
612 #ifndef SCM_EXIT_FAILURE
614 #define SCM_EXIT_FAILURE 2
616 #define SCM_EXIT_FAILURE 1
618 #endif /* ndef SCM_EXIT_FAILURE */