* Makefile.am: Added modules.c, modules.x, modules.h.
[bpt/guile.git] / libguile / symbols.h
index aa6e357..06566a8 100644 (file)
@@ -2,7 +2,7 @@
 
 #ifndef SYMBOLSH
 #define SYMBOLSH
-/*     Copyright (C) 1995,1996 Free Software Foundation, Inc.
+/*     Copyright (C) 1995,1996,1997,1998 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.
@@ -40,8 +41,7 @@
  *
  * 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.  */
 \f
 
 #include "libguile/__scm.h"
 
 extern int scm_symhash_dim;
 
+/* SCM_LENGTH(SYM) is the length of SYM's name in characters, and
+   SCM_CHARS(SYM) is the address of the first character of SYM's name.
+
+   Beyond that, there are two kinds of symbols: ssymbols and msymbols,
+   distinguished by the 'S' bit in the type.
+
+   Ssymbols are just uniquified strings.  They have a length, chars,
+   and that's it.  They use the scm_tc7_ssymbol tag (S bit clear).
+
+   Msymbols are symbols with extra slots.  These slots hold a property
+   list and a function value (for Emacs Lisp compatibility), and a hash
+   code.  They use the scm_tc7_msymbol tag.
+
+   We'd like SCM_CHARS to work on msymbols just as it does on
+   ssymbols, so we'll have it point to the symbol's name as usual, and
+   store a pointer to the slots just before the name in memory.  Thus,
+   you have to do some casting and pointer arithmetic to find the
+   slots; see the SCM_SLOTS macro.
+
+   In practice, the slots always live just before the pointer to them.
+   So why not ditch the pointer, and use negative indices to refer to
+   the slots?  That's a good question; ask the author.  I think it was
+   the cognac.  */
+
 #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)
@@ -57,85 +81,62 @@ extern int scm_symhash_dim;
 #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_SLOTS 4
 #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_ROSTRINGP(x) ((SCM_TYP7S(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_INUM (SCM_CADR (x)) + SCM_UCHARS (SCM_CDDR (x))\
                         : SCM_UCHARS (x))
 #define SCM_ROLENGTH(x) SCM_LENGTH (x)
-#define SCM_SUBSTRP(x) ((SCM_TYP7S(x) == scm_tc7_substring))
+#define SCM_SUBSTRP(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_ROLENGTH (x), 0); }
 
 \f
-#ifdef __STDC__
-extern unsigned long scm_strhash (unsigned char *str, scm_sizet len, unsigned long n);
-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_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);
-extern SCM scm_symbol_set_x (SCM o, SCM s, SCM v);
-extern SCM scm_symbol_fref (SCM s);
-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 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 */
-
-
-
 
+extern unsigned long scm_strhash SCM_P ((unsigned char *str, scm_sizet len, unsigned long n));
+extern SCM scm_sym2vcell SCM_P ((SCM sym, SCM thunk, SCM definep));
+extern SCM scm_sym2ovcell_soft SCM_P ((SCM sym, SCM obarray));
+extern SCM scm_sym2ovcell SCM_P ((SCM sym, SCM obarray));
+extern SCM scm_intern_obarray_soft SCM_P ((char *name, scm_sizet len, SCM obarray, int softness));
+extern SCM scm_intern_obarray SCM_P ((char *name, scm_sizet len, SCM obarray));
+extern SCM scm_intern SCM_P ((char *name, scm_sizet len));
+extern SCM scm_intern0 SCM_P ((char * name));
+extern SCM scm_sysintern SCM_P ((char *name, SCM val));
+extern SCM scm_sysintern0 SCM_P ((char *name));
+extern SCM scm_sysintern0_no_module_lookup SCM_P ((char *name));
+extern SCM scm_symbol_value0 SCM_P ((char *name));
+extern SCM scm_symbol_p SCM_P ((SCM x));
+extern SCM scm_symbol_to_string SCM_P ((SCM s));
+extern SCM scm_string_to_symbol SCM_P ((SCM s));
+extern SCM scm_string_to_obarray_symbol SCM_P ((SCM o, SCM s, SCM softp));
+extern SCM scm_intern_symbol SCM_P ((SCM o, SCM s));
+extern SCM scm_unintern_symbol SCM_P ((SCM o, SCM s));
+extern SCM scm_symbol_binding SCM_P ((SCM o, SCM s));
+extern SCM scm_symbol_interned_p SCM_P ((SCM o, SCM s));
+extern SCM scm_symbol_bound_p SCM_P ((SCM o, SCM s));
+extern SCM scm_symbol_set_x SCM_P ((SCM o, SCM s, SCM v));
+extern SCM scm_symbol_fref SCM_P ((SCM s));
+extern SCM scm_symbol_pref SCM_P ((SCM s));
+extern SCM scm_symbol_fset_x SCM_P ((SCM s, SCM val));
+extern SCM scm_symbol_pset_x SCM_P ((SCM s, SCM val));
+extern SCM scm_symbol_hash SCM_P ((SCM s));
+extern SCM scm_builtin_bindings SCM_P ((void));
+extern SCM scm_builtin_weak_bindings SCM_P ((void));
+extern SCM scm_gensym SCM_P ((SCM name, SCM obarray));
+extern void scm_init_symbols SCM_P ((void));
 
+extern int scm_can_use_top_level_lookup_closure_var;
 
 #endif  /* SYMBOLSH */