ext/Data/Dumper/Dumper.xs

   1 #define PERL_NO_GET_CONTEXT
   2 #include "EXTERN.h"
   3 #include "perl.h"
   4 #include "XSUB.h"
   5
   6 #ifndef PERL_VERSION
   7 #include "patchlevel.h"
   8 #define PERL_VERSION PATCHLEVEL
   9 #endif
  10
  11 #if PERL_VERSION < 5
  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
  22
  23 static I32 num_q (char *s, STRLEN slen);
  24 static I32 esc_q (char *dest, char *src, STRLEN slen);
  25 static I32 esc_q_utf8 (pTHX_ SV *sv, char *src, STRLEN slen);
  26 static SV *sv_x (pTHX_ SV *sv, char *str, STRLEN len, I32 n);
  27 static I32 DD_dump (pTHX_ SV *val, char *name, STRLEN namelen, SV *retval,
  28                     HV *seenhv, AV *postav, I32 *levelp, I32 indent,
  29                     SV *pad, SV *xpad, SV *apad, SV *sep,
  30                     SV *freezer, SV *toaster,
  31                     I32 purity, I32 deepcopy, I32 quotekeys, SV *bless,
  32                     I32 maxdepth, SV *sortkeys);
  33
  34 /* does a string need to be protected? */
  35 static I32
  36 needs_quote(register char *s)
  37 {
  38 TOP:
  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)
  49             if (!isALNUM(*s)) {
  50                 if (*s == ':')
  51                     goto TOP;
  52                 else
  53                     return 1;
  54             }
  55     }
  56     else
  57         return 1;
  58     return 0;
  59 }
  60
  61 /* count the number of "'"s and "\"s in string */
  62 static I32
  63 num_q(register char *s, register STRLEN slen)
  64 {
  65     register I32 ret = 0;
  66
  67     while (slen > 0) {
  68         if (*s == '\'' || *s == '\\')
  69             ++ret;
  70         ++s;
  71         --slen;
  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 */
  80 static I32
  81 esc_q(register char *d, register char *s, register STRLEN slen)
  82 {
  83     register I32 ret = 0;
  84
  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
 100 static I32
 101 esc_q_utf8(pTHX_ SV* sv, register char *src, register STRLEN slen)
 102 {
 103     char *s, *send, *r;
 104     STRLEN grow = 0, j = 1, l;
 105     bool dquote = FALSE;
 106
 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);
 110
 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++] = '{';
 131             j += sprintf(r + j, "%"UVxf, k);
 132             r[j++] = '}';
 133             dquote = TRUE;
 134         }
 135     }
 136     if (dquote)
 137       r[0] = r[j++] = '"';
 138     else
 139       r[0] = r[j++] = '\'';
 140     r[j] = '\0';
 141     SvCUR_set(sv, SvCUR(sv) + j);
 142
 143     return j;
 144 }
 145
 146 /* append a repeated string to an SV */
 147 static SV *
 148 sv_x(pTHX_ SV *sv, register char *str, STRLEN len, I32 n)
 149 {
 150     if (sv == Nullsv)
 151         sv = newSVpvn("", 0);
 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  */
 178 static I32
 179 DD_dump(pTHX_ SV *val, char *name, STRLEN namelen, SV *retval, HV *seenhv,
 180         AV *postav, I32 *levelp, I32 indent, SV *pad, SV *xpad,
 181         SV *apad, SV *sep, SV *freezer, SV *toaster, I32 purity,
 182         I32 deepcopy, I32 quotekeys, SV *bless, I32 maxdepth, SV *sortkeys)
 183 {
 184     char tmpbuf[128];
 185     U32 i;
 186     char *c, *r, *realpack, id[128];
 187     SV **svp;
 188     SV *sv, *ipad, *ival;
 189     SV *blesspad = Nullsv;
 190     AV *seenentry = Nullav;
 191     char *iname;
 192     STRLEN inamelen, idlen = 0;
 193     U32 realtype;
 194
 195     if (!val)
 196         return 0;
 197
 198     realtype = SvTYPE(val);
 199
 200     if (SvGMAGICAL(val))
 201         mg_get(val);
 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;
 211             if (SvTRUE(ERRSV))
 212                 warn("WARNING(Freezer method call failed): %s",
 213                      SvPVX(ERRSV));
 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);
 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;
 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
 249                             sv_catpvn(retval, "do{my $o}", 9);
 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                             }
 268                         }
 269                         else
 270                             sv_catsv(retval, othername);
 271                     }
 272                     return 1;
 273                 }
 274                 else {
 275                     warn("ref name not found for %s", id);
 276                     return 0;
 277                 }
 278             }
 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);
 299             }
 300         }
 301
 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, '/');
 313             }
 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
 322          * at this depth (i.e., 'Foo=ARRAY(0xdeadbeef)').
 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);
 342             }
 343         }
 344
 345         (*levelp)++;
 346         ipad = sv_x(aTHX_ Nullsv, SvPVX(xpad), SvCUR(xpad), *levelp);
 347
 348         if (realtype <= SVt_PVBM) {                          /* scalar ref */
 349             SV *namesv = newSVpvn("${", 2);
 350             sv_catpvn(namesv, name, namelen);
 351             sv_catpvn(namesv, "}", 1);
 352             if (realpack) {                                  /* blessed */
 353                 sv_catpvn(retval, "do{\\(my $o = ", 13);
 354                 DD_dump(aTHX_ ival, SvPVX(namesv), SvCUR(namesv), retval, seenhv,
 355                         postav, levelp, indent, pad, xpad, apad, sep,
 356                         freezer, toaster, purity, deepcopy, quotekeys, bless,
 357                         maxdepth, sortkeys);
 358                 sv_catpvn(retval, ")}", 2);
 359             }                                                /* plain */
 360             else {
 361                 sv_catpvn(retval, "\\", 1);
 362                 DD_dump(aTHX_ ival, SvPVX(namesv), SvCUR(namesv), retval, seenhv,
 363                         postav, levelp, indent, pad, xpad, apad, sep,
 364                         freezer, toaster, purity, deepcopy, quotekeys, bless,
 365                         maxdepth, sortkeys);
 366             }
 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);
 374             DD_dump(aTHX_ ival, SvPVX(namesv), SvCUR(namesv), retval, seenhv,
 375                     postav, levelp,     indent, pad, xpad, apad, sep,
 376                     freezer, toaster, purity, deepcopy, quotekeys, bless,
 377                     maxdepth, sortkeys);
 378             SvREFCNT_dec(namesv);
 379         }
 380         else if (realtype == SVt_PVAV) {
 381             SV *totpad;
 382             I32 ix = 0;
 383             I32 ixmax = av_len((AV *)ival);
 384
 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);
 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                 {
 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
 428                     elem = &PL_sv_undef;
 429
 430                 ilen = inamelen;
 431                 sv_setiv(ixsv, ix);
 432                 (void) sprintf(iname+ilen, "%"IVdf, (IV)ix);
 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);
 443                 DD_dump(aTHX_ elem, iname, ilen, retval, seenhv, postav,
 444                         levelp, indent, pad, xpad, apad, sep,
 445                         freezer, toaster, purity, deepcopy, quotekeys, bless,
 446                         maxdepth, sortkeys);
 447                 if (ix < ixmax)
 448                     sv_catpvn(retval, ",", 1);
 449             }
 450             if (ixmax >= 0) {
 451                 SV *opad = sv_x(aTHX_ Nullsv, SvPVX(xpad), SvCUR(xpad), (*levelp)-1);
 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;
 471             AV *keys = Nullav;
 472
 473             iname = newSVpvn(name, namelen);
 474             if (name[0] == '%') {
 475                 sv_catpvn(retval, "(", 1);
 476                 (SvPVX(iname))[0] = '$';
 477             }
 478             else {
 479                 sv_catpvn(retval, "{", 1);
 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                 {
 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);
 500
 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,
 513 #ifdef USE_LOCALE_NUMERIC
 514                            IN_LOCALE ? Perl_sv_cmp_locale : Perl_sv_cmp);
 515 #else
 516                             Perl_sv_cmp);
 517 #endif
 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);
 538
 539             /* foreach (keys %hash) */
 540             for (i = 0; 1; i++) {
 541                 char *nkey = NULL;
 542                 I32 nticks = 0;
 543                 SV* keysv;
 544                 STRLEN keylen;
 545                 bool do_utf8 = FALSE;
 546
 547                 if ((sortkeys && !(keys && i <= av_len(keys))) ||
 548                     !(entry = hv_iternext((HV *)ival)))
 549                     break;
 550
 551                 if (i)
 552                     sv_catpvn(retval, ",", 1);
 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
 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);
 577                     nlen = esc_q_utf8(aTHX_ retval, key, klen);
 578
 579                     sname = newSVsv(iname);
 580                     sv_catpvn(sname, okey, nlen);
 581                     sv_catpvn(sname, "}", 1);
 582                 }
 583                 else {
 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                     }
 599
 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                 }
 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
 623                 DD_dump(aTHX_ hval, SvPVX(sname), SvCUR(sname), retval, seenhv,
 624                         postav, levelp, indent, pad, xpad, newapad, sep,
 625                         freezer, toaster, purity, deepcopy, quotekeys, bless,
 626                         maxdepth, sortkeys);
 627                 SvREFCNT_dec(sname);
 628                 Safefree(nkey);
 629                 if (indent >= 2)
 630                     SvREFCNT_dec(newapad);
 631             }
 632             if (i) {
 633                 SV *opad = sv_x(aTHX_ Nullsv, SvPVX(xpad), SvCUR(xpad), *levelp-1);
 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) &&
 678                 (seenentry = (AV*)SvRV(sv)))
 679             {
 680                 SV *othername;
 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);
 685                     sv_catsv(retval, othername);
 686                     sv_catpvn(retval, "}", 1);
 687                     return 1;
 688                 }
 689             }
 690             else {
 691                 SV *namesv;
 692                 namesv = newSVpvn("\\", 1);
 693                 sv_catpvn(namesv, name, namelen);
 694                 seenentry = newAV();
 695                 av_push(seenentry, namesv);
 696                 av_push(seenentry, newRV(val));
 697                 (void)hv_store(seenhv, id, strlen(id), newRV((SV*)seenentry), 0);
 698                 SvREFCNT_dec(seenentry);
 699             }
 700         }
 701
 702         if (SvIOK(val)) {
 703             STRLEN len;
 704             if (SvIsUV(val))
 705               (void) sprintf(tmpbuf, "%"UVuf, SvUV(val));
 706             else
 707               (void) sprintf(tmpbuf, "%"IVdf, SvIV(val));
 708             len = strlen(tmpbuf);
 709             sv_catpvn(retval, tmpbuf, len);
 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             }
 733             SvCUR_set(retval, SvCUR(retval)+i);
 734
 735             if (purity) {
 736                 static char *entries[] = { "{SCALAR}", "{ARRAY}", "{HASH}" };
 737                 static STRLEN sizes[] = { 8, 7, 6 };
 738                 SV *e;
 739                 SV *nname = newSVpvn("", 0);
 740                 SV *newapad = newSVpvn("", 0);
 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));
 746                     if (!e)
 747                         continue;
 748                     if (j == 0 && !SvOK(e))
 749                         continue;
 750
 751                     {
 752                         I32 nlevel = 0;
 753                         SV *postentry = newSVpvn(r,i);
 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)
 763                             (void)sv_x(aTHX_ newapad, " ", 1, SvCUR(postentry));
 764
 765                         DD_dump(aTHX_ e, SvPVX(nname), SvCUR(nname), postentry,
 766                                 seenhv, postav, &nlevel, indent, pad, xpad,
 767                                 newapad, sep, freezer, toaster, purity,
 768                                 deepcopy, quotekeys, bless, maxdepth,
 769                                 sortkeys);
 770                         SvREFCNT_dec(e);
 771                     }
 772                 }
 773
 774                 SvREFCNT_dec(newapad);
 775                 SvREFCNT_dec(nname);
 776             }
 777         }
 778         else if (val == &PL_sv_undef || !SvOK(val)) {
 779             sv_catpvn(retval, "undef", 5);
 780         }
 781         else {
 782             c = SvPV(val, i);
 783             if (DO_UTF8(val))
 784                 i += esc_q_utf8(aTHX_ retval, c, i);
 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             }
 795         }
 796     }
 797
 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     }
 806     return 1;
 807 }
 808
 809
 810 MODULE = 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
 818 void
 819 Data_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;
 829             I32 indent, terse, i, imax, postlen;
 830             SV **svp;
 831             SV *val, *name, *pad, *xpad, *apad, *sep, *varname;
 832             SV *freezer, *toaster, *bless, *sortkeys;
 833             I32 purity, deepcopy, quotekeys, maxdepth = 0;
 834             char tmpbuf[1024];
 835             I32 gimme = GIMME;
 836
 837             if (!SvROK(href)) {         /* call new to get an object first */
 838                 if (items < 2)
 839                     croak("Usage: Data::Dumper::Dumpxs(PACKAGE, VAL_ARY_REF, [NAME_ARY_REF])");
 840
 841                 ENTER;
 842                 SAVETMPS;
 843
 844                 PUSHMARK(sp);
 845                 XPUSHs(href);
 846                 XPUSHs(sv_2mortal(newSVsv(ST(1))));
 847                 if (items >= 3)
 848                     XPUSHs(sv_2mortal(newSVsv(ST(2))));
 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;
 864             val = pad = xpad = apad = sep = varname
 865                 = freezer = toaster = bless = &PL_sv_undef;
 866             name = sv_newmortal();
 867             indent = 2;
 868             terse = purity = deepcopy = 0;
 869             quotekeys = 1;
 870
 871             retval = newSVpvn("", 0);
 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);
 888 #if 0 /* useqq currently unused */
 889                 if ((svp = hv_fetch(hv, "useqq", 5, FALSE)))
 890                     useqq = SvTRUE(*svp);
 891 #endif
 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;
 912                 if ((svp = hv_fetch(hv, "maxdepth", 8, FALSE)))
 913                     maxdepth = SvIV(*svp);
 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                 }
 925                 postav = newAV();
 926
 927                 if (todumpav)
 928                     imax = av_len(todumpav);
 929                 else
 930                     imax = -1;
 931                 valstr = newSVpvn("",0);
 932                 for (i = 0; i <= imax; ++i) {
 933                     SV *newapad;
 934
 935                     av_clear(postav);
 936                     if ((svp = av_fetch(todumpav, i, FALSE)))
 937                         val = *svp;
 938                     else
 939                         val = &PL_sv_undef;
 940                     if ((svp = av_fetch(namesav, i, TRUE)))
 941                         sv_setsv(name, *svp);
 942                     else
 943                         (void)SvOK_off(name);
 944
 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);
 973                         (void) sprintf(tmpbuf, "%"IVdf, (IV)(i+1));
 974                         nchars = strlen(tmpbuf);
 975                         sv_catpvn(name, tmpbuf, nchars);
 976                     }
 977
 978                     if (indent >= 2) {
 979                         SV *tmpsv = sv_x(aTHX_ Nullsv, " ", 1, SvCUR(name)+3);
 980                         newapad = newSVsv(apad);
 981                         sv_catsv(newapad, tmpsv);
 982                         SvREFCNT_dec(tmpsv);
 983                     }
 984                     else
 985                         newapad = apad;
 986
 987                     DD_dump(aTHX_ val, SvPVX(name), SvCUR(name), valstr, seenhv,
 988                             postav, &level, indent, pad, xpad, newapad, sep,
 989                             freezer, toaster, purity, deepcopy, quotekeys,
 990                             bless, maxdepth, sortkeys);
 991
 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 ? */
1026                             retval = newSVpvn("",0);
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         }