This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Reduce false positives for @hsh{$s} and @ary[$s] warnings
[perl5.git] / ext / B / B / Concise.pm
index 817fa0c..c644d30 100644 (file)
@@ -14,7 +14,7 @@ use warnings; # uses #3 and #4, since warnings uses Carp
 
 use Exporter (); # use #5
 
-our $VERSION   = "0.92";
+our $VERSION   = "0.99";
 our @ISA       = qw(Exporter);
 our @EXPORT_OK = qw( set_style set_style_standard add_callback
                     concise_subref concise_cv concise_main
@@ -47,8 +47,7 @@ my %style =
     "(?(#seq)?)#noise#arg(?([#targarg])?)"],
    "debug" =>
    ["#class (#addr)\n\top_next\t\t#nextaddr\n\top_sibling\t#sibaddr\n\t"
-    . "op_ppaddr\tPL_ppaddr[OP_#NAME]\n\top_type\t\t#typenum\n" .
-    ($] > 5.009 ? '' : "\top_seq\t\t#seqnum\n")
+    . "op_ppaddr\tPL_ppaddr[OP_#NAME]\n\top_type\t\t#typenum\n"
     . "\top_flags\t#flagval\n\top_private\t#privval\t#hintsval\n"
     . "(?(\top_first\t#firstaddr\n)?)(?(\top_last\t\t#lastaddr\n)?)"
     . "(?(\top_sv\t\t#svaddr\n)?)",
@@ -356,8 +355,6 @@ sub compile {
            }
            else {
                # convert function names to subrefs
-               my $objref;
-               my $objref2;
                if (ref $objname) {
                    print $walkHandle "B::Concise::compile($objname)\n"
                        if $banner;
@@ -512,15 +509,9 @@ sub walk_exec {
                push @$targ, $ar;
                push @todo, [$op->pmreplstart, $ar];
            } elsif ($name =~ /^enter(loop|iter)$/) {
-               if ($] > 5.009) {
-                   $labels{${$op->nextop}} = "NEXT";
-                   $labels{${$op->lastop}} = "LAST";
-                   $labels{${$op->redoop}} = "REDO";
-               } else {
-                   $labels{$op->nextop->seq} = "NEXT";
-                   $labels{$op->lastop->seq} = "LAST";
-                   $labels{$op->redoop->seq} = "REDO";         
-               }
+               $labels{${$op->nextop}} = "NEXT";
+               $labels{${$op->lastop}} = "LAST";
+               $labels{${$op->redoop}} = "REDO";
            }
        }
     }
