UnixTerminal::getColourSupport() - Code Metrics - Inspection of "Merge pull request #8 from Lynesth/patch-1" - php-school/terminal - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f98c61...7d4983 )

by Aydin

created 2018-05-05 17:40 UTC

UnixTerminal::getColourSupport() A

↳ Parent: UnixTerminal

Complexity

Conditions	2
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	2
eloc	1
nc	1
nop	0

<?php

namespace PhpSchool\Terminal;

use PhpSchool\Terminal\Exception\NotInteractiveTerminal;
use PhpSchool\Terminal\IO\InputStream;
use PhpSchool\Terminal\IO\OutputStream;

/**
 * @author Michael Woodward <[email protected]>
 * @author Aydin Hassan <[email protected]>
 */
class UnixTerminal implements Terminal
{
    /**
     * @var bool
     */
    private $isCanonical;

    /**
     * Whether terminal echo back is enabled or not.
     * Eg. user key presses and the terminal immediately shows it.
     *
     * @var bool
     */
    private $echoBack = true;

    /**
     * @var int
     */
    private $width;

    /**
     * @var int
     */
    private $height;
    
    /**
     * @var int;
     */
    private $colourSupport;

    /**
     * @var string
     */
    private $originalConfiguration;

    /**
     * @var InputStream
     */
    private $input;

    /**
     * @var OutputStream
     */
    private $output;

    public function __construct(InputStream $input, OutputStream $output)
    {
        $this->getOriginalConfiguration();
        $this->getOriginalCanonicalMode();
        $this->input = $input;
        $this->output = $output;
    }

    private function getOriginalCanonicalMode() : void
    {
        exec('stty -a', $output);
        $this->isCanonical = (strpos(implode("\n", $output), ' icanon') !== false);
    }

    public function getWidth() : int
    {
        return $this->width ?: $this->width = (int) exec('tput cols');
    }

    public function getHeight() : int
    {
        return $this->height ?: $this->height = (int) exec('tput lines');
    }

    public function getColourSupport() : int
    {
        return $this->colourSupport ?: $this->colourSupport = (int) exec('tput colors');
    }

    private function getOriginalConfiguration() : string
    {
        return $this->originalConfiguration ?: $this->originalConfiguration = exec('stty -g');
    }

    /**
     * Disables echoing every character back to the terminal. This means
     * we do not have to clear the line when reading.
     */
    public function disableEchoBack() : void
    {
        exec('stty -echo');
        $this->echoBack = false;
    }

    /**
     * Enable echoing back every character input to the terminal.
     */
    public function enableEchoBack() : void
    {
        exec('stty echo');
        $this->echoBack = true;
    }

    /**
     * Is echo back mode enabled
     */
    public function isEchoBack() : bool
    {
        return $this->echoBack;
    }

    /**
     * Disable canonical input (allow each key press for reading, rather than the whole line)
     *
     * @see https://www.gnu.org/software/libc/manual/html_node/Canonical-or-Not.html
     */
    public function disableCanonicalMode() : void
    {
        if ($this->isCanonical) {
            exec('stty -icanon');
            $this->isCanonical = false;
        }
    }

    /**
     * Enable canonical input - read input by line
     *
     * @see https://www.gnu.org/software/libc/manual/html_node/Canonical-or-Not.html
     */
    public function enableCanonicalMode() : void
    {
        if (!$this->isCanonical) {
            exec('stty canon');
            $this->isCanonical = true;
        }
    }

    /**
     * Is canonical mode enabled or not
     */
    public function isCanonicalMode() : bool
    {
        return $this->isCanonical;
    }

    /**
     * Restore the original terminal configuration
     */
    public function restoreOriginalConfiguration() : void
    {
        exec('stty ' . $this->getOriginalConfiguration());
    }

    /**
     * Check if the Input & Output streams are interactive. Eg - they are
     * connected to a terminal.
     *
     * @return bool
     */
    public function isInteractive() : bool
    {
        return $this->input->isInteractive() && $this->output->isInteractive();
    }

    /**
     * Assert that both the Input & Output streams are interactive. Throw
     * `NotInteractiveTerminal` if not.
     */
    public function mustBeInteractive() : void
    {
        if (!$this->input->isInteractive()) {
            throw NotInteractiveTerminal::inputNotInteractive();
        }

        if (!$this->output->isInteractive()) {
            throw NotInteractiveTerminal::outputNotInteractive();
        }
    }

