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