* goops.c, goops.h (scm_sys_pre_expand_closure_x): Removed.
[bpt/guile.git] / libguile / tags.h
index 65fdc4c..f69031d 100644 (file)
@@ -2,7 +2,7 @@
 
 #ifndef TAGSH
 #define TAGSH
-/* Copyright (C) 1995, 1996, 1997, 1998, 1999 Free Software Foundation, Inc.
+/* Copyright (C) 1995, 96, 97, 98, 99, 2000 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
 
 \f
 
+/* #define SCM_VOIDP_TEST    */
+
 /* In the beginning was the Word:
  */
-typedef long SCM;
+typedef long scm_bits_t;
 
+/* But as external interface, we use SCM, which may, according to the desired
+ * level of type checking, be defined in several ways:
+ */
+#if (SCM_DEBUG_TYPING_STRICTNESS == 1)
+    typedef union { struct { scm_bits_t n; } n; } SCM;
+    static SCM scm_pack(scm_bits_t b) { SCM s; s.n.n = b; return s; }
+#   define SCM_UNPACK(x) ((x).n.n)
+#   define SCM_PACK(x) (scm_pack ((scm_bits_t) (x)))
+#elif defined (SCM_VOIDP_TEST)
+/* This is the default, which provides an intermediate level of compile time
+ * type checking while still resulting in very efficient code.
+ */
+    typedef void * SCM;
+#   define SCM_UNPACK(x) ((scm_bits_t) (x))
+#   define SCM_PACK(x) ((SCM) (x))
+#else
+/* This should be used as a fall back solution for machines on which casting
+ * to a pointer may lead to loss of bit information, e. g. in the three least
+ * significant bits.
+ */
+    typedef scm_bits_t SCM;
+#   define SCM_UNPACK(x) (x)
+#   define SCM_PACK(x) ((scm_bits_t) (x))
+#endif
 
 
-/* Cray machines have pointers that are incremented once for each word,
- * rather than each byte, the 3 most significant bits encode the byte
- * within the word.  The following macros deal with this by storing the
- * native Cray pointers like the ones that looks like scm expects.  This
- * is done for any pointers that might appear in the car of a scm_cell, pointers
- * to scm_vector elts, functions, &c are not munged.
+/* SCM values can not be compared by using the operator ==.  Use the following
+ * macro instead, which is the equivalent of the scheme predicate 'eq?'.
  */
-#ifdef _UNICOS
-# define SCM2PTR(x) ((int)(x) >> 3)
-# define PTR2SCM(x) (((SCM)(x)) << 3)
-# define SCM_POINTERS_MUNGED
-#else
-# define SCM2PTR(x) (x)
-# define PTR2SCM(x) ((SCM)(x))
-#endif /* def _UNICOS */
+#define SCM_EQ_P(x, y) (SCM_UNPACK (x) == SCM_UNPACK (y))
 
 \f
+
 /* SCM variables can contain:
  *
  * Non-objects -- meaning that the tag-related macros don't apply to them
@@ -106,8 +122,8 @@ typedef long SCM;
  * (Not always impossible but it is fair to say that many details of tags
  * are mutually dependent).  */
 
