* tests/symbols.test ("gensym"): New tests for long gensym
[bpt/guile.git] / libguile / tags.h
index f0d953c..3de11fe 100644 (file)
@@ -1,8 +1,8 @@
 /* classes: h_files */
 
-#ifndef TAGSH
-#define TAGSH
-/* Copyright (C) 1995, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
+#ifndef SCM_TAGS_H
+#define SCM_TAGS_H
+/* Copyright (C) 1995,1996,1997,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
 
 \f
 
-
 /* In the beginning was the Word:
  */
 typedef long scm_bits_t;
-/*
-  But as external interface, we use void*, which will be checked more strictly for
-  dubious conversions.
+
+/* 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 == 2)
+    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 (SCM_DEBUG_TYPING_STRICTNESS == 1)
+/* This is the default, which provides an intermediate level of compile time
+ * type checking while still resulting in very efficient code.
  */
-#define SCM_VOIDP_TEST
-#ifndef SCM_VOIDP_TEST
-typedef scm_bits_t  SCM;
-#define SCM_UNPACK(x) (x)
-#define SCM_PACK(x) (x)
+    typedef struct scm_unused_struct * SCM;
+#   define SCM_UNPACK(x) ((scm_bits_t) (x))
+#   define SCM_PACK(x) ((SCM) (x))
 #else
-typedef void * SCM;
-#define SCM_UNPACK(x) ((scm_bits_t) (x))
-#define SCM_PACK(x) ((SCM) (x))
+/* 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
 
-/* SCM_UNPACK_CAR is a convenience for treating the CAR of X as a word */
-#define SCM_UNPACK_CAR(x) SCM_UNPACK (SCM_CAR (x))
-
 
-/* 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
@@ -211,7 +208,7 @@ typedef void * 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............
  *
  *
  *
@@ -220,19 +217,11 @@ typedef void * 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).
+ *             for strings 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 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
@@ -258,7 +247,6 @@ typedef void * 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,
@@ -281,35 +269,30 @@ typedef void * SCM;
  * stored in the SCM_CAR of a non-immediate object have a 1 in bit 1:
  */
 
-#define SCM_SLOPPY_NCONSP(x) (1 & SCM_UNPACK_CAR (x))
-#define SCM_SLOPPY_CONSP(x)  (!SCM_SLOPPY_NCONSP (x))
-
-#define SCM_NCONSP(x) (SCM_IMP (x) || SCM_SLOPPY_NCONSP (x))
-#define SCM_CONSP(x)  (SCM_NIMP (x) && SCM_SLOPPY_CONSP (x))
+#define SCM_CONSP(x)  (!SCM_IMP (x) && ((1 & SCM_CELL_TYPE (x)) == 0))
+#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_NIMP (x) \
-                      && (SCM_SLOPPY_CONSP (x) \
-                          || (SCM_TYP3 (x) == 1 \
-                              && SCM_CDR (SCM_CAR (x) - 1) != 0)))
-#define SCM_NECONSP(x) (SCM_IMP (x) \
-                       || (SCM_SLOPPY_NCONSP (x) \
-                           && (SCM_TYP3 (x) != 1 \
-                               || SCM_CDR (SCM_CAR (x) - 1) == 0)))
+#define SCM_ECONSP(x) \
+  (!SCM_IMP (x) \
+   && (SCM_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_UNPACK (x))
+#define SCM_CELLP(x)   (((sizeof (scm_cell) - 1) & SCM_UNPACK (x)) == 0)
+#define SCM_NCELLP(x)  (!SCM_CELLP (x))
 
 /* See numbers.h for macros relating to immediate integers.
  */
 
 #define SCM_ITAG3(x)           (7 & SCM_UNPACK (x))
-#define SCM_TYP3(x)            (7 & SCM_UNPACK_CAR (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
@@ -325,31 +308,20 @@ typedef void * SCM;
  */
 
 
-#define SCM_TYP7(x)            (0x7f &        SCM_UNPACK_CAR (x))
-#define SCM_TYP7S(x)           ((0x7f & ~2) & SCM_UNPACK_CAR (x))
+#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_UNPACK_CAR (x))
-#define SCM_TYP16S(x)          (0xfeff & SCM_UNPACK_CAR (x))
-#define SCM_GCTYP16(x)                 (0xff7f & SCM_UNPACK_CAR (x))
-
-
-
-/* Testing and Changing GC Marks in Various Standard Positions
- */
-#define SCM_GCMARKP(x)                 (1 & SCM_UNPACK (SCM_CDR (x)))
-#define SCM_GC8MARKP(x)        (0x80 & SCM_UNPACK_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(x)           (0xffff & SCM_CELL_TYPE (x))
+#define SCM_TYP16S(x)          (0xfeff & SCM_CELL_TYPE (x))
 
+#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
@@ -364,11 +336,11 @@ typedef void * 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
@@ -378,7 +350,7 @@ typedef void * 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
@@ -393,16 +365,10 @@ typedef void * 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.
  */
@@ -417,32 +383,13 @@ typedef void * 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}
@@ -521,6 +468,7 @@ extern char *scm_isymnames[];   /* defined in print.c */
 #define SCM_IM_BIND            SCM_MAKISYM (31)
 
 #define SCM_IM_DELAY           SCM_MAKISYM (32)
+#define SCM_IM_CALL_WITH_VALUES SCM_MAKISYM (33)
 
 /* When a variable is unbound this is marked by the SCM_UNDEFINED
  * value.  The following is an unbound value which can be handled on
@@ -533,7 +481,7 @@ extern char *scm_isymnames[];   /* defined in print.c */
  */
 #define SCM_UNBOUND            SCM_MAKIFLAG (33)
 
-#define SCM_UNBNDP(x)  (SCM_UNDEFINED == (x))
+#define SCM_UNBNDP(x)          (SCM_EQ_P ((x), SCM_UNDEFINED))
 
 \f
 
@@ -581,8 +529,23 @@ 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
+
+#if (SCM_DEBUG_DEPRECATED == 0)
+
+#define SCM_SLOPPY_CONSP(x)  ((1 & SCM_CELL_TYPE (x)) == 0)
+#define SCM_SLOPPY_NCONSP(x) (!SCM_SLOPPY_CONSP(x))
 
-#define scm_tcs_bignums scm_tc16_bigpos:case scm_tc16_bigneg
+#define scm_tc7_ssymbol                scm_tc7_symbol
+#define scm_tc7_msymbol                scm_tc7_symbol
+#define scm_tcs_symbols         scm_tc7_symbol
 
-#endif  /* TAGSH */
+#endif  /* SCM_DEBUG_DEPRECATED == 0 */
+
+#endif  /* SCM_TAGS_H */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/