#ifndef __SCMH
#define __SCMH
-/* Copyright (C) 1995, 1996, 1998, 1999 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* whether to permit this exception to apply to your modifications.
* If you do not wish that, delete this exception notice. */
\f
+
+/* "What's the difference between _scm.h and __scm.h?"
+
+ _scm.h is not installed; it's only visible to the libguile sources
+ themselves.
+
+ __scm.h is installed, and is #included by <libguile.h>. If both
+ the client and libguile need some piece of information, and it
+ doesn't fit well into the header file for any particular module, it
+ should go in __scm.h. */
+
+
/* {Supported Options}
*
* These may be defined or undefined.
*/
+/* Old async mechanism */
+/* #define GUILE_OLD_ASYNC_CLICK */
+
+/* #define GUILE_DEBUG_FREELIST */
+
/* If the compile FLAG `SCM_CAUTIOUS' is #defined then the number of
* arguments is always checked for application of closures. If the
* compile FLAG `SCM_RECKLESS' is #defined then they are not checked.
/* All the number support there is.
*/
-#define SCM_FLOATS
#define BIGNUMS
-/* GC should relinquish empty cons-pair arenas.
- */
-#define GC_FREE_SEGMENTS
+/* GC should relinquish empty cons-pair arenas. */
+/* cmm:FIXME look at this after done mangling the GC */
+/* #define GC_FREE_SEGMENTS */
/* Provide a scheme-accessible count-down timer that
* generates a pseudo-interrupt.
*/
#undef ENGNOT
-/* Include support for uniform arrays?
- *
- * Possibly some of the initialization code depends on this
- * being defined, but that is a bug and should be fixed.
- */
-#define ARRAYS
-
-#undef SCM_CAREFUL_INTS
\f
/* {Unsupported Options}
*
#define STACK_CHECKING
#undef NO_CEVAL_STACK_CHECKING
-#undef LONGLONGS
-
-/* Some auto-generated .h files contain unused prototypes
- * that need these typedefs.
- */
-typedef long long_long;
-typedef unsigned long ulong_long;
-
\f
+
/* What did the configure script discover about the outside world? */
#include "libguile/scmconfig.h"
\f
-/* Write prototype declarations like this:
- int foo SCM_P ((int a, int b));
- At definitions, use K&R style declarations, but make sure there's a
- declarative prototype (as above) in scope. This will give you
- argument type checking, when available, and be harmless otherwise. */
-#ifdef __STDC__
-# define SCM_P(x) x
-#else
-# define SCM_P(x) ()
+
+/* {Debugging Options}
+ *
+ * These compile time options determine whether to include code that is only
+ * useful for debugging guile itself or C level extensions to guile. The
+ * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
+ * guaranteed that a macro named SCM_DEBUG_XXX is defined to be either 0 or 1,
+ * i. e. there is no need to test for the undefined case. This allows to use
+ * these definitions comfortably in macro code, as in the following example:
+ * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
+ * Any sane compiler will remove the unused branch without any performance
+ * penalty for the resulting code.
+ *
+ * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
+ * To change the value of such options you will have to edit this header
+ * file or give suitable options to make, like:
+ * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
+ */
+
+
+/* The value of SCM_DEBUG determines the default for most of the not yet
+ * defined debugging options. This allows, for example, to enable most of the
+ * debugging options by simply defining SCM_DEBUG as 1.
+ */
+#ifndef SCM_DEBUG
+#define SCM_DEBUG 0
#endif
+/* If SCM_DEBUG_CELL_ACCESSES is set to 1, cell accesses will perform
+ * exhaustive parameter checking: It will be verified that cell parameters
+ * actually point to a valid heap cell. Note: If this option is enabled,
+ * guile will run about ten times slower than normally.
+ */
+#ifndef SCM_DEBUG_CELL_ACCESSES
+#define SCM_DEBUG_CELL_ACCESSES SCM_DEBUG
+#endif
+
+/* If SCM_DEBUG_DEPRECATED is set to 1, deprecated code is not compiled. This
+ * can be used by developers to get rid of references to deprecated code.
+ */
+#ifndef SCM_DEBUG_DEPRECATED
+#define SCM_DEBUG_DEPRECATED SCM_DEBUG
+#endif
+
+/* If SCM_DEBUG_INTERRUPTS is set to 1, with every deferring and allowing of
+ * interrupts a consistency check will be performed.
+ */
+#ifndef SCM_DEBUG_INTERRUPTS
+#define SCM_DEBUG_INTERRUPTS SCM_DEBUG
+#endif
+
+/* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
+ * will check whether the rest arguments are actually passed as a proper list.
+ * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
+ * arguments will take it for granted that these are passed as a proper list.
+ */
+#ifndef SCM_DEBUG_REST_ARGUMENT
+#define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
+#endif
+
+/* Use this for _compile time_ type checking only, since the compiled result
+ * will be quite inefficient. The right way to make use of this option is to
+ * do a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=1', fix your
+ * errors, and then do 'make clean; make'.
+ */
+#ifndef SCM_DEBUG_TYPING_STRICTNESS
+#define SCM_DEBUG_TYPING_STRICTNESS 0
+#endif
+
+/* If SCM_ENABLE_VCELLS is set to 1, a couple of functions that deal
+ * with vcells are defined for compatability reasons. Supporting
+ * vcells reduces performance however.
+ *
+ * We use a dedicated macro instead of just SCM_DEBUG_DEPRECATED so
+ * that code the belongs to the `vcell' feature is easier to find.
+ */
+#define SCM_ENABLE_VCELLS !SCM_DEBUG_DEPRECATED
+
+\f
+
+#ifdef HAVE_LONG_LONGS
+
+/* Some auto-generated .h files contain unused prototypes
+ * that need these typedefs.
+ */
+
+#if (SCM_DEBUG_DEPRECATED == 0)
+typedef long long long_long;
+typedef unsigned long long ulong_long;
+#endif
+
+#endif /* HAVE_LONG_LONGS */
+
\f
-/* Define
+/* {Architecture and compiler properties}
*
- * SCM_CHAR_CODE_LIMIT == UCHAR_MAX + 1
- * SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
- * SCM_MOST_NEGATIVE_FIXNUM == SCM_SRS((long)LONG_MIN, 2)
+ * Guile as of today can only work on systems which fulfill at least the
+ * following requirements:
+ * - long ints have at least 32 bits.
+ * Guile's type system is based on this assumption.
+ * - long ints consist of at least four characters.
+ * It is assumed that cells, i. e. pairs of long ints, are eight character
+ * aligned, because three bits of a cell pointer are used for type data.
+ * - sizeof (void*) == sizeof (long int)
+ * Pointers are stored in SCM objects, and sometimes SCM objects are passed
+ * as void*. Thus, there has to be a one-to-one correspondence.
+ * - numbers are encoded using two's complement.
+ * The implementation of the bitwise scheme level operations is based on
+ * this assumption.
+ * - ... add more
*/
#ifdef HAVE_LIMITS_H
# include <limits.h>
-# ifdef UCHAR_MAX
-# define SCM_CHAR_CODE_LIMIT (UCHAR_MAX+1L)
-# else
-# define SCM_CHAR_CODE_LIMIT 256L
-# endif /* def UCHAR_MAX */
-# define SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
-# ifdef _UNICOS /* Stupid cray bug */
-# define SCM_MOST_NEGATIVE_FIXNUM ((long)LONG_MIN/4)
-# else
-# define SCM_MOST_NEGATIVE_FIXNUM SCM_SRS((long)LONG_MIN, 2)
-# endif /* UNICOS */
+#endif
+
+#ifdef CHAR_BIT
+# define SCM_CHAR_BIT CHAR_BIT
+#else
+# define SCM_CHAR_BIT 8
+#endif
+
+#ifdef LONG_BIT
+# define SCM_LONG_BIT LONG_BIT
+#else
+# define SCM_LONG_BIT (SCM_CHAR_BIT * sizeof (long) / sizeof (char))
+#endif
+
+#define SCM_BITS_LENGTH (SCM_CHAR_BIT * SCM_SIZEOF_BITS_T)
+
+#ifdef UCHAR_MAX
+# define SCM_CHAR_CODE_LIMIT (UCHAR_MAX + 1L)
#else
# define SCM_CHAR_CODE_LIMIT 256L
-# define SCM_MOST_POSITIVE_FIXNUM ((long)((unsigned long)~0L>>3))
-# if (0 != ~0)
-# define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
-# else
-# define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM)
-# endif /* (0 != ~0) */
-#endif /* def HAVE_LIMITS_H */
+#endif
+
\f
#ifdef STDC_HEADERS
# include <stdlib.h>
-# ifdef AMIGA
+# if HAVE_SYS_TYPES_H
+# include <sys/types.h>
+# endif
+# if HAVE_SYS_STDTYPES_H
+# include <sys/stdtypes.h>
+# endif
# include <stddef.h>
-# endif /* def AMIGA */
-# define scm_sizet size_t
-#else
-# ifdef _SIZE_T
-# define scm_sizet size_t
-# else
-# define scm_sizet unsigned int
-# endif /* def _SIZE_T */
#endif /* def STDC_HEADERS */
+#if (SCM_DEBUG_DEPRECATED == 0)
+# define scm_sizet size_t
+#endif
+
\f
#include "libguile/tags.h"
\f
#ifndef USE_THREADS
-#define SCM_THREAD_DEFER
-#define SCM_THREAD_ALLOW
-#define SCM_THREAD_REDEFER
-#define SCM_THREAD_REALLOW_1
-#define SCM_THREAD_REALLOW_2
+#define SCM_CRITICAL_SECTION_START
+#define SCM_CRITICAL_SECTION_END
#define SCM_THREAD_SWITCHING_CODE
#endif
+#ifdef GUILE_OLD_ASYNC_CLICK
extern unsigned int scm_async_clock;
#define SCM_ASYNC_TICK \
-{ \
+do { \
if (0 == --scm_async_clock) \
scm_async_click (); \
-} \
+} while(0)
+#else
+extern int scm_asyncs_pending_p;
+
+#define SCM_ASYNC_TICK /*fixme* should change names */ \
+do { \
+ if (scm_asyncs_pending_p) \
+ scm_async_click (); \
+} while (0)
+#endif
-#ifdef SCM_CAREFUL_INTS
+#if (SCM_DEBUG_INTERRUPTS == 1)
+#include <stdio.h>
#define SCM_CHECK_NOT_DISABLED \
- if (scm_ints_disabled) \
- fputs("ints already disabled\n", stderr); \
+ do { \
+ if (scm_ints_disabled) \
+ fprintf(stderr, "ints already disabled (at %s:%d)\n", \
+ __FILE__, __LINE__); \
+ } while (0)
#define SCM_CHECK_NOT_ENABLED \
- if (!scm_ints_disabled) \
- fputs("ints already enabled\n", stderr); \
+ do { \
+ if (!scm_ints_disabled) \
+ fprintf(stderr, "ints already enabled (at %s:%d)\n", \
+ __FILE__, __LINE__); \
+ } while (0)
#else
#define SCM_CHECK_NOT_DISABLED
#endif
#define SCM_DEFER_INTS \
-{ \
+do { \
SCM_FENCE; \
SCM_CHECK_NOT_DISABLED; \
- SCM_THREAD_DEFER; \
+ SCM_CRITICAL_SECTION_START; \
SCM_FENCE; \
scm_ints_disabled = 1; \
SCM_FENCE; \
-} \
+} while (0)
#define SCM_ALLOW_INTS_ONLY \
-{ \
- SCM_THREAD_ALLOW; \
+do { \
+ SCM_CRITICAL_SECTION_END; \
scm_ints_disabled = 0; \
-} \
+} while (0)
#define SCM_ALLOW_INTS \
-{ \
+do { \
SCM_FENCE; \
SCM_CHECK_NOT_ENABLED; \
- SCM_THREAD_SWITCHING_CODE; \
+ SCM_CRITICAL_SECTION_END; \
SCM_FENCE; \
scm_ints_disabled = 0; \
SCM_FENCE; \
- SCM_THREAD_ALLOW; \
- SCM_ASYNC_TICK; \
+ SCM_THREAD_SWITCHING_CODE; \
SCM_FENCE; \
-} \
+} while (0)
#define SCM_REDEFER_INTS \
-{ \
+do { \
SCM_FENCE; \
- SCM_THREAD_REDEFER; \
+ SCM_CRITICAL_SECTION_START; \
++scm_ints_disabled; \
SCM_FENCE; \
-} \
+} while (0)
#define SCM_REALLOW_INTS \
-{ \
+do { \
SCM_FENCE; \
- SCM_THREAD_REALLOW_1; \
- SCM_THREAD_SWITCHING_CODE; \
+ SCM_CRITICAL_SECTION_END; \
SCM_FENCE; \
--scm_ints_disabled; \
- if (!scm_ints_disabled) \
- { \
- SCM_THREAD_REALLOW_2; \
- SCM_ASYNC_TICK; \
- } \
SCM_FENCE; \
-} \
+} while (0)
#define SCM_TICK \
-{ \
- SCM_DEFER_INTS; \
- SCM_ALLOW_INTS; \
-} \
+do { \
+ SCM_ASYNC_TICK; \
+ SCM_THREAD_SWITCHING_CODE; \
+} while (0)
\f
* at all times.
*/
-#ifdef SCM_POSIX_THREADS
-#define SCM_ENTER_A_SECTION
-#define SCM_EXIT_A_SECTION
-#else
-#define SCM_ENTER_A_SECTION SCM_DEFER_INTS
-#define SCM_EXIT_A_SECTION SCM_ALLOW_INTS
-#endif
+#define SCM_ENTER_A_SECTION SCM_CRITICAL_SECTION_START
+#define SCM_EXIT_A_SECTION SCM_CRITICAL_SECTION_END
\f
#ifdef SCM_RECKLESS
#define SCM_ASSERT(_cond, _arg, _pos, _subr)
+#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg)
#define SCM_ASRTGO(_cond, _label)
#else
#define SCM_ASSERT(_cond, _arg, _pos, _subr) \
if (!(_cond)) \
- scm_wta(_arg, (char *)(_pos), _subr)
+ scm_wrong_type_arg (_subr, _pos, _arg)
+#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
+ if (!(_cond)) \
+ scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg)
#define SCM_ASRTGO(_cond, _label) \
if (!(_cond)) \
goto _label
* SCM_WTA_DISPATCH
*/
+/* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that
+ * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value
+ * like SCM_BOOL_F or SCM_UNDEFINED was chosen.
+ */
+
+extern SCM scm_call_generic_0 (SCM gf);
+
+#define SCM_WTA_DISPATCH_0(gf, subr) \
+ return (SCM_UNPACK (gf) \
+ ? scm_call_generic_0 ((gf)) \
+ : (scm_error_num_args_subr ((subr)), SCM_UNSPECIFIED))
+#define SCM_GASSERT0(cond, gf, subr) \
+ if (!(cond)) SCM_WTA_DISPATCH_0((gf), (subr))
+
extern SCM scm_call_generic_1 (SCM gf, SCM a1);
-#define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
- return ((gf) \
- ? scm_call_generic_1 ((gf), (a1)) \
- : scm_wta ((a1), (char *) (pos), (subr)))
+#define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
+ return (SCM_UNPACK (gf) \
+ ? scm_call_generic_1 ((gf), (a1)) \
+ : (scm_wrong_type_arg ((subr), (pos), (a1)), SCM_UNSPECIFIED))
#define SCM_GASSERT1(cond, gf, a1, pos, subr) \
if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
extern SCM scm_call_generic_2 (SCM gf, SCM a1, SCM a2);
-#define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
- return ((gf) \
- ? scm_call_generic_2 ((gf), (a1), (a2)) \
- : scm_wta ((pos) == SCM_ARG1 ? (a1) : (a2), (char *) (pos), (subr)))
+#define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
+ return (SCM_UNPACK (gf) \
+ ? scm_call_generic_2 ((gf), (a1), (a2)) \
+ : (scm_wrong_type_arg ((subr), (pos), \
+ (pos) == SCM_ARG1 ? (a1) : (a2)), \
+ SCM_UNSPECIFIED))
#define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
extern SCM scm_apply_generic (SCM gf, SCM args);
-#define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
- return ((gf) \
- ? scm_apply_generic ((gf), (args)) \
- : scm_wta (scm_list_ref ((args), SCM_MAKINUM ((pos) - 1)), \
- (char *) (pos), \
- (subr)))
+#define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
+ return (SCM_UNPACK (gf) \
+ ? scm_apply_generic ((gf), (args)) \
+ : (scm_wrong_type_arg ((subr), (pos), \
+ scm_list_ref ((args), \
+ SCM_MAKINUM ((pos) - 1))), \
+ SCM_UNSPECIFIED))
#define SCM_GASSERTn(cond, gf, args, pos, subr) \
if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
+#ifndef SCM_MAGIC_SNARFER
+/* Let these macros pass through if
+ we are snarfing; thus we can tell the
+ difference between the use of an actual
+ number vs. the use of one of these macros --
+ actual numbers in SCM_VALIDATE_* and SCM_ASSERT
+ constructs must match the formal argument name,
+ but using SCM_ARG* avoids the test */
+
#define SCM_ARGn 0
#define SCM_ARG1 1
#define SCM_ARG2 2
#define SCM_ARG5 5
#define SCM_ARG6 6
#define SCM_ARG7 7
- /* #define SCM_ARGERR(X) ((X) < SCM_WNA \
- ? (char *)(X) \
- : "wrong type argument")
- */
-/* Following must match entry indexes in scm_errmsgs[].
- * Also, SCM_WNA must follow the last SCM_ARGn in sequence.
- */
+#if (SCM_DEBUG_DEPRECATED == 0)
+
+/* Use SCM_WRONG_NUM_ARGS instead of: */
#define SCM_WNA 8
- /* #define SCM_OVSCM_FLOW 9 */
-#define SCM_OUTOFRANGE 10
-#define SCM_NALLOC 11
- /* #define SCM_STACK_OVFLOW 12 */
- /* #define SCM_EXIT 13 */
-
-
-/* (...still matching scm_errmsgs) These
- * are signals. Signals may become errors
- * but are distinguished because they first
- * try to invoke a handler that can resume
- * the interrupted routine.
- */
-#define SCM_HUP_SIGNAL 14
-#define SCM_INT_SIGNAL 15
-#define SCM_FPE_SIGNAL 16
-#define SCM_BUS_SIGNAL 17
-#define SCM_SEGV_SIGNAL 18
-#define SCM_ALRM_SIGNAL 19
-#define SCM_GC_SIGNAL 20
-#define SCM_TICK_SIGNAL 21
-
-#define SCM_SIG_ORD(X) ((X) - SCM_HUP_SIGNAL)
-#define SCM_ORD_SIG(X) ((X) + SCM_HUP_SIGNAL)
-#define SCM_NUM_SIGS (SCM_SIG_ORD (SCM_TICK_SIGNAL) + 1)
-
-#if 0
-struct errdesc
-{
- char *msg;
- char *s_response;
- short parent_err;
-};
-
-
-extern struct errdesc scm_errmsgs[];
-#endif
+
+/* Use SCM_ASSERT_RANGE or SCM_VALIDATE_XXX_RANGE instead of: */
+#define SCM_OUTOFRANGE 10
+
+/* Use scm_memory_error instead of: */
+#define SCM_NALLOC 11
+
+#define SCM_HUP_SIGNAL 14
+#define SCM_INT_SIGNAL 15
+#define SCM_FPE_SIGNAL 16
+#define SCM_BUS_SIGNAL 17
+#define SCM_SEGV_SIGNAL 18
+#define SCM_ALRM_SIGNAL 19
+#define SCM_GC_SIGNAL 20
+#define SCM_TICK_SIGNAL 21
+#define SCM_SIG_ORD(X) ((X) - SCM_HUP_SIGNAL)
+#define SCM_ORD_SIG(X) ((X) + SCM_HUP_SIGNAL)
+#define SCM_NUM_SIGS (SCM_SIG_ORD (SCM_TICK_SIGNAL) + 1)
+
+#endif /* SCM_DEBUG_DEPRECATED == 0 */
+
+#endif /* SCM_MAGIC_SNARFER */
\f
#endif /* def vms */
#endif /* ndef SCM_EXIT_FAILURE */
-
-
\f
#endif /* __SCMH */
+
+/*
+ Local Variables:
+ c-file-style: "gnu"
+ End:
+*/
HCoop / bpt / guile.git / blobdiff