6 /* Copyright (C) 1995,1996,1998,1999,2000,2001, 2004, 2006 Free Software Foundation, Inc.
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.
13 * This library 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 GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "libguile/__scm.h"
26 #include "libguile/print.h"
28 #include "libguile/boehm-gc.h"
32 /* This is the internal representation of a smob type */
34 typedef struct scm_smob_descriptor
40 int (*print
) (SCM exp
, SCM port
, scm_print_state
*pstate
);
41 SCM (*equalp
) (SCM
, SCM
);
44 SCM (*apply_1
) (SCM
, SCM
);
45 SCM (*apply_2
) (SCM
, SCM
, SCM
);
46 SCM (*apply_3
) (SCM
, SCM
, SCM
, SCM
);
47 int gsubr_type
; /* Used in procprop.c */
48 } scm_smob_descriptor
;
52 SCM_API SCM
scm_i_new_smob_with_mark_proc (scm_t_bits tc
,
53 scm_t_bits
, scm_t_bits
, scm_t_bits
);
57 #define SCM_NEWSMOB(z, tc, data) \
60 register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc); \
61 z = (scm_smobs[_smobnum].mark \
62 ? scm_i_new_smob_with_mark_proc ((tc), (scm_t_bits)(data), \
64 : scm_cell (tc, (scm_t_bits)(data))); \
65 if (scm_smobs[_smobnum].free) \
67 GC_finalization_proc _prev_finalizer; \
68 GC_PTR _prev_finalizer_data; \
70 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (z), scm_i_finalize_smob, \
73 &_prev_finalizer_data); \
78 #define SCM_RETURN_NEWSMOB(tc, data) \
79 do { SCM __SCM_smob_answer; \
80 SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \
81 return __SCM_smob_answer; \
84 #define SCM_NEWSMOB2(z, tc, data1, data2) \
85 SCM_NEWSMOB3 (z, tc, data1, data2, 0)
87 #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \
88 do { SCM __SCM_smob_answer; \
89 SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \
90 return __SCM_smob_answer; \
93 #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \
96 register scm_t_bits _smobnum = SCM_TC2SMOBNUM (tc); \
97 z = (scm_smobs[_smobnum].mark \
98 ? scm_i_new_smob_with_mark_proc (tc, (scm_t_bits)(data1), \
99 (scm_t_bits)(data2), \
100 (scm_t_bits)(data3)) \
101 : scm_double_cell ((tc), (scm_t_bits)(data1), \
102 (scm_t_bits)(data2), \
103 (scm_t_bits)(data3))); \
104 if (scm_smobs[_smobnum].free) \
106 GC_finalization_proc _prev_finalizer; \
107 GC_PTR _prev_finalizer_data; \
109 GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (z), scm_i_finalize_smob, \
112 &_prev_finalizer_data); \
117 #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \
118 do { SCM __SCM_smob_answer; \
119 SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \
120 return __SCM_smob_answer; \
124 #define SCM_SMOB_FLAGS(x) (SCM_CELL_WORD_0 (x) >> 16)
125 #define SCM_SMOB_DATA(x) (SCM_CELL_WORD_1 (x))
126 #define SCM_SMOB_DATA_2(x) (SCM_CELL_WORD_2 (x))
127 #define SCM_SMOB_DATA_3(x) (SCM_CELL_WORD_3 (x))
128 #define SCM_SET_SMOB_DATA(x, data) (SCM_SET_CELL_WORD_1 ((x), (data)))
129 #define SCM_SET_SMOB_DATA_2(x, data) (SCM_SET_CELL_WORD_2 ((x), (data)))
130 #define SCM_SET_SMOB_DATA_3(x, data) (SCM_SET_CELL_WORD_3 ((x), (data)))
131 #define SCM_SET_SMOB_FLAGS(x, data) (scm_i_set_smob_flags((x),(data)<<16))
133 #define SCM_SMOB_OBJECT(x) (SCM_CELL_OBJECT_1 (x))
134 #define SCM_SMOB_OBJECT_2(x) (SCM_CELL_OBJECT_2 (x))
135 #define SCM_SMOB_OBJECT_3(x) (SCM_CELL_OBJECT_3 (x))
136 #define SCM_SET_SMOB_OBJECT(x,obj) (SCM_SET_CELL_OBJECT_1 ((x), (obj)))
137 #define SCM_SET_SMOB_OBJECT_2(x,obj) (SCM_SET_CELL_OBJECT_2 ((x), (obj)))
138 #define SCM_SET_SMOB_OBJECT_3(x,obj) (SCM_SET_CELL_OBJECT_3 ((x), (obj)))
139 #define SCM_SMOB_OBJECT_LOC(x) (SCM_CELL_OBJECT_LOC ((x), 1))
140 #define SCM_SMOB_OBJECT_2_LOC(x) (SCM_CELL_OBJECT_LOC ((x), 2))
141 #define SCM_SMOB_OBJECT_3_LOC(x) (SCM_CELL_OBJECT_LOC ((x), 3))
143 #define SCM_TC2SMOBNUM(x) (0x0ff & ((x) >> 8))
144 #define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x)))
145 /* SCM_SMOBNAME can be 0 if name is missing */
146 #define SCM_SMOBNAME(smobnum) (scm_smobs[smobnum].name)
147 #define SCM_SMOB_PREDICATE(tag, obj) SCM_TYP16_PREDICATE (tag, obj)
148 #define SCM_SMOB_DESCRIPTOR(x) (scm_smobs[SCM_SMOBNUM (x)])
149 #define SCM_SMOB_APPLICABLE_P(x) (SCM_SMOB_DESCRIPTOR (x).apply)
150 #define SCM_SMOB_APPLY_0(x) (SCM_SMOB_DESCRIPTOR (x).apply_0 (x))
151 #define SCM_SMOB_APPLY_1(x, a1) (SCM_SMOB_DESCRIPTOR (x).apply_1 (x, (a1)))
152 #define SCM_SMOB_APPLY_2(x, a1, a2) (SCM_SMOB_DESCRIPTOR (x).apply_2 (x, (a1), (a2)))
153 #define SCM_SMOB_APPLY_3(x, a1, a2, rst) (SCM_SMOB_DESCRIPTOR (x).apply_3 (x, (a1), (a2), (rst)))
155 SCM_API
long scm_numsmob
;
156 SCM_API scm_smob_descriptor scm_smobs
[];
158 SCM_API
void scm_i_set_smob_flags (SCM x
, scm_t_bits data
);
159 SCM_API
void scm_i_finalize_smob (GC_PTR obj
, GC_PTR data
);
163 SCM_API SCM
scm_mark0 (SCM ptr
);
164 SCM_API SCM
scm_markcdr (SCM ptr
);
165 SCM_API
size_t scm_free0 (SCM ptr
);
166 SCM_API
size_t scm_smob_free (SCM obj
);
167 SCM_API
int scm_smob_print (SCM exp
, SCM port
, scm_print_state
*pstate
);
169 /* The following set of functions is the standard way to create new
172 * Create a type tag using `scm_make_smob_type', accept default values
173 * for mark, free, print and/or equalp functions, or set your own
174 * values using `scm_set_smob_xxx'.
177 SCM_API scm_t_bits
scm_make_smob_type (char const *name
, size_t size
);
179 SCM_API
void scm_set_smob_mark (scm_t_bits tc
, SCM (*mark
) (SCM
));
180 SCM_API
void scm_set_smob_free (scm_t_bits tc
, size_t (*free
) (SCM
));
181 SCM_API
void scm_set_smob_print (scm_t_bits tc
,
182 int (*print
) (SCM
, SCM
, scm_print_state
*));
183 SCM_API
void scm_set_smob_equalp (scm_t_bits tc
, SCM (*equalp
) (SCM
, SCM
));
184 SCM_API
void scm_set_smob_apply (scm_t_bits tc
,
190 SCM_API
void scm_assert_smob_type (scm_t_bits tag
, SCM val
);
192 /* Function for creating smobs */
194 SCM_API SCM
scm_make_smob (scm_t_bits tc
);
196 SCM_API
void scm_smob_prehistory (void);
198 #endif /* SCM_SMOB_H */