goldstein.w.n updated this revision to Diff 475050.
goldstein.w.n added a comment.
1. Updating D137181 <https://reviews.llvm.org/D137181>: [clang-format] Don't
use 'PPIndentWidth' inside multi-line macros #
2. Enter a brief description of the changes included in this update.
3. The first line is used as subject, next lines as comment. #
4. If you intended to create a new revision, use:
5. $ arc diff --create
Cleanup logic in Formatter
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D137181/new/
https://reviews.llvm.org/D137181
Files:
clang/lib/Format/TokenAnnotator.h
clang/lib/Format/UnwrappedLineFormatter.cpp
clang/lib/Format/UnwrappedLineParser.cpp
clang/lib/Format/UnwrappedLineParser.h
clang/unittests/Format/FormatTest.cpp
Index: clang/unittests/Format/FormatTest.cpp
===================================================================
--- clang/unittests/Format/FormatTest.cpp
+++ clang/unittests/Format/FormatTest.cpp
@@ -5040,6 +5040,348 @@
" int y = 0;\n"
"}",
style);
+
+ style.IndentPPDirectives = FormatStyle::PPDIS_None;
+ verifyFormat("#ifdef X\n"
+ "#define Y \\\n"
+ " switch (Y) { \\\n"
+ " case 0: \\\n"
+ " break; \\\n"
+ " case 1: \\\n"
+ " break; \\\n"
+ " } \\\n"
+ " Z();\n"
+ "#endif",
+ style);
+ verifyFormat("#ifdef foo\n"
+ "#define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+ verifyFormat("if (emacs) {\n"
+ "#ifdef is\n"
+ "#define lit \\\n"
+ " if (af) { \\\n"
+ " return duh(); \\\n"
+ " }\n"
+ "#endif\n"
+ "}",
+ style);
+ verifyFormat("#if abc\n"
+ "#ifdef foo\n"
+ "#define bar() \\\n"
+ " if (A) { \\\n"
+ " if (B) { \\\n"
+ " C(); \\\n"
+ " } \\\n"
+ " } \\\n"
+ " D();\n"
+ "#endif\n"
+ "#endif",
+ style);
+ verifyFormat("#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);
+ verifyFormat("#if 1\n"
+ "#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n"
+ "#endif",
+ style);
+ verifyFormat("#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n",
+ style);
+
+ style.PPIndentWidth = 2;
+ verifyFormat("#ifdef foo\n"
+ "#define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+ style.IndentWidth = 8;
+ verifyFormat("#ifdef foo\n"
+ "#define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+
+ style.IndentWidth = 1;
+ style.PPIndentWidth = 4;
+ verifyFormat("#if 1\n"
+ "#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n"
+ "#endif",
+ style);
+ verifyFormat("#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n",
+ style);
+
+ style.IndentWidth = 4;
+ style.PPIndentWidth = 1;
+
+ style.IndentPPDirectives = FormatStyle::PPDIS_AfterHash;
+ verifyFormat("#ifdef X\n"
+ "# define Y \\\n"
+ " switch (Y) { \\\n"
+ " case 0: \\\n"
+ " break; \\\n"
+ " case 1: \\\n"
+ " break; \\\n"
+ " } \\\n"
+ " Z();\n"
+ "#endif",
+ style);
+ verifyFormat("#ifdef foo\n"
+ "# define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+ verifyFormat("if (emacs) {\n"
+ "#ifdef is\n"
+ "# define lit \\\n"
+ " if (af) { \\\n"
+ " return duh(); \\\n"
+ " }\n"
+ "#endif\n"
+ "}",
+ style);
+ verifyFormat("#if abc\n"
+ "# ifdef foo\n"
+ "# define bar() \\\n"
+ " if (A) { \\\n"
+ " if (B) { \\\n"
+ " C(); \\\n"
+ " } \\\n"
+ " } \\\n"
+ " D();\n"
+ "# endif\n"
+ "#endif",
+ style);
+ verifyFormat("#if abc\n"
+ "# ifdef foo\n"
+ "# define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "# endif\n"
+ "#endif",
+ style);
+ verifyFormat("#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);
+ verifyFormat("#if 1\n"
+ "# define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n"
+ "#endif",
+ style);
+ verifyFormat("#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n",
+ style);
+
+ style.PPIndentWidth = 2;
+ verifyFormat("#ifdef foo\n"
+ "# define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+ style.IndentWidth = 8;
+ verifyFormat("#ifdef foo\n"
+ "# define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+
+ style.IndentWidth = 1;
+ style.PPIndentWidth = 4;
+ verifyFormat("#if 1\n"
+ "# define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n"
+ "#endif",
+ style);
+ verifyFormat("#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n",
+ style);
+
+
+ style.IndentWidth = 4;
+ style.PPIndentWidth = 1;
+
+ style.IndentPPDirectives = FormatStyle::PPDIS_BeforeHash;
+ verifyFormat("#ifdef X\n"
+ " #define Y \\\n"
+ " switch (Y) { \\\n"
+ " case 0: \\\n"
+ " break; \\\n"
+ " case 1: \\\n"
+ " break; \\\n"
+ " } \\\n"
+ " Z();\n"
+ "#endif",
+ style);
+ verifyFormat("#ifdef foo\n"
+ " #define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+ verifyFormat("if (emacs) {\n"
+ "#ifdef is\n"
+ " #define lit \\\n"
+ " if (af) { \\\n"
+ " return duh(); \\\n"
+ " }\n"
+ "#endif\n"
+ "}",
+ style);
+ verifyFormat("#if abc\n"
+ " #ifdef foo\n"
+ " #define bar() \\\n"
+ " if (A) { \\\n"
+ " if (B) { \\\n"
+ " C(); \\\n"
+ " } \\\n"
+ " } \\\n"
+ " D();\n"
+ " #endif\n"
+ "#endif",
+ style);
+ verifyFormat("#if abc\n"
+ " #ifdef foo\n"
+ " #define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ " #endif\n"
+ "#endif",
+ style);
+ verifyFormat("#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);
+ verifyFormat("#if 1\n"
+ " #define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n"
+ "#endif",
+ style);
+ verifyFormat("#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n",
+ style);
+
+ style.PPIndentWidth = 2;
+ verifyFormat("#ifdef foo\n"
+ " #define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+ style.IndentWidth = 8;
+ verifyFormat("#ifdef foo\n"
+ " #define bar() \\\n"
+ " if (A) { \\\n"
+ " B(); \\\n"
+ " } \\\n"
+ " C();\n"
+ "#endif",
+ style);
+
+ style.IndentWidth = 1;
+ style.PPIndentWidth = 4;
+ verifyFormat("#if 1\n"
+ " #define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n"
+ "#endif",
+ style);
+ verifyFormat("#define X \\\n"
+ " { \\\n"
+ " x; \\\n"
+ " x; \\\n"
+ " }\n",
+ style);
+
+ style.IndentWidth = 4;
+ style.PPIndentWidth = 1;
}
TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) {
Index: clang/lib/Format/UnwrappedLineParser.h
===================================================================
--- clang/lib/Format/UnwrappedLineParser.h
+++ clang/lib/Format/UnwrappedLineParser.h
@@ -44,6 +44,27 @@
/// The indent level of the \c UnwrappedLine.
unsigned Level;
+ /// The nested preprocessor #if* level of the \c UnwrappedLine. This does not
+ /// include header-guards.
+ /// For example:
+ /// #ifndef foobar_h PPLevel still at : 0 (because header guard)
+ /// #define foobar_h PPLevel still at : 0
+ /// #if A PPLevel from : 0 -> 1
+ /// if (abc) { PPLevel still at : 1 (not preprocessor indent)
+ /// biz(); PPlevel still at : 1
+ /// buz(); PPlevel still at : 1
+ /// } PPLevel still at : 1 (not preprocessor indent)
+ /// #define B PPlevel still at : 1
+ /// #ifdef foo PPLevel from : 1 -> 2
+ /// #ifndef bar PPLevel from : 2 -> 3
+ /// #else PPLevel still at : 3
+ /// #endif PPLevel from : 3 -> 2
+ /// #elif C PPLevel still at : 2
+ /// #endif PPLevel from : 2 -> 1
+ /// #endif PPLevel from : 1 -> 0
+ /// #endif PPLevel still at : 0
+ unsigned PPLevel;
+
/// Whether this \c UnwrappedLine is part of a preprocessor directive.
bool InPPDirective;
/// Whether this \c UnwrappedLine is part of a pramga directive.
@@ -358,7 +379,7 @@
};
inline UnwrappedLine::UnwrappedLine()
- : Level(0), InPPDirective(false), InPragmaDirective(false),
+ : Level(0), PPLevel(0), InPPDirective(false), InPragmaDirective(false),
InMacroBody(false), MustBeDeclaration(false),
MatchingOpeningBlockLineIndex(kInvalidIndex) {}
Index: clang/lib/Format/UnwrappedLineParser.cpp
===================================================================
--- clang/lib/Format/UnwrappedLineParser.cpp
+++ clang/lib/Format/UnwrappedLineParser.cpp
@@ -197,6 +197,7 @@
PreBlockLine = std::move(Parser.Line);
Parser.Line = std::make_unique<UnwrappedLine>();
Parser.Line->Level = PreBlockLine->Level;
+ Parser.Line->PPLevel = PreBlockLine->PPLevel;
Parser.Line->InPPDirective = PreBlockLine->InPPDirective;
Parser.Line->InMacroBody = PreBlockLine->InMacroBody;
}
@@ -1273,6 +1274,10 @@
Line->Level += PPBranchLevel + 1;
addUnwrappedLine();
++Line->Level;
+
+ if (Style.IndentPPDirectives != FormatStyle::PPDIS_None)
+ Line->PPLevel = PPBranchLevel + (IncludeGuard == IG_Defined ? 0 : 1);
+
Line->InMacroBody = true;
// Errors during a preprocessor directive can only affect the layout of the
Index: clang/lib/Format/UnwrappedLineFormatter.cpp
===================================================================
--- clang/lib/Format/UnwrappedLineFormatter.cpp
+++ clang/lib/Format/UnwrappedLineFormatter.cpp
@@ -60,12 +60,20 @@
// Update the indent level cache size so that we can rely on it
// having the right size in adjustToUnmodifiedline.
skipLine(Line, /*UnknownIndent=*/true);
- if (Line.InPPDirective ||
- (Style.IndentPPDirectives == FormatStyle::PPDIS_BeforeHash &&
- Line.Type == LT_CommentAbovePPDirective)) {
- unsigned IndentWidth =
+ 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.Level * IndentWidth + AdditionalIndent;
+ if (Line.InMacroBody) {
+ Indent = (Line.PPLevel + 1) * PPIndentWidth;
+ Indent += (Line.Level - Line.PPLevel - 1) * Style.IndentWidth;
+ Indent += Style.IndentWidth - PPIndentWidth;
+ } else {
+ Indent = Line.Level * PPIndentWidth;
+ }
+ Indent += AdditionalIndent;
} else {
Indent = getIndent(Line.Level);
}
Index: clang/lib/Format/TokenAnnotator.h
===================================================================
--- clang/lib/Format/TokenAnnotator.h
+++ clang/lib/Format/TokenAnnotator.h
@@ -38,6 +38,7 @@
public:
AnnotatedLine(const UnwrappedLine &Line)
: First(Line.Tokens.front().Tok), Level(Line.Level),
+ PPLevel(Line.PPLevel),
MatchingOpeningBlockLineIndex(Line.MatchingOpeningBlockLineIndex),
MatchingClosingBlockLineIndex(Line.MatchingClosingBlockLineIndex),
InPPDirective(Line.InPPDirective),
@@ -129,6 +130,7 @@
LineType Type;
unsigned Level;
+ unsigned PPLevel;
size_t MatchingOpeningBlockLineIndex;
size_t MatchingClosingBlockLineIndex;
bool InPPDirective;
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