    /**
     * @see https://github.com/symfony/Console/blob/master/Output/StreamOutput.php#L95-L102
     */
    public function supportsColour() : bool
    {
        if (DIRECTORY_SEPARATOR === '\\') {
            return false !== getenv('ANSICON') || 'ON' === getenv('ConEmuANSI') || 'xterm' === getenv('TERM');
        }

        return $this->isInteractive();
    }

    public function clear() : void
    {
        $this->output->write("\033[2J");
    }

    public function clearLine() : void
    {
        $this->output->write("\033[2K");
    }

    /**
     * Erase screen from the current line down to the bottom of the screen
     */
    public function clearDown() : void
    {
        $this->output->write("\033[J");
    }

    public function clean() : void
    {
        foreach (range(0, $this->getHeight()) as $rowNum) {
            $this->moveCursorToRow($rowNum);
            $this->clearLine();
        }
    }

    public function enableCursor() : void
    {
        $this->output->write("\033[?25h");
    }

    public function disableCursor() : void
    {
        $this->output->write("\033[?25l");
    }

    public function moveCursorToTop() : void
    {
        $this->output->write("\033[H");
    }

    public function moveCursorToRow(int $rowNumber) : void
    {
        $this->output->write(sprintf("\033[%d;0H", $rowNumber));
    }

    public function moveCursorToColumn(int $column) : void
    {
        $this->output->write(sprintf("\033[%dC", $column));
    }

    public function showSecondaryScreen() : void
    {
        $this->output->write("\033[?47h");
    }

    public function showPrimaryScreen() : void
    {
        $this->output->write("\033[?47l");
    }

    /**
     * Read bytes from the input stream
     */
    public function read(int $bytes): string
    {
        $buffer = '';
        $this->input->read($bytes, function ($data) use (&$buffer) {
            $buffer .= $data;
        });
        return $buffer;
    }

    /**
     * Write to the output stream
     */
    public function write(string $buffer): void
    {
        $this->output->write($buffer);
    }

    /**
     * Restore the original terminal configuration on shutdown.
     */
    public function __destruct()
    {
        $this->restoreOriginalConfiguration();
    }
}


