php-kilo/src/Editor.php

<?php declare(strict_types=1);

namespace Aviat\Kilo;

use Aviat\Kilo\Enum\{Color, KeyCode, KeyType, Highlight};
use Aviat\Kilo\Tokens\PHP8;

/**
 * // Don't highlight this!
 * @property-read int $numRows
 */
class Editor {
	use Traits\MagicProperties;

	private string $outputBuffer = '';

	protected int $cursorX = 0;
	protected int $cursorY = 0;
	protected int $renderX = 0;
	protected int $rowOffset = 0;
	protected int $colOffset = 0;
	protected int $screenRows = 0;
	protected int $screenCols = 0;

	/**
	 * Array of Row objects
	 */
	public array $rows = [];

	public int $dirty = 0;
	public string $filename = '';
	protected string $statusMsg = '';
	protected int $statusMsgTime;

	public ?Syntax $syntax = NULL;

	// Tokens for highlighting PHP
	public array $tokens = [];

	public static function new(): Editor
	{
		return new self();
	}

	private function __construct()
	{
		$this->statusMsgTime = time();

		[$this->screenRows, $this->screenCols] = Terminal::getWindowSize();

		// Remove a row for the status bar, and one for the message bar
		$this->screenRows -= 2;
	}

	public function __get(string $name): ?int
	{
		if ($name === 'numRows')
		{
			return count($this->rows);
		}

		return NULL;
	}

	public function __debugInfo(): array
	{
		return [
			'colOffset' => $this->colOffset,
			'cursorX' => $this->cursorX,
			'cursorY' => $this->cursorY,
			'dirty' => $this->dirty,
			'filename' => $this->filename,
			'renderX' => $this->renderX,
			'rowOffset' => $this->rowOffset,
			'rows' => $this->rows,
			'screenCols' => $this->screenCols,
			'screenRows' => $this->screenRows,
			'statusMsg' => $this->statusMsg,
			'syntax' => $this->syntax,
			'tokens' => $this->tokens,
		];
	}

	// ------------------------------------------------------------------------
	// ! Terminal
	// ------------------------------------------------------------------------
	protected function readKey(): string
	{
		$c = Terminal::read();

		return match($c)
		{
			// Unambiguous mappings
			KeyCode::ARROW_DOWN => KeyType::ARROW_DOWN,
			KeyCode::ARROW_LEFT => KeyType::ARROW_LEFT,
			KeyCode::ARROW_RIGHT => KeyType::ARROW_RIGHT,
			KeyCode::ARROW_UP => KeyType::ARROW_UP,
			KeyCode::DEL_KEY => KeyType::DEL_KEY,
			KeyCode::ENTER => KeyType::ENTER,
			KeyCode::PAGE_DOWN => KeyType::PAGE_DOWN,
			KeyCode::PAGE_UP => KeyType::PAGE_UP,

			// Backspace
			KeyCode::CTRL('h'), KeyCode::BACKSPACE => KeyType::BACKSPACE,

			// Escape
			KeyCode::CTRL('l'), KeyCode::ESCAPE => KeyType::ESCAPE,

			// Home Key
			"\eOH", "\e[7~", "\e[1~", ANSI::RESET_CURSOR => KeyType::HOME_KEY,

			// End Key
			"\eOF", "\e[4~", "\e[8~", "\e[F" => KeyType::END_KEY,

			default => $c,
		};
	}

	protected function selectSyntaxHighlight(): void
	{
		$this->syntax = NULL;
		if (empty($this->filename))
		{
			return;
		}

		// In PHP, `strchr` and `strstr` are the same function
		$ext = (string)strstr(basename($this->filename), '.');

		foreach (get_file_syntax_map() as $syntax)
		{
			if (
				in_array($ext, $syntax->filematch, TRUE) ||
				in_array(basename($this->filename), $syntax->filematch, TRUE)
			) {
				$this->syntax = $syntax;

				// Pre-tokenize the file
				if ($this->syntax->filetype === 'PHP')
				{
					$this->tokens = PHP8::getFileTokens($this->filename);
				}

				$this->refreshSyntax();

				return;
			}
		}
	}

