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

/* classes: h_files */

#ifndef SCM_SMOB_H
#define SCM_SMOB_H

/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006 Free Software Foundation, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

\f

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

\f
/* This is the internal representation of a smob type */

typedef struct scm_smob_descriptor
{
  char const *name;
  size_t size;
  SCM (*mark) (SCM);
  size_t (*free) (SCM);
  int (*print) (SCM exp, SCM port, scm_print_state *pstate);
  SCM (*equalp) (SCM, SCM);
  SCM (*apply) ();
  SCM (*apply_0) (SCM);
  SCM (*apply_1) (SCM, SCM);
  SCM (*apply_2) (SCM, SCM, SCM);
  SCM (*apply_3) (SCM, SCM, SCM, SCM);
  int gsubr_type; /* Used in procprop.c */
} scm_smob_descriptor;


\f
SCM_API SCM scm_i_new_smob_with_mark_proc (scm_t_bits tc,
					   scm_t_bits, scm_t_bits, scm_t_bits);


#define SCM_NEWSMOB(z, tc, data)					\
do									\
  {									\
    register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc);			\
    z = (scm_smobs[_smobnum].mark					\
	 ? scm_i_new_smob_with_mark_proc ((tc), (scm_t_bits)(data),	\
					  0, 0)				\
	 : scm_cell (tc, (scm_t_bits)(data)));				\
    if (scm_smobs[_smobnum].free)					\
      scm_gc_register_finalizer ((z), scm_i_finalize_smob,		\
				 SCM_BOOL_F, 0);			\
  }									\
while (0)

#define SCM_RETURN_NEWSMOB(tc, data)			\
  do { SCM __SCM_smob_answer;				\
       SCM_NEWSMOB (__SCM_smob_answer, (tc), (data));	\
       return __SCM_smob_answer;			\
  } while (0)

#define SCM_NEWSMOB2(z, tc, data1, data2)	\
  SCM_NEWSMOB3 (z, tc, data1, data2, 0)

#define SCM_RETURN_NEWSMOB2(tc, data1, data2)				\
  do { SCM __SCM_smob_answer;						\
       SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2));	\
       return __SCM_smob_answer;					\
  } while (0)

#define SCM_NEWSMOB3(z, tc, data1, data2, data3)			\
do									\
  {									\
    register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc);			\
    z = (scm_smobs[_smobnum].mark					\
	 ? scm_i_new_smob_with_mark_proc (tc, (scm_t_bits)(data1),	\
					  (scm_t_bits)(data2),		\
					  (scm_t_bits)(data3))		\
	 : scm_double_cell ((tc), (scm_t_bits)(data1),			\
			    (scm_t_bits)(data2),			\
			    (scm_t_bits)(data3)));			\
    if (scm_smobs[_smobnum].free)					\
      scm_gc_register_finalizer ((z), scm_i_finalize_smob,		\
				 SCM_BOOL_F, 0);			\
  }									\
while (0)

#define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3)			    \
  do { SCM __SCM_smob_answer;						    \
       SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3));   \
       return __SCM_smob_answer;					    \
  } while (0)


#define SCM_SMOB_FLAGS(x)               (SCM_CELL_WORD_0 (x) >> 16)
#define SCM_SMOB_DATA(x)		(SCM_CELL_WORD_1 (x))
#define SCM_SMOB_DATA_2(x)		(SCM_CELL_WORD_2 (x))
#define SCM_SMOB_DATA_3(x)		(SCM_CELL_WORD_3 (x))
#define SCM_SET_SMOB_DATA(x, data)	(SCM_SET_CELL_WORD_1 ((x), (data)))
#define SCM_SET_SMOB_DATA_2(x, data)	(SCM_SET_CELL_WORD_2 ((x), (data)))
#define SCM_SET_SMOB_DATA_3(x, data)	(SCM_SET_CELL_WORD_3 ((x), (data)))
#define SCM_SET_SMOB_FLAGS(x, data)     (scm_i_set_smob_flags((x),(data)<<16))

#define SCM_SMOB_OBJECT(x)		(SCM_CELL_OBJECT_1 (x))
#define SCM_SMOB_OBJECT_2(x)	        (SCM_CELL_OBJECT_2 (x))
#define SCM_SMOB_OBJECT_3(x)	        (SCM_CELL_OBJECT_3 (x))
#define SCM_SET_SMOB_OBJECT(x,obj)	(SCM_SET_CELL_OBJECT_1 ((x), (obj)))
#define SCM_SET_SMOB_OBJECT_2(x,obj)    (SCM_SET_CELL_OBJECT_2 ((x), (obj)))
#define SCM_SET_SMOB_OBJECT_3(x,obj)    (SCM_SET_CELL_OBJECT_3 ((x), (obj)))
#define SCM_SMOB_OBJECT_LOC(x)		(SCM_CELL_OBJECT_LOC ((x), 1))
#define SCM_SMOB_OBJECT_2_LOC(x)	(SCM_CELL_OBJECT_LOC ((x), 2))
#define SCM_SMOB_OBJECT_3_LOC(x)	(SCM_CELL_OBJECT_LOC ((x), 3))

