@ -45,6 +45,7 @@ class Console
const BG_CYAN = 46; const BG_CYAN = 46;
const BG_GREY = 47; const BG_GREY = 47;
const RESET = 0;
const NORMAL = 0; const NORMAL = 0;
const BOLD = 1; const BOLD = 1;
const ITALIC = 3; const ITALIC = 3;
@ -240,34 +241,41 @@ class Console
} }
/** /**
* Sets the ANSI format for any text that is printed afterwards . * Returns the ANSI format code .
* *
* You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xterm256ColorFg]] and [[xterm256ColorBg ]]. * @param array $format You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xtermFgColor]] and [[xtermBgColor ]].
* TODO: documentation * TODO: documentation
* @return string
*/ */
public static function ansiFormatBegin( ) public static function ansiFormatCode($format )
{ {
echo "\033[" . implode(';', func_get_args() ) . 'm'; return "\033[" . implode(';', $format ) . 'm';
} }
/** /**
* Resets any ANSI format set by previous method [[ansiFormatBegin()]] * Sets the ANSI format for any text that is printed afterwards.
* Any output after this is will have default text style. *
* @param array $format You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xtermFgColor]] and [[xtermBgColor]].
* TODO: documentation
* @see ansiFormatEnd()
*/ */
public static function ansiFormatReset() public static function beginAnsiFormat($format )
{ {
echo "\033[0m" ; echo "\033[" . implode(';', $format) . 'm' ;
} }
/** /**
* Returns the ANSI format code. * Resets any ANSI format set by previous method [[ansiFormatBegin()]]
* Any output after this is will have default text style.
* This is equal to
* *
* You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xterm256ColorFg]] and [[xterm256ColorBg]]. * ```php
* TODO: documentation * echo Console::ansiFormatCode(array(Console::RESET))
* ```
*/ */
public static function ansiFormatCode($format ) public static function endAnsiFormat( )
{ {
return "\033[" . implode(';', $format) . 'm' ; echo "\033[0m" ;
} }
/** /**
@ -275,7 +283,7 @@ class Console
* *
* @param string $string the string to be formatted * @param string $string the string to be formatted
* @param array $format array containing formatting values. * @param array $format array containing formatting values.
* You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xterm256ColorFg]] and [[xterm256ColorBg ]]. * You can pass any of the FG_*, BG_* and TEXT_* constants and also [[xtermFgColor]] and [[xtermBgColor ]].
* @return string * @return string
*/ */
public static function ansiFormat($string, $format=array()) public static function ansiFormat($string, $format=array())
@ -284,15 +292,32 @@ class Console
return "\033[0m" . ($code !== '' ? "\033[" . $code . "m" : '') . $string . "\033[0m"; return "\033[0m" . ($code !== '' ? "\033[" . $code . "m" : '') . $string . "\033[0m";
} }
//const COLOR_XTERM256 = 38;// http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors /**
public static function xterm256ColorFg($i) // TODO naming! * Returns the ansi format code for xterm foreground color.
* You can pass the returnvalue of this to one of the formatting methods:
* [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]]
*
* @param integer $colorCode xterm color code
* @return string
* @see http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors
*/
public static function xtermFgColor($colorCode)
{ {
return '38;5;' . $i; return '38;5;' . $colorCode ;
} }
public static function xterm256ColorBg($i) // TODO naming! /**
* Returns the ansi format code for xterm foreground color.
* You can pass the returnvalue of this to one of the formatting methods:
* [[ansiFormat]], [[ansiFormatCode]], [[beginAnsiFormat]]
*
* @param integer $colorCode xterm color code
* @return string
* @see http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors
*/
public static function xtermBgColor($colorCode)
{ {
return '48;5;' . $i; return '48;5;' . $colorCode ;
} }
/** /**
@ -303,7 +328,7 @@ class Console
*/ */
public static function stripAnsiFormat($string) public static function stripAnsiFormat($string)
{ {
return preg_replace('/\033\[[\d;]+m/', '', $string); // TODO currently only strips color return preg_replace('/\033\[[\d;?]*\w/', '', $string);
} }
// TODO refactor and review // TODO refactor and review
@ -418,10 +443,11 @@ class Console
} }
/** /**
* TODO syntax copied from https://github.com/pear/Console_Color2/blob/master/Console/Color2.php * Converts a string to ansi formatted by replacing patterns like %y (for yellow) with ansi control codes
* *
* Converts colorcodes in the format %y (for yellow) into ansi-control * // TODO documentation
* codes. The conversion table is: ('bold' meaning 'light' on some * Uses almost the same syntax as https://github.com/pear/Console_Color2/blob/master/Console/Color2.php
* The conversion table is: ('bold' meaning 'light' on some
* terminals). It's almost the same conversion table irssi uses. * terminals). It's almost the same conversion table irssi uses.
* < pre > * < pre >
* text text background * text text background
@ -450,7 +476,6 @@ class Console
* *
* @param string $string String to convert * @param string $string String to convert
* @param bool $colored Should the string be colored? * @param bool $colored Should the string be colored?
*
* @return string * @return string
*/ */
public static function renderColoredString($string, $colored = true) public static function renderColoredString($string, $colored = true)
@ -508,13 +533,14 @@ class Console
} }
/** /**
* Escapes % so they don't get interpreted as color codes * Escapes % so they don't get interpreted as color codes when
* * the string is parsed by [[renderColoredString]]
* @param string $string String to escape *
* * @param string $string String to escape
* @access public *
* @return string * @access public
*/ * @return string
*/
public static function escape($string) public static function escape($string)
{ {
return str_replace('%', '%%', $string); return str_replace('%', '%%', $string);
@ -548,12 +574,38 @@ class Console
/** /**
* Usage: list($w, $h) = ConsoleHelper::getScreenSize(); * Usage: list($w, $h) = ConsoleHelper::getScreenSize();
* *
* @return array * @return array|boolean An array of ($width, $height) or false when it was not able to determine size.
*/ */
public static function getScreenSize() public static function getScreenSize($refresh = false )
{ {
// TODO implement static $size;
return array(150, 50); if ($size !== null & & !$refresh) {
return $size;
}
if (static::isRunningOnWindows()) {
// TODO implement for windows
return $size = false;
} else {
// try stty if available
$stty = array();
if (exec('stty -a 2>& 1', $stty) & & preg_match('/rows\s+(\d+);\s*columns\s+(\d+);/mi', implode(' ', $stty), $matches)) {
return $size = array($matches[2], $matches[1]);
}
// fallback to tput, which may not be updated on terminal resize
if (($width = (int) exec('tput cols 2>& 1')) > 0 & & ($height = (int) exec('tput lines 2>& 1')) > 0) {
return $size = array($width, $height);
}
// fallback to ENV variables, which may not be updated on terminal resize
if (($width = (int) getenv('COLUMNS')) > 0 & & ($height = (int) getenv('LINES')) > 0) {
return $size = array($width, $height);
}
}
return $size = false;
} }
/** /**
@ -607,27 +659,23 @@ class Console
/** /**
* Prints text to STDOUT appended with a carriage return (PHP_EOL). * Prints text to STDOUT appended with a carriage return (PHP_EOL).
* *
* @param string $text * @param string $string
* @param bool $raw
*
* @return mixed Number of bytes printed or bool false on error * @return mixed Number of bytes printed or bool false on error
*/ */
public static function output($text = null) public static function output($string = null)
{ {
return static::stdout($text . PHP_EOL); return static::stdout($string . PHP_EOL);
} }
/** /**
* Prints text to STDERR appended with a carriage return (PHP_EOL). * Prints text to STDERR appended with a carriage return (PHP_EOL).
* *
* @param string $text * @param string $string
* @param bool $raw
*
* @return mixed Number of bytes printed or false on error * @return mixed Number of bytes printed or false on error
*/ */
public static function error($text = null) public static function error($string = null)
{ {
return static::stderr($text . PHP_EOL); return static::stderr($string . PHP_EOL);
} }
/** /**
Carsten Brandt
12 years ago