-#define SCM_IMP(x)             (6 & (SCM)(x))
-#define SCM_NIMP(x)            (!SCM_IMP(x))
+#define SCM_IMP(x)             (6 & SCM_UNPACK (x))
+#define SCM_NIMP(x)            (!SCM_IMP (x))
 
 /* Here is a summary of tagging in SCM values as they might occur in
  * SCM variables or in the heap.
@@ -194,7 +210,7 @@ typedef long SCM;
  * gloc    ..........SCM vcell..........001  ...........SCM cdr.............G
  * struct  ..........void * type........001  ...........void * data.........G
  * closure ..........SCM code...........011  ...........SCM env.............G
- * tc7    .........long length....Gxxxx1S1  ..........void *data............
+ * tc7    ......24.bits of data...Gxxxx1S1  ..........void *data............
  *
  *
  *
@@ -203,19 +219,11 @@ typedef long SCM;
  *             tc7_tags are 7 bit tags ending in 1x1.  These tags
  *             occur only in the CAR of heap cells, and have the
  *             handy property that all bits of the CAR above the
- *             bottom eight can be used to store a length, thus
+ *             bottom eight can be used to store some data, thus
  *             saving a word in the body itself.  Thus, we use them
- *             for strings, symbols, and vectors (among other
- *             things).
- *
- *             SCM_LENGTH returns the bits in "length" (see the diagram).
- *             SCM_CHARS returns the data cast to "char *"
- *             SCM_CDR returns the data cast to "SCM"
- *             TYP7(X) returns bits 0...6 of SCM_CAR (X)
+ *             for strings and vectors (among other things).
  *
- *             For the interpretation of SCM_LENGTH and SCM_CHARS
- *             that applies to a particular type, see the header file
- *             for that type.
+ *             TYP7(X) returns bits 0...6 of CELL_TYPE (X)
  *
  *              Sometimes we choose the bottom seven bits carefully,
  *              so that the 2-valued bit (called S bit) can be masked
@@ -241,7 +249,6 @@ typedef long SCM;
  *
  *             TYP16
  *             TYP16S
- *             GCTYP16
  *
  *             TYP16S functions similarly wrt to TYP16 as TYP7S to TYP7,
  *             but a different option bit is used (bit 2 for TYP7S,
@@ -264,38 +271,45 @@ typedef long SCM;
  * stored in the SCM_CAR of a non-immediate object have a 1 in bit 1:
  */
 
-#define SCM_NCONSP(x) (1 & SCM_CAR(x))
-#define SCM_CONSP(x) (!SCM_NCONSP(x))
+#define SCM_SLOPPY_CONSP(x)  ((1 & SCM_CELL_TYPE (x)) == 0)
+#define SCM_SLOPPY_NCONSP(x) (!SCM_SLOPPY_CONSP(x))
+
+#define SCM_CONSP(x)  (!SCM_IMP (x) && SCM_SLOPPY_CONSP (x))
+#define SCM_NCONSP(x) (!SCM_CONSP (x))
 
 
 /* SCM_ECONSP should be used instead of SCM_CONSP at places where GLOCS
  * can be expected to occur.
  */
-#define SCM_ECONSP(x) (SCM_CONSP (x) \
-                      || (SCM_TYP3(x) == 1 \
-                           && SCM_CDR (SCM_CAR (x) - 1) != 0))
-#define SCM_NECONSP(x) (SCM_NCONSP(x) \
-                       && (SCM_TYP3(x) != 1 \
-                           || SCM_CDR (SCM_CAR (x) - 1) == 0))
+#define SCM_ECONSP(x) \
+  (!SCM_IMP (x) \
+   && (SCM_SLOPPY_CONSP (x) \
+       || (SCM_TYP3 (x) == 1 \
+          && (SCM_STRUCT_VTABLE_DATA (x)[scm_vtable_index_vcell] != 0))))
+#define SCM_NECONSP(x) (!SCM_ECONSP (x))
 
 \f
 
-#define SCM_CELLP(x)   (!SCM_NCELLP(x))
-#define SCM_NCELLP(x)  ((sizeof(scm_cell)-1) & (SCM)(x))
+#define SCM_CELLP(x)   (((sizeof (scm_cell) - 1) & SCM_UNPACK (x)) == 0)
+#define SCM_NCELLP(x)  (!SCM_CELLP (x))
+
+#if (SCM_DEBUG_DEPRECATED == 0)
+#define SCM_DOUBLE_CELLP(x)  (((2 * sizeof (scm_cell) - 1) & SCM_UNPACK (x)) == 0)
+#endif /* SCM_DEBUG_DEPRECATED == 0 */
 
 /* See numbers.h for macros relating to immediate integers.
  */
 
