[clang-format] Refactor SpaceBeforeParens to add options

The coding style of some projects requires to have more control on space
before opening parentheses.
The goal is to add the support of clang-format to more projects.
For example adding a space only for function definitions or
declarations.
This revision adds SpaceBeforeParensOptions to configure each option
independently from one another.

Differentiel Revision: https://reviews.llvm.org/D110833
This commit is contained in:
C. Rayroud 2021-11-07 20:56:35 +01:00 committed by Björn Schäpers
parent 6633605691
commit 6facafe7da
6 changed files with 453 additions and 50 deletions

View File

@ -3618,7 +3618,7 @@ the configuration (without a prefix: ``Auto``).
true: false: true: false:
class Foo : Bar {} vs. class Foo: Bar {} class Foo : Bar {} vs. class Foo: Bar {}
**SpaceBeforeParens** (``SpaceBeforeParensOptions``) :versionbadge:`clang-format 3.5` **SpaceBeforeParens** (``SpaceBeforeParensStyle``) :versionbadge:`clang-format 3.5`
Defines in which cases to put a space before opening parentheses. Defines in which cases to put a space before opening parentheses.
Possible values: Possible values:
@ -3688,6 +3688,78 @@ the configuration (without a prefix: ``Auto``).
} }
} }
* ``SBPO_Custom`` (in configuration: ``Custom``)
Configure each individual space before parentheses in
`SpaceBeforeParensOptions`.
**SpaceBeforeParensOptions** (``SpaceBeforeParensCustom``) :versionbadge:`clang-format 14`
Control of individual space before parentheses.
If ``SpaceBeforeParens`` is set to ``Custom``, use this to specify
how each individual space before parentheses case should be handled.
Otherwise, this is ignored.
.. code-block:: yaml
# Example of usage:
SpaceBeforeParens: Custom
SpaceBeforeParensOptions:
AfterControlStatements: true
AfterFunctionDefinitionName: true
Nested configuration flags:
* ``bool AfterControlStatements`` If ``true``, put space betwee control statement keywords
(for/if/while...) and opening parentheses.
.. code-block:: c++
true: false:
if (...) {} vs. if(...) {}
* ``bool AfterForeachMacros`` If ``true``, put space between foreach macros and opening parentheses.
.. code-block:: c++
true: false:
FOREACH (...) vs. FOREACH(...)
<loop-body> <loop-body>
* ``bool AfterFunctionDeclarationName`` If ``true``, put a space between function declaration name and opening
parentheses.
.. code-block:: c++
true: false:
void f (); vs. void f();
* ``bool AfterFunctionDefinitionName`` If ``true``, put a space between function definition name and opening
parentheses.
.. code-block:: c++
true: false:
void f () {} vs. void f() {}
* ``bool AfterIfMacros`` If ``true``, put space between if macros and opening parentheses.
.. code-block:: c++
true: false:
IF (...) vs. IF(...)
<conditional-body> <conditional-body>
* ``bool BeforeNonEmptyParentheses`` If ``true``, put a space before opening parentheses only if the
parentheses are not empty.
.. code-block:: c++
true: false:
void f (int a); vs. void f();
f (a); f();
**SpaceBeforeRangeBasedForLoopColon** (``Boolean``) :versionbadge:`clang-format 7` **SpaceBeforeRangeBasedForLoopColon** (``Boolean``) :versionbadge:`clang-format 7`

View File

@ -244,6 +244,10 @@ clang-format
`const` `volatile` `static` `inline` `constexpr` `restrict` `const` `volatile` `static` `inline` `constexpr` `restrict`
to be controlled relative to the `type`. to be controlled relative to the `type`.
- Add a ``Custom`` style to ``SpaceBeforeParens``, to better configure the
space before parentheses. The custom options can be set using
``SpaceBeforeParensOptions``.
libclang libclang
-------- --------

View File

