The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Carp-Source-0.02
River stage zero No dependents
++
/ Carp::Source

NAME

Carp::Source - warn of errors with stack backtrace and source context

SYNOPSIS

    use Carp::Source 'source_cluck';
    source_cluck 'some error';
    source_cluck 'some error',
        lines => 5, number => 0, color => 'yellow on_blue';

DESCRIPTION

This module exports one function, source_cluck(), which prints stack traces with source code extracts to make it obvious what has been called from where.

source_cluck
    source_cluck 'some error';
    source_cluck 'some error',
        lines => 5, number => 0, color => 'yellow on_blue';

Like Carp's cluck(), but it also displays the source code context of all call frames, with three lines before and after each call being shown, and the call being highlighted.

It takes as arguments a string (the error message) and a hash of options. The following options are recognized:

lines

Number of lines to display before and after the line reported in the stack trace. Defaults to 3.

number

Boolean value to indicate whether line numbers should be printed at the beginning of the context source code lines. Defaults to yes.

color

The color in which to print the source code line reported in the stack trace. It has to be a string that Term::ANSIColor understands. Defaults to black on_yellow.

This is just a quick hack - not all of Carp's or even just cluck()'s features are present. The code borrows heavily from Carp.

TAGS

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the carpsource tag.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-carp-source@rt.cpan.org, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.