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