The FSF has a new address.
[bpt/guile.git] / libguile / __scm.h
index c20a9c2..b2b68a1 100644 (file)
@@ -3,7 +3,7 @@
 #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
@@ -17,8 +17,8 @@
  *
  * 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.
 #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
  */
 
 # define SCM_CHAR_CODE_LIMIT 256L
 #endif
 
+#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)
+
+#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)
+
+#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
+
+#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"
@@ -379,11 +446,15 @@ typedef short SCM_STACKITEM;
 #else
 typedef long SCM_STACKITEM;
 #endif
+
+/* 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_root->pending_asyncs) \
+  if (SCM_I_CURRENT_THREAD->pending_asyncs) \
     scm_async_click (); \
 } while (0)
 
@@ -405,18 +476,12 @@ do { \
    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 scm_rec_mutex_lock (&scm_i_defer_mutex);
-
-#define SCM_ALLOW_INTS scm_rec_mutex_unlock (&scm_i_defer_mutex);
-
-#define SCM_REDEFER_INTS SCM_DEFER_INTS
-
-#define SCM_REALLOW_INTS SCM_ALLOW_INTS
-
 #define SCM_TICK \
 do { \
   SCM_ASYNC_TICK; \
@@ -425,41 +490,6 @@ do { \
 
 \f
 
-/* Note: The following needs updating. */
-
-/* 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
  **
  **/
@@ -471,14 +501,14 @@ do { \
 #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
 
 /*
@@ -526,7 +556,7 @@ SCM_API SCM scm_apply_generic (SCM gf, SCM args);
          ? 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))
@@ -574,6 +604,17 @@ SCM_API SCM scm_apply_generic (SCM gf, SCM args);
 #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 */
 
 /*