@@ -603,78 +594,70 @@ sub fmt_line {    # generate text-line for op.
 our %priv; # used to display each opcode's BASEOP.op_private values
 
 $priv{$_}{128} = "LVINTRO"
-  for ("pos", "substr", "vec", "threadsv", "gvsv", "rv2sv", "rv2hv", "rv2gv",
-       "rv2av", "rv2arylen", "aelem", "helem", "aslice", "hslice", "padsv",
-       "padav", "padhv", "enteriter", "entersub");
-$priv{$_}{64} = "REFC" for ("leave", "leavesub", "leavesublv", "leavewrite");
-$priv{"aassign"}{64} = "COMMON";
-$priv{"aassign"}{32} = $] < 5.009 ? "PHASH" : "STATE";
-$priv{"sassign"}{32} = "STATE";
-$priv{"sassign"}{64} = "BKWARD";
-$priv{"sassign"}{128}= "CV2GV";
-$priv{$_}{64} = "RTIME" for ("match", "subst", "substcont", "qr");
-@{$priv{"trans"}}{1,2,4,8,16,64} = ("<UTF", ">UTF", "IDENT", "SQUASH", "DEL",
-                                   "COMPL", "GROWS");
-$priv{transr} = $priv{trans};
-$priv{"repeat"}{64} = "DOLIST";
-$priv{"leaveloop"}{64} = "CONT";
-$priv{$_}{4} = "DREFed" for (qw(rv2sv rv2av rv2hv));
-@{$priv{$_}}{32,64,96} = ("DREFAV", "DREFHV", "DREFSV")
-  for (qw(rv2gv rv2sv padsv aelem helem));
-$priv{$_}{16} = "STATE" for ("padav", "padhv", "padsv");
-@{$priv{rv2gv}}{4,16} = qw "NOINIT FAKE";
-@{$priv{"entersub"}}{1,4,16,32,64} = qw( INARGS TARG DBG DEREF );
-@{$priv{rv2cv}}{1,8,128} = ("CONST","AMPER","NO()");
-$priv{"gv"}{32} = "EARLYCV";
-$priv{"aelem"}{16} = $priv{"helem"}{16} = "LVDEFER";
-$priv{$_}{16} = "OURINTR" for ("gvsv", "rv2sv", "rv2av", "rv2hv", "r2gv",
-       "enteriter");
-$priv{$_}{8} = 'LVSUB' for qw(rv2av rv2gv rv2hv padav padhv aelem helem
-                        aslice hslice av2arylen keys rkeys substr pos vec);
-$priv{substr}{16} = 'REPL1ST';
+  for qw(pos substr vec threadsv gvsv rv2sv rv2hv rv2gv rv2av rv2arylen
+         aelem helem aslice hslice padsv padav padhv enteriter entersub
+         padrange pushmark);
+$priv{$_}{64} = "REFC" for qw(leave leavesub leavesublv leavewrite);
+@{$priv{aassign}}{32,64} = qw(STATE COMMON);
+@{$priv{sassign}}{32,64,128} = qw(STATE BKWARD CV2GV);
+$priv{$_}{64} = "RTIME" for qw(match subst substcont qr);
+@{$priv{$_}}{1,2,4,8,16,64} = qw(<UTF >UTF IDENT SQUASH DEL COMPL GROWS)
+  for qw(trans transr);
+$priv{repeat}{64} = "DOLIST";
+$priv{leaveloop}{64} = "CONT";
+$priv{$_}{4} = "DREFed" for qw(rv2sv rv2av rv2hv);
+@{$priv{$_}}{32,64,96} = qw(DREFAV DREFHV DREFSV)
+  for qw(rv2gv rv2sv padsv aelem helem);
+$priv{$_}{16} = "STATE" for qw(padav padhv padsv);
+@{$priv{rv2gv}}{4,16} = qw(NOINIT FAKE);
+@{$priv{entersub}}{1,4,16,32,64} = qw(INARGS TARG DBG DEREF);
+@{$priv{rv2cv}}{1,8,128} = qw(CONST AMPER NO());
+$priv{gv}{32} = "EARLYCV";
+$priv{$_}{16} = "LVDEFER" for qw(aelem helem);
+$priv{$_}{16} = "OURINTR" for qw(gvsv rv2sv rv2av rv2hv r2gv enteriter);
+$priv{$_}{8} = "LVSUB"
+  for qw(rv2av rv2gv rv2hv padav padhv aelem helem aslice hslice
+         av2arylen keys rkeys substr pos vec);
+$priv{$_}{4} = "SLICEWARN"
+  for qw(rv2hv rv2av kvhslice kvaslice padav padhv hslice aslice);
+@{$priv{$_}}{32,64} = qw(BOOL BOOL?) for qw(rv2hv padhv);
+$priv{substr}{16} = "REPL1ST";
 $priv{$_}{16} = "TARGMY"
-  for (map(($_,"s$_"),"chop", "chomp"),
-       map(($_,"i_$_"), "postinc", "postdec", "multiply", "divide", "modulo",
-          "add", "subtract", "negate"), "pow", "concat", "stringify",
-       "left_shift", "right_shift", "bit_and", "bit_xor", "bit_or",
-       "complement", "atan2", "sin", "cos", "rand", "exp", "log", "sqrt",
-       "int", "hex", "oct", "abs", "length", "index", "rindex", "sprintf",
-       "ord", "chr", "crypt", "quotemeta", "join", "push", "unshift", "flock",
-       "chdir", "chown", "chroot", "unlink", "chmod", "utime", "rename",
-       "link", "symlink", "mkdir", "rmdir", "wait", "waitpid", "system",
-       "exec", "kill", "getppid", "getpgrp", "setpgrp", "getpriority",
-       "setpriority", "time", "sleep");
-$priv{$_}{4} = "REVERSED" for ("enteriter", "iter");
-@{$priv{"const"}}{2,4,8,16,64,128} =
-    ("NOVER","SHORT","STRICT","ENTERED","BARE","FOLD");
-$priv{"flip"}{64} = $priv{"flop"}{64} = "LINENUM";
-$priv{"list"}{64} = "GUESSED";
-$priv{"delete"}{64} = "SLICE";
-$priv{"exists"}{64} = "SUB";
-@{$priv{"sort"}}{1,2,4,8,16,32,64} = ("NUM", "INT", "REV", "INPLACE","DESC","QSORT","STABLE");
-$priv{"reverse"}{8} = "INPLACE";
-$priv{"threadsv"}{64} = "SVREFd";
-@{$priv{$_}}{16,32,64,128} = ("INBIN","INCR","OUTBIN","OUTCR")
-  for ("open", "backtick");
-$priv{"exit"}{128} = "VMS";
+  for map(($_,"s$_"), qw(chop chomp)),
+      map(($_,"i_$_"), qw(postinc postdec multiply divide modulo add
+                          subtract negate)),
+      qw(pow concat stringify left_shift right_shift bit_and bit_xor
+         bit_or complement atan2 sin cos rand exp log sqrt int hex oct
+         abs length index rindex sprintf ord chr crypt quotemeta join
+         push unshift flock chdir chown chroot unlink chmod utime rename
+         link symlink mkdir rmdir wait waitpid system exec kill getppid
+         getpgrp setpgrp getpriority setpriority time sleep);
+$priv{$_}{4} = "REVERSED" for qw(enteriter iter);
+@{$priv{const}}{2,4,8,16,64,128} = qw(NOVER SHORT STRICT ENTERED BARE FOLD);
+$priv{$_}{64} = "LINENUM" for qw(flip flop);
+$priv{list}{64} = "GUESSED";
+$priv{delete}{64} = "SLICE";
+$priv{exists}{64} = "SUB";
+@{$priv{sort}}{1,2,4,8,16,32,64} = qw(NUM INT REV INPLACE DESC QSORT STABLE);
+$priv{reverse}{8} = "INPLACE";
+$priv{threadsv}{64} = "SVREFd";
+@{$priv{$_}}{16,32,64,128} = qw(INBIN INCR OUTBIN OUTCR)
+  for qw(open backtick);
+$priv{exit}{128} = "VMS";
 $priv{$_}{2} = "FTACCESS"