	// ------------------------------------------------------------------------
	// ! Row Operations
	// ------------------------------------------------------------------------

	protected function rowCxToRx(Row $row, int $cx): int
	{
		$rx = 0;
		for ($i = 0; $i < $cx; $i++)
		{
			if ($row->chars[$i] === KeyCode::TAB)
			{
				$rx += (KILO_TAB_STOP - 1) - ($rx % KILO_TAB_STOP);
			}
			$rx++;
		}

		return $rx;
	}

	protected function rowRxToCx(Row $row, int $rx): int
	{
		$cur_rx = 0;
		for ($cx = 0; $cx < $row->size; $cx++)
		{
			if ($row->chars[$cx] === KeyCode::TAB)
			{
				$cur_rx += (KILO_TAB_STOP - 1) - ($cur_rx % KILO_TAB_STOP);
			}
			$cur_rx++;

			if ($cur_rx > $rx)
			{
				return $cx;
			}
		}

		return $cx;
	}

	protected function insertRow(int $at, string $s, bool $updateSyntax = TRUE): void
	{
		if ($at > $this->numRows)
		{
			return;
		}

		$row = Row::new($this, $s, $at);

		if ($at === $this->numRows)
		{
			$this->rows[] = $row;
		}
		else
		{
			$this->rows = [
				...array_slice($this->rows, 0, $at),
				$row,
				...array_slice($this->rows, $at),
			];
		}

		ksort($this->rows);

		$this->rows[$at]->update();

		$this->dirty++;

		// Re-tokenize the file
		if ($updateSyntax)
		{
			$this->refreshPHPSyntax();
		}
	}

	protected function deleteRow(int $at): void
	{
		if ($at < 0 || $at >= $this->numRows)
		{
			return;
		}

		// Remove the row
		unset($this->rows[$at]);

		// Re-index the array of rows
		$this->rows = array_values($this->rows);
		for ($i = $at; $i < $this->numRows; $i++)
		{
			$this->rows[$i]->idx--;
		}

		// Re-tokenize the file
		$this->refreshPHPSyntax();

		$this->dirty++;
	}

	// ------------------------------------------------------------------------
	// ! Editor Operations
	// ------------------------------------------------------------------------

	protected function insertChar(string $c): void
	{
		if ($this->cursorY === $this->numRows)
		{
			$this->insertRow($this->numRows, '');
		}
		$this->rows[$this->cursorY]->insertChar($this->cursorX, $c);

		// Re-tokenize the file
		$this->refreshPHPSyntax();

		$this->cursorX++;
	}

	protected function insertNewline(): void
	{
		// @TODO attempt smart indentation on newline?

		if ($this->cursorX === 0)
		{
			$this->insertRow($this->cursorY, '');
		}
		else
		{
			$row = $this->rows[$this->cursorY];
			$chars = $row->chars;
			$newChars = substr($chars, 0, $this->cursorX);

			// Truncate the previous row
			$row->chars = $newChars;

			// Add a new row, with the contents from the cursor to the end of the line
			$this->insertRow($this->cursorY + 1, substr($chars, $this->cursorX));
		}

		$this->cursorY++;
		$this->cursorX = 0;

		// Re-tokenize the file
		$this->refreshPHPSyntax();
	}

	protected function deleteChar(): void
	{
		if ($this->cursorY === $this->numRows || ($this->cursorX === 0 && $this->cursorY === 0))
		{
			return;
		}

		$row = $this->rows[$this->cursorY];
		if ($this->cursorX > 0)
		{
			$row->deleteChar($this->cursorX - 1);
			$this->cursorX--;
		}
		else
		{
			$this->cursorX = $this->rows[$this->cursorY - 1]->size;
			$this->rows[$this->cursorY -1]->appendString($row->chars);
			$this->deleteRow($this->cursorY);
			$this->cursorY--;
		}

		// Re-tokenize the file
		$this->refreshPHPSyntax();
	}

