1 require 5.002; # For (defined ref)
4 # Needed for PrettyPrinter only:
6 # require 5.001; # Well, it coredumps anyway undef DB in 5.000 (not now)
8 # translate control chars to ^X - Randal Schwartz
9 # Modifications to print types by Peter Gordon v1.0
11 # Ilya Zakharevich -- patches after 5.001 (and some before ;-)
13 # Won't dump symbol tables and contents of debugged files by default
15 $winsize = 80 unless defined $winsize;
21 $printUndef = 1 unless defined $printUndef;
22 $tick = "auto" unless defined $tick;
23 $unctrl = 'quote' unless defined $unctrl;
25 $dumpReused = 0 unless defined $dumpReused;
26 $bareStringify = 1 unless defined $bareStringify;
31 (print "undef\n"), return unless defined $_[0];
32 (print &stringify($_[0]), "\n"), return unless ref $_[0];
33 dumpvar::unwrap($_[0],0, $_[1]);
36 # This one is good for variable names:
42 return \$_ if ref \$_ eq "GLOB";
43 s/([\001-\037\177])/'^'.pack('c',ord($1)^64)/eg;
49 map { $_ > 255 ? sprintf("\\x{%04X}", $_) : chr($_) }
54 local($_,$noticks) = @_;
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'};
64 if ($tick eq 'auto') {
65 if (/[\000-\011\013-\037\177]/) {
73 } elsif ($unctrl eq 'unctrl') {
75 s/([\000-\037\177])/'^'.pack('c',ord($1)^64)/eg;
77 s/([\200-\377])/'\\0x'.sprintf('%2X',ord($1))/eg
79 } elsif ($unctrl eq 'quote') {
80 s/([\"\\\$\@])/\\$1/g if $tick eq '"';
82 s/([\000-\037\177])/'\\c'.chr(ord($1)^64)/eg;
85 s/([\200-\377])/'\\'.sprintf('%3o',ord($1))/eg if $quoteHighBit;
86 ($noticks || /^\d+(\.\d*)?\Z/)
92 my $tArrayDepth = $#{$_[0]} ;
93 $tArrayDepth = $#{$_[0]} < $arrayDepth-1 ? $#{$_[0]} : $arrayDepth-1
94 unless $arrayDepth eq '' ;
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;
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]})) {
114 $short = $sp . "0..$#{$v} '" .
115 join("' '", @{$v}[0..$tArrayDepth]) . "'$shortmore";
118 unwrap($_[0],$_[1],$_[2]) if ref $_[0];
123 return if $DB::signal;
125 local($s) = shift ; # extra no of spaces
126 local($m) = shift ; # maximum recursion depth
128 local(%v,@v,$sp,$value,$key,@sortKeys,$more,$shortmore,$short) ;
129 local($tHashDepth,$tArrayDepth) ;
134 # Check for reused addresses
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
148 (0x[0-9a-f]+) # Save the address
149 \) # Skip close paren
150 $/x; # Should be at end now
152 if (!$dumpReused && defined $address) {
153 $address{$address}++ ;
154 if ( $address{$address} > 1 ) {
155 print "${sp}-> REUSED_ADDRESS\n" ;
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" ;
169 if (ref $v eq 'Regexp') {
170 # Reformat the regexp to look the standard way.
173 print "$sp-> qr/$re/\n";
177 if ( $item_type eq 'HASH' ) {
178 # Hash ref or hash-based object.
179 my @sortKeys = sort keys(%$v) ;
181 $tHashDepth = $#sortKeys ;
182 $tHashDepth = $#sortKeys < $hashDepth-1 ? $#sortKeys : $hashDepth-1
183 unless $hashDepth eq '' ;
184 $more = "....\n" if $tHashDepth < $#sortKeys ;
186 $shortmore = ", ..." if $tHashDepth < $#sortKeys ;
187 $#sortKeys = $tHashDepth ;
188 if ($compactDump && !grep(ref $_, values %{$v})) {
191 # Next row core dumps during require from DB on 5.000, even with map {"_"}
192 # map {&stringify($_) . " => " . &stringify($v->{$_})}
193 # @sortKeys) . "'$shortmore";
197 push @keys, &stringify($_) . " => " . &stringify($v->{$_});
199 $short .= join ', ', @keys;
200 $short .= $shortmore;
201 (print "$short\n"), return if length $short <= $compactDump;
203 for $key (@sortKeys) {
204 return if $DB::signal;
205 $value = $ {$v}{$key} ;
206 print "$sp", &stringify($key), " => ";
207 DumpElem $value, $s, $m-1;
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} ;
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} ;
222 $shortmore = " ..." if $tArrayDepth < $#{$v} ;
224 if ($compactDump && !grep(ref $_, @{$v})) {
226 $short = $sp . "0..$#{$v} " .
228 map {exists $v->[$_] ? stringify $v->[$_] : "empty"} ($[..$tArrayDepth)
231 $short = $sp . "empty array";
233 (print "$short\n"), return if length $short <= $compactDump;
235 #if ($compactDump && $short = ShortArray($v)) {
239 for $num ($[ .. $tArrayDepth) {
240 return if $DB::signal;
242 if (exists $v->[$num]) {
243 if (defined $v->[$num]) {
244 DumpElem $v->[$num], $s, $m-1;
250 print "empty slot\n";
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";
261 DumpElem $$v, $s, $m-1;
262 } elsif ( $item_type eq 'REF' ) {
264 return unless defined $$v;
265 unwrap($$v, $s+3, $m-1);
266 } elsif ( $item_type eq 'CODE' ) {
267 # Code object or reference.
270 } elsif ( $item_type eq 'GLOB' ) {
271 # Glob object or reference.
272 print "$sp-> ",&stringify($$v,1),"\n";
275 dumpglob($s, "{$$v}", $$v, 1, $m-1);
276 } elsif (defined ($fileno = fileno($v))) {
277 print( (' ' x ($s+3)) . "FileHandle({$$v}) => fileno($fileno)\n" );
279 } elsif (ref \$v eq 'GLOB') {
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" );
290 (my $var = $_[0]) =~ s/.//;
292 ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and
293 ($1 eq '!') ^ (eval { $var =~ /$2$3/ });
298 ($_[1] =~ /^([!~])(.)([\x00-\xff]*)/) and
299 ($1 eq '!') ^ (eval {($_[2] . "::" . $_[0]) =~ /$2$3/});
303 $compactDump = shift if @_;
304 $compactDump = 6*80-1 if $compactDump and $compactDump < 2;
309 $veryCompact = shift if @_;
310 compactDump(1) if !$compactDump and $veryCompact;
317 if ($in eq 'unctrl' or $in eq 'quote') {
320 print "Unknown value for `unctrl'.\n";
327 if (@_ and $_[0] eq '"') {
330 } elsif (@_ and $_[0] eq 'auto') {
333 } elsif (@_) { # Need to set
341 return if $DB::signal;
342 my ($off,$key, $val, $all, $m) = @_;
343 local(*entry) = $val;
345 if (($key !~ /^_</ or $dumpDBFiles) and defined $entry) {
346 print( (' ' x $off) . "\$", &unctrl($key), " = " );
347 DumpElem $entry, 3+$off, $m;
349 if (($key !~ /^_</ or $dumpDBFiles) and @entry) {
350 print( (' ' x $off) . "\@$key = (\n" );
351 unwrap(\@entry,3+$off,$m) ;
352 print( (' ' x $off) . ")\n" );
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" );
362 if (defined ($fileno = fileno(*entry))) {
363 print( (' ' x $off) . "FileHandle($key) => fileno($fileno)\n" );
366 if (defined &entry) {
373 return if $DB::signal;
374 my ($key, $val, $m, @vars) = @_;
375 return if @vars && !grep( matchlex($key, $_), @vars );
377 my $off = 0; # It reads better this way
379 if (UNIVERSAL::isa($val,'ARRAY')) {
380 print( (' ' x $off) . "$key = (\n" );
381 unwrap($val,3+$off,$m) ;
382 print( (' ' x $off) . ")\n" );
384 elsif (UNIVERSAL::isa($val,'HASH')) {
385 print( (' ' x $off) . "$key = (\n" );
386 unwrap($val,3+$off,$m) ;
387 print( (' ' x $off) . ")\n" );
389 elsif (UNIVERSAL::isa($val,'IO')) {
390 print( (' ' x $off) . "FileHandle($key) => fileno($fileno)\n" );
392 # No lexical subroutines yet...
393 # elsif (UNIVERSAL::isa($val,'CODE')) {
394 # dumpsub($off, $$val);
397 print( (' ' x $off) . &unctrl($key), " = " );
398 DumpElem $$val, 3+$off, $m;
402 sub CvGV_name_or_bust {
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};
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" );
426 return undef unless %DB::sub;
427 my ($addr, $name, $loc);
428 while (($name, $loc) = each %DB::sub) {
430 $subs{"$addr"} = $name;
437 my ($package,$m,@vars) = @_;
438 local(%address,$key,$val,$^W);
439 $package .= "::" unless $package =~ /::$/;
441 while ($package =~ /(\w+?::)/g){
442 *stab = $ {stab}{$1};
444 local $TotalStrings = 0;
446 local $CompleteTotal = 0;
447 while (($key,$val) = each(%stab)) {
448 return if $DB::signal;
449 next if @vars && !grep( matchvar($key, $_), @vars );
451 globUsage(\$val, $key)
452 if ($package ne 'dumpvar' or $key ne 'stab')
453 and ref(\$val) eq 'GLOB';
455 dumpglob(0,$key, $val, 0, $m);
459 print "String space: $TotalStrings bytes in $Strings strings.\n";
460 $CompleteTotal += $TotalStrings;
461 print "Grand total = $CompleteTotal bytes (1 level deep) + overhead.\n";
466 my $size = length($_[0]);
467 $TotalStrings += $size;
472 sub arrayUsage { # array ref, name
474 map {$size += scalarUsage($_)} @{$_[0]};
476 print "\@$_[1] = $len item", ($len > 1 ? "s" : ""),
477 " (data: $size bytes)\n"
479 $CompleteTotal += $size;
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;
489 my $total = $keys + $values;
490 print "\%$_[1] = $len item", ($len > 1 ? "s" : ""),
491 " (keys: $keys; values: $values; total: $total bytes)\n"
496 sub globUsage { # glob ref, name
497 local *name = *{$_[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"));
507 my ($package,@vars) = @_;
508 $package .= "::" unless $package =~ /::$/;
509 local *stab = *{"main::"};
510 while ($package =~ /(\w+?::)/g){
511 *stab = $ {stab}{$1};
513 local $TotalStrings = 0;
514 local $CompleteTotal = 0;
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';
520 print "String space: $TotalStrings.\n";
521 $CompleteTotal += $TotalStrings;
522 print "\nGrand total = $CompleteTotal bytes\n";