xs-src/Mouse.xs

   1 #include "mouse.h"
   2
   3 SV* mouse_package;
   4 SV* mouse_namespace;
   5 SV* mouse_methods;
   6 SV* mouse_name;
   7
   8 MODULE = Mouse  PACKAGE = Mouse::Util
   9
  10 PROTOTYPES: DISABLE
  11
  12 BOOT:
  13     mouse_package   = newSVpvs_share("package");
  14     mouse_namespace = newSVpvs_share("namespace");
  15     mouse_methods   = newSVpvs_share("methods");
  16     mouse_name      = newSVpvs_share("name");
  17
  18     MOUSE_CALL_BOOT(Mouse__Util__TypeConstraints);
  19
  20
  21 bool
  22 is_class_loaded(SV* sv)
  23
  24 void
  25 get_code_info(CV* code)
  26 PREINIT:
  27     GV* gv;
  28     HV* stash;
  29 PPCODE:
  30     if((gv = CvGV(code)) && isGV(gv) && (stash = GvSTASH(gv))){
  31         EXTEND(SP, 2);
  32         mPUSHs(newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U));
  33         mPUSHs(newSVpvn_share(GvNAME_get(gv), GvNAMELEN_get(gv), 0U));
  34     }
  35
  36 SV*
  37 get_code_package(CV* code)
  38 PREINIT:
  39     HV* stash;
  40 CODE:
  41     if(CvGV(code) && isGV(CvGV(code)) && (stash = GvSTASH(CvGV(code)))){
  42         RETVAL = newSVpvn_share(HvNAME_get(stash), HvNAMELEN_get(stash), 0U);
  43     }
  44     else{
  45         RETVAL = &PL_sv_no;
  46     }
  47 OUTPUT:
  48     RETVAL
  49
  50 CV*
  51 get_code_ref(SV* package, SV* name)
  52 CODE:
  53 {
  54     HV* stash;
  55     HE* he;
  56
  57     if(!SvOK(package)){
  58         croak("You must define a package name");
  59     }
  60     if(!SvOK(name)){
  61         croak("You must define a subroutine name");
  62     }
  63
  64     stash = gv_stashsv(package, FALSE);
  65     if(!stash){
  66         XSRETURN_UNDEF;
  67     }
  68     he = hv_fetch_ent(stash, name, FALSE, 0U);
  69     if(he){
  70         GV* const gv = (GV*)hv_iterval(stash, he);
  71         if(!isGV(gv)){ /* special constant or stub */
  72             STRLEN len;
  73             const char* const pv = SvPV_const(name, len);
  74             gv_init(gv, stash, pv, len, GV_ADDMULTI);
  75         }
  76         RETVAL = GvCVu(gv);
  77     }
  78     else{
  79         RETVAL = NULL;
  80     }
  81
  82     if(!RETVAL){
  83         XSRETURN_UNDEF;
  84     }
  85 }
  86 OUTPUT:
  87     RETVAL
  88
  89 void
  90 _generate_isa_predicate_for(SV* klass, const char* predicate_name = NULL)
  91 PPCODE:
  92 {
  93     STRLEN klass_len;
  94     const char* klass_pv;
  95     HV* stash;
  96     CV* xsub;
  97
  98     if(!SvOK(klass)){
  99         croak("You must define a class name for generate_for");
 100     }
 101     klass_pv = SvPV_const(klass, klass_len);
 102     klass_pv = mouse_canonicalize_package_name(klass_pv);
 103
 104     if(strNE(klass_pv, "UNIVERSAL")){
 105         static MGVTBL mouse_util_type_constraints_vtbl; /* not used, only for identity */
 106
 107         xsub = newXS(predicate_name, XS_isa_check, __FILE__);
 108
 109         stash = gv_stashpvn(klass_pv, klass_len, GV_ADD);
 110
 111         CvXSUBANY(xsub).any_ptr = sv_magicext(
 112             (SV*)xsub,
 113             (SV*)stash, /* mg_obj */
 114             PERL_MAGIC_ext,
 115             &mouse_util_type_constraints_vtbl,
 116             klass_pv,   /* mg_ptr */
 117             klass_len   /* mg_len */
 118         );
 119     }
 120     else{
 121         xsub = newXS(predicate_name, XS_isa_check_for_universal, __FILE__);
 122     }
 123
 124     if(predicate_name == NULL){ /* anonymous predicate */
 125         XPUSHs( newRV_noinc((SV*)xsub) );
 126     }
 127 }
 128
 129
 130 MODULE = Mouse  PACKAGE = Mouse::Meta::Module
 131
 132 BOOT:
 133     INSTALL_SIMPLE_READER_WITH_KEY(Module, name, package);
 134     INSTALL_SIMPLE_READER_WITH_KEY(Module, _method_map, methods);
 135     INSTALL_SIMPLE_READER_WITH_KEY(Module, _attribute_map, attributes);
 136
 137 HV*
 138 namespace(SV* self)
 139 CODE:
 140 {
 141     SV* const package = mouse_instance_get_slot(aTHX_ self, mouse_package);
 142     if(!(package && SvOK(package))){
 143         croak("No package name defined");
 144     }
 145     RETVAL = gv_stashsv(package, GV_ADDMULTI);
 146 }
 147 OUTPUT:
 148     RETVAL
 149
 150 # ignore extra arguments for extensibility
 151 void
 152 add_method(SV* self, SV* name, SV* code, ...)
 153 CODE:
 154 {
 155     SV* const package = mouse_instance_get_slot(aTHX_ self, mouse_package); /* $self->{package} */
 156     SV* const methods = mouse_instance_get_slot(aTHX_ self, mouse_methods); /* $self->{methods} */
 157     GV* gv;
 158     SV* code_ref;
 159
 160     if(!(package && SvOK(package))){
 161         croak("No package name defined");
 162     }
 163
 164     SvGETMAGIC(name);
 165     SvGETMAGIC(code);
 166
 167     if(!SvOK(name)){
 168         mouse_throw_error(self, NULL, "You must define a method name");
 169     }
 170     if(!SvROK(code)){
 171         mouse_throw_error(self, NULL, "You must define a CODE reference");
 172     }
 173
 174     code_ref = code;
 175     if(SvTYPE(SvRV(code_ref)) != SVt_PVCV){
 176         SV*  sv = code_ref;  /* used in tryAMAGICunDEREF */
 177         SV** sp = &sv;       /* used in tryAMAGICunDEREF */
 178         tryAMAGICunDEREF(to_cv); /* try \&{$code} */
 179         if(SvROK(sv) && SvTYPE(SvRV(sv)) == SVt_PVCV){
 180             mouse_throw_error(self, NULL, "Not a CODE reference");
 181         }
 182         code_ref = sv;
 183     }
 184
 185     /*  *{$package . '::' . $name} -> *gv */
 186     gv = gv_fetchpv(form("%"SVf"::%"SVf, package, name), GV_ADDMULTI, SVt_PVCV);
 187     if(GvCVu(gv)){ /* delete *slot{gv} to work around "redefine" warning */
 188         SvREFCNT_dec(GvCV(gv));
 189         GvCV(gv) = NULL;
 190     }
 191     sv_setsv_mg((SV*)gv, code_ref); /* *gv = $code_ref */
 192
 193     mouse_instance_set_slot(aTHX_ methods, name, code); /* $self->{methods}{$name} = $code */
 194
 195     /* TODO: name the CODE ref if it's anonymous */
 196     //code_entity = (CV*)SvRV(code_ref);
 197     //if(CvANON(code_entity)
 198     //    && CvGV(code_entity) /* a cv under construction has no gv */ ){
 199
 200     //    CvGV(code_entity) = gv;
 201     //    CvANON_off(code_entity);
 202     //}
 203 }
 204
 205 MODULE = Mouse  PACKAGE = Mouse::Meta::Class
 206
 207 BOOT:
 208     INSTALL_SIMPLE_READER(Class, roles);
 209     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Class, is_anon_class, anon_serial_id);
 210
 211 void
 212 linearized_isa(SV* self)
 213 PPCODE:
 214 {
 215     SV* const stash_ref = mcall0(self, mouse_namespace); /* $self->namespace */
 216     AV* linearized_isa;
 217     I32 len;
 218     I32 i;
 219     if(!(SvROK(stash_ref) && SvTYPE(SvRV(stash_ref)) == SVt_PVHV)){
 220         croak("namespace() didn't return a HASH reference");
 221     }
 222     linearized_isa = mro_get_linear_isa((HV*)SvRV(stash_ref));
 223     len = AvFILLp(linearized_isa) + 1;
 224     EXTEND(SP, len);
 225     for(i = 0; i < len; i++){
 226         PUSHs(AvARRAY(linearized_isa)[i]);
 227     }
 228 }
 229
 230 MODULE = Mouse  PACKAGE = Mouse::Meta::Role
 231
 232 BOOT:
 233     INSTALL_SIMPLE_READER_WITH_KEY(Role, get_roles, roles);
 234     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Role, is_anon_role, anon_serial_id);
 235
 236 MODULE = Mouse  PACKAGE = Mouse::Meta::Attribute
 237
 238 BOOT:
 239     /* readers */
 240     INSTALL_SIMPLE_READER(Attribute, name);
 241     INSTALL_SIMPLE_READER(Attribute, associated_class);
 242     INSTALL_SIMPLE_READER(Attribute, accessor);
 243     INSTALL_SIMPLE_READER(Attribute, reader);
 244     INSTALL_SIMPLE_READER(Attribute, writer);
 245     INSTALL_SIMPLE_READER(Attribute, predicate);
 246     INSTALL_SIMPLE_READER(Attribute, clearer);
 247     INSTALL_SIMPLE_READER(Attribute, handles);
 248
 249     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, _is_metadata, is);
 250     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_required, required);
 251     INSTALL_SIMPLE_READER(Attribute, default);
 252     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_lazy, lazy);
 253     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_lazy_build, lazy_build);
 254     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_weak_ref, weak_ref);
 255     INSTALL_SIMPLE_READER(Attribute, init_arg);
 256     INSTALL_SIMPLE_READER(Attribute, type_constraint);
 257     INSTALL_SIMPLE_READER(Attribute, trigger);
 258     INSTALL_SIMPLE_READER(Attribute, builder);
 259     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, should_auto_deref, auto_deref);
 260     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, should_coerce, coerce);
 261     INSTALL_SIMPLE_READER(Attribute, documentation);
 262
 263     /* predicates */
 264     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_accessor, accessor);
 265     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_reader, reader);
 266     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_writer, writer);
 267     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_predicate, predicate);
 268     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_clearer, clearer);
 269     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_handles, handles);
 270
 271     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_default, default);
 272     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_type_constraint, type_constraint);
 273     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_trigger, trigger);
 274     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_builder, builder);
 275     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_documentation, documentation);
 276
 277     newCONSTSUB(gv_stashpvs("Mouse::Meta::Attribute", TRUE), "accessor_metaclass",
 278         newSVpvs("Mouse::Meta::Method::Accessor::XS"));
 279
 280 MODULE = Mouse  PACKAGE = Mouse::Meta::TypeConstraint
 281
 282 BOOT:
 283     INSTALL_SIMPLE_READER(TypeConstraint, name);
 284     INSTALL_SIMPLE_READER(TypeConstraint, parent);
 285     INSTALL_SIMPLE_READER(TypeConstraint, message);
 286
 287     INSTALL_SIMPLE_READER_WITH_KEY(TypeConstraint, _compiled_type_constraint, compiled_type_constraint);
 288     INSTALL_SIMPLE_READER(TypeConstraint, _compiled_type_coercion); /* Mouse specific */
 289
 290     INSTALL_SIMPLE_PREDICATE_WITH_KEY(TypeConstraint, has_coercion, _compiled_type_coercion);
 291
 292
 293 MODULE = Mouse  PACKAGE = Mouse::Meta::Method::Accessor::XS
 294
 295 CV*
 296 _generate_accessor(klass, SV* attr, metaclass)
 297 CODE:
 298 {
 299     RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_accessor);
 300 }
 301 OUTPUT:
 302     RETVAL
 303
 304 CV*
 305 _generate_reader(klass, SV* attr, metaclass)
 306 CODE:
 307 {
 308     RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_reader);
 309 }
 310 OUTPUT:
 311     RETVAL
 312
 313 CV*
 314 _generate_writer(klass, SV* attr, metaclass)
 315 CODE:
 316 {
 317     RETVAL = mouse_instantiate_xs_accessor(aTHX_ attr, mouse_xs_writer);
 318 }
 319 OUTPUT:
 320     RETVAL
 321
 322 CV*
 323 _generate_clearer(klass, SV* attr, metaclass)
 324 CODE:
 325 {
 326     SV* const slot = mcall0s(attr, "name");
 327     STRLEN len;
 328     const char* const pv = SvPV_const(slot, len);
 329     RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, mouse_xs_simple_clearer);
 330 }
 331 OUTPUT:
 332     RETVAL
 333
 334 CV*
 335 _generate_predicate(klass, SV* attr, metaclass)
 336 CODE:
 337 {
 338     SV* const slot = mcall0s(attr, "name");
 339     STRLEN len;
 340     const char* const pv = SvPV_const(slot, len);
 341     RETVAL = mouse_install_simple_accessor(aTHX_ NULL, pv, len, mouse_xs_simple_predicate);
 342 }
 343 OUTPUT:
 344     RETVAL
 345