libguile/symbols.h

   1 /* classes: h_files */
   2
   3 #ifndef SYMBOLSH
   4 #define SYMBOLSH
   5 /*      Copyright (C) 1995,1996,1997,1998, 2000, 2001 Free Software Foundation, Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this software; see the file COPYING.  If not, write to
  19  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307 USA
  21  *
  22  * As a special exception, the Free Software Foundation gives permission
  23  * for additional uses of the text contained in its release of GUILE.
  24  *
  25  * The exception is that, if you link the GUILE library with other files
  26  * to produce an executable, this does not by itself cause the
  27  * resulting executable to be covered by the GNU General Public License.
  28  * Your use of that executable is in no way restricted on account of
  29  * linking the GUILE library code into it.
  30  *
  31  * This exception does not however invalidate any other reasons why
  32  * the executable file might be covered by the GNU General Public License.
  33  *
  34  * This exception applies only to the code released by the
  35  * Free Software Foundation under the name GUILE.  If you copy
  36  * code from other Free Software Foundation releases into a copy of
  37  * GUILE, as the General Public License permits, the exception does
  38  * not apply to the code that you add in this way.  To avoid misleading
  39  * anyone as to the status of such modified files, you must delete
  40  * this exception notice from them.
  41  *
  42  * If you write modifications of your own for GUILE, it is your choice
  43  * whether to permit this exception to apply to your modifications.
  44  * If you do not wish that, delete this exception notice.  */
  45
  46 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  47    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  48 \f
  49
  50 #include "libguile/__scm.h"
  51 \f
  52
  53 /* SCM_SYMBOL_LENGTH(SYM) is the length of SYM's name in characters, and
  54  * SCM_SYMBOL_CHARS(SYM) is the address of the first character of SYM's name.
  55  */
  56
  57 #define SCM_SYMBOLP(x)              (SCM_NIMP (x) && (SCM_TYP7 (x) == scm_tc7_symbol))
  58 #define SCM_SYMBOL_LENGTH(x)        (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
  59 #define SCM_SET_SYMBOL_LENGTH(s, l) (SCM_SET_CELL_WORD_0 ((s), ((l) << 8) + scm_tc7_symbol))
  60 #define SCM_SYMBOL_CHARS(x)         ((char *) (SCM_CELL_WORD_1 (x)))
  61 #define SCM_SET_SYMBOL_CHARS(s, c)  (SCM_SET_CELL_WORD_1 ((s), (c)))
  62 #define SCM_SYMBOL_HASH(X)          ((unsigned long) SCM_CELL_WORD_2 (X))
  63 #define SCM_SET_SYMBOL_HASH(X, v)   (SCM_SET_CELL_WORD_2 ((X), (v)))
  64
  65 #define SCM_PROP_SLOTS(X)           (SCM_CELL_WORD_3 (X))
  66 #define SCM_SET_PROP_SLOTS(X, v)    (SCM_SET_CELL_WORD_3 ((X), (v)))
  67 #define SCM_SYMBOL_FUNC(X)          (SCM_CAR (SCM_CELL_WORD_3 (X)))
  68 #define SCM_SET_SYMBOL_FUNC(X, v)   (SCM_SETCAR (SCM_CELL_WORD_3 (X), (v)))
  69 #define SCM_SYMBOL_PROPS(X)         (SCM_CDR (SCM_CELL_WORD_3 (X)))
  70 #define SCM_SET_SYMBOL_PROPS(X, v)  (SCM_SETCDR (SCM_CELL_WORD_3 (X), (v)))
  71
  72 \f
  73
  74 #ifdef GUILE_DEBUG
  75 extern SCM scm_sys_symbols (void);
  76 #endif
  77 extern SCM scm_mem2symbol (const char*, scm_sizet);
  78 extern SCM scm_str2symbol (const char*);
  79
  80 extern SCM scm_symbol_p (SCM x);
  81 extern SCM scm_symbol_to_string (SCM s);
  82 extern SCM scm_string_to_symbol (SCM s);
  83
  84 extern SCM scm_symbol_fref (SCM s);
  85 extern SCM scm_symbol_pref (SCM s);
  86 extern SCM scm_symbol_fset_x (SCM s, SCM val);
  87 extern SCM scm_symbol_pset_x (SCM s, SCM val);
  88
  89 extern SCM scm_symbol_hash (SCM s);
  90 extern SCM scm_gensym (SCM prefix);
  91
  92 extern void scm_symbols_prehistory (void);
  93 extern void scm_init_symbols (void);
  94
  95 \f
  96
  97 #if (SCM_DEBUG_DEPRECATED == 0)
  98
  99 #define SCM_CHARS(x) ((char *) (SCM_CELL_WORD_1 (x)))
 100 #define SCM_UCHARS(x) ((unsigned char *) (SCM_CELL_WORD_1 (x)))
 101 #define SCM_SETCHARS(x, v) (SCM_SET_CELL_WORD_1 ((x), (scm_bits_t) (v)))
 102 #define SCM_SLOPPY_SUBSTRP(x) (SCM_SUBSTRP (x))
 103 #define SCM_SUBSTR_STR(x) (SCM_CDDR (x))
 104 #define SCM_SUBSTR_OFFSET(x) (SCM_CADR (x))
 105 #define SCM_LENGTH_MAX (0xffffffL)
 106 #define SCM_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
 107 #define SCM_SETLENGTH(x, v, t) (SCM_SET_CELL_WORD_0 ((x), ((v) << 8) + (t)))
 108 #define SCM_ROSTRINGP(x) (SCM_NIMP(x) && ((SCM_TYP7S(x)==scm_tc7_string) \
 109                           || (SCM_TYP7(x) == scm_tc7_symbol)))
 110 #define SCM_ROLENGTH(x) SCM_LENGTH (x)
 111 #define SCM_ROCHARS(x) ((SCM_TYP7 (x) == scm_tc7_substring) \
 112                         ? (SCM_INUM (SCM_CADR (x)) + SCM_STRING_CHARS (SCM_CDDR (x))) \
 113                         : ((SCM_TYP7 (x) == scm_tc7_string) \
 114                            ? SCM_STRING_CHARS (x) \
 115                            : SCM_SYMBOL_CHARS (x)))
 116 #define SCM_ROUCHARS(x) ((SCM_TYP7 (x) == scm_tc7_substring) \
 117                          ? (SCM_INUM (SCM_CADR (x)) + SCM_STRING_UCHARS (SCM_CDDR (x))) \
 118                          : ((SCM_TYP7 (x) == scm_tc7_string) \
 119                             ? SCM_STRING_UCHARS (x) \
 120                             : (unsigned char *) SCM_SYMBOL_CHARS (x)))
 121 #define SCM_SUBSTRP(x) (SCM_NIMP (x) && (SCM_TYP7 (x) == scm_tc7_substring))
 122 #define SCM_COERCE_SUBSTR(x) SCM_STRING_COERCE_0TERMINATION_X (x)
 123 #define scm_strhash(str, len, n) (scm_string_hash ((str), (len)) % (n))
 124
 125 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 126
 127 #if SCM_ENABLE_VCELLS
 128
 129 extern SCM scm_sym2vcell (SCM sym, SCM thunk, SCM definep);
 130 extern SCM scm_sym2ovcell_soft (SCM sym, SCM obarray);
 131 extern SCM scm_sym2ovcell (SCM sym, SCM obarray);
 132 extern SCM scm_intern_obarray_soft (const char *name, scm_sizet len, SCM obarray, unsigned int softness);
 133 extern SCM scm_intern_obarray (const char *name, scm_sizet len, SCM obarray);
 134 extern SCM scm_intern (const char *name, scm_sizet len);
 135 extern SCM scm_intern0 (const char *name);
 136 extern SCM scm_sysintern (const char *name, SCM val);
 137 extern SCM scm_sysintern0 (const char *name);
 138 extern SCM scm_sysintern0_no_module_lookup (const char *name);
 139 extern SCM scm_symbol_value0 (const char *name);
 140
 141 extern SCM scm_string_to_obarray_symbol (SCM o, SCM s, SCM softp);
 142 extern SCM scm_intern_symbol (SCM o, SCM s);
 143 extern SCM scm_unintern_symbol (SCM o, SCM s);
 144 extern SCM scm_symbol_binding (SCM o, SCM s);
 145 extern SCM scm_symbol_interned_p (SCM o, SCM s);
 146 extern SCM scm_symbol_bound_p (SCM o, SCM s);
 147 extern SCM scm_symbol_set_x (SCM o, SCM s, SCM v);
 148
 149 extern SCM scm_gentemp (SCM prefix, SCM obarray);
 150
 151 extern void scm_init_symbols_deprecated (void);
 152
 153 #endif /* SCM_ENABLE_VCELLS */
 154
 155 #endif  /* SYMBOLSH */
 156
 157 /*
 158   Local Variables:
 159   c-file-style: "gnu"
 160   End:
 161 */