Clarifying the documentation of goto
[p5sagit/p5-mst-13.2.git] / ext / Data / Dumper / Dumper.xs
CommitLineData
c5be433b 1#define PERL_NO_GET_CONTEXT
823edd99 2#include "EXTERN.h"
3#include "perl.h"
4#include "XSUB.h"
823edd99 5
cceca5ed 6#ifndef PERL_VERSION
0f4592ef 7#include "patchlevel.h"
5a930efa 8#define PERL_VERSION PATCHLEVEL
cceca5ed 9#endif
0f4592ef 10
cceca5ed 11#if PERL_VERSION < 5
7820172a 12# ifndef PL_sv_undef
13# define PL_sv_undef sv_undef
14# endif
15# ifndef ERRSV
16# define ERRSV GvSV(errgv)
17# endif
18# ifndef newSVpvn
19# define newSVpvn newSVpv
20# endif
21#endif
823edd99 22
20ce7b12 23static I32 num_q (char *s, STRLEN slen);
24static I32 esc_q (char *dest, char *src, STRLEN slen);
6cde4e94 25static I32 esc_q_utf8 (pTHX_ SV *sv, char *src, STRLEN slen);
cea2e8a9 26static SV *sv_x (pTHX_ SV *sv, char *str, STRLEN len, I32 n);
27static I32 DD_dump (pTHX_ SV *val, char *name, STRLEN namelen, SV *retval,
20ce7b12 28 HV *seenhv, AV *postav, I32 *levelp, I32 indent,
29 SV *pad, SV *xpad, SV *apad, SV *sep,
30 SV *freezer, SV *toaster,
a2126434 31 I32 purity, I32 deepcopy, I32 quotekeys, SV *bless,
e9105f86 32 I32 maxdepth, SV *sortkeys);
823edd99 33
34/* does a string need to be protected? */
35static I32
36needs_quote(register char *s)
37{
38TOP:
39 if (s[0] == ':') {
40 if (*++s) {
41 if (*s++ != ':')
42 return 1;
43 }
44 else
45 return 1;
46 }
47 if (isIDFIRST(*s)) {
48 while (*++s)
7b0972df 49 if (!isALNUM(*s)) {
823edd99 50 if (*s == ':')
51 goto TOP;
52 else
53 return 1;
7b0972df 54 }
823edd99 55 }
6cde4e94 56 else
823edd99 57 return 1;
58 return 0;
59}
60
61/* count the number of "'"s and "\"s in string */
62static I32
6c1ab3c2 63num_q(register char *s, register STRLEN slen)
823edd99 64{
65 register I32 ret = 0;
6c1ab3c2 66
67 while (slen > 0) {
823edd99 68 if (*s == '\'' || *s == '\\')
69 ++ret;
70 ++s;
6c1ab3c2 71 --slen;
823edd99 72 }
73 return ret;
74}
75
76
77/* returns number of chars added to escape "'"s and "\"s in s */
78/* slen number of characters in s will be escaped */
79/* destination must be long enough for additional chars */
80static I32
81esc_q(register char *d, register char *s, register STRLEN slen)
82{
83 register I32 ret = 0;
6cde4e94 84
823edd99 85 while (slen > 0) {
86 switch (*s) {
87 case '\'':
88 case '\\':
89 *d = '\\';
90 ++d; ++ret;
91 default:
92 *d = *s;
93 ++d; ++s; --slen;
94 break;
95 }
96 }
97 return ret;
98}
99
dc71dc59 100static I32
6cde4e94 101esc_q_utf8(pTHX_ SV* sv, register char *src, register STRLEN slen)
dc71dc59 102{
103 char *s, *send, *r;
104 STRLEN grow = 0, j = 1, l;
105 bool dquote = FALSE;
6cde4e94 106
dc71dc59 107 /* this will need EBCDICification */
108 for (s = src, send = src + slen; s < send; s += UTF8SKIP(s)) {
109 UV k = utf8_to_uvchr((U8*)s, &l);
6cde4e94 110
dc71dc59 111 grow +=
112 (*s == '"' || *s == '\\') ? 2 :
113 (k < 0x80 ? 1 : UNISKIP(k) + 1 + 4); /* 4: \x{} */
114 }
115 sv_grow(sv, SvCUR(sv)+3+grow); /* 3: ""\0 */
116 r = SvPVX(sv) + SvCUR(sv);
117
118 for (s = src; s < send; s += UTF8SKIP(s)) {
119 UV k = utf8_to_uvchr((U8*)s, &l);
120
121 if (*s == '"' || *s == '\\') {
122 r[j++] = '\\';
123 r[j++] = *s;
124 }
125 else if (k < 0x80)
126 r[j++] = k;
127 else {
128 r[j++] = '\\';
129 r[j++] = 'x';
130 r[j++] = '{';
29b291f7 131 j += sprintf(r + j, "%"UVxf, k);
dc71dc59 132 r[j++] = '}';
133 dquote = TRUE;
134 }
135 }
136 if (dquote)
137 r[0] = r[j++] = '"';
138 else
139 r[0] = r[j++] = '\'';
f397e026 140 r[j] = '\0';
dc71dc59 141 SvCUR_set(sv, SvCUR(sv) + j);
142
143 return j;
144}
145
823edd99 146/* append a repeated string to an SV */
147static SV *
cea2e8a9 148sv_x(pTHX_ SV *sv, register char *str, STRLEN len, I32 n)
823edd99 149{
150 if (sv == Nullsv)
7820172a 151 sv = newSVpvn("", 0);
823edd99 152 else
153 assert(SvTYPE(sv) >= SVt_PV);
154
155 if (n > 0) {
156 SvGROW(sv, len*n + SvCUR(sv) + 1);
157 if (len == 1) {
158 char *start = SvPVX(sv) + SvCUR(sv);
159 SvCUR(sv) += n;
160 start[n] = '\0';
161 while (n > 0)
162 start[--n] = str[0];
163 }
164 else
165 while (n > 0) {
166 sv_catpvn(sv, str, len);
167 --n;
168 }
169 }
170 return sv;
171}
172
173/*
174 * This ought to be split into smaller functions. (it is one long function since
175 * it exactly parallels the perl version, which was one long thing for
176 * efficiency raisins.) Ugggh!
177 */
178static I32
cea2e8a9 179DD_dump(pTHX_ SV *val, char *name, STRLEN namelen, SV *retval, HV *seenhv,
823edd99 180 AV *postav, I32 *levelp, I32 indent, SV *pad, SV *xpad,
181 SV *apad, SV *sep, SV *freezer, SV *toaster, I32 purity,
e9105f86 182 I32 deepcopy, I32 quotekeys, SV *bless, I32 maxdepth, SV *sortkeys)
823edd99 183{
184 char tmpbuf[128];
185 U32 i;
186 char *c, *r, *realpack, id[128];
187 SV **svp;
7820172a 188 SV *sv, *ipad, *ival;
823edd99 189 SV *blesspad = Nullsv;
7820172a 190 AV *seenentry = Nullav;
823edd99 191 char *iname;
192 STRLEN inamelen, idlen = 0;
823edd99 193 U32 realtype;
194
195 if (!val)
196 return 0;
197
823edd99 198 realtype = SvTYPE(val);
6cde4e94 199
823edd99 200 if (SvGMAGICAL(val))
201 mg_get(val);
823edd99 202 if (SvROK(val)) {
203
204 if (SvOBJECT(SvRV(val)) && freezer &&
205 SvPOK(freezer) && SvCUR(freezer))
206 {
207 dSP; ENTER; SAVETMPS; PUSHMARK(sp);
208 XPUSHs(val); PUTBACK;
209 i = perl_call_method(SvPVX(freezer), G_EVAL|G_SCALAR);
210 SPAGAIN;
7820172a 211 if (SvTRUE(ERRSV))
823edd99 212 warn("WARNING(Freezer method call failed): %s",
7820172a 213 SvPVX(ERRSV));
823edd99 214 else if (i)
215 val = newSVsv(POPs);
216 PUTBACK; FREETMPS; LEAVE;
217 if (i)
218 (void)sv_2mortal(val);
219 }
220
221 ival = SvRV(val);
823edd99 222 realtype = SvTYPE(ival);
223 (void) sprintf(id, "0x%lx", (unsigned long)ival);
224 idlen = strlen(id);
225 if (SvOBJECT(ival))
226 realpack = HvNAME(SvSTASH(ival));
227 else
228 realpack = Nullch;
7820172a 229
230 /* if it has a name, we need to either look it up, or keep a tab
231 * on it so we know when we hit it later
232 */
233 if (namelen) {
234 if ((svp = hv_fetch(seenhv, id, idlen, FALSE))
235 && (sv = *svp) && SvROK(sv) && (seenentry = (AV*)SvRV(sv)))
236 {
237 SV *othername;
238 if ((svp = av_fetch(seenentry, 0, FALSE))
239 && (othername = *svp))
240 {
241 if (purity && *levelp > 0) {
242 SV *postentry;
243
244 if (realtype == SVt_PVHV)
245 sv_catpvn(retval, "{}", 2);
246 else if (realtype == SVt_PVAV)
247 sv_catpvn(retval, "[]", 2);
248 else
5df59fb6 249 sv_catpvn(retval, "do{my $o}", 9);
7820172a 250 postentry = newSVpvn(name, namelen);
251 sv_catpvn(postentry, " = ", 3);
252 sv_catsv(postentry, othername);
253 av_push(postav, postentry);
254 }
255 else {
256 if (name[0] == '@' || name[0] == '%') {
257 if ((SvPVX(othername))[0] == '\\' &&
258 (SvPVX(othername))[1] == name[0]) {
259 sv_catpvn(retval, SvPVX(othername)+1,
260 SvCUR(othername)-1);
261 }
262 else {
263 sv_catpvn(retval, name, 1);
264 sv_catpvn(retval, "{", 1);
265 sv_catsv(retval, othername);
266 sv_catpvn(retval, "}", 1);
267 }
823edd99 268 }
7820172a 269 else
823edd99 270 sv_catsv(retval, othername);
823edd99 271 }
7820172a 272 return 1;
273 }
274 else {
275 warn("ref name not found for %s", id);
276 return 0;
823edd99 277 }
823edd99 278 }
7820172a 279 else { /* store our name and continue */
280 SV *namesv;
281 if (name[0] == '@' || name[0] == '%') {
282 namesv = newSVpvn("\\", 1);
283 sv_catpvn(namesv, name, namelen);
284 }
285 else if (realtype == SVt_PVCV && name[0] == '*') {
286 namesv = newSVpvn("\\", 2);
287 sv_catpvn(namesv, name, namelen);
288 (SvPVX(namesv))[1] = '&';
289 }
290 else
291 namesv = newSVpvn(name, namelen);
292 seenentry = newAV();
293 av_push(seenentry, namesv);
294 (void)SvREFCNT_inc(val);
295 av_push(seenentry, val);
296 (void)hv_store(seenhv, id, strlen(id),
297 newRV((SV*)seenentry), 0);
298 SvREFCNT_dec(seenentry);
823edd99 299 }
823edd99 300 }
823edd99 301
a2126434 302 if (realpack && *realpack == 'R' && strEQ(realpack, "Regexp")) {
303 STRLEN rlen;
304 char *rval = SvPV(val, rlen);
305 char *slash = strchr(rval, '/');
306 sv_catpvn(retval, "qr/", 3);
307 while (slash) {
308 sv_catpvn(retval, rval, slash-rval);
309 sv_catpvn(retval, "\\/", 2);
310 rlen -= slash-rval+1;
311 rval = slash+1;
312 slash = strchr(rval, '/');
7894fbab 313 }
a2126434 314 sv_catpvn(retval, rval, rlen);
315 sv_catpvn(retval, "/", 1);
316 return 1;
317 }
318
319 /* If purity is not set and maxdepth is set, then check depth:
320 * if we have reached maximum depth, return the string
321 * representation of the thing we are currently examining
6cde4e94 322 * at this depth (i.e., 'Foo=ARRAY(0xdeadbeef)').
a2126434 323 */
324 if (!purity && maxdepth > 0 && *levelp >= maxdepth) {
325 STRLEN vallen;
326 char *valstr = SvPV(val,vallen);
327 sv_catpvn(retval, "'", 1);
328 sv_catpvn(retval, valstr, vallen);
329 sv_catpvn(retval, "'", 1);
330 return 1;
331 }
332
333 if (realpack) { /* we have a blessed ref */
334 STRLEN blesslen;
335 char *blessstr = SvPV(bless, blesslen);
336 sv_catpvn(retval, blessstr, blesslen);
337 sv_catpvn(retval, "( ", 2);
338 if (indent >= 2) {
339 blesspad = apad;
340 apad = newSVsv(apad);
341 sv_x(aTHX_ apad, " ", 1, blesslen+2);
823edd99 342 }
343 }
344
7894fbab 345 (*levelp)++;
346 ipad = sv_x(aTHX_ Nullsv, SvPVX(xpad), SvCUR(xpad), *levelp);
347
7820172a 348 if (realtype <= SVt_PVBM) { /* scalar ref */
349 SV *namesv = newSVpvn("${", 2);
350 sv_catpvn(namesv, name, namelen);
351 sv_catpvn(namesv, "}", 1);
6cde4e94 352 if (realpack) { /* blessed */
823edd99 353 sv_catpvn(retval, "do{\\(my $o = ", 13);
cea2e8a9 354 DD_dump(aTHX_ ival, SvPVX(namesv), SvCUR(namesv), retval, seenhv,
7820172a 355 postav, levelp, indent, pad, xpad, apad, sep,
a2126434 356 freezer, toaster, purity, deepcopy, quotekeys, bless,
e9105f86 357 maxdepth, sortkeys);
823edd99 358 sv_catpvn(retval, ")}", 2);
7820172a 359 } /* plain */
823edd99 360 else {
361 sv_catpvn(retval, "\\", 1);
cea2e8a9 362 DD_dump(aTHX_ ival, SvPVX(namesv), SvCUR(namesv), retval, seenhv,
7820172a 363 postav, levelp, indent, pad, xpad, apad, sep,
a2126434 364 freezer, toaster, purity, deepcopy, quotekeys, bless,
e9105f86 365 maxdepth, sortkeys);
823edd99 366 }
7820172a 367 SvREFCNT_dec(namesv);
368 }
369 else if (realtype == SVt_PVGV) { /* glob ref */
370 SV *namesv = newSVpvn("*{", 2);
371 sv_catpvn(namesv, name, namelen);
372 sv_catpvn(namesv, "}", 1);
373 sv_catpvn(retval, "\\", 1);
cea2e8a9 374 DD_dump(aTHX_ ival, SvPVX(namesv), SvCUR(namesv), retval, seenhv,
7820172a 375 postav, levelp, indent, pad, xpad, apad, sep,
a2126434 376 freezer, toaster, purity, deepcopy, quotekeys, bless,
e9105f86 377 maxdepth, sortkeys);
7820172a 378 SvREFCNT_dec(namesv);
823edd99 379 }
380 else if (realtype == SVt_PVAV) {
381 SV *totpad;
382 I32 ix = 0;
383 I32 ixmax = av_len((AV *)ival);
6cde4e94 384
823edd99 385 SV *ixsv = newSViv(0);
386 /* allowing for a 24 char wide array index */
387 New(0, iname, namelen+28, char);
388 (void)strcpy(iname, name);
389 inamelen = namelen;
390 if (name[0] == '@') {
391 sv_catpvn(retval, "(", 1);
392 iname[0] = '$';
393 }
394 else {
395 sv_catpvn(retval, "[", 1);
7820172a 396 /* omit "->" in $foo{bar}->[0], but not in ${$foo}->[0] */
397 /*if (namelen > 0
398 && name[namelen-1] != ']' && name[namelen-1] != '}'
399 && (namelen < 4 || (name[1] != '{' && name[2] != '{')))*/
400 if ((namelen > 0
401 && name[namelen-1] != ']' && name[namelen-1] != '}')
402 || (namelen > 4
403 && (name[1] == '{'
404 || (name[0] == '\\' && name[2] == '{'))))
405 {
823edd99 406 iname[inamelen++] = '-'; iname[inamelen++] = '>';
407 iname[inamelen] = '\0';
408 }
409 }
410 if (iname[0] == '*' && iname[inamelen-1] == '}' && inamelen >= 8 &&
411 (instr(iname+inamelen-8, "{SCALAR}") ||
412 instr(iname+inamelen-7, "{ARRAY}") ||
413 instr(iname+inamelen-6, "{HASH}"))) {
414 iname[inamelen++] = '-'; iname[inamelen++] = '>';
415 }
416 iname[inamelen++] = '['; iname[inamelen] = '\0';
417 totpad = newSVsv(sep);
418 sv_catsv(totpad, pad);
419 sv_catsv(totpad, apad);
420
421 for (ix = 0; ix <= ixmax; ++ix) {
422 STRLEN ilen;
423 SV *elem;
424 svp = av_fetch((AV*)ival, ix, FALSE);
425 if (svp)
426 elem = *svp;
427 else
3280af22 428 elem = &PL_sv_undef;
823edd99 429
430 ilen = inamelen;
431 sv_setiv(ixsv, ix);
7b0972df 432 (void) sprintf(iname+ilen, "%"IVdf, (IV)ix);
823edd99 433 ilen = strlen(iname);
434 iname[ilen++] = ']'; iname[ilen] = '\0';
435 if (indent >= 3) {
436 sv_catsv(retval, totpad);
437 sv_catsv(retval, ipad);
438 sv_catpvn(retval, "#", 1);
439 sv_catsv(retval, ixsv);
440 }
441 sv_catsv(retval, totpad);
442 sv_catsv(retval, ipad);
cea2e8a9 443 DD_dump(aTHX_ elem, iname, ilen, retval, seenhv, postav,
823edd99 444 levelp, indent, pad, xpad, apad, sep,
a2126434 445 freezer, toaster, purity, deepcopy, quotekeys, bless,
e9105f86 446 maxdepth, sortkeys);
823edd99 447 if (ix < ixmax)
448 sv_catpvn(retval, ",", 1);
449 }
450 if (ixmax >= 0) {
cea2e8a9 451 SV *opad = sv_x(aTHX_ Nullsv, SvPVX(xpad), SvCUR(xpad), (*levelp)-1);
823edd99 452 sv_catsv(retval, totpad);
453 sv_catsv(retval, opad);
454 SvREFCNT_dec(opad);
455 }
456 if (name[0] == '@')
457 sv_catpvn(retval, ")", 1);
458 else
459 sv_catpvn(retval, "]", 1);
460 SvREFCNT_dec(ixsv);
461 SvREFCNT_dec(totpad);
462 Safefree(iname);
463 }
464 else if (realtype == SVt_PVHV) {
465 SV *totpad, *newapad;
466 SV *iname, *sname;
467 HE *entry;
468 char *key;
469 I32 klen;
470 SV *hval;
e9105f86 471 AV *keys = Nullav;
6cde4e94 472
7820172a 473 iname = newSVpvn(name, namelen);
823edd99 474 if (name[0] == '%') {
475 sv_catpvn(retval, "(", 1);
476 (SvPVX(iname))[0] = '$';
477 }
478 else {
479 sv_catpvn(retval, "{", 1);
7820172a 480 /* omit "->" in $foo[0]->{bar}, but not in ${$foo}->{bar} */
481 if ((namelen > 0
482 && name[namelen-1] != ']' && name[namelen-1] != '}')
483 || (namelen > 4
484 && (name[1] == '{'
485 || (name[0] == '\\' && name[2] == '{'))))
486 {
823edd99 487 sv_catpvn(iname, "->", 2);
488 }
489 }
490 if (name[0] == '*' && name[namelen-1] == '}' && namelen >= 8 &&
491 (instr(name+namelen-8, "{SCALAR}") ||
492 instr(name+namelen-7, "{ARRAY}") ||
493 instr(name+namelen-6, "{HASH}"))) {
494 sv_catpvn(iname, "->", 2);
495 }
496 sv_catpvn(iname, "{", 1);
497 totpad = newSVsv(sep);
498 sv_catsv(totpad, pad);
499 sv_catsv(totpad, apad);
6cde4e94 500
e9105f86 501 /* If requested, get a sorted/filtered array of hash keys */
502 if (sortkeys) {
503 if (sortkeys == &PL_sv_yes) {
504 keys = newAV();
505 (void)hv_iterinit((HV*)ival);
506 while (entry = hv_iternext((HV*)ival)) {
507 sv = hv_iterkeysv(entry);
508 SvREFCNT_inc(sv);
509 av_push(keys, sv);
510 }
511 sortsv(AvARRAY(keys),
512 av_len(keys)+1,
02a99678 513#ifdef USE_LOCALE_NUMERIC
3c253d0e 514 IN_LOCALE ? Perl_sv_cmp_locale : Perl_sv_cmp);
02a99678 515#else
516 Perl_sv_cmp);
517#endif
e9105f86 518 }
519 else {
520 dSP; ENTER; SAVETMPS; PUSHMARK(sp);
521 XPUSHs(sv_2mortal(newRV_inc(ival))); PUTBACK;
522 i = perl_call_sv(sortkeys, G_SCALAR | G_EVAL);
523 SPAGAIN;
524 if (i) {
525 sv = POPs;
526 if (SvROK(sv) && (SvTYPE(SvRV(sv)) == SVt_PVAV))
527 keys = (AV*)SvREFCNT_inc(SvRV(sv));
528 }
529 if (! keys)
530 warn("Sortkeys subroutine did not return ARRAYREF\n");
531 PUTBACK; FREETMPS; LEAVE;
532 }
533 if (keys)
534 sv_2mortal((SV*)keys);
535 }
536 else
537 (void)hv_iterinit((HV*)ival);
ecfc8647 538
539 /* foreach (keys %hash) */
540 for (i = 0; 1; i++) {
dc71dc59 541 char *nkey = NULL;
823edd99 542 I32 nticks = 0;
dc71dc59 543 SV* keysv;
544 STRLEN keylen;
545 bool do_utf8 = FALSE;
ecfc8647 546
547 if ((sortkeys && !(keys && i <= av_len(keys))) ||
548 !(entry = hv_iternext((HV *)ival)))
549 break;
550
823edd99 551 if (i)
552 sv_catpvn(retval, ",", 1);
e9105f86 553
554 if (sortkeys) {
555 char *key;
556 svp = av_fetch(keys, i, FALSE);
557 keysv = svp ? *svp : sv_mortalcopy(&PL_sv_undef);
558 key = SvPV(keysv, keylen);
559 svp = hv_fetch((HV*)ival, key, keylen, 0);
560 hval = svp ? *svp : sv_mortalcopy(&PL_sv_undef);
561 }
562 else {
563 keysv = hv_iterkeysv(entry);
564 hval = hv_iterval((HV*)ival, entry);
565 }
566
dc71dc59 567 do_utf8 = DO_UTF8(keysv);
568 key = SvPV(keysv, keylen);
569 klen = keylen;
570
571 if (do_utf8) {
572 char *okey = SvPVX(retval) + SvCUR(retval);
573 I32 nlen;
574
575 sv_catsv(retval, totpad);
576 sv_catsv(retval, ipad);
6cde4e94 577 nlen = esc_q_utf8(aTHX_ retval, key, klen);
dc71dc59 578
579 sname = newSVsv(iname);
580 sv_catpvn(sname, okey, nlen);
581 sv_catpvn(sname, "}", 1);
823edd99 582 }
583 else {
dc71dc59 584 if (quotekeys || needs_quote(key)) {
585 nticks = num_q(key, klen);
586 New(0, nkey, klen+nticks+3, char);
587 nkey[0] = '\'';
588 if (nticks)
589 klen += esc_q(nkey+1, key, klen);
590 else
591 (void)Copy(key, nkey+1, klen, char);
592 nkey[++klen] = '\'';
593 nkey[++klen] = '\0';
594 }
595 else {
596 New(0, nkey, klen, char);
597 (void)Copy(key, nkey, klen, char);
598 }
823edd99 599
dc71dc59 600 sname = newSVsv(iname);
601 sv_catpvn(sname, nkey, klen);
602 sv_catpvn(sname, "}", 1);
603
604 sv_catsv(retval, totpad);
605 sv_catsv(retval, ipad);
606 sv_catpvn(retval, nkey, klen);
607 }
823edd99 608 sv_catpvn(retval, " => ", 4);
609 if (indent >= 2) {
610 char *extra;
611 I32 elen = 0;
612 newapad = newSVsv(apad);
613 New(0, extra, klen+4+1, char);
614 while (elen < (klen+4))
615 extra[elen++] = ' ';
616 extra[elen] = '\0';
617 sv_catpvn(newapad, extra, elen);
618 Safefree(extra);
619 }
620 else
621 newapad = apad;
622
cea2e8a9 623 DD_dump(aTHX_ hval, SvPVX(sname), SvCUR(sname), retval, seenhv,
823edd99 624 postav, levelp, indent, pad, xpad, newapad, sep,
a2126434 625 freezer, toaster, purity, deepcopy, quotekeys, bless,
e9105f86 626 maxdepth, sortkeys);
823edd99 627 SvREFCNT_dec(sname);
628 Safefree(nkey);
629 if (indent >= 2)
630 SvREFCNT_dec(newapad);
631 }
632 if (i) {
cea2e8a9 633 SV *opad = sv_x(aTHX_ Nullsv, SvPVX(xpad), SvCUR(xpad), *levelp-1);
823edd99 634 sv_catsv(retval, totpad);
635 sv_catsv(retval, opad);
636 SvREFCNT_dec(opad);
637 }
638 if (name[0] == '%')
639 sv_catpvn(retval, ")", 1);
640 else
641 sv_catpvn(retval, "}", 1);
642 SvREFCNT_dec(iname);
643 SvREFCNT_dec(totpad);
644 }
645 else if (realtype == SVt_PVCV) {
646 sv_catpvn(retval, "sub { \"DUMMY\" }", 15);
647 if (purity)
648 warn("Encountered CODE ref, using dummy placeholder");
649 }
650 else {
651 warn("cannot handle ref type %ld", realtype);
652 }
653
654 if (realpack) { /* free blessed allocs */
655 if (indent >= 2) {
656 SvREFCNT_dec(apad);
657 apad = blesspad;
658 }
659 sv_catpvn(retval, ", '", 3);
660 sv_catpvn(retval, realpack, strlen(realpack));
661 sv_catpvn(retval, "' )", 3);
662 if (toaster && SvPOK(toaster) && SvCUR(toaster)) {
663 sv_catpvn(retval, "->", 2);
664 sv_catsv(retval, toaster);
665 sv_catpvn(retval, "()", 2);
666 }
667 }
668 SvREFCNT_dec(ipad);
669 (*levelp)--;
670 }
671 else {
672 STRLEN i;
673
674 if (namelen) {
675 (void) sprintf(id, "0x%lx", (unsigned long)val);
676 if ((svp = hv_fetch(seenhv, id, (idlen = strlen(id)), FALSE)) &&
677 (sv = *svp) && SvROK(sv) &&
7820172a 678 (seenentry = (AV*)SvRV(sv)))
679 {
823edd99 680 SV *othername;
7820172a 681 if ((svp = av_fetch(seenentry, 0, FALSE)) && (othername = *svp)
682 && (svp = av_fetch(seenentry, 2, FALSE)) && *svp && SvIV(*svp) > 0)
683 {
684 sv_catpvn(retval, "${", 2);
823edd99 685 sv_catsv(retval, othername);
7820172a 686 sv_catpvn(retval, "}", 1);
823edd99 687 return 1;
688 }
689 }
690 else {
691 SV *namesv;
7820172a 692 namesv = newSVpvn("\\", 1);
823edd99 693 sv_catpvn(namesv, name, namelen);
694 seenentry = newAV();
695 av_push(seenentry, namesv);
7820172a 696 av_push(seenentry, newRV(val));
823edd99 697 (void)hv_store(seenhv, id, strlen(id), newRV((SV*)seenentry), 0);
698 SvREFCNT_dec(seenentry);
699 }
700 }
7820172a 701
823edd99 702 if (SvIOK(val)) {
703 STRLEN len;
0e8b3009 704 if (SvIsUV(val))
5e8f63cb 705 (void) sprintf(tmpbuf, "%"UVuf, SvUV(val));
0e8b3009 706 else
707 (void) sprintf(tmpbuf, "%"IVdf, SvIV(val));
823edd99 708 len = strlen(tmpbuf);
709 sv_catpvn(retval, tmpbuf, len);
823edd99 710 }
711 else if (realtype == SVt_PVGV) {/* GLOBs can end up with scribbly names */
712 c = SvPV(val, i);
713 ++c; --i; /* just get the name */
714 if (i >= 6 && strncmp(c, "main::", 6) == 0) {
715 c += 4;
716 i -= 4;
717 }
718 if (needs_quote(c)) {
719 sv_grow(retval, SvCUR(retval)+6+2*i);
720 r = SvPVX(retval)+SvCUR(retval);
721 r[0] = '*'; r[1] = '{'; r[2] = '\'';
722 i += esc_q(r+3, c, i);
723 i += 3;
724 r[i++] = '\''; r[i++] = '}';
725 r[i] = '\0';
726 }
727 else {
728 sv_grow(retval, SvCUR(retval)+i+2);
729 r = SvPVX(retval)+SvCUR(retval);
730 r[0] = '*'; strcpy(r+1, c);
731 i++;
732 }
7820172a 733 SvCUR_set(retval, SvCUR(retval)+i);
823edd99 734
735 if (purity) {
736 static char *entries[] = { "{SCALAR}", "{ARRAY}", "{HASH}" };
737 static STRLEN sizes[] = { 8, 7, 6 };
738 SV *e;
7820172a 739 SV *nname = newSVpvn("", 0);
740 SV *newapad = newSVpvn("", 0);
823edd99 741 GV *gv = (GV*)val;
742 I32 j;
743
744 for (j=0; j<3; j++) {
745 e = ((j == 0) ? GvSV(gv) : (j == 1) ? (SV*)GvAV(gv) : (SV*)GvHV(gv));
7820172a 746 if (!e)
747 continue;
748 if (j == 0 && !SvOK(e))
749 continue;
750
751 {
823edd99 752 I32 nlevel = 0;
7820172a 753 SV *postentry = newSVpvn(r,i);
823edd99 754
755 sv_setsv(nname, postentry);
756 sv_catpvn(nname, entries[j], sizes[j]);
757 sv_catpvn(postentry, " = ", 3);
758 av_push(postav, postentry);
759 e = newRV(e);
760
761 SvCUR(newapad) = 0;
762 if (indent >= 2)
cea2e8a9 763 (void)sv_x(aTHX_ newapad, " ", 1, SvCUR(postentry));
823edd99 764
cea2e8a9 765 DD_dump(aTHX_ e, SvPVX(nname), SvCUR(nname), postentry,
823edd99 766 seenhv, postav, &nlevel, indent, pad, xpad,
767 newapad, sep, freezer, toaster, purity,
e9105f86 768 deepcopy, quotekeys, bless, maxdepth,
769 sortkeys);
823edd99 770 SvREFCNT_dec(e);
771 }
772 }
773
774 SvREFCNT_dec(newapad);
775 SvREFCNT_dec(nname);
776 }
777 }
7820172a 778 else if (val == &PL_sv_undef || !SvOK(val)) {
779 sv_catpvn(retval, "undef", 5);
780 }
823edd99 781 else {
782 c = SvPV(val, i);
dc71dc59 783 if (DO_UTF8(val))
6cde4e94 784 i += esc_q_utf8(aTHX_ retval, c, i);
dc71dc59 785 else {
786 sv_grow(retval, SvCUR(retval)+3+2*i); /* 3: ""\0 */
787 r = SvPVX(retval) + SvCUR(retval);
788 r[0] = '\'';
789 i += esc_q(r+1, c, i);
790 ++i;
791 r[i++] = '\'';
792 r[i] = '\0';
793 SvCUR_set(retval, SvCUR(retval)+i);
794 }
823edd99 795 }
823edd99 796 }
797
7820172a 798 if (idlen) {
799 if (deepcopy)
800 (void)hv_delete(seenhv, id, idlen, G_DISCARD);
801 else if (namelen && seenentry) {
802 SV *mark = *av_fetch(seenentry, 2, TRUE);
803 sv_setiv(mark,1);
804 }
805 }
823edd99 806 return 1;
807}
808
809
810MODULE = Data::Dumper PACKAGE = Data::Dumper PREFIX = Data_Dumper_
811
812#
813# This is the exact equivalent of Dump. Well, almost. The things that are
814# different as of now (due to Laziness):
815# * doesnt do double-quotes yet.
816#
817
818void
819Data_Dumper_Dumpxs(href, ...)
820 SV *href;
821 PROTOTYPE: $;$$
822 PPCODE:
823 {
824 HV *hv;
825 SV *retval, *valstr;
826 HV *seenhv = Nullhv;
827 AV *postav, *todumpav, *namesav;
828 I32 level = 0;
497b47a8 829 I32 indent, terse, i, imax, postlen;
823edd99 830 SV **svp;
497b47a8 831 SV *val, *name, *pad, *xpad, *apad, *sep, *varname;
e9105f86 832 SV *freezer, *toaster, *bless, *sortkeys;
7b0972df 833 I32 purity, deepcopy, quotekeys, maxdepth = 0;
823edd99 834 char tmpbuf[1024];
835 I32 gimme = GIMME;
836
837 if (!SvROK(href)) { /* call new to get an object first */
0f1923bd 838 if (items < 2)
839 croak("Usage: Data::Dumper::Dumpxs(PACKAGE, VAL_ARY_REF, [NAME_ARY_REF])");
823edd99 840
841 ENTER;
842 SAVETMPS;
843
844 PUSHMARK(sp);
845 XPUSHs(href);
0f1923bd 846 XPUSHs(sv_2mortal(newSVsv(ST(1))));
847 if (items >= 3)
848 XPUSHs(sv_2mortal(newSVsv(ST(2))));
823edd99 849 PUTBACK;
850 i = perl_call_method("new", G_SCALAR);
851 SPAGAIN;
852 if (i)
853 href = newSVsv(POPs);
854
855 PUTBACK;
856 FREETMPS;
857 LEAVE;
858 if (i)
859 (void)sv_2mortal(href);
860 }
861
862 todumpav = namesav = Nullav;
863 seenhv = Nullhv;
497b47a8 864 val = pad = xpad = apad = sep = varname
3280af22 865 = freezer = toaster = bless = &PL_sv_undef;
823edd99 866 name = sv_newmortal();
867 indent = 2;
497b47a8 868 terse = purity = deepcopy = 0;
823edd99 869 quotekeys = 1;
6cde4e94 870
7820172a 871 retval = newSVpvn("", 0);
823edd99 872 if (SvROK(href)
873 && (hv = (HV*)SvRV((SV*)href))
874 && SvTYPE(hv) == SVt_PVHV) {
875
876 if ((svp = hv_fetch(hv, "seen", 4, FALSE)) && SvROK(*svp))
877 seenhv = (HV*)SvRV(*svp);
878 if ((svp = hv_fetch(hv, "todump", 6, FALSE)) && SvROK(*svp))
879 todumpav = (AV*)SvRV(*svp);
880 if ((svp = hv_fetch(hv, "names", 5, FALSE)) && SvROK(*svp))
881 namesav = (AV*)SvRV(*svp);
882 if ((svp = hv_fetch(hv, "indent", 6, FALSE)))
883 indent = SvIV(*svp);
884 if ((svp = hv_fetch(hv, "purity", 6, FALSE)))
885 purity = SvIV(*svp);
886 if ((svp = hv_fetch(hv, "terse", 5, FALSE)))
887 terse = SvTRUE(*svp);
497b47a8 888#if 0 /* useqq currently unused */
823edd99 889 if ((svp = hv_fetch(hv, "useqq", 5, FALSE)))
890 useqq = SvTRUE(*svp);
497b47a8 891#endif
823edd99 892 if ((svp = hv_fetch(hv, "pad", 3, FALSE)))
893 pad = *svp;
894 if ((svp = hv_fetch(hv, "xpad", 4, FALSE)))
895 xpad = *svp;
896 if ((svp = hv_fetch(hv, "apad", 4, FALSE)))
897 apad = *svp;
898 if ((svp = hv_fetch(hv, "sep", 3, FALSE)))
899 sep = *svp;
900 if ((svp = hv_fetch(hv, "varname", 7, FALSE)))
901 varname = *svp;
902 if ((svp = hv_fetch(hv, "freezer", 7, FALSE)))
903 freezer = *svp;
904 if ((svp = hv_fetch(hv, "toaster", 7, FALSE)))
905 toaster = *svp;
906 if ((svp = hv_fetch(hv, "deepcopy", 8, FALSE)))
907 deepcopy = SvTRUE(*svp);
908 if ((svp = hv_fetch(hv, "quotekeys", 9, FALSE)))
909 quotekeys = SvTRUE(*svp);
910 if ((svp = hv_fetch(hv, "bless", 5, FALSE)))
911 bless = *svp;
a2126434 912 if ((svp = hv_fetch(hv, "maxdepth", 8, FALSE)))
913 maxdepth = SvIV(*svp);
e9105f86 914 if ((svp = hv_fetch(hv, "sortkeys", 8, FALSE))) {
915 sortkeys = *svp;
916 if (! SvTRUE(sortkeys))
917 sortkeys = NULL;
918 else if (! (SvROK(sortkeys) &&
919 SvTYPE(SvRV(sortkeys)) == SVt_PVCV) )
920 {
921 /* flag to use qsortsv() for sorting hash keys */
922 sortkeys = &PL_sv_yes;
923 }
924 }
823edd99 925 postav = newAV();
926
927 if (todumpav)
928 imax = av_len(todumpav);
929 else
930 imax = -1;
7820172a 931 valstr = newSVpvn("",0);
823edd99 932 for (i = 0; i <= imax; ++i) {
933 SV *newapad;
6cde4e94 934
823edd99 935 av_clear(postav);
936 if ((svp = av_fetch(todumpav, i, FALSE)))
937 val = *svp;
938 else
3280af22 939 val = &PL_sv_undef;
823edd99 940 if ((svp = av_fetch(namesav, i, TRUE)))
941 sv_setsv(name, *svp);
942 else
8063af02 943 (void)SvOK_off(name);
6cde4e94 944
823edd99 945 if (SvOK(name)) {
946 if ((SvPVX(name))[0] == '*') {
947 if (SvROK(val)) {
948 switch (SvTYPE(SvRV(val))) {
949 case SVt_PVAV:
950 (SvPVX(name))[0] = '@';
951 break;
952 case SVt_PVHV:
953 (SvPVX(name))[0] = '%';
954 break;
955 case SVt_PVCV:
956 (SvPVX(name))[0] = '*';
957 break;
958 default:
959 (SvPVX(name))[0] = '$';
960 break;
961 }
962 }
963 else
964 (SvPVX(name))[0] = '$';
965 }
966 else if ((SvPVX(name))[0] != '$')
967 sv_insert(name, 0, 0, "$", 1);
968 }
969 else {
970 STRLEN nchars = 0;
971 sv_setpvn(name, "$", 1);
972 sv_catsv(name, varname);
faccc32b 973 (void) sprintf(tmpbuf, "%"IVdf, (IV)(i+1));
823edd99 974 nchars = strlen(tmpbuf);
975 sv_catpvn(name, tmpbuf, nchars);
976 }
6cde4e94 977
823edd99 978 if (indent >= 2) {
cea2e8a9 979 SV *tmpsv = sv_x(aTHX_ Nullsv, " ", 1, SvCUR(name)+3);
823edd99 980 newapad = newSVsv(apad);
981 sv_catsv(newapad, tmpsv);
982 SvREFCNT_dec(tmpsv);
983 }
984 else
985 newapad = apad;
6cde4e94 986
cea2e8a9 987 DD_dump(aTHX_ val, SvPVX(name), SvCUR(name), valstr, seenhv,
823edd99 988 postav, &level, indent, pad, xpad, newapad, sep,
989 freezer, toaster, purity, deepcopy, quotekeys,
e9105f86 990 bless, maxdepth, sortkeys);
6cde4e94 991
823edd99 992 if (indent >= 2)
993 SvREFCNT_dec(newapad);
994
995 postlen = av_len(postav);
996 if (postlen >= 0 || !terse) {
997 sv_insert(valstr, 0, 0, " = ", 3);
998 sv_insert(valstr, 0, 0, SvPVX(name), SvCUR(name));
999 sv_catpvn(valstr, ";", 1);
1000 }
1001 sv_catsv(retval, pad);
1002 sv_catsv(retval, valstr);
1003 sv_catsv(retval, sep);
1004 if (postlen >= 0) {
1005 I32 i;
1006 sv_catsv(retval, pad);
1007 for (i = 0; i <= postlen; ++i) {
1008 SV *elem;
1009 svp = av_fetch(postav, i, FALSE);
1010 if (svp && (elem = *svp)) {
1011 sv_catsv(retval, elem);
1012 if (i < postlen) {
1013 sv_catpvn(retval, ";", 1);
1014 sv_catsv(retval, sep);
1015 sv_catsv(retval, pad);
1016 }
1017 }
1018 }
1019 sv_catpvn(retval, ";", 1);
1020 sv_catsv(retval, sep);
1021 }
1022 sv_setpvn(valstr, "", 0);
1023 if (gimme == G_ARRAY) {
1024 XPUSHs(sv_2mortal(retval));
1025 if (i < imax) /* not the last time thro ? */
7820172a 1026 retval = newSVpvn("",0);
823edd99 1027 }
1028 }
1029 SvREFCNT_dec(postav);
1030 SvREFCNT_dec(valstr);
1031 }
1032 else
1033 croak("Call to new() method failed to return HASH ref");
1034 if (gimme == G_SCALAR)
1035 XPUSHs(sv_2mortal(retval));
1036 }