[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 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
/* This is the internal representation of a smob type */

typedef struct scm_smob_descriptor
{
  char *name;
  scm_sizet size;
  SCM (*mark) (SCM);
  scm_sizet (*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

#define SCM_NEWSMOB(z, tc, data) \
do { \
  SCM_NEWCELL (z); \
  SCM_SET_CELL_WORD_1 ((z), (data)); \
  SCM_SET_CELL_TYPE ((z), (tc)); \
} 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) \
do { \
  SCM_NEWCELL2 (z); \
  SCM_SET_CELL_WORD_1 ((z), (data1)); \
  SCM_SET_CELL_WORD_2 ((z), (data2)); \
  SCM_SET_CELL_TYPE ((z), (tc)); \
} while (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 { \
  SCM_NEWCELL2 (z); \
  SCM_SET_CELL_WORD_1 ((z), (data1)); \
  SCM_SET_CELL_WORD_2 ((z), (data2)); \
  SCM_SET_CELL_WORD_3 ((z), (data3)); \
  SCM_SET_CELL_TYPE ((z), (tc)); \
} 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_DATA(x)		(SCM_CELL_WORD_1 (x))
#define SCM_SET_SMOB_DATA(x, data)	(SCM_SET_CELL_WORD_1 ((x), (data)))
#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)))

extern int scm_numsmob;
extern scm_smob_descriptor scm_smobs[];

\f

extern SCM scm_mark0 (SCM ptr);
extern SCM scm_markcdr (SCM ptr);
extern scm_sizet scm_free0 (SCM ptr);
extern scm_sizet scm_smob_free (SCM obj);
extern 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'.
 */

extern scm_bits_t scm_make_smob_type (char *name, scm_sizet size);

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

/* Function for creating smobs */

extern SCM scm_make_smob (scm_bits_t tc);
extern void scm_smob_prehistory (void);

\f

#if (SCM_DEBUG_DEPRECATED == 0)

extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
                                    SCM (*mark) (SCM),
                                    scm_sizet (*free) (SCM),
                                    int (*print) (SCM, SCM, scm_print_state*),
                                    SCM (*equalp) (SCM, SCM));

extern void scm_set_smob_mfpe (long tc, 
			       SCM (*mark) (SCM),
			       scm_sizet (*free) (SCM),
			       int (*print) (SCM, SCM, scm_print_state*),
			       SCM (*equalp) (SCM, SCM));

#endif  /* SCM_DEBUG_DEPRECATED == 0 */

#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
	4	#define SCM_SMOB_H
	5	/* Copyright (C) 1995,1996,1998,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. */
0f2d19dd	45	\f
b4309c3c	46	#include "libguile/__scm.h"
b08323d1	47	#include "libguile/print.h"
0f2d19dd JB	48
0f2d19dd JB	49	\f
9dd5943c MD	50	/* This is the internal representation of a smob type */
	51
	52	typedef struct scm_smob_descriptor
	53	{
	54	char *name;
	55	scm_sizet size;
7866a09b GB	56	SCM (*mark) (SCM);
	57	scm_sizet (*free) (SCM);
	58	int (print) (SCM exp, SCM port, scm_print_state pstate);
	59	SCM (*equalp) (SCM, SCM);
cb1c46c5 KN	60	SCM (*apply) ();
	61	SCM (*apply_0) (SCM);
	62	SCM (*apply_1) (SCM, SCM);
	63	SCM (*apply_2) (SCM, SCM, SCM);
	64	SCM (*apply_3) (SCM, SCM, SCM, SCM);
68b06924	65	int gsubr_type; /* Used in procprop.c */
9dd5943c MD	66	} scm_smob_descriptor;
9dd5943c MD	67
0f2d19dd JB	68	\f
0f2d19dd JB	69
9dd5943c	70	#define SCM_NEWSMOB(z, tc, data) \
23a62151	71	do { \
9dd5943c	72	SCM_NEWCELL (z); \
94113249 DH	73	SCM_SET_CELL_WORD_1 ((z), (data)); \
94113249 DH	74	SCM_SET_CELL_TYPE ((z), (tc)); \
23a62151 MD	75	} while (0)
	76
	77	#define SCM_RETURN_NEWSMOB(tc, data) \
	78	do { SCM __SCM_smob_answer; \
94113249	79	SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
23a62151 MD	80	return __SCM_smob_answer; \
	81	} while (0)
	82
87621a14 MD	83	#define SCM_NEWSMOB2(z, tc, data1, data2) \
	84	do { \
	85	SCM_NEWCELL2 (z); \
94113249 DH	86	SCM_SET_CELL_WORD_1 ((z), (data1)); \
	87	SCM_SET_CELL_WORD_2 ((z), (data2)); \
	88	SCM_SET_CELL_TYPE ((z), (tc)); \
87621a14 MD	89	} while (0)
	90
	91	#define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
	92	do { SCM __SCM_smob_answer; \
94113249	93	SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
87621a14 MD	94	return __SCM_smob_answer; \
	95	} while (0)
	96
	97	#define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
	98	do { \
	99	SCM_NEWCELL2 (z); \
94113249 DH	100	SCM_SET_CELL_WORD_1 ((z), (data1)); \
	101	SCM_SET_CELL_WORD_2 ((z), (data2)); \
	102	SCM_SET_CELL_WORD_3 ((z), (data3)); \
	103	SCM_SET_CELL_TYPE ((z), (tc)); \
87621a14 MD	104	} while (0)
	105
	106	#define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
	107	do { SCM __SCM_smob_answer; \
94113249	108	SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
87621a14 MD	109	return __SCM_smob_answer; \
	110	} while (0)
	111
9dd5943c	112
94113249 DH	113	#define SCM_SMOB_DATA(x) (SCM_CELL_WORD_1 (x))
	114	#define SCM_SET_SMOB_DATA(x, data) (SCM_SET_CELL_WORD_1 ((x), (data)))
	115	#define SCM_TC2SMOBNUM(x) (0x0ff & ((x) >> 8))
	116	#define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
2c16a78a	117	/* SCM_SMOBNAME can be 0 if name is missing */
94113249	118	#define SCM_SMOBNAME(smobnum) (scm_smobs[smobnum].name)
e841c3e0	119	#define SCM_SMOB_PREDICATE(tag, obj) SCM_TYP16_PREDICATE (tag, obj)
0717dfd8	120	#define SCM_SMOB_DESCRIPTOR(x) (scm_smobs[SCM_SMOBNUM (x)])
68b06924 KN	121	#define SCM_SMOB_APPLICABLE_P(x) (SCM_SMOB_DESCRIPTOR (x).apply)
	122	#define SCM_SMOB_APPLY_0(x) (SCM_SMOB_DESCRIPTOR (x).apply_0 (x))
	123	#define SCM_SMOB_APPLY_1(x,a1) (SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1)))
	124	#define SCM_SMOB_APPLY_2(x,a1,a2) (SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2)))
	125	#define SCM_SMOB_APPLY_3(x,a1,a2,rst) (SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst)))
0f2d19dd	126
4e6e2119	127	extern int scm_numsmob;
7a7f7c53	128	extern scm_smob_descriptor scm_smobs[];
0f2d19dd JB	129
0f2d19dd JB	130	\f
0f2d19dd	131
7866a09b GB	132	extern SCM scm_mark0 (SCM ptr);
	133	extern SCM scm_markcdr (SCM ptr);
	134	extern scm_sizet scm_free0 (SCM ptr);
9dd5943c MD	135	extern scm_sizet scm_smob_free (SCM obj);
9dd5943c MD	136	extern int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate);
23a62151	137
c72baaaa MD	138	/* The following set of functions is the standard way to create new
	139	* SMOB types.
	140	*
	141	* Create a type tag using `scm_make_smob_type', accept default values
	142	* for mark, free, print and/or equalp functions, or set your own
	143	* values using `scm_set_smob_xxx'.
	144	*/
23a62151	145
8a39e3fc	146	extern scm_bits_t scm_make_smob_type (char *name, scm_sizet size);
23a62151	147
914cceec KN	148	extern void scm_set_smob_mark (scm_bits_t tc, SCM (*mark) (SCM));
914cceec KN	149	extern void scm_set_smob_free (scm_bits_t tc, scm_sizet (*free) (SCM));
03416a99 KN	150	extern void scm_set_smob_print (scm_bits_t tc,
03416a99 KN	151	int (print) (SCM, SCM, scm_print_state));
914cceec	152	extern void scm_set_smob_equalp (scm_bits_t tc, SCM (*equalp) (SCM, SCM));
03416a99 KN	153	extern void scm_set_smob_apply (scm_bits_t tc,
03416a99 KN	154	SCM (*apply) (),
7c58e21b KN	155	unsigned int req,
	156	unsigned int opt,
	157	unsigned int rst);
c72baaaa	158
7c58e21b	159	/* Function for creating smobs */
c72baaaa	160
03416a99	161	extern SCM scm_make_smob (scm_bits_t tc);
7c58e21b KN	162	extern void scm_smob_prehistory (void);
	163
	164	\f
	165
	166	#if (SCM_DEBUG_DEPRECATED == 0)
c72baaaa MD	167
	168	extern long scm_make_smob_type_mfpe (char *name, scm_sizet size,
	169	SCM (*mark) (SCM),
	170	scm_sizet (*free) (SCM),
	171	int (print) (SCM, SCM, scm_print_state),
	172	SCM (*equalp) (SCM, SCM));
	173
23a62151 MD	174	extern void scm_set_smob_mfpe (long tc,
	175	SCM (*mark) (SCM),
	176	scm_sizet (*free) (SCM),
	177	int (print) (SCM, SCM, scm_print_state),
	178	SCM (*equalp) (SCM, SCM));
	179
7c58e21b	180	#endif /* SCM_DEBUG_DEPRECATED == 0 */
f5f2dcff	181
7a7f7c53	182	#endif /* SCM_SMOB_H */
89e00824 ML	183
	184	/*
	185	Local Variables:
	186	c-file-style: "gnu"
	187	End:
	188	*/