Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
3 | #ifndef SMOBH | |
4 | #define SMOBH | |
87621a14 | 5 | /* Copyright (C) 1995, 1996, 1998, 1999, 2000 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, |
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 | |
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); | |
9dd5943c MD |
60 | } scm_smob_descriptor; |
61 | ||
0f2d19dd JB |
62 | \f |
63 | ||
9dd5943c | 64 | #define SCM_NEWSMOB(z, tc, data) \ |
23a62151 | 65 | do { \ |
9dd5943c | 66 | SCM_NEWCELL (z); \ |
94113249 DH |
67 | SCM_SET_CELL_WORD_1 ((z), (data)); \ |
68 | SCM_SET_CELL_TYPE ((z), (tc)); \ | |
23a62151 MD |
69 | } while (0) |
70 | ||
71 | #define SCM_RETURN_NEWSMOB(tc, data) \ | |
72 | do { SCM __SCM_smob_answer; \ | |
94113249 | 73 | SCM_NEWSMOB (__SCM_smob_answer, (tc), (data)); \ |
23a62151 MD |
74 | return __SCM_smob_answer; \ |
75 | } while (0) | |
76 | ||
87621a14 MD |
77 | #define SCM_NEWSMOB2(z, tc, data1, data2) \ |
78 | do { \ | |
79 | SCM_NEWCELL2 (z); \ | |
94113249 DH |
80 | SCM_SET_CELL_WORD_1 ((z), (data1)); \ |
81 | SCM_SET_CELL_WORD_2 ((z), (data2)); \ | |
82 | SCM_SET_CELL_TYPE ((z), (tc)); \ | |
87621a14 MD |
83 | } while (0) |
84 | ||
85 | #define SCM_RETURN_NEWSMOB2(tc, data1, data2) \ | |
86 | do { SCM __SCM_smob_answer; \ | |
94113249 | 87 | SCM_NEWSMOB2 (__SCM_smob_answer, (tc), (data1), (data2)); \ |
87621a14 MD |
88 | return __SCM_smob_answer; \ |
89 | } while (0) | |
90 | ||
91 | #define SCM_NEWSMOB3(z, tc, data1, data2, data3) \ | |
92 | do { \ | |
93 | SCM_NEWCELL2 (z); \ | |
94113249 DH |
94 | SCM_SET_CELL_WORD_1 ((z), (data1)); \ |
95 | SCM_SET_CELL_WORD_2 ((z), (data2)); \ | |
96 | SCM_SET_CELL_WORD_3 ((z), (data3)); \ | |
97 | SCM_SET_CELL_TYPE ((z), (tc)); \ | |
87621a14 MD |
98 | } while (0) |
99 | ||
100 | #define SCM_RETURN_NEWSMOB3(tc, data1, data2, data3) \ | |
101 | do { SCM __SCM_smob_answer; \ | |
94113249 | 102 | SCM_NEWSMOB3 (__SCM_smob_answer, (tc), (data1), (data2), (data3)); \ |
87621a14 MD |
103 | return __SCM_smob_answer; \ |
104 | } while (0) | |
105 | ||
9dd5943c | 106 | |
94113249 DH |
107 | #define SCM_SMOB_DATA(x) (SCM_CELL_WORD_1 (x)) |
108 | #define SCM_SET_SMOB_DATA(x, data) (SCM_SET_CELL_WORD_1 ((x), (data))) | |
109 | #define SCM_TC2SMOBNUM(x) (0x0ff & ((x) >> 8)) | |
110 | #define SCM_SMOBNUM(x) (SCM_TC2SMOBNUM (SCM_CELL_TYPE (x))) | |
2c16a78a | 111 | /* SCM_SMOBNAME can be 0 if name is missing */ |
94113249 DH |
112 | #define SCM_SMOBNAME(smobnum) (scm_smobs[smobnum].name) |
113 | #define SCM_SMOB_PREDICATE(tag, obj) (SCM_NIMP (obj) \ | |
114 | && SCM_TYP16 (obj) == (tag)) | |
0f2d19dd | 115 | |
4e6e2119 | 116 | extern int scm_numsmob; |
9dd5943c | 117 | extern scm_smob_descriptor *scm_smobs; |
0f2d19dd JB |
118 | |
119 | \f | |
0f2d19dd | 120 | |
7866a09b GB |
121 | extern SCM scm_mark0 (SCM ptr); |
122 | extern SCM scm_markcdr (SCM ptr); | |
123 | extern scm_sizet scm_free0 (SCM ptr); | |
9dd5943c MD |
124 | extern scm_sizet scm_smob_free (SCM obj); |
125 | extern int scm_smob_print (SCM exp, SCM port, scm_print_state *pstate); | |
23a62151 MD |
126 | |
127 | /* These next two functions are the supported way to create new SMOB types. | |
128 | ||
129 | scm_make_smob_type is useful if there are no special smob functions | |
130 | and the defaults work for mark,free,print,equal_p, or you want to use | |
131 | scm_set_smob_{mark,free,print,equalp}, below. | |
132 | ||
133 | scm_make_smob_type_mfpe is ideal if you need to set one or more of | |
134 | the special smob functions-- use NULL for when the default function | |
135 | is fine | |
136 | */ | |
137 | ||
9dd5943c | 138 | extern long scm_make_smob_type (char *name, scm_sizet size); |
23a62151 MD |
139 | |
140 | extern long scm_make_smob_type_mfpe (char *name, scm_sizet size, | |
141 | SCM (*mark) (SCM), | |
142 | scm_sizet (*free) (SCM), | |
143 | int (*print) (SCM, SCM, scm_print_state*), | |
144 | SCM (*equalp) (SCM, SCM)); | |
145 | ||
9dd5943c MD |
146 | extern void scm_set_smob_mark (long tc, SCM (*mark) (SCM)); |
147 | extern void scm_set_smob_free (long tc, scm_sizet (*free) (SCM)); | |
148 | extern void scm_set_smob_print (long tc, int (*print) (SCM, | |
149 | SCM, | |
150 | scm_print_state*)); | |
151 | extern void scm_set_smob_equalp (long tc, SCM (*equalp) (SCM, SCM)); | |
23a62151 MD |
152 | /* convenience function for registering multiple handler fns */ |
153 | extern void scm_set_smob_mfpe (long tc, | |
154 | SCM (*mark) (SCM), | |
155 | scm_sizet (*free) (SCM), | |
156 | int (*print) (SCM, SCM, scm_print_state*), | |
157 | SCM (*equalp) (SCM, SCM)); | |
158 | ||
159 | ||
9dd5943c MD |
160 | extern SCM scm_make_smob (long tc); |
161 | extern void scm_smob_prehistory (void); | |
0f2d19dd | 162 | |
f5f2dcff DH |
163 | \f |
164 | ||
0f2d19dd | 165 | #endif /* SMOBH */ |
89e00824 ML |
166 | |
167 | /* | |
168 | Local Variables: | |
169 | c-file-style: "gnu" | |
170 | End: | |
171 | */ |