	// ------------------------------------------------------------------------
	// ! File I/O
	// ------------------------------------------------------------------------

	protected function rowsToString(): string
	{
		$lines = array_map(fn (Row $row) => (string)$row, $this->rows);

		return implode('', $lines);
	}

	public function open(string $filename): void
	{
		// Copy filename for display
		$this->filename = $filename;

		$this->selectSyntaxHighlight();

		$handle = fopen($filename, 'rb');
		if ($handle === FALSE)
		{
			$this->setStatusMessage('Failed to open file: %s', $filename);
			return;
		}

		while (($line = fgets($handle)) !== FALSE)
		{
			// Remove line endings when reading the file
			$this->insertRow($this->numRows, rtrim($line), FALSE);
		}

		fclose($handle);

		$this->dirty = 0;
	}

	protected function save(): void
	{
		if ($this->filename === '')
		{
			$newFilename = $this->prompt('Save as: %s');
			if ($newFilename === '')
			{
				$this->setStatusMessage('Save aborted');
				return;
			}

			$this->filename = $newFilename;
			$this->selectSyntaxHighlight();
		}

		$contents = $this->rowsToString();

		$res = file_put_contents($this->filename, $contents);
		if ($res === strlen($contents))
		{
			$this->setStatusMessage('%d bytes written to disk', strlen($contents));
			$this->dirty = 0;
			return;
		}

		$this->setStatusMessage('Failed to save! I/O error: %s', error_get_last()['message']);
	}

	// ------------------------------------------------------------------------
	// ! Find
	// ------------------------------------------------------------------------

	protected function findCallback(string $query, string $key): void
	{
		static $lastMatch = -1;
		static $direction = 1;

		static $savedHlLine = 0;
		static $savedHl = [];

		if ( ! empty($savedHl))
		{
			$this->rows[$savedHlLine]->hl = $savedHl;
			$savedHl = [];
		}

		switch ($key)
		{
			case KeyCode::ENTER:
			case KeyCode::ESCAPE:
				$lastMatch = -1;
				$direction = 1;
				return;

			case KeyType::ARROW_DOWN:
			case KeyType::ARROW_RIGHT:
				$direction = 1;
			break;

			case KeyType::ARROW_UP:
			case KeyType::ARROW_LEFT:
				$direction = -1;
			break;

			default:
				$lastMatch = -1;
				$direction = 1;
		}

		if ($lastMatch === -1)
		{
			$direction = 1;
		}

		$current = $lastMatch;

		if (empty($query))
		{
			return;
		}

		for ($i = 0; $i < $this->numRows; $i++)
		{
			$current += $direction;
			if ($current === -1)
			{
				$current = $this->numRows - 1;
			}
			else if ($current === $this->numRows)
			{
				$current = 0;
			}

			$row =& $this->rows[$current];

			$match = strpos($row->render, $query);
			if ($match !== FALSE)
			{
				$lastMatch = $current;
				$this->cursorY = (int)$current;
				$this->cursorX = $this->rowRxToCx($row, $match);
				$this->rowOffset = $this->numRows;

				$savedHlLine = $current;
				$savedHl = $row->hl;
				// Update the highlight array of the relevant row with the 'MATCH' type
				array_replace_range($row->hl, $match, strlen($query), Highlight::MATCH);

				break;
			}
		}
	}

	protected function find(): void
	{
		$savedCx = $this->cursorX;
		$savedCy = $this->cursorY;
		$savedColOff = $this->colOffset;
		$savedRowOff = $this->rowOffset;

		$query = $this->prompt('Search: %s (Use ESC/Arrows/Enter)', [$this, 'findCallback']);

		// If they pressed escape, the query will be empty,
		// restore original cursor and scroll locations
		if ($query === '')
		{
			$this->cursorX = $savedCx;
			$this->cursorY = $savedCy;
			$this->colOffset = $savedColOff;
			$this->rowOffset = $savedRowOff;
		}
	}

	// ------------------------------------------------------------------------
	// ! Output
	// ------------------------------------------------------------------------

