[gitmo/Mouse.git] / mouse.h

#ifndef MOUSE_H
#define MOUSE_H

#include "xshelper.h"

#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);
#define mro_method_changed_in(stash) ((void)++PL_sub_generation)
#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 */

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

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

/* workaround RT #69939 */
I32
mouse_call_sv_safe(pTHX_ SV*, I32);

#define call_sv_safe(sv, flags)     mouse_call_sv_safe(aTHX_ sv, flags)
#define call_method_safe(m, flags)  mouse_call_sv_safe(aTHX_ newSVpvn_flags(m, strlen(m), SVs_TEMP), flags | G_METHOD)
#define call_method_safes(m, flags) mouse_call_sv_safe(aTHX_ newSVpvs_flags(m, SVs_TEMP),            flags | G_METHOD)


#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 predicate_call(invocant, m)  mouse_predicate_call(aTHX_ (invocant), (m))

#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 predicate_calls(invocant, m)  predicate_call((invocant), sv_2mortal(newSVpvs_share(m)))


#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);
int mouse_predicate_call(pTHX_ SV* const self, SV* const method);

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))

void mouse_install_sub(pTHX_ GV* const gv, SV* const code_ref);

void mouse_must_defined(pTHX_ SV* const value, const char* const name);
void mouse_must_ref(pTHX_ SV* const value, const char* const name, svtype const t);

#define must_defined(sv, name)   mouse_must_defined(aTHX_ sv, name)
#define must_ref(sv, name, svt)  mouse_must_ref(aTHX_ sv, name, svt)

#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 MOUSE_mg_obj(mg)     ((mg)->mg_obj)
#define MOUSE_mg_ptr(mg)     ((mg)->mg_ptr)
#define MOUSE_mg_len(mg)     ((mg)->mg_len)
#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 for meta object protocols */
#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_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
    #name, #key, sizeof(#key)-1, XS_Mouse_simple_reader, NULL, 0)

#define INSTALL_CLASS_HOLDER_SV(klass, name, dsv) \
    (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
    #name, #name, sizeof(#name)-1, XS_Mouse_simple_reader, (dsv), HEf_SVKEY)
#define INSTALL_CLASS_HOLDER(klass, name, ds) \
    INSTALL_CLASS_HOLDER_SV(klass, name, newSVpvs(ds))

#define INSTALL_SIMPLE_WRITER(klass, name) \
    NSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, name)
