[clang] 7dd2f1c - [clang-format] Add IndentPPDirectives Leave option (#139750)
via cfe-commits
cfe-commits at lists.llvm.org
Sun Sep 14 13:47:10 PDT 2025
Author: Gedare Bloom
Date: 2025-09-14T13:47:06-07:00
New Revision: 7dd2f1cc10902e632c0c78c75a30432a53eb59dc
URL: https://github.com/llvm/llvm-project/commit/7dd2f1cc10902e632c0c78c75a30432a53eb59dc
DIFF: https://github.com/llvm/llvm-project/commit/7dd2f1cc10902e632c0c78c75a30432a53eb59dc.diff
LOG: [clang-format] Add IndentPPDirectives Leave option (#139750)
Allow an option to leave preprocessor directive indenting as-is. This
simplifies handling mixed styles of CPP directive indentation.
Fixes #38511
Added:
Modified:
clang/docs/ClangFormatStyleOptions.rst
clang/docs/ReleaseNotes.rst
clang/include/clang/Format/Format.h
clang/lib/Format/ContinuationIndenter.cpp
clang/lib/Format/Format.cpp
clang/lib/Format/TokenAnnotator.cpp
clang/lib/Format/UnwrappedLineFormatter.cpp
clang/lib/Format/UnwrappedLineParser.cpp
clang/lib/Format/UnwrappedLineParser.h
clang/unittests/Format/FormatTest.cpp
Removed:
################################################################################
diff --git a/clang/docs/ClangFormatStyleOptions.rst b/clang/docs/ClangFormatStyleOptions.rst
index 6be4d512bda6a..9413b9a348b76 100644
--- a/clang/docs/ClangFormatStyleOptions.rst
+++ b/clang/docs/ClangFormatStyleOptions.rst
@@ -4426,6 +4426,21 @@ the configuration (without a prefix: ``Auto``).
#endif
#endif
+ * ``PPDIS_Leave`` (in configuration: ``Leave``)
+ Leaves indentation of directives as-is.
+
+ .. note::
+
+ Ignores ``PPIndentWidth``.
+
+ .. code-block:: c++
+
+ #if FOO
+ #if BAR
+ #include <foo>
+ #endif
+ #endif
+
.. _IndentRequiresClause:
diff --git a/clang/docs/ReleaseNotes.rst b/clang/docs/ReleaseNotes.rst
index 6eb2a52e80ba9..873d63f56480c 100644
--- a/clang/docs/ReleaseNotes.rst
+++ b/clang/docs/ReleaseNotes.rst
@@ -475,6 +475,7 @@ clang-format
- Add ``SpaceInEmptyBraces`` option and set it to ``Always`` for WebKit style.
- Add ``NumericLiteralCase`` option for enforcing character case in numeric
literals.
+- Add ``Leave`` suboption to ``IndentPPDirectives``.
libclang
--------
diff --git a/clang/include/clang/Format/Format.h b/clang/include/clang/Format/Format.h
index 03cff5f8cfb66..342fefcfc408c 100644
--- a/clang/include/clang/Format/Format.h
+++ b/clang/include/clang/Format/Format.h
@@ -2976,7 +2976,19 @@ struct FormatStyle {
/// #endif
/// #endif
/// \endcode
- PPDIS_BeforeHash
+ PPDIS_BeforeHash,
+ /// Leaves indentation of directives as-is.
+ /// \note
+ /// Ignores ``PPIndentWidth``.
+ /// \endnote
+ /// \code
+ /// #if FOO
+ /// #if BAR
+ /// #include <foo>
+ /// #endif
+ /// #endif
+ /// \endcode
+ PPDIS_Leave
};
/// The preprocessor directive indenting style to use.
diff --git a/clang/lib/Format/ContinuationIndenter.cpp b/clang/lib/Format/ContinuationIndenter.cpp
index 888d0faf80931..9413c13a4137e 100644
--- a/clang/lib/Format/ContinuationIndenter.cpp
+++ b/clang/lib/Format/ContinuationIndenter.cpp
@@ -780,19 +780,21 @@ void ContinuationIndenter::addTokenOnCurrentLine(LineState &State, bool DryRun,
// Indent preprocessor directives after the hash if required.
int PPColumnCorrection = 0;
- if (Style.IndentPPDirectives == FormatStyle::PPDIS_AfterHash &&
- Previous.is(tok::hash) && State.FirstIndent > 0 &&
- &Previous == State.Line->First &&
+ if (&Previous == State.Line->First && Previous.is(tok::hash) &&
(State.Line->Type == LT_PreprocessorDirective ||
State.Line->Type == LT_ImportStatement)) {
- Spaces += State.FirstIndent;
-
- // For preprocessor indent with tabs, State.Column will be 1 because of the
- // hash. This causes second-level indents onward to have an extra space
- // after the tabs. We avoid this misalignment by subtracting 1 from the
- // column value passed to replaceWhitespace().
- if (Style.UseTab != FormatStyle::UT_Never)
- PPColumnCorrection = -1;
+ if (Style.IndentPPDirectives == FormatStyle::PPDIS_AfterHash) {
+ Spaces += State.FirstIndent;
+
+ // For preprocessor indent with tabs, State.Column will be 1 because of
+ // the hash. This causes second-level indents onward to have an extra
+ // space after the tabs. We avoid this misalignment by subtracting 1 from
+ // the column value passed to replaceWhitespace().
+ if (Style.UseTab != FormatStyle::UT_Never)
+ PPColumnCorrection = -1;
+ } else if (Style.IndentPPDirectives == FormatStyle::PPDIS_Leave) {
+ Spaces += Current.OriginalColumn - Previous.OriginalColumn - 1;
+ }
}
if (!DryRun) {
diff --git a/clang/lib/Format/Format.cpp b/clang/lib/Format/Format.cpp
index f095d2c18cfcf..1776e373cf8a8 100644
--- a/clang/lib/Format/Format.cpp
+++ b/clang/lib/Format/Format.cpp
@@ -535,6 +535,7 @@ struct ScalarEnumerationTraits<FormatStyle::PPDirectiveIndentStyle> {
IO.enumCase(Value, "None", FormatStyle::PPDIS_None);
IO.enumCase(Value, "AfterHash", FormatStyle::PPDIS_AfterHash);
IO.enumCase(Value, "BeforeHash", FormatStyle::PPDIS_BeforeHash);
+ IO.enumCase(Value, "Leave", FormatStyle::PPDIS_Leave);
}
};
diff --git a/clang/lib/Format/TokenAnnotator.cpp b/clang/lib/Format/TokenAnnotator.cpp
index bbb7ef2c337d6..d97f56751ea69 100644
--- a/clang/lib/Format/TokenAnnotator.cpp
+++ b/clang/lib/Format/TokenAnnotator.cpp
@@ -3627,7 +3627,7 @@ void TokenAnnotator::setCommentLineLevels(
// Align comments for preprocessor lines with the # in column 0 if
// preprocessor lines are not indented. Otherwise, align with the next
// line.
- Line->Level = Style.IndentPPDirectives != FormatStyle::PPDIS_BeforeHash &&
+ Line->Level = Style.IndentPPDirectives < FormatStyle::PPDIS_BeforeHash &&
PPDirectiveOrImportStmt
? 0
: NextNonCommentLine->Level;
diff --git a/clang/lib/Format/UnwrappedLineFormatter.cpp b/clang/lib/Format/UnwrappedLineFormatter.cpp
index 2a7bfd1a7dc5b..ac9d147defc13 100644
--- a/clang/lib/Format/UnwrappedLineFormatter.cpp
+++ b/clang/lib/Format/UnwrappedLineFormatter.cpp
@@ -62,10 +62,16 @@ class LevelIndentTracker {
// having the right size in adjustToUnmodifiedline.
if (Line.Level >= IndentForLevel.size())
IndentForLevel.resize(Line.Level + 1, -1);
- if (Style.IndentPPDirectives != FormatStyle::PPDIS_None &&
- (Line.InPPDirective ||
- (Style.IndentPPDirectives == FormatStyle::PPDIS_BeforeHash &&
- Line.Type == LT_CommentAbovePPDirective))) {
+ if (Style.IndentPPDirectives == FormatStyle::PPDIS_Leave &&
+ (Line.InPPDirective || Line.Type == LT_CommentAbovePPDirective)) {
+ Indent = Line.InMacroBody
+ ? (Line.Level - Line.PPLevel) * Style.IndentWidth +
+ AdditionalIndent
+ : Line.First->OriginalColumn;
+ } else if (Style.IndentPPDirectives != FormatStyle::PPDIS_None &&
+ (Line.InPPDirective ||
+ (Style.IndentPPDirectives == FormatStyle::PPDIS_BeforeHash &&
+ Line.Type == LT_CommentAbovePPDirective))) {
unsigned PPIndentWidth =
(Style.PPIndentWidth >= 0) ? Style.PPIndentWidth : Style.IndentWidth;
Indent = Line.InMacroBody
@@ -1656,7 +1662,7 @@ void UnwrappedLineFormatter::formatFirstToken(
// Preprocessor directives get indented before the hash only if specified. In
// Javascript import statements are indented like normal statements.
if (!Style.isJavaScript() &&
- Style.IndentPPDirectives != FormatStyle::PPDIS_BeforeHash &&
+ Style.IndentPPDirectives < FormatStyle::PPDIS_BeforeHash &&
(Line.Type == LT_PreprocessorDirective ||
Line.Type == LT_ImportStatement)) {
Indent = 0;
diff --git a/clang/lib/Format/UnwrappedLineParser.cpp b/clang/lib/Format/UnwrappedLineParser.cpp
index f4bbfcf8461bc..2c9766c9b7bc0 100644
--- a/clang/lib/Format/UnwrappedLineParser.cpp
+++ b/clang/lib/Format/UnwrappedLineParser.cpp
@@ -162,17 +162,13 @@ UnwrappedLineParser::UnwrappedLineParser(
LangOpts(getFormattingLangOpts(Style)), Keywords(Keywords),
CommentPragmasRegex(Style.CommentPragmas), Tokens(nullptr),
Callback(Callback), AllTokens(Tokens), PPBranchLevel(-1),
- IncludeGuard(Style.IndentPPDirectives == FormatStyle::PPDIS_None
- ? IG_Rejected
- : IG_Inited),
+ IncludeGuard(getIncludeGuardState(Style.IndentPPDirectives)),
IncludeGuardToken(nullptr), FirstStartColumn(FirstStartColumn),
Macros(Style.Macros, SourceMgr, Style, Allocator, IdentTable) {}
void UnwrappedLineParser::reset() {
PPBranchLevel = -1;
- IncludeGuard = Style.IndentPPDirectives == FormatStyle::PPDIS_None
- ? IG_Rejected
- : IG_Inited;
+ IncludeGuard = getIncludeGuardState(Style.IndentPPDirectives);
IncludeGuardToken = nullptr;
Line.reset(new UnwrappedLine);
CommentsBeforeNextToken.clear();
@@ -1140,7 +1136,7 @@ void UnwrappedLineParser::parsePPEndIf() {
// If the #endif of a potential include guard is the last thing in the file,
// then we found an include guard.
if (IncludeGuard == IG_Defined && PPBranchLevel == -1 && Tokens->isEOF() &&
- Style.IndentPPDirectives != FormatStyle::PPDIS_None) {
+ getIncludeGuardState(Style.IndentPPDirectives) == IG_Inited) {
IncludeGuard = IG_Found;
}
}
diff --git a/clang/lib/Format/UnwrappedLineParser.h b/clang/lib/Format/UnwrappedLineParser.h
index 8e29680ff244b..8b8ad84896f1a 100644
--- a/clang/lib/Format/UnwrappedLineParser.h
+++ b/clang/lib/Format/UnwrappedLineParser.h
@@ -397,6 +397,13 @@ class UnwrappedLineParser {
// Current state of include guard search.
IncludeGuardState IncludeGuard;
+ IncludeGuardState
+ getIncludeGuardState(FormatStyle::PPDirectiveIndentStyle Style) const {
+ return Style == FormatStyle::PPDIS_None || Style == FormatStyle::PPDIS_Leave
+ ? IG_Rejected
+ : IG_Inited;
+ }
+
// Points to the #ifndef condition for a potential include guard. Null unless
// IncludeGuardState == IG_IfNdefed.
FormatToken *IncludeGuardToken;
diff --git a/clang/unittests/Format/FormatTest.cpp b/clang/unittests/Format/FormatTest.cpp
index 4e9d31895998f..d9db06667d802 100644
--- a/clang/unittests/Format/FormatTest.cpp
+++ b/clang/unittests/Format/FormatTest.cpp
@@ -5564,6 +5564,63 @@ TEST_F(FormatTest, IndentsPPDirectiveWithPPIndentWidth) {
" }",
style);
+ style.IndentPPDirectives = FormatStyle::PPDIS_Leave;
+ style.IndentWidth = 4;
+ verifyNoChange("#ifndef foo\n"
+ "#define foo\n"
+ "if (emacs) {\n"
+ "#ifdef is\n"
+ "#define lit \\\n"
+ " if (af) { \\\n"
+ " return duh(); \\\n"
+ " }\n"
+ "#endif\n"
+ "}\n"
+ "#endif",
+ style);
+ verifyNoChange("#ifndef foo\n"
+ " #define foo\n"
+ "if (emacs) {\n"
+ " #ifdef is\n"
+ "#define lit \\\n"
+ " if (af) { \\\n"
+ " return duh(); \\\n"
+ " }\n"
+ " #endif\n"
+ "}\n"
+ "#endif",
+ style);
+ verifyNoChange(" #ifndef foo\n"
+ "# define foo\n"
+ "if (emacs) {\n"
+ "#ifdef is\n"
+ " # define lit \\\n"
+ " if (af) { \\\n"
+ " return duh(); \\\n"
+ " }\n"
+ "#endif\n"
+ "}\n"
+ " #endif",
+ style);
+ verifyNoChange("#ifdef foo\n"
+ "#else\n"
+ "/* This is a comment */\n"
+ "#ifdef BAR\n"
+ "#endif\n"
+ "#endif",
+ style);
+
+ style.IndentWidth = 1;
+ style.PPIndentWidth = 4;
+ verifyNoChange("# if 1\n"
+ " #define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n"
+ "# endif",
+ style);
+
style.IndentWidth = 4;
style.PPIndentWidth = 1;
style.IndentPPDirectives = FormatStyle::PPDIS_AfterHash;
@@ -25597,6 +25654,20 @@ TEST_F(FormatTest, SkipMacroDefinitionBody) {
"a",
Style);
+ Style.IndentPPDirectives = FormatStyle::PPDIS_Leave;
+ verifyNoChange("#if A\n"
+ "#define A a\n"
+ "#endif",
+ Style);
+ verifyNoChange("#if A\n"
+ " #define A a\n"
+ "#endif",
+ Style);
+ verifyNoChange("#if A\n"
+ "# define A a\n"
+ "#endif",
+ Style);
+
// Adjust indendations but don't change the definition.
Style.IndentPPDirectives = FormatStyle::PPDIS_None;
verifyNoChange("#if A\n"
More information about the cfe-commits
mailing list