update some for terminal op

Author: inhere

README.md

@@ -7,8 +7,8 @@
 
 Provide some useful utils for the php CLI application. 
 
-- Parse CLI arguments and options
-- Console color render
+- Simple CLI arguments and options parser.
+- Terminal console color render
 - CLI code highlighter
 - Build simple CLI application
 - CLI ENV information helper
@@ -33,6 +33,49 @@ echo Color::render('hello world', 'success');
 
 ![colors](example/terminal-color.png)
 
+## Terminal control
+
+examples:
+
+```php
+use \Toolkit\Cli\Util\Terminal;
+
+Terminal::forward(3);
+Terminal::backward(2);
+
+Terminal::clearLine();
+
+Terminal::clearScreen();
+```
+
+### Control Methods
+
+```php
+/**
+ * @method static showCursor()
+ * @method static hideCursor()
+ * @method static savePosition()
+ * @method static restorePosition()
+ * @method static toTop()
+ * @method static toColumn(int $step)
+ * @method static up(int $step = 1)
+ * @method static down(int $step = 1)
+ * @method static forward(int $step = 1)
+ * @method static backward(int $step = 1) Moves the terminal cursor backward
+ * @method static toPrevNLineStart(int $step = 1)
+ * @method static toNextNLineStart(int $step = 1)
+ * @method static coordinate(int $col, int $row = 0)
+ * @method static clearScreen()
+ * @method static clearLine()
+ * @method static clearToScreenBegin()
+ * @method static clearToScreenEnd()
+ * @method static scrollUp(int $step = 1)
+ * @method static scrollDown(int $step = 1)
+ * @method static showSecondaryScreen()
+ * @method static showPrimaryScreen()
+ */
+```
+
 ## PHP file highlight
 
 > This is inspire `jakub-onderka/php-console-highlighter`
@@ -173,6 +216,10 @@ $down->start();
 
 - https://github.com/inhere/php-console Build rich console application
 
+## Refer
+
+- https://www.sitepoint.com/howd-they-do-it-phpsnake-detecting-keypresses/
+
 ## License
 
 [MIT](LICENSE)

composer.json

@@ -22,7 +22,9 @@
     "php": ">7.1.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5"
+    "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5",
+    "ext-posix": "*",
+    "ext-readline": "*"
   },
   "autoload": {
     "psr-4": {

example/keyboard.php

@@ -0,0 +1,21 @@
+<?php
+
+
+function test_run()
+{
+    echo "Hello, I am snake!";
+
+    system('stty cbreak -echo');
+    $stdin = fopen('php://stdin', 'rb');
+
+    while (1) {
+        $c = ord(fgetc($stdin));
+
+        echo "Char read: $c\n";
+    }
+}
+
+require dirname(__DIR__) . '/test/bootstrap.php';
+
+test_run();
+

example/term_move.php

@@ -0,0 +1,69 @@
+<?php
+
+class TermMove {
+
+    const KEYS = [
+        10  => 'enter',
+        127 => 'backspace',
+        65  => 'up',
+        66  => 'down',
+        67  => 'right',
+        68  => 'left',
+        9   => 'tab'
+    ];
+
+    public function readChar() : string
+    {
+        $c = $this->char();
+
+        var_dump($c);
+        $last = '';
+        foreach (str_split($c) as $one) {
+            var_dump($one . ' => num: ' . ord($one));
+
+            $last = $one;
+        }
+
+        // var_dump($c);
+        if (ctype_print($last)) {
+            return $last;
+        }
+
+        $n = ord($last);
+        if (
+            array_key_exists($n, static::KEYS)
+            && in_array(static::KEYS[$n], ['enter', 'backspace'])
+        ) {
+            return static::KEYS[$n];
+        }
+
+        return '';
+    }
+
+    public function char() : string
+    {
+        // return fread(STDIN, 4);
+
+        if (DIRECTORY_SEPARATOR === "\\") {
+            $c = stream_get_contents(STDIN, 1);
+
+            return $c;
+        }
+
+        readline_callback_handler_install('', function() {});
+        // $c = $this->read(1);
+        // $c = fread(STDIN, 4);
+        $c = stream_get_contents(STDIN, 4);
+        // $c = readline();
+        readline_callback_handler_remove();
+        return $c;
+    }
+}
+
+require dirname(__DIR__) . '/test/bootstrap.php';
+
+$tm = new TermMove();
+
+echo "please input:";
+$c = $tm->readChar();
+echo "CHAR: $c\n";

src/Util/Keyboard.php

@@ -0,0 +1,38 @@
+<?php declare(strict_types=1);
+
+
+namespace Toolkit\Cli\Util;
+
+/**
+ * Class Keyboard
+ *
+ * @package Toolkit\Cli\Util
+ */
+class Keyboard
+{
+    /**
+     * @var self
+     */
+    private static $global;
+
+    /**
+     * @return static
+     */
+    public static function global(): self
+    {
+        if (!self::$global) {
+            self::$global = new self;
+        }
+
+        return self::$global;
+    }
+
+    /**
+     * @return static
+     */
+    public static function new(): self
+    {
+        return new self;
+    }
+
+}

src/Util/Readline.php

@@ -109,7 +109,7 @@ public static function removeHandler(): bool
     /**
      * Reads a character and informs the readline callback interface when a line is received
      */
-    public static function readChar(): void
+    public static function callbackReadChar(): void
     {
         // 当一个行被接收时读取一个字符并且通知 readline 调用回调函数
         readline_callback_read_char();