[bpt/guile.git] / libguile / symbols.h

/* classes: h_files */

#ifndef SYMBOLSH
#define SYMBOLSH
/*	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
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * 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, 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.
 *
 * The exception is that, if you link the GUILE library with other files
 * to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * Your use of that executable is in no way restricted on account of
 * linking the GUILE library code into it.
 *
 * This exception does not however invalidate any other reasons why
 * the executable file might be covered by the GNU General Public License.
 *
 * This exception applies only to the code released by the
 * Free Software Foundation under the name GUILE.  If you copy
 * code from other Free Software Foundation releases into a copy of
 * GUILE, as the General Public License permits, the exception does
 * not apply to the code that you add in this way.  To avoid misleading
 * anyone as to the status of such modified files, you must delete
 * this exception notice from them.
 *
 * 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.  */

/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
\f

#include "libguile/__scm.h"
\f

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.
 */

#define SCM_SYMBOLP(x)	(SCM_NIMP (x) && (SCM_TYP7 (x) == scm_tc7_symbol))

#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_CHARS(x)		((char *) (SCM_CELL_WORD_1 (x)))
#define SCM_UCHARS(x)		((unsigned char *) (SCM_CELL_WORD_1 (x)))
#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) ((char *)((SCM_TYP7(x) == scm_tc7_substring) \
			? SCM_INUM (SCM_CADR (x)) + SCM_CHARS (SCM_CDDR (x))  \
			: SCM_CHARS (x)))
#define SCM_ROUCHARS(x) ((unsigned char *) ((SCM_TYP7(x) == scm_tc7_substring) \
			 ? SCM_INUM (SCM_CADR (x)) + SCM_UCHARS (SCM_CDDR (x))\
			 : SCM_UCHARS (x)))
#define SCM_ROLENGTH(x) SCM_LENGTH (x)
#define SCM_SLOPPY_SUBSTRP(x) (SCM_TYP7(x) == scm_tc7_substring)
#define SCM_SUBSTRP(x) (SCM_NIMP(x) && SCM_SLOPPY_SUBSTRP(x))
#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

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 (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);
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 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);

\f

#if (SCM_DEBUG_DEPRECATED == 0)

#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:
*/
Commit	Line	Data
0f2d19dd JB	1	/* classes: h_files */
	2
	3	#ifndef SYMBOLSH
	4	#define SYMBOLSH
f2c9fcb0	5	/* Copyright (C) 1995,1996,1997,1998, 2000 Free Software Foundation, Inc.
0f2d19dd JB	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
82892bed JB	19	* the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
82892bed JB	20	* Boston, MA 02111-1307 USA
0f2d19dd JB	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.
82892bed	44	* If you do not wish that, delete this exception notice. */
d3a6bc94 GB	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 */
0f2d19dd JB	48	\f
0f2d19dd JB	49
b4309c3c	50	#include "libguile/__scm.h"
0f2d19dd JB	51	\f
	52
	53	extern int scm_symhash_dim;
	54
8ce94504	55	/* SCM_LENGTH(SYM) is the length of SYM's name in characters, and
28b06554 DH	56	* SCM_CHARS(SYM) is the address of the first character of SYM's name.
28b06554 DH	57	*/
8ce94504	58
28b06554	59	#define SCM_SYMBOLP(x) (SCM_NIMP (x) && (SCM_TYP7 (x) == scm_tc7_symbol))
3210f49a DH	60
	61	#define SCM_LENGTH_MAX (0xffffffL)
	62	#define SCM_LENGTH(x) (((unsigned long) SCM_CELL_WORD_0 (x)) >> 8)
	63	#define SCM_SETLENGTH(x, v, t) (SCM_SET_CELL_WORD_0 ((x), ((v) << 8) + (t)))
	64
	65	#define SCM_CHARS(x) ((char *) (SCM_CELL_WORD_1 (x)))
	66	#define SCM_UCHARS(x) ((unsigned char *) (SCM_CELL_WORD_1 (x)))
	67	#define SCM_SETCHARS(x, v) (SCM_SET_CELL_WORD_1 ((x), (scm_bits_t) (v)))
	68
28b06554 DH	69	#define SCM_PROP_SLOTS(X) (SCM_CELL_WORD_3 (X))
	70	#define SCM_SET_PROP_SLOTS(X, v) (SCM_SET_CELL_WORD_3 ((X), (v)))
	71	#define SCM_SYMBOL_FUNC(X) (SCM_CAR (SCM_CELL_WORD_3 (X)))
	72	#define SCM_SET_SYMBOL_FUNC(X, v) (SCM_SETCAR (SCM_CELL_WORD_3 (X), (v)))
	73	#define SCM_SYMBOL_PROPS(X) (SCM_CDR (SCM_CELL_WORD_3 (X)))
	74	#define SCM_SET_SYMBOL_PROPS(X, v) (SCM_SETCDR (SCM_CELL_WORD_3 (X), (v)))
	75	#define SCM_SYMBOL_HASH(X) (SCM_CELL_WORD_2 (X))
	76	#define SCM_SET_SYMBOL_HASH(X, v) (SCM_SET_CELL_WORD_2 ((X), (v)))
