Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
7bfd8453e7 | |||
482d8a54e5 | |||
b2a23f992d | |||
455574b6a5 |
12
examples/basic.php
Normal file
12
examples/basic.php
Normal 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();
|
@ -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()
|
||||
{
|
||||
|
@ -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,15 @@ 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);
|
||||
}
|
||||
|
||||
public function getName()
|
||||
{
|
||||
return $this->name;
|
||||
|
@ -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";
|
||||
|
||||
|
@ -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) {
|
||||
return;
|
||||
}
|
||||
$this->prompt = $text;
|
||||
|
||||
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 ($context->hasCommand($command)) {
|
||||
if ($this->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;
|
||||
}
|
||||
@ -223,11 +232,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 +245,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 +317,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));
|
||||
|
||||
|
Reference in New Issue
Block a user