Nullsv et.al are deprecated
[gitmo/Package-Stash-XS.git] / Stash.xs
CommitLineData
59017825 1#include "EXTERN.h"
2#include "perl.h"
3#include "XSUB.h"
4
a382a84b 5typedef enum {
6 VAR_NONE = 0,
7 VAR_SCALAR,
8 VAR_ARRAY,
9 VAR_HASH,
10 VAR_CODE,
11 VAR_IO,
12 VAR_GLOB, /* TODO: unimplemented */
13 VAR_FORMAT /* TODO: unimplemented */
14} vartype_t;
15
16typedef struct {
17 vartype_t type;
18 char sigil;
19 char *name;
20} varspec_t;
21
76f7c306 22const char *vartype_to_string(vartype_t type)
23{
24 switch (type) {
25 case VAR_SCALAR:
26 return "SCALAR";
27 case VAR_ARRAY:
28 return "ARRAY";
29 case VAR_HASH:
30 return "HASH";
31 case VAR_CODE:
32 return "CODE";
33 case VAR_IO:
34 return "IO";
35 default:
36 return "unknown";
37 }
38}
39
40I32 vartype_to_svtype(vartype_t type)
41{
42 switch (type) {
43 case VAR_SCALAR:
44 return SVt_PV; /* or whatever */
45 case VAR_ARRAY:
46 return SVt_PVAV;
47 case VAR_HASH:
48 return SVt_PVHV;
49 case VAR_CODE:
50 return SVt_PVCV;
51 case VAR_IO:
52 return SVt_PVIO;
53 default:
54 return SVt_NULL;
55 }
56}
57
a382a84b 58vartype_t string_to_vartype(char *vartype)
59{
60 if (strEQ(vartype, "SCALAR")) {
61 return VAR_SCALAR;
62 }
63 else if (strEQ(vartype, "ARRAY")) {
64 return VAR_ARRAY;
65 }
66 else if (strEQ(vartype, "HASH")) {
67 return VAR_HASH;
68 }
69 else if (strEQ(vartype, "CODE")) {
70 return VAR_CODE;
71 }
72 else if (strEQ(vartype, "IO")) {
73 return VAR_IO;
74 }
75 else {
76 croak("Type must be one of 'SCALAR', 'ARRAY', 'HASH', 'CODE', or 'IO'");
77 }
78}
79
80void _deconstruct_variable_name(char *variable, varspec_t *varspec)
81{
82 if (!variable || !variable[0])
83 croak("You must pass a variable name");
84
85 varspec->type = VAR_NONE;
86
87 switch (variable[0]) {
88 case '$':
89 varspec->type = VAR_SCALAR;
90 break;
91 case '@':
92 varspec->type = VAR_ARRAY;
93 break;
94 case '%':
95 varspec->type = VAR_HASH;
96 break;
97 case '&':
98 varspec->type = VAR_CODE;
99 break;
100 }
101
102 if (varspec->type != VAR_NONE) {
103 varspec->sigil = variable[0];
104 varspec->name = &variable[1];
105 }
106 else {
107 varspec->type = VAR_IO;
108 varspec->sigil = '\0';
109 varspec->name = variable;
110 }
111}
112
113void _deconstruct_variable_hash(HV *variable, varspec_t *varspec)
114{
115 SV **val;
a382a84b 116
117 val = hv_fetch(variable, "name", 4, 0);
118 if (!val)
119 croak("The 'name' key is required in variable specs");
120
121 varspec->name = savesvpv(*val);
301f570b 122 SAVEFREEPV(varspec->name);
a382a84b 123
124 val = hv_fetch(variable, "sigil", 5, 0);
125 if (!val)
126 croak("The 'sigil' key is required in variable specs");
127
128 varspec->sigil = (SvPV_nolen(*val))[0];
129
130 val = hv_fetch(variable, "type", 4, 0);
131 if (!val)
132 croak("The 'type' key is required in variable specs");
133
134 varspec->type = string_to_vartype(SvPV_nolen(*val));
135}
136
137int _valid_for_type(SV *value, vartype_t type)
138{
139 svtype sv_type = SvROK(value) ? SvTYPE(SvRV(value)) : SVt_NULL;
140
141 switch (type) {
142 case VAR_SCALAR:
143 return sv_type == SVt_NULL ||
144 sv_type == SVt_IV ||
145 sv_type == SVt_NV ||
146 sv_type == SVt_PV ||
147 sv_type == SVt_RV;
148 case VAR_ARRAY:
149 return sv_type == SVt_PVAV;
150 case VAR_HASH:
151 return sv_type == SVt_PVHV;
152 case VAR_CODE:
153 return sv_type == SVt_PVCV;
154 case VAR_IO:
76f7c306 155 return sv_type == SVt_PVIO;
a382a84b 156 default:
157 return 0;
158 }
159}
160
3fd56b4d 161HV *_get_namespace(SV *self)
162{
163 dSP;
164 SV *ret;
165
166 PUSHMARK(SP);
167 XPUSHs(self);
168 PUTBACK;
169
612dcf3b 170 call_method("namespace", G_SCALAR);
3fd56b4d 171
172 SPAGAIN;
173 ret = POPs;
174 PUTBACK;
175
176 return (HV*)SvRV(ret);
177}
178
76f7c306 179SV *_get_name(SV *self)
180{
181 dSP;
182 SV *ret;
183
184 PUSHMARK(SP);
185 XPUSHs(self);
186 PUTBACK;
187
612dcf3b 188 call_method("name", G_SCALAR);
76f7c306 189
190 SPAGAIN;
191 ret = POPs;
192 PUTBACK;
193
194 return ret;
195}
196
4871b1a0 197SV *_get_package_symbol(SV *self, varspec_t *variable, int vivify)
198{
199 HV *namespace;
200 SV **entry;
201 GV *glob;
202
203 namespace = _get_namespace(self);
204 entry = hv_fetch(namespace, variable->name, strlen(variable->name), vivify);
205 if (!entry)
206 return NULL;
207
208 glob = (GV*)(*entry);
209 if (!isGV(glob)) {
210 SV *namesv;
4871b1a0 211
212 namesv = newSVsv(_get_name(self));
213 sv_catpvs(namesv, "::");
214 sv_catpv(namesv, variable->name);
215
b55c97c2 216 /* can't use gv_init here, because it screws up @ISA in a way that I
217 * can't reproduce, but that CMOP triggers */
218 gv_fetchsv(namesv, GV_ADD, vartype_to_svtype(variable->type));
4871b1a0 219 }
220
221 if (vivify) {
222 switch (variable->type) {
223 case VAR_SCALAR:
224 if (!GvSV(glob))
225 GvSV(glob) = newSV(0);
226 break;
227 case VAR_ARRAY:
228 if (!GvAV(glob))
229 GvAV(glob) = newAV();
230 break;
231 case VAR_HASH:
232 if (!GvHV(glob))
233 GvHV(glob) = newHV();
234 break;
235 case VAR_CODE:
236 croak("Don't know how to vivify CODE variables");
237 case VAR_IO:
238 if (!GvIO(glob))
239 GvIOp(glob) = newIO();
240 break;
241 default:
242 croak("Unknown type in vivication");
243 }
244 }
245
246 switch (variable->type) {
247 case VAR_SCALAR:
248 return GvSV(glob);
249 case VAR_ARRAY:
250 return (SV*)GvAV(glob);
251 case VAR_HASH:
252 return (SV*)GvHV(glob);
253 case VAR_CODE:
254 return (SV*)GvCV(glob);
255 case VAR_IO:
256 return (SV*)GvIO(glob);
257 default:
258 return NULL;
259 }
260}
261
59017825 262MODULE = Package::Stash PACKAGE = Package::Stash
263
be2a7e99 264PROTOTYPES: DISABLE
265
59017825 266SV*
267new(class, package_name)
268 char *class
269 SV *package_name
3496f1e8 270 PREINIT:
59017825 271 HV *instance;
272 HV *namespace;
273 CODE:
274 if (!SvPOK(package_name))
275 croak("The constructor argument must be the name of a package");
276
277 instance = newHV();
278
279 hv_store(instance, "name", 4, package_name, 0);
280 namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD);
93c36417 281 hv_store(instance, "namespace", 9, newRV_noinc((SV*)namespace), 0);
59017825 282
93c36417 283 RETVAL = sv_bless(newRV_inc((SV*)instance), gv_stashpv(class, 0));
59017825 284 OUTPUT:
285 RETVAL
194acf47 286
287SV*
288name(self)
289 SV *self
3496f1e8 290 PREINIT:
194acf47 291 SV **slot;
292 CODE:
293 if (!sv_isobject(self))
294 croak("Can't call name as a class method");
295 slot = hv_fetch((HV*)SvRV(self), "name", 4, 0);
296 RETVAL = slot ? SvREFCNT_inc(*slot) : &PL_sv_undef;
297 OUTPUT:
298 RETVAL
299
300SV*
301namespace(self)
302 SV *self
3496f1e8 303 PREINIT:
194acf47 304 SV **slot;
305 CODE:
306 if (!sv_isobject(self))
307 croak("Can't call namespace as a class method");
308 slot = hv_fetch((HV*)SvRV(self), "namespace", 9, 0);
309 RETVAL = slot ? SvREFCNT_inc(*slot) : &PL_sv_undef;
310 OUTPUT:
311 RETVAL
3fd56b4d 312
313void
76f7c306 314add_package_symbol(self, variable, initial=NULL, ...)
315 SV *self
316 varspec_t variable
317 SV *initial
318 PREINIT:
319 SV *name;
320 GV *glob;
321 CODE:
322 if (initial && !_valid_for_type(initial, variable.type))
323 croak("%s is not of type %s",
324 SvPV_nolen(initial), vartype_to_string(variable.type));
325
326 name = newSVsv(_get_name(self));
327 sv_catpvs(name, "::");
328 sv_catpv(name, variable.name);
329
330 /* XXX: come back to this when i feel like reimplementing caller() */
331/*
332 my $filename = $opts{filename};
333 my $first_line_num = $opts{first_line_num};
334
335 (undef, $filename, $first_line_num) = caller
336 if not defined $filename;
337
338 my $last_line_num = $opts{last_line_num} || ($first_line_num ||= 0);
339
340 # http://perldoc.perl.org/perldebguts.html#Debugger-Internals
341 $DB::sub{$pkg . '::' . $name} = "$filename:$first_line_num-$last_line_num";
342*/
343/*
344 if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) {
345 int i;
346 char *filename = NULL, *name;
347 I32 first_line_num, last_line_num;
348
349 if ((items - 3) % 2)
350 croak("add_package_symbol: Odd number of elements in %%opts");
351
352 for (i = 3; i < items; i += 2) {
353 char *key;
354 key = SvPV_nolen(ST(i));
355 if (strEQ(key, "filename")) {
356 if (!SvPOK(ST(i + 1)))
357 croak("add_package_symbol: filename must be a string");
358 filename = SvPV_nolen(ST(i + 1));
359 }
360 else if (strEQ(key, "first_line_num")) {
361 if (!SvIOK(ST(i + 1)))
362 croak("add_package_symbol: first_line_num must be an integer");
363 first_line_num = SvIV(ST(i + 1));
364 }
365 else if (strEQ(key, "last_line_num")) {
366 if (!SvIOK(ST(i + 1)))
367 croak("add_package_symbol: last_line_num must be an integer");
368 last_line_num = SvIV(ST(i + 1));
369 }
370 }
371
372 if (!filename) {
373 }
374 }
375*/
376
fedea7f9 377 glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type));
76f7c306 378
379 if (initial) {
380 SV *val;
381
382 if (SvROK(initial)) {
383 val = SvRV(initial);
384 SvREFCNT_inc(val);
385 }
386 else {
387 val = newSVsv(initial);
388 }
389
390 switch (variable.type) {
391 case VAR_SCALAR:
392 GvSV(glob) = val;
393 break;
394 case VAR_ARRAY:
395 GvAV(glob) = (AV*)val;
396 break;
397 case VAR_HASH:
398 GvHV(glob) = (HV*)val;
399 break;
400 case VAR_CODE:
401 GvCV(glob) = (CV*)val;
402 break;
403 case VAR_IO:
404 GvIOp(glob) = (IO*)val;
405 break;
406 }
407 }
408
409void
3fd56b4d 410remove_package_glob(self, name)
411 SV *self
412 char *name
3fd56b4d 413 CODE:
414 hv_delete(_get_namespace(self), name, strlen(name), G_DISCARD);
9b608466 415
34805376 416int
417has_package_symbol(self, variable)
418 SV *self
419 varspec_t variable
420 PREINIT:
421 HV *namespace;
422 SV **entry;
423 CODE:
424 namespace = _get_namespace(self);
425 entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
426 if (!entry)
427 XSRETURN_UNDEF;
428
429 if (isGV(*entry)) {
430 GV *glob = (GV*)(*entry);
431 switch (variable.type) {
432 case VAR_SCALAR:
433 RETVAL = GvSV(glob) ? 1 : 0;
434 break;
435 case VAR_ARRAY:
436 RETVAL = GvAV(glob) ? 1 : 0;
437 break;
438 case VAR_HASH:
439 RETVAL = GvHV(glob) ? 1 : 0;
440 break;
441 case VAR_CODE:
442 RETVAL = GvCV(glob) ? 1 : 0;
443 break;
444 case VAR_IO:
445 RETVAL = GvIO(glob) ? 1 : 0;
446 break;
447 }
448 }
449 else {
450 RETVAL = (variable.type == VAR_CODE);
451 }
452 OUTPUT:
453 RETVAL
454
e3ad44fd 455SV*
4871b1a0 456get_package_symbol(self, variable)
e3ad44fd 457 SV *self
458 varspec_t variable
459 PREINIT:
fca4ed0c 460 SV *val;
e3ad44fd 461 CODE:
4871b1a0 462 val = _get_package_symbol(self, &variable, 0);
463 if (!val)
e3ad44fd 464 XSRETURN_UNDEF;
93c36417 465 RETVAL = newRV_inc(val);
4871b1a0 466 OUTPUT:
467 RETVAL
e3ad44fd 468
4871b1a0 469SV*
470get_or_add_package_symbol(self, variable)
471 SV *self
472 varspec_t variable
473 PREINIT:
474 SV *val;
475 CODE:
476 val = _get_package_symbol(self, &variable, 1);
fca4ed0c 477 if (!val)
478 XSRETURN_UNDEF;
93c36417 479 RETVAL = newRV_inc(val);
e3ad44fd 480 OUTPUT:
481 RETVAL
482
9b608466 483void
215f49f8 484remove_package_symbol(self, variable)
485 SV *self
486 varspec_t variable
487 PREINIT:
488 HV *namespace;
489 SV **entry;
490 CODE:
491 namespace = _get_namespace(self);
492 entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0);
493 if (!entry)
494 XSRETURN_EMPTY;
495
496 if (isGV(*entry)) {
497 GV *glob = (GV*)(*entry);
498 switch (variable.type) {
499 case VAR_SCALAR:
4e3b237e 500 GvSV(glob) = (SV *)NULL;
215f49f8 501 break;
502 case VAR_ARRAY:
4e3b237e 503 GvAV(glob) = (AV *)NULL;
215f49f8 504 break;
505 case VAR_HASH:
4e3b237e 506 GvHV(glob) = (HV *)NULL;
215f49f8 507 break;
508 case VAR_CODE:
4e3b237e 509 GvCV(glob) = (CV *)NULL;
215f49f8 510 break;
511 case VAR_IO:
4e3b237e 512 GvIOp(glob) = (IO *)NULL;
215f49f8 513 break;
514 }
515 }
516 else {
517 if (variable.type == VAR_CODE) {
518 hv_delete(namespace, variable.name, strlen(variable.name), G_DISCARD);
519 }
520 }
521
522void
9b608466 523list_all_package_symbols(self, vartype=VAR_NONE)
524 SV *self
525 vartype_t vartype
526 PPCODE:
527 if (vartype == VAR_NONE) {
528 HV *namespace;
529 HE *entry;
530 int keys;
531
532 namespace = _get_namespace(self);
533 keys = hv_iterinit(namespace);
534 EXTEND(SP, keys);
535 while (entry = hv_iternext(namespace)) {
536 mPUSHs(newSVhek(HeKEY_hek(entry)));
537 }
538 }
539 else {
540 HV *namespace;
541 HE *entry;
542 SV *val;
543 char *key;
544 int len;
545
546 namespace = _get_namespace(self);
547 hv_iterinit(namespace);
548 while (val = hv_iternextsv(namespace, &key, &len)) {
549 GV *gv = (GV*)val;
550 if (isGV(gv)) {
551 switch (vartype) {
552 case VAR_SCALAR:
553 if (GvSV(val))
554 mXPUSHp(key, len);
555 break;
556 case VAR_ARRAY:
557 if (GvAV(val))
558 mXPUSHp(key, len);
559 break;
560 case VAR_HASH:
561 if (GvHV(val))
562 mXPUSHp(key, len);
563 break;
564 case VAR_CODE:
565 if (GvCVu(val))
566 mXPUSHp(key, len);
567 break;
568 case VAR_IO:
569 if (GvIO(val))
570 mXPUSHp(key, len);
571 break;
572 }
573 }
574 else if (vartype == VAR_CODE) {
575 mXPUSHp(key, len);
576 }
577 }
578 }