cbab1460d33ba47e3ae36c3c034550cc62c94142
[gitmo/Class-MOP.git] / 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 #define NEED_newRV_noinc
10 #define NEED_sv_2pv_flags
11 #define NEED_sv_2pv_nolen
12 #include "ppport.h"
13
14 #define MOP_CALL_BOOT(name)  mop_call_xs(aTHX_ name, cv, mark);
15
16 #ifndef XSPROTO
17 #define XSPROTO(name) XS(name)
18 #endif
19
20 void mop_call_xs (pTHX_ XSPROTO(subaddr), CV *cv, SV **mark);
21
22
23 #define MAKE_KEYSV(name) newSVpvn_share(#name, sizeof(#name)-1, 0U)
24
25 XS(mop_xs_simple_accessor);
26 XS(mop_xs_simple_reader);
27 XS(mop_xs_simple_writer);
28 XS(mop_xs_simple_predicate);
29 XS(mop_xs_simple_predicate_for_metaclass);
30 XS(mop_xs_simple_clearer);
31
32 extern SV *mop_method_metaclass;
33 extern SV *mop_associated_metaclass;
34 extern SV *mop_associated_attribute;
35 extern SV *mop_wrap;
36 extern SV *mop_methods;
37 extern SV *mop_name;
38 extern SV *mop_body;
39 extern SV *mop_package;
40 extern SV *mop_package_name;
41 extern SV *mop_package_cache_flag;
42 extern SV *mop_VERSION;
43 extern SV *mop_ISA;
44
45 UV mop_check_package_cache_flag(pTHX_ HV *stash);
46 int mop_get_code_info (SV *coderef, char **pkg, char **name);
47 SV *mop_call0(pTHX_ SV *const self, SV *const method);
48 SV *mop_call1(pTHX_ SV *const self, SV *const method, SV *const arg1);
49
50 #define mop_call0_pvs(o, m)    mop_call0(aTHX_ o, newSVpvs_flags(m, SVs_TEMP))
51 #define mop_call1_pvs(o, m, a) mop_call1(aTHX_ o, newSVpvs_flags(m, SVs_TEMP), a)
52
53
54 typedef enum {
55     TYPE_FILTER_NONE,
56     TYPE_FILTER_CODE,
57     TYPE_FILTER_ARRAY,
58     TYPE_FILTER_IO,
59     TYPE_FILTER_HASH,
60     TYPE_FILTER_SCALAR,
61 } type_filter_t;
62
63 typedef bool (*get_package_symbols_cb_t) (const char *, STRLEN, SV *, void *);
64
65 void mop_get_package_symbols(HV *stash, type_filter_t filter, get_package_symbols_cb_t cb, void *ud);
66 HV  *mop_get_all_package_symbols (HV *stash, type_filter_t filter);
67
68
69 /* Class::MOP::Instance stuff */
70
71 typedef struct {
72     SV*  (*create_instance)(pTHX);
73     bool (*has_slot)       (pTHX_ SV* const instance, SV* const slot_name);
74     SV*  (*get_slot)       (pTHX_ SV* const instance, SV* const slot_name);
75     SV*  (*set_slot)       (pTHX_ SV* const instance, SV* const slot_name, SV* const value);
76     SV*  (*delete_slot)    (pTHX_ SV* const instance, SV* const slot_name);
77     void (*weaken_slot)    (pTHX_ SV* const instance, SV* const slot_name);
78 } mop_instance_vtbl;
79
80 const mop_instance_vtbl* mop_get_default_instance_vtbl(pTHX);
81
82 #define MOP_mg_meta(mg) ((AV*)(mg)->mg_obj)
83 #ifdef DEBUGGING
84 #define MOP_mg_key(mg)  (*av_fetch( MOP_mg_meta(mg) , 0, TRUE))
85 #else
86 #define MOP_mg_key(mg)  (AvARRAY( MOP_mg_meta(mg))[0])
87 #endif
88 #define MOP_mg_vtbl(mg) ((const mop_instance_vtbl*)(mg)->mg_ptr)
89
90 /* Class::MOP::Method::Accessor stuff */
91
92 #define dMOP_METHOD_COMMON                                            \
93     SV* const self      = mop_accessor_get_self(aTHX_ ax, items, cv); \
94     MAGIC* const mg     = mop_accessor_get_mg(aTHX_ cv)               \
95
96
97 SV*    mop_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv);
98 MAGIC* mop_accessor_get_mg(pTHX_ CV* const cv);
99
100 CV*    mop_install_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSPROTO(accessor_impl), const mop_instance_vtbl* vtbl);
101
102 #define INSTALL_SIMPLE_READER(klass, name)                  INSTALL_SIMPLE_READER_WITH_KEY(klass, name, name)
103 #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)
104
105 #define INSTALL_SIMPLE_WRITER(klass, name)                  INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, name)
106 #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)
107
108 #define INSTALL_SIMPLE_PREDICATE(klass, name)                INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, name)
109 #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)
110
111 #define MOPf_DIE_ON_FAIL 0x01
112 MAGIC* mop_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags);
113
114 #endif