Introduce a new function, pv_escape(), to display contents of PVs
[p5sagit/p5-mst-13.2.git] / dump.c
diff --git a/dump.c b/dump.c
index 4635eef..98405c6 100644 (file)
--- a/dump.c
+++ b/dump.c
@@ -119,40 +119,121 @@ Perl_dump_eval(pTHX)
     op_dump(PL_eval_root);
 }
 
-char *
-Perl_pv_display(pTHX_ SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
-{
-    const bool nul_terminated = len > cur && pv[cur] == '\0';
-    bool truncated = 0;
 
-    sv_setpvn(dsv, "\"", 1);
-    for (; cur--; pv++) {
-       if (pvlim && SvCUR(dsv) >= pvlim) {
-            truncated = 1;
-           break;
-        }
-       switch (*pv) {
-       case '\t': sv_catpvs(dsv, "\\t");  break;
-       case '\n': sv_catpvs(dsv, "\\n");  break;
-       case '\r': sv_catpvs(dsv, "\\r");  break;
-       case '\f': sv_catpvs(dsv, "\\f");  break;
-       case '"':  sv_catpvs(dsv, "\\\""); break;
-       case '\\': sv_catpvs(dsv, "\\\\"); break;
-       default:
-           if (isPRINT(*pv))
-               sv_catpvn(dsv, pv, 1);
-           else if (cur && isDIGIT(*(pv+1)))
-               Perl_sv_catpvf(aTHX_ dsv, "\\%03o", (U8)*pv);
-           else
-               Perl_sv_catpvf(aTHX_ dsv, "\\%o", (U8)*pv);
-        }
+/*
+=for apidoc Apd|char*|pv_escape|NN SV *dsv|NN const char *pv|const STRLEN count|const STRLEN max|const U32 flags
+
+Escapes at most the first "count" chars of pv and puts the results into
+buf such that the size of the escaped string will not exceed "max" chars
+and will not contain any incomplete escape sequences.
+
+If flags contains PERL_PV_ESCAPE_QUOTE then the string will have quotes
+placed around it; moreover, if the number of chars converted was less than
+"count" then a trailing elipses (...) will be added after the closing
+quote.
+
+If PERL_PV_ESCAPE_QUOTE is not set, but PERL_PV_ESCAPE_PADR is, then the
+returned string will be right padded with spaces such that it is max chars
+long.
+
+Normally the SV will be cleared before the escaped string is prepared,
+but when PERL_PV_ESCAPE_CAT is set this will not occur.
+
+Returns a pointer to the string contained by SV.
+
+=cut
+*/
+
+char *
+Perl_pv_escape( pTHX_ SV *dsv, const char *pv, const STRLEN count, const STRLEN max, const U32 flags ) {
+    char dq = (flags & PERL_PV_ESCAPE_QUOTE) ? '"' : '\\';
+    char octbuf[8] = "\\0123456";
+    STRLEN wrote = 0;
+    STRLEN chsize = 0;
+    const char *end = pv + count;
+
+    if (flags & PERL_PV_ESCAPE_CAT) {
+       if ( dq == '"' )
+           sv_catpvn(dsv, "\"", 1);
+    } else {
+       if ( dq == '"' )
+           sv_setpvn(dsv, "\"", 1);
+       else
+           sv_setpvn(dsv, "", 0);
+    }
+    for ( ; (pv < end && (!max || (wrote < max))) ; pv++ ) {
+       if ( (*pv == dq) || (*pv == '\\') || isCNTRL(*pv) ) {
+           chsize = 2;
+           switch (*pv) {
+               case '\\' : octbuf[1] = '\\'; break;
+               case '\v' : octbuf[1] = 'v';  break;
+               case '\t' : octbuf[1] = 't';  break;
+               case '\r' : octbuf[1] = 'r';  break;
+               case '\n' : octbuf[1] = 'n';  break;
+               case '\f' : octbuf[1] = 'f';  break;
+               case '"'  : if ( dq == *pv ) {
+                               octbuf[1] = '"';
+                               break;
+                           }
+               default:
+                           /* note the (U8*) casts here are important.
+                            * if they are omitted we can produce the octal
+                            * for a negative number which could produce a
+                            * buffer overrun in octbuf, with it on we are
+                            * guaranteed that the longest the string could be
+                            * is 5, (we reserve 8 just because its the first
+                            * power of 2 larger than 5.)*/
+                           if ( (pv < end) && isDIGIT(*(pv+1)) )
+                               chsize = sprintf( octbuf, "\\%03o", (U8)*pv);
+                           else
+                               chsize = sprintf( octbuf, "\\%o", (U8)*pv);
+           }
+           if ( max && (wrote + chsize > max) ) {
+               break;
+           } else {
+               sv_catpvn(dsv, octbuf, chsize);
+               wrote += chsize;
+           }
+       } else {
+           sv_catpvn(dsv, pv, 1);
+           wrote++;
+       }
+    }
+    if ( dq == '"' ) {
+       sv_catpvn( dsv, "\"", 1 );
+       if ( pv < end )
+           sv_catpvn( dsv, "...", 3 );
+    } else if ( max && (flags & PERL_PV_ESCAPE_PADR) ) {
+       for ( ; wrote < max ; wrote++ )
+           sv_catpvn( dsv, " ", 1 );
     }
-    sv_catpvs(dsv, "\"");
-    if (truncated)
-       sv_catpvs(dsv, "...");
-    if (nul_terminated)
-       sv_catpvs(dsv, "\\0");
+    return SvPVX(dsv);
+}
+
+/*
+=for apidoc pv_display
+
+  char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
+                   STRLEN pvlim, U32 flags)
+
+Similar to
+
+  pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
+
+except that an additional "\0" will be appended to the string when
+len > cur and pv[cur] is "\0".
+
+Note that the final string may be up to 7 chars longer than pvlim.
+
+=cut
+*/
 
+char *
+Perl_pv_display(pTHX_ SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)
+{
+    pv_escape( dsv, pv, cur, pvlim, PERL_PV_ESCAPE_QUOTE);
+    if (len > cur && pv[cur] == '\0')
+            sv_catpvn( dsv, "\\0", 2 );
     return SvPVX(dsv);
 }
 
@@ -305,7 +386,7 @@ Perl_sv_peek(pTHX_ SV *sv)
        if (!SvPVX_const(sv))
            sv_catpv(t, "(null)");
        else {
-           SV *tmp = newSVpvs("");
+           SV * const tmp = newSVpvs("");
            sv_catpv(t, "(");
            if (SvOOK(sv))
                Perl_sv_catpvf(aTHX_ t, "[%s]", pv_display(tmp, SvPVX_const(sv)-SvIVX(sv), SvIVX(sv), 0, 127));
@@ -373,8 +454,7 @@ Perl_do_pmop_dump(pTHX_ I32 level, PerlIO *file, const PMOP *pm)
     Perl_dump_indent(aTHX_ level-1, file, "}\n");
 }
 
-static
-SV *
+static SV *
 S_pm_description(pTHX_ const PMOP *pm)
 {
     SV * const desc = newSVpvs("");
@@ -423,11 +503,7 @@ STATIC void
 S_sequence(pTHX_ register const OP *o)
 {
     dVAR;
-    SV      *op;
-    const char *key;
-    STRLEN   len;
     const OP *oldop = NULL;
-    OP      *l;
 
     if (!o)
        return;
@@ -441,8 +517,10 @@ S_sequence(pTHX_ register const OP *o)
        Sequence = newHV();
 
     for (; o; o = o->op_next) {
-       op = newSVuv(PTR2UV(o));
-       key = SvPV_const(op, len);
+       STRLEN len;
+       SV * const op = newSVuv(PTR2UV(o));
+       const char * const key = SvPV_const(op, len);
+
        if (hv_exists(Sequence, key, len))
            break;
 
@@ -481,32 +559,22 @@ S_sequence(pTHX_ register const OP *o)
        case OP_COND_EXPR:
        case OP_RANGE:
            hv_store(Sequence, key, len, newSVuv(++PL_op_seq), 0);
-           for (l = cLOGOPo->op_other; l && l->op_type == OP_NULL; l = l->op_next)
-               ;
-           sequence(l);
+           sequence_tail(cLOGOPo->op_other);
            break;
 
        case OP_ENTERLOOP:
        case OP_ENTERITER:
            hv_store(Sequence, key, len, newSVuv(++PL_op_seq), 0);
-           for (l = cLOOPo->op_redoop; l && l->op_type == OP_NULL; l = l->op_next)
-               ;
-           sequence(l);
-           for (l = cLOOPo->op_nextop; l && l->op_type == OP_NULL; l = l->op_next)
-               ;
-           sequence(l);
-           for (l = cLOOPo->op_lastop; l && l->op_type == OP_NULL; l = l->op_next)
-               ;
-           sequence(l);
+           sequence_tail(cLOOPo->op_redoop);
+           sequence_tail(cLOOPo->op_nextop);
+           sequence_tail(cLOOPo->op_lastop);
            break;
 
        case OP_QR:
        case OP_MATCH:
        case OP_SUBST:
            hv_store(Sequence, key, len, newSVuv(++PL_op_seq), 0);
-           for (l = cPMOPo->op_pmreplstart; l && l->op_type == OP_NULL; l = l->op_next)
-               ;
-           sequence(l);
+           sequence_tail(cPMOPo->op_pmreplstart);
            break;
 
        case OP_HELEM:
@@ -520,6 +588,14 @@ S_sequence(pTHX_ register const OP *o)
     }
 }
 
+static void
+S_sequence_tail(pTHX_ const OP *o)
+{
+    while (o && (o->op_type == OP_NULL))
+       o = o->op_next;
+    sequence(o);
+}
+
 STATIC UV
 S_sequence_num(pTHX_ const OP *o)
 {
@@ -672,16 +748,16 @@ Perl_do_op_dump(pTHX_ I32 level, PerlIO *file, const OP *o)
            }
            else {
                switch (o->op_private & OPpDEREF) {
-           case OPpDEREF_SV:
-               sv_catpv(tmpsv, ",SV");
-               break;
-           case OPpDEREF_AV:
-               sv_catpv(tmpsv, ",AV");
-               break;
-           case OPpDEREF_HV:
-               sv_catpv(tmpsv, ",HV");
-               break;
-           }
+               case OPpDEREF_SV:
+                   sv_catpv(tmpsv, ",SV");
+                   break;
+               case OPpDEREF_AV:
+                   sv_catpv(tmpsv, ",AV");
+                   break;
+               case OPpDEREF_HV:
+                   sv_catpv(tmpsv, ",HV");
+                   break;
+               }
                if (o->op_private & OPpMAYBE_LVSUB)
                    sv_catpv(tmpsv, ",MAYBE_LVSUB");
            }
@@ -1004,7 +1080,7 @@ static const struct { const char type; const char *name; } magic_names[] = {
        { PERL_MAGIC_defelem,        "defelem(y)" },
        { PERL_MAGIC_ext,            "ext(~)" },
        /* this null string terminates the list */
-       { 0,                         0 },
+       { 0,                         NULL },
 };
 
 void
@@ -1015,7 +1091,7 @@ Perl_do_magic_dump(pTHX_ I32 level, PerlIO *file, const MAGIC *mg, I32 nest, I32
                         "  MAGIC = 0x%"UVxf"\n", PTR2UV(mg));
        if (mg->mg_virtual) {
             const MGVTBL * const v = mg->mg_virtual;
-           const char *s = NULL;
+           const char *s;
            if      (v == &PL_vtbl_sv)         s = "sv";
             else if (v == &PL_vtbl_env)        s = "env";
             else if (v == &PL_vtbl_envelem)    s = "envelem";
@@ -1045,6 +1121,7 @@ Perl_do_magic_dump(pTHX_ I32 level, PerlIO *file, const MAGIC *mg, I32 nest, I32
            else if (v == &PL_vtbl_utf8)       s = "utf8";
             else if (v == &PL_vtbl_arylen_p)   s = "arylen_p";
             else if (v == &PL_vtbl_hintselem)  s = "hintselem";
+           else                               s = NULL;
            if (s)
                Perl_dump_indent(aTHX_ level, file, "    MG_VIRTUAL = &PL_vtbl_%s\n", s);
            else
@@ -1129,7 +1206,7 @@ Perl_do_magic_dump(pTHX_ I32 level, PerlIO *file, const MAGIC *mg, I32 nest, I32
 void
 Perl_magic_dump(pTHX_ const MAGIC *mg)
 {
-    do_magic_dump(0, Perl_debug_log, mg, 0, 0, 0, 0);
+    do_magic_dump(0, Perl_debug_log, mg, 0, 0, FALSE, 0);
 }
 
 void
@@ -1241,15 +1318,19 @@ Perl_do_sv_dump(pTHX_ I32 level, PerlIO *file, SV *sv, I32 nest, I32 maxnest, bo
        if (HvREHASH(sv))       sv_catpv(d, "REHASH,");
        if (flags & SVphv_CLONEABLE) sv_catpv(d, "CLONEABLE,");
        break;
-    case SVt_PVGV: case SVt_PVLV:
-       if (GvINTRO(sv))        sv_catpv(d, "INTRO,");
-       if (GvMULTI(sv))        sv_catpv(d, "MULTI,");
-       if (GvUNIQUE(sv))       sv_catpv(d, "UNIQUE,");
-       if (GvASSUMECV(sv))     sv_catpv(d, "ASSUMECV,");
-       if (GvIN_PAD(sv))       sv_catpv(d, "IN_PAD,");
+    case SVt_PVGV:
+    case SVt_PVLV:
+       if (isGV_with_GP(sv)) {
+           if (GvINTRO(sv))    sv_catpv(d, "INTRO,");
+           if (GvMULTI(sv))    sv_catpv(d, "MULTI,");
+           if (GvUNIQUE(sv))   sv_catpv(d, "UNIQUE,");
+           if (GvASSUMECV(sv)) sv_catpv(d, "ASSUMECV,");
+           if (GvIN_PAD(sv))   sv_catpv(d, "IN_PAD,");
+       }
        if (SvPAD_OUR(sv))      sv_catpv(d, "OUR,");
+       if (SvPAD_STATE(sv))    sv_catpv(d, "STATE,");
        if (SvPAD_TYPED(sv))    sv_catpv(d, "TYPED,");
-       if (GvIMPORTED(sv)) {
+       if (isGV_with_GP(sv) && GvIMPORTED(sv)) {
            sv_catpv(d, "IMPORT");
            if (GvIMPORTED(sv) == GVf_IMPORTED)
                sv_catpv(d, "ALL,");
@@ -1448,7 +1529,7 @@ Perl_do_sv_dump(pTHX_ I32 level, PerlIO *file, SV *sv, I32 nest, I32 maxnest, bo
        if (HvARRAY(sv) && HvKEYS(sv)) {
            /* Show distribution of HEs in the ARRAY */
            int freq[200];
-#define FREQ_MAX (sizeof freq / sizeof freq[0] - 1)
+#define FREQ_MAX ((int)(sizeof freq / sizeof freq[0] - 1))
            int i;
            int max = 0;
            U32 pow2 = 2, keys = HvKEYS(sv);
@@ -1505,18 +1586,18 @@ Perl_do_sv_dump(pTHX_ I32 level, PerlIO *file, SV *sv, I32 nest, I32 maxnest, bo
        Perl_dump_indent(aTHX_ level, file, "  RITER = %"IVdf"\n", (IV)HvRITER_get(sv));
        Perl_dump_indent(aTHX_ level, file, "  EITER = 0x%"UVxf"\n", PTR2UV(HvEITER_get(sv)));
        {
-           MAGIC *mg = mg_find(sv, PERL_MAGIC_symtab);
+           MAGIC * const mg = mg_find(sv, PERL_MAGIC_symtab);
            if (mg && mg->mg_obj) {
                Perl_dump_indent(aTHX_ level, file, "  PMROOT = 0x%"UVxf"\n", PTR2UV(mg->mg_obj));
            }
        }
        {
-           const char *hvname = HvNAME_get(sv);
+           const char * const hvname = HvNAME_get(sv);
            if (hvname)
                Perl_dump_indent(aTHX_ level, file, "  NAME = \"%s\"\n", hvname);
        }
        if (SvOOK(sv)) {
-           AV *backrefs = *Perl_hv_backreferences_p(aTHX_ (HV*)sv);
+           const AV * const backrefs = *Perl_hv_backreferences_p(aTHX_ (HV*)sv);
            if (backrefs) {
                Perl_dump_indent(aTHX_ level, file, "  BACKREFS = 0x%"UVxf"\n",
                                 PTR2UV(backrefs));
@@ -1601,7 +1682,7 @@ Perl_do_sv_dump(pTHX_ I32 level, PerlIO *file, SV *sv, I32 nest, I32 maxnest, bo
            do_dump_pad(level+1, file, CvPADLIST(sv), 0);
        }
        {
-            const CV *outside = CvOUTSIDE(sv);
+           const CV * const outside = CvOUTSIDE(sv);
            Perl_dump_indent(aTHX_ level, file, "  OUTSIDE = 0x%"UVxf" (%s)\n",
                        PTR2UV(outside),
                        (!outside ? "null"
@@ -1613,21 +1694,22 @@ Perl_do_sv_dump(pTHX_ I32 level, PerlIO *file, SV *sv, I32 nest, I32 maxnest, bo
        if (nest < maxnest && (CvCLONE(sv) || CvCLONED(sv)))
            do_sv_dump(level+1, file, (SV*)CvOUTSIDE(sv), nest+1, maxnest, dumpops, pvlim);
        break;
-    case SVt_PVGV: case SVt_PVLV:
-    if (type == SVt_PVLV) {
-        Perl_dump_indent(aTHX_ level, file, "  TYPE = %c\n", LvTYPE(sv));
-        Perl_dump_indent(aTHX_ level, file, "  TARGOFF = %"IVdf"\n", (IV)LvTARGOFF(sv));
-        Perl_dump_indent(aTHX_ level, file, "  TARGLEN = %"IVdf"\n", (IV)LvTARGLEN(sv));
-        Perl_dump_indent(aTHX_ level, file, "  TARG = 0x%"UVxf"\n", PTR2UV(LvTARG(sv)));
-        if (LvTYPE(sv) != 't' && LvTYPE(sv) != 'T')
-            do_sv_dump(level+1, file, LvTARG(sv), nest+1, maxnest,
-                dumpops, pvlim);
-    }
+    case SVt_PVGV:
+    case SVt_PVLV:
+       if (type == SVt_PVLV) {
+           Perl_dump_indent(aTHX_ level, file, "  TYPE = %c\n", LvTYPE(sv));
+           Perl_dump_indent(aTHX_ level, file, "  TARGOFF = %"IVdf"\n", (IV)LvTARGOFF(sv));
+           Perl_dump_indent(aTHX_ level, file, "  TARGLEN = %"IVdf"\n", (IV)LvTARGLEN(sv));
+           Perl_dump_indent(aTHX_ level, file, "  TARG = 0x%"UVxf"\n", PTR2UV(LvTARG(sv)));
+           if (LvTYPE(sv) != 't' && LvTYPE(sv) != 'T')
+               do_sv_dump(level+1, file, LvTARG(sv), nest+1, maxnest,
+                   dumpops, pvlim);
+       }
+       if (!isGV_with_GP(sv))
+           break;
        Perl_dump_indent(aTHX_ level, file, "  NAME = \"%s\"\n", GvNAME(sv));
        Perl_dump_indent(aTHX_ level, file, "  NAMELEN = %"IVdf"\n", (IV)GvNAMELEN(sv));
        do_hv_dump (level, file, "  GvSTASH", GvSTASH(sv));
-       if (!isGV_with_GP(sv))
-           break;
        Perl_dump_indent(aTHX_ level, file, "  GP = 0x%"UVxf"\n", PTR2UV(GvGP(sv)));
        if (!GvGP(sv))
            break;
@@ -1716,7 +1798,7 @@ Perl_runops_debug(pTHX)
     do {
        PERL_ASYNC_CHECK();
        if (PL_debug) {
-           if (PL_watchaddr != 0 && *PL_watchaddr != PL_watchok)
+           if (PL_watchaddr && (*PL_watchaddr != PL_watchok))
                PerlIO_printf(Perl_debug_log,
                              "WARNING: %"UVxf" changed from %"UVxf" to %"UVxf"\n",
                              PTR2UV(PL_watchaddr), PTR2UV(PL_watchok),
@@ -1756,7 +1838,7 @@ Perl_debop(pTHX_ const OP *o)
     case OP_GVSV:
     case OP_GV:
        if (cGVOPo_gv) {
-           SV *sv = newSV(0);
+           SV * const sv = newSV(0);
 #ifdef PERL_MAD
            /* FIXME - it this making unwarranted assumptions about the
               UTF-8 cleanliness of the dump file handle?  */
@@ -1774,18 +1856,18 @@ Perl_debop(pTHX_ const OP *o)
     case OP_PADHV:
        {
        /* print the lexical's name */
-       CV *cv = deb_curcv(cxstack_ix);
+       CV * const cv = deb_curcv(cxstack_ix);
        SV *sv;
         if (cv) {
-            AV * const padlist = CvPADLIST(cv);
+           AV * const padlist = CvPADLIST(cv);
             AV * const comppad = (AV*)(*av_fetch(padlist, 0, FALSE));
             sv = *av_fetch(comppad, o->op_targ, FALSE);
         } else
             sv = NULL;
         if (sv)
-           PerlIO_printf(Perl_debug_log, "(%s)", SvPV_nolen_const(sv));
+           PerlIO_printf(Perl_debug_log, "(%s)", SvPV_nolen_const(sv));
         else
-           PerlIO_printf(Perl_debug_log, "[%"UVuf"]", (UV)o->op_targ);
+           PerlIO_printf(Perl_debug_log, "[%"UVuf"]", (UV)o->op_targ);
        }
         break;
     default:
@@ -1799,7 +1881,7 @@ STATIC CV*
 S_deb_curcv(pTHX_ I32 ix)
 {
     dVAR;
-    const PERL_CONTEXT *cx = &cxstack[ix];
+    const PERL_CONTEXT * const cx = &cxstack[ix];
     if (CxTYPE(cx) == CXt_SUB || CxTYPE(cx) == CXt_FORMAT)
         return cx->blk_sub.cv;
     else if (CxTYPE(cx) == CXt_EVAL && !CxTRYBLOCK(cx))