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