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                     if ( name ) {
 466                         bool is_regexp = strEQ("Regexp", name);
 467                         return ( (type == RegexpRef) ^ !is_regexp );
 468                     }
 469                 }
 470             }
 471             return 0;
 472             break;
 473         case ClassName:
 474             if ( SvOK(sv) && !SvROK(sv) ) {
 475                 STRLEN len;
 476                 char *pv;
 477                 pv = SvPV(sv, len);
 478                 return ( gv_stashpvn(pv, len, 0) != NULL );
 479             }
 480             return 0;
 481             break;
 482         case FileHandle:
 483             croak("todo");
 484             break;
 485         default:
 486             croak("todo");
 487     }
 488
 489     return 0;
 490 }
 491
 492 /* invoke a CV on an SV and return SvTRUE of the result */
 493 STATIC bool check_sv_cv (pTHX_ SV *cv, SV *sv) {
 494     bool ret;
 495     dSP;
 496
 497     ENTER;
 498     SAVETMPS;
 499     PUSHMARK(SP);
 500     XPUSHs(sv);
 501     PUTBACK;
 502
 503     call_sv(cv, G_SCALAR);
 504
 505     SPAGAIN;
 506     ret = SvTRUE(POPs);
 507
 508     PUTBACK;
 509     FREETMPS;
 510     LEAVE;
 511
 512     return ret;
 513 }
 514
 515 /* checks the type constraint for an SV based on the type constraint kind */
 516 STATIC bool check_type_constraint(pTHX_ tc_kind kind, TC_CHECK tc_check, SV *type_constraint, SV *sv) {
 517     switch (kind) {
 518         case tc_none:
 519             return 1;
 520             break;
 521         case tc_type:
 522             return check_sv_type(tc_check.type, sv);
 523             break;
 524         case tc_stash:
 525             return check_sv_class(aTHX_ (HV *)tc_check.sv, sv);
 526             break;
 527         case tc_fptr:
 528             return tc_check.fptr(aTHX_ type_constraint, sv);
 529             break;
 530         case tc_cv:
 531             return check_sv_cv(aTHX_ tc_check.sv, sv);
 532             break;
 533         case tc_enum:
 534             croak("todo\n");
 535             break;
 536     }
 537
 538     croak("todo");
 539     return 0;
 540 }
 541
 542
 543 /* end of type constraint checking functions */
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553 /* Initialize the ATTR structure using positional arguments from Perl space. */
 554
 555 STATIC void init_attr (MI *mi, ATTR *attr, AV *desc) {
 556     U32 flags = 0;
 557     U32 slot_hash, init_arg_hash;
 558     STRLEN slot_len, init_arg_len;
 559     char *slot_pv, *init_arg_pv;
 560     I32 ix = av_len(desc);
 561     SV **params = AvARRAY(desc);
 562     SV *tc;
 563     SV *slot_sv;
 564     SV *init_arg_sv;
 565
 566     attr->mi = mi;
 567
 568     if ( ix != 13 )
 569         croak("wrong number of args (%d != 14)", (int)ix + 1);
 570
 571     for ( ; ix >= 0; ix-- ) {
 572         if ( !params[ix] || params[ix] == &PL_sv_undef )
 573             croak("bad params");
 574     }
 575
 576
 577
 578     /* handle attribute slot array */
 579
 580     if ( !SvROK(params[1]) || SvTYPE(SvRV(params[1])) != SVt_PVAV )
 581         croak("slots is not an array");
 582
 583     if ( av_len((AV *)SvRV(params[1])) != 0 )
 584         croak("Only unary slots are supported at the moment");
 585
 586     /* calculate a hash from the slot */
 587     /* FIXME arrays etc should also be supported */
 588     slot_sv = *av_fetch((AV *)SvRV(params[1]), 0, 0);
 589     slot_pv = SvPV(slot_sv, slot_len);
 590     PERL_HASH(slot_hash, slot_pv, slot_len);
 591
 592
 593     init_arg_sv = params[13];
 594     init_arg_pv = SvPV(init_arg_sv, init_arg_len);
 595     PERL_HASH(init_arg_hash, init_arg_pv, init_arg_len);
 596
 597
 598     /* FIXME better organize these, positionals suck */
 599     if ( SvTRUE(params[2]) )
 600         flags |= ATTR_WEAK;
 601
 602     if ( SvTRUE(params[3]) )
 603         flags |= ATTR_COERCE;
 604
 605     if ( SvTRUE(params[4]) )
 606         flags |= ATTR_LAZY;
 607
 608
 609
 610     /* type constraint data */
 611
 612     tc = params[5];
 613
 614     if ( SvOK(tc) ) {
 615         int tc_kind = SvIV(params[6]);
 616         SV *data = params[7];
 617
 618         switch (tc_kind) {
 619             case tc_type:
 620                 attr->tc_check.type = SvIV(data);
 621                 break;
 622             case tc_stash:
 623                 flags |= ATTR_TCREFCNT;
 624                 attr->tc_check.sv = (SV *)gv_stashsv(data, 0);
 625                 break;
 626             case tc_cv:
 627                 flags |= ATTR_TCREFCNT;
 628                 attr->tc_check.sv = SvRV(data);
 629                 if ( SvTYPE(attr->tc_check.sv) != SVt_PVCV )
 630                     croak("compiled type constraint is not a coderef");
 631                 break;
 632             default:
 633                 croak("todo");
 634         }
 635
 636         flags |= tc_kind;
 637     }
 638
 639
 640
 641     /* default/builder data */
 642
 643     if ( SvTRUE(params[10]) ) { /* has default */
 644         SV *sv = params[11];
 645
 646         if ( SvROK(sv) ) {
 647             attr->def.sv = SvRV(sv);
 648             if ( SvTYPE(attr->def.sv) != SVt_PVCV )
 649                 croak("compiled type constraint is not a coderef");
 650         } else {
 651             attr->def.sv = newSVsv(sv);
 652             sv_2mortal(attr->def.sv); /* in case of error soon, we refcnt inc it later after we're done checking params */
 653         }
 654
 655         flags |= ( ATTR_DEFREFCNT | ( default_normal << ATTR_SHIFT_DEFAULT ) );
 656     } else if ( SvOK(params[12]) ) { /* builder */
 657         attr->def.sv = newSVsv(params[12]);
 658         flags |= ( ATTR_DEFREFCNT | ( default_builder << ATTR_SHIFT_DEFAULT ) );
 659     }
 660
 661
 662
 663     attr->trigger = SvROK(params[6]) ? (CV *)SvRV(params[6]) : NULL;
 664     if ( attr->trigger && SvTYPE(attr->trigger) != SVt_PVCV )
 665         croak("trigger is not a coderef");
 666
 667     attr->initializer = SvROK(params[7]) ? (CV *)SvRV(params[7]) : NULL;
 668     if ( attr->initializer && SvTYPE(attr->initializer) != SVt_PVCV )
 669         croak("initializer is not a coderef");
 670
 671
 672
 673     /* now that we're done preparing/checking args and shit, so we finalize the
 674      * attr, increasing refcounts for any referenced data, and creating the CV
 675      * array */
 676
 677     attr->flags = flags;
 678
 679     /* copy the outer ref SV */
 680     attr->meta_attr       = newSVsv(params[0]);
 681     attr->type_constraint = newSVsv(tc);
 682
 683     /* increase the refcount for auxillary structures */
 684     SvREFCNT_inc_simple_void(attr->trigger);
 685     SvREFCNT_inc_simple_void(attr->initializer);
 686     if ( flags & ATTR_TCREFCNT )  SvREFCNT_inc_simple_void_NN(attr->tc_check.sv);
 687     if ( flags & ATTR_DEFREFCNT ) SvREFCNT_inc_simple_void_NN(attr->def.sv);
 688
 689     attr->slot_sv = newSVpvn_share(slot_pv, slot_len, slot_hash);
 690     attr->slot_u32 = slot_hash;
 691
 692     attr->init_arg_sv = newSVpvn_share(init_arg_pv, init_arg_len, init_arg_hash);
 693     attr->init_arg_u32 = init_arg_hash;
 694
 695     /* cross refs to CVs which use this struct */
 696     attr->cvs = newAV();
 697 }
 698
 699 STATIC SV *new_mi (pTHX_ HV *stash, AV *attrs) {
 700     HV *mi_stash = gv_stashpvs("Moose::XS::Meta::Instance",0);
 701     SV *sv_ptr = newSViv(0);
 702     SV *obj = sv_2mortal(sv_bless(newRV_noinc(sv_ptr), mi_stash));
 703     MI *mi;
 704     const I32 num_attrs = av_len(attrs) + 1;
 705
 706     Newxz(mi, 1, MI);
 707
 708     /* set the pointer now, if we have any initialization errors it'll get
 709      * cleaned up because obj is mortal */
 710     sv_setiv(sv_ptr, PTR2IV(mi));
 711
 712     Newxz(mi->attrs, num_attrs, ATTR);
 713
 714     SvREFCNT_inc_simple_void_NN(stash);
 715     mi->stash = stash;
 716
 717     mi->type = 0; /* nothing else implemented yet */
 718
 719     /* initialize attributes */
 720     for ( ; mi->num_attrs < num_attrs; mi->num_attrs++ ) {
 721         SV **desc = av_fetch(attrs, mi->num_attrs, 0);
 722
 723         if ( !desc || !*desc || !SvROK(*desc) || !(SvTYPE(SvRV(*desc)) == SVt_PVAV) ) {
 724             croak("Attribute descriptor has to be a hash reference");
 725         }
 726
 727         init_attr(mi, &mi->attrs[mi->num_attrs], (AV *)SvRV(*desc));
 728     }
 729
 730     return obj;
 731 }
 732
 733 STATIC void delete_attr (pTHX_ ATTR *attr) {
 734     I32 i;
 735     SV **cvs = AvARRAY(attr->cvs);
 736
 737     /* remove the pointers to this ATTR struct from all the the dependent CVs */
 738     for ( i = av_len(attr->cvs); i >= 0; i-- ) {
 739         CV *cv = (CV *)cvs[i];
 740         XSANY.any_i32 = 0;
 741     }
 742
 743     SvREFCNT_dec(attr->cvs);
 744     SvREFCNT_dec(attr->slot_sv);
 745     SvREFCNT_dec(attr->type_constraint);
 746     if ( attr->flags & ATTR_TCREFCNT )  SvREFCNT_dec(attr->tc_check.sv);
 747     if ( attr->flags & ATTR_DEFREFCNT ) SvREFCNT_dec(attr->def.sv);
 748     SvREFCNT_dec(attr->initializer);
 749     SvREFCNT_dec(attr->trigger);
 750     SvREFCNT_dec(attr->meta_attr);
 751 }
 752
 753 STATIC void delete_mi (pTHX_ MI *mi) {
 754     SvREFCNT_dec(mi->stash);
 755
 756     while ( mi->num_attrs--) {
 757         ATTR *attr = &mi->attrs[mi->num_attrs];
 758         delete_attr(aTHX_ attr);
 759     }
 760
 761     if ( mi->attrs ) Safefree(mi->attrs);
 762     Safefree(mi);
 763 }
 764
 765
 766
 767
 768 /* these functions call Perl-space for MOP methods, helpers etc */
 769
 770
 771 /* wow, so much code for the equivalent of
 772  * $attr->associated_class->get_meta_instance */
 773 STATIC SV *attr_to_meta_instance(pTHX_ SV *meta_attr) {
 774     dSP;
 775     SV *mi;
 776
 777     if ( !meta_attr )
 778         croak("No attr found in magic!");
 779
 780     ENTER;
 781     SAVETMPS;
 782     PUSHMARK(SP);
 783
 784     XPUSHs(meta_attr);
 785
 786     PUTBACK;
 787     call_pv("Moose::XS::attr_to_meta_instance", G_SCALAR);
 788
 789     SPAGAIN;
 790     mi = POPs;
 791
 792     SvREFCNT_inc_simple_void(mi);
 793
 794     PUTBACK;
 795     FREETMPS;
 796     LEAVE;
 797
 798     return sv_2mortal(mi);
 799 }
 800
 801 /* gets a class and an array of attr parameters */
 802 STATIC SV *perl_mi_to_c_mi(pTHX_ SV *perl_mi) {
 803     dSP;
 804     I32 count;
 805     SV *mi;
 806     SV *class;
 807     SV *attrs;
 808     HV *stash;
 809
 810     ENTER;
 811     SAVETMPS;
 812     PUSHMARK(SP);
 813
 814     XPUSHs(perl_mi);
 815
 816     PUTBACK;
 817     count = call_pv("Moose::XS::meta_instance_to_attr_descs", G_ARRAY);
 818
 819     if ( count != 2 )
 820         croak("meta_instance_to_attr_descs borked (%d args returned, expecting 2)", (int)count);
 821
 822     SPAGAIN;
 823     attrs = POPs;
 824     class = POPs;
 825
 826     PUTBACK;
 827
 828     stash = gv_stashsv(class, 0);
 829
 830     mi = new_mi(aTHX_ stash, (AV *)SvRV(attrs));
 831     SvREFCNT_inc_simple_void_NN(mi);
 832
 833     FREETMPS;
 834     LEAVE;
 835
 836     return sv_2mortal(mi);
 837 }
 838
 839
 840
 841 /* locate an ATTR for a MOP level attribute inside an MI */
 842 STATIC ATTR *mi_find_attr(SV *mi_obj, SV *meta_attr) {
 843     I32 ix;
 844     MI *mi = INT2PTR(MI *, SvIV(SvRV(mi_obj)));
 845
 846     for ( ix = 0; ix < mi->num_attrs; ix++ ) {
 847         if ( SvRV(mi->attrs[ix].meta_attr) == SvRV(meta_attr) ) {
 848             return &mi->attrs[ix];
 849         }
 850     }
 851
 852     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) );
 853     return NULL;
 854 }
 855
 856 /* returns the ATTR for a CV:
 857  *
 858  * 1. get the Moose::Meta::Attribute using get_stashed_in_mg from the CV itself
 859  * 2. get the meta instance by calling $attr->associated_class->get_meta_instance
 860  * 3. get the MI by using get_stashed_in_mg from the meta instance, creating it if necessary
 861  * 4. search for the appropriate ATTR in the MI using mi_find_attr
 862  */
 863 STATIC ATTR *get_attr(pTHX_ CV *cv) {
 864     SV *meta_attr = get_stashed_in_mg(aTHX_ (SV *)cv);
 865     SV *perl_mi = attr_to_meta_instance(aTHX_ meta_attr);
 866     SV *mi_obj = get_stashed_in_mg(aTHX_ SvRV(perl_mi));
 867
 868     if (!mi_obj) {
 869         mi_obj = perl_mi_to_c_mi(aTHX_ perl_mi);
 870         stash_in_mg(aTHX_ SvRV(perl_mi), mi_obj);
 871     }
 872
 873     return mi_find_attr(mi_obj, meta_attr);
 874 }
 875
 876 /* Cache a pointer to the appropriate ATTR in the XSANY of the CV, using
 877  * get_attr */
 878 STATIC ATTR *define_attr (pTHX_ CV *cv) {
 879     ATTR *attr = get_attr(aTHX_ cv);
 880     assert(attr);
 881
 882     XSANY.any_i32 = PTR2IV(attr);
 883
 884     SvREFCNT_inc_simple_void(cv);
 885     av_push( attr->cvs, (SV *)cv );
 886
 887     return attr;
 888 }
 889
 890
 891
 892
 893
 894
 895
 896 STATIC void weaken(pTHX_ SV *sv) {
 897 #ifdef SvWEAKREF
 898         sv_rvweaken(sv); /* FIXME i think this might warn when weakening an already weak ref */
 899 #else
 900         croak("weak references are not implemented in this release of perl");
 901 #endif
 902 }
 903
 904
 905
 906
 907
 908
 909 /* meta instance protocol
 910  *
 911  * The slot functions don't change the refcount or copy (aliasing semantics)
 912  *
 913  * create_instance returns a new mortal */
 914
 915 STATIC SV *get_slot_lvalue(pTHX_ SV *self, ATTR *attr) {
 916     HE *he;
 917
 918     assert(self);
 919     assert(SvROK(self));
 920     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 921
 922     assert( ATTR_DUMB_INSTANCE(attr) );
 923
 924     if ((he = hv_fetch_ent((HV *)SvRV(self), attr->slot_sv, 0, attr->slot_u32)))
 925         return HeVAL(he);
 926     else
 927         return NULL;
 928 }
 929
 930 STATIC bool set_slot_value(pTHX_ SV *self, ATTR *attr, SV *value) {
 931     HE *he;
 932
 933     assert(self);
 934     assert(SvROK(self));
 935     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 936
 937     assert( ATTR_DUMB_INSTANCE(attr) );
 938
 939     he = hv_store_ent((HV*)SvRV(self), attr->slot_sv, value, attr->slot_u32);
 940
 941     return he != NULL;
 942 }
 943
 944 STATIC bool has_slot_value(pTHX_ SV *self, ATTR *attr) {
 945     assert(self);
 946     assert(SvROK(self));
 947     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 948
 949     assert( ATTR_DUMB_INSTANCE(attr) );
 950
 951     return hv_exists_ent((HV *)SvRV(self), attr->slot_sv, attr->slot_u32);
 952 }
 953
 954 STATIC SV *deinitialize_slot(pTHX_ SV *self, ATTR *attr) {
 955     assert(self);
 956     assert(SvROK(self));
 957     assert(SvTYPE(SvRV(self)) == SVt_PVHV);
 958
 959     assert( ATTR_DUMB_INSTANCE(attr) );
 960
 961     return hv_delete_ent((HV *)SvRV(self), attr->slot_sv, 0, attr->slot_u32);
 962 }
 963
 964 STATIC SV *create_instance(pTHX_ MI *mi) {
 965     return sv_bless(sv_2mortal(newRV_noinc((SV *)newHV())), mi->stash);
 966 }
 967
 968
 969
 970
 971 /* Shared functionality for readers/writers/accessors, this roughly corresponds
 972  * to the methods of Moose::Meta::Attribute on the instance
 973  * (get_value/set_value, default value handling, etc)
 974  *
 975  * These functions return mortal copiess and save copies (handling refcounting). */
 976
 977 STATIC void attr_set_value(pTHX_ SV *self, ATTR *attr, SV *value);
 978
 979 STATIC SV *call_builder (pTHX_ SV *self, ATTR *attr) {
 980     SV *sv;
 981     dSP;
 982
 983     ENTER;
 984     SAVETMPS;
 985     PUSHMARK(SP);
 986
 987     XPUSHs(self);
 988
 989     /* we invoke the builder as a stringified method. This will not work for
 990      * $obj->$coderef etc, for that we need to use 'default' */
 991     PUTBACK;
 992     call_method(SvPV_nolen(attr->def.sv), G_SCALAR);
 993
 994     /* the value is a mortal with a refcount of 1, so we need to keep it around */
 995     SPAGAIN;
 996     sv = POPs;
 997     SvREFCNT_inc_simple_void(sv);
 998
 999     PUTBACK;
1000     FREETMPS;
1001     LEAVE;
1002
1003     return sv_2mortal(sv);
1004 }
1005
1006
1007 STATIC SV *get_default(pTHX_ SV *self, ATTR *attr) {
1008     switch ( ATTR_DEFAULT(attr) ) {
1009         case default_none:
1010             return NULL;
1011             break;
1012         case default_builder:
1013             return call_builder(aTHX_ self, attr);
1014             break;
1015         case default_normal:
1016             if ( SvROK(attr->def.sv) ) {
1017                 printf("CV default\n");
1018                 croak("todo");
1019             } else {
1020                 printf("simple value\n");
1021                 return sv_mortalcopy(attr->def.sv); /* will be copied by set for lazy, and by reader for both cases */
1022             }
1023             break;
1024         case default_type:
1025             croak("todo");
1026             break;
1027     }
1028
1029     return NULL;
1030 }
1031
1032 /* $attr->get_value($self), will vivify lazy values if needed
1033  * returns an alias to the sv that is copied in the reader/writer/accessor code
1034  * */
1035 STATIC SV *attr_get_value(pTHX_ SV *self, ATTR *attr) {
1036     SV *value = get_slot_lvalue(aTHX_ self, attr);
1037
1038     if ( value ) {
1039         return sv_mortalcopy(value);
1040     } else if ( ATTR_ISLAZY(attr) ) {
1041         value = get_default(aTHX_ self, attr);
1042         attr_set_value(aTHX_ self, attr, value);
1043         return value;
1044     }
1045
1046     return NULL;
1047 }
1048
1049 /* $attr->set_value($self) */
1050 STATIC void attr_set_value(pTHX_ SV *self, ATTR *attr, SV *value) {
1051     SV *copy;
1052
1053     if ( !value ) {
1054         /* FIXME croak if required ? */
1055         return;
1056     }
1057
1058     if ( ATTR_TYPE(attr) ) {
1059         if ( !check_type_constraint(aTHX_ ATTR_TYPE(attr), attr->tc_check, attr->type_constraint, value) )
1060             croak("Bad param");
1061     }
1062
1063     copy = newSVsv(value);
1064
1065     if ( ATTR_ISWEAK(attr) && SvROK(copy) )
1066         weaken(aTHX_ copy);
1067
1068     if ( !set_slot_value(aTHX_ self, attr, copy) ) {
1069         SvREFCNT_dec(copy);
1070         croak("Hash store failed.");
1071     }
1072 }
1073
1074
1075
1076
1077
1078
1079
1080 /* Perl-space level functionality
1081  *
1082  * These subs are installed by new_sub's various aliases as the bodies of the
1083  * new XSUBs
1084  * */
1085
1086
1087
1088 /* This macro is used in the XS subs to set up the 'attr' variable.
1089  *
1090  * if XSANY is NULL then define_attr is called on the CV, to set the pointer
1091  * to the ATTR struct.
1092  * */
1093 #define dATTR ATTR *attr = (XSANY.any_i32 ? INT2PTR(ATTR *, (XSANY.any_i32)) : define_attr(aTHX_ cv))
1094
1095
1096 STATIC XS(reader);
1097 STATIC XS(reader)
1098 {
1099 #ifdef dVAR
1100     dVAR;
1101 #endif
1102     dXSARGS;
1103     dATTR;
1104     SV *value;
1105
1106     if (items != 1)
1107         Perl_croak(aTHX_ "Usage: %s(%s)", GvNAME(CvGV(cv)), "self");
1108
1109     SP -= items;
1110
1111     value = attr_get_value(aTHX_ ST(0), attr);
1112
1113     if (value) {
1114         ST(0) = value;
1115         XSRETURN(1);
1116     } else {
1117         XSRETURN_UNDEF;
1118     }
1119 }
1120
1121 STATIC XS(writer);
1122 STATIC XS(writer)
1123 {
1124 #ifdef dVAR
1125     dVAR;
1126 #endif
1127     dXSARGS;
1128     dATTR;
1129
1130     if (items != 2)
1131         Perl_croak(aTHX_ "Usage: %s(%s, %s)", GvNAME(CvGV(cv)), "self", "value");
1132
1133     SP -= items;
1134
1135     attr_set_value(aTHX_ ST(0), attr, ST(1));
1136
1137     ST(0) = ST(1); /* return value */
1138     XSRETURN(1);
1139 }
1140
1141 STATIC XS(accessor);
1142 STATIC XS(accessor)
1143 {
1144 #ifdef dVAR
1145     dVAR;
1146 #endif
1147     dXSARGS;
1148     dATTR;
1149
1150     if (items < 1)
1151         Perl_croak(aTHX_ "Usage: %s(%s, [ %s ])", GvNAME(CvGV(cv)), "self", "value");
1152
1153     SP -= items;
1154
1155     if (items > 1) {
1156         attr_set_value(aTHX_ ST(0), attr, ST(1));
1157         ST(0) = ST(1); /* return value */
1158     } else {
1159         SV *value = attr_get_value(aTHX_ ST(0), attr);
1160         if ( value ) {
1161             ST(0) = value;
1162         } else {
1163             XSRETURN_UNDEF;
1164         }
1165     }
1166
1167     XSRETURN(1);
1168 }
1169
1170 STATIC XS(predicate);
1171 STATIC XS(predicate)
1172 {
1173 #ifdef dVAR
1174     dVAR;
1175 #endif
1176     dXSARGS;
1177     dATTR;
1178
1179     if (items != 1)
1180         Perl_croak(aTHX_ "Usage: %s(%s)", GvNAME(CvGV(cv)), "self");
1181
1182     SP -= items;
1183
1184     if ( has_slot_value(aTHX_ ST(0), attr) )
1185         XSRETURN_YES;
1186     else
1187         XSRETURN_NO;
1188 }
1189
1190 enum xs_body {
1191     xs_body_reader = 0,
1192     xs_body_writer,
1193     xs_body_accessor,
1194     xs_body_predicate,
1195     max_xs_body
1196 };
1197
1198 STATIC XSPROTO ((*xs_bodies[])) = {
1199     reader,
1200     writer,
1201     accessor,
1202     predicate,
1203 };
1204
1205 MODULE = Moose PACKAGE = Moose::XS
1206 PROTOTYPES: ENABLE
1207
1208 CV *
1209 new_sub(attr, name)
1210     INPUT:
1211         SV *attr;
1212         SV *name;
1213     PROTOTYPE: $;$
1214     ALIAS:
1215         new_reader    = xs_body_reader
1216         new_writer    = xs_body_writer
1217         new_accessor  = xs_body_accessor
1218         new_predicate = xs_body_predicate
1219     PREINIT:
1220         CV * cv;
1221     CODE:
1222         if ( ix >= max_xs_body )
1223             croak("Unknown Moose::XS body type");
1224
1225         if ( !sv_isobject(attr) )
1226             croak("'attr' must be a Moose::Meta::Attribute");
1227
1228         cv = newXS(SvOK(name) ? SvPV_nolen(name) : NULL, xs_bodies[ix], __FILE__);
1229
1230         if (cv == NULL)
1231             croak("Oi vey!");
1232
1233         /* associate CV with meta attr */
1234         stash_in_mg(aTHX_ (SV *)cv, attr);
1235
1236         /* this will be set on first call */
1237         XSANY.any_i32 = 0;
1238
1239         RETVAL = cv;
1240     OUTPUT:
1241         RETVAL
1242
1243
1244 MODULE = Moose  PACKAGE = Moose::XS::Meta::Instance
1245 PROTOTYPES: DISABLE
1246
1247 void
1248 DESTROY(self)
1249     INPUT:
1250         SV *self;
1251     PREINIT:
1252         MI *mi = INT2PTR(MI *, SvIV(SvRV(self)));
1253     CODE:
1254         if ( mi )
1255             delete_mi(aTHX_ mi);
1256
1257
1258 MODULE = Moose  PACKAGE = Moose::XS::TypeConstraints
1259 PROTOTYPES: ENABLE
1260
1261 bool
1262 _check_type(sv)
1263     INPUT:
1264         SV* sv
1265     ALIAS:
1266         Any = Any
1267         Item = Any
1268         Bool = Any
1269         Undef = Undef
1270         Defined = Defined
1271         Str = Str
1272         Value = Str
1273         Num = Num
1274         Int = Int
1275         GlobRef = GlobRef
1276         ArrayRef = ArrayRef
1277         HashRef = HashRef
1278         CodeRef = CodeRef
1279         Ref = Ref
1280         ScalarRef = ScalarRef
1281         FileHandle = FileHandle
1282         RegexpRef = RegexpRef
1283         Object = Object
1284         Role = Role
1285         ClassName = ClassName
1286     CODE:
1287         RETVAL = check_sv_type(ix, sv);
1288     OUTPUT:
1289         RETVAL
1290
1291 bool
1292 ObjectOfType(sv, class)
1293     INPUT:
1294         SV* sv
1295         SV* class
1296     PREINIT:
1297         HV *stash = gv_stashsv(class, 0);
1298     CODE:
1299         RETVAL = check_sv_class(aTHX_ stash, sv);
1300     OUTPUT:
1301         RETVAL