Fix screen rendering issues (#70)

A massive amount of work to make rendering more consistent. 

---------

Co-authored-by: aarondfrancis <[email protected]>
Co-authored-by: Hambrook <[email protected]>

Author: aarondfrancis

README.md

@@ -214,11 +214,11 @@ I wouldn't! Use supervisor or similar tools for production environments.
 
 This is free! If you want to support me:
 
+- Sponsor my open source work: [aaronfrancis.com/backstage](https://aaronfrancis.com/backstage)
 - Check out my courses:
     - [Mastering Postgres](https://masteringpostgres.com)
     - [High Performance SQLite](https://highperformancesqlite.com)
     - [Screencasting](https://screencasting.com)
-- Share them with friends
 - Help spread the word about things I make
 
 ## Credits

composer.json

@@ -18,7 +18,8 @@
         "ext-pcntl": "*",
         "ext-posix": "*",
         "laravel/prompts": "^0.1.21|^0.2|^0.3",
-        "joetannenbaum/chewie": "^0.1"
+        "joetannenbaum/chewie": "^0.1",
+        "soloterm/grapheme": "^1"
     },
     "require-dev": {
         "illuminate/database": "^10|^11|^12",
@@ -32,8 +33,6 @@
         }
     },
     "autoload-dev": {
-        "files": [
-        ],
         "psr-4": {
             "SoloTerm\\Solo\\Tests\\": "tests/",
             "App\\": "workbench/app/"

home-end.log

@@ -7,18 +7,14 @@
  * @link https://x.com/aarondfrancis
  */
 
-namespace SoloTerm\Solo\Support;
+namespace SoloTerm\Solo\Buffers;
 
 use InvalidArgumentException;
 use RuntimeException;
 
-class AnsiTracker
+class AnsiBuffer extends Buffer
 {
-    /**
-     * The buffer that stores ANSI codes for each cell as either a pure integer
-     * or as an array, if there are extended foreground and backgrounds.
-     */
-    public Buffer $buffer;
+    protected mixed $valueForClearing = 0;
 
     /**
      * The active integer bitmask representing current standard ANSI
@@ -92,7 +88,7 @@ class AnsiTracker
         9 => 29,
     ];
 
-    public function __construct()
+    public function initialize()
     {
         if (PHP_INT_SIZE < 8) {
             throw new RuntimeException(static::class . ' requires a 64-bit PHP environment.');
@@ -119,9 +115,6 @@ public function __construct()
 
             return $carry;
         }, []);
-
-        // This buffer uses integers and arrays to keep track of active ANSI codes.
-        $this->buffer = new Buffer(usesStrings: false);
     }
 
     /**
@@ -144,7 +137,7 @@ protected function cellValue(): int|array
 
     public function fillBufferWithActiveFlags(int $row, int $startCol, int $endCol): void
     {
-        $this->buffer->fill($this->cellValue(), $row, $startCol, $endCol);
+        $this->fill($this->cellValue(), $row, $startCol, $endCol);
     }
 
     public function getActive(): int
@@ -157,9 +150,27 @@ public function getActiveAsAnsi(): string
         return $this->ansiStringFromBits($this->active);
     }
 
+    public function getActiveBackground(): array|int
+    {
+        // If we have an extended background (256-color or RGB), that counts as "active"
+        if ($this->extendedBackground !== null) {
+            return $this->extendedBackground;
+        }
+
+        // Build a bitmask that represents all possible background codes.
+        // Then see if any of those bits are set in $this->active.
+        $backgroundBitmask = 0;
+        foreach ($this->background as $code) {
+            $backgroundBitmask |= $this->codes[$code];
+        }
+
+        // If any background bits are set, this expression will be non-zero.
+        return $this->active & $backgroundBitmask;
+    }
+
     public function compressedAnsiBuffer(): array
     {
-        $lines = $this->buffer->getBuffer();
+        $lines = $this->buffer;
 
         return array_map(function ($line) {
             // We reset the previous cell on every single line, because we're not guaranteed that the

src/Support/AnsiTracker.php renamed to src/Buffers/AnsiBuffer.php

@@ -7,7 +7,7 @@
  * @link https://x.com/aarondfrancis
  */
 
-namespace SoloTerm\Solo\Support;
+namespace SoloTerm\Solo\Buffers;
 
 use ArrayAccess;
 use ReturnTypeWillChange;
@@ -16,9 +16,13 @@ class Buffer implements ArrayAccess
 {
     public array $buffer = [];
 
-    public function __construct(public bool $usesStrings = false, public int $max = 5000)
+    protected mixed $valueForClearing = 0;
+
+    public function __construct(public int $max = 5000)
     {
-        //
+        if (method_exists($this, 'initialize')) {
+            $this->initialize();
+        }
     }
 
     public function getBuffer()
@@ -53,27 +57,22 @@ public function clear(
             if ($cols[0] === 0 && $cols[1] === $length) {
                 // Clearing an entire line. Benchmarked slightly
                 // faster to just replace the entire row.
-                $this->buffer[$row] = $this->usesStrings ? '' : [];
+                $this->buffer[$row] = [];
             } elseif ($cols[0] > 0 && $cols[1] === $length) {
                 // Clearing from cols[0] to the end of the line.
-                $this->buffer[$row] = $this->usesStrings
-                    // Chop off the end of the string.
-                    ? mb_substr($line, 0, $cols[0], 'UTF-8')
-                    // Chop off the end of the array.
-                    : array_slice($line, 0, $cols[0]);
+                // Chop off the end of the array.
+                $this->buffer[$row] = array_slice($line, 0, $cols[0]);
             } else {
-                // Clearing the middle of a row. Fill with either 0s or spaces.
-                $this->fill(
-                    ($this->usesStrings ? ' ' : 0), $row, $cols[0], $cols[1]
-                );
+                // Clearing the middle of a row. Fill with the replacement value.
+                $this->fill($this->valueForClearing, $row, $cols[0], $cols[1]);
             }
         }
     }
 
     public function expand($rows)
     {
         while (count($this->buffer) <= $rows) {
-            $this->buffer[] = $this->usesStrings ? '' : [];
+            $this->buffer[] = [];
         }
     }
 
@@ -83,26 +82,16 @@ public function fill(mixed $value, int $row, int $startCol, int $endCol)
 
         $line = $this->buffer[$row];
 
-        if ($this->usesStrings) {
-            $replacement = str_repeat($value, $endCol - $startCol + 1);
-            $beforeStart = mb_substr($line, 0, $startCol, 'UTF-8');
-            $afterEnd = mb_substr($line, $endCol + 1, null, 'UTF-8');
-
-            $this->buffer[$row] = $beforeStart . $replacement . $afterEnd;
-        } else {
-            $this->buffer[$row] = array_replace(
-                $line, array_fill_keys(range($startCol, $endCol), $value)
-            );
-        }
+        $this->buffer[$row] = array_replace(
+            $line, array_fill_keys(range($startCol, $endCol), $value)
+        );
 
         $this->trim();
     }
 
     public function rowMax($row)
     {
-        $line = $this->buffer[$row];
-
-        return $this->usesStrings ? mb_strlen($line, 'UTF-8') : count($line) - 1;
+        return count($this->buffer[$row]) - 1;
     }
 
     public function trim()
@@ -119,7 +108,7 @@ public function trim()
         if ($excess > 0) {
             $keys = array_keys($this->buffer);
             $remove = array_slice($keys, 0, $excess);
-            $nulls = array_fill_keys($remove, $this->usesStrings ? '' : []);
+            $nulls = array_fill_keys($remove, []);
 
             $this->buffer = array_replace($this->buffer, $nulls);
         }

src/Support/Buffer.php renamed to src/Buffers/Buffer.php

@@ -0,0 +1,133 @@
+<?php
+
+namespace SoloTerm\Solo\Buffers;
+
+use Exception;
+use SoloTerm\Grapheme\Grapheme;
+
+class PrintableBuffer extends Buffer
+{
+    public int $width;
+
+    protected mixed $valueForClearing = ' ';
+
+    public function setWidth(int $width): static
+    {
+        $this->width = $width;
+
+        return $this;
+    }
+
+    /**
+     * Writes a string into the buffer at the specified row and starting column.
+     * The string is split into "units" (either single characters or grapheme clusters),
+     * and each unit is inserted into one or more cells based on its display width.
+     * If a unit has width > 1, its first cell gets the unit, and the remaining cells are set to PHP null.
+     *
+     * If the text overflows the available width on that row, the function stops writing and returns
+     * an array containing the number of columns advanced and a string of the remaining characters.
+     *
+     * @param  int  $row  Row index (0-based).
+     * @param  int  $col  Starting column index (0-based).
+     * @param  string  $text  The text to write.
+     * @return array [$advanceCursor, $remainder]
+     *
+     * @throws Exception if splitting into graphemes fails.
+     */
+    public function writeString(int $row, int $col, string $text): array
+    {
+        // Determine the units to iterate over: if the text is ASCII-only, we can split by character,
+        // otherwise we split into grapheme clusters.
+        if (strlen($text) === mb_strlen($text)) {
+            $units = str_split($text);
+        } else {
+            if (preg_match_all('/\X/u', $text, $matches) === false) {
+                throw new Exception('Error splitting text into grapheme clusters.');
+            }
+
+            $units = $matches[0];
+        }
+
+        $currentCol = $col;
+        $advanceCursor = 0;
+        $totalUnits = count($units);
+
+        // Ensure that the row is not sparse.
+        // If the row already exists, fill any missing indices before the starting column with a space.
+        // Otherwise, initialize the row and fill indices 0 through $col-1 with spaces.
+        if (!isset($this->buffer[$row])) {
+            $this->buffer[$row] = [];
+        }
+
+        for ($i = 0; $i < $col; $i++) {
+            if (!array_key_exists($i, $this->buffer[$row])) {
+                $this->buffer[$row][$i] = ' ';
+            }
+        }
+
+        // Make sure we don't splice a wide character.
+        if (array_key_exists($col, $this->buffer[$row]) && $this->buffer[$row][$col] === null) {
+            for ($i = $col; $i >= 0; $i--) {
+                // Replace null values with a space.
+                if (!isset($this->buffer[$row][$i]) || $this->buffer[$row][$i] === null) {
+                    $this->buffer[$row][$i] = ' ';
+                } else {
+                    // Also replace the first non-null value with a space, then exit.
+                    $this->buffer[$row][$i] = ' ';
+                    break;
+                }
+            }
+        }
+
+        for ($i = 0; $i < $totalUnits; $i++) {
+            $unit = $units[$i];
+
+            // Check if the unit is a tab character.
+            if ($unit === "\t") {
+                // Calculate tab width as the number of spaces needed to reach the next tab stop.
+                $unitWidth = 8 - ($currentCol % 8);
+            } else {
+                $unitWidth = Grapheme::wcwidth($unit);
+            }
+
+            // If adding this unit would overflow the available width, break out.
+            if ($currentCol + $unitWidth > $this->width) {
+                break;
+            }
+
+            // Write the unit into the first cell.
+            $this->buffer[$row][$currentCol] = $unit;
+
+            // Fill any additional columns that the unit occupies with PHP null.
+            for ($j = 1; $j < $unitWidth; $j++) {
+                if (($currentCol + $j) < $this->width) {
+                    $this->buffer[$row][$currentCol + $j] = null;
+                }
+            }
+
+            $currentCol += $unitWidth;
+
+            // Clear out any leftover continuation nulls
+            if (array_key_exists($currentCol, $this->buffer[$row]) && $this->buffer[$row][$currentCol] === null) {
+                $k = $currentCol;
+
+                while (array_key_exists($k, $this->buffer[$row]) && $this->buffer[$row][$k] === null) {
+                    $this->buffer[$row][$k] = ' ';
+                    $k++;
+                }
+            }
+
+            $advanceCursor += $unitWidth;
+        }
+
+        // The remainder is the unprocessed units joined back into a string.
+        $remainder = implode('', array_slice($units, $i));
+
+        return [$advanceCursor, $remainder];
+    }
+
+    public function lines(): array
+    {
+        return array_map(fn($line) => implode('', $line), $this->buffer);
+    }
+}

src/Buffers/PrintableBuffer.php

@@ -12,6 +12,7 @@
 use Chewie\Concerns\Ticks;
 use Chewie\Contracts\Loopable;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
 use SoloTerm\Solo\Commands\Concerns\ManagesProcess;
 use SoloTerm\Solo\Hotkeys\Hotkey;
 use SoloTerm\Solo\Hotkeys\KeyHandler;
@@ -168,13 +169,13 @@ public function isInteractive(): bool
     */
     public function dd()
     {
-        $this->wrappedLines()->dd();
-        exit();
+        dd($this->screen->printable->buffer);
     }
 
     public function addOutput($text)
     {
-        $text = str_replace('[screen is terminating]', '', $text);
+        $text = Str::before($text, $this->outputEndMarker);
+        $text = Str::after($text, $this->outputStartMarker);
 
         $this->screen->write($text);
     }