mop.h

   1 #ifndef __MOP_H__
   2 #define __MOP_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 #define MOP_CALL_BOOT(name)  mop_call_xs(aTHX_ name, cv, mark);
  12
  13 void mop_call_xs (pTHX_ XSPROTO(subaddr), CV *cv, SV **mark);
  14
  15 #define MAKE_KEYSV(name) newSVpvn_share(#name, sizeof(#name)-1, 0U)
  16
  17 XS(mop_xs_simple_accessor);
  18 XS(mop_xs_simple_reader);
  19 XS(mop_xs_simple_writer);
  20 XS(mop_xs_simple_predicate);
  21 XS(mop_xs_simple_predicate_for_metaclass);
  22 XS(mop_xs_simple_clearer);
  23
  24 extern SV *mop_method_metaclass;
  25 extern SV *mop_associated_metaclass;
  26 extern SV *mop_associated_attribute;
  27 extern SV *mop_wrap;
  28 extern SV *mop_methods;
  29 extern SV *mop_name;
  30 extern SV *mop_body;
  31 extern SV *mop_package;
  32 extern SV *mop_package_name;
  33 extern SV *mop_package_cache_flag;
  34 extern SV *mop_initialize;
  35 extern SV *mop_can;
  36 extern SV *mop_Class;
  37 extern SV *mop_VERSION;
  38 extern SV *mop_ISA;
  39
  40 /* MOP utilities */
  41
  42 UV mop_check_package_cache_flag(pTHX_ HV *stash);
  43 int mop_get_code_info (SV *coderef, char **pkg, char **name);
  44 SV *mop_call0(pTHX_ SV *const self, SV *const method);
  45 SV *mop_call1(pTHX_ SV *const self, SV *const method, SV *const arg1);
  46
  47 #define mop_call0_pvs(o, m)    mop_call0(aTHX_ o, newSVpvs_flags(m, SVs_TEMP))
  48 #define mop_call1_pvs(o, m, a) mop_call1(aTHX_ o, newSVpvs_flags(m, SVs_TEMP), a)
  49
  50 bool mop_is_class_loaded(pTHX_ SV*);
  51 #define is_class_loaded(klass) mop_is_class_loaded(aTHX_ klass)
  52
  53 bool mop_is_instance_of(pTHX_ SV*, SV*);
  54 #define is_instance_of(sv, klass)     mop_is_instance_of(aTHX_ sv, klass)
  55 #define is_instance_of_pvs(sv, klass) mop_is_instance_of(aTHX_ sv, newSVpvs_flags(klass, SVs_TEMP))
  56
  57 typedef enum {
  58     TYPE_FILTER_NONE,
  59     TYPE_FILTER_CODE,
  60     TYPE_FILTER_ARRAY,
  61     TYPE_FILTER_IO,
  62     TYPE_FILTER_HASH,
  63     TYPE_FILTER_SCALAR,
  64 } type_filter_t;
  65
  66 typedef bool (*get_package_symbols_cb_t) (const char *, STRLEN, SV *, void *);
  67
  68 void mop_get_package_symbols(HV *stash, type_filter_t filter, get_package_symbols_cb_t cb, void *ud);
  69 HV  *mop_get_all_package_symbols (HV *stash, type_filter_t filter);
  70
  71
  72 #define MOPf_DIE_ON_FAIL 0x01
  73 MAGIC* mop_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags);
  74
  75 #ifdef DEBUGGING
  76 #define MOP_av_at(av, ix)  *mop_av_at_safe(aTHX_ (av) , (ix))
  77 SV** mop_av_at_safe(pTHX_ AV* const mi, I32 const ix);
  78 #else
  79 #define MOP_av_at(av, ix)  AvARRAY(av)[ix]
  80 #endif
  81
  82 #define IsObject(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)))
  83
  84 #define newSVsv_share(sv) mop_newSVsv_share(aTHX_ sv)
  85 SV* mop_newSVsv_share(pTHX_ SV*);
  86
  87 SV* mop_class_of(pTHX_ SV* const sv);
  88
  89 /* Class::MOP::Class */
  90
  91 AV* mop_class_get_all_attributes(pTHX_ SV* const metaclass);
  92
  93 /* Class::MOP Magic stuff */
  94
  95 /* All the MOP_mg_* macros require MAGIC* mg for the first argument */
  96
  97 typedef struct {
  98     SV*  (*create_instance)(pTHX_ HV* const stash);
  99     bool (*has_slot)       (pTHX_ SV* const mi, SV* const instance);
 100     SV*  (*get_slot)       (pTHX_ SV* const mi, SV* const instance);
 101     SV*  (*set_slot)       (pTHX_ SV* const mi, SV* const instance, SV* const value);
 102     SV*  (*delete_slot)    (pTHX_ SV* const mi, SV* const instance);
 103     void (*weaken_slot)    (pTHX_ SV* const mi, SV* const instance);
 104 } mop_instance_vtbl;
 105
 106 /* Class::MOP::Instance stuff */
 107
 108 SV*  mop_instance_create     (pTHX_ HV* const stash);
 109 SV*  mop_instance_slot       (pTHX_ SV* const meta_instance, SV* const attr);
 110 bool mop_instance_has_slot   (pTHX_ SV* const instance, SV* const slot);
 111 SV*  mop_instance_get_slot   (pTHX_ SV* const instance, SV* const slot);
 112 SV*  mop_instance_set_slot   (pTHX_ SV* const instance, SV* const slot, SV* const value);
 113 SV*  mop_instance_delete_slot(pTHX_ SV* const instance, SV* const slot);
 114 void mop_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot);
 115
 116 const mop_instance_vtbl* mop_get_default_instance_vtbl(pTHX);
 117
 118 #define MOP_mg_obj(mg)   ((mg)->mg_obj)
 119 #define MOP_mg_ptr(mg)   ((mg)->mg_ptr)
 120 #define MOP_mg_vtbl(mg)  ((const mop_instance_vtbl*)MOP_mg_ptr(mg))
 121 #define MOP_mg_flags(mg) ((mg)->mg_private)
 122 #define MOP_mg_virtual(mg) ((mg)->mg_virtual)
 123
 124 #define MOP_mg_obj_refcounted_on(mg)    (void)((mg)->mg_flags |= MGf_REFCOUNTED);
 125
 126 #define MOP_mg_create_instance(mg, stash) MOP_mg_vtbl(mg)->create_instance (aTHX_ (stash))
 127 #define MOP_mg_has_slot(mg, o, slot)      MOP_mg_vtbl(mg)->has_slot        (aTHX_ (o), (slot))
 128 #define MOP_mg_get_slot(mg, o, slot)      MOP_mg_vtbl(mg)->get_slot        (aTHX_ (o), (slot))
 129 #define MOP_mg_set_slot(mg, o, slot, v)   MOP_mg_vtbl(mg)->set_slot        (aTHX_ (o), (slot), (v))
 130 #define MOP_mg_delete_slot(mg, o, slot)   MOP_mg_vtbl(mg)->delete_slot     (aTHX_ (o), (slot))
 131 #define MOP_mg_weaken_slot(mg, o, slot)   MOP_mg_vtbl(mg)->weaken_slot     (aTHX_ (o), (slot))
 132
 133 /* Class::MOP::Attribute stuff */
 134
 135
 136 #define MOP_attr_slot(meta)          MOP_av_at(meta, MOP_ATTR_SLOT)
 137 #define MOP_attr_init_arg(meta)      MOP_av_at(meta, MOP_ATTR_INIT_ARG)
 138 #define MOP_attr_default(meta)       MOP_av_at(meta, MOP_ATTR_DEFAULT)
 139 #define MOP_attr_builder(meta)       MOP_av_at(meta, MOP_ATTR_BUILDER)
 140
 141 enum mop_attr_ix_t{
 142     MOP_ATTR_SLOT,
 143
 144     MOP_ATTR_INIT_ARG,
 145     MOP_ATTR_DEFAULT,
 146     MOP_ATTR_BUILDER,
 147
 148     MOP_ATTR_last,
 149 };
 150
 151 enum mop_attr_flags_t{ /* keep 16 bits */
 152     MOP_ATTRf_HAS_INIT_ARG         = 0x0001,
 153     MOP_ATTRf_HAS_DEFAULT          = 0x0002,
 154     MOP_ATTRf_IS_DEFAULT_A_CODEREF = 0x0004,
 155     MOP_ATTRf_HAS_BUILDER          = 0x0008,
 156     MOP_ATTRf_HAS_INITIALIZER      = 0x0010,
 157
 158     MOP_ATTRf_DEBUG                = 0x8000
 159 };
 160
 161 MAGIC* mop_attr_mg(pTHX_ SV* const attr, SV* const instance);
 162 void   mop_attr_initialize_instance_slot(pTHX_ SV* const attr, const mop_instance_vtbl* const vtbl, SV* const instance, HV* const args);
 163
 164 /* Class::MOP::Method::Accessor stuff */
 165
 166 #define dMOP_self      SV* const self = mop_accessor_get_self(aTHX_ ax, items, cv)
 167 #define dMOP_mg(xsub)  MAGIC* mg      = (MAGIC*)CvXSUBANY(xsub).any_ptr
 168 #define dMOP_METHOD_COMMON  dMOP_self; dMOP_mg(cv)
 169
 170
 171 SV*    mop_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv);
 172
 173 CV*    mop_install_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl, const mop_instance_vtbl* vtbl);
 174 CV*    mop_instantiate_xs_accessor(pTHX_ SV* const accessor, XSUBADDR_t const accessor_impl, mop_instance_vtbl* const vtbl);
 175
 176 #define INSTALL_SIMPLE_READER(klass, name)                  INSTALL_SIMPLE_READER_WITH_KEY(klass, name, name)
 177 #define INSTALL_SIMPLE_READER_WITH_KEY(klass, name, key)    (void)mop_install_accessor(aTHX_ "Class::MOP::" #klass "::" #name, #key, sizeof(#key)-1, mop_xs_simple_reader, NULL)
 178
 179 #define INSTALL_SIMPLE_WRITER(klass, name)                  INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, name)
 180 #define INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, key)    (void)mop_install_accessor(aTHX_ "Class::MOP::" #klass "::" #name, #key, sizeof(#key)-1, mop_xs_simple_writer, NULL)
 181
 182 #define INSTALL_SIMPLE_PREDICATE(klass, name)                INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, name)
 183 #define INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, key) (void)mop_install_accessor(aTHX_ "Class::MOP::" #klass "::has_" #name, #key, sizeof(#key)-1, mop_xs_simple_predicate_for_metaclass, NULL)
 184
 185 #endif