Color.php

<?php declare(strict_types=1);
/**
 * This file is part of toolkit/cli-utils.
 *
 * @link     https://github.com/php-toolkit/cli-utils
 * @author   https://github.com/inhere
 * @license  MIT
 */

namespace Toolkit\Cli;

use Toolkit\Cli\Color\ANSICode;
use Toolkit\Cli\Color\ColorCode;
use Toolkit\Cli\Color\ColorTag;
use function array_filter;
use function array_keys;
use function implode;
use function is_array;
use function is_string;
use function preg_replace;
use function sprintf;
use function strip_tags;
use function strpos;
use const PHP_EOL;

/**
 * Class Color
 *
 * Usage:
 *
 * ```php
 * echo Color::red('hello');
 * echo Color::info('hello');
 * ```
 *
 * @package Toolkit\Cli
 * // basic
 * @method static string red(string $text)
 * @method static string blue(string $text)
 * @method static string cyan(string $text)
 * @method static string black(string $text)
 * @method static string brown(string $text)
 * @method static string green(string $text)
 * @method static string white(string $text)
 * @method static string yellow(string $text)
 * @method static string magenta(string $text)
 *
 * // alert
 * @method static string info(string $text)
 * @method static string danger(string $text)
 * @method static string error(string $text)
 * @method static string notice(string $text)
 * @method static string warning(string $text)
 * @method static string success(string $text)
 *
 * // more please @see Color::STYLES
 */
class Color extends ANSICode
{
    // Regex to match color tags
    public const COLOR_TAG = '/<([a-z=;]+)>(.*?)<\/\\1>/s';

    // CLI color template
    public const COLOR_TPL = "\033[%sm%s\033[0m";

    /**
     * There are some internal styles
     * custom style: fg;bg;opt
     *
     * @var array
     */
    public const STYLES = [
        // basic
        'normal'         => '39',// no color
        'red'            => '0;31',
        'red1'           => '1;31',
        'blue'           => '0;34',
        'cyan'           => '0;36',
        'cyan1'          => '1;36',
        'black'          => '0;30',
        'green'          => '0;32',
        'green1'         => '1;32',
        'brown'          => '0;33',
        'brown1'         => '1;33',
        'white'          => '1;37',
        'ylw0'           => '0;33',
        'ylw'            => '1;33',
        'yellow0'        => '0;33',
        'yellow'         => '1;33',
        'mga0'           => '0;35',
        'magenta0'       => '0;35',
        'mga'            => '1;35',
        'mga1'           => '1;35',
        'magenta'        => '1;35',

        // alert
        'suc'            => '1;32',// same 'green' and 'bold'
        'success'        => '1;32',
        'info'           => '0;32',// same 'green'
        'comment'        => '0;33',// same 'brown'
        'cmd'            => '0;33',// same 'brown'
        'note'           => '36;1',
        'notice'         => '36;4',
        'warn'           => '0;30;43',
        'warning'        => '0;30;43',
        'code'           => '0;95',// same 'red'
        'danger'         => '0;31',// same 'red'
        'err'            => '97;41',
        'error'          => '97;41',

        // extra
        'darkDray'       => '90',
        'dark_gray'      => '90',
        'hiRed'          => '91',
        'hiRed1'         => '1;91',
        'hiGreen'        => '92',
        'hiGreen1'       => '1;92',
        'hiYellow'       => '93',
        'hiYellow1'      => '1;93',
        'hiBlue'         => '94',
        'hiBlue1'        => '1;94',
        'hiMagenta'      => '95',
        'hiMagenta1'     => '1;95',
        'hiCyan'         => '96',
        'hiCyan1'        => '1;96',

        // extra
        'lightRedEx'     => '91',
        'light_red_ex'   => '91',
        'lightGreenEx'   => '92',
        'light_green_ex' => '92',
        'lightYellow'    => '93',
        'light_yellow'   => '93',
        'lightBlueEx'    => '94',
        'light_blue_ex'  => '94',
        'lightMagenta'   => '95',
        'light_magenta'  => '95',
        'lightCyanEx'    => '96',
        'light_cyan_ex'  => '96',
        'whiteEx'        => '97',
        'white_ex'       => '97',

        // option
        'b'              => '0;1',
        'bold'           => '0;1',
        'fuzzy'          => '0;2',
        'i'              => '0;3',
        'italic'         => '0;3',
        'us'             => '0;4',
        'underscore'     => '0;4',
        'blink'          => '5',
        'reverse'        => '7',
        'concealed'      => '8',

        // ---------- The following is deprecated ----------

        'lightRed'    => '1;31',
        'light_red'   => '1;31',
        'lightGreen'  => '1;32',
        'light_green' => '1;32',
        'lightBlue'   => '1;34',
        'light_blue'  => '1;34',
        'lightCyan'   => '1;36',
        'light_cyan'  => '1;36',
        'lightDray'   => '37',
        'light_gray'  => '37',
    ];

    /**
     * Flag to remove color codes from the output
     *
     * @var bool
     */
    private static bool $noColor = false;

    /**
     * Force render color code
     *
     * @var bool
     */
    private static bool $forceColor = false;

    /**
     * @param string $method
     * @param array  $args
     *
     * @return string
     */
    public static function __callStatic(string $method, array $args)
    {
        if (isset(self::STYLES[$method])) {
            return self::render($args[0], $method);
        }

        return '';
    }

    /**
     * Apply style for text
     *
     * @param string $style
     * @param string $text
     *
     * @return string
     */
    public static function apply(string $style, string $text): string
    {
        return self::render($text, $style);
    }

    /**
     * Format and print to STDOUT
     *
     * @param string $format
     * @param mixed  ...$args
     */
    public static function printf(string $format, ...$args): void
    {
        echo self::render(sprintf($format, ...$args));
    }

    /**
     * Print colored message to STDOUT
     *
     * @param array|string $messages
     * @param array|string $style
     */
    public static function println(array|string $messages, array|string $style = 'info'): void
    {
        $str = is_array($messages) ? implode("\n", $messages) : (string)$messages;

        echo self::render($str, $style) . PHP_EOL;
    }

    /**
     * @param string $text
     * @param string $tag
     *
     * @return string
     */
    public static function addTag(string $text, string $tag = 'info'): string
    {
        return ColorTag::add($text, $tag);
    }

    /*******************************************************************************
     * color render
     ******************************************************************************/

    /**
     * Render text, apply color code
     *
     * @param string            $text
     * @param array|string|null $style
     * - string: 'green', 'blue'
     * - array: [Color::FG_GREEN, Color::BG_WHITE, Color::UNDERSCORE]
     *
     * @return string
     */
    public static function render(string $text, array|string|null $style = null): string
    {
        if (!$text) {
            return $text;
        }

        // shouldn't render color, clear color code.
        if (!self::isShouldRenderColor()) {
            return self::clearColor($text);
        }

        $color = '';

        // use defined style: 'green'
        if (is_string($style)) {
            $color = self::STYLES[$style] ?? '';

        // custom style: [self::FG_GREEN, self::BG_WHITE, self::UNDERSCORE]
        } elseif (is_array($style)) {
            $color = implode(';', $style);

        // user color tag: <info>message</info>
        } elseif (strpos($text, '</') > 0) {
            return self::parseTag($text);
        }

        if (!$color) {
            return $text;
        }

        // $result = chr(27). "$color{$text}" . chr(27) . chr(27) . "[0m". chr(27);
        return sprintf(self::COLOR_TPL, $color, $text);
    }

    /**
     * parse color tag e.g: <info>message</info>
     *
     * @param string $text
     * @param bool   $recursive
     *
     * @return string
     */
    public static function parseTag(string $text, bool $recursive = false): string
    {
        return ColorTag::parse($text, $recursive);
    }

    /**
     * @return bool
     */
    public static function isShouldRenderColor(): bool
    {
        // force render color code
        if (self::$forceColor) {
            return true;
        }

        // disable color
        if (self::$noColor) {
            return false;
        }

        // current env is support render color?
        return Cli::isSupportColor();
    }

    /**
     * Create a color style code from a parameter string.
     *
     * @param string $string e.g 'fg=white;bg=black;options=bold,underscore;extra=1'
     *
     * @return string
     */
    public static function stringToCode(string $string): string
    {
        return ColorCode::fromString($string)->toString();
    }

    /**
     * @param string $text
     * @param bool   $stripTag
     *
     * @return string
     */
    public static function clearColor(string $text, bool $stripTag = true): string
    {
        // return preg_replace('/\033\[(?:\d;?)+m/', '' , "\033[0;36mtext\033[0m");
        return preg_replace('/\033\[(?:\d;?)+m/', '', $stripTag ? strip_tags($text) : $text);
    }

    /**
     * @param string $style
     *
     * @return bool
     */
    public static function hasStyle(string $style): bool
    {
        return isset(self::STYLES[$style]);
    }

    /**
     * get all style names
     *
     * @return array
     */
    public static function getStyles(): array
    {
        return array_filter(array_keys(self::STYLES), static function ($style) {
            return !strpos($style, '_');
        });
    }

    /**
     * reset color config
     */
    public static function resetConfig(): void
    {
        self::$noColor = self::$forceColor = false;
    }

    /**
     * @return bool
     */
    public static function isNoColor(): bool
    {
        return self::$noColor;
    }

    /**
     * @param bool $noColor
     */
    public static function setNoColor(bool $noColor): void
    {
        self::$noColor = $noColor;
    }

    /**
     * @return bool
     */
    public static function isForceColor(): bool
    {
        return self::$forceColor;
    }

    /**
     * @param bool $forceColor
     */
    public static function setForceColor(bool $forceColor): void
    {
        self::$forceColor = $forceColor;
    }
}