/ 
Acme-JavaTrace-0.08
River stage zero No dependents
/ Acme::JavaTrace

NAME

Acme::JavaTrace - Module for using Java-like stack traces

VERSION

Version 0.08

SYNOPSIS

On the command-line:

perl -wMAcme::JavaTrace program_with_strange_errors.pl

Inside a module:

use Acme::JavaTrace;
warn "some kind of non-fatal exception occured";
die "some kind of fatal exception occured";

DESCRIPTION

<buzzword>This module tries to improves the Perl programmer experience by porting the Java paradigm to print stack traces, which is more professional than Perl's way. </buzzword>

This is achieved by modifying the functions warn() and die() in order to replace the standard messages by complete stack traces that precisely indicates how and where the error or warning occurred. Other than this, their use should stay unchanged, even when using die() inside eval().

For a explanation of why I wrote this module, you can read the slides of my lightning talk Entreprise Perl, available here: http://maddingue.org/conferences/yapc-eu-2004/entreprise-perl/

OPTIONS

Options can be set at import time using:

perl -wMDevel::SimpleTrace=option1,option2

or

use Devel::SimpleTrace qw(option1 option2);

Available options are:

showrefs

Using this option will tell Devel::SimpleTrace to stringify objects and references passed in argument to die(). This option is disabled by default in order to leave objects and references untouched.

EXAMPLE

Here is an example of stack trace produced by Acme::JavaTrace using a fictional Perl program:

Exception: event not implemented
        at MyEvents::generic_event_handler(workshop/events.pl:26)
        at MyEvents::__ANON__(workshop/events.pl:11)
        at MyEvents::dispatch_event(workshop/events.pl:22)
        at MyEvents::call_event(workshop/events.pl:17)
        at main::(workshop/events.pl:30)

Please note that even the professionnal indentation present in the Java environment is included in the trace.

DIAGNOSTICS

Unknown option: %s

(W) This warning occurs if you try to set an unknown option.

CAVEATS

This module is currently not compatible with other modules that also work by overriding die() and warn(), like CGI::Carp.

BLAME

Java, for its unhelpful kilometre-long stack traces.

AUTHOR

Sébastien Aperghis-Tramoni <sebastien@aperghis.net>

BUGS

Please report any bugs or feature requests to bug-Acme-JavaTrace@rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-JavaTrace. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT & LICENSE

Acme::JavaTrace is Copyright (C)2004-2011 Sébastien Aperghis-Tramoni.

This program is free software. You can redistribute it and/or modify it under the same terms as Perl itself.