[gitmo/Mouse.git] / mouse.h

#ifndef MOUSE_H
#define MOUSE_H

#define PERL_NO_GET_CONTEXT
#include <EXTERN.h>
#include <perl.h>
#include <XSUB.h>

#include "ppport.h"

/* for portability */
#ifndef newSVpvs_share
#define newSVpvs_share(s) Perl_newSVpvn_share(aTHX_ s, sizeof(s)-1, 0U)
#endif

#ifndef get_cvs
#define get_cvs(name, flags) get_cv(name, flags)
#endif

#ifndef GvNAME_get
#define GvNAME_get GvNAME
#endif
#ifndef GvNAMELEN_get
#define GvNAMELEN_get GvNAMELEN
#endif

#ifndef mro_get_linear_isa
#define no_mro_get_linear_isa
#define mro_get_linear_isa(stash) mouse_mro_get_linear_isa(aTHX_ stash)
AV* mouse_mro_get_linear_isa(pTHX_ HV* const stash);
#endif /* !mro_get_linear_isa */

#ifndef mro_get_pkg_gen
#ifdef no_mro_get_linear_isa
#define mro_get_pkg_gen(stash) ((void)stash, PL_sub_generation)
#else
#define mro_get_pkg_gen(stash) (HvAUX(stash)->xhv_mro_meta ? HvAUX(stash)->xhv_mro_meta->pkg_gen : (U32)0)
#endif /* !no_mro_get_linear_isa */
#endif /* mro_get_package_gen */

#define newAV_mortal() (AV*)sv_2mortal((SV*)newAV())
#define newHV_mortal() (HV*)sv_2mortal((SV*)newHV())

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

extern SV* mouse_package;
extern SV* mouse_namespace;
extern SV* mouse_methods;
extern SV* mouse_name;

void
mouse_throw_error(SV* const metaobject, SV* const data /* not used */, const char* const fmt, ...)
#ifdef __attribute__format__
    __attribute__format__(__printf__, 3, 4);
#else
    ;
#endif

#define is_class_loaded(sv) mouse_is_class_loaded(aTHX_ sv)
bool mouse_is_class_loaded(pTHX_ SV*);

#define is_an_instance_of(klass, sv) mouse_is_an_instance_of(aTHX_ gv_stashpvs(klass, GV_ADD), (sv))

#define IsObject(sv)   (SvROK(sv) && SvOBJECT(SvRV(sv)))
#define IsArrayRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVAV)
#define IsHashRef(sv)  (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVHV)
#define IsCodeRef(sv)  (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVCV)

#define mcall0(invocant, m)        mouse_call0(aTHX_ (invocant), (m))
#define mcall1(invocant, m, arg1)  mouse_call1(aTHX_ (invocant), (m), (arg1))
#define mcall0s(invocant, m)       mcall0((invocant), sv_2mortal(newSVpvs_share(m)))
#define mcall1s(invocant, m, arg1) mcall1((invocant), sv_2mortal(newSVpvs_share(m)), (arg1))

#define get_metaclass(name) mouse_get_metaclass(aTHX_ name)

SV* mouse_call0(pTHX_ SV *const self, SV *const method);
SV* mouse_call1(pTHX_ SV *const self, SV *const method, SV* const arg1);

SV* mouse_get_metaclass(pTHX_ SV* metaclass_name);

GV* mouse_stash_fetch(pTHX_ HV* const stash, const char* const name, I32 const namelen, I32 const create);
#define stash_fetch(s, n, l, c) mouse_stash_fetch(aTHX_ (s), (n), (l), (c))
#define stash_fetchs(s, n, c)   mouse_stash_fetch(aTHX_ (s), STR_WITH_LEN(n), (c))


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

/* MOUSE_av_at(av, ix) is the safer version of AvARRAY(av)[ix] if perl is compiled with -DDEBUGGING */
#ifdef DEBUGGING
#define MOUSE_av_at(av, ix)  *mouse_av_at_safe(aTHX_ (av) , (ix))
SV** mouse_av_at_safe(pTHX_ AV* const mi, I32 const ix);
#else
#define MOUSE_av_at(av, ix)  AvARRAY(av)[ix]
#endif

#define dMOUSE_self  SV* const self = mouse_accessor_get_self(aTHX_ ax, items, cv)
SV* mouse_accessor_get_self(pTHX_ I32 const ax, I32 const items, CV* const cv);

