ea1a402e380e59941afb9d40f375e8cae41c4e1a
[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         SV *dbval;
439         HV *dbsub;
440
441         if ((items - 3) % 2)
442             croak("add_symbol: Odd number of elements in %%opts");
443
444         for (i = 3; i < items; i += 2) {
445             char *key;
446             key = SvPV_nolen(ST(i));
447             if (strEQ(key, "filename")) {
448                 if (!SvPOK(ST(i + 1)))
449                     croak("add_symbol: filename must be a string");
450                 filename = SvPV_nolen(ST(i + 1));
451             }
452             else if (strEQ(key, "first_line_num")) {
453                 if (!SvIOK(ST(i + 1)))
454                     croak("add_symbol: first_line_num must be an integer");
455                 first_line_num = SvIV(ST(i + 1));
456             }
457             else if (strEQ(key, "last_line_num")) {
458                 if (!SvIOK(ST(i + 1)))
459                     croak("add_symbol: last_line_num must be an integer");
460                 last_line_num = SvIV(ST(i + 1));
461             }
462         }
463
464         if (!filename || first_line_num == -1) {
465             if (!filename)
466                 filename = CopFILE(PL_curcop);
467             if (first_line_num == -1)
468                 first_line_num = PL_curcop->cop_line;
469         }
470
471         if (last_line_num == -1)
472             last_line_num = first_line_num;
473
474         /* http://perldoc.perl.org/perldebguts.html#Debugger-Internals */
475         dbsub = get_hv("DB::sub", 1);
476         dbval = newSVpvf("%s:%d-%d", filename, first_line_num, last_line_num);
477         if (!hv_store_ent(dbsub, name, dbval, 0)) {
478             warn("Failed to update $DB::sub for subroutine %s",
479                  SvPV_nolen(name));
480             SvREFCNT_dec(dbval);
481         }
482     }
483
484     /* GV_ADDMULTI rather than GV_ADD because otherwise you get 'used only
485      * once' warnings in some situations... i can't reproduce this, but CMOP
486      * triggers it */
487     glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
488
489     if (initial) {
490         SV *val;
491
492         if (SvROK(initial)) {
493             val = SvRV(initial);
494             SvREFCNT_inc_simple_void_NN(val);
495         }
496         else {
497             val = newSVsv(initial);
498         }
499
500         switch (variable.type) {
501         case VAR_SCALAR:
502             GvSetSV(glob, val);
503             break;
504         case VAR_ARRAY:
505             GvSetAV(glob, val);
506             break;
507         case VAR_HASH:
508             GvSetHV(glob, val);
509             break;
510         case VAR_CODE:
511             GvSetCV(glob, val);
512             break;
513         case VAR_IO:
514             GvSetIO(glob, val);
515             break;
516         }
517     }
518
519     SvREFCNT_dec(name);
520
521 void
522 remove_glob(self, name)
523     SV *self
524     SV *name
525   CODE:
526     hv_delete_ent(_get_namespace(self), name, G_DISCARD, 0);
527
528 int
529 has_symbol(self, variable)
530     SV *self
531     varspec_t variable
532   PREINIT:
533     HV *namespace;
534     HE *entry;
535     SV *val;
536   CODE:
537     namespace = _get_namespace(self);
538     entry = hv_fetch_ent(namespace, variable.name, 0, 0);
539     if (!entry)
540         XSRETURN_UNDEF;
541
542     val = HeVAL(entry);
543     if (isGV(val)) {
544         GV *glob = (GV*)val;
545         switch (variable.type) {
546         case VAR_SCALAR:
547             RETVAL = GvSVOK(glob) ? 1 : 0;
548             break;
549         case VAR_ARRAY:
550             RETVAL = GvAVOK(glob) ? 1 : 0;
551             break;
552         case VAR_HASH:
553             RETVAL = GvHVOK(glob) ? 1 : 0;
554             break;
555         case VAR_CODE:
556             RETVAL = GvCVOK(glob) ? 1 : 0;
557             break;
558         case VAR_IO:
559             RETVAL = GvIOOK(glob) ? 1 : 0;
560             break;
561         }
562     }
563     else {
564         RETVAL = (variable.type == VAR_CODE);
565     }
566   OUTPUT:
567     RETVAL
568
569 SV*
570 get_symbol(self, variable)
571     SV *self
572     varspec_t variable
573   PREINIT:
574     SV *val;
575   CODE:
576     val = _get_symbol(self, &variable, 0);
577     if (!val)
578         XSRETURN_UNDEF;
579     RETVAL = newRV_inc(val);
580   OUTPUT:
581     RETVAL
582
583 SV*
584 get_or_add_symbol(self, variable)
585     SV *self
586     varspec_t variable
587   PREINIT:
588     SV *val;
589   CODE:
590     val = _get_symbol(self, &variable, 1);
591     if (!val)
592         XSRETURN_UNDEF;
593     RETVAL = newRV_inc(val);
594   OUTPUT:
595     RETVAL
596
597 void
598 remove_symbol(self, variable)
599     SV *self
600     varspec_t variable
601   PREINIT:
602     HV *namespace;
603     HE *entry;
604     SV *val;
605   CODE:
606     namespace = _get_namespace(self);
607     entry = hv_fetch_ent(namespace, variable.name, 0, 0);
608     if (!entry)
609         XSRETURN_EMPTY;
610
611     val = HeVAL(entry);
612     if (isGV(val)) {
613         GV *glob = (GV*)val;
614         switch (variable.type) {
615         case VAR_SCALAR:
616             GvSetSV(glob, NULL);
617             break;
618         case VAR_ARRAY:
619             GvSetAV(glob, NULL);
620             break;
621         case VAR_HASH:
622             GvSetHV(glob, NULL);
623             break;
624         case VAR_CODE:
625             GvSetCV(glob, NULL);
626             break;
627         case VAR_IO:
628             GvSetIO(glob, NULL);
629             break;
630         }
631     }
632     else {
633         if (variable.type == VAR_CODE) {
634             hv_delete_ent(namespace, variable.name, G_DISCARD, 0);
635         }
636     }
637
638 void
639 list_all_symbols(self, vartype=VAR_NONE)
640     SV *self
641     vartype_t vartype
642   PPCODE:
643     if (vartype == VAR_NONE) {
644         HV *namespace;
645         HE *entry;
646         int keys;
647
648         namespace = _get_namespace(self);
649         keys = hv_iterinit(namespace);
650         EXTEND(SP, keys);
651         while ((entry = hv_iternext(namespace))) {
652             mPUSHs(newSVhe(entry));
653         }
654     }
655     else {
656         HV *namespace;
657         SV *val;
658         char *key;
659         I32 len;
660
661         namespace = _get_namespace(self);
662         hv_iterinit(namespace);
663         while ((val = hv_iternextsv(namespace, &key, &len))) {
664             GV *gv = (GV*)val;
665             if (isGV(gv)) {
666                 switch (vartype) {
667                 case VAR_SCALAR:
668                     if (GvSVOK(val))
669                         mXPUSHp(key, len);
670                     break;
671                 case VAR_ARRAY:
672                     if (GvAVOK(val))
673                         mXPUSHp(key, len);
674                     break;
675                 case VAR_HASH:
676                     if (GvHVOK(val))
677                         mXPUSHp(key, len);
678                     break;
679                 case VAR_CODE:
680                     if (GvCVOK(val))
681                         mXPUSHp(key, len);
682                     break;
683                 case VAR_IO:
684                     if (GvIOOK(val))
685                         mXPUSHp(key, len);
686                     break;
687                 }
688             }
689             else if (vartype == VAR_CODE) {
690                 mXPUSHp(key, len);
691             }
692         }
693     }
694
695 void
696 get_all_symbols(self, vartype=VAR_NONE)
697     SV *self
698     vartype_t vartype
699   PREINIT:
700     HV *namespace, *ret;
701     SV *val;
702     char *key;
703     I32 len;
704   PPCODE:
705     namespace = _get_namespace(self);
706     ret = newHV();
707
708     hv_iterinit(namespace);
709     while ((val = hv_iternextsv(namespace, &key, &len))) {
710         GV *gv = (GV*)val;
711
712         if (!isGV(gv)) {
713             SV *keysv = newSVpvn(key, len);
714             _expand_glob(self, keysv);
715             SvREFCNT_dec(keysv);
716         }
717
718         switch (vartype) {
719         case VAR_SCALAR:
720             if (GvSVOK(val))
721                 hv_store(ret, key, len, newRV_inc(GvSV(gv)), 0);
722             break;
723         case VAR_ARRAY:
724             if (GvAVOK(val))
725                 hv_store(ret, key, len, newRV_inc((SV*)GvAV(gv)), 0);
726             break;
727         case VAR_HASH:
728             if (GvHVOK(val))
729                 hv_store(ret, key, len, newRV_inc((SV*)GvHV(gv)), 0);
730             break;
731         case VAR_CODE:
732             if (GvCVOK(val))
733                 hv_store(ret, key, len, newRV_inc((SV*)GvCV(gv)), 0);
734             break;
735         case VAR_IO:
736             if (GvIOOK(val))
737                 hv_store(ret, key, len, newRV_inc((SV*)GvIO(gv)), 0);
738             break;
739         case VAR_NONE:
740             hv_store(ret, key, len, SvREFCNT_inc_simple_NN(val), 0);
741             break;
742         }
743     }
744
745     mPUSHs(newRV_noinc((SV*)ret));
746
747 BOOT:
748     {
749         name_key = newSVpvs("name");
750         PERL_HASH(name_hash, "name", 4);
751
752         namespace_key = newSVpvs("namespace");
753         PERL_HASH(namespace_hash, "namespace", 9);
754
755         type_key = newSVpvs("type");
756         PERL_HASH(type_hash, "type", 4);
757     }