#define SCM_TC2SMOBNUM(x)		(0x0ff & ((x) >> 8))
#define SCM_SMOBNUM(x)			(SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
/* SCM_SMOBNAME can be 0 if name is missing */
#define SCM_SMOBNAME(smobnum)		(scm_smobs[smobnum].name)
#define SCM_SMOB_PREDICATE(tag, obj)	SCM_TYP16_PREDICATE (tag, obj)
#define SCM_SMOB_DESCRIPTOR(x)		(scm_smobs[SCM_SMOBNUM (x)])
#define SCM_SMOB_APPLICABLE_P(x)	(SCM_SMOB_DESCRIPTOR (x).apply)
#define SCM_SMOB_APPLY_0(x)		(SCM_SMOB_DESCRIPTOR (x).apply_0 (x))
#define SCM_SMOB_APPLY_1(x, a1)		(SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1)))
#define SCM_SMOB_APPLY_2(x, a1, a2)	(SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2)))
#define SCM_SMOB_APPLY_3(x, a1, a2, rst)	(SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst)))

SCM_API long scm_numsmob;
SCM_API scm_smob_descriptor scm_smobs[];

SCM_API void scm_i_set_smob_flags (SCM x, scm_t_bits data);
SCM_API SCM scm_i_finalize_smob (SCM smob, SCM data);

\f

SCM_API SCM scm_mark0 (SCM ptr);
SCM_API SCM scm_markcdr (SCM ptr);
SCM_API size_t scm_free0 (SCM ptr);
SCM_API size_t scm_smob_free (SCM obj);
SCM_API int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);

/* The following set of functions is the standard way to create new
 * SMOB types.
 *
 * Create a type tag using `scm_make_smob_type', accept default values
 * for mark, free, print and/or equalp functions, or set your own
 * values using `scm_set_smob_xxx'.
 */

SCM_API scm_t_bits scm_make_smob_type (char const *name, size_t size);

SCM_API void scm_set_smob_mark (scm_t_bits tc, SCM (*mark) (SCM));
SCM_API void scm_set_smob_free (scm_t_bits tc, size_t (*free) (SCM));
SCM_API void scm_set_smob_print (scm_t_bits tc,
				 int (*print) (SCM, SCM, scm_print_state*));
SCM_API void scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM));
SCM_API void scm_set_smob_apply (scm_t_bits tc,
				 SCM (*apply) (),
				 unsigned int req,
				 unsigned int opt,
				 unsigned int rst);

SCM_API void scm_assert_smob_type (scm_t_bits tag, SCM val);

/* Function for creating smobs */

SCM_API SCM scm_make_smob (scm_t_bits tc);

SCM_API void scm_smob_prehistory (void);

#endif  /* SCM_SMOB_H */

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
0f2d19dd JB	1	/* classes: h_files */
0f2d19dd JB	2
7a7f7c53 DH	3	#ifndef SCM_SMOB_H
7a7f7c53 DH	4	#define SCM_SMOB_H
dee01b01	5
2b829bbb	6	/* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006 Free Software Foundation, Inc.
dee01b01	7	*
73be1d9e MV	8	* This library is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU Lesser General Public
	10	* License as published by the Free Software Foundation; either
	11	* version 2.1 of the License, or (at your option) any later version.
dee01b01	12	*
73be1d9e	13	* This library is distributed in the hope that it will be useful,
0f2d19dd	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
73be1d9e MV	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
73be1d9e MV	16	* Lesser General Public License for more details.
dee01b01	17	*
73be1d9e MV	18	* You should have received a copy of the GNU Lesser General Public
73be1d9e MV	19	* License along with this library; if not, write to the Free Software
92205699	20	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
73be1d9e	21	*/
dee01b01	22
0f2d19dd	23	\f
dee01b01	24
b4309c3c	25	#include "libguile/__scm.h"
b08323d1	26	#include "libguile/print.h"
0f2d19dd JB	27
0f2d19dd JB	28	\f
9dd5943c MD	29	/* This is the internal representation of a smob type */
	30
	31	typedef struct scm_smob_descriptor
	32	{
da0e6c2b	33	char const *name;
1be6b49c	34	size_t size;
7866a09b	35	SCM (*mark) (SCM);
1be6b49c	36	size_t (*free) (SCM);
7866a09b GB	37	int (print) (SCM exp, SCM port, scm_print_state pstate);
7866a09b GB	38	SCM (*equalp) (SCM, SCM);
cb1c46c5 KN	39	SCM (*apply) ();
	40	SCM (*apply_0) (SCM);
	41	SCM (*apply_1) (SCM, SCM);
	42	SCM (*apply_2) (SCM, SCM, SCM);
	43	SCM (*apply_3) (SCM, SCM, SCM, SCM);
68b06924	44	int gsubr_type; /* Used in procprop.c */
9dd5943c MD	45	} scm_smob_descriptor;
9dd5943c MD	46
378f2625	47
0f2d19dd	48	\f
378f2625 LC	49	SCM_API SCM scm_i_new_smob_with_mark_proc (scm_t_bits tc,
	50	scm_t_bits, scm_t_bits, scm_t_bits);
	51
	52
