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