diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst --- a/clang/docs/ClangFormatStyleOptions.rst +++ b/clang/docs/ClangFormatStyleOptions.rst @@ -5069,9 +5069,12 @@ The number of spaces before trailing line comments (``//`` - comments). - This does not affect trailing block comments (``/*`` - comments) as - those commonly have different usage patterns and a number of special - cases. + This does not affect trailing block comments (``/*`` - comments) as those + commonly have different usage patterns and a number of special cases. In + the case of Verilog, it doesn't affect a comment right after the opening + parenthesis in the port or parameter list in a module header, because it + is probably for the port on the following line instead of the parenthesis + it follows. .. code-block:: c++ diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h --- a/clang/include/clang/Format/Format.h +++ b/clang/include/clang/Format/Format.h @@ -4019,9 +4019,12 @@ /// The number of spaces before trailing line comments /// (``//`` - comments). /// - /// This does not affect trailing block comments (``/*`` - comments) as - /// those commonly have different usage patterns and a number of special - /// cases. + /// This does not affect trailing block comments (``/*`` - comments) as those + /// commonly have different usage patterns and a number of special cases. In + /// the case of Verilog, it doesn't affect a comment right after the opening + /// parenthesis in the port or parameter list in a module header, because it + /// is probably for the port on the following line instead of the parenthesis + /// it follows. /// \code /// SpacesBeforeTrailingComments: 3 /// void f() { diff --git a/clang/lib/Format/ContinuationIndenter.cpp b/clang/lib/Format/ContinuationIndenter.cpp --- a/clang/lib/Format/ContinuationIndenter.cpp +++ b/clang/lib/Format/ContinuationIndenter.cpp @@ -748,7 +748,8 @@ !CurrentState.IsCSharpGenericTypeConstraint && Previous.opensScope() && Previous.isNot(TT_ObjCMethodExpr) && Previous.isNot(TT_RequiresClause) && !(Current.MacroParent && Previous.MacroParent) && - (Current.isNot(TT_LineComment) || Previous.is(BK_BracedInit))) { + (Current.isNot(TT_LineComment) || + Previous.isOneOf(BK_BracedInit, TT_VerilogMultiLineListLParen))) { CurrentState.Indent = State.Column + Spaces; CurrentState.IsAligned = true; } diff --git a/clang/lib/Format/FormatToken.h b/clang/lib/Format/FormatToken.h --- a/clang/lib/Format/FormatToken.h +++ b/clang/lib/Format/FormatToken.h @@ -156,6 +156,9 @@ /* list of port connections or parameters in a module instantiation */ \ TYPE(VerilogInstancePortComma) \ TYPE(VerilogInstancePortLParen) \ + /* A parenthesized list within which line breaks are inserted by the \ + * formatter, for example the list of ports in a module header. */ \ + TYPE(VerilogMultiLineListLParen) \ /* for the base in a number literal, not including the quote */ \ TYPE(VerilogNumberBase) \ /* like `(strong1, pull0)` */ \ diff --git a/clang/lib/Format/TokenAnnotator.cpp b/clang/lib/Format/TokenAnnotator.cpp --- a/clang/lib/Format/TokenAnnotator.cpp +++ b/clang/lib/Format/TokenAnnotator.cpp @@ -3312,6 +3312,8 @@ if (Prev->is(BK_BracedInit) && Prev->opensScope()) { Current->SpacesRequiredBefore = (Style.Cpp11BracedListStyle && !Style.SpacesInParentheses) ? 0 : 1; + } else if (Prev->is(TT_VerilogMultiLineListLParen)) { + Current->SpacesRequiredBefore = 0; } else { Current->SpacesRequiredBefore = Style.SpacesBeforeTrailingComments; } diff --git a/clang/lib/Format/UnwrappedLineParser.cpp b/clang/lib/Format/UnwrappedLineParser.cpp --- a/clang/lib/Format/UnwrappedLineParser.cpp +++ b/clang/lib/Format/UnwrappedLineParser.cpp @@ -4196,11 +4196,14 @@ if (FormatTok->is(Keywords.kw_verilogHash)) { NewLine(); nextToken(); - if (FormatTok->is(tok::l_paren)) + if (FormatTok->is(tok::l_paren)) { + FormatTok->setFinalizedType(TT_VerilogMultiLineListLParen); parseParens(); + } } if (FormatTok->is(tok::l_paren)) { NewLine(); + FormatTok->setFinalizedType(TT_VerilogMultiLineListLParen); parseParens(); } diff --git a/clang/unittests/Format/FormatTestVerilog.cpp b/clang/unittests/Format/FormatTestVerilog.cpp --- a/clang/unittests/Format/FormatTestVerilog.cpp +++ b/clang/unittests/Format/FormatTestVerilog.cpp @@ -517,6 +517,15 @@ " (input var x `a, //\n" " b);\n" "endmodule"); + // A line comment shouldn't disrupt the indentation of the port list. + verifyFormat("extern module x\n" + " (//\n" + " output y);"); + verifyFormat("extern module x\n" + " #(//\n" + " parameter x)\n" + " (//\n" + " output y);"); // With a concatenation in the names. auto Style = getDefaultStyle(); Style.ColumnLimit = 40;