0f2d19dd	53
378f2625 LC	54	#define SCM_NEWSMOB(z, tc, data) \
	55	do \
	56	{ \
e9d635e5 LC	57	register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc); \
e9d635e5 LC	58	z = (scm_smobs[_smobnum].mark \
378f2625 LC	59	? scm_i_new_smob_with_mark_proc ((tc), (scm_t_bits)(data), \
	60	0, 0) \
	61	: scm_cell (tc, (scm_t_bits)(data))); \
e9d635e5 LC	62	if (scm_smobs[_smobnum].free) \
	63	scm_gc_register_finalizer ((z), scm_i_finalize_smob, \
	64	SCM_BOOL_F, 0); \
378f2625 LC	65	} \
378f2625 LC	66	while (0)
23a62151	67
378f2625 LC	68	#define SCM_RETURN_NEWSMOB(tc, data) \
	69	do { SCM __SCM_smob_answer; \
	70	SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
	71	return __SCM_smob_answer; \
23a62151 MD	72	} while (0)
23a62151 MD	73
378f2625 LC	74	#define SCM_NEWSMOB2(z, tc, data1, data2) \
378f2625 LC	75	SCM_NEWSMOB3 (z, tc, data1, data2, 0)
87621a14	76
378f2625 LC	77	#define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
	78	do { SCM __SCM_smob_answer; \
	79	SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
	80	return __SCM_smob_answer; \
87621a14 MD	81	} while (0)
87621a14 MD	82
378f2625 LC	83	#define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
	84	do \
	85	{ \
e9d635e5 LC	86	register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc); \
e9d635e5 LC	87	z = (scm_smobs[_smobnum].mark \
378f2625 LC	88	? scm_i_new_smob_with_mark_proc (tc, (scm_t_bits)(data1), \
	89	(scm_t_bits)(data2), \
	90	(scm_t_bits)(data3)) \
	91	: scm_double_cell ((tc), (scm_t_bits)(data1), \
	92	(scm_t_bits)(data2), \
	93	(scm_t_bits)(data3))); \
e9d635e5 LC	94	if (scm_smobs[_smobnum].free) \
	95	scm_gc_register_finalizer ((z), scm_i_finalize_smob, \
	96	SCM_BOOL_F, 0); \
378f2625 LC	97	} \
378f2625 LC	98	while (0)
87621a14	99
378f2625 LC	100	#define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
	101	do { SCM __SCM_smob_answer; \
	102	SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
	103	return __SCM_smob_answer; \
87621a14 MD	104	} while (0)
87621a14 MD	105
9dd5943c	106
37fc18ae	107	#define SCM_SMOB_FLAGS(x) (SCM_CELL_WORD_0 (x) >> 16)
94113249	108	#define SCM_SMOB_DATA(x) (SCM_CELL_WORD_1 (x))
37fc18ae MV	109	#define SCM_SMOB_DATA_2(x) (SCM_CELL_WORD_2 (x))
37fc18ae MV	110	#define SCM_SMOB_DATA_3(x) (SCM_CELL_WORD_3 (x))
94113249	111	#define SCM_SET_SMOB_DATA(x, data) (SCM_SET_CELL_WORD_1 ((x), (data)))
37fc18ae MV	112	#define SCM_SET_SMOB_DATA_2(x, data) (SCM_SET_CELL_WORD_2 ((x), (data)))
	113	#define SCM_SET_SMOB_DATA_3(x, data) (SCM_SET_CELL_WORD_3 ((x), (data)))
	114	#define SCM_SET_SMOB_FLAGS(x, data) (scm_i_set_smob_flags((x),(data)<<16))
	115
	116	#define SCM_SMOB_OBJECT(x) (SCM_CELL_OBJECT_1 (x))
	117	#define SCM_SMOB_OBJECT_2(x) (SCM_CELL_OBJECT_2 (x))
	118	#define SCM_SMOB_OBJECT_3(x) (SCM_CELL_OBJECT_3 (x))
	119	#define SCM_SET_SMOB_OBJECT(x,obj) (SCM_SET_CELL_OBJECT_1 ((x), (obj)))
	120	#define SCM_SET_SMOB_OBJECT_2(x,obj) (SCM_SET_CELL_OBJECT_2 ((x), (obj)))
	121	#define SCM_SET_SMOB_OBJECT_3(x,obj) (SCM_SET_CELL_OBJECT_3 ((x), (obj)))
	122	#define SCM_SMOB_OBJECT_LOC(x) (SCM_CELL_OBJECT_LOC ((x), 1))
	123	#define SCM_SMOB_OBJECT_2_LOC(x) (SCM_CELL_OBJECT_LOC ((x), 2))
	124	#define SCM_SMOB_OBJECT_3_LOC(x) (SCM_CELL_OBJECT_LOC ((x), 3))
	125
