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