6 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this software; see the file COPYING. If not, write to
20 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
21 * Boston, MA 02111-1307 USA
23 * As a special exception, the Free Software Foundation gives permission
24 * for additional uses of the text contained in its release of GUILE.
26 * The exception is that, if you link the GUILE library with other files
27 * to produce an executable, this does not by itself cause the
28 * resulting executable to be covered by the GNU General Public License.
29 * Your use of that executable is in no way restricted on account of
30 * linking the GUILE library code into it.
32 * This exception does not however invalidate any other reasons why
33 * the executable file might be covered by the GNU General Public License.
35 * This exception applies only to the code released by the
36 * Free Software Foundation under the name GUILE. If you copy
37 * code from other Free Software Foundation releases into a copy of
38 * GUILE, as the General Public License permits, the exception does
39 * not apply to the code that you add in this way. To avoid misleading
40 * anyone as to the status of such modified files, you must delete
41 * this exception notice from them.
43 * If you write modifications of your own for GUILE, it is your choice
44 * whether to permit this exception to apply to your modifications.
45 * If you do not wish that, delete this exception notice. */
49 /* "What's the difference between _scm.h and __scm.h?"
51 _scm.h is not installed; it's only visible to the libguile sources
54 __scm.h is installed, and is #included by <libguile.h>. If both
55 the client and libguile need some piece of information, and it
56 doesn't fit well into the header file for any particular module, it
57 should go in __scm.h. */
62 * The following macros are used to provide additional information for the
63 * compiler, which may help to do better error checking and code
64 * optimization. A second benefit of these macros is, that they also provide
65 * additional information to the developers.
68 /* The macro SCM_NORETURN indicates that a function will never return.
70 * 1) int foo (char arg) SCM_NORETURN;
73 #define SCM_NORETURN __attribute__ ((noreturn))
78 /* The macro SCM_UNUSED indicates that a function, function argument or
79 * variable may potentially be unused.
81 * 1) static int unused_function (char arg) SCM_UNUSED;
82 * 2) int foo (char unused_argument SCM_UNUSED);
83 * 3) int unused_variable SCM_UNUSED;
86 #define SCM_UNUSED __attribute__ ((unused))
92 /* {Supported Options}
94 * These may be defined or undefined.
97 /* Old async mechanism */
98 /* #define GUILE_OLD_ASYNC_CLICK */
100 /* #define GUILE_DEBUG_FREELIST */
102 /* If the compile FLAG `SCM_CAUTIOUS' is #defined then the number of
103 * arguments is always checked for application of closures. If the
104 * compile FLAG `SCM_RECKLESS' is #defined then they are not checked.
105 * Otherwise, number of argument checks for closures are made only
106 * when the function position (whose value is the closure) of a
107 * combination is not an ILOC or a variable (true?). When the
108 * function position of a combination is a symbol it will be checked
109 * only the first time it is evaluated because it will then be
110 * replaced with an ILOC or variable.
115 /* After looking up a local for the first time, rewrite the
116 * code graph, caching its position.
118 #define MEMOIZE_LOCALS
120 /* All the number support there is.
124 /* GC should relinquish empty cons-pair arenas. */
125 /* cmm:FIXME look at this after done mangling the GC */
126 /* #define GC_FREE_SEGMENTS */
128 /* Provide a scheme-accessible count-down timer that
129 * generates a pseudo-interrupt.
134 /* Use engineering notation when converting numbers strings?
139 /* {Unsupported Options}
141 * These must be defined as given here.
147 /* Guile Scheme supports the #f/() distinction; Guile Lisp won't. We
148 have horrible plans for their unification. */
153 /* Random options (not yet supported or in final form). */
155 #define STACK_CHECKING
156 #undef NO_CEVAL_STACK_CHECKING
160 /* SCM_API is a macro prepended to all function and data definitions
161 which should be exported or imported in the resulting dynamic link
162 library (DLL) in the Win32 port. */
164 #if defined (SCM_IMPORT)
165 # define SCM_API __declspec (dllimport) extern
166 #elif defined (SCM_EXPORT) || defined (DLL_EXPORT)
167 # define SCM_API __declspec (dllexport) extern
169 # define SCM_API extern
174 /* What did the configure script discover about the outside world? */
175 #include "libguile/scmconfig.h"
179 /* {Debugging Options}
181 * These compile time options determine whether to include code that is only
182 * useful for debugging guile itself or C level extensions to guile. The
183 * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
184 * guaranteed that a macro named SCM_DEBUG_XXX is defined to be either 0 or 1,
185 * i. e. there is no need to test for the undefined case. This allows to use
186 * these definitions comfortably within code, as in the following example:
187 * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
188 * Any sane compiler will remove the unused branch without any performance
189 * penalty for the resulting code.
191 * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
192 * To change the value of such options you will have to edit this header
193 * file or give suitable options to make, like:
194 * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
198 /* The value of SCM_DEBUG determines the default for most of the not yet
199 * defined debugging options. This allows, for example, to enable most of the
200 * debugging options by simply defining SCM_DEBUG as 1.
206 /* If SCM_DEBUG_CELL_ACCESSES is set to 1, cell accesses will perform
207 * exhaustive parameter checking: It will be verified that cell parameters
208 * actually point to a valid heap cell. Note: If this option is enabled,
209 * guile will run about ten times slower than normally.
211 #ifndef SCM_DEBUG_CELL_ACCESSES
212 #define SCM_DEBUG_CELL_ACCESSES SCM_DEBUG
215 /* If SCM_DEBUG_INTERRUPTS is set to 1, with every deferring and allowing of
216 * interrupts a consistency check will be performed.
218 #ifndef SCM_DEBUG_INTERRUPTS
219 #define SCM_DEBUG_INTERRUPTS SCM_DEBUG
222 /* If SCM_DEBUG_PAIR_ACCESSES is set to 1, accesses to cons cells will be
223 * exhaustively checked. Note: If this option is enabled, guile will run
224 * slower than normally.
226 #ifndef SCM_DEBUG_PAIR_ACCESSES
227 #define SCM_DEBUG_PAIR_ACCESSES SCM_DEBUG
230 /* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
231 * will check whether the rest arguments are actually passed as a proper list.
232 * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
233 * arguments will take it for granted that these are passed as a proper list.
235 #ifndef SCM_DEBUG_REST_ARGUMENT
236 #define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
239 /* Use this for _compile time_ type checking only, since the compiled result
240 * will be quite inefficient. The right way to make use of this option is to
241 * do a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=1', fix your
242 * errors, and then do 'make clean; make'.
244 #ifndef SCM_DEBUG_TYPING_STRICTNESS
245 #define SCM_DEBUG_TYPING_STRICTNESS 1
252 * These compile time options determine whether code for certain features
253 * should be compiled into guile. The common prefix for all option macros
254 * of this kind is "SCM_ENABLE_". It is guaranteed that a macro named
255 * SCM_ENABLE_XXX is defined to be either 0 or 1, i. e. there is no need to
256 * test for the undefined case. This allows to use these definitions
257 * comfortably within code, as in the following example:
258 * #define FOO do { if (SCM_ENABLE_XXX) bar(); else baz(); } while (0)
259 * Any sane compiler will remove the unused branch without any performance
260 * penalty for the resulting code.
262 * Note: Some SCM_ENABLE_XXX options are not settable at configure time.
263 * To change the value of such options you will have to edit this header
264 * file or give suitable options to make, like:
265 * make all CFLAGS="-DSCM_ENABLE_XXX=1 ..."
268 /* If SCM_ENABLE_DEPRECATED is set to 1, deprecated code will be included in
269 * guile, as well as some functions to issue run-time warnings about uses of
270 * deprecated functions.
272 #ifndef SCM_ENABLE_DEPRECATED
273 #define SCM_ENABLE_DEPRECATED 0
278 /* {Architecture and compiler properties}
280 * Guile as of today can only work on systems which fulfill at least the
281 * following requirements:
282 * - long ints have at least 32 bits.
283 * Guile's type system is based on this assumption.
284 * - long ints consist of at least four characters.
285 * It is assumed that cells, i. e. pairs of long ints, are eight character
286 * aligned, because three bits of a cell pointer are used for type data.
287 * - sizeof (void*) == sizeof (long int)
288 * Pointers are stored in SCM objects, and sometimes SCM objects are passed
289 * as void*. Thus, there has to be a one-to-one correspondence.
290 * - numbers are encoded using two's complement.
291 * The implementation of the bitwise scheme level operations is based on
296 #if SIZEOF_UINTPTR_T != 0
297 #define HAVE_UINTPTR_T
300 #if SIZEOF_PTRDIFF_T != 0
301 #define HAVE_PTRDIFF_T
304 #if SIZEOF_LONG_LONG != 0
305 #define HAVE_LONG_LONGS
306 #define HAVE_LONG_LONG
309 #ifndef HAVE_PTRDIFF_T
310 typedef long ptrdiff_t;
318 # define SCM_CHAR_BIT CHAR_BIT
320 # define SCM_CHAR_BIT 8
324 # define SCM_LONG_BIT LONG_BIT
326 # define SCM_LONG_BIT (SCM_CHAR_BIT * sizeof (long) / sizeof (char))
330 # define SCM_CHAR_CODE_LIMIT (UCHAR_MAX + 1L)
332 # define SCM_CHAR_CODE_LIMIT 256L
339 # if HAVE_SYS_TYPES_H
340 # include <sys/types.h>
342 # if HAVE_SYS_STDTYPES_H
343 # include <sys/stdtypes.h>
346 #endif /* def STDC_HEADERS */
350 /* Define some additional CPP macros on Win32 platforms. */
352 # define __REGEX_IMPORT__ 1
353 # define __CRYPT_IMPORT__ 1
354 # define __READLINE_IMPORT__ 1
360 #include "libguile/tags.h"
364 # ifndef CHEAP_CONTINUATIONS
365 typedef int jmp_buf[17];
366 extern int setjump(jmp_buf env
);
367 extern int longjump(jmp_buf env
, int ret
);
368 # define setjmp setjump
369 # define longjmp longjump
375 typedef int jmp_buf[112];
376 extern int setjump(jmp_buf env
);
377 extern int longjump(jmp_buf env
, int ret
);
378 # define setjmp setjump
379 # define longjmp longjump
380 # else /* ndef _CRAY1 */
382 # endif /* ndef _CRAY1 */
383 #endif /* ndef vms */
385 /* James Clark came up with this neat one instruction fix for
386 * continuations on the SPARC. It flushes the register windows so
387 * that all the state of the process is contained in the stack.
391 # define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
393 # define SCM_FLUSH_REGISTER_WINDOWS /* empty */
396 /* If stack is not longword aligned then
399 /* #define SHORT_ALIGN */
411 typedef short SCM_STACKITEM
;
413 typedef long SCM_STACKITEM
;
418 #define SCM_CRITICAL_SECTION_START
419 #define SCM_CRITICAL_SECTION_END
420 #define SCM_THREAD_SWITCHING_CODE
423 #ifdef GUILE_OLD_ASYNC_CLICK
424 SCM_API
unsigned int scm_async_clock
;
426 #define SCM_ASYNC_TICK \
428 if (0 == --scm_async_clock) \
429 scm_async_click (); \
432 SCM_API
int scm_asyncs_pending_p
;
434 #define SCM_ASYNC_TICK /*fixme* should change names */ \
436 if (scm_asyncs_pending_p) \
437 scm_async_click (); \
441 #if (SCM_DEBUG_INTERRUPTS == 1)
443 #define SCM_CHECK_NOT_DISABLED \
445 if (scm_ints_disabled) \
446 fprintf(stderr, "ints already disabled (at %s:%d)\n", \
447 __FILE__, __LINE__); \
450 #define SCM_CHECK_NOT_ENABLED \
452 if (!scm_ints_disabled) \
453 fprintf(stderr, "ints already enabled (at %s:%d)\n", \
454 __FILE__, __LINE__); \
458 #define SCM_CHECK_NOT_DISABLED
459 #define SCM_CHECK_NOT_ENABLED
463 /* Anthony Green writes:
464 When the compiler sees...
468 ...it doesn't actually promise to keep the critical code within the
469 boundries of the DEFER/ALLOW_INTS instructions. It may very well
470 schedule it outside of the magic defined in those macros.
472 However, GCC's volatile asm feature forms a barrier over which code is
473 never moved. So if you add...
475 ...to each of the DEFER_INTS and ALLOW_INTS macros, the critical
476 code will always remain in place. asm's without inputs or outputs
477 are implicitly volatile. */
479 #define SCM_FENCE asm /* volatile */ ("")
484 #define SCM_DEFER_INTS \
487 SCM_CHECK_NOT_DISABLED; \
488 SCM_CRITICAL_SECTION_START; \
490 scm_ints_disabled = 1; \
495 #define SCM_ALLOW_INTS_ONLY \
497 SCM_CRITICAL_SECTION_END; \
498 scm_ints_disabled = 0; \
502 #define SCM_ALLOW_INTS \
505 SCM_CHECK_NOT_ENABLED; \
506 SCM_CRITICAL_SECTION_END; \
508 scm_ints_disabled = 0; \
510 SCM_THREAD_SWITCHING_CODE; \
515 #define SCM_REDEFER_INTS \
518 SCM_CRITICAL_SECTION_START; \
519 ++scm_ints_disabled; \
524 #define SCM_REALLOW_INTS \
527 SCM_CRITICAL_SECTION_END; \
529 --scm_ints_disabled; \
537 SCM_THREAD_SWITCHING_CODE; \
542 /* Classification of critical sections
544 * When Guile moves to POSIX threads, it won't be possible to prevent
545 * context switching. In fact, the whole idea of context switching is
546 * bogus if threads are run by different processors. Therefore, we
547 * must ultimately eliminate all critical sections or enforce them by
550 * All instances of SCM_DEFER_INTS and SCM_ALLOW_INTS should therefore
551 * be classified and replaced by one of the delimiters below. If you
552 * understand what this is all about, I'd like to encourage you to
553 * help with this task. The set of classes below must of course be
554 * incrementally augmented.
556 * MDJ 980419 <djurfeldt@nada.kth.se>
561 * Allocation of a cell with type tag in the CAR.
563 * With POSIX threads, each thread will have a private pool of free
564 * cells. Therefore, this type of section can be removed. But! It
565 * is important that the CDR is initialized first (with the CAR still
566 * indicating a free cell) so that we can guarantee a consistent heap
570 #define SCM_ENTER_A_SECTION SCM_CRITICAL_SECTION_START
571 #define SCM_EXIT_A_SECTION SCM_CRITICAL_SECTION_END
581 #define SCM_ASSERT(_cond, _arg, _pos, _subr)
582 #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg)
583 #define SCM_ASRTGO(_cond, _label)
585 #define SCM_ASSERT(_cond, _arg, _pos, _subr) \
587 scm_wrong_type_arg (_subr, _pos, _arg)
588 #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
590 scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg)
591 #define SCM_ASRTGO(_cond, _label) \
600 /* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that
601 * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value
602 * like SCM_BOOL_F or SCM_UNDEFINED was chosen.
605 SCM_API SCM
scm_call_generic_0 (SCM gf
);
607 #define SCM_WTA_DISPATCH_0(gf, subr) \
608 return (SCM_UNPACK (gf) \
609 ? scm_call_generic_0 ((gf)) \
610 : (scm_error_num_args_subr ((subr)), SCM_UNSPECIFIED))
611 #define SCM_GASSERT0(cond, gf, subr) \
612 if (!(cond)) SCM_WTA_DISPATCH_0((gf), (subr))
614 SCM_API SCM
scm_call_generic_1 (SCM gf
, SCM a1
);
616 #define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
617 return (SCM_UNPACK (gf) \
618 ? scm_call_generic_1 ((gf), (a1)) \
619 : (scm_wrong_type_arg ((subr), (pos), (a1)), SCM_UNSPECIFIED))
620 #define SCM_GASSERT1(cond, gf, a1, pos, subr) \
621 if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
623 SCM_API SCM
scm_call_generic_2 (SCM gf
, SCM a1
, SCM a2
);
625 #define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
626 return (SCM_UNPACK (gf) \
627 ? scm_call_generic_2 ((gf), (a1), (a2)) \
628 : (scm_wrong_type_arg ((subr), (pos), \
629 (pos) == SCM_ARG1 ? (a1) : (a2)), \
631 #define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
632 if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
634 SCM_API SCM
scm_apply_generic (SCM gf
, SCM args
);
636 #define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
637 return (SCM_UNPACK (gf) \
638 ? scm_apply_generic ((gf), (args)) \
639 : (scm_wrong_type_arg ((subr), (pos), \
640 scm_list_ref ((args), \
641 SCM_MAKINUM ((pos) - 1))), \
643 #define SCM_GASSERTn(cond, gf, args, pos, subr) \
644 if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
646 #ifndef SCM_MAGIC_SNARFER
647 /* Let these macros pass through if
648 we are snarfing; thus we can tell the
649 difference between the use of an actual
650 number vs. the use of one of these macros --
651 actual numbers in SCM_VALIDATE_* and SCM_ASSERT
652 constructs must match the formal argument name,
653 but using SCM_ARG* avoids the test */
664 #endif /* SCM_MAGIC_SNARFER */
668 /* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
669 * were encountered. SCM_EXIT_FAILURE is the default code to return from
670 * SCM if errors were encountered. The return code can be explicitly
671 * specified in a SCM program with (scm_quit <n>).
674 #ifndef SCM_EXIT_SUCCESS
676 #define SCM_EXIT_SUCCESS 1
678 #define SCM_EXIT_SUCCESS 0
680 #endif /* ndef SCM_EXIT_SUCCESS */
681 #ifndef SCM_EXIT_FAILURE
683 #define SCM_EXIT_FAILURE 2
685 #define SCM_EXIT_FAILURE 1
687 #endif /* ndef SCM_EXIT_FAILURE */
689 #endif /* SCM___SCM_H */