#ifndef SCM___SCM_H
#define SCM___SCM_H
-/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1998,1999,2000,2001,2002,2003 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
*
* You should have received a copy of the GNU General Public License
* along with this software; see the file COPYING. If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA
*
* As a special exception, the Free Software Foundation gives permission
* for additional uses of the text contained in its release of GUILE.
\f
-/* "What's the difference between _scm.h and __scm.h?"
+/**********************************************************************
+ This file is Guile's central public header.
+
+ When included by other files, this file should preceed any include
+ other than __scm.h.
+
+ Under *NO* circumstances should new items be added to the global
+ namespace (via adding #define, typedef, or similar to this file) with
+ generic names. This usually means that any new names should be
+ prefixed by either SCM_ or GUILE_. i.e. do *not* #define HAVE_FOO or
+ SIZEOF_BAR. See configure.in, gen-scmconfig.h.in, and
+ gen-scmconfig.c for examples of how to properly handle this issue.
+ The main documentation is in gen-scmconfig.c.
+
+ "What's the difference between _scm.h and __scm.h?"
_scm.h is not installed; it's only visible to the libguile sources
- themselves.
+ themselves, and it includes config.h, the private config header.
__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. */
+ should go in __scm.h. __scm.h includes scmconfig.h, the public
+ config header.
+ **********************************************************************/
+
+/* What did the configure script discover about the outside world? */
+#include "libguile/scmconfig.h"
+\f
/* {Compiler hints}
*
* These may be defined or undefined.
*/
-/* Old async mechanism */
-/* #define GUILE_OLD_ASYNC_CLICK */
-
/* #define GUILE_DEBUG_FREELIST */
/* All the number support there is.
\f
-/* What did the configure script discover about the outside world? */
-#include "libguile/scmconfig.h"
-
-\f
-
/* {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 within code, as in the following example:
+ * guaranteed that a macro named SCM_DEBUG_XXX is always defined (typically to
+ * either 0 or 1), i. e. there is no need to test for the undefined case.
+ * This allows to use these definitions comfortably within 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.
#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
+/* The macro SCM_DEBUG_TYPING_STRICTNESS indicates what level of type checking
+ * shall be performed with respect to the use of the SCM datatype. The macro
+ * may be defined to one of the values 0, 1 and 2.
+ *
+ * A value of 0 means that there will be no compile time type checking, since
+ * the SCM datatype will be declared as an integral type. This setting should
+ * only be used on systems, where casting from integral types to pointers may
+ * lead to loss of bit information.
+ *
+ * A value of 1 means that there will an intermediate level of compile time
+ * type checking, since the SCM datatype will be declared as a pointer to an
+ * undefined struct. This setting is the default, since it does not cost
+ * anything in terms of performance or code size.
+ *
+ * A value of 2 provides a maximum level of compile time type checking since
+ * the SCM datatype will be declared as a struct. This setting should be used
+ * for _compile time_ type checking only, since the compiled result is likely
+ * to be quite inefficient. The right way to make use of this option is to do
+ * a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=2', fix your
* errors, and then do 'make clean; make'.
*/
#ifndef SCM_DEBUG_TYPING_STRICTNESS
#define SCM_DEBUG_TYPING_STRICTNESS 1
#endif
+/* If SCM_DEBUG_DEBUGGING_SUPPORT is set to 1, guile will provide a set of
+ * special functions that support debugging with a debugger like gdb or
+ * debugging of guile internals on the scheme level. The behaviour of guile
+ * is not changed by this macro, only the set of functions that are available
+ * will differ. All functions that are introduced this way have the prefix
+ * 'scm_dbg_' on the C level and the prefix 'dbg-' on the scheme level. This
+ * allows to easily determine the set of support functions, given that your
+ * debugger or repl provide automatic name completion. Note that these
+ * functions are intended to be used during interactive debugging sessions
+ * only. They are not considered part of guile's official API. They may
+ * change or disappear without notice or deprecation phase.
+ */
+#ifndef SCM_DEBUG_DEBUGGING_SUPPORT
+#define SCM_DEBUG_DEBUGGING_SUPPORT SCM_DEBUG
+#endif
+
\f
/* {Feature Options}
*
* Guile as of today can only work on systems which fulfill at least the
* following requirements:
- * - long ints have at least 32 bits.
+ *
+ * - scm_t_bits and SCM variables 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.
+ *
+ * - sizeof (scm_t_bits) >= sizeof (void*) and sizeof (SCM) >= sizeof (void*)
+ * Guile's type system is based on this assumption, since it must be
+ * possible to store pointers to cells on the heap in scm_t_bits and SCM
+ * variables.
+ *
+ * - sizeof (scm_t_bits) >= 4 and sizeof (scm_t_bits) is a power of 2.
+ * Guile's type system is based on this assumption. In particular, it is
+ * assumed that cells, i. e. pairs of scm_t_bits variables, are eight
+ * character aligned. This is because three bits of a scm_t_bits variable
+ * that is holding a pointer to a cell on the heap must be available for
+ * storing type data.
+ *
+ * - sizeof (scm_t_bits) <= sizeof (void*) and sizeof (SCM) <= sizeof (void*)
+ * In some parts of guile, scm_t_bits and SCM variables are passed to
+ * functions as void* arguments. Together with the requirement above, this
+ * requires a one-to-one correspondence between the size of a void* and the
+ * sizes of scm_t_bits and SCM variables.
+ *
* - numbers are encoded using two's complement.
* The implementation of the bitwise scheme level operations is based on
* this assumption.
+ *
* - ... add more
*/
-#if SIZEOF_UINTPTR_T != 0 && defined(UINTPTR_MAX) \
- && defined(INTPTR_MAX) \
- && defined(INTPTR_MIN)
-/* Used as SCM if available, so we bundle related attributes to avoid possible
- type incon[st][oi]n[ae]nce later. Word in tags.h. */
-#define HAVE_UINTPTR_T 1
-#endif
-
-#if SIZEOF_PTRDIFF_T != 0
-#define HAVE_PTRDIFF_T 1
-#endif
-
-#if SIZEOF_LONG_LONG != 0
-#define HAVE_LONG_LONGS 1
-#define HAVE_LONG_LONG 1
-#endif
-
-#ifndef HAVE_PTRDIFF_T
-typedef long ptrdiff_t;
-#endif
-
-#ifdef HAVE_LIMITS_H
-# include <limits.h>
-#endif
-
#ifdef CHAR_BIT
# define SCM_CHAR_BIT CHAR_BIT
#else
# define SCM_CHAR_CODE_LIMIT 256L
#endif
-\f
+#define SCM_I_UTYPE_MAX(type) ((type)-1)
+#define SCM_I_TYPE_MAX(type,umax) ((type)((umax)/2))
+#define SCM_I_TYPE_MIN(type,umax) (-((type)((umax)/2))-1)
-#ifdef STDC_HEADERS
-# include <stdlib.h>
-# 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 STDC_HEADERS */
+#define SCM_T_UINT8_MAX SCM_I_UTYPE_MAX(scm_t_uint8)
+#define SCM_T_INT8_MIN SCM_I_TYPE_MIN(scm_t_int8,SCM_T_UINT8_MAX)
+#define SCM_T_INT8_MAX SCM_I_TYPE_MAX(scm_t_int8,SCM_T_UINT8_MAX)
-\f
+#define SCM_T_UINT16_MAX SCM_I_UTYPE_MAX(scm_t_uint16)
+#define SCM_T_INT16_MIN SCM_I_TYPE_MIN(scm_t_int16,SCM_T_UINT16_MAX)
+#define SCM_T_INT16_MAX SCM_I_TYPE_MAX(scm_t_int16,SCM_T_UINT16_MAX)
+
+#define SCM_T_UINT32_MAX SCM_I_UTYPE_MAX(scm_t_uint32)
+#define SCM_T_INT32_MIN SCM_I_TYPE_MIN(scm_t_int32,SCM_T_UINT32_MAX)
+#define SCM_T_INT32_MAX SCM_I_TYPE_MAX(scm_t_int32,SCM_T_UINT32_MAX)
+
+#if SCM_HAVE_T_INT64
+#define SCM_T_UINT64_MAX SCM_I_UTYPE_MAX(scm_t_uint64)
+#define SCM_T_INT64_MIN SCM_I_TYPE_MIN(scm_t_int64,SCM_T_UINT64_MAX)
+#define SCM_T_INT64_MAX SCM_I_TYPE_MAX(scm_t_int64,SCM_T_UINT64_MAX)
+#endif
-/* Define some additional CPP macros on Win32 platforms. */
-#if USE_DLL_IMPORT
-# define __REGEX_IMPORT__ 1
-# define __CRYPT_IMPORT__ 1
-# define __READLINE_IMPORT__ 1
-# define QT_IMPORT 1
+#if SCM_SIZEOF_LONG_LONG
+#define SCM_I_ULLONG_MAX SCM_I_UTYPE_MAX(unsigned long long)
+#define SCM_I_LLONG_MIN SCM_I_TYPE_MIN(long long,SCM_I_ULLONG_MAX)
+#define SCM_I_LLONG_MAX SCM_I_TYPE_MAX(long long,SCM_I_ULLONG_MAX)
#endif
+#define SCM_T_UINTMAX_MAX SCM_I_UTYPE_MAX(scm_t_uintmax)
+#define SCM_T_INTMAX_MIN SCM_I_TYPE_MIN(scm_t_intmax,SCM_T_UINTMAX_MAX)
+#define SCM_T_INTMAX_MAX SCM_I_TYPE_MAX(scm_t_intmax,SCM_T_UINTMAX_MAX)
+
+#define SCM_I_SIZE_MAX SCM_I_UTYPE_MAX(size_t)
+#define SCM_I_SSIZE_MIN SCM_I_TYPE_MIN(ssize_t,SCM_I_SIZE_MAX)
+#define SCM_I_SSIZE_MAX SCM_I_TYPE_MAX(ssize_t,SCM_I_SIZE_MAX)
+
\f
#include "libguile/tags.h"
* that all the state of the process is contained in the stack.
*/
-#ifdef sparc
+#if defined (sparc) || defined (__sparc__) || defined (__sparc)
# define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
#else
# define SCM_FLUSH_REGISTER_WINDOWS /* empty */
#else
typedef long SCM_STACKITEM;
#endif
-\f
-
-#ifndef USE_THREADS
-#define SCM_CRITICAL_SECTION_START
-#define SCM_CRITICAL_SECTION_END
-#define SCM_THREAD_SWITCHING_CODE
-#endif
-
-#ifdef GUILE_OLD_ASYNC_CLICK
-SCM_API unsigned int scm_async_clock;
-#define SCM_ASYNC_TICK \
-do { \
- if (0 == --scm_async_clock) \
- scm_async_click (); \
-} while(0)
-#else
-SCM_API int scm_asyncs_pending_p;
+/* Cast pointer through (void *) in order to avoid compiler warnings
+ when strict aliasing is enabled */
+#define SCM_STACK_PTR(ptr) ((SCM_STACKITEM *) (void *) (ptr))
+\f
#define SCM_ASYNC_TICK /*fixme* should change names */ \
do { \
- if (scm_asyncs_pending_p) \
+ if (SCM_I_CURRENT_THREAD->pending_asyncs) \
scm_async_click (); \
} while (0)
-#endif
-
-#if (SCM_DEBUG_INTERRUPTS == 1)
-#include <stdio.h>
-#define SCM_CHECK_NOT_DISABLED \
- do { \
- if (scm_ints_disabled) \
- fprintf(stderr, "ints already disabled (at %s:%d)\n", \
- __FILE__, __LINE__); \
- } while (0)
-
-#define SCM_CHECK_NOT_ENABLED \
- do { \
- if (!scm_ints_disabled) \
- fprintf(stderr, "ints already enabled (at %s:%d)\n", \
- __FILE__, __LINE__); \
- } while (0)
-
-#else
-#define SCM_CHECK_NOT_DISABLED
-#define SCM_CHECK_NOT_ENABLED
-#endif
/* Anthony Green writes:
are implicitly volatile. */
#ifdef __GNUC__
#define SCM_FENCE asm /* volatile */ ("")
+#elif defined (__INTEL_COMPILER) && defined (__ia64)
+#define SCM_FENCE __memory_barrier()
#else
#define SCM_FENCE
#endif
-#define SCM_DEFER_INTS \
-do { \
- SCM_FENCE; \
- SCM_CHECK_NOT_DISABLED; \
- SCM_CRITICAL_SECTION_START; \
- SCM_FENCE; \
- scm_ints_disabled = 1; \
- SCM_FENCE; \
-} while (0)
-
-
-#define SCM_ALLOW_INTS_ONLY \
-do { \
- SCM_CRITICAL_SECTION_END; \
- scm_ints_disabled = 0; \
-} while (0)
-
-
-#define SCM_ALLOW_INTS \
-do { \
- SCM_FENCE; \
- SCM_CHECK_NOT_ENABLED; \
- SCM_CRITICAL_SECTION_END; \
- SCM_FENCE; \
- scm_ints_disabled = 0; \
- SCM_FENCE; \
- SCM_THREAD_SWITCHING_CODE; \
- SCM_FENCE; \
-} while (0)
-
-
-#define SCM_REDEFER_INTS \
-do { \
- SCM_FENCE; \
- SCM_CRITICAL_SECTION_START; \
- ++scm_ints_disabled; \
- SCM_FENCE; \
-} while (0)
-
-
-#define SCM_REALLOW_INTS \
-do { \
- SCM_FENCE; \
- SCM_CRITICAL_SECTION_END; \
- SCM_FENCE; \
- --scm_ints_disabled; \
- SCM_FENCE; \
-} while (0)
-
-
#define SCM_TICK \
do { \
SCM_ASYNC_TICK; \
\f
-/* Classification of critical sections
- *
- * When Guile moves to POSIX threads, it won't be possible to prevent
- * context switching. In fact, the whole idea of context switching is
- * bogus if threads are run by different processors. Therefore, we
- * must ultimately eliminate all critical sections or enforce them by
- * use of mutecis.
- *
- * All instances of SCM_DEFER_INTS and SCM_ALLOW_INTS should therefore
- * be classified and replaced by one of the delimiters below. If you
- * understand what this is all about, I'd like to encourage you to
- * help with this task. The set of classes below must of course be
- * incrementally augmented.
- *
- * MDJ 980419 <djurfeldt@nada.kth.se>
- */
-
-/* A sections
- *
- * Allocation of a cell with type tag in the CAR.
- *
- * With POSIX threads, each thread will have a private pool of free
- * cells. Therefore, this type of section can be removed. But! It
- * is important that the CDR is initialized first (with the CAR still
- * indicating a free cell) so that we can guarantee a consistent heap
- * at all times.
- */
-
-#define SCM_ENTER_A_SECTION SCM_CRITICAL_SECTION_START
-#define SCM_EXIT_A_SECTION SCM_CRITICAL_SECTION_END
-
-\f
-
/** SCM_ASSERT
**
**/
#define SCM_ASRTGO(_cond, _label)
#else
#define SCM_ASSERT(_cond, _arg, _pos, _subr) \
- if (!(_cond)) \
- scm_wrong_type_arg (_subr, _pos, _arg)
+ do { if (!(_cond)) \
+ scm_wrong_type_arg (_subr, _pos, _arg); } while (0)
#define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
- if (!(_cond)) \
- scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg)
+ do { if (!(_cond)) \
+ scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg); } while (0)
#define SCM_ASRTGO(_cond, _label) \
- if (!(_cond)) \
- goto _label
+ do { if (!(_cond)) \
+ goto _label; } while (0)
#endif
/*
? scm_apply_generic ((gf), (args)) \
: (scm_wrong_type_arg ((subr), (pos), \
scm_list_ref ((args), \
- SCM_MAKINUM ((pos) - 1))), \
+ scm_from_int ((pos) - 1))), \
SCM_UNSPECIFIED))
#define SCM_GASSERTn(cond, gf, args, pos, subr) \
if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
#endif /* def vms */
#endif /* ndef SCM_EXIT_FAILURE */
+/* Define SCM_C_INLINE_KEYWORD so that it can be used as a replacement
+ for the "inline" keyword, expanding to nothing when "inline" is not
+ available.
+*/
+
+#ifdef SCM_C_INLINE
+#define SCM_C_INLINE_KEYWORD SCM_C_INLINE
+#else
+#define SCM_C_INLINE_KEYWORD
+#endif
+
#endif /* SCM___SCM_H */
/*