Carp::Trace - simple traceback of call stacks


Carp-Trace documentation Contained in the Carp-Trace distribution.

Index


Code Index:

NAME

Top

Carp::Trace - simple traceback of call stacks

SYNOPSIS

Top

    use Carp::Trace;

    sub flubber {
        die "You took this route to get here:\n" .
            trace();
    }

DESCRIPTION

Top

Carp::Trace provides an easy way to see the route your script took to get to a certain place. It uses simple caller calls to determine this.

FUNCTIONS

Top

trace( [DEPTH, OFFSET, ARGS] )

trace is a function, exported by default, that gives a simple traceback of how you got where you are. It returns a formatted string, ready to be sent to STDOUT or STDERR.

Optionally, you can provide a DEPTH argument, which tells trace to only go back so many levels. The OFFSET argument will tell trace to skip the first [OFFSET] layers up.

If you provide a true value for the ARGS parameter, the arguments passed to each callstack will be dumped using Data::Dumper. This might slow down your trace, but is very useful for debugging.

See also the Global Variables section.

trace is able to tell you the following things:

The output from the following code:

    use Carp::Trace;

    sub foo { bar() };
    sub bar { $x = baz() };
    sub baz { @y = zot() };
    sub zot { print trace() };

    eval 'foo(1)';

Might look something like this:

    main::(eval) [5]
        foo(1);
        void - no new stash
        x.pl line 1
    main::foo [4]
        void - new stash
        (eval 1) line 1
    main::bar [3]
        void - new stash
        x.pl line 1
    main::baz [2]
        scalar - new stash
        x.pl line 1
    main::zot [1]
        list - new stash
        x.pl line 1

Global Variables

Top

$Carp::Trace::DEPTH

Sets the depth to be used by default for trace. Any depth argument to trace will override this setting.

$Carp::Trace::OFFSET

Sets the offset to be used by default for trace. Any offset argument to trace will override this setting.

$Carp::Trace::ARGUMENTS

Sets a flag to indicate that a trace should dump all arguments for every call stack it's printing out. Any args argument to trace will override this setting.

AUTHOR

Top

This module by Jos Boumans <kane@cpan.org>.

COPYRIGHT

Top


Carp-Trace documentation Contained in the Carp-Trace distribution.

package Carp::Trace;
use strict;
use Data::Dumper;
use Devel::Caller::Perl qw[called_args];

BEGIN {
    use     vars qw[@ISA @EXPORT $VERSION $DEPTH $OFFSET $ARGUMENTS];
    use     Exporter;

    @ISA    = 'Exporter';
    @EXPORT = 'trace';
}

$OFFSET     = 0;
$DEPTH      = 0;
$ARGUMENTS  = 0;
$VERSION    = '0.12';

sub trace {
    my $level   = shift || $DEPTH       || 0;
    my $offset  = shift || $OFFSET      || 0;
    my $args    = shift || $ARGUMENTS   || 0;

    my $trace = '';
    my $i = 1 + $OFFSET;

    while (1) {
        last if $level && $level < $i;

        my  @caller = caller($i);
        last unless scalar @caller;

        my  ($package, $filename, $line, $subroutine, $hasargs, $wantarray,
            $evaltext, $is_require, $hints, $bitmask) = @caller;

        my $string = $subroutine eq '(eval)'
                    ?   $package . '::' . $subroutine . qq| [$i]|
                        . (defined $evaltext ? qq[\n\t$evaltext] : '')
                    :   $subroutine . qq| [$i]|;
        $string =~ s/\n;$/;/gs;

        $string .= qq[\n\t];

        $string .= q[require|use - ] if $is_require;
        $string .= defined $wantarray
                        ? $wantarray ? 'list - ' : 'scalar - '
                        : 'void - ';
        $string .= $hasargs ? 'new stash' : 'no new stash';
        $string .=  qq[\n\t] . $filename . ' line ' . $line . qq[\n];

        if ($args) {
            local $Data::Dumper::Varname    = 'ARGS';
            local $Data::Dumper::Indent     = 1;

            for my $line ( split $/, Dumper( called_args($i) ) ) {
                $string .=  "\t$line\n";
            }
        }

        $trace = $string . $trace;

        $i++;
    }

    return $trace;
}

__END__