4 Commits

7 changed files with 149 additions and 50 deletions

View File

@ -0,0 +1,12 @@
NoccyLabs Shell Core
====================
This library helps make elegant command line applications that spawn an isolated shell.
It uses a standalone implementation for buffered input with support for arrow keys to
navigate the history and more.
Note that this library requirements a fully ANSI compatible terminal with UTF-8 support
in order to use colors, control the cursor position etc. As it uses `stty` to configure
input buffering, it will likely not work on Windows.

20
examples/catchall.php Normal file
View File

@ -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();

19
examples/errors.php Normal file
View File

@ -0,0 +1,19 @@
<?php
require_once __DIR__."/../vendor/autoload.php";
use NoccyLabs\Shell\Shell;
use NoccyLabs\Shell\Context;
class CatchAllContext extends Context
{
public function execute($cmd, ...$arg)
{
throw new \Exception("Uh-oh! Error!");
}
}
$myShell = new Shell();
$myShell->setPrompt("test>");
$myShell->pushContext(new CatchAllContext());
$myShell->run();

View File

@ -30,9 +30,15 @@ class MyShell extends Shell
$this->pushContext($context); $this->pushContext($context);
$this->updatePrompt(); $this->updatePrompt();
$this->addTimer(5000, function () { $t1 = $this->addTimer(5000, function () {
echo "5 seconds\n"; echo "5 seconds\n";
}); });
$app = $this;
$t2 = $this->addTimer(15000, function () use ($t1, $app) {
echo "Removing timers...\n";
$app->removeTimer($t1);
});
} }
protected function updatePrompt() protected function updatePrompt()

View File

@ -146,6 +146,23 @@ class Context
return array_key_exists('global', $info); 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() public function getName()
{ {
return $this->name; return $this->name;

View File

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

View File

@ -137,6 +137,7 @@ class Shell
private $userdata; private $userdata;
public function __construct($interval, callable $handler, array $userdata) { public function __construct($interval, callable $handler, array $userdata) {
$this->interval = $interval / 1000; $this->interval = $interval / 1000;
$this->next = microtime(true) + $this->interval;
$this->handler = $handler; $this->handler = $handler;
$this->userdata = $userdata; $this->userdata = $userdata;
} }
@ -157,9 +158,11 @@ class Shell
* *
* @param Timer $timer * @param Timer $timer
*/ */
public function removeTimer(Timer $timer) public function removeTimer($timer)
{ {
$this->timers = array_filter($this->timers, function ($v) use ($timer) {
return ($v !== $timer);
});
} }
public function setPrompt($text) public function setPrompt($text)
@ -223,6 +226,12 @@ class Shell
} }
return; return;
} }
// Call 'execute' on the current context
if ($this->context->execute($command, ...$args)) {
return;
}
// Throw error if the command could not be found // Throw error if the command could not be found
throw new Exception\BadCommandException("Command {$command} not found"); throw new Exception\BadCommandException("Command {$command} not found");
} }
@ -315,6 +324,7 @@ class Shell
public function run() public function run()
{ {
try {
$this->lineReader = new LineRead(); $this->lineReader = new LineRead();
$this->lineReader->setPromptText($this->prompt); $this->lineReader->setPromptText($this->prompt);
@ -368,6 +378,10 @@ class Shell
} }
} }
} catch (\Exception $e) {
fprintf(STDERR, "\e[31;1mFatal: Unhandled exception\e[0m\n\n%s\n", $e);
}
$this->lineReader = null; $this->lineReader = null;
} }