Implement get_all_attributes in XS
[gitmo/Mouse.git] / mouse.h
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
11 /* for portability */
12 #ifndef newSVpvs_share
13 #define newSVpvs_share(s) Perl_newSVpvn_share(aTHX_ s, sizeof(s)-1, 0U)
14 #endif
15
16 #ifndef get_cvs
17 #define get_cvs(name, flags) get_cv(name, flags)
18 #endif
19
20 #ifndef GvNAME_get
21 #define GvNAME_get GvNAME
22 #endif
23 #ifndef GvNAMELEN_get
24 #define GvNAMELEN_get GvNAMELEN
25 #endif
26
27 #ifndef mro_get_linear_isa
28 #define no_mro_get_linear_isa
29 #define mro_get_linear_isa(stash) mouse_mro_get_linear_isa(aTHX_ stash)
30 AV* mouse_mro_get_linear_isa(pTHX_ HV* const stash);
31 #endif /* !mro_get_linear_isa */
32
33 #ifndef mro_get_pkg_gen
34 #ifdef no_mro_get_linear_isa
35 #define mro_get_pkg_gen(stash) ((void)stash, PL_sub_generation)
36 #else
37 #define mro_get_pkg_gen(stash) (HvAUX(stash)->xhv_mro_meta ? HvAUX(stash)->xhv_mro_meta->pkg_gen : (U32)0)
38 #endif /* !no_mro_get_linear_isa */
39 #endif /* mro_get_package_gen */
40
41 #define MOUSE_CALL_BOOT(name) STMT_START {      \
42         EXTERN_C XS(CAT2(boot_, name));         \
43         PUSHMARK(SP);                           \
44         CALL_FPTR(CAT2(boot_, name))(aTHX_ cv); \
45     } STMT_END
46
47 extern SV* mouse_package;
48 extern SV* mouse_namespace;
49 extern SV* mouse_methods;
50 extern SV* mouse_name;
51
52 void
53 mouse_throw_error(SV* const metaobject, SV* const data /* not used */, const char* const fmt, ...)
54 #ifdef __attribute__format__
55     __attribute__format__(__printf__, 3, 4);
56 #else
57     ;
58 #endif
59
60 #define is_class_loaded(sv) mouse_is_class_loaded(aTHX_ sv)
61 bool mouse_is_class_loaded(pTHX_ SV*);
62
63 #define is_an_instance_of(klass, sv) mouse_is_an_instance_of(aTHX_ gv_stashpvs(klass, GV_ADD), (sv))
64
65 #define IsObject(sv)   (SvROK(sv) && SvOBJECT(SvRV(sv)))
66 #define IsArrayRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVAV)
67 #define IsHashRef(sv)  (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVHV)
68 #define IsCodeRef(sv)  (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVCV)
69
70 #define mcall0(invocant, m)        mouse_call0(aTHX_ (invocant), (m))
71 #define mcall1(invocant, m, arg1)  mouse_call1(aTHX_ (invocant), (m), (arg1))
72 #define mcall0s(invocant, m)       mcall0((invocant), sv_2mortal(newSVpvs_share(m)))
73 #define mcall1s(invocant, m, arg1) mcall1((invocant), sv_2mortal(newSVpvs_share(m)), (arg1))
74
75 SV* mouse_call0(pTHX_ SV *const self, SV *const method);
76 SV* mouse_call1(pTHX_ SV *const self, SV *const method, SV* const arg1);
77
78 #define MOUSEf_DIE_ON_FAIL 0x01
79 MAGIC* mouse_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags);
80
81 /* MOUSE_av_at(av, ix) is the safer version of AvARRAY(av)[ix] if perl is compiled with -DDEBUGGING */
82 #ifdef DEBUGGING
83 #define MOUSE_av_at(av, ix)  *mouse_av_at_safe(aTHX_ (av) , (ix))
84 SV** mouse_av_at_safe(pTHX_ AV* const mi, I32 const ix);
85 #else
86 #define MOUSE_av_at(av, ix)  AvARRAY(av)[ix]
87 #endif
88
89 #define dMOUSE_self  SV* const self = mouse_accessor_get_self(aTHX_ ax, items, cv)
90 SV* mouse_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv);
91
92 #define MOUSE_mg_obj(mg)     ((mg)->mg_obj)
93 #define MOUSE_mg_ptr(mg)     ((mg)->mg_ptr)
94 #define MOUSE_mg_flags(mg)   ((mg)->mg_private)
95 #define MOUSE_mg_virtual(mg) ((mg)->mg_virtual)
96
97 #define MOUSE_mg_slot(mg)   MOUSE_mg_obj(mg)
98 #define MOUSE_mg_xa(mg)    ((AV*)MOUSE_mg_ptr(mg))
99
100
101 /* mouse_instance.xs stuff */
102 SV*  mouse_instance_create     (pTHX_ HV* const stash);
103 SV*  mouse_instance_clone      (pTHX_ SV* const instance);
104 bool mouse_instance_has_slot   (pTHX_ SV* const instance, SV* const slot);
105 SV*  mouse_instance_get_slot   (pTHX_ SV* const instance, SV* const slot);
106 SV*  mouse_instance_set_slot   (pTHX_ SV* const instance, SV* const slot, SV* const value);
107 SV*  mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot);
108 void mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot);
109
110 #define has_slot(self, key)         mouse_instance_has_slot(aTHX_ self, key)
111 #define get_slot(self, key)         mouse_instance_get_slot(aTHX_ self, key)
112 #define set_slot(self, key, value)  mouse_instance_set_slot(aTHX_ self, key, value)
113 #define delete_slot(self, key)      mouse_instance_delete_slot(aTHX_ self, key)
114 #define weaken_slot(self, key)      mouse_instance_weaken_slot(aTHX_ self, key)
115
116 #define has_slots(self, key)        has_slot(self, sv_2mortal(newSVpvs_share(key)))
117 #define get_slots(self, key)        get_slot(self, sv_2mortal(newSVpvs_share(key)))
118 #define set_slots(self, key, value) set_slot(self, sv_2mortal(newSVpvs_share(key)), value)
119
120 /* mouse_simle_accessor.xs */
121 #define INSTALL_SIMPLE_READER(klass, name)                  INSTALL_SIMPLE_READER_WITH_KEY(klass, name, name)
122 #define INSTALL_SIMPLE_READER_WITH_KEY(klass, name, key)    (void)mouse_install_simple_accessor(aTHX_ "Mouse::Meta::" #klass "::" #name, #key, sizeof(#key)-1, XS_Mouse_simple_reader)
123
124 #define INSTALL_SIMPLE_WRITER(klass, name)                  INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, name)
125 #define INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, key)    (void)mouse_install_simple_accessor(aTHX_ "Mouse::Meta::" #klass "::" #name, #key, sizeof(#key)-1, XS_Mouse_simple_writer)
126
127 #define INSTALL_SIMPLE_PREDICATE(klass, name)                INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, name)
128 #define INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, key) (void)mouse_install_simple_accessor(aTHX_ "Mouse::Meta::" #klass "::" #name, #key, sizeof(#key)-1, XS_Mouse_simple_predicate)
129
130 CV* mouse_install_simple_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl);
131
132 XS(XS_Mouse_simple_reader);
133 XS(XS_Mouse_simple_writer);
134 XS(XS_Mouse_simple_clearer);
135 XS(XS_Mouse_simple_predicate);
136
137 CV* mouse_instantiate_xs_accessor(pTHX_ SV* const attr, XSUBADDR_t const accessor_impl);
138
139 XS(XS_Mouse_accessor);
140 XS(XS_Mouse_reader);
141 XS(XS_Mouse_writer);
142
143 /* type constraints */
144
145 int mouse_tc_check(pTHX_ SV* const tc, SV* const sv);
146
147 int mouse_tc_Any       (pTHX_ SV*, SV* const sv);
148 int mouse_tc_Bool      (pTHX_ SV*, SV* const sv);
149 int mouse_tc_Undef     (pTHX_ SV*, SV* const sv);
150 int mouse_tc_Defined   (pTHX_ SV*, SV* const sv);
151 int mouse_tc_Value     (pTHX_ SV*, SV* const sv);
152 int mouse_tc_Num       (pTHX_ SV*, SV* const sv);
153 int mouse_tc_Int       (pTHX_ SV*, SV* const sv);
154 int mouse_tc_Str       (pTHX_ SV*, SV* const sv);
155 int mouse_tc_ClassName (pTHX_ SV*, SV* const sv);
156 int mouse_tc_RoleName  (pTHX_ SV*, SV* const sv);
157 int mouse_tc_Ref       (pTHX_ SV*, SV* const sv);
158 int mouse_tc_ScalarRef (pTHX_ SV*, SV* const sv);
159 int mouse_tc_ArrayRef  (pTHX_ SV*, SV* const sv);
160 int mouse_tc_HashRef   (pTHX_ SV*, SV* const sv);
161 int mouse_tc_CodeRef   (pTHX_ SV*, SV* const sv);
162 int mouse_tc_RegexpRef (pTHX_ SV*, SV* const sv);
163 int mouse_tc_GlobRef   (pTHX_ SV*, SV* const sv);
164 int mouse_tc_FileHandle(pTHX_ SV*, SV* const sv);
165 int mouse_tc_Object    (pTHX_ SV*, SV* const sv);
166
167 CV* mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name);
168
169 int mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance);
170
171 XS(XS_Mouse_constraint_check);
172
173 #endif /* !MOUSE_H */
174