	protected function scroll(): void
	{
		$this->renderX = 0;
		if ($this->cursorY < $this->numRows)
		{
			$this->renderX = $this->rowCxToRx($this->rows[$this->cursorY], $this->cursorX);
		}

		// Vertical Scrolling
		if ($this->cursorY < $this->rowOffset)
		{
			$this->rowOffset = $this->cursorY;
		}
		if ($this->cursorY >= ($this->rowOffset + $this->screenRows))
		{
			$this->rowOffset = $this->cursorY - $this->screenRows + 1;
		}

		// Horizontal Scrolling
		if ($this->renderX < $this->colOffset)
		{
			$this->colOffset = $this->renderX;
		}
		if ($this->renderX >= ($this->colOffset + $this->screenCols))
		{
			$this->colOffset = $this->renderX - $this->screenCols + 1;
		}
	}

	protected function drawRows(): void
	{
		for ($y = 0; $y < $this->screenRows; $y++)
		{
			$filerow = $y + $this->rowOffset;

			($filerow >= $this->numRows)
				? $this->drawPlaceholderRow($y)
				: $this->drawRow($filerow);

			$this->outputBuffer .= ANSI::CLEAR_LINE;
			$this->outputBuffer .= "\r\n";
		}
	}

	protected function drawRow(int $rowIdx): void
	{
		$len = $this->rows[$rowIdx]->rsize - $this->colOffset;
		if ($len < 0)
		{
			$len = 0;
		}
		if ($len > $this->screenCols)
		{
			$len = $this->screenCols;
		}

		$chars = substr($this->rows[$rowIdx]->render, $this->colOffset, (int)$len);
		$hl = array_slice($this->rows[$rowIdx]->hl, $this->colOffset, (int)$len);

		$currentColor = -1;

		for ($i = 0; $i < $len; $i++)
		{
			$ch = $chars[$i];

			// Handle 'non-printable' characters
			if (is_ctrl($ch))
			{
				$sym = (ord($ch) <= 26)
					? chr(ord('@') + ord($ch))
					: '?';
				$this->outputBuffer .= ANSI::color(Color::INVERT);
				$this->outputBuffer .= $sym;
				$this->outputBuffer .= ANSI::RESET_TEXT;
				if ($currentColor !== -1)
				{
					$this->outputBuffer .= ANSI::color($currentColor);
				}
			}
			else if ($hl[$i] === Highlight::NORMAL)
			{
				if ($currentColor !== -1)
				{
					$this->outputBuffer .= ANSI::RESET_TEXT;
					$this->outputBuffer .= ANSI::color(Color::FG_WHITE);
					$currentColor = -1;
				}
				$this->outputBuffer .= $ch;
			}
			else
			{
				$color = syntax_to_color($hl[$i]);
				if ($color !== $currentColor)
				{
					$currentColor = $color;
					$this->outputBuffer .= ANSI::RESET_TEXT;
					$this->outputBuffer .= ANSI::color($color);
				}
				$this->outputBuffer .= $ch;
			}
		}

		$this->outputBuffer .= ANSI::RESET_TEXT;
		$this->outputBuffer .= ANSI::color(Color::FG_WHITE);
	}

	protected function drawPlaceholderRow(int $y): void
	{
		if ($this->numRows === 0 && $y === (int)($this->screenRows / 2))
		{
			$welcome = sprintf('PHP Kilo editor -- version %s', KILO_VERSION);
			$welcomelen = strlen($welcome);
			if ($welcomelen > $this->screenCols)
			{
				$welcomelen = $this->screenCols;
			}

			$padding = ($this->screenCols - $welcomelen) / 2;
			if ($padding > 0)
			{
				$this->outputBuffer .= '~';
				$padding--;
			}
			for ($i = 0; $i < $padding; $i++)
			{
				$this->outputBuffer .= ' ';
			}

			$this->outputBuffer .= substr($welcome, 0, $welcomelen);
		}
		else
		{
			$this->outputBuffer .= '~';
		}
	}