-  for ("ftrread", "ftrwrite", "ftrexec", "fteread", "ftewrite", "fteexec");
-@{$priv{"entereval"}}{2,4,8,16} = qw "HAS_HH UNI BYTES COPHH";
-if ($] >= 5.009) {
-  # Stacked filetests are post 5.8.x
-  @{$priv{$_}}{4,8,16} = ("FTSTACKED","FTSTACKING","FTAFTERt")
-    for ("ftrread", "ftrwrite", "ftrexec", "fteread", "ftewrite", "fteexec",
-         "ftis", "fteowned", "ftrowned", "ftzero", "ftsize", "ftmtime",
-        "ftatime", "ftctime", "ftsock", "ftchr", "ftblk", "ftfile", "ftdir",
-        "ftpipe", "ftlink", "ftsuid", "ftsgid", "ftsvtx", "fttty", "fttext",
-        "ftbinary");
-  # Lexical $_ is post 5.8.x
-  $priv{$_}{2} = "GREPLEX"
-    for ("mapwhile", "mapstart", "grepwhile", "grepstart");
-}
-$priv{$_}{128} = '+1' for qw "caller wantarray runcv";
-@{$priv{coreargs}}{1,2,64,128} = ('DREF1','DREF2','$MOD','MARK');
-$priv{$_}{128} = 'UTF' for qw "last redo next goto dump";
+  for qw(ftrread ftrwrite ftrexec fteread ftewrite fteexec);
+@{$priv{entereval}}{2,4,8,16} = qw(HAS_HH UNI BYTES COPHH);
+@{$priv{$_}}{4,8,16} = qw(FTSTACKED FTSTACKING FTAFTERt)
+  for qw(ftrread ftrwrite ftrexec fteread ftewrite fteexec ftis fteowned
+         ftrowned ftzero ftsize ftmtime ftatime ftctime ftsock ftchr
+         ftblk ftfile ftdir ftpipe ftlink ftsuid ftsgid ftsvtx fttty
+         fttext ftbinary);
+$priv{$_}{2} = "GREPLEX"
+  for qw(mapwhile mapstart grepwhile grepstart);
+$priv{$_}{128} = "+1" for qw(caller wantarray runcv);
+@{$priv{coreargs}}{1,2,64,128} = qw(DREF1 DREF2 $MOD MARK);
+$priv{$_}{128} = "UTF" for qw(last redo next goto dump);
+$priv{split}{128} = "IMPLIM";
 
 our %hints; # used to display each COP's op_hints values
 
