286 lines
8.8 KiB
PHP

<?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\utils;
use function fclose;
use function fopen;
use function function_exists;
use function getenv;
use function is_array;
use function stream_isatty;
abstract class Terminal{
public static $FORMAT_BOLD = "";
public static $FORMAT_OBFUSCATED = "";
public static $FORMAT_ITALIC = "";
public static $FORMAT_UNDERLINE = "";
public static $FORMAT_STRIKETHROUGH = "";
public static $FORMAT_RESET = "";
public static $COLOR_BLACK = "";
public static $COLOR_DARK_BLUE = "";
public static $COLOR_DARK_GREEN = "";
public static $COLOR_DARK_AQUA = "";
public static $COLOR_DARK_RED = "";
public static $COLOR_PURPLE = "";
public static $COLOR_GOLD = "";
public static $COLOR_GRAY = "";
public static $COLOR_DARK_GRAY = "";
public static $COLOR_BLUE = "";
public static $COLOR_GREEN = "";
public static $COLOR_AQUA = "";
public static $COLOR_RED = "";
public static $COLOR_LIGHT_PURPLE = "";
public static $COLOR_YELLOW = "";
public static $COLOR_WHITE = "";
/** @var bool|null */
private static $formattingCodes = null;
public static function hasFormattingCodes() : bool{
if(self::$formattingCodes === null){
throw new \InvalidStateException("Formatting codes have not been initialized");
}
return self::$formattingCodes;
}
private static function detectFormattingCodesSupport() : bool{
$stdout = fopen("php://stdout", "w");
$result = (
stream_isatty($stdout) and //STDOUT isn't being piped
(
getenv('TERM') !== false or //Console says it supports colours
(function_exists('sapi_windows_vt100_support') and sapi_windows_vt100_support($stdout)) //we're on windows and have vt100 support
)
);
fclose($stdout);
return $result;
}
protected static function getFallbackEscapeCodes(){
self::$FORMAT_BOLD = "\x1b[1m";
self::$FORMAT_OBFUSCATED = "";
self::$FORMAT_ITALIC = "\x1b[3m";
self::$FORMAT_UNDERLINE = "\x1b[4m";
self::$FORMAT_STRIKETHROUGH = "\x1b[9m";
self::$FORMAT_RESET = "\x1b[m";
self::$COLOR_BLACK = "\x1b[38;5;16m";
self::$COLOR_DARK_BLUE = "\x1b[38;5;19m";
self::$COLOR_DARK_GREEN = "\x1b[38;5;34m";
self::$COLOR_DARK_AQUA = "\x1b[38;5;37m";
self::$COLOR_DARK_RED = "\x1b[38;5;124m";
self::$COLOR_PURPLE = "\x1b[38;5;127m";
self::$COLOR_GOLD = "\x1b[38;5;214m";
self::$COLOR_GRAY = "\x1b[38;5;145m";
self::$COLOR_DARK_GRAY = "\x1b[38;5;59m";
self::$COLOR_BLUE = "\x1b[38;5;63m";
self::$COLOR_GREEN = "\x1b[38;5;83m";
self::$COLOR_AQUA = "\x1b[38;5;87m";
self::$COLOR_RED = "\x1b[38;5;203m";
self::$COLOR_LIGHT_PURPLE = "\x1b[38;5;207m";
self::$COLOR_YELLOW = "\x1b[38;5;227m";
self::$COLOR_WHITE = "\x1b[38;5;231m";
}
protected static function getEscapeCodes(){
self::$FORMAT_BOLD = `tput bold`;
self::$FORMAT_OBFUSCATED = `tput smacs`;
self::$FORMAT_ITALIC = `tput sitm`;
self::$FORMAT_UNDERLINE = `tput smul`;
self::$FORMAT_STRIKETHROUGH = "\x1b[9m"; //`tput `;
self::$FORMAT_RESET = `tput sgr0`;
$colors = (int) `tput colors`;
if($colors > 8){
self::$COLOR_BLACK = $colors >= 256 ? `tput setaf 16` : `tput setaf 0`;
self::$COLOR_DARK_BLUE = $colors >= 256 ? `tput setaf 19` : `tput setaf 4`;
self::$COLOR_DARK_GREEN = $colors >= 256 ? `tput setaf 34` : `tput setaf 2`;
self::$COLOR_DARK_AQUA = $colors >= 256 ? `tput setaf 37` : `tput setaf 6`;
self::$COLOR_DARK_RED = $colors >= 256 ? `tput setaf 124` : `tput setaf 1`;
self::$COLOR_PURPLE = $colors >= 256 ? `tput setaf 127` : `tput setaf 5`;
self::$COLOR_GOLD = $colors >= 256 ? `tput setaf 214` : `tput setaf 3`;
self::$COLOR_GRAY = $colors >= 256 ? `tput setaf 145` : `tput setaf 7`;
self::$COLOR_DARK_GRAY = $colors >= 256 ? `tput setaf 59` : `tput setaf 8`;
self::$COLOR_BLUE = $colors >= 256 ? `tput setaf 63` : `tput setaf 12`;
self::$COLOR_GREEN = $colors >= 256 ? `tput setaf 83` : `tput setaf 10`;
self::$COLOR_AQUA = $colors >= 256 ? `tput setaf 87` : `tput setaf 14`;
self::$COLOR_RED = $colors >= 256 ? `tput setaf 203` : `tput setaf 9`;
self::$COLOR_LIGHT_PURPLE = $colors >= 256 ? `tput setaf 207` : `tput setaf 13`;
self::$COLOR_YELLOW = $colors >= 256 ? `tput setaf 227` : `tput setaf 11`;
self::$COLOR_WHITE = $colors >= 256 ? `tput setaf 231` : `tput setaf 15`;
}else{
self::$COLOR_BLACK = self::$COLOR_DARK_GRAY = `tput setaf 0`;
self::$COLOR_RED = self::$COLOR_DARK_RED = `tput setaf 1`;
self::$COLOR_GREEN = self::$COLOR_DARK_GREEN = `tput setaf 2`;
self::$COLOR_YELLOW = self::$COLOR_GOLD = `tput setaf 3`;
self::$COLOR_BLUE = self::$COLOR_DARK_BLUE = `tput setaf 4`;
self::$COLOR_LIGHT_PURPLE = self::$COLOR_PURPLE = `tput setaf 5`;
self::$COLOR_AQUA = self::$COLOR_DARK_AQUA = `tput setaf 6`;
self::$COLOR_GRAY = self::$COLOR_WHITE = `tput setaf 7`;
}
}
public static function init(?bool $enableFormatting = null) : void{
self::$formattingCodes = $enableFormatting ?? self::detectFormattingCodesSupport();
if(!self::$formattingCodes){
return;
}
switch(Utils::getOS()){
case "linux":
case "mac":
case "bsd":
self::getEscapeCodes();
return;
case "win":
case "android":
self::getFallbackEscapeCodes();
return;
}
//TODO: iOS
}
public static function isInit() : bool{
return self::$formattingCodes !== null;
}
/**
* Returns a string with colorized ANSI Escape codes for the current terminal
* Note that this is platform-dependent and might produce different results depending on the terminal type and/or OS.
*
* @param string|array $string
*
* @return string
*/
public static function toANSI($string) : string{
if(!is_array($string)){
$string = TextFormat::tokenize($string);
}
$newString = "";
foreach($string as $token){
switch($token){
case TextFormat::BOLD:
$newString .= Terminal::$FORMAT_BOLD;
break;
case TextFormat::OBFUSCATED:
$newString .= Terminal::$FORMAT_OBFUSCATED;
break;
case TextFormat::ITALIC:
$newString .= Terminal::$FORMAT_ITALIC;
break;
case TextFormat::UNDERLINE:
$newString .= Terminal::$FORMAT_UNDERLINE;
break;
case TextFormat::STRIKETHROUGH:
$newString .= Terminal::$FORMAT_STRIKETHROUGH;
break;
case TextFormat::RESET:
$newString .= Terminal::$FORMAT_RESET;
break;
//Colors
case TextFormat::BLACK:
$newString .= Terminal::$COLOR_BLACK;
break;
case TextFormat::DARK_BLUE:
$newString .= Terminal::$COLOR_DARK_BLUE;
break;
case TextFormat::DARK_GREEN:
$newString .= Terminal::$COLOR_DARK_GREEN;
break;
case TextFormat::DARK_AQUA:
$newString .= Terminal::$COLOR_DARK_AQUA;
break;
case TextFormat::DARK_RED:
$newString .= Terminal::$COLOR_DARK_RED;
break;
case TextFormat::DARK_PURPLE:
$newString .= Terminal::$COLOR_PURPLE;
break;
case TextFormat::GOLD:
$newString .= Terminal::$COLOR_GOLD;
break;
case TextFormat::GRAY:
$newString .= Terminal::$COLOR_GRAY;
break;
case TextFormat::DARK_GRAY:
$newString .= Terminal::$COLOR_DARK_GRAY;
break;
case TextFormat::BLUE:
$newString .= Terminal::$COLOR_BLUE;
break;
case TextFormat::GREEN:
$newString .= Terminal::$COLOR_GREEN;
break;
case TextFormat::AQUA:
$newString .= Terminal::$COLOR_AQUA;
break;
case TextFormat::RED:
$newString .= Terminal::$COLOR_RED;
break;
case TextFormat::LIGHT_PURPLE:
$newString .= Terminal::$COLOR_LIGHT_PURPLE;
break;
case TextFormat::YELLOW:
$newString .= Terminal::$COLOR_YELLOW;
break;
case TextFormat::WHITE:
$newString .= Terminal::$COLOR_WHITE;
break;
default:
$newString .= $token;
break;
}
}
return $newString;
}
/**
* Emits a string containing Minecraft colour codes to the console formatted with native colours.
*
* @param string $line
*/
public static function write(string $line) : void{
echo self::toANSI($line);
}
/**
* Emits a string containing Minecraft colour codes to the console formatted with native colours, followed by a
* newline character.
*
* @param string $line
*/
public static function writeLine(string $line) : void{
echo self::toANSI($line) . PHP_EOL;
}
}