Commit | Line | Data |
df6dd016 |
1 | #ifndef MOUSE_H |
2 | #define MOUSE_H |
3 | |
8e4a10a8 |
4 | #include "xshelper.h" |
d6ceb359 |
5 | |
cccb83de |
6 | #ifndef mro_get_linear_isa |
7 | #define no_mro_get_linear_isa |
8 | #define mro_get_linear_isa(stash) mouse_mro_get_linear_isa(aTHX_ stash) |
3ea28db6 |
9 | AV* mouse_mro_get_linear_isa(pTHX_ HV* const stash); |
da4b1214 |
10 | #define mro_method_changed_in(stash) ((void)++PL_sub_generation) |
cccb83de |
11 | #endif /* !mro_get_linear_isa */ |
12 | |
13 | #ifndef mro_get_pkg_gen |
14 | #ifdef no_mro_get_linear_isa |
15 | #define mro_get_pkg_gen(stash) ((void)stash, PL_sub_generation) |
16 | #else |
17 | #define mro_get_pkg_gen(stash) (HvAUX(stash)->xhv_mro_meta ? HvAUX(stash)->xhv_mro_meta->pkg_gen : (U32)0) |
18 | #endif /* !no_mro_get_linear_isa */ |
19 | #endif /* mro_get_package_gen */ |
20 | |
952a7aee |
21 | #ifndef GvCV_set |
22 | #define GvCV_set(gv, cv) (GvCV(gv) = (cv)) |
23 | #endif |
24 | |
cccb83de |
25 | extern SV* mouse_package; |
a5df48e5 |
26 | extern SV* mouse_methods; |
27 | extern SV* mouse_name; |
d39ac61c |
28 | extern SV* mouse_coerce; |
43165725 |
29 | |
93540011 |
30 | void |
31 | mouse_throw_error(SV* const metaobject, SV* const data /* not used */, const char* const fmt, ...) |
93540011 |
32 | __attribute__format__(__printf__, 3, 4); |
93540011 |
33 | |
b3cd4c14 |
34 | /* workaround RT #69939 */ |
35 | I32 |
36 | mouse_call_sv_safe(pTHX_ SV*, I32); |
37 | |
38 | #define call_sv_safe(sv, flags) mouse_call_sv_safe(aTHX_ sv, flags) |
39 | #define call_method_safe(m, flags) mouse_call_sv_safe(aTHX_ newSVpvn_flags(m, strlen(m), SVs_TEMP), flags | G_METHOD) |
40 | #define call_method_safes(m, flags) mouse_call_sv_safe(aTHX_ newSVpvs_flags(m, SVs_TEMP), flags | G_METHOD) |
41 | |
42 | |
df6dd016 |
43 | #define is_class_loaded(sv) mouse_is_class_loaded(aTHX_ sv) |
44 | bool mouse_is_class_loaded(pTHX_ SV*); |
45 | |
016e4681 |
46 | #define is_an_instance_of(klass, sv) mouse_is_an_instance_of(aTHX_ gv_stashpvs(klass, GV_ADD), (sv)) |
df6dd016 |
47 | |
80aa5731 |
48 | #define IsObject(sv) (SvROK(sv) && SvOBJECT(SvRV(sv))) |
49 | #define IsArrayRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVAV) |
50 | #define IsHashRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVHV) |
51 | #define IsCodeRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVCV) |
df6dd016 |
52 | |
0aad0266 |
53 | #define mcall0(invocant, m) mouse_call0(aTHX_ (invocant), (m)) |
54 | #define mcall1(invocant, m, arg1) mouse_call1(aTHX_ (invocant), (m), (arg1)) |
55 | #define predicate_call(invocant, m) mouse_predicate_call(aTHX_ (invocant), (m)) |
56 | |
57 | #define mcall0s(invocant, m) mcall0((invocant), sv_2mortal(newSVpvs_share(m))) |
58 | #define mcall1s(invocant, m, arg1) mcall1((invocant), sv_2mortal(newSVpvs_share(m)), (arg1)) |
59 | #define predicate_calls(invocant, m) predicate_call((invocant), sv_2mortal(newSVpvs_share(m))) |
60 | |
df6dd016 |
61 | |
aa2d2e2c |
62 | #define get_metaclass(name) mouse_get_metaclass(aTHX_ name) |
a39e9541 |
63 | |
df6dd016 |
64 | SV* mouse_call0(pTHX_ SV *const self, SV *const method); |
65 | SV* mouse_call1(pTHX_ SV *const self, SV *const method, SV* const arg1); |
0aad0266 |
66 | int mouse_predicate_call(pTHX_ SV* const self, SV* const method); |
df6dd016 |
67 | |
aa2d2e2c |
68 | SV* mouse_get_metaclass(pTHX_ SV* metaclass_name); |
a39e9541 |
69 | |
70 | GV* mouse_stash_fetch(pTHX_ HV* const stash, const char* const name, I32 const namelen, I32 const create); |
71 | #define stash_fetch(s, n, l, c) mouse_stash_fetch(aTHX_ (s), (n), (l), (c)) |
72 | #define stash_fetchs(s, n, c) mouse_stash_fetch(aTHX_ (s), STR_WITH_LEN(n), (c)) |
73 | |
d67f600d |
74 | void mouse_install_sub(pTHX_ GV* const gv, SV* const code_ref); |
a39e9541 |
75 | |
d06d9266 |
76 | void mouse_must_defined(pTHX_ SV* const value, const char* const name); |
77 | void mouse_must_ref(pTHX_ SV* const value, const char* const name, svtype const t); |
78 | |
79 | #define must_defined(sv, name) mouse_must_defined(aTHX_ sv, name) |
80 | #define must_ref(sv, name, svt) mouse_must_ref(aTHX_ sv, name, svt) |
81 | |
43165725 |
82 | #define MOUSEf_DIE_ON_FAIL 0x01 |
83 | MAGIC* mouse_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags); |
84 | |
93540011 |
85 | /* MOUSE_av_at(av, ix) is the safer version of AvARRAY(av)[ix] if perl is compiled with -DDEBUGGING */ |
86 | #ifdef DEBUGGING |
87 | #define MOUSE_av_at(av, ix) *mouse_av_at_safe(aTHX_ (av) , (ix)) |
88 | SV** mouse_av_at_safe(pTHX_ AV* const mi, I32 const ix); |
89 | #else |
90 | #define MOUSE_av_at(av, ix) AvARRAY(av)[ix] |
91 | #endif |
92 | |
93540011 |
93 | #define MOUSE_mg_obj(mg) ((mg)->mg_obj) |
94 | #define MOUSE_mg_ptr(mg) ((mg)->mg_ptr) |
ace98309 |
95 | #define MOUSE_mg_len(mg) ((mg)->mg_len) |
93540011 |
96 | #define MOUSE_mg_flags(mg) ((mg)->mg_private) |
97 | #define MOUSE_mg_virtual(mg) ((mg)->mg_virtual) |
98 | |
99 | #define MOUSE_mg_slot(mg) MOUSE_mg_obj(mg) |
100 | #define MOUSE_mg_xa(mg) ((AV*)MOUSE_mg_ptr(mg)) |
101 | |
43165725 |
102 | |
103 | /* mouse_instance.xs stuff */ |
104 | SV* mouse_instance_create (pTHX_ HV* const stash); |
105 | SV* mouse_instance_clone (pTHX_ SV* const instance); |
106 | bool mouse_instance_has_slot (pTHX_ SV* const instance, SV* const slot); |
107 | SV* mouse_instance_get_slot (pTHX_ SV* const instance, SV* const slot); |
108 | SV* mouse_instance_set_slot (pTHX_ SV* const instance, SV* const slot, SV* const value); |
109 | SV* mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot); |
110 | void mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot); |
111 | |
f790c46b |
112 | #define has_slot(self, key) mouse_instance_has_slot(aTHX_ self, key) |
113 | #define get_slot(self, key) mouse_instance_get_slot(aTHX_ self, key) |
114 | #define set_slot(self, key, value) mouse_instance_set_slot(aTHX_ self, key, value) |
6fe2272b |
115 | #define delete_slot(self, key) mouse_instance_delete_slot(aTHX_ self, key) |
116 | #define weaken_slot(self, key) mouse_instance_weaken_slot(aTHX_ self, key) |
f790c46b |
117 | |
6fe2272b |
118 | #define has_slots(self, key) has_slot(self, sv_2mortal(newSVpvs_share(key))) |
119 | #define get_slots(self, key) get_slot(self, sv_2mortal(newSVpvs_share(key))) |
120 | #define set_slots(self, key, value) set_slot(self, sv_2mortal(newSVpvs_share(key)), value) |
43165725 |
121 | |
fad99075 |
122 | /* mouse_simle_accessor.xs for meta object protocols */ |
e058b279 |
123 | #define INSTALL_SIMPLE_READER(klass, name) \ |
124 | INSTALL_SIMPLE_READER_WITH_KEY(klass, name, name) |
125 | #define INSTALL_SIMPLE_READER_WITH_KEY(klass, name, key) \ |
fad99075 |
126 | (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \ |
127 | #name, #key, sizeof(#key)-1, XS_Mouse_simple_reader, NULL, 0) |
e058b279 |
128 | |
787f84c2 |
129 | #define INSTALL_CLASS_HOLDER_SV(klass, name, dsv) \ |
fad99075 |
130 | (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \ |
131 | #name, #name, sizeof(#name)-1, XS_Mouse_simple_reader, (dsv), HEf_SVKEY) |
787f84c2 |
132 | #define INSTALL_CLASS_HOLDER(klass, name, ds) \ |
133 | INSTALL_CLASS_HOLDER_SV(klass, name, newSVpvs(ds)) |
2468f1d7 |
134 | |
e058b279 |
135 | #define INSTALL_SIMPLE_WRITER(klass, name) \ |
136 | NSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, name) |
137 | #define INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, key) \ |
fad99075 |
138 | (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \ |
139 | #name, #key, sizeof(#key)-1, XS_Mouse_simple_writer, NULL, 0) |
e058b279 |
140 | |
141 | #define INSTALL_SIMPLE_PREDICATE(klass, name) \ |
142 | INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, name) |
143 | #define INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, key) \ |
fad99075 |
144 | (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \ |
145 | #name, #key, sizeof(#key)-1, XS_Mouse_simple_predicate, NULL, 0) |
146 | |
147 | /* generate inhertiable class accessors for Mouse::Meta::Class */ |
148 | #define INSTALL_INHERITABLE_CLASS_ACCESSOR(name) \ |
149 | INSTALL_INHERITABLE_CLASS_ACCESSOR_WITH_KEY(name, name) |
150 | #define INSTALL_INHERITABLE_CLASS_ACCESSOR_WITH_KEY(name, key) \ |
151 | (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::Class::" #name,\ |
152 | #key, sizeof(#key)-1, XS_Mouse_inheritable_class_accessor, NULL, 0) |
e058b279 |
153 | |
a17f6313 |
154 | CV* mouse_simple_accessor_generate(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl, void* const dptr, I32 const dlen); |
43165725 |
155 | |
30e11004 |
156 | XS(XS_Mouse_simple_reader); |
157 | XS(XS_Mouse_simple_writer); |
158 | XS(XS_Mouse_simple_clearer); |
159 | XS(XS_Mouse_simple_predicate); |
df6dd016 |
160 | |
a17f6313 |
161 | CV* mouse_accessor_generate(pTHX_ SV* const attr, XSUBADDR_t const accessor_impl); |
93540011 |
162 | |
30e11004 |
163 | XS(XS_Mouse_accessor); |
164 | XS(XS_Mouse_reader); |
165 | XS(XS_Mouse_writer); |
93540011 |
166 | |
fad99075 |
167 | XS(XS_Mouse_inheritable_class_accessor); |
168 | |
7d96ae4d |
169 | /* type constraints */ |
170 | |
1d5ecd5f |
171 | int mouse_tc_check(pTHX_ SV* const tc, SV* const sv); |
19462c57 |
172 | |
173 | int mouse_tc_Any (pTHX_ SV*, SV* const sv); |
174 | int mouse_tc_Bool (pTHX_ SV*, SV* const sv); |
175 | int mouse_tc_Undef (pTHX_ SV*, SV* const sv); |
176 | int mouse_tc_Defined (pTHX_ SV*, SV* const sv); |
177 | int mouse_tc_Value (pTHX_ SV*, SV* const sv); |
178 | int mouse_tc_Num (pTHX_ SV*, SV* const sv); |
179 | int mouse_tc_Int (pTHX_ SV*, SV* const sv); |
180 | int mouse_tc_Str (pTHX_ SV*, SV* const sv); |
181 | int mouse_tc_ClassName (pTHX_ SV*, SV* const sv); |
182 | int mouse_tc_RoleName (pTHX_ SV*, SV* const sv); |
183 | int mouse_tc_Ref (pTHX_ SV*, SV* const sv); |
184 | int mouse_tc_ScalarRef (pTHX_ SV*, SV* const sv); |
185 | int mouse_tc_ArrayRef (pTHX_ SV*, SV* const sv); |
186 | int mouse_tc_HashRef (pTHX_ SV*, SV* const sv); |
187 | int mouse_tc_CodeRef (pTHX_ SV*, SV* const sv); |
188 | int mouse_tc_RegexpRef (pTHX_ SV*, SV* const sv); |
189 | int mouse_tc_GlobRef (pTHX_ SV*, SV* const sv); |
190 | int mouse_tc_FileHandle(pTHX_ SV*, SV* const sv); |
191 | int mouse_tc_Object (pTHX_ SV*, SV* const sv); |
7d96ae4d |
192 | |
672bde7c |
193 | CV* mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name); |
ebe91068 |
194 | CV* mouse_generate_can_predicate_for(pTHX_ SV* const klass, const char* const predicate_name); |
f48920c1 |
195 | |
016e4681 |
196 | int mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance); |
197 | |
0aad0266 |
198 | /* Mouse XS Attribute object */ |
199 | |
200 | AV* mouse_get_xa(pTHX_ SV* const attr); |
4e7e3250 |
201 | SV* mouse_xa_apply_type_constraint(pTHX_ AV* const xa, SV* value, U16 const flags); |
202 | SV* mouse_xa_set_default(pTHX_ AV* const xa, SV* const object); |
0aad0266 |
203 | |
204 | enum mouse_xa_ix_t{ |
205 | MOUSE_XA_SLOT, /* for constructors, sync to mg_obj */ |
206 | MOUSE_XA_FLAGS, /* for constructors, sync to mg_private */ |
207 | MOUSE_XA_ATTRIBUTE, |
4e7e3250 |
208 | MOUSE_XA_INIT_ARG, |
0aad0266 |
209 | MOUSE_XA_TC, |
210 | MOUSE_XA_TC_CODE, |
211 | |
212 | MOUSE_XA_last |
213 | }; |
214 | |
215 | #define MOUSE_xa_slot(m) MOUSE_av_at(m, MOUSE_XA_SLOT) |
4e7e3250 |
216 | #define MOUSE_xa_flags(m) SvUVX( MOUSE_av_at(m, MOUSE_XA_FLAGS) ) |
0aad0266 |
217 | #define MOUSE_xa_attribute(m) MOUSE_av_at(m, MOUSE_XA_ATTRIBUTE) |
4e7e3250 |
218 | #define MOUSE_xa_init_arg(m) MOUSE_av_at(m, MOUSE_XA_INIT_ARG) |
0aad0266 |
219 | #define MOUSE_xa_tc(m) MOUSE_av_at(m, MOUSE_XA_TC) |
220 | #define MOUSE_xa_tc_code(m) MOUSE_av_at(m, MOUSE_XA_TC_CODE) |
221 | |
0aad0266 |
222 | enum mouse_xa_flags_t{ |
223 | MOUSEf_ATTR_HAS_TC = 0x0001, |
224 | MOUSEf_ATTR_HAS_DEFAULT = 0x0002, |
225 | MOUSEf_ATTR_HAS_BUILDER = 0x0004, |
4e7e3250 |
226 | MOUSEf_ATTR_HAS_INITIALIZER = 0x0008, /* not used */ |
0aad0266 |
227 | MOUSEf_ATTR_HAS_TRIGGER = 0x0010, |
228 | |
229 | MOUSEf_ATTR_IS_LAZY = 0x0020, |
230 | MOUSEf_ATTR_IS_WEAK_REF = 0x0040, |
231 | MOUSEf_ATTR_IS_REQUIRED = 0x0080, |
232 | |
233 | MOUSEf_ATTR_SHOULD_COERCE = 0x0100, |
234 | |
235 | MOUSEf_ATTR_SHOULD_AUTO_DEREF |
236 | = 0x0200, |
237 | MOUSEf_TC_IS_ARRAYREF = 0x0400, |
238 | MOUSEf_TC_IS_HASHREF = 0x0800, |
239 | |
240 | MOUSEf_OTHER1 = 0x1000, |
241 | MOUSEf_OTHER2 = 0x2000, |
242 | MOUSEf_OTHER3 = 0x4000, |
243 | MOUSEf_OTHER4 = 0x8000, |
244 | |
245 | MOUSEf_MOUSE_MASK = 0xFFFF /* not used */ |
246 | }; |
247 | |
05e658dc |
248 | /* Mouse::Meta::Class stuff */ |
249 | HV* mouse_get_namespace(pTHX_ SV* const meta); /* $meta->namespace */ |
df6dd016 |
250 | #endif /* !MOUSE_H */ |
251 | |