/ 
Sub-ForceEval-1.20
/ Sub::ForceEval

NAME

Sub::ForceEval - runtime cluck if a dying subrutine is not eval-ed.

SYNOPSIS

# if you just want your death recorded:

use Sub::ForceEval;

# if any call to foo dies an eval will be added 
# at runtime if there isn't already one on the
# stack.

sub foo :ForceEval
{
   ...
}


# a bare call to foo() in the main code will cluck
# about having no eval on the stack and get wrapped
# on the fly if anything in it dies.

foo();

# this works, however, since foo can find that
# bletch was called from within an eval.

eval { bletch() };

sub bletch { bar() }

sub bar { foo() }


# or you may want an exceptional death.
#
# this can be helpful with higher-level code
# calls system service modules that have to 
# deal with non-exceptional die's internally.
# this way, anything that percolates above
# the service utilities will be a blessed
# exception.

package MyClass;

# use sets default constructor for any ForceEval in
# the class: if $@ is true then it will be blessed
# via $class->$method( $@ );

use Sub::ForceEval qw( My::Class::Default::constructor );

# individual sub's can override the class default
# (e.g., different classes of exception handlers
# can deal with different types of errors).

sub marine :ForceEval( 'Override::Default::new' );

DESCRIPTION

Subroutines that are marked with the ForceEval attribute check at runtime if there is an eval on the stack when the call dies. If there is an eval on the stack then the die is propagated to it via die $@; if not then cluck (see Carp) is called and the die is trapped.

The stack is only checked if something dies, so there is relatively little overhead in using the attribute.

Note that this inludes anything that dies for any reason even if the death is not intended as an OO 'exception'. This can be helpful for long-lived processes that need to ensure survival. It can also be handy for subs that call modules which use Fatal: all of the fatalities can be guaranteed to be gracefully handled.

If exception objects are preferred to flat $@ values then a constructor can be provided with the use. This will be broken into class and method portions and called to construct an object from the exception; individual subs can also provide a constructor.

INTERFACE

Un-blessed exceptions (default)

Use the module and add the :ForceEval attribute to a subroutine:

use Sub::ForceEval;

sub foo :ForceEval { ...}

Blessed exceptions (optional)

Package default exception

Passing a constructor to "use" will wrap all $@ via the constructor for subroutines in that package:

use Sub::ForceEval qw( Exceptional::Class::construct );

This will be broken into $class of Exceptional::Class and method of "construct", which are then called as:

die $class->$method( $@ );

This is a per-package setting (i.e., using it in one package does not affect other packages to use it with ForceEval).

Subroutine-specific exception

Passing a constructor to the ForceEval attribute will use that instead of any package default:

sub frobnicate :ForceEval qw( Exceptional::File::handler )
{
    ...
}

leaves $class and $method for the subroutine set to "Exceptional::File" and "handler".

DIAGNOSTICS

"Missing eval for '$name'", $@

An :ForceEval subroutine was called from a context where exceptions would not be caught by any surrounding eval. This uses Carp::cluck to complain about the fact and keeps going.

CONFIGURATION AND ENVIRONMENT

Sub::ForceEval requires no configuration files or environment variables.

DEPENDENCIES

strict

Carp

Symbol

version

Attribute::Handlers

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Some parts of this are impossible to test since detecting that the module incorrectly detected an existing eval requires running it in an eval.

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

AUTHORS

Steven Lembark <lembark@wrkhors.com>

Damian Conway

LICENCE AND COPYRIGHT

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.