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