Changeset 4815492 for perl/lib/BarnOwl/Completion.pm

Timestamp:

Dec 28, 2009, 12:03:28 AM (15 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, release-1.10, release-1.6, release-1.7, release-1.8, release-1.9

Children:

880311d

Parents:

4d26776

git-author:

Nelson Elhage <nelhage@mit.edu> (12/24/09 16:44:52)

git-committer:

Nelson Elhage <nelhage@mit.edu> (12/28/09 00:03:28)

Message:

Completion: Allow for separate display and replacement strings.

File:

• perl/lib/BarnOwl/Completion.pm (modified) (4 diffs)

perl/lib/BarnOwl/Completion.pm

@@ -31 +31 @@
     my @words = get_completions($ctx);
     return unless @words;
-    my $prefix = common_prefix(@words);
+    my $prefix = common_prefix(map {completion_value($_)} @words);
 
     if($prefix) {
@@ -44 +44 @@
 }
 
+=head1 COMPLETIONS
+
+A COMPLETION is either a simple string, or a reference to an array
+containing two or more values.
+
+In the former case, the string use used for both the text to display,
+as well as the result of the completion, and is assumed to be a full
+completion.
+
+An arrayref completion consists of
+
+    [$display_text, $replacement_value].
+
+$display_text will be printed in the case of ambiguous completions,
+$replacement_value will be used to substitute the value in.
+
+=cut
+
+sub completion_text {
+    my $c = shift;
+    return $c unless ref($c) eq 'ARRAY';
+    return $c->[0];
+}
+
+sub completion_value {
+    my $c = shift;
+    return $c unless ref($c) eq 'ARRAY';
+    return $c->[1];
+}
+
 sub insert_completion {
     my $ctx = shift;
-    my $completion = BarnOwl::quote(shift);
+    my $completion = BarnOwl::quote(completion_value(shift));
     my $unique = shift;
 
@@ -66 +96 @@
 sub show_completions {
     my @words = @_;
-    my $all = BarnOwl::quote(@words);
+    my $all = BarnOwl::quote(map {completion_text($_)} @words);
     my $width = BarnOwl::getnumcols();
     if (length($all) > $width-1) {
@@ -98 +128 @@
         my $word = $ctx->words->[$ctx->word];
         if(exists($completers{$cmd})) {
-            return grep {$_ =~ m{^\Q$word\E}} $completers{$cmd}->($ctx);
+            return grep {completion_value($_) =~ m{^\Q$word\E}} $completers{$cmd}->($ctx);
         }
         return;