-#define SCM_ITAG3(x)           (7 & (SCM)x)
-#define SCM_TYP3(x)            (7 & SCM_CAR(x))
+#define SCM_ITAG3(x)           (7 & SCM_UNPACK (x))
+#define SCM_TYP3(x)            (7 & SCM_CELL_TYPE (x))
 #define scm_tc3_cons           0
 #define scm_tc3_cons_gloc      1
 #define scm_tc3_int_1          2
-#define scm_tc3_closure                3
-#define scm_tc3_imm24          4
-#define scm_tc3_tc7_1          5
-#define scm_tc3_int_2          6
-#define scm_tc3_tc7_2          7
+#define scm_tc3_closure                 3
+#define scm_tc3_imm24           4
+#define scm_tc3_tc7_1           5
+#define scm_tc3_int_2           6
+#define scm_tc3_tc7_2           7
 
 
 /*
@@ -303,31 +317,20 @@ typedef long SCM;
  */
 
 
-#define SCM_TYP7(x)            (SCM_CAR(x) & 0x7f)
-#define SCM_TYP7S(x)           (SCM_CAR(x) & (0x7f & ~2))
-
+#define SCM_ITAG7(x)           (127 & SCM_UNPACK (x))
+#define SCM_TYP7(x)            (0x7f &        SCM_CELL_TYPE (x))
+#define SCM_TYP7S(x)           ((0x7f & ~2) & SCM_CELL_TYPE (x))
 
-#define SCM_TYP16(x)           (0xffff & SCM_CAR(x))
-#define SCM_TYP16S(x)          (0xfeff & SCM_CAR(x))
-#define SCM_GCTYP16(x)                 (0xff7f & SCM_CAR(x))
 
+#define SCM_TYP16(x)           (0xffff & SCM_CELL_TYPE (x))
+#define SCM_TYP16S(x)          (0xfeff & SCM_CELL_TYPE (x))
 
-
-/* Testing and Changing GC Marks in Various Standard Positions
- */
-#define SCM_GCMARKP(x)                 (1 & SCM_CDR(x))
-#define SCM_GC8MARKP(x)        (0x80 & SCM_CAR(x))
-#define SCM_SETGCMARK(x)       SCM_SETOR_CDR (x,1)
-#define SCM_CLRGCMARK(x)       SCM_SETAND_CDR (x, ~1L)
-#define SCM_SETGC8MARK(x)      SCM_SETOR_CAR (x, 0x80)
-#define SCM_CLRGC8MARK(x)      SCM_SETAND_CAR (x, ~0x80L)
-
+#define SCM_TYP16_PREDICATE(tag,x) (SCM_NIMP (x) && SCM_TYP16 (x) == (tag))
 
 \f
 
-/* couple */
-#define scm_tc7_ssymbol                5
-#define scm_tc7_msymbol                7
+#define scm_tc7_symbol         5
+/* free                         7 */
 
 /* couple */
 #define scm_tc7_vector         13
@@ -342,11 +345,11 @@ typedef long SCM;
  * of these 7 bit tags!
  */
 #define scm_tc7_pws            31
-#define scm_tc7_lvector                39
 
 #ifdef HAVE_ARRAYS
 #define scm_tc7_llvect          29
 #define scm_tc7_uvect          37
+/* free                         39 */
 #define scm_tc7_fvect          45
 #define scm_tc7_dvect          47
 #define scm_tc7_cvect          53
@@ -356,7 +359,7 @@ typedef long SCM;
 #define scm_tc7_ivect          79
 #endif
 
-#define scm_tc7_contin         61
+/* free                        61 */
 #define scm_tc7_cclo           63
 #define scm_tc7_rpsubr         69
 #define scm_tc7_subr_0         85
@@ -371,16 +374,10 @@ typedef long SCM;
 #define scm_tc7_lsubr          119
 
 
-/* There are 256 port subtypes.  Here are the first few.
- * These must agree with the init function in ports.c
+/* There are 256 port subtypes.
  */
 #define scm_tc7_port           125
 
