use namespace::clean -except => [ 'meta' ];
has current_matches => (
- is => 'rw',
- isa => 'ArrayRef',
- lazy => 1,
- default => sub { [] },
+ is => 'rw',
+ isa => 'ArrayRef',
+ lazy => 1,
+ default => sub { [] },
);
has match_index => (
- is => 'rw',
- isa => 'Int',
- lazy => 1,
- default => sub { 0 },
+ is => 'rw',
+ isa => 'Int',
+ lazy => 1,
+ default => sub { 0 },
);
has no_term_class_warning => (
- isa => "Bool",
- is => "rw",
- default => 0,
+ isa => "Bool",
+ is => "rw",
+ default => 0,
);
-sub BEFORE_PLUGIN {
- my ($self) = @_;
-
- my $weakself = $self;
- weaken($weakself);
-
- $self->term->Attribs->{attempted_completion_function} = sub {
- $weakself->_completion(@_);
- };
-}
-
-sub AFTER_PLUGIN {
- my ($self) = @_;
-
- warn "Term::ReadLine::Gnu is required for the Completion plugin to work"
- unless $self->term->isa("Term::ReadLine::Gnu") and !$self->no_term_class_warning;
-}
-
-sub _completion {
- my ($self, $text, $line, $start, $end) = @_;
+has do_readline_filename_completion => ( # so default is no if Completion loaded
+ isa => "Bool",
+ is => "rw",
+ lazy => 1,
+ default => sub { 0 },
+);
- # 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) = '';
+before 'read' => sub {
+ my ($self) = @_;
- my $document = PPI::Document->new(\$line);
- return unless defined($document);
+ 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);
+ }
- $document->prune('PPI::Token::Whitespace');
+ my $weakself = $self;
+ weaken($weakself);
- my @matches = $self->complete($text, $document);
+ if ($self->term->isa("Term::ReadLine::Gnu")) {
+ $self->term->Attribs->{attempted_completion_function} = sub {
+ $weakself->_completion(@_);
+ };
+ }
- # iterate through the completions
- return $self->term->completion_matches($text, sub {
- my ($text, $state) = @_;
+ if ($self->term->isa("Term::ReadLine::Perl")) {
+ $self->term->Attribs->{completion_function} = sub {
+ $weakself->_completion(@_);
+ };
+ }
- 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];
- });
+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;
+ }
+ }
}
sub complete {
- return ();
+ return ();
}
# 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;
+ 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;
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