mouse.h

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