[clang-tools-extra] r233697 - Force braces on the else branch if they are being added to the if branch.
Samuel Benzaquen
sbenza at google.com
Tue Mar 31 06:53:04 PDT 2015
Author: sbenza
Date: Tue Mar 31 08:53:03 2015
New Revision: 233697
URL: http://llvm.org/viewvc/llvm-project?rev=233697&view=rev
Log:
Force braces on the else branch if they are being added to the if branch.
Summary:
Force braces on the else branch if they are being added to the if branch.
This ensures consistency in the transformed code.
Reviewers: alexfh
Subscribers: cfe-commits
Differential Revision: http://reviews.llvm.org/D8708
Modified:
clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.cpp
clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.h
clang-tools-extra/trunk/unittests/clang-tidy/ClangTidyTest.h
clang-tools-extra/trunk/unittests/clang-tidy/ReadabilityModuleTest.cpp
Modified: clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.cpp
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.cpp?rev=233697&r1=233696&r2=233697&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.cpp (original)
+++ clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.cpp Tue Mar 31 08:53:03 2015
@@ -151,11 +151,11 @@ BracesAroundStatementsCheck::check(const
SourceLocation StartLoc = findRParenLoc(S, SM, Context);
if (StartLoc.isInvalid())
return;
- checkStmt(Result, S->getThen(), StartLoc, S->getElseLoc());
+ bool BracedIf = checkStmt(Result, S->getThen(), StartLoc, S->getElseLoc());
const Stmt *Else = S->getElse();
if (Else && !isa<IfStmt>(Else)) {
// Omit 'else if' statements here, they will be handled directly.
- checkStmt(Result, Else, S->getElseLoc());
+ checkStmt(Result, Else, S->getElseLoc(), SourceLocation(), BracedIf);
}
} else {
llvm_unreachable("Invalid match");
@@ -199,10 +199,11 @@ BracesAroundStatementsCheck::findRParenL
return RParenLoc;
}
-void
-BracesAroundStatementsCheck::checkStmt(const MatchFinder::MatchResult &Result,
- const Stmt *S, SourceLocation InitialLoc,
- SourceLocation EndLocHint) {
+/// Determine if the statement needs braces around it, and add them if it does.
+/// Returns true if braces where added.
+bool BracesAroundStatementsCheck::checkStmt(
+ const MatchFinder::MatchResult &Result, const Stmt *S,
+ SourceLocation InitialLoc, SourceLocation EndLocHint, bool ForceBraces) {
// 1) If there's a corresponding "else" or "while", the check inserts "} "
// right before that token.
// 2) If there's a multi-line block comment starting on the same line after
@@ -212,11 +213,11 @@ BracesAroundStatementsCheck::checkStmt(c
// line comments) and inserts "\n}" right before that EOL.
if (!S || isa<CompoundStmt>(S)) {
// Already inside braces.
- return;
+ return false;
}
// Skip macros.
if (S->getLocStart().isMacroID())
- return;
+ return false;
const SourceManager &SM = *Result.SourceManager;
const ASTContext *Context = Result.Context;
@@ -240,16 +241,17 @@ BracesAroundStatementsCheck::checkStmt(c
assert(EndLoc.isValid());
// Don't require braces for statements spanning less than certain number of
// lines.
- if (ShortStatementLines) {
+ if (ShortStatementLines && !ForceBraces) {
unsigned StartLine = SM.getSpellingLineNumber(StartLoc);
unsigned EndLine = SM.getSpellingLineNumber(EndLoc);
if (EndLine - StartLine < ShortStatementLines)
- return;
+ return false;
}
auto Diag = diag(StartLoc, "statement should be inside braces");
Diag << FixItHint::CreateInsertion(StartLoc, " {")
<< FixItHint::CreateInsertion(EndLoc, ClosingInsertion);
+ return true;
}
} // namespace readability
Modified: clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.h?rev=233697&r1=233696&r2=233697&view=diff
==============================================================================
--- clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.h (original)
+++ clang-tools-extra/trunk/clang-tidy/readability/BracesAroundStatementsCheck.h Tue Mar 31 08:53:03 2015
@@ -43,9 +43,10 @@ public:
void check(const ast_matchers::MatchFinder::MatchResult &Result) override;
private:
- void checkStmt(const ast_matchers::MatchFinder::MatchResult &Result,
+ bool checkStmt(const ast_matchers::MatchFinder::MatchResult &Result,
const Stmt *S, SourceLocation StartLoc,
- SourceLocation EndLocHint = SourceLocation());
+ SourceLocation EndLocHint = SourceLocation(),
+ bool ForceBraces = false);
template <typename IfOrWhileStmt>
SourceLocation findRParenLoc(const IfOrWhileStmt *S, const SourceManager &SM,
const ASTContext *Context);
Modified: clang-tools-extra/trunk/unittests/clang-tidy/ClangTidyTest.h
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/unittests/clang-tidy/ClangTidyTest.h?rev=233697&r1=233696&r2=233697&view=diff
==============================================================================
--- clang-tools-extra/trunk/unittests/clang-tidy/ClangTidyTest.h (original)
+++ clang-tools-extra/trunk/unittests/clang-tidy/ClangTidyTest.h Tue Mar 31 08:53:03 2015
@@ -42,11 +42,12 @@ private:
};
template <typename T>
-std::string runCheckOnCode(StringRef Code,
- std::vector<ClangTidyError> *Errors = nullptr,
- const Twine &Filename = "input.cc",
- ArrayRef<std::string> ExtraArgs = None) {
- ClangTidyOptions Options;
+std::string
+runCheckOnCode(StringRef Code, std::vector<ClangTidyError> *Errors = nullptr,
+ const Twine &Filename = "input.cc",
+ ArrayRef<std::string> ExtraArgs = None,
+ const ClangTidyOptions &ExtraOptions = ClangTidyOptions()) {
+ ClangTidyOptions Options = ExtraOptions;
Options.Checks = "*";
ClangTidyContext Context(llvm::make_unique<DefaultOptionsProvider>(
ClangTidyGlobalOptions(), Options));
Modified: clang-tools-extra/trunk/unittests/clang-tidy/ReadabilityModuleTest.cpp
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/unittests/clang-tidy/ReadabilityModuleTest.cpp?rev=233697&r1=233696&r2=233697&view=diff
==============================================================================
--- clang-tools-extra/trunk/unittests/clang-tidy/ReadabilityModuleTest.cpp (original)
+++ clang-tools-extra/trunk/unittests/clang-tidy/ReadabilityModuleTest.cpp Tue Mar 31 08:53:03 2015
@@ -235,6 +235,27 @@ TEST(BracesAroundStatementsCheck, If) {
"}"));
}
+TEST(BracesAroundStatementsCheck, IfElseWithShortStatements) {
+ ClangTidyOptions Options;
+ Options.CheckOptions["test-check.ShortStatementLines"] = "1";
+
+ EXPECT_EQ("int main() {\n"
+ " if (true) return 1;\n"
+ " if (false) { return -1;\n"
+ " } else if (1 == 2) { return -2;\n"
+ " } else { return -3;\n"
+ "}\n"
+ "}",
+ runCheckOnCode<BracesAroundStatementsCheck>(
+ "int main() {\n"
+ " if (true) return 1;\n"
+ " if (false) return -1;\n"
+ " else if (1 == 2) return -2;\n"
+ " else return -3;\n"
+ "}",
+ nullptr, "input.cc", None, Options));
+}
+
TEST(BracesAroundStatementsCheck, For) {
EXPECT_NO_CHANGES(BracesAroundStatementsCheck, "int main() {\n"
" for (;;) {\n"
More information about the cfe-commits
mailing list