<?php

/*
 *
 *  ____            _        _   __  __ _                  __  __ ____
 * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
 * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
 * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
 * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * @author PocketMine Team
 * @link http://www.pocketmine.net/
 *
 *
 */

declare(strict_types=1);

namespace pocketmine\block\utils;

use pocketmine\color\Color;
use pocketmine\utils\Utils;
use function array_fill;
use function array_pad;
use function array_slice;
use function count;
use function explode;
use function is_int;
use function str_contains;

class SignText{
	public const LINE_COUNT = 4;

	/**
	 * @var string[]
	 * @phpstan-var array{0: string, 1: string, 2: string, 3: string}
	 */
	private array $lines;
	private Color $baseColor;
	private bool $glowing;

	/**
	 * @param string[]|null $lines index-sensitive; keys 0-3 will be used, regardless of array order
	 * @phpstan-param array{0?: string, 1?: string, 2?: string, 3?: string}|null $lines
	 *
	 * @throws \InvalidArgumentException if the array size is greater than 4
	 * @throws \InvalidArgumentException if invalid keys (out of bounds or string) are found in the array
	 * @throws \InvalidArgumentException if any line is not valid UTF-8 or contains a newline
	 */
	public function __construct(?array $lines = null, ?Color $baseColor = null, bool $glowing = false){
		$this->lines = array_fill(0, self::LINE_COUNT, "");
		if($lines !== null){
			if(count($lines) > self::LINE_COUNT){
				throw new \InvalidArgumentException("Expected at most 4 lines, got " . count($lines));
			}
			foreach($lines as $k => $line){
				$this->checkLineIndex($k);
				Utils::checkUTF8($line);
				if(str_contains($line, "\n")){
					throw new \InvalidArgumentException("Line must not contain newlines");
				}
				//TODO: add length checks
				$this->lines[$k] = $line;
			}
		}
		$this->baseColor = $baseColor ?? new Color(0, 0, 0);
		$this->glowing = $glowing;
	}

	/**
	 * Parses sign lines from the given string blob.
	 * TODO: add a strict mode for this
	 *
	 * @throws \InvalidArgumentException if the text is not valid UTF-8
	 */
	public static function fromBlob(string $blob, ?Color $baseColor = null, bool $glowing = false) : SignText{
		return new self(array_slice(array_pad(explode("\n", $blob, limit: self::LINE_COUNT + 1), self::LINE_COUNT, ""), 0, self::LINE_COUNT), $baseColor, $glowing);
	}

	/**
	 * Returns an array of lines currently on the sign.
	 *
	 * @return string[]
	 * @phpstan-return array{0: string, 1: string, 2: string, 3: string}
	 */
	public function getLines() : array{
		return $this->lines;
	}

	private function checkLineIndex(int|string $index) : void{
		if(!is_int($index)){
			throw new \InvalidArgumentException("Index must be an integer");
		}
		if($index < 0 || $index >= self::LINE_COUNT){
			throw new \InvalidArgumentException("Line index is out of bounds");
		}
	}

	/**
	 * Returns the sign line at the given offset.
	 *
	 * @throws \InvalidArgumentException
	 */
	public function getLine(int $index) : string{
		$this->checkLineIndex($index);
		return $this->lines[$index];
	}

	/**
	 * Returns the base text color of sign. Color codes using the § escape character will override this color when used.
	 */
	public function getBaseColor() : Color{
		return $this->baseColor;
	}

	/**
	 * Returns whether the sign text is glowing. When true, the text will have an outline (usually a darker tone of the
	 * base color, or white for black text), and will glow in the dark, making it readable without any light sources.
	 */
	public function isGlowing() : bool{
		return $this->glowing;
	}
}