	protected function drawStatusBar(): void
	{
		$this->outputBuffer .= ANSI::color(Color::INVERT);

		$statusFilename = $this->filename !== '' ? $this->filename : '[No Name]';
		$syntaxType = ($this->syntax !== NULL) ? $this->syntax->filetype : 'no ft';
		$isDirty = ($this->dirty > 0) ? '(modified)' : '';
		$status = sprintf('%.20s - %d lines %s', $statusFilename, $this->numRows, $isDirty);
		$rstatus = sprintf('%s | %d/%d', $syntaxType, $this->cursorY + 1, $this->numRows);
		$len = strlen($status);
		$rlen = strlen($rstatus);
		if ($len > $this->screenCols)
		{
			$len = $this->screenCols;
		}
		$this->outputBuffer .= substr($status, 0, $len);
		while ($len < $this->screenCols)
		{
			if ($this->screenCols - $len === $rlen)
			{
				$this->outputBuffer .= substr($rstatus, 0, $rlen);
				break;
			}

			$this->outputBuffer .= ' ';
			$len++;
		}
		$this->outputBuffer .= ANSI::RESET_TEXT;
		$this->outputBuffer .= "\r\n";
	}

	protected function drawMessageBar(): void
	{
		$this->outputBuffer .= ANSI::CLEAR_LINE;
		$len = strlen($this->statusMsg);
		if ($len > $this->screenCols)
		{
			$len = $this->screenCols;
		}

		if ($len > 0 && (time() - $this->statusMsgTime) < 5)
		{
			$this->outputBuffer .= substr($this->statusMsg, 0, $len);
		}
	}

	public function refreshScreen(): void
	{
		Terminal::clear();

		$this->scroll();

		$this->outputBuffer = '';

		$this->outputBuffer .= ANSI::HIDE_CURSOR;
		$this->outputBuffer .= ANSI::RESET_CURSOR;

		$this->drawRows();
		$this->drawStatusBar();
		$this->drawMessageBar();

		// Specify the current cursor position
		$this->outputBuffer .= ANSI::moveCursor(
			$this->cursorY - $this->rowOffset,
			$this->renderX - $this->colOffset
		);

		$this->outputBuffer .= ANSI::SHOW_CURSOR;

		Terminal::write($this->outputBuffer, strlen($this->outputBuffer));
	}

	public function setStatusMessage(string $fmt, mixed ...$args): void
	{
		$this->statusMsg = (count($args) > 0)
			? sprintf($fmt, ...$args)
			: $fmt;
		$this->statusMsgTime = time();
	}

	// ------------------------------------------------------------------------
	// ! Input
	// ------------------------------------------------------------------------

	protected function prompt(string $prompt, ?callable $callback = NULL): string
	{
		$buffer = '';
		$modifiers = KeyType::getConstList();
		while (TRUE)
		{
			$this->setStatusMessage($prompt, $buffer);
			$this->refreshScreen();

			$c = $this->readKey();
			$isModifier = in_array($c, $modifiers, TRUE);

			if ($c === KeyType::ESCAPE || ($c === KeyType::ENTER && $buffer !== ''))
			{
				$this->setStatusMessage('');
				if ($callback !== NULL)
				{
					$callback($buffer, $c);
				}
				return ($c === KeyType::ENTER) ? $buffer : '';
			}

			if ($c === KeyType::DEL_KEY || $c === KeyType::BACKSPACE)
			{
				$buffer = substr($buffer, 0, -1);
			}
			else if (is_ascii($c) && ( ! (is_ctrl($c) || $isModifier)))
			{
				$buffer .= $c;
			}

			if ($callback !== NULL)
			{
				$callback($buffer, $c);
			}
		}
	}

