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