[gitmo/Class-MOP.git] / mop.h

#ifndef __MOP_H__
#define __MOP_H__

#define PERL_NO_GET_CONTEXT
#include "EXTERN.h"
#include "perl.h"
#include "XSUB.h"

#include "ppport.h"

#define MOP_CALL_BOOT(name) STMT_START {        \
        EXTERN_C XS(CAT2(boot_, name));         \
        PUSHMARK(SP);                           \
        CALL_FPTR(CAT2(boot_, name))(aTHX_ cv); \
    } STMT_END


#define MAKE_KEYSV(name) newSVpvn_share(#name, sizeof(#name)-1, 0U)

XS(mop_xs_simple_accessor);
XS(mop_xs_simple_reader);
XS(mop_xs_simple_writer);
XS(mop_xs_simple_predicate);
XS(mop_xs_simple_predicate_for_metaclass);
XS(mop_xs_simple_clearer);

extern SV *mop_method_metaclass;
extern SV *mop_associated_metaclass;
extern SV *mop_associated_attribute;
extern SV *mop_wrap;
extern SV *mop_methods;
extern SV *mop_name;
extern SV *mop_body;
extern SV *mop_package;
extern SV *mop_package_name;
extern SV *mop_package_cache_flag;
extern SV *mop_initialize;
extern SV *mop_can;
extern SV *mop_Class;
extern SV *mop_VERSION;
extern SV *mop_ISA;

/* MOP utilities */

UV mop_check_package_cache_flag(pTHX_ HV *stash);
int mop_get_code_info (SV *coderef, char **pkg, char **name);
SV *mop_call0(pTHX_ SV *const self, SV *const method);
SV *mop_call1(pTHX_ SV *const self, SV *const method, SV *const arg1);

#define mop_call0_pvs(o, m)    mop_call0(aTHX_ o, newSVpvs_flags(m, SVs_TEMP))
#define mop_call1_pvs(o, m, a) mop_call1(aTHX_ o, newSVpvs_flags(m, SVs_TEMP), a)

bool mop_is_class_loaded(pTHX_ SV*);
#define is_class_loaded(klass) mop_is_class_loaded(aTHX_ klass)

bool mop_is_instance_of(pTHX_ SV*, SV*);
#define is_instance_of(sv, klass)     mop_is_instance_of(aTHX_ sv, klass)
#define is_instance_of_pvs(sv, klass) mop_is_instance_of(aTHX_ sv, newSVpvs_flags(klass, SVs_TEMP))

typedef enum {
    TYPE_FILTER_NONE,
    TYPE_FILTER_CODE,
    TYPE_FILTER_ARRAY,
    TYPE_FILTER_IO,
    TYPE_FILTER_HASH,
    TYPE_FILTER_SCALAR,
} type_filter_t;

typedef bool (*get_package_symbols_cb_t) (const char *, STRLEN, SV *, void *);

void mop_get_package_symbols(HV *stash, type_filter_t filter, get_package_symbols_cb_t cb, void *ud);
HV  *mop_get_all_package_symbols (HV *stash, type_filter_t filter);


#define MOPf_DIE_ON_FAIL 0x01
MAGIC* mop_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags);

#ifdef DEBUGGING
#define MOP_av_at(av, ix)  *mop_av_at_safe(aTHX_ (av) , (ix))
SV** mop_av_at_safe(pTHX_ AV* const mi, I32 const ix);
#else
#define MOP_av_at(av, ix)  AvARRAY(av)[ix]
#endif

#define IsObject(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)))

#define newSVsv_share(sv) mop_newSVsv_share(aTHX_ sv)
SV* mop_newSVsv_share(pTHX_ SV*);

SV* mop_class_of(pTHX_ SV* const sv);

/* Class::MOP::Class */

AV* mop_class_get_all_attributes(pTHX_ SV* const metaclass);

/* Class::MOP Magic stuff */

/* All the MOP_mg_* macros require MAGIC* mg for the first argument */

typedef struct {
    SV*  (*create_instance)(pTHX_ HV* const stash);
    SV*  (*clone_instance) (pTHX_ SV* const instance);
    bool (*has_slot)       (pTHX_ SV* const mi, SV* const instance);
    SV*  (*get_slot)       (pTHX_ SV* const mi, SV* const instance);
    SV*  (*set_slot)       (pTHX_ SV* const mi, SV* const instance, SV* const value);
    SV*  (*delete_slot)    (pTHX_ SV* const mi, SV* const instance);
    void (*weaken_slot)    (pTHX_ SV* const mi, SV* const instance);
} mop_instance_vtbl;

/* Class::MOP::Instance stuff */

