X-Git-Url: http://git.vpit.fr/?a=blobdiff_plain;f=README;h=fb57293ab15771c482cbd629d7ea4ef876b70925;hb=d6668cdd400c8d8f02afca5a4df363e26fa71ef0;hp=673b96ac42ff966f224c555dea0f21707c128bbd;hpb=77ec52f71f128e1b4d092107ce21545e5cbc7252;p=perl%2Fmodules%2FB-RecDeparse.git diff --git a/README b/README index 673b96a..fb57293 100644 --- a/README +++ b/README @@ -2,15 +2,22 @@ NAME B::RecDeparse - Deparse recursively into subroutines. VERSION - Version 0.04 + Version 0.08 SYNOPSIS - perl -MO=RecDeparse,deparse,[@B__Deparse_opts],level,-1 [ -e '...' | bleh.pl ] + # Deparse recursively a Perl one-liner : + $ perl -MO=RecDeparse,deparse,@B__Deparse_opts,level,-1 -e '...' - # Or as a module : + # Or a complete Perl script : + $ perl -MO=RecDeparse,deparse,@B__Deparse_opts,level,-1 x.pl + + # Or a single code reference : use B::RecDeparse; - my $brd = B::RecDeparse->new(deparse => [ @b__deparse_opts ], level => $level); + my $brd = B::RecDeparse->new( + deparse => \@B__Deparse_opts, + level => $level, + ); my $code = $brd->coderef2text(sub { ... }); DESCRIPTION @@ -22,20 +29,32 @@ DESCRIPTION the two modules. METHODS - "new < deparse => [ @B__Deparse_opts ], level => $level >" + "new" + my $brd = B::RecDeparse->new( + deparse => \@B__Deparse_opts, + level => $level, + ); + The B::RecDeparse object constructor. You can specify the underlying B::Deparse constructor arguments by passing a string or an array reference as the value of the "deparse" key. The "level" option expects an integer that specifies how many levels of recursions are allowed : -1 means infinite while 0 means none and match B::Deparse behaviour. - "compile" - "init" - "pp_entersub" - "pp_refgen" - "pp_gv" - Functions and methods from B::Deparse reimplemented by this module. - Never call them directly. + The following functions and methods from B::Deparse are reimplemented by + this module : + + * "compile" + + * "init" + + * "deparse_sub" + + * "pp_entersub" + + * "pp_refgen" + + * "pp_gv" Otherwise, B::RecDeparse inherits all methods from B::Deparse. @@ -44,6 +63,8 @@ EXPORT this one. DEPENDENCIES + perl 5.8.1. + Carp (standard since perl 5), Config (since perl 5.00307) and B::Deparse (since perl 5.005). @@ -68,7 +89,7 @@ SUPPORT . COPYRIGHT & LICENSE - Copyright 2008 Vincent Pit, all rights reserved. + Copyright 2008,2009,2010,2011,2013 Vincent Pit, all rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.