Merge pull request #751 from antmicro/keep-parenthesis

Adjust closing parenthesis penalties
chipsalliance · Apr 7, 2021 · d4cd328 · d4cd328
2 parents 4366c2c + bd4eb09
commit d4cd328
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/verilog/formatting/formatter_test.cc b/verilog/formatting/formatter_test.cc
@@ -385,6 +385,22 @@ static constexpr FormatterTestCase kFormatterTestCases[] = {
      "`FOO(bar)\n"},
     {// multiple argument macro call
      "  `FOO( bar , baz )\n", "`FOO(bar, baz)\n"},
+    {// long macro call breaking
+     " `ASSERT_INIT(S, (D == 4 && K inside {0, 1}) ||"
+     " (D == 3 && K== 4))\n",
+     "`ASSERT_INIT(S,\n"
+     "             (D == 4 && K inside {0, 1})\n"
+     "                 || (D == 3 && K == 4))\n"},
+    {// long macro call breaking
+     " `AINIT(S, (D == 4 && K inside {0, 1}) ||"
+     " (D == 3 && K== 4))\n",
+     "`AINIT(S,\n"
+     "       (D == 4 && K inside {0, 1}) || (\n"
+     "           D == 3 && K == 4))\n"},
+    {// long macro call breaking
+     " `ASSERT_INIT(S, D == 4 && K inside {0, 1})\n",
+     "`ASSERT_INIT(S,\n"
+     "             D == 4 && K inside {0, 1})\n"},
     {// macro call in function
      "function void foo( );   foo=`FOO( bar , baz ) ; endfunction\n",
      "function void foo();\n"

diff --git a/verilog/formatting/token_annotator.cc b/verilog/formatting/token_annotator.cc
@@ -613,6 +613,10 @@ static WithReason<int> BreakPenaltyBetweenTokens(
   // TODO(fangism): ... except when () is used as precedence.
   if (right.format_token_enum == FormatTokenType::open_group)
     return {5, "right is open-group"};
+  // Prefer to keep ')' with whatever is on the left.
+  if (right.format_token_enum == FormatTokenType::close_group ||
+      right.TokenEnum() == verilog_tokentype::MacroCallCloseToEndLine)
+    return {10, "right is close-group"};
 
   if (left.TokenEnum() == TK_DecNumber &&
       right.TokenEnum() == TK_UnBasedNumber) {