bug #60042 [Console] Table counts wrong number of padding symbols in renderCell() method when cell contain unicode variant selector (vladimir-vv)

nicolas-grekas · nicolas-grekas · commit ce3d3f759267 · 2025-06-27T21:30:32.000+02:00
This PR was squashed before being merged into the 6.4 branch. Discussion ---------- [Console] Table counts wrong number of padding symbols in `renderCell()` method when cell contain unicode variant selector | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? |no | Issues | Fix #60038 | License | MIT When rendering a table in console and use emojis then width of columns could be wrong calculated. Commits ------- 380afcc [Console] Table counts wrong number of padding symbols in `renderCell()` method when cell contain unicode variant selector
diff --git a/src/Symfony/Component/Console/Application.php b/src/Symfony/Component/Console/Application.php
@@ -1278,7 +1278,7 @@ private function splitStringByWidth(string $string, int $width): array
 
             foreach (preg_split('//u', $m[0]) as $char) {
                 // test if $char could be appended to current line
-                if (mb_strwidth($line.$char, 'utf8') <= $width) {
+                if (Helper::width($line.$char) <= $width) {
                     $line .= $char;
                     continue;
                 }
diff --git a/src/Symfony/Component/Console/Helper/Helper.php b/src/Symfony/Component/Console/Helper/Helper.php
@@ -48,7 +48,9 @@ public static function width(?string $string): int
         $string ??= '';
 
         if (preg_match('//u', $string)) {
-            return (new UnicodeString($string))->width(false);
+            $string = preg_replace('/[\p{Cc}\x7F]++/u', '', $string, -1, $count);
+
+            return (new UnicodeString($string))->width(false) + $count;
         }
 
         if (false === $encoding = mb_detect_encoding($string, null, true)) {
diff --git a/src/Symfony/Component/Console/Helper/Table.php b/src/Symfony/Component/Console/Helper/Table.php
@@ -564,10 +564,7 @@ private function renderCell(array $row, int $column, string $cellFormat): string
         }
 
         // str_pad won't work properly with multi-byte strings, we need to fix the padding
-        if (false !== $encoding = mb_detect_encoding($cell, null, true)) {
-            $width += \strlen($cell) - mb_strwidth($cell, $encoding);
-        }
-
+        $width += \strlen($cell) - Helper::width($cell) - substr_count($cell, "\0");
         $style = $this->getColumnStyle($column);
 
         if ($cell instanceof TableSeparator) {
diff --git a/src/Symfony/Component/Console/Tests/Helper/TableTest.php b/src/Symfony/Component/Console/Tests/Helper/TableTest.php
@@ -1294,9 +1294,9 @@ public static function renderSetTitle()
                 'footer',
                 'default',
                 <<<'TABLE'
-+---------------+---- Multiline
++---------------+--- Multiline
 header
-here -+------------------+
+here +------------------+
 | ISBN          | Title                    | Author           |
 +---------------+--------------------------+------------------+
 | 99921-58-10-7 | Divine Comedy            | Dante Alighieri  |
@@ -2078,4 +2078,36 @@ public function testGithubIssue52101HorizontalFalse()
             $this->getOutputContent($output)
         );
     }
+
+    public function testGithubIssue60038WidthOfCellWithEmoji()
+    {
+        $table = (new Table($output = $this->getOutputStream()))
+            ->setHeaderTitle('Test Title')
+            ->setHeaders(['Title', 'Author'])
+            ->setRows([
+                ["🎭 💫 ☯"." Divine Comedy", "Dante Alighieri"],
+                // the snowflake (e2 9d 84 ef b8 8f) has a variant selector
+                ["👑 ❄️  🗡"." Game of Thrones", "George R.R. Martin"],
+                // the snowflake in text style (e2 9d 84 ef b8 8e) has a variant selector
+                ["❄︎❄︎❄︎ snowflake in text style ❄︎❄︎❄︎", ""],
+                ["And a very long line to show difference in previous lines", ""],
+            ])
+        ;
+        $table->render();
+
+        $this->assertSame(<<<TABLE
++---------------------------------- Test Title -------------+--------------------+
+| Title                                                     | Author             |
++-----------------------------------------------------------+--------------------+
+| 🎭 💫 ☯ Divine Comedy                                     | Dante Alighieri    |
+| 👑 ❄️  🗡 Game of Thrones                                   | George R.R. Martin |
+| ❄︎❄︎❄︎ snowflake in text style ❄︎❄︎❄︎                           |                    |
+| And a very long line to show difference in previous lines |                    |
++-----------------------------------------------------------+--------------------+
+
+TABLE
+            ,
+            $this->getOutputContent($output)
+        );
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -1278,7 +1278,7 @@ private function splitStringByWidth(string $string, int $width): array`
`1278`	`1278`
`1279`	`1279`	`foreach (preg_split('//u', $m[0]) as $char) {`
`1280`	`1280`	`// test if $char could be appended to current line`
`1281`		`- if (mb_strwidth($line.$char, 'utf8') <= $width) {`
	`1281`	`+ if (Helper::width($line.$char) <= $width) {`
`1282`	`1282`	`$line .= $char;`
`1283`	`1283`	`continue;`
`1284`	`1284`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,9 @@ public static function width(?string $string): int`
`48`	`48`	`$string ??= '';`
`49`	`49`
`50`	`50`	`if (preg_match('//u', $string)) {`
`51`		`- return (new UnicodeString($string))->width(false);`
	`51`	`+ $string = preg_replace('/[\p{Cc}\x7F]++/u', '', $string, -1, $count);`
	`52`	`+`
	`53`	`+ return (new UnicodeString($string))->width(false) + $count;`
`52`	`54`	`}`
`53`	`55`
`54`	`56`	`if (false === $encoding = mb_detect_encoding($string, null, true)) {`