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

/* classes: h_files */

#ifndef SCM_STRUCT_H
#define SCM_STRUCT_H

/* Copyright (C) 1995,1997,1999,2000,2001 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.  */

\f

#include "libguile/__scm.h"
#include "libguile/print.h"

\f

/* Number of words with negative index */
#define scm_struct_n_extra_words 4
#define scm_struct_entity_n_extra_words 6

/* These are how the initial words of a vtable are allocated. */
#define scm_struct_i_setter	-6 /* Setter */
#define scm_struct_i_procedure	-5 /* Optional procedure slot */
#define scm_struct_i_free	-4 /* Destructor */
#define scm_struct_i_ptr	-3 /* Start of block (see alloc_struct) */
#define scm_struct_i_n_words	-2 /* How many words allocated to this struct? */
#define scm_struct_i_size	-1 /* Instance size */
#define scm_struct_i_flags	-1 /* Upper 12 bits used as flags */

/* These indices must correspond to required_vtable_fields in
   struct.c. */
#define scm_vtable_index_layout  0 /* A symbol describing the physical arrangement of this type. */
#define scm_vtable_index_vtable  1 /* A pointer to the handle for this vtable. */
#define scm_vtable_index_printer 2 /* A printer for this struct type. */
#define scm_vtable_offset_user   3 /* Where do user fields start? */

typedef void (*scm_t_struct_free) (scm_t_bits * vtable, scm_t_bits * data);

#define SCM_STRUCTF_MASK   (0xFFF << 20)
#define SCM_STRUCTF_ENTITY (1L << 30) /* Indicates presence of proc slots */
#define SCM_STRUCTF_LIGHT  (1L << 31) /* Light representation
					 (no hidden words) */

#define SCM_STRUCTP(X)  		(!SCM_IMP(X) && (SCM_TYP3(X) == scm_tc3_struct))
#define SCM_STRUCT_DATA(X) 		((scm_t_bits *) SCM_CELL_WORD_1 (X))
#define SCM_STRUCT_VTABLE_DATA(X)       ((scm_t_bits *) (SCM_CELL_WORD_0 (X) - scm_tc3_struct))

#define SCM_STRUCT_LAYOUT(X) 	        (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout]))
#define SCM_SET_STRUCT_LAYOUT(X, v)     (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout] = SCM_UNPACK (v))

#define SCM_STRUCT_VTABLE(X) 	        (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_vtable]))
#define SCM_STRUCT_VTABLE_FLAGS(X) \
  (SCM_STRUCT_VTABLE_DATA (X) [scm_struct_i_flags])
#define SCM_STRUCT_PRINTER(X) 	        (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_printer]))
#define SCM_SET_STRUCT_PRINTER(x, v)\
   (SCM_STRUCT_VTABLE_DATA (x) [scm_vtable_index_printer] = SCM_UNPACK (v))
#define SCM_SET_VTABLE_DESTRUCTOR(X, D) (SCM_STRUCT_DATA (X) [scm_struct_i_free] = (scm_t_bits) (D))
/* Efficiency is important in the following macro, since it's used in GC */
#define SCM_LAYOUT_TAILP(X)		(((X) & 32) == 0) /* R, W or O */

#define SCM_STRUCT_TABLE_NAME(X) SCM_CAR (X)
#define SCM_SET_STRUCT_TABLE_NAME(X, NAME) SCM_SETCAR (X, NAME)
#define SCM_STRUCT_TABLE_CLASS(X) SCM_CDR (X)
#define SCM_SET_STRUCT_TABLE_CLASS(X, CLASS) SCM_SETCDR (X, CLASS)
SCM_API SCM scm_struct_table;

#define SCM_STRUCT_GC_CHAIN(X) SCM_CELL_OBJECT_3 (X)
#define SCM_SET_STRUCT_GC_CHAIN(X, Y) SCM_SET_CELL_OBJECT_3 (X, Y)
SCM_API SCM scm_i_structs_to_free;

\f

SCM_API scm_t_bits * scm_alloc_struct (int n_words, int n_extra,
				       const char *what);
