/ 
Devel-Scope-0.12
River stage zero No dependents
/ Devel::Scope

NAME

Devel::Scope - Scope based debug

VERSION

Version 0.12

SYNOPSIS

Provide a debug method that outputs conditionally based on the scoping level.

use Devel::Scope qw( debug );

debug("main"); # Main Scope

sub foo {
    debug("inside foo"); # Function Scope
    if ( 1 ) {
        debug("if true start calculations"); # Function Scope + 1
        for my $x ( 0..3 ) {
            debug("x is set to $x"); # Function Scope + 2
            for my $y ( 0..3 ) {
                debug("x=$x, y=$y"); # Function Scope + 3
                for my $z ( 0 ..3 ) {
                    debug("x=$x, y=$y, z=$z"); # Function Scope + 4
                }
            }
        }
        debug("end of calculaions");
    }
    debug("leaving foo");
}

...

DEVEL_SCOPE_DEPTH=3 perl foo.pl

EXPORT

debug
debug_enable
debug_disable

SUBROUTINES/METHODS

debug

Prints only when the scope is greater (deeper) than some number.
Turns into a NO-OP unless DEVEL_SCOPE_DEPTH environmental variable is set.

    debug("The value of foo = 2")

head2 debug_enable

Turn on debugging

    debug_enable(2); # Set the depth to 2

    my $current_debug_depth = debug_enable();

head3 debug disable

Turn off debugging

    debug_disable();

    my $previous_debug_depth = debug_disable();

AUTHOR

Felix Tubiana, <felixtubiana at gmail.com>

BUGS

Please report any bugs or feature requests to bug-devel-debug-scope at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Devel-Scope. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Devel::Scope

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2018 Felix Tubiana.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.