5 #define NEED_newRV_noinc
6 #define NEED_sv_2pv_flags
10 #define gv_fetchsv(n,f,t) gv_fetchpv(SvPV_nolen(n), f, t)
13 #ifndef mro_method_changed_in
14 #define mro_method_changed_in(x) PL_sub_generation++
18 #define newSVhe(he) newSVhek(HeKEY_hek(he))
20 #define newSVhe(he) newSVpv(HePV(he, PL_na), 0)
24 #define savesvpv(s) savepv(SvPV_nolen(s))
28 #define GvCV_set(gv, cv) (GvCV(gv) = (CV*)(cv))
32 #define SVT_SCALAR(svt) (svt <= SVt_PVLV)
36 #define SVT_ARRAY(svt) (svt == SVt_PVAV)
40 #define SVT_HASH(svt) (svt == SVt_PVHV)
44 #define SVT_CODE(svt) (svt == SVt_PVCV)
48 #define SVT_IO(svt) (svt == SVt_PVIO)
52 #define SVT_FORMAT(svt) (svt == SVt_PVFM)
55 /* HACK: scalar slots are always populated on perl < 5.10, so treat undef
56 * as nonexistent. this is consistent with the previous behavior of the pure
57 * perl version of this module (since this is the behavior that perl sees
60 #define GvSVOK(g) (GvSV(g) && SvTYPE(GvSV(g)) != SVt_NULL)
62 #define GvSVOK(g) GvSV(g)
65 #define GvAVOK(g) GvAV(g)
66 #define GvHVOK(g) GvHV(g)
67 #define GvCVOK(g) GvCVu(g) /* XXX: should this really be GvCVu? or GvCV? */
68 #define GvIOOK(g) GvIO(g)
70 /* see above - don't let scalar slots become unpopulated, this breaks
71 * assumptions in core */
73 #define GvSetSV(g,v) do { \
75 SvREFCNT_dec(GvSV(g)); \
76 if ((GvSV(g) = _v ? _v : newSV(0))) \
77 GvIMPORTED_SV_on(g); \
80 #define GvSetSV(g,v) do { \
81 SvREFCNT_dec(GvSV(g)); \
82 if ((GvSV(g) = (SV*)(v))) \
83 GvIMPORTED_SV_on(g); \
87 #define GvSetAV(g,v) do { \
88 SvREFCNT_dec(GvAV(g)); \
89 if ((GvAV(g) = (AV*)(v))) \
90 GvIMPORTED_AV_on(g); \
92 #define GvSetHV(g,v) do { \
93 SvREFCNT_dec(GvHV(g)); \
94 if ((GvHV(g) = (HV*)(v))) \
95 GvIMPORTED_HV_on(g); \
97 #define GvSetCV(g,v) do { \
98 SvREFCNT_dec(GvCV(g)); \
99 if ((GvCV_set(g, v))) { \
100 GvIMPORTED_CV_on(g); \
104 mro_method_changed_in(GvSTASH(g)); \
106 #define GvSetIO(g,v) do { \
107 SvREFCNT_dec(GvIO(g)); \
108 GvIOp(g) = (IO*)(v); \
118 VAR_GLOB, /* TODO: unimplemented */
119 VAR_FORMAT /* TODO: unimplemented */
127 static U32 name_hash, namespace_hash, type_hash;
128 static SV *name_key, *namespace_key, *type_key;
129 static REGEXP *valid_module_regex;
131 static const char *vartype_to_string(vartype_t type)
149 static I32 vartype_to_svtype(vartype_t type)
153 return SVt_PV; /* or whatever */
167 static vartype_t string_to_vartype(char *vartype)
169 if (strEQ(vartype, "SCALAR")) {
172 else if (strEQ(vartype, "ARRAY")) {
175 else if (strEQ(vartype, "HASH")) {
178 else if (strEQ(vartype, "CODE")) {
181 else if (strEQ(vartype, "IO")) {
185 croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO', not '%s'", vartype);
189 static int _is_valid_module_name(SV *package)
195 buf = SvPV(package, len);
197 /* whee cargo cult */
199 sv_upgrade(sv, SVt_PV);
207 return pregexec(valid_module_regex, buf, buf + len, buf, 1, sv, 1);
210 static void _deconstruct_variable_name(SV *variable, varspec_t *varspec)
214 if (!SvCUR(variable))
215 croak("You must pass a variable name");
217 varspec->name = sv_2mortal(newSVsv(variable));
219 varpv = SvPV_nolen(varspec->name);
222 varspec->type = VAR_SCALAR;
223 sv_chop(varspec->name, &varpv[1]);
226 varspec->type = VAR_ARRAY;
227 sv_chop(varspec->name, &varpv[1]);
230 varspec->type = VAR_HASH;
231 sv_chop(varspec->name, &varpv[1]);
234 varspec->type = VAR_CODE;
235 sv_chop(varspec->name, &varpv[1]);
238 varspec->type = VAR_IO;
243 static void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
247 val = hv_fetch_ent(variable, name_key, 0, name_hash);
249 croak("The 'name' key is required in variable specs");
251 varspec->name = sv_2mortal(newSVsv(HeVAL(val)));
253 val = hv_fetch_ent(variable, type_key, 0, type_hash);
255 croak("The 'type' key is required in variable specs");
257 varspec->type = string_to_vartype(SvPV_nolen(HeVAL(val)));
260 static void _check_varspec_is_valid(varspec_t *varspec)
262 if (strstr(SvPV_nolen(varspec->name), "::")) {
263 croak("Variable names may not contain ::");
267 static int _valid_for_type(SV *value, vartype_t type)
269 svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
273 /* XXX is a glob a scalar? assigning a glob to the scalar slot seems
274 * to work here, but in pure perl i'm pretty sure it goes to the EGV
275 * slot, which seems more correct to me. just disable it for now
277 return SVT_SCALAR(sv_type) && sv_type != SVt_PVGV;
279 return SVT_ARRAY(sv_type);
281 return SVT_HASH(sv_type);
283 return SVT_CODE(sv_type);
285 return SVT_IO(sv_type);
291 static HV *_get_namespace(SV *self)
300 call_method("namespace", G_SCALAR);
306 return (HV*)SvRV(ret);
309 static SV *_get_name(SV *self)
318 call_method("name", G_SCALAR);
327 static void _expand_glob(SV *self, SV *varname)
331 name = newSVsv(_get_name(self));
332 sv_catpvs(name, "::");
333 sv_catsv(name, varname);
335 /* can't use gv_init here, because it screws up @ISA in a way that I
336 * can't reproduce, but that CMOP triggers */
337 gv_fetchsv(name, GV_ADD, SVt_NULL);
341 static SV *_get_symbol(SV *self, varspec_t *variable, int vivify)
347 namespace = _get_namespace(self);
348 entry = hv_fetch_ent(namespace, variable->name, vivify, 0);
352 glob = (GV*)(HeVAL(entry));
354 _expand_glob(self, variable->name);
357 switch (variable->type) {
360 GvSetSV(glob, newSV(0));
364 GvSetAV(glob, newAV());
368 GvSetHV(glob, newHV());
371 croak("Don't know how to vivify CODE variables");
374 GvSetIO(glob, newIO());
377 croak("Unknown type in vivication");
381 switch (variable->type) {
385 return (SV*)GvAV(glob);
387 return (SV*)GvHV(glob);
389 return (SV*)GvCV(glob);
391 return (SV*)GvIO(glob);
397 MODULE = Package::Stash::XS PACKAGE = Package::Stash::XS
402 new(class, package_name)
408 if (!SvPOK(package_name))
409 croak("Package::Stash->new must be passed the name of the package to access");
411 if (!_is_valid_module_name(package_name))
412 croak("%s is not a module name", SvPV_nolen(package_name));
416 if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package_name), 0)) {
417 SvREFCNT_dec(package_name);
418 SvREFCNT_dec(instance);
419 croak("Couldn't initialize the 'name' key, hv_store failed");
422 RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashsv(class, 0));
432 if (!sv_isobject(self))
433 croak("Can't call name as a class method");
434 slot = hv_fetch_ent((HV*)SvRV(self), name_key, 0, name_hash);
435 RETVAL = slot ? SvREFCNT_inc_simple_NN(HeVAL(slot)) : &PL_sv_undef;
446 if (!sv_isobject(self))
447 croak("Can't call namespace as a class method");
448 #if PERL_VERSION < 10
449 package_name = _get_name(self);
450 RETVAL = newRV_inc((SV*)gv_stashpv(SvPV_nolen(package_name), GV_ADD));
452 slot = hv_fetch_ent((HV*)SvRV(self), namespace_key, 0, namespace_hash);
454 RETVAL = SvREFCNT_inc_simple_NN(HeVAL(slot));
460 package_name = _get_name(self);
461 namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
462 nsref = newRV_inc((SV*)namespace);
464 if (!hv_store((HV*)SvRV(self), "namespace", 9, nsref, 0)) {
467 croak("Couldn't initialize the 'namespace' key, hv_store failed");
469 RETVAL = SvREFCNT_inc_simple_NN(nsref);
476 add_symbol(self, variable, initial=NULL, ...)
484 if (initial && !_valid_for_type(initial, variable.type))
485 croak("%s is not of type %s",
486 SvPV_nolen(initial), vartype_to_string(variable.type));
488 name = newSVsv(_get_name(self));
489 sv_catpvs(name, "::");
490 sv_catsv(name, variable.name);
492 if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
494 char *filename = NULL;
495 I32 first_line_num = -1, last_line_num = -1;
500 croak("add_symbol: Odd number of elements in %%opts");
502 for (i = 3; i < items; i += 2) {
504 key = SvPV_nolen(ST(i));
505 if (strEQ(key, "filename")) {
506 if (!SvPOK(ST(i + 1)))
507 croak("add_symbol: filename must be a string");
508 filename = SvPV_nolen(ST(i + 1));
510 else if (strEQ(key, "first_line_num")) {
511 if (!SvIOK(ST(i + 1)))
512 croak("add_symbol: first_line_num must be an integer");
513 first_line_num = SvIV(ST(i + 1));
515 else if (strEQ(key, "last_line_num")) {
516 if (!SvIOK(ST(i + 1)))
517 croak("add_symbol: last_line_num must be an integer");
518 last_line_num = SvIV(ST(i + 1));
522 if (!filename || first_line_num == -1) {
524 filename = CopFILE(PL_curcop);
525 if (first_line_num == -1)
526 first_line_num = PL_curcop->cop_line;
529 if (last_line_num == -1)
530 last_line_num = first_line_num;
532 /* http://perldoc.perl.org/perldebguts.html#Debugger-Internals */
533 dbsub = get_hv("DB::sub", 1);
534 dbval = newSVpvf("%s:%d-%d", filename, first_line_num, last_line_num);
535 if (!hv_store_ent(dbsub, name, dbval, 0)) {
536 warn("Failed to update $DB::sub for subroutine %s",
542 /* GV_ADDMULTI rather than GV_ADD because otherwise you get 'used only
543 * once' warnings in some situations... i can't reproduce this, but CMOP
545 glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
550 if (SvROK(initial)) {
552 SvREFCNT_inc_simple_void_NN(val);
555 val = newSVsv(initial);
558 switch (variable.type) {
580 remove_glob(self, name)
584 hv_delete_ent(_get_namespace(self), name, G_DISCARD, 0);
587 has_symbol(self, variable)
595 namespace = _get_namespace(self);
596 entry = hv_fetch_ent(namespace, variable.name, 0, 0);
603 switch (variable.type) {
605 RETVAL = GvSVOK(glob) ? 1 : 0;
608 RETVAL = GvAVOK(glob) ? 1 : 0;
611 RETVAL = GvHVOK(glob) ? 1 : 0;
614 RETVAL = GvCVOK(glob) ? 1 : 0;
617 RETVAL = GvIOOK(glob) ? 1 : 0;
622 RETVAL = (variable.type == VAR_CODE);
628 get_symbol(self, variable)
634 val = _get_symbol(self, &variable, 0);
637 RETVAL = newRV_inc(val);
642 get_or_add_symbol(self, variable)
648 val = _get_symbol(self, &variable, 1);
651 RETVAL = newRV_inc(val);
656 remove_symbol(self, variable)
664 namespace = _get_namespace(self);
665 entry = hv_fetch_ent(namespace, variable.name, 0, 0);
672 switch (variable.type) {
691 if (variable.type == VAR_CODE) {
692 hv_delete_ent(namespace, variable.name, G_DISCARD, 0);
697 list_all_symbols(self, vartype=VAR_NONE)
701 if (vartype == VAR_NONE) {
706 namespace = _get_namespace(self);
707 keys = hv_iterinit(namespace);
709 while ((entry = hv_iternext(namespace))) {
710 mPUSHs(newSVhe(entry));
719 namespace = _get_namespace(self);
720 hv_iterinit(namespace);
721 while ((val = hv_iternextsv(namespace, &key, &len))) {
747 else if (vartype == VAR_CODE) {
754 get_all_symbols(self, vartype=VAR_NONE)
763 namespace = _get_namespace(self);
766 hv_iterinit(namespace);
767 while ((val = hv_iternextsv(namespace, &key, &len))) {
771 SV *keysv = newSVpvn(key, len);
772 _expand_glob(self, keysv);
779 hv_store(ret, key, len, newRV_inc(GvSV(gv)), 0);
783 hv_store(ret, key, len, newRV_inc((SV*)GvAV(gv)), 0);
787 hv_store(ret, key, len, newRV_inc((SV*)GvHV(gv)), 0);
791 hv_store(ret, key, len, newRV_inc((SV*)GvCV(gv)), 0);
795 hv_store(ret, key, len, newRV_inc((SV*)GvIO(gv)), 0);
798 hv_store(ret, key, len, SvREFCNT_inc_simple_NN(val), 0);
803 mPUSHs(newRV_noinc((SV*)ret));
809 re = newSVpv("\\A[0-9A-Z_a-z]+(?:::[0-9A-Z_a-z]+)*\\z", 0);
810 valid_module_regex = pregcomp(re, 0);
812 name_key = newSVpvs("name");
813 PERL_HASH(name_hash, "name", 4);
815 namespace_key = newSVpvs("namespace");
816 PERL_HASH(namespace_hash, "namespace", 9);
818 type_key = newSVpvs("type");
819 PERL_HASH(type_hash, "type", 4);