#define MOUSE_mg_obj(mg)     ((mg)->mg_obj)
#define MOUSE_mg_ptr(mg)     ((mg)->mg_ptr)
#define MOUSE_mg_flags(mg)   ((mg)->mg_private)
#define MOUSE_mg_virtual(mg) ((mg)->mg_virtual)

#define MOUSE_mg_slot(mg)   MOUSE_mg_obj(mg)
#define MOUSE_mg_xa(mg)    ((AV*)MOUSE_mg_ptr(mg))


/* mouse_instance.xs stuff */
SV*  mouse_instance_create     (pTHX_ HV* const stash);
SV*  mouse_instance_clone      (pTHX_ SV* const instance);
bool mouse_instance_has_slot   (pTHX_ SV* const instance, SV* const slot);
SV*  mouse_instance_get_slot   (pTHX_ SV* const instance, SV* const slot);
SV*  mouse_instance_set_slot   (pTHX_ SV* const instance, SV* const slot, SV* const value);
SV*  mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot);
void mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot);

#define has_slot(self, key)         mouse_instance_has_slot(aTHX_ self, key)
#define get_slot(self, key)         mouse_instance_get_slot(aTHX_ self, key)
#define set_slot(self, key, value)  mouse_instance_set_slot(aTHX_ self, key, value)
#define delete_slot(self, key)      mouse_instance_delete_slot(aTHX_ self, key)
#define weaken_slot(self, key)      mouse_instance_weaken_slot(aTHX_ self, key)

#define has_slots(self, key)        has_slot(self, sv_2mortal(newSVpvs_share(key)))
#define get_slots(self, key)        get_slot(self, sv_2mortal(newSVpvs_share(key)))
#define set_slots(self, key, value) set_slot(self, sv_2mortal(newSVpvs_share(key)), value)

/* mouse_simle_accessor.xs */
#define INSTALL_SIMPLE_READER(klass, name)                  INSTALL_SIMPLE_READER_WITH_KEY(klass, name, name)
#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)

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

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

CV* mouse_install_simple_accessor(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl);

XS(XS_Mouse_simple_reader);
XS(XS_Mouse_simple_writer);
XS(XS_Mouse_simple_clearer);
XS(XS_Mouse_simple_predicate);

CV* mouse_instantiate_xs_accessor(pTHX_ SV* const attr, XSUBADDR_t const accessor_impl);

XS(XS_Mouse_accessor);
XS(XS_Mouse_reader);
XS(XS_Mouse_writer);

/* type constraints */

int mouse_tc_check(pTHX_ SV* const tc, SV* const sv);

int mouse_tc_Any       (pTHX_ SV*, SV* const sv);
int mouse_tc_Bool      (pTHX_ SV*, SV* const sv);
int mouse_tc_Undef     (pTHX_ SV*, SV* const sv);
int mouse_tc_Defined   (pTHX_ SV*, SV* const sv);
int mouse_tc_Value     (pTHX_ SV*, SV* const sv);
int mouse_tc_Num       (pTHX_ SV*, SV* const sv);
int mouse_tc_Int       (pTHX_ SV*, SV* const sv);
int mouse_tc_Str       (pTHX_ SV*, SV* const sv);
int mouse_tc_ClassName (pTHX_ SV*, SV* const sv);
int mouse_tc_RoleName  (pTHX_ SV*, SV* const sv);
int mouse_tc_Ref       (pTHX_ SV*, SV* const sv);
int mouse_tc_ScalarRef (pTHX_ SV*, SV* const sv);
int mouse_tc_ArrayRef  (pTHX_ SV*, SV* const sv);
int mouse_tc_HashRef   (pTHX_ SV*, SV* const sv);
int mouse_tc_CodeRef   (pTHX_ SV*, SV* const sv);
int mouse_tc_RegexpRef (pTHX_ SV*, SV* const sv);
int mouse_tc_GlobRef   (pTHX_ SV*, SV* const sv);
int mouse_tc_FileHandle(pTHX_ SV*, SV* const sv);
int mouse_tc_Object    (pTHX_ SV*, SV* const sv);

CV* mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name);

int mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance);

XS(XS_Mouse_constraint_check);

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