Stash.xs

   1 #include "EXTERN.h"
   2 #include "perl.h"
   3 #include "XSUB.h"
   4
   5 #define NEED_newRV_noinc
   6 #define NEED_sv_2pv_flags
   7 #include "ppport.h"
   8
   9 #ifndef gv_fetchsv
  10 #define gv_fetchsv(n,f,t) gv_fetchpv(SvPV_nolen(n), f, t)
  11 #endif
  12
  13 #ifndef mro_method_changed_in
  14 #define mro_method_changed_in(x) PL_sub_generation++
  15 #endif
  16
  17 #ifdef newSVhek
  18 #define newSVhe(he) newSVhek(HeKEY_hek(he))
  19 #else
  20 #define newSVhe(he) newSVpv(HePV(he, PL_na), 0)
  21 #endif
  22
  23 #ifndef savesvpv
  24 #define savesvpv(s) savepv(SvPV_nolen(s))
  25 #endif
  26
  27 /* HACK: scalar slots are always populated on perl < 5.10, so treat undef
  28  * as nonexistent. this is consistent with the previous behavior of the pure
  29  * perl version of this module (since this is the behavior that perl sees
  30  * in all versions */
  31 #if PERL_VERSION < 10
  32 #define GvSVOK(g) (GvSV(g) && SvTYPE(GvSV(g)) != SVt_NULL)
  33 #else
  34 #define GvSVOK(g) GvSV(g)
  35 #endif
  36
  37 #define GvAVOK(g) GvAV(g)
  38 #define GvHVOK(g) GvHV(g)
  39 #define GvCVOK(g) GvCVu(g) /* XXX: should this really be GvCVu? or GvCV? */
  40 #define GvIOOK(g) GvIO(g)
  41
  42 /* see above - don't let scalar slots become unpopulated, this breaks
  43  * assumptions in core */
  44 #if PERL_VERSION < 10
  45 #define GvSetSV(g,v) do {               \
  46     SV *_v = (SV*)(v);                  \
  47     SvREFCNT_dec(GvSV(g));              \
  48     if ((GvSV(g) = _v ? _v : newSV(0))) \
  49         GvIMPORTED_SV_on(g);            \
  50 } while (0)
  51 #else
  52 #define GvSetSV(g,v) do {               \
  53     SvREFCNT_dec(GvSV(g));              \
  54     if ((GvSV(g) = (SV*)(v)))           \
  55         GvIMPORTED_SV_on(g);            \
  56 } while (0)
  57 #endif
  58
  59 #define GvSetAV(g,v) do {               \
  60     SvREFCNT_dec(GvAV(g));              \
  61     if ((GvAV(g) = (AV*)(v)))           \
  62         GvIMPORTED_AV_on(g);            \
  63 } while (0)
  64 #define GvSetHV(g,v) do {               \
  65     SvREFCNT_dec(GvHV(g));              \
  66     if ((GvHV(g) = (HV*)(v)))           \
  67         GvIMPORTED_HV_on(g);            \
  68 } while (0)
  69 #define GvSetCV(g,v) do {               \
  70     SvREFCNT_dec(GvCV(g));              \
  71     if ((GvCV(g) = (CV*)(v))) {         \
  72         GvIMPORTED_CV_on(g);            \
  73         GvASSUMECV_on(g);               \
  74     }                                   \
  75     GvCVGEN(g) = 0;                     \
  76     mro_method_changed_in(GvSTASH(g));  \
  77 } while (0)
  78 #define GvSetIO(g,v) do {               \
  79     SvREFCNT_dec(GvIO(g));              \
  80     GvIOp(g) = (IO*)(v);                \
  81 } while (0)
  82
  83 /* XXX: the core implementation of caller() is private, so we need a
  84  * a reimplementation. luckily, padwalker already has done this. rafl says
  85  * that there should be a public interface in 5.14, so maybe look into
  86  * converting to use that at some point */
  87 #include "stolen_bits_of_padwalker.c"
  88
  89 typedef enum {
  90     VAR_NONE = 0,
  91     VAR_SCALAR,
  92     VAR_ARRAY,
  93     VAR_HASH,
  94     VAR_CODE,
  95     VAR_IO,
  96     VAR_GLOB,  /* TODO: unimplemented */
  97     VAR_FORMAT /* TODO: unimplemented */
  98 } vartype_t;
  99
 100 typedef struct {
 101     vartype_t type;
 102     char *name;
 103 } varspec_t;
 104
 105 static U32 name_hash, namespace_hash, type_hash;
 106 static SV *name_key, *namespace_key, *type_key;
 107
 108 const char *vartype_to_string(vartype_t type)
 109 {
 110     switch (type) {
 111     case VAR_SCALAR:
 112         return "SCALAR";
 113     case VAR_ARRAY:
 114         return "ARRAY";
 115     case VAR_HASH:
 116         return "HASH";
 117     case VAR_CODE:
 118         return "CODE";
 119     case VAR_IO:
 120         return "IO";
 121     default:
 122         return "unknown";
 123     }
 124 }
 125
 126 I32 vartype_to_svtype(vartype_t type)
 127 {
 128     switch (type) {
 129     case VAR_SCALAR:
 130         return SVt_PV; /* or whatever */
 131     case VAR_ARRAY:
 132         return SVt_PVAV;
 133     case VAR_HASH:
 134         return SVt_PVHV;
 135     case VAR_CODE:
 136         return SVt_PVCV;
 137     case VAR_IO:
 138         return SVt_PVIO;
 139     default:
 140         return SVt_NULL;
 141     }
 142 }
 143
 144 vartype_t string_to_vartype(char *vartype)
 145 {
 146     if (strEQ(vartype, "SCALAR")) {
 147         return VAR_SCALAR;
 148     }
 149     else if (strEQ(vartype, "ARRAY")) {
 150         return VAR_ARRAY;
 151     }
 152     else if (strEQ(vartype, "HASH")) {
 153         return VAR_HASH;
 154     }
 155     else if (strEQ(vartype, "CODE")) {
 156         return VAR_CODE;
 157     }
 158     else if (strEQ(vartype, "IO")) {
 159         return VAR_IO;
 160     }
 161     else {
 162         croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO'");
 163     }
 164 }
 165
 166 void _deconstruct_variable_name(char *variable, varspec_t *varspec)
 167 {
 168     if (!variable || !variable[0])
 169         croak("You must pass a variable name");
 170
 171     varspec->type = VAR_NONE;
 172
 173     switch (variable[0]) {
 174     case '$':
 175         varspec->type = VAR_SCALAR;
 176         break;
 177     case '@':
 178         varspec->type = VAR_ARRAY;
 179         break;
 180     case '%':
 181         varspec->type = VAR_HASH;
 182         break;
 183     case '&':
 184         varspec->type = VAR_CODE;
 185         break;
 186     }
 187
 188     if (varspec->type != VAR_NONE) {
 189         varspec->name = &variable[1];
 190     }
 191     else {
 192         varspec->type = VAR_IO;
 193         varspec->name = variable;
 194     }
 195 }
 196
 197 void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
 198 {
 199     HE *val;
 200     char *valpv;
 201     STRLEN len;
 202
 203     val = hv_fetch_ent(variable, name_key, 0, name_hash);
 204     if (!val)
 205         croak("The 'name' key is required in variable specs");
 206
 207     valpv = HePV(val, len);
 208     varspec->name = savepvn(valpv, len);
 209     SAVEFREEPV(varspec->name);
 210
 211     val = hv_fetch_ent(variable, type_key, 0, type_hash);
 212     if (!val)
 213         croak("The 'type' key is required in variable specs");
 214
 215     valpv = HePV(val, len);
 216     varspec->type = string_to_vartype(valpv);
 217 }
 218
 219 int _valid_for_type(SV *value, vartype_t type)
 220 {
 221     svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
 222
 223     switch (type) {
 224     case VAR_SCALAR:
 225         return sv_type == SVt_NULL ||
 226                sv_type == SVt_IV   ||
 227                sv_type == SVt_NV   ||
 228                sv_type == SVt_PV   ||
 229                sv_type == SVt_RV;
 230     case VAR_ARRAY:
 231         return sv_type == SVt_PVAV;
 232     case VAR_HASH:
 233         return sv_type == SVt_PVHV;
 234     case VAR_CODE:
 235         return sv_type == SVt_PVCV;
 236     case VAR_IO:
 237         return sv_type == SVt_PVIO;
 238     default:
 239         return 0;
 240     }
 241 }
 242
 243 HV *_get_namespace(SV *self)
 244 {
 245     dSP;
 246     SV *ret;
 247
 248     PUSHMARK(SP);
 249     XPUSHs(self);
 250     PUTBACK;
 251
 252     call_method("namespace", G_SCALAR);
 253
 254     SPAGAIN;
 255     ret = POPs;
 256     PUTBACK;
 257
 258     return (HV*)SvRV(ret);
 259 }
 260
 261 SV *_get_name(SV *self)
 262 {
 263     dSP;
 264     SV *ret;
 265
 266     PUSHMARK(SP);
 267     XPUSHs(self);
 268     PUTBACK;
 269
 270     call_method("name", G_SCALAR);
 271
 272     SPAGAIN;
 273     ret = POPs;
 274     PUTBACK;
 275
 276     return ret;
 277 }
 278
 279 SV *_get_symbol(SV *self, varspec_t *variable, int vivify)
 280 {
 281     HV *namespace;
 282     SV **entry;
 283     GV *glob;
 284
 285     namespace = _get_namespace(self);
 286     entry = hv_fetch(namespace, variable->name, strlen(variable->name), vivify);
 287     if (!entry)
 288         return NULL;
 289
 290     glob = (GV*)(*entry);
 291     if (!isGV(glob)) {
 292         SV *namesv;
 293
 294         namesv = newSVsv(_get_name(self));
 295         sv_catpvs(namesv, "::");
 296         sv_catpv(namesv, variable->name);
 297
 298         /* can't use gv_init here, because it screws up @ISA in a way that I
 299          * can't reproduce, but that CMOP triggers */
 300         gv_fetchsv(namesv, GV_ADD, vartype_to_svtype(variable->type));
 301         SvREFCNT_dec(namesv);
 302     }
 303
 304     if (vivify) {
 305         switch (variable->type) {
 306         case VAR_SCALAR:
 307             if (!GvSVOK(glob))
 308                 GvSetSV(glob, newSV(0));
 309             break;
 310         case VAR_ARRAY:
 311             if (!GvAVOK(glob))
 312                 GvSetAV(glob, newAV());
 313             break;
 314         case VAR_HASH:
 315             if (!GvHVOK(glob))
 316                 GvSetHV(glob, newHV());
 317             break;
 318         case VAR_CODE:
 319             croak("Don't know how to vivify CODE variables");
 320         case VAR_IO:
 321             if (!GvIOOK(glob))
 322                 GvSetIO(glob, newIO());
 323             break;
 324         default:
 325             croak("Unknown type in vivication");
 326         }
 327     }
 328
 329     switch (variable->type) {
 330     case VAR_SCALAR:
 331         return GvSV(glob);
 332     case VAR_ARRAY:
 333         return (SV*)GvAV(glob);
 334     case VAR_HASH:
 335         return (SV*)GvHV(glob);
 336     case VAR_CODE:
 337         return (SV*)GvCV(glob);
 338     case VAR_IO:
 339         return (SV*)GvIO(glob);
 340     default:
 341         return NULL;
 342     }
 343 }
 344
 345 MODULE = Package::Stash  PACKAGE = Package::Stash
 346
 347 PROTOTYPES: DISABLE
 348
 349 SV*
 350 new(class, package_name)
 351     char *class
 352     SV *package_name
 353   PREINIT:
 354     HV *instance;
 355     HV *namespace;
 356     SV *nsref;
 357   CODE:
 358     if (!SvPOK(package_name))
 359         croak("The constructor argument must be the name of a package");
 360
 361     instance = newHV();
 362
 363     if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package_name), 0)) {
 364         SvREFCNT_dec(package_name);
 365         SvREFCNT_dec(instance);
 366         croak("Couldn't initialize the 'name' key, hv_store failed");
 367     }
 368     namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
 369     nsref = newRV_inc((SV*)namespace);
 370     if (!hv_store(instance, "namespace", 9, nsref, 0)) {
 371         SvREFCNT_dec(nsref);
 372         SvREFCNT_dec(instance);
 373         croak("Couldn't initialize the 'namespace' key, hv_store failed");
 374     }
 375
 376     RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashpv(class, 0));
 377   OUTPUT:
 378     RETVAL
 379
 380 SV*
 381 name(self)
 382     SV *self
 383   PREINIT:
 384     HE *slot;
 385   CODE:
 386     if (!sv_isobject(self))
 387         croak("Can't call name as a class method");
 388     slot = hv_fetch_ent((HV*)SvRV(self), name_key, 0, name_hash);
 389     RETVAL = slot ? SvREFCNT_inc_simple_NN(HeVAL(slot)) : &PL_sv_undef;
 390   OUTPUT:
 391     RETVAL
 392
 393 SV*
 394 namespace(self)
 395     SV *self
 396   PREINIT:
 397     HE *slot;
 398   CODE:
 399     if (!sv_isobject(self))
 400         croak("Can't call namespace as a class method");
 401     slot = hv_fetch_ent((HV*)SvRV(self), namespace_key, 0, namespace_hash);
 402     RETVAL = slot ? SvREFCNT_inc_simple_NN(HeVAL(slot)) : &PL_sv_undef;
 403   OUTPUT:
 404     RETVAL
 405
 406 void
 407 add_symbol(self, variable, initial=NULL, ...)
 408     SV *self
 409     varspec_t variable
 410     SV *initial
 411   PREINIT:
 412     SV *name;
 413     GV *glob;
 414   CODE:
 415     if (initial && !_valid_for_type(initial, variable.type))
 416         croak("%s is not of type %s",
 417               SvPV_nolen(initial), vartype_to_string(variable.type));
 418
 419     name = newSVsv(_get_name(self));
 420     sv_catpvs(name, "::");
 421     sv_catpv(name, variable.name);
 422
 423     if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
 424         int i;
 425         char *filename = NULL, *namepv;
 426         I32 first_line_num = -1, last_line_num = -1;
 427         STRLEN namelen;
 428         SV *dbval;
 429         HV *dbsub;
 430
 431         if ((items - 3) % 2)
 432             croak("add_symbol: Odd number of elements in %%opts");
 433
 434         for (i = 3; i < items; i += 2) {
 435             char *key;
 436             key = SvPV_nolen(ST(i));
 437             if (strEQ(key, "filename")) {
 438                 if (!SvPOK(ST(i + 1)))
 439                     croak("add_symbol: filename must be a string");
 440                 filename = SvPV_nolen(ST(i + 1));
 441             }
 442             else if (strEQ(key, "first_line_num")) {
 443                 if (!SvIOK(ST(i + 1)))
 444                     croak("add_symbol: first_line_num must be an integer");
 445                 first_line_num = SvIV(ST(i + 1));
 446             }
 447             else if (strEQ(key, "last_line_num")) {
 448                 if (!SvIOK(ST(i + 1)))
 449                     croak("add_symbol: last_line_num must be an integer");
 450                 last_line_num = SvIV(ST(i + 1));
 451             }
 452         }
 453
 454         if (!filename || first_line_num == -1) {
 455             I32 cxix_from, cxix_to;
 456             PERL_CONTEXT *cx, *ccstack;
 457             COP *cop = NULL;
 458
 459             cx = upcontext(0, &cop, &ccstack, &cxix_from, &cxix_to);
 460             if (!cop)
 461                 cop = PL_curcop;
 462
 463             if (!filename)
 464                 filename = CopFILE(cop);
 465             if (first_line_num == -1)
 466                 first_line_num = cop->cop_line;
 467         }
 468
 469         if (last_line_num == -1)
 470             last_line_num = first_line_num;
 471
 472         /* http://perldoc.perl.org/perldebguts.html#Debugger-Internals */
 473         dbsub = get_hv("DB::sub", 1);
 474         dbval = newSVpvf("%s:%d-%d", filename, first_line_num, last_line_num);
 475         namepv = SvPV(name, namelen);
 476         if (!hv_store(dbsub, namepv, namelen, dbval, 0)) {
 477             warn("Failed to update $DB::sub for subroutine %s", namepv);
 478             SvREFCNT_dec(dbval);
 479         }
 480     }
 481
 482     /* GV_ADDMULTI rather than GV_ADD because otherwise you get 'used only
 483      * once' warnings in some situations... i can't reproduce this, but CMOP
 484      * triggers it */
 485     glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
 486
 487     if (initial) {
 488         SV *val;
 489
 490         if (SvROK(initial)) {
 491             val = SvRV(initial);
 492             SvREFCNT_inc_simple_void_NN(val);
 493         }
 494         else {
 495             val = newSVsv(initial);
 496         }
 497
 498         switch (variable.type) {
 499         case VAR_SCALAR:
 500             GvSetSV(glob, val);
 501             break;
 502         case VAR_ARRAY:
 503             GvSetAV(glob, val);
 504             break;
 505         case VAR_HASH:
 506             GvSetHV(glob, val);
 507             break;
 508         case VAR_CODE:
 509             GvSetCV(glob, val);
 510             break;
 511         case VAR_IO:
 512             GvSetIO(glob, val);
 513             break;
 514         }
 515     }
 516
 517     SvREFCNT_dec(name);
 518
 519 void
 520 remove_glob(self, name)
 521     SV *self
 522     char *name
 523   CODE:
 524     hv_delete(_get_namespace(self), name, strlen(name), G_DISCARD);
 525
 526 int
 527 has_symbol(self, variable)
 528     SV *self
 529     varspec_t variable
 530   PREINIT:
 531     HV *namespace;
 532     SV **entry;
 533   CODE:
 534     namespace = _get_namespace(self);
 535     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 536     if (!entry)
 537         XSRETURN_UNDEF;
 538
 539     if (isGV(*entry)) {
 540         GV *glob = (GV*)(*entry);
 541         switch (variable.type) {
 542         case VAR_SCALAR:
 543             RETVAL = GvSVOK(glob) ? 1 : 0;
 544             break;
 545         case VAR_ARRAY:
 546             RETVAL = GvAVOK(glob) ? 1 : 0;
 547             break;
 548         case VAR_HASH:
 549             RETVAL = GvHVOK(glob) ? 1 : 0;
 550             break;
 551         case VAR_CODE:
 552             RETVAL = GvCVOK(glob) ? 1 : 0;
 553             break;
 554         case VAR_IO:
 555             RETVAL = GvIOOK(glob) ? 1 : 0;
 556             break;
 557         }
 558     }
 559     else {
 560         RETVAL = (variable.type == VAR_CODE);
 561     }
 562   OUTPUT:
 563     RETVAL
 564
 565 SV*
 566 get_symbol(self, variable)
 567     SV *self
 568     varspec_t variable
 569   PREINIT:
 570     SV *val;
 571   CODE:
 572     val = _get_symbol(self, &variable, 0);
 573     if (!val)
 574         XSRETURN_UNDEF;
 575     RETVAL = newRV_inc(val);
 576   OUTPUT:
 577     RETVAL
 578
 579 SV*
 580 get_or_add_symbol(self, variable)
 581     SV *self
 582     varspec_t variable
 583   PREINIT:
 584     SV *val;
 585   CODE:
 586     val = _get_symbol(self, &variable, 1);
 587     if (!val)
 588         XSRETURN_UNDEF;
 589     RETVAL = newRV_inc(val);
 590   OUTPUT:
 591     RETVAL
 592
 593 void
 594 remove_symbol(self, variable)
 595     SV *self
 596     varspec_t variable
 597   PREINIT:
 598     HV *namespace;
 599     SV **entry;
 600   CODE:
 601     namespace = _get_namespace(self);
 602     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 603     if (!entry)
 604         XSRETURN_EMPTY;
 605
 606     if (isGV(*entry)) {
 607         GV *glob = (GV*)(*entry);
 608         switch (variable.type) {
 609         case VAR_SCALAR:
 610             GvSetSV(glob, NULL);
 611             break;
 612         case VAR_ARRAY:
 613             GvSetAV(glob, NULL);
 614             break;
 615         case VAR_HASH:
 616             GvSetHV(glob, NULL);
 617             break;
 618         case VAR_CODE:
 619             GvSetCV(glob, NULL);
 620             break;
 621         case VAR_IO:
 622             GvSetIO(glob, NULL);
 623             break;
 624         }
 625     }
 626     else {
 627         if (variable.type == VAR_CODE) {
 628             hv_delete(namespace, variable.name, strlen(variable.name), G_DISCARD);
 629         }
 630     }
 631
 632 void
 633 list_all_symbols(self, vartype=VAR_NONE)
 634     SV *self
 635     vartype_t vartype
 636   PPCODE:
 637     if (vartype == VAR_NONE) {
 638         HV *namespace;
 639         HE *entry;
 640         int keys;
 641
 642         namespace = _get_namespace(self);
 643         keys = hv_iterinit(namespace);
 644         EXTEND(SP, keys);
 645         while ((entry = hv_iternext(namespace))) {
 646             mPUSHs(newSVhe(entry));
 647         }
 648     }
 649     else {
 650         HV *namespace;
 651         SV *val;
 652         char *key;
 653         int len;
 654
 655         namespace = _get_namespace(self);
 656         hv_iterinit(namespace);
 657         while ((val = hv_iternextsv(namespace, &key, &len))) {
 658             GV *gv = (GV*)val;
 659             if (isGV(gv)) {
 660                 switch (vartype) {
 661                 case VAR_SCALAR:
 662                     if (GvSVOK(val))
 663                         mXPUSHp(key, len);
 664                     break;
 665                 case VAR_ARRAY:
 666                     if (GvAVOK(val))
 667                         mXPUSHp(key, len);
 668                     break;
 669                 case VAR_HASH:
 670                     if (GvHVOK(val))
 671                         mXPUSHp(key, len);
 672                     break;
 673                 case VAR_CODE:
 674                     if (GvCVOK(val))
 675                         mXPUSHp(key, len);
 676                     break;
 677                 case VAR_IO:
 678                     if (GvIOOK(val))
 679                         mXPUSHp(key, len);
 680                     break;
 681                 }
 682             }
 683             else if (vartype == VAR_CODE) {
 684                 mXPUSHp(key, len);
 685             }
 686         }
 687     }
 688
 689 BOOT:
 690     {
 691         name_key = newSVpvs("name");
 692         PERL_HASH(name_hash, "name", 4);
 693
 694         namespace_key = newSVpvs("namespace");
 695         PERL_HASH(namespace_hash, "namespace", 9);
 696
 697         type_key = newSVpvs("type");
 698         PERL_HASH(type_hash, "type", 4);
 699     }