123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142 |
- <?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\Output;
- use Symfony\Component\Console\Formatter\OutputFormatterInterface;
- use Symfony\Component\Console\Helper\Helper;
- use Symfony\Component\Console\Terminal;
- /**
- * @author Pierre du Plessis <pdples@gmail.com>
- * @author Gabriel Ostrolucký <gabriel.ostrolucky@gmail.com>
- */
- class ConsoleSectionOutput extends StreamOutput
- {
- private $content = [];
- private $lines = 0;
- private $sections;
- private $terminal;
- /**
- * @param resource $stream
- * @param ConsoleSectionOutput[] $sections
- */
- public function __construct($stream, array &$sections, int $verbosity, bool $decorated, OutputFormatterInterface $formatter)
- {
- parent::__construct($stream, $verbosity, $decorated, $formatter);
- array_unshift($sections, $this);
- $this->sections = &$sections;
- $this->terminal = new Terminal();
- }
- /**
- * Clears previous output for this section.
- *
- * @param int $lines Number of lines to clear. If null, then the entire output of this section is cleared
- */
- public function clear(int $lines = null)
- {
- if (empty($this->content) || !$this->isDecorated()) {
- return;
- }
- if ($lines) {
- array_splice($this->content, -($lines * 2)); // Multiply lines by 2 to cater for each new line added between content
- } else {
- $lines = $this->lines;
- $this->content = [];
- }
- $this->lines -= $lines;
- parent::doWrite($this->popStreamContentUntilCurrentSection($lines), false);
- }
- /**
- * Overwrites the previous output with a new message.
- *
- * @param array|string $message
- */
- public function overwrite($message)
- {
- $this->clear();
- $this->writeln($message);
- }
- public function getContent(): string
- {
- return implode('', $this->content);
- }
- /**
- * @internal
- */
- public function addContent(string $input)
- {
- foreach (explode(PHP_EOL, $input) as $lineContent) {
- $this->lines += ceil($this->getDisplayLength($lineContent) / $this->terminal->getWidth()) ?: 1;
- $this->content[] = $lineContent;
- $this->content[] = PHP_EOL;
- }
- }
- /**
- * {@inheritdoc}
- */
- protected function doWrite($message, $newline)
- {
- if (!$this->isDecorated()) {
- return parent::doWrite($message, $newline);
- }
- $erasedContent = $this->popStreamContentUntilCurrentSection();
- $this->addContent($message);
- parent::doWrite($message, true);
- parent::doWrite($erasedContent, false);
- }
- /**
- * At initial stage, cursor is at the end of stream output. This method makes cursor crawl upwards until it hits
- * current section. Then it erases content it crawled through. Optionally, it erases part of current section too.
- */
- private function popStreamContentUntilCurrentSection(int $numberOfLinesToClearFromCurrentSection = 0): string
- {
- $numberOfLinesToClear = $numberOfLinesToClearFromCurrentSection;
- $erasedContent = [];
- foreach ($this->sections as $section) {
- if ($section === $this) {
- break;
- }
- $numberOfLinesToClear += $section->lines;
- $erasedContent[] = $section->getContent();
- }
- if ($numberOfLinesToClear > 0) {
- // move cursor up n lines
- parent::doWrite(sprintf("\x1b[%dA", $numberOfLinesToClear), false);
- // erase to end of screen
- parent::doWrite("\x1b[0J", false);
- }
- return implode('', array_reverse($erasedContent));
- }
- private function getDisplayLength(string $text): string
- {
- return Helper::strlenWithoutDecoration($this->getFormatter(), str_replace("\t", ' ', $text));
- }
- }
|