Implemented input completion for Userland

src/Configuration.php

@@ -87,7 +87,8 @@ class Configuration
     private $historySize;
     private $eraseDuplicates;
     private $manualDbFile;
-    private $hasReadline;
+    /** @bool Native readline implementation provided by {@see readline()} function */
+    private $hasNativeReadline;
     private $useReadline;
     private $useBracketedPaste;
     private $hasPcntl;
@@ -370,7 +371,7 @@ public static function getInputOptions(): array
     public function init()
     {
         // feature detection
-        $this->hasReadline = \function_exists('readline');
+        $this->hasNativeReadline = \function_exists('readline');
         $this->hasPcntl = ProcessForker::isSupported();
 
         if ($configFile = $this->getConfigFile()) {
@@ -735,13 +736,25 @@ public function getPipe(string $type, int $pid): string
     }
 
     /**
-     * Check whether this PHP instance has Readline available.
+     * Check whether this PHP instance has native readline available.
+     *
+     * @deprecated Call {@see Configuration::hasNativeReadline()} instead
      *
      * @return bool True if Readline is available
      */
     public function hasReadline(): bool
     {
-        return $this->hasReadline;
+        return $this->hasNativeReadline;
+    }
+
+    /**
+     * Check whether this PHP instance has native readline available.
+     *
+     * @return bool True if Readline is available
+     */
+    public function hasNativeReadline(): bool
+    {
+        return $this->hasNativeReadline;
     }
 
     /**
@@ -764,7 +777,7 @@ public function setUseReadline(bool $useReadline)
      */
     public function useReadline(): bool
     {
-        return isset($this->useReadline) ? ($this->hasReadline && $this->useReadline) : $this->hasReadline;
+        return isset($this->useReadline) ? ($this->hasNativeReadline && $this->useReadline) : $this->hasNativeReadline;
     }
 
     /**
@@ -1081,7 +1094,9 @@ public function setTabCompletion(bool $useTabCompletion)
      */
     public function useTabCompletion(): bool
     {
-        return isset($this->useTabCompletion) ? ($this->hasReadline && $this->useTabCompletion) : $this->hasReadline;
+        // TODO: In the future, if stability other than GNU Readline improves,
+        //       it will no longer depend on $this->hasNativeReadline property.
+        return isset($this->useTabCompletion) ? $this->useTabCompletion : $this->hasNativeReadline;
     }
 
     /**

src/Readline/GNUReadline.php

@@ -11,6 +11,8 @@
 
 namespace Psy\Readline;
 
+use Psy\TabCompletion\AutoCompleter;
+
 /**
  * A Readline interface implementation for GNU Readline.
  *
@@ -176,4 +178,18 @@ public function writeHistory(): bool
 
         return true;
     }
+
+    public function activateAutoCompleter(AutoCompleter $autoCompleter): void
+    {
+        \readline_completion_function([$autoCompleter, 'callback']);
+    }
+
+    public function deactivateAutoCompleter(): void
+    {
+        // PHP didn't implement the whole readline API when they first switched
+        // to libedit. And they still haven't.
+        if (\function_exists('readline_callback_handler_remove')) {
+            \readline_callback_handler_remove();
+        }
+    }
 }

src/Readline/Hoa/Autocompleter.php

@@ -46,8 +46,11 @@ interface Autocompleter
     /**
      * Complete a word.
      * Returns null for no word, a full-word or an array of full-words.
+     *
+     * @param array{line_buffer: string} $info A subset of {@see readline_info()}'s return value.
+     * @see https://www.php.net/readline_info
      */
-    public function complete(&$prefix);
+    public function complete(string $prefix, int $index, array $info);
 
     /**
      * Get definition of a word.

src/Readline/Hoa/AutocompleterAggregate.php

@@ -48,21 +48,14 @@ class AutocompleterAggregate implements Autocompleter
      */
     protected $_autocompleters = null;
 
-    /**
-     * Constructor.
-     */
     public function __construct(array $autocompleters)
     {
         $this->setAutocompleters($autocompleters);
 
         return;
     }
 
-    /**
-     * Complete a word.
-     * Returns null for no word, a full-word or an array of full-words.
-     */
-    public function complete(&$prefix)
+    public function complete(string $prefix, int $index, array $info)
     {
         foreach ($this->getAutocompleters() as $autocompleter) {
             $preg = \preg_match(
@@ -108,9 +101,6 @@ public function getAutocompleters()
         return $this->_autocompleters;
     }
 
-    /**
-     * Get definition of a word.
-     */
     public function getWordDefinition(): string
     {
         return '.*';

src/Readline/Hoa/AutocompleterPath.php

@@ -58,9 +58,6 @@ class AutocompleterPath implements Autocompleter
      */
     protected $_iteratorFactory = null;
 
-    /**
-     * Constructor.
-     */
     public function __construct(
         string $root = null,
         \Closure $iteratorFactory = null
@@ -78,11 +75,7 @@ public function __construct(
         }
     }
 
-    /**
-     * Complete a word.
-     * Returns null for no word, a full-word or an array of full-words.
-     */
-    public function complete(&$prefix)
+    public function complete(string $prefix, int $index, array $info)
     {
         $root = $this->getRoot();
 
@@ -136,9 +129,6 @@ public function complete(&$prefix)
         return $out;
     }
 
-    /**
-     * Get definition of a word.
-     */
     public function getWordDefinition(): string
     {
         return '/?[\w\d\\_\-\.]+(/[\w\d\\_\-\.]*)*';

src/Readline/Hoa/AutocompleterWord.php

@@ -56,15 +56,7 @@ public function __construct(array $words)
         $this->setWords($words);
     }
 
-    /**
-     * Complete a word.
-     * Returns null for no word, a full-word or an array of full-words.
-     *
-     * @param string &$prefix Prefix to autocomplete
-     *
-     * @return mixed
-     */
-    public function complete(&$prefix)
+    public function complete(string $prefix, int $index, array $info)
     {
         $out = [];
         $length = \mb_strlen($prefix);
@@ -86,9 +78,6 @@ public function complete(&$prefix)
         return $out;
     }
 
-    /**
-     * Get definition of a word.
-     */
     public function getWordDefinition(): string
     {
         return '\b\w+';

src/Readline/Hoa/ConsoleWindow.php

@@ -120,7 +120,7 @@ public static function getSize(): array
         }
 
         $command = $term.'tput cols && '.$term.'tput lines';
-        $tput = Processus::execute($command, false);
+        $tput = ConsoleProcessus::execute($command, false);
 
         if (!empty($tput)) {
             list($x, $y) = \explode("\n", $tput);

src/Readline/Hoa/Readline.php

@@ -763,7 +763,10 @@ public function _bindTab(self $self): int
             return $state;
         }
 
-        $solution = $autocompleter->complete($word);
+        $solution = $autocompleter->complete($word, $current, [
+            'line_buffer' => $line,
+        ]);
+
         $length = \mb_strlen($word);
 
         if (null === $solution) {

src/Readline/HoaAutocompleterAdapter.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Psy\Readline;
+
+use Psy\Readline\Hoa\Autocompleter as HoaAutocompleter;
+use Psy\TabCompletion\AutoCompleter;
+
+class HoaAutocompleterAdapter implements HoaAutocompleter
+{
+    /** @var AutoCompleter */
+    private $autoCompleter;
+
+    public function __construct(AutoCompleter $autoCompleter)
+    {
+        $this->autoCompleter = $autoCompleter;
+    }
+
+    public function complete(string $prefix, int $index, array $info)
+    {
+        return $this->autoCompleter->complete($prefix, $index, $info);
+    }
+
+    public function getWordDefinition(): string
+    {
+        return '.';
+    }
+}

src/Readline/Readline.php

@@ -11,6 +11,8 @@
 
 namespace Psy\Readline;
 
+use Psy\TabCompletion\AutoCompleter;
+
 /**
  * An interface abstracting the various readline_* functions.
  */
@@ -80,4 +82,14 @@ public function redisplay();
      * @return bool Success
      */
     public function writeHistory(): bool;
+
+    /**
+     * Activete auto completer for tab completion.
+     */
+    public function activateAutoCompleter(AutoCompleter $autoCompleter): void;
+
+    /**
+     * Deactivete auto completer for tab completion.
+     */
+    public function deactivateAutoCompleter(): void;
 }

src/Readline/Transient.php

@@ -12,6 +12,7 @@
 namespace Psy\Readline;
 
 use Psy\Exception\BreakException;
+use Psy\TabCompletion\AutoCompleter;
 
 /**
  * An array-based Readline emulation implementation.
@@ -152,4 +153,14 @@ private function getStdin()
 
         return $this->stdin;
     }
+
+    public function activateAutoCompleter(AutoCompleter $autoCompleter): void
+    {
+        // noop
+    }
+
+    public function deactivateAutoCompleter(): void
+    {
+        // noop
+    }
 }

src/Readline/Userland.php

@@ -19,6 +19,7 @@
 use Psy\Readline\Hoa\ConsoleTput as HoaConsoleTput;
 use Psy\Readline\Hoa\Readline as HoaReadline;
 use Psy\Readline\Hoa\Ustring as HoaUstring;
+use Psy\TabCompletion\AutoCompleter;
 
 /**
  * Userland Readline implementation.
@@ -158,4 +159,14 @@ public function writeHistory(): bool
     {
         return true;
     }
+
+    public function activateAutoCompleter(AutoCompleter $autoCompleter): void
+    {
+        $this->hoaReadline->setAutocompleter(new HoaAutocompleterAdapter($autoCompleter));
+    }
+
+    public function deactivateAutoCompleter(): void
+    {
+        // noop
+    }
 }

src/Shell.php

@@ -1501,7 +1501,7 @@ protected function initializeTabCompletion()
         $this->addMatchersToAutoCompleter($this->getDefaultMatchers());
         $this->addMatchersToAutoCompleter($this->matchers);
 
-        $this->autoCompleter->activate();
+        $this->readline->activateAutoCompleter($this->autoCompleter);
     }
 
     /**