libguile/symbols.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_SYMBOLS_H
   4 #define SCM_SYMBOLS_H
   5
   6 /* Copyright (C) 1995,1996,1997,1998,2000,2001 Free Software Foundation, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this software; see the file COPYING.  If not, write to
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  22  *
  23  * As a special exception, the Free Software Foundation gives permission
  24  * for additional uses of the text contained in its release of GUILE.
  25  *
  26  * The exception is that, if you link the GUILE library with other files
  27  * to produce an executable, this does not by itself cause the
  28  * resulting executable to be covered by the GNU General Public License.
  29  * Your use of that executable is in no way restricted on account of
  30  * linking the GUILE library code into it.
  31  *
  32  * This exception does not however invalidate any other reasons why
  33  * the executable file might be covered by the GNU General Public License.
  34  *
  35  * This exception applies only to the code released by the
  36  * Free Software Foundation under the name GUILE.  If you copy
  37  * code from other Free Software Foundation releases into a copy of
  38  * GUILE, as the General Public License permits, the exception does
  39  * not apply to the code that you add in this way.  To avoid misleading
  40  * anyone as to the status of such modified files, you must delete
  41  * this exception notice from them.
  42  *
  43  * If you write modifications of your own for GUILE, it is your choice
  44  * whether to permit this exception to apply to your modifications.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 #include "libguile/__scm.h"
  50 \f
  51
  52 /* SCM_SYMBOL_LENGTH(SYM) is the length of SYM's name in characters, and
  53  * SCM_SYMBOL_CHARS(SYM) is the address of the first character of SYM's name.
  54  *
  55  * SCM_SYMBOL_HASH is a hash value for the symbol.  It is also used to
  56  * encode whether the symbol is interned or not.  See
  57  * SCM_SYMBOL_INTERNED_P.
  58  */
  59
  60 #define SCM_SYMBOLP(x)              (!SCM_IMP (x) && (SCM_TYP7 (x) == scm_tc7_symbol))
  61 #define SCM_SYMBOL_LENGTH(x)        (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
  62 #define SCM_MAKE_SYMBOL_TAG(l)      (((l) << 8) + scm_tc7_symbol)
  63 #define SCM_SET_SYMBOL_LENGTH(s, l) (SCM_SET_CELL_WORD_0 ((s), SCM_MAKE_SYMBOL_TAG(l)))
  64 #define SCM_SYMBOL_CHARS(x)         ((char *) (SCM_CELL_WORD_1 (x)))
  65 #define SCM_SET_SYMBOL_CHARS(s, c)  (SCM_SET_CELL_WORD_1 ((s), (c)))
  66 #define SCM_SYMBOL_HASH(X)          ((unsigned long) SCM_CELL_WORD_2 (X))
  67 #define SCM_SYMBOL_INTERNED_P(X)    (SCM_SYMBOL_HASH(X) <= (SCM_T_BITS_MAX/2))
  68
  69 #define SCM_PROP_SLOTS(X)           (SCM_CELL_OBJECT_3 (X))
  70 #define SCM_SET_PROP_SLOTS(X, v)    (SCM_SET_CELL_OBJECT_3 ((X), (v)))
  71 #define SCM_SYMBOL_FUNC(X)          (SCM_CAR (SCM_CELL_OBJECT_3 (X)))
  72 #define SCM_SET_SYMBOL_FUNC(X, v)   (SCM_SETCAR (SCM_CELL_OBJECT_3 (X), (v)))
  73 #define SCM_SYMBOL_PROPS(X)         (SCM_CDR (SCM_CELL_OBJECT_3 (X)))
  74 #define SCM_SET_SYMBOL_PROPS(X, v)  (SCM_SETCDR (SCM_CELL_OBJECT_3 (X), (v)))
  75
  76 \f
  77
  78 #ifdef GUILE_DEBUG
  79 SCM_API SCM scm_sys_symbols (void);
  80 #endif
  81 SCM_API SCM scm_mem2symbol (const char*, size_t);
  82 SCM_API SCM scm_mem2uninterned_symbol (const char *name, size_t len);
  83 SCM_API SCM scm_str2symbol (const char*);
  84
  85 SCM_API SCM scm_symbol_p (SCM x);
  86 SCM_API SCM scm_symbol_interned_p (SCM sym);
  87 SCM_API SCM scm_make_symbol (SCM name);
  88 SCM_API SCM scm_symbol_to_string (SCM s);
  89 SCM_API SCM scm_string_to_symbol (SCM s);
  90
  91 SCM_API SCM scm_symbol_fref (SCM s);
  92 SCM_API SCM scm_symbol_pref (SCM s);
  93 SCM_API SCM scm_symbol_fset_x (SCM s, SCM val);
  94 SCM_API SCM scm_symbol_pset_x (SCM s, SCM val);
  95
  96 SCM_API SCM scm_symbol_hash (SCM s);
  97 SCM_API SCM scm_gensym (SCM prefix);
  98
  99 SCM_API char *scm_c_symbol2str (SCM obj, char *str, size_t *lenp);
 100 SCM_API void scm_symbols_prehistory (void);
 101 SCM_API void scm_init_symbols (void);
 102
 103 #endif  /* SCM_SYMBOLS_H */
 104
 105 /*
 106   Local Variables:
 107   c-file-style: "gnu"
 108   End:
 109 */