X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit%2FDevel-REPL.git;a=blobdiff_plain;f=lib%2FDevel%2FREPL%2FPlugin%2FReadLineHistory.pm;h=bae5df939706537d71bb6eecbd288a6c89b35f0e;hp=42f733fa9726d10454eaa63ef0dc3685c3cc42bb;hb=master;hpb=baa665c24b891d98e5f937a36679fac44e23ffb6

diff --git a/lib/Devel/REPL/Plugin/ReadLineHistory.pm b/lib/Devel/REPL/Plugin/ReadLineHistory.pm
index 42f733f..bae5df9 100644
--- a/lib/Devel/REPL/Plugin/ReadLineHistory.pm
+++ b/lib/Devel/REPL/Plugin/ReadLineHistory.pm
@@ -3,14 +3,19 @@
 #
 # epitaph, 22nd April 2007
 
+use strict;
+use warnings;
 package Devel::REPL::Plugin::ReadLineHistory;
+# ABSTRACT: Integrate history with the facilities provided by L<Term::ReadLine>
+
+our $VERSION = '1.003030';
 
 use Devel::REPL::Plugin;
-use File::HomeDir;
 use File::Spec;
+use namespace::autoclean;
 
 my $hist_file = $ENV{PERLREPL_HISTFILE} ||
-    File::Spec->catfile(File::HomeDir->my_home, '.perlreplhist');
+    File::Spec->catfile(($^O eq 'MSWin32' && "$]" < 5.016 ? $ENV{HOME} || $ENV{USERPROFILE} : (<~>)[0]), '.perlreplhist');
 
 # HISTLEN should probably be in a config file to stop people accidentally
 # truncating their history if they start the program and forget to set
@@ -39,8 +44,16 @@ around 'run' => sub {
          close HIST;
       }
    }
-   $self->term->Attribs->{do_expand}=1;
+
+   $self->term->Attribs->{do_expand}=1;  # for Term::ReadLine::Gnu
+   $self->term->MinLine(2);              # don't save one letter commands
+
+   # let History plugin know we have Term::ReadLine support
+   $self->have_readline_history(1) if $self->can('have_readline_history');
+
+
    $self->$orig(@args);
+
    if ($self->term->ReadLine eq 'Term::ReadLine::Gnu') {
       $self->term->WriteHistory($hist_file) ||
       $self->print("warning: failed to write history file $hist_file");
@@ -60,9 +73,40 @@ around 'run' => sub {
 
 __END__
 
-=head1 NAME
+=pod
 
-Devel::REPL::Plugin::ReadLineHistory - Integrate history with the facilities provided by L<Term::ReadLine>
+=head1 DESCRIPTION
 
-=cut
+This plugin enables loading and saving command line history from
+a file as well has history expansion of previous commands using
+the !-syntax a la bash.
+
+By default, history expansion is enabled with this plugin when
+using L<Term::ReadLine::Gnu|Term::ReadLine::Gnu>. That means that
+"loose" '!' characters will be treated as history events which
+may not be what you wish.
+
+To avoid this, you need to quote the '!' with '\':
 
+  my $var = "foo\!";
+
+or place the arguments in single quotes---but enable the
+C<Term::ReadLine> attribute C<history_quotes_inhibit_expansion>:
+
+  $_REPL->term->Attribs->{history_quotes_inhibit_expansion} = 1;
+  my $var = 'foo!';
+
+and to disable history expansion from GNU readline/history do
+
+  $_REPL->term->Attribs->{do_expand} = 0;
+
+=head1 CONFLICTS
+
+Note that L<Term::ReadLine::Perl> does not support a history
+expansion method.  In that case, you may wish to use the
+L<Devel::REPL History plugin|Devel::REPL::Plugin::History> which provides similar functions.
+Work is underway to make use of either L<History|Devel::REPL::Plugin::History> or
+L<ReadLineHistory|Devel::REPL::Plugin::ReadHistory>> consistent for expansion with either the
+L<Term::ReadLine::Gnu> support or L<Term::ReadLine::Perl>.
+
+=cut