94113249 DH	126	#define SCM_TC2SMOBNUM(x) (0x0ff & ((x) >> 8))
94113249 DH	127	#define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
2c16a78a	128	/* SCM_SMOBNAME can be 0 if name is missing */
94113249	129	#define SCM_SMOBNAME(smobnum) (scm_smobs[smobnum].name)
e841c3e0	130	#define SCM_SMOB_PREDICATE(tag, obj) SCM_TYP16_PREDICATE (tag, obj)
0717dfd8	131	#define SCM_SMOB_DESCRIPTOR(x) (scm_smobs[SCM_SMOBNUM (x)])
68b06924 KN	132	#define SCM_SMOB_APPLICABLE_P(x) (SCM_SMOB_DESCRIPTOR (x).apply)
68b06924 KN	133	#define SCM_SMOB_APPLY_0(x) (SCM_SMOB_DESCRIPTOR (x).apply_0 (x))
34d19ef6 HWN	134	#define SCM_SMOB_APPLY_1(x, a1) (SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1)))
	135	#define SCM_SMOB_APPLY_2(x, a1, a2) (SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2)))
	136	#define SCM_SMOB_APPLY_3(x, a1, a2, rst) (SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst)))
0f2d19dd	137
33b001fd MV	138	SCM_API long scm_numsmob;
33b001fd MV	139	SCM_API scm_smob_descriptor scm_smobs[];
0f2d19dd	140
37fc18ae	141	SCM_API void scm_i_set_smob_flags (SCM x, scm_t_bits data);
e9d635e5	142	SCM_API SCM scm_i_finalize_smob (SCM smob, SCM data);
37fc18ae	143
0f2d19dd	144	\f
0f2d19dd	145
33b001fd MV	146	SCM_API SCM scm_mark0 (SCM ptr);
	147	SCM_API SCM scm_markcdr (SCM ptr);
	148	SCM_API size_t scm_free0 (SCM ptr);
	149	SCM_API size_t scm_smob_free (SCM obj);
	150	SCM_API int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
23a62151	151
c72baaaa MD	152	/* The following set of functions is the standard way to create new
	153	* SMOB types.
	154	*
	155	* Create a type tag using `scm_make_smob_type', accept default values
	156	* for mark, free, print and/or equalp functions, or set your own
	157	* values using `scm_set_smob_xxx'.
	158	*/
23a62151	159
df5af69a	160	SCM_API scm_t_bits scm_make_smob_type (char const *name, size_t size);
23a62151	161
33b001fd MV	162	SCM_API void scm_set_smob_mark (scm_t_bits tc, SCM (*mark) (SCM));
	163	SCM_API void scm_set_smob_free (scm_t_bits tc, size_t (*free) (SCM));
	164	SCM_API void scm_set_smob_print (scm_t_bits tc,
	165	int (print) (SCM, SCM, scm_print_state));
	166	SCM_API void scm_set_smob_equalp (scm_t_bits tc, SCM (*equalp) (SCM, SCM));
	167	SCM_API void scm_set_smob_apply (scm_t_bits tc,
	168	SCM (*apply) (),
	169	unsigned int req,
	170	unsigned int opt,
	171	unsigned int rst);
c72baaaa	172
197b0573 MV	173	SCM_API void scm_assert_smob_type (scm_t_bits tag, SCM val);
197b0573 MV	174
7c58e21b	175	/* Function for creating smobs */
c72baaaa	176
33b001fd	177	SCM_API SCM scm_make_smob (scm_t_bits tc);
197b0573	178
33b001fd	179	SCM_API void scm_smob_prehistory (void);
7c58e21b	180
7a7f7c53	181	#endif /* SCM_SMOB_H */
89e00824 ML	182
	183	/*
	184	Local Variables:
	185	c-file-style: "gnu"
	186	End:
	187	*/