Stash.xs

   1 #include "EXTERN.h"
   2 #include "perl.h"
   3 #include "XSUB.h"
   4
   5 typedef enum {
   6     VAR_NONE = 0,
   7     VAR_SCALAR,
   8     VAR_ARRAY,
   9     VAR_HASH,
  10     VAR_CODE,
  11     VAR_IO,
  12     VAR_GLOB,  /* TODO: unimplemented */
  13     VAR_FORMAT /* TODO: unimplemented */
  14 } vartype_t;
  15
  16 typedef struct {
  17     vartype_t type;
  18     char sigil;
  19     char *name;
  20 } varspec_t;
  21
  22 const char *vartype_to_string(vartype_t type)
  23 {
  24     switch (type) {
  25     case VAR_SCALAR:
  26         return "SCALAR";
  27     case VAR_ARRAY:
  28         return "ARRAY";
  29     case VAR_HASH:
  30         return "HASH";
  31     case VAR_CODE:
  32         return "CODE";
  33     case VAR_IO:
  34         return "IO";
  35     default:
  36         return "unknown";
  37     }
  38 }
  39
  40 I32 vartype_to_svtype(vartype_t type)
  41 {
  42     switch (type) {
  43     case VAR_SCALAR:
  44         return SVt_PV; /* or whatever */
  45     case VAR_ARRAY:
  46         return SVt_PVAV;
  47     case VAR_HASH:
  48         return SVt_PVHV;
  49     case VAR_CODE:
  50         return SVt_PVCV;
  51     case VAR_IO:
  52         return SVt_PVIO;
  53     default:
  54         return SVt_NULL;
  55     }
  56 }
  57
  58 vartype_t string_to_vartype(char *vartype)
  59 {
  60     if (strEQ(vartype, "SCALAR")) {
  61         return VAR_SCALAR;
  62     }
  63     else if (strEQ(vartype, "ARRAY")) {
  64         return VAR_ARRAY;
  65     }
  66     else if (strEQ(vartype, "HASH")) {
  67         return VAR_HASH;
  68     }
  69     else if (strEQ(vartype, "CODE")) {
  70         return VAR_CODE;
  71     }
  72     else if (strEQ(vartype, "IO")) {
  73         return VAR_IO;
  74     }
  75     else {
  76         croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO'");
  77     }
  78 }
  79
  80 void _deconstruct_variable_name(char *variable, varspec_t *varspec)
  81 {
  82     if (!variable || !variable[0])
  83         croak("You must pass a variable name");
  84
  85     varspec->type = VAR_NONE;
  86
  87     switch (variable[0]) {
  88     case '$':
  89         varspec->type = VAR_SCALAR;
  90         break;
  91     case '@':
  92         varspec->type = VAR_ARRAY;
  93         break;
  94     case '%':
  95         varspec->type = VAR_HASH;
  96         break;
  97     case '&':
  98         varspec->type = VAR_CODE;
  99         break;
 100     }
 101
 102     if (varspec->type != VAR_NONE) {
 103         varspec->sigil = variable[0];
 104         varspec->name = &variable[1];
 105     }
 106     else {
 107         varspec->type = VAR_IO;
 108         varspec->sigil = '\0';
 109         varspec->name = variable;
 110     }
 111 }
 112
 113 void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
 114 {
 115     SV **val;
 116
 117     val = hv_fetch(variable, "name", 4, 0);
 118     if (!val)
 119         croak("The 'name' key is required in variable specs");
 120
 121     varspec->name = savesvpv(*val);
 122     SAVEFREEPV(varspec->name);
 123
 124     val = hv_fetch(variable, "sigil", 5, 0);
 125     if (!val)
 126         croak("The 'sigil' key is required in variable specs");
 127
 128     varspec->sigil = (SvPV_nolen(*val))[0];
 129
 130     val = hv_fetch(variable, "type", 4, 0);
 131     if (!val)
 132         croak("The 'type' key is required in variable specs");
 133
 134     varspec->type = string_to_vartype(SvPV_nolen(*val));
 135 }
 136
 137 int _valid_for_type(SV *value, vartype_t type)
 138 {
 139     svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
 140
 141     switch (type) {
 142     case VAR_SCALAR:
 143         return sv_type == SVt_NULL ||
 144                sv_type == SVt_IV   ||
 145                sv_type == SVt_NV   ||
 146                sv_type == SVt_PV   ||
 147                sv_type == SVt_RV;
 148     case VAR_ARRAY:
 149         return sv_type == SVt_PVAV;
 150     case VAR_HASH:
 151         return sv_type == SVt_PVHV;
 152     case VAR_CODE:
 153         return sv_type == SVt_PVCV;
 154     case VAR_IO:
 155         return sv_type == SVt_PVIO;
 156     default:
 157         return 0;
 158     }
 159 }
 160
 161 HV *_get_namespace(SV *self)
 162 {
 163     dSP;
 164     SV *ret;
 165
 166     PUSHMARK(SP);
 167     XPUSHs(self);
 168     PUTBACK;
 169
 170     call_method("namespace", G_SCALAR);
 171
 172     SPAGAIN;
 173     ret = POPs;
 174     PUTBACK;
 175
 176     return (HV*)SvRV(ret);
 177 }
 178
 179 SV *_get_name(SV *self)
 180 {
 181     dSP;
 182     SV *ret;
 183
 184     PUSHMARK(SP);
 185     XPUSHs(self);
 186     PUTBACK;
 187
 188     call_method("name", G_SCALAR);
 189
 190     SPAGAIN;
 191     ret = POPs;
 192     PUTBACK;
 193
 194     return ret;
 195 }
 196
 197 SV *_get_package_symbol(SV *self, varspec_t *variable, int vivify)
 198 {
 199     HV *namespace;
 200     SV **entry;
 201     GV *glob;
 202
 203     namespace = _get_namespace(self);
 204     entry = hv_fetch(namespace, variable->name, strlen(variable->name), vivify);
 205     if (!entry)
 206         return NULL;
 207
 208     glob = (GV*)(*entry);
 209     if (!isGV(glob)) {
 210         SV *namesv;
 211
 212         namesv = newSVsv(_get_name(self));
 213         sv_catpvs(namesv, "::");
 214         sv_catpv(namesv, variable->name);
 215
 216         /* can't use gv_init here, because it screws up @ISA in a way that I
 217          * can't reproduce, but that CMOP triggers */
 218         gv_fetchsv(namesv, GV_ADD, vartype_to_svtype(variable->type));
 219         SvREFCNT_dec(namesv);
 220     }
 221
 222     if (vivify) {
 223         switch (variable->type) {
 224         case VAR_SCALAR:
 225             if (!GvSV(glob))
 226                 GvSV(glob) = newSV(0);
 227             break;
 228         case VAR_ARRAY:
 229             if (!GvAV(glob))
 230                 GvAV(glob) = newAV();
 231             break;
 232         case VAR_HASH:
 233             if (!GvHV(glob))
 234                 GvHV(glob) = newHV();
 235             break;
 236         case VAR_CODE:
 237             croak("Don't know how to vivify CODE variables");
 238         case VAR_IO:
 239             if (!GvIO(glob))
 240                 GvIOp(glob) = newIO();
 241             break;
 242         default:
 243             croak("Unknown type in vivication");
 244         }
 245     }
 246
 247     switch (variable->type) {
 248     case VAR_SCALAR:
 249         return GvSV(glob);
 250     case VAR_ARRAY:
 251         return (SV*)GvAV(glob);
 252     case VAR_HASH:
 253         return (SV*)GvHV(glob);
 254     case VAR_CODE:
 255         return (SV*)GvCV(glob);
 256     case VAR_IO:
 257         return (SV*)GvIO(glob);
 258     default:
 259         return NULL;
 260     }
 261 }
 262
 263 MODULE = Package::Stash  PACKAGE = Package::Stash
 264
 265 PROTOTYPES: DISABLE
 266
 267 SV*
 268 new(class, package_name)
 269     char *class
 270     SV *package_name
 271   PREINIT:
 272     HV *instance;
 273     HV *namespace;
 274   CODE:
 275     if (!SvPOK(package_name))
 276         croak("The constructor argument must be the name of a package");
 277
 278     instance = newHV();
 279
 280     if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package_name), 0))
 281         croak("Couldn't initialize the 'name' key, hv_store failed");
 282     namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
 283     if (!hv_store(instance, "namespace", 9, newRV_inc((SV*)namespace), 0))
 284         croak("Couldn't initialize the 'namespace' key, hv_store failed");
 285
 286     RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashpv(class, 0));
 287   OUTPUT:
 288     RETVAL
 289
 290 SV*
 291 name(self)
 292     SV *self
 293   PREINIT:
 294     SV **slot;
 295   CODE:
 296     if (!sv_isobject(self))
 297         croak("Can't call name as a class method");
 298     slot = hv_fetch((HV*)SvRV(self), "name", 4, 0);
 299     RETVAL = slot ? SvREFCNT_inc_simple_NN(*slot) : &PL_sv_undef;
 300   OUTPUT:
 301     RETVAL
 302
 303 SV*
 304 namespace(self)
 305     SV *self
 306   PREINIT:
 307     SV **slot;
 308   CODE:
 309     if (!sv_isobject(self))
 310         croak("Can't call namespace as a class method");
 311     slot = hv_fetch((HV*)SvRV(self), "namespace", 9, 0);
 312     RETVAL = slot ? SvREFCNT_inc_simple_NN(*slot) : &PL_sv_undef;
 313   OUTPUT:
 314     RETVAL
 315
 316 void
 317 add_package_symbol(self, variable, initial=NULL, ...)
 318     SV *self
 319     varspec_t variable
 320     SV *initial
 321   PREINIT:
 322     SV *name;
 323     GV *glob;
 324   CODE:
 325     if (initial && !_valid_for_type(initial, variable.type))
 326         croak("%s is not of type %s",
 327               SvPV_nolen(initial), vartype_to_string(variable.type));
 328
 329     name = newSVsv(_get_name(self));
 330     sv_catpvs(name, "::");
 331     sv_catpv(name, variable.name);
 332
 333     /* XXX: come back to this when i feel like reimplementing caller() */
 334 /*
 335     my $filename = $opts{filename};
 336     my $first_line_num = $opts{first_line_num};
 337
 338     (undef, $filename, $first_line_num) = caller
 339         if not defined $filename;
 340
 341     my $last_line_num = $opts{last_line_num} || ($first_line_num ||= 0);
 342
 343     # http://perldoc.perl.org/perldebguts.html#Debugger-Internals
 344     $DB::sub{$pkg . '::' . $name} = "$filename:$first_line_num-$last_line_num";
 345 */
 346 /*
 347     if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
 348         int i;
 349         char *filename = NULL, *name;
 350         I32 first_line_num, last_line_num;
 351
 352         if ((items - 3) % 2)
 353             croak("add_package_symbol: Odd number of elements in %%opts");
 354
 355         for (i = 3; i < items; i += 2) {
 356             char *key;
 357             key = SvPV_nolen(ST(i));
 358             if (strEQ(key, "filename")) {
 359                 if (!SvPOK(ST(i + 1)))
 360                     croak("add_package_symbol: filename must be a string");
 361                 filename = SvPV_nolen(ST(i + 1));
 362             }
 363             else if (strEQ(key, "first_line_num")) {
 364                 if (!SvIOK(ST(i + 1)))
 365                     croak("add_package_symbol: first_line_num must be an integer");
 366                 first_line_num = SvIV(ST(i + 1));
 367             }
 368             else if (strEQ(key, "last_line_num")) {
 369                 if (!SvIOK(ST(i + 1)))
 370                     croak("add_package_symbol: last_line_num must be an integer");
 371                 last_line_num = SvIV(ST(i + 1));
 372             }
 373         }
 374
 375         if (!filename) {
 376         }
 377     }
 378 */
 379
 380     glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
 381
 382     if (initial) {
 383         SV *val;
 384
 385         if (SvROK(initial)) {
 386             val = SvRV(initial);
 387             SvREFCNT_inc_simple_void_NN(val);
 388         }
 389         else {
 390             val = newSVsv(initial);
 391         }
 392
 393         switch (variable.type) {
 394         case VAR_SCALAR:
 395             SvREFCNT_dec(GvSV(glob));
 396             GvSV(glob) = val;
 397             break;
 398         case VAR_ARRAY:
 399             SvREFCNT_dec(GvAV(glob));
 400             GvAV(glob) = (AV*)val;
 401             break;
 402         case VAR_HASH:
 403             SvREFCNT_dec(GvHV(glob));
 404             GvHV(glob) = (HV*)val;
 405             break;
 406         case VAR_CODE:
 407             SvREFCNT_dec(GvCV(glob));
 408             GvCV(glob) = (CV*)val;
 409             break;
 410         case VAR_IO:
 411             SvREFCNT_dec(GvIO(glob));
 412             GvIOp(glob) = (IO*)val;
 413             break;
 414         }
 415     }
 416
 417     SvREFCNT_dec(name);
 418
 419 void
 420 remove_package_glob(self, name)
 421     SV *self
 422     char *name
 423   CODE:
 424     hv_delete(_get_namespace(self), name, strlen(name), G_DISCARD);
 425
 426 int
 427 has_package_symbol(self, variable)
 428     SV *self
 429     varspec_t variable
 430   PREINIT:
 431     HV *namespace;
 432     SV **entry;
 433   CODE:
 434     namespace = _get_namespace(self);
 435     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 436     if (!entry)
 437         XSRETURN_UNDEF;
 438
 439     if (isGV(*entry)) {
 440         GV *glob = (GV*)(*entry);
 441         switch (variable.type) {
 442         case VAR_SCALAR:
 443             RETVAL = GvSV(glob) ? 1 : 0;
 444             break;
 445         case VAR_ARRAY:
 446             RETVAL = GvAV(glob) ? 1 : 0;
 447             break;
 448         case VAR_HASH:
 449             RETVAL = GvHV(glob) ? 1 : 0;
 450             break;
 451         case VAR_CODE:
 452             RETVAL = GvCV(glob) ? 1 : 0;
 453             break;
 454         case VAR_IO:
 455             RETVAL = GvIO(glob) ? 1 : 0;
 456             break;
 457         }
 458     }
 459     else {
 460         RETVAL = (variable.type == VAR_CODE);
 461     }
 462   OUTPUT:
 463     RETVAL
 464
 465 SV*
 466 get_package_symbol(self, variable)
 467     SV *self
 468     varspec_t variable
 469   PREINIT:
 470     SV *val;
 471   CODE:
 472     val = _get_package_symbol(self, &variable, 0);
 473     if (!val)
 474         XSRETURN_UNDEF;
 475     RETVAL = newRV_inc(val);
 476   OUTPUT:
 477     RETVAL
 478
 479 SV*
 480 get_or_add_package_symbol(self, variable)
 481     SV *self
 482     varspec_t variable
 483   PREINIT:
 484     SV *val;
 485   CODE:
 486     val = _get_package_symbol(self, &variable, 1);
 487     if (!val)
 488         XSRETURN_UNDEF;
 489     RETVAL = newRV_inc(val);
 490   OUTPUT:
 491     RETVAL
 492
 493 void
 494 remove_package_symbol(self, variable)
 495     SV *self
 496     varspec_t variable
 497   PREINIT:
 498     HV *namespace;
 499     SV **entry;
 500   CODE:
 501     namespace = _get_namespace(self);
 502     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 503     if (!entry)
 504         XSRETURN_EMPTY;
 505
 506     if (isGV(*entry)) {
 507         GV *glob = (GV*)(*entry);
 508         switch (variable.type) {
 509         case VAR_SCALAR:
 510             GvSV(glob) = (SV *)NULL;
 511             break;
 512         case VAR_ARRAY:
 513             GvAV(glob) = (AV *)NULL;
 514             break;
 515         case VAR_HASH:
 516             GvHV(glob) = (HV *)NULL;
 517             break;
 518         case VAR_CODE:
 519             GvCV(glob) = (CV *)NULL;
 520             break;
 521         case VAR_IO:
 522             GvIOp(glob) = (IO *)NULL;
 523             break;
 524         }
 525     }
 526     else {
 527         if (variable.type == VAR_CODE) {
 528             hv_delete(namespace, variable.name, strlen(variable.name), G_DISCARD);
 529         }
 530     }
 531
 532 void
 533 list_all_package_symbols(self, vartype=VAR_NONE)
 534     SV *self
 535     vartype_t vartype
 536   PPCODE:
 537     if (vartype == VAR_NONE) {
 538         HV *namespace;
 539         HE *entry;
 540         int keys;
 541
 542         namespace = _get_namespace(self);
 543         keys = hv_iterinit(namespace);
 544         EXTEND(SP, keys);
 545         while ((entry = hv_iternext(namespace))) {
 546             mPUSHs(newSVhek(HeKEY_hek(entry)));
 547         }
 548     }
 549     else {
 550         HV *namespace;
 551         SV *val;
 552         char *key;
 553         int len;
 554
 555         namespace = _get_namespace(self);
 556         hv_iterinit(namespace);
 557         while ((val = hv_iternextsv(namespace, &key, &len))) {
 558             GV *gv = (GV*)val;
 559             if (isGV(gv)) {
 560                 switch (vartype) {
 561                 case VAR_SCALAR:
 562                     if (GvSV(val))
 563                         mXPUSHp(key, len);
 564                     break;
 565                 case VAR_ARRAY:
 566                     if (GvAV(val))
 567                         mXPUSHp(key, len);
 568                     break;
 569                 case VAR_HASH:
 570                     if (GvHV(val))
 571                         mXPUSHp(key, len);
 572                     break;
 573                 case VAR_CODE:
 574                     if (GvCVu(val))
 575                         mXPUSHp(key, len);
 576                     break;
 577                 case VAR_IO:
 578                     if (GvIO(val))
 579                         mXPUSHp(key, len);
 580                     break;
 581                 }
 582             }
 583             else if (vartype == VAR_CODE) {
 584                 mXPUSHp(key, len);
 585             }
 586         }
 587     }