/ 
JIP-Debug-0.02
River stage zero No dependents
/ JIP::Debug

NAME

JIP::Debug - provides a convenient way to attach debug print statements anywhere in a program.

VERSION

This document describes JIP::Debug version 0.02.

SYNOPSIS

For complex data structures (references, arrays and hashes) you can use the

use JIP::Debug qw(to_debug);

to_debug(
    an_array    => [],
    a_hash      => {},
    a_reference => \42,
);

to_debug({a => 1, b => 1}) will produce the output:

--------------------------------------------------------------------------------
[package=main, subroutine=tratata, line=1]:
--------------------------------------------------------------------------------
$VAR1 = [
  {
    'a' => 1,
    'b' => 1
  }
];

Prints a string

use JIP::Debug qw(to_debug_raw);

to_debug_raw('Hello');

to_debug_raw('Hello') will produce the output:

--------------------------------------------------------------------------------
[package=main, subroutine=tratata, line=1]:
--------------------------------------------------------------------------------
Hello

Prints empty lines

use JIP::Debug qw(to_debug_empty);

to_debug_empty();

Prints the number of times that this particular call to to_debug_count() has been called

use JIP::Debug qw(to_debug_count);

to_debug_count('tratata label');

to_debug_count('tratata label') will produce the output:

--------------------------------------------------------------------------------
[package=main, subroutine=tratata, line=1]:
--------------------------------------------------------------------------------
tratata label: 1

Prints a stack trace

use JIP::Debug qw(to_debug_trace);

to_debug_trace();

to_debug_trace() will produce the output:

--------------------------------------------------------------------------------
[package=main, subroutine=tratata, line=1]:
--------------------------------------------------------------------------------
Trace begun at -e line 1
main::tratata at -e line 1

DESCRIPTION

Each debug message is added a header with useful data during debugging, such as a package (package name), a subroutine (function name/method), a line (line number).

All debug messages are output via a file descriptor. Default is STDERR. Value can be changed by editing the variable $JIP::Debug::HANDLE.

The list of exporting functions by default is empty, all functions of this module are exported explicitly.

SUBROUTINES/METHODS

to_debug(LIST)

A wrapper for Dumper method of the Data::Dumper module. The list of parameters passed to to_debug, without any changes, is passed to Dumper.

Parameters for Data::Dumper can be changed, here are their analogues (and default values) in this module:

  • $JIP::Debug::DUMPER_INDENT = 1 or $Data::Dumper::Indent = 1

    Mild pretty print.

  • $JIP::Debug::DUMPER_DEEPCOPY = 1 or $Data::Dumper::Deepcopy = 1

    Avoid cross-refs.

  • $JIP::Debug::DUMPER_SORTKEYS = 1 or $Data::Dumper::Sortkeys = 1

    Hash keys are dumped in sorted order.

to_debug_raw([STRING])

Logs a string without any changes.

to_debug_empty()

Logs 18 empty lines. The content can be changed, there is a parameter for this $JIP::Debug::MSG_EMPTY_LINES.

to_debug_count([LABEL, CODE])

Logs the number of times that this particular call to to_debug_count() has been called.

This function takes an optional argument label. If label is supplied, this function logs the number of times to_debug_count() has been called with that particular label.

label - a string. If this is supplied, to_debug_count() outputs the number of times it has been called at this line and with that label.

to_debug_count('label');

If label is omitted, the function logs the number of times to_debug_count() has been called at this particular line.

to_debug_count();

This function takes an optional argument callback:

to_debug_count('label', sub {
    my ($label, $count) = @_;
});

or

to_debug_count(sub {
    my ($label, $count) = @_;
});

to_debug_trace([CODE])

Logs a stack trace from the point where the method was called.

This function takes an optional argument callback:

to_debug_trace(sub {
    my ($trace) = @_;
});

CODE SNIPPET

use JIP::Debug qw(to_debug to_debug_raw to_debug_empty to_debug_count to_debug_trace);
BEGIN { $JIP::Debug::HANDLE = IO::File->new('/home/my_dir/debug.log', '>>'); }

DIAGNOSTICS

None.

CONFIGURATION AND ENVIRONMENT

JIP::Debug requires no configuration files or environment variables.

SEE ALSO

Debuggit, Debug::Simple, Debug::Easy

AUTHOR

Vladimir Zhavoronkov, <flyweight at yandex.ru>

LICENSE AND COPYRIGHT

Copyright 2018 Vladimir Zhavoronkov.

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.