[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 size_t (*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_NIMP(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)
extern 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)
extern SCM scm_structs_to_free;

\f

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