package Devel::REPL::Plugin::Completion;
-
-use Moose::Role;
+use Devel::REPL::Plugin;
+use Scalar::Util 'weaken';
+use PPI;
use namespace::clean -except => [ 'meta' ];
+has current_matches => (
+ is => 'rw',
+ isa => 'ArrayRef',
+ lazy => 1,
+ default => sub { [] },
+);
+
+has match_index => (
+ is => 'rw',
+ isa => 'Int',
+ lazy => 1,
+ default => sub { 0 },
+);
+
+has no_term_class_warning => (
+ isa => "Bool",
+ is => "rw",
+ default => 0,
+);
+
+has do_readline_filename_completion => ( # so default is no if Completion loaded
+ isa => "Bool",
+ is => "rw",
+ lazy => 1,
+ default => sub { 0 },
+);
+
+before 'read' => sub {
+ my ($self) = @_;
+
+ if ((!$self->term->isa("Term::ReadLine::Gnu") and !$self->term->isa("Term::ReadLine::Perl"))
+ and !$self->no_term_class_warning) {
+ warn "Term::ReadLine::Gnu or Term::ReadLine::Perl is required for the Completion plugin to work";
+ $self->no_term_class_warning(1);
+ }
+
+ my $weakself = $self;
+ weaken($weakself);
+
+ if ($self->term->isa("Term::ReadLine::Gnu")) {
+ $self->term->Attribs->{attempted_completion_function} = sub {
+ $weakself->_completion(@_);
+ };
+ }
+
+ if ($self->term->isa("Term::ReadLine::Perl")) {
+ $self->term->Attribs->{completion_function} = sub {
+ $weakself->_completion(@_);
+ };
+ }
-# push the given string in the completion list
-sub push_completion
-{
- my ($self, $string) = @_;
- $self->term->Attribs->{completion_entry_function} =
- $self->term->Attribs->{list_completion_function};
- push @{$self->term->Attribs->{completion_word}}, $string;
};
-# return the namespace of the module given
-sub get_namespace
-{
- my ($self, $module) = @_;
- my $namespace;
- eval '$namespace = \%'.$module.'::';
- return $namespace;
+sub _completion {
+ my $is_trp = scalar(@_) == 4 ? 1 : 0;
+ my ($self, $text, $line, $start, $end) = @_;
+ $end = $start+length($text) if $is_trp;
+
+ # we're discarding everything after the cursor for completion purposes
+ # we can't just use $text because we want all the code before the cursor to
+ # matter, not just the current word
+ substr($line, $end) = '';
+
+ my $document = PPI::Document->new(\$line);
+ return unless defined($document);
+
+ $document->prune('PPI::Token::Whitespace');
+
+ my @matches = $self->complete($text, $document);
+
+ # iterate through the completions
+ if ($is_trp) {
+ if (scalar(@matches)) {
+ return @matches;
+ } else {
+ return ($self->do_readline_filename_completion) ? readline::rl_filename_list($text) : () ;
+ }
+ } else {
+ $self->term->Attribs->{attempted_completion_over} = 1 unless $self->do_readline_filename_completion;
+ if (scalar(@matches)) {
+ return $self->term->completion_matches($text, sub {
+ my ($text, $state) = @_;
+
+ if (!$state) {
+ $self->current_matches(\@matches);
+ $self->match_index(0);
+ }
+ else {
+ $self->match_index($self->match_index + 1);
+ }
+
+ return $self->current_matches->[$self->match_index];
+ });
+ } else {
+ return;
+ }
+ }
}
-# we wrap the run method to init the completion list
-# with filenames found in the current dir and init
-# the completion list.
-# yes, this is our 'init the plugin' stuff actually
-sub BEFORE_PLUGIN
-{
- my ($self) = @_;
- # set the completion function
- $self->term->Attribs->{completion_entry_function} =
- $self->term->Attribs->{list_completion_function};
- $self->term->Attribs->{completion_word} = [];
-
- # now put each file in curdir in the completion list
- my $curdir = File::Spec->curdir();
- if (opendir(CURDIR, $curdir)) {
- while (my $file = readdir(CURDIR)) {
- next if $file =~ /^\.+$/; # we skip "." and ".."
- $self->push_completion($file);
- }
- }
- closedir(CURDIR);
+sub complete {
+ return ();
}
-# wrap the eval one to catch each 'use' statement in order to
-# load the namespace in the completion list (module functions and friends)
-# we do that around the eval method cause we want the module to be actually loaded.
-around 'eval' => sub {
- my $orig = shift;
- my ($self, $line) = @_;
- my @ret = $self->$orig($line);
-
- # the namespace of the loaded module
- if ($line =~ /\buse\s+(\S+)/) {
- my $module = $1;
- foreach my $keyword (keys %{$self->get_namespace($module) || {}}) {
- $self->push_completion($keyword);
- }
- }
-
- # parses the lexical environment for new variables to add to
- # the completion list
- my $lex = $self->lexical_environment;
- foreach my $var (keys %{$lex->get_context('_')}) {
- $var = substr($var, 1); # we drop the variable idiom as it confuses the completion
- $self->push_completion($var) unless
- grep $_ eq $var, @{$self->term->Attribs->{completion_word}};
- }
-
- return @ret;
-};
+# recursively find the last element
+sub last_ppi_element {
+ my ($self, $document, $type) = @_;
+ my $last = $document;
+ while ($last->can('last_element') && defined($last->last_element)) {
+ $last = $last->last_element;
+ return $last if $type && $last->isa($type);
+ }
+ return $last;
+}
1;
+
+__END__
+
+=head1 NAME
+
+Devel::REPL::Plugin::Completion - Extensible tab completion
+
+=head1 NOTE
+
+By default, the Completion plugin explicitly does I<not> use the Gnu readline
+or Term::ReadLine::Perl fallback filename completion.
+
+Set the attribute C<do_readline_filename_completion> to 1 to enable this feature.
+
+=head1 AUTHOR
+
+Shawn M Moore, C<< <sartak at gmail dot com> >>
+
+=cut
+
projects / p5sagit/Devel-REPL.git / blobdiff