Add character-by-character autocompletion

Fix autocomplete code. This is proof of concept for now Move functions inside of DialogHelper class Fix syntax errors Fix half-completed text not being returned from DialogHelper::ask when return key is pressed Handle arrow keys (ignore for now) Fallback if lacking colour support User $output->write instead of echo/printf Lose escape character constant Cleanup/minor refactor

Author: lmcd

src/Symfony/Component/Console/Helper/DialogHelper.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\Console\Helper;
 
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Output\StreamOutput;
 
 /**
  * The Dialog class provides helpers to interact with the user.
@@ -31,15 +32,102 @@ class DialogHelper extends Helper
  *
  * @return string The user answer
  */
- public function ask(OutputInterface $output, $question, $default = null)
+ public function ask(OutputInterface $output, $question, $default = null, $autocomplete = null)
  {
  $output->write($question);
 
- $ret = fgets($this->inputStream ?: STDIN, 4096);
- if (false === $ret) {
- throw new \RuntimeException('Aborted');
+ $inputStream = (null === $this->inputStream ? STDIN : $this->inputStream);
+
+ if (null === $autocomplete || !($output instanceof StreamOutput && $output->hasColorSupport())) {
+ $ret = fgets($inputStream);
+ if (false === $ret) {
+ throw new \RuntimeException('Aborted');
+ }
+ $ret = trim($ret);
+ } else {
+ $i = 0;
+ $currentMatched = false;
+ $ret = '';
+
+ // Disable icanon (so we can fread each keypress) and echo (we'll do echoing here instead)
+ system("stty -icanon -echo");
+
+ while ($c = fread($inputStream, 3)) {
+ // Did we read an escape character?
+ if (strlen($c) > 1 && $c[0] == "\033") {
+ // Escape sequences for arrow keys
+ if ($c[2] == 'A' || $c[2] == 'B' || $c[2] == 'C' || $c[2] == 'D') {
+ continue;
+ }
+ }
+
+ // Backspace Character
+ if (ord($c) == 127) {
+ if ($i == 0) {
+ continue;
+ }
+
+ // Move cursor backwards
+ $output->write("\033[1D");
+ // Erase characters from cursor to end of line
+ $output->write("\033[K");
+ $ret = substr($ret, 0, --$i);
+
+ continue;
+ }
+
+ if ($c == "\t" | $c == "\n") {
+ if (false !== $currentMatched) {
+ // Echo out completed match
+ $output->write(substr($autocomplete[$currentMatched], strlen($ret)));
+ $ret = $autocomplete[$currentMatched];
+ $i = strlen($ret);
+ }
+
+ if ($c == "\n") {
+ $output->write($c);
+ break;
+ }
+
+ continue;
+ }
+
+ $output->write($c);
+ $ret .= $c;
+ $i++;
+
+ $lastMatch = $currentMatched;
+
+ // Erase characters from cursor to end of line
+ $output->write("\033[K");
+
+ for ($j = 0; $j < count($autocomplete); $j++) {
+ $matchTest = substr($autocomplete[$j], 0, strlen($ret));
+
+ if ($ret == $matchTest) {
+ // Save cursor position
+ $output->write("\0337");
+
+ // Set fore/background colour to make text appear highlighted
+ $output->write("\033[47;30m");
+ $output->write(substr($autocomplete[$j], strlen($ret)));
+ // Reset text colour
+ $output->write("\033[0m");
+
+ // Restore cursor position
+ $output->write("\0338");
+
+ $currentMatched = $j;
+ break;
+ }
+
+ $currentMatched = false;
+ }
+ }
+
+ // Reset stty so it behaves normally again
+ system("stty icanon echo");
  }
- $ret = trim($ret);
 
  return strlen($ret) > 0 ? $ret : $default;
  }
@@ -78,23 +166,24 @@ public function askConfirmation(OutputInterface $output, $question, $default = t
  *
  * @param OutputInterface $output
  * @param string|array $question
- * @param callback $validator A PHP callback
- * @param integer $attempts Max number of times to ask before giving up (false by default, which means infinite)
- * @param string $default The default answer if none is given by the user
+ * @param callback $validator A PHP callback
+ * @param integer $attempts Max number of times to ask before giving up (false by default, which means infinite)
+ * @param string $default The default answer if none is given by the user
+ * @param array $autoComplete
  *
  * @return mixed
  *
  * @throws \Exception When any of the validator returns an error
  */
- public function askAndValidate(OutputInterface $output, $question, $validator, $attempts = false, $default = null)
+ public function askAndValidate(OutputInterface $output, $question, $validator, $attempts = false, $default = null, $autocomplete = null)
  {
  $error = null;
  while (false === $attempts || $attempts--) {
  if (null !== $error) {
  $output->writeln($this->getHelperSet()->get('formatter')->formatBlock($error->getMessage(), 'error'));
  }
 
- $value = $this->ask($output, $question, $default);
+ $value = $this->ask($output, $question, $default, $autocomplete);
 
  try {
  return call_user_func($validator, $value);

src/Symfony/Component/Console/Output/StreamOutput.php

@@ -100,7 +100,7 @@ public function doWrite($message, $newline)
  *
  * @return Boolean true if the stream supports colorization, false otherwise
  */
- protected function hasColorSupport()
+ public function hasColorSupport()
  {
  // @codeCoverageIgnoreStart
  if (DIRECTORY_SEPARATOR == '\\') {