4 Commits

5 changed files with 98 additions and 19 deletions

12
examples/basic.php Normal file
View File

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

View File

@ -20,6 +20,29 @@ class MyContext extends Context
* @command testme * @command testme
* @args * @args
* @help Useful test! * @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() public function test()
{ {

View File

@ -23,6 +23,11 @@ class Context
$this->configure(); $this->configure();
} }
public function getContextInfo()
{
return null;
}
public function setShell(Shell $shell) public function setShell(Shell $shell)
{ {
$this->shell = $shell; $this->shell = $shell;
@ -71,7 +76,7 @@ class Context
}, explode("\n", $docblock)); }, explode("\n", $docblock));
$info = []; $info = [];
foreach ($lines as $line) { 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; list($void,$key,$value) = $match;
$info[$key] = $value; $info[$key] = $value;
} }
@ -132,6 +137,15 @@ class Context
return $ret; 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);
}
public function getName() public function getName()
{ {
return $this->name; return $this->name;

View File

@ -68,11 +68,11 @@ class LineRead
$this->posCursor = strlen($this->buffer); $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"; $endStyle = "\e[0m";
fprintf(STDOUT, "\r\e[2K%s%s\e[%dG{$endStyle}", ($this->promptStyle)($prompt), ($this->commandStyle)($buffer), $cursor); fprintf(STDOUT, "\r\e[2K%s %s\e[%dG{$endStyle}", ($this->promptStyle)($prompt), ($this->commandStyle)($buffer), $cursor);
} }
protected function styleToAnsi($style) protected function styleToAnsi($style)

View File

@ -19,6 +19,8 @@ class Shell
protected $timers = []; protected $timers = [];
protected $prompt = ">";
public function __construct() public function __construct()
{ {
$this->configure(); $this->configure();
@ -162,10 +164,11 @@ class Shell
public function setPrompt($text) public function setPrompt($text)
{ {
if (!$this->lineReader) { $this->prompt = $text;
return;
if ($this->lineReader) {
$this->lineReader->setPromptText($text);
} }
$this->lineReader->setPromptText($text);
} }
/** /**
@ -176,12 +179,18 @@ class Shell
private function findCommand($command) private function findCommand($command)
{ {
// Go over current context and walk through stack until finding 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);
$handler = $context->getCommand($command); } else {
break; foreach($this->contextStack as $context) {
if ($context->hasCommand($command) && $context->isCommandGlobal($command)) {
$handler = $context->getCommand($command);
break;
}
} }
} }
// No handler...
if (empty($handler)) { if (empty($handler)) {
return false; return false;
} }
@ -223,11 +232,11 @@ class Shell
switch ($command) { switch ($command) {
case '.': case '.':
$type = basename(strtr(get_class($this->context), "\\", "/")); $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; $level = 0;
foreach ($this->contextStack as $context) { foreach ($this->contextStack as $context) {
$type = basename(strtr(get_class($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; break;
case '..': case '..':
@ -236,13 +245,34 @@ class Shell
break; break;
case 'help': case 'help':
$help = $this->context->getCommandHelp(); $help = $this->context->getCommandHelp();
printf("Commands in current context:\n\n"); $ghelp = [];
foreach ($help as $command=>$info) { foreach ($this->contextStack as $context) {
printf(" %-20s %s\n", $command, $info); $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;
}
}
} }
printf("\nGlobal commands:\n\n"); ksort($ghelp);
printf(" %-20s %s\n", "exit", "Leave the shell"); printf("Commands in current context:\n");
printf(" %-20s %s\n", "..", "Discard the current context and go to parent"); foreach ($help as $command=>$info) {
printf(" %-20s %s\n", $command, $info);
}
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; break;
case 'exit': case 'exit':
$this->stop(); $this->stop();
@ -287,7 +317,7 @@ class Shell
{ {
$this->lineReader = new LineRead(); $this->lineReader = new LineRead();
$this->lineReader->setPromptText("shell>"); $this->lineReader->setPromptText($this->prompt);
$this->lineReader->setPromptStyle(new Style(Style::BR_GREEN)); $this->lineReader->setPromptStyle(new Style(Style::BR_GREEN));
$this->lineReader->setCommandStyle(new Style(Style::GREEN)); $this->lineReader->setCommandStyle(new Style(Style::GREEN));