Devel::StackTrace - Stack trace and stack trace frame objects |
Devel::StackTrace - Stack trace and stack trace frame objects
use Devel::StackTrace;
my $trace = Devel::StackTrace->new;
print $trace->as_string; # like carp
# from top (most recent) of stack to bottom. while (my $frame = $trace->next_frame) { print "Has args\n" if $f->hasargs; }
# from bottom (least recent) of stack to top. while (my $frame = $trace->prev_frame) { print "Sub: ", $f->subroutine, "\n"; }
The Devel::StackTrace module contains two classes, Devel::StackTrace
and Devel::StackTraceFrame. The goal of this object is to encapsulate
the information that can found through using the caller()
function, as
well as providing a simple interface to this data.
The Devel::StackTrace object contains a set of Devel::StackTraceFrame
objects, one for each level of the stack. The frames contain all the
data available from caller()
as of Perl 5.6.0 though this module still
works with 5.00503.
This code was created to support my the Exception::Class::Base manpage class (part of Exception::Class) but may be useful in other contexts.
When describing the methods of the trace object, I use the words 'top' and 'bottom'. In this context, the 'top' frame on the stack is the most recent frame and the 'bottom' is the least recent.
Here's an example:
foo(); # bottom frame is here
sub foo { bar(); }
sub bar { Devel::StackTrace->new; # top frame is here. }
new(%named_params)
Takes the following parameters:
Devel::StackTrace internally adds itself to the 'ignore_package' parameter, meaning that the Devel::StackTrace package is ALWAYS ignored. However, if you create a subclass of Devel::StackTrace it will not be ignored.
Devel::StackTrace replaces any references with their stringified representation.
next_frame
or prev_frame
will work
properly.
next_frame
or prev_frame
will work
properly.
next_frame
or
prev_frame
will start at the top or bottom of the stack, as
appropriate.
See the caller documentation for more information on what these methods return.
Dave Rolsky, <autarch@urth.org>
Exception::Class
Devel::StackTrace - Stack trace and stack trace frame objects |