-#define scm_tc16_fport                 (scm_tc7_port + 0*256L)
-/* scm_tc16_pipe was here.  */
-#define scm_tc16_strport       (scm_tc7_port + 2*256L)
-#define scm_tc16_sfport        (scm_tc7_port + 3*256L)
-
 
 /* There are 256 smob subtypes.  Here are the first four.
  */
@@ -395,32 +392,13 @@ typedef long SCM;
 /* scm_tc_free_cell is also the 0th smob type.  We place this
  * in free cells to tell the conservative marker not to trace it.
  */
-#define scm_tc_free_cell       127
-
-/* The 1st smob type:
- */
-#define scm_tc16_flo           0x017f
-#define scm_tc_flo             0x017fL
-
-/* Some option bits begeinning at bit 16 of scm_tc16_flo:
- */
-#define SCM_REAL_PART          (1L<<16)
-#define SCM_IMAG_PART          (2L<<16)
-#define scm_tc_dblr            (scm_tc16_flo|SCM_REAL_PART)
-#define scm_tc_dblc            (scm_tc16_flo|SCM_REAL_PART|SCM_IMAG_PART)
-
+#define scm_tc_free_cell       (scm_tc7_smob + 0 * 256L)
 
-/* Smob types 2 and 3:
+/* Smob type 1 to 3 (note the dependency on the predicate SCM_NUMP)
  */
-#define scm_tc16_bigpos                0x027f
-#define scm_tc16_bigneg                0x037f
-
-/* Smob type 4: this is allocated, but not initialized cells;
-   this is required to prevent the gc from hosing your cells if
-   you have to allocate while creating the cell*/
-
-#define scm_tc16_allocated      0x047f
-
+#define scm_tc16_big           (scm_tc7_smob + 1 * 256L)
+#define scm_tc16_real           (scm_tc7_smob + 2 * 256L)
+#define scm_tc16_complex        (scm_tc7_smob + 3 * 256L)
 
 \f
 /* {Immediate Values}
@@ -432,9 +410,9 @@ enum scm_tags
   scm_tc8_iloc = 0xfc
 };
 
-#define SCM_ITAG8(X)           ((SCM)(X) & 0xff)
-#define SCM_MAKE_ITAG8(X, TAG) (((X)<<8) + TAG)
-#define SCM_ITAG8_DATA(X)      ((X)>>8)
+#define SCM_ITAG8(X)           (SCM_UNPACK (X) & 0xff)
+#define SCM_MAKE_ITAG8(X, TAG) SCM_PACK (((X) << 8) + TAG)
+#define SCM_ITAG8_DATA(X)      (SCM_UNPACK (X) >> 8)
 
 
 \f
@@ -442,15 +420,15 @@ enum scm_tags
  */
 
 /* SCM_ISYMP tests for ISPCSYM and ISYM */
-#define SCM_ISYMP(n)           ((0x187 & (SCM)(n))==4)
+#define SCM_ISYMP(n)           ((0x187 & SCM_UNPACK (n)) == 4)
 
 /* SCM_IFLAGP tests for ISPCSYM, ISYM and IFLAG */
-#define SCM_IFLAGP(n)          ((0x87 & (SCM)(n))==4)
-#define SCM_ISYMNUM(n)                 ((SCM)((n)>>9))
-#define SCM_ISYMCHARS(n)       (scm_isymnames[SCM_ISYMNUM(n)])
-#define SCM_MAKSPCSYM(n)       (((n)<<9)+((n)<<3)+4L)
-#define SCM_MAKISYM(n)                 (((n)<<9)+0x74L)
-#define SCM_MAKIFLAG(n)        (((n)<<9)+0x174L)
+#define SCM_IFLAGP(n)          ((0x87 & SCM_UNPACK (n)) == 4)
+#define SCM_ISYMNUM(n)                 (SCM_UNPACK (n) >> 9)
+#define SCM_ISYMCHARS(n)       (scm_isymnames[SCM_ISYMNUM (n)])
+#define SCM_MAKSPCSYM(n)       SCM_PACK (((n) << 9) + ((n) << 3) + 4L)
+#define SCM_MAKISYM(n)                 SCM_PACK (((n) << 9) + 0x74L)
+#define SCM_MAKIFLAG(n)        SCM_PACK (((n) << 9) + 0x174L)
 
 extern char *scm_isymnames[];   /* defined in print.c */
 
