1 # Carp::Heavy uses some variables in common with Carp.
6 Carp::Heavy - heavy machinery, no user serviceable parts inside
10 # On one line so MakeMaker will see it.
11 use Carp; our $VERSION = $Carp::VERSION;
12 # use strict; # not yet
14 # 'use Carp' just installs some very lightweight stubs; the first time
15 # these are called, they require Carp::Heavy which installs the real
18 # The members of %Internal are packages that are internal to perl.
19 # Carp will not report errors from within these packages if it
20 # can. The members of %CarpInternal are internal to Perl's warning
21 # system. Carp will not report errors from within these packages
22 # either, and will not report calls *to* these packages for carp and
23 # croak. They replace $CarpLevel, which is deprecated. The
24 # $Max(EvalLen|(Arg(Len|Nums)) variables are used to specify how the eval
25 # text and function arguments should be formatted when printed.
27 # disable these by default, so they can live w/o require Carp
28 $CarpInternal{Carp}++;
29 $CarpInternal{warnings}++;
30 $Internal{Exporter}++;
31 $Internal{'Exporter::Heavy'}++;
34 our ($CarpLevel, $MaxArgNums, $MaxEvalLen, $MaxArgLen, $Verbose);
36 # XXX longmess_real and shortmess_real should really be merged into
37 # XXX {long|sort}mess_heavy at some point
40 # Icky backwards compatibility wrapper. :-(
42 # The story is that the original implementation hard-coded the
43 # number of call levels to go back, so calls to longmess were off
44 # by one. Other code began calling longmess and expecting this
45 # behaviour, so the replacement has to emulate that behaviour.
46 my $call_pack = caller();
47 if ($Internal{$call_pack} or $CarpInternal{$call_pack}) {
48 return longmess_heavy(@_);
51 local $CarpLevel = $CarpLevel + 1;
52 return longmess_heavy(@_);
57 # Icky backwards compatibility wrapper. :-(
58 my $call_pack = caller();
59 local @CARP_NOT = caller();
63 # replace the two hooks added by Carp
65 # aliasing the whole glob rather than just the CV slot avoids 'redefined'
66 # warnings, even in the presence of perl -W (as used by lib/warnings.t !)
68 *longmess_jmp = *longmess_real;
69 *shortmess_jmp = *shortmess_real;
73 my $i = shift(@_) + 1;
77 qw(pack file line sub has_args wantarray evaltext is_require)
80 unless (defined $call_info{pack}) {
84 my $sub_name = Carp::get_subname(\%call_info);
85 if ($call_info{has_args}) {
86 my @args = map {Carp::format_arg($_)} @DB::args;
87 if ($MaxArgNums and @args > $MaxArgNums) { # More than we want to show?
91 # Push the args onto the subroutine
92 $sub_name .= '(' . join (', ', @args) . ')';
94 $call_info{sub_name} = $sub_name;
95 return wantarray() ? %call_info : \%call_info;
98 # Transform an argument to a function into a string.
102 $arg = defined($overload::VERSION) ? overload::StrVal($arg) : "$arg";
103 }elsif (not defined($arg)) {
107 $arg = str_len_trim($arg, $MaxArgLen);
110 $arg = "'$arg'" unless $arg =~ /^-?[\d.]+\z/;
112 # The following handling of "control chars" is direct from
113 # the original code - it is broken on Unicode though.
116 or $arg =~ s/([[:cntrl:]]|[[:^ascii:]])/sprintf("\\x{%x}",ord($1))/eg;
120 # Takes an inheritance cache and a package and returns
121 # an anon hash of known inheritances and anon array of
122 # inheritances which consequences have not been figured
127 $cache->{$pkg} ||= [{$pkg => $pkg}, [trusts_directly($pkg)]];
128 return @{$cache->{$pkg}};
131 # Takes the info from caller() and figures out the name of
132 # the sub/require/eval
135 if (defined($info->{evaltext})) {
136 my $eval = $info->{evaltext};
137 if ($info->{is_require}) {
138 return "require $eval";
141 $eval =~ s/([\\\'])/\\$1/g;
142 return "eval '" . str_len_trim($eval, $MaxEvalLen) . "'";
146 return ($info->{sub} eq '(eval)') ? 'eval {...}' : $info->{sub};
149 # Figures out what call (from the point of view of the caller)
150 # the long error backtrace should start at.
153 my $lvl = $CarpLevel;
155 my $pkg = caller(++$i);
156 unless(defined($pkg)) {
157 # This *shouldn't* happen.
160 $i = long_error_loc();
164 # OK, now I am irritated.
168 redo if $CarpInternal{$pkg};
169 redo unless 0 > --$lvl;
170 redo if $Internal{$pkg};
177 return @_ if ref($_[0]); # don't break references as exceptions
178 my $i = long_error_loc();
179 return ret_backtrace($i, @_);
182 # Returns a full stack backtrace starting from where it is
185 my ($i, @error) = @_;
187 my $err = join '', @error;
191 if (defined &Thread::tid) {
192 my $tid = Thread->self->tid;
193 $tid_msg = " thread $tid" if $tid;
196 my %i = caller_info($i);
197 $mess = "$err at $i{file} line $i{line}$tid_msg\n";
199 while (my %i = caller_info(++$i)) {
200 $mess .= "\t$i{sub_name} called at $i{file} line $i{line}$tid_msg\n";
207 my ($i, @error) = @_;
208 my $err = join '', @error;
212 if (defined &Thread::tid) {
213 my $tid = Thread->self->tid;
214 $tid_msg = " thread $tid" if $tid;
217 my %i = caller_info($i);
218 return "$err at $i{file} line $i{line}$tid_msg\n";
222 sub short_error_loc {
225 my $lvl = $CarpLevel;
227 my $called = caller($i++);
228 my $caller = caller($i);
230 return 0 unless defined($caller); # What happened?
231 redo if $Internal{$caller};
232 redo if $CarpInternal{$caller};
233 redo if $CarpInternal{$called};
234 redo if trusts($called, $caller, $cache);
235 redo if trusts($caller, $called, $cache);
236 redo unless 0 > --$lvl;
242 sub shortmess_heavy {
243 return longmess_heavy(@_) if $Verbose;
244 return @_ if ref($_[0]); # don't break references as exceptions
245 my $i = short_error_loc();
254 # If a string is too long, trims it with ...
257 my $max = shift || 0;
258 if (2 < $max and $max < length($str)) {
259 substr($str, $max - 3) = '...';
264 # Takes two packages and an optional cache. Says whether the
265 # first inherits from the second.
267 # Recursive versions of this have to work to avoid certain
268 # possible endless loops, and when following long chains of
269 # inheritance are less efficient.
273 my $cache = shift || {};
274 my ($known, $partial) = get_status($cache, $child);
275 # Figure out consequences until we have an answer
276 while (@$partial and not exists $known->{$parent}) {
277 my $anc = shift @$partial;
278 next if exists $known->{$anc};
280 my ($anc_knows, $anc_partial) = get_status($cache, $anc);
281 my @found = keys %$anc_knows;
282 @$known{@found} = ();
283 push @$partial, @$anc_partial;
285 return exists $known->{$parent};
288 # Takes a package and gives a list of those trusted directly
289 sub trusts_directly {
293 return @{"$class\::CARP_NOT"}
294 ? @{"$class\::CARP_NOT"}