New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Console] Add Cursor class to control the cursor in the terminal #27444
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Console; | ||
|
||
use Symfony\Component\Console\Output\OutputInterface; | ||
|
||
/** | ||
* @author Pierre du Plessis <pdples@gmail.com> | ||
*/ | ||
class Cursor | ||
{ | ||
private $output; | ||
|
||
private $input; | ||
|
||
public function __construct(OutputInterface $output, $input = STDIN) | ||
{ | ||
$this->output = $output; | ||
$this->input = $input; | ||
} | ||
|
||
public function moveUp(int $lines = 1) | ||
{ | ||
$this->output->write(sprintf("\x1b[%dA", $lines)); | ||
} | ||
|
||
public function moveDown(int $lines = 1) | ||
{ | ||
$this->output->write(sprintf("\x1b[%dB", $lines)); | ||
} | ||
|
||
public function moveRight(int $columns = 1) | ||
{ | ||
$this->output->write(sprintf("\x1b[%dC", $columns)); | ||
} | ||
|
||
public function moveLeft(int $columns = 1) | ||
{ | ||
$this->output->write(sprintf("\x1b[%dD", $columns)); | ||
} | ||
|
||
public function moveToColumn(int $column) | ||
{ | ||
$this->output->write(sprintf("\x1b[%dG", $column)); | ||
} | ||
|
||
public function moveToPosition(int $column, int $row) | ||
{ | ||
$this->output->write(sprintf("\x1b[%d;%dH", $row + 1, $column)); | ||
} | ||
|
||
public function savePosition() | ||
{ | ||
$this->output->write("\x1b7"); | ||
} | ||
|
||
public function restorePosition() | ||
{ | ||
$this->output->write("\x1b8"); | ||
} | ||
|
||
public function hide() | ||
{ | ||
$this->output->write("\x1b[?25l"); | ||
} | ||
|
||
public function show() | ||
{ | ||
$this->output->write("\x1b[?25h\x1b[?0c"); | ||
} | ||
|
||
/** | ||
* Clears all the output from the current line. | ||
*/ | ||
public function clearLine(bool $fromCurrentPosition = false) | ||
{ | ||
if (true === $fromCurrentPosition) { | ||
$this->output->write("\x1b[K"); | ||
} else { | ||
$this->output->write("\x1b[2K"); | ||
} | ||
} | ||
|
||
/** | ||
* Clears all the output from the cursors' current position to the end of the screen. | ||
*/ | ||
public function clearOutput() | ||
{ | ||
$this->output->write("\x1b[0J", false); | ||
} | ||
|
||
/** | ||
* Clears the entire screen. | ||
*/ | ||
public function clearScreen() | ||
{ | ||
$this->output->write("\x1b[2J", false); | ||
} | ||
|
||
/** | ||
* Returns the current cursor position as x,y coordinates. | ||
*/ | ||
public function getCurrentPosition(): array | ||
{ | ||
static $isTtySupported; | ||
|
||
if (null === $isTtySupported && \function_exists('proc_open')) { | ||
$isTtySupported = (bool) @proc_open('echo 1 >/dev/null', [['file', '/dev/tty', 'r'], ['file', '/dev/tty', 'w'], ['file', '/dev/tty', 'w']], $pipes); | ||
} | ||
|
||
if (!$isTtySupported) { | ||
return [1, 1]; | ||
} | ||
|
||
$sttyMode = shell_exec('stty -g'); | ||
shell_exec('stty -icanon -echo'); | ||
|
||
@fwrite($this->input, "\033[6n"); | ||
|
||
$code = trim(fread($this->input, 1024)); | ||
|
||
shell_exec(sprintf('stty %s', $sttyMode)); | ||
|
||
sscanf($code, "\033[%d;%dR", $row, $col); | ||
|
||
return [$col, $row]; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it really belong to the cursor?