SV*  mop_instance_create     (pTHX_ HV* const stash);
SV*  mop_instance_clone      (pTHX_ SV* const instance);
bool mop_instance_has_slot   (pTHX_ SV* const instance, SV* const slot);
SV*  mop_instance_get_slot   (pTHX_ SV* const instance, SV* const slot);
SV*  mop_instance_set_slot   (pTHX_ SV* const instance, SV* const slot, SV* const value);
SV*  mop_instance_delete_slot(pTHX_ SV* const instance, SV* const slot);
void mop_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot);

const mop_instance_vtbl* mop_get_default_instance_vtbl(pTHX);

#define MOP_mg_obj(mg)   ((mg)->mg_obj)
#define MOP_mg_ptr(mg)   ((mg)->mg_ptr)
#define MOP_mg_vtbl(mg)  ((const mop_instance_vtbl*)MOP_mg_ptr(mg))
#define MOP_mg_flags(mg) ((mg)->mg_private)
#define MOP_mg_virtual(mg) ((mg)->mg_virtual)

#define MOP_mg_obj_refcounted_on(mg)    (void)((mg)->mg_flags |= MGf_REFCOUNTED);

#define MOP_mg_create_instance(mg, stash) MOP_mg_vtbl(mg)->create_instance (aTHX_ (stash))
#define MOP_mg_clone_instance(mg, o)      MOP_mg_vtbl(mg)->clone_instance  (aTHX_ (o))
#define MOP_mg_has_slot(mg, o, slot)      MOP_mg_vtbl(mg)->has_slot        (aTHX_ (o), (slot))
#define MOP_mg_get_slot(mg, o, slot)      MOP_mg_vtbl(mg)->get_slot        (aTHX_ (o), (slot))
#define MOP_mg_set_slot(mg, o, slot, v)   MOP_mg_vtbl(mg)->set_slot        (aTHX_ (o), (slot), (v))
#define MOP_mg_delete_slot(mg, o, slot)   MOP_mg_vtbl(mg)->delete_slot     (aTHX_ (o), (slot))
#define MOP_mg_weaken_slot(mg, o, slot)   MOP_mg_vtbl(mg)->weaken_slot     (aTHX_ (o), (slot))

/* Class::MOP::Attribute stuff */


#define MOP_attr_slot(meta)          MOP_av_at(meta, MOP_ATTR_SLOT)
#define MOP_attr_init_arg(meta)      MOP_av_at(meta, MOP_ATTR_INIT_ARG)
#define MOP_attr_default(meta)       MOP_av_at(meta, MOP_ATTR_DEFAULT)
#define MOP_attr_builder(meta)       MOP_av_at(meta, MOP_ATTR_BUILDER)

enum mop_attr_ix_t{
    MOP_ATTR_SLOT,

    MOP_ATTR_INIT_ARG,
    MOP_ATTR_DEFAULT,
    MOP_ATTR_BUILDER,

    MOP_ATTR_last,
};

enum mop_attr_flags_t{ /* keep 16 bits */
    MOP_ATTRf_HAS_INIT_ARG         = 0x0001,
    MOP_ATTRf_HAS_DEFAULT          = 0x0002,
    MOP_ATTRf_IS_DEFAULT_A_CODEREF = 0x0004,
    MOP_ATTRf_HAS_BUILDER          = 0x0008,
    MOP_ATTRf_HAS_INITIALIZER      = 0x0010,

    MOP_ATTRf_DEBUG                = 0x8000
};

MAGIC* mop_attr_mg(pTHX_ SV* const attr, SV* const instance);
void   mop_attr_initialize_instance_slot(pTHX_ SV* const attr, const mop_instance_vtbl* const vtbl, SV* const instance, HV* const args);

/* Class::MOP::Method::Accessor stuff */

#define dMOP_self      SV* const self = mop_accessor_get_self(aTHX_ ax, items, cv)
#define dMOP_mg(xsub)  MAGIC* mg      = (MAGIC*)CvXSUBANY(xsub).any_ptr
#define dMOP_METHOD_COMMON  dMOP_self; dMOP_mg(cv)


SV*    mop_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv);

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);
CV*    mop_instantiate_xs_accessor(pTHX_ SV* const accessor, XSUBADDR_t const accessor_impl, mop_instance_vtbl* const vtbl);

#define INSTALL_SIMPLE_READER(klass, name)                  INSTALL_SIMPLE_READER_WITH_KEY(klass, name, name)
#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)

#define INSTALL_SIMPLE_WRITER(klass, name)                  INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, name)
#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)

#define INSTALL_SIMPLE_PREDICATE(klass, name)                INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, name)
#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)

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