Skip to content

[clang-format] Add an option for editing enum trailing commas #133576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 30, 2025
Merged

[clang-format] Add an option for editing enum trailing commas #133576

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3b35212
[clang-format] Add an option for editing enum trailing commas
owenca Mar 29, 2025
9e16e89
Add a warning and refactor the code that removes/replaces a token
owenca Mar 29, 2025
7cf3994
Change `const char *` to `StringRef`
owenca Mar 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions clang/docs/ClangFormatStyleOptions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3982,6 +3982,13 @@ the configuration (without a prefix: ``Auto``).
Insert a comma (if missing) or remove the comma at the end of an ``enum``
enumerator list.

.. warning::

Setting this option to any value other than ``Leave`` could lead to
incorrect code formatting due to clang-format's lack of complete semantic
information. As such, extra care should be taken to review code changes
made by this option.

Possible values:

* ``ETC_Leave`` (in configuration: ``Leave``)
Expand Down
6 changes: 6 additions & 0 deletions clang/include/clang/Format/Format.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2728,6 +2728,12 @@ struct FormatStyle {

/// Insert a comma (if missing) or remove the comma at the end of an ``enum``
/// enumerator list.
/// \warning
/// Setting this option to any value other than ``Leave`` could lead to
/// incorrect code formatting due to clang-format's lack of complete semantic
/// information. As such, extra care should be taken to review code changes
/// made by this option.
/// \endwarning
/// \version 21
EnumTrailingCommaStyle EnumTrailingComma;

Expand Down
83 changes: 26 additions & 57 deletions clang/lib/Format/Format.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2214,6 +2214,21 @@ FormatStyle::GetLanguageStyle(FormatStyle::LanguageKind Language) const {

namespace {

void replaceToken(const FormatToken &Token, FormatToken *Next,
const SourceManager &SourceMgr, tooling::Replacements &Result,
const char *Text = "") {
const auto &Tok = Token.Tok;
SourceLocation Start;
if (Next && Next->NewlinesBefore == 0 && Next->isNot(tok::eof)) {
Start = Tok.getLocation();
Next->WhitespaceRange = Token.WhitespaceRange;
} else {
Start = Token.WhitespaceRange.getBegin();
}
const auto &Range = CharSourceRange::getCharRange(Start, Tok.getEndLoc());
cantFail(Result.add(tooling::Replacement(SourceMgr, Range, Text)));
}

class ParensRemover : public TokenAnalyzer {
public:
ParensRemover(const Environment &Env, const FormatStyle &Style)
Expand All @@ -2240,20 +2255,8 @@ class ParensRemover : public TokenAnalyzer {
continue;
for (const auto *Token = Line->First; Token && !Token->Finalized;
Token = Token->Next) {
if (!Token->Optional || !Token->isOneOf(tok::l_paren, tok::r_paren))
continue;
auto *Next = Token->Next;
assert(Next && Next->isNot(tok::eof));
SourceLocation Start;
if (Next->NewlinesBefore == 0) {
Start = Token->Tok.getLocation();
Next->WhitespaceRange = Token->WhitespaceRange;
} else {
Start = Token->WhitespaceRange.getBegin();
}
const auto &Range =
CharSourceRange::getCharRange(Start, Token->Tok.getEndLoc());
cantFail(Result.add(tooling::Replacement(SourceMgr, Range, " ")));
if (Token->Optional && Token->isOneOf(tok::l_paren, tok::r_paren))
replaceToken(*Token, Token->Next, SourceMgr, Result, " ");
}
}
}
Expand Down Expand Up @@ -2342,24 +2345,13 @@ class BracesRemover : public TokenAnalyzer {
const auto *NextLine = I + 1 == End ? nullptr : I[1];
for (const auto *Token = Line->First; Token && !Token->Finalized;
Token = Token->Next) {
if (!Token->Optional)
continue;
if (!Token->isOneOf(tok::l_brace, tok::r_brace))
if (!Token->Optional || !Token->isOneOf(tok::l_brace, tok::r_brace))
continue;
auto *Next = Token->Next;
assert(Next || Token == Line->Last);
if (!Next && NextLine)
Next = NextLine->First;
SourceLocation Start;
if (Next && Next->NewlinesBefore == 0 && Next->isNot(tok::eof)) {
Start = Token->Tok.getLocation();
Next->WhitespaceRange = Token->WhitespaceRange;
} else {
Start = Token->WhitespaceRange.getBegin();
}
const auto &Range =
CharSourceRange::getCharRange(Start, Token->Tok.getEndLoc());
cantFail(Result.add(tooling::Replacement(SourceMgr, Range, "")));
replaceToken(*Token, Next, SourceMgr, Result);
}
}
}
Expand Down Expand Up @@ -2411,16 +2403,7 @@ class SemiRemover : public TokenAnalyzer {
assert(Next || Token == Line->Last);
if (!Next && NextLine)
Next = NextLine->First;
SourceLocation Start;
if (Next && Next->NewlinesBefore == 0 && Next->isNot(tok::eof)) {
Start = Token->Tok.getLocation();
Next->WhitespaceRange = Token->WhitespaceRange;
} else {
Start = Token->WhitespaceRange.getBegin();
}
const auto &Range =
CharSourceRange::getCharRange(Start, Token->Tok.getEndLoc());
cantFail(Result.add(tooling::Replacement(SourceMgr, Range, "")));
replaceToken(*Token, Next, SourceMgr, Result);
}
}
}
Expand Down Expand Up @@ -2458,26 +2441,12 @@ class EnumTrailingCommaEditor : public TokenAnalyzer {
assert(BeforeRBrace);
if (BeforeRBrace->is(TT_EnumLBrace)) // Empty braces.
continue;
if (Style.EnumTrailingComma == FormatStyle::ETC_Insert) {
if (BeforeRBrace->isNot(tok::comma)) {
cantFail(Result.add(tooling::Replacement(
SourceMgr, BeforeRBrace->Tok.getEndLoc(), 0, ",")));
}
} else {
assert(Style.EnumTrailingComma == FormatStyle::ETC_Remove);
if (BeforeRBrace->isNot(tok::comma))
continue;
auto *Next = BeforeRBrace->Next;
SourceLocation Start;
if (Next->NewlinesBefore == 0) {
Start = BeforeRBrace->Tok.getLocation();
Next->WhitespaceRange = BeforeRBrace->WhitespaceRange;
} else {
Start = BeforeRBrace->WhitespaceRange.getBegin();
}
const auto &Range = CharSourceRange::getCharRange(
Start, BeforeRBrace->Tok.getEndLoc());
cantFail(Result.add(tooling::Replacement(SourceMgr, Range, " ")));
if (BeforeRBrace->is(tok::comma)) {
if (Style.EnumTrailingComma == FormatStyle::ETC_Remove)
replaceToken(*BeforeRBrace, BeforeRBrace->Next, SourceMgr, Result);
} else if (Style.EnumTrailingComma == FormatStyle::ETC_Insert) {
cantFail(Result.add(tooling::Replacement(
SourceMgr, BeforeRBrace->Tok.getEndLoc(), 0, ",")));
}
}
}
Expand Down