Commit | Line | Data |
---|---|---|
0f2d19dd JB |
1 | /* classes: h_files */ |
2 | ||
729dbac3 DH |
3 | #ifndef SCM_STRUCT_H |
4 | #define SCM_STRUCT_H | |
b29058ff | 5 | |
2b829bbb | 6 | /* Copyright (C) 1995,1997,1999,2000,2001, 2006 Free Software Foundation, Inc. |
b29058ff | 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. | |
b29058ff | 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 |
16 | * Lesser General Public License for more details. | |
b29058ff | 17 | * |
73be1d9e MV |
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 | |
92205699 | 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 21 | */ |
d3a6bc94 | 22 | |
0f2d19dd JB |
23 | \f |
24 | ||
b4309c3c | 25 | #include "libguile/__scm.h" |
bafcafb2 | 26 | #include "libguile/print.h" |
0f2d19dd JB |
27 | |
28 | \f | |
29 | ||
2c36c351 | 30 | /* Number of words with negative index */ |
ad196599 | 31 | #define scm_struct_n_extra_words 4 |
2c53acd5 | 32 | #define scm_struct_entity_n_extra_words 6 |
2c36c351 | 33 | |
0f2d19dd | 34 | /* These are how the initial words of a vtable are allocated. */ |
2c53acd5 MD |
35 | #define scm_struct_i_setter -6 /* Setter */ |
36 | #define scm_struct_i_procedure -5 /* Optional procedure slot */ | |
ad196599 MD |
37 | #define scm_struct_i_free -4 /* Destructor */ |
38 | #define scm_struct_i_ptr -3 /* Start of block (see alloc_struct) */ | |
4bfdf158 | 39 | #define scm_struct_i_n_words -2 /* How many words allocated to this struct? */ |
ad196599 MD |
40 | #define scm_struct_i_size -1 /* Instance size */ |
41 | #define scm_struct_i_flags -1 /* Upper 12 bits used as flags */ | |
7866776c MV |
42 | |
43 | /* These indices must correspond to required_vtable_fields in | |
44 | struct.c. */ | |
4bfdf158 | 45 | #define scm_vtable_index_layout 0 /* A symbol describing the physical arrangement of this type. */ |
7866776c MV |
46 | #define scm_vtable_index_vtable 1 /* A pointer to the handle for this vtable. */ |
47 | #define scm_vtable_index_printer 2 /* A printer for this struct type. */ | |
48 | #define scm_vtable_offset_user 3 /* Where do user fields start? */ | |
0f2d19dd | 49 | |
4c9419ac | 50 | typedef void (*scm_t_struct_free) (scm_t_bits * vtable, scm_t_bits * data); |
ad196599 MD |
51 | |
52 | #define SCM_STRUCTF_MASK (0xFFF << 20) | |
f40f662e | 53 | #define SCM_STRUCTF_ENTITY (1L << 30) /* Indicates presence of proc slots */ |
7ee70a26 MD |
54 | #define SCM_STRUCTF_LIGHT (1L << 31) /* Light representation |
55 | (no hidden words) */ | |
0f2d19dd | 56 | |
b29058ff | 57 | #define SCM_STRUCTP(X) (!SCM_IMP(X) && (SCM_TYP3(X) == scm_tc3_struct)) |
92c2555f | 58 | #define SCM_STRUCT_DATA(X) ((scm_t_bits *) SCM_CELL_WORD_1 (X)) |
904a077d | 59 | #define SCM_STRUCT_VTABLE_DATA(X) ((scm_t_bits *) (SCM_CELL_WORD_0 (X) - scm_tc3_struct)) |
1c3e63f0 DH |
60 | |
61 | #define SCM_STRUCT_LAYOUT(X) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout])) | |
62 | #define SCM_SET_STRUCT_LAYOUT(X, v) (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout] = SCM_UNPACK (v)) | |
63 | ||
64 | #define SCM_STRUCT_VTABLE(X) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_vtable])) | |
00d8d838 DH |
65 | #define SCM_STRUCT_VTABLE_FLAGS(X) \ |
66 | (SCM_STRUCT_VTABLE_DATA (X) [scm_struct_i_flags]) | |
1c3e63f0 | 67 | #define SCM_STRUCT_PRINTER(X) (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_printer])) |
ce212434 | 68 | #define SCM_SET_STRUCT_PRINTER(x, v)\ |
729dbac3 | 69 | (SCM_STRUCT_VTABLE_DATA (x) [scm_vtable_index_printer] = SCM_UNPACK (v)) |
92c2555f | 70 | #define SCM_SET_VTABLE_DESTRUCTOR(X, D) (SCM_STRUCT_DATA (X) [scm_struct_i_free] = (scm_t_bits) (D)) |
2c36c351 MD |
71 | /* Efficiency is important in the following macro, since it's used in GC */ |
72 | #define SCM_LAYOUT_TAILP(X) (((X) & 32) == 0) /* R, W or O */ | |
0f2d19dd | 73 | |
6decd505 MD |
74 | #define SCM_STRUCT_TABLE_NAME(X) SCM_CAR (X) |
75 | #define SCM_SET_STRUCT_TABLE_NAME(X, NAME) SCM_SETCAR (X, NAME) | |
76 | #define SCM_STRUCT_TABLE_CLASS(X) SCM_CDR (X) | |
77 | #define SCM_SET_STRUCT_TABLE_CLASS(X, CLASS) SCM_SETCDR (X, CLASS) | |
33b001fd | 78 | SCM_API SCM scm_struct_table; |
0f2d19dd | 79 | |
85c21339 MD |
80 | #define SCM_STRUCT_GC_CHAIN(X) SCM_CELL_OBJECT_3 (X) |
81 | #define SCM_SET_STRUCT_GC_CHAIN(X, Y) SCM_SET_CELL_OBJECT_3 (X, Y) | |
ffd72400 | 82 | SCM_API SCM scm_i_structs_to_free; |
85c21339 | 83 | |
0f2d19dd | 84 | \f |
0f2d19dd | 85 | |
4c9419ac MV |
86 | SCM_API scm_t_bits * scm_alloc_struct (int n_words, int n_extra, |
87 | const char *what); | |
88 | SCM_API void scm_struct_free_0 (scm_t_bits * vtable, scm_t_bits * data); | |
89 | SCM_API void scm_struct_free_light (scm_t_bits * vtable, scm_t_bits * data); | |
90 | SCM_API void scm_struct_free_standard (scm_t_bits * vtable, scm_t_bits * data); | |
91 | SCM_API void scm_struct_free_entity (scm_t_bits * vtable, scm_t_bits * data); | |
33b001fd MV |
92 | SCM_API SCM scm_make_struct_layout (SCM fields); |
93 | SCM_API SCM scm_struct_p (SCM x); | |
94 | SCM_API SCM scm_struct_vtable_p (SCM x); | |
95 | SCM_API SCM scm_make_struct (SCM vtable, SCM tail_array_size, SCM init); | |
96 | SCM_API SCM scm_make_vtable_vtable (SCM extra_fields, SCM tail_array_size, SCM init); | |
d15ad007 | 97 | SCM_API SCM scm_i_struct_equalp (SCM s1, SCM s2); |
33b001fd MV |
98 | SCM_API SCM scm_struct_ref (SCM handle, SCM pos); |
99 | SCM_API SCM scm_struct_set_x (SCM handle, SCM pos, SCM val); | |
100 | SCM_API SCM scm_struct_vtable (SCM handle); | |
101 | SCM_API SCM scm_struct_vtable_tag (SCM handle); | |
102 | SCM_API unsigned long scm_struct_ihashq (SCM obj, unsigned long n); | |
103 | SCM_API SCM scm_struct_create_handle (SCM obj); | |
104 | SCM_API SCM scm_struct_vtable_name (SCM vtable); | |
105 | SCM_API SCM scm_set_struct_vtable_name_x (SCM vtable, SCM name); | |
106 | SCM_API void scm_print_struct (SCM exp, SCM port, scm_print_state *); | |
107 | SCM_API void scm_struct_prehistory (void); | |
108 | SCM_API void scm_init_struct (void); | |
0f2d19dd | 109 | |
729dbac3 | 110 | #endif /* SCM_STRUCT_H */ |
89e00824 ML |
111 | |
112 | /* | |
113 | Local Variables: | |
114 | c-file-style: "gnu" | |
115 | End: | |
116 | */ |