macro-ize
[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 int _valid_for_type(SV *value, vartype_t type)
239 {
240     svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
241
242     switch (type) {
243     case VAR_SCALAR:
244         return SVT_SCALAR(sv_type);
245     case VAR_ARRAY:
246         return SVT_ARRAY(sv_type);
247     case VAR_HASH:
248         return SVT_HASH(sv_type);
249     case VAR_CODE:
250         return SVT_CODE(sv_type);
251     case VAR_IO:
252         return SVT_IO(sv_type);
253     default:
254         return 0;
255     }
256 }
257
258 static HV *_get_namespace(SV *self)
259 {
260     dSP;
261     SV *ret;
262
263     PUSHMARK(SP);
264     XPUSHs(self);
265     PUTBACK;
266
267     call_method("namespace", G_SCALAR);
268
269     SPAGAIN;
270     ret = POPs;
271     PUTBACK;
272
273     return (HV*)SvRV(ret);
274 }
275
276 static SV *_get_name(SV *self)
277 {
278     dSP;
279     SV *ret;
280
281     PUSHMARK(SP);
282     XPUSHs(self);
283     PUTBACK;
284
285     call_method("name", G_SCALAR);
286
287     SPAGAIN;
288     ret = POPs;
289     PUTBACK;
290
291     return ret;
292 }
293
294 static void _expand_glob(SV *self, SV *varname)
295 {
296     SV *name;
297
298     name = newSVsv(_get_name(self));
299     sv_catpvs(name, "::");
300     sv_catsv(name, varname);
301
302     /* can't use gv_init here, because it screws up @ISA in a way that I
303      * can't reproduce, but that CMOP triggers */
304     gv_fetchsv(name, GV_ADD, SVt_NULL);
305     SvREFCNT_dec(name);
306 }
307
308 static SV *_get_symbol(SV *self, varspec_t *variable, int vivify)
309 {
310     HV *namespace;
311     HE *entry;
312     GV *glob;
313
314     namespace = _get_namespace(self);
315     entry = hv_fetch_ent(namespace, variable->name, vivify, 0);
316     if (!entry)
317         return NULL;
318
319     glob = (GV*)(HeVAL(entry));
320     if (!isGV(glob))
321         _expand_glob(self, variable->name);
322
323     if (vivify) {
324         switch (variable->type) {
325         case VAR_SCALAR:
326             if (!GvSVOK(glob))
327                 GvSetSV(glob, newSV(0));
328             break;
329         case VAR_ARRAY:
330             if (!GvAVOK(glob))
331                 GvSetAV(glob, newAV());
332             break;
333         case VAR_HASH:
334             if (!GvHVOK(glob))
335                 GvSetHV(glob, newHV());
336             break;
337         case VAR_CODE:
338             croak("Don't know how to vivify CODE variables");
339         case VAR_IO:
340             if (!GvIOOK(glob))
341                 GvSetIO(glob, newIO());
342             break;
343         default:
344             croak("Unknown type in vivication");
345         }
346     }
347
348     switch (variable->type) {
349     case VAR_SCALAR:
350         return GvSV(glob);
351     case VAR_ARRAY:
352         return (SV*)GvAV(glob);
353     case VAR_HASH:
354         return (SV*)GvHV(glob);
355     case VAR_CODE:
356         return (SV*)GvCV(glob);
357     case VAR_IO:
358         return (SV*)GvIO(glob);
359     default:
360         return NULL;
361     }
362 }
363
364 MODULE = Package::Stash::XS  PACKAGE = Package::Stash::XS
365
366 PROTOTYPES: DISABLE
367
368 SV*
369 new(class, package_name)
370     SV *class
371     SV *package_name
372   PREINIT:
373     HV *instance;
374   CODE:
375     if (!SvPOK(package_name))
376         croak("The constructor argument must be the name of a package");
377
378     instance = newHV();
379
380     if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package_name), 0)) {
381         SvREFCNT_dec(package_name);
382         SvREFCNT_dec(instance);
383         croak("Couldn't initialize the 'name' key, hv_store failed");
384     }
385
386     RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashsv(class, 0));
387   OUTPUT:
388     RETVAL
389
390 SV*
391 name(self)
392     SV *self
393   PREINIT:
394     HE *slot;
395   CODE:
396     if (!sv_isobject(self))
397         croak("Can't call name as a class method");
398     slot = hv_fetch_ent((HV*)SvRV(self), name_key, 0, name_hash);
399     RETVAL = slot ? SvREFCNT_inc_simple_NN(HeVAL(slot)) : &PL_sv_undef;
400   OUTPUT:
401     RETVAL
402
403 SV*
404 namespace(self)
405     SV *self
406   PREINIT:
407     HE *slot;
408     SV *package_name;
409   CODE:
410     if (!sv_isobject(self))
411         croak("Can't call namespace as a class method");
412 #if PERL_VERSION < 10
413     package_name = _get_name(self);
414     RETVAL = newRV_inc((SV*)gv_stashpv(SvPV_nolen(package_name), GV_ADD));
415 #else
416     slot = hv_fetch_ent((HV*)SvRV(self), namespace_key, 0, namespace_hash);
417     if (slot) {
418         RETVAL = SvREFCNT_inc_simple_NN(HeVAL(slot));
419     }
420     else {
421         HV *namespace;
422         SV *nsref;
423
424         package_name = _get_name(self);
425         namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
426         nsref = newRV_inc((SV*)namespace);
427         sv_rvweaken(nsref);
428         if (!hv_store((HV*)SvRV(self), "namespace", 9, nsref, 0)) {
429             SvREFCNT_dec(nsref);
430             SvREFCNT_dec(self);
431             croak("Couldn't initialize the 'namespace' key, hv_store failed");
432         }
433         RETVAL = SvREFCNT_inc_simple_NN(nsref);
434     }
435 #endif
436   OUTPUT:
437     RETVAL
438
439 void
440 add_symbol(self, variable, initial=NULL, ...)
441     SV *self
442     varspec_t variable
443     SV *initial
444   PREINIT:
445     SV *name;
446     GV *glob;
447   CODE:
448     if (initial && !_valid_for_type(initial, variable.type))
449         croak("%s is not of type %s",
450               SvPV_nolen(initial), vartype_to_string(variable.type));
451
452     name = newSVsv(_get_name(self));
453     sv_catpvs(name, "::");
454     sv_catsv(name, variable.name);
455
456     if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
457         int i;
458         char *filename = NULL;
459         I32 first_line_num = -1, last_line_num = -1;
460         SV *dbval;
461         HV *dbsub;
462
463         if ((items - 3) % 2)
464             croak("add_symbol: Odd number of elements in %%opts");
465
466         for (i = 3; i < items; i += 2) {
467             char *key;
468             key = SvPV_nolen(ST(i));
469             if (strEQ(key, "filename")) {
470                 if (!SvPOK(ST(i + 1)))
471                     croak("add_symbol: filename must be a string");
472                 filename = SvPV_nolen(ST(i + 1));
473             }
474             else if (strEQ(key, "first_line_num")) {
475                 if (!SvIOK(ST(i + 1)))
476                     croak("add_symbol: first_line_num must be an integer");
477                 first_line_num = SvIV(ST(i + 1));
478             }
479             else if (strEQ(key, "last_line_num")) {
480                 if (!SvIOK(ST(i + 1)))
481                     croak("add_symbol: last_line_num must be an integer");
482                 last_line_num = SvIV(ST(i + 1));
483             }
484         }
485
486         if (!filename || first_line_num == -1) {
487             if (!filename)
488                 filename = CopFILE(PL_curcop);
489             if (first_line_num == -1)
490                 first_line_num = PL_curcop->cop_line;
491         }
492
493         if (last_line_num == -1)
494             last_line_num = first_line_num;
495
496         /* http://perldoc.perl.org/perldebguts.html#Debugger-Internals */
497         dbsub = get_hv("DB::sub", 1);
498         dbval = newSVpvf("%s:%d-%d", filename, first_line_num, last_line_num);
499         if (!hv_store_ent(dbsub, name, dbval, 0)) {
500             warn("Failed to update $DB::sub for subroutine %s",
501                  SvPV_nolen(name));
502             SvREFCNT_dec(dbval);
503         }
504     }
505
506     /* GV_ADDMULTI rather than GV_ADD because otherwise you get 'used only
507      * once' warnings in some situations... i can't reproduce this, but CMOP
508      * triggers it */
509     glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
510
511     if (initial) {
512         SV *val;
513
514         if (SvROK(initial)) {
515             val = SvRV(initial);
516             SvREFCNT_inc_simple_void_NN(val);
517         }
518         else {
519             val = newSVsv(initial);
520         }
521
522         switch (variable.type) {
523         case VAR_SCALAR:
524             GvSetSV(glob, val);
525             break;
526         case VAR_ARRAY:
527             GvSetAV(glob, val);
528             break;
529         case VAR_HASH:
530             GvSetHV(glob, val);
531             break;
532         case VAR_CODE:
533             GvSetCV(glob, val);
534             break;
535         case VAR_IO:
536             GvSetIO(glob, val);
537             break;
538         }
539     }
540
541     SvREFCNT_dec(name);
542
543 void
544 remove_glob(self, name)
545     SV *self
546     SV *name
547   CODE:
548     hv_delete_ent(_get_namespace(self), name, G_DISCARD, 0);
549
550 int
551 has_symbol(self, variable)
552     SV *self
553     varspec_t variable
554   PREINIT:
555     HV *namespace;
556     HE *entry;
557     SV *val;
558   CODE:
559     namespace = _get_namespace(self);
560     entry = hv_fetch_ent(namespace, variable.name, 0, 0);
561     if (!entry)
562         XSRETURN_UNDEF;
563
564     val = HeVAL(entry);
565     if (isGV(val)) {
566         GV *glob = (GV*)val;
567         switch (variable.type) {
568         case VAR_SCALAR:
569             RETVAL = GvSVOK(glob) ? 1 : 0;
570             break;
571         case VAR_ARRAY:
572             RETVAL = GvAVOK(glob) ? 1 : 0;
573             break;
574         case VAR_HASH:
575             RETVAL = GvHVOK(glob) ? 1 : 0;
576             break;
577         case VAR_CODE:
578             RETVAL = GvCVOK(glob) ? 1 : 0;
579             break;
580         case VAR_IO:
581             RETVAL = GvIOOK(glob) ? 1 : 0;
582             break;
583         }
584     }
585     else {
586         RETVAL = (variable.type == VAR_CODE);
587     }
588   OUTPUT:
589     RETVAL
590
591 SV*
592 get_symbol(self, variable)
593     SV *self
594     varspec_t variable
595   PREINIT:
596     SV *val;
597   CODE:
598     val = _get_symbol(self, &variable, 0);
599     if (!val)
600         XSRETURN_UNDEF;
601     RETVAL = newRV_inc(val);
602   OUTPUT:
603     RETVAL
604
605 SV*
606 get_or_add_symbol(self, variable)
607     SV *self
608     varspec_t variable
609   PREINIT:
610     SV *val;
611   CODE:
612     val = _get_symbol(self, &variable, 1);
613     if (!val)
614         XSRETURN_UNDEF;
615     RETVAL = newRV_inc(val);
616   OUTPUT:
617     RETVAL
618
619 void
620 remove_symbol(self, variable)
621     SV *self
622     varspec_t variable
623   PREINIT:
624     HV *namespace;
625     HE *entry;
626     SV *val;
627   CODE:
628     namespace = _get_namespace(self);
629     entry = hv_fetch_ent(namespace, variable.name, 0, 0);
630     if (!entry)
631         XSRETURN_EMPTY;
632
633     val = HeVAL(entry);
634     if (isGV(val)) {
635         GV *glob = (GV*)val;
636         switch (variable.type) {
637         case VAR_SCALAR:
638             GvSetSV(glob, NULL);
639             break;
640         case VAR_ARRAY:
641             GvSetAV(glob, NULL);
642             break;
643         case VAR_HASH:
644             GvSetHV(glob, NULL);
645             break;
646         case VAR_CODE:
647             GvSetCV(glob, NULL);
648             break;
649         case VAR_IO:
650             GvSetIO(glob, NULL);
651             break;
652         }
653     }
654     else {
655         if (variable.type == VAR_CODE) {
656             hv_delete_ent(namespace, variable.name, G_DISCARD, 0);
657         }
658     }
659
660 void
661 list_all_symbols(self, vartype=VAR_NONE)
662     SV *self
663     vartype_t vartype
664   PPCODE:
665     if (vartype == VAR_NONE) {
666         HV *namespace;
667         HE *entry;
668         int keys;
669
670         namespace = _get_namespace(self);
671         keys = hv_iterinit(namespace);
672         EXTEND(SP, keys);
673         while ((entry = hv_iternext(namespace))) {
674             mPUSHs(newSVhe(entry));
675         }
676     }
677     else {
678         HV *namespace;
679         SV *val;
680         char *key;
681         I32 len;
682
683         namespace = _get_namespace(self);
684         hv_iterinit(namespace);
685         while ((val = hv_iternextsv(namespace, &key, &len))) {
686             GV *gv = (GV*)val;
687             if (isGV(gv)) {
688                 switch (vartype) {
689                 case VAR_SCALAR:
690                     if (GvSVOK(val))
691                         mXPUSHp(key, len);
692                     break;
693                 case VAR_ARRAY:
694                     if (GvAVOK(val))
695                         mXPUSHp(key, len);
696                     break;
697                 case VAR_HASH:
698                     if (GvHVOK(val))
699                         mXPUSHp(key, len);
700                     break;
701                 case VAR_CODE:
702                     if (GvCVOK(val))
703                         mXPUSHp(key, len);
704                     break;
705                 case VAR_IO:
706                     if (GvIOOK(val))
707                         mXPUSHp(key, len);
708                     break;
709                 }
710             }
711             else if (vartype == VAR_CODE) {
712                 mXPUSHp(key, len);
713             }
714         }
715     }
716
717 void
718 get_all_symbols(self, vartype=VAR_NONE)
719     SV *self
720     vartype_t vartype
721   PREINIT:
722     HV *namespace, *ret;
723     SV *val;
724     char *key;
725     I32 len;
726   PPCODE:
727     namespace = _get_namespace(self);
728     ret = newHV();
729
730     hv_iterinit(namespace);
731     while ((val = hv_iternextsv(namespace, &key, &len))) {
732         GV *gv = (GV*)val;
733
734         if (!isGV(gv)) {
735             SV *keysv = newSVpvn(key, len);
736             _expand_glob(self, keysv);
737             SvREFCNT_dec(keysv);
738         }
739
740         switch (vartype) {
741         case VAR_SCALAR:
742             if (GvSVOK(val))
743                 hv_store(ret, key, len, newRV_inc(GvSV(gv)), 0);
744             break;
745         case VAR_ARRAY:
746             if (GvAVOK(val))
747                 hv_store(ret, key, len, newRV_inc((SV*)GvAV(gv)), 0);
748             break;
749         case VAR_HASH:
750             if (GvHVOK(val))
751                 hv_store(ret, key, len, newRV_inc((SV*)GvHV(gv)), 0);
752             break;
753         case VAR_CODE:
754             if (GvCVOK(val))
755                 hv_store(ret, key, len, newRV_inc((SV*)GvCV(gv)), 0);
756             break;
757         case VAR_IO:
758             if (GvIOOK(val))
759                 hv_store(ret, key, len, newRV_inc((SV*)GvIO(gv)), 0);
760             break;
761         case VAR_NONE:
762             hv_store(ret, key, len, SvREFCNT_inc_simple_NN(val), 0);
763             break;
764         }
765     }
766
767     mPUSHs(newRV_noinc((SV*)ret));
768
769 BOOT:
770     {
771         name_key = newSVpvs("name");
772         PERL_HASH(name_hash, "name", 4);
773
774         namespace_key = newSVpvs("namespace");
775         PERL_HASH(namespace_hash, "namespace", 9);
776
777         type_key = newSVpvs("type");
778         PERL_HASH(type_hash, "type", 4);
779     }