Improved the cursor in LineRead when using history

examples/basic.php

@@ -0,0 +1,12 @@
+<?php
+
+require_once __DIR__."/../vendor/autoload.php";
+
+use NoccyLabs\Shell\Shell;
+use NoccyLabs\Shell\Context;
+
+
+$myShell = new Shell();
+$myShell->setPrompt("test>");
+$myShell->pushContext(new Context());
+$myShell->run();

examples/catchall.php

@@ -0,0 +1,20 @@
+<?php
+
+require_once __DIR__."/../vendor/autoload.php";
+
+use NoccyLabs\Shell\Shell;
+use NoccyLabs\Shell\Context;
+
+class CatchAllContext extends Context
+{
+    public function execute($cmd, ...$arg)
+    {
+        printf("Executing: %s %s\n", $cmd, join(" ",$arg));
+        return true;
+    }
+}
+
+$myShell = new Shell();
+$myShell->setPrompt("test>");
+$myShell->pushContext(new CatchAllContext());
+$myShell->run();

examples/simple.php

@@ -20,6 +20,29 @@ class MyContext extends Context
      * @command testme
      * @args
      * @help Useful test!
+     * @global
+     */
+    public function test()
+    {
+        echo "Test\n";
+    }
+
+    /**
+     * @command context
+     * @help Create a new context
+     */
+    public function context()
+    {
+        return new OtherContext("newcontext");
+    }
+}
+
+class OtherContext extends Context
+{
+    /**
+     * @command other
+     * @args
+     * @help Other test
      */
     public function test()
     {

lib/Context.php

@@ -23,6 +23,11 @@ class Context
         $this->configure();
     }
 
+    public function getContextInfo()
+    {
+        return null;
+    }
+
     public function setShell(Shell $shell)
     {
         $this->shell = $shell;
@@ -71,7 +76,7 @@ class Context
             }, explode("\n", $docblock));
             $info = [];
             foreach ($lines as $line) {
-                if (preg_match("/^@(command|help|args) (.+?)$/", $line, $match)) {
+                if (preg_match("/^@(command|help|args|global)\\s*(.*)$/", $line, $match)) {
                     list($void,$key,$value) = $match;
                     $info[$key] = $value; 
                 }
@@ -132,6 +137,32 @@ class Context
         return $ret;
     }
 
+    public function isCommandGlobal($command)
+    {
+        if (strpos($command," ")!==false) {
+            list($command, $void) = explode(" ",$command,2);
+        }
+        $info = $this->commandInfo[$command];
+        return array_key_exists('global', $info);
+    }
+
+    /**
+     * Catch-all handler for commands not defined in context, globally or builtin.
+     * Override this function and return true if the command is handled ok.
+     *
+     * @param string $command The command to execute
+     * @param string[] $args The arguments to the command
+     * @return bool True if the command was handled
+     */
+    public function execute($command, ...$args)
+    {
+        return false;
+    }
+
+    /**
+     * Get the name of the context
+     *
+     */
     public function getName()
     {
         return $this->name;

lib/LineRead.php

@@ -68,7 +68,7 @@ class LineRead
             $this->posCursor = strlen($this->buffer);
         }
 
-        $cursor = strlen($this->prompt) + 1 + $this->posCursor - $this->posScroll;
+        $cursor = strlen($this->prompt) + 2 + $this->posCursor - $this->posScroll;
         
         $endStyle = "\e[0m";
         
@@ -161,22 +161,33 @@ class LineRead
                 if ($this->posHistory == 0) {
                     $this->stashedBuffer = $this->buffer;
                 }
+                if ($this->posCursor == strlen($this->buffer)) {
+                    $this->posCursor = -1;
+                }
                 if ($this->posHistory < count($this->history)) {
                     $this->posHistory++;
                     $this->buffer = $this->history[$this->posHistory-1];
-                    $this->redraw();
                 }
+                if ($this->posCursor == -1) {
+                    $this->posCursor = strlen($this->buffer);
+                }
+                $this->redraw();
                 break;
             case "\e[B": // down
+                if ($this->posCursor == strlen($this->buffer)) {
+                    $this->posCursor = -1;
+                }
                 if ($this->posHistory > 1) {
                     $this->posHistory--;
                     $this->buffer = $this->history[$this->posHistory-1];
-                    $this->redraw();
                 } elseif ($this->posHistory > 0) {
                     $this->posHistory--;
                     $this->buffer = $this->stashedBuffer;
-                    $this->redraw();
                 }
+                if ($this->posCursor == -1) {
+                    $this->posCursor = strlen($this->buffer);
+                }
+                $this->redraw();
                 break;
             default:
                 fprintf(STDERR, "\n%s\n", substr($code,1));

lib/Shell.php

@@ -19,6 +19,8 @@ class Shell
     
     protected $timers = [];
 
+    protected $prompt = ">";
+
     public function __construct()
     {
         $this->configure();
@@ -162,11 +164,12 @@ class Shell
 
     public function setPrompt($text)
     {
-        if (!$this->lineReader) {
+        $this->prompt = $text;
-            return;
+    
-        }
+        if ($this->lineReader) {
             $this->lineReader->setPromptText($text);
         }
+    }
 
     /**
      * Find a command and return a closure.
@@ -176,12 +179,18 @@ class Shell
     private function findCommand($command)
     {
         // Go over current context and walk through stack until finding command
-        foreach(array_merge([ $this->context ] , $this->contextStack) as $context) {
+        if ($this->context->hasCommand($command)) {
-            if ($context->hasCommand($command)) {
+            $handler = $this->context->getCommand($command);
+        } else {
+            foreach($this->contextStack as $context) {
+                if ($context->hasCommand($command) && $context->isCommandGlobal($command)) {
                     $handler = $context->getCommand($command);
                     break;
                 }
             }
+        }
+
+        // No handler...
         if (empty($handler)) {
             return false;
         }
@@ -214,6 +223,12 @@ class Shell
             }
             return;
         }
+
+        // Call 'execute' on the current context
+        if ($this->context->execute($command, ...$args)) {
+            return;
+        }
+
         // Throw error if the command could not be found
         throw new Exception\BadCommandException("Command {$command} not found");
     }
@@ -223,11 +238,11 @@ class Shell
         switch ($command) {
             case '.':
                 $type = basename(strtr(get_class($this->context), "\\", "/"));
-                printf("%s<%s>: %s\n", $type, $this->context->getName(), json_encode($this->context->getData()));
+                printf("%s<%s>: %s\n", $type, $this->context->getName(), $this->context->getContextInfo());
                 $level = 0;
                 foreach ($this->contextStack as $context) {
                     $type = basename(strtr(get_class($context), "\\", "/"));
-                    printf(" %s- %s<%s>\n", str_repeat("  ",$level++), $type, $context->getName());
+                    printf(" %s└─%s<%s>: %s\n", str_repeat("  ",$level++), $type, $context->getName(), $context->getContextInfo());
                 }
                 break;
             case '..':
@@ -236,11 +251,32 @@ class Shell
                 break;
             case 'help':
                 $help = $this->context->getCommandHelp();
-                printf("Commands in current context:\n\n");
+                $ghelp = [];
+                foreach ($this->contextStack as $context) {
+                    $commands = $context->getCommandHelp();
+                    foreach ($commands as $command=>$info) {
+                        if (strpos(" ",$command)!==false) {
+                            list ($cmd,$arg)=explode(" ",$command,2);
+                        } else {
+                            $cmd = $command;
+                        }
+                        if ($context->isCommandGlobal($cmd)) {
+                            $ghelp[$command] = $info;
+                        }
+                    }
+                }
+                ksort($ghelp);
+                printf("Commands in current context:\n");
                 foreach ($help as $command=>$info) {
                     printf("  %-20s  %s\n", $command, $info);
                 }
-                printf("\nGlobal commands:\n\n");
+                if (count($ghelp)) {
+                    printf("\nImported from parent contexts:\n");
+                    foreach ($ghelp as $command=>$info) {
+                        printf("  %-20s  %s\n", $command, $info);
+                    }
+                }
+                printf("\nGlobal commands:\n");
                 printf("  %-20s  %s\n", "exit", "Leave the shell");
                 printf("  %-20s  %s\n", "..", "Discard the current context and go to parent");
                 break;
@@ -287,7 +323,7 @@ class Shell
     {
         $this->lineReader = new LineRead();
 
-        $this->lineReader->setPromptText("shell>");
+        $this->lineReader->setPromptText($this->prompt);
         $this->lineReader->setPromptStyle(new Style(Style::BR_GREEN));
         $this->lineReader->setCommandStyle(new Style(Style::GREEN));