libguile/symbols.h

   1 /* classes: h_files */
   2
   3 #ifndef SYMBOLSH
   4 #define SYMBOLSH
   5 /*      Copyright (C) 1995,1996,1997,1998, 2000 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 extern int scm_symhash_dim;
  54
  55 /* SCM_LENGTH(SYM) is the length of SYM's name in characters, and
  56  * SCM_CHARS(SYM) is the address of the first character of SYM's name.
  57  */
  58
  59 #define SCM_SYMBOLP(x)  (SCM_NIMP (x) && (SCM_TYP7 (x) == scm_tc7_symbol))
  60 #define SCM_SYMBOL_CHARS(x)  ((char *) (SCM_CELL_WORD_1 (x)))
  61
  62 #define SCM_LENGTH_MAX          (0xffffffL)
  63 #define SCM_LENGTH(x)           (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
  64 #define SCM_SETLENGTH(x, v, t)  (SCM_SET_CELL_WORD_0 ((x), ((v) << 8) + (t)))
  65
  66 #define SCM_CHARS(x)            ((char *) (SCM_CELL_WORD_1 (x)))
  67 #define SCM_UCHARS(x)           ((unsigned char *) (SCM_CELL_WORD_1 (x)))
  68 #define SCM_SETCHARS(x, v)      (SCM_SET_CELL_WORD_1 ((x), (scm_bits_t) (v)))
  69
  70 #define SCM_PROP_SLOTS(X)           (SCM_CELL_WORD_3 (X))
  71 #define SCM_SET_PROP_SLOTS(X, v)    (SCM_SET_CELL_WORD_3 ((X), (v)))
  72 #define SCM_SYMBOL_FUNC(X)          (SCM_CAR (SCM_CELL_WORD_3 (X)))
  73 #define SCM_SET_SYMBOL_FUNC(X, v)   (SCM_SETCAR (SCM_CELL_WORD_3 (X), (v)))
  74 #define SCM_SYMBOL_PROPS(X)         (SCM_CDR (SCM_CELL_WORD_3 (X)))
  75 #define SCM_SET_SYMBOL_PROPS(X, v)  (SCM_SETCDR (SCM_CELL_WORD_3 (X), (v)))
  76 #define SCM_SYMBOL_HASH(X)          (SCM_CELL_WORD_2 (X))
  77 #define SCM_SET_SYMBOL_HASH(X, v)   (SCM_SET_CELL_WORD_2 ((X), (v)))
  78
  79 #define SCM_ROSTRINGP(x) (SCM_NIMP(x) && ((SCM_TYP7S(x)==scm_tc7_string) \
  80                           || (SCM_TYP7(x) == scm_tc7_symbol)))
  81 #define SCM_ROCHARS(x) ((char *)((SCM_TYP7(x) == scm_tc7_substring) \
  82                         ? SCM_INUM (SCM_CADR (x)) + SCM_CHARS (SCM_CDDR (x))  \
  83                         : SCM_CHARS (x)))
  84 #define SCM_ROUCHARS(x) ((unsigned char *) ((SCM_TYP7(x) == scm_tc7_substring) \
  85                          ? SCM_INUM (SCM_CADR (x)) + SCM_UCHARS (SCM_CDDR (x))\
  86                          : SCM_UCHARS (x)))
  87 #define SCM_ROLENGTH(x) SCM_LENGTH (x)
  88 #define SCM_SLOPPY_SUBSTRP(x) (SCM_TYP7(x) == scm_tc7_substring)
  89 #define SCM_SUBSTRP(x) (SCM_NIMP(x) && SCM_SLOPPY_SUBSTRP(x))
  90 #define SCM_SUBSTR_STR(x) (SCM_CDDR (x))
  91 #define SCM_SUBSTR_OFFSET(x) (SCM_CADR (x))
  92
  93 #define SCM_COERCE_SUBSTR(x) { if (SCM_SUBSTRP (x)) \
  94                                  x = scm_makfromstr (SCM_ROCHARS (x), \
  95                                                      SCM_ROLENGTH (x), 0); }
  96
  97 \f
  98
  99 extern unsigned long scm_string_hash (const unsigned char *str, scm_sizet len);
 100 extern SCM scm_sym2vcell (SCM sym, SCM thunk, SCM definep);
 101 extern SCM scm_sym2ovcell_soft (SCM sym, SCM obarray);
 102 extern SCM scm_sym2ovcell (SCM sym, SCM obarray);
 103 extern SCM scm_intern_obarray_soft (const char *name, scm_sizet len, SCM obarray, unsigned int softness);
 104 extern SCM scm_intern_obarray (const char *name, scm_sizet len, SCM obarray);
 105 extern SCM scm_intern (const char *name, scm_sizet len);
 106 extern SCM scm_intern0 (const char *name);
 107 extern SCM scm_sysintern (const char *name, SCM val);
 108 extern SCM scm_sysintern0 (const char *name);
 109 extern SCM scm_sysintern0_no_module_lookup (const char *name);
 110 extern SCM scm_symbol_value0 (const char *name);
 111 extern SCM scm_symbol_p (SCM x);
 112 extern SCM scm_symbol_to_string (SCM s);
 113 extern SCM scm_string_to_symbol (SCM s);
 114 extern SCM scm_string_to_obarray_symbol (SCM o, SCM s, SCM softp);
 115 extern SCM scm_intern_symbol (SCM o, SCM s);
 116 extern SCM scm_unintern_symbol (SCM o, SCM s);
 117 extern SCM scm_symbol_binding (SCM o, SCM s);
 118 extern SCM scm_symbol_interned_p (SCM o, SCM s);
 119 extern SCM scm_symbol_bound_p (SCM o, SCM s);
 120 extern SCM scm_symbol_set_x (SCM o, SCM s, SCM v);
 121 extern SCM scm_symbol_fref (SCM s);
 122 extern SCM scm_symbol_pref (SCM s);
 123 extern SCM scm_symbol_fset_x (SCM s, SCM val);
 124 extern SCM scm_symbol_pset_x (SCM s, SCM val);
 125 extern SCM scm_symbol_hash (SCM s);
 126 extern SCM scm_builtin_bindings (void);
 127 extern SCM scm_builtin_weak_bindings (void);
 128 extern SCM scm_gensym (SCM prefix);
 129 extern SCM scm_gentemp (SCM prefix, SCM obarray);
 130 extern void scm_init_symbols (void);
 131
 132 \f
 133
 134 #if (SCM_DEBUG_DEPRECATED == 0)
 135
 136 #define scm_strhash(str, len, n) (scm_string_hash ((str), (len)) % (n))
 137
 138 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 139
 140 #endif  /* SYMBOLSH */
 141
 142 /*
 143   Local Variables:
 144   c-file-style: "gnu"
 145   End:
 146 */