1N/Arequire 5.002; # For (defined ref)
1N/Apackage dumpvar;
1N/A
1N/A# Needed for PrettyPrinter only:
1N/A
1N/A# require 5.001; # Well, it coredumps anyway undef DB in 5.000 (not now)
1N/A
1N/A# translate control chars to ^X - Randal Schwartz
1N/A# Modifications to print types by Peter Gordon v1.0
1N/A
1N/A# Ilya Zakharevich -- patches after 5.001 (and some before ;-)
1N/A
1N/A# Won't dump symbol tables and contents of debugged files by default
1N/A
1N/A$winsize = 80 unless defined $winsize;
1N/A
1N/A
1N/A# Defaults
1N/A
1N/A# $globPrint = 1;
1N/A$printUndef = 1 unless defined $printUndef;
1N/A$tick = "auto" unless defined $tick;
1N/A$unctrl = 'quote' unless defined $unctrl;
1N/A$subdump = 1;
1N/A$dumpReused = 0 unless defined $dumpReused;
1N/A$bareStringify = 1 unless defined $bareStringify;
1N/A
1N/Asub main::dumpValue {
1N/A local %address;
1N/A local $^W=0;
1N/A (print "undef\n"), return unless defined $_[0];
1N/A (print &stringify($_[0]), "\n"), return unless ref $_[0];
1N/A push @_, -1 if @_ == 1;
1N/A dumpvar::unwrap($_[0], 0, $_[1]);
1N/A}
1N/A
1N/A# This one is good for variable names:
1N/A
1N/Asub unctrl {
1N/A local($_) = @_;
1N/A local($v) ;
1N/A
1N/A return \$_ if ref \$_ eq "GLOB";
1N/A s/([\001-\037\177])/'^'.pack('c',ord($1)^64)/eg;
1N/A $_;
1N/A}
1N/A
1N/Asub uniescape {
1N/A join("",
1N/A map { $_ > 255 ? sprintf("\\x{%04X}", $_) : chr($_) }
1N/A unpack("U*", $_[0]));
1N/A}
1N/A
1N/Asub stringify {
1N/A local($_,$noticks) = @_;
1N/A local($v) ;
1N/A my $tick = $tick;
1N/A
1N/A return 'undef' unless defined $_ or not $printUndef;
1N/A return $_ . "" if ref \$_ eq 'GLOB';
1N/A $_ = &{'overload::StrVal'}($_)
1N/A if $bareStringify and ref $_
1N/A and %overload:: and defined &{'overload::StrVal'};
1N/A
1N/A if ($tick eq 'auto') {
1N/A if (/[\000-\011\013-\037\177]/) {
1N/A $tick = '"';
1N/A }else {
1N/A $tick = "'";
1N/A }
1N/A }
1N/A if ($tick eq "'") {
1N/A s/([\'\\])/\\$1/g;
1N/A } elsif ($unctrl eq 'unctrl') {
1N/A s/([\"\\])/\\$1/g ;
1N/A s/([\000-\037\177])/'^'.pack('c',ord($1)^64)/eg;
1N/A # uniescape?
1N/A s/([\200-\377])/'\\0x'.sprintf('%2X',ord($1))/eg
1N/A if $quoteHighBit;
1N/A } elsif ($unctrl eq 'quote') {
1N/A s/([\"\\\$\@])/\\$1/g if $tick eq '"';
1N/A s/\033/\\e/g;
1N/A s/([\000-\037\177])/'\\c'.chr(ord($1)^64)/eg;
1N/A }
1N/A $_ = uniescape($_);
1N/A s/([\200-\377])/'\\'.sprintf('%3o',ord($1))/eg if $quoteHighBit;
1N/A ($noticks || /^\d+(\.\d*)?\Z/)
1N/A ? $_
1N/A : $tick . $_ . $tick;
1N/A}
1N/A
1N/Asub ShortArray {
1N/A my $tArrayDepth = $#{$_[0]} ;
1N/A $tArrayDepth = $#{$_[0]} < $arrayDepth-1 ? $#{$_[0]} : $arrayDepth-1
1N/A unless $arrayDepth eq '' ;
1N/A my $shortmore = "";
1N/A $shortmore = " ..." if $tArrayDepth < $#{$_[0]} ;
1N/A if (!grep(ref $_, @{$_[0]})) {
1N/A $short = "0..$#{$_[0]} '" .
1N/A join("' '", @{$_[0]}[0..$tArrayDepth]) . "'$shortmore";
1N/A return $short if length $short <= $compactDump;
1N/A }
1N/A undef;
1N/A}
1N/A
1N/Asub DumpElem {
1N/A my $short = &stringify($_[0], ref $_[0]);
1N/A if ($veryCompact && ref $_[0]
1N/A && (ref $_[0] eq 'ARRAY' and !grep(ref $_, @{$_[0]}) )) {
1N/A my $end = "0..$#{$v} '" .
1N/A join("' '", @{$_[0]}[0..$tArrayDepth]) . "'$shortmore";
1N/A } elsif ($veryCompact && ref $_[0]
1N/A && (ref $_[0] eq 'HASH') and !grep(ref $_, values %{$_[0]})) {
1N/A my $end = 1;
1N/A $short = $sp . "0..$#{$v} '" .
1N/A join("' '", @{$v}[0..$tArrayDepth]) . "'$shortmore";
1N/A } else {
1N/A print "$short\n";
1N/A unwrap($_[0],$_[1],$_[2]) if ref $_[0];
1N/A }
1N/A}
1N/A
1N/Asub unwrap {
1N/A return if $DB::signal;
1N/A local($v) = shift ;
1N/A local($s) = shift ; # extra no of spaces
1N/A local($m) = shift ; # maximum recursion depth
1N/A return if $m == 0;
1N/A local(%v,@v,$sp,$value,$key,@sortKeys,$more,$shortmore,$short) ;
1N/A local($tHashDepth,$tArrayDepth) ;
1N/A
1N/A $sp = " " x $s ;
1N/A $s += 3 ;
1N/A
1N/A # Check for reused addresses
1N/A if (ref $v) {
1N/A my $val = $v;
1N/A $val = &{'overload::StrVal'}($v)
1N/A if %overload:: and defined &{'overload::StrVal'};
1N/A # Match type and address.
1N/A # Unblessed references will look like TYPE(0x...)
1N/A # Blessed references will look like Class=TYPE(0x...)
1N/A ($start_part, $val) = split /=/,$val;
1N/A $val = $start_part unless defined $val;
1N/A ($item_type, $address) =
1N/A $val =~ /([^\(]+) # Keep stuff that's
1N/A # not an open paren
1N/A \( # Skip open paren
1N/A (0x[0-9a-f]+) # Save the address
1N/A \) # Skip close paren
1N/A $/x; # Should be at end now
1N/A
1N/A if (!$dumpReused && defined $address) {
1N/A $address{$address}++ ;
1N/A if ( $address{$address} > 1 ) {
1N/A print "${sp}-> REUSED_ADDRESS\n" ;
1N/A return ;
1N/A }
1N/A }
1N/A } elsif (ref \$v eq 'GLOB') {
1N/A # This is a raw glob. Special handling for that.
1N/A $address = "$v" . ""; # To avoid a bug with globs
1N/A $address{$address}++ ;
1N/A if ( $address{$address} > 1 ) {
1N/A print "${sp}*DUMPED_GLOB*\n" ;
1N/A return ;
1N/A }
1N/A }
1N/A
1N/A if (ref $v eq 'Regexp') {
1N/A # Reformat the regexp to look the standard way.
1N/A my $re = "$v";
1N/A $re =~ s,/,\\/,g;
1N/A print "$sp-> qr/$re/\n";
1N/A return;
1N/A }
1N/A
1N/A if ( $item_type eq 'HASH' ) {
1N/A # Hash ref or hash-based object.
1N/A my @sortKeys = sort keys(%$v) ;
1N/A undef $more ;
1N/A $tHashDepth = $#sortKeys ;
1N/A $tHashDepth = $#sortKeys < $hashDepth-1 ? $#sortKeys : $hashDepth-1
1N/A unless $hashDepth eq '' ;
1N/A $more = "....\n" if $tHashDepth < $#sortKeys ;
1N/A $shortmore = "";
1N/A $shortmore = ", ..." if $tHashDepth < $#sortKeys ;
1N/A $#sortKeys = $tHashDepth ;
1N/A if ($compactDump && !grep(ref $_, values %{$v})) {
1N/A #$short = $sp .
1N/A # (join ', ',
1N/A# Next row core dumps during require from DB on 5.000, even with map {"_"}
1N/A # map {&stringify($_) . " => " . &stringify($v->{$_})}
1N/A # @sortKeys) . "'$shortmore";
1N/A $short = $sp;
1N/A my @keys;
1N/A for (@sortKeys) {
1N/A push @keys, &stringify($_) . " => " . &stringify($v->{$_});
1N/A }
1N/A $short .= join ', ', @keys;
1N/A $short .= $shortmore;
1N/A (print "$short\n"), return if length $short <= $compactDump;
1N/A }
1N/A for $key (@sortKeys) {
1N/A return if $DB::signal;
1N/A $value = $ {$v}{$key} ;
1N/A print "$sp", &stringify($key), " => ";
1N/A DumpElem $value, $s, $m-1;
1N/A }
1N/A print "$sp empty hash\n" unless @sortKeys;
1N/A print "$sp$more" if defined $more ;
1N/A } elsif ( $item_type eq 'ARRAY' ) {
1N/A # Array ref or array-based object. Also: undef.
1N/A # See how big the array is.
1N/A $tArrayDepth = $#{$v} ;
1N/A undef $more ;
1N/A # Bigger than the max?
1N/A $tArrayDepth = $#{$v} < $arrayDepth-1 ? $#{$v} : $arrayDepth-1
1N/A if defined $arrayDepth && $arrayDepth ne '';
1N/A # Yep. Don't show it all.
1N/A $more = "....\n" if $tArrayDepth < $#{$v} ;
1N/A $shortmore = "";
1N/A $shortmore = " ..." if $tArrayDepth < $#{$v} ;
1N/A
1N/A if ($compactDump && !grep(ref $_, @{$v})) {
1N/A if ($#$v >= 0) {
1N/A $short = $sp . "0..$#{$v} " .
1N/A join(" ",
1N/A map {exists $v->[$_] ? stringify $v->[$_] : "empty"} ($[..$tArrayDepth)
1N/A ) . "$shortmore";
1N/A } else {
1N/A $short = $sp . "empty array";
1N/A }
1N/A (print "$short\n"), return if length $short <= $compactDump;
1N/A }
1N/A #if ($compactDump && $short = ShortArray($v)) {
1N/A # print "$short\n";
1N/A # return;
1N/A #}
1N/A for $num ($[ .. $tArrayDepth) {
1N/A return if $DB::signal;
1N/A print "$sp$num ";
1N/A if (exists $v->[$num]) {
1N/A if (defined $v->[$num]) {
1N/A DumpElem $v->[$num], $s, $m-1;
1N/A }
1N/A else {
1N/A print "undef\n";
1N/A }
1N/A } else {
1N/A print "empty slot\n";
1N/A }
1N/A }
1N/A print "$sp empty array\n" unless @$v;
1N/A print "$sp$more" if defined $more ;
1N/A } elsif ( $item_type eq 'SCALAR' ) {
1N/A unless (defined $$v) {
1N/A print "$sp-> undef\n";
1N/A return;
1N/A }
1N/A print "$sp-> ";
1N/A DumpElem $$v, $s, $m-1;
1N/A } elsif ( $item_type eq 'REF' ) {
1N/A print "$sp-> $$v\n";
1N/A return unless defined $$v;
1N/A unwrap($$v, $s+3, $m-1);
1N/A } elsif ( $item_type eq 'CODE' ) {
1N/A # Code object or reference.
1N/A print "$sp-> ";
1N/A dumpsub (0, $v);
1N/A } elsif ( $item_type eq 'GLOB' ) {
1N/A # Glob object or reference.
1N/A print "$sp-> ",&stringify($$v,1),"\n";
1N/A if ($globPrint) {
1N/A $s += 3;
1N/A dumpglob($s, "{$$v}", $$v, 1, $m-1);
1N/A } elsif (defined ($fileno = fileno($v))) {
1N/A print( (' ' x ($s+3)) . "FileHandle({$$v}) => fileno($fileno)\n" );
1N/A }
1N/A } elsif (ref \$v eq 'GLOB') {
1N/A # Raw glob (again?)
1N/A if ($globPrint) {
1N/A dumpglob($s, "{$v}", $v, 1, $m-1) if $globPrint;
1N/A } elsif (defined ($fileno = fileno(\$v))) {
1N/A print( (' ' x $s) . "FileHandle({$v}) => fileno($fileno)\n" );
1N/A }
1N/A }
1N/A}
1N/A
1N/Asub matchlex {
1N/A (my $var = $_[0]) =~ s/.//;
1N/A $var eq $_[1] or
1N/A ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and
1N/A ($1 eq '!') ^ (eval { $var =~ /$2$3/ });
1N/A}
1N/A
1N/Asub matchvar {
1N/A $_[0] eq $_[1] or
1N/A ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and
1N/A ($1 eq '!') ^ (eval {($_[2] . "::" . $_[0]) =~ /$2$3/});
1N/A}
1N/A
1N/Asub compactDump {
1N/A $compactDump = shift if @_;
1N/A $compactDump = 6*80-1 if $compactDump and $compactDump < 2;
1N/A $compactDump;
1N/A}
1N/A
1N/Asub veryCompact {
1N/A $veryCompact = shift if @_;
1N/A compactDump(1) if !$compactDump and $veryCompact;
1N/A $veryCompact;
1N/A}
1N/A
1N/Asub unctrlSet {
1N/A if (@_) {
1N/A my $in = shift;
1N/A if ($in eq 'unctrl' or $in eq 'quote') {
1N/A $unctrl = $in;
1N/A } else {
1N/A print "Unknown value for `unctrl'.\n";
1N/A }
1N/A }
1N/A $unctrl;
1N/A}
1N/A
1N/Asub quote {
1N/A if (@_ and $_[0] eq '"') {
1N/A $tick = '"';
1N/A $unctrl = 'quote';
1N/A } elsif (@_ and $_[0] eq 'auto') {
1N/A $tick = 'auto';
1N/A $unctrl = 'quote';
1N/A } elsif (@_) { # Need to set
1N/A $tick = "'";
1N/A $unctrl = 'unctrl';
1N/A }
1N/A $tick;
1N/A}
1N/A
1N/Asub dumpglob {
1N/A return if $DB::signal;
1N/A my ($off,$key, $val, $all, $m) = @_;
1N/A local(*entry) = $val;
1N/A my $fileno;
1N/A if (($key !~ /^_</ or $dumpDBFiles) and defined $entry) {
1N/A print( (' ' x $off) . "\$", &unctrl($key), " = " );
1N/A DumpElem $entry, 3+$off, $m;
1N/A }
1N/A if (($key !~ /^_</ or $dumpDBFiles) and @entry) {
1N/A print( (' ' x $off) . "\@$key = (\n" );
1N/A unwrap(\@entry,3+$off,$m) ;
1N/A print( (' ' x $off) . ")\n" );
1N/A }
1N/A if ($key ne "main::" && $key ne "DB::" && %entry
1N/A && ($dumpPackages or $key !~ /::$/)
1N/A && ($key !~ /^_</ or $dumpDBFiles)
1N/A && !($package eq "dumpvar" and $key eq "stab")) {
1N/A print( (' ' x $off) . "\%$key = (\n" );
1N/A unwrap(\%entry,3+$off,$m) ;
1N/A print( (' ' x $off) . ")\n" );
1N/A }
1N/A if (defined ($fileno = fileno(*entry))) {
1N/A print( (' ' x $off) . "FileHandle($key) => fileno($fileno)\n" );
1N/A }
1N/A if ($all) {
1N/A if (defined &entry) {
1N/A dumpsub($off, $key);
1N/A }
1N/A }
1N/A}
1N/A
1N/Asub dumplex {
1N/A return if $DB::signal;
1N/A my ($key, $val, $m, @vars) = @_;
1N/A return if @vars && !grep( matchlex($key, $_), @vars );
1N/A local %address;
1N/A my $off = 0; # It reads better this way
1N/A my $fileno;
1N/A if (UNIVERSAL::isa($val,'ARRAY')) {
1N/A print( (' ' x $off) . "$key = (\n" );
1N/A unwrap($val,3+$off,$m) ;
1N/A print( (' ' x $off) . ")\n" );
1N/A }
1N/A elsif (UNIVERSAL::isa($val,'HASH')) {
1N/A print( (' ' x $off) . "$key = (\n" );
1N/A unwrap($val,3+$off,$m) ;
1N/A print( (' ' x $off) . ")\n" );
1N/A }
1N/A elsif (UNIVERSAL::isa($val,'IO')) {
1N/A print( (' ' x $off) . "FileHandle($key) => fileno($fileno)\n" );
1N/A }
1N/A # No lexical subroutines yet...
1N/A # elsif (UNIVERSAL::isa($val,'CODE')) {
1N/A # dumpsub($off, $$val);
1N/A # }
1N/A else {
1N/A print( (' ' x $off) . &unctrl($key), " = " );
1N/A DumpElem $$val, 3+$off, $m;
1N/A }
1N/A}
1N/A
1N/Asub CvGV_name_or_bust {
1N/A my $in = shift;
1N/A return if $skipCvGV; # Backdoor to avoid problems if XS broken...
1N/A $in = \&$in; # Hard reference...
1N/A eval {require Devel::Peek; 1} or return;
1N/A my $gv = Devel::Peek::CvGV($in) or return;
1N/A *$gv{PACKAGE} . '::' . *$gv{NAME};
1N/A}
1N/A
1N/Asub dumpsub {
1N/A my ($off,$sub) = @_;
1N/A my $ini = $sub;
1N/A my $s;
1N/A $sub = $1 if $sub =~ /^\{\*(.*)\}$/;
1N/A my $subref = defined $1 ? \&$sub : \&$ini;
1N/A my $place = $DB::sub{$sub} || (($s = $subs{"$subref"}) && $DB::sub{$s})
1N/A || (($s = CvGV_name_or_bust($subref)) && $DB::sub{$s})
1N/A || ($subdump && ($s = findsubs("$subref")) && $DB::sub{$s});
1N/A $place = '???' unless defined $place;
1N/A $s = $sub unless defined $s;
1N/A print( (' ' x $off) . "&$s in $place\n" );
1N/A}
1N/A
1N/Asub findsubs {
1N/A return undef unless %DB::sub;
1N/A my ($addr, $name, $loc);
1N/A while (($name, $loc) = each %DB::sub) {
1N/A $addr = \&$name;
1N/A $subs{"$addr"} = $name;
1N/A }
1N/A $subdump = 0;
1N/A $subs{ shift() };
1N/A}
1N/A
1N/Asub main::dumpvar {
1N/A my ($package,$m,@vars) = @_;
1N/A local(%address,$key,$val,$^W);
1N/A $package .= "::" unless $package =~ /::$/;
1N/A *stab = *{"main::"};
1N/A while ($package =~ /(\w+?::)/g){
1N/A *stab = $ {stab}{$1};
1N/A }
1N/A local $TotalStrings = 0;
1N/A local $Strings = 0;
1N/A local $CompleteTotal = 0;
1N/A while (($key,$val) = each(%stab)) {
1N/A return if $DB::signal;
1N/A next if @vars && !grep( matchvar($key, $_), @vars );
1N/A if ($usageOnly) {
1N/A globUsage(\$val, $key)
1N/A if ($package ne 'dumpvar' or $key ne 'stab')
1N/A and ref(\$val) eq 'GLOB';
1N/A } else {
1N/A dumpglob(0,$key, $val, 0, $m);
1N/A }
1N/A }
1N/A if ($usageOnly) {
1N/A print "String space: $TotalStrings bytes in $Strings strings.\n";
1N/A $CompleteTotal += $TotalStrings;
1N/A print "Grand total = $CompleteTotal bytes (1 level deep) + overhead.\n";
1N/A }
1N/A}
1N/A
1N/Asub scalarUsage {
1N/A my $size = length($_[0]);
1N/A $TotalStrings += $size;
1N/A $Strings++;
1N/A $size;
1N/A}
1N/A
1N/Asub arrayUsage { # array ref, name
1N/A my $size = 0;
1N/A map {$size += scalarUsage($_)} @{$_[0]};
1N/A my $len = @{$_[0]};
1N/A print "\@$_[1] = $len item", ($len > 1 ? "s" : ""),
1N/A " (data: $size bytes)\n"
1N/A if defined $_[1];
1N/A $CompleteTotal += $size;
1N/A $size;
1N/A}
1N/A
1N/Asub hashUsage { # hash ref, name
1N/A my @keys = keys %{$_[0]};
1N/A my @values = values %{$_[0]};
1N/A my $keys = arrayUsage \@keys;
1N/A my $values = arrayUsage \@values;
1N/A my $len = @keys;
1N/A my $total = $keys + $values;
1N/A print "\%$_[1] = $len item", ($len > 1 ? "s" : ""),
1N/A " (keys: $keys; values: $values; total: $total bytes)\n"
1N/A if defined $_[1];
1N/A $total;
1N/A}
1N/A
1N/Asub globUsage { # glob ref, name
1N/A local *name = *{$_[0]};
1N/A $total = 0;
1N/A $total += scalarUsage $name if defined $name;
1N/A $total += arrayUsage \@name, $_[1] if @name;
1N/A $total += hashUsage \%name, $_[1] if %name and $_[1] ne "main::"
1N/A and $_[1] ne "DB::"; #and !($package eq "dumpvar" and $key eq "stab"));
1N/A $total;
1N/A}
1N/A
1N/Asub packageUsage {
1N/A my ($package,@vars) = @_;
1N/A $package .= "::" unless $package =~ /::$/;
1N/A local *stab = *{"main::"};
1N/A while ($package =~ /(\w+?::)/g){
1N/A *stab = $ {stab}{$1};
1N/A }
1N/A local $TotalStrings = 0;
1N/A local $CompleteTotal = 0;
1N/A my ($key,$val);
1N/A while (($key,$val) = each(%stab)) {
1N/A next if @vars && !grep($key eq $_,@vars);
1N/A globUsage \$val, $key unless $package eq 'dumpvar' and $key eq 'stab';
1N/A }
1N/A print "String space: $TotalStrings.\n";
1N/A $CompleteTotal += $TotalStrings;
1N/A print "\nGrand total = $CompleteTotal bytes\n";
1N/A}
1N/A
1N/A1;
1N/A