[perl5.git] / lib / dumpvar.pl

require 5.014;			# For more reliable $@ after eval
package dumpvar;

# Needed for PrettyPrinter only:

# require 5.001;  # Well, it coredumps anyway undef DB in 5.000 (not now)

# translate control chars to ^X - Randal Schwartz
# Modifications to print types by Peter Gordon v1.0

# Ilya Zakharevich -- patches after 5.001 (and some before ;-)

# Won't dump symbol tables and contents of debugged files by default

$winsize = 80 unless defined $winsize;


# Defaults

# $globPrint = 1;
$printUndef = 1 unless defined $printUndef;
$tick = "auto" unless defined $tick;
$unctrl = 'quote' unless defined $unctrl;
$subdump = 1;
$dumpReused = 0 unless defined $dumpReused;
$bareStringify = 1 unless defined $bareStringify;

sub main::dumpValue {
  local %address;
  local $^W=0;
  (print "undef\n"), return unless defined $_[0];
  (print &stringify($_[0]), "\n"), return unless ref $_[0];
  push @_, -1 if @_ == 1;
  dumpvar::unwrap($_[0], 0, $_[1]);
}

# This one is good for variable names:

sub unctrl {
    for (my($dummy) = shift) {
	local($v) ; 

	return \$_ if ref \$_ eq "GLOB";
        if (ord('A') == 193) { # EBCDIC.
	    # EBCDIC has no concept of "\cA" or "A" being related
	    # to each other by a linear/boolean mapping.
	} else {
	    s/([\001-\037\177])/'^'.pack('c',ord($1)^64)/eg;
	}
	return $_;
    }
}

sub uniescape {
    join("",
	 map { $_ > 255 ? sprintf("\\x{%04X}", $_) : chr($_) }
	     unpack("U*", $_[0]));
}

sub stringify {
  my $string;
  if (eval { $string = _stringify(@_); 1 }) {
    return $string;
  }

  return "<< value could not be dumped: $@ >>";
}

