X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit%2FDevel-REPL.git;a=blobdiff_plain;f=lib%2FDevel%2FREPL.pm;h=951404bdca3770d0c608a30f41f898261678c7c0;hp=c550a01c7f3a06ff648915de908509beaf9df5db;hb=eb7716dcfaffb2cc7fac0b44879a518809a0fc10;hpb=577190956fdbf84c17da73d3cdab183309542c9b diff --git a/lib/Devel/REPL.pm b/lib/Devel/REPL.pm index c550a01..951404b 100644 --- a/lib/Devel/REPL.pm +++ b/lib/Devel/REPL.pm @@ -2,32 +2,32 @@ package Devel::REPL; use Term::ReadLine; use Moose; -use namespace::clean -except => [ 'meta' ]; +use namespace::autoclean; use 5.008001; # backwards compat, doesn't warn like 5.8.1 -our $VERSION = '1.003009_02'; # 1.3.9_02 - with 'MooseX::Object::Pluggable'; use Devel::REPL::Error; has 'term' => ( - is => 'rw', required => 1, + is => 'rw', + lazy => 1, default => sub { Term::ReadLine->new('Perl REPL') } ); has 'prompt' => ( - is => 'rw', required => 1, + is => 'rw', default => sub { '$ ' } ); has 'out_fh' => ( - is => 'rw', required => 1, lazy => 1, + is => 'rw', + lazy => 1, default => sub { shift->term->OUT || \*STDOUT; } ); has 'exit_repl' => ( - is => 'rw', required => 1, + is => 'rw', default => sub { 0 } ); @@ -151,7 +151,7 @@ sub print { =head1 NAME -Devel::REPL - a modern perl interactive shell +Devel::REPL - A modern perl interactive shell =head1 SYNOPSIS @@ -186,8 +186,8 @@ message will be returned. Here are a few examples: 1 $_ nosuchfunction Compile error: Bareword "nosuchfunction" not allowed while "strict subs" in use at (eval 130) line 5. - - $_ + + $_ In the first example above you see the output of the command (C), if any, and then the return value of the statement (C<1>). Following @@ -199,7 +199,8 @@ which means a single statement doesn't require the semicolon. You can add one if you like, though. If you followed the first example in the L above, you'll have the -History and LexEnv plugins loaded (and there are many more available). +L and L +plugins loaded (and there are many more available). Although the shell might support "up-arrow" history, the History plugin adds "bang" history to that so you can re-execute chosen commands (with e.g. C). The LexEnv plugin ensures that lexical variables declared with the @@ -214,16 +215,20 @@ exported functions from that module are available for immediate use: (Do you need to predeclare carp?) Compile error: syntax error at (eval 129) line 5, near "carp "I'm dieeeing!\n"" BEGIN not safe after errors--compilation aborted at (eval 129) line 5. - - $_ use Carp - + + $_ use Carp + $_ carp "I'm dieeeing!\n" I'm dieeeing! at /usr/share/perl5/Lexical/Persistence.pm line 327 1 - $_ + $_ + +To quit from the shell, hit C or C. + + MSWin32 NOTE: control keys won't work if TERM=dumb + because readline functionality will be disabled. -To quit from the shell, hit C or C. =head2 Run Control Files @@ -241,7 +246,7 @@ filename like so: system$ re.pl --rcfile myproject.pc -If the filename happens to contain a forwardslash, then it's used absolutely, +If the filename happens to contain a forward slash, then it's used absolutely, or realive to the current working directory: system$ re.pl --rcfile /path/to/my/project/repl.rc @@ -255,7 +260,9 @@ To allow for the sharing of run control files, you can fashion them into a Perl module for distribution (perhaps via the CPAN). For more information on this feature, please see the L manual page. -A default profile ships with C; it loads the following plugins: +A C profile ships with C; it loads the following plugins +(note that some of these require optional features -- or you can also use the +C profile): =over 4 @@ -283,11 +290,39 @@ L L +=item * + +L + +=item * + +L + +=item * + +L + +=item * + +L + +=item * + +L + +=item * + +L + +=item * + +L + =back =head2 Plugins -Plugins are a way to add funcionality to the REPL shell, and take advantage of +Plugins are a way to add functionality to the REPL shell, and take advantage of C being based on the L object system for Perl 5. This means it's simple to 'hook into' many steps of the R-E-P-L process. Plugins can change the way commands are interpreted, or the way their results are @@ -295,7 +330,9 @@ output, or even add commands to the shell environment. A number of plugins ship with C, and more are available on the CPAN. Some of the shipped plugins are loaded in the default profile, mentioned -above. +above. These plugins can be loaded in your F< $HOME/.re.pl/repl.rc > like: + + load_plugin qw( CompletionDriver::Global DumpHistory ); Writing your own plugins is not difficult, and is discussed in the L manual page, along with links to the manual pages of @@ -319,74 +356,37 @@ control files have already been executed: 1 $_ -=head1 REQUIREMENTS +=head1 OPTIONAL FEATURES -In addition to the contents of the standard Perl distribution, you will need -the following: - -=over 4 - -=item * +In addition to the prerequisites declared in this distribution, which should be automatically installed by your L client, there are a number of optional features, used by +additional plugins. You can install any of these features by installing this +distribution interactively (e.g. C). -L >= 0.64 - -=item * - -L >= 0.0009 - -=item * - -L >= 0.15 - -=item * - -L >= 0.14 - -=item * - -L - -=item * - -L - -=item * - -L - -=back - -Optionally, some plugins if installed will require the following modules: +=for comment I hope to automatically generate this data via a Pod::Weaver section =over 4 -=item * - -L - -=item * - -L +=item * Completion plugin - extensible tab completion -=item * +=item * DDS plugin - better format results with Data::Dump::Streamer -L +=item * DDC plugin - even better format results with Data::Dumper::Concise -=item * +=item * INC completion driver - tab complete module names in use and require -L +=item * Interrupt plugin - traps SIGINT to kill long-running lines -=item * +=item * Keywords completion driver - tab complete Perl keywords and operators -L +=item * LexEnv plugin - variables declared with "my" persist between statements -=item * +=item * MultiLine::PPI plugin - continue reading lines until all blocks are closed -L +=item * Nopaste plugin - upload a session\'s input and output to a Pastebin -=item * +=item * PPI plugin - PPI dumping of Perl code -L +=item * Refresh plugin - automatically reload libraries with Module::Refresh =back @@ -416,6 +416,10 @@ Matt S Trout - mst (at) shadowcatsystems.co.uk (L >> +=item Chris Marshall + +=item Karen Etheridge C<< >> + =back =head1 LICENSE