Moose.xs

   1 #include "EXTERN.h"
   2 #include "perl.h"
   3 #include "XSUB.h"
   4
   5 #define NEED_grok_number
   6 #define NEED_grok_numeric_radix
   7 #define NEED_newRV_noinc
   8 #define NEED_newSVpvn_share
   9 #define NEED_sv_2pv_flags
  10 #include "ppport.h"
  11
  12 #ifndef XSPROTO
  13 #define XSPROTO(name) void name(pTHX_ CV* cv)
  14 #endif
  15
  16 #ifndef gv_stashpvs
  17 #define gv_stashpvs(x, y) Perl_gv_stashpvn(aTHX_ STR_WITH_LEN(x), y)
  18 #endif
  19
  20 /* FIXME
  21  * delegations and attribute helpers:
  22  *
  23  * typedef struct {
  24  *      ATTR *attr;
  25  *      pv *method;
  26  * } delegation;
  27  *
  28  * typedef struct {
  29  *      ATTR *attr;
  30  *      I32 *type; // hash, array, whatever + vtable for operation
  31  * } attributehelper;
  32  */
  33
  34
  35
  36
  37
  38
  39
  40 /* These two functions attach magic with no behavior to an SV.
  41  *
  42  * The stashed value is reference counted, and is destroyed when it's parent
  43  * object is destroyed.
  44  *
  45  * This is used to keep a reference the the meta attribute from a generated
  46  * method, and to cache the C struct based wrapper attached to the meta
  47  * instance.
  48  */
  49
  50 STATIC MGVTBL null_mg_vtbl = {
  51     NULL, /* get */
  52     NULL, /* set */
  53     NULL, /* len */
  54     NULL, /* clear */
  55     NULL, /* free */
  56 #if MGf_COPY
  57     NULL, /* copy */
  58 #endif /* MGf_COPY */
  59 #if MGf_DUP
  60     NULL, /* dup */
  61 #endif /* MGf_DUP */
  62 #if MGf_LOCAL
  63     NULL, /* local */
  64 #endif /* MGf_LOCAL */
  65 };
  66
  67 STATIC MAGIC *stash_in_mg (pTHX_ SV *sv, SV *obj) {
  68     MAGIC *mg = sv_magicext(sv, obj, PERL_MAGIC_ext, &null_mg_vtbl, NULL, 0 );
  69     mg->mg_flags |= MGf_REFCOUNTED;
  70
  71     return mg;
  72 }
  73
  74 STATIC SV *get_stashed_in_mg(pTHX_ SV *sv) {
  75     MAGIC *mg;
  76
  77     if (SvTYPE(sv) >= SVt_PVMG) {
  78         for (mg = SvMAGIC(sv); mg; mg = mg->mg_moremagic) {
  79             if ((mg->mg_type == PERL_MAGIC_ext) && (mg->mg_virtual == &null_mg_vtbl))
  80                 break;
  81         }
  82         if (mg)
  83             return mg->mg_obj;
  84     }
  85
  86     return NULL;
  87 }
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97 /* The folloing data structures deal with type constraints */
  98
  99 /* this is an enum of the various kinds of constraint checking an attribute can
 100  * have.
 101  *
 102  * tc_cv is the fallback behavior (simply applying the
 103  * ->_compiled_type_constraint to the value, but other more optimal checks are
 104  *  implemented too. */
 105
 106 typedef enum {
 107     tc_none = 0, /* no type checking */
 108     tc_type, /* a builtin type to be checked by check_sv_type */
 109     tc_stash, /* a stash for a class, implements TypeConstraint::Class by comparing SvSTASH and then invoking C<isa> if necessary */
 110     tc_cv, /* applies a code reference to the value and checks for truth */
 111     tc_fptr, /* apply a C function pointer */
 112     tc_enum /* TODO check that the value is in an allowed set of values (strings) */
 113 } tc_kind;
 114
 115 /* this is a enum of builtin type check. They are handled in a switch statement
 116  * in check_sv_type */
 117 typedef enum {
 118     Any, /* or item, or bool */
 119     Undef,
 120     Defined,
 121     Str, /* or value */
 122     Num,
 123     Int,
 124     GlobRef, /* SVt_PVGV */
 125     ArrayRef, /* SVt_PVAV */
 126     HashRef, /* SVt_PVHV */
 127     CodeRef, /* SVt_PVCV */
 128     Ref,
 129     ScalarRef,
 130     FileHandle, /* TODO */
 131     RegexpRef,
 132     Object,
 133     Role, /* TODO */
 134     ClassName
 135 } TC;
 136
 137 /* auxillary pointer/int union used for constraint checking */
 138 typedef union {
 139     TC type; /* the builtin type number for tc_type */
 140     SV *sv; /* the cv for tc_cv, or the stash for tc_stash */
 141     OP *op; /* TODO not used */
 142     bool (*fptr)(pTHX_ SV *type_constraint, SV *sv); /* the function pointer for tc_fptr  FIXME aux data? */
 143 } TC_CHECK;
 144
 145
 146
 147
 148
 149
 150 /* The folloing data structures deal with type default value generation */
 151
 152 /* This is an enum for the various types of default value behaviors an
 153  * attribute can have */
 154
 155 typedef enum {
 156     default_none = 0, /* no default value */
 157     default_normal, /* code reference or scalar */
 158     default_builder, /* builder method */
 159     default_type /* TODO enumerated type optimization (will call newHV, newAV etc to avoid calling a code ref for these simple cases) */
 160 } default_kind;
 161
 162 typedef union {
 163     SV *sv; /* The default value, or a code ref to generate one. If builder then this sv is applied as a method (stringified) */
 164     U32 type; /* TODO for default_type, should probably be one of SVt_PVAV/SVt_PVHV */
 165 } DEFAULT;
 166
 167
 168
 169
 170
 171
 172 /* the ATTR struct contains all the meta data for a Moose::Meta::Attribute for
 173  * a given meta instance
 174  *
 175  * flags determines the various behaviors
 176  *
 177  * This supports only one slot per attribute in the current implementation, but
 178  * slot_sv could contain an array
 179  *
 180  * A list of XSUBs that rely on this attr struct are cross indexed in the cvs
 181  * array, so that when the meta instance is destroyed the XSANY field will be
 182  * cleared. This is done in delete_mi
 183  * */
 184
 185 typedef struct {
 186     /* pointer to the MI this attribute is a part of the meta instance struct */
 187     struct mi *mi;
 188
 189     U32 flags; /* slot type, TC behavior, coerce, weaken, (no default | default, builder + lazy), auto_deref */
 190
 191     /* slot access fields */
 192     SV *slot_sv; /* value of the slot (currently always slot name) */
 193     U32 slot_u32; /* for optimized access (precomputed hash, possibly something else) */
 194
 195     SV *init_arg_sv;
 196     U32 init_arg_u32;
 197
 198     DEFAULT def; /* cv, value or other, depending on flags */
 199
 200     TC_CHECK tc_check; /* see TC_CHECK*/
 201     SV *type_constraint; /* Moose::Meta::TypeConstraint object */
 202
 203     CV *initializer; /* TODO */
 204     CV *trigger; /* TODO */
 205
 206     SV *meta_attr; /* the Moose::Meta::Attribute */
 207     AV *cvs; /* an array of CVs which use this attr, see delete_mi */
 208 } ATTR;
 209
 210 /* the flags integer is mapped as follows
 211  * instance     misc  reading  writing
 212  * 00000000 00000000 00000000 00000000
 213  *                                     writing
 214  *                             ^       trigger
 215  *                              ^      weak
 216  *                               ^     tc.sv is refcounted
 217  *                                 ^^^ tc_kind
 218  *                                ^    coerce
 219  *
 220  *                                     reading
 221  *                        ^^^          default_kind
 222  *                       ^             lazy
 223  *                      ^              def.sv is refcounted
 224  *
 225  *                                     misc
 226  *                 ^                   attr is required TODO
 227  *
 228  *                                     flags having to do with the instance layout (TODO, only hash supported for now)
 229  * ^^^^^^^                             if 0 then nothing special (just hash)? FIXME TBD
 230  */
 231
 232 #define ATTR_INSTANCE_MASK 0xff000000
 233 #define ATTR_READING_MASK  0x0000ff00
 234 #define ATTR_WRITING_MASK  0x000000ff
 235
 236 #define ATTR_MASK_TYPE 0x7
 237
 238 #define ATTR_MASK_DEFAULT 0x700
 239 #define ATTR_SHIFT_DEFAULT 8
 240
 241 #define ATTR_LAZY 0x800
 242 #define ATTR_DEFREFCNT 0x1000
 243
 244 #define ATTR_COERCE 0x8
 245 #define ATTR_TCREFCNT 0x10
 246 #define ATTR_WEAK 0x20
 247 #define ATTR_TRIGGER 0x40
 248
 249 #define ATTR_ISWEAK(attr) ( attr->flags & ATTR_WEAK )
 250 #define ATTR_ISLAZY(attr) ( attr->flags & ATTR_LAZY )
 251 #define ATTR_ISCOERCE(attr) ( attr->flags & ATTR_COERCE )
 252
 253 #define ATTR_TYPE(f) ( attr->flags & 0x7 )
 254 #define ATTR_DEFAULT(f) ( ( attr->flags & ATTR_MASK_DEFAULT ) >> ATTR_SHIFT_DEFAULT )
 255
 256 #define ATTR_DUMB_READER(attr) !ATTR_IS_LAZY(attr)
 257 #define ATTR_DUMB_WRITER(attr) ( ( attr->flags & ATTR_WRITING_MASK ) == 0 )
 258 #define ATTR_DUMB_INSTANCE(attr) ( ( attr->flags & ATTR_INSTANCE_MASK ) == 0 )
 259
 260
 261
 262 /* This unused (TODO) vtable will implement the meta instance protocol in terms
 263  * of function pointers to allow the XS accessors to be used with custom meta
 264  * instances in the future.
 265  *
 266  * We'll need to define a default instance of this vtable that uses call_sv,
 267  * too. */
 268
 269 /* FIXME define a vtable that does call_sv for fallback meta instance protocol */
 270 typedef struct {
 271     SV * (*get)(pTHX_ SV *self, ATTR *attr);
 272     void (*set)(pTHX_ SV *self, ATTR *attr, SV *value);
 273     bool * (*has)(pTHX_ SV *self, ATTR *attr);
 274     SV * (*delete)(pTHX_ SV *self, ATTR *attr);
 275 } instance_vtbl;
 276
 277 /* TODO this table describes the instance layout of the object. Not yet
 278  * implemented */
 279 typedef enum {
 280     hash = 0,
 281
 282     /* these are not yet implemented */
 283     array,
 284     fptr,
 285     cv,
 286     judy
 287 } instance_types;
 288
 289
 290 /* this struct models the meta instance *and* meta attributes simultaneously.
 291  * It is a cache of the meta attribute behaviors for a given class or subclass
 292  * and can be parametrized on that level
 293  *
 294  *
 295  * An object pointing to this structure is kept in a refcounted magic inside
 296  * the meta instance it corresponds to. On C<invalidate_meta_instance> the meta
 297  * instance is destroyed, causing the proxy object to be destroyed, deleting
 298  * this structure, clearing the XSANY of all dependent attribute methods.
 299  *
 300  * The next invocation of an attribute method will eventually call get_attr,
 301  * which will call C<get_meta_instance> on the metaclass (recreating it in the
 302  * Class::MOP level), and cache a new MI struct inside it. Subsequent
 303  * invocations of get_attr will then search the MI for an ATTR matching the
 304  * meta_attribute of the attribute method */
 305 typedef struct mi {
 306     HV *stash;
 307
 308     /* slot access method */
 309     instance_types type; /* TODO only hashes supported currently */
 310     instance_vtbl *vtbl; /* TODO */
 311
 312     /* attr descriptors */
 313     I32 num_attrs;
 314     ATTR *attrs;
 315 } MI;
 316
 317
 318
 319
 320
 321
 322
 323
 324 /* these functions implement type constraint checking */
 325
 326 /* checks that the SV is a scalar ref */
 327 STATIC bool check_is_scalar_ref(SV *sv) {
 328     if( SvROK(sv) ) {
 329         switch (SvTYPE(SvRV(sv))) {
 330             case SVt_IV:
 331             case SVt_NV:
 332             case SVt_PV:
 333             case SVt_NULL:
 334                 return 1;
 335                 break;
 336             default:
 337                 return 0;
 338         }
 339     }
 340     return 0;
 341 }
 342
 343 /* checks that the SV is a ref to a certain SvTYPE, where type is in the table
 344  * above */
 345 STATIC bool check_reftype(TC type, SV *sv) {
 346     int svt;
 347
 348     if ( !SvROK(sv) )
 349         return 0;
 350
 351     switch (type) {
 352         case GlobRef:
 353             svt = SVt_PVGV;
 354             break;
 355         case ArrayRef:
 356             svt = SVt_PVAV;
 357             break;
 358         case HashRef:
 359             svt = SVt_PVHV;
 360             break;
 361         case CodeRef:
 362             svt = SVt_PVCV;
 363             break;
 364         default:
 365             croak("not a reftype %d\n", type);
 366     }
 367
 368     return SvTYPE(SvRV(sv)) == svt;
 369 }
 370
 371 /* checks whether an SV is of a certain class
 372  * SvSTASH is first compared by pointer for efficiency */
 373 STATIC bool check_sv_class(pTHX_ HV *stash, SV *sv) {
 374     dSP;
 375     bool ret;
 376     SV *rv;
 377
 378     if (!sv)
 379         return 0;
 380     SvGETMAGIC(sv);
 381     if (!SvROK(sv))
 382         return 0;
 383     rv = (SV*)SvRV(sv);
 384     if (!SvOBJECT(rv))
 385         return 0;
 386     if (SvSTASH(rv) == stash)
 387         return 1;
 388
 389     ENTER;
 390     SAVETMPS;
 391     PUSHMARK(SP);
 392     XPUSHs(sv);
 393     XPUSHs(sv_2mortal(newSVpv(HvNAME_get(stash), 0)));
 394     PUTBACK;
 395
 396     call_method("isa", G_SCALAR);
 397
 398     SPAGAIN;
 399     ret = SvTRUE(TOPs);
 400
 401     FREETMPS;
 402     LEAVE;
 403
 404     return ret;
 405 }
 406
 407 /* checks whether SV of of a known simple type. Most of the non parametrized
 408  * Moose core types are implemented here */
 409 STATIC bool check_sv_type (TC type, SV *sv) {
 410     if (!sv)
 411         return 0;
 412
 413     SvGETMAGIC(sv);
 414
 415     switch (type) {
 416         case Any:
 417             return 1;
 418             break;
 419         case Undef:
 420             return !SvOK(sv);
 421             break;
 422         case Defined:
 423             return SvOK(sv);
 424             break;
 425         case Str:
 426             return (SvOK(sv) && !SvROK(sv));
 427         case Num:
 428 #if (PERL_VERSION < 8) || (PERL_VERSION == 8 && PERL_SUBVERSION <5)
 429             if (!SvPOK(sv) && !SvPOKp(sv))
 430                 return SvFLAGS(sv) & (SVf_NOK|SVp_NOK|SVf_IOK|SVp_IOK);
 431             else
 432 #endif
 433                 return looks_like_number(sv);
 434             break;
 435         case Int:
 436             if ( SvIOK(sv) ) {
 437                 return 1;
 438             } else if ( SvPOK(sv) ) {
 439                 STRLEN len;
 440                 char *pv = SvPV(sv, len);
 441                 int flags = grok_number(pv, len, NULL);
 442                 return ( flags && !(flags & IS_NUMBER_NOT_INT) );
 443             }
 444             return 0;
 445             break;
 446         case Ref:
 447             return SvROK(sv);
 448             break;
 449         case ScalarRef:
 450             return check_is_scalar_ref(sv);
 451             break;
 452         case ArrayRef:
 453         case HashRef:
 454         case CodeRef:
 455         case GlobRef:
 456             return check_reftype(type, sv);
 457             break;
 458         case RegexpRef:
 459         case Object:
 460             /* not using sv_isobject to avoid repeated get magic */
 461             if ( SvROK(sv) ) {
 462                 SV *rv = SvRV(sv);
 463                 if ( SvOBJECT(rv) ) {
 464                     char *name = HvNAME_get(SvSTASH(SvRV(sv)));
 465                     bool is_regexp = strEQ("Regexp", name);
 466                     return ( (type == RegexpRef) ^ !is_regexp );
 467                 }
 468             }
 469             return 0;
 470             break;
 471         case ClassName:
 472             if ( SvOK(sv) && !SvROK(sv) ) {
 473                 STRLEN len;
 474                 char *pv;
 475                 pv = SvPV(sv, len);
 476                 return ( gv_stashpvn(pv, len, 0) != NULL );
 477             }
 478             return 0;
 479             break;
 480         case FileHandle:
 481             croak("todo");
 482             break;
 483         default:
 484             croak("todo");
 485     }
 486
 487     return 0;
 488 }
 489
 490 /* invoke a CV on an SV and return SvTRUE of the result */
 491 STATIC bool check_sv_cv (pTHX_ SV *cv, SV *sv) {
 492     bool ret;
 493     dSP;
 494
 495     ENTER;
 496     SAVETMPS;
 497     PUSHMARK(SP);
 498     XPUSHs(sv);
 499     PUTBACK;
 500
 501     call_sv(cv, G_SCALAR);
 502
 503     SPAGAIN;
 504     ret = SvTRUE(POPs);
 505
 506     PUTBACK;
 507     FREETMPS;
 508     LEAVE;
 509
 510     return ret;
 511 }
 512
 513 /* checks the type constraint for an SV based on the type constraint kind */
 514 STATIC bool check_type_constraint(pTHX_ tc_kind kind, TC_CHECK tc_check, SV *type_constraint, SV *sv) {
 515     switch (kind) {
 516         case tc_none:
 517             return 1;
 518             break;
 519         case tc_type:
 520             return check_sv_type(tc_check.type, sv);
 521             break;
 522         case tc_stash:
 523             return check_sv_class(aTHX_ (HV *)tc_check.sv, sv);
 524             break;
 525         case tc_fptr:
 526             return tc_check.fptr(aTHX_ type_constraint, sv);
 527             break;
 528         case tc_cv:
 529             return check_sv_cv(aTHX_ tc_check.sv, sv);
 530             break;
 531         case tc_enum:
 532             croak("todo\n");
 533             break;
 534     }
 535
 536     croak("todo");
 537     return 0;
 538 }
 539
 540
 541 /* end of type constraint checking functions */
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551 /* Initialize the ATTR structure using positional arguments from Perl space. */
 552
 553 STATIC void init_attr (MI *mi, ATTR *attr, AV *desc) {
 554     U32 flags = 0;
 555     U32 slot_hash, init_arg_hash;
 556     STRLEN slot_len, init_arg_len;
 557     char *slot_pv, *init_arg_pv;
 558     I32 ix = av_len(desc);
 559     SV **params = AvARRAY(desc);
 560     SV *tc;
 561     SV *slot_sv;
 562     SV *init_arg_sv;
 563
 564     attr->mi = mi;
 565
 566     if ( ix != 13 )
 567         croak("wrong number of args (%d != 14)", (int)ix + 1);
 568
 569     for ( ; ix >= 0; ix-- ) {
 570         if ( !params[ix] || params[ix] == &PL_sv_undef )
 571             croak("bad params");
 572     }
 573
 574
 575
 576     /* handle attribute slot array */
 577
 578     if ( !SvROK(params[1]) || SvTYPE(SvRV(params[1])) != SVt_PVAV )
 579         croak("slots is not an array");
 580
 581     if ( av_len((AV *)SvRV(params[1])) != 0 )
 582         croak("Only unary slots are supported at the moment");
 583
 584     /* calculate a hash from the slot */
 585     /* FIXME arrays etc should also be supported */
 586     slot_sv = *av_fetch((AV *)SvRV(params[1]), 0, 0);
 587     slot_pv = SvPV(slot_sv, slot_len);
 588     PERL_HASH(slot_hash, slot_pv, slot_len);
 589
 590
 591     init_arg_sv = params[13];
 592     init_arg_pv = SvPV(init_arg_sv, init_arg_len);
 593     PERL_HASH(init_arg_hash, init_arg_pv, init_arg_len);
 594
 595
 596     /* FIXME better organize these, positionals suck */
 597     if ( SvTRUE(params[2]) )
 598         flags |= ATTR_WEAK;
 599
 600     if ( SvTRUE(params[3]) )
 601         flags |= ATTR_COERCE;
 602
 603     if ( SvTRUE(params[4]) )
 604         flags |= ATTR_LAZY;
 605
 606
 607
 608     /* type constraint data */
 609
 610     tc = params[5];
 611
 612     if ( SvOK(tc) ) {
 613         int tc_kind = SvIV(params[6]);
 614         SV *data = params[7];
 615
 616         switch (tc_kind) {
 617             case tc_type:
 618                 attr->tc_check.type = SvIV(data);
 619                 break;
 620             case tc_stash:
 621                 flags |= ATTR_TCREFCNT;
 622                 attr->tc_check.sv = (SV *)gv_stashsv(data, 0);
 623                 break;
 624             case tc_cv:
 625                 flags |= ATTR_TCREFCNT;
 626                 attr->tc_check.sv = SvRV(data);
 627                 if ( SvTYPE(attr->tc_check.sv) != SVt_PVCV )
 628                     croak("compiled type constraint is not a coderef");
 629                 break;
 630             default:
 631                 croak("todo");
 632         }
 633
 634         flags |= tc_kind;
 635     }
 636
 637
 638
 639     /* default/builder data */
 640
 641     if ( SvTRUE(params[10]) ) { /* has default */
 642         SV *sv = params[11];
 643
 644         if ( SvROK(sv) ) {
 645             attr->def.sv = SvRV(sv);
 646             if ( SvTYPE(attr->def.sv) != SVt_PVCV )
 647                 croak("compiled type constraint is not a coderef");
 648         } else {
 649             attr->def.sv = newSVsv(sv);
 650             sv_2mortal(attr->def.sv); /* in case of error soon, we refcnt inc it later after we're done checking params */
 651         }
 652
 653         flags |= ( ATTR_DEFREFCNT | ( default_normal << ATTR_SHIFT_DEFAULT ) );
 654     } else if ( SvOK(params[12]) ) { /* builder */
 655         attr->def.sv = newSVsv(params[12]);
 656         flags |= ( ATTR_DEFREFCNT | ( default_builder << ATTR_SHIFT_DEFAULT ) );
 657     }
 658
 659
 660
 661     attr->trigger = SvROK(params[6]) ? (CV *)SvRV(params[6]) : NULL;
 662     if ( attr->trigger && SvTYPE(attr->trigger) != SVt_PVCV )
 663         croak("trigger is not a coderef");
 664
 665     attr->initializer = SvROK(params[7]) ? (CV *)SvRV(params[7]) : NULL;
 666     if ( attr->initializer && SvTYPE(attr->initializer) != SVt_PVCV )
 667         croak("initializer is not a coderef");
 668
 669
 670
 671     /* now that we're done preparing/checking args and shit, so we finalize the
 672      * attr, increasing refcounts for any referenced data, and creating the CV
 673      * array */
 674
 675     attr->flags = flags;
 676
 677     /* copy the outer ref SV */
 678     attr->meta_attr       = newSVsv(params[0]);
 679     attr->type_constraint = newSVsv(tc);
 680
 681     /* increase the refcount for auxillary structures */
 682     SvREFCNT_inc_simple_void(attr->trigger);
 683     SvREFCNT_inc_simple_void(attr->initializer);
 684     if ( flags & ATTR_TCREFCNT )  SvREFCNT_inc_simple_void_NN(attr->tc_check.sv);
 685     if ( flags & ATTR_DEFREFCNT ) SvREFCNT_inc_simple_void_NN(attr->def.sv);
 686
 687     attr->slot_sv = newSVpvn_share(slot_pv, slot_len, slot_hash);
 688     attr->slot_u32 = slot_hash;
 689
 690     attr->init_arg_sv = newSVpvn_share(init_arg_pv, init_arg_len, init_arg_hash);
 691     attr->init_arg_u32 = init_arg_hash;
 692
 693     /* cross refs to CVs which use this struct */
 694     attr->cvs = newAV();
 695 }
 696
 697 STATIC SV *new_mi (pTHX_ HV *stash, AV *attrs) {
 698     HV *mi_stash = gv_stashpvs("Moose::XS::Meta::Instance",0);
 699     SV *sv_ptr = newSViv(0);
 700     SV *obj = sv_2mortal(sv_bless(newRV_noinc(sv_ptr), mi_stash));
 701     MI *mi;
 702     const I32 num_attrs = av_len(attrs) + 1;
 703
 704     Newxz(mi, 1, MI);
 705
 706     /* set the pointer now, if we have any initialization errors it'll get
 707      * cleaned up because obj is mortal */
 708     sv_setiv(sv_ptr, PTR2IV(mi));
 709
 710     Newxz(mi->attrs, num_attrs, ATTR);
 711
 712     SvREFCNT_inc_simple_void_NN(stash);
 713     mi->stash = stash;
 714
 715     mi->type = 0; /* nothing else implemented yet */
 716
 717     /* initialize attributes */
 718     for ( ; mi->num_attrs < num_attrs; mi->num_attrs++ ) {
 719         SV **desc = av_fetch(attrs, mi->num_attrs, 0);
 720
 721         if ( !desc || !*desc || !SvROK(*desc) || !(SvTYPE(SvRV(*desc)) == SVt_PVAV) ) {
 722             croak("Attribute descriptor has to be a hash reference");
 723         }
 724
 725         init_attr(mi, &mi->attrs[mi->num_attrs], (AV *)SvRV(*desc));
 726     }
 727
 728     return obj;
 729 }
 730
 731 STATIC void delete_attr (pTHX_ ATTR *attr) {
 732     I32 i;
 733     SV **cvs = AvARRAY(attr->cvs);
 734
 735     /* remove the pointers to this ATTR struct from all the the dependent CVs */
 736     for ( i = av_len(attr->cvs); i >= 0; i-- ) {
 737         CV *cv = (CV *)cvs[i];
 738         XSANY.any_i32 = 0;
 739     }
 740
 741     SvREFCNT_dec(attr->cvs);
 742     SvREFCNT_dec(attr->slot_sv);
 743     SvREFCNT_dec(attr->type_constraint);
 744     if ( attr->flags & ATTR_TCREFCNT )  SvREFCNT_dec(attr->tc_check.sv);
 745     if ( attr->flags & ATTR_DEFREFCNT ) SvREFCNT_dec(attr->def.sv);
 746     SvREFCNT_dec(attr->initializer);
 747     SvREFCNT_dec(attr->trigger);
 748     SvREFCNT_dec(attr->meta_attr);
 749 }
 750
 751 STATIC void delete_mi (pTHX_ MI *mi) {
 752     SvREFCNT_dec(mi->stash);
 753
 754     while ( mi->num_attrs--) {
 755         ATTR *attr = &mi->attrs[mi->num_attrs];
 756         delete_attr(aTHX_ attr);
 757     }
 758
 759     if ( mi->attrs ) Safefree(mi->attrs);
 760     Safefree(mi);
 761 }
 762
 763
 764
 765
 766 /* these functions call Perl-space for MOP methods, helpers etc */
 767
 768
 769 /* wow, so much code for the equivalent of
 770  * $attr->associated_class->get_meta_instance */
 771 STATIC SV *attr_to_meta_instance(pTHX_ SV *meta_attr) {
 772     dSP;
 773     SV *mi;
 774
 775     if ( !meta_attr )
 776         croak("No attr found in magic!");
 777
 778     ENTER;
 779     SAVETMPS;
 780     PUSHMARK(SP);
 781
 782     XPUSHs(meta_attr);
 783
 784     PUTBACK;
 785     call_pv("Moose::XS::attr_to_meta_instance", G_SCALAR);
 786
 787     SPAGAIN;
 788     mi = POPs;
 789
 790     SvREFCNT_inc_simple_void(mi);
 791
 792     PUTBACK;
 793     FREETMPS;
 794     LEAVE;
 795
 796     return sv_2mortal(mi);
 797 }
 798
 799 /* gets a class and an array of attr parameters */
 800 STATIC SV *perl_mi_to_c_mi(pTHX_ SV *perl_mi) {
 801     dSP;
 802     I32 count;
 803     SV *mi;
 804     SV *class;
 805     SV *attrs;
 806     HV *stash;
 807
 808     ENTER;
 809     SAVETMPS;
 810     PUSHMARK(SP);
 811
 812     XPUSHs(perl_mi);
 813
 814     PUTBACK;
 815     count = call_pv("Moose::XS::meta_instance_to_attr_descs", G_ARRAY);
 816
 817     if ( count != 2 )
 818         croak("meta_instance_to_attr_descs borked (%d args returned, expecting 2)", (int)count);
 819
 820     SPAGAIN;
 821     attrs = POPs;
 822     class = POPs;
 823
 824     PUTBACK;
 825
 826     stash = gv_stashsv(class, 0);
 827
 828     mi = new_mi(aTHX_ stash, (AV *)SvRV(attrs));
 829     SvREFCNT_inc_simple_void_NN(mi);
 830
 831     FREETMPS;
 832     LEAVE;
 833
 834     return sv_2mortal(mi);
 835 }
 836
 837
 838
 839 /* locate an ATTR for a MOP level attribute inside an MI */
 840 STATIC ATTR *mi_find_attr(SV *mi_obj, SV *meta_attr) {
 841     I32 ix;
 842     MI *mi = INT2PTR(MI *, SvIV(SvRV(mi_obj)));
 843
 844     for ( ix = 0; ix < mi->num_attrs; ix++ ) {
 845         if ( SvRV(mi->attrs[ix].meta_attr) == SvRV(meta_attr) ) {
 846             return &mi->attrs[ix];
 847         }
 848     }
 849
 850     croak("Attr %x not found in meta instance of %s", (unsigned int)PTR2UV(SvRV(meta_attr)) /* SvPV_force_nomg(sv_2mortal(newSVsv(meta_attr))) */, HvNAME_get(mi->stash) );
 851     return NULL;
 852 }
 853
 854 /* returns the ATTR for a CV:
 855  *
 856  * 1. get the Moose::Meta::Attribute using get_stashed_in_mg from the CV itself
 857  * 2. get the meta instance by calling $attr->associated_class->get_meta_instance
 858  * 3. get the MI by using get_stashed_in_mg from the meta instance, creating it if necessary
 859  * 4. search for the appropriate ATTR in the MI using mi_find_attr
 860  */
 861 STATIC ATTR *get_attr(pTHX_ CV *cv) {
 862     SV *meta_attr = get_stashed_in_mg(aTHX_ (SV *)cv);
 863     SV *perl_mi = attr_to_meta_instance(aTHX_ meta_attr);
 864     SV *mi_obj = get_stashed_in_mg(aTHX_ SvRV(perl_mi));
 865
 866     if (!mi_obj) {
 867         mi_obj = perl_mi_to_c_mi(aTHX_ perl_mi);
 868         stash_in_mg(aTHX_ SvRV(perl_mi), mi_obj);
 869     }
 870
 871     return mi_find_attr(mi_obj, meta_attr);
 872 }
 873
 874 /* Cache a pointer to the appropriate ATTR in the XSANY of the CV, using
 875  * get_attr */
 876 STATIC ATTR *define_attr (pTHX_ CV *cv) {
 877     ATTR *attr = get_attr(aTHX_ cv);
 878     assert(attr);
 879
 880     XSANY.any_i32 = PTR2IV(attr);
 881
 882     SvREFCNT_inc_simple_void(cv);
 883     av_push( attr->cvs, (SV *)cv );
 884
 885     return attr;
 886 }
 887
 888
 889
 890
 891
 892
 893
 894 STATIC void weaken(pTHX_ SV *sv) {
 895 #ifdef SvWEAKREF
 896         sv_rvweaken(sv); /* FIXME i think this might warn when weakening an already weak ref */
 897 #else
 898         croak("weak references are not implemented in this release of perl");
 899 #endif
 900 }
 901
 902
 903
 904
 905
 906
 907 /* meta instance protocol
 908  *
 909  * The slot functions don't change the refcount or copy (aliasing semantics)
 910  *
 911  * create_instance returns a new mortal */
 912
 913 STATIC SV *get_slot_lvalue(pTHX_ SV *self, ATTR *attr) {
 914     HE *he;
 915
 916     assert(self);
 917     assert(SvROK(self));
 918     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 919
 920     assert( ATTR_DUMB_INSTANCE(attr) );
 921
 922     if ((he = hv_fetch_ent((HV *)SvRV(self), attr->slot_sv, 0, attr->slot_u32)))
 923         return HeVAL(he);
 924     else
 925         return NULL;
 926 }
 927
 928 STATIC bool set_slot_value(pTHX_ SV *self, ATTR *attr, SV *value) {
 929     HE *he;
 930
 931     assert(self);
 932     assert(SvROK(self));
 933     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 934
 935     assert( ATTR_DUMB_INSTANCE(attr) );
 936
 937     he = hv_store_ent((HV*)SvRV(self), attr->slot_sv, value, attr->slot_u32);
 938
 939     return he != NULL;
 940 }
 941
 942 STATIC bool has_slot_value(pTHX_ SV *self, ATTR *attr) {
 943     assert(self);
 944     assert(SvROK(self));
 945     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 946
 947     assert( ATTR_DUMB_INSTANCE(attr) );
 948
 949     return hv_exists_ent((HV *)SvRV(self), attr->slot_sv, attr->slot_u32);
 950 }
 951
 952 STATIC SV *deinitialize_slot(pTHX_ SV *self, ATTR *attr) {
 953     assert(self);
 954     assert(SvROK(self));
 955     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 956
 957     assert( ATTR_DUMB_INSTANCE(attr) );
 958
 959     return hv_delete_ent((HV *)SvRV(self), attr->slot_sv, 0, attr->slot_u32);
 960 }
 961
 962 STATIC SV *create_instance(pTHX_ MI *mi) {
 963     return sv_bless(sv_2mortal(newRV_noinc((SV *)newHV())), mi->stash);
 964 }
 965
 966
 967
 968
 969 /* Shared functionality for readers/writers/accessors, this roughly corresponds
 970  * to the methods of Moose::Meta::Attribute on the instance
 971  * (get_value/set_value, default value handling, etc)
 972  *
 973  * These functions return mortal copiess and save copies (handling refcounting). */
 974
 975 STATIC void attr_set_value(pTHX_ SV *self, ATTR *attr, SV *value);
 976
 977 STATIC SV *call_builder (pTHX_ SV *self, ATTR *attr) {
 978     SV *sv;
 979     dSP;
 980
 981     ENTER;
 982     SAVETMPS;
 983     PUSHMARK(SP);
 984
 985     XPUSHs(self);
 986
 987     /* we invoke the builder as a stringified method. This will not work for
 988      * $obj->$coderef etc, for that we need to use 'default' */
 989     PUTBACK;
 990     call_method(SvPV_nolen(attr->def.sv), G_SCALAR);
 991
 992     /* the value is a mortal with a refcount of 1, so we need to keep it around */
 993     SPAGAIN;
 994     sv = POPs;
 995     SvREFCNT_inc_simple_void(sv);
 996
 997     PUTBACK;
 998     FREETMPS;
 999     LEAVE;
1000
1001     return sv_2mortal(sv);
1002 }
1003
1004
1005 STATIC SV *get_default(pTHX_ SV *self, ATTR *attr) {
1006     switch ( ATTR_DEFAULT(attr) ) {
1007         case default_none:
1008             return NULL;
1009             break;
1010         case default_builder:
1011             return call_builder(aTHX_ self, attr);
1012             break;
1013         case default_normal:
1014             if ( SvROK(attr->def.sv) ) {
1015                 printf("CV default\n");
1016                 croak("todo");
1017             } else {
1018                 printf("simple value\n");
1019                 return sv_mortalcopy(attr->def.sv); /* will be copied by set for lazy, and by reader for both cases */
1020             }
1021             break;
1022         case default_type:
1023             croak("todo");
1024             break;
1025     }
1026
1027     return NULL;
1028 }
1029
1030 /* $attr->get_value($self), will vivify lazy values if needed
1031  * returns an alias to the sv that is copied in the reader/writer/accessor code
1032  * */
1033 STATIC SV *attr_get_value(pTHX_ SV *self, ATTR *attr) {
1034     SV *value = get_slot_lvalue(aTHX_ self, attr);
1035
1036     if ( value ) {
1037         return sv_mortalcopy(value);
1038     } else if ( ATTR_ISLAZY(attr) ) {
1039         value = get_default(aTHX_ self, attr);
1040         attr_set_value(aTHX_ self, attr, value);
1041         return value;
1042     }
1043
1044     return NULL;
1045 }
1046
1047 /* $attr->set_value($self) */
1048 STATIC void attr_set_value(pTHX_ SV *self, ATTR *attr, SV *value) {
1049     SV *copy;
1050
1051     if ( !value ) {
1052         /* FIXME croak if required ? */
1053         return;
1054     }
1055
1056     if ( ATTR_TYPE(attr) ) {
1057         if ( !check_type_constraint(aTHX_ ATTR_TYPE(attr), attr->tc_check, attr->type_constraint, value) )
1058             croak("Bad param");
1059     }
1060
1061     copy = newSVsv(value);
1062
1063     if ( ATTR_ISWEAK(attr) && SvROK(copy) )
1064         weaken(aTHX_ copy);
1065
1066     if ( !set_slot_value(aTHX_ self, attr, copy) ) {
1067         SvREFCNT_dec(copy);
1068         croak("Hash store failed.");
1069     }
1070 }
1071
1072
1073
1074
1075
1076
1077
1078 /* Perl-space level functionality
1079  *
1080  * These subs are installed by new_sub's various aliases as the bodies of the
1081  * new XSUBs
1082  * */
1083
1084
1085
1086 /* This macro is used in the XS subs to set up the 'attr' variable.
1087  *
1088  * if XSANY is NULL then define_attr is called on the CV, to set the pointer
1089  * to the ATTR struct.
1090  * */
1091 #define dATTR ATTR *attr = (XSANY.any_i32 ? INT2PTR(ATTR *, (XSANY.any_i32)) : define_attr(aTHX_ cv))
1092
1093
1094 STATIC XS(reader);
1095 STATIC XS(reader)
1096 {
1097 #ifdef dVAR
1098     dVAR;
1099 #endif
1100     dXSARGS;
1101     dATTR;
1102     SV *value;
1103
1104     if (items != 1)
1105         Perl_croak(aTHX_ "Usage: %s(%s)", GvNAME(CvGV(cv)), "self");
1106
1107     SP -= items;
1108
1109     value = attr_get_value(aTHX_ ST(0), attr);
1110
1111     if (value) {
1112         ST(0) = value;
1113         XSRETURN(1);
1114     } else {
1115         XSRETURN_UNDEF;
1116     }
1117 }
1118
1119 STATIC XS(writer);
1120 STATIC XS(writer)
1121 {
1122 #ifdef dVAR
1123     dVAR;
1124 #endif
1125     dXSARGS;
1126     dATTR;
1127
1128     if (items != 2)
1129         Perl_croak(aTHX_ "Usage: %s(%s, %s)", GvNAME(CvGV(cv)), "self", "value");
1130
1131     SP -= items;
1132
1133     attr_set_value(aTHX_ ST(0), attr, ST(1));
1134
1135     ST(0) = ST(1); /* return value */
1136     XSRETURN(1);
1137 }
1138
1139 STATIC XS(accessor);
1140 STATIC XS(accessor)
1141 {
1142 #ifdef dVAR
1143     dVAR;
1144 #endif
1145     dXSARGS;
1146     dATTR;
1147
1148     if (items < 1)
1149         Perl_croak(aTHX_ "Usage: %s(%s, [ %s ])", GvNAME(CvGV(cv)), "self", "value");
1150
1151     SP -= items;
1152
1153     if (items > 1) {
1154         attr_set_value(aTHX_ ST(0), attr, ST(1));
1155         ST(0) = ST(1); /* return value */
1156     } else {
1157         SV *value = attr_get_value(aTHX_ ST(0), attr);
1158         if ( value ) {
1159             ST(0) = value;
1160         } else {
1161             XSRETURN_UNDEF;
1162         }
1163     }
1164
1165     XSRETURN(1);
1166 }
1167
1168 STATIC XS(predicate);
1169 STATIC XS(predicate)
1170 {
1171 #ifdef dVAR
1172     dVAR;
1173 #endif
1174     dXSARGS;
1175     dATTR;
1176
1177     if (items != 1)
1178         Perl_croak(aTHX_ "Usage: %s(%s)", GvNAME(CvGV(cv)), "self");
1179
1180     SP -= items;
1181
1182     if ( has_slot_value(aTHX_ ST(0), attr) )
1183         XSRETURN_YES;
1184     else
1185         XSRETURN_NO;
1186 }
1187
1188 enum xs_body {
1189     xs_body_reader = 0,
1190     xs_body_writer,
1191     xs_body_accessor,
1192     xs_body_predicate,
1193     max_xs_body
1194 };
1195
1196 STATIC XSPROTO ((*xs_bodies[])) = {
1197     reader,
1198     writer,
1199     accessor,
1200     predicate,
1201 };
1202
1203 MODULE = Moose PACKAGE = Moose::XS
1204 PROTOTYPES: ENABLE
1205
1206 CV *
1207 new_sub(attr, name)
1208     INPUT:
1209         SV *attr;
1210         SV *name;
1211     PROTOTYPE: $;$
1212     ALIAS:
1213         new_reader    = xs_body_reader
1214         new_writer    = xs_body_writer
1215         new_accessor  = xs_body_accessor
1216         new_predicate = xs_body_predicate
1217     PREINIT:
1218         CV * cv;
1219     CODE:
1220         if ( ix >= max_xs_body )
1221             croak("Unknown Moose::XS body type");
1222
1223         if ( !sv_isobject(attr) )
1224             croak("'attr' must be a Moose::Meta::Attribute");
1225
1226         cv = newXS(SvOK(name) ? SvPV_nolen(name) : NULL, xs_bodies[ix], __FILE__);
1227
1228         if (cv == NULL)
1229             croak("Oi vey!");
1230
1231         /* associate CV with meta attr */
1232         stash_in_mg(aTHX_ (SV *)cv, attr);
1233
1234         /* this will be set on first call */
1235         XSANY.any_i32 = 0;
1236
1237         RETVAL = cv;
1238     OUTPUT:
1239         RETVAL
1240
1241
1242 MODULE = Moose  PACKAGE = Moose::XS::Meta::Instance
1243 PROTOTYPES: DISABLE
1244
1245 void
1246 DESTROY(self)
1247     INPUT:
1248         SV *self;
1249     PREINIT:
1250         MI *mi = INT2PTR(MI *, SvIV(SvRV(self)));
1251     CODE:
1252         if ( mi )
1253             delete_mi(aTHX_ mi);
1254
1255
1256 MODULE = Moose  PACKAGE = Moose::XS::TypeConstraints
1257 PROTOTYPES: ENABLE
1258
1259 bool
1260 _check_type(sv)
1261     INPUT:
1262         SV* sv
1263     ALIAS:
1264         Any = Any
1265         Item = Any
1266         Bool = Any
1267         Undef = Undef
1268         Defined = Defined
1269         Str = Str
1270         Value = Str
1271         Num = Num
1272         Int = Int
1273         GlobRef = GlobRef
1274         ArrayRef = ArrayRef
1275         HashRef = HashRef
1276         CodeRef = CodeRef
1277         Ref = Ref
1278         ScalarRef = ScalarRef
1279         FileHandle = FileHandle
1280         RegexpRef = RegexpRef
1281         Object = Object
1282         Role = Role
1283         ClassName = ClassName
1284     CODE:
1285         RETVAL = check_sv_type(ix, sv);
1286     OUTPUT:
1287         RETVAL
1288
1289 bool
1290 ObjectOfType(sv, class)
1291     INPUT:
1292         SV* sv
1293         SV* class
1294     PREINIT:
1295         HV *stash = gv_stashsv(class, 0);
1296     CODE:
1297         RETVAL = check_sv_class(aTHX_ stash, sv);
1298     OUTPUT:
1299         RETVAL