sub _stringify {
    (my $__, local $noticks) = @_;
    for ($__) {
	local($v) ; 
	my $tick = $tick;

	return 'undef' unless defined $_ or not $printUndef;
	return $_ . "" if ref \$_ eq 'GLOB';
	$_ = &{'overload::StrVal'}($_) 
	  if $bareStringify and ref $_ 
	    and %overload:: and defined &{'overload::StrVal'};
	
	if ($tick eq 'auto') {
	    if (ord('A') == 193) {
		if (/[\000-\011]/ or /[\013-\024\31-\037\177]/) {
		    $tick = '"';
		} else {
		    $tick = "'";
		}
            }  else {
		if (/[\000-\011\013-\037\177]/) {
		    $tick = '"';
		} else {
		    $tick = "'";
		}
	    }
	}
	if ($tick eq "'") {
	  s/([\'\\])/\\$1/g;
	} elsif ($unctrl eq 'unctrl') {
	  s/([\"\\])/\\$1/g ;
	  s/([\000-\037\177])/'^'.pack('c',ord($1)^64)/eg;
	  # uniescape?
	  s/([\200-\377])/'\\0x'.sprintf('%2X',ord($1))/eg 
	    if $quoteHighBit;
	} elsif ($unctrl eq 'quote') {
	  s/([\"\\\$\@])/\\$1/g if $tick eq '"';
	  s/\033/\\e/g;
	  if (ord('A') == 193) { # EBCDIC.
	      s/([\000-\037\177])/'\\c'.chr(193)/eg; # Unfinished.
	  } else {
	      s/([\000-\037\177])/'\\c'._escaped_ord($1)/eg;
	  }
	}
	$_ = uniescape($_);
	s/([\200-\377])/'\\'.sprintf('%3o',ord($1))/eg if $quoteHighBit;
	return ($noticks || /^\d+(\.\d*)?\Z/) 
	  ? $_ 
	  : $tick . $_ . $tick;
    }
}

# Ensure a resulting \ is escaped to be \\
sub _escaped_ord {
    my $chr = shift;
    $chr = chr(ord($chr)^64);
    $chr =~ s{\\}{\\\\}g;
    return $chr;
}

sub ShortArray {
  my $tArrayDepth = $#{$_[0]} ; 
  $tArrayDepth = $#{$_[0]} < $arrayDepth-1 ? $#{$_[0]} : $arrayDepth-1 
    unless  $arrayDepth eq '' ; 
  my $shortmore = "";
  $shortmore = " ..." if $tArrayDepth < $#{$_[0]} ;
  if (!grep(ref $_, @{$_[0]})) {
    $short = "0..$#{$_[0]}  '" . 
      join("' '", @{$_[0]}[0..$tArrayDepth]) . "'$shortmore";
    return $short if length $short <= $compactDump;
  }
  undef;
}

sub DumpElem {
  my $short = &stringify($_[0], ref $_[0]);
  if ($veryCompact && ref $_[0]
      && (ref $_[0] eq 'ARRAY' and !grep(ref $_, @{$_[0]}) )) {
    my $end = "0..$#{$v}  '" . 
      join("' '", @{$_[0]}[0..$tArrayDepth]) . "'$shortmore";
  } elsif ($veryCompact && ref $_[0]
      && (ref $_[0] eq 'HASH') and !grep(ref $_, values %{$_[0]})) {
    my $end = 1;
	  $short = $sp . "0..$#{$v}  '" . 
	    join("' '", @{$v}[0..$tArrayDepth]) . "'$shortmore";
  } else {
    print "$short\n";
    unwrap($_[0],$_[1],$_[2]) if ref $_[0];
  }
}

sub unwrap {
    return if $DB::signal;
    local($v) = shift ; 
    local($s) = shift ; # extra no of spaces
    local($m) = shift ; # maximum recursion depth
    return if $m == 0;
    local(%v,@v,$sp,$value,$key,@sortKeys,$more,$shortmore,$short) ;
    local($tHashDepth,$tArrayDepth) ;

    $sp = " " x $s ;
    $s += 3 ; 

    eval {
    # Check for reused addresses
    if (ref $v) { 
      my $val = $v;
      $val = &{'overload::StrVal'}($v) 
	if %overload:: and defined &{'overload::StrVal'};
      # Match type and address.                      
      # Unblessed references will look like TYPE(0x...)
      # Blessed references will look like Class=TYPE(0x...)
      $val =~ s/^.*=//; # suppress the Class part, just keep TYPE(0x...)
      ($item_type, $address) = 
        $val =~ /([^\(]+)        # Keep stuff that's     
                                 # not an open paren
                 \(              # Skip open paren
                 (0x[0-9a-f]+)   # Save the address
                 \)              # Skip close paren
                 $/x;            # Should be at end now

      if (!$dumpReused && defined $address) { 
	$address{$address}++ ;
	if ( $address{$address} > 1 ) { 
	  print "${sp}-> REUSED_ADDRESS\n" ; 
	  return ; 
	} 
      }
    } elsif (ref \$v eq 'GLOB') {
      # This is a raw glob. Special handling for that.
      $address = "$v" . "";	# To avoid a bug with globs
      $address{$address}++ ;
      if ( $address{$address} > 1 ) { 
	print "${sp}*DUMPED_GLOB*\n" ; 
	return ; 
      } 
    }

    if (ref $v eq 'Regexp') {
      # Reformat the regexp to look the standard way.
      my $re = "$v";
      $re =~ s,/,\\/,g;
      print "$sp-> qr/$re/\n";
      return;
    }

    if ( $item_type eq 'HASH' ) { 
        # Hash ref or hash-based object.
	my @sortKeys = sort keys(%$v) ;
	undef $more ; 
	$tHashDepth = $#sortKeys ; 
	$tHashDepth = $#sortKeys < $hashDepth-1 ? $#sortKeys : $hashDepth-1
	  unless $hashDepth eq '' ; 
	$more = "....\n" if $tHashDepth < $#sortKeys ; 
	$shortmore = "";
	$shortmore = ", ..." if $tHashDepth < $#sortKeys ; 
	$#sortKeys = $tHashDepth ; 
	if ($compactDump && !grep(ref $_, values %{$v})) {
	  #$short = $sp . 
	  #  (join ', ', 
# Next row core dumps during require from DB on 5.000, even with map {"_"}
	  #   map {&stringify($_) . " => " . &stringify($v->{$_})} 
	  #   @sortKeys) . "'$shortmore";
	  $short = $sp;
	  my @keys;
	  for (@sortKeys) {
	    push @keys, &stringify($_) . " => " . &stringify($v->{$_});
	  }
	  $short .= join ', ', @keys;
	  $short .= $shortmore;
	  (print "$short\n"), return if length $short <= $compactDump;
	}
	for $key (@sortKeys) {
	    return if $DB::signal;
	    $value = $ {$v}{$key} ;
	    print "$sp", &stringify($key), " => ";
	    DumpElem $value, $s, $m-1;
	}
	print "$sp  empty hash\n" unless @sortKeys;
	print "$sp$more" if defined $more ;
    } elsif ( $item_type eq 'ARRAY' ) { 
        # Array ref or array-based object. Also: undef.
        # See how big the array is.
	$tArrayDepth = $#{$v} ; 
	undef $more ; 
        # Bigger than the max?
	$tArrayDepth = $#{$v} < $arrayDepth-1 ? $#{$v} : $arrayDepth-1 
	  if defined $arrayDepth && $arrayDepth ne '';
        # Yep. Don't show it all.
	$more = "....\n" if $tArrayDepth < $#{$v} ; 
	$shortmore = "";
	$shortmore = " ..." if $tArrayDepth < $#{$v} ;

	if ($compactDump && !grep(ref $_, @{$v})) {
	  if ($#$v >= 0) {
	    $short = $sp . "0..$#{$v}  " . 
	      join(" ", 
		   map {exists $v->[$_] ? stringify $v->[$_] : "empty"} (0..$tArrayDepth)
		  ) . "$shortmore";
	  } else {
	    $short = $sp . "empty array";
	  }
	  (print "$short\n"), return if length $short <= $compactDump;
	}
	#if ($compactDump && $short = ShortArray($v)) {
	#  print "$short\n";
	#  return;
	#}
	for $num (0 .. $tArrayDepth) {
	    return if $DB::signal;
	    print "$sp$num  ";
	    if (exists $v->[$num]) {
                if (defined $v->[$num]) {
	          DumpElem $v->[$num], $s, $m-1;
                } 
                else {
                  print "undef\n";
                }
	    } else {
	    	print "empty slot\n";
	    }
	}
	print "$sp  empty array\n" unless @$v;
	print "$sp$more" if defined $more ;  
    } elsif ( $item_type eq 'SCALAR' ) { 
            unless (defined $$v) {
              print "$sp-> undef\n";
              return;
            }
	    print "$sp-> ";
	    DumpElem $$v, $s, $m-1;
    } elsif ( $item_type eq 'REF' ) { 
	    print "$sp-> $$v\n";
            return unless defined $$v;
	    unwrap($$v, $s+3, $m-1);
    } elsif ( $item_type eq 'CODE' ) { 
            # Code object or reference.
	    print "$sp-> ";
	    dumpsub (0, $v);
    } elsif ( $item_type eq 'GLOB' ) {
      # Glob object or reference.
      print "$sp-> ",&stringify($$v,1),"\n";
      if ($globPrint) {
	$s += 3;
       dumpglob($s, "{$$v}", $$v, 1, $m-1);
      } elsif (defined ($fileno = eval {fileno($v)})) {
	print( (' ' x ($s+3)) .  "FileHandle({$$v}) => fileno($fileno)\n" );
      }
    } elsif (ref \$v eq 'GLOB') {
      # Raw glob (again?)
      if ($globPrint) {
       dumpglob($s, "{$v}", $v, 1, $m-1) if $globPrint;
      } elsif (defined ($fileno = eval {fileno(\$v)})) {
	print( (' ' x $s) .  "FileHandle({$v}) => fileno($fileno)\n" );
      }
    }
    };
    if ($@) {
      print( (' ' x $s) .  "<< value could not be dumped: $@ >>\n");
    }

    return;
}

sub matchlex {
  (my $var = $_[0]) =~ s/.//;
  $var eq $_[1] or 
    ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and 
      ($1 eq '!') ^ (eval { $var =~ /$2$3/ });
}

sub matchvar {
  $_[0] eq $_[1] or 
    ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and 
      ($1 eq '!') ^ (eval {($_[2] . "::" . $_[0]) =~ /$2$3/});
}

sub compactDump {
  $compactDump = shift if @_;
  $compactDump = 6*80-1 if $compactDump and $compactDump < 2;
  $compactDump;
}

sub veryCompact {
  $veryCompact = shift if @_;
  compactDump(1) if !$compactDump and $veryCompact;
  $veryCompact;
}

sub unctrlSet {
  if (@_) {
    my $in = shift;
    if ($in eq 'unctrl' or $in eq 'quote') {
      $unctrl = $in;
    } else {
      print "Unknown value for 'unctrl'.\n";
    }
  }
  $unctrl;
}

sub quote {
  if (@_ and $_[0] eq '"') {
    $tick = '"';
    $unctrl = 'quote';
  } elsif (@_ and $_[0] eq 'auto') {
    $tick = 'auto';
    $unctrl = 'quote';
  } elsif (@_) {		# Need to set
    $tick = "'";
    $unctrl = 'unctrl';
  }
  $tick;
}

sub dumpglob {
    return if $DB::signal;
    my ($off,$key, $val, $all, $m) = @_;
    local(*entry) = $val;
    my $fileno;
    if (($key !~ /^_</ or $dumpDBFiles) and defined $entry) {
      print( (' ' x $off) . "\$", &unctrl($key), " = " );
      DumpElem $entry, 3+$off, $m;
    }
    if (($key !~ /^_</ or $dumpDBFiles) and @entry) {
      print( (' ' x $off) . "\@$key = (\n" );
      unwrap(\@entry,3+$off,$m) ;
      print( (' ' x $off) .  ")\n" );
    }
    if ($key ne "main::" && $key ne "DB::" && %entry
	&& ($dumpPackages or $key !~ /::$/)
	&& ($key !~ /^_</ or $dumpDBFiles)
	&& !($package eq "dumpvar" and $key eq "stab")) {
      print( (' ' x $off) . "\%$key = (\n" );
      unwrap(\%entry,3+$off,$m) ;
      print( (' ' x $off) .  ")\n" );
    }
    if (defined ($fileno = eval{fileno(*entry)})) {
      print( (' ' x $off) .  "FileHandle($key) => fileno($fileno)\n" );
    }
    if ($all) {
      if (defined &entry) {
	dumpsub($off, $key);
      }
    }
}

sub dumplex {
  return if $DB::signal;
  my ($key, $val, $m, @vars) = @_;
  return if @vars && !grep( matchlex($key, $_), @vars );
  local %address;
  my $off = 0;  # It reads better this way
  my $fileno;
  if (UNIVERSAL::isa($val,'ARRAY')) {
    print( (' ' x $off) . "$key = (\n" );
    unwrap($val,3+$off,$m) ;
    print( (' ' x $off) .  ")\n" );
  }
  elsif (UNIVERSAL::isa($val,'HASH')) {
    print( (' ' x $off) . "$key = (\n" );
    unwrap($val,3+$off,$m) ;
    print( (' ' x $off) .  ")\n" );
  }
  elsif (UNIVERSAL::isa($val,'IO')) {
    print( (' ' x $off) .  "FileHandle($key) => fileno($fileno)\n" );
  }
  #  No lexical subroutines yet...
  #  elsif (UNIVERSAL::isa($val,'CODE')) {
  #    dumpsub($off, $$val);
  #  }
  else {
    print( (' ' x $off) . &unctrl($key), " = " );
    DumpElem $$val, 3+$off, $m;
  }
}

sub CvGV_name_or_bust {
  my $in = shift;
  return if $skipCvGV;		# Backdoor to avoid problems if XS broken...
  $in = \&$in;			# Hard reference...
  eval {require Devel::Peek; 1} or return;
  my $gv = Devel::Peek::CvGV($in) or return;
  *$gv{PACKAGE} . '::' . *$gv{NAME};
}

sub dumpsub {
    my ($off,$sub) = @_;
    my $ini = $sub;
    my $s;
    $sub = $1 if $sub =~ /^\{\*(.*)\}$/;
    my $subref = defined $1 ? \&$sub : \&$ini;
    my $place = $DB::sub{$sub} || (($s = $subs{"$subref"}) && $DB::sub{$s})
      || (($s = CvGV_name_or_bust($subref)) && $DB::sub{$s})
      || ($subdump && ($s = findsubs("$subref")) && $DB::sub{$s});
    $place = '???' unless defined $place;
    $s = $sub unless defined $s;
    print( (' ' x $off) .  "&$s in $place\n" );
}

sub findsubs {
  return undef unless %DB::sub;
  my ($addr, $name, $loc);
  while (($name, $loc) = each %DB::sub) {
    $addr = \&$name;
    $subs{"$addr"} = $name;
  }
  $subdump = 0;
  $subs{ shift() };
}

sub main::dumpvar {
    my ($package,$m,@vars) = @_;
    local(%address,$key,$val,$^W);
    $package .= "::" unless $package =~ /::$/;
    *stab = *{"main::"};
    while ($package =~ /(\w+?::)/g){
      *stab = $ {stab}{$1};
    }
    local $TotalStrings = 0;
    local $Strings = 0;
    local $CompleteTotal = 0;
    while (($key,$val) = each(%stab)) {
      return if $DB::signal;
      next if @vars && !grep( matchvar($key, $_), @vars );
      if ($usageOnly) {
	globUsage(\$val, $key)
	  if ($package ne 'dumpvar' or $key ne 'stab')
	     and ref(\$val) eq 'GLOB';
      } else {
       dumpglob(0,$key, $val, 0, $m);
      }
    }
    if ($usageOnly) {
      print "String space: $TotalStrings bytes in $Strings strings.\n";
      $CompleteTotal += $TotalStrings;
      print "Grand total = $CompleteTotal bytes (1 level deep) + overhead.\n";
    }
}

sub scalarUsage {
  my $size = length($_[0]);
  $TotalStrings += $size;
  $Strings++;
  $size;
}

sub arrayUsage {		# array ref, name
  my $size = 0;
  map {$size += scalarUsage($_)} @{$_[0]};
  my $len = @{$_[0]};
  print "\@$_[1] = $len item", ($len > 1 ? "s" : ""),
    " (data: $size bytes)\n"
      if defined $_[1];
  $CompleteTotal +=  $size;
  $size;
}

sub hashUsage {		# hash ref, name
  my @keys = keys %{$_[0]};
  my @values = values %{$_[0]};
  my $keys = arrayUsage \@keys;
  my $values = arrayUsage \@values;
  my $len = @keys;
  my $total = $keys + $values;
  print "\%$_[1] = $len item", ($len > 1 ? "s" : ""),
    " (keys: $keys; values: $values; total: $total bytes)\n"
      if defined $_[1];
  $total;
}

sub globUsage {			# glob ref, name
  local *name = *{$_[0]};
  $total = 0;
  $total += scalarUsage $name if defined $name;
  $total += arrayUsage \@name, $_[1] if @name;
  $total += hashUsage \%name, $_[1] if %name and $_[1] ne "main::" 
    and $_[1] ne "DB::";   #and !($package eq "dumpvar" and $key eq "stab"));
  $total;
}

sub packageUsage {
  my ($package,@vars) = @_;
  $package .= "::" unless $package =~ /::$/;
  local *stab = *{"main::"};
  while ($package =~ /(\w+?::)/g){
    *stab = $ {stab}{$1};
  }
  local $TotalStrings = 0;
  local $CompleteTotal = 0;
  my ($key,$val);
  while (($key,$val) = each(%stab)) {
    next if @vars && !grep($key eq $_,@vars);
    globUsage \$val, $key unless $package eq 'dumpvar' and $key eq 'stab';
  }
  print "String space: $TotalStrings.\n";
  $CompleteTotal += $TotalStrings;
  print "\nGrand total = $CompleteTotal bytes\n";
}

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