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 typedef enum {
  84     VAR_NONE = 0,
  85     VAR_SCALAR,
  86     VAR_ARRAY,
  87     VAR_HASH,
  88     VAR_CODE,
  89     VAR_IO,
  90     VAR_GLOB,  /* TODO: unimplemented */
  91     VAR_FORMAT /* TODO: unimplemented */
  92 } vartype_t;
  93
  94 typedef struct {
  95     vartype_t type;
  96     char sigil;
  97     char *name;
  98 } varspec_t;
  99
 100 const char *vartype_to_string(vartype_t type)
 101 {
 102     switch (type) {
 103     case VAR_SCALAR:
 104         return "SCALAR";
 105     case VAR_ARRAY:
 106         return "ARRAY";
 107     case VAR_HASH:
 108         return "HASH";
 109     case VAR_CODE:
 110         return "CODE";
 111     case VAR_IO:
 112         return "IO";
 113     default:
 114         return "unknown";
 115     }
 116 }
 117
 118 I32 vartype_to_svtype(vartype_t type)
 119 {
 120     switch (type) {
 121     case VAR_SCALAR:
 122         return SVt_PV; /* or whatever */
 123     case VAR_ARRAY:
 124         return SVt_PVAV;
 125     case VAR_HASH:
 126         return SVt_PVHV;
 127     case VAR_CODE:
 128         return SVt_PVCV;
 129     case VAR_IO:
 130         return SVt_PVIO;
 131     default:
 132         return SVt_NULL;
 133     }
 134 }
 135
 136 vartype_t string_to_vartype(char *vartype)
 137 {
 138     if (strEQ(vartype, "SCALAR")) {
 139         return VAR_SCALAR;
 140     }
 141     else if (strEQ(vartype, "ARRAY")) {
 142         return VAR_ARRAY;
 143     }
 144     else if (strEQ(vartype, "HASH")) {
 145         return VAR_HASH;
 146     }
 147     else if (strEQ(vartype, "CODE")) {
 148         return VAR_CODE;
 149     }
 150     else if (strEQ(vartype, "IO")) {
 151         return VAR_IO;
 152     }
 153     else {
 154         croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO'");
 155     }
 156 }
 157
 158 void _deconstruct_variable_name(char *variable, varspec_t *varspec)
 159 {
 160     if (!variable || !variable[0])
 161         croak("You must pass a variable name");
 162
 163     varspec->type = VAR_NONE;
 164
 165     switch (variable[0]) {
 166     case '$':
 167         varspec->type = VAR_SCALAR;
 168         break;
 169     case '@':
 170         varspec->type = VAR_ARRAY;
 171         break;
 172     case '%':
 173         varspec->type = VAR_HASH;
 174         break;
 175     case '&':
 176         varspec->type = VAR_CODE;
 177         break;
 178     }
 179
 180     if (varspec->type != VAR_NONE) {
 181         varspec->sigil = variable[0];
 182         varspec->name = &variable[1];
 183     }
 184     else {
 185         varspec->type = VAR_IO;
 186         varspec->sigil = '\0';
 187         varspec->name = variable;
 188     }
 189 }
 190
 191 void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
 192 {
 193     SV **val;
 194
 195     val = hv_fetch(variable, "name", 4, 0);
 196     if (!val)
 197         croak("The 'name' key is required in variable specs");
 198
 199     varspec->name = savesvpv(*val);
 200     SAVEFREEPV(varspec->name);
 201
 202     val = hv_fetch(variable, "sigil", 5, 0);
 203     if (!val)
 204         croak("The 'sigil' key is required in variable specs");
 205
 206     varspec->sigil = (SvPV_nolen(*val))[0];
 207
 208     val = hv_fetch(variable, "type", 4, 0);
 209     if (!val)
 210         croak("The 'type' key is required in variable specs");
 211
 212     varspec->type = string_to_vartype(SvPV_nolen(*val));
 213 }
 214
 215 int _valid_for_type(SV *value, vartype_t type)
 216 {
 217     svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
 218
 219     switch (type) {
 220     case VAR_SCALAR:
 221         return sv_type == SVt_NULL ||
 222                sv_type == SVt_IV   ||
 223                sv_type == SVt_NV   ||
 224                sv_type == SVt_PV   ||
 225                sv_type == SVt_RV;
 226     case VAR_ARRAY:
 227         return sv_type == SVt_PVAV;
 228     case VAR_HASH:
 229         return sv_type == SVt_PVHV;
 230     case VAR_CODE:
 231         return sv_type == SVt_PVCV;
 232     case VAR_IO:
 233         return sv_type == SVt_PVIO;
 234     default:
 235         return 0;
 236     }
 237 }
 238
 239 HV *_get_namespace(SV *self)
 240 {
 241     dSP;
 242     SV *ret;
 243
 244     PUSHMARK(SP);
 245     XPUSHs(self);
 246     PUTBACK;
 247
 248     call_method("namespace", G_SCALAR);
 249
 250     SPAGAIN;
 251     ret = POPs;
 252     PUTBACK;
 253
 254     return (HV*)SvRV(ret);
 255 }
 256
 257 SV *_get_name(SV *self)
 258 {
 259     dSP;
 260     SV *ret;
 261
 262     PUSHMARK(SP);
 263     XPUSHs(self);
 264     PUTBACK;
 265
 266     call_method("name", G_SCALAR);
 267
 268     SPAGAIN;
 269     ret = POPs;
 270     PUTBACK;
 271
 272     return ret;
 273 }
 274
 275 SV *_get_symbol(SV *self, varspec_t *variable, int vivify)
 276 {
 277     HV *namespace;
 278     SV **entry;
 279     GV *glob;
 280
 281     namespace = _get_namespace(self);
 282     entry = hv_fetch(namespace, variable->name, strlen(variable->name), vivify);
 283     if (!entry)
 284         return NULL;
 285
 286     glob = (GV*)(*entry);
 287     if (!isGV(glob)) {
 288         SV *namesv;
 289
 290         namesv = newSVsv(_get_name(self));
 291         sv_catpvs(namesv, "::");
 292         sv_catpv(namesv, variable->name);
 293
 294         /* can't use gv_init here, because it screws up @ISA in a way that I
 295          * can't reproduce, but that CMOP triggers */
 296         gv_fetchsv(namesv, GV_ADD, vartype_to_svtype(variable->type));
 297         SvREFCNT_dec(namesv);
 298     }
 299
 300     if (vivify) {
 301         switch (variable->type) {
 302         case VAR_SCALAR:
 303             if (!GvSVOK(glob))
 304                 GvSetSV(glob, newSV(0));
 305             break;
 306         case VAR_ARRAY:
 307             if (!GvAVOK(glob))
 308                 GvSetAV(glob, newAV());
 309             break;
 310         case VAR_HASH:
 311             if (!GvHVOK(glob))
 312                 GvSetHV(glob, newHV());
 313             break;
 314         case VAR_CODE:
 315             croak("Don't know how to vivify CODE variables");
 316         case VAR_IO:
 317             if (!GvIOOK(glob))
 318                 GvSetIO(glob, newIO());
 319             break;
 320         default:
 321             croak("Unknown type in vivication");
 322         }
 323     }
 324
 325     switch (variable->type) {
 326     case VAR_SCALAR:
 327         return GvSV(glob);
 328     case VAR_ARRAY:
 329         return (SV*)GvAV(glob);
 330     case VAR_HASH:
 331         return (SV*)GvHV(glob);
 332     case VAR_CODE:
 333         return (SV*)GvCV(glob);
 334     case VAR_IO:
 335         return (SV*)GvIO(glob);
 336     default:
 337         return NULL;
 338     }
 339 }
 340
 341 MODULE = Package::Stash  PACKAGE = Package::Stash
 342
 343 PROTOTYPES: DISABLE
 344
 345 SV*
 346 new(class, package_name)
 347     char *class
 348     SV *package_name
 349   PREINIT:
 350     HV *instance;
 351     HV *namespace;
 352     SV *nsref;
 353   CODE:
 354     if (!SvPOK(package_name))
 355         croak("The constructor argument must be the name of a package");
 356
 357     instance = newHV();
 358
 359     if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package_name), 0)) {
 360         SvREFCNT_dec(package_name);
 361         SvREFCNT_dec(instance);
 362         croak("Couldn't initialize the 'name' key, hv_store failed");
 363     }
 364     namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
 365     nsref = newRV_inc((SV*)namespace);
 366     if (!hv_store(instance, "namespace", 9, nsref, 0)) {
 367         SvREFCNT_dec(nsref);
 368         SvREFCNT_dec(instance);
 369         croak("Couldn't initialize the 'namespace' key, hv_store failed");
 370     }
 371
 372     RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashpv(class, 0));
 373   OUTPUT:
 374     RETVAL
 375
 376 SV*
 377 name(self)
 378     SV *self
 379   PREINIT:
 380     SV **slot;
 381   CODE:
 382     if (!sv_isobject(self))
 383         croak("Can't call name as a class method");
 384     slot = hv_fetch((HV*)SvRV(self), "name", 4, 0);
 385     RETVAL = slot ? SvREFCNT_inc_simple_NN(*slot) : &PL_sv_undef;
 386   OUTPUT:
 387     RETVAL
 388
 389 SV*
 390 namespace(self)
 391     SV *self
 392   PREINIT:
 393     SV **slot;
 394   CODE:
 395     if (!sv_isobject(self))
 396         croak("Can't call namespace as a class method");
 397     slot = hv_fetch((HV*)SvRV(self), "namespace", 9, 0);
 398     RETVAL = slot ? SvREFCNT_inc_simple_NN(*slot) : &PL_sv_undef;
 399   OUTPUT:
 400     RETVAL
 401
 402 void
 403 add_symbol(self, variable, initial=NULL, ...)
 404     SV *self
 405     varspec_t variable
 406     SV *initial
 407   PREINIT:
 408     SV *name;
 409     GV *glob;
 410   CODE:
 411     if (initial && !_valid_for_type(initial, variable.type))
 412         croak("%s is not of type %s",
 413               SvPV_nolen(initial), vartype_to_string(variable.type));
 414
 415     name = newSVsv(_get_name(self));
 416     sv_catpvs(name, "::");
 417     sv_catpv(name, variable.name);
 418
 419     /* XXX: come back to this when i feel like reimplementing caller() */
 420 /*
 421     my $filename = $opts{filename};
 422     my $first_line_num = $opts{first_line_num};
 423
 424     (undef, $filename, $first_line_num) = caller
 425         if not defined $filename;
 426
 427     my $last_line_num = $opts{last_line_num} || ($first_line_num ||= 0);
 428
 429     # http://perldoc.perl.org/perldebguts.html#Debugger-Internals
 430     $DB::sub{$pkg . '::' . $name} = "$filename:$first_line_num-$last_line_num";
 431 */
 432 /*
 433     if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
 434         int i;
 435         char *filename = NULL, *name;
 436         I32 first_line_num, last_line_num;
 437
 438         if ((items - 3) % 2)
 439             croak("add_symbol: Odd number of elements in %%opts");
 440
 441         for (i = 3; i < items; i += 2) {
 442             char *key;
 443             key = SvPV_nolen(ST(i));
 444             if (strEQ(key, "filename")) {
 445                 if (!SvPOK(ST(i + 1)))
 446                     croak("add_symbol: filename must be a string");
 447                 filename = SvPV_nolen(ST(i + 1));
 448             }
 449             else if (strEQ(key, "first_line_num")) {
 450                 if (!SvIOK(ST(i + 1)))
 451                     croak("add_symbol: first_line_num must be an integer");
 452                 first_line_num = SvIV(ST(i + 1));
 453             }
 454             else if (strEQ(key, "last_line_num")) {
 455                 if (!SvIOK(ST(i + 1)))
 456                     croak("add_symbol: last_line_num must be an integer");
 457                 last_line_num = SvIV(ST(i + 1));
 458             }
 459         }
 460
 461         if (!filename) {
 462         }
 463     }
 464 */
 465
 466     /* GV_ADDMULTI rather than GV_ADD because otherwise you get 'used only
 467      * once' warnings in some situations... i can't reproduce this, but CMOP
 468      * triggers it */
 469     glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
 470
 471     if (initial) {
 472         SV *val;
 473
 474         if (SvROK(initial)) {
 475             val = SvRV(initial);
 476             SvREFCNT_inc_simple_void_NN(val);
 477         }
 478         else {
 479             val = newSVsv(initial);
 480         }
 481
 482         switch (variable.type) {
 483         case VAR_SCALAR:
 484             GvSetSV(glob, val);
 485             break;
 486         case VAR_ARRAY:
 487             GvSetAV(glob, val);
 488             break;
 489         case VAR_HASH:
 490             GvSetHV(glob, val);
 491             break;
 492         case VAR_CODE:
 493             GvSetCV(glob, val);
 494             break;
 495         case VAR_IO:
 496             GvSetIO(glob, val);
 497             break;
 498         }
 499     }
 500
 501     SvREFCNT_dec(name);
 502
 503 void
 504 remove_glob(self, name)
 505     SV *self
 506     char *name
 507   CODE:
 508     hv_delete(_get_namespace(self), name, strlen(name), G_DISCARD);
 509
 510 int
 511 has_symbol(self, variable)
 512     SV *self
 513     varspec_t variable
 514   PREINIT:
 515     HV *namespace;
 516     SV **entry;
 517   CODE:
 518     namespace = _get_namespace(self);
 519     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 520     if (!entry)
 521         XSRETURN_UNDEF;
 522
 523     if (isGV(*entry)) {
 524         GV *glob = (GV*)(*entry);
 525         switch (variable.type) {
 526         case VAR_SCALAR:
 527             RETVAL = GvSVOK(glob) ? 1 : 0;
 528             break;
 529         case VAR_ARRAY:
 530             RETVAL = GvAVOK(glob) ? 1 : 0;
 531             break;
 532         case VAR_HASH:
 533             RETVAL = GvHVOK(glob) ? 1 : 0;
 534             break;
 535         case VAR_CODE:
 536             RETVAL = GvCVOK(glob) ? 1 : 0;
 537             break;
 538         case VAR_IO:
 539             RETVAL = GvIOOK(glob) ? 1 : 0;
 540             break;
 541         }
 542     }
 543     else {
 544         RETVAL = (variable.type == VAR_CODE);
 545     }
 546   OUTPUT:
 547     RETVAL
 548
 549 SV*
 550 get_symbol(self, variable)
 551     SV *self
 552     varspec_t variable
 553   PREINIT:
 554     SV *val;
 555   CODE:
 556     val = _get_symbol(self, &variable, 0);
 557     if (!val)
 558         XSRETURN_UNDEF;
 559     RETVAL = newRV_inc(val);
 560   OUTPUT:
 561     RETVAL
 562
 563 SV*
 564 get_or_add_symbol(self, variable)
 565     SV *self
 566     varspec_t variable
 567   PREINIT:
 568     SV *val;
 569   CODE:
 570     val = _get_symbol(self, &variable, 1);
 571     if (!val)
 572         XSRETURN_UNDEF;
 573     RETVAL = newRV_inc(val);
 574   OUTPUT:
 575     RETVAL
 576
 577 void
 578 remove_symbol(self, variable)
 579     SV *self
 580     varspec_t variable
 581   PREINIT:
 582     HV *namespace;
 583     SV **entry;
 584   CODE:
 585     namespace = _get_namespace(self);
 586     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 587     if (!entry)
 588         XSRETURN_EMPTY;
 589
 590     if (isGV(*entry)) {
 591         GV *glob = (GV*)(*entry);
 592         switch (variable.type) {
 593         case VAR_SCALAR:
 594             GvSetSV(glob, NULL);
 595             break;
 596         case VAR_ARRAY:
 597             GvSetAV(glob, NULL);
 598             break;
 599         case VAR_HASH:
 600             GvSetHV(glob, NULL);
 601             break;
 602         case VAR_CODE:
 603             GvSetCV(glob, NULL);
 604             break;
 605         case VAR_IO:
 606             GvSetIO(glob, NULL);
 607             break;
 608         }
 609     }
 610     else {
 611         if (variable.type == VAR_CODE) {
 612             hv_delete(namespace, variable.name, strlen(variable.name), G_DISCARD);
 613         }
 614     }
 615
 616 void
 617 list_all_symbols(self, vartype=VAR_NONE)
 618     SV *self
 619     vartype_t vartype
 620   PPCODE:
 621     if (vartype == VAR_NONE) {
 622         HV *namespace;
 623         HE *entry;
 624         int keys;
 625
 626         namespace = _get_namespace(self);
 627         keys = hv_iterinit(namespace);
 628         EXTEND(SP, keys);
 629         while ((entry = hv_iternext(namespace))) {
 630             mPUSHs(newSVhe(entry));
 631         }
 632     }
 633     else {
 634         HV *namespace;
 635         SV *val;
 636         char *key;
 637         int len;
 638
 639         namespace = _get_namespace(self);
 640         hv_iterinit(namespace);
 641         while ((val = hv_iternextsv(namespace, &key, &len))) {
 642             GV *gv = (GV*)val;
 643             if (isGV(gv)) {
 644                 switch (vartype) {
 645                 case VAR_SCALAR:
 646                     if (GvSVOK(val))
 647                         mXPUSHp(key, len);
 648                     break;
 649                 case VAR_ARRAY:
 650                     if (GvAVOK(val))
 651                         mXPUSHp(key, len);
 652                     break;
 653                 case VAR_HASH:
 654                     if (GvHVOK(val))
 655                         mXPUSHp(key, len);
 656                     break;
 657                 case VAR_CODE:
 658                     if (GvCVOK(val))
 659                         mXPUSHp(key, len);
 660                     break;
 661                 case VAR_IO:
 662                     if (GvIOOK(val))
 663                         mXPUSHp(key, len);
 664                     break;
 665                 }
 666             }
 667             else if (vartype == VAR_CODE) {
 668                 mXPUSHp(key, len);
 669             }
 670         }
 671     }