mouse.h

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