SCM_API void scm_struct_free_0 (scm_t_bits * vtable, scm_t_bits * data);
SCM_API void scm_struct_free_light (scm_t_bits * vtable, scm_t_bits * data);
SCM_API void scm_struct_free_standard (scm_t_bits * vtable, scm_t_bits * data);
SCM_API void scm_struct_free_entity (scm_t_bits * vtable, scm_t_bits * data);
SCM_API SCM scm_make_struct_layout (SCM fields);
SCM_API SCM scm_struct_p (SCM x);
SCM_API SCM scm_struct_vtable_p (SCM x);
SCM_API SCM scm_make_struct (SCM vtable, SCM tail_array_size, SCM init);
SCM_API SCM scm_make_vtable_vtable (SCM extra_fields, SCM tail_array_size, SCM init);
SCM_API SCM scm_struct_ref (SCM handle, SCM pos);
SCM_API SCM scm_struct_set_x (SCM handle, SCM pos, SCM val);
SCM_API SCM scm_struct_vtable (SCM handle);
SCM_API SCM scm_struct_vtable_tag (SCM handle);
SCM_API unsigned long scm_struct_ihashq (SCM obj, unsigned long n);
SCM_API SCM scm_struct_create_handle (SCM obj);
SCM_API SCM scm_struct_vtable_name (SCM vtable);
SCM_API SCM scm_set_struct_vtable_name_x (SCM vtable, SCM name);
SCM_API void scm_print_struct (SCM exp, SCM port, scm_print_state *);
SCM_API void scm_struct_prehistory (void);
SCM_API void scm_init_struct (void);

#endif  /* SCM_STRUCT_H */

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
0f2d19dd JB	1	/* classes: h_files */
0f2d19dd JB	2
729dbac3 DH	3	#ifndef SCM_STRUCT_H
729dbac3 DH	4	#define SCM_STRUCT_H
b29058ff	5
729dbac3	6	/* Copyright (C) 1995,1997,1999,2000,2001 Free Software Foundation, Inc.
b29058ff	7	*
0f2d19dd JB	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.
b29058ff	12	*
0f2d19dd JB	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.
b29058ff	17	*
0f2d19dd JB	18	* You should have received a copy of the GNU General Public License
0f2d19dd JB	19	* along with this software; see the file COPYING. If not, write to
82892bed JB	20	* the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
82892bed JB	21	* Boston, MA 02111-1307 USA
0f2d19dd JB	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.
82892bed	45	* If you do not wish that, delete this exception notice. */
d3a6bc94	46
0f2d19dd JB	47	\f
0f2d19dd JB	48
b4309c3c	49	#include "libguile/__scm.h"
bafcafb2	50	#include "libguile/print.h"
0f2d19dd JB	51
	52	\f
	53
2c36c351	54	/* Number of words with negative index */
ad196599	55	#define scm_struct_n_extra_words 4
2c53acd5	56	#define scm_struct_entity_n_extra_words 6
2c36c351	57
0f2d19dd	58	/* These are how the initial words of a vtable are allocated. */
2c53acd5 MD	59	#define scm_struct_i_setter -6 /* Setter */
2c53acd5 MD	60	#define scm_struct_i_procedure -5 /* Optional procedure slot */
ad196599 MD	61	#define scm_struct_i_free -4 /* Destructor */
ad196599 MD	62	#define scm_struct_i_ptr -3 /* Start of block (see alloc_struct) */
4bfdf158	63	#define scm_struct_i_n_words -2 /* How many words allocated to this struct? */
ad196599 MD	64	#define scm_struct_i_size -1 /* Instance size */
ad196599 MD	65	#define scm_struct_i_flags -1 /* Upper 12 bits used as flags */
7866776c MV	66
	67	/* These indices must correspond to required_vtable_fields in
	68	struct.c. */
4bfdf158	69	#define scm_vtable_index_layout 0 /* A symbol describing the physical arrangement of this type. */
7866776c MV	70	#define scm_vtable_index_vtable 1 /* A pointer to the handle for this vtable. */
	71	#define scm_vtable_index_printer 2 /* A printer for this struct type. */
	72	#define scm_vtable_offset_user 3 /* Where do user fields start? */
0f2d19dd	73
4c9419ac	74	typedef void (scm_t_struct_free) (scm_t_bits vtable, scm_t_bits * data);
ad196599 MD	75
ad196599 MD	76	#define SCM_STRUCTF_MASK (0xFFF << 20)
f40f662e	77	#define SCM_STRUCTF_ENTITY (1L << 30) /* Indicates presence of proc slots */
7ee70a26 MD	78	#define SCM_STRUCTF_LIGHT (1L << 31) /* Light representation
7ee70a26 MD	79	(no hidden words) */
0f2d19dd	80
b29058ff	81	#define SCM_STRUCTP(X) (!SCM_IMP(X) && (SCM_TYP3(X) == scm_tc3_struct))
92c2555f	82	#define SCM_STRUCT_DATA(X) ((scm_t_bits *) SCM_CELL_WORD_1 (X))
904a077d	83	#define SCM_STRUCT_VTABLE_DATA(X) ((scm_t_bits *) (SCM_CELL_WORD_0 (X) - scm_tc3_struct))
1c3e63f0 DH	84
	85	#define SCM_STRUCT_LAYOUT(X) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout]))
	86	#define SCM_SET_STRUCT_LAYOUT(X, v) (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout] = SCM_UNPACK (v))
	87
	88	#define SCM_STRUCT_VTABLE(X) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_vtable]))
