Bugfixes, updated examples

* Added example of using the abort event
* Added setter/getter for allowAbbreviatedCommands
* Fixed SIGINT handling

examples/aborting.php

@@ -0,0 +1,44 @@
+<?php
+
+use NoccyLabs\React\Shell\CommandHandler;
+use React\EventLoop\Loop;
+
+require_once __DIR__."/../vendor/autoload.php";
+
+$operation = new class {
+    public bool $active = false;
+};
+
+$shell = new NoccyLabs\React\Shell\Shell();
+
+// The prompt event is invoked before every full redraw. Call redrawPrompt()
+// to trigger it manually. Set the prompt or the style here.
+$shell->on('prompt', function ($shell) {
+    $shell->setPrompt(">> ");
+});
+
+// Input handler, parse the commands.
+$shell->on('input', function ($args, $shell) use ($operation){
+    switch ($args[0]) {
+        case 'start':
+            $operation->active = true;
+            $shell->write("Operation started... Press Ctrl-C to abort\n");
+            break;
+        default:
+            $shell->write("Type start to start the imaginary operation, then ctrl-c to abort it. Press ctrl-c again to exit.\n");
+    }
+});
+
+// The abort event lets you keep going if a specific operation is the main
+// context. For example, if you are copying a file ^C could stop the copy
+// operation.
+$shell->on('abort', function ($shell) use ($operation) {
+    if ($operation->active == true) {
+        $shell->write("Aborting operation\n");
+        $operation->active = false;
+    } else {
+        $shell->write("Exiting\n");
+        $shell->close();
+    }
+});
+

examples/commands.php

@@ -8,16 +8,39 @@ require_once __DIR__."/../vendor/autoload.php";
 $shell = new NoccyLabs\React\Shell\Shell();
 
 $commands = new CommandHandler();
+// Make it possible to use as few characters as possible as long as they match
+// a single command. For example with the commands foo, bar and baz, foo could
+// be executed with 'f', 'fo', or 'foo', while both bar and baz would require
+// the full name.
+$commands->setAllowAbbreviatedCommands(true);
+// Add commands
 $commands->add('help', function ($args, $shell) {
     $shell->write("This could be usage help :)\n");
-    $shell->write("Exit by pressing ^C\n");
+    $shell->write("Exit by typing quit or pressing ^C\n");
 });
+// This is how you terminate the shell. Obviously, you close it :) Using end()
+// on the shell differs somewhat between ReactPHP; close() will exit with
+// code 0, while end will exit with code 1, and print a friendly message.
+$commands->add('quit', function ($args, $shell) {
+    $shell->close();
+});
+// The command handler gets everything that was not matched. Resolve your own
+// commands here, or print an error.
 $commands->on('command', function ($command, $args, $shell) {
     $shell->write("Bad command '{$command}', try help.\n");
     $shell->write("Arguments passed: ".json_encode($args)."\n");
 });
 
+
+// The prompt event is invoked before every full redraw. Call redrawPrompt()
+// to trigger it manually. Set the prompt or the style here.
 $shell->on('prompt', function ($shell) {
     $shell->setPrompt(">> ");
 });
+// This is where we hook the CommandHandler to the shell.
 $shell->on('input', $commands);
+// And finally, the end event gives you a chance to shut down cleanly. After
+// returning from here, the shell will exit.
+$shell->on('end', function ($shell) {
+    $shell->write("Shutting down...\n");
+});