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     hv_store(instance, "name", 4, SvREFCNT_inc(package_name), 0);
 281     namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
 282     hv_store(instance, "namespace", 9, newRV_inc((SV*)namespace), 0);
 283
 284     RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashpv(class, 0));
 285   OUTPUT:
 286     RETVAL
 287
 288 SV*
 289 name(self)
 290     SV *self
 291   PREINIT:
 292     SV **slot;
 293   CODE:
 294     if (!sv_isobject(self))
 295         croak("Can't call name as a class method");
 296     slot = hv_fetch((HV*)SvRV(self), "name", 4, 0);
 297     RETVAL = slot ? SvREFCNT_inc(*slot) : &PL_sv_undef;
 298   OUTPUT:
 299     RETVAL
 300
 301 SV*
 302 namespace(self)
 303     SV *self
 304   PREINIT:
 305     SV **slot;
 306   CODE:
 307     if (!sv_isobject(self))
 308         croak("Can't call namespace as a class method");
 309     slot = hv_fetch((HV*)SvRV(self), "namespace", 9, 0);
 310     RETVAL = slot ? SvREFCNT_inc(*slot) : &PL_sv_undef;
 311   OUTPUT:
 312     RETVAL
 313
 314 void
 315 add_package_symbol(self, variable, initial=NULL, ...)
 316     SV *self
 317     varspec_t variable
 318     SV *initial
 319   PREINIT:
 320     SV *name;
 321     GV *glob;
 322   CODE:
 323     if (initial && !_valid_for_type(initial, variable.type))
 324         croak("%s is not of type %s",
 325               SvPV_nolen(initial), vartype_to_string(variable.type));
 326
 327     name = newSVsv(_get_name(self));
 328     sv_catpvs(name, "::");
 329     sv_catpv(name, variable.name);
 330
 331     /* XXX: come back to this when i feel like reimplementing caller() */
 332 /*
 333     my $filename = $opts{filename};
 334     my $first_line_num = $opts{first_line_num};
 335
 336     (undef, $filename, $first_line_num) = caller
 337         if not defined $filename;
 338
 339     my $last_line_num = $opts{last_line_num} || ($first_line_num ||= 0);
 340
 341     # http://perldoc.perl.org/perldebguts.html#Debugger-Internals
 342     $DB::sub{$pkg . '::' . $name} = "$filename:$first_line_num-$last_line_num";
 343 */
 344 /*
 345     if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
 346         int i;
 347         char *filename = NULL, *name;
 348         I32 first_line_num, last_line_num;
 349
 350         if ((items - 3) % 2)
 351             croak("add_package_symbol: Odd number of elements in %%opts");
 352
 353         for (i = 3; i < items; i += 2) {
 354             char *key;
 355             key = SvPV_nolen(ST(i));
 356             if (strEQ(key, "filename")) {
 357                 if (!SvPOK(ST(i + 1)))
 358                     croak("add_package_symbol: filename must be a string");
 359                 filename = SvPV_nolen(ST(i + 1));
 360             }
 361             else if (strEQ(key, "first_line_num")) {
 362                 if (!SvIOK(ST(i + 1)))
 363                     croak("add_package_symbol: first_line_num must be an integer");
 364                 first_line_num = SvIV(ST(i + 1));
 365             }
 366             else if (strEQ(key, "last_line_num")) {
 367                 if (!SvIOK(ST(i + 1)))
 368                     croak("add_package_symbol: last_line_num must be an integer");
 369                 last_line_num = SvIV(ST(i + 1));
 370             }
 371         }
 372
 373         if (!filename) {
 374         }
 375     }
 376 */
 377
 378     glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
 379
 380     if (initial) {
 381         SV *val;
 382
 383         if (SvROK(initial)) {
 384             val = SvRV(initial);
 385             SvREFCNT_inc(val);
 386         }
 387         else {
 388             val = newSVsv(initial);
 389         }
 390
 391         switch (variable.type) {
 392         case VAR_SCALAR:
 393             if (GvSV(glob))
 394                 SvREFCNT_dec(GvSV(glob));
 395             GvSV(glob) = val;
 396             break;
 397         case VAR_ARRAY:
 398             if (GvAV(glob))
 399                 SvREFCNT_dec((SV*)GvAV(glob));
 400             GvAV(glob) = (AV*)val;
 401             break;
 402         case VAR_HASH:
 403             if (GvHV(glob))
 404                 SvREFCNT_dec((SV*)GvHV(glob));
 405             GvHV(glob) = (HV*)val;
 406             break;
 407         case VAR_CODE:
 408             if (GvCV(glob))
 409                 SvREFCNT_dec((SV*)GvCV(glob));
 410             GvCV(glob) = (CV*)val;
 411             break;
 412         case VAR_IO:
 413             if (GvIO(glob))
 414                 SvREFCNT_dec((SV*)GvIO(glob));
 415             GvIOp(glob) = (IO*)val;
 416             break;
 417         }
 418     }
 419
 420     SvREFCNT_dec(name);
 421
 422 void
 423 remove_package_glob(self, name)
 424     SV *self
 425     char *name
 426   CODE:
 427     hv_delete(_get_namespace(self), name, strlen(name), G_DISCARD);
 428
 429 int
 430 has_package_symbol(self, variable)
 431     SV *self
 432     varspec_t variable
 433   PREINIT:
 434     HV *namespace;
 435     SV **entry;
 436   CODE:
 437     namespace = _get_namespace(self);
 438     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 439     if (!entry)
 440         XSRETURN_UNDEF;
 441
 442     if (isGV(*entry)) {
 443         GV *glob = (GV*)(*entry);
 444         switch (variable.type) {
 445         case VAR_SCALAR:
 446             RETVAL = GvSV(glob) ? 1 : 0;
 447             break;
 448         case VAR_ARRAY:
 449             RETVAL = GvAV(glob) ? 1 : 0;
 450             break;
 451         case VAR_HASH:
 452             RETVAL = GvHV(glob) ? 1 : 0;
 453             break;
 454         case VAR_CODE:
 455             RETVAL = GvCV(glob) ? 1 : 0;
 456             break;
 457         case VAR_IO:
 458             RETVAL = GvIO(glob) ? 1 : 0;
 459             break;
 460         }
 461     }
 462     else {
 463         RETVAL = (variable.type == VAR_CODE);
 464     }
 465   OUTPUT:
 466     RETVAL
 467
 468 SV*
 469 get_package_symbol(self, variable)
 470     SV *self
 471     varspec_t variable
 472   PREINIT:
 473     SV *val;
 474   CODE:
 475     val = _get_package_symbol(self, &variable, 0);
 476     if (!val)
 477         XSRETURN_UNDEF;
 478     RETVAL = newRV_inc(val);
 479   OUTPUT:
 480     RETVAL
 481
 482 SV*
 483 get_or_add_package_symbol(self, variable)
 484     SV *self
 485     varspec_t variable
 486   PREINIT:
 487     SV *val;
 488   CODE:
 489     val = _get_package_symbol(self, &variable, 1);
 490     if (!val)
 491         XSRETURN_UNDEF;
 492     RETVAL = newRV_inc(val);
 493   OUTPUT:
 494     RETVAL
 495
 496 void
 497 remove_package_symbol(self, variable)
 498     SV *self
 499     varspec_t variable
 500   PREINIT:
 501     HV *namespace;
 502     SV **entry;
 503   CODE:
 504     namespace = _get_namespace(self);
 505     entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
 506     if (!entry)
 507         XSRETURN_EMPTY;
 508
 509     if (isGV(*entry)) {
 510         GV *glob = (GV*)(*entry);
 511         switch (variable.type) {
 512         case VAR_SCALAR:
 513             GvSV(glob) = (SV *)NULL;
 514             break;
 515         case VAR_ARRAY:
 516             GvAV(glob) = (AV *)NULL;
 517             break;
 518         case VAR_HASH:
 519             GvHV(glob) = (HV *)NULL;
 520             break;
 521         case VAR_CODE:
 522             GvCV(glob) = (CV *)NULL;
 523             break;
 524         case VAR_IO:
 525             GvIOp(glob) = (IO *)NULL;
 526             break;
 527         }
 528     }
 529     else {
 530         if (variable.type == VAR_CODE) {
 531             hv_delete(namespace, variable.name, strlen(variable.name), G_DISCARD);
 532         }
 533     }
 534
 535 void
 536 list_all_package_symbols(self, vartype=VAR_NONE)
 537     SV *self
 538     vartype_t vartype
 539   PPCODE:
 540     if (vartype == VAR_NONE) {
 541         HV *namespace;
 542         HE *entry;
 543         int keys;
 544
 545         namespace = _get_namespace(self);
 546         keys = hv_iterinit(namespace);
 547         EXTEND(SP, keys);
 548         while ((entry = hv_iternext(namespace))) {
 549             mPUSHs(newSVhek(HeKEY_hek(entry)));
 550         }
 551     }
 552     else {
 553         HV *namespace;
 554         SV *val;
 555         char *key;
 556         int len;
 557
 558         namespace = _get_namespace(self);
 559         hv_iterinit(namespace);
 560         while ((val = hv_iternextsv(namespace, &key, &len))) {
 561             GV *gv = (GV*)val;
 562             if (isGV(gv)) {
 563                 switch (vartype) {
 564                 case VAR_SCALAR:
 565                     if (GvSV(val))
 566                         mXPUSHp(key, len);
 567                     break;
 568                 case VAR_ARRAY:
 569                     if (GvAV(val))
 570                         mXPUSHp(key, len);
 571                     break;
 572                 case VAR_HASH:
 573                     if (GvHV(val))
 574                         mXPUSHp(key, len);
 575                     break;
 576                 case VAR_CODE:
 577                     if (GvCVu(val))
 578                         mXPUSHp(key, len);
 579                     break;
 580                 case VAR_IO:
 581                     if (GvIO(val))
 582                         mXPUSHp(key, len);
 583                     break;
 584                 }
 585             }
 586             else if (vartype == VAR_CODE) {
 587                 mXPUSHp(key, len);
 588             }
 589         }
 590     }