* validate.h
[bpt/guile.git] / libguile / __scm.h
index f1aa50a..753684e 100644 (file)
@@ -2,7 +2,7 @@
 
 #ifndef __SCMH
 #define __SCMH
-/*     Copyright (C) 1995, 1996, 1998, 1999, 2000 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
  */
 #undef ENGNOT
 
-#undef SCM_CAREFUL_INTS
 \f
 /* {Unsupported Options}
  *
 #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
 #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"
@@ -308,9 +340,8 @@ typedef long SCM_STACKITEM;
 \f
 
 #ifndef USE_THREADS
-#define SCM_THREAD_DEFER
-#define SCM_THREAD_ALLOW
-#define SCM_THREAD_REDEFER
+#define SCM_CRITICAL_SECTION_START 
+#define SCM_CRITICAL_SECTION_END 
 #define SCM_THREAD_SWITCHING_CODE
 #endif
 
@@ -332,14 +363,21 @@ do { \
 } 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
@@ -372,7 +410,7 @@ do { \
 do { \
   SCM_FENCE; \
   SCM_CHECK_NOT_DISABLED; \
-  SCM_THREAD_DEFER; \
+  SCM_CRITICAL_SECTION_START; \
   SCM_FENCE; \
   scm_ints_disabled = 1; \
   SCM_FENCE; \
@@ -381,7 +419,7 @@ do { \
 
 #define SCM_ALLOW_INTS_ONLY \
 do { \
-  SCM_THREAD_ALLOW; \
+  SCM_CRITICAL_SECTION_END; \
   scm_ints_disabled = 0; \
 } while (0)
 
@@ -390,11 +428,11 @@ do { \
 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_THREAD_SWITCHING_CODE; \
   SCM_FENCE; \
 } while (0)
 
@@ -402,7 +440,7 @@ do { \
 #define SCM_REDEFER_INTS  \
 do { \
   SCM_FENCE; \
-  SCM_THREAD_REDEFER; \
+  SCM_CRITICAL_SECTION_START; \
   ++scm_ints_disabled; \
   SCM_FENCE; \
 } while (0)
@@ -411,7 +449,7 @@ do { \
 #define SCM_REALLOW_INTS \
 do { \
   SCM_FENCE; \
-  SCM_THREAD_SWITCHING_CODE; \
+  SCM_CRITICAL_SECTION_END; \
   SCM_FENCE; \
   --scm_ints_disabled; \
   SCM_FENCE; \
@@ -420,9 +458,8 @@ do { \
 
 #define SCM_TICK \
 do { \
-  SCM_DEFER_INTS; \
-  SCM_ALLOW_INTS; \
   SCM_ASYNC_TICK; \
+  SCM_THREAD_SWITCHING_CODE; \
 } while (0)
 
 \f
@@ -455,13 +492,8 @@ do { \
  * 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
 
@@ -472,12 +504,12 @@ do { \
 
 #ifdef SCM_RECKLESS
 #define SCM_ASSERT(_cond, _arg, _pos, _subr)
-#define SCM_ASSERT_TYPE(_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)
@@ -497,39 +529,42 @@ do { \
 
 extern SCM scm_call_generic_0 (SCM gf);
 
-#define SCM_WTA_DISPATCH_0(gf, arg, pos, subr) \
-  return (SCM_UNPACK (gf) \
-          ? scm_call_generic_0 ((gf)) \
-          : scm_wta ((arg), (char *) (pos), (subr)))
-#define SCM_GASSERT0(cond, gf, arg, pos, subr) \
-  if (!(cond)) SCM_WTA_DISPATCH_0((gf), (arg), (pos), (subr))
+#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 (SCM_UNPACK (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 (SCM_UNPACK (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 (SCM_UNPACK (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))
 
@@ -551,10 +586,31 @@ extern SCM scm_apply_generic (SCM gf, SCM args);
 #define SCM_ARG6               6
 #define SCM_ARG7               7 
 
-/* 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
 
+/* 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