0f2d19dd	77
d3a6bc94	78	#define SCM_ROSTRINGP(x) (SCM_NIMP(x) && ((SCM_TYP7S(x)==scm_tc7_string) \
28b06554	79	\|\| (SCM_TYP7(x) == scm_tc7_symbol)))
d3a6bc94	80	#define SCM_ROCHARS(x) ((char *)((SCM_TYP7(x) == scm_tc7_substring) \
0f2d19dd	81	? SCM_INUM (SCM_CADR (x)) + SCM_CHARS (SCM_CDDR (x)) \
d3a6bc94	82	: SCM_CHARS (x)))
cfaba30e	83	#define SCM_ROUCHARS(x) ((unsigned char *) ((SCM_TYP7(x) == scm_tc7_substring) \
c2cb2500	84	? SCM_INUM (SCM_CADR (x)) + SCM_UCHARS (SCM_CDDR (x))\
d3a6bc94	85	: SCM_UCHARS (x)))
0f2d19dd	86	#define SCM_ROLENGTH(x) SCM_LENGTH (x)
30939477 GB	87	#define SCM_SLOPPY_SUBSTRP(x) (SCM_TYP7(x) == scm_tc7_substring)
30939477 GB	88	#define SCM_SUBSTRP(x) (SCM_NIMP(x) && SCM_SLOPPY_SUBSTRP(x))
0f2d19dd JB	89	#define SCM_SUBSTR_STR(x) (SCM_CDDR (x))
	90	#define SCM_SUBSTR_OFFSET(x) (SCM_CADR (x))
	91
89958ad0 JB	92	#define SCM_COERCE_SUBSTR(x) { if (SCM_SUBSTRP (x)) \
	93	x = scm_makfromstr (SCM_ROCHARS (x), \
	94	SCM_ROLENGTH (x), 0); }
0f2d19dd JB	95
0f2d19dd JB	96	\f
0f2d19dd	97
28b06554	98	extern unsigned long scm_string_hash (const unsigned char *str, scm_sizet len);
7866a09b GB	99	extern SCM scm_sym2vcell (SCM sym, SCM thunk, SCM definep);
	100	extern SCM scm_sym2ovcell_soft (SCM sym, SCM obarray);
	101	extern SCM scm_sym2ovcell (SCM sym, SCM obarray);
28b06554	102	extern SCM scm_intern_obarray_soft (const char *name, scm_sizet len, SCM obarray, unsigned int softness);
7866a09b GB	103	extern SCM scm_intern_obarray (const char *name, scm_sizet len, SCM obarray);
7866a09b GB	104	extern SCM scm_intern (const char *name, scm_sizet len);
5b99c4a9	105	extern SCM scm_intern0 (const char *name);
7866a09b GB	106	extern SCM scm_sysintern (const char *name, SCM val);
	107	extern SCM scm_sysintern0 (const char *name);
	108	extern SCM scm_sysintern0_no_module_lookup (const char *name);
	109	extern SCM scm_symbol_value0 (const char *name);
	110	extern SCM scm_symbol_p (SCM x);
	111	extern SCM scm_symbol_to_string (SCM s);
	112	extern SCM scm_string_to_symbol (SCM s);
	113	extern SCM scm_string_to_obarray_symbol (SCM o, SCM s, SCM softp);
	114	extern SCM scm_intern_symbol (SCM o, SCM s);
	115	extern SCM scm_unintern_symbol (SCM o, SCM s);
	116	extern SCM scm_symbol_binding (SCM o, SCM s);
	117	extern SCM scm_symbol_interned_p (SCM o, SCM s);
	118	extern SCM scm_symbol_bound_p (SCM o, SCM s);
	119	extern SCM scm_symbol_set_x (SCM o, SCM s, SCM v);
	120	extern SCM scm_symbol_fref (SCM s);
	121	extern SCM scm_symbol_pref (SCM s);
	122	extern SCM scm_symbol_fset_x (SCM s, SCM val);
	123	extern SCM scm_symbol_pset_x (SCM s, SCM val);
	124	extern SCM scm_symbol_hash (SCM s);
	125	extern SCM scm_builtin_bindings (void);
	126	extern SCM scm_builtin_weak_bindings (void);
5382d876 MD	127	extern SCM scm_gensym (SCM prefix);
5382d876 MD	128	extern SCM scm_gentemp (SCM prefix, SCM obarray);
7866a09b	129	extern void scm_init_symbols (void);
0f2d19dd	130
28b06554 DH	131	\f
	132
	133	#if (SCM_DEBUG_DEPRECATED == 0)
	134
	135	#define scm_strhash(str, len, n) (scm_string_hash ((str), (len)) % (n))
	136
	137	#endif /* SCM_DEBUG_DEPRECATED == 0 */
	138
0f2d19dd	139	#endif /* SYMBOLSH */
89e00824 ML	140
	141	/*
	142	Local Variables:
	143	c-file-style: "gnu"
	144	End:
	145	*/