@@ -462,50 +440,60 @@ extern char *scm_isymnames[];   /* defined in print.c */
  *
  */
 
-#define SCM_IM_AND             SCM_MAKSPCSYM(0)
-#define SCM_IM_BEGIN           SCM_MAKSPCSYM(1)
-#define SCM_IM_CASE            SCM_MAKSPCSYM(2)
-#define SCM_IM_COND            SCM_MAKSPCSYM(3)
-#define SCM_IM_DO              SCM_MAKSPCSYM(4)
-#define SCM_IM_IF              SCM_MAKSPCSYM(5)
-#define SCM_IM_LAMBDA          SCM_MAKSPCSYM(6)
-#define SCM_IM_LET             SCM_MAKSPCSYM(7)
-#define SCM_IM_LETSTAR         SCM_MAKSPCSYM(8)
-#define SCM_IM_LETREC          SCM_MAKSPCSYM(9)
-#define SCM_IM_OR              SCM_MAKSPCSYM(10)
-#define SCM_IM_QUOTE           SCM_MAKSPCSYM(11)
-#define SCM_IM_SET_X           SCM_MAKSPCSYM(12)
-#define SCM_IM_DEFINE          SCM_MAKSPCSYM(13)
-#define SCM_IM_APPLY           SCM_MAKISYM(14)
-#define SCM_IM_CONT            SCM_MAKISYM(15)
-#define SCM_BOOL_F             SCM_MAKIFLAG(16)
-#define SCM_BOOL_T             SCM_MAKIFLAG(17)
-#define SCM_UNDEFINED          SCM_MAKIFLAG(18)
-#define SCM_EOF_VAL            SCM_MAKIFLAG(19)
-#define SCM_EOL                        SCM_MAKIFLAG(20)
-#define SCM_UNSPECIFIED                SCM_MAKIFLAG(21)
-#define SCM_IM_DISPATCH                SCM_MAKISYM(22)
-#define SCM_IM_SLOT_REF                SCM_MAKISYM(23)
-#define SCM_IM_SLOT_SET_X      SCM_MAKISYM(24)
+#define SCM_IM_AND             SCM_MAKSPCSYM (0)
+#define SCM_IM_BEGIN           SCM_MAKSPCSYM (1)
+#define SCM_IM_CASE            SCM_MAKSPCSYM (2)
+#define SCM_IM_COND            SCM_MAKSPCSYM (3)
+#define SCM_IM_DO              SCM_MAKSPCSYM (4)
+#define SCM_IM_IF              SCM_MAKSPCSYM (5)
+#define SCM_IM_LAMBDA          SCM_MAKSPCSYM (6)
+#define SCM_IM_LET             SCM_MAKSPCSYM (7)
+#define SCM_IM_LETSTAR         SCM_MAKSPCSYM (8)
+#define SCM_IM_LETREC          SCM_MAKSPCSYM (9)
+#define SCM_IM_OR              SCM_MAKSPCSYM (10)
+#define SCM_IM_QUOTE           SCM_MAKSPCSYM (11)
+#define SCM_IM_SET_X           SCM_MAKSPCSYM (12)
+#define SCM_IM_DEFINE          SCM_MAKSPCSYM (13)
+#define SCM_IM_APPLY           SCM_MAKISYM (14)
+#define SCM_IM_CONT            SCM_MAKISYM (15)
+#define SCM_BOOL_F             SCM_MAKIFLAG (16)
+#define SCM_BOOL_T             SCM_MAKIFLAG (17)
+#define SCM_UNDEFINED          SCM_MAKIFLAG (18)
+#define SCM_EOF_VAL            SCM_MAKIFLAG (19)
+#define SCM_EOL                        SCM_MAKIFLAG (20)
+#define SCM_UNSPECIFIED                SCM_MAKIFLAG (21)
+#define SCM_IM_DISPATCH                SCM_MAKISYM (22)
+#define SCM_IM_SLOT_REF                SCM_MAKISYM (23)
+#define SCM_IM_SLOT_SET_X      SCM_MAKISYM (24)
 
 /* Multi-language support */
 