00d8d838 DH	89	#define SCM_STRUCT_VTABLE_FLAGS(X) \
00d8d838 DH	90	(SCM_STRUCT_VTABLE_DATA (X) [scm_struct_i_flags])
1c3e63f0	91	#define SCM_STRUCT_PRINTER(X) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_printer]))
ce212434	92	#define SCM_SET_STRUCT_PRINTER(x, v)\
729dbac3	93	(SCM_STRUCT_VTABLE_DATA (x) [scm_vtable_index_printer] = SCM_UNPACK (v))
92c2555f	94	#define SCM_SET_VTABLE_DESTRUCTOR(X, D) (SCM_STRUCT_DATA (X) [scm_struct_i_free] = (scm_t_bits) (D))
2c36c351 MD	95	/* Efficiency is important in the following macro, since it's used in GC */
2c36c351 MD	96	#define SCM_LAYOUT_TAILP(X) (((X) & 32) == 0) /* R, W or O */
0f2d19dd	97
6decd505 MD	98	#define SCM_STRUCT_TABLE_NAME(X) SCM_CAR (X)
	99	#define SCM_SET_STRUCT_TABLE_NAME(X, NAME) SCM_SETCAR (X, NAME)
	100	#define SCM_STRUCT_TABLE_CLASS(X) SCM_CDR (X)
	101	#define SCM_SET_STRUCT_TABLE_CLASS(X, CLASS) SCM_SETCDR (X, CLASS)
33b001fd	102	SCM_API SCM scm_struct_table;
0f2d19dd	103
85c21339 MD	104	#define SCM_STRUCT_GC_CHAIN(X) SCM_CELL_OBJECT_3 (X)
85c21339 MD	105	#define SCM_SET_STRUCT_GC_CHAIN(X, Y) SCM_SET_CELL_OBJECT_3 (X, Y)
ffd72400	106	SCM_API SCM scm_i_structs_to_free;
85c21339	107
0f2d19dd	108	\f
0f2d19dd	109
4c9419ac MV	110	SCM_API scm_t_bits * scm_alloc_struct (int n_words, int n_extra,
	111	const char *what);
	112	SCM_API void scm_struct_free_0 (scm_t_bits * vtable, scm_t_bits * data);
	113	SCM_API void scm_struct_free_light (scm_t_bits * vtable, scm_t_bits * data);
	114	SCM_API void scm_struct_free_standard (scm_t_bits * vtable, scm_t_bits * data);
	115	SCM_API void scm_struct_free_entity (scm_t_bits * vtable, scm_t_bits * data);
33b001fd MV	116	SCM_API SCM scm_make_struct_layout (SCM fields);
	117	SCM_API SCM scm_struct_p (SCM x);
	118	SCM_API SCM scm_struct_vtable_p (SCM x);
	119	SCM_API SCM scm_make_struct (SCM vtable, SCM tail_array_size, SCM init);
	120	SCM_API SCM scm_make_vtable_vtable (SCM extra_fields, SCM tail_array_size, SCM init);
	121	SCM_API SCM scm_struct_ref (SCM handle, SCM pos);
	122	SCM_API SCM scm_struct_set_x (SCM handle, SCM pos, SCM val);
	123	SCM_API SCM scm_struct_vtable (SCM handle);
	124	SCM_API SCM scm_struct_vtable_tag (SCM handle);
	125	SCM_API unsigned long scm_struct_ihashq (SCM obj, unsigned long n);
	126	SCM_API SCM scm_struct_create_handle (SCM obj);
	127	SCM_API SCM scm_struct_vtable_name (SCM vtable);
	128	SCM_API SCM scm_set_struct_vtable_name_x (SCM vtable, SCM name);
	129	SCM_API void scm_print_struct (SCM exp, SCM port, scm_print_state *);
	130	SCM_API void scm_struct_prehistory (void);
	131	SCM_API void scm_init_struct (void);
0f2d19dd	132
729dbac3	133	#endif /* SCM_STRUCT_H */
89e00824 ML	134
	135	/*
	136	Local Variables:
	137	c-file-style: "gnu"
	138	End:
	139	*/