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 MUTABLE_PTR(p) ((void *) (p))
36 #define MUTABLE_SV(p) ((SV *)MUTABLE_PTR(p))
40 #define SVT_SCALAR(svt) (svt <= SVt_PVLV)
44 #define SVT_ARRAY(svt) (svt == SVt_PVAV)
48 #define SVT_HASH(svt) (svt == SVt_PVHV)
52 #define SVT_CODE(svt) (svt == SVt_PVCV)
56 #define SVT_IO(svt) (svt == SVt_PVIO)
60 #define SVT_FORMAT(svt) (svt == SVt_PVFM)
63 /* HACK: scalar slots are always populated on perl < 5.10, so treat undef
64 * as nonexistent. this is consistent with the previous behavior of the pure
65 * perl version of this module (since this is the behavior that perl sees
68 #define GvSVOK(g) (GvSV(g) && SvTYPE(GvSV(g)) != SVt_NULL)
70 #define GvSVOK(g) GvSV(g)
73 #define GvAVOK(g) GvAV(g)
74 #define GvHVOK(g) GvHV(g)
75 #define GvCVOK(g) GvCVu(g) /* XXX: should this really be GvCVu? or GvCV? */
76 #define GvIOOK(g) GvIO(g)
78 /* see above - don't let scalar slots become unpopulated, this breaks
79 * assumptions in core */
81 #define GvSetSV(g,v) do { \
83 SvREFCNT_dec(GvSV(g)); \
84 if ((GvSV(g) = _v ? _v : newSV(0))) \
85 GvIMPORTED_SV_on(g); \
88 #define GvSetSV(g,v) do { \
89 SvREFCNT_dec(GvSV(g)); \
90 if ((GvSV(g) = (SV*)(v))) \
91 GvIMPORTED_SV_on(g); \
95 #define GvSetAV(g,v) do { \
96 SvREFCNT_dec(GvAV(g)); \
97 if ((GvAV(g) = (AV*)(v))) \
98 GvIMPORTED_AV_on(g); \
100 #define GvSetHV(g,v) do { \
101 SvREFCNT_dec(GvHV(g)); \
102 if ((GvHV(g) = (HV*)(v))) \
103 GvIMPORTED_HV_on(g); \
105 #define GvSetCV(g,v) do { \
106 SvREFCNT_dec(GvCV(g)); \
107 if ((GvCV_set(g, (CV*)(v)))) { \
108 GvIMPORTED_CV_on(g); \
112 mro_method_changed_in(GvSTASH(g)); \
114 #define GvSetIO(g,v) do { \
115 SvREFCNT_dec(GvIO(g)); \
116 GvIOp(g) = (IO*)(v); \
126 VAR_GLOB, /* TODO: unimplemented */
127 VAR_FORMAT /* TODO: unimplemented */
135 static U32 name_hash, namespace_hash, type_hash;
136 static SV *name_key, *namespace_key, *type_key;
137 static REGEXP *valid_module_regex;
139 static const char *vartype_to_string(vartype_t type)
157 static I32 vartype_to_svtype(vartype_t type)
161 return SVt_PV; /* or whatever */
175 static vartype_t string_to_vartype(char *vartype)
177 if (strEQ(vartype, "SCALAR")) {
180 else if (strEQ(vartype, "ARRAY")) {
183 else if (strEQ(vartype, "HASH")) {
186 else if (strEQ(vartype, "CODE")) {
189 else if (strEQ(vartype, "IO")) {
193 croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO', not '%s'", vartype);
197 static int _is_valid_module_name(SV *package)
203 buf = SvPV(package, len);
205 /* whee cargo cult */
207 sv_upgrade(sv, SVt_PV);
215 return pregexec(valid_module_regex, buf, buf + len, buf, 1, sv, 1);
218 static void _deconstruct_variable_name(SV *variable, varspec_t *varspec)
222 if (!SvCUR(variable))
223 croak("You must pass a variable name");
225 varspec->name = sv_2mortal(newSVsv(variable));
227 varpv = SvPV_nolen(varspec->name);
230 varspec->type = VAR_SCALAR;
231 sv_chop(varspec->name, &varpv[1]);
234 varspec->type = VAR_ARRAY;
235 sv_chop(varspec->name, &varpv[1]);
238 varspec->type = VAR_HASH;
239 sv_chop(varspec->name, &varpv[1]);
242 varspec->type = VAR_CODE;
243 sv_chop(varspec->name, &varpv[1]);
246 varspec->type = VAR_IO;
251 static void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
255 val = hv_fetch_ent(variable, name_key, 0, name_hash);
257 croak("The 'name' key is required in variable specs");
259 varspec->name = sv_2mortal(newSVsv(HeVAL(val)));
261 val = hv_fetch_ent(variable, type_key, 0, type_hash);
263 croak("The 'type' key is required in variable specs");
265 varspec->type = string_to_vartype(SvPV_nolen(HeVAL(val)));
268 static void _check_varspec_is_valid(varspec_t *varspec)
270 if (strstr(SvPV_nolen(varspec->name), "::")) {
271 croak("Variable names may not contain ::");
275 static int _valid_for_type(SV *value, vartype_t type)
277 svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
281 /* XXX is a glob a scalar? assigning a glob to the scalar slot seems
282 * to work here, but in pure perl i'm pretty sure it goes to the EGV
283 * slot, which seems more correct to me. just disable it for now
285 return SVT_SCALAR(sv_type) && sv_type != SVt_PVGV;
287 return SVT_ARRAY(sv_type);
289 return SVT_HASH(sv_type);
291 return SVT_CODE(sv_type);
293 return SVT_IO(sv_type);
299 static HV *_get_namespace(SV *self)
308 call_method("namespace", G_SCALAR);
314 return (HV*)SvRV(ret);
317 static SV *_get_name(SV *self)
326 call_method("name", G_SCALAR);
335 static void _real_gv_init(GV *gv, HV *stash, SV *name)
340 name_pv = SvPV(name, name_len);
341 gv_init(gv, stash, name_pv, name_len, 1);
343 /* XXX: copied and pasted from gv_fetchpvn_flags and such */
344 /* ignoring the stuff for CORE:: and main:: for now, and also
345 * ignoring the GvMULTI_on bits, since we pass 1 to gv_init above */
346 switch (name_pv[0]) {
348 if (strEQ(&name_pv[1], "SA")) {
352 sv_magic(MUTABLE_SV(av), MUTABLE_SV(gv), PERL_MAGIC_isa,
357 if (strEQ(&name_pv[1], "VERLOAD")) {
361 hv_magic(hv, NULL, PERL_MAGIC_overload);
369 static void _expand_glob(SV *self, SV *varname)
375 namespace = _get_namespace(self);
377 if (entry = hv_fetch_ent(namespace, varname, 0, 0)) {
378 glob = (GV*)HeVAL(entry);
380 croak("_expand_glob called on stash slot with expanded glob");
384 _real_gv_init(glob, namespace, varname);
385 if (!hv_store_ent(namespace, varname, (SV*)glob, 0)) {
386 croak("hv_store failed");
391 croak("_expand_glob called on nonexistent stash slot");
395 static SV *_get_symbol(SV *self, varspec_t *variable, int vivify)
401 namespace = _get_namespace(self);
402 entry = hv_fetch_ent(namespace, variable->name, vivify, 0);
406 glob = (GV*)(HeVAL(entry));
408 _expand_glob(self, variable->name);
411 switch (variable->type) {
414 GvSetSV(glob, newSV(0));
418 GvSetAV(glob, newAV());
422 GvSetHV(glob, newHV());
425 croak("Don't know how to vivify CODE variables");
428 GvSetIO(glob, newIO());
431 croak("Unknown type in vivication");
435 switch (variable->type) {
439 return (SV*)GvAV(glob);
441 return (SV*)GvHV(glob);
443 return (SV*)GvCV(glob);
445 return (SV*)GvIO(glob);
451 MODULE = Package::Stash::XS PACKAGE = Package::Stash::XS
462 if (SvPOK(package)) {
463 if (!_is_valid_module_name(package))
464 croak("%s is not a module name", SvPV_nolen(package));
468 if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package), 0)) {
469 SvREFCNT_dec(package);
470 SvREFCNT_dec(instance);
471 croak("Couldn't initialize the 'name' key, hv_store failed");
474 else if (SvROK(package) && SvTYPE(SvRV(package)) == SVt_PVHV) {
477 if (!hv_store(instance, "namespace", 9, SvREFCNT_inc_simple_NN(package), 0)) {
478 SvREFCNT_dec(package);
479 SvREFCNT_dec(instance);
480 croak("Couldn't initialize the 'namespace' key, hv_store failed");
484 croak("Package::Stash->new must be passed the name of the package to access");
487 RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashsv(class, 0));
497 if (!sv_isobject(self))
498 croak("Can't call name as a class method");
499 if (slot = hv_fetch_ent((HV*)SvRV(self), name_key, 0, name_hash)) {
500 RETVAL = SvREFCNT_inc_simple_NN(HeVAL(slot));
503 croak("Can't get the name of an anonymous package");
515 if (!sv_isobject(self))
516 croak("Can't call namespace as a class method");
517 #if PERL_VERSION < 10
518 package_name = _get_name(self);
519 RETVAL = newRV_inc((SV*)gv_stashpv(SvPV_nolen(package_name), GV_ADD));
521 slot = hv_fetch_ent((HV*)SvRV(self), namespace_key, 0, namespace_hash);
523 RETVAL = SvREFCNT_inc_simple_NN(HeVAL(slot));
529 package_name = _get_name(self);
530 namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
531 nsref = newRV_inc((SV*)namespace);
533 if (!hv_store((HV*)SvRV(self), "namespace", 9, nsref, 0)) {
536 croak("Couldn't initialize the 'namespace' key, hv_store failed");
538 RETVAL = SvREFCNT_inc_simple_NN(nsref);
545 add_symbol(self, variable, initial=NULL, ...)
554 if (initial && !_valid_for_type(initial, variable.type))
555 croak("%s is not of type %s",
556 SvPV_nolen(initial), vartype_to_string(variable.type));
558 if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
560 char *filename = NULL;
561 I32 first_line_num = -1, last_line_num = -1;
566 croak("add_symbol: Odd number of elements in %%opts");
568 for (i = 3; i < items; i += 2) {
570 key = SvPV_nolen(ST(i));
571 if (strEQ(key, "filename")) {
572 if (!SvPOK(ST(i + 1)))
573 croak("add_symbol: filename must be a string");
574 filename = SvPV_nolen(ST(i + 1));
576 else if (strEQ(key, "first_line_num")) {
577 if (!SvIOK(ST(i + 1)))
578 croak("add_symbol: first_line_num must be an integer");
579 first_line_num = SvIV(ST(i + 1));
581 else if (strEQ(key, "last_line_num")) {
582 if (!SvIOK(ST(i + 1)))
583 croak("add_symbol: last_line_num must be an integer");
584 last_line_num = SvIV(ST(i + 1));
588 if (!filename || first_line_num == -1) {
590 filename = CopFILE(PL_curcop);
591 if (first_line_num == -1)
592 first_line_num = PL_curcop->cop_line;
595 if (last_line_num == -1)
596 last_line_num = first_line_num;
598 name = newSVsv(_get_name(self));
599 sv_catpvs(name, "::");
600 sv_catsv(name, variable.name);
602 /* http://perldoc.perl.org/perldebguts.html#Debugger-Internals */
603 dbsub = get_hv("DB::sub", 1);
604 dbval = newSVpvf("%s:%d-%d", filename, first_line_num, last_line_num);
605 if (!hv_store_ent(dbsub, name, dbval, 0)) {
606 warn("Failed to update $DB::sub for subroutine %s",
614 /* GV_ADDMULTI rather than GV_ADD because otherwise you get 'used only
615 * once' warnings in some situations... i can't reproduce this, but CMOP
617 namespace = _get_namespace(self);
618 entry = hv_fetch_ent(namespace, variable.name, 0, 0);
620 glob = (GV*)HeVAL(entry);
623 glob = (GV*)newSV(0);
624 _real_gv_init(glob, namespace, variable.name);
625 if (!hv_store_ent(namespace, variable.name, (SV*)glob, 0)) {
626 croak("hv_store failed");
633 if (SvROK(initial)) {
635 SvREFCNT_inc_simple_void_NN(val);
638 val = newSVsv(initial);
641 switch (variable.type) {
661 remove_glob(self, name)
665 hv_delete_ent(_get_namespace(self), name, G_DISCARD, 0);
668 has_symbol(self, variable)
676 namespace = _get_namespace(self);
677 entry = hv_fetch_ent(namespace, variable.name, 0, 0);
684 switch (variable.type) {
686 RETVAL = GvSVOK(glob) ? 1 : 0;
689 RETVAL = GvAVOK(glob) ? 1 : 0;
692 RETVAL = GvHVOK(glob) ? 1 : 0;
695 RETVAL = GvCVOK(glob) ? 1 : 0;
698 RETVAL = GvIOOK(glob) ? 1 : 0;
703 RETVAL = (variable.type == VAR_CODE);
709 get_symbol(self, variable)
715 val = _get_symbol(self, &variable, 0);
718 RETVAL = newRV_inc(val);
723 get_or_add_symbol(self, variable)
729 val = _get_symbol(self, &variable, 1);
732 RETVAL = newRV_inc(val);
737 remove_symbol(self, variable)
745 namespace = _get_namespace(self);
746 entry = hv_fetch_ent(namespace, variable.name, 0, 0);
753 switch (variable.type) {
772 if (variable.type == VAR_CODE) {
773 hv_delete_ent(namespace, variable.name, G_DISCARD, 0);
778 list_all_symbols(self, vartype=VAR_NONE)
782 if (vartype == VAR_NONE) {
787 namespace = _get_namespace(self);
788 keys = hv_iterinit(namespace);
790 while ((entry = hv_iternext(namespace))) {
791 mPUSHs(newSVhe(entry));
800 namespace = _get_namespace(self);
801 hv_iterinit(namespace);
802 while ((val = hv_iternextsv(namespace, &key, &len))) {
828 else if (vartype == VAR_CODE) {
835 get_all_symbols(self, vartype=VAR_NONE)
844 namespace = _get_namespace(self);
847 hv_iterinit(namespace);
848 while ((val = hv_iternextsv(namespace, &key, &len))) {
852 SV *keysv = newSVpvn(key, len);
853 _expand_glob(self, keysv);
860 hv_store(ret, key, len, newRV_inc(GvSV(gv)), 0);
864 hv_store(ret, key, len, newRV_inc((SV*)GvAV(gv)), 0);
868 hv_store(ret, key, len, newRV_inc((SV*)GvHV(gv)), 0);
872 hv_store(ret, key, len, newRV_inc((SV*)GvCV(gv)), 0);
876 hv_store(ret, key, len, newRV_inc((SV*)GvIO(gv)), 0);
879 hv_store(ret, key, len, SvREFCNT_inc_simple_NN(val), 0);
884 mPUSHs(newRV_noinc((SV*)ret));
888 const char *vmre = "\\A[0-9A-Z_a-z]+(?:::[0-9A-Z_a-z]+)*\\z";
889 #if (PERL_VERSION < 9) || ((PERL_VERSION == 9) && (PERL_SUBVERSION < 5))
892 fakepmop.op_pmflags = 0;
893 valid_module_regex = pregcomp(vmre, vmre + strlen(vmre), &fakepmop);
897 re = newSVpv(vmre, 0);
898 valid_module_regex = pregcomp(re, 0);
901 name_key = newSVpvs("name");
902 PERL_HASH(name_hash, "name", 4);
904 namespace_key = newSVpvs("namespace");
905 PERL_HASH(namespace_hash, "namespace", 9);
907 type_key = newSVpvs("type");
908 PERL_HASH(type_hash, "type", 4);