Terminal::getWidth() - Code Metrics - Inspection of "wp 28" - alecrabbit/php-console-colour - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b3847f...c7da00 )

by Alec

created 2019-03-26 12:41 UTC

Terminal::getWidth() A

↳ Parent: Terminal

Complexity

Conditions	4
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	6
nc	3
nop	0
dl	0
loc	11
ccs	4
cts	4
cp	1
crap	4
rs	10
c	0
b	0
f	0

<?php declare(strict_types=1);
/*
 * This class based on
 * `Symfony\Component\Console\Terminal::class`
 * from `symfony\console` package.
 *
 * @author Fabien Potencier <[email protected]>
 */

namespace Symfony;

/**
 * Class Terminal
 * @author AlecRabbit
 */
class Terminal
{
    public const DEFAULT_WIDTH = 80;
    public const DEFAULT_HEIGHT = 50;

    /** @var null|int */
    private static $width;

    /** @var null|int */
    private static $height;

    /** @var null|bool */
    private static $supports256Color;

    /** @var null|bool */
    private static $supportsColor;

    /**
     * Gets the terminal width.
     *
     * @return int
     */
    public function getWidth(): int
    {
        $width = \getenv('COLUMNS');
        if (false !== $width) {
            return (int)\trim($width);
        }
        // @codeCoverageIgnoreStart
        if (null === self::$width) {
            self::initDimensions();
        }
        return self::$width ?: static::DEFAULT_WIDTH;
        // @codeCoverageIgnoreEnd
    }

    /**
     * @codeCoverageIgnore
     */
    private static function initDimensions(): void
    {
        if ('\\' === \DIRECTORY_SEPARATOR) {
            if ((false !== $term = \getenv('ANSICON')) &&
                \preg_match('/^(\d+)x(\d+)(?: \((\d+)x(\d+)\))?$/', \trim($term), $matches)) {
                // extract [w, H] from "wxh (WxH)"
                // or [w, h] from "wxh"
                self::$width = (int)$matches[1];
                self::$height = isset($matches[4]) ? (int)$matches[4] : (int)$matches[2];
            } elseif (null !== $dimensions = self::getConsoleMode()) {
                // extract [w, h] from "wxh"
                self::$width = (int)$dimensions[0];
                self::$height = (int)$dimensions[1];
            }
        } elseif ($sttyString = self::getSttyColumns()) {
            if (\preg_match('/rows.(\d+);.columns.(\d+);/i', $sttyString, $matches)) {
                // extract [w, h] from "rows h; columns w;"
                self::$width = (int)$matches[2];
                self::$height = (int)$matches[1];
            } elseif (\preg_match('/;.(\d+).rows;.(\d+).columns/i', $sttyString, $matches)) {
                // extract [w, h] from "; h rows; w columns"
                self::$width = (int)$matches[2];
                self::$height = (int)$matches[1];
            }
        }
    }

    /**
     * @codeCoverageIgnore
     *
     * Runs and parses mode CON if it's available, suppressing any error output.
     *
     * @return int[]|null An array composed of the width and the height or null if it could not be parsed
     */
    private static function getConsoleMode(): ?array
    {
        if (!\function_exists('proc_open')) {
            return null;
        }

        $descriptorSpec = [
            1 => ['pipe', 'w'],
            2 => ['pipe', 'w'],
        ];
        $process =
            \proc_open('mode CON', $descriptorSpec, $pipes, null, null, ['suppress_errors' => true]);
        if (\is_resource($process)) {
            $info = \stream_get_contents($pipes[1]);
            \fclose($pipes[1]);
            \fclose($pipes[2]);
            \proc_close($process);

            if (false !== $info && \preg_match('/--------+\r?\n.+?(\d+)\r?\n.+?(\d+)\r?\n/', $info, $matches)) {
                return [(int)$matches[2], (int)$matches[1]];
            }
        }
        return null;
    }

    /**
     * @codeCoverageIgnore
     *
     * Runs and parses stty -a if it's available, suppressing any error output.
     *
     * @return string|null
     */
    private static function getSttyColumns(): ?string
    {
        if (!\function_exists('proc_open')) {
            return null;
        }

        $descriptorSpec = [
            1 => ['pipe', 'w'],
            2 => ['pipe', 'w'],
        ];

        $process = \proc_open(
            'stty -a | grep columns',
            $descriptorSpec,
            $pipes,
            null,
            null,
            ['suppress_errors' => true]
        );

        if (\is_resource($process)) {
            $info = \stream_get_contents($pipes[1]);
            \fclose($pipes[1]);
            \fclose($pipes[2]);
            \proc_close($process);

            return $info ?: null;
        }
        return null;
    }

