Improve message box config

Author: SerafimArts

src/Api/MessageBox/MessageBoxCreateInfo.php

@@ -7,8 +7,8 @@
 final readonly class MessageBoxCreateInfo
 {
     public function __construct(
-        public string $title,
-        public string $text,
+        public string $title = '',
+        public string $text = '',
         public bool $cancel = false,
         public ?MessageBoxIcon $icon = null,
     ) {}

src/Internal/Poller/SaucerPoller.php

@@ -6,8 +6,10 @@
 
 use Boson\ApplicationId;
 use Boson\Component\Saucer\SaucerInterface;
+use Boson\Poller\CancellableTask;
 use Boson\Poller\PollerInterface;
 use Boson\Poller\Suspension;
+use Boson\Poller\TaskInterface;
 use Boson\Shared\IdValueGenerator\IdValueGeneratorInterface;
 use Boson\Shared\IdValueGenerator\PlatformDependentIntValueGenerator;
 use FFI\CData;
@@ -76,6 +78,9 @@ public function next(): void
                 break;
         }
 
+        // Reduces CPU usage
+        \time_nanosleep(0, 1);
+
         $this->type = $this->type->next();
     }
 
@@ -104,35 +109,35 @@ private function executeQueuedTask(): void
         }
     }
 
-    public function defer(callable $task): int|string
+    public function defer(callable $task): CancellableTask
     {
         $this->queueTasks[$id = $this->ids->nextId()] = $task(...);
 
-        return $id;
+        return new CancellableTask($this, $id);
     }
 
-    public function repeat(callable $task): int|string
+    public function repeat(callable $task): CancellableTask
     {
         $this->periodicTasks[$id = $this->ids->nextId()] = $task(...);
 
-        return $id;
+        return new CancellableTask($this, $id);
     }
 
-    public function delay(float $delay, callable $task): int|string
+    public function delay(float $delay, callable $task): CancellableTask
     {
         $stopsAfter = \microtime(true) + $delay;
 
-        return $this->repeat(function (string|int $taskId) use ($stopsAfter, $task): void {
+        return $this->repeat(function (TaskInterface $id) use ($stopsAfter, $task): void {
             if (\microtime(true) > $stopsAfter) {
-                $task($taskId);
+                $task($id);
 
-                $this->cancel($taskId);
+                $this->cancel($id);
             }
         });
     }
 
-    public function cancel(int|string $taskId): void
+    public function cancel(TaskInterface $task): void
     {
-        unset($this->periodicTasks[$taskId], $this->queueTasks[$taskId]);
+        unset($this->periodicTasks[$task->id], $this->queueTasks[$task->id]);
     }
 }

src/Poller/CancellableTask.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Boson\Poller;
+
+/**
+ * @template TTaskId of array-key = array-key
+ *
+ * @template-implements CancellableTaskInterface<TTaskId>
+ */
+final class CancellableTask implements CancellableTaskInterface, \Stringable
+{
+    public private(set) bool $isCancelled = false;
+
+    public function __construct(
+        /**
+         * @var PollerInterface<TTaskId>
+         */
+        private readonly PollerInterface $parent,
+        /**
+         * @var array-key
+         */
+        public readonly string|int $id,
+    ) {}
+
+    public function cancel(): void
+    {
+        $this->isCancelled = true;
+        $this->parent->cancel($this);
+    }
+
+    public function __toString(): string
+    {
+        return (string) $this->id;
+    }
+}

src/Poller/CancellableTaskInterface.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Boson\Poller;
+
+/**
+ * @template TTaskId of array-key = array-key
+ *
+ * @template-extends TaskInterface<TTaskId>
+ */
+interface CancellableTaskInterface extends TaskInterface
+{
+    /**
+     * Returns {@see true} in case of the task is
+     * cancelled, {@see false} otherwise.
+     */
+    public bool $isCancelled { get; }
+
+    /**
+     * Cancel the task.
+     */
+    public function cancel(): void;
+}

src/Poller/PollerInterface.php

@@ -5,7 +5,7 @@
 namespace Boson\Poller;
 
 /**
- * @phpstan-type TaskIdType array-key
+ * @template TTaskId of array-key = array-key
  */
 interface PollerInterface
 {
@@ -23,43 +23,39 @@ public function createSuspension(): SuspensionInterface;
     /**
      * Defer the execution of a callback.
      *
-     * @param callable(TaskIdType):void $task the callback to defer
+     * @param callable(TaskInterface<TTaskId>):void $task the callback to defer
      *
-     * @return TaskIdType a unique identifier that can be used to cancel
-     *         the callback
+     * @return TaskInterface<TTaskId>
      */
-    public function defer(callable $task): int|string;
+    public function defer(callable $task): TaskInterface;
 
     /**
      * Repeatedly execute a callback.
      *
-     * @param callable(TaskIdType):void $task the callback to execute
+     * @param callable(TaskInterface<TTaskId>):void $task the callback to execute
      *
-     * @return TaskIdType a unique identifier that can be used to cancel
-     *         the callback
+     * @return TaskInterface<TTaskId>
      */
-    public function repeat(callable $task): int|string;
+    public function repeat(callable $task): TaskInterface;
 
     /**
      * Delay the execution of a callback.
      *
      * @param float $delay the amount of time, in seconds, to delay the execution for
-     * @param callable(TaskIdType):void $task the callback to delay
+     * @param callable(TaskInterface<TTaskId>):void $task the callback to delay
      *
-     * @return TaskIdType a unique identifier that can be used to
-     *         cancel the callback
+     * @return TaskInterface<TTaskId>
      */
-    public function delay(float $delay, callable $task): int|string;
+    public function delay(float $delay, callable $task): TaskInterface;
 
     /**
      * Cancel a task.
      *
      * This will detach the event loop from all resources that are associated
      * to the callback. After this operation the callback is permanently
-     * invalid. Calling this function MUST NOT fail, even if passed an invalid
-     * identifier.
+     * invalid.
      *
-     * @param TaskIdType $taskId the callback identifier
+     * @param TaskInterface<TTaskId> $task
      */
-    public function cancel(int|string $taskId): void;
+    public function cancel(TaskInterface $task): void;
 }

src/Poller/TaskInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Boson\Poller;
+
+/**
+ * @template TTaskId of array-key = array-key
+ */
+interface TaskInterface
+{
+    /**
+     * An identifier of the task.
+     *
+     * @var TTaskId
+     */
+    public int|string $id { get; }
+}