don't allow variable names that contain ::
[gitmo/Package-Stash-XS.git] / XS.xs
1 #include "EXTERN.h"
2 #include "perl.h"
3 #include "XSUB.h"
4
5 #define NEED_newRV_noinc
6 #define NEED_sv_2pv_flags
7 #include "ppport.h"
8
9 #ifndef gv_fetchsv
10 #define gv_fetchsv(n,f,t) gv_fetchpv(SvPV_nolen(n), f, t)
11 #endif
12
13 #ifndef mro_method_changed_in
14 #define mro_method_changed_in(x) PL_sub_generation++
15 #endif
16
17 #ifdef newSVhek
18 #define newSVhe(he) newSVhek(HeKEY_hek(he))
19 #else
20 #define newSVhe(he) newSVpv(HePV(he, PL_na), 0)
21 #endif
22
23 #ifndef savesvpv
24 #define savesvpv(s) savepv(SvPV_nolen(s))
25 #endif
26
27 #ifndef GvCV_set
28 #define GvCV_set(gv, cv) (GvCV(gv) = (CV*)(cv))
29 #endif
30
31 #ifndef SVT_SCALAR
32 #define SVT_SCALAR(svt) (svt <= SVt_PVLV)
33 #endif
34
35 #ifndef SVT_ARRAY
36 #define SVT_ARRAY(svt) (svt == SVt_PVAV)
37 #endif
38
39 #ifndef SVT_HASH
40 #define SVT_HASH(svt) (svt == SVt_PVHV)
41 #endif
42
43 #ifndef SVT_CODE
44 #define SVT_CODE(svt) (svt == SVt_PVCV)
45 #endif
46
47 #ifndef SVT_IO
48 #define SVT_IO(svt) (svt == SVt_PVIO)
49 #endif
50
51 #ifndef SVT_FORMAT
52 #define SVT_FORMAT(svt) (svt == SVt_PVFM)
53 #endif
54
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
58  * in all versions */
59 #if PERL_VERSION < 10
60 #define GvSVOK(g) (GvSV(g) && SvTYPE(GvSV(g)) != SVt_NULL)
61 #else
62 #define GvSVOK(g) GvSV(g)
63 #endif
64
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)
69
70 /* see above - don't let scalar slots become unpopulated, this breaks
71  * assumptions in core */
72 #if PERL_VERSION < 10
73 #define GvSetSV(g,v) do {               \
74     SV *_v = (SV*)(v);                  \
75     SvREFCNT_dec(GvSV(g));              \
76     if ((GvSV(g) = _v ? _v : newSV(0))) \
77         GvIMPORTED_SV_on(g);            \
78 } while (0)
79 #else
80 #define GvSetSV(g,v) do {               \
81     SvREFCNT_dec(GvSV(g));              \
82     if ((GvSV(g) = (SV*)(v)))           \
83         GvIMPORTED_SV_on(g);            \
84 } while (0)
85 #endif
86
87 #define GvSetAV(g,v) do {               \
88     SvREFCNT_dec(GvAV(g));              \
89     if ((GvAV(g) = (AV*)(v)))           \
90         GvIMPORTED_AV_on(g);            \
91 } while (0)
92 #define GvSetHV(g,v) do {               \
93     SvREFCNT_dec(GvHV(g));              \
94     if ((GvHV(g) = (HV*)(v)))           \
95         GvIMPORTED_HV_on(g);            \
96 } while (0)
97 #define GvSetCV(g,v) do {               \
98     SvREFCNT_dec(GvCV(g));              \
99     if ((GvCV_set(g, v))) {             \
100         GvIMPORTED_CV_on(g);            \
101         GvASSUMECV_on(g);               \
102     }                                   \
103     GvCVGEN(g) = 0;                     \
104     mro_method_changed_in(GvSTASH(g));  \
105 } while (0)
106 #define GvSetIO(g,v) do {               \
107     SvREFCNT_dec(GvIO(g));              \
108     GvIOp(g) = (IO*)(v);                \
109 } while (0)
110
111 typedef enum {
112     VAR_NONE = 0,
113     VAR_SCALAR,
114     VAR_ARRAY,
115     VAR_HASH,
116     VAR_CODE,
117     VAR_IO,
118     VAR_GLOB,  /* TODO: unimplemented */
119     VAR_FORMAT /* TODO: unimplemented */
120 } vartype_t;
121
122 typedef struct {
123     vartype_t type;
124     SV *name;
125 } varspec_t;
126
127 static U32 name_hash, namespace_hash, type_hash;
128 static SV *name_key, *namespace_key, *type_key;
129
130 static const char *vartype_to_string(vartype_t type)
131 {
132     switch (type) {
133     case VAR_SCALAR:
134         return "SCALAR";
135     case VAR_ARRAY:
136         return "ARRAY";
137     case VAR_HASH:
138         return "HASH";
139     case VAR_CODE:
140         return "CODE";
141     case VAR_IO:
142         return "IO";
143     default:
144         return "unknown";
145     }
146 }
147
148 static I32 vartype_to_svtype(vartype_t type)
149 {
150     switch (type) {
151     case VAR_SCALAR:
152         return SVt_PV; /* or whatever */
153     case VAR_ARRAY:
154         return SVt_PVAV;
155     case VAR_HASH:
156         return SVt_PVHV;
157     case VAR_CODE:
158         return SVt_PVCV;
159     case VAR_IO:
160         return SVt_PVIO;
161     default:
162         return SVt_NULL;
163     }
164 }
165
166 static vartype_t string_to_vartype(char *vartype)
167 {
168     if (strEQ(vartype, "SCALAR")) {
169         return VAR_SCALAR;
170     }
171     else if (strEQ(vartype, "ARRAY")) {
172         return VAR_ARRAY;
173     }
174     else if (strEQ(vartype, "HASH")) {
175         return VAR_HASH;
176     }
177     else if (strEQ(vartype, "CODE")) {
178         return VAR_CODE;
179     }
180     else if (strEQ(vartype, "IO")) {
181         return VAR_IO;
182     }
183     else {
184         croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO', not '%s'", vartype);
185     }
186 }
187
188 static void _deconstruct_variable_name(SV *variable, varspec_t *varspec)
189 {
190     char *varpv;
191
192     if (!SvCUR(variable))
193         croak("You must pass a variable name");
194
195     varspec->name = sv_2mortal(newSVsv(variable));
196
197     varpv = SvPV_nolen(varspec->name);
198     switch (varpv[0]) {
199     case '$':
200         varspec->type = VAR_SCALAR;
201         sv_chop(varspec->name, &varpv[1]);
202         break;
203     case '@':
204         varspec->type = VAR_ARRAY;
205         sv_chop(varspec->name, &varpv[1]);
206         break;
207     case '%':
208         varspec->type = VAR_HASH;
209         sv_chop(varspec->name, &varpv[1]);
210         break;
211     case '&':
212         varspec->type = VAR_CODE;
213         sv_chop(varspec->name, &varpv[1]);
214         break;
215     default:
216         varspec->type = VAR_IO;
217         break;
218     }
219 }
220
221 static void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
222 {
223     HE *val;
224
225     val = hv_fetch_ent(variable, name_key, 0, name_hash);
226     if (!val)
227         croak("The 'name' key is required in variable specs");
228
229     varspec->name = sv_2mortal(newSVsv(HeVAL(val)));
230
231     val = hv_fetch_ent(variable, type_key, 0, type_hash);
232     if (!val)
233         croak("The 'type' key is required in variable specs");
234
235     varspec->type = string_to_vartype(SvPV_nolen(HeVAL(val)));
236 }
237
238 static void _check_varspec_is_valid(varspec_t *varspec)
239 {
240     if (strstr(SvPV_nolen(varspec->name), "::")) {
241         croak("Variable names may not contain ::");
242     }
243 }
244
245 static int _valid_for_type(SV *value, vartype_t type)
246 {
247     svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
248
249     switch (type) {
250     case VAR_SCALAR:
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
254          * i guess */
255         return SVT_SCALAR(sv_type) && sv_type != SVt_PVGV;
256     case VAR_ARRAY:
257         return SVT_ARRAY(sv_type);
258     case VAR_HASH:
259         return SVT_HASH(sv_type);
260     case VAR_CODE:
261         return SVT_CODE(sv_type);
262     case VAR_IO:
263         return SVT_IO(sv_type);
264     default:
265         return 0;
266     }
267 }
268
269 static HV *_get_namespace(SV *self)
270 {
271     dSP;
272     SV *ret;
273
274     PUSHMARK(SP);
275     XPUSHs(self);
276     PUTBACK;
277
278     call_method("namespace", G_SCALAR);
279
280     SPAGAIN;
281     ret = POPs;
282     PUTBACK;
283
284     return (HV*)SvRV(ret);
285 }
286
287 static SV *_get_name(SV *self)
288 {
289     dSP;
290     SV *ret;
291
292     PUSHMARK(SP);
293     XPUSHs(self);
294     PUTBACK;
295
296     call_method("name", G_SCALAR);
297
298     SPAGAIN;
299     ret = POPs;
300     PUTBACK;
301
302     return ret;
303 }
304
305 static void _expand_glob(SV *self, SV *varname)
306 {
307     SV *name;
308
309     name = newSVsv(_get_name(self));
310     sv_catpvs(name, "::");
311     sv_catsv(name, varname);
312
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);
316     SvREFCNT_dec(name);
317 }
318
319 static SV *_get_symbol(SV *self, varspec_t *variable, int vivify)
320 {
321     HV *namespace;
322     HE *entry;
323     GV *glob;
324
325     namespace = _get_namespace(self);
326     entry = hv_fetch_ent(namespace, variable->name, vivify, 0);
327     if (!entry)
328         return NULL;
329
330     glob = (GV*)(HeVAL(entry));
331     if (!isGV(glob))
332         _expand_glob(self, variable->name);
333
334     if (vivify) {
335         switch (variable->type) {
336         case VAR_SCALAR:
337             if (!GvSVOK(glob))
338                 GvSetSV(glob, newSV(0));
339             break;
340         case VAR_ARRAY:
341             if (!GvAVOK(glob))
342                 GvSetAV(glob, newAV());
343             break;
344         case VAR_HASH:
345             if (!GvHVOK(glob))
346                 GvSetHV(glob, newHV());
347             break;
348         case VAR_CODE:
349             croak("Don't know how to vivify CODE variables");
350         case VAR_IO:
351             if (!GvIOOK(glob))
352                 GvSetIO(glob, newIO());
353             break;
354         default:
355             croak("Unknown type in vivication");
356         }
357     }
358
359     switch (variable->type) {
360     case VAR_SCALAR:
361         return GvSV(glob);
362     case VAR_ARRAY:
363         return (SV*)GvAV(glob);
364     case VAR_HASH:
365         return (SV*)GvHV(glob);
366     case VAR_CODE:
367         return (SV*)GvCV(glob);
368     case VAR_IO:
369         return (SV*)GvIO(glob);
370     default:
371         return NULL;
372     }
373 }
374
375 MODULE = Package::Stash::XS  PACKAGE = Package::Stash::XS
376
377 PROTOTYPES: DISABLE
378
379 SV*
380 new(class, package_name)
381     SV *class
382     SV *package_name
383   PREINIT:
384     HV *instance;
385   CODE:
386     if (!SvPOK(package_name))
387         croak("The constructor argument must be the name of a package");
388
389     instance = newHV();
390
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");
395     }
396
397     RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashsv(class, 0));
398   OUTPUT:
399     RETVAL
400
401 SV*
402 name(self)
403     SV *self
404   PREINIT:
405     HE *slot;
406   CODE:
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;
411   OUTPUT:
412     RETVAL
413
414 SV*
415 namespace(self)
416     SV *self
417   PREINIT:
418     HE *slot;
419     SV *package_name;
420   CODE:
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));
426 #else
427     slot = hv_fetch_ent((HV*)SvRV(self), namespace_key, 0, namespace_hash);
428     if (slot) {
429         RETVAL = SvREFCNT_inc_simple_NN(HeVAL(slot));
430     }
431     else {
432         HV *namespace;
433         SV *nsref;
434
435         package_name = _get_name(self);
436         namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
437         nsref = newRV_inc((SV*)namespace);
438         sv_rvweaken(nsref);
439         if (!hv_store((HV*)SvRV(self), "namespace", 9, nsref, 0)) {
440             SvREFCNT_dec(nsref);
441             SvREFCNT_dec(self);
442             croak("Couldn't initialize the 'namespace' key, hv_store failed");
443         }
444         RETVAL = SvREFCNT_inc_simple_NN(nsref);
445     }
446 #endif
447   OUTPUT:
448     RETVAL
449
450 void
451 add_symbol(self, variable, initial=NULL, ...)
452     SV *self
453     varspec_t variable
454     SV *initial
455   PREINIT:
456     SV *name;
457     GV *glob;
458   CODE:
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));
462
463     name = newSVsv(_get_name(self));
464     sv_catpvs(name, "::");
465     sv_catsv(name, variable.name);
466
467     if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
468         int i;
469         char *filename = NULL;
470         I32 first_line_num = -1, last_line_num = -1;
471         SV *dbval;
472         HV *dbsub;
473
474         if ((items - 3) % 2)
475             croak("add_symbol: Odd number of elements in %%opts");
476
477         for (i = 3; i < items; i += 2) {
478             char *key;
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));
484             }
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));
489             }
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));
494             }
495         }
496
497         if (!filename || first_line_num == -1) {
498             if (!filename)
499                 filename = CopFILE(PL_curcop);
500             if (first_line_num == -1)
501                 first_line_num = PL_curcop->cop_line;
502         }
503
504         if (last_line_num == -1)
505             last_line_num = first_line_num;
506
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",
512                  SvPV_nolen(name));
513             SvREFCNT_dec(dbval);
514         }
515     }
516
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
519      * triggers it */
520     glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
521
522     if (initial) {
523         SV *val;
524
525         if (SvROK(initial)) {
526             val = SvRV(initial);
527             SvREFCNT_inc_simple_void_NN(val);
528         }
529         else {
530             val = newSVsv(initial);
531         }
532
533         switch (variable.type) {
534         case VAR_SCALAR:
535             GvSetSV(glob, val);
536             break;
537         case VAR_ARRAY:
538             GvSetAV(glob, val);
539             break;
540         case VAR_HASH:
541             GvSetHV(glob, val);
542             break;
543         case VAR_CODE:
544             GvSetCV(glob, val);
545             break;
546         case VAR_IO:
547             GvSetIO(glob, val);
548             break;
549         }
550     }
551
552     SvREFCNT_dec(name);
553
554 void
555 remove_glob(self, name)
556     SV *self
557     SV *name
558   CODE:
559     hv_delete_ent(_get_namespace(self), name, G_DISCARD, 0);
560
561 int
562 has_symbol(self, variable)
563     SV *self
564     varspec_t variable
565   PREINIT:
566     HV *namespace;
567     HE *entry;
568     SV *val;
569   CODE:
570     namespace = _get_namespace(self);
571     entry = hv_fetch_ent(namespace, variable.name, 0, 0);
572     if (!entry)
573         XSRETURN_UNDEF;
574
575     val = HeVAL(entry);
576     if (isGV(val)) {
577         GV *glob = (GV*)val;
578         switch (variable.type) {
579         case VAR_SCALAR:
580             RETVAL = GvSVOK(glob) ? 1 : 0;
581             break;
582         case VAR_ARRAY:
583             RETVAL = GvAVOK(glob) ? 1 : 0;
584             break;
585         case VAR_HASH:
586             RETVAL = GvHVOK(glob) ? 1 : 0;
587             break;
588         case VAR_CODE:
589             RETVAL = GvCVOK(glob) ? 1 : 0;
590             break;
591         case VAR_IO:
592             RETVAL = GvIOOK(glob) ? 1 : 0;
593             break;
594         }
595     }
596     else {
597         RETVAL = (variable.type == VAR_CODE);
598     }
599   OUTPUT:
600     RETVAL
601
602 SV*
603 get_symbol(self, variable)
604     SV *self
605     varspec_t variable
606   PREINIT:
607     SV *val;
608   CODE:
609     val = _get_symbol(self, &variable, 0);
610     if (!val)
611         XSRETURN_UNDEF;
612     RETVAL = newRV_inc(val);
613   OUTPUT:
614     RETVAL
615
616 SV*
617 get_or_add_symbol(self, variable)
618     SV *self
619     varspec_t variable
620   PREINIT:
621     SV *val;
622   CODE:
623     val = _get_symbol(self, &variable, 1);
624     if (!val)
625         XSRETURN_UNDEF;
626     RETVAL = newRV_inc(val);
627   OUTPUT:
628     RETVAL
629
630 void
631 remove_symbol(self, variable)
632     SV *self
633     varspec_t variable
634   PREINIT:
635     HV *namespace;
636     HE *entry;
637     SV *val;
638   CODE:
639     namespace = _get_namespace(self);
640     entry = hv_fetch_ent(namespace, variable.name, 0, 0);
641     if (!entry)
642         XSRETURN_EMPTY;
643
644     val = HeVAL(entry);
645     if (isGV(val)) {
646         GV *glob = (GV*)val;
647         switch (variable.type) {
648         case VAR_SCALAR:
649             GvSetSV(glob, NULL);
650             break;
651         case VAR_ARRAY:
652             GvSetAV(glob, NULL);
653             break;
654         case VAR_HASH:
655             GvSetHV(glob, NULL);
656             break;
657         case VAR_CODE:
658             GvSetCV(glob, NULL);
659             break;
660         case VAR_IO:
661             GvSetIO(glob, NULL);
662             break;
663         }
664     }
665     else {
666         if (variable.type == VAR_CODE) {
667             hv_delete_ent(namespace, variable.name, G_DISCARD, 0);
668         }
669     }
670
671 void
672 list_all_symbols(self, vartype=VAR_NONE)
673     SV *self
674     vartype_t vartype
675   PPCODE:
676     if (vartype == VAR_NONE) {
677         HV *namespace;
678         HE *entry;
679         int keys;
680
681         namespace = _get_namespace(self);
682         keys = hv_iterinit(namespace);
683         EXTEND(SP, keys);
684         while ((entry = hv_iternext(namespace))) {
685             mPUSHs(newSVhe(entry));
686         }
687     }
688     else {
689         HV *namespace;
690         SV *val;
691         char *key;
692         I32 len;
693
694         namespace = _get_namespace(self);
695         hv_iterinit(namespace);
696         while ((val = hv_iternextsv(namespace, &key, &len))) {
697             GV *gv = (GV*)val;
698             if (isGV(gv)) {
699                 switch (vartype) {
700                 case VAR_SCALAR:
701                     if (GvSVOK(val))
702                         mXPUSHp(key, len);
703                     break;
704                 case VAR_ARRAY:
705                     if (GvAVOK(val))
706                         mXPUSHp(key, len);
707                     break;
708                 case VAR_HASH:
709                     if (GvHVOK(val))
710                         mXPUSHp(key, len);
711                     break;
712                 case VAR_CODE:
713                     if (GvCVOK(val))
714                         mXPUSHp(key, len);
715                     break;
716                 case VAR_IO:
717                     if (GvIOOK(val))
718                         mXPUSHp(key, len);
719                     break;
720                 }
721             }
722             else if (vartype == VAR_CODE) {
723                 mXPUSHp(key, len);
724             }
725         }
726     }
727
728 void
729 get_all_symbols(self, vartype=VAR_NONE)
730     SV *self
731     vartype_t vartype
732   PREINIT:
733     HV *namespace, *ret;
734     SV *val;
735     char *key;
736     I32 len;
737   PPCODE:
738     namespace = _get_namespace(self);
739     ret = newHV();
740
741     hv_iterinit(namespace);
742     while ((val = hv_iternextsv(namespace, &key, &len))) {
743         GV *gv = (GV*)val;
744
745         if (!isGV(gv)) {
746             SV *keysv = newSVpvn(key, len);
747             _expand_glob(self, keysv);
748             SvREFCNT_dec(keysv);
749         }
750
751         switch (vartype) {
752         case VAR_SCALAR:
753             if (GvSVOK(val))
754                 hv_store(ret, key, len, newRV_inc(GvSV(gv)), 0);
755             break;
756         case VAR_ARRAY:
757             if (GvAVOK(val))
758                 hv_store(ret, key, len, newRV_inc((SV*)GvAV(gv)), 0);
759             break;
760         case VAR_HASH:
761             if (GvHVOK(val))
762                 hv_store(ret, key, len, newRV_inc((SV*)GvHV(gv)), 0);
763             break;
764         case VAR_CODE:
765             if (GvCVOK(val))
766                 hv_store(ret, key, len, newRV_inc((SV*)GvCV(gv)), 0);
767             break;
768         case VAR_IO:
769             if (GvIOOK(val))
770                 hv_store(ret, key, len, newRV_inc((SV*)GvIO(gv)), 0);
771             break;
772         case VAR_NONE:
773             hv_store(ret, key, len, SvREFCNT_inc_simple_NN(val), 0);
774             break;
775         }
776     }
777
778     mPUSHs(newRV_noinc((SV*)ret));
779
780 BOOT:
781     {
782         name_key = newSVpvs("name");
783         PERL_HASH(name_hash, "name", 4);
784
785         namespace_key = newSVpvs("namespace");
786         PERL_HASH(namespace_hash, "namespace", 9);
787
788         type_key = newSVpvs("type");
789         PERL_HASH(type_hash, "type", 4);
790     }