@ -3258,7 +3258,7 @@ struct FormatStyle {
bool SpaceBeforeInheritanceColon; bool SpaceBeforeInheritanceColon;
/// Different ways to put a space before opening parentheses. /// Different ways to put a space before opening parentheses.
enum SpaceBeforeParensOptions : unsigned char { enum SpaceBeforeParensStyle : unsigned char {
/// Never put a space before opening parentheses. /// Never put a space before opening parentheses.
/// \code /// \code
/// void f() { /// void f() {
@ -3313,12 +3313,100 @@ struct FormatStyle {
/// } /// }
/// } /// }
/// \endcode /// \endcode
SBPO_Always SBPO_Always,
/// Configure each individual space before parentheses in
/// `SpaceBeforeParensOptions`.
SBPO_Custom,
}; };
/// Defines in which cases to put a space before opening parentheses. /// Defines in which cases to put a space before opening parentheses.
/// \version 3.5 /// \version 3.5
SpaceBeforeParensOptions SpaceBeforeParens; SpaceBeforeParensStyle SpaceBeforeParens;
/// Precise control over the spacing before parentheses.
/// \code
/// # Should be declared this way:
/// SpaceBeforeParens: Custom
/// SpaceBeforeParensOptions:
/// AfterControlStatements: true
/// AfterFunctionDefinitionName: true
/// \endcode
struct SpaceBeforeParensCustom {
/// If ``true``, put space betwee control statement keywords
/// (for/if/while...) and opening parentheses.
/// \code
/// true: false:
/// if (...) {} vs. if(...) {}
/// \endcode
bool AfterControlStatements;
/// If ``true``, put space between foreach macros and opening parentheses.
/// \code
/// true: false:
/// FOREACH (...) vs. FOREACH(...)
/// <loop-body> <loop-body>
/// \endcode
bool AfterForeachMacros;
/// If ``true``, put a space between function declaration name and opening
/// parentheses.
/// \code
/// true: false:
/// void f (); vs. void f();
/// \endcode
bool AfterFunctionDeclarationName;
/// If ``true``, put a space between function definition name and opening
/// parentheses.
/// \code
/// true: false:
/// void f () {} vs. void f() {}
/// \endcode
bool AfterFunctionDefinitionName;
/// If ``true``, put space between if macros and opening parentheses.
/// \code
/// true: false:
/// IF (...) vs. IF(...)
/// <conditional-body> <conditional-body>
/// \endcode
bool AfterIfMacros;
/// If ``true``, put a space before opening parentheses only if the
/// parentheses are not empty.
/// \code
/// true: false:
/// void f (int a); vs. void f();
/// f (a); f();
/// \endcode
bool BeforeNonEmptyParentheses;
SpaceBeforeParensCustom()
: AfterControlStatements(false), AfterForeachMacros(false),
AfterFunctionDeclarationName(false),
AfterFunctionDefinitionName(false), AfterIfMacros(false),
BeforeNonEmptyParentheses(false) {}
bool operator==(const SpaceBeforeParensCustom &Other) const {
return AfterControlStatements == Other.AfterControlStatements &&
AfterForeachMacros == Other.AfterForeachMacros &&
AfterFunctionDeclarationName ==
Other.AfterFunctionDeclarationName &&
AfterFunctionDefinitionName == Other.AfterFunctionDefinitionName &&
AfterIfMacros == Other.AfterIfMacros &&
BeforeNonEmptyParentheses == Other.BeforeNonEmptyParentheses;
}
};
/// Control of individual space before parentheses.
///
/// If ``SpaceBeforeParens`` is set to ``Custom``, use this to specify
/// how each individual space before parentheses case should be handled.
/// Otherwise, this is ignored.
/// \code{.yaml}
/// # Example of usage:
/// SpaceBeforeParens: Custom
/// SpaceBeforeParensOptions:
/// AfterControlStatements: true
/// AfterFunctionDefinitionName: true
/// \endcode
/// \version 14
SpaceBeforeParensCustom SpaceBeforeParensOptions;
/// If ``false``, spaces will be removed before range-based for loop /// If ``false``, spaces will be removed before range-based for loop
/// colon. /// colon.
@ -3715,6 +3803,7 @@ struct FormatStyle {
R.SpaceBeforeCtorInitializerColon && R.SpaceBeforeCtorInitializerColon &&
SpaceBeforeInheritanceColon == R.SpaceBeforeInheritanceColon && SpaceBeforeInheritanceColon == R.SpaceBeforeInheritanceColon &&
SpaceBeforeParens == R.SpaceBeforeParens && SpaceBeforeParens == R.SpaceBeforeParens &&
SpaceBeforeParensOptions == R.SpaceBeforeParensOptions &&
SpaceAroundPointerQualifiers == R.SpaceAroundPointerQualifiers && SpaceAroundPointerQualifiers == R.SpaceAroundPointerQualifiers &&
SpaceBeforeRangeBasedForLoopColon == SpaceBeforeRangeBasedForLoopColon ==
R.SpaceBeforeRangeBasedForLoopColon && R.SpaceBeforeRangeBasedForLoopColon &&

View File

@ -451,9 +451,8 @@ struct ScalarEnumerationTraits<FormatStyle::ReferenceAlignmentStyle> {
}; };
template <> template <>
struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> { struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensStyle> {
static void enumeration(IO &IO, static void enumeration(IO &IO, FormatStyle::SpaceBeforeParensStyle &Value) {
FormatStyle::SpaceBeforeParensOptions &Value) {
IO.enumCase(Value, "Never", FormatStyle::SBPO_Never); IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
IO.enumCase(Value, "ControlStatements", IO.enumCase(Value, "ControlStatements",
FormatStyle::SBPO_ControlStatements); FormatStyle::SBPO_ControlStatements);
@ -462,6 +461,7 @@ struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensOptions> {
IO.enumCase(Value, "NonEmptyParentheses", IO.enumCase(Value, "NonEmptyParentheses",
FormatStyle::SBPO_NonEmptyParentheses); FormatStyle::SBPO_NonEmptyParentheses);
IO.enumCase(Value, "Always", FormatStyle::SBPO_Always); IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
IO.enumCase(Value, "Custom", FormatStyle::SBPO_Custom);
// For backward compatibility. // For backward compatibility.
IO.enumCase(Value, "false", FormatStyle::SBPO_Never); IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
@ -787,6 +787,7 @@ template <> struct MappingTraits<FormatStyle> {
IO.mapOptional("SpaceBeforeInheritanceColon", IO.mapOptional("SpaceBeforeInheritanceColon",
Style.SpaceBeforeInheritanceColon); Style.SpaceBeforeInheritanceColon);
IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens); IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
IO.mapOptional("SpaceBeforeParensOptions", Style.SpaceBeforeParensOptions);
IO.mapOptional("SpaceAroundPointerQualifiers", IO.mapOptional("SpaceAroundPointerQualifiers",
Style.SpaceAroundPointerQualifiers); Style.SpaceAroundPointerQualifiers);
IO.mapOptional("SpaceBeforeRangeBasedForLoopColon", IO.mapOptional("SpaceBeforeRangeBasedForLoopColon",
@ -845,6 +846,20 @@ template <> struct MappingTraits<FormatStyle::BraceWrappingFlags> {
} }
}; };
template <> struct MappingTraits<FormatStyle::SpaceBeforeParensCustom> {
static void mapping(IO &IO, FormatStyle::SpaceBeforeParensCustom &Spacing) {
IO.mapOptional("AfterControlStatements", Spacing.AfterControlStatements);
IO.mapOptional("AfterForeachMacros", Spacing.AfterForeachMacros);
IO.mapOptional("AfterFunctionDefinitionName",
Spacing.AfterFunctionDefinitionName);
IO.mapOptional("AfterFunctionDeclarationName",
Spacing.AfterFunctionDeclarationName);
IO.mapOptional("AfterIfMacros", Spacing.AfterIfMacros);
IO.mapOptional("BeforeNonEmptyParentheses",
Spacing.BeforeNonEmptyParentheses);
}
};
template <> struct MappingTraits<FormatStyle::RawStringFormat> { template <> struct MappingTraits<FormatStyle::RawStringFormat> {
static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) { static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) {
IO.mapOptional("Language", Format.Language); IO.mapOptional("Language", Format.Language);
@ -939,10 +954,9 @@ std::string ParseErrorCategory::message(int EV) const {
llvm_unreachable("unexpected parse error"); llvm_unreachable("unexpected parse error");
} }
static FormatStyle expandPresets(const FormatStyle &Style) { static void expandPresetsBraceWrapping(FormatStyle &Expanded) {
if (Style.BreakBeforeBraces == FormatStyle::BS_Custom) if (Expanded.BreakBeforeBraces == FormatStyle::BS_Custom)
return Style; return;
FormatStyle Expanded = Style;
Expanded.BraceWrapping = {/*AfterCaseLabel=*/false, Expanded.BraceWrapping = {/*AfterCaseLabel=*/false,
/*AfterClass=*/false, /*AfterClass=*/false,
/*AfterControlStatement=*/FormatStyle::BWACS_Never, /*AfterControlStatement=*/FormatStyle::BWACS_Never,
@ -961,7 +975,7 @@ static FormatStyle expandPresets(const FormatStyle &Style) {
/*SplitEmptyFunction=*/true, /*SplitEmptyFunction=*/true,
/*SplitEmptyRecord=*/true, /*SplitEmptyRecord=*/true,
/*SplitEmptyNamespace=*/true}; /*SplitEmptyNamespace=*/true};
switch (Style.BreakBeforeBraces) { switch (Expanded.BreakBeforeBraces) {
case FormatStyle::BS_Linux: case FormatStyle::BS_Linux:
Expanded.BraceWrapping.AfterClass = true; Expanded.BraceWrapping.AfterClass = true;
Expanded.BraceWrapping.AfterFunction = true; Expanded.BraceWrapping.AfterFunction = true;
@ -1042,7 +1056,33 @@ static FormatStyle expandPresets(const FormatStyle &Style) {
default: default:
break; break;
} }
return Expanded; }
static void expandPresetsSpaceBeforeParens(FormatStyle &Expanded) {
if (Expanded.SpaceBeforeParens == FormatStyle::SBPO_Custom)
return;
// Reset all flags
Expanded.SpaceBeforeParensOptions = {};
switch (Expanded.SpaceBeforeParens) {
case FormatStyle::SBPO_Never:
break;
case FormatStyle::SBPO_ControlStatements:
Expanded.SpaceBeforeParensOptions.AfterControlStatements = true;
Expanded.SpaceBeforeParensOptions.AfterForeachMacros = true;
Expanded.SpaceBeforeParensOptions.AfterIfMacros = true;
break;
case FormatStyle::SBPO_ControlStatementsExceptControlMacros:
Expanded.SpaceBeforeParensOptions.AfterControlStatements = true;
break;
case FormatStyle::SBPO_NonEmptyParentheses:
Expanded.SpaceBeforeParensOptions.BeforeNonEmptyParentheses = true;
break;
case FormatStyle::SBPO_Always:
break;
default:
break;
}
} }
FormatStyle getLLVMStyle(FormatStyle::LanguageKind Language) { FormatStyle getLLVMStyle(FormatStyle::LanguageKind Language) {
@ -1174,6 +1214,9 @@ FormatStyle getLLVMStyle(FormatStyle::LanguageKind Language) {
LLVMStyle.SpaceBeforeCtorInitializerColon = true; LLVMStyle.SpaceBeforeCtorInitializerColon = true;
LLVMStyle.SpaceBeforeInheritanceColon = true; LLVMStyle.SpaceBeforeInheritanceColon = true;
LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements; LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
LLVMStyle.SpaceBeforeParensOptions.AfterControlStatements = true;
LLVMStyle.SpaceBeforeParensOptions.AfterForeachMacros = true;
LLVMStyle.SpaceBeforeParensOptions.AfterIfMacros = true;
LLVMStyle.SpaceBeforeRangeBasedForLoopColon = true; LLVMStyle.SpaceBeforeRangeBasedForLoopColon = true;
LLVMStyle.SpaceBeforeAssignmentOperators = true; LLVMStyle.SpaceBeforeAssignmentOperators = true;
LLVMStyle.SpaceBeforeCpp11BracedList = false; LLVMStyle.SpaceBeforeCpp11BracedList = false;
@ -1649,8 +1692,11 @@ std::string configurationAsText(const FormatStyle &Style) {
llvm::yaml::Output Output(Stream); llvm::yaml::Output Output(Stream);
// We use the same mapping method for input and output, so we need a non-const // We use the same mapping method for input and output, so we need a non-const
// reference here. // reference here.
FormatStyle NonConstStyle = expandPresets(Style); FormatStyle NonConstStyle = Style;
expandPresetsBraceWrapping(NonConstStyle);
expandPresetsSpaceBeforeParens(NonConstStyle);
Output << NonConstStyle; Output << NonConstStyle;
return Stream.str(); return Stream.str();
} }
@ -2929,7 +2975,9 @@ reformat(const FormatStyle &Style, StringRef Code,
ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn, ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName, unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
FormattingAttemptStatus *Status) { FormattingAttemptStatus *Status) {
FormatStyle Expanded = expandPresets(Style); FormatStyle Expanded = Style;
expandPresetsBraceWrapping(Expanded);
expandPresetsSpaceBeforeParens(Expanded);
if (Expanded.DisableFormat) if (Expanded.DisableFormat)
return {tooling::Replacements(), 0}; return {tooling::Replacements(), 0};
if (isLikelyXml(Code)) if (isLikelyXml(Code))

View File

@ -2906,7 +2906,7 @@ unsigned TokenAnnotator::splitPenalty(const AnnotatedLine &Line,
bool TokenAnnotator::spaceRequiredBeforeParens(const FormatToken &Right) const { bool TokenAnnotator::spaceRequiredBeforeParens(const FormatToken &Right) const {
return Style.SpaceBeforeParens == FormatStyle::SBPO_Always || return Style.SpaceBeforeParens == FormatStyle::SBPO_Always ||
(Style.SpaceBeforeParens == FormatStyle::SBPO_NonEmptyParentheses && (Style.SpaceBeforeParensOptions.BeforeNonEmptyParentheses &&
Right.ParameterCount > 0); Right.ParameterCount > 0);
} }
@ -2940,9 +2940,6 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
return true; return true;
} }
// requires ( or requires(
if (Right.is(tok::l_paren) && Left.is(tok::kw_requires))
return spaceRequiredBeforeParens(Right);
// requires clause Concept1<T> && Concept2<T> // requires clause Concept1<T> && Concept2<T>
if (Left.is(TT_ConstraintJunctions) && Right.is(tok::identifier)) if (Left.is(TT_ConstraintJunctions) && Right.is(tok::identifier))
return true; return true;
@ -3134,33 +3131,60 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
// e.g. template <typename T> [[nodiscard]] ... // e.g. template <typename T> [[nodiscard]] ...
if (Left.is(TT_TemplateCloser) && Right.is(TT_AttributeSquare)) if (Left.is(TT_TemplateCloser) && Right.is(TT_AttributeSquare))
return true; return true;
// Space before parentheses common for all languages
if (Right.is(tok::l_paren)) { if (Right.is(tok::l_paren)) {
if (Left.is(TT_TemplateCloser) && Right.isNot(TT_FunctionTypeLParen))
return spaceRequiredBeforeParens(Right);
if (Left.is(tok::kw_requires))
return spaceRequiredBeforeParens(Right);
if ((Left.is(tok::r_paren) && Left.is(TT_AttributeParen)) || if ((Left.is(tok::r_paren) && Left.is(TT_AttributeParen)) ||
(Left.is(tok::r_square) && Left.is(TT_AttributeSquare))) (Left.is(tok::r_square) && Left.is(TT_AttributeSquare)))
return true; return true;
if (Style.SpaceBeforeParens == if (Left.is(TT_ForEachMacro))
FormatStyle::SBPO_ControlStatementsExceptControlMacros && return (Style.SpaceBeforeParensOptions.AfterForeachMacros ||
Left.is(TT_ForEachMacro)) spaceRequiredBeforeParens(Right));
return false; if (Left.is(TT_IfMacro))
if (Style.SpaceBeforeParens == return (Style.SpaceBeforeParensOptions.AfterIfMacros ||
FormatStyle::SBPO_ControlStatementsExceptControlMacros && spaceRequiredBeforeParens(Right));
Left.is(TT_IfMacro)) if (Line.Type == LT_ObjCDecl)
return false; return true;
return Line.Type == LT_ObjCDecl || Left.is(tok::semi) || if (Left.is(tok::semi))
(Style.SpaceBeforeParens != FormatStyle::SBPO_Never && return true;
(Left.isOneOf(tok::pp_elif, tok::kw_for, tok::kw_while, if (Left.isOneOf(tok::pp_elif, tok::kw_for, tok::kw_while, tok::kw_switch,
tok::kw_switch, tok::kw_case, TT_ForEachMacro, tok::kw_case, TT_ForEachMacro, TT_ObjCForIn))
TT_ObjCForIn) || return Style.SpaceBeforeParensOptions.AfterControlStatements ||
Left.isIf(Line.Type != LT_PreprocessorDirective) || spaceRequiredBeforeParens(Right);
(Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch, if (Left.isIf(Line.Type != LT_PreprocessorDirective))
tok::kw_new, tok::kw_delete) && return Style.SpaceBeforeParensOptions.AfterControlStatements ||
(!Left.Previous || Left.Previous->isNot(tok::period))))) || spaceRequiredBeforeParens(Right);
(spaceRequiredBeforeParens(Right) && // Function declaration or definition
if (Line.MightBeFunctionDecl && (Left.is(TT_FunctionDeclarationName) ||
Right.is(TT_OverloadedOperatorLParen))) {
if (Line.mightBeFunctionDefinition())
return Style.SpaceBeforeParensOptions.AfterFunctionDefinitionName ||
spaceRequiredBeforeParens(Right);
else
return Style.SpaceBeforeParensOptions.AfterFunctionDeclarationName ||
spaceRequiredBeforeParens(Right);
}
// Lambda
if (Line.Type != LT_PreprocessorDirective && Left.is(tok::r_square) &&
Left.MatchingParen && Left.MatchingParen->is(TT_LambdaLSquare))
return Style.SpaceBeforeParensOptions.AfterFunctionDefinitionName ||
spaceRequiredBeforeParens(Right);
if (!Left.Previous || Left.Previous->isNot(tok::period)) {
if (Left.isOneOf(tok::kw_try, Keywords.kw___except, tok::kw_catch))
return Style.SpaceBeforeParensOptions.AfterControlStatements ||
spaceRequiredBeforeParens(Right);
if (Left.isOneOf(tok::kw_new, tok::kw_delete))
return Style.SpaceBeforeParens != FormatStyle::SBPO_Never ||
spaceRequiredBeforeParens(Right);
}
if (Line.Type != LT_PreprocessorDirective &&
(Left.is(tok::identifier) || Left.isFunctionLikeKeyword() || (Left.is(tok::identifier) || Left.isFunctionLikeKeyword() ||
Left.is(tok::r_paren) || Left.isSimpleTypeSpecifier() || Left.is(tok::r_paren) || Left.isSimpleTypeSpecifier()))
(Left.is(tok::r_square) && Left.MatchingParen && return spaceRequiredBeforeParens(Right);
Left.MatchingParen->is(TT_LambdaLSquare))) && return false;
Line.Type != LT_PreprocessorDirective);
} }
if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword) if (Left.is(tok::at) && Right.Tok.getObjCKeywordID() != tok::objc_not_keyword)
return false; return false;
@ -3202,6 +3226,7 @@ bool TokenAnnotator::spaceRequiredBetween(const AnnotatedLine &Line,
// qualifiers such as // qualifiers such as
// void Fn() const &; // void Fn() const &;
return getTokenReferenceAlignment(Right) != FormatStyle::PAS_Left; return getTokenReferenceAlignment(Right) != FormatStyle::PAS_Left;
return true; return true;
} }
@ -3307,7 +3332,7 @@ bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
if (Right.is(tok::l_paren)) if (Right.is(tok::l_paren))
if (Left.isOneOf(tok::kw_using, Keywords.kw_async, Keywords.kw_when, if (Left.isOneOf(tok::kw_using, Keywords.kw_async, Keywords.kw_when,
Keywords.kw_lock)) Keywords.kw_lock))
return Style.SpaceBeforeParens == FormatStyle::SBPO_ControlStatements || return Style.SpaceBeforeParensOptions.AfterControlStatements ||
spaceRequiredBeforeParens(Right); spaceRequiredBeforeParens(Right);
// space between method modifier and opening parenthesis of a tuple return // space between method modifier and opening parenthesis of a tuple return
@ -3414,7 +3439,8 @@ bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
if (Left.is(tok::r_square) && Right.is(tok::l_brace)) if (Left.is(tok::r_square) && Right.is(tok::l_brace))
return true; return true;
if (Left.is(Keywords.kw_synchronized) && Right.is(tok::l_paren)) if (Left.is(Keywords.kw_synchronized) && Right.is(tok::l_paren))
return Style.SpaceBeforeParens != FormatStyle::SBPO_Never; return Style.SpaceBeforeParensOptions.AfterControlStatements ||
spaceRequiredBeforeParens(Right);
if ((Left.isOneOf(tok::kw_static, tok::kw_public, tok::kw_private, if ((Left.isOneOf(tok::kw_static, tok::kw_public, tok::kw_private,
tok::kw_protected) || tok::kw_protected) ||
Left.isOneOf(Keywords.kw_final, Keywords.kw_abstract, Left.isOneOf(Keywords.kw_final, Keywords.kw_abstract,
@ -3440,9 +3466,7 @@ bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
if (Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow) || if (Right.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow) ||
Left.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow)) Left.isOneOf(TT_TrailingReturnArrow, TT_LambdaArrow))
return true; return true;
if (Right.is(TT_OverloadedOperatorLParen)) if (Left.is(tok::comma) && !Right.is(TT_OverloadedOperatorLParen))
return spaceRequiredBeforeParens(Right);
if (Left.is(tok::comma))
return true; return true;
if (Right.is(tok::comma)) if (Right.is(tok::comma))
return false; return false;
@ -3565,9 +3589,6 @@ bool TokenAnnotator::spaceRequiredBefore(const AnnotatedLine &Line,
(Left.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) && (Left.isOneOf(TT_BinaryOperator, TT_ConditionalExpr) &&
!Right.is(tok::r_paren))) !Right.is(tok::r_paren)))
return true; return true;
if (Left.is(TT_TemplateCloser) && Right.is(tok::l_paren) &&
Right.isNot(TT_FunctionTypeLParen))
return spaceRequiredBeforeParens(Right);
if (Right.is(TT_TemplateOpener) && Left.is(tok::r_paren) && if (Right.is(TT_TemplateOpener) && Left.is(tok::r_paren) &&
Left.MatchingParen && Left.MatchingParen->is(TT_OverloadedOperatorLParen)) Left.MatchingParen && Left.MatchingParen->is(TT_OverloadedOperatorLParen))
return false; return false;

View File

@ -14133,6 +14133,173 @@ TEST_F(FormatTest, ConfigurableSpaceBeforeParens) {
verifyFormat("X A::operator++ (T);", SomeSpace); verifyFormat("X A::operator++ (T);", SomeSpace);
verifyFormat("int x = int (y);", SomeSpace); verifyFormat("int x = int (y);", SomeSpace);
verifyFormat("auto lambda = []() { return 0; };", SomeSpace); verifyFormat("auto lambda = []() { return 0; };", SomeSpace);
FormatStyle SpaceControlStatements = getLLVMStyle();
SpaceControlStatements.SpaceBeforeParens = FormatStyle::SBPO_Custom;
SpaceControlStatements.SpaceBeforeParensOptions.AfterControlStatements = true;
verifyFormat("while (true)\n"
" continue;",
SpaceControlStatements);
verifyFormat("if (true)\n"
" f();\n"
"else if (true)\n"
" f();",
SpaceControlStatements);
verifyFormat("for (;;) {\n"
" do_something();\n"
"}",
SpaceControlStatements);
verifyFormat("do {\n"
" do_something();\n"
"} while (something());",
SpaceControlStatements);
verifyFormat("switch (x) {\n"
"default:\n"
" break;\n"
"}",
SpaceControlStatements);
FormatStyle SpaceFuncDecl = getLLVMStyle();
SpaceFuncDecl.SpaceBeforeParens = FormatStyle::SBPO_Custom;
SpaceFuncDecl.SpaceBeforeParensOptions.AfterFunctionDeclarationName = true;
verifyFormat("int f ();", SpaceFuncDecl);
verifyFormat("void f(int a, T b) {}", SpaceFuncDecl);
verifyFormat("A::A() : a(1) {}", SpaceFuncDecl);
verifyFormat("void f () __attribute__((asdf));", SpaceFuncDecl);
verifyFormat("#define A(x) x", SpaceFuncDecl);
verifyFormat("#define A (x) x", SpaceFuncDecl);
verifyFormat("#if defined(x)\n"
"#endif",
SpaceFuncDecl);
verifyFormat("auto i = std::make_unique<int>(5);", SpaceFuncDecl);
verifyFormat("size_t x = sizeof(x);", SpaceFuncDecl);
verifyFormat("auto f (int x) -> decltype(x);", SpaceFuncDecl);
verifyFormat("auto f (int x) -> typeof(x);", SpaceFuncDecl);
verifyFormat("auto f (int x) -> _Atomic(x);", SpaceFuncDecl);
verifyFormat("auto f (int x) -> __underlying_type(x);", SpaceFuncDecl);
verifyFormat("int f (T x) noexcept(x.create());", SpaceFuncDecl);
verifyFormat("alignas(128) char a[128];", SpaceFuncDecl);
verifyFormat("size_t x = alignof(MyType);", SpaceFuncDecl);
verifyFormat("static_assert(sizeof(char) == 1, \"Impossible!\");",
SpaceFuncDecl);
verifyFormat("int f () throw(Deprecated);", SpaceFuncDecl);
verifyFormat("typedef void (*cb)(int);", SpaceFuncDecl);
verifyFormat("T A::operator() ();", SpaceFuncDecl);
verifyFormat("X A::operator++ (T);", SpaceFuncDecl);
verifyFormat("T A::operator()() {}", SpaceFuncDecl);
verifyFormat("auto lambda = []() { return 0; };", SpaceFuncDecl);
verifyFormat("int x = int(y);", SpaceFuncDecl);
verifyFormat("M(std::size_t R, std::size_t C) : C(C), data(R) {}",
SpaceFuncDecl);
FormatStyle SpaceFuncDef = getLLVMStyle();
SpaceFuncDef.SpaceBeforeParens = FormatStyle::SBPO_Custom;
SpaceFuncDef.SpaceBeforeParensOptions.AfterFunctionDefinitionName = true;
verifyFormat("int f();", SpaceFuncDef);
verifyFormat("void f (int a, T b) {}", SpaceFuncDef);
verifyFormat("A::A() : a(1) {}", SpaceFuncDef);
verifyFormat("void f() __attribute__((asdf));", SpaceFuncDef);
verifyFormat("#define A(x) x", SpaceFuncDef);
verifyFormat("#define A (x) x", SpaceFuncDef);
verifyFormat("#if defined(x)\n"
"#endif",
SpaceFuncDef);
verifyFormat("auto i = std::make_unique<int>(5);", SpaceFuncDef);
verifyFormat("size_t x = sizeof(x);", SpaceFuncDef);
verifyFormat("auto f(int x) -> decltype(x);", SpaceFuncDef);
verifyFormat("auto f(int x) -> typeof(x);", SpaceFuncDef);
verifyFormat("auto f(int x) -> _Atomic(x);", SpaceFuncDef);
verifyFormat("auto f(int x) -> __underlying_type(x);", SpaceFuncDef);
verifyFormat("int f(T x) noexcept(x.create());", SpaceFuncDef);
verifyFormat("alignas(128) char a[128];", SpaceFuncDef);
verifyFormat("size_t x = alignof(MyType);", SpaceFuncDef);
verifyFormat("static_assert(sizeof(char) == 1, \"Impossible!\");",
SpaceFuncDef);
verifyFormat("int f() throw(Deprecated);", SpaceFuncDef);
verifyFormat("typedef void (*cb)(int);", SpaceFuncDef);
verifyFormat("T A::operator()();", SpaceFuncDef);
verifyFormat("X A::operator++(T);", SpaceFuncDef);
verifyFormat("T A::operator() () {}", SpaceFuncDef);
verifyFormat("auto lambda = [] () { return 0; };", SpaceFuncDef);
verifyFormat("int x = int(y);", SpaceFuncDef);
verifyFormat("M(std::size_t R, std::size_t C) : C(C), data(R) {}",
SpaceFuncDef);
FormatStyle SpaceIfMacros = getLLVMStyle();
SpaceIfMacros.IfMacros.clear();
SpaceIfMacros.IfMacros.push_back("MYIF");
SpaceIfMacros.SpaceBeforeParens = FormatStyle::SBPO_Custom;
SpaceIfMacros.SpaceBeforeParensOptions.AfterIfMacros = true;
verifyFormat("MYIF (a)\n return;", SpaceIfMacros);
verifyFormat("MYIF (a)\n return;\nelse MYIF (b)\n return;", SpaceIfMacros);
verifyFormat("MYIF (a)\n return;\nelse\n return;", SpaceIfMacros);
FormatStyle SpaceForeachMacros = getLLVMStyle();
SpaceForeachMacros.SpaceBeforeParens = FormatStyle::SBPO_Custom;
SpaceForeachMacros.SpaceBeforeParensOptions.AfterForeachMacros = true;
verifyFormat("foreach (Item *item, itemlist) {}", SpaceForeachMacros);
verifyFormat("Q_FOREACH (Item *item, itemlist) {}", SpaceForeachMacros);
verifyFormat("BOOST_FOREACH (Item *item, itemlist) {}", SpaceForeachMacros);
verifyFormat("UNKNOWN_FOREACH(Item *item, itemlist) {}", SpaceForeachMacros);
FormatStyle SomeSpace2 = getLLVMStyle();
SomeSpace2.SpaceBeforeParens = FormatStyle::SBPO_Custom;
SomeSpace2.SpaceBeforeParensOptions.BeforeNonEmptyParentheses = true;
verifyFormat("[]() -> float {}", SomeSpace2);
verifyFormat("[] (auto foo) {}", SomeSpace2);
verifyFormat("[foo]() -> int {}", SomeSpace2);
verifyFormat("int f();", SomeSpace2);
verifyFormat("void f (int a, T b) {\n"
" while (true)\n"
" continue;\n"
"}",
SomeSpace2);
verifyFormat("if (true)\n"
" f();\n"
"else if (true)\n"
" f();",
SomeSpace2);
verifyFormat("do {\n"
" do_something();\n"
"} while (something());",
SomeSpace2);
verifyFormat("switch (x) {\n"
"default:\n"
" break;\n"
"}",
SomeSpace2);
verifyFormat("A::A() : a (1) {}", SomeSpace2);
verifyFormat("void f() __attribute__ ((asdf));", SomeSpace2);
verifyFormat("*(&a + 1);\n"
"&((&a)[1]);\n"
"a[(b + c) * d];\n"
"(((a + 1) * 2) + 3) * 4;",
SomeSpace2);
verifyFormat("#define A(x) x", SomeSpace2);
verifyFormat("#define A (x) x", SomeSpace2);
verifyFormat("#if defined(x)\n"
"#endif",
SomeSpace2);
verifyFormat("auto i = std::make_unique<int> (5);", SomeSpace2);
verifyFormat("size_t x = sizeof (x);", SomeSpace2);
verifyFormat("auto f (int x) -> decltype (x);", SomeSpace2);
verifyFormat("auto f (int x) -> typeof (x);", SomeSpace2);
verifyFormat("auto f (int x) -> _Atomic (x);", SomeSpace2);
verifyFormat("auto f (int x) -> __underlying_type (x);", SomeSpace2);
verifyFormat("int f (T x) noexcept (x.create());", SomeSpace2);
verifyFormat("alignas (128) char a[128];", SomeSpace2);
verifyFormat("size_t x = alignof (MyType);", SomeSpace2);
verifyFormat("static_assert (sizeof (char) == 1, \"Impossible!\");",
SomeSpace2);
verifyFormat("int f() throw (Deprecated);", SomeSpace2);
verifyFormat("typedef void (*cb) (int);", SomeSpace2);
verifyFormat("T A::operator()();", SomeSpace2);
verifyFormat("X A::operator++ (T);", SomeSpace2);
verifyFormat("int x = int (y);", SomeSpace2);
verifyFormat("auto lambda = []() { return 0; };", SomeSpace2);
} }
TEST_F(FormatTest, SpaceAfterLogicalNot) { TEST_F(FormatTest, SpaceAfterLogicalNot) {
@ -18631,6 +18798,8 @@ TEST_F(FormatTest, ParsesConfiguration) {
FormatStyle::SBPO_ControlStatementsExceptControlMacros); FormatStyle::SBPO_ControlStatementsExceptControlMacros);
CHECK_PARSE("SpaceBeforeParens: NonEmptyParentheses", SpaceBeforeParens, CHECK_PARSE("SpaceBeforeParens: NonEmptyParentheses", SpaceBeforeParens,
FormatStyle::SBPO_NonEmptyParentheses); FormatStyle::SBPO_NonEmptyParentheses);
CHECK_PARSE("SpaceBeforeParens: Custom", SpaceBeforeParens,
FormatStyle::SBPO_Custom);
// For backward compatibility: // For backward compatibility:
CHECK_PARSE("SpaceAfterControlStatementKeyword: false", SpaceBeforeParens, CHECK_PARSE("SpaceAfterControlStatementKeyword: false", SpaceBeforeParens,
FormatStyle::SBPO_Never); FormatStyle::SBPO_Never);