-#define SCM_IM_NIL_COND                SCM_MAKISYM(25)
-#define SCM_IM_NIL_IFY         SCM_MAKISYM(26)
-#define SCM_IM_T_IFY           SCM_MAKISYM(27)
-#define SCM_IM_0_COND          SCM_MAKISYM(28)
-#define SCM_IM_0_IFY           SCM_MAKISYM(29)
-#define SCM_IM_1_IFY           SCM_MAKISYM(30)
-#define SCM_IM_BIND            SCM_MAKISYM(31)
-
-#define SCM_IM_DELAY           SCM_MAKISYM(32)
+#define SCM_IM_NIL_COND                SCM_MAKISYM (25)
+#define SCM_IM_NIL_IFY         SCM_MAKISYM (26)
+#define SCM_IM_T_IFY           SCM_MAKISYM (27)
+#define SCM_IM_0_COND          SCM_MAKISYM (28)
+#define SCM_IM_0_IFY           SCM_MAKISYM (29)
+#define SCM_IM_1_IFY           SCM_MAKISYM (30)
+#define SCM_IM_BIND            SCM_MAKISYM (31)
+
+#define SCM_IM_DELAY           SCM_MAKISYM (32)
+
+/* When a variable is unbound this is marked by the SCM_UNDEFINED
+ * value.  The following is an unbound value which can be handled on
+ * the Scheme level, i.e., it can be stored in and retrieved from a
+ * Scheme variable.  This value is only intended to mark an unbound
+ * slot in GOOPS.  It is needed now, but we should probably rewrite
+ * the code which handles this value in C so that SCM_UNDEFINED can be
+ * used instead.  It is not ideal to let this kind of unique and
+ * strange values loose on the Scheme level.
+ */
+#define SCM_UNBOUND            SCM_MAKIFLAG (33)
 
-#define SCM_UNBNDP(x)  (SCM_UNDEFINED==(x))
+#define SCM_UNBNDP(x)          (SCM_EQ_P ((x), SCM_UNDEFINED))
 
 \f
 
-/* Dispatching aids:
- */
+/* Dispatching aids: */
 
 
 /* For cons pairs with immediate values in the CAR
@@ -549,8 +537,25 @@ extern char *scm_isymnames[];   /* defined in print.c */
  case scm_tc7_subr_3:case scm_tc7_subr_2:case scm_tc7_rpsubr:case scm_tc7_subr_1o:\
  case scm_tc7_subr_2o:case scm_tc7_lsubr_2:case scm_tc7_lsubr
 
-#define scm_tcs_symbols scm_tc7_ssymbol:case scm_tc7_msymbol
+\f
 
-#define scm_tcs_bignums scm_tc16_bigpos:case scm_tc16_bigneg
+#if (SCM_DEBUG_DEPRECATED == 0)
+
+#define scm_tc7_ssymbol                scm_tc7_symbol
+#define scm_tc7_msymbol                scm_tc7_symbol
+#define scm_tcs_symbols         scm_tc7_symbol
+
+#define scm_tc16_flo           scm_tc16_real
+#define scm_tc_flo             0x017fL
+#define scm_tc_dblr            scm_tc16_real
+#define scm_tc_dblc            scm_tc16_complex
+
+#endif  /* SCM_DEBUG_DEPRECATED == 0 */
 
 #endif  /* TAGSH */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/