#define INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, key) \
    (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
    #name, #key, sizeof(#key)-1, XS_Mouse_simple_writer, NULL, 0)

#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_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
    #name, #key, sizeof(#key)-1, XS_Mouse_simple_predicate, NULL, 0)

/* generate inhertiable class accessors for Mouse::Meta::Class */
#define INSTALL_INHERITABLE_CLASS_ACCESSOR(name) \
    INSTALL_INHERITABLE_CLASS_ACCESSOR_WITH_KEY(name, name)
#define INSTALL_INHERITABLE_CLASS_ACCESSOR_WITH_KEY(name, key) \
    (void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::Class::" #name,\
    #key, sizeof(#key)-1, XS_Mouse_inheritable_class_accessor, NULL, 0)

CV* mouse_simple_accessor_generate(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl, void* const dptr, I32 const dlen);

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

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

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

XS(XS_Mouse_inheritable_class_accessor);

/* 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);
CV* mouse_generate_can_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);

/* Mouse XS Attribute object */

AV* mouse_get_xa(pTHX_ SV* const attr);
SV* mouse_xa_apply_type_constraint(pTHX_ AV* const xa, SV* value, U16 const flags);
SV* mouse_xa_set_default(pTHX_ AV* const xa, SV* const object);

enum mouse_xa_ix_t{
    MOUSE_XA_SLOT,      /* for constructors, sync to mg_obj */
    MOUSE_XA_FLAGS,     /* for constructors, sync to mg_private */
    MOUSE_XA_ATTRIBUTE,
    MOUSE_XA_INIT_ARG,
    MOUSE_XA_TC,
    MOUSE_XA_TC_CODE,

    MOUSE_XA_last
};

#define MOUSE_xa_slot(m)      MOUSE_av_at(m, MOUSE_XA_SLOT)
#define MOUSE_xa_flags(m)     SvUVX( MOUSE_av_at(m, MOUSE_XA_FLAGS) )
#define MOUSE_xa_attribute(m) MOUSE_av_at(m, MOUSE_XA_ATTRIBUTE)
#define MOUSE_xa_init_arg(m)  MOUSE_av_at(m, MOUSE_XA_INIT_ARG)
#define MOUSE_xa_tc(m)        MOUSE_av_at(m, MOUSE_XA_TC)
#define MOUSE_xa_tc_code(m)   MOUSE_av_at(m, MOUSE_XA_TC_CODE)

enum mouse_xa_flags_t{
    MOUSEf_ATTR_HAS_TC          = 0x0001,
    MOUSEf_ATTR_HAS_DEFAULT     = 0x0002,
    MOUSEf_ATTR_HAS_BUILDER     = 0x0004,
    MOUSEf_ATTR_HAS_INITIALIZER = 0x0008, /* not used */
    MOUSEf_ATTR_HAS_TRIGGER     = 0x0010,

    MOUSEf_ATTR_IS_LAZY         = 0x0020,
    MOUSEf_ATTR_IS_WEAK_REF     = 0x0040,
    MOUSEf_ATTR_IS_REQUIRED     = 0x0080,

    MOUSEf_ATTR_SHOULD_COERCE   = 0x0100,

    MOUSEf_ATTR_SHOULD_AUTO_DEREF
                                = 0x0200,
    MOUSEf_TC_IS_ARRAYREF       = 0x0400,
    MOUSEf_TC_IS_HASHREF        = 0x0800,

    MOUSEf_OTHER1               = 0x1000,
    MOUSEf_OTHER2               = 0x2000,
    MOUSEf_OTHER3               = 0x4000,
    MOUSEf_OTHER4               = 0x8000,

    MOUSEf_MOUSE_MASK           = 0xFFFF /* not used */
};


#endif /* !MOUSE_H */
Commit	Line	Data
df6dd016	1	#ifndef MOUSE_H
	2	#define MOUSE_H
	3
8e4a10a8	4	#include "xshelper.h"
d6ceb359	5
cccb83de	6	#ifndef mro_get_linear_isa
	7	#define no_mro_get_linear_isa
	8	#define mro_get_linear_isa(stash) mouse_mro_get_linear_isa(aTHX_ stash)
3ea28db6	9	AV* mouse_mro_get_linear_isa(pTHX_ HV* const stash);
da4b1214	10	#define mro_method_changed_in(stash) ((void)++PL_sub_generation)
cccb83de	11	#endif /* !mro_get_linear_isa */
	12
	13	#ifndef mro_get_pkg_gen
	14	#ifdef no_mro_get_linear_isa
	15	#define mro_get_pkg_gen(stash) ((void)stash, PL_sub_generation)
	16	#else
	17	#define mro_get_pkg_gen(stash) (HvAUX(stash)->xhv_mro_meta ? HvAUX(stash)->xhv_mro_meta->pkg_gen : (U32)0)
	18	#endif /* !no_mro_get_linear_isa */
	19	#endif /* mro_get_package_gen */
	20
cccb83de	21	extern SV* mouse_package;
cccb83de	22	extern SV* mouse_namespace;
a5df48e5	23	extern SV* mouse_methods;
a5df48e5	24	extern SV* mouse_name;
d39ac61c	25	extern SV* mouse_coerce;
43165725	26
93540011	27	void
93540011	28	mouse_throw_error(SV* const metaobject, SV* const data /* not used /, const char const fmt, ...)
93540011	29	__attribute__format__(__printf__, 3, 4);
93540011	30
b3cd4c14	31	/* workaround RT #69939 */
	32	I32
	33	mouse_call_sv_safe(pTHX_ SV*, I32);
	34
	35	#define call_sv_safe(sv, flags) mouse_call_sv_safe(aTHX_ sv, flags)
	36	#define call_method_safe(m, flags) mouse_call_sv_safe(aTHX_ newSVpvn_flags(m, strlen(m), SVs_TEMP), flags \| G_METHOD)
	37	#define call_method_safes(m, flags) mouse_call_sv_safe(aTHX_ newSVpvs_flags(m, SVs_TEMP), flags \| G_METHOD)
	38
	39
df6dd016	40	#define is_class_loaded(sv) mouse_is_class_loaded(aTHX_ sv)
	41	bool mouse_is_class_loaded(pTHX_ SV*);
	42
016e4681	43	#define is_an_instance_of(klass, sv) mouse_is_an_instance_of(aTHX_ gv_stashpvs(klass, GV_ADD), (sv))
df6dd016	44
80aa5731	45	#define IsObject(sv) (SvROK(sv) && SvOBJECT(SvRV(sv)))
	46	#define IsArrayRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVAV)
	47	#define IsHashRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVHV)
	48	#define IsCodeRef(sv) (SvROK(sv) && !SvOBJECT(SvRV(sv)) && SvTYPE(SvRV(sv)) == SVt_PVCV)
df6dd016	49
0aad0266	50	#define mcall0(invocant, m) mouse_call0(aTHX_ (invocant), (m))
	51	#define mcall1(invocant, m, arg1) mouse_call1(aTHX_ (invocant), (m), (arg1))
	52	#define predicate_call(invocant, m) mouse_predicate_call(aTHX_ (invocant), (m))
	53
	54	#define mcall0s(invocant, m) mcall0((invocant), sv_2mortal(newSVpvs_share(m)))
	55	#define mcall1s(invocant, m, arg1) mcall1((invocant), sv_2mortal(newSVpvs_share(m)), (arg1))
	56	#define predicate_calls(invocant, m) predicate_call((invocant), sv_2mortal(newSVpvs_share(m)))
	57
df6dd016	58
aa2d2e2c	59	#define get_metaclass(name) mouse_get_metaclass(aTHX_ name)
a39e9541	60
df6dd016	61	SV* mouse_call0(pTHX_ SV const self, SV const method);
df6dd016	62	SV* mouse_call1(pTHX_ SV const self, SV const method, SV* const arg1);
0aad0266	63	int mouse_predicate_call(pTHX_ SV* const self, SV* const method);
df6dd016	64
aa2d2e2c	65	SV* mouse_get_metaclass(pTHX_ SV* metaclass_name);
a39e9541	66
	67	GV* mouse_stash_fetch(pTHX_ HV* const stash, const char* const name, I32 const namelen, I32 const create);
	68	#define stash_fetch(s, n, l, c) mouse_stash_fetch(aTHX_ (s), (n), (l), (c))
	69	#define stash_fetchs(s, n, c) mouse_stash_fetch(aTHX_ (s), STR_WITH_LEN(n), (c))
	70
d67f600d	71	void mouse_install_sub(pTHX_ GV* const gv, SV* const code_ref);
a39e9541	72
d06d9266	73	void mouse_must_defined(pTHX_ SV* const value, const char* const name);
	74	void mouse_must_ref(pTHX_ SV* const value, const char* const name, svtype const t);
	75
	76	#define must_defined(sv, name) mouse_must_defined(aTHX_ sv, name)
	77	#define must_ref(sv, name, svt) mouse_must_ref(aTHX_ sv, name, svt)
	78
43165725	79	#define MOUSEf_DIE_ON_FAIL 0x01
	80	MAGIC* mouse_mg_find(pTHX_ SV* const sv, const MGVTBL* const vtbl, I32 const flags);
	81
93540011	82	/* MOUSE_av_at(av, ix) is the safer version of AvARRAY(av)[ix] if perl is compiled with -DDEBUGGING */
	83	#ifdef DEBUGGING
	84	#define MOUSE_av_at(av, ix) *mouse_av_at_safe(aTHX_ (av) , (ix))
	85	SV** mouse_av_at_safe(pTHX_ AV* const mi, I32 const ix);
	86	#else
	87	#define MOUSE_av_at(av, ix) AvARRAY(av)[ix]
	88	#endif
	89
93540011	90	#define MOUSE_mg_obj(mg) ((mg)->mg_obj)
93540011	91	#define MOUSE_mg_ptr(mg) ((mg)->mg_ptr)
ace98309	92	#define MOUSE_mg_len(mg) ((mg)->mg_len)
93540011	93	#define MOUSE_mg_flags(mg) ((mg)->mg_private)
	94	#define MOUSE_mg_virtual(mg) ((mg)->mg_virtual)
	95
	96	#define MOUSE_mg_slot(mg) MOUSE_mg_obj(mg)
	97	#define MOUSE_mg_xa(mg) ((AV*)MOUSE_mg_ptr(mg))
	98
43165725	99
	100	/* mouse_instance.xs stuff */
	101	SV* mouse_instance_create (pTHX_ HV* const stash);
	102	SV* mouse_instance_clone (pTHX_ SV* const instance);
	103	bool mouse_instance_has_slot (pTHX_ SV* const instance, SV* const slot);
	104	SV* mouse_instance_get_slot (pTHX_ SV* const instance, SV* const slot);
	105	SV* mouse_instance_set_slot (pTHX_ SV* const instance, SV* const slot, SV* const value);
	106	SV* mouse_instance_delete_slot(pTHX_ SV* const instance, SV* const slot);
	107	void mouse_instance_weaken_slot(pTHX_ SV* const instance, SV* const slot);
	108
f790c46b	109	#define has_slot(self, key) mouse_instance_has_slot(aTHX_ self, key)
	110	#define get_slot(self, key) mouse_instance_get_slot(aTHX_ self, key)
	111	#define set_slot(self, key, value) mouse_instance_set_slot(aTHX_ self, key, value)
6fe2272b	112	#define delete_slot(self, key) mouse_instance_delete_slot(aTHX_ self, key)
6fe2272b	113	#define weaken_slot(self, key) mouse_instance_weaken_slot(aTHX_ self, key)
f790c46b	114
6fe2272b	115	#define has_slots(self, key) has_slot(self, sv_2mortal(newSVpvs_share(key)))
	116	#define get_slots(self, key) get_slot(self, sv_2mortal(newSVpvs_share(key)))
	117	#define set_slots(self, key, value) set_slot(self, sv_2mortal(newSVpvs_share(key)), value)
43165725	118
fad99075	119	/* mouse_simle_accessor.xs for meta object protocols */
e058b279	120	#define INSTALL_SIMPLE_READER(klass, name) \
	121	INSTALL_SIMPLE_READER_WITH_KEY(klass, name, name)
	122	#define INSTALL_SIMPLE_READER_WITH_KEY(klass, name, key) \
fad99075	123	(void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
fad99075	124	#name, #key, sizeof(#key)-1, XS_Mouse_simple_reader, NULL, 0)
e058b279	125
787f84c2	126	#define INSTALL_CLASS_HOLDER_SV(klass, name, dsv) \
fad99075	127	(void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
fad99075	128	#name, #name, sizeof(#name)-1, XS_Mouse_simple_reader, (dsv), HEf_SVKEY)
787f84c2	129	#define INSTALL_CLASS_HOLDER(klass, name, ds) \
787f84c2	130	INSTALL_CLASS_HOLDER_SV(klass, name, newSVpvs(ds))
2468f1d7	131
e058b279	132	#define INSTALL_SIMPLE_WRITER(klass, name) \
	133	NSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, name)
	134	#define INSTALL_SIMPLE_WRITER_WITH_KEY(klass, name, key) \
fad99075	135	(void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
fad99075	136	#name, #key, sizeof(#key)-1, XS_Mouse_simple_writer, NULL, 0)
e058b279	137
	138	#define INSTALL_SIMPLE_PREDICATE(klass, name) \
	139	INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, name)
	140	#define INSTALL_SIMPLE_PREDICATE_WITH_KEY(klass, name, key) \
fad99075	141	(void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::" #klass "::" \
	142	#name, #key, sizeof(#key)-1, XS_Mouse_simple_predicate, NULL, 0)
	143
	144	/* generate inhertiable class accessors for Mouse::Meta::Class */
	145	#define INSTALL_INHERITABLE_CLASS_ACCESSOR(name) \
	146	INSTALL_INHERITABLE_CLASS_ACCESSOR_WITH_KEY(name, name)
	147	#define INSTALL_INHERITABLE_CLASS_ACCESSOR_WITH_KEY(name, key) \
	148	(void)mouse_simple_accessor_generate(aTHX_ "Mouse::Meta::Class::" #name,\
	149	#key, sizeof(#key)-1, XS_Mouse_inheritable_class_accessor, NULL, 0)
e058b279	150
a17f6313	151	CV* mouse_simple_accessor_generate(pTHX_ const char* const fq_name, const char* const key, I32 const keylen, XSUBADDR_t const accessor_impl, void* const dptr, I32 const dlen);
43165725	152
30e11004	153	XS(XS_Mouse_simple_reader);
	154	XS(XS_Mouse_simple_writer);
	155	XS(XS_Mouse_simple_clearer);
	156	XS(XS_Mouse_simple_predicate);
df6dd016	157
a17f6313	158	CV* mouse_accessor_generate(pTHX_ SV* const attr, XSUBADDR_t const accessor_impl);
93540011	159
30e11004	160	XS(XS_Mouse_accessor);
	161	XS(XS_Mouse_reader);
	162	XS(XS_Mouse_writer);
93540011	163
fad99075	164	XS(XS_Mouse_inheritable_class_accessor);
fad99075	165
7d96ae4d	166	/* type constraints */
7d96ae4d	167
1d5ecd5f	168	int mouse_tc_check(pTHX_ SV* const tc, SV* const sv);
19462c57	169
	170	int mouse_tc_Any (pTHX_ SV, SV const sv);
	171	int mouse_tc_Bool (pTHX_ SV, SV const sv);
	172	int mouse_tc_Undef (pTHX_ SV, SV const sv);
	173	int mouse_tc_Defined (pTHX_ SV, SV const sv);
	174	int mouse_tc_Value (pTHX_ SV, SV const sv);
	175	int mouse_tc_Num (pTHX_ SV, SV const sv);
	176	int mouse_tc_Int (pTHX_ SV, SV const sv);
	177	int mouse_tc_Str (pTHX_ SV, SV const sv);
	178	int mouse_tc_ClassName (pTHX_ SV, SV const sv);
	179	int mouse_tc_RoleName (pTHX_ SV, SV const sv);
	180	int mouse_tc_Ref (pTHX_ SV, SV const sv);
	181	int mouse_tc_ScalarRef (pTHX_ SV, SV const sv);
	182	int mouse_tc_ArrayRef (pTHX_ SV, SV const sv);
	183	int mouse_tc_HashRef (pTHX_ SV, SV const sv);
	184	int mouse_tc_CodeRef (pTHX_ SV, SV const sv);
	185	int mouse_tc_RegexpRef (pTHX_ SV, SV const sv);
	186	int mouse_tc_GlobRef (pTHX_ SV, SV const sv);
	187	int mouse_tc_FileHandle(pTHX_ SV, SV const sv);
	188	int mouse_tc_Object (pTHX_ SV, SV const sv);
7d96ae4d	189
672bde7c	190	CV* mouse_generate_isa_predicate_for(pTHX_ SV* const klass, const char* const predicate_name);
ebe91068	191	CV* mouse_generate_can_predicate_for(pTHX_ SV* const klass, const char* const predicate_name);
f48920c1	192
016e4681	193	int mouse_is_an_instance_of(pTHX_ HV* const stash, SV* const instance);
016e4681	194
19462c57	195	XS(XS_Mouse_constraint_check);
af5eccce	196
0aad0266	197	/* Mouse XS Attribute object */
	198
	199	AV* mouse_get_xa(pTHX_ SV* const attr);
4e7e3250	200	SV* mouse_xa_apply_type_constraint(pTHX_ AV* const xa, SV* value, U16 const flags);
4e7e3250	201	SV* mouse_xa_set_default(pTHX_ AV* const xa, SV* const object);
0aad0266	202
	203	enum mouse_xa_ix_t{
	204	MOUSE_XA_SLOT, /* for constructors, sync to mg_obj */
	205	MOUSE_XA_FLAGS, /* for constructors, sync to mg_private */
	206	MOUSE_XA_ATTRIBUTE,
4e7e3250	207	MOUSE_XA_INIT_ARG,
0aad0266	208	MOUSE_XA_TC,
	209	MOUSE_XA_TC_CODE,
	210
	211	MOUSE_XA_last
	212	};
	213
	214	#define MOUSE_xa_slot(m) MOUSE_av_at(m, MOUSE_XA_SLOT)
4e7e3250	215	#define MOUSE_xa_flags(m) SvUVX( MOUSE_av_at(m, MOUSE_XA_FLAGS) )
0aad0266	216	#define MOUSE_xa_attribute(m) MOUSE_av_at(m, MOUSE_XA_ATTRIBUTE)
4e7e3250	217	#define MOUSE_xa_init_arg(m) MOUSE_av_at(m, MOUSE_XA_INIT_ARG)
0aad0266	218	#define MOUSE_xa_tc(m) MOUSE_av_at(m, MOUSE_XA_TC)
	219	#define MOUSE_xa_tc_code(m) MOUSE_av_at(m, MOUSE_XA_TC_CODE)
	220
0aad0266	221	enum mouse_xa_flags_t{
	222	MOUSEf_ATTR_HAS_TC = 0x0001,
	223	MOUSEf_ATTR_HAS_DEFAULT = 0x0002,
	224	MOUSEf_ATTR_HAS_BUILDER = 0x0004,
4e7e3250	225	MOUSEf_ATTR_HAS_INITIALIZER = 0x0008, /* not used */
0aad0266	226	MOUSEf_ATTR_HAS_TRIGGER = 0x0010,
	227
	228	MOUSEf_ATTR_IS_LAZY = 0x0020,
	229	MOUSEf_ATTR_IS_WEAK_REF = 0x0040,
	230	MOUSEf_ATTR_IS_REQUIRED = 0x0080,
	231
	232	MOUSEf_ATTR_SHOULD_COERCE = 0x0100,
	233
	234	MOUSEf_ATTR_SHOULD_AUTO_DEREF
	235	= 0x0200,
	236	MOUSEf_TC_IS_ARRAYREF = 0x0400,
	237	MOUSEf_TC_IS_HASHREF = 0x0800,
	238
	239	MOUSEf_OTHER1 = 0x1000,
	240	MOUSEf_OTHER2 = 0x2000,
	241	MOUSEf_OTHER3 = 0x4000,
	242	MOUSEf_OTHER4 = 0x8000,
	243
	244	MOUSEf_MOUSE_MASK = 0xFFFF /* not used */
	245	};
	246
	247
df6dd016	248	#endif /* !MOUSE_H */
df6dd016	249