1			<?php
2
3			namespace PhpSchool\Terminal;
4
5			use PhpSchool\Terminal\Exception\NotInteractiveTerminal;
6			use PhpSchool\Terminal\IO\InputStream;
7			use PhpSchool\Terminal\IO\OutputStream;
8
9			/**
10			* @author Michael Woodward <[email protected]>
11			* @author Aydin Hassan <[email protected]>
12			*/
13			class UnixTerminal implements Terminal
14			{
15			/**
16			* @var bool
17			*/
18			private $isCanonical;
19
20			/**
21			* Whether terminal echo back is enabled or not.
22			* Eg. user key presses and the terminal immediately shows it.
23			*
24			* @var bool
25			*/
26			private $echoBack = true;
27
28			/**
29			* @var int
30			*/
31			private $width;
32
33			/**
34			* @var int
35			*/
36			private $height;
37
38			/**
39			* @var int;
40			*/
41			private $colourSupport;
42
43			/**
44			* @var string
45			*/
46			private $originalConfiguration;
47
48			/**
49			* @var InputStream
50			*/
51			private $input;
52
53			/**
54			* @var OutputStream
55			*/
56			private $output;
57
58			public function __construct(InputStream $input, OutputStream $output)
59			{
60			$this->getOriginalConfiguration();
61			$this->getOriginalCanonicalMode();
62			$this->input = $input;
63			$this->output = $output;
64			}
65
66			private function getOriginalCanonicalMode() : void
67			{
68			exec('stty -a', $output);
69			$this->isCanonical = (strpos(implode("\n", $output), ' icanon') !== false);
70			}
71
72			public function getWidth() : int
73			{
74			return $this->width ?: $this->width = (int) exec('tput cols');
75			}
76
77			public function getHeight() : int
78			{
79			return $this->height ?: $this->height = (int) exec('tput lines');
80			}
81
82			public function getColourSupport() : int
83			{
84			return $this->colourSupport ?: $this->colourSupport = (int) exec('tput colors');
85			}
86
87			private function getOriginalConfiguration() : string
88			{
89			return $this->originalConfiguration ?: $this->originalConfiguration = exec('stty -g');
90			}
91
92			/**
93			* Disables echoing every character back to the terminal. This means
94			* we do not have to clear the line when reading.
95			*/
96			public function disableEchoBack() : void
97			{
98			exec('stty -echo');
99			$this->echoBack = false;
100			}
101
102			/**
103			* Enable echoing back every character input to the terminal.
104			*/
105			public function enableEchoBack() : void
106			{
107			exec('stty echo');
108			$this->echoBack = true;
109			}
110
111			/**
112			* Is echo back mode enabled
113			*/
114			public function isEchoBack() : bool
115			{
116			return $this->echoBack;
117			}
118
119			/**
120			* Disable canonical input (allow each key press for reading, rather than the whole line)
121			*
122			* @see https://www.gnu.org/software/libc/manual/html_node/Canonical-or-Not.html
123			*/
124			public function disableCanonicalMode() : void
125			{
126			if ($this->isCanonical) {
127			exec('stty -icanon');
128			$this->isCanonical = false;
129			}
130			}
131
132			/**
133			* Enable canonical input - read input by line
134			*
135			* @see https://www.gnu.org/software/libc/manual/html_node/Canonical-or-Not.html
136			*/
137			public function enableCanonicalMode() : void
138			{
139			if (!$this->isCanonical) {
140			exec('stty canon');
141			$this->isCanonical = true;
142			}
143			}
144
145			/**
146			* Is canonical mode enabled or not
147			*/
148			public function isCanonicalMode() : bool
149			{
150			return $this->isCanonical;
151			}
152
153			/**
154			* Restore the original terminal configuration
155			*/
156			public function restoreOriginalConfiguration() : void
157			{
158			exec('stty ' . $this->getOriginalConfiguration());
159			}
160
161			/**
162			* Check if the Input & Output streams are interactive. Eg - they are
163			* connected to a terminal.
164			*
165			* @return bool
166			*/
167			public function isInteractive() : bool
168			{
169			return $this->input->isInteractive() && $this->output->isInteractive();
170			}
171
172			/**
173			* Assert that both the Input & Output streams are interactive. Throw
174			* `NotInteractiveTerminal` if not.
175			*/
176			public function mustBeInteractive() : void
177			{
178			if (!$this->input->isInteractive()) {
179			throw NotInteractiveTerminal::inputNotInteractive();
180			}
181
182			if (!$this->output->isInteractive()) {
183			throw NotInteractiveTerminal::outputNotInteractive();
184			}
185			}
186
187			/**
188			* @see https://github.com/symfony/Console/blob/master/Output/StreamOutput.php#L95-L102
189			*/
190			public function supportsColour() : bool
191			{
192			if (DIRECTORY_SEPARATOR === '\\') {
193			return false !== getenv('ANSICON') \|\| 'ON' === getenv('ConEmuANSI') \|\| 'xterm' === getenv('TERM');
194			}
195
196			return $this->isInteractive();
197			}
198
199			public function clear() : void
200			{
201			$this->output->write("\033[2J");
202			}
203
204			public function clearLine() : void
205			{
206			$this->output->write("\033[2K");
207			}
208
209			/**
210			* Erase screen from the current line down to the bottom of the screen
211			*/
212			public function clearDown() : void
213			{
214			$this->output->write("\033[J");
215			}
216
217			public function clean() : void
218			{
219			foreach (range(0, $this->getHeight()) as $rowNum) {
220			$this->moveCursorToRow($rowNum);
221			$this->clearLine();
222			}
223			}
224
225			public function enableCursor() : void
226			{
227			$this->output->write("\033[?25h");
228			}
229
230			public function disableCursor() : void
231			{
232			$this->output->write("\033[?25l");
233			}
234
235			public function moveCursorToTop() : void
236			{
237			$this->output->write("\033[H");
238			}
239
240			public function moveCursorToRow(int $rowNumber) : void
241			{
242			$this->output->write(sprintf("\033[%d;0H", $rowNumber));
243			}
244
245			public function moveCursorToColumn(int $column) : void
246			{
247			$this->output->write(sprintf("\033[%dC", $column));
248			}
249
250			public function showSecondaryScreen() : void
251			{
252			$this->output->write("\033[?47h");
253			}
254
255			public function showPrimaryScreen() : void
256			{
257			$this->output->write("\033[?47l");
258			}
259
260			/**
261			* Read bytes from the input stream
262			*/
263			public function read(int $bytes): string
264			{
265			$buffer = '';
266			$this->input->read($bytes, function ($data) use (&$buffer) {
267			$buffer .= $data;
268			});
269			return $buffer;
270			}
271
272			/**
273			* Write to the output stream
274			*/
275			public function write(string $buffer): void
276			{
277			$this->output->write($buffer);
278			}
279
280			/**
281			* Restore the original terminal configuration on shutdown.
282			*/
283			public function __destruct()
284			{
285			$this->restoreOriginalConfiguration();
286			}
287			}
288

php-school / terminal

Push — master ( f98c61...7d4983 )

UnixTerminal::getColourSupport() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like