@@ -723,7 +706,14 @@ sub concise_sv {
     $hr->{svaddr} = sprintf("%#x", $$sv);
     if ($hr->{svclass} eq "GV" && $sv->isGV_with_GP()) {
        my $gv = $sv;
-       my $stash = $gv->STASH->NAME; if ($stash eq "main") {
+       my $stash = $gv->STASH;
+       if (class($stash) eq "SPECIAL") {
+           $stash = "<none>";
+       }
+       else {
+           $stash = $stash->NAME;
+       }
+       if ($stash eq "main") {
            $stash = "";
        } else {
            $stash = $stash . "::";
@@ -744,13 +734,14 @@ sub concise_sv {
        }
        if (class($sv) eq "SPECIAL") {
            $hr->{svval} .= ["Null", "sv_undef", "sv_yes", "sv_no"]->[$$sv];
-       } elsif ($preferpv && $sv->FLAGS & SVf_POK) {
+       } elsif ($preferpv
+             && ($sv->FLAGS & SVf_POK || class($sv) eq "REGEXP")) {
            $hr->{svval} .= cstring($sv->PV);
        } elsif ($sv->FLAGS & SVf_NOK) {
            $hr->{svval} .= $sv->NV;
        } elsif ($sv->FLAGS & SVf_IOK) {
            $hr->{svval} .= $sv->int_value;
-       } elsif ($sv->FLAGS & SVf_POK) {
+       } elsif ($sv->FLAGS & SVf_POK || class($sv) eq "REGEXP") {
            $hr->{svval} .= cstring($sv->PV);
        } elsif (class($sv) eq "HV") {
            $hr->{svval} .= 'HASH';
@@ -798,38 +789,44 @@ sub concise_op {
            $h{targarglife} = $h{targarg} = "$h{targ} $refs";
        }
     } elsif ($h{targ}) {
-       my $padname = (($curcv->PADLIST->ARRAY)[0]->ARRAY)[$h{targ}];
-       if (defined $padname and class($padname) ne "SPECIAL") {
-           $h{targarg}  = $padname->PVX;
-           if ($padname->FLAGS & SVf_FAKE) {
-               if ($] < 5.009) {
-                   $h{targarglife} = "$h{targarg}:FAKE";
-               } else {
+       my $count = $h{name} eq 'padrange' ? ($op->private & 127) : 1;
+       my (@targarg, @targarglife);
+       for my $i (0..$count-1) {
+           my ($targarg, $targarglife);
+           my $padname = (($curcv->PADLIST->ARRAY)[0]->ARRAY)[$h{targ}+$i];
+           if (defined $padname and class($padname) ne "SPECIAL") {
+               $targarg  = $padname->PVX;
+               if ($padname->FLAGS & SVf_FAKE) {
                    # These changes relate to the jumbo closure fix.
                    # See changes 19939 and 20005
                    my $fake = '';
                    $fake .= 'a'
-                       if $padname->PARENT_FAKELEX_FLAGS & PAD_FAKELEX_ANON;
+                       if $padname->PARENT_FAKELEX_FLAGS & PAD_FAKELEX_ANON;
                    $fake .= 'm'
-                       if $padname->PARENT_FAKELEX_FLAGS & PAD_FAKELEX_MULTI;
+                       if $padname->PARENT_FAKELEX_FLAGS & PAD_FAKELEX_MULTI;
                    $fake .= ':' . $padname->PARENT_PAD_INDEX
                        if $curcv->CvFLAGS & CVf_ANON;
-                   $h{targarglife} = "$h{targarg}:FAKE:$fake";
+                   $targarglife = "$targarg:FAKE:$fake";
                }
+               else {
+                   my $intro = $padname->COP_SEQ_RANGE_LOW - $cop_seq_base;
+                   my $finish = int($padname->COP_SEQ_RANGE_HIGH) - $cop_seq_base;
+                   $finish = "end" if $finish == 999999999 - $cop_seq_base;
+                   $targarglife = "$targarg:$intro,$finish";
+               }
+           } else {
+               $targarglife = $targarg = "t" . ($h{targ}+$i);
            }
-           else {
-               my $intro = $padname->COP_SEQ_RANGE_LOW - $cop_seq_base;
-               my $finish = int($padname->COP_SEQ_RANGE_HIGH) - $cop_seq_base;
-               $finish = "end" if $finish == 999999999 - $cop_seq_base;
-               $h{targarglife} = "$h{targarg}:$intro,$finish";
-           }
-       } else {
-           $h{targarglife} = $h{targarg} = "t" . $h{targ};
+           push @targarg,     $targarg;
+           push @targarglife, $targarglife;
        }
+       $h{targarg}     = join '; ', @targarg;
+       $h{targarglife} = join '; ', @targarglife;
     }
     $h{arg} = "";
     $h{svclass} = $h{svaddr} = $h{svval} = "";
     if ($h{class} eq "PMOP") {
+       my $extra = '';
        my $precomp = $op->precomp;
        if (defined $precomp) {
            $precomp = cstring($precomp); # Escape literal control sequences
@@ -837,25 +834,30 @@ sub concise_op {
        } else {
            $precomp = "";
        }
-       my $pmreplroot = $op->pmreplroot;
-       my $pmreplstart;
-       if (ref($pmreplroot) eq "B::GV") {
+       if ($op->name eq 'subst') {
+           if (class($op->pmreplstart) ne "NULL") {
+               undef $lastnext;
+               $extra = " replstart->" . seq($op->pmreplstart);
+           }
+       }
+       elsif ($op->name eq 'pushre') {
            # with C<@stash_array = split(/pat/, str);>,
            #  *stash_array is stored in /pat/'s pmreplroot.
-           $h{arg} = "($precomp => \@" . $pmreplroot->NAME . ")";
-       } elsif (!ref($pmreplroot) and $pmreplroot) {
-           # same as the last case, except the value is actually a
-           # pad offset for where the GV is kept (this happens under
-           # ithreads)
-           my $gv = (($curcv->PADLIST->ARRAY)[1]->ARRAY)[$pmreplroot];
-           $h{arg} = "($precomp => \@" . $gv->NAME . ")";
-       } elsif ($ {$op->pmreplstart}) {
-           undef $lastnext;
-           $pmreplstart = "replstart->" . seq($op->pmreplstart);
-           $h{arg} = "(" . join(" ", $precomp, $pmreplstart) . ")";
-       } else {
-           $h{arg} = "($precomp)";
+           my $gv = $op->pmreplroot;
+           if (!ref($gv)) {
+               # threaded: the value is actually a pad offset for where
+               # the GV is kept (op_pmtargetoff)
+               if ($gv) {
+                   $gv = (($curcv->PADLIST->ARRAY)[1]->ARRAY)[$gv]->NAME;
+               }
+           }
+           else {
+               # unthreaded: its a GV (if it exists)
+               $gv = (ref($gv) eq "B::GV") ? $gv->NAME : undef;
+           }
+           $extra = " => \@$gv" if $gv;
        }
+       $h{arg} = "($precomp$extra)";
     } elsif ($h{class} eq "PVOP" and $h{name} !~ '^transr?\z') {
        $h{arg} = '("' . $op->pv . '")';
        $h{svval} = '"' . $op->pv . '"';
@@ -900,13 +902,8 @@ sub concise_op {
     }
     $h{seq} = $h{hyphseq} = seq($op);
     $h{seq} = "" if $h{seq} eq "-";
-    if ($] > 5.009) {
-       $h{opt} = $op->opt;
-       $h{label} = $labels{$$op};
-    } else {
-       $h{seqnum} = $op->seq;
-       $h{label} = $labels{$op->seq};
-    }
+    $h{opt} = $op->opt;
+    $h{label} = $labels{$$op};
     $h{next} = $op->next;
     $h{next} = (class($h{next}) eq "NULL") ? "(end)" : seq($h{next});
     $h{nextaddr} = sprintf("%#x", $ {$op->next});
@@ -1139,7 +1136,8 @@ on threaded and un-threaded perls.
 =head1 OPTIONS
 
 Arguments that don't start with a hyphen are taken to be the names of
-subroutines to render; if no such functions are specified, the main
+subroutines or formats to render; if no
+such functions are specified, the main
 body of the program (outside any subroutines, and not including use'd
 or require'd files) is rendered.  Passing C<BEGIN>, C<UNITCHECK>,
 C<CHECK>, C<INIT>, or C<END> will cause all of the corresponding
@@ -1640,7 +1638,7 @@ your program is).
 
 =item B<#opt>
 
-Whether or not the op has been optimised by the peephole optimiser.
+Whether or not the op has been optimized by the peephole optimizer.
 
 Only available in 5.9 and later.
 
@@ -1807,13 +1805,13 @@ B<walk_output> lets you change the print destination from STDOUT to
 another open filehandle, or into a string passed as a ref (unless
 you've built perl with -Uuseperlio).
 
-    my $walker = B::Concise::compile('-terse','aFuncName', \&aSubRef);  # 1
-    walk_output(\my $buf);
-    $walker->();                       # 1 renders -terse
-    set_style_standard('concise');     # 2
-    $walker->();                       # 2 renders -concise
-    $walker->(@new);                   # 3 renders whatever
-    print "3 different renderings: terse, concise, and @new: $buf\n";
+  my $walker = B::Concise::compile('-terse','aFuncName', \&aSubRef); # 1
+  walk_output(\my $buf);
+  $walker->();                         # 1 renders -terse
+  set_style_standard('concise');       # 2
+  $walker->();                         # 2 renders -concise
+  $walker->(@new);                     # 3 renders whatever
+  print "3 different renderings: terse, concise, and @new: $buf\n";
 
 When $walker is called, it traverses the subroutines supplied when it
 was created, and renders them using the current style.  You can change