Commit | Line | Data |
59017825 |
1 | #include "EXTERN.h" |
2 | #include "perl.h" |
3 | #include "XSUB.h" |
4 | |
a382a84b |
5 | typedef 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 | |
16 | typedef struct { |
17 | vartype_t type; |
18 | char sigil; |
19 | char *name; |
20 | } varspec_t; |
21 | |
76f7c306 |
22 | const 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 | |
40 | I32 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 |
58 | vartype_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 | |
80 | void _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 | |
113 | void _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 | |
137 | int _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 |
161 | HV *_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 |
179 | SV *_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 |
197 | SV *_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)); |
02b2a57f |
219 | SvREFCNT_dec(namesv); |
4871b1a0 |
220 | } |
221 | |
222 | if (vivify) { |
223 | switch (variable->type) { |
224 | case VAR_SCALAR: |
225 | if (!GvSV(glob)) |
226 | GvSV(glob) = newSV(0); |
227 | break; |
228 | case VAR_ARRAY: |
229 | if (!GvAV(glob)) |
230 | GvAV(glob) = newAV(); |
231 | break; |
232 | case VAR_HASH: |
233 | if (!GvHV(glob)) |
234 | GvHV(glob) = newHV(); |
235 | break; |
236 | case VAR_CODE: |
237 | croak("Don't know how to vivify CODE variables"); |
238 | case VAR_IO: |
239 | if (!GvIO(glob)) |
240 | GvIOp(glob) = newIO(); |
241 | break; |
242 | default: |
243 | croak("Unknown type in vivication"); |
244 | } |
245 | } |
246 | |
247 | switch (variable->type) { |
248 | case VAR_SCALAR: |
249 | return GvSV(glob); |
250 | case VAR_ARRAY: |
251 | return (SV*)GvAV(glob); |
252 | case VAR_HASH: |
253 | return (SV*)GvHV(glob); |
254 | case VAR_CODE: |
255 | return (SV*)GvCV(glob); |
256 | case VAR_IO: |
257 | return (SV*)GvIO(glob); |
258 | default: |
259 | return NULL; |
260 | } |
261 | } |
262 | |
59017825 |
263 | MODULE = Package::Stash PACKAGE = Package::Stash |
264 | |
be2a7e99 |
265 | PROTOTYPES: DISABLE |
266 | |
59017825 |
267 | SV* |
268 | new(class, package_name) |
269 | char *class |
270 | SV *package_name |
3496f1e8 |
271 | PREINIT: |
59017825 |
272 | HV *instance; |
273 | HV *namespace; |
1d6c978b |
274 | SV *nsref; |
59017825 |
275 | CODE: |
276 | if (!SvPOK(package_name)) |
277 | croak("The constructor argument must be the name of a package"); |
278 | |
6c3e69c6 |
279 | instance = newHV(); |
59017825 |
280 | |
1d6c978b |
281 | if (!hv_store(instance, "name", 4, SvREFCNT_inc_simple_NN(package_name), 0)) { |
282 | SvREFCNT_dec(package_name); |
e8d57afd |
283 | croak("Couldn't initialize the 'name' key, hv_store failed"); |
1d6c978b |
284 | } |
59017825 |
285 | namespace = gv_stashpv(SvPV_nolen(package_name), GV_ADD); |
1d6c978b |
286 | nsref = newRV_inc((SV*)namespace); |
287 | if (!hv_store(instance, "namespace", 9, nsref, 0)) { |
288 | SvREFCNT_dec(nsref); |
e8d57afd |
289 | croak("Couldn't initialize the 'namespace' key, hv_store failed"); |
1d6c978b |
290 | } |
59017825 |
291 | |
6c3e69c6 |
292 | RETVAL = sv_bless(newRV_noinc((SV*)instance), gv_stashpv(class, 0)); |
59017825 |
293 | OUTPUT: |
294 | RETVAL |
194acf47 |
295 | |
296 | SV* |
297 | name(self) |
298 | SV *self |
3496f1e8 |
299 | PREINIT: |
194acf47 |
300 | SV **slot; |
301 | CODE: |
302 | if (!sv_isobject(self)) |
303 | croak("Can't call name as a class method"); |
304 | slot = hv_fetch((HV*)SvRV(self), "name", 4, 0); |
a2fec41a |
305 | RETVAL = slot ? SvREFCNT_inc_simple_NN(*slot) : &PL_sv_undef; |
194acf47 |
306 | OUTPUT: |
307 | RETVAL |
308 | |
309 | SV* |
310 | namespace(self) |
311 | SV *self |
3496f1e8 |
312 | PREINIT: |
194acf47 |
313 | SV **slot; |
314 | CODE: |
315 | if (!sv_isobject(self)) |
316 | croak("Can't call namespace as a class method"); |
317 | slot = hv_fetch((HV*)SvRV(self), "namespace", 9, 0); |
a2fec41a |
318 | RETVAL = slot ? SvREFCNT_inc_simple_NN(*slot) : &PL_sv_undef; |
194acf47 |
319 | OUTPUT: |
320 | RETVAL |
3fd56b4d |
321 | |
322 | void |
76f7c306 |
323 | add_package_symbol(self, variable, initial=NULL, ...) |
324 | SV *self |
325 | varspec_t variable |
326 | SV *initial |
327 | PREINIT: |
328 | SV *name; |
329 | GV *glob; |
330 | CODE: |
331 | if (initial && !_valid_for_type(initial, variable.type)) |
332 | croak("%s is not of type %s", |
333 | SvPV_nolen(initial), vartype_to_string(variable.type)); |
334 | |
335 | name = newSVsv(_get_name(self)); |
336 | sv_catpvs(name, "::"); |
337 | sv_catpv(name, variable.name); |
338 | |
339 | /* XXX: come back to this when i feel like reimplementing caller() */ |
340 | /* |
341 | my $filename = $opts{filename}; |
342 | my $first_line_num = $opts{first_line_num}; |
343 | |
344 | (undef, $filename, $first_line_num) = caller |
345 | if not defined $filename; |
346 | |
347 | my $last_line_num = $opts{last_line_num} || ($first_line_num ||= 0); |
348 | |
349 | # http://perldoc.perl.org/perldebguts.html#Debugger-Internals |
350 | $DB::sub{$pkg . '::' . $name} = "$filename:$first_line_num-$last_line_num"; |
351 | */ |
352 | /* |
353 | if (items > 2 && (PL_perldb & 0x10) && variable.type == VAR_CODE) { |
354 | int i; |
355 | char *filename = NULL, *name; |
356 | I32 first_line_num, last_line_num; |
357 | |
358 | if ((items - 3) % 2) |
359 | croak("add_package_symbol: Odd number of elements in %%opts"); |
360 | |
361 | for (i = 3; i < items; i += 2) { |
362 | char *key; |
363 | key = SvPV_nolen(ST(i)); |
364 | if (strEQ(key, "filename")) { |
365 | if (!SvPOK(ST(i + 1))) |
366 | croak("add_package_symbol: filename must be a string"); |
367 | filename = SvPV_nolen(ST(i + 1)); |
368 | } |
369 | else if (strEQ(key, "first_line_num")) { |
370 | if (!SvIOK(ST(i + 1))) |
371 | croak("add_package_symbol: first_line_num must be an integer"); |
372 | first_line_num = SvIV(ST(i + 1)); |
373 | } |
374 | else if (strEQ(key, "last_line_num")) { |
375 | if (!SvIOK(ST(i + 1))) |
376 | croak("add_package_symbol: last_line_num must be an integer"); |
377 | last_line_num = SvIV(ST(i + 1)); |
378 | } |
379 | } |
380 | |
381 | if (!filename) { |
382 | } |
383 | } |
384 | */ |
385 | |
fedea7f9 |
386 | glob = gv_fetchsv(name, GV_ADDMULTI, vartype_to_svtype(variable.type)); |
76f7c306 |
387 | |
388 | if (initial) { |
389 | SV *val; |
390 | |
391 | if (SvROK(initial)) { |
392 | val = SvRV(initial); |
a2fec41a |
393 | SvREFCNT_inc_simple_void_NN(val); |
76f7c306 |
394 | } |
395 | else { |
396 | val = newSVsv(initial); |
397 | } |
398 | |
399 | switch (variable.type) { |
400 | case VAR_SCALAR: |
a2fec41a |
401 | SvREFCNT_dec(GvSV(glob)); |
76f7c306 |
402 | GvSV(glob) = val; |
403 | break; |
404 | case VAR_ARRAY: |
6cce0a02 |
405 | SvREFCNT_dec(GvAV(glob)); |
76f7c306 |
406 | GvAV(glob) = (AV*)val; |
407 | break; |
408 | case VAR_HASH: |
6cce0a02 |
409 | SvREFCNT_dec(GvHV(glob)); |
76f7c306 |
410 | GvHV(glob) = (HV*)val; |
411 | break; |
412 | case VAR_CODE: |
6cce0a02 |
413 | SvREFCNT_dec(GvCV(glob)); |
76f7c306 |
414 | GvCV(glob) = (CV*)val; |
415 | break; |
416 | case VAR_IO: |
6cce0a02 |
417 | SvREFCNT_dec(GvIO(glob)); |
76f7c306 |
418 | GvIOp(glob) = (IO*)val; |
419 | break; |
420 | } |
421 | } |
422 | |
5bb2b07b |
423 | SvREFCNT_dec(name); |
424 | |
76f7c306 |
425 | void |
3fd56b4d |
426 | remove_package_glob(self, name) |
427 | SV *self |
428 | char *name |
3fd56b4d |
429 | CODE: |
430 | hv_delete(_get_namespace(self), name, strlen(name), G_DISCARD); |
9b608466 |
431 | |
34805376 |
432 | int |
433 | has_package_symbol(self, variable) |
434 | SV *self |
435 | varspec_t variable |
436 | PREINIT: |
437 | HV *namespace; |
438 | SV **entry; |
439 | CODE: |
440 | namespace = _get_namespace(self); |
441 | entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0); |
442 | if (!entry) |
443 | XSRETURN_UNDEF; |
444 | |
445 | if (isGV(*entry)) { |
446 | GV *glob = (GV*)(*entry); |
447 | switch (variable.type) { |
448 | case VAR_SCALAR: |
449 | RETVAL = GvSV(glob) ? 1 : 0; |
450 | break; |
451 | case VAR_ARRAY: |
452 | RETVAL = GvAV(glob) ? 1 : 0; |
453 | break; |
454 | case VAR_HASH: |
455 | RETVAL = GvHV(glob) ? 1 : 0; |
456 | break; |
457 | case VAR_CODE: |
458 | RETVAL = GvCV(glob) ? 1 : 0; |
459 | break; |
460 | case VAR_IO: |
461 | RETVAL = GvIO(glob) ? 1 : 0; |
462 | break; |
463 | } |
464 | } |
465 | else { |
466 | RETVAL = (variable.type == VAR_CODE); |
467 | } |
468 | OUTPUT: |
469 | RETVAL |
470 | |
e3ad44fd |
471 | SV* |
4871b1a0 |
472 | get_package_symbol(self, variable) |
e3ad44fd |
473 | SV *self |
474 | varspec_t variable |
475 | PREINIT: |
fca4ed0c |
476 | SV *val; |
e3ad44fd |
477 | CODE: |
4871b1a0 |
478 | val = _get_package_symbol(self, &variable, 0); |
479 | if (!val) |
e3ad44fd |
480 | XSRETURN_UNDEF; |
93c36417 |
481 | RETVAL = newRV_inc(val); |
4871b1a0 |
482 | OUTPUT: |
483 | RETVAL |
e3ad44fd |
484 | |
4871b1a0 |
485 | SV* |
486 | get_or_add_package_symbol(self, variable) |
487 | SV *self |
488 | varspec_t variable |
489 | PREINIT: |
490 | SV *val; |
491 | CODE: |
492 | val = _get_package_symbol(self, &variable, 1); |
fca4ed0c |
493 | if (!val) |
494 | XSRETURN_UNDEF; |
93c36417 |
495 | RETVAL = newRV_inc(val); |
e3ad44fd |
496 | OUTPUT: |
497 | RETVAL |
498 | |
9b608466 |
499 | void |
215f49f8 |
500 | remove_package_symbol(self, variable) |
501 | SV *self |
502 | varspec_t variable |
503 | PREINIT: |
504 | HV *namespace; |
505 | SV **entry; |
506 | CODE: |
507 | namespace = _get_namespace(self); |
508 | entry = hv_fetch(namespace, variable.name, strlen(variable.name), 0); |
509 | if (!entry) |
510 | XSRETURN_EMPTY; |
511 | |
512 | if (isGV(*entry)) { |
513 | GV *glob = (GV*)(*entry); |
514 | switch (variable.type) { |
515 | case VAR_SCALAR: |
4e3b237e |
516 | GvSV(glob) = (SV *)NULL; |
215f49f8 |
517 | break; |
518 | case VAR_ARRAY: |
4e3b237e |
519 | GvAV(glob) = (AV *)NULL; |
215f49f8 |
520 | break; |
521 | case VAR_HASH: |
4e3b237e |
522 | GvHV(glob) = (HV *)NULL; |
215f49f8 |
523 | break; |
524 | case VAR_CODE: |
4e3b237e |
525 | GvCV(glob) = (CV *)NULL; |
215f49f8 |
526 | break; |
527 | case VAR_IO: |
4e3b237e |
528 | GvIOp(glob) = (IO *)NULL; |
215f49f8 |
529 | break; |
530 | } |
531 | } |
532 | else { |
533 | if (variable.type == VAR_CODE) { |
534 | hv_delete(namespace, variable.name, strlen(variable.name), G_DISCARD); |
535 | } |
536 | } |
537 | |
538 | void |
9b608466 |
539 | list_all_package_symbols(self, vartype=VAR_NONE) |
540 | SV *self |
541 | vartype_t vartype |
542 | PPCODE: |
543 | if (vartype == VAR_NONE) { |
544 | HV *namespace; |
545 | HE *entry; |
546 | int keys; |
547 | |
548 | namespace = _get_namespace(self); |
549 | keys = hv_iterinit(namespace); |
550 | EXTEND(SP, keys); |
ebcc8ba8 |
551 | while ((entry = hv_iternext(namespace))) { |
9b608466 |
552 | mPUSHs(newSVhek(HeKEY_hek(entry))); |
553 | } |
554 | } |
555 | else { |
556 | HV *namespace; |
9b608466 |
557 | SV *val; |
558 | char *key; |
559 | int len; |
560 | |
561 | namespace = _get_namespace(self); |
562 | hv_iterinit(namespace); |
ebcc8ba8 |
563 | while ((val = hv_iternextsv(namespace, &key, &len))) { |
9b608466 |
564 | GV *gv = (GV*)val; |
565 | if (isGV(gv)) { |
566 | switch (vartype) { |
567 | case VAR_SCALAR: |
568 | if (GvSV(val)) |
569 | mXPUSHp(key, len); |
570 | break; |
571 | case VAR_ARRAY: |
572 | if (GvAV(val)) |
573 | mXPUSHp(key, len); |
574 | break; |
575 | case VAR_HASH: |
576 | if (GvHV(val)) |
577 | mXPUSHp(key, len); |
578 | break; |
579 | case VAR_CODE: |
580 | if (GvCVu(val)) |
581 | mXPUSHp(key, len); |
582 | break; |
583 | case VAR_IO: |
584 | if (GvIO(val)) |
585 | mXPUSHp(key, len); |
586 | break; |
587 | } |
588 | } |
589 | else if (vartype == VAR_CODE) { |
590 | mXPUSHp(key, len); |
591 | } |
592 | } |
593 | } |