	protected function moveCursor(string $key): void
	{
		$row = ($this->cursorY >= $this->numRows)
			? NULL
			: $this->rows[$this->cursorY];

		switch ($key)
		{
			case KeyType::ARROW_LEFT:
				if ($this->cursorX !== 0)
				{
					$this->cursorX--;
				}
				else if ($this->cursorY > 0)
				{
					$this->cursorY--;
					$this->cursorX = $this->rows[$this->cursorY]->size;
				}
			break;

			case KeyType::ARROW_RIGHT:
				if ($row && $this->cursorX < $row->size)
				{
					$this->cursorX++;
				}
				else if ($row && $this->cursorX === $row->size)
				{
					$this->cursorY++;
					$this->cursorX = 0;
				}
			break;

			case KeyType::ARROW_UP:
				if ($this->cursorY !== 0)
				{
					$this->cursorY--;
				}
			break;

			case KeyType::ARROW_DOWN:
				if ($this->cursorY < $this->numRows)
				{
					$this->cursorY++;
				}
			break;
		}

		$row = ($this->cursorY >= $this->numRows)
			? NULL
			: $this->rows[$this->cursorY];
		$rowlen = $row->size ?? 0;
		if ($this->cursorX > $rowlen)
		{
			$this->cursorX = $rowlen;
		}
	}

	public function processKeypress(): ?string
	{
		static $quit_times = KILO_QUIT_TIMES;

		$c = $this->readKey();

		if ($c === KeyCode::NULL || $c === KeyCode::EMPTY)
		{
			return '';
		}

		switch ($c)
		{
			case KeyType::ENTER:
				$this->insertNewline();
			break;

			case KeyCode::CTRL('q'):
				if ($this->dirty > 0 && $quit_times > 0)
				{
					$this->setStatusMessage('WARNING!!! File has unsaved changes.' .
						'Press Ctrl-Q %d more times to quit.', $quit_times);
					$quit_times--;
					return '';
				}
				Terminal::clear();

				return NULL;
			break;

			case KeyCode::CTRL('s'):
				$this->save();
			break;

			case KeyType::HOME_KEY:
				$this->cursorX = 0;
			break;

			case KeyType::END_KEY:
				if ($this->cursorY < $this->numRows)
				{
					$this->cursorX = $this->rows[$this->cursorY]->size - 1;
				}
			break;

			case KeyCode::CTRL('f'):
				$this->find();
			break;

			case KeyType::BACKSPACE:
			case KeyType::DEL_KEY:
				if ($c === KeyType::DEL_KEY)
				{
					$this->moveCursor(KeyType::ARROW_RIGHT);
				}
				$this->deleteChar();
			break;

			case KeyType::PAGE_UP:
			case KeyType::PAGE_DOWN:
				$this->pageUpOrDown($c);
			break;

			case KeyType::ARROW_UP:
			case KeyType::ARROW_DOWN:
			case KeyType::ARROW_LEFT:
			case KeyType::ARROW_RIGHT:
				$this->moveCursor($c);
			break;

			case KeyCode::CTRL('l'):
			case KeyType::ESCAPE:
				// Do nothing
			break;

			default:
				$this->insertChar($c);
			break;
		}

		$quit_times = KILO_QUIT_TIMES;

		return $c;
	}

	public function pageUpOrDown(string $c): void
	{
		if ($c === KeyType::PAGE_UP)
		{
			$this->cursorY = $this->rowOffset;
		}
		else if ($c === KeyType::PAGE_DOWN)
		{
			$this->cursorY = $this->rowOffset + $this->screenRows - 1;
			if ($this->cursorY > $this->numRows)
			{
				$this->cursorY = $this->numRows;
			}
		}

		$times = $this->screenRows;
		for (; $times > 0; $times--)
		{
			$this->moveCursor($c === KeyType::PAGE_UP ? KeyType::ARROW_UP : KeyType::ARROW_DOWN);
		}
	}

	protected function refreshSyntax(): void
	{
		// Update the syntax highlighting for all the rows of the file
		array_walk($this->rows, static fn (Row $row) => $row->updateSyntax());
	}

	private function refreshPHPSyntax(): void
	{
		if ($this->syntax?->filetype !== 'PHP')
		{
			return;
		}

		$this->tokens = PHP8::getTokens($this->rowsToString());
		$this->refreshSyntax();
	}
}