lib/dumpvar.pl

   1 require 5.002;                  # For (defined ref)
   2 package dumpvar;
   3
   4 # Needed for PrettyPrinter only:
   5
   6 # require 5.001;  # Well, it coredumps anyway undef DB in 5.000 (not now)
   7
   8 # translate control chars to ^X - Randal Schwartz
   9 # Modifications to print types by Peter Gordon v1.0
  10
  11 # Ilya Zakharevich -- patches after 5.001 (and some before ;-)
  12
  13 # Won't dump symbol tables and contents of debugged files by default
  14
  15 $winsize = 80 unless defined $winsize;
  16
  17
  18 # Defaults
  19
  20 # $globPrint = 1;
  21 $printUndef = 1 unless defined $printUndef;
  22 $tick = "auto" unless defined $tick;
  23 $unctrl = 'quote' unless defined $unctrl;
  24 $subdump = 1;
  25 $dumpReused = 0 unless defined $dumpReused;
  26 $bareStringify = 1 unless defined $bareStringify;
  27
  28 sub main::dumpValue {
  29   local %address;
  30   local $^W=0;
  31   (print "undef\n"), return unless defined $_[0];
  32   (print &stringify($_[0]), "\n"), return unless ref $_[0];
  33   dumpvar::unwrap($_[0],0, $_[1]);
  34 }
  35
  36 # This one is good for variable names:
  37
  38 sub unctrl {
  39         local($_) = @_;
  40         local($v) ;
  41
  42         return \$_ if ref \$_ eq "GLOB";
  43         s/([\001-\037\177])/'^'.pack('c',ord($1)^64)/eg;
  44         $_;
  45 }
  46
  47 sub uniescape {
  48     join("",
  49          map { $_ > 255 ? sprintf("\\x{%04X}", $_) : chr($_) }
  50              unpack("U*", $_[0]));
  51 }
  52
  53 sub stringify {
  54         local($_,$noticks) = @_;
  55         local($v) ;
  56         my $tick = $tick;
  57
  58         return 'undef' unless defined $_ or not $printUndef;
  59         return $_ . "" if ref \$_ eq 'GLOB';
  60         $_ = &{'overload::StrVal'}($_)
  61           if $bareStringify and ref $_
  62             and %overload:: and defined &{'overload::StrVal'};
  63
  64         if ($tick eq 'auto') {
  65           if (/[\000-\011\013-\037\177]/) {
  66             $tick = '"';
  67           }else {
  68             $tick = "'";
  69           }
  70         }
  71         if ($tick eq "'") {
  72           s/([\'\\])/\\$1/g;
  73         } elsif ($unctrl eq 'unctrl') {
  74           s/([\"\\])/\\$1/g ;
  75           s/([\000-\037\177])/'^'.pack('c',ord($1)^64)/eg;
  76           # uniescape?
  77           s/([\200-\377])/'\\0x'.sprintf('%2X',ord($1))/eg
  78             if $quoteHighBit;
  79         } elsif ($unctrl eq 'quote') {
  80           s/([\"\\\$\@])/\\$1/g if $tick eq '"';
  81           s/\033/\\e/g;
  82           s/([\000-\037\177])/'\\c'.chr(ord($1)^64)/eg;
  83         }
  84         $_ = uniescape($_);
  85         s/([\200-\377])/'\\'.sprintf('%3o',ord($1))/eg if $quoteHighBit;
  86         ($noticks || /^\d+(\.\d*)?\Z/)
  87           ? $_
  88           : $tick . $_ . $tick;
  89 }
  90
  91 sub ShortArray {
  92   my $tArrayDepth = $#{$_[0]} ;
  93   $tArrayDepth = $#{$_[0]} < $arrayDepth-1 ? $#{$_[0]} : $arrayDepth-1
  94     unless  $arrayDepth eq '' ;
  95   my $shortmore = "";
  96   $shortmore = " ..." if $tArrayDepth < $#{$_[0]} ;
  97   if (!grep(ref $_, @{$_[0]})) {
  98     $short = "0..$#{$_[0]}  '" .
  99       join("' '", @{$_[0]}[0..$tArrayDepth]) . "'$shortmore";
 100     return $short if length $short <= $compactDump;
 101   }
 102   undef;
 103 }
 104
 105 sub DumpElem {
 106   my $short = &stringify($_[0], ref $_[0]);
 107   if ($veryCompact && ref $_[0]
 108       && (ref $_[0] eq 'ARRAY' and !grep(ref $_, @{$_[0]}) )) {
 109     my $end = "0..$#{$v}  '" .
 110       join("' '", @{$_[0]}[0..$tArrayDepth]) . "'$shortmore";
 111   } elsif ($veryCompact && ref $_[0]
 112       && (ref $_[0] eq 'HASH') and !grep(ref $_, values %{$_[0]})) {
 113     my $end = 1;
 114           $short = $sp . "0..$#{$v}  '" .
 115             join("' '", @{$v}[0..$tArrayDepth]) . "'$shortmore";
 116   } else {
 117     print "$short\n";
 118     unwrap($_[0],$_[1],$_[2]);
 119   }
 120 }
 121
 122 sub unwrap {
 123     return if $DB::signal;
 124     local($v) = shift ;
 125     local($s) = shift ; # extra no of spaces
 126     local($m) = shift ; # maximum recursion depth
 127     return if $m == 0;
 128     local(%v,@v,$sp,$value,$key,@sortKeys,$more,$shortmore,$short) ;
 129     local($tHashDepth,$tArrayDepth) ;
 130
 131     $sp = " " x $s ;
 132     $s += 3 ;
 133
 134     # Check for reused addresses
 135     if (ref $v) {
 136       my $val = $v;
 137       $val = &{'overload::StrVal'}($v)
 138         if %overload:: and defined &{'overload::StrVal'};
 139       # Match type and address.
 140       # Unblessed references will look like TYPE(0x...)
 141       # Blessed references will look like Class=TYPE(0x...)
 142       ($start_part, $val) = split /=/,$val;
 143       $val = $start_part unless defined $val;
 144       ($item_type, $address) =
 145         $val =~ /([^\(]+)        # Keep stuff that's
 146                                  # not an open paren
 147                  \(              # Skip open paren
 148                  (0x[0-9a-f]+)   # Save the address
 149                  \)              # Skip close paren
 150                  $/x;            # Should be at end now
 151
 152       if (!$dumpReused && defined $address) {
 153         $address{$address}++ ;
 154         if ( $address{$address} > 1 ) {
 155           print "${sp}-> REUSED_ADDRESS\n" ;
 156           return ;
 157         }
 158       }
 159     } elsif (ref \$v eq 'GLOB') {
 160       # This is a raw glob. Special handling for that.
 161       $address = "$v" . "";     # To avoid a bug with globs
 162       $address{$address}++ ;
 163       if ( $address{$address} > 1 ) {
 164         print "${sp}*DUMPED_GLOB*\n" ;
 165         return ;
 166       }
 167     }
 168
 169     if (ref $v eq 'Regexp') {
 170       # Reformat the regexp to look the standard way.
 171       my $re = "$v";
 172       $re =~ s,/,\\/,g;
 173       print "$sp-> qr/$re/\n";
 174       return;
 175     }
 176
 177     if ( $item_type eq 'HASH' ) {
 178         # Hash ref or hash-based object.
 179         @sortKeys = sort keys(%$v) ;
 180         undef $more ;
 181         $tHashDepth = $#sortKeys ;
 182         $tHashDepth = $#sortKeys < $hashDepth-1 ? $#sortKeys : $hashDepth-1
 183           unless $hashDepth eq '' ;
 184         $more = "....\n" if $tHashDepth < $#sortKeys ;
 185         $shortmore = "";
 186         $shortmore = ", ..." if $tHashDepth < $#sortKeys ;
 187         $#sortKeys = $tHashDepth ;
 188         if ($compactDump && !grep(ref $_, values %{$v})) {
 189           #$short = $sp .
 190           #  (join ', ',
 191 # Next row core dumps during require from DB on 5.000, even with map {"_"}
 192           #   map {&stringify($_) . " => " . &stringify($v->{$_})}
 193           #   @sortKeys) . "'$shortmore";
 194           $short = $sp;
 195           my @keys;
 196           for (@sortKeys) {
 197             push @keys, &stringify($_) . " => " . &stringify($v->{$_});
 198           }
 199           $short .= join ', ', @keys;
 200           $short .= $shortmore;
 201           (print "$short\n"), return if length $short <= $compactDump;
 202         }
 203         for $key (@sortKeys) {
 204             return if $DB::signal;
 205             $value = $ {$v}{$key} ;
 206             print "$sp", &stringify($key), " => ";
 207             DumpElem $value, $s, $m-1;
 208         }
 209         print "$sp  empty hash\n" unless @sortKeys;
 210         print "$sp$more" if defined $more ;
 211     } elsif ( $item_type eq 'ARRAY' ) {
 212         # Array ref or array-based object. Also: undef.
 213         # See how big the array is.
 214         $tArrayDepth = $#{$v} ;
 215         undef $more ;
 216         # Bigger than the max?
 217         $tArrayDepth = $#{$v} < $arrayDepth-1 ? $#{$v} : $arrayDepth-1
 218           if defined $arrayDepth && $arrayDepth ne '';
 219         # Yep. Don't show it all.
 220         $more = "....\n" if $tArrayDepth < $#{$v} ;
 221         $shortmore = "";
 222         $shortmore = " ..." if $tArrayDepth < $#{$v} ;
 223
 224         if ($compactDump && !grep(ref $_, @{$v})) {
 225           if ($#$v >= 0) {
 226             $short = $sp . "0..$#{$v}  " .
 227               join(" ",
 228                    map {exists $v->[$_] ? stringify $v->[$_] : "empty"} ($[..$tArrayDepth)
 229                   ) . "$shortmore";
 230           } else {
 231             $short = $sp . "empty array";
 232           }
 233           (print "$short\n"), return if length $short <= $compactDump;
 234         }
 235         #if ($compactDump && $short = ShortArray($v)) {
 236         #  print "$short\n";
 237         #  return;
 238         #}
 239         for $num ($[ .. $tArrayDepth) {
 240             return if $DB::signal;
 241             print "$sp$num  ";
 242             if (exists $v->[$num]) {
 243                 if (defined $v->[$num]) {
 244                   DumpElem $v->[$num], $s, $m-1;
 245                 }
 246                 else {
 247                   print "undef\n";
 248                 }
 249             } else {
 250                 print "empty slot\n";
 251             }
 252         }
 253         print "$sp  empty array\n" unless @$v;
 254         print "$sp$more" if defined $more ;
 255     } elsif ( $item_type eq 'SCALAR' ) {
 256             unless (defined $$v) {
 257               print "$sp-> undef\n";
 258               return;
 259             }
 260             print "$sp-> ";
 261             DumpElem $$v, $s, $m-1;
 262     } elsif ( $item_type eq 'REF' ) {
 263             print "$sp-> $$v\n";
 264             return unless defined $$v;
 265             unwrap($$v, $s+3, $m-1);
 266     } elsif ( $item_type eq 'CODE' ) {
 267             # Code object or reference.
 268             print "$sp-> ";
 269             dumpsub (0, $v);
 270     } elsif ( $item_type eq 'GLOB' ) {
 271       # Glob object or reference.
 272       print "$sp-> ",&stringify($$v,1),"\n";
 273       if ($globPrint) {
 274         $s += 3;
 275        dumpglob($s, "{$$v}", $$v, 1, $m-1);
 276       } elsif (defined ($fileno = fileno($v))) {
 277         print( (' ' x ($s+3)) .  "FileHandle({$$v}) => fileno($fileno)\n" );
 278       }
 279     } elsif (ref \$v eq 'GLOB') {
 280       # Raw glob (again?)
 281       if ($globPrint) {
 282        dumpglob($s, "{$v}", $v, 1, $m-1) if $globPrint;
 283       } elsif (defined ($fileno = fileno(\$v))) {
 284         print( (' ' x $s) .  "FileHandle({$v}) => fileno($fileno)\n" );
 285       }
 286     }
 287 }
 288
 289 sub matchlex {
 290   (my $var = $_[0]) =~ s/.//;
 291   $var eq $_[1] or
 292     ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and
 293       ($1 eq '!') ^ (eval { $var =~ /$2$3/ });
 294 }
 295
 296 sub matchvar {
 297   $_[0] eq $_[1] or
 298     ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and
 299       ($1 eq '!') ^ (eval {($_[2] . "::" . $_[0]) =~ /$2$3/});
 300 }
 301
 302 sub compactDump {
 303   $compactDump = shift if @_;
 304   $compactDump = 6*80-1 if $compactDump and $compactDump < 2;
 305   $compactDump;
 306 }
 307
 308 sub veryCompact {
 309   $veryCompact = shift if @_;
 310   compactDump(1) if !$compactDump and $veryCompact;
 311   $veryCompact;
 312 }
 313
 314 sub unctrlSet {
 315   if (@_) {
 316     my $in = shift;
 317     if ($in eq 'unctrl' or $in eq 'quote') {
 318       $unctrl = $in;
 319     } else {
 320       print "Unknown value for `unctrl'.\n";
 321     }
 322   }
 323   $unctrl;
 324 }
 325
 326 sub quote {
 327   if (@_ and $_[0] eq '"') {
 328     $tick = '"';
 329     $unctrl = 'quote';
 330   } elsif (@_ and $_[0] eq 'auto') {
 331     $tick = 'auto';
 332     $unctrl = 'quote';
 333   } elsif (@_) {                # Need to set
 334     $tick = "'";
 335     $unctrl = 'unctrl';
 336   }
 337   $tick;
 338 }
 339
 340 sub dumpglob {
 341     return if $DB::signal;
 342     my ($off,$key, $val, $all, $m) = @_;
 343     local(*entry) = $val;
 344     my $fileno;
 345     if (($key !~ /^_</ or $dumpDBFiles) and defined $entry) {
 346       print( (' ' x $off) . "\$", &unctrl($key), " = " );
 347       DumpElem $entry, 3+$off, $m;
 348     }
 349     if (($key !~ /^_</ or $dumpDBFiles) and @entry) {
 350       print( (' ' x $off) . "\@$key = (\n" );
 351       unwrap(\@entry,3+$off,$m) ;
 352       print( (' ' x $off) .  ")\n" );
 353     }
 354     if ($key ne "main::" && $key ne "DB::" && %entry
 355         && ($dumpPackages or $key !~ /::$/)
 356         && ($key !~ /^_</ or $dumpDBFiles)
 357         && !($package eq "dumpvar" and $key eq "stab")) {
 358       print( (' ' x $off) . "\%$key = (\n" );
 359       unwrap(\%entry,3+$off,$m) ;
 360       print( (' ' x $off) .  ")\n" );
 361     }
 362     if (defined ($fileno = fileno(*entry))) {
 363       print( (' ' x $off) .  "FileHandle($key) => fileno($fileno)\n" );
 364     }
 365     if ($all) {
 366       if (defined &entry) {
 367         dumpsub($off, $key);
 368       }
 369     }
 370 }
 371
 372 sub dumplex {
 373   return if $DB::signal;
 374   my ($key, $val, $m, @vars) = @_;
 375   return if @vars && !grep( matchlex($key, $_), @vars );
 376   local %address;
 377   my $off = 0;  # It reads better this way
 378   my $fileno;
 379   if (UNIVERSAL::isa($val,'ARRAY')) {
 380     print( (' ' x $off) . "$key = (\n" );
 381     unwrap($val,3+$off,$m) ;
 382     print( (' ' x $off) .  ")\n" );
 383   }
 384   elsif (UNIVERSAL::isa($val,'HASH')) {
 385     print( (' ' x $off) . "$key = (\n" );
 386     unwrap($val,3+$off,$m) ;
 387     print( (' ' x $off) .  ")\n" );
 388   }
 389   elsif (UNIVERSAL::isa($val,'IO')) {
 390     print( (' ' x $off) .  "FileHandle($key) => fileno($fileno)\n" );
 391   }
 392   #  No lexical subroutines yet...
 393   #  elsif (UNIVERSAL::isa($val,'CODE')) {
 394   #    dumpsub($off, $$val);
 395   #  }
 396   else {
 397     print( (' ' x $off) . &unctrl($key), " = " );
 398     DumpElem $$val, 3+$off, $m;
 399   }
 400 }
 401
 402 sub CvGV_name_or_bust {
 403   my $in = shift;
 404   return if $skipCvGV;          # Backdoor to avoid problems if XS broken...
 405   $in = \&$in;                  # Hard reference...
 406   eval {require Devel::Peek; 1} or return;
 407   my $gv = Devel::Peek::CvGV($in) or return;
 408   *$gv{PACKAGE} . '::' . *$gv{NAME};
 409 }
 410
 411 sub dumpsub {
 412     my ($off,$sub) = @_;
 413     my $ini = $sub;
 414     my $s;
 415     $sub = $1 if $sub =~ /^\{\*(.*)\}$/;
 416     my $subref = defined $1 ? \&$sub : \&$ini;
 417     my $place = $DB::sub{$sub} || (($s = $subs{"$subref"}) && $DB::sub{$s})
 418       || (($s = CvGV_name_or_bust($subref)) && $DB::sub{$s})
 419       || ($subdump && ($s = findsubs("$subref")) && $DB::sub{$s});
 420     $place = '???' unless defined $place;
 421     $s = $sub unless defined $s;
 422     print( (' ' x $off) .  "&$s in $place\n" );
 423 }
 424
 425 sub findsubs {
 426   return undef unless %DB::sub;
 427   my ($addr, $name, $loc);
 428   while (($name, $loc) = each %DB::sub) {
 429     $addr = \&$name;
 430     $subs{"$addr"} = $name;
 431   }
 432   $subdump = 0;
 433   $subs{ shift() };
 434 }
 435
 436 sub main::dumpvar {
 437     my ($package,$m,@vars) = @_;
 438     local(%address,$key,$val,$^W);
 439     $package .= "::" unless $package =~ /::$/;
 440     *stab = *{"main::"};
 441     while ($package =~ /(\w+?::)/g){
 442       *stab = $ {stab}{$1};
 443     }
 444     local $TotalStrings = 0;
 445     local $Strings = 0;
 446     local $CompleteTotal = 0;
 447     while (($key,$val) = each(%stab)) {
 448       return if $DB::signal;
 449       next if @vars && !grep( matchvar($key, $_), @vars );
 450       if ($usageOnly) {
 451         globUsage(\$val, $key)
 452           if ($package ne 'dumpvar' or $key ne 'stab')
 453              and ref(\$val) eq 'GLOB';
 454       } else {
 455        dumpglob(0,$key, $val, 0, $m);
 456       }
 457     }
 458     if ($usageOnly) {
 459       print "String space: $TotalStrings bytes in $Strings strings.\n";
 460       $CompleteTotal += $TotalStrings;
 461       print "Grand total = $CompleteTotal bytes (1 level deep) + overhead.\n";
 462     }
 463 }
 464
 465 sub scalarUsage {
 466   my $size = length($_[0]);
 467   $TotalStrings += $size;
 468   $Strings++;
 469   $size;
 470 }
 471
 472 sub arrayUsage {                # array ref, name
 473   my $size = 0;
 474   map {$size += scalarUsage($_)} @{$_[0]};
 475   my $len = @{$_[0]};
 476   print "\@$_[1] = $len item", ($len > 1 ? "s" : ""),
 477     " (data: $size bytes)\n"
 478       if defined $_[1];
 479   $CompleteTotal +=  $size;
 480   $size;
 481 }
 482
 483 sub hashUsage {         # hash ref, name
 484   my @keys = keys %{$_[0]};
 485   my @values = values %{$_[0]};
 486   my $keys = arrayUsage \@keys;
 487   my $values = arrayUsage \@values;
 488   my $len = @keys;
 489   my $total = $keys + $values;
 490   print "\%$_[1] = $len item", ($len > 1 ? "s" : ""),
 491     " (keys: $keys; values: $values; total: $total bytes)\n"
 492       if defined $_[1];
 493   $total;
 494 }
 495
 496 sub globUsage {                 # glob ref, name
 497   local *name = *{$_[0]};
 498   $total = 0;
 499   $total += scalarUsage $name if defined $name;
 500   $total += arrayUsage \@name, $_[1] if @name;
 501   $total += hashUsage \%name, $_[1] if %name and $_[1] ne "main::"
 502     and $_[1] ne "DB::";   #and !($package eq "dumpvar" and $key eq "stab"));
 503   $total;
 504 }
 505
 506 sub packageUsage {
 507   my ($package,@vars) = @_;
 508   $package .= "::" unless $package =~ /::$/;
 509   local *stab = *{"main::"};
 510   while ($package =~ /(\w+?::)/g){
 511     *stab = $ {stab}{$1};
 512   }
 513   local $TotalStrings = 0;
 514   local $CompleteTotal = 0;
 515   my ($key,$val);
 516   while (($key,$val) = each(%stab)) {
 517     next if @vars && !grep($key eq $_,@vars);
 518     globUsage \$val, $key unless $package eq 'dumpvar' and $key eq 'stab';
 519   }
 520   print "String space: $TotalStrings.\n";
 521   $CompleteTotal += $TotalStrings;
 522   print "\nGrand total = $CompleteTotal bytes\n";
 523 }
 524
 525 1;
 526