    /**
     * Gets the terminal height.
     *
     * @return int
     */
    public function getHeight(): int
    {
        $height = \getenv('LINES');
        if (false !== $height) {
            return (int)\trim($height);
        }
        // @codeCoverageIgnoreStart
        if (null === self::$height) {
            self::initDimensions();
        }
        return self::$height ?: static::DEFAULT_HEIGHT;
        // @codeCoverageIgnoreEnd
    }

    /**
     * @return bool
     */
    public function supports256Color(): bool
    {
        if (null !== static::$supports256Color) {

            return static::$supports256Color;
        }
        return
            static::$supports256Color = $this->check256ColorSupport();
    }

    /**
     * @return bool
     */
    public function supportsColor(): bool
    {
        if (null !== static::$supportsColor) {

            return static::$supportsColor;
        }
        return
            static::$supportsColor = $this->checkColorSupport();
    }

    /**
     * @return bool
     */
    protected function check256ColorSupport(): bool
    {
        if (DIRECTORY_SEPARATOR === '\\') {
            return
                \function_exists('sapi_windows_vt100_support') && @\sapi_windows_vt100_support(STDOUT);
        }
        if (!$terminal = \getenv('TERM')) {
            // @codeCoverageIgnoreStart
            return false;
            // @codeCoverageIgnoreEnd
        }
        return \strpos($terminal, '256color') !== false;
    }

    /**
     * @return bool
     */
    protected function checkColorSupport(): bool
    {
        if (DIRECTORY_SEPARATOR === '\\') {
            if (\function_exists('sapi_windows_vt100_support') && @\sapi_windows_vt100_support(STDOUT)) {
                return true;
            }
            if (\getenv('ANSICON') !== false || \getenv('ConEmuANSI') === 'ON') {
                return true;
            }
            return false;
        }
        /** @noinspection PhpComposerExtensionStubsInspection */
        return \function_exists('posix_isatty') && @\posix_isatty(STDOUT);
    }
}


