[Console] added support for multiline formats in ProgressBar

fabpot · fabpot · commit 7a30e50eee8a · 2014-03-01T10:21:46.000+01:00
diff --git a/src/Symfony/Component/Console/Helper/ProgressBar.php b/src/Symfony/Component/Console/Helper/ProgressBar.php
@@ -48,6 +48,7 @@ class ProgressBar
     private $percent;
     private $lastMessagesLength;
     private $barCharOriginal;
+    private $formatLineCount;
 
     static private $formatters;
 
@@ -224,6 +225,7 @@ public function getProgressCharacter()
     public function setFormat($format)
     {
         $this->format = $format;
+        $this->formatLineCount = substr_count($format, "\n");
     }
 
     /**
@@ -248,7 +250,7 @@ public function start()
         $this->barCharOriginal = '';
 
         if (null === $this->format) {
-            $this->format = $this->determineBestFormat();
+            $this->setFormat($this->determineBestFormat());
         }
 
         if (!$this->max) {
@@ -351,7 +353,7 @@ public function display()
      */
     public function clear()
     {
-        $this->overwrite('');
+        $this->overwrite(str_repeat("\n", $this->formatLineCount));
     }
 
     /**
@@ -364,12 +366,17 @@ private function overwrite($message)
         $length = Helper::strlen($message);
 
         // append whitespace to match the last line's length
+// FIXME: on each line!!!!!
+// FIXME: max of each line for lastMessagesLength or an array?
         if (null !== $this->lastMessagesLength && $this->lastMessagesLength > $length) {
             $message = str_pad($message, $this->lastMessagesLength, "\x20", STR_PAD_RIGHT);
         }
 
-        // carriage return
+        // move back to the beginning of the progress bar before redrawing it
         $this->output->write("\x0D");
+        if ($this->formatLineCount) {
+            $this->output->write(sprintf("\033[%dA", $this->formatLineCount));
+        }
         $this->output->write($message);
 
         $this->lastMessagesLength = Helper::strlen($message);
diff --git a/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php b/src/Symfony/Component/Console/Tests/Helper/ProgressBarTest.php
@@ -319,6 +319,26 @@ public function testAddingPlaceholderFormatter()
         );
     }
 
+    public function testMultilineFormat()
+    {
+        $bar = new ProgressBar($output = $this->getOutputStream(), 3);
+        $bar->setFormat("%bar%\nfoobar");
+
+        $bar->start();
+        $bar->advance();
+        $bar->clear();
+        $bar->finish();
+
+        rewind($output->getStream());
+        $this->assertEquals(
+            $this->generateOutput(">---------------------------\nfoobar").
+            $this->generateOutput("=========>------------------\nfoobar").
+            $this->generateOutput("\n").
+            $this->generateOutput("============================\nfoobar"),
+            stream_get_contents($output->getStream())
+        );
+    }
+
     protected function getOutputStream($decorated = true)
     {
         return new StreamOutput(fopen('php://memory', 'r+', false), StreamOutput::VERBOSITY_NORMAL, $decorated);
@@ -334,6 +354,8 @@ protected function generateOutput($expected)
 
         $this->lastMessagesLength = strlen($expectedout);
 
-        return "\x0D".$expectedout;
+        $count = substr_count($expected, "\n");
+
+        return "\x0D".($count ? sprintf("\033[%dA", $count) : '').$expectedout;
     }
 }
