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;
130 static const char *vartype_to_string(vartype_t type)
148 static I32 vartype_to_svtype(vartype_t type)
152 return SVt_PV; /* or whatever */
166 static vartype_t string_to_vartype(char *vartype)
168 if (strEQ(vartype, "SCALAR")) {
171 else if (strEQ(vartype, "ARRAY")) {
174 else if (strEQ(vartype, "HASH")) {
177 else if (strEQ(vartype, "CODE")) {
180 else if (strEQ(vartype, "IO")) {
184 croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO', not '%s'", vartype);
188 static void _deconstruct_variable_name(SV *variable, varspec_t *varspec)
192 if (!SvCUR(variable))
193 croak("You must pass a variable name");
195 varspec->name = sv_2mortal(newSVsv(variable));
197 varpv = SvPV_nolen(varspec->name);
200 varspec->type = VAR_SCALAR;
201 sv_chop(varspec->name, &varpv[1]);
204 varspec->type = VAR_ARRAY;
205 sv_chop(varspec->name, &varpv[1]);
208 varspec->type = VAR_HASH;
209 sv_chop(varspec->name, &varpv[1]);
212 varspec->type = VAR_CODE;
213 sv_chop(varspec->name, &varpv[1]);
216 varspec->type = VAR_IO;
221 static void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
225 val = hv_fetch_ent(variable, name_key, 0, name_hash);
227 croak("The 'name' key is required in variable specs");
229 varspec->name = sv_2mortal(newSVsv(HeVAL(val)));
231 val = hv_fetch_ent(variable, type_key, 0, type_hash);
233 croak("The 'type' key is required in variable specs");
235 varspec->type = string_to_vartype(SvPV_nolen(HeVAL(val)));
238 static void _check_varspec_is_valid(varspec_t *varspec)
240 if (strstr(SvPV_nolen(varspec->name), "::")) {
241 croak("Variable names may not contain ::");
245 static int _valid_for_type(SV *value, vartype_t type)
247 svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
251 /* XXX is a glob a scalar? assigning a glob to the scalar slot seems
252 * to work here, but in pure perl i'm pretty sure it goes to the EGV
253 * slot, which seems more correct to me. just disable it for now
255 return SVT_SCALAR(sv_type) && sv_type != SVt_PVGV;
257 return SVT_ARRAY(sv_type);
259 return SVT_HASH(sv_type);
261 return SVT_CODE(sv_type);
263 return SVT_IO(sv_type);
269 static HV *_get_namespace(SV *self)
278 call_method("namespace", G_SCALAR);
284 return (HV*)SvRV(ret);
287 static SV *_get_name(SV *self)
296 call_method("name", G_SCALAR);
305 static void _expand_glob(SV *self, SV *varname)
309 name = newSVsv(_get_name(self));
310 sv_catpvs(name, "::");
311 sv_catsv(name, varname);
313 /* can't use gv_init here, because it screws up @ISA in a way that I
314 * can't reproduce, but that CMOP triggers */
315 gv_fetchsv(name, GV_ADD, SVt_NULL);
319 static SV *_get_symbol(SV *self, varspec_t *variable, int vivify)
325 namespace = _get_namespace(self);
326 entry = hv_fetch_ent(namespace, variable->name, vivify, 0);
330 glob = (GV*)(HeVAL(entry));
332 _expand_glob(self, variable->name);
335 switch (variable->type) {
338 GvSetSV(glob, newSV(0));
342 GvSetAV(glob, newAV());
346 GvSetHV(glob, newHV());
349 croak("Don't know how to vivify CODE variables");
352 GvSetIO(glob, newIO());
355 croak("Unknown type in vivication");
359 switch (variable->type) {
363 return (SV*)GvAV(glob);
365 return (SV*)GvHV(glob);
367 return (SV*)GvCV(glob);
369 return (SV*)GvIO(glob);
375 MODULE = Package::Stash::XS PACKAGE = Package::Stash::XS
380 new(class, package_name)
386 if (!SvPOK(package_name))
387 croak("The constructor argument must be the name of a package");
391 if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package_name), 0)) {
392 SvREFCNT_dec(package_name);
393 SvREFCNT_dec(instance);
394 croak("Couldn't initialize the 'name' key, hv_store failed");
397 RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashsv(class, 0));
407 if (!sv_isobject(self))
408 croak("Can't call name as a class method");
409 slot = hv_fetch_ent((HV*)SvRV(self), name_key, 0, name_hash);
410 RETVAL = slot ? SvREFCNT_inc_simple_NN(HeVAL(slot)) : &PL_sv_undef;
421 if (!sv_isobject(self))
422 croak("Can't call namespace as a class method");
423 #if PERL_VERSION < 10
424 package_name = _get_name(self);
425 RETVAL = newRV_inc((SV*)gv_stashpv(SvPV_nolen(package_name), GV_ADD));
427 slot = hv_fetch_ent((HV*)SvRV(self), namespace_key, 0, namespace_hash);
429 RETVAL = SvREFCNT_inc_simple_NN(HeVAL(slot));
435 package_name = _get_name(self);
436 namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
437 nsref = newRV_inc((SV*)namespace);
439 if (!hv_store((HV*)SvRV(self), "namespace", 9, nsref, 0)) {
442 croak("Couldn't initialize the 'namespace' key, hv_store failed");
444 RETVAL = SvREFCNT_inc_simple_NN(nsref);
451 add_symbol(self, variable, initial=NULL, ...)
459 if (initial && !_valid_for_type(initial, variable.type))
460 croak("%s is not of type %s",
461 SvPV_nolen(initial), vartype_to_string(variable.type));
463 name = newSVsv(_get_name(self));
464 sv_catpvs(name, "::");
465 sv_catsv(name, variable.name);
467 if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
469 char *filename = NULL;
470 I32 first_line_num = -1, last_line_num = -1;
475 croak("add_symbol: Odd number of elements in %%opts");
477 for (i = 3; i < items; i += 2) {
479 key = SvPV_nolen(ST(i));
480 if (strEQ(key, "filename")) {
481 if (!SvPOK(ST(i + 1)))
482 croak("add_symbol: filename must be a string");
483 filename = SvPV_nolen(ST(i + 1));
485 else if (strEQ(key, "first_line_num")) {
486 if (!SvIOK(ST(i + 1)))
487 croak("add_symbol: first_line_num must be an integer");
488 first_line_num = SvIV(ST(i + 1));
490 else if (strEQ(key, "last_line_num")) {
491 if (!SvIOK(ST(i + 1)))
492 croak("add_symbol: last_line_num must be an integer");
493 last_line_num = SvIV(ST(i + 1));
497 if (!filename || first_line_num == -1) {
499 filename = CopFILE(PL_curcop);
500 if (first_line_num == -1)
501 first_line_num = PL_curcop->cop_line;
504 if (last_line_num == -1)
505 last_line_num = first_line_num;
507 /* http://perldoc.perl.org/perldebguts.html#Debugger-Internals */
508 dbsub = get_hv("DB::sub", 1);
509 dbval = newSVpvf("%s:%d-%d", filename, first_line_num, last_line_num);
510 if (!hv_store_ent(dbsub, name, dbval, 0)) {
511 warn("Failed to update $DB::sub for subroutine %s",
517 /* GV_ADDMULTI rather than GV_ADD because otherwise you get 'used only
518 * once' warnings in some situations... i can't reproduce this, but CMOP
520 glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
525 if (SvROK(initial)) {
527 SvREFCNT_inc_simple_void_NN(val);
530 val = newSVsv(initial);
533 switch (variable.type) {
555 remove_glob(self, name)
559 hv_delete_ent(_get_namespace(self), name, G_DISCARD, 0);
562 has_symbol(self, variable)
570 namespace = _get_namespace(self);
571 entry = hv_fetch_ent(namespace, variable.name, 0, 0);
578 switch (variable.type) {
580 RETVAL = GvSVOK(glob) ? 1 : 0;
583 RETVAL = GvAVOK(glob) ? 1 : 0;
586 RETVAL = GvHVOK(glob) ? 1 : 0;
589 RETVAL = GvCVOK(glob) ? 1 : 0;
592 RETVAL = GvIOOK(glob) ? 1 : 0;
597 RETVAL = (variable.type == VAR_CODE);
603 get_symbol(self, variable)
609 val = _get_symbol(self, &variable, 0);
612 RETVAL = newRV_inc(val);
617 get_or_add_symbol(self, variable)
623 val = _get_symbol(self, &variable, 1);
626 RETVAL = newRV_inc(val);
631 remove_symbol(self, variable)
639 namespace = _get_namespace(self);
640 entry = hv_fetch_ent(namespace, variable.name, 0, 0);
647 switch (variable.type) {
666 if (variable.type == VAR_CODE) {
667 hv_delete_ent(namespace, variable.name, G_DISCARD, 0);
672 list_all_symbols(self, vartype=VAR_NONE)
676 if (vartype == VAR_NONE) {
681 namespace = _get_namespace(self);
682 keys = hv_iterinit(namespace);
684 while ((entry = hv_iternext(namespace))) {
685 mPUSHs(newSVhe(entry));
694 namespace = _get_namespace(self);
695 hv_iterinit(namespace);
696 while ((val = hv_iternextsv(namespace, &key, &len))) {
722 else if (vartype == VAR_CODE) {
729 get_all_symbols(self, vartype=VAR_NONE)
738 namespace = _get_namespace(self);
741 hv_iterinit(namespace);
742 while ((val = hv_iternextsv(namespace, &key, &len))) {
746 SV *keysv = newSVpvn(key, len);
747 _expand_glob(self, keysv);
754 hv_store(ret, key, len, newRV_inc(GvSV(gv)), 0);
758 hv_store(ret, key, len, newRV_inc((SV*)GvAV(gv)), 0);
762 hv_store(ret, key, len, newRV_inc((SV*)GvHV(gv)), 0);
766 hv_store(ret, key, len, newRV_inc((SV*)GvCV(gv)), 0);
770 hv_store(ret, key, len, newRV_inc((SV*)GvIO(gv)), 0);
773 hv_store(ret, key, len, SvREFCNT_inc_simple_NN(val), 0);
778 mPUSHs(newRV_noinc((SV*)ret));
782 name_key = newSVpvs("name");
783 PERL_HASH(name_hash, "name", 4);
785 namespace_key = newSVpvs("namespace");
786 PERL_HASH(namespace_hash, "namespace", 9);
788 type_key = newSVpvs("type");
789 PERL_HASH(type_hash, "type", 4);