xs-src/MouseAttribute.xs

   1 #include "mouse.h"
   2
   3 static MGVTBL mouse_xa_vtbl; /* identity */
   4
   5 static AV*
   6 mouse_build_xa(pTHX_ SV* const attr) {
   7     AV*    xa;
   8     MAGIC* mg;
   9
  10     SV* slot;
  11     STRLEN len;
  12     const char* pv;
  13     U16 flags = 0x00;
  14
  15     ENTER;
  16     SAVETMPS;
  17
  18     xa    = newAV();
  19
  20     mg = sv_magicext(SvRV(attr), (SV*)xa, PERL_MAGIC_ext, &mouse_xa_vtbl, NULL, 0);
  21     SvREFCNT_dec(xa); /* refcnt++ in sv_magicext */
  22
  23     av_extend(xa, MOUSE_XA_last - 1);
  24
  25     slot = mcall0(attr, mouse_name);
  26     pv = SvPV_const(slot, len);
  27     av_store(xa, MOUSE_XA_SLOT, newSVpvn_share(pv, len, 0U));
  28
  29     av_store(xa, MOUSE_XA_ATTRIBUTE, newSVsv(attr));
  30
  31     av_store(xa, MOUSE_XA_INIT_ARG, newSVsv(mcall0s(attr, "init_arg")));
  32
  33     if(predicate_calls(attr, "has_type_constraint")){
  34         SV* tc;
  35         flags |= MOUSEf_ATTR_HAS_TC;
  36
  37         tc = mcall0s(attr, "type_constraint");
  38         av_store(xa, MOUSE_XA_TC, newSVsv(tc));
  39
  40         if(predicate_calls(attr, "should_auto_deref")){
  41             SV* const is_a_type_of = sv_2mortal(newSVpvs_share("is_a_type_of"));
  42
  43             flags |= MOUSEf_ATTR_SHOULD_AUTO_DEREF;
  44             if( sv_true(mcall1(tc, is_a_type_of, newSVpvs_flags("ArrayRef", SVs_TEMP))) ){
  45                 flags |= MOUSEf_TC_IS_ARRAYREF;
  46             }
  47             else if( sv_true(mcall1(tc, is_a_type_of, newSVpvs_flags("HashRef", SVs_TEMP))) ){
  48                 flags |= MOUSEf_TC_IS_HASHREF;
  49             }
  50             else{
  51                 mouse_throw_error(attr, tc,
  52                     "Can not auto de-reference the type constraint '%"SVf"'",
  53                         mcall0(tc, mouse_name));
  54             }
  55         }
  56
  57         if(predicate_calls(attr, "should_coerce") && predicate_calls(tc, "has_coercion")){
  58             flags |= MOUSEf_ATTR_SHOULD_COERCE;
  59         }
  60
  61     }
  62
  63     if(predicate_calls(attr, "has_trigger")){
  64         flags |= MOUSEf_ATTR_HAS_TRIGGER;
  65     }
  66
  67     if(predicate_calls(attr, "is_lazy")){
  68         flags |= MOUSEf_ATTR_IS_LAZY;
  69     }
  70     if(predicate_calls(attr, "has_builder")){
  71         flags |= MOUSEf_ATTR_HAS_BUILDER;
  72     }
  73     else if(predicate_calls(attr, "has_default")){
  74         flags |= MOUSEf_ATTR_HAS_DEFAULT;
  75     }
  76
  77     if(predicate_calls(attr, "is_weak_ref")){
  78         flags |= MOUSEf_ATTR_IS_WEAK_REF;
  79     }
  80
  81     if(predicate_calls(attr, "is_required")){
  82         flags |= MOUSEf_ATTR_IS_REQUIRED;
  83     }
  84
  85     av_store(xa, MOUSE_XA_FLAGS, newSVuv(flags));
  86     MOUSE_mg_flags(mg) = flags;
  87
  88     FREETMPS;
  89     LEAVE;
  90
  91     return xa;
  92 }
  93
  94 AV*
  95 mouse_get_xa(pTHX_ SV* const attr) {
  96     AV*    xa;
  97     MAGIC* mg;
  98
  99     if(!IsObject(attr)){
 100         croak("Not a Mouse meta attribute");
 101     }
 102
 103     mg = mouse_mg_find(aTHX_ SvRV(attr), &mouse_xa_vtbl, 0x00);
 104     if(!mg){
 105         xa = mouse_build_xa(aTHX_ attr);
 106     }
 107     else{
 108         xa = (AV*)MOUSE_mg_obj(mg);
 109
 110         assert(xa);
 111         assert(SvTYPE(xa) == SVt_PVAV);
 112     }
 113
 114     return xa;
 115 }
 116
 117 SV*
 118 mouse_xa_apply_type_constraint(pTHX_ AV* const xa, SV* value, U16 const flags){
 119     SV* const tc = MOUSE_xa_tc(xa);
 120     SV* tc_code;
 121
 122     if(flags & MOUSEf_ATTR_SHOULD_COERCE){
 123           value = mcall1(tc, mouse_coerce, value);
 124     }
 125
 126     if(!SvOK(MOUSE_xa_tc_code(xa))){
 127         tc_code = mcall0s(tc, "_compiled_type_constraint");
 128         av_store(xa, MOUSE_XA_TC_CODE, newSVsv(tc_code));
 129
 130         if(!IsCodeRef(tc_code)){
 131             mouse_throw_error(MOUSE_xa_attribute(xa), tc, "Not a CODE reference");
 132         }
 133     }
 134     else{
 135         tc_code = MOUSE_xa_tc_code(xa);
 136     }
 137
 138     if(!mouse_tc_check(aTHX_ tc_code, value)){
 139         mouse_throw_error(MOUSE_xa_attribute(xa), value,
 140             "Attribute (%"SVf") does not pass the type constraint because: %"SVf,
 141                 mcall0(MOUSE_xa_attribute(xa), mouse_name),
 142                 mcall1s(tc, "get_message", value));
 143     }
 144
 145     return value;
 146 }
 147
 148
 149 SV*
 150 mouse_xa_set_default(pTHX_ AV* const xa, SV* const object) {
 151     U16 const flags = (U16)MOUSE_xa_flags(xa);
 152     SV* value;
 153
 154     ENTER;
 155     SAVETMPS;
 156
 157     /* get default value by $attr->builder or $attr->default */
 158     if(flags & MOUSEf_ATTR_HAS_BUILDER){
 159         SV* const builder = mcall0s(MOUSE_xa_attribute(xa), "builder");
 160         value = mcall0(object, builder); /* $object->$builder() */
 161     }
 162     else {
 163         value = mcall0s(MOUSE_xa_attribute(xa), "default");
 164
 165         if(IsCodeRef(value)){
 166             value = mcall0(object, value);
 167         }
 168     }
 169
 170     /* apply coerce and type constraint */
 171     if(flags & MOUSEf_ATTR_HAS_TC){
 172         value = mouse_xa_apply_type_constraint(aTHX_ xa, value, flags);
 173     }
 174
 175     /* store value to slot */
 176     value = set_slot(object, MOUSE_xa_slot(xa), value);
 177     if(flags & MOUSEf_ATTR_IS_WEAK_REF && SvROK(value)){
 178         weaken_slot(object, MOUSE_xa_slot(xa));
 179     }
 180
 181     FREETMPS;
 182     LEAVE;
 183
 184     return value;
 185 }
 186
 187 static void
 188 mouse_check_isa_does_does(pTHX_ SV* const klass, SV* const name, SV* const isa, SV* const does){
 189     STRLEN len;
 190     const char* const pv = SvPV_const(isa, len); /* need strigify */
 191     bool does_ok;
 192     dSP;
 193
 194     ENTER;
 195     SAVETMPS;
 196
 197     SAVESPTR(ERRSV);
 198     ERRSV = sv_newmortal();
 199
 200     PUSHMARK(SP);
 201     EXTEND(SP, 2);
 202     mPUSHp(pv, len);
 203     PUSHs(does);
 204     PUTBACK;
 205
 206     call_method("does", G_EVAL | G_SCALAR);
 207
 208     SPAGAIN;
 209     does_ok = sv_true(POPs);
 210     PUTBACK;
 211
 212     FREETMPS;
 213     LEAVE;
 214
 215     if(!does_ok){
 216         mouse_throw_error(klass, NULL,
 217             "Cannot have both an isa option and a does option"
 218             "because '%"SVf"' does not do '%"SVf"' on attribute (%"SVf")",
 219             isa, does, name
 220         );
 221     }
 222 }
 223
 224 MODULE = Mouse::Meta::Attribute  PACKAGE = Mouse::Meta::Attribute
 225
 226 PROTOTYPES: DISABLE
 227
 228 BOOT:
 229     /* readers */
 230     INSTALL_SIMPLE_READER(Attribute, name);
 231     INSTALL_SIMPLE_READER(Attribute, associated_class);
 232     INSTALL_SIMPLE_READER(Attribute, accessor);
 233     INSTALL_SIMPLE_READER(Attribute, reader);
 234     INSTALL_SIMPLE_READER(Attribute, writer);
 235     INSTALL_SIMPLE_READER(Attribute, predicate);
 236     INSTALL_SIMPLE_READER(Attribute, clearer);
 237     INSTALL_SIMPLE_READER(Attribute, handles);
 238
 239     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, _is_metadata, is);
 240     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_required, required);
 241     INSTALL_SIMPLE_READER(Attribute, default);
 242     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_lazy, lazy);
 243     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_lazy_build, lazy_build);
 244     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, is_weak_ref, weak_ref);
 245     INSTALL_SIMPLE_READER(Attribute, init_arg);
 246     INSTALL_SIMPLE_READER(Attribute, type_constraint);
 247     INSTALL_SIMPLE_READER(Attribute, trigger);
 248     INSTALL_SIMPLE_READER(Attribute, builder);
 249     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, should_auto_deref, auto_deref);
 250     INSTALL_SIMPLE_READER_WITH_KEY(Attribute, should_coerce, coerce);
 251     INSTALL_SIMPLE_READER(Attribute, documentation);
 252
 253     /* predicates */
 254     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_accessor, accessor);
 255     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_reader, reader);
 256     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_writer, writer);
 257     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_predicate, predicate);
 258     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_clearer, clearer);
 259     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_handles, handles);
 260
 261     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_default, default);
 262     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_type_constraint, type_constraint);
 263     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_trigger, trigger);
 264     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_builder, builder);
 265     INSTALL_SIMPLE_PREDICATE_WITH_KEY(Attribute, has_documentation, documentation);
 266
 267     INSTALL_CLASS_HOLDER(Attribute, accessor_metaclass, "Mouse::Meta::Method::Accessor::XS");
 268
 269 void
 270 _process_options(SV* klass, SV* name, HV* args)
 271 CODE:
 272 {
 273     SV** svp;
 274     SV* tc = NULL;
 275
 276     /* 'required' requires eigher 'init_arg', 'builder', or 'default' */
 277     bool can_be_required = FALSE;
 278     bool has_default     = FALSE;
 279     bool has_builder     = FALSE;
 280
 281     /* taken from Class::MOP::Attribute::new */
 282
 283     must_defined(name, "an attribute name");
 284
 285     svp = hv_fetchs(args, "init_arg", FALSE);
 286     if(!svp){
 287         (void)hv_stores(args, "init_arg", newSVsv(name));
 288         can_be_required = TRUE;
 289     }
 290     else{
 291         can_be_required = SvOK(*svp) ? TRUE : FALSE;
 292     }
 293
 294     svp = hv_fetchs(args, "builder", FALSE);
 295     if(svp){
 296         if(!SvOK(*svp)){
 297             mouse_throw_error(klass, *svp,
 298                 "builder must be a defined scalar value which is a method name");
 299         }
 300         can_be_required = TRUE;
 301         has_builder     = TRUE;
 302     }
 303     else if((svp = hv_fetchs(args, "default", FALSE))){
 304         if(SvROK(*svp) && SvTYPE(SvRV(*svp)) != SVt_PVCV) {
 305             mouse_throw_error(klass, *svp,
 306                "References are not allowed as default values, you must "
 307                 "wrap the default of '%"SVf"' in a CODE reference "
 308                 "(ex: sub { [] } and not [])", name);
 309         }
 310         can_be_required = TRUE;
 311         has_default     = TRUE;
 312     }
 313
 314     svp = hv_fetchs(args, "required", FALSE);
 315     if( (svp && sv_true(*svp)) && !can_be_required){
 316         mouse_throw_error(klass, NULL,
 317             "You cannot have a required attribute (%"SVf") "
 318             "without a default, builder, or an init_arg", name);
 319     }
 320
 321      /* taken from Mouse::Meta::Attribute->new and ->_process_args */
 322
 323     svp = hv_fetchs(args, "is", FALSE);
 324     if(svp){
 325         const char* const is = SvOK(*svp) ? SvPV_nolen_const(*svp) : "undef";
 326         if(strEQ(is, "ro")){
 327             svp = hv_fetchs(args, "reader", TRUE);
 328             if(!sv_true(*svp)){
 329                 sv_setsv(*svp, name);
 330             }
 331         }
 332         else if(strEQ(is, "rw")){
 333             if(hv_fetchs(args, "writer", FALSE)){
 334                 svp = hv_fetchs(args, "reader", TRUE);
 335             }
 336             else{
 337                 svp = hv_fetchs(args, "accessor", TRUE);
 338             }
 339             sv_setsv(*svp, name);
 340         }
 341         else if(strEQ(is, "bare")){
 342             /* do nothing, but don't complain (later) about missing methods */
 343         }
 344         else{
 345             mouse_throw_error(klass, NULL,
 346                 "I do not understand this option (is => %s) on attribute (%"SVf")",
 347                 is, name);
 348         }
 349     }
 350
 351     svp = hv_fetchs(args, "isa", FALSE);
 352     if(svp){
 353         SPAGAIN;
 354         PUSHMARK(SP);
 355         XPUSHs(*svp);
 356         PUTBACK;
 357
 358         call_pv("Mouse::Util::TypeConstraints::find_or_create_isa_type_constraint",
 359             G_SCALAR);
 360         SPAGAIN;
 361         tc = newSVsv(POPs);
 362         PUTBACK;
 363     }
 364
 365     if((svp = hv_fetchs(args, "does", FALSE))){
 366         /* check 'isa' does 'does' */
 367         if(tc){
 368             mouse_check_isa_does_does(aTHX_ klass, name, tc, *svp);
 369             /* nothing to do */
 370         }
 371         else{
 372             SPAGAIN;
 373             PUSHMARK(SP);
 374             XPUSHs(*svp);
 375             PUTBACK;
 376
 377             call_pv("Mouse::Util::TypeConstraints::find_or_create_does_type_constraint",
 378                 G_SCALAR);
 379             SPAGAIN;
 380             tc = newSVsv(POPs);
 381             PUTBACK;
 382         }
 383     }
 384     if(tc){
 385         (void)hv_stores(args, "type_constraint", tc);
 386     }
 387
 388     svp = hv_fetchs(args, "coerce", FALSE);
 389     if(svp){
 390         if(!tc){
 391             mouse_throw_error(klass, NULL,
 392                 "You cannot have coercion without specifying a type constraint "
 393                 "on attribute (%"SVf")", name);
 394         }
 395         svp = hv_fetchs(args, "weak_ref", FALSE);
 396         if(svp && sv_true(*svp)){
 397             mouse_throw_error(klass, NULL,
 398                 "You cannot have a weak reference to a coerced value on "
 399                 "attribute (%"SVf")", name);
 400         }
 401     }
 402
 403     svp = hv_fetchs(args, "lazy_build", FALSE);
 404     if(svp){
 405         SV* clearer;
 406         SV* predicate;
 407         if(has_default){
 408             mouse_throw_error(klass, NULL,
 409                 "You can not use lazy_build and default for the same "
 410                 "attribute (%"SVf")", name);
 411         }
 412
 413         svp = hv_fetchs(args, "lazy", TRUE);
 414         sv_setiv(*svp, TRUE);
 415
 416         svp = hv_fetchs(args, "builder", TRUE);
 417         if(!sv_true(*svp)){
 418             sv_setpvf(*svp, "_build_%"SVf, name);
 419         }
 420         has_builder = TRUE;
 421
 422         clearer   = *hv_fetchs(args, "clearer",   TRUE);
 423         predicate = *hv_fetchs(args, "predicate", TRUE);
 424
 425         if(SvPV_nolen_const(name)[0] == '_'){
 426             if(!sv_true(clearer)){
 427                 sv_setpvf(clearer, "_clear%"SVf, name);
 428             }
 429             if(!sv_true(predicate)){
 430                 sv_setpvf(predicate, "_has%"SVf, name);
 431             }
 432         }
 433         else{
 434             if(!sv_true(clearer)){
 435                 sv_setpvf(clearer, "clear_%"SVf, name);
 436             }
 437             if(!sv_true(predicate)){
 438                 sv_setpvf(predicate, "has_%"SVf, name);
 439             }
 440         }
 441     }
 442
 443     svp = hv_fetchs(args, "auto_deref", FALSE);
 444     if(svp && sv_true(*svp)){
 445         SV* const meth = sv_2mortal(newSVpvs_share("is_a_type_of"));
 446         if(!tc){
 447             mouse_throw_error(klass, NULL,
 448                 "You cannot auto-dereference without specifying a type "
 449                 "constraint on attribute (%"SVf")", name);
 450         }
 451
 452         if(!(sv_true(mcall1(tc, meth, newSVpvs_flags("ArrayRef", SVs_TEMP)))
 453             || sv_true(mcall1(tc, meth, newSVpvs_flags("HashRef", SVs_TEMP))) )){
 454             mouse_throw_error(klass, NULL,
 455                 "You cannot auto-dereference anything other than a ArrayRef "
 456                 "or HashRef on attribute (%"SVf")", name);
 457         }
 458     }
 459
 460     svp = hv_fetchs(args, "trigger", FALSE);
 461     if(svp){
 462         if(!IsCodeRef(*svp)){
 463             mouse_throw_error(klass, NULL,
 464                 "Trigger must be a CODE ref on attribute (%"SVf")",
 465                 name);
 466         }
 467     }
 468
 469
 470     svp = hv_fetchs(args, "lazy", FALSE);
 471     if(svp && sv_true(*svp)){
 472         if(!(has_default || has_builder)){
 473             mouse_throw_error(klass, NULL,
 474                 "You cannot have lazy attribute (%"SVf") without specifying "
 475                 "a default value for it", name);
 476         }
 477     }
 478 }