* Some more work to get rid of SCM_LENGTH
[bpt/guile.git] / libguile / symbols.h
index b1486ce..3331bd6 100644 (file)
@@ -2,7 +2,7 @@
 
 #ifndef SYMBOLSH
 #define SYMBOLSH
-/*     Copyright (C) 1995,1996 Free Software Foundation, Inc.
+/*     Copyright (C) 1995,1996,1997,1998, 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
@@ -16,7 +16,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, 675 Mass Ave, Cambridge, MA 02139, USA.
+ * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
+ * Boston, MA 02111-1307 USA
  *
  * As a special exception, the Free Software Foundation gives permission
  * for additional uses of the text contained in its release of GUILE.
  *
  * If you write modifications of your own for GUILE, it is your choice
  * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  
- */
+ * If you do not wish that, delete this exception notice.  */
+
+/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
+   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
 \f
 
-#include "__scm.h"
+#include "libguile/__scm.h"
 \f
 
 extern int scm_symhash_dim;
 
-#define SCM_SYMBOLP(x) (SCM_TYP7S(x)==scm_tc7_ssymbol)
-#define SCM_LENGTH(x) (((unsigned long)SCM_CAR(x))>>8)
-#define SCM_LENGTH_MAX (0xffffffL)
-#define SCM_SETLENGTH(x, v, t) SCM_CAR(x) = ((v)<<8)+(t)
-#define SCM_SETCHARS SCM_SETCDR
-#define SCM_CHARS(x) ((char *)(SCM_CDR(x)))
-#define SCM_UCHARS(x) ((unsigned char *)(SCM_CDR(x)))
-#define SCM_SLOTS(x) ((SCM *) (* ((SCM *)SCM_CHARS(x) - 1)))
-#define SCM_SYMBOL_SLOTS 5
-#define SCM_SYMBOL_FUNC(X) (SCM_SLOTS(X)[0])
-#define SCM_SYMBOL_PROPS(X) (SCM_SLOTS(X)[1])
-#define SCM_SYMBOL_HASH(X) (*(unsigned long*)(&SCM_SLOTS(X)[2]))
-#define SCM_SYMBOL_MULTI_BYTE_SCM_STRINGP(X) (*(unsigned long*)(&SCM_SLOTS(X)[3]))
-
-#define SCM_ROSTRINGP(x) ((SCM_TYP7SD(x)==scm_tc7_string) || (SCM_TYP7S(x) == scm_tc7_ssymbol))
-#define SCM_ROCHARS(x) ((SCM_TYP7(x) == scm_tc7_substring) \
-                       ? SCM_INUM (SCM_CADR (x)) + SCM_CHARS (SCM_CDDR (x))  \
-                       : SCM_CHARS (x))
-#define SCM_ROUCHARS(x) ((SCM_TYP7(x) == scm_tc7_substring) \
-                        ? SCM_INUM (SCM_CADR (x)) + SCM_UCHARS (SCM_CDDR (x))  \
-                        : SCM_UCHARS (x))
+/* SCM_SYMBOL_LENGTH(SYM) is the length of SYM's name in characters, and
+ * SCM_SYMBOL_CHARS(SYM) is the address of the first character of SYM's name.
+ */
+
+#define SCM_SYMBOLP(x) (SCM_NIMP (x) && (SCM_TYP7 (x) == scm_tc7_symbol))
+#define SCM_SYMBOL_UCHARS(x)  ((unsigned char *) (SCM_CELL_WORD_1 (x)))
+#define SCM_SYMBOL_CHARS(x)  ((char *) (SCM_CELL_WORD_1 (x)))
+#define SCM_SYMBOL_LENGTH(x)  (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
+
+#define SCM_LENGTH_MAX         (0xffffffL)
+#define SCM_LENGTH(x)          (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
+#define SCM_SETLENGTH(x, v, t) (SCM_SET_CELL_WORD_0 ((x), ((v) << 8) + (t)))
+
+#define SCM_SETCHARS(x, v)     (SCM_SET_CELL_WORD_1 ((x), (scm_bits_t) (v)))
+
+#define SCM_PROP_SLOTS(X)           (SCM_CELL_WORD_3 (X))
+#define SCM_SET_PROP_SLOTS(X, v)    (SCM_SET_CELL_WORD_3 ((X), (v)))
+#define SCM_SYMBOL_FUNC(X)         (SCM_CAR (SCM_CELL_WORD_3 (X)))
+#define SCM_SET_SYMBOL_FUNC(X, v)   (SCM_SETCAR (SCM_CELL_WORD_3 (X), (v)))
+#define SCM_SYMBOL_PROPS(X)        (SCM_CDR (SCM_CELL_WORD_3 (X)))
+#define SCM_SET_SYMBOL_PROPS(X, v)  (SCM_SETCDR (SCM_CELL_WORD_3 (X), (v)))
+#define SCM_SYMBOL_HASH(X)         (SCM_CELL_WORD_2 (X))
+#define SCM_SET_SYMBOL_HASH(X, v)   (SCM_SET_CELL_WORD_2 ((X), (v)))
+
+#define SCM_ROSTRINGP(x) (SCM_NIMP(x) && ((SCM_TYP7S(x)==scm_tc7_string) \
+                         || (SCM_TYP7(x) == scm_tc7_symbol)))
+#define SCM_ROCHARS(x) ((SCM_TYP7 (x) == scm_tc7_substring) \
+                       ? (SCM_INUM (SCM_CADR (x)) + SCM_STRING_CHARS (SCM_CDDR (x))) \
+                       : ((SCM_TYP7 (x) == scm_tc7_string) \
+                          ? SCM_STRING_CHARS (x) \
+                          : SCM_SYMBOL_CHARS (x)))
+#define SCM_ROUCHARS(x) ((SCM_TYP7 (x) == scm_tc7_substring) \
+                        ? (SCM_INUM (SCM_CADR (x)) + SCM_STRING_UCHARS (SCM_CDDR (x))) \
+                        : ((SCM_TYP7 (x) == scm_tc7_string) \
+                           ? SCM_STRING_UCHARS (x) \
+                           : SCM_SYMBOL_UCHARS (x)))
 #define SCM_ROLENGTH(x) SCM_LENGTH (x)
-#define SCM_SUBSTRP(x) ((SCM_TYP7S(x) == scm_tc7_substring))
+#define SCM_SUBSTRP(x) (SCM_NIMP (x) && (SCM_TYP7 (x) == scm_tc7_substring))
 #define SCM_SUBSTR_STR(x) (SCM_CDDR (x))
 #define SCM_SUBSTR_OFFSET(x) (SCM_CADR (x))
 
+#define SCM_COERCE_SUBSTR(x) { if (SCM_SUBSTRP (x)) \
+                                x = scm_makfromstr (SCM_ROCHARS (x), \
+                                                    SCM_STRING_LENGTH (x), 0); }
 
 \f
-#ifdef __STDC__
-extern unsigned long scm_strhash (unsigned char *str, scm_sizet len, unsigned long n);
+
+extern unsigned long scm_string_hash (const unsigned char *str, scm_sizet len);
 extern SCM scm_sym2vcell (SCM sym, SCM thunk, SCM definep);
 extern SCM scm_sym2ovcell_soft (SCM sym, SCM obarray);
 extern SCM scm_sym2ovcell (SCM sym, SCM obarray);
-extern SCM scm_intern_obarray_soft (char *name, scm_sizet len, SCM obarray, int softness);
-extern SCM scm_intern_obarray (char *name, scm_sizet len, SCM obarray);
-extern SCM scm_intern (char *name, scm_sizet len);
-extern SCM scm_intern0 (char * name);
-extern SCM scm_sysintern (char *name, SCM val);
-extern SCM scm_symbol_p(SCM x);
-extern SCM scm_symbol_to_string(SCM s);
-extern SCM scm_string_to_symbol(SCM s);
-extern SCM scm_string_to_obarray_symbol(SCM o, SCM s, SCM softp);
-extern SCM scm_intern_symbol(SCM o, SCM s);
-extern SCM scm_unintern_symbol(SCM o, SCM s);
+extern SCM scm_intern_obarray_soft (const char *name, scm_sizet len, SCM obarray, unsigned int softness);
+extern SCM scm_intern_obarray (const char *name, scm_sizet len, SCM obarray);
+extern SCM scm_intern (const char *name, scm_sizet len);
+extern SCM scm_intern0 (const char *name);
+extern SCM scm_sysintern (const char *name, SCM val);
+extern SCM scm_sysintern0 (const char *name);
+extern SCM scm_sysintern0_no_module_lookup (const char *name);
+extern SCM scm_symbol_value0 (const char *name);
+extern SCM scm_symbol_p (SCM x);
+extern SCM scm_symbol_to_string (SCM s);
+extern SCM scm_string_to_symbol (SCM s);
+extern SCM scm_string_to_obarray_symbol (SCM o, SCM s, SCM softp);
+extern SCM scm_intern_symbol (SCM o, SCM s);
+extern SCM scm_unintern_symbol (SCM o, SCM s);
 extern SCM scm_symbol_binding (SCM o, SCM s);
 extern SCM scm_symbol_interned_p (SCM o, SCM s);
 extern SCM scm_symbol_bound_p (SCM o, SCM s);
@@ -102,40 +126,27 @@ extern SCM scm_symbol_pref (SCM s);
 extern SCM scm_symbol_fset_x (SCM s, SCM val);
 extern SCM scm_symbol_pset_x (SCM s, SCM val);
 extern SCM scm_symbol_hash (SCM s);
+extern SCM scm_builtin_bindings (void);
+extern SCM scm_builtin_weak_bindings (void);
+extern SCM scm_gensym (SCM prefix);
+extern SCM scm_gentemp (SCM prefix, SCM obarray);
 extern void scm_init_symbols (void);
 
-#else /* STDC */
-extern unsigned long scm_strhash ();
-extern SCM scm_sym2vcell ();
-extern SCM scm_sym2ovcell_soft ();
-extern SCM scm_sym2ovcell ();
-extern SCM scm_intern_obarray_soft ();
-extern SCM scm_intern_obarray ();
-extern SCM scm_intern ();
-extern SCM scm_intern0 ();
-extern SCM scm_sysintern ();
-extern SCM scm_symbol_p();
-extern SCM scm_symbol_to_string();
-extern SCM scm_string_to_symbol();
-extern SCM scm_string_to_obarray_symbol();
-extern SCM scm_intern_symbol();
-extern SCM scm_unintern_symbol();
-extern SCM scm_symbol_binding ();
-extern SCM scm_symbol_interned_p ();
-extern SCM scm_symbol_bound_p ();
-extern SCM scm_symbol_set_x ();
-extern SCM scm_symbol_fref ();
-extern SCM scm_symbol_pref ();
-extern SCM scm_symbol_fset_x ();
-extern SCM scm_symbol_pset_x ();
-extern SCM scm_symbol_hash ();
-extern void scm_init_symbols ();
-
-#endif /* STDC */
-
-
+\f
 
+#if (SCM_DEBUG_DEPRECATED == 0)
 
+#define SCM_CHARS(x) ((char *) (SCM_CELL_WORD_1 (x)))
+#define SCM_UCHARS(x) ((unsigned char *) (SCM_CELL_WORD_1 (x)))
+#define SCM_SLOPPY_SUBSTRP(x) (SCM_SUBSTRP (x))
+#define scm_strhash(str, len, n) (scm_string_hash ((str), (len)) % (n))
 
+#endif  /* SCM_DEBUG_DEPRECATED == 0 */
 
 #endif  /* SYMBOLSH */
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/