1		<?php declare(strict_types=1);
2		/*
3		* This class based on
4		* `Symfony\Component\Console\Terminal::class`
5		* from `symfony\console` package.
6		*
7		* @author Fabien Potencier <[email protected]>
8		*/
9
10		namespace Symfony;
11
12		/**
13		* Class Terminal
14		* @author AlecRabbit
15		*/
16		class Terminal
17		{
18		public const DEFAULT_WIDTH = 80;
19		public const DEFAULT_HEIGHT = 50;
20
21		/** @var null\|int */
22		private static $width;
23
24		/** @var null\|int */
25		private static $height;
26
27		/** @var null\|bool */
28		private static $supports256Color;
29
30		/** @var null\|bool */
31		private static $supportsColor;
32
33		/**
34		* Gets the terminal width.
35		*
36		* @return int
37		*/
38	2	public function getWidth(): int
39		{
40	2	$width = \getenv('COLUMNS');
41	2	if (false !== $width) {
42	2	return (int)\trim($width);
43		}
44		// @codeCoverageIgnoreStart
45		if (null === self::$width) {
46		self::initDimensions();
47		}
48		return self::$width ?: static::DEFAULT_WIDTH;
49		// @codeCoverageIgnoreEnd
50		}
51
52		/**
53		* @codeCoverageIgnore
54		*/
55		private static function initDimensions(): void
56		{
57		if ('\\' === \DIRECTORY_SEPARATOR) {
58		if ((false !== $term = \getenv('ANSICON')) &&
59		\preg_match('/^(\d+)x(\d+)(?: \((\d+)x(\d+)\))?$/', \trim($term), $matches)) {
60		// extract [w, H] from "wxh (WxH)"
61		// or [w, h] from "wxh"
62		self::$width = (int)$matches[1];
63		self::$height = isset($matches[4]) ? (int)$matches[4] : (int)$matches[2];
64		} elseif (null !== $dimensions = self::getConsoleMode()) {
65		// extract [w, h] from "wxh"
66		self::$width = (int)$dimensions[0];
67		self::$height = (int)$dimensions[1];
68		}
69		} elseif ($sttyString = self::getSttyColumns()) {
70		if (\preg_match('/rows.(\d+);.columns.(\d+);/i', $sttyString, $matches)) {
71		// extract [w, h] from "rows h; columns w;"
72		self::$width = (int)$matches[2];
73		self::$height = (int)$matches[1];
74		} elseif (\preg_match('/;.(\d+).rows;.(\d+).columns/i', $sttyString, $matches)) {
75		// extract [w, h] from "; h rows; w columns"
76		self::$width = (int)$matches[2];
77		self::$height = (int)$matches[1];
78		}
79		}
80		}
81
82		/**
83		* @codeCoverageIgnore
84		*
85		* Runs and parses mode CON if it's available, suppressing any error output.
86		*
87		* @return int[]\|null An array composed of the width and the height or null if it could not be parsed
88		*/
89		private static function getConsoleMode(): ?array
90		{
91		if (!\function_exists('proc_open')) {
92		return null;
93		}
94
95		$descriptorSpec = [
96		1 => ['pipe', 'w'],
97		2 => ['pipe', 'w'],
98		];
99		$process =
100		\proc_open('mode CON', $descriptorSpec, $pipes, null, null, ['suppress_errors' => true]);
101		if (\is_resource($process)) {
102		$info = \stream_get_contents($pipes[1]);
103		\fclose($pipes[1]);
104		\fclose($pipes[2]);
105		\proc_close($process);
106
107		if (false !== $info && \preg_match('/--------+\r?\n.+?(\d+)\r?\n.+?(\d+)\r?\n/', $info, $matches)) {
108		return [(int)$matches[2], (int)$matches[1]];
109		}
110		}
111		return null;
112		}
113
114		/**
115		* @codeCoverageIgnore
116		*
117		* Runs and parses stty -a if it's available, suppressing any error output.
118		*
119		* @return string\|null
120		*/
121		private static function getSttyColumns(): ?string
122		{
123		if (!\function_exists('proc_open')) {
124		return null;
125		}
126
127		$descriptorSpec = [
128		1 => ['pipe', 'w'],
129		2 => ['pipe', 'w'],
130		];
131
132		$process = \proc_open(
133		'stty -a \| grep columns',
134		$descriptorSpec,
135		$pipes,
136		null,
137		null,
138		['suppress_errors' => true]
139		);
140
141		if (\is_resource($process)) {
142		$info = \stream_get_contents($pipes[1]);
143		\fclose($pipes[1]);
144		\fclose($pipes[2]);
145		\proc_close($process);
146
147		return $info ?: null;
148		}
149		return null;
150		}
151
152		/**
153		* Gets the terminal height.
154		*
155		* @return int
156		*/
157	2	public function getHeight(): int
158		{
159	2	$height = \getenv('LINES');
160	2	if (false !== $height) {
161	2	return (int)\trim($height);
162		}
163		// @codeCoverageIgnoreStart
164		if (null === self::$height) {
165		self::initDimensions();
166		}
167		return self::$height ?: static::DEFAULT_HEIGHT;
168		// @codeCoverageIgnoreEnd
169		}
170
171		/**
172		* @return bool
173		*/
174	1	public function supports256Color(): bool
175		{
176	1	if (null !== static::$supports256Color) {
		0 ignored issues – show Bug introduced 2019-03-26 12:43 UTC by Report Bug Copy Issue Report Since `$supports256Color` is declared private, accessing it with `static` will lead to errors in possible sub-classes; you can either use `self`, or increase the visibility of `$supports256Color` to at least protected. Loading history...
177		return static::$supports256Color;
178		}
179		return
180	1	static::$supports256Color = $this->check256ColorSupport();
181		}
182
183		/**
184		* @return bool
185		*/
186	1	public function supportsColor(): bool
187		{
188	1	if (null !== static::$supportsColor) {
		0 ignored issues – show Bug introduced 2019-03-26 12:43 UTC by Report Bug Copy Issue Report Since `$supportsColor` is declared private, accessing it with `static` will lead to errors in possible sub-classes; you can either use `self`, or increase the visibility of `$supportsColor` to at least protected. Loading history...
189		return static::$supportsColor;
190		}
191		return
192	1	static::$supportsColor = $this->checkColorSupport();
193		}
194
195		/**
196		* @return bool
197		*/
198	1	protected function check256ColorSupport(): bool
199		{
200	1	if (DIRECTORY_SEPARATOR === '\\') {
201		return
202		\function_exists('sapi_windows_vt100_support') && @\sapi_windows_vt100_support(STDOUT);
203		}
204	1	if (!$terminal = \getenv('TERM')) {
205		// @codeCoverageIgnoreStart
206		return false;
207		// @codeCoverageIgnoreEnd
208		}
209	1	return \strpos($terminal, '256color') !== false;
210		}
211
212		/**
213		* @return bool
214		*/
215	1	protected function checkColorSupport(): bool
216		{
217	1	if (DIRECTORY_SEPARATOR === '\\') {
218		if (\function_exists('sapi_windows_vt100_support') && @\sapi_windows_vt100_support(STDOUT)) {
219		return true;
220		}
221		if (\getenv('ANSICON') !== false \|\| \getenv('ConEmuANSI') === 'ON') {
222		return true;
223		}
224		return false;
225		}
226		/** @noinspection PhpComposerExtensionStubsInspection */
227	1	return \function_exists('posix_isatty') && @\posix_isatty(STDOUT);
228		}
229		}
230

alecrabbit / php-console-colour

Push — master ( b3847f...c7da00 )

Terminal::getWidth() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like