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