]> git.vpit.fr Git - perl/modules/B-RecDeparse.git/blob - README
Put prerequisites in their own separate hash
[perl/modules/B-RecDeparse.git] / README
1 NAME
2     B::RecDeparse - Deparse recursively into subroutines.
3
4 VERSION
5     Version 0.04
6
7 SYNOPSIS
8         perl -MO=RecDeparse,deparse,[@B__Deparse_opts],level,-1 [ -e '...' | bleh.pl ]
9
10         # Or as a module :
11         use B::RecDeparse;
12
13         my $brd = B::RecDeparse->new(deparse => [ @b__deparse_opts ], level => $level);
14         my $code = $brd->coderef2text(sub { ... });
15
16 DESCRIPTION
17     This module extends B::Deparse by making it recursively replace
18     subroutine calls encountered when deparsing.
19
20     Please refer to B::Deparse documentation for what to do and how to do
21     it. Besides the constructor syntax, everything should work the same for
22     the two modules.
23
24 METHODS
25   "new < deparse => [ @B__Deparse_opts ], level => $level >"
26     The B::RecDeparse object constructor. You can specify the underlying
27     B::Deparse constructor arguments by passing a string or an array
28     reference as the value of the "deparse" key. The "level" option expects
29     an integer that specifies how many levels of recursions are allowed : -1
30     means infinite while 0 means none and match B::Deparse behaviour.
31
32   "compile"
33   "init"
34   "pp_entersub"
35   "pp_refgen"
36   "pp_gv"
37     Functions and methods from B::Deparse reimplemented by this module.
38     Never call them directly.
39
40     Otherwise, B::RecDeparse inherits all methods from B::Deparse.
41
42 EXPORT
43     An object-oriented module shouldn't export any function, and so does
44     this one.
45
46 DEPENDENCIES
47     Carp (standard since perl 5), Config (since perl 5.00307) and B::Deparse
48     (since perl 5.005).
49
50 AUTHOR
51     Vincent Pit, "<perl at profvince.com>", <http://www.profvince.com>.
52
53     You can contact me by mail or on "irc.perl.org" (vincent).
54
55 BUGS
56     Please report any bugs or feature requests to "bug-b-recdeparse at
57     rt.cpan.org", or through the web interface at
58     <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=B-RecDeparse>. I will be
59     notified, and then you'll automatically be notified of progress on your
60     bug as I make changes.
61
62 SUPPORT
63     You can find documentation for this module with the perldoc command.
64
65         perldoc B::RecDeparse
66
67     Tests code coverage report is available at
68     <http://www.profvince.com/perl/cover/B-RecDeparse>.
69
70 COPYRIGHT & LICENSE
71     Copyright 2008 Vincent Pit, all rights reserved.
72
73     This program is free software; you can redistribute it and/or modify it
74     under the same terms as Perl itself.
75