diff options
author | dim <dim@FreeBSD.org> | 2013-12-22 00:07:40 +0000 |
---|---|---|
committer | dim <dim@FreeBSD.org> | 2013-12-22 00:07:40 +0000 |
commit | 952eddef9aff85b1e92626e89baaf7a360e2ac85 (patch) | |
tree | df8df0b0067b381eab470a3b8f28d14a552a6340 /unittests | |
parent | ea266cad53e3d49771fa38103913d3ec7a166694 (diff) | |
download | FreeBSD-src-952eddef9aff85b1e92626e89baaf7a360e2ac85.zip FreeBSD-src-952eddef9aff85b1e92626e89baaf7a360e2ac85.tar.gz |
Vendor import of clang release_34 branch r197841 (effectively, 3.4 RC3):
https://llvm.org/svn/llvm-project/cfe/branches/release_34@197841
Diffstat (limited to 'unittests')
41 files changed, 6558 insertions, 471 deletions
diff --git a/unittests/AST/ASTTypeTraitsTest.cpp b/unittests/AST/ASTTypeTraitsTest.cpp new file mode 100644 index 0000000..dd73b52 --- /dev/null +++ b/unittests/AST/ASTTypeTraitsTest.cpp @@ -0,0 +1,114 @@ +//===- unittest/AST/ASTTypeTraits.cpp - AST type traits unit tests ------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===--------------------------------------------------------------------===// + + +#include "clang/AST/ASTTypeTraits.h" +#include "gtest/gtest.h" +#include "MatchVerifier.h" + +using namespace clang::ast_matchers; + +namespace clang { +namespace ast_type_traits { + +TEST(ASTNodeKind, NoKind) { + EXPECT_FALSE(ASTNodeKind().isBaseOf(ASTNodeKind())); + EXPECT_FALSE(ASTNodeKind().isSame(ASTNodeKind())); +} + +template <typename T> static ASTNodeKind DNT() { + return ASTNodeKind::getFromNodeKind<T>(); +} + +TEST(ASTNodeKind, Bases) { + EXPECT_TRUE(DNT<Decl>().isBaseOf(DNT<VarDecl>())); + EXPECT_FALSE(DNT<Decl>().isSame(DNT<VarDecl>())); + EXPECT_FALSE(DNT<VarDecl>().isBaseOf(DNT<Decl>())); + + EXPECT_TRUE(DNT<Decl>().isSame(DNT<Decl>())); +} + +TEST(ASTNodeKind, SameBase) { + EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<CallExpr>())); + EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<BinaryOperator>())); + EXPECT_FALSE(DNT<CallExpr>().isBaseOf(DNT<BinaryOperator>())); + EXPECT_FALSE(DNT<BinaryOperator>().isBaseOf(DNT<CallExpr>())); +} + +TEST(ASTNodeKind, DiffBase) { + EXPECT_FALSE(DNT<Expr>().isBaseOf(DNT<ArrayType>())); + EXPECT_FALSE(DNT<QualType>().isBaseOf(DNT<FunctionDecl>())); + EXPECT_FALSE(DNT<Type>().isSame(DNT<QualType>())); +} + +struct Foo {}; + +TEST(ASTNodeKind, UnknownKind) { + // We can construct one, but it is nowhere in the hierarchy. + EXPECT_FALSE(DNT<Foo>().isSame(DNT<Foo>())); +} + +TEST(ASTNodeKind, Name) { + EXPECT_EQ("Decl", DNT<Decl>().asStringRef()); + EXPECT_EQ("CallExpr", DNT<CallExpr>().asStringRef()); + EXPECT_EQ("ConstantArrayType", DNT<ConstantArrayType>().asStringRef()); + EXPECT_EQ("<None>", ASTNodeKind().asStringRef()); +} + +TEST(DynTypedNode, DeclSourceRange) { + RangeVerifier<DynTypedNode> Verifier; + Verifier.expectRange(1, 1, 1, 11); + EXPECT_TRUE(Verifier.match("void f() {}", decl())); +} + +TEST(DynTypedNode, StmtSourceRange) { + RangeVerifier<DynTypedNode> Verifier; + Verifier.expectRange(1, 10, 1, 11); + EXPECT_TRUE(Verifier.match("void f() {}", stmt())); +} + +TEST(DynTypedNode, TypeLocSourceRange) { + RangeVerifier<DynTypedNode> Verifier; + Verifier.expectRange(1, 1, 1, 8); + EXPECT_TRUE(Verifier.match("void f() {}", typeLoc(loc(functionType())))); +} + +TEST(DynTypedNode, NNSLocSourceRange) { + RangeVerifier<DynTypedNode> Verifier; + Verifier.expectRange(1, 33, 1, 34); + EXPECT_TRUE(Verifier.match("namespace N { typedef void T; } N::T f() {}", + nestedNameSpecifierLoc())); +} + +TEST(DynTypedNode, DeclDump) { + DumpVerifier Verifier; + Verifier.expectSubstring("FunctionDecl"); + EXPECT_TRUE(Verifier.match("void f() {}", functionDecl())); +} + +TEST(DynTypedNode, StmtDump) { + DumpVerifier Verifier; + Verifier.expectSubstring("CompoundStmt"); + EXPECT_TRUE(Verifier.match("void f() {}", stmt())); +} + +TEST(DynTypedNode, DeclPrint) { + PrintVerifier Verifier; + Verifier.expectString("void f() {\n}\n\n"); + EXPECT_TRUE(Verifier.match("void f() {}", functionDecl())); +} + +TEST(DynTypedNode, StmtPrint) { + PrintVerifier Verifier; + Verifier.expectString("{\n}\n"); + EXPECT_TRUE(Verifier.match("void f() {}", stmt())); +} + +} // namespace ast_type_traits +} // namespace clang diff --git a/unittests/AST/ASTVectorTest.cpp b/unittests/AST/ASTVectorTest.cpp new file mode 100644 index 0000000..a92e86b --- /dev/null +++ b/unittests/AST/ASTVectorTest.cpp @@ -0,0 +1,24 @@ +//===- unittests/AST/DeclTest.cpp --- Declaration tests -------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// Unit tests for the ASTVector container. +// +//===----------------------------------------------------------------------===// + +#include "llvm/Support/Compiler.h" +#include "clang/AST/ASTContext.h" +#include "clang/AST/ASTVector.h" + +using namespace clang; + +LLVM_ATTRIBUTE_UNUSED void CompileTest() { + ASTContext *C = 0; + ASTVector<int> V; + V.insert(*C, V.begin(), 0); +} diff --git a/unittests/AST/CMakeLists.txt b/unittests/AST/CMakeLists.txt index ad29428..70f86d3 100644 --- a/unittests/AST/CMakeLists.txt +++ b/unittests/AST/CMakeLists.txt @@ -1,8 +1,11 @@ add_clang_unittest(ASTTests ASTContextParentMapTest.cpp + ASTTypeTraitsTest.cpp + ASTVectorTest.cpp CommentLexer.cpp CommentParser.cpp DeclPrinterTest.cpp + DeclTest.cpp SourceLocationTest.cpp StmtPrinterTest.cpp ) diff --git a/unittests/AST/CommentParser.cpp b/unittests/AST/CommentParser.cpp index d05fb58..f75c636 100644 --- a/unittests/AST/CommentParser.cpp +++ b/unittests/AST/CommentParser.cpp @@ -628,18 +628,43 @@ TEST_F(CommentParserTest, Basic3) { } } -TEST_F(CommentParserTest, Paragraph1) { +TEST_F(CommentParserTest, ParagraphSplitting1) { const char *Sources[] = { "// Aaa\n" "//\n" "// Bbb", "// Aaa\n" + "// \n" + "// Bbb", + + "// Aaa\n" + "//\t\n" + "// Bbb", + + "// Aaa\n" "//\n" "//\n" "// Bbb", - }; + "/**\n" + " Aaa\n" + "\n" + " Bbb\n" + "*/", + + "/**\n" + " Aaa\n" + " \n" + " Bbb\n" + "*/", + + "/**\n" + " Aaa\n" + "\t \n" + " Bbb\n" + "*/", + }; for (size_t i = 0, e = array_lengthof(Sources); i != e; i++) { FullComment *FC = parseString(Sources[i]); @@ -650,7 +675,7 @@ TEST_F(CommentParserTest, Paragraph1) { } } -TEST_F(CommentParserTest, Paragraph2) { +TEST_F(CommentParserTest, Paragraph1) { const char *Source = "// \\brief Aaa\n" "//\n" @@ -670,7 +695,7 @@ TEST_F(CommentParserTest, Paragraph2) { ASSERT_TRUE(HasParagraphCommentAt(FC, 2, " Bbb")); } -TEST_F(CommentParserTest, Paragraph3) { +TEST_F(CommentParserTest, Paragraph2) { const char *Source = "// \\brief \\author"; FullComment *FC = parseString(Source); @@ -694,7 +719,7 @@ TEST_F(CommentParserTest, Paragraph3) { } } -TEST_F(CommentParserTest, Paragraph4) { +TEST_F(CommentParserTest, Paragraph3) { const char *Source = "// \\brief Aaa\n" "// Bbb \\author\n" diff --git a/unittests/AST/DeclTest.cpp b/unittests/AST/DeclTest.cpp new file mode 100644 index 0000000..c845da2 --- /dev/null +++ b/unittests/AST/DeclTest.cpp @@ -0,0 +1,59 @@ +//===- unittests/AST/DeclTest.cpp --- Declaration tests -------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// Unit tests for Decl nodes in the AST. +// +//===----------------------------------------------------------------------===// + +#include "clang/ASTMatchers/ASTMatchFinder.h" +#include "clang/Tooling/Tooling.h" +#include "gtest/gtest.h" + +using namespace clang::ast_matchers; +using namespace clang::tooling; + +TEST(Decl, CleansUpAPValues) { + MatchFinder Finder; + llvm::OwningPtr<FrontendActionFactory> Factory( + newFrontendActionFactory(&Finder)); + + // This is a regression test for a memory leak in APValues for structs that + // allocate memory. This test only fails if run under valgrind with full leak + // checking enabled. + std::vector<std::string> Args(1, "-std=c++11"); + Args.push_back("-fno-ms-extensions"); + ASSERT_TRUE(runToolOnCodeWithArgs( + Factory->create(), + "struct X { int a; }; constexpr X x = { 42 };" + "union Y { constexpr Y(int a) : a(a) {} int a; }; constexpr Y y = { 42 };" + "constexpr int z[2] = { 42, 43 };" + "constexpr int __attribute__((vector_size(16))) v1 = {};" + "\n#ifdef __SIZEOF_INT128__\n" + "constexpr __uint128_t large_int = 0xffffffffffffffff;" + "constexpr __uint128_t small_int = 1;" + "\n#endif\n" + "constexpr double d1 = 42.42;" + "constexpr long double d2 = 42.42;" + "constexpr _Complex long double c1 = 42.0i;" + "constexpr _Complex long double c2 = 42.0;" + "template<int N> struct A : A<N-1> {};" + "template<> struct A<0> { int n; }; A<50> a;" + "constexpr int &r = a.n;" + "constexpr int A<50>::*p = &A<50>::n;" + "void f() { foo: bar: constexpr int k = __builtin_constant_p(0) ?" + " (char*)&&foo - (char*)&&bar : 0; }", + Args)); + + // FIXME: Once this test starts breaking we can test APValue::needsCleanup + // for ComplexInt. + ASSERT_FALSE(runToolOnCodeWithArgs( + Factory->create(), + "constexpr _Complex __uint128_t c = 0xffffffffffffffff;", + Args)); +} diff --git a/unittests/AST/Makefile b/unittests/AST/Makefile index 4fb2f5b..0282d21 100644 --- a/unittests/AST/Makefile +++ b/unittests/AST/Makefile @@ -10,7 +10,7 @@ CLANG_LEVEL = ../.. TESTNAME = AST include $(CLANG_LEVEL)/../../Makefile.config -LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc +LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option USEDLIBS = clangTooling.a clangFrontend.a clangSerialization.a clangDriver.a \ clangRewriteCore.a clangRewriteFrontend.a \ clangParse.a clangSema.a clangAnalysis.a \ diff --git a/unittests/AST/MatchVerifier.h b/unittests/AST/MatchVerifier.h index 7aa7886..5a29cde 100644 --- a/unittests/AST/MatchVerifier.h +++ b/unittests/AST/MatchVerifier.h @@ -25,7 +25,7 @@ namespace clang { namespace ast_matchers { -enum Language { Lang_C, Lang_C89, Lang_CXX, Lang_OpenCL }; +enum Language { Lang_C, Lang_C89, Lang_CXX, Lang_CXX11, Lang_OpenCL }; /// \brief Base class for verifying some property of nodes found by a matcher. template <typename NodeType> @@ -34,12 +34,23 @@ public: template <typename MatcherType> testing::AssertionResult match(const std::string &Code, const MatcherType &AMatcher) { - return match(Code, AMatcher, Lang_CXX); + std::vector<std::string> Args; + return match(Code, AMatcher, Args, Lang_CXX); } template <typename MatcherType> testing::AssertionResult match(const std::string &Code, - const MatcherType &AMatcher, Language L); + const MatcherType &AMatcher, + Language L) { + std::vector<std::string> Args; + return match(Code, AMatcher, Args, L); + } + + template <typename MatcherType> + testing::AssertionResult match(const std::string &Code, + const MatcherType &AMatcher, + std::vector<std::string>& Args, + Language L); protected: virtual void run(const MatchFinder::MatchResult &Result); @@ -64,13 +75,13 @@ private: /// verifier for the matched node. template <typename NodeType> template <typename MatcherType> testing::AssertionResult MatchVerifier<NodeType>::match( - const std::string &Code, const MatcherType &AMatcher, Language L) { + const std::string &Code, const MatcherType &AMatcher, + std::vector<std::string>& Args, Language L) { MatchFinder Finder; Finder.addMatcher(AMatcher.bind(""), this); OwningPtr<tooling::FrontendActionFactory> Factory( tooling::newFrontendActionFactory(&Finder)); - std::vector<std::string> Args; StringRef FileName; switch (L) { case Lang_C: @@ -85,6 +96,10 @@ testing::AssertionResult MatchVerifier<NodeType>::match( Args.push_back("-std=c++98"); FileName = "input.cc"; break; + case Lang_CXX11: + Args.push_back("-std=c++11"); + FileName = "input.cc"; + break; case Lang_OpenCL: FileName = "input.cl"; } @@ -110,6 +125,20 @@ void MatchVerifier<NodeType>::run(const MatchFinder::MatchResult &Result) { } } +template <> +inline void MatchVerifier<ast_type_traits::DynTypedNode>::run( + const MatchFinder::MatchResult &Result) { + BoundNodes::IDToNodeMap M = Result.Nodes.getMap(); + BoundNodes::IDToNodeMap::const_iterator I = M.find(""); + if (I == M.end()) { + setFailure("Node was not bound"); + } else { + // Callback has been called, default to success. + setSuccess(); + verify(Result, I->second); + } +} + /// \brief Verify whether a node has the correct source location. /// /// By default, Node.getSourceLocation() is checked. This can be changed @@ -192,5 +221,59 @@ private: unsigned ExpectBeginLine, ExpectBeginColumn, ExpectEndLine, ExpectEndColumn; }; +/// \brief Verify whether a node's dump contains a given substring. +class DumpVerifier : public MatchVerifier<ast_type_traits::DynTypedNode> { +public: + void expectSubstring(const std::string &Str) { + ExpectSubstring = Str; + } + +protected: + void verify(const MatchFinder::MatchResult &Result, + const ast_type_traits::DynTypedNode &Node) { + std::string DumpStr; + llvm::raw_string_ostream Dump(DumpStr); + Node.dump(Dump, *Result.SourceManager); + + if (Dump.str().find(ExpectSubstring) == std::string::npos) { + std::string MsgStr; + llvm::raw_string_ostream Msg(MsgStr); + Msg << "Expected dump substring <" << ExpectSubstring << ">, found <" + << Dump.str() << '>'; + this->setFailure(Msg.str()); + } + } + +private: + std::string ExpectSubstring; +}; + +/// \brief Verify whether a node's pretty print matches a given string. +class PrintVerifier : public MatchVerifier<ast_type_traits::DynTypedNode> { +public: + void expectString(const std::string &Str) { + ExpectString = Str; + } + +protected: + void verify(const MatchFinder::MatchResult &Result, + const ast_type_traits::DynTypedNode &Node) { + std::string PrintStr; + llvm::raw_string_ostream Print(PrintStr); + Node.print(Print, Result.Context->getPrintingPolicy()); + + if (Print.str() != ExpectString) { + std::string MsgStr; + llvm::raw_string_ostream Msg(MsgStr); + Msg << "Expected pretty print <" << ExpectString << ">, found <" + << Print.str() << '>'; + this->setFailure(Msg.str()); + } + } + +private: + std::string ExpectString; +}; + } // end namespace ast_matchers } // end namespace clang diff --git a/unittests/AST/SourceLocationTest.cpp b/unittests/AST/SourceLocationTest.cpp index f6c0edc..29156bc 100644 --- a/unittests/AST/SourceLocationTest.cpp +++ b/unittests/AST/SourceLocationTest.cpp @@ -155,5 +155,116 @@ TEST(InitListExpr, VectorLiteralInitListParens) { "constant int2 i2 = (int2)(1, 2);", initListExpr(), Lang_OpenCL)); } +class TemplateAngleBracketLocRangeVerifier : public RangeVerifier<TypeLoc> { +protected: + virtual SourceRange getRange(const TypeLoc &Node) { + TemplateSpecializationTypeLoc T = + Node.getUnqualifiedLoc().castAs<TemplateSpecializationTypeLoc>(); + assert(!T.isNull()); + return SourceRange(T.getLAngleLoc(), T.getRAngleLoc()); + } +}; + +TEST(TemplateSpecializationTypeLoc, AngleBracketLocations) { + TemplateAngleBracketLocRangeVerifier Verifier; + Verifier.expectRange(2, 8, 2, 10); + EXPECT_TRUE(Verifier.match( + "template<typename T> struct A {}; struct B{}; void f(\n" + "const A<B>&);", + loc(templateSpecializationType()))); +} + +TEST(CXXNewExpr, TypeParenRange) { + RangeVerifier<CXXNewExpr> Verifier; + Verifier.expectRange(1, 10, 1, 18); + EXPECT_TRUE(Verifier.match("int* a = new (int);", newExpr())); +} + +class UnaryTransformTypeLocParensRangeVerifier : public RangeVerifier<TypeLoc> { +protected: + virtual SourceRange getRange(const TypeLoc &Node) { + UnaryTransformTypeLoc T = + Node.getUnqualifiedLoc().castAs<UnaryTransformTypeLoc>(); + assert(!T.isNull()); + return SourceRange(T.getLParenLoc(), T.getRParenLoc()); + } +}; + +TEST(UnaryTransformTypeLoc, ParensRange) { + UnaryTransformTypeLocParensRangeVerifier Verifier; + Verifier.expectRange(3, 26, 3, 28); + EXPECT_TRUE(Verifier.match( + "template <typename T>\n" + "struct S {\n" + "typedef __underlying_type(T) type;\n" + "};", + loc(unaryTransformType()))); +} + +TEST(CXXFunctionalCastExpr, SourceRange) { + RangeVerifier<CXXFunctionalCastExpr> Verifier; + Verifier.expectRange(2, 10, 2, 14); + EXPECT_TRUE(Verifier.match( + "int foo() {\n" + " return int{};\n" + "}", + functionalCastExpr(), Lang_CXX11)); +} + +TEST(CXXTemporaryObjectExpr, SourceRange) { + RangeVerifier<CXXTemporaryObjectExpr> Verifier; + Verifier.expectRange(2, 6, 2, 12); + EXPECT_TRUE(Verifier.match( + "struct A { A(int, int); };\n" + "A a( A{0, 0} );", + temporaryObjectExpr(), Lang_CXX11)); +} + +TEST(CXXUnresolvedConstructExpr, SourceRange) { + RangeVerifier<CXXUnresolvedConstructExpr> Verifier; + Verifier.expectRange(3, 10, 3, 12); + std::vector<std::string> Args; + Args.push_back("-fno-delayed-template-parsing"); + EXPECT_TRUE(Verifier.match( + "template <typename U>\n" + "U foo() {\n" + " return U{};\n" + "}", + unresolvedConstructExpr(), Args, Lang_CXX11)); +} + +TEST(UsingDecl, SourceRange) { + RangeVerifier<UsingDecl> Verifier; + Verifier.expectRange(2, 22, 2, 25); + EXPECT_TRUE(Verifier.match( + "class B { protected: int i; };\n" + "class D : public B { B::i; };", + usingDecl())); +} + +TEST(UnresolvedUsingValueDecl, SourceRange) { + RangeVerifier<UnresolvedUsingValueDecl> Verifier; + Verifier.expectRange(3, 3, 3, 6); + EXPECT_TRUE(Verifier.match( + "template <typename B>\n" + "class D : public B {\n" + " B::i;\n" + "};", + unresolvedUsingValueDecl())); +} + +TEST(FriendDecl, InstantiationSourceRange) { + RangeVerifier<FriendDecl> Verifier; + Verifier.expectRange(4, 3, 4, 35); + EXPECT_TRUE(Verifier.match( + "template <typename T> class S;\n" + "template<class T> void operator+(S<T> x);\n" + "template<class T> struct S {\n" + " friend void operator+<>(S<T> src);\n" + "};\n" + "void test(S<double> s) { +s; }", + friendDecl(hasParent(recordDecl(isTemplateInstantiation()))))); +} + } // end namespace ast_matchers } // end namespace clang diff --git a/unittests/ASTMatchers/ASTMatchersTest.cpp b/unittests/ASTMatchers/ASTMatchersTest.cpp index cfa5386..cc13c01 100644 --- a/unittests/ASTMatchers/ASTMatchersTest.cpp +++ b/unittests/ASTMatchers/ASTMatchersTest.cpp @@ -40,6 +40,18 @@ TEST(IsDerivedFromDeathTest, DiesOnEmptyBaseName) { } #endif +TEST(Finder, DynamicOnlyAcceptsSomeMatchers) { + MatchFinder Finder; + EXPECT_TRUE(Finder.addDynamicMatcher(decl(), NULL)); + EXPECT_TRUE(Finder.addDynamicMatcher(callExpr(), NULL)); + EXPECT_TRUE(Finder.addDynamicMatcher(constantArrayType(hasSize(42)), NULL)); + + // Do not accept non-toplevel matchers. + EXPECT_FALSE(Finder.addDynamicMatcher(isArrow(), NULL)); + EXPECT_FALSE(Finder.addDynamicMatcher(hasSize(2), NULL)); + EXPECT_FALSE(Finder.addDynamicMatcher(hasName("x"), NULL)); +} + TEST(Decl, MatchesDeclarations) { EXPECT_TRUE(notMatches("", decl(usingDecl()))); EXPECT_TRUE(matches("namespace x { class X {}; } using x::X;", @@ -311,6 +323,12 @@ TEST(DeclarationMatcher, ClassIsDerived) { EXPECT_TRUE(matches( "class X {}; class Y : public X {};", recordDecl(isDerivedFrom(recordDecl(hasName("X")).bind("test"))))); + + EXPECT_TRUE(matches( + "template<typename T> class X {};" + "template<typename T> using Z = X<T>;" + "template <typename T> class Y : Z<T> {};", + recordDecl(isDerivedFrom(namedDecl(hasName("X")))))); } TEST(DeclarationMatcher, hasMethod) { @@ -645,14 +663,22 @@ public: : Id(Id), ExpectedCount(ExpectedCount), Count(0), ExpectedName(ExpectedName) {} - ~VerifyIdIsBoundTo() { + void onEndOfTranslationUnit() LLVM_OVERRIDE { if (ExpectedCount != -1) EXPECT_EQ(ExpectedCount, Count); if (!ExpectedName.empty()) EXPECT_EQ(ExpectedName, Name); + Count = 0; + Name.clear(); + } + + ~VerifyIdIsBoundTo() { + EXPECT_EQ(0, Count); + EXPECT_EQ("", Name); } virtual bool run(const BoundNodes *Nodes) { + const BoundNodes::IDToNodeMap &M = Nodes->getMap(); if (Nodes->getNodeAs<T>(Id)) { ++Count; if (const NamedDecl *Named = Nodes->getNodeAs<NamedDecl>(Id)) { @@ -662,8 +688,13 @@ public: llvm::raw_string_ostream OS(Name); NNS->print(OS, PrintingPolicy(LangOptions())); } + BoundNodes::IDToNodeMap::const_iterator I = M.find(Id); + EXPECT_NE(M.end(), I); + if (I != M.end()) + EXPECT_EQ(Nodes->getNodeAs<T>(Id), I->second.get<T>()); return true; } + EXPECT_TRUE(M.count(Id) == 0 || M.find(Id)->second.template get<T>() == 0); return false; } @@ -912,6 +943,15 @@ TEST(HasType, TakesDeclMatcherAndMatchesValueDecl) { notMatches("class X {}; void y() { X *x; }", varDecl(hasType(ClassX)))); } +TEST(HasTypeLoc, MatchesDeclaratorDecls) { + EXPECT_TRUE(matches("int x;", + varDecl(hasName("x"), hasTypeLoc(loc(asString("int")))))); + + // Make sure we don't crash on implicit constructors. + EXPECT_TRUE(notMatches("class X {}; X x;", + declaratorDecl(hasTypeLoc(loc(asString("int")))))); +} + TEST(Matcher, Call) { // FIXME: Do we want to overload Call() to directly take // Matcher<Decl>, too? @@ -1346,8 +1386,12 @@ TEST(Matcher, References) { ReferenceClassX)); EXPECT_TRUE( matches("class X {}; void y(X y) { const X &x = y; }", ReferenceClassX)); + // The match here is on the implicit copy constructor code for + // class X, not on code 'X x = y'. + EXPECT_TRUE( + matches("class X {}; void y(X y) { X x = y; }", ReferenceClassX)); EXPECT_TRUE( - notMatches("class X {}; void y(X y) { X x = y; }", ReferenceClassX)); + notMatches("class X {}; extern X x;", ReferenceClassX)); EXPECT_TRUE( notMatches("class X {}; void y(X *y) { X *&x = y; }", ReferenceClassX)); } @@ -1452,6 +1496,16 @@ TEST(Matcher, MatchesClassTemplateSpecialization) { classTemplateSpecializationDecl())); } +TEST(DeclaratorDecl, MatchesDeclaratorDecls) { + EXPECT_TRUE(matches("int x;", declaratorDecl())); + EXPECT_TRUE(notMatches("class A {};", declaratorDecl())); +} + +TEST(ParmVarDecl, MatchesParmVars) { + EXPECT_TRUE(matches("void f(int x);", parmVarDecl())); + EXPECT_TRUE(notMatches("void f();", parmVarDecl())); +} + TEST(Matcher, MatchesTypeTemplateArgument) { EXPECT_TRUE(matches( "template<typename T> struct B {};" @@ -1507,6 +1561,13 @@ TEST(Matcher, MatchesVirtualMethod) { methodDecl(isVirtual()))); } +TEST(Matcher, MatchesConstMethod) { + EXPECT_TRUE(matches("struct A { void foo() const; };", + methodDecl(isConst()))); + EXPECT_TRUE(notMatches("struct A { void foo(); };", + methodDecl(isConst()))); +} + TEST(Matcher, MatchesOverridingMethod) { EXPECT_TRUE(matches("class X { virtual int f(); }; " "class Y : public X { int f(); };", @@ -1827,6 +1888,17 @@ TEST(Matcher, IntegerLiterals) { EXPECT_TRUE(notMatches("int i = 10.0;", HasIntLiteral)); } +TEST(Matcher, FloatLiterals) { + StatementMatcher HasFloatLiteral = floatLiteral(); + EXPECT_TRUE(matches("float i = 10.0;", HasFloatLiteral)); + EXPECT_TRUE(matches("float i = 10.0f;", HasFloatLiteral)); + EXPECT_TRUE(matches("double i = 10.0;", HasFloatLiteral)); + EXPECT_TRUE(matches("double i = 10.0L;", HasFloatLiteral)); + EXPECT_TRUE(matches("double i = 1e10;", HasFloatLiteral)); + + EXPECT_TRUE(notMatches("float i = 10;", HasFloatLiteral)); +} + TEST(Matcher, NullPtrLiteral) { EXPECT_TRUE(matches("int* i = nullptr;", nullPtrLiteralExpr())); } @@ -2224,10 +2296,9 @@ TEST(AstMatcherPMacro, Works) { } AST_POLYMORPHIC_MATCHER_P( - polymorphicHas, internal::Matcher<Decl>, AMatcher) { - TOOLING_COMPILE_ASSERT((llvm::is_same<NodeType, Decl>::value) || - (llvm::is_same<NodeType, Stmt>::value), - assert_node_type_is_accessible); + polymorphicHas, + AST_POLYMORPHIC_SUPPORTED_TYPES_2(Decl, Stmt), + internal::Matcher<Decl>, AMatcher) { return Finder->matchesChildOf( Node, AMatcher, Builder, ASTMatchFinder::TK_IgnoreImplicitCastsAndParentheses, @@ -2917,6 +2988,37 @@ TEST(SwitchCase, MatchesSwitch) { EXPECT_TRUE(notMatches("void x() {}", switchStmt())); } +TEST(SwitchCase, MatchesEachCase) { + EXPECT_TRUE(notMatches("void x() { switch(42); }", + switchStmt(forEachSwitchCase(caseStmt())))); + EXPECT_TRUE(matches("void x() { switch(42) case 42:; }", + switchStmt(forEachSwitchCase(caseStmt())))); + EXPECT_TRUE(matches("void x() { switch(42) { case 42:; } }", + switchStmt(forEachSwitchCase(caseStmt())))); + EXPECT_TRUE(notMatches( + "void x() { if (1) switch(42) { case 42: switch (42) { default:; } } }", + ifStmt(has(switchStmt(forEachSwitchCase(defaultStmt())))))); + EXPECT_TRUE(matches("void x() { switch(42) { case 1+1: case 4:; } }", + switchStmt(forEachSwitchCase( + caseStmt(hasCaseConstant(integerLiteral())))))); + EXPECT_TRUE(notMatches("void x() { switch(42) { case 1+1: case 2+2:; } }", + switchStmt(forEachSwitchCase( + caseStmt(hasCaseConstant(integerLiteral())))))); + EXPECT_TRUE(notMatches("void x() { switch(42) { case 1 ... 2:; } }", + switchStmt(forEachSwitchCase( + caseStmt(hasCaseConstant(integerLiteral())))))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "void x() { switch (42) { case 1: case 2: case 3: default:; } }", + switchStmt(forEachSwitchCase(caseStmt().bind("x"))), + new VerifyIdIsBoundTo<CaseStmt>("x", 3))); +} + +TEST(ForEachConstructorInitializer, MatchesInitializers) { + EXPECT_TRUE(matches( + "struct X { X() : i(42), j(42) {} int i, j; };", + constructorDecl(forEachConstructorInitializer(ctorInitializer())))); +} + TEST(ExceptionHandling, SimpleCases) { EXPECT_TRUE(matches("void foo() try { } catch(int X) { }", catchStmt())); EXPECT_TRUE(matches("void foo() try { } catch(int X) { }", tryStmt())); @@ -2977,12 +3079,13 @@ TEST(ForEachDescendant, NestedForEachDescendant) { recordDecl(hasName("A"), anyOf(m, forEachDescendant(m))), new VerifyIdIsBoundTo<Decl>("x", "C"))); - // FIXME: This is not really a useful matcher, but the result is still - // surprising (currently binds "A"). - //EXPECT_TRUE(matchAndVerifyResultTrue( - // "class A { class B { class C {}; }; };", - // recordDecl(hasName("A"), allOf(hasDescendant(m), anyOf(m, anything()))), - // new VerifyIdIsBoundTo<Decl>("x", "C"))); + // Check that a partial match of 'm' that binds 'x' in the + // first part of anyOf(m, anything()) will not overwrite the + // binding created by the earlier binding in the hasDescendant. + EXPECT_TRUE(matchAndVerifyResultTrue( + "class A { class B { class C {}; }; };", + recordDecl(hasName("A"), allOf(hasDescendant(m), anyOf(m, anything()))), + new VerifyIdIsBoundTo<Decl>("x", "C"))); } TEST(ForEachDescendant, BindsMultipleNodes) { @@ -3002,6 +3105,117 @@ TEST(ForEachDescendant, BindsRecursiveCombinations) { new VerifyIdIsBoundTo<FieldDecl>("f", 8))); } +TEST(ForEachDescendant, BindsCombinations) { + EXPECT_TRUE(matchAndVerifyResultTrue( + "void f() { if(true) {} if (true) {} while (true) {} if (true) {} while " + "(true) {} }", + compoundStmt(forEachDescendant(ifStmt().bind("if")), + forEachDescendant(whileStmt().bind("while"))), + new VerifyIdIsBoundTo<IfStmt>("if", 6))); +} + +TEST(Has, DoesNotDeleteBindings) { + EXPECT_TRUE(matchAndVerifyResultTrue( + "class X { int a; };", recordDecl(decl().bind("x"), has(fieldDecl())), + new VerifyIdIsBoundTo<Decl>("x", 1))); +} + +TEST(LoopingMatchers, DoNotOverwritePreviousMatchResultOnFailure) { + // Those matchers cover all the cases where an inner matcher is called + // and there is not a 1:1 relationship between the match of the outer + // matcher and the match of the inner matcher. + // The pattern to look for is: + // ... return InnerMatcher.matches(...); ... + // In which case no special handling is needed. + // + // On the other hand, if there are multiple alternative matches + // (for example forEach*) or matches might be discarded (for example has*) + // the implementation must make sure that the discarded matches do not + // affect the bindings. + // When new such matchers are added, add a test here that: + // - matches a simple node, and binds it as the first thing in the matcher: + // recordDecl(decl().bind("x"), hasName("X"))) + // - uses the matcher under test afterwards in a way that not the first + // alternative is matched; for anyOf, that means the first branch + // would need to return false; for hasAncestor, it means that not + // the direct parent matches the inner matcher. + + EXPECT_TRUE(matchAndVerifyResultTrue( + "class X { int y; };", + recordDecl( + recordDecl().bind("x"), hasName("::X"), + anyOf(forEachDescendant(recordDecl(hasName("Y"))), anything())), + new VerifyIdIsBoundTo<CXXRecordDecl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class X {};", recordDecl(recordDecl().bind("x"), hasName("::X"), + anyOf(unless(anything()), anything())), + new VerifyIdIsBoundTo<CXXRecordDecl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "template<typename T1, typename T2> class X {}; X<float, int> x;", + classTemplateSpecializationDecl( + decl().bind("x"), + hasAnyTemplateArgument(refersToType(asString("int")))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class X { void f(); void g(); };", + recordDecl(decl().bind("x"), hasMethod(hasName("g"))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class X { X() : a(1), b(2) {} double a; int b; };", + recordDecl(decl().bind("x"), + has(constructorDecl( + hasAnyConstructorInitializer(forField(hasName("b")))))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "void x(int, int) { x(0, 42); }", + callExpr(expr().bind("x"), hasAnyArgument(integerLiteral(equals(42)))), + new VerifyIdIsBoundTo<Expr>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "void x(int, int y) {}", + functionDecl(decl().bind("x"), hasAnyParameter(hasName("y"))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "void x() { return; if (true) {} }", + functionDecl(decl().bind("x"), + has(compoundStmt(hasAnySubstatement(ifStmt())))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "namespace X { void b(int); void b(); }" + "using X::b;", + usingDecl(decl().bind("x"), hasAnyUsingShadowDecl(hasTargetDecl( + functionDecl(parameterCountIs(1))))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class A{}; class B{}; class C : B, A {};", + recordDecl(decl().bind("x"), isDerivedFrom("::A")), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class A{}; typedef A B; typedef A C; typedef A D;" + "class E : A {};", + recordDecl(decl().bind("x"), isDerivedFrom("C")), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class A { class B { void f() {} }; };", + functionDecl(decl().bind("x"), hasAncestor(recordDecl(hasName("::A")))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "template <typename T> struct A { struct B {" + " void f() { if(true) {} }" + "}; };" + "void t() { A<int>::B b; b.f(); }", + ifStmt(stmt().bind("x"), hasAncestor(recordDecl(hasName("::A")))), + new VerifyIdIsBoundTo<Stmt>("x", 2))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class A {};", + recordDecl(hasName("::A"), decl().bind("x"), unless(hasName("fooble"))), + new VerifyIdIsBoundTo<Decl>("x", 1))); + EXPECT_TRUE(matchAndVerifyResultTrue( + "class A { A() : s(), i(42) {} const char *s; int i; };", + constructorDecl(hasName("::A::A"), decl().bind("x"), + forEachConstructorInitializer(forField(hasName("i")))), + new VerifyIdIsBoundTo<Decl>("x", 1))); +} + TEST(ForEachDescendant, BindsCorrectNodes) { EXPECT_TRUE(matchAndVerifyResultTrue( "class C { void f(); int i; };", @@ -3900,6 +4114,128 @@ TEST(MatchFinder, InterceptsStartOfTranslationUnit) { OwningPtr<FrontendActionFactory> Factory(newFrontendActionFactory(&Finder)); ASSERT_TRUE(tooling::runToolOnCode(Factory->create(), "int x;")); EXPECT_TRUE(VerifyCallback.Called); + + VerifyCallback.Called = false; + OwningPtr<ASTUnit> AST(tooling::buildASTFromCode("int x;")); + ASSERT_TRUE(AST.get()); + Finder.matchAST(AST->getASTContext()); + EXPECT_TRUE(VerifyCallback.Called); +} + +class VerifyEndOfTranslationUnit : public MatchFinder::MatchCallback { +public: + VerifyEndOfTranslationUnit() : Called(false) {} + virtual void run(const MatchFinder::MatchResult &Result) { + EXPECT_FALSE(Called); + } + virtual void onEndOfTranslationUnit() { + Called = true; + } + bool Called; +}; + +TEST(MatchFinder, InterceptsEndOfTranslationUnit) { + MatchFinder Finder; + VerifyEndOfTranslationUnit VerifyCallback; + Finder.addMatcher(decl(), &VerifyCallback); + OwningPtr<FrontendActionFactory> Factory(newFrontendActionFactory(&Finder)); + ASSERT_TRUE(tooling::runToolOnCode(Factory->create(), "int x;")); + EXPECT_TRUE(VerifyCallback.Called); + + VerifyCallback.Called = false; + OwningPtr<ASTUnit> AST(tooling::buildASTFromCode("int x;")); + ASSERT_TRUE(AST.get()); + Finder.matchAST(AST->getASTContext()); + EXPECT_TRUE(VerifyCallback.Called); +} + +TEST(EqualsBoundNodeMatcher, QualType) { + EXPECT_TRUE(matches( + "int i = 1;", varDecl(hasType(qualType().bind("type")), + hasInitializer(ignoringParenImpCasts( + hasType(qualType(equalsBoundNode("type")))))))); + EXPECT_TRUE(notMatches("int i = 1.f;", + varDecl(hasType(qualType().bind("type")), + hasInitializer(ignoringParenImpCasts(hasType( + qualType(equalsBoundNode("type")))))))); +} + +TEST(EqualsBoundNodeMatcher, NonMatchingTypes) { + EXPECT_TRUE(notMatches( + "int i = 1;", varDecl(namedDecl(hasName("i")).bind("name"), + hasInitializer(ignoringParenImpCasts( + hasType(qualType(equalsBoundNode("type")))))))); +} + +TEST(EqualsBoundNodeMatcher, Stmt) { + EXPECT_TRUE( + matches("void f() { if(true) {} }", + stmt(allOf(ifStmt().bind("if"), + hasParent(stmt(has(stmt(equalsBoundNode("if"))))))))); + + EXPECT_TRUE(notMatches( + "void f() { if(true) { if (true) {} } }", + stmt(allOf(ifStmt().bind("if"), has(stmt(equalsBoundNode("if"))))))); +} + +TEST(EqualsBoundNodeMatcher, Decl) { + EXPECT_TRUE(matches( + "class X { class Y {}; };", + decl(allOf(recordDecl(hasName("::X::Y")).bind("record"), + hasParent(decl(has(decl(equalsBoundNode("record"))))))))); + + EXPECT_TRUE(notMatches("class X { class Y {}; };", + decl(allOf(recordDecl(hasName("::X")).bind("record"), + has(decl(equalsBoundNode("record"))))))); +} + +TEST(EqualsBoundNodeMatcher, Type) { + EXPECT_TRUE(matches( + "class X { int a; int b; };", + recordDecl( + has(fieldDecl(hasName("a"), hasType(type().bind("t")))), + has(fieldDecl(hasName("b"), hasType(type(equalsBoundNode("t")))))))); + + EXPECT_TRUE(notMatches( + "class X { int a; double b; };", + recordDecl( + has(fieldDecl(hasName("a"), hasType(type().bind("t")))), + has(fieldDecl(hasName("b"), hasType(type(equalsBoundNode("t")))))))); +} + +TEST(EqualsBoundNodeMatcher, UsingForEachDescendant) { + + EXPECT_TRUE(matchAndVerifyResultTrue( + "int f() {" + " if (1) {" + " int i = 9;" + " }" + " int j = 10;" + " {" + " float k = 9.0;" + " }" + " return 0;" + "}", + // Look for variable declarations within functions whose type is the same + // as the function return type. + functionDecl(returns(qualType().bind("type")), + forEachDescendant(varDecl(hasType( + qualType(equalsBoundNode("type")))).bind("decl"))), + // Only i and j should match, not k. + new VerifyIdIsBoundTo<VarDecl>("decl", 2))); +} + +TEST(EqualsBoundNodeMatcher, FiltersMatchedCombinations) { + EXPECT_TRUE(matchAndVerifyResultTrue( + "void f() {" + " int x;" + " double d;" + " x = d + x - d + x;" + "}", + functionDecl( + hasName("f"), forEachDescendant(varDecl().bind("d")), + forEachDescendant(declRefExpr(to(decl(equalsBoundNode("d")))))), + new VerifyIdIsBoundTo<VarDecl>("d", 5))); } } // end namespace ast_matchers diff --git a/unittests/ASTMatchers/ASTMatchersTest.h b/unittests/ASTMatchers/ASTMatchersTest.h index 5fed85b..f5bcd37 100644 --- a/unittests/ASTMatchers/ASTMatchersTest.h +++ b/unittests/ASTMatchers/ASTMatchersTest.h @@ -11,12 +11,14 @@ #define LLVM_CLANG_UNITTESTS_AST_MATCHERS_AST_MATCHERS_TEST_H #include "clang/ASTMatchers/ASTMatchFinder.h" +#include "clang/Frontend/ASTUnit.h" #include "clang/Tooling/Tooling.h" #include "gtest/gtest.h" namespace clang { namespace ast_matchers { +using clang::tooling::buildASTFromCodeWithArgs; using clang::tooling::newFrontendActionFactory; using clang::tooling::runToolOnCodeWithArgs; using clang::tooling::FrontendActionFactory; @@ -26,6 +28,7 @@ public: virtual ~BoundNodesCallback() {} virtual bool run(const BoundNodes *BoundNodes) = 0; virtual bool run(const BoundNodes *BoundNodes, ASTContext *Context) = 0; + virtual void onEndOfTranslationUnit() {} }; // If 'FindResultVerifier' is not NULL, sets *Verified to the result of @@ -44,6 +47,11 @@ public: } } + void onEndOfTranslationUnit() LLVM_OVERRIDE { + if (FindResultReviewer) + FindResultReviewer->onEndOfTranslationUnit(); + } + private: bool *const Verified; BoundNodesCallback *const FindResultReviewer; @@ -54,15 +62,23 @@ testing::AssertionResult matchesConditionally(const std::string &Code, const T &AMatcher, bool ExpectMatch, llvm::StringRef CompileArg) { - bool Found = false; + bool Found = false, DynamicFound = false; MatchFinder Finder; Finder.addMatcher(AMatcher, new VerifyMatch(0, &Found)); + if (!Finder.addDynamicMatcher(AMatcher, new VerifyMatch(0, &DynamicFound))) + return testing::AssertionFailure() << "Could not add dynamic matcher"; OwningPtr<FrontendActionFactory> Factory(newFrontendActionFactory(&Finder)); // Some tests use typeof, which is a gnu extension. std::vector<std::string> Args(1, CompileArg); if (!runToolOnCodeWithArgs(Factory->create(), Code, Args)) { return testing::AssertionFailure() << "Parsing error in \"" << Code << "\""; } + if (Found != DynamicFound) { + return testing::AssertionFailure() << "Dynamic match result (" + << DynamicFound + << ") does not match static result (" + << Found << ")"; + } if (!Found && ExpectMatch) { return testing::AssertionFailure() << "Could not find match in \"" << Code << "\""; @@ -107,6 +123,21 @@ matchAndVerifyResultConditionally(const std::string &Code, const T &AMatcher, return testing::AssertionFailure() << "Verified unexpected result in \"" << Code << "\""; } + + VerifiedResult = false; + OwningPtr<ASTUnit> AST(buildASTFromCodeWithArgs(Code, Args)); + if (!AST.get()) + return testing::AssertionFailure() << "Parsing error in \"" << Code + << "\" while building AST"; + Finder.matchAST(AST->getASTContext()); + if (!VerifiedResult && ExpectResult) { + return testing::AssertionFailure() + << "Could not verify result in \"" << Code << "\" with AST"; + } else if (VerifiedResult && !ExpectResult) { + return testing::AssertionFailure() + << "Verified unexpected result in \"" << Code << "\" with AST"; + } + return testing::AssertionSuccess(); } diff --git a/unittests/ASTMatchers/CMakeLists.txt b/unittests/ASTMatchers/CMakeLists.txt index 91feaac..862c6a0 100644 --- a/unittests/ASTMatchers/CMakeLists.txt +++ b/unittests/ASTMatchers/CMakeLists.txt @@ -11,3 +11,5 @@ add_clang_unittest(ASTMatchersTests target_link_libraries(ASTMatchersTests gtest gtest_main clangASTMatchers clangTooling) + +add_subdirectory(Dynamic) diff --git a/unittests/ASTMatchers/Dynamic/CMakeLists.txt b/unittests/ASTMatchers/Dynamic/CMakeLists.txt new file mode 100644 index 0000000..eb9fa54 --- /dev/null +++ b/unittests/ASTMatchers/Dynamic/CMakeLists.txt @@ -0,0 +1,7 @@ +add_clang_unittest(DynamicASTMatchersTests + VariantValueTest.cpp + ParserTest.cpp + RegistryTest.cpp) + +target_link_libraries(DynamicASTMatchersTests + gtest gtest_main clangASTMatchers clangDynamicASTMatchers clangTooling) diff --git a/unittests/ASTMatchers/Dynamic/Makefile b/unittests/ASTMatchers/Dynamic/Makefile new file mode 100644 index 0000000..66b183c --- /dev/null +++ b/unittests/ASTMatchers/Dynamic/Makefile @@ -0,0 +1,20 @@ +##===- unittests/ASTMatchers/Dynamic/Makefile --------------*- Makefile -*-===## +# +# The LLVM Compiler Infrastructure +# +# This file is distributed under the University of Illinois Open Source +# License. See LICENSE.TXT for details. +# +##===----------------------------------------------------------------------===## + +CLANG_LEVEL = ../../.. + +TESTNAME = DynamicASTMatchers +include $(CLANG_LEVEL)/../../Makefile.config +LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option +USEDLIBS = clangTooling.a clangFrontend.a clangSerialization.a clangDriver.a \ + clangRewriteCore.a clangRewriteFrontend.a clangParse.a clangSema.a \ + clangAnalysis.a clangEdit.a clangAST.a clangASTMatchers.a \ + clangLex.a clangBasic.a clangDynamicASTMatchers.a + +include $(CLANG_LEVEL)/unittests/Makefile diff --git a/unittests/ASTMatchers/Dynamic/ParserTest.cpp b/unittests/ASTMatchers/Dynamic/ParserTest.cpp new file mode 100644 index 0000000..f19ec51 --- /dev/null +++ b/unittests/ASTMatchers/Dynamic/ParserTest.cpp @@ -0,0 +1,238 @@ +//===- unittest/ASTMatchers/Dynamic/ParserTest.cpp - Parser unit tests -===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===-------------------------------------------------------------------===// + +#include <string> +#include <vector> + +#include "../ASTMatchersTest.h" +#include "clang/ASTMatchers/Dynamic/Parser.h" +#include "clang/ASTMatchers/Dynamic/Registry.h" +#include "gtest/gtest.h" +#include "llvm/ADT/StringMap.h" + +namespace clang { +namespace ast_matchers { +namespace dynamic { +namespace { + +class MockSema : public Parser::Sema { +public: + virtual ~MockSema() {} + + uint64_t expectMatcher(StringRef MatcherName) { + ast_matchers::internal::Matcher<Stmt> M = stmt(); + ExpectedMatchers.insert(std::make_pair(MatcherName, M)); + return M.getID(); + } + + void parse(StringRef Code) { + Diagnostics Error; + VariantValue Value; + Parser::parseExpression(Code, this, &Value, &Error); + Values.push_back(Value); + Errors.push_back(Error.toStringFull()); + } + + VariantMatcher actOnMatcherExpression(StringRef MatcherName, + const SourceRange &NameRange, + StringRef BindID, + ArrayRef<ParserValue> Args, + Diagnostics *Error) { + MatcherInfo ToStore = { MatcherName, NameRange, Args, BindID }; + Matchers.push_back(ToStore); + return VariantMatcher::SingleMatcher( + ExpectedMatchers.find(MatcherName)->second); + } + + struct MatcherInfo { + StringRef MatcherName; + SourceRange NameRange; + std::vector<ParserValue> Args; + std::string BoundID; + }; + + std::vector<std::string> Errors; + std::vector<VariantValue> Values; + std::vector<MatcherInfo> Matchers; + std::map<std::string, ast_matchers::internal::Matcher<Stmt> > + ExpectedMatchers; +}; + +TEST(ParserTest, ParseUnsigned) { + MockSema Sema; + Sema.parse("0"); + Sema.parse("123"); + Sema.parse("0x1f"); + Sema.parse("12345678901"); + Sema.parse("1a1"); + EXPECT_EQ(5U, Sema.Values.size()); + EXPECT_EQ(0U, Sema.Values[0].getUnsigned()); + EXPECT_EQ(123U, Sema.Values[1].getUnsigned()); + EXPECT_EQ(31U, Sema.Values[2].getUnsigned()); + EXPECT_EQ("1:1: Error parsing unsigned token: <12345678901>", Sema.Errors[3]); + EXPECT_EQ("1:1: Error parsing unsigned token: <1a1>", Sema.Errors[4]); +} + +TEST(ParserTest, ParseString) { + MockSema Sema; + Sema.parse("\"Foo\""); + Sema.parse("\"\""); + Sema.parse("\"Baz"); + EXPECT_EQ(3ULL, Sema.Values.size()); + EXPECT_EQ("Foo", Sema.Values[0].getString()); + EXPECT_EQ("", Sema.Values[1].getString()); + EXPECT_EQ("1:1: Error parsing string token: <\"Baz>", Sema.Errors[2]); +} + +bool matchesRange(const SourceRange &Range, unsigned StartLine, + unsigned EndLine, unsigned StartColumn, unsigned EndColumn) { + EXPECT_EQ(StartLine, Range.Start.Line); + EXPECT_EQ(EndLine, Range.End.Line); + EXPECT_EQ(StartColumn, Range.Start.Column); + EXPECT_EQ(EndColumn, Range.End.Column); + return Range.Start.Line == StartLine && Range.End.Line == EndLine && + Range.Start.Column == StartColumn && Range.End.Column == EndColumn; +} + +llvm::Optional<DynTypedMatcher> getSingleMatcher(const VariantValue &Value) { + llvm::Optional<DynTypedMatcher> Result = + Value.getMatcher().getSingleMatcher(); + EXPECT_TRUE(Result.hasValue()); + return Result; +} + +TEST(ParserTest, ParseMatcher) { + MockSema Sema; + const uint64_t ExpectedFoo = Sema.expectMatcher("Foo"); + const uint64_t ExpectedBar = Sema.expectMatcher("Bar"); + const uint64_t ExpectedBaz = Sema.expectMatcher("Baz"); + Sema.parse(" Foo ( Bar ( 17), Baz( \n \"B A,Z\") ) .bind( \"Yo!\") "); + for (size_t i = 0, e = Sema.Errors.size(); i != e; ++i) { + EXPECT_EQ("", Sema.Errors[i]); + } + + EXPECT_EQ(1ULL, Sema.Values.size()); + EXPECT_EQ(ExpectedFoo, getSingleMatcher(Sema.Values[0])->getID()); + + EXPECT_EQ(3ULL, Sema.Matchers.size()); + const MockSema::MatcherInfo Bar = Sema.Matchers[0]; + EXPECT_EQ("Bar", Bar.MatcherName); + EXPECT_TRUE(matchesRange(Bar.NameRange, 1, 1, 8, 17)); + EXPECT_EQ(1ULL, Bar.Args.size()); + EXPECT_EQ(17U, Bar.Args[0].Value.getUnsigned()); + + const MockSema::MatcherInfo Baz = Sema.Matchers[1]; + EXPECT_EQ("Baz", Baz.MatcherName); + EXPECT_TRUE(matchesRange(Baz.NameRange, 1, 2, 19, 10)); + EXPECT_EQ(1ULL, Baz.Args.size()); + EXPECT_EQ("B A,Z", Baz.Args[0].Value.getString()); + + const MockSema::MatcherInfo Foo = Sema.Matchers[2]; + EXPECT_EQ("Foo", Foo.MatcherName); + EXPECT_TRUE(matchesRange(Foo.NameRange, 1, 2, 2, 12)); + EXPECT_EQ(2ULL, Foo.Args.size()); + EXPECT_EQ(ExpectedBar, getSingleMatcher(Foo.Args[0].Value)->getID()); + EXPECT_EQ(ExpectedBaz, getSingleMatcher(Foo.Args[1].Value)->getID()); + EXPECT_EQ("Yo!", Foo.BoundID); +} + +using ast_matchers::internal::Matcher; + +TEST(ParserTest, FullParserTest) { + Diagnostics Error; + llvm::Optional<DynTypedMatcher> VarDecl(Parser::parseMatcherExpression( + "varDecl(hasInitializer(binaryOperator(hasLHS(integerLiteral())," + " hasOperatorName(\"+\"))))", + &Error)); + EXPECT_EQ("", Error.toStringFull()); + Matcher<Decl> M = VarDecl->unconditionalConvertTo<Decl>(); + EXPECT_TRUE(matches("int x = 1 + false;", M)); + EXPECT_FALSE(matches("int x = true + 1;", M)); + EXPECT_FALSE(matches("int x = 1 - false;", M)); + EXPECT_FALSE(matches("int x = true - 1;", M)); + + llvm::Optional<DynTypedMatcher> HasParameter(Parser::parseMatcherExpression( + "functionDecl(hasParameter(1, hasName(\"x\")))", &Error)); + EXPECT_EQ("", Error.toStringFull()); + M = HasParameter->unconditionalConvertTo<Decl>(); + + EXPECT_TRUE(matches("void f(int a, int x);", M)); + EXPECT_FALSE(matches("void f(int x, int a);", M)); + + EXPECT_TRUE(!Parser::parseMatcherExpression( + "hasInitializer(\n binaryOperator(hasLHS(\"A\")))", + &Error).hasValue()); + EXPECT_EQ("1:1: Error parsing argument 1 for matcher hasInitializer.\n" + "2:5: Error parsing argument 1 for matcher binaryOperator.\n" + "2:20: Error building matcher hasLHS.\n" + "2:27: Incorrect type for arg 1. " + "(Expected = Matcher<Expr>) != (Actual = String)", + Error.toStringFull()); +} + +std::string ParseWithError(StringRef Code) { + Diagnostics Error; + VariantValue Value; + Parser::parseExpression(Code, &Value, &Error); + return Error.toStringFull(); +} + +std::string ParseMatcherWithError(StringRef Code) { + Diagnostics Error; + Parser::parseMatcherExpression(Code, &Error); + return Error.toStringFull(); +} + +TEST(ParserTest, Errors) { + EXPECT_EQ( + "1:5: Error parsing matcher. Found token <123> while looking for '('.", + ParseWithError("Foo 123")); + EXPECT_EQ( + "1:9: Error parsing matcher. Found token <123> while looking for ','.", + ParseWithError("Foo(\"A\" 123)")); + EXPECT_EQ( + "1:4: Error parsing matcher. Found end-of-code while looking for ')'.", + ParseWithError("Foo(")); + EXPECT_EQ("1:1: End of code found while looking for token.", + ParseWithError("")); + EXPECT_EQ("Input value is not a matcher expression.", + ParseMatcherWithError("\"A\"")); + EXPECT_EQ("1:1: Error parsing argument 1 for matcher Foo.\n" + "1:5: Invalid token <(> found when looking for a value.", + ParseWithError("Foo((")); + EXPECT_EQ("1:7: Expected end of code.", ParseWithError("expr()a")); + EXPECT_EQ("1:11: Malformed bind() expression.", + ParseWithError("isArrow().biind")); + EXPECT_EQ("1:15: Malformed bind() expression.", + ParseWithError("isArrow().bind")); + EXPECT_EQ("1:16: Malformed bind() expression.", + ParseWithError("isArrow().bind(foo")); + EXPECT_EQ("1:21: Malformed bind() expression.", + ParseWithError("isArrow().bind(\"foo\"")); + EXPECT_EQ("1:1: Error building matcher isArrow.\n" + "1:1: Matcher does not support binding.", + ParseWithError("isArrow().bind(\"foo\")")); + EXPECT_EQ("Input value has unresolved overloaded type: " + "Matcher<DoStmt|ForStmt|WhileStmt>", + ParseMatcherWithError("hasBody(stmt())")); +} + +TEST(ParserTest, OverloadErrors) { + EXPECT_EQ("1:1: Error building matcher callee.\n" + "1:8: Candidate 1: Incorrect type for arg 1. " + "(Expected = Matcher<Stmt>) != (Actual = String)\n" + "1:8: Candidate 2: Incorrect type for arg 1. " + "(Expected = Matcher<Decl>) != (Actual = String)", + ParseWithError("callee(\"A\")")); +} + +} // end anonymous namespace +} // end namespace dynamic +} // end namespace ast_matchers +} // end namespace clang diff --git a/unittests/ASTMatchers/Dynamic/RegistryTest.cpp b/unittests/ASTMatchers/Dynamic/RegistryTest.cpp new file mode 100644 index 0000000..e716484 --- /dev/null +++ b/unittests/ASTMatchers/Dynamic/RegistryTest.cpp @@ -0,0 +1,347 @@ +//===- unittest/ASTMatchers/Dynamic/RegistryTest.cpp - Registry unit tests -===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===-----------------------------------------------------------------------===// + +#include <vector> + +#include "../ASTMatchersTest.h" +#include "clang/ASTMatchers/Dynamic/Registry.h" +#include "gtest/gtest.h" + +namespace clang { +namespace ast_matchers { +namespace dynamic { +namespace { + +using ast_matchers::internal::Matcher; + +class RegistryTest : public ::testing::Test { +public: + std::vector<ParserValue> Args() { return std::vector<ParserValue>(); } + std::vector<ParserValue> Args(const VariantValue &Arg1) { + std::vector<ParserValue> Out(1); + Out[0].Value = Arg1; + return Out; + } + std::vector<ParserValue> Args(const VariantValue &Arg1, + const VariantValue &Arg2) { + std::vector<ParserValue> Out(2); + Out[0].Value = Arg1; + Out[1].Value = Arg2; + return Out; + } + + VariantMatcher constructMatcher(StringRef MatcherName, + Diagnostics *Error = NULL) { + Diagnostics DummyError; + if (!Error) Error = &DummyError; + const VariantMatcher Out = + Registry::constructMatcher(MatcherName, SourceRange(), Args(), Error); + EXPECT_EQ("", DummyError.toStringFull()); + return Out; + } + + VariantMatcher constructMatcher(StringRef MatcherName, + const VariantValue &Arg1, + Diagnostics *Error = NULL) { + Diagnostics DummyError; + if (!Error) Error = &DummyError; + const VariantMatcher Out = Registry::constructMatcher( + MatcherName, SourceRange(), Args(Arg1), Error); + EXPECT_EQ("", DummyError.toStringFull()); + return Out; + } + + VariantMatcher constructMatcher(StringRef MatcherName, + const VariantValue &Arg1, + const VariantValue &Arg2, + Diagnostics *Error = NULL) { + Diagnostics DummyError; + if (!Error) Error = &DummyError; + const VariantMatcher Out = Registry::constructMatcher( + MatcherName, SourceRange(), Args(Arg1, Arg2), Error); + EXPECT_EQ("", DummyError.toStringFull()); + return Out; + } +}; + +TEST_F(RegistryTest, CanConstructNoArgs) { + Matcher<Stmt> IsArrowValue = constructMatcher( + "memberExpr", constructMatcher("isArrow")).getTypedMatcher<Stmt>(); + Matcher<Stmt> BoolValue = + constructMatcher("boolLiteral").getTypedMatcher<Stmt>(); + + const std::string ClassSnippet = "struct Foo { int x; };\n" + "Foo *foo = new Foo;\n" + "int i = foo->x;\n"; + const std::string BoolSnippet = "bool Foo = true;\n"; + + EXPECT_TRUE(matches(ClassSnippet, IsArrowValue)); + EXPECT_TRUE(matches(BoolSnippet, BoolValue)); + EXPECT_FALSE(matches(ClassSnippet, BoolValue)); + EXPECT_FALSE(matches(BoolSnippet, IsArrowValue)); +} + +TEST_F(RegistryTest, ConstructWithSimpleArgs) { + Matcher<Decl> Value = constructMatcher( + "namedDecl", constructMatcher("hasName", std::string("X"))) + .getTypedMatcher<Decl>(); + EXPECT_TRUE(matches("class X {};", Value)); + EXPECT_FALSE(matches("int x;", Value)); + + Value = functionDecl(constructMatcher("parameterCountIs", 2) + .getTypedMatcher<FunctionDecl>()); + EXPECT_TRUE(matches("void foo(int,int);", Value)); + EXPECT_FALSE(matches("void foo(int);", Value)); +} + +TEST_F(RegistryTest, ConstructWithMatcherArgs) { + Matcher<Decl> HasInitializerSimple = constructMatcher( + "varDecl", constructMatcher("hasInitializer", constructMatcher("stmt"))) + .getTypedMatcher<Decl>(); + Matcher<Decl> HasInitializerComplex = constructMatcher( + "varDecl", + constructMatcher("hasInitializer", constructMatcher("callExpr"))) + .getTypedMatcher<Decl>(); + + std::string code = "int i;"; + EXPECT_FALSE(matches(code, HasInitializerSimple)); + EXPECT_FALSE(matches(code, HasInitializerComplex)); + + code = "int i = 1;"; + EXPECT_TRUE(matches(code, HasInitializerSimple)); + EXPECT_FALSE(matches(code, HasInitializerComplex)); + + code = "int y(); int i = y();"; + EXPECT_TRUE(matches(code, HasInitializerSimple)); + EXPECT_TRUE(matches(code, HasInitializerComplex)); + + Matcher<Decl> HasParameter = + functionDecl(constructMatcher( + "hasParameter", 1, constructMatcher("hasName", std::string("x"))) + .getTypedMatcher<FunctionDecl>()); + EXPECT_TRUE(matches("void f(int a, int x);", HasParameter)); + EXPECT_FALSE(matches("void f(int x, int a);", HasParameter)); +} + +TEST_F(RegistryTest, OverloadedMatchers) { + Matcher<Stmt> CallExpr0 = constructMatcher( + "callExpr", + constructMatcher("callee", constructMatcher("memberExpr", + constructMatcher("isArrow")))) + .getTypedMatcher<Stmt>(); + + Matcher<Stmt> CallExpr1 = constructMatcher( + "callExpr", + constructMatcher( + "callee", + constructMatcher("methodDecl", + constructMatcher("hasName", std::string("x"))))) + .getTypedMatcher<Stmt>(); + + std::string Code = "class Y { public: void x(); }; void z() { Y y; y.x(); }"; + EXPECT_FALSE(matches(Code, CallExpr0)); + EXPECT_TRUE(matches(Code, CallExpr1)); + + Code = "class Z { public: void z() { this->z(); } };"; + EXPECT_TRUE(matches(Code, CallExpr0)); + EXPECT_FALSE(matches(Code, CallExpr1)); +} + +TEST_F(RegistryTest, PolymorphicMatchers) { + const VariantMatcher IsDefinition = constructMatcher("isDefinition"); + Matcher<Decl> Var = + constructMatcher("varDecl", IsDefinition).getTypedMatcher<Decl>(); + Matcher<Decl> Class = + constructMatcher("recordDecl", IsDefinition).getTypedMatcher<Decl>(); + Matcher<Decl> Func = + constructMatcher("functionDecl", IsDefinition).getTypedMatcher<Decl>(); + EXPECT_TRUE(matches("int a;", Var)); + EXPECT_FALSE(matches("extern int a;", Var)); + EXPECT_TRUE(matches("class A {};", Class)); + EXPECT_FALSE(matches("class A;", Class)); + EXPECT_TRUE(matches("void f(){};", Func)); + EXPECT_FALSE(matches("void f();", Func)); + + Matcher<Decl> Anything = constructMatcher("anything").getTypedMatcher<Decl>(); + Matcher<Decl> RecordDecl = constructMatcher( + "recordDecl", constructMatcher("hasName", std::string("Foo")), + VariantMatcher::SingleMatcher(Anything)).getTypedMatcher<Decl>(); + + EXPECT_TRUE(matches("int Foo;", Anything)); + EXPECT_TRUE(matches("class Foo {};", Anything)); + EXPECT_TRUE(matches("void Foo(){};", Anything)); + EXPECT_FALSE(matches("int Foo;", RecordDecl)); + EXPECT_TRUE(matches("class Foo {};", RecordDecl)); + EXPECT_FALSE(matches("void Foo(){};", RecordDecl)); + + Matcher<Stmt> ConstructExpr = constructMatcher( + "constructExpr", + constructMatcher( + "hasDeclaration", + constructMatcher( + "methodDecl", + constructMatcher( + "ofClass", constructMatcher("hasName", std::string("Foo")))))) + .getTypedMatcher<Stmt>(); + EXPECT_FALSE(matches("class Foo { public: Foo(); };", ConstructExpr)); + EXPECT_TRUE( + matches("class Foo { public: Foo(); }; Foo foo = Foo();", ConstructExpr)); +} + +TEST_F(RegistryTest, TemplateArgument) { + Matcher<Decl> HasTemplateArgument = constructMatcher( + "classTemplateSpecializationDecl", + constructMatcher( + "hasAnyTemplateArgument", + constructMatcher("refersToType", + constructMatcher("asString", std::string("int"))))) + .getTypedMatcher<Decl>(); + EXPECT_TRUE(matches("template<typename T> class A {}; A<int> a;", + HasTemplateArgument)); + EXPECT_FALSE(matches("template<typename T> class A {}; A<char> a;", + HasTemplateArgument)); +} + +TEST_F(RegistryTest, TypeTraversal) { + Matcher<Type> M = constructMatcher( + "pointerType", + constructMatcher("pointee", constructMatcher("isConstQualified"), + constructMatcher("isInteger"))).getTypedMatcher<Type>(); + EXPECT_FALSE(matches("int *a;", M)); + EXPECT_TRUE(matches("int const *b;", M)); + + M = constructMatcher( + "arrayType", + constructMatcher("hasElementType", constructMatcher("builtinType"))) + .getTypedMatcher<Type>(); + EXPECT_FALSE(matches("struct A{}; A a[7];;", M)); + EXPECT_TRUE(matches("int b[7];", M)); +} + +TEST_F(RegistryTest, CXXCtorInitializer) { + Matcher<Decl> CtorDecl = constructMatcher( + "constructorDecl", + constructMatcher( + "hasAnyConstructorInitializer", + constructMatcher("forField", + constructMatcher("hasName", std::string("foo"))))) + .getTypedMatcher<Decl>(); + EXPECT_TRUE(matches("struct Foo { Foo() : foo(1) {} int foo; };", CtorDecl)); + EXPECT_FALSE(matches("struct Foo { Foo() {} int foo; };", CtorDecl)); + EXPECT_FALSE(matches("struct Foo { Foo() : bar(1) {} int bar; };", CtorDecl)); +} + +TEST_F(RegistryTest, Adaptative) { + Matcher<Decl> D = constructMatcher( + "recordDecl", + constructMatcher( + "has", + constructMatcher("recordDecl", + constructMatcher("hasName", std::string("X"))))) + .getTypedMatcher<Decl>(); + EXPECT_TRUE(matches("class X {};", D)); + EXPECT_TRUE(matches("class Y { class X {}; };", D)); + EXPECT_FALSE(matches("class Y { class Z {}; };", D)); + + Matcher<Stmt> S = constructMatcher( + "forStmt", + constructMatcher( + "hasDescendant", + constructMatcher("varDecl", + constructMatcher("hasName", std::string("X"))))) + .getTypedMatcher<Stmt>(); + EXPECT_TRUE(matches("void foo() { for(int X;;); }", S)); + EXPECT_TRUE(matches("void foo() { for(;;) { int X; } }", S)); + EXPECT_FALSE(matches("void foo() { for(;;); }", S)); + EXPECT_FALSE(matches("void foo() { if (int X = 0){} }", S)); + + S = constructMatcher( + "compoundStmt", constructMatcher("hasParent", constructMatcher("ifStmt"))) + .getTypedMatcher<Stmt>(); + EXPECT_TRUE(matches("void foo() { if (true) { int x = 42; } }", S)); + EXPECT_FALSE(matches("void foo() { if (true) return; }", S)); +} + +TEST_F(RegistryTest, VariadicOp) { + Matcher<Decl> D = constructMatcher( + "anyOf", + constructMatcher("recordDecl", + constructMatcher("hasName", std::string("Foo"))), + constructMatcher("namedDecl", + constructMatcher("hasName", std::string("foo")))) + .getTypedMatcher<Decl>(); + + EXPECT_TRUE(matches("void foo(){}", D)); + EXPECT_TRUE(matches("struct Foo{};", D)); + EXPECT_FALSE(matches("int i = 0;", D)); + + D = constructMatcher( + "allOf", constructMatcher("recordDecl"), + constructMatcher( + "namedDecl", + constructMatcher("anyOf", + constructMatcher("hasName", std::string("Foo")), + constructMatcher("hasName", std::string("Bar"))))) + .getTypedMatcher<Decl>(); + + EXPECT_FALSE(matches("void foo(){}", D)); + EXPECT_TRUE(matches("struct Foo{};", D)); + EXPECT_FALSE(matches("int i = 0;", D)); + EXPECT_TRUE(matches("class Bar{};", D)); + EXPECT_FALSE(matches("class OtherBar{};", D)); +} + +TEST_F(RegistryTest, Errors) { + // Incorrect argument count. + OwningPtr<Diagnostics> Error(new Diagnostics()); + EXPECT_TRUE(constructMatcher("hasInitializer", Error.get()).isNull()); + EXPECT_EQ("Incorrect argument count. (Expected = 1) != (Actual = 0)", + Error->toString()); + Error.reset(new Diagnostics()); + EXPECT_TRUE(constructMatcher("isArrow", std::string(), Error.get()).isNull()); + EXPECT_EQ("Incorrect argument count. (Expected = 0) != (Actual = 1)", + Error->toString()); + + // Bad argument type + Error.reset(new Diagnostics()); + EXPECT_TRUE(constructMatcher("ofClass", std::string(), Error.get()).isNull()); + EXPECT_EQ("Incorrect type for arg 1. (Expected = Matcher<CXXRecordDecl>) != " + "(Actual = String)", + Error->toString()); + Error.reset(new Diagnostics()); + EXPECT_TRUE(constructMatcher("recordDecl", constructMatcher("recordDecl"), + constructMatcher("parameterCountIs", 3), + Error.get()).isNull()); + EXPECT_EQ("Incorrect type for arg 2. (Expected = Matcher<CXXRecordDecl>) != " + "(Actual = Matcher<FunctionDecl>)", + Error->toString()); + + // Bad argument type with variadic. + Error.reset(new Diagnostics()); + EXPECT_TRUE(constructMatcher("anyOf", std::string(), Error.get()).isNull()); + EXPECT_EQ( + "Incorrect type for arg 1. (Expected = Matcher<>) != (Actual = String)", + Error->toString()); + Error.reset(new Diagnostics()); + EXPECT_TRUE(constructMatcher( + "recordDecl", + constructMatcher("allOf", + constructMatcher("isDerivedFrom", std::string("FOO")), + constructMatcher("isArrow")), + Error.get()).isNull()); + EXPECT_EQ("Incorrect type for arg 1. " + "(Expected = Matcher<CXXRecordDecl>) != " + "(Actual = Matcher<CXXRecordDecl>&Matcher<MemberExpr>)", + Error->toString()); +} + +} // end anonymous namespace +} // end namespace dynamic +} // end namespace ast_matchers +} // end namespace clang diff --git a/unittests/ASTMatchers/Dynamic/VariantValueTest.cpp b/unittests/ASTMatchers/Dynamic/VariantValueTest.cpp new file mode 100644 index 0000000..d2b8a58 --- /dev/null +++ b/unittests/ASTMatchers/Dynamic/VariantValueTest.cpp @@ -0,0 +1,144 @@ +//===- unittest/ASTMatchers/Dynamic/VariantValueTest.cpp - VariantValue unit tests -===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===-----------------------------------------------------------------------------===// + +#include "../ASTMatchersTest.h" +#include "clang/ASTMatchers/Dynamic/VariantValue.h" +#include "gtest/gtest.h" + +namespace clang { +namespace ast_matchers { +namespace dynamic { +namespace { + +using ast_matchers::internal::DynTypedMatcher; +using ast_matchers::internal::Matcher; + +TEST(VariantValueTest, Unsigned) { + const unsigned kUnsigned = 17; + VariantValue Value = kUnsigned; + + EXPECT_TRUE(Value.isUnsigned()); + EXPECT_EQ(kUnsigned, Value.getUnsigned()); + + EXPECT_FALSE(Value.isString()); + EXPECT_FALSE(Value.isMatcher()); +} + +TEST(VariantValueTest, String) { + const ::std::string kString = "string"; + VariantValue Value = kString; + + EXPECT_TRUE(Value.isString()); + EXPECT_EQ(kString, Value.getString()); + EXPECT_EQ("String", Value.getTypeAsString()); + + EXPECT_FALSE(Value.isUnsigned()); + EXPECT_FALSE(Value.isMatcher()); +} + +TEST(VariantValueTest, DynTypedMatcher) { + VariantValue Value = VariantMatcher::SingleMatcher(stmt()); + + EXPECT_FALSE(Value.isUnsigned()); + EXPECT_FALSE(Value.isString()); + + EXPECT_TRUE(Value.isMatcher()); + EXPECT_FALSE(Value.getMatcher().hasTypedMatcher<Decl>()); + EXPECT_TRUE(Value.getMatcher().hasTypedMatcher<UnaryOperator>()); + EXPECT_EQ("Matcher<Stmt>", Value.getTypeAsString()); + + // Can only convert to compatible matchers. + Value = VariantMatcher::SingleMatcher(recordDecl()); + EXPECT_TRUE(Value.isMatcher()); + EXPECT_TRUE(Value.getMatcher().hasTypedMatcher<Decl>()); + EXPECT_FALSE(Value.getMatcher().hasTypedMatcher<UnaryOperator>()); + EXPECT_EQ("Matcher<Decl>", Value.getTypeAsString()); + + Value = VariantMatcher::SingleMatcher(ignoringImpCasts(expr())); + EXPECT_TRUE(Value.isMatcher()); + EXPECT_FALSE(Value.getMatcher().hasTypedMatcher<Decl>()); + EXPECT_FALSE(Value.getMatcher().hasTypedMatcher<Stmt>()); + EXPECT_TRUE(Value.getMatcher().hasTypedMatcher<Expr>()); + EXPECT_TRUE(Value.getMatcher().hasTypedMatcher<IntegerLiteral>()); + EXPECT_FALSE(Value.getMatcher().hasTypedMatcher<GotoStmt>()); + EXPECT_EQ("Matcher<Expr>", Value.getTypeAsString()); +} + +TEST(VariantValueTest, Assignment) { + VariantValue Value = std::string("A"); + EXPECT_TRUE(Value.isString()); + EXPECT_EQ("A", Value.getString()); + EXPECT_FALSE(Value.isUnsigned()); + EXPECT_FALSE(Value.isMatcher()); + EXPECT_EQ("String", Value.getTypeAsString()); + + Value = VariantMatcher::SingleMatcher(recordDecl()); + EXPECT_FALSE(Value.isUnsigned()); + EXPECT_FALSE(Value.isString()); + EXPECT_TRUE(Value.isMatcher()); + EXPECT_TRUE(Value.getMatcher().hasTypedMatcher<Decl>()); + EXPECT_FALSE(Value.getMatcher().hasTypedMatcher<UnaryOperator>()); + EXPECT_EQ("Matcher<Decl>", Value.getTypeAsString()); + + Value = 17; + EXPECT_TRUE(Value.isUnsigned()); + EXPECT_EQ(17U, Value.getUnsigned()); + EXPECT_FALSE(Value.isMatcher()); + EXPECT_FALSE(Value.isString()); + + Value = VariantValue(); + EXPECT_FALSE(Value.isUnsigned()); + EXPECT_FALSE(Value.isString()); + EXPECT_FALSE(Value.isMatcher()); + EXPECT_EQ("Nothing", Value.getTypeAsString()); +} + +TEST(VariantValueTest, Matcher) { + EXPECT_TRUE(matches("class X {};", VariantValue(VariantMatcher::SingleMatcher( + recordDecl(hasName("X")))) + .getMatcher() + .getTypedMatcher<Decl>())); + EXPECT_TRUE( + matches("int x;", VariantValue(VariantMatcher::SingleMatcher(varDecl())) + .getMatcher() + .getTypedMatcher<Decl>())); + EXPECT_TRUE( + matches("int foo() { return 1 + 1; }", + VariantValue(VariantMatcher::SingleMatcher(functionDecl())) + .getMatcher() + .getTypedMatcher<Decl>())); + // Can't get the wrong matcher. + EXPECT_FALSE(VariantValue(VariantMatcher::SingleMatcher(varDecl())) + .getMatcher() + .hasTypedMatcher<Stmt>()); +#if !defined(NDEBUG) && GTEST_HAS_DEATH_TEST && !defined(_MSC_VER) + // Trying to get the wrong matcher fails an assertion in Matcher<T>. We don't + // do this test when building with MSVC because its debug C runtime prints the + // assertion failure message as a wide string, which gtest doesn't understand. + EXPECT_DEATH(VariantValue(VariantMatcher::SingleMatcher(varDecl())) + .getMatcher() + .getTypedMatcher<Stmt>(), + "hasTypedMatcher"); +#endif + + EXPECT_FALSE(matches( + "int x;", VariantValue(VariantMatcher::SingleMatcher(functionDecl())) + .getMatcher() + .getTypedMatcher<Decl>())); + EXPECT_FALSE( + matches("int foo() { return 1 + 1; }", + VariantValue(VariantMatcher::SingleMatcher(declRefExpr())) + .getMatcher() + .getTypedMatcher<Stmt>())); +} + +} // end anonymous namespace +} // end namespace dynamic +} // end namespace ast_matchers +} // end namespace clang diff --git a/unittests/ASTMatchers/Makefile b/unittests/ASTMatchers/Makefile index 2abe6ee..dad300c 100644 --- a/unittests/ASTMatchers/Makefile +++ b/unittests/ASTMatchers/Makefile @@ -9,9 +9,11 @@ CLANG_LEVEL = ../.. +PARALLEL_DIRS = Dynamic + TESTNAME = ASTMatchers include $(CLANG_LEVEL)/../../Makefile.config -LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc +LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option USEDLIBS = clangTooling.a clangFrontend.a clangSerialization.a clangDriver.a \ clangRewriteCore.a clangRewriteFrontend.a \ clangParse.a clangSema.a clangAnalysis.a \ diff --git a/unittests/Basic/FileManagerTest.cpp b/unittests/Basic/FileManagerTest.cpp index a55fcbf..f8ce50d 100644 --- a/unittests/Basic/FileManagerTest.cpp +++ b/unittests/Basic/FileManagerTest.cpp @@ -24,18 +24,15 @@ class FakeStatCache : public FileSystemStatCache { private: // Maps a file/directory path to its desired stat result. Anything // not in this map is considered to not exist in the file system. - llvm::StringMap<struct stat, llvm::BumpPtrAllocator> StatCalls; + llvm::StringMap<FileData, llvm::BumpPtrAllocator> StatCalls; void InjectFileOrDirectory(const char *Path, ino_t INode, bool IsFile) { - struct stat statBuf; - memset(&statBuf, 0, sizeof(statBuf)); - statBuf.st_dev = 1; -#ifndef _WIN32 // struct stat has no st_ino field on Windows. - statBuf.st_ino = INode; -#endif - statBuf.st_mode = IsFile ? (0777 | S_IFREG) // a regular file - : (0777 | S_IFDIR); // a directory - StatCalls[Path] = statBuf; + FileData Data; + memset(&Data, 0, sizeof(FileData)); + llvm::sys::fs::UniqueID ID(1, INode); + Data.UniqueID = ID; + Data.IsDirectory = !IsFile; + StatCalls[Path] = Data; } public: @@ -50,10 +47,10 @@ public: } // Implement FileSystemStatCache::getStat(). - virtual LookupResult getStat(const char *Path, struct stat &StatBuf, - bool isFile, int *FileDescriptor) { + virtual LookupResult getStat(const char *Path, FileData &Data, bool isFile, + int *FileDescriptor) { if (StatCalls.count(Path) != 0) { - StatBuf = StatCalls[Path]; + Data = StatCalls[Path]; return CacheExists; } @@ -125,6 +122,14 @@ TEST_F(FileManagerTest, getFileReturnsValidFileEntryForExistingRealFile) { FakeStatCache *statCache = new FakeStatCache; statCache->InjectDirectory("/tmp", 42); statCache->InjectFile("/tmp/test", 43); + +#ifdef _WIN32 + const char *DirName = "C:."; + const char *FileName = "C:test"; + statCache->InjectDirectory(DirName, 44); + statCache->InjectFile(FileName, 45); +#endif + manager.addStatCache(statCache); const FileEntry *file = manager.getFile("/tmp/test"); @@ -134,6 +139,15 @@ TEST_F(FileManagerTest, getFileReturnsValidFileEntryForExistingRealFile) { const DirectoryEntry *dir = file->getDir(); ASSERT_TRUE(dir != NULL); EXPECT_STREQ("/tmp", dir->getName()); + +#ifdef _WIN32 + file = manager.getFile(FileName); + ASSERT_TRUE(file != NULL); + + dir = file->getDir(); + ASSERT_TRUE(dir != NULL); + EXPECT_STREQ(DirName, dir->getName()); +#endif } // getFile() returns non-NULL if a virtual file exists at the given path. diff --git a/unittests/Basic/SourceManagerTest.cpp b/unittests/Basic/SourceManagerTest.cpp index 8e7f4a0..d94cfe9 100644 --- a/unittests/Basic/SourceManagerTest.cpp +++ b/unittests/Basic/SourceManagerTest.cpp @@ -73,7 +73,7 @@ TEST_F(SourceManagerTest, isBeforeInTranslationUnit) { FileID mainFileID = SourceMgr.createMainFileIDForMemBuffer(buf); VoidModuleLoader ModLoader; - HeaderSearch HeaderInfo(new HeaderSearchOptions, FileMgr, Diags, LangOpts, + HeaderSearch HeaderInfo(new HeaderSearchOptions, SourceMgr, Diags, LangOpts, &*Target); Preprocessor PP(new PreprocessorOptions(), Diags, LangOpts, Target.getPtr(), SourceMgr, HeaderInfo, ModLoader, @@ -188,7 +188,7 @@ TEST_F(SourceManagerTest, getMacroArgExpandedLocation) { SourceMgr.overrideFileContents(headerFile, headerBuf); VoidModuleLoader ModLoader; - HeaderSearch HeaderInfo(new HeaderSearchOptions, FileMgr, Diags, LangOpts, + HeaderSearch HeaderInfo(new HeaderSearchOptions, SourceMgr, Diags, LangOpts, &*Target); Preprocessor PP(new PreprocessorOptions(), Diags, LangOpts, Target.getPtr(), SourceMgr, HeaderInfo, ModLoader, @@ -286,7 +286,7 @@ TEST_F(SourceManagerTest, isBeforeInTranslationUnitWithMacroInInclude) { SourceMgr.overrideFileContents(headerFile, headerBuf); VoidModuleLoader ModLoader; - HeaderSearch HeaderInfo(new HeaderSearchOptions, FileMgr, Diags, LangOpts, + HeaderSearch HeaderInfo(new HeaderSearchOptions, SourceMgr, Diags, LangOpts, &*Target); Preprocessor PP(new PreprocessorOptions(), Diags, LangOpts, Target.getPtr(), SourceMgr, HeaderInfo, ModLoader, diff --git a/unittests/CMakeLists.txt b/unittests/CMakeLists.txt index 334ea41..479b36f 100644 --- a/unittests/CMakeLists.txt +++ b/unittests/CMakeLists.txt @@ -9,10 +9,15 @@ function(add_clang_unittest test_dirname) add_unittest(ClangUnitTests ${test_dirname} ${ARGN}) endfunction() -add_subdirectory(ASTMatchers) -add_subdirectory(AST) add_subdirectory(Basic) add_subdirectory(Lex) -add_subdirectory(Frontend) -add_subdirectory(Tooling) -add_subdirectory(Format) +if(CLANG_ENABLE_STATIC_ANALYZER) + add_subdirectory(Frontend) +endif() +if(CLANG_ENABLE_REWRITER) + add_subdirectory(ASTMatchers) + add_subdirectory(AST) + add_subdirectory(Tooling) + add_subdirectory(Format) + add_subdirectory(Sema) +endif() diff --git a/unittests/Format/FormatTest.cpp b/unittests/Format/FormatTest.cpp index 4c948e8..b6574c7 100644 --- a/unittests/Format/FormatTest.cpp +++ b/unittests/Format/FormatTest.cpp @@ -10,7 +10,6 @@ #define DEBUG_TYPE "format-test" #include "clang/Format/Format.h" -#include "../Tooling/RewriterTestContext.h" #include "clang/Lex/Lexer.h" #include "llvm/Support/Debug.h" #include "gtest/gtest.h" @@ -23,21 +22,14 @@ protected: std::string format(llvm::StringRef Code, unsigned Offset, unsigned Length, const FormatStyle &Style) { DEBUG(llvm::errs() << "---\n"); - RewriterTestContext Context; - FileID ID = Context.createInMemoryFile("input.cc", Code); - SourceLocation Start = - Context.Sources.getLocForStartOfFile(ID).getLocWithOffset(Offset); - std::vector<CharSourceRange> Ranges( - 1, - CharSourceRange::getCharRange(Start, Start.getLocWithOffset(Length))); - Lexer Lex(ID, Context.Sources.getBuffer(ID), Context.Sources, - getFormattingLangOpts()); - tooling::Replacements Replace = reformat( - Style, Lex, Context.Sources, Ranges, new IgnoringDiagConsumer()); - ReplacementCount = Replace.size(); - EXPECT_TRUE(applyAllReplacements(Replace, Context.Rewrite)); - DEBUG(llvm::errs() << "\n" << Context.getRewrittenText(ID) << "\n\n"); - return Context.getRewrittenText(ID); + DEBUG(llvm::errs() << Code << "\n\n"); + std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length)); + tooling::Replacements Replaces = reformat(Style, Code, Ranges); + ReplacementCount = Replaces.size(); + std::string Result = applyAllReplacements(Code, Replaces); + EXPECT_NE("", Result); + DEBUG(llvm::errs() << "\n" << Result << "\n\n"); + return Result; } std::string @@ -75,7 +67,14 @@ protected: JustReplacedNewline = false; } } - return MessedUp; + std::string WithoutWhitespace; + if (MessedUp[0] != ' ') + WithoutWhitespace.push_back(MessedUp[0]); + for (unsigned i = 1, e = MessedUp.size(); i != e; ++i) { + if (MessedUp[i] != ' ' || MessedUp[i - 1] != ' ') + WithoutWhitespace.push_back(MessedUp[i]); + } + return WithoutWhitespace; } FormatStyle getLLVMStyleWithColumns(unsigned ColumnLimit) { @@ -112,20 +111,20 @@ TEST_F(FormatTest, MessUp) { EXPECT_EQ("1 2 3\n", messUp("1\n2\n3\n")); EXPECT_EQ("a\n//b\nc", messUp("a\n//b\nc")); EXPECT_EQ("a\n#b\nc", messUp("a\n#b\nc")); - EXPECT_EQ("a\n#b c d\ne", messUp("a\n#b\\\nc\\\nd\ne")); + EXPECT_EQ("a\n#b c d\ne", messUp("a\n#b\\\nc\\\nd\ne")); } //===----------------------------------------------------------------------===// // Basic function tests. //===----------------------------------------------------------------------===// -TEST_F(FormatTest, DoesNotChangeCorrectlyFormatedCode) { +TEST_F(FormatTest, DoesNotChangeCorrectlyFormattedCode) { EXPECT_EQ(";", format(";")); } TEST_F(FormatTest, FormatsGlobalStatementsAt0) { EXPECT_EQ("int i;", format(" int i;")); - EXPECT_EQ("\nint i;", format(" \n\t \r int i;")); + EXPECT_EQ("\nint i;", format(" \n\t \v \f int i;")); EXPECT_EQ("int i;\nint j;", format(" int i; int j;")); EXPECT_EQ("int i;\nint j;", format(" int i;\n int j;")); } @@ -147,6 +146,7 @@ TEST_F(FormatTest, FormatsNestedCall) { TEST_F(FormatTest, NestedNameSpecifiers) { verifyFormat("vector< ::Type> v;"); verifyFormat("::ns::SomeFunction(::ns::SomeOtherFunction())"); + verifyFormat("static constexpr bool Bar = decltype(bar())::value;"); } TEST_F(FormatTest, OnlyGeneratesNecessaryReplacements) { @@ -201,6 +201,53 @@ TEST_F(FormatTest, RemovesWhitespaceWhenTriggeredOnEmptyLine) { format("int a;\n \n\n int b;", 9, 0, getLLVMStyle())); } +TEST_F(FormatTest, RemovesEmptyLines) { + EXPECT_EQ("class C {\n" + " int i;\n" + "};", + format("class C {\n" + " int i;\n" + "\n" + "};")); + + // Don't remove empty lines in more complex control statements. + EXPECT_EQ("void f() {\n" + " if (a) {\n" + " f();\n" + "\n" + " } else if (b) {\n" + " f();\n" + " }\n" + "}", + format("void f() {\n" + " if (a) {\n" + " f();\n" + "\n" + " } else if (b) {\n" + " f();\n" + "\n" + " }\n" + "\n" + "}")); + + // FIXME: This is slightly inconsistent. + EXPECT_EQ("namespace {\n" + "int i;\n" + "}", + format("namespace {\n" + "int i;\n" + "\n" + "}")); + EXPECT_EQ("namespace {\n" + "int i;\n" + "\n" + "} // namespace", + format("namespace {\n" + "int i;\n" + "\n" + "} // namespace")); +} + TEST_F(FormatTest, ReformatsMovedLines) { EXPECT_EQ( "template <typename T> T *getFETokenInfo() const {\n" @@ -218,25 +265,31 @@ TEST_F(FormatTest, ReformatsMovedLines) { // Tests for control statements. //===----------------------------------------------------------------------===// -TEST_F(FormatTest, FormatIfWithoutCompountStatement) { +TEST_F(FormatTest, FormatIfWithoutCompoundStatement) { verifyFormat("if (true)\n f();\ng();"); verifyFormat("if (a)\n if (b)\n if (c)\n g();\nh();"); verifyFormat("if (a)\n if (b) {\n f();\n }\ng();"); - FormatStyle AllowsMergedIf = getGoogleStyle(); + FormatStyle AllowsMergedIf = getLLVMStyle(); AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true; verifyFormat("if (a)\n" " // comment\n" " f();", AllowsMergedIf); + verifyFormat("if (a)\n" + " ;", + AllowsMergedIf); + verifyFormat("if (a)\n" + " if (b) return;", + AllowsMergedIf); - verifyFormat("if (a) // Can't merge this\n" + verifyFormat("if (a) // Can't merge this\n" " f();\n", AllowsMergedIf); verifyFormat("if (a) /* still don't merge */\n" " f();", AllowsMergedIf); - verifyFormat("if (a) { // Never merge this\n" + verifyFormat("if (a) { // Never merge this\n" " f();\n" "}", AllowsMergedIf); @@ -245,6 +298,10 @@ TEST_F(FormatTest, FormatIfWithoutCompountStatement) { "}", AllowsMergedIf); + EXPECT_EQ("if (a) return;", format("if(a)\nreturn;", 7, 1, AllowsMergedIf)); + EXPECT_EQ("if (a) return; // comment", + format("if(a)\nreturn; // comment", 20, 1, AllowsMergedIf)); + AllowsMergedIf.ColumnLimit = 14; verifyFormat("if (a) return;", AllowsMergedIf); verifyFormat("if (aaaaaaaaa)\n" @@ -255,6 +312,29 @@ TEST_F(FormatTest, FormatIfWithoutCompountStatement) { verifyFormat("if (a)\n return;", AllowsMergedIf); } +TEST_F(FormatTest, FormatLoopsWithoutCompoundStatement) { + FormatStyle AllowsMergedLoops = getLLVMStyle(); + AllowsMergedLoops.AllowShortLoopsOnASingleLine = true; + verifyFormat("while (true) continue;", AllowsMergedLoops); + verifyFormat("for (;;) continue;", AllowsMergedLoops); + verifyFormat("for (int &v : vec) v *= 2;", AllowsMergedLoops); + verifyFormat("while (true)\n" + " ;", + AllowsMergedLoops); + verifyFormat("for (;;)\n" + " ;", + AllowsMergedLoops); + verifyFormat("for (;;)\n" + " for (;;) continue;", + AllowsMergedLoops); + verifyFormat("for (;;) // Can't merge this\n" + " continue;", + AllowsMergedLoops); + verifyFormat("for (;;) /* still don't merge */\n" + " continue;", + AllowsMergedLoops); +} + TEST_F(FormatTest, ParseIfElse) { verifyFormat("if (true)\n" " if (true)\n" @@ -279,6 +359,11 @@ TEST_F(FormatTest, ParseIfElse) { "else {\n" " i();\n" "}"); + verifyFormat("void f() {\n" + " if (a) {\n" + " } else {\n" + " }\n" + "}"); } TEST_F(FormatTest, ElseIf) { @@ -289,6 +374,13 @@ TEST_F(FormatTest, ElseIf) { " g();\n" "else\n" " h();"); + verifyFormat("if (a) {\n" + " f();\n" + "}\n" + "// or else ..\n" + "else {\n" + " g()\n" + "}"); } TEST_F(FormatTest, FormatsForLoop) { @@ -453,6 +545,10 @@ TEST_F(FormatTest, FormatsSwitchStatement) { " case a: \\\n" " foo = b; \\\n" " }", getLLVMStyleWithColumns(20)); + verifyFormat("#define OPERATION_CASE(name) \\\n" + " case OP_name: \\\n" + " return operations::Operation##name\n", + getLLVMStyleWithColumns(40)); verifyGoogleFormat("switch (x) {\n" " case 1:\n" @@ -473,7 +569,40 @@ TEST_F(FormatTest, FormatsSwitchStatement) { " }\n" "}"); verifyGoogleFormat("switch (test)\n" - " ;"); + " ;"); + + verifyGoogleFormat("#define OPERATION_CASE(name) \\\n" + " case OP_name: \\\n" + " return operations::Operation##name\n"); + verifyGoogleFormat("Operation codeToOperation(OperationCode OpCode) {\n" + " // Get the correction operation class.\n" + " switch (OpCode) {\n" + " CASE(Add);\n" + " CASE(Subtract);\n" + " default:\n" + " return operations::Unknown;\n" + " }\n" + "#undef OPERATION_CASE\n" + "}"); + verifyFormat("DEBUG({\n" + " switch (x) {\n" + " case A:\n" + " f();\n" + " break;\n" + " // On B:\n" + " case B:\n" + " g();\n" + " break;\n" + " }\n" + "});"); +} + +TEST_F(FormatTest, CaseRanges) { + verifyFormat("switch (x) {\n" + "case 'A' ... 'Z':\n" + "case 1 ... 5:\n" + " break;\n" + "}"); } TEST_F(FormatTest, FormatsLabels) { @@ -505,6 +634,9 @@ TEST_F(FormatTest, UnderstandsSingleLineComments) { verifyFormat("void f() {\n" " // Doesn't do anything\n" "}"); + verifyFormat("SomeObject\n" + " // Calling someFunction on SomeObject\n" + " .someFunction();"); verifyFormat("void f(int i, // some comment (probably for i)\n" " int j, // some comment (probably for j)\n" " int k); // some comment (probably for k)"); @@ -543,6 +675,11 @@ TEST_F(FormatTest, UnderstandsSingleLineComments) { "#include \"a/b/c\" // comment"); verifyFormat("#include <a> // comment\n" "#include <a/b/c> // comment"); + EXPECT_EQ("#include \"a\" // comment\n" + "#include \"a/b/c\" // comment", + format("#include \\\n" + " \"a\" // comment\n" + "#include \"a/b/c\" // comment")); verifyFormat("enum E {\n" " // comment\n" @@ -571,14 +708,17 @@ TEST_F(FormatTest, UnderstandsSingleLineComments) { format("void f() { // This does something ..\n" " }\n" "int a; // This is unrelated")); - EXPECT_EQ("void f() { // This does something ..\n" - "} // awesome..\n" + EXPECT_EQ("class C {\n" + " void f() { // This does something ..\n" + " } // awesome..\n" "\n" - "int a; // This is unrelated", - format("void f() { // This does something ..\n" + " int a; // This is unrelated\n" + "};", + format("class C{void f() { // This does something ..\n" " } // awesome..\n" " \n" - "int a; // This is unrelated")); + "int a; // This is unrelated\n" + "};")); EXPECT_EQ("int i; // single line trailing comment", format("int i;\\\n// single line trailing comment")); @@ -598,7 +738,7 @@ TEST_F(FormatTest, UnderstandsSingleLineComments) { "};"); verifyGoogleFormat( "aaaaaaaaaaaaaaaaaaaaaaaaaa(\n" - " aaaaaaaaaaaaaaaaaaaaaa); // 81 cols with this comment"); + " aaaaaaaaaaaaaaaaaaaaaa); // 81_cols_with_this_comment"); EXPECT_EQ("D(a, {\n" " // test\n" " int a;\n" @@ -607,6 +747,66 @@ TEST_F(FormatTest, UnderstandsSingleLineComments) { "// test\n" "int a;\n" "});")); + + EXPECT_EQ("lineWith(); // comment\n" + "// at start\n" + "otherLine();", + format("lineWith(); // comment\n" + "// at start\n" + "otherLine();")); + EXPECT_EQ("lineWith(); // comment\n" + " // at start\n" + "otherLine();", + format("lineWith(); // comment\n" + " // at start\n" + "otherLine();")); + + EXPECT_EQ("lineWith(); // comment\n" + "// at start\n" + "otherLine(); // comment", + format("lineWith(); // comment\n" + "// at start\n" + "otherLine(); // comment")); + EXPECT_EQ("lineWith();\n" + "// at start\n" + "otherLine(); // comment", + format("lineWith();\n" + " // at start\n" + "otherLine(); // comment")); + EXPECT_EQ("// first\n" + "// at start\n" + "otherLine(); // comment", + format("// first\n" + " // at start\n" + "otherLine(); // comment")); + EXPECT_EQ("f();\n" + "// first\n" + "// at start\n" + "otherLine(); // comment", + format("f();\n" + "// first\n" + " // at start\n" + "otherLine(); // comment")); + verifyFormat("f(); // comment\n" + "// first\n" + "// at start\n" + "otherLine();"); + EXPECT_EQ("f(); // comment\n" + "// first\n" + "// at start\n" + "otherLine();", + format("f(); // comment\n" + "// first\n" + " // at start\n" + "otherLine();")); + EXPECT_EQ("f(); // comment\n" + " // first\n" + "// at start\n" + "otherLine();", + format("f(); // comment\n" + " // first\n" + "// at start\n" + "otherLine();")); } TEST_F(FormatTest, CanFormatCommentsLocally) { @@ -636,10 +836,12 @@ TEST_F(FormatTest, RemovesTrailingWhitespaceOfComments) { EXPECT_EQ("int aaaaaaa, bbbbbbb; // comment", format("int aaaaaaa, bbbbbbb; // comment ", getLLVMStyleWithColumns(33))); + EXPECT_EQ("// comment\\\n", format("// comment\\\n \t \v \f ")); + EXPECT_EQ("// comment \\\n", format("// comment \\\n \t \v \f ")); } -TEST_F(FormatTest, UnderstandsMultiLineComments) { - verifyFormat("f(/*test=*/ true);"); +TEST_F(FormatTest, UnderstandsBlockComments) { + verifyFormat("f(/*noSpaceAfterParameterNamingComment=*/true);"); EXPECT_EQ( "f(aaaaaaaaaaaaaaaaaaaaaaaaa, /* Trailing comment for aa... */\n" " bbbbbbbbbbbbbbbbbbbbbbbbb);", @@ -650,6 +852,15 @@ TEST_F(FormatTest, UnderstandsMultiLineComments) { " /* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);", format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \n" "/* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);")); + EXPECT_EQ( + "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaa) { /*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/\n" + "}", + format("void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaa ,\n" + " aaaaaaaaaaaaaaaaaa) { /*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/\n" + "}")); FormatStyle NoBinPacking = getLLVMStyle(); NoBinPacking.BinPackParameters = false; @@ -660,7 +871,7 @@ TEST_F(FormatTest, UnderstandsMultiLineComments) { NoBinPacking); } -TEST_F(FormatTest, AlignsMultiLineComments) { +TEST_F(FormatTest, AlignsBlockComments) { EXPECT_EQ("/*\n" " * Really multi-line\n" " * comment.\n" @@ -696,11 +907,49 @@ TEST_F(FormatTest, AlignsMultiLineComments) { " 1.1.1. to keep the formatting.\n" " */")); EXPECT_EQ("/*\n" - " Don't try to outdent if there's not enough inentation.\n" - " */", + "Don't try to outdent if there's not enough indentation.\n" + "*/", format(" /*\n" - " Don't try to outdent if there's not enough inentation.\n" + " Don't try to outdent if there's not enough indentation.\n" " */")); + + EXPECT_EQ("int i; /* Comment with empty...\n" + " *\n" + " * line. */", + format("int i; /* Comment with empty...\n" + " *\n" + " * line. */")); +} + +TEST_F(FormatTest, CorrectlyHandlesLengthOfBlockComments) { + EXPECT_EQ("double *x; /* aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa */", + format("double *x; /* aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa */")); + EXPECT_EQ( + "void ffffffffffff(\n" + " int aaaaaaaa, int bbbbbbbb,\n" + " int cccccccccccc) { /*\n" + " aaaaaaaaaa\n" + " aaaaaaaaaaaaa\n" + " bbbbbbbbbbbbbb\n" + " bbbbbbbbbb\n" + " */\n" + "}", + format("void ffffffffffff(int aaaaaaaa, int bbbbbbbb, int cccccccccccc)\n" + "{ /*\n" + " aaaaaaaaaa aaaaaaaaaaaaa\n" + " bbbbbbbbbbbbbb bbbbbbbbbb\n" + " */\n" + "}", + getLLVMStyleWithColumns(40))); +} + +TEST_F(FormatTest, DontBreakNonTrailingBlockComments) { + EXPECT_EQ("void\n" + "ffffffffff(int aaaaa /* test */);", + format("void ffffffffff(int aaaaa /* test */);", + getLLVMStyleWithColumns(35))); } TEST_F(FormatTest, SplitsLongCxxComments) { @@ -727,10 +976,20 @@ TEST_F(FormatTest, SplitsLongCxxComments) { EXPECT_EQ("// Don't_touch_leading_whitespace", format("// Don't_touch_leading_whitespace", getLLVMStyleWithColumns(20))); - EXPECT_EQ( - "//Don't add leading\n" - "//whitespace", - format("//Don't add leading whitespace", getLLVMStyleWithColumns(20))); + EXPECT_EQ("// Add leading\n" + "// whitespace", + format("//Add leading whitespace", getLLVMStyleWithColumns(20))); + EXPECT_EQ("// whitespace", format("//whitespace", getLLVMStyle())); + EXPECT_EQ("// Even if it makes the line exceed the column\n" + "// limit", + format("//Even if it makes the line exceed the column limit", + getLLVMStyleWithColumns(51))); + EXPECT_EQ("//--But not here", format("//--But not here", getLLVMStyle())); + + EXPECT_EQ("// aa bb cc dd", + format("// aa bb cc dd ", + getLLVMStyleWithColumns(15))); + EXPECT_EQ("// A comment before\n" "// a macro\n" "// definition\n" @@ -738,6 +997,106 @@ TEST_F(FormatTest, SplitsLongCxxComments) { format("// A comment before a macro definition\n" "#define a b", getLLVMStyleWithColumns(20))); + EXPECT_EQ("void ffffff(int aaaaaaaaa, // wwww\n" + " int a, int bbb, // xxxxxxx\n" + " // yyyyyyyyy\n" + " int c, int d, int e) {}", + format("void ffffff(\n" + " int aaaaaaaaa, // wwww\n" + " int a,\n" + " int bbb, // xxxxxxx yyyyyyyyy\n" + " int c, int d, int e) {}", + getLLVMStyleWithColumns(40))); + EXPECT_EQ("//\t aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + format("//\t aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + getLLVMStyleWithColumns(20))); + EXPECT_EQ( + "#define XXX // a b c d\n" + " // e f g h", + format("#define XXX // a b c d e f g h", getLLVMStyleWithColumns(22))); + EXPECT_EQ( + "#define XXX // q w e r\n" + " // t y u i", + format("#define XXX //q w e r t y u i", getLLVMStyleWithColumns(22))); +} + +TEST_F(FormatTest, DontSplitLineCommentsWithEscapedNewlines) { + EXPECT_EQ("// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + format("// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")); + EXPECT_EQ("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", + format("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", + getLLVMStyleWithColumns(50))); + // FIXME: One day we might want to implement adjustment of leading whitespace + // of the consecutive lines in this kind of comment: + EXPECT_EQ("int\n" + "a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", + format("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n" + " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA", + getLLVMStyleWithColumns(49))); +} + +TEST_F(FormatTest, PriorityOfCommentBreaking) { + EXPECT_EQ("if (xxx ==\n" + " yyy && // aaaaaaaaaaaa bbbbbbbbb\n" + " zzz)\n" + " q();", + format("if (xxx == yyy && // aaaaaaaaaaaa bbbbbbbbb\n" + " zzz) q();", + getLLVMStyleWithColumns(40))); + EXPECT_EQ("if (xxxxxxxxxx ==\n" + " yyy && // aaaaaa bbbbbbbb cccc\n" + " zzz)\n" + " q();", + format("if (xxxxxxxxxx == yyy && // aaaaaa bbbbbbbb cccc\n" + " zzz) q();", + getLLVMStyleWithColumns(40))); + EXPECT_EQ("if (xxxxxxxxxx &&\n" + " yyy || // aaaaaa bbbbbbbb cccc\n" + " zzz)\n" + " q();", + format("if (xxxxxxxxxx && yyy || // aaaaaa bbbbbbbb cccc\n" + " zzz) q();", + getLLVMStyleWithColumns(40))); + EXPECT_EQ("fffffffff(&xxx, // aaaaaaaaaaaa\n" + " // bbbbbbbbbbb\n" + " zzz);", + format("fffffffff(&xxx, // aaaaaaaaaaaa bbbbbbbbbbb\n" + " zzz);", + getLLVMStyleWithColumns(40))); +} + +TEST_F(FormatTest, MultiLineCommentsInDefines) { + EXPECT_EQ("#define A(x) /* \\\n" + " a comment \\\n" + " inside */ \\\n" + " f();", + format("#define A(x) /* \\\n" + " a comment \\\n" + " inside */ \\\n" + " f();", + getLLVMStyleWithColumns(17))); + EXPECT_EQ("#define A( \\\n" + " x) /* \\\n" + " a comment \\\n" + " inside */ \\\n" + " f();", + format("#define A( \\\n" + " x) /* \\\n" + " a comment \\\n" + " inside */ \\\n" + " f();", + getLLVMStyleWithColumns(17))); } TEST_F(FormatTest, ParsesCommentsAdjacentToPPDirectives) { @@ -858,7 +1217,8 @@ TEST_F(FormatTest, SplitsLongLinesInComments) { " */", getLLVMStyleWithColumns(20))); EXPECT_EQ("{\n" " if (something) /* This is a\n" - "long comment */\n" + " long\n" + " comment */\n" " ;\n" "}", format("{\n" @@ -866,6 +1226,48 @@ TEST_F(FormatTest, SplitsLongLinesInComments) { " ;\n" "}", getLLVMStyleWithColumns(30))); + + EXPECT_EQ("/* A comment before\n" + " * a macro\n" + " * definition */\n" + "#define a b", + format("/* A comment before a macro definition */\n" + "#define a b", + getLLVMStyleWithColumns(20))); + + EXPECT_EQ("/* some comment\n" + " * a comment\n" + "* that we break\n" + " * another comment\n" + "* we have to break\n" + "* a left comment\n" + " */", + format(" /* some comment\n" + " * a comment that we break\n" + " * another comment we have to break\n" + "* a left comment\n" + " */", + getLLVMStyleWithColumns(20))); + + EXPECT_EQ("/*\n" + "\n" + "\n" + " */\n", + format(" /* \n" + " \n" + " \n" + " */\n")); + + EXPECT_EQ("/* a a */", + format("/* a a */", getLLVMStyleWithColumns(15))); + EXPECT_EQ("/* a a bc */", + format("/* a a bc */", getLLVMStyleWithColumns(15))); + EXPECT_EQ("/* aaa aaa\n" + " * aaaaa */", + format("/* aaa aaa aaaaa */", getLLVMStyleWithColumns(15))); + EXPECT_EQ("/* aaa aaa\n" + " * aaaaa */", + format("/* aaa aaa aaaaa */", getLLVMStyleWithColumns(15))); } TEST_F(FormatTest, SplitsLongLinesInCommentsInPreprocessor) { @@ -923,11 +1325,11 @@ TEST_F(FormatTest, CommentsInStaticInitializers) { " // comment for bb....\n" " bbbbbbbbbbb, ccccccccccc };"); verifyGoogleFormat( - "static SomeType type = { aaaaaaaaaaa, // comment for aa...\n" - " bbbbbbbbbbb, ccccccccccc };"); - verifyGoogleFormat("static SomeType type = { aaaaaaaaaaa,\n" - " // comment for bb....\n" - " bbbbbbbbbbb, ccccccccccc };"); + "static SomeType type = {aaaaaaaaaaa, // comment for aa...\n" + " bbbbbbbbbbb, ccccccccccc};"); + verifyGoogleFormat("static SomeType type = {aaaaaaaaaaa,\n" + " // comment for bb....\n" + " bbbbbbbbbbb, ccccccccccc};"); verifyFormat("S s = { { a, b, c }, // Group #1\n" " { d, e, f }, // Group #2\n" @@ -953,11 +1355,20 @@ TEST_F(FormatTest, CommentsInStaticInitializers) { " // Comment after empty line\n" " b\n" "}")); - EXPECT_EQ("S s = { a, b };", format("S s = {\n" - " a,\n" - "\n" - " b\n" - "};")); + EXPECT_EQ("S s = {\n" + " /* Some comment */\n" + " a,\n" + "\n" + " /* Comment after empty line */\n" + " b\n" + "}", + format("S s = {\n" + " /* Some comment */\n" + " a,\n" + " \n" + " /* Comment after empty line */\n" + " b\n" + "}")); verifyFormat("const uint8_t aaaaaaaaaaaaaaaaaaaaaa[0] = {\n" " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n" @@ -965,12 +1376,150 @@ TEST_F(FormatTest, CommentsInStaticInitializers) { "};"); } +TEST_F(FormatTest, IgnoresIf0Contents) { + EXPECT_EQ("#if 0\n" + "}{)(&*(^%%#%@! fsadj f;ldjs ,:;| <<<>>>][)(][\n" + "#endif\n" + "void f() {}", + format("#if 0\n" + "}{)(&*(^%%#%@! fsadj f;ldjs ,:;| <<<>>>][)(][\n" + "#endif\n" + "void f( ) { }")); + EXPECT_EQ("#if false\n" + "void f( ) { }\n" + "#endif\n" + "void g() {}\n", + format("#if false\n" + "void f( ) { }\n" + "#endif\n" + "void g( ) { }\n")); + EXPECT_EQ("enum E {\n" + " One,\n" + " Two,\n" + "#if 0\n" + "Three,\n" + " Four,\n" + "#endif\n" + " Five\n" + "};", + format("enum E {\n" + " One,Two,\n" + "#if 0\n" + "Three,\n" + " Four,\n" + "#endif\n" + " Five};")); + EXPECT_EQ("enum F {\n" + " One,\n" + "#if 1\n" + " Two,\n" + "#if 0\n" + "Three,\n" + " Four,\n" + "#endif\n" + " Five\n" + "#endif\n" + "};", + format("enum F {\n" + "One,\n" + "#if 1\n" + "Two,\n" + "#if 0\n" + "Three,\n" + " Four,\n" + "#endif\n" + "Five\n" + "#endif\n" + "};")); + EXPECT_EQ("enum G {\n" + " One,\n" + "#if 0\n" + "Two,\n" + "#else\n" + " Three,\n" + "#endif\n" + " Four\n" + "};", + format("enum G {\n" + "One,\n" + "#if 0\n" + "Two,\n" + "#else\n" + "Three,\n" + "#endif\n" + "Four\n" + "};")); + EXPECT_EQ("enum H {\n" + " One,\n" + "#if 0\n" + "#ifdef Q\n" + "Two,\n" + "#else\n" + "Three,\n" + "#endif\n" + "#endif\n" + " Four\n" + "};", + format("enum H {\n" + "One,\n" + "#if 0\n" + "#ifdef Q\n" + "Two,\n" + "#else\n" + "Three,\n" + "#endif\n" + "#endif\n" + "Four\n" + "};")); + EXPECT_EQ("enum I {\n" + " One,\n" + "#if /* test */ 0 || 1\n" + "Two,\n" + "Three,\n" + "#endif\n" + " Four\n" + "};", + format("enum I {\n" + "One,\n" + "#if /* test */ 0 || 1\n" + "Two,\n" + "Three,\n" + "#endif\n" + "Four\n" + "};")); + EXPECT_EQ("enum J {\n" + " One,\n" + "#if 0\n" + "#if 0\n" + "Two,\n" + "#else\n" + "Three,\n" + "#endif\n" + "Four,\n" + "#endif\n" + " Five\n" + "};", + format("enum J {\n" + "One,\n" + "#if 0\n" + "#if 0\n" + "Two,\n" + "#else\n" + "Three,\n" + "#endif\n" + "Four,\n" + "#endif\n" + "Five\n" + "};")); + +} + //===----------------------------------------------------------------------===// // Tests for classes, namespaces, etc. //===----------------------------------------------------------------------===// TEST_F(FormatTest, DoesNotBreakSemiAfterClassDecl) { - verifyFormat("class A {\n};"); + verifyFormat("class A {};"); } TEST_F(FormatTest, UnderstandsAccessSpecifiers) { @@ -1009,34 +1558,49 @@ TEST_F(FormatTest, SeparatesLogicalBlocks) { "protected:\n" "int h;\n" "};")); + EXPECT_EQ("class A {\n" + "protected:\n" + "public:\n" + " void f();\n" + "};", + format("class A {\n" + "protected:\n" + "\n" + "public:\n" + "\n" + " void f();\n" + "};")); } TEST_F(FormatTest, FormatsClasses) { - verifyFormat("class A : public B {\n};"); - verifyFormat("class A : public ::B {\n};"); + verifyFormat("class A : public B {};"); + verifyFormat("class A : public ::B {};"); verifyFormat( "class AAAAAAAAAAAAAAAAAAAA : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" - " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {\n" - "};\n"); + " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {};"); verifyFormat("class AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\n" " : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n" - " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {\n" - "};\n"); + " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {};"); verifyFormat( - "class A : public B, public C, public D, public E, public F, public G {\n" - "};"); + "class A : public B, public C, public D, public E, public F {};"); verifyFormat("class AAAAAAAAAAAA : public B,\n" " public C,\n" " public D,\n" " public E,\n" " public F,\n" - " public G {\n" - "};"); + " public G {};"); verifyFormat("class\n" - " ReallyReallyLongClassName {\n};", + " ReallyReallyLongClassName {\n" + " int i;\n" + "};", getLLVMStyleWithColumns(32)); + verifyFormat("struct aaaaaaaaaaaaa : public aaaaaaaaaaaaaaaaaaa< // break\n" + " aaaaaaaaaaaaaaaa> {};"); + verifyFormat("struct aaaaaaaaaaaaaaaaaaaa\n" + " : public aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaa> {};"); } TEST_F(FormatTest, FormatsVariableDeclarationsAfterStructOrClass) { @@ -1054,14 +1618,82 @@ TEST_F(FormatTest, FormatsEnum) { " Four = (Zero && (One ^ Two)) | (One << Two),\n" " Five = (One, Two, Three, Four, 5)\n" "};"); - verifyFormat("enum Enum {\n" - "};"); + verifyGoogleFormat("enum {\n" + " Zero,\n" + " One = 1,\n" + " Two = One + 1,\n" + " Three = (One + Two),\n" + " Four = (Zero && (One ^ Two)) | (One << Two),\n" + " Five = (One, Two, Three, Four, 5)\n" + "};"); + verifyFormat("enum Enum {};"); + verifyFormat("enum {};"); + verifyFormat("enum X E {} d;"); + verifyFormat("enum __attribute__((...)) E {} d;"); + verifyFormat("enum __declspec__((...)) E {} d;"); + verifyFormat("enum X f() {\n a();\n return 42;\n}"); verifyFormat("enum {\n" + " Bar = Foo<int, int>::value\n" + "};"); +} + +TEST_F(FormatTest, FormatsEnumsWithErrors) { + verifyFormat("enum Type {\n" + " One = 0;\n" // These semicolons should be commas. + " Two = 1;\n" + "};"); + verifyFormat("namespace n {\n" + "enum Type {\n" + " One,\n" + " Two,\n" // missing }; + " int i;\n" + "}\n" + "void g() {}"); +} + +TEST_F(FormatTest, FormatsEnumStruct) { + verifyFormat("enum struct {\n" + " Zero,\n" + " One = 1,\n" + " Two = One + 1,\n" + " Three = (One + Two),\n" + " Four = (Zero && (One ^ Two)) | (One << Two),\n" + " Five = (One, Two, Three, Four, 5)\n" + "};"); + verifyFormat("enum struct Enum {};"); + verifyFormat("enum struct {};"); + verifyFormat("enum struct X E {} d;"); + verifyFormat("enum struct __attribute__((...)) E {} d;"); + verifyFormat("enum struct __declspec__((...)) E {} d;"); + verifyFormat("enum struct X f() {\n a();\n return 42;\n}"); +} + +TEST_F(FormatTest, FormatsEnumClass) { + verifyFormat("enum class {\n" + " Zero,\n" + " One = 1,\n" + " Two = One + 1,\n" + " Three = (One + Two),\n" + " Four = (Zero && (One ^ Two)) | (One << Two),\n" + " Five = (One, Two, Three, Four, 5)\n" + "};"); + verifyFormat("enum class Enum {};"); + verifyFormat("enum class {};"); + verifyFormat("enum class X E {} d;"); + verifyFormat("enum class __attribute__((...)) E {} d;"); + verifyFormat("enum class __declspec__((...)) E {} d;"); + verifyFormat("enum class X f() {\n a();\n return 42;\n}"); +} + +TEST_F(FormatTest, FormatsEnumTypes) { + verifyFormat("enum X : int {\n" + " A,\n" + " B\n" + "};"); + verifyFormat("enum X : std::uint32_t {\n" + " A,\n" + " B\n" "};"); - verifyFormat("enum X E {\n} d;"); - verifyFormat("enum __attribute__((...)) E {\n} d;"); - verifyFormat("enum __declspec__((...)) E {\n} d;"); - verifyFormat("enum X f() {\n a();\n return 42;\n}"); } TEST_F(FormatTest, FormatsBitfields) { @@ -1069,33 +1701,83 @@ TEST_F(FormatTest, FormatsBitfields) { " unsigned sClass : 8;\n" " unsigned ValueKind : 2;\n" "};"); + verifyFormat("struct A {\n" + " int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa : 1,\n" + " bbbbbbbbbbbbbbbbbbbbbbbbb;\n" + "};"); } TEST_F(FormatTest, FormatsNamespaces) { verifyFormat("namespace some_namespace {\n" - "class A {\n};\n" + "class A {};\n" "void f() { f(); }\n" "}"); verifyFormat("namespace {\n" - "class A {\n};\n" + "class A {};\n" "void f() { f(); }\n" "}"); verifyFormat("inline namespace X {\n" - "class A {\n};\n" + "class A {};\n" "void f() { f(); }\n" "}"); verifyFormat("using namespace some_namespace;\n" - "class A {\n};\n" + "class A {};\n" "void f() { f(); }"); // This code is more common than we thought; if we // layout this correctly the semicolon will go into // its own line, which is undesireable. - verifyFormat("namespace {\n};"); + verifyFormat("namespace {};"); verifyFormat("namespace {\n" - "class A {\n" - "};\n" + "class A {};\n" "};"); + + verifyFormat("namespace {\n" + "int SomeVariable = 0; // comment\n" + "} // namespace"); + EXPECT_EQ("#ifndef HEADER_GUARD\n" + "#define HEADER_GUARD\n" + "namespace my_namespace {\n" + "int i;\n" + "} // my_namespace\n" + "#endif // HEADER_GUARD", + format("#ifndef HEADER_GUARD\n" + " #define HEADER_GUARD\n" + " namespace my_namespace {\n" + "int i;\n" + "} // my_namespace\n" + "#endif // HEADER_GUARD")); + + FormatStyle Style = getLLVMStyle(); + Style.NamespaceIndentation = FormatStyle::NI_All; + EXPECT_EQ("namespace out {\n" + " int i;\n" + " namespace in {\n" + " int i;\n" + " } // namespace\n" + "} // namespace", + format("namespace out {\n" + "int i;\n" + "namespace in {\n" + "int i;\n" + "} // namespace\n" + "} // namespace", + Style)); + + Style.NamespaceIndentation = FormatStyle::NI_Inner; + EXPECT_EQ("namespace out {\n" + "int i;\n" + "namespace in {\n" + " int i;\n" + "} // namespace\n" + "} // namespace", + format("namespace out {\n" + "int i;\n" + "namespace in {\n" + "int i;\n" + "} // namespace\n" + "} // namespace", + Style)); } TEST_F(FormatTest, FormatsExternC) { verifyFormat("extern \"C\" {\nint a;"); } @@ -1106,7 +1788,7 @@ TEST_F(FormatTest, FormatsInlineASM) { "asm(\"movq\\t%%rbx, %%rsi\\n\\t\"\n" " \"cpuid\\n\\t\"\n" " \"xchgq\\t%%rbx, %%rsi\\n\\t\"\n" - " : \"=a\" (*rEAX), \"=S\" (*rEBX), \"=c\" (*rECX), \"=d\" (*rEDX)\n" + " : \"=a\"(*rEAX), \"=S\"(*rEBX), \"=c\"(*rECX), \"=d\"(*rEDX)\n" " : \"a\"(value));"); } @@ -1152,22 +1834,46 @@ TEST_F(FormatTest, FormatObjCTryCatch) { TEST_F(FormatTest, StaticInitializers) { verifyFormat("static SomeClass SC = { 1, 'a' };"); - // FIXME: Format like enums if the static initializer does not fit on a line. verifyFormat( "static SomeClass WithALoooooooooooooooooooongName = {\n" " 100000000, \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" "};"); - verifyFormat( - "static SomeClass = { a, b, c, d, e, f, g, h, i, j,\n" - " looooooooooooooooooooooooooooooooooongname,\n" - " looooooooooooooooooooooooooooooong };"); - // Allow bin-packing in static initializers as this would often lead to - // terrible results, e.g.: - verifyGoogleFormat( - "static SomeClass = { a, b, c, d, e, f, g, h, i, j,\n" - " looooooooooooooooooooooooooooooooooongname,\n" - " looooooooooooooooooooooooooooooong };"); + // Here, everything other than the "}" would fit on a line. + verifyFormat("static int LooooooooooooooooooooooooongVariable[1] = {\n" + " 100000000000000000000000\n" + "};"); + EXPECT_EQ("S s = { a, b };", format("S s = {\n" + " a,\n" + "\n" + " b\n" + "};")); + + // FIXME: This would fit into the column limit if we'd fit "{ {" on the first + // line. However, the formatting looks a bit off and this probably doesn't + // happen often in practice. + verifyFormat("static int Variable[1] = {\n" + " { 1000000000000000000000000000000000000 }\n" + "};", + getLLVMStyleWithColumns(40)); +} + +TEST_F(FormatTest, DesignatedInitializers) { + verifyFormat("const struct A a = { .a = 1, .b = 2 };"); + verifyFormat("const struct A a = { .aaaaaaaaaa = 1,\n" + " .bbbbbbbbbb = 2,\n" + " .cccccccccc = 3,\n" + " .dddddddddd = 4,\n" + " .eeeeeeeeee = 5 };"); + verifyFormat("const struct Aaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaa = {\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaa = 1,\n" + " .bbbbbbbbbbbbbbbbbbbbbbbbbbb = 2,\n" + " .ccccccccccccccccccccccccccc = 3,\n" + " .ddddddddddddddddddddddddddd = 4,\n" + " .eeeeeeeeeeeeeeeeeeeeeeeeeee = 5\n" + "};"); + + verifyGoogleFormat("const struct A a = {.a = 1, .b = 2};"); } TEST_F(FormatTest, NestedStaticInitializers) { @@ -1180,11 +1886,10 @@ TEST_F(FormatTest, NestedStaticInitializers) { " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n" " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n" "};"); - verifyGoogleFormat("somes Status::global_reps[3] = {\n" - " { kGlobalRef, OK_CODE, NULL, NULL, NULL },\n" - " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n" - " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n" - "};"); + verifyGoogleFormat("SomeType Status::global_reps[3] = {\n" + " {kGlobalRef, OK_CODE, NULL, NULL, NULL},\n" + " {kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL},\n" + " {kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL}};"); verifyFormat( "CGRect cg_rect = { { rect.fLeft, rect.fTop },\n" " { rect.fRight - rect.fLeft, rect.fBottom - rect.fTop" @@ -1202,15 +1907,21 @@ TEST_F(FormatTest, NestedStaticInitializers) { " 222222222222222222222222222222,\n" " 333333333333333333333333333333 } },\n" " { { 1, 2, 3 } }, { { 1, 2, 3 } } };"); + verifyGoogleFormat( + "SomeArrayOfSomeType a = {\n" + " {{1, 2, 3}}, {{1, 2, 3}},\n" + " {{111111111111111111111111111111, 222222222222222222222222222222,\n" + " 333333333333333333333333333333}},\n" + " {{1, 2, 3}}, {{1, 2, 3}}};"); - // FIXME: We might at some point want to handle this similar to parameter - // lists, where we have an option to put each on a single line. verifyFormat( "struct {\n" " unsigned bit;\n" " const char *const name;\n" - "} kBitsToOs[] = { { kOsMac, \"Mac\" }, { kOsWin, \"Windows\" },\n" - " { kOsLinux, \"Linux\" }, { kOsCrOS, \"Chrome OS\" } };"); + "} kBitsToOs[] = { { kOsMac, \"Mac\" },\n" + " { kOsWin, \"Windows\" },\n" + " { kOsLinux, \"Linux\" },\n" + " { kOsCrOS, \"Chrome OS\" } };"); } TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) { @@ -1220,14 +1931,28 @@ TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) { } TEST_F(FormatTest, DoesNotBreakPureVirtualFunctionDefinition) { - verifyFormat( - "virtual void write(ELFWriter *writerrr,\n" - " OwningPtr<FileOutputBuffer> &buffer) = 0;"); + verifyFormat("virtual void write(ELFWriter *writerrr,\n" + " OwningPtr<FileOutputBuffer> &buffer) = 0;"); } -TEST_F(FormatTest, LayoutUnknownPPDirective) { - EXPECT_EQ("#123 \"A string literal\"", +TEST_F(FormatTest, BreaksStringLiteralsOnlyInDefine) { + verifyFormat("# 1111 \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/aaaaaaaa.cpp\" 2 3", + getLLVMStyleWithColumns(40)); + verifyFormat("#line 11111 \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/aaaaaaaa.cpp\"", + getLLVMStyleWithColumns(40)); + EXPECT_EQ("#define Q \\\n" + " \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/\" \\\n" + " \"aaaaaaaa.cpp\"", + format("#define Q \"/aaaaaaaaa/aaaaaaaaaaaaaaaaaaa/aaaaaaaa.cpp\"", + getLLVMStyleWithColumns(40))); +} + +TEST_F(FormatTest, UnderstandsLinePPDirective) { + EXPECT_EQ("# 123 \"A string literal\"", format(" # 123 \"A string literal\"")); +} + +TEST_F(FormatTest, LayoutUnknownPPDirective) { EXPECT_EQ("#;", format("#;")); verifyFormat("#\n;\n;\n;"); } @@ -1245,12 +1970,22 @@ TEST_F(FormatTest, EndOfFileEndsPPDirective) { EXPECT_EQ("#define A B", format("# \\\n define \\\n A \\\n B")); } +TEST_F(FormatTest, DoesntRemoveUnknownTokens) { + verifyFormat("#define A \\x20"); + verifyFormat("#define A \\ x20"); + EXPECT_EQ("#define A \\ x20", format("#define A \\ x20")); + verifyFormat("#define A ''"); + verifyFormat("#define A ''qqq"); + verifyFormat("#define A `qqq"); + verifyFormat("f(\"aaaa, bbbb, \"\\\"ccccc\\\"\");"); +} + TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) { verifyFormat("#define A(BB)", getLLVMStyleWithColumns(13)); verifyFormat("#define A( \\\n BB)", getLLVMStyleWithColumns(12)); verifyFormat("#define A( \\\n A, B)", getLLVMStyleWithColumns(12)); // FIXME: We never break before the macro name. - verifyFormat("#define AA(\\\n B)", getLLVMStyleWithColumns(12)); + verifyFormat("#define AA( \\\n B)", getLLVMStyleWithColumns(12)); verifyFormat("#define A A\n#define A A"); verifyFormat("#define A(X) A\n#define A A"); @@ -1289,9 +2024,29 @@ TEST_F(FormatTest, LayoutCodeInMacroDefinitions) { TEST_F(FormatTest, LayoutRemainingTokens) { EXPECT_EQ("{}", format("{}")); } -TEST_F(FormatTest, LayoutSingleUnwrappedLineInMacro) { - EXPECT_EQ("# define A\\\n b;", - format("# define A b;", 11, 2, getLLVMStyleWithColumns(11))); +TEST_F(FormatTest, AlwaysFormatsEntireMacroDefinitions) { + EXPECT_EQ("int i;\n" + "#define A \\\n" + " int i; \\\n" + " int j\n" + "int k;", + format("int i;\n" + "#define A \\\n" + " int i ; \\\n" + " int j\n" + "int k;", + 8, 0, getGoogleStyle())); // 8: position of "#define". + EXPECT_EQ("int i;\n" + "#define A \\\n" + " int i; \\\n" + " int j\n" + "int k;", + format("int i;\n" + "#define A \\\n" + " int i ; \\\n" + " int j\n" + "int k;", + 45, 0, getGoogleStyle())); // 45: position of "j". } TEST_F(FormatTest, MacroDefinitionInsideStatement) { @@ -1302,10 +2057,11 @@ TEST_F(FormatTest, MacroDefinitionInsideStatement) { } TEST_F(FormatTest, HashInMacroDefinition) { + EXPECT_EQ("#define A(c) L#c", format("#define A(c) L#c", getLLVMStyle())); verifyFormat("#define A \\\n b #c;", getLLVMStyleWithColumns(11)); - verifyFormat("#define A \\\n" - " { \\\n" - " f(#c);\\\n" + verifyFormat("#define A \\\n" + " { \\\n" + " f(#c); \\\n" " }", getLLVMStyleWithColumns(11)); @@ -1351,24 +2107,59 @@ TEST_F(FormatTest, EmptyLinesInMacroDefinitions) { TEST_F(FormatTest, MacroDefinitionsWithIncompleteCode) { verifyFormat("#define A :"); - - // FIXME: Improve formatting of case labels in macros. verifyFormat("#define SOMECASES \\\n" " case 1: \\\n" " case 2\n", getLLVMStyleWithColumns(20)); - verifyFormat("#define A template <typename T>"); verifyFormat("#define STR(x) #x\n" "f(STR(this_is_a_string_literal{));"); + verifyFormat("#pragma omp threadprivate( \\\n" + " y)), // expected-warning", + getLLVMStyleWithColumns(28)); +} + +TEST_F(FormatTest, MacrosWithoutTrailingSemicolon) { + verifyFormat("SOME_TYPE_NAME abc;"); // Gated on the newline. + EXPECT_EQ("class A : public QObject {\n" + " Q_OBJECT\n" + "\n" + " A() {}\n" + "};", + format("class A : public QObject {\n" + " Q_OBJECT\n" + "\n" + " A() {\n}\n" + "} ;")); + EXPECT_EQ("SOME_MACRO\n" + "namespace {\n" + "void f();\n" + "}", + format("SOME_MACRO\n" + " namespace {\n" + "void f( );\n" + "}")); + // Only if the identifier contains at least 5 characters. + EXPECT_EQ("HTTP f();", + format("HTTP\nf();")); + EXPECT_EQ("MACRO\nf();", + format("MACRO\nf();")); + // Only if everything is upper case. + EXPECT_EQ("class A : public QObject {\n" + " Q_Object A() {}\n" + "};", + format("class A : public QObject {\n" + " Q_Object\n" + "\n" + " A() {\n}\n" + "} ;")); } TEST_F(FormatTest, MacroCallsWithoutTrailingSemicolon) { EXPECT_EQ("INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n" "INITIALIZE_AG_DEPENDENCY(AliasAnalysis)\n" "INITIALIZE_PASS_DEPENDENCY(DominatorTree)\n" - "class X {\n" - "};\n" + "class X {};\n" "INITIALIZE_PASS_END(ScopDetection, \"polly-detect\")\n" "int *createScopDetectionPass() { return 0; }", format(" INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n" @@ -1389,6 +2180,8 @@ TEST_F(FormatTest, MacroCallsWithoutTrailingSemicolon) { " IPC_MESSAGE_HANDLER(xxx, qqq)\n" " IPC_END_MESSAGE_MAP()\n" "}")); + + // These must not be recognized as macros. EXPECT_EQ("int q() {\n" " f(x);\n" " f(x) {}\n" @@ -1472,6 +2265,13 @@ TEST_F(FormatTest, MacroCallsWithoutTrailingSemicolon) { "};")); } +TEST_F(FormatTest, LayoutMacroDefinitionsStatementsSpanningBlocks) { + verifyFormat("#define A \\\n" + " f({ \\\n" + " g(); \\\n" + " });", getLLVMStyleWithColumns(11)); +} + TEST_F(FormatTest, IndentPreprocessorDirectivesAtZero) { EXPECT_EQ("{\n {\n#define A\n }\n}", format("{{\n#define A\n}}")); } @@ -1487,10 +2287,15 @@ TEST_F(FormatTest, FormatUnbalancedStructuralElements) { format("#define A } }\nint i;", getLLVMStyleWithColumns(11))); } -TEST_F(FormatTest, EscapedNewlineAtStartOfTokenInMacroDefinition) { +TEST_F(FormatTest, EscapedNewlineAtStartOfToken) { EXPECT_EQ( "#define A \\\n int i; \\\n int j;", format("#define A \\\nint i;\\\n int j;", getLLVMStyleWithColumns(11))); + EXPECT_EQ("template <class T> f();", format("\\\ntemplate <class T> f();")); +} + +TEST_F(FormatTest, NoEscapedNewlineHandlingInBlockComments) { + EXPECT_EQ("/* \\ \\ \\\n*/", format("\\\n/* \\ \\ \\\n*/")); } TEST_F(FormatTest, CalculateSpaceOnConsecutiveLinesInMacro) { @@ -1521,7 +2326,7 @@ TEST_F(FormatTest, LayoutStatementsAroundPreprocessorDirectives) { EXPECT_EQ("int\n" "#define A\n" " a;", - format("int\n#define A\na;")); + format("int\n#define A\na;", getGoogleStyle())); verifyFormat("functionCallTo(\n" " someOtherFunction(\n" " withSomeParameters, whichInSequence,\n" @@ -1532,13 +2337,106 @@ TEST_F(FormatTest, LayoutStatementsAroundPreprocessorDirectives) { " andMoreParameters),\n" " trailing);", getLLVMStyleWithColumns(69)); + verifyFormat("Foo::Foo()\n" + "#ifdef BAR\n" + " : baz(0)\n" + "#endif\n" + "{\n" + "}"); + verifyFormat("void f() {\n" + " if (true)\n" + "#ifdef A\n" + " f(42);\n" + " x();\n" + "#else\n" + " g();\n" + " x();\n" + "#endif\n" + "}"); + verifyFormat("void f(param1, param2,\n" + " param3,\n" + "#ifdef A\n" + " param4(param5,\n" + "#ifdef A1\n" + " param6,\n" + "#ifdef A2\n" + " param7),\n" + "#else\n" + " param8),\n" + " param9,\n" + "#endif\n" + " param10,\n" + "#endif\n" + " param11)\n" + "#else\n" + " param12)\n" + "#endif\n" + "{\n" + " x();\n" + "}", + getLLVMStyleWithColumns(28)); + verifyFormat("#if 1\n" + "int i;"); + verifyFormat( + "#if 1\n" + "#endif\n" + "#if 1\n" + "#else\n" + "#endif\n"); + verifyFormat("DEBUG({\n" + " return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;\n" + "});\n" + "#if a\n" + "#else\n" + "#endif"); +} + +TEST_F(FormatTest, FormatsJoinedLinesOnSubsequentRuns) { + FormatStyle SingleLine = getLLVMStyle(); + SingleLine.AllowShortIfStatementsOnASingleLine = true; + verifyFormat( + "#if 0\n" + "#elif 1\n" + "#endif\n" + "void foo() {\n" + " if (test) foo2();\n" + "}", + SingleLine); } TEST_F(FormatTest, LayoutBlockInsideParens) { + EXPECT_EQ("functionCall({ int i; });", format(" functionCall ( {int i;} );")); + EXPECT_EQ("functionCall({\n" + " int i;\n" + " int j;\n" + "});", + format(" functionCall ( {int i;int j;} );")); EXPECT_EQ("functionCall({\n" + " int i;\n" + " int j;\n" + " },\n" + " aaaa, bbbb, cccc);", + format(" functionCall ( {int i;int j;}, aaaa, bbbb, cccc);")); + EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });", + format(" functionCall (aaaa, bbbb, {int i;});")); + EXPECT_EQ("functionCall(aaaa, bbbb, {\n" " int i;\n" + " int j;\n" "});", - format(" functionCall ( {int i;} );")); + format(" functionCall (aaaa, bbbb, {int i;int j;});")); + EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });", + format(" functionCall (aaaa, bbbb, {int i;});")); + verifyFormat( + "Aaa({\n" + " int i; // break\n" + " },\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" + " ccccccccccccccccc));"); + verifyFormat("DEBUG({\n" + " if (a)\n" + " f();\n" + "});"); } TEST_F(FormatTest, LayoutBlockInsideStatement) { @@ -1556,15 +2454,87 @@ TEST_F(FormatTest, LayoutNestedBlocks) { " for (int i = 0; i < 10; ++i)\n" " return;\n" "}"); + verifyFormat("call(parameter, {\n" + " something();\n" + " // Comment using all columns.\n" + " somethingelse();\n" + "});", + getLLVMStyleWithColumns(40)); + EXPECT_EQ("call(parameter, {\n" + " something();\n" + " // Comment too\n" + " // looooooooooong.\n" + " somethingElse();\n" + "});", + format("call(parameter, {\n" + " something();\n" + " // Comment too looooooooooong.\n" + " somethingElse();\n" + "});", + getLLVMStyleWithColumns(29))); + EXPECT_EQ("DEBUG({ int i; });", format("DEBUG({ int i; });")); + EXPECT_EQ("DEBUG({ // comment\n" + " int i;\n" + "});", + format("DEBUG({ // comment\n" + "int i;\n" + "});")); + EXPECT_EQ("DEBUG({\n" + " int i;\n" + "\n" + " // comment\n" + " int j;\n" + "});", + format("DEBUG({\n" + " int i;\n" + "\n" + " // comment\n" + " int j;\n" + "});")); + + verifyFormat("DEBUG({\n" + " if (a)\n" + " return;\n" + "});"); + verifyGoogleFormat("DEBUG({\n" + " if (a) return;\n" + "});"); + FormatStyle Style = getGoogleStyle(); + Style.ColumnLimit = 45; + verifyFormat("Debug(aaaaa, {\n" + " if (aaaaaaaaaaaaaaaaaaaaaaaa)\n" + " return;\n" + " },\n" + " a);", Style); + + EXPECT_EQ("Debug({\n" + " if (aaaaaaaaaaaaaaaaaaaaaaaa)\n" + " return;\n" + " },\n" + " a);", + format("Debug({\n" + " if (aaaaaaaaaaaaaaaaaaaaaaaa)\n" + " return;\n" + " },\n" + " a);", + 50, 1, getLLVMStyle())); +} + +TEST_F(FormatTest, IndividualStatementsOfNestedBlocks) { + EXPECT_EQ("DEBUG({\n" + " int i;\n" + " int j;\n" + "});", + format("DEBUG( {\n" + " int i;\n" + " int j;\n" + "} ) ;", + 40, 1, getLLVMStyle())); } TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) { EXPECT_EQ("{}", format("{}")); - - // Negative test for enum. - verifyFormat("enum E {\n};"); - - // Note that when there's a missing ';', we still join... + verifyFormat("enum E {};"); verifyFormat("enum E {}"); } @@ -1572,30 +2542,23 @@ TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) { // Line break tests. //===----------------------------------------------------------------------===// -TEST_F(FormatTest, FormatsFunctionDefinition) { - verifyFormat("void f(int a, int b, int c, int d, int e, int f, int g," - " int h, int j, int f,\n" - " int c, int ddddddddddddd) {}"); -} - -TEST_F(FormatTest, FormatsAwesomeMethodCall) { - verifyFormat( - "SomeLongMethodName(SomeReallyLongMethod(CallOtherReallyLongMethod(\n" - " parameter, parameter, parameter)),\n" - " SecondLongCall(parameter));"); -} - TEST_F(FormatTest, PreventConfusingIndents) { verifyFormat( + "void f() {\n" + " SomeLongMethodName(SomeReallyLongMethod(CallOtherReallyLongMethod(\n" + " parameter, parameter, parameter)),\n" + " SecondLongCall(parameter));\n" + "}"); + verifyFormat( "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" " aaaaaaaaaaaaaaaaaaaaaaaa(\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" " aaaaaaaaaaaaaaaaaaaaaaaa);"); verifyFormat( - "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa[\n" - " aaaaaaaaaaaaaaaaaaaaaaaa[\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa],\n" - " aaaaaaaaaaaaaaaaaaaaaaaa];"); + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " [aaaaaaaaaaaaaaaaaaaaaaaa\n" + " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n" + " [aaaaaaaaaaaaaaaaaaaaaaaa]];"); verifyFormat( "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" " aaaaaaaaaaaaaaaaaaaaaaaa<\n" @@ -1606,6 +2569,75 @@ TEST_F(FormatTest, PreventConfusingIndents) { " ddd);"); } +TEST_F(FormatTest, LineBreakingInBinaryExpressions) { + verifyFormat( + "bool aaaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaa).aaaaaaaaaaaaaaaaaaa() ||\n" + " bbbbbbbb();"); + verifyFormat("bool aaaaaaaaaaaaaaaaaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa != bbbbbbbbbbbbbbbbbb &&\n" + " ccccccccc == ddddddddddd;"); + + verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n" + " aaaaaa) &&\n" + " bbbbbb && cccccc;"); + verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n" + " aaaaaa) >>\n" + " bbbbbb;"); + verifyFormat("Whitespaces.addUntouchableComment(\n" + " SourceMgr.getSpellingColumnNumber(\n" + " TheLine.Last->FormatTok.Tok.getLocation()) -\n" + " 1);"); + + verifyFormat("if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" + " bbbbbbbbbbbbbbbbbb) && // aaaaaaaaaaaaaaaa\n" + " cccccc) {\n}"); + + // If the LHS of a comparison is not a binary expression itself, the + // additional linebreak confuses many people. + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) > 5) {\n" + "}"); + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" + "}"); + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" + "}"); + // Even explicit parentheses stress the precedence enough to make the + // additional break unnecessary. + verifyFormat( + "if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n" + "}"); + // This cases is borderline, but with the indentation it is still readable. + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaa) > aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n" + "}", + getLLVMStyleWithColumns(75)); + + // If the LHS is a binary expression, we should still use the additional break + // as otherwise the formatting hides the operator precedence. + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n" + " 5) {\n" + "}"); + + FormatStyle OnePerLine = getLLVMStyle(); + OnePerLine.BinPackParameters = false; + verifyFormat( + "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}", + OnePerLine); +} + TEST_F(FormatTest, ExpressionIndentation) { verifyFormat("bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" @@ -1628,6 +2660,66 @@ TEST_F(FormatTest, ExpressionIndentation) { " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}"); + verifyFormat("if () {\n" + "} else if (aaaaa && bbbbb > // break\n" + " ccccc) {\n" + "}"); + + // Presence of a trailing comment used to change indentation of b. + verifyFormat("return aaaaaaaaaaaaaaaaaaa +\n" + " b;\n" + "return aaaaaaaaaaaaaaaaaaa +\n" + " b; //", + getLLVMStyleWithColumns(30)); +} + +TEST_F(FormatTest, ExpressionIndentationBreakingBeforeOperators) { + // Not sure what the best system is here. Like this, the LHS can be found + // immediately above an operator (everything with the same or a higher + // indent). The RHS is aligned right of the operator and so compasses + // everything until something with the same indent as the operator is found. + // FIXME: Is this a good system? + FormatStyle Style = getLLVMStyle(); + Style.BreakBeforeBinaryOperators = true; + verifyFormat( + "bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " * bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" + " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n" + " && aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " > ccccccccccccccccccccccccccccccccccccccccc;", + Style); + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", + Style); + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", + Style); + verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}", + Style); + verifyFormat("if () {\n" + "} else if (aaaaa && bbbbb // break\n" + " > ccccc) {\n" + "}", + Style); + + // Forced by comments. + verifyFormat( + "unsigned ContentSize =\n" + " sizeof(int16_t) // DWARF ARange version number\n" + " + sizeof(int32_t) // Offset of CU in the .debug_info section\n" + " + sizeof(int8_t) // Pointer Size (in bytes)\n" + " + sizeof(int8_t); // Segment Size (in bytes)"); } TEST_F(FormatTest, ConstructorInitializers) { @@ -1667,6 +2759,13 @@ TEST_F(FormatTest, ConstructorInitializers) { verifyFormat("Constructor(int Parameter = 0)\n" " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa),\n" " aaaaaaaaaaaa(aaaaaaaaaaaaaaaaa) {}"); + verifyFormat("Constructor()\n" + " : aaaaaaaaaaaaaaaaaaaa(a), bbbbbbbbbbbbbbbbbbbbbbbb(b) {\n" + "}", + getLLVMStyleWithColumns(60)); + verifyFormat("Constructor()\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa(aaaa, aaaa)) {}"); // Here a line could be saved by splitting the second initializer onto two // lines, but that is not desireable. @@ -1723,6 +2822,53 @@ TEST_F(FormatTest, MemoizationTests) { " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n" " aaaaa())))))))))))))))))))))))))))))))))))))));", getLLVMStyleWithColumns(65)); + verifyFormat( + "aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa(\n" + " aaaaa,\n" + " aaaaa))))))))))));", + getLLVMStyleWithColumns(65)); + verifyFormat( + "a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(), a), a), a), a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a),\n" + " a)", + getLLVMStyleWithColumns(65)); // This test takes VERY long when memoization is broken. FormatStyle OnePerLine = getLLVMStyle(); @@ -1753,22 +2899,29 @@ TEST_F(FormatTest, BreaksFunctionDeclarations) { // 1) break amongst arguments. verifyFormat("Aaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccc,\n" " Cccccccccccccc cccccccccccccc);"); + verifyFormat( + "template <class TemplateIt>\n" + "SomeReturnType SomeFunction(TemplateIt begin, TemplateIt end,\n" + " TemplateIt *stop) {}"); // 2) break after return type. verifyFormat( - "Aaaaaaaaaaaaaaaaaaaaaaaa\n" - " bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccccccccccccccc);"); + "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccccccccccccccc);", + getGoogleStyle()); // 3) break after (. verifyFormat( "Aaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb(\n" - " Cccccccccccccccccccccccccccccc cccccccccccccccccccccccccccccccc);"); + " Cccccccccccccccccccccccccccccc cccccccccccccccccccccccccccccccc);", + getGoogleStyle()); // 4) break before after nested name specifiers. verifyFormat( "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " SomeClasssssssssssssssssssssssssssssssssssssss::\n" - " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc);"); + " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc);", + getGoogleStyle()); // However, there are exceptions, if a sufficient amount of lines can be // saved. @@ -1780,10 +2933,11 @@ TEST_F(FormatTest, BreaksFunctionDeclarations) { " Cccccccccccccc cccccccccc,\n" " Cccccccccccccc cccccccccc);"); verifyFormat( - "Aaaaaaaaaaaaaaaaaa\n" + "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " bbbbbbbbbbb(Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n" - " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);"); + " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);", + getGoogleStyle()); verifyFormat( "Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n" " Cccccccccccccc cccccccccc,\n" @@ -1803,6 +2957,85 @@ TEST_F(FormatTest, BreaksFunctionDeclarations) { " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" " bbbb bbbb);"); + + // Treat overloaded operators like other functions. + verifyFormat("SomeLoooooooooooooooooooooooooogType\n" + "operator>(const SomeLoooooooooooooooooooooooooogType &other);"); + verifyFormat("SomeLoooooooooooooooooooooooooogType\n" + "operator>>(const SomeLooooooooooooooooooooooooogType &other);"); + verifyGoogleFormat( + "SomeLoooooooooooooooooooooooooooooogType operator<<(\n" + " const SomeLooooooooogType &a, const SomeLooooooooogType &b);"); +} + +TEST_F(FormatTest, TrailingReturnType) { + verifyFormat("auto foo() -> int;\n"); + verifyFormat("struct S {\n" + " auto bar() const -> int;\n" + "};"); + verifyFormat("template <size_t Order, typename T>\n" + "auto load_img(const std::string &filename)\n" + " -> alias::tensor<Order, T, mem::tag::cpu> {}"); + + // Not trailing return types. + verifyFormat("void f() { auto a = b->c(); }"); +} + +TEST_F(FormatTest, BreaksFunctionDeclarationsWithTrailingTokens) { + // Avoid breaking before trailing 'const' or other trailing annotations, if + // they are not function-like. + FormatStyle Style = getGoogleStyle(); + Style.ColumnLimit = 47; + verifyFormat("void\n" + "someLongFunction(int someLongParameter) const {\n}", + getLLVMStyleWithColumns(47)); + verifyFormat("LoooooongReturnType\n" + "someLoooooooongFunction() const {}", + getLLVMStyleWithColumns(47)); + verifyFormat("LoooooongReturnType someLoooooooongFunction()\n" + " const {}", + Style); + verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" + " aaaaa aaaaaaaaaaaaaaaaaaaa) OVERRIDE;"); + verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" + " aaaaa aaaaaaaaaaaaaaaaaaaa) OVERRIDE FINAL;"); + verifyFormat("void SomeFunction(aaaaa aaaaaaaaaaaaaaaaaaaa,\n" + " aaaaa aaaaaaaaaaaaaaaaaaaa) override final;"); + + // Unless this would lead to the first parameter being broken. + verifyFormat("void someLongFunction(int someLongParameter)\n" + " const {}", + getLLVMStyleWithColumns(46)); + verifyFormat("void someLongFunction(int someLongParameter)\n" + " const {}", + Style); + verifyFormat("void SomeFunction(aaaaaaaaaa aaaaaaaaaaaaaaa,\n" + " aaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " LONG_AND_UGLY_ANNOTATION;"); + + // Breaking before function-like trailing annotations is fine to keep them + // close to their arguments. + verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); + verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" + " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); + verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" + " LOCKS_EXCLUDED(aaaaaaaaaaaaa) {}"); + + verifyFormat( + "void aaaaaaaaaaaaaaaaaa()\n" + " __attribute__((aaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa));"); + verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " __attribute__((unused));"); + verifyFormat( + "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " GUARDED_BY(aaaaaaaaaaaa);", + getGoogleStyle()); + verifyFormat( + "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " GUARDED_BY(aaaaaaaaaaaa);", + getGoogleStyle()); } TEST_F(FormatTest, BreaksDesireably) { @@ -1842,9 +3075,15 @@ TEST_F(FormatTest, BreaksDesireably) { "aaaaaa(aaa, new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));"); verifyFormat( - "aaaaaaaaaaaaaaaaa(\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + "aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + + // Indent consistently indenpendent of call expression. + verifyFormat("aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbb.ccccccccccccccccc(\n" + " dddddddddddddddddddddddddddddd));\n" + "aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n" + " dddddddddddddddddddddddddddddd));"); // This test case breaks on an incorrect memoization, i.e. an optimization not // taking into account the StopAt value. @@ -1859,6 +3098,20 @@ TEST_F(FormatTest, BreaksDesireably) { " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n" " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n" " }\n }\n}"); + + // Break on an outer level if there was a break on an inner level. + EXPECT_EQ("f(g(h(a, // comment\n" + " b, c),\n" + " d, e),\n" + " x, y);", + format("f(g(h(a, // comment\n" + " b, c), d, e), x, y);")); + + // Prefer breaking similar line breaks. + verifyFormat( + "const int kTrackingOptions = NSTrackingMouseMoved |\n" + " NSTrackingMouseEnteredAndExited |\n" + " NSTrackingActiveAlways;"); } TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) { @@ -1882,8 +3135,10 @@ TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) { verifyFormat("aaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n" " .aaaaaaaaaaaaaaaaaa();", NoBinPacking); - verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" - " aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaaa);", + verifyFormat("void f() {\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaaa);\n" + "}", NoBinPacking); verifyFormat( @@ -1916,48 +3171,104 @@ TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) { " .aaaaaaa();\n" "}", NoBinPacking); + verifyFormat( + "template <class SomeType, class SomeOtherType>\n" + "SomeType SomeFunction(SomeType Type, SomeOtherType OtherType) {}", + NoBinPacking); +} + +TEST_F(FormatTest, AdaptiveOnePerLineFormatting) { + FormatStyle Style = getLLVMStyleWithColumns(15); + Style.ExperimentalAutoDetectBinPacking = true; + EXPECT_EQ("aaa(aaaa,\n" + " aaaa,\n" + " aaaa);\n" + "aaa(aaaa,\n" + " aaaa,\n" + " aaaa);", + format("aaa(aaaa,\n" // one-per-line + " aaaa,\n" + " aaaa );\n" + "aaa(aaaa, aaaa, aaaa);", // inconclusive + Style)); + EXPECT_EQ("aaa(aaaa, aaaa,\n" + " aaaa);\n" + "aaa(aaaa, aaaa,\n" + " aaaa);", + format("aaa(aaaa, aaaa,\n" // bin-packed + " aaaa );\n" + "aaa(aaaa, aaaa, aaaa);", // inconclusive + Style)); } TEST_F(FormatTest, FormatsBuilderPattern) { verifyFormat( "return llvm::StringSwitch<Reference::Kind>(name)\n" " .StartsWith(\".eh_frame_hdr\", ORDER_EH_FRAMEHDR)\n" - " .StartsWith(\".eh_frame\", ORDER_EH_FRAME).StartsWith(\".init\", ORDER_INIT)\n" - " .StartsWith(\".fini\", ORDER_FINI).StartsWith(\".hash\", ORDER_HASH)\n" + " .StartsWith(\".eh_frame\", ORDER_EH_FRAME)\n" + " .StartsWith(\".init\", ORDER_INIT)\n" + " .StartsWith(\".fini\", ORDER_FINI)\n" + " .StartsWith(\".hash\", ORDER_HASH)\n" " .Default(ORDER_TEXT);\n"); - + verifyFormat("return aaaaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa() <\n" " aaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa();"); verifyFormat( - "aaaaaaa->aaaaaaa\n" - " ->aaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + "aaaaaaa->aaaaaaa->aaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" " ->aaaaaaaa(aaaaaaaaaaaaaaa);"); verifyFormat( "aaaaaaaaaaaaaaaaaaa()->aaaaaa(bbbbb)->aaaaaaaaaaaaaaaaaaa( // break\n" " aaaaaaaaaaaaaa);"); verifyFormat( - "aaaaaaaaaaaaaaaaaaaaaaa *aaaaaaaaa = aaaaaa->aaaaaaaaaaaa()\n" - " ->aaaaaaaaaaaaaaaa(\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" - " ->aaaaaaaaaaaaaaaaa();"); -} + "aaaaaaaaaaaaaaaaaaaaaaa *aaaaaaaaa =\n" + " aaaaaa->aaaaaaaaaaaa()\n" + " ->aaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " ->aaaaaaaaaaaaaaaaa();"); + verifyGoogleFormat( + "void f() {\n" + " someo->Add((new util::filetools::Handler(dir))\n" + " ->OnEvent1(NewPermanentCallback(\n" + " this, &HandlerHolderClass::EventHandlerCBA))\n" + " ->OnEvent2(NewPermanentCallback(\n" + " this, &HandlerHolderClass::EventHandlerCBB))\n" + " ->OnEvent3(NewPermanentCallback(\n" + " this, &HandlerHolderClass::EventHandlerCBC))\n" + " ->OnEvent5(NewPermanentCallback(\n" + " this, &HandlerHolderClass::EventHandlerCBD))\n" + " ->OnEvent6(NewPermanentCallback(\n" + " this, &HandlerHolderClass::EventHandlerCBE)));\n" + "}"); -TEST_F(FormatTest, DoesNotBreakTrailingAnnotation) { - verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" - " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); - verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" - " LOCKS_EXCLUDED(aaaaaaaaaaaaa);"); - verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n" - " LOCKS_EXCLUDED(aaaaaaaaaaaaa) {}"); verifyFormat( - "void aaaaaaaaaaaaaaaaaa()\n" - " __attribute__((aaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaa,\n" - " aaaaaaaaaaaaaaaaaaaaaaaaa));"); - verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" - " __attribute__((unused));"); - verifyFormat( - "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" - " GUARDED_BY(aaaaaaaaaaaa);"); + "aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa();"); + verifyFormat("aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa();"); + verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa();"); + verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaa();"); + verifyFormat("aaaaaaaaaaaaa->aaaaaaaaaaaaaaaaaaaaaaaa()\n" + " ->aaaaaaaaaaaaaae(0)\n" + " ->aaaaaaaaaaaaaaa();"); + + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaa()\n" + " .has<bbbbbbbbbbbbbbbbbbbbb>();"); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaa()\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>();"); + + // Prefer not to break after empty parentheses. + verifyFormat("FirstToken->WhitespaceRange.getBegin().getLocWithOffset(\n" + " First->LastNewlineOffset);"); } TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) { @@ -1990,8 +3301,12 @@ TEST_F(FormatTest, BreaksAfterAssignments) { " Line.Tokens.front().Tok.getLo(), Line.Tokens.back().Tok.getLoc());"); verifyFormat( - "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaa = aaaaaaaaaaaaaa(0).aaaa()\n" - " .aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaa);"); + "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaa = aaaaaaaaaaaaaa(0).aaaa().aaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat("unsigned OriginalStartColumn =\n" + " SourceMgr.getSpellingColumnNumber(\n" + " Current.FormatTok.getStartOfNonWhitespace()) -\n" + " 1;"); } TEST_F(FormatTest, AlignsAfterAssignments) { @@ -2007,9 +3322,10 @@ TEST_F(FormatTest, AlignsAfterAssignments) { verifyFormat( "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n" " aaaaaaaaaaaaaaaaaaaaaaaaa);"); - verifyFormat("double LooooooooooooooooooooooooongResult =\n" - " aaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaa +\n" - " aaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat( + "double LooooooooooooooooooooooooongResult = aaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaa +\n" + " aaaaaaaaaaaaaaaaaaaaaaaa;"); } TEST_F(FormatTest, AlignsAfterReturn) { @@ -2030,13 +3346,16 @@ TEST_F(FormatTest, AlignsAfterReturn) { verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) &&\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat("return\n" + " // true if code is one of a or b.\n" + " code == a || code == b;"); } TEST_F(FormatTest, BreaksConditionalExpressions) { verifyFormat( - "aaaa(aaaaaaaaaaaaaaaaaaaa,\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" - " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); + "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); verifyFormat( "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); @@ -2048,6 +3367,10 @@ TEST_F(FormatTest, BreaksConditionalExpressions) { " aaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " : aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" " aaaaaaaaaaaaa);"); + verifyFormat( + "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaa ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaa);"); verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" @@ -2060,7 +3383,11 @@ TEST_F(FormatTest, BreaksConditionalExpressions) { " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); - + verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa);"); verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " ? aaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " : aaaaaaaaaaaaaaaaaaaaaaaaaaa;"); @@ -2083,6 +3410,16 @@ TEST_F(FormatTest, BreaksConditionalExpressions) { " : TheLine * 2,\n" " TheLine.InPPDirective, PreviousEndOfLineColumn);", getLLVMStyleWithColumns(70)); + verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n" + " ? aaaaaaaaaaaaaaa\n" + " : bbbbbbbbbbbbbbb //\n" + " ? ccccccccccccccc\n" + " : ddddddddddddddd;"); + verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n" + " ? aaaaaaaaaaaaaaa\n" + " : (bbbbbbbbbbbbbbb //\n" + " ? ccccccccccccccc\n" + " : ddddddddddddddd);"); FormatStyle NoBinPacking = getLLVMStyle(); NoBinPacking.BinPackParameters = false; @@ -2095,6 +3432,102 @@ TEST_F(FormatTest, BreaksConditionalExpressions) { " : aaaaaaaaaaaaaaa);\n" "}", NoBinPacking); + verifyFormat( + "void f() {\n" + " g(aaa,\n" + " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " ?: aaaaaaaaaaaaaaa);\n" + "}", + NoBinPacking); +} + +TEST_F(FormatTest, BreaksConditionalExpressionsAfterOperator) { + FormatStyle Style = getLLVMStyle(); + Style.BreakBeforeTernaryOperators = false; + Style.ColumnLimit = 70; + verifyFormat( + "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaa ?\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", + Style); + verifyFormat( + "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", + Style); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaa ? aaaa(aaaaaa) :\n" + " aaaaaaaaaaaaa);", + Style); + verifyFormat( + "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaa);", + Style); + verifyFormat( + "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaa ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaa);", + Style); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ?\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", + Style); + verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ?\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa);", + Style); + verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ?:\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa);", + Style); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ?\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa;", + Style); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaa =\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ?\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", + Style); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ?\n" + " aaaaaaaaaaaaaaa :\n" + " aaaaaaaaaaaaaaa;", + Style); + verifyFormat("f(aaaaaaaaaaaaaaaa == // force break\n" + " aaaaaaaaa ?\n" + " b :\n" + " c);", + Style); + verifyFormat( + "unsigned Indent =\n" + " format(TheLine.First, IndentForLevel[TheLine.Level] >= 0 ?\n" + " IndentForLevel[TheLine.Level] :\n" + " TheLine * 2,\n" + " TheLine.InPPDirective, PreviousEndOfLineColumn);", + Style); + verifyFormat("bool aaaaaa = aaaaaaaaaaaaa ? //\n" + " aaaaaaaaaaaaaaa :\n" + " bbbbbbbbbbbbbbb ? //\n" + " ccccccccccccccc :\n" + " ddddddddddddddd;", + Style); + verifyFormat("bool aaaaaa = aaaaaaaaaaaaa ? //\n" + " aaaaaaaaaaaaaaa :\n" + " (bbbbbbbbbbbbbbb ? //\n" + " ccccccccccccccc :\n" + " ddddddddddddddd);", + Style); } TEST_F(FormatTest, DeclarationsOfMultipleVariables) { @@ -2118,9 +3551,10 @@ TEST_F(FormatTest, DeclarationsOfMultipleVariables) { " ***c = ccccccccccccccccccc, ***d = ddddddddddddddd;"); // FIXME: If multiple variables are defined, the "*" needs to move to the new // line. Also fix indent for breaking after the type, this looks bad. - verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n" + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa = aaaaaaaaaaaaaaaaaaa,\n" - " *b = bbbbbbbbbbbbbbbbbbb;"); + " *b = bbbbbbbbbbbbbbbbbbb;", + getGoogleStyle()); // Not ideal, but pointer-with-type does not allow much here. verifyGoogleFormat( @@ -2161,11 +3595,78 @@ TEST_F(FormatTest, AlignsStringLiterals) { verifyFormat("a = a + \"a\"\n" " \"a\"\n" " \"a\";"); + verifyFormat("f(\"a\", \"b\"\n" + " \"c\");"); verifyFormat( "#define LL_FORMAT \"ll\"\n" "printf(\"aaaaa: %d, bbbbbb: %\" LL_FORMAT \"d, cccccccc: %\" LL_FORMAT\n" " \"d, ddddddddd: %\" LL_FORMAT \"d\");"); + + verifyFormat("#define A(X) \\\n" + " \"aaaaa\" #X \"bbbbbb\" \\\n" + " \"ccccc\"", + getLLVMStyleWithColumns(23)); + verifyFormat("#define A \"def\"\n" + "f(\"abc\" A \"ghi\"\n" + " \"jkl\");"); +} + +TEST_F(FormatTest, AlwaysBreakBeforeMultilineStrings) { + FormatStyle NoBreak = getLLVMStyle(); + NoBreak.AlwaysBreakBeforeMultilineStrings = false; + FormatStyle Break = getLLVMStyle(); + Break.AlwaysBreakBeforeMultilineStrings = true; + verifyFormat("aaaa = \"bbbb\"\n" + " \"cccc\";", + NoBreak); + verifyFormat("aaaa =\n" + " \"bbbb\"\n" + " \"cccc\";", + Break); + verifyFormat("aaaa(\"bbbb\"\n" + " \"cccc\");", + NoBreak); + verifyFormat("aaaa(\n" + " \"bbbb\"\n" + " \"cccc\");", + Break); + verifyFormat("aaaa(qqq, \"bbbb\"\n" + " \"cccc\");", + NoBreak); + verifyFormat("aaaa(qqq,\n" + " \"bbbb\"\n" + " \"cccc\");", + Break); + + // Don't break if there is no column gain. + verifyFormat("f(\"aaaa\"\n" + " \"bbbb\");", + Break); + + // Treat literals with escaped newlines like multi-line string literals. + EXPECT_EQ("x = \"a\\\n" + "b\\\n" + "c\";", + format("x = \"a\\\n" + "b\\\n" + "c\";", + NoBreak)); + EXPECT_EQ("x =\n" + " \"a\\\n" + "b\\\n" + "c\";", + format("x = \"a\\\n" + "b\\\n" + "c\";", + Break)); + + // Exempt ObjC strings for now. + EXPECT_EQ("NSString *const kString = @\"aaaa\"\n" + " \"bbbb\";", + format("NSString *const kString = @\"aaaa\"\n" + "\"bbbb\";", + Break)); } TEST_F(FormatTest, AlignsPipes) { @@ -2189,12 +3690,15 @@ TEST_F(FormatTest, AlignsPipes) { " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); verifyFormat("return out << \"somepacket = {\\n\"\n" - " << \" aaaaaa = \" << pkt.aaaaaa << \"\\n\"\n" - " << \" bbbb = \" << pkt.bbbb << \"\\n\"\n" - " << \" cccccc = \" << pkt.cccccc << \"\\n\"\n" - " << \" ddd = [\" << pkt.ddd << \"]\\n\"\n" + " << \" aaaaaa = \" << pkt.aaaaaa << \"\\n\"\n" + " << \" bbbb = \" << pkt.bbbb << \"\\n\"\n" + " << \" cccccc = \" << pkt.cccccc << \"\\n\"\n" + " << \" ddd = [\" << pkt.ddd << \"]\\n\"\n" " << \"}\";"); + verifyFormat("llvm::outs() << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n" + " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n" + " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa;"); verifyFormat( "llvm::outs() << \"aaaaaaaaaaaaaaaaa = \" << aaaaaaaaaaaaaaaaa\n" " << \"bbbbbbbbbbbbbbbbb = \" << bbbbbbbbbbbbbbbbb\n" @@ -2203,10 +3707,43 @@ TEST_F(FormatTest, AlignsPipes) { " << \"eeeeeeeeeeeeeeeee = \" << eeeeeeeeeeeeeeeee;"); verifyFormat("llvm::outs() << aaaaaaaaaaaaaaaaaaaaaaaa << \"=\"\n" " << bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); + verifyFormat( + "void f() {\n" + " llvm::outs() << \"aaaaaaaaaaaaaaaaaaaa: \"\n" + " << aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n" + "}"); + + // Breaking before the first "<<" is generally not desirable. + verifyFormat( + "llvm::errs()\n" + " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;", + getLLVMStyleWithColumns(70)); + verifyFormat("llvm::errs() << \"aaaaaaaaaaaaaaaaaaa: \"\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << \"aaaaaaaaaaaaaaaaaaa: \"\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << \"aaaaaaaaaaaaaaaaaaa: \"\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;", + getLLVMStyleWithColumns(70)); + + // But sometimes, breaking before the first "<<" is desirable. + verifyFormat("Diag(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbb)\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;"); + verifyFormat("SemaRef.Diag(Loc, diag::note_for_range_begin_end)\n" + " << BEF << IsTemplate << Description << E->getType();"); verifyFormat( "llvm::errs() << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); + + // Incomplete string literal. + EXPECT_EQ("llvm::errs() << \"\n" + " << a;", + format("llvm::errs() << \"\n<<a;")); } TEST_F(FormatTest, UnderstandsEquals) { @@ -2254,12 +3791,19 @@ TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) { " .WillRepeatedly(Return(SomeValue));"); verifyFormat("SomeMap[std::pair(aaaaaaaaaaaa, bbbbbbbbbbbbbbb)]\n" " .insert(ccccccccccccccccccccccc);"); + verifyFormat("aaaaa(aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).aaaaa(aaaaa),\n" + " aaaaaaaaaaaaaaaaaaaaa);"); + verifyFormat("void f() {\n" + " aaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa)->aaaaaaaaa());\n" + "}"); verifyFormat( "aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" - " .aaaaaaaaaaaaaaa(\n" - " aa(aaaaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaaa));"); + " .aaaaaaaaaaaaaaa(aa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaa));"); verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" @@ -2294,11 +3838,23 @@ TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) { " aaaaaaaaaaaaaaaaaaa,\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);", NoBinPacking); + + // If there is a subsequent call, change to hanging indentation. + verifyFormat( + "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa))\n" + " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); + verifyFormat( + "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa));"); } TEST_F(FormatTest, WrapsTemplateDeclarations) { verifyFormat("template <typename T>\n" "virtual void loooooooooooongFunction(int Param1, int Param2);"); + verifyFormat("template <typename T>\n" + "// T should be one of {A, B}.\n" + "virtual void loooooooooooongFunction(int Param1, int Param2);"); verifyFormat( "template <typename T>\n" "using comment_to_xml_conversion = comment_to_xml_conversion<T, int>;"); @@ -2325,8 +3881,39 @@ TEST_F(FormatTest, WrapsTemplateDeclarations) { "aaaaaaaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa>(\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);"); - verifyFormat("a<aaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaa>(\n" - " a(aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));"); + verifyFormat("void f() {\n" + " a<aaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaa>(\n" + " a(aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));\n" + "}"); + + verifyFormat("template <typename T> class C {};"); + verifyFormat("template <typename T> void f();"); + verifyFormat("template <typename T> void f() {}"); + verifyFormat( + "aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa> *aaaa =\n" + " new aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>(\n" + " bbbbbbbbbbbbbbbbbbbbbbbb);", + getLLVMStyleWithColumns(72)); + + FormatStyle AlwaysBreak = getLLVMStyle(); + AlwaysBreak.AlwaysBreakTemplateDeclarations = true; + verifyFormat("template <typename T>\nclass C {};", AlwaysBreak); + verifyFormat("template <typename T>\nvoid f();", AlwaysBreak); + verifyFormat("template <typename T>\nvoid f() {}", AlwaysBreak); + verifyFormat("void aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " bbbbbbbbbbbbbbbbbbbbbbbbbbbb>(\n" + " ccccccccccccccccccccccccccccccccccccccccccccccc);"); + verifyFormat("template <template <typename> class Fooooooo,\n" + " template <typename> class Baaaaaaar>\n" + "struct C {};", + AlwaysBreak); + verifyFormat("template <typename T> // T can be A, B or C.\n" + "struct C {};", + AlwaysBreak); } TEST_F(FormatTest, WrapsAtNestedNameSpecifiers) { @@ -2338,14 +3925,12 @@ TEST_F(FormatTest, WrapsAtNestedNameSpecifiers) { " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa());"); - // FIXME: Should we have an extra indent after the second break? + // FIXME: Should we have the extra indent after the second break? verifyFormat( "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();"); - // FIXME: Look into whether we should indent 4 from the start or 4 from - // "bbbbb..." here instead of what we are doing now. verifyFormat( "aaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb::\n" " cccccccccccccccccccccccccccccccccccccccccccccc());"); @@ -2383,14 +3968,33 @@ TEST_F(FormatTest, UnderstandsTemplateParameters) { verifyGoogleFormat("A<A<int> > a;"); verifyGoogleFormat("A<A<A<int> > > a;"); verifyGoogleFormat("A<A<A<A<int> > > > a;"); + verifyGoogleFormat("A<::A<int>> a;"); + verifyGoogleFormat("A<::A> a;"); + verifyGoogleFormat("A< ::A> a;"); + verifyGoogleFormat("A< ::A<int> > a;"); EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A> >> a;", getGoogleStyle())); EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A>> > a;", getGoogleStyle())); + EXPECT_EQ("A<::A<int>> a;", format("A< ::A<int>> a;", getGoogleStyle())); + EXPECT_EQ("A<::A<int>> a;", format("A<::A<int> > a;", getGoogleStyle())); verifyFormat("test >> a >> b;"); verifyFormat("test << a >> b;"); verifyFormat("f<int>();"); verifyFormat("template <typename T> void f() {}"); + + // Not template parameters. + verifyFormat("return a < b && c > d;"); + verifyFormat("void f() {\n" + " while (a < b && c > d) {\n" + " }\n" + "}"); + verifyFormat("template <typename... Types>\n" + "typename enable_if<0 < sizeof...(Types)>::type Foo() {}"); + + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa >> aaaaa);", + getLLVMStyleWithColumns(60)); } TEST_F(FormatTest, UnderstandsBinaryOperators) { @@ -2399,14 +4003,23 @@ TEST_F(FormatTest, UnderstandsBinaryOperators) { TEST_F(FormatTest, UnderstandsPointersToMembers) { verifyFormat("int A::*x;"); - // FIXME: Recognize pointers to member functions. - //verifyFormat("int (S::*func)(void *);"); - verifyFormat("int(S::*func)(void *);"); - verifyFormat("(a->*f)();"); - verifyFormat("a->*x;"); - verifyFormat("(a.*f)();"); - verifyFormat("((*a).*f)();"); - verifyFormat("a.*x;"); + verifyFormat("int (S::*func)(void *);"); + verifyFormat("void f() { int (S::*func)(void *); }"); + verifyFormat("typedef bool *(Class::*Member)() const;"); + verifyFormat("void f() {\n" + " (a->*f)();\n" + " a->*x;\n" + " (a.*f)();\n" + " ((*a).*f)();\n" + " a.*x;\n" + "}"); + verifyFormat("void f() {\n" + " (a->*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)(\n" + " aaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb);\n" + "}"); + FormatStyle Style = getLLVMStyle(); + Style.PointerBindsToType = true; + verifyFormat("typedef bool* (Class::*Member)() const;", Style); } TEST_F(FormatTest, UnderstandsUnaryOperators) { @@ -2427,9 +4040,9 @@ TEST_F(FormatTest, UnderstandsUnaryOperators) { verifyFormat("a-- > b;"); verifyFormat("b ? -a : c;"); verifyFormat("n * sizeof char16;"); - verifyFormat("n * alignof char16;"); + verifyFormat("n * alignof char16;", getGoogleStyle()); verifyFormat("sizeof(char);"); - verifyFormat("alignof(char);"); + verifyFormat("alignof(char);", getGoogleStyle()); verifyFormat("return -1;"); verifyFormat("switch (a) {\n" @@ -2447,7 +4060,19 @@ TEST_F(FormatTest, UnderstandsUnaryOperators) { verifyFormat("int a = i /* confusing comment */++;"); } -TEST_F(FormatTest, UndestandsOverloadedOperators) { +TEST_F(FormatTest, IndentsRelativeToUnaryOperators) { + verifyFormat("if (!aaaaaaaaaa( // break\n" + " aaaaa)) {\n" + "}"); + verifyFormat("aaaaaaaaaa(!aaaaaaaaaa( // break\n" + " aaaaa));"); + + // Only indent relative to unary operators if the expression is nested. + verifyFormat("*aaa = aaaaaaa( // break\n" + " bbbbbb);"); +} + +TEST_F(FormatTest, UnderstandsOverloadedOperators) { verifyFormat("bool operator<();"); verifyFormat("bool operator>();"); verifyFormat("bool operator=();"); @@ -2468,6 +4093,8 @@ TEST_F(FormatTest, UndestandsOverloadedOperators) { verifyFormat("void *operator new[](std::size_t size);"); verifyFormat("void operator delete(void *ptr);"); verifyFormat("void operator delete[](void *ptr);"); + verifyFormat("template <typename AAAAAAA, typename BBBBBBB>\n" + "AAAAAAA operator/(const AAAAAAA &a, BBBBBBB &b);"); verifyFormat( "ostream &operator<<(ostream &OutputStream,\n" @@ -2480,6 +4107,9 @@ TEST_F(FormatTest, UndestandsOverloadedOperators) { verifyGoogleFormat("operator void*();"); verifyGoogleFormat("operator SomeType<SomeType<int>>();"); + verifyGoogleFormat("operator ::A();"); + + verifyFormat("using A::operator+;"); } TEST_F(FormatTest, UnderstandsNewAndDelete) { @@ -2529,12 +4159,14 @@ TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) { verifyIndependentOfContext("return sizeof(int **);"); verifyIndependentOfContext("return sizeof(int ******);"); verifyIndependentOfContext("return (int **&)a;"); + verifyIndependentOfContext("f((*PointerToArray)[10]);"); verifyFormat("void f(Type (*parameter)[10]) {}"); verifyGoogleFormat("return sizeof(int**);"); verifyIndependentOfContext("Type **A = static_cast<Type **>(P);"); verifyGoogleFormat("Type** A = static_cast<Type**>(P);"); - // FIXME: The newline is wrong. - verifyFormat("auto a = [](int **&, int ***) {}\n;"); + verifyFormat("auto a = [](int **&, int ***) {};"); + verifyFormat("auto PointerBinding = [](const char *S) {};"); + verifyFormat("typedef typeof(int(int, int)) *MyFunc;"); verifyIndependentOfContext("InvalidRegions[*R] = 0;"); @@ -2587,22 +4219,47 @@ TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) { verifyIndependentOfContext("if (*b[i])"); verifyIndependentOfContext("if (int *a = (&b))"); verifyIndependentOfContext("while (int *a = &b)"); + verifyIndependentOfContext("size = sizeof *a;"); verifyFormat("void f() {\n" " for (const int &v : Values) {\n" " }\n" "}"); verifyFormat("for (int i = a * a; i < 10; ++i) {\n}"); verifyFormat("for (int i = 0; i < a * a; ++i) {\n}"); + verifyGoogleFormat("for (int i = 0; i * 2 < z; i *= 2) {\n}"); + + verifyFormat("#define A (!a * b)"); + verifyFormat("#define MACRO \\\n" + " int *i = a * b; \\\n" + " void f(a *b);", + getLLVMStyleWithColumns(19)); verifyIndependentOfContext("A = new SomeType *[Length];"); verifyIndependentOfContext("A = new SomeType *[Length]();"); + verifyIndependentOfContext("T **t = new T *;"); + verifyIndependentOfContext("T **t = new T *();"); verifyGoogleFormat("A = new SomeType* [Length]();"); verifyGoogleFormat("A = new SomeType* [Length];"); + verifyGoogleFormat("T** t = new T*;"); + verifyGoogleFormat("T** t = new T*();"); + + FormatStyle PointerLeft = getLLVMStyle(); + PointerLeft.PointerBindsToType = true; + verifyFormat("delete *x;", PointerLeft); +} + +TEST_F(FormatTest, UnderstandsAttributes) { + verifyFormat("SomeType s __attribute__((unused)) (InitValue);"); } TEST_F(FormatTest, UnderstandsEllipsis) { verifyFormat("int printf(const char *fmt, ...);"); verifyFormat("template <class... Ts> void Foo(Ts... ts) { Foo(ts...); }"); + verifyFormat("template <class... Ts> void Foo(Ts *... ts) {}"); + + FormatStyle PointersLeft = getLLVMStyle(); + PointersLeft.PointerBindsToType = true; + verifyFormat("template <class... Ts> void Foo(Ts*... ts) {}", PointersLeft); } TEST_F(FormatTest, AdaptivelyFormatsPointersAndReferences) { @@ -2636,12 +4293,17 @@ TEST_F(FormatTest, UnderstandsRvalueReferences) { verifyGoogleFormat("int f(int a, char&& b) {}"); verifyGoogleFormat("void f() { int&& a = b; }"); - // FIXME: These require somewhat deeper changes in template arguments - // formatting. - // verifyIndependentOfContext("A<int &&> a;"); - // verifyIndependentOfContext("A<int &&, int &&> a;"); - // verifyGoogleFormat("A<int&&> a;"); - // verifyGoogleFormat("A<int&&, int&&> a;"); + verifyIndependentOfContext("A<int &&> a;"); + verifyIndependentOfContext("A<int &&, int &&> a;"); + verifyGoogleFormat("A<int&&> a;"); + verifyGoogleFormat("A<int&&, int&&> a;"); + + // Not rvalue references: + verifyFormat("template <bool B, bool C> class A {\n" + " static_assert(B && C, \"Something is wrong\");\n" + "};"); + verifyGoogleFormat("#define IF(a, b, c) if (a && (b == c))"); + verifyGoogleFormat("#define WHILE(a, b, c) while (a && (b == c))"); } TEST_F(FormatTest, FormatsBinaryOperatorsPrecedingEquals) { @@ -2657,10 +4319,33 @@ TEST_F(FormatTest, FormatsCasts) { verifyFormat("Type *A = (Type *)P;"); verifyFormat("Type *A = (vector<Type *, int *>)P;"); verifyFormat("int a = (int)(2.0f);"); - - // FIXME: These also need to be identified. - verifyFormat("int a = (int) 2.0f;"); - verifyFormat("int a = (int) * b;"); + verifyFormat("int a = (int)2.0f;"); + verifyFormat("x[(int32)y];"); + verifyFormat("x = (int32)y;"); + verifyFormat("#define AA(X) sizeof(((X *)NULL)->a)"); + verifyFormat("int a = (int)*b;"); + verifyFormat("int a = (int)2.0f;"); + verifyFormat("int a = (int)~0;"); + verifyFormat("int a = (int)++a;"); + verifyFormat("int a = (int)sizeof(int);"); + verifyFormat("int a = (int)+2;"); + verifyFormat("my_int a = (my_int)2.0f;"); + verifyFormat("my_int a = (my_int)sizeof(int);"); + verifyFormat("return (my_int)aaa;"); + verifyFormat("#define x ((int)-1)"); + verifyFormat("#define p(q) ((int *)&q)"); + + // FIXME: Without type knowledge, this can still fall apart miserably. + verifyFormat("void f() { my_int a = (my_int) * b; }"); + verifyFormat("void f() { return P ? (my_int) * P : (my_int)0; }"); + verifyFormat("my_int a = (my_int) ~0;"); + verifyFormat("my_int a = (my_int)++ a;"); + verifyFormat("my_int a = (my_int) + 2;"); + + // Don't break after a cast's + verifyFormat("int aaaaaaaaaaaaaaaaaaaaaaaaaaa =\n" + " (aaaaaaaaaaaaaaaaaaaaaaaaaa *)(aaaaaaaaaaaaaaaaaaaaaa +\n" + " bbbbbbbbbbbbbbbbbbbbbb);"); // These are not casts. verifyFormat("void f(int *) {}"); @@ -2668,7 +4353,7 @@ TEST_F(FormatTest, FormatsCasts) { verifyFormat("f(foo).b;"); verifyFormat("f(foo)(b);"); verifyFormat("f(foo)[b];"); - verifyFormat("[](foo) { return 4; }(bar)];"); + verifyFormat("[](foo) { return 4; }(bar);"); verifyFormat("(*funptr)(foo)[4];"); verifyFormat("funptrs[4](foo)[4];"); verifyFormat("void f(int *);"); @@ -2679,44 +4364,76 @@ TEST_F(FormatTest, FormatsCasts) { verifyFormat("void f(int i = (kValue) * kMask) {}"); verifyFormat("void f(int i = (kA * kB) & kMask) {}"); verifyFormat("int a = sizeof(int) * b;"); - verifyFormat("int a = alignof(int) * b;"); + verifyFormat("int a = alignof(int) * b;", getGoogleStyle()); + verifyFormat("template <> void f<int>(int i) SOME_ANNOTATION;"); + verifyFormat("f(\"%\" SOME_MACRO(ll) \"d\");"); + verifyFormat("aaaaa &operator=(const aaaaa &) LLVM_DELETED_FUNCTION;"); // These are not casts, but at some point were confused with casts. verifyFormat("virtual void foo(int *) override;"); verifyFormat("virtual void foo(char &) const;"); verifyFormat("virtual void foo(int *a, char *) const;"); verifyFormat("int a = sizeof(int *) + b;"); - verifyFormat("int a = alignof(int *) + b;"); + verifyFormat("int a = alignof(int *) + b;", getGoogleStyle()); + + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *foo = (aaaaaaaaaaaaaaaaa *)\n" + " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;"); + // FIXME: The indentation here is not ideal. + verifyFormat( + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (*cccccccccccccccc)\n" + " [dddddddddddddddddddddddddddddddddddddddddddddddddddddddd];"); } TEST_F(FormatTest, FormatsFunctionTypes) { verifyFormat("A<bool()> a;"); verifyFormat("A<SomeType()> a;"); - verifyFormat("A<void(*)(int, std::string)> a;"); + verifyFormat("A<void (*)(int, std::string)> a;"); verifyFormat("A<void *(int)>;"); verifyFormat("void *(*a)(int *, SomeType *);"); - - // FIXME: Inconsistent. verifyFormat("int (*func)(void *);"); - verifyFormat("void f() { int(*func)(void *); }"); + verifyFormat("void f() { int (*func)(void *); }"); + verifyFormat("template <class CallbackClass>\n" + "using MyCallback = void (CallbackClass::*)(SomeObject *Data);"); verifyGoogleFormat("A<void*(int*, SomeType*)>;"); verifyGoogleFormat("void* (*a)(int);"); + verifyGoogleFormat( + "template <class CallbackClass>\n" + "using MyCallback = void (CallbackClass::*)(SomeObject* Data);"); + + // Other constructs can look somewhat like function types: + verifyFormat("A<sizeof(*x)> a;"); + verifyFormat("#define DEREF_AND_CALL_F(x) f(*x)"); + verifyFormat("some_var = function(*some_pointer_var)[0];"); + verifyFormat("void f() { function(*some_pointer_var)[0] = 10; }"); } TEST_F(FormatTest, BreaksLongDeclarations) { verifyFormat("typedef LoooooooooooooooooooooooooooooooooooooooongType\n" - " AnotherNameForTheLongType;"); + " AnotherNameForTheLongType;", + getGoogleStyle()); + verifyFormat("typedef LongTemplateType<aaaaaaaaaaaaaaaaaaa()>\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;", + getGoogleStyle()); verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType\n" - " LoooooooooooooooooooooooooooooooooooooooongVariable;"); + " LoooooooooooooooooooooooooooooooooooooooongVariable;", + getGoogleStyle()); + verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType const\n" + " LoooooooooooooooooooooooooooooooooooooooongVariable;", + getGoogleStyle()); verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" - " LoooooooooooooooooooooooooooooooongFunctionDeclaration();"); + " LoooooooooooooooooooooooooooooooongFunctionDeclaration();", + getGoogleStyle()); verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n" "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}"); + verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType const\n" + "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}"); // FIXME: Without the comment, this breaks after "(". - verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType // break\n" - " (*LoooooooooooooooooooooooooooongFunctionTypeVarialbe)();"); + verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType // break\n" + " (*LoooooooooooooooooooooooooooongFunctionTypeVarialbe)();", + getGoogleStyle()); verifyFormat("int *someFunction(int LoooooooooooooooooooongParam1,\n" " int LoooooooooooooooooooongParam2) {}"); @@ -2731,10 +4448,14 @@ TEST_F(FormatTest, BreaksLongDeclarations) { " ReallyReallyLongParameterName,\n" " const SomeType<string, SomeOtherTemplateParameter> &\n" " AnotherLongParameterName) {}"); - verifyFormat( + verifyFormat("template <typename A>\n" + "SomeLoooooooooooooooooooooongType<\n" + " typename some_namespace::SomeOtherType<A>::Type>\n" + "Function() {}"); + + verifyGoogleFormat( "aaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaa<aaaaaaaaaaaaa, aaaaaaaaaaaa>\n" " aaaaaaaaaaaaaaaaaaaaaaa;"); - verifyGoogleFormat( "TypeSpecDecl* TypeSpecDecl::Create(ASTContext& C, DeclContext* DC,\n" " SourceLocation L) {}"); @@ -2750,6 +4471,22 @@ TEST_F(FormatTest, BreaksLongDeclarations) { " int aaaaaaaaaaaaaaaaaaaaaaa);"); } +TEST_F(FormatTest, FormatsArrays) { + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaa[aaaaaaaaaaaaaaaaaaaaaaaaa]\n" + " [bbbbbbbbbbbbbbbbbbbbbbbbb] = c;"); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;"); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " [a][bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = cccccccc;"); + verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n" + " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;"); + verifyFormat( + "llvm::outs() << \"aaaaaaaaaaaa: \"\n" + " << (*aaaaaaaiaaaaaaa)[aaaaaaaaaaaaaaaaaaaaaaaaa]\n" + " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa];"); +} + TEST_F(FormatTest, LineStartsWithSpecialCharacter) { verifyFormat("(a)->b();"); verifyFormat("--a;"); @@ -2764,14 +4501,20 @@ TEST_F(FormatTest, HandlesIncludeDirectives) { "#include <a-a>\n" "#include < path with space >\n" "#include \"abc.h\" // this is included for ABC\n" + "#include \"some long include\" // with a comment\n" "#include \"some very long include paaaaaaaaaaaaaaaaaaaaaaath\"", getLLVMStyleWithColumns(35)); + EXPECT_EQ("#include \"a.h\"", format("#include \"a.h\"")); + EXPECT_EQ("#include <a>", format("#include<a>")); verifyFormat("#import <string>"); verifyFormat("#import <a/b/c.h>"); verifyFormat("#import \"a/b/string\""); verifyFormat("#import \"string.h\""); verifyFormat("#import \"string.h\""); + verifyFormat("#if __has_include(<strstream>)\n" + "#include <strstream>\n" + "#endif"); } //===----------------------------------------------------------------------===// @@ -2813,7 +4556,10 @@ TEST_F(FormatTest, IncorrectCodeMissingSemicolon) { " return\n" "}", format("void f ( ) { if ( a ) return }")); - EXPECT_EQ("namespace N { void f() }", format("namespace N { void f() }")); + EXPECT_EQ("namespace N {\n" + "void f()\n" + "}", + format("namespace N { void f() }")); EXPECT_EQ("namespace N {\n" "void f() {}\n" "void g()\n" @@ -2874,20 +4620,22 @@ TEST_F(FormatTest, IncorrectCodeMissingParens) { TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) { verifyFormat("namespace {\n" - "class Foo { Foo ( }; } // comment"); + "class Foo { Foo (\n" + "};\n" + "} // comment"); } TEST_F(FormatTest, IncorrectCodeErrorDetection) { - EXPECT_EQ("{\n{}\n", format("{\n{\n}\n")); + EXPECT_EQ("{\n {}\n", format("{\n{\n}\n")); EXPECT_EQ("{\n {}\n", format("{\n {\n}\n")); EXPECT_EQ("{\n {}\n", format("{\n {\n }\n")); - EXPECT_EQ("{\n {}\n }\n}\n", format("{\n {\n }\n }\n}\n")); + EXPECT_EQ("{\n {}\n}\n}\n", format("{\n {\n }\n }\n}\n")); EXPECT_EQ("{\n" - " {\n" - " breakme(\n" - " qwe);\n" - "}\n", + " {\n" + " breakme(\n" + " qwe);\n" + " }\n", format("{\n" " {\n" " breakme(qwe);\n" @@ -2907,14 +4655,119 @@ TEST_F(FormatTest, LayoutBraceInitializersInReturnStatement) { verifyFormat("return (a)(b) { 1, 2, 3 };"); } -TEST_F(FormatTest, LayoutTokensFollowingBlockInParentheses) { - // FIXME: This is bad, find a better and more generic solution. +TEST_F(FormatTest, LayoutCxx11ConstructorBraceInitializers) { + verifyFormat("vector<int> x{ 1, 2, 3, 4 };"); + verifyFormat("vector<T> x{ {}, {}, {}, {} };"); + verifyFormat("f({ 1, 2 });"); + verifyFormat("auto v = Foo{ 1 };"); + verifyFormat("f({ 1, 2 }, { { 2, 3 }, { 4, 5 } }, c, { d });"); + verifyFormat("Class::Class : member{ 1, 2, 3 } {}"); + verifyFormat("new vector<int>{ 1, 2, 3 };"); + verifyFormat("new int[3]{ 1, 2, 3 };"); + verifyFormat("return { arg1, arg2 };"); + verifyFormat("return { arg1, SomeType{ parameter } };"); + verifyFormat("new T{ arg1, arg2 };"); + verifyFormat("f(MyMap[{ composite, key }]);"); + verifyFormat("class Class {\n" + " T member = { arg1, arg2 };\n" + "};"); + verifyFormat( + "foo = aaaaaaaaaaa ? vector<int>{ aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaaaaaaa, aaaaa }\n" + " : vector<int>{ bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" + " bbbbbbbbbbbbbbbbbbbb, bbbbb };"); + verifyFormat("DoSomethingWithVector({} /* No data */);"); + verifyFormat("DoSomethingWithVector({ {} /* No data */ }, { { 1, 2 } });"); + verifyFormat( + "someFunction(OtherParam, BracedList{\n" + " // comment 1 (Forcing interesting break)\n" + " param1, param2,\n" + " // comment 2\n" + " param3, param4\n" + " });"); + verifyFormat( + "std::this_thread::sleep_for(\n" + " std::chrono::nanoseconds{ std::chrono::seconds{ 1 } } / 5);"); + + FormatStyle NoSpaces = getLLVMStyle(); + NoSpaces.Cpp11BracedListStyle = true; + verifyFormat("vector<int> x{1, 2, 3, 4};", NoSpaces); + verifyFormat("vector<T> x{{}, {}, {}, {}};", NoSpaces); + verifyFormat("f({1, 2});", NoSpaces); + verifyFormat("auto v = Foo{-1};", NoSpaces); + verifyFormat("f({1, 2}, {{2, 3}, {4, 5}}, c, {d});", NoSpaces); + verifyFormat("Class::Class : member{1, 2, 3} {}", NoSpaces); + verifyFormat("new vector<int>{1, 2, 3};", NoSpaces); + verifyFormat("new int[3]{1, 2, 3};", NoSpaces); + verifyFormat("return {arg1, arg2};", NoSpaces); + verifyFormat("return {arg1, SomeType{parameter}};", NoSpaces); + verifyFormat("new T{arg1, arg2};", NoSpaces); + verifyFormat("f(MyMap[{composite, key}]);", NoSpaces); + verifyFormat("class Class {\n" + " T member = {arg1, arg2};\n" + "};", + NoSpaces); + verifyFormat("Constructor::Constructor()\n" + " : some_value{ //\n" + " aaaaaaa //\n" + " } {}", + NoSpaces); +} + +TEST_F(FormatTest, FormatsBracedListsInColumnLayout) { + verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777 };"); + verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " // line comment\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555,\n" + " // line comment\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777 };"); verifyFormat( - "Aaa({\n" - " int i;\n" - "},\n" - " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n" - " ccccccccccccccccc));"); + "vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, 7777777,\n" + " 1, 22, 333, 4444, 55555, 666666, // comment\n" + " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" + " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" + " 7777777, 1, 22, 333, 4444, 55555, 666666,\n" + " 7777777 };"); + verifyFormat("static const uint16_t CallerSavedRegs64Bittttt[] = {\n" + " X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,\n" + " X86::R8, X86::R9, X86::R10, X86::R11, 0\n" + "};"); + verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" + " 1, 1, 1, 1 };", + getLLVMStyleWithColumns(39)); + verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" + " 1, 1, 1, 1 };", + getLLVMStyleWithColumns(38)); + verifyFormat("vector<int> aaaaaaaaaaaaaaaaaaaaaa = {\n" + " 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1\n" + "};", + getLLVMStyleWithColumns(40)); + + // Trailing commas. + verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" + " 1, 1, 1, 1, };", + getLLVMStyleWithColumns(39)); + verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" + " 1, 1, 1, 1, //\n" + "};", + getLLVMStyleWithColumns(39)); + verifyFormat("vector<int> x = { 1, 1, 1, 1,\n" + " 1, 1, 1, 1,\n" + " /**/ /**/ };", + getLLVMStyleWithColumns(39)); + verifyFormat("return { { aaaaaaaaaaaaaaaaaaaaa },\n" + " { aaaaaaaaaaaaaaaaaaa },\n" + " { aaaaaaaaaaaaaaaaaaaaa },\n" + " { aaaaaaaaaaaaaaaaa } };", + getLLVMStyleWithColumns(60)); } TEST_F(FormatTest, PullTrivialFunctionDefinitionsIntoSingleLine) { @@ -2930,6 +4783,11 @@ TEST_F(FormatTest, PullTrivialFunctionDefinitionsIntoSingleLine) { " int a;\n" "#error {\n" "}"); + verifyFormat("void f() {} // comment"); + verifyFormat("void f() { int a; } // comment"); + verifyFormat("void f() {\n" + "} // comment", + getLLVMStyleWithColumns(15)); verifyFormat("void f() { return 42; }", getLLVMStyleWithColumns(23)); verifyFormat("void f() {\n return 42;\n}", getLLVMStyleWithColumns(22)); @@ -2964,13 +4822,21 @@ TEST_F(FormatTest, UnderstandContextOfRecordTypeKeywords) { verifyFormat("class __attribute__(X) Z {\n} n;"); verifyFormat("class __declspec(X) Z {\n} n;"); verifyFormat("class A##B##C {\n} n;"); + verifyFormat("class alignas(16) Z {\n} n;"); // Redefinition from nested context: verifyFormat("class A::B::C {\n} n;"); // Template definitions. + verifyFormat( + "template <typename F>\n" + "Matcher(const Matcher<F> &Other,\n" + " typename enable_if_c<is_base_of<F, T>::value &&\n" + " !is_same<F, T>::value>::type * = 0)\n" + " : Implementation(new ImplicitCastMatcher<F>(Other)) {}"); + // FIXME: This is still incorrectly handled at the formatter side. - verifyFormat("template <> struct X < 15, i < 3 && 42 < 50 && 33<28> {\n};"); + verifyFormat("template <> struct X < 15, i<3 && 42 < 50 && 33 < 28> {};"); // FIXME: // This now gets parsed incorrectly as class definition. @@ -2984,12 +4850,15 @@ TEST_F(FormatTest, UnderstandContextOfRecordTypeKeywords) { " f();\n"); // This is simply incomplete. Formatting is not important, but must not crash. - verifyFormat("class A:"); + verifyFormat("class A:"); } TEST_F(FormatTest, DoNotInterfereWithErrorAndWarning) { - verifyFormat("#error Leave all white!!!!! space* alone!\n"); - verifyFormat("#warning Leave all white!!!!! space* alone!\n"); + EXPECT_EQ("#error Leave all white!!!!! space* alone!\n", + format("#error Leave all white!!!!! space* alone!\n")); + EXPECT_EQ( + "#warning Leave all white!!!!! space* alone!\n", + format("#warning Leave all white!!!!! space* alone!\n")); EXPECT_EQ("#error 1", format(" # error 1")); EXPECT_EQ("#warning 1", format(" # warning 1")); } @@ -3034,7 +4903,8 @@ TEST_F(FormatTest, MergeHandlingInTheFaceOfPreprocessorDirectives) { " if (true) continue;\n" "#endif\n" " // Comment\n" - " if (true) continue;", + " if (true) continue;\n" + "}", ShortMergedIf); } @@ -3062,7 +4932,7 @@ TEST_F(FormatTest, BlockComments) { EXPECT_EQ("/* */ /* */ /* */\n/* */ /* */ /* */", format("/* *//* */ /* */\n/* *//* */ /* */")); EXPECT_EQ("/* */ a /* */ b;", format(" /* */ a/* */ b;")); - EXPECT_EQ("#define A /*123*/\\\n" + EXPECT_EQ("#define A /*123*/ \\\n" " b\n" "/* */\n" "someCall(\n" @@ -3078,6 +4948,27 @@ TEST_F(FormatTest, BlockComments) { format("#define A\n" "/* */someCall(parameter);", getLLVMStyleWithColumns(15))); + EXPECT_EQ("/*\n**\n*/", format("/*\n**\n*/")); + EXPECT_EQ("/*\n" + "*\n" + " * aaaaaa\n" + "*aaaaaa\n" + "*/", + format("/*\n" + "*\n" + " * aaaaaa aaaaaa\n" + "*/", + getLLVMStyleWithColumns(10))); + EXPECT_EQ("/*\n" + "**\n" + "* aaaaaa\n" + "*aaaaaa\n" + "*/", + format("/*\n" + "**\n" + "* aaaaaa aaaaaa\n" + "*/", + getLLVMStyleWithColumns(10))); FormatStyle NoBinPacking = getLLVMStyle(); NoBinPacking.BinPackParameters = false; @@ -3109,6 +5000,35 @@ TEST_F(FormatTest, BlockComments) { format("int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n" "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n" "int cccccccccccccccccccccccccccccc; /* comment */\n")); + + verifyFormat("void f(int * /* unused */) {}"); + + EXPECT_EQ("/*\n" + " **\n" + " */", + format("/*\n" + " **\n" + " */")); + EXPECT_EQ("/*\n" + " *q\n" + " */", + format("/*\n" + " *q\n" + " */")); + EXPECT_EQ("/*\n" + " * q\n" + " */", + format("/*\n" + " * q\n" + " */")); + EXPECT_EQ("/*\n" + " **/", + format("/*\n" + " **/")); + EXPECT_EQ("/*\n" + " ***/", + format("/*\n" + " ***/")); } TEST_F(FormatTest, BlockCommentsInMacros) { @@ -3132,6 +5052,30 @@ TEST_F(FormatTest, BlockCommentsInMacros) { getLLVMStyleWithColumns(20))); } +TEST_F(FormatTest, BlockCommentsAtEndOfLine) { + EXPECT_EQ("a = {\n" + " 1111 /* */\n" + "};", + format("a = {1111 /* */\n" + "};", + getLLVMStyleWithColumns(15))); + EXPECT_EQ("a = {\n" + " 1111 /* */\n" + "};", + format("a = {1111 /* */\n" + "};", + getLLVMStyleWithColumns(15))); + + // FIXME: The formatting is still wrong here. + EXPECT_EQ("a = {\n" + " 1111 /* a\n" + " */\n" + "};", + format("a = {1111 /* a */\n" + "};", + getLLVMStyleWithColumns(15))); +} + TEST_F(FormatTest, IndentLineCommentsInStartOfBlockAtEndOfFile) { // FIXME: This is not what we want... verifyFormat("{\n" @@ -3202,8 +5146,8 @@ TEST_F(FormatTest, FormatForObjectiveCMethodDecls) { // protocol lists (but not for template classes): //verifyFormat("- (void)setDelegate:(id <Protocol>)delegate;"); - verifyFormat("- (int(*)())foo:(int(*)())f;"); - verifyGoogleFormat("- (int(*)())foo:(int(*)())foo;"); + verifyFormat("- (int (*)())foo:(int (*)())f;"); + verifyGoogleFormat("- (int (*)())foo:(int (*)())foo;"); // If there's no return type (very rare in practice!), LLVM and Google style // agree. @@ -3386,6 +5330,10 @@ TEST_F(FormatTest, FormatObjCImplementation) { verifyFormat("@implementation Foo (HackStuff)\n" "+ (id)init {\n}\n" "@end"); + verifyFormat("@implementation ObjcClass\n" + "- (void)method;\n" + "{}\n" + "@end"); } TEST_F(FormatTest, FormatObjCProtocol) { @@ -3419,6 +5367,11 @@ TEST_F(FormatTest, FormatObjCProtocol) { "@optional\n" "@property(assign) int madProp;\n" "@end\n"); + + verifyFormat("@property(nonatomic, assign, readonly)\n" + " int *looooooooooooooooooooooooooooongNumber;\n" + "@property(nonatomic, assign, readonly)\n" + " NSString *looooooooooooooooooooooooooooongName;"); } TEST_F(FormatTest, FormatObjCMethodDeclarations) { @@ -3449,7 +5402,7 @@ TEST_F(FormatTest, FormatObjCMethodExpr) { verifyFormat("int a = ++[foo bar:baz];"); verifyFormat("int a = --[foo bar:baz];"); verifyFormat("int a = sizeof [foo bar:baz];"); - verifyFormat("int a = alignof [foo bar:baz];"); + verifyFormat("int a = alignof [foo bar:baz];", getGoogleStyle()); verifyFormat("int a = &[foo bar:baz];"); verifyFormat("int a = *[foo bar:baz];"); // FIXME: Make casts work, without breaking f()[4]. @@ -3508,22 +5461,26 @@ TEST_F(FormatTest, FormatObjCMethodExpr) { verifyFormat("throw [self errorFor:a];"); verifyFormat("@throw [self errorFor:a];"); + verifyFormat("[(id)foo bar:(id)baz quux:(id)snorf];"); + verifyFormat("[(id)foo bar:(id) ? baz : quux];"); + verifyFormat("4 > 4 ? (id)a : (id)baz;"); + // This tests that the formatter doesn't break after "backing" but before ":", // which would be at 80 columns. verifyFormat( "void f() {\n" " if ((self = [super initWithContentRect:contentRect\n" - " styleMask:styleMask\n" + " styleMask:styleMask ?: otherMask\n" " backing:NSBackingStoreBuffered\n" " defer:YES]))"); verifyFormat( "[foo checkThatBreakingAfterColonWorksOk:\n" - " [bar ifItDoes:reduceOverallLineLengthLikeInThisCase]];"); + " [bar ifItDoes:reduceOverallLineLengthLikeInThisCase]];"); verifyFormat("[myObj short:arg1 // Force line break\n" - " longKeyword:arg2\n" - " evenLongerKeyword:arg3\n" + " longKeyword:arg2 != nil ? arg2 : @\"longKeyword\"\n" + " evenLongerKeyword:arg3 ?: @\"evenLongerKeyword\"\n" " error:arg4];"); verifyFormat( "void f() {\n" @@ -3534,6 +5491,16 @@ TEST_F(FormatTest, FormatObjCMethodExpr) { " backing:NSBackingStoreBuffered\n" " defer:NO]);\n" "}"); + verifyFormat( + "void f() {\n" + " popup_wdow_.reset([[RenderWidgetPopupWindow alloc]\n" + " iniithContentRect:NSMakRet(origin_global.x, origin_global.y,\n" + " pos.width(), pos.height())\n" + " syeMask:NSBorderlessWindowMask\n" + " bking:NSBackingStoreBuffered\n" + " der:NO]);\n" + "}", + getLLVMStyleWithColumns(70)); verifyFormat("[contentsContainer replaceSubview:[subviews objectAtIndex:0]\n" " with:contentsNativeView];"); @@ -3560,6 +5527,27 @@ TEST_F(FormatTest, FormatObjCMethodExpr) { "scoped_nsobject<NSTextField> message(\n" " // The frame will be fixed up when |-setMessageText:| is called.\n" " [[NSTextField alloc] initWithFrame:NSMakeRect(0, 0, 0, 0)]);"); + verifyFormat("[self aaaaaa:bbbbbbbbbbbbb\n" + " aaaaaaaaaa:bbbbbbbbbbbbbbbbb\n" + " aaaaa:bbbbbbbbbbb + bbbbbbbbbbbb\n" + " aaaa:bbb];"); + verifyFormat("[self param:function( //\n" + " parameter)]"); + verifyFormat( + "[self aaaaaaaaaa:aaaaaaaaaaaaaaa | aaaaaaaaaaaaaaa | aaaaaaaaaaaaaaa |\n" + " aaaaaaaaaaaaaaa | aaaaaaaaaaaaaaa | aaaaaaaaaaaaaaa |\n" + " aaaaaaaaaaaaaaa | aaaaaaaaaaaaaaa];"); + + // Variadic parameters. + verifyFormat( + "NSArray *myStrings = [NSArray stringarray:@\"a\", @\"b\", nil];"); + verifyFormat( + "[self aaaaaaaaaaaaa:aaaaaaaaaaaaaaa, aaaaaaaaaaaaaaa, aaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaa, aaaaaaaaaaaaaaa, aaaaaaaaaaaaaaa,\n" + " aaaaaaaaaaaaaaa, aaaaaaaaaaaaaaa];"); + verifyFormat("[self // break\n" + " a:a\n" + " aaa:aaa];"); } TEST_F(FormatTest, ObjCAt) { @@ -3618,6 +5606,9 @@ TEST_F(FormatTest, ObjCSnippets) { verifyFormat("@property(assign, nonatomic) CGFloat hoverAlpha;"); verifyFormat("@property(assign, getter=isEditable) BOOL editable;"); verifyGoogleFormat("@property(assign, getter=isEditable) BOOL editable;"); + + verifyFormat("@import foo.bar;\n" + "@import baz;"); } TEST_F(FormatTest, ObjCLiterals) { @@ -3634,29 +5625,17 @@ TEST_F(FormatTest, ObjCLiterals) { verifyFormat("NSNumber *piOverTwo = @(M_PI / 2);"); verifyFormat("NSNumber *favoriteColor = @(Green);"); verifyFormat("NSString *path = @(getenv(\"PATH\"));"); +} - verifyFormat("@["); - verifyFormat("@[]"); - verifyFormat( - "NSArray *array = @[ @\" Hey \", NSApp, [NSNumber numberWithInt:42] ];"); - verifyFormat("return @[ @3, @[], @[ @4, @5 ] ];"); - +TEST_F(FormatTest, ObjCDictLiterals) { verifyFormat("@{"); verifyFormat("@{}"); verifyFormat("@{ @\"one\" : @1 }"); verifyFormat("return @{ @\"one\" : @1 };"); verifyFormat("@{ @\"one\" : @1, }"); - // FIXME: Breaking in cases where we think there's a structural error - // showed that we're incorrectly parsing this code. We need to fix the - // parsing here. - verifyFormat("@{ @\"one\" : @\n" - "{ @2 : @1 }\n" - "}"); - verifyFormat("@{ @\"one\" : @\n" - "{ @2 : @1 }\n" - ",\n" - "}"); + verifyFormat("@{ @\"one\" : @{ @2 : @1 } }"); + verifyFormat("@{ @\"one\" : @{ @2 : @1 }, }"); verifyFormat("@{ 1 > 2 ? @\"one\" : @\"two\" : 1 > 2 ? @1 : @2 }"); verifyFormat("[self setDict:@{}"); @@ -3667,10 +5646,67 @@ TEST_F(FormatTest, ObjCLiterals) { verifyFormat( "NSDictionary *settings = @{ AVEncoderKey : @(AVAudioQualityMax) };"); - // FIXME: Nested and multi-line array and dictionary literals need more work. verifyFormat( - "NSDictionary *d = @{ @\"nam\" : NSUserNam(), @\"dte\" : [NSDate date],\n" - " @\"processInfo\" : [NSProcessInfo processInfo] };"); + "NSDictionary *d = @{\n" + " @\"nam\" : NSUserNam(),\n" + " @\"dte\" : [NSDate date],\n" + " @\"processInfo\" : [NSProcessInfo processInfo]\n" + "};"); + verifyFormat( + "@{\n" + " NSFontAttributeNameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee : " + "regularFont,\n" + "};"); + verifyGoogleFormat( + "@{\n" + " NSFontAttributeNameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee : " + "regularFont,\n" + "};"); + + // We should try to be robust in case someone forgets the "@". + verifyFormat( + "NSDictionary *d = {\n" + " @\"nam\" : NSUserNam(),\n" + " @\"dte\" : [NSDate date],\n" + " @\"processInfo\" : [NSProcessInfo processInfo]\n" + "};"); +} + +TEST_F(FormatTest, ObjCArrayLiterals) { + verifyFormat("@["); + verifyFormat("@[]"); + verifyFormat( + "NSArray *array = @[ @\" Hey \", NSApp, [NSNumber numberWithInt:42] ];"); + verifyFormat("return @[ @3, @[], @[ @4, @5 ] ];"); + verifyFormat("NSArray *array = @[ [foo description] ];"); + + verifyFormat( + "NSArray *some_variable = @[\n" + " aaaa == bbbbbbbbbbb ? @\"aaaaaaaaaaaa\" : @\"aaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\"\n" + "];"); + verifyFormat("NSArray *some_variable = @[\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + "];"); + verifyGoogleFormat("NSArray *some_variable = @[\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\"\n" + "];"); + + // We should try to be robust in case someone forgets the "@". + verifyFormat("NSArray *some_variable = [\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + " @\"aaaaaaaaaaaaaaaaa\",\n" + "];"); } TEST_F(FormatTest, ReformatRegionAdjustsIndent) { @@ -3718,7 +5754,7 @@ TEST_F(FormatTest, ReformatRegionAdjustsIndent) { "a;\n" "}\n" "{\n" - " b;\n" + " b; //\n" "}\n" "}", format("{\n" @@ -3726,15 +5762,15 @@ TEST_F(FormatTest, ReformatRegionAdjustsIndent) { "a;\n" "}\n" "{\n" - " b;\n" + " b; //\n" "}\n" "}", 22, 2, getLLVMStyle())); EXPECT_EQ(" {\n" - " a;\n" + " a; //\n" " }", format(" {\n" - "a;\n" + "a; //\n" " }", 4, 2, getLLVMStyle())); EXPECT_EQ("void f() {}\n" @@ -3749,6 +5785,13 @@ TEST_F(FormatTest, ReformatRegionAdjustsIndent) { " // line 2\n" " int b;", 35, 0, getLLVMStyle())); + EXPECT_EQ(" int a;\n" + " void\n" + " ffffff() {\n" + " }", + format(" int a;\n" + "void ffffff() {}", + 11, 0, getLLVMStyleWithColumns(11))); } TEST_F(FormatTest, BreakStringLiterals) { @@ -3808,6 +5851,18 @@ TEST_F(FormatTest, BreakStringLiterals) { format("variable = f(\"long string literal\", short, " "loooooooooooooooooooong);", getLLVMStyleWithColumns(20))); + + EXPECT_EQ("f(g(\"long string \"\n" + " \"literal\"),\n" + " b);", + format("f(g(\"long string literal\"), b);", + getLLVMStyleWithColumns(20))); + EXPECT_EQ("f(g(\"long string \"\n" + " \"literal\",\n" + " a),\n" + " b);", + format("f(g(\"long string literal\", a), b);", + getLLVMStyleWithColumns(20))); EXPECT_EQ( "f(\"one two\".split(\n" " variable));", @@ -3842,6 +5897,53 @@ TEST_F(FormatTest, BreakStringLiterals) { "\"slashes\"", format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10))); + EXPECT_EQ( + "\"split/\"\n" + "\"pathat/\"\n" + "\"slashes\"", + format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10))); + EXPECT_EQ("\"split at \"\n" + "\"spaces/at/\"\n" + "\"slashes.at.any$\"\n" + "\"non-alphanumeric%\"\n" + "\"1111111111characte\"\n" + "\"rs\"", + format("\"split at " + "spaces/at/" + "slashes.at." + "any$non-" + "alphanumeric%" + "1111111111characte" + "rs\"", + getLLVMStyleWithColumns(20))); + + // Verify that splitting the strings understands + // Style::AlwaysBreakBeforeMultilineStrings. + EXPECT_EQ("aaaaaaaaaaaa(aaaaaaaaaaaaa,\n" + " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa \"\n" + " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa\");", + format("aaaaaaaaaaaa(aaaaaaaaaaaaa, \"aaaaaaaaaaaaaaaaaaaaaa " + "aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa " + "aaaaaaaaaaaaaaaaaaaaaa\");", + getGoogleStyle())); + EXPECT_EQ("return \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" + " \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa\";", + format("return \"aaaaaaaaaaaaaaaaaaaaaa " + "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaa " + "aaaaaaaaaaaaaaaaaaaaaa\";", + getGoogleStyle())); + EXPECT_EQ("llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" + " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";", + format("llvm::outs() << " + "\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaa" + "aaaaaaaaaaaaaaaaaaa\";")); + EXPECT_EQ("ffff(\n" + " {\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n" + " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});", + format("ffff({\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa " + "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});", + getGoogleStyle())); + FormatStyle AlignLeft = getLLVMStyleWithColumns(12); AlignLeft.AlignEscapedNewlinesLeft = true; EXPECT_EQ( @@ -3852,6 +5954,177 @@ TEST_F(FormatTest, BreakStringLiterals) { format("#define A \"some text other\";", AlignLeft)); } +TEST_F(FormatTest, BreaksWideStringLiterals) { + EXPECT_EQ( + "u8\"utf8 string \"\n" + "u8\"literal\";", + format("u8\"utf8 string literal\";", getGoogleStyleWithColumns(16))); + EXPECT_EQ( + "u\"utf16 string \"\n" + "u\"literal\";", + format("u\"utf16 string literal\";", getGoogleStyleWithColumns(16))); + EXPECT_EQ( + "U\"utf32 string \"\n" + "U\"literal\";", + format("U\"utf32 string literal\";", getGoogleStyleWithColumns(16))); + EXPECT_EQ("L\"wide string \"\n" + "L\"literal\";", + format("L\"wide string literal\";", getGoogleStyleWithColumns(16))); +} + +TEST_F(FormatTest, BreaksRawStringLiterals) { + EXPECT_EQ("R\"x(raw )x\"\n" + "R\"x(literal)x\";", + format("R\"x(raw literal)x\";", getGoogleStyleWithColumns(15))); + EXPECT_EQ("uR\"x(raw )x\"\n" + "uR\"x(literal)x\";", + format("uR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); + EXPECT_EQ("u8R\"x(raw )x\"\n" + "u8R\"x(literal)x\";", + format("u8R\"x(raw literal)x\";", getGoogleStyleWithColumns(17))); + EXPECT_EQ("LR\"x(raw )x\"\n" + "LR\"x(literal)x\";", + format("LR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); + EXPECT_EQ("UR\"x(raw )x\"\n" + "UR\"x(literal)x\";", + format("UR\"x(raw literal)x\";", getGoogleStyleWithColumns(16))); +} + +TEST_F(FormatTest, BreaksStringLiteralsWithin_TMacro) { + FormatStyle Style = getLLVMStyleWithColumns(20); + EXPECT_EQ( + "_T(\"aaaaaaaaaaaaaa\")\n" + "_T(\"aaaaaaaaaaaaaa\")\n" + "_T(\"aaaaaaaaaaaa\")", + format(" _T(\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")", Style)); + EXPECT_EQ("f(x, _T(\"aaaaaaaaa\")\n" + " _T(\"aaaaaa\"),\n" + " z);", + format("f(x, _T(\"aaaaaaaaaaaaaaa\"), z);", Style)); + + // FIXME: Handle embedded spaces in one iteration. + // EXPECT_EQ("_T(\"aaaaaaaaaaaaa\")\n" + // "_T(\"aaaaaaaaaaaaa\")\n" + // "_T(\"aaaaaaaaaaaaa\")\n" + // "_T(\"a\")", + // format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", + // getLLVMStyleWithColumns(20))); + EXPECT_EQ( + "_T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", + format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", Style)); +} + +TEST_F(FormatTest, DontSplitStringLiteralsWithEscapedNewlines) { + EXPECT_EQ( + "aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";", + format("aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";")); +} + +TEST_F(FormatTest, CountsCharactersInMultilineRawStringLiterals) { + EXPECT_EQ("f(g(R\"x(raw literal)x\", a), b);", + format("f(g(R\"x(raw literal)x\", a), b);", getGoogleStyle())); + EXPECT_EQ("fffffffffff(g(R\"x(\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\",\n" + " a),\n" + " b);", + format("fffffffffff(g(R\"x(\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\", a), b);", + getGoogleStyleWithColumns(20))); + EXPECT_EQ("fffffffffff(\n" + " g(R\"x(qqq\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\",\n" + " a),\n" + " b);", + format("fffffffffff(g(R\"x(qqq\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\", a), b);", + getGoogleStyleWithColumns(20))); + + EXPECT_EQ("fffffffffff(R\"x(\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\");", + format("fffffffffff(R\"x(\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\");", + getGoogleStyleWithColumns(20))); + EXPECT_EQ("fffffffffff(R\"x(\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\" +\n" + " bbbbbb);", + format("fffffffffff(R\"x(\n" + "multiline raw string literal xxxxxxxxxxxxxx\n" + ")x\" + bbbbbb);", + getGoogleStyleWithColumns(20))); +} + +TEST_F(FormatTest, SkipsUnknownStringLiterals) { + verifyFormat("string a = \"unterminated;"); + EXPECT_EQ("function(\"unterminated,\n" + " OtherParameter);", + format("function( \"unterminated,\n" + " OtherParameter);")); +} + +TEST_F(FormatTest, DoesNotTryToParseUDLiteralsInPreCpp11Code) { + EXPECT_EQ("#define x(_a) printf(\"foo\" _a);", + format("#define x(_a) printf(\"foo\"_a);", getLLVMStyle())); +} + +TEST_F(FormatTest, BreakStringLiteralsBeforeUnbreakableTokenSequence) { + EXPECT_EQ("someFunction(\"aaabbbcccd\"\n" + " \"ddeeefff\");", + format("someFunction(\"aaabbbcccdddeeefff\");", + getLLVMStyleWithColumns(25))); + EXPECT_EQ("someFunction1234567890(\n" + " \"aaabbbcccdddeeefff\");", + format("someFunction1234567890(\"aaabbbcccdddeeefff\");", + getLLVMStyleWithColumns(26))); + EXPECT_EQ("someFunction1234567890(\n" + " \"aaabbbcccdddeeeff\"\n" + " \"f\");", + format("someFunction1234567890(\"aaabbbcccdddeeefff\");", + getLLVMStyleWithColumns(25))); + EXPECT_EQ("someFunction1234567890(\n" + " \"aaabbbcccdddeeeff\"\n" + " \"f\");", + format("someFunction1234567890(\"aaabbbcccdddeeefff\");", + getLLVMStyleWithColumns(24))); + EXPECT_EQ("someFunction(\"aaabbbcc \"\n" + " \"ddde \"\n" + " \"efff\");", + format("someFunction(\"aaabbbcc ddde efff\");", + getLLVMStyleWithColumns(25))); + EXPECT_EQ("someFunction(\"aaabbbccc \"\n" + " \"ddeeefff\");", + format("someFunction(\"aaabbbccc ddeeefff\");", + getLLVMStyleWithColumns(25))); + EXPECT_EQ("someFunction1234567890(\n" + " \"aaabb \"\n" + " \"cccdddeeefff\");", + format("someFunction1234567890(\"aaabb cccdddeeefff\");", + getLLVMStyleWithColumns(25))); + EXPECT_EQ("#define A \\\n" + " string s = \\\n" + " \"123456789\" \\\n" + " \"0\"; \\\n" + " int i;", + format("#define A string s = \"1234567890\"; int i;", + getLLVMStyleWithColumns(20))); + // FIXME: Put additional penalties on breaking at non-whitespace locations. + EXPECT_EQ("someFunction(\"aaabbbcc \"\n" + " \"dddeeeff\"\n" + " \"f\");", + format("someFunction(\"aaabbbcc dddeeefff\");", + getLLVMStyleWithColumns(25))); +} + TEST_F(FormatTest, DoNotBreakStringLiteralsInEscapeSequence) { EXPECT_EQ("\"\\a\"", format("\"\\a\"", getLLVMStyleWithColumns(3))); @@ -3888,8 +6161,11 @@ TEST_F(FormatTest, DoNotBreakStringLiteralsInEscapeSequence) { "\"00000000\"\n" "\"1\"", format("\"test\\000000000001\"", getLLVMStyleWithColumns(10))); - EXPECT_EQ("R\"(\\x\\x00)\"\n", - format("R\"(\\x\\x00)\"\n", getLLVMStyleWithColumns(7))); + // FIXME: We probably don't need to care about escape sequences in raw + // literals. + EXPECT_EQ("R\"(\\x)\"\n" + "R\"(\\x00)\"\n", + format("R\"(\\x\\x00)\"\n", getGoogleStyleWithColumns(7))); } TEST_F(FormatTest, DoNotCreateUnreasonableUnwrappedLines) { @@ -3899,12 +6175,1134 @@ TEST_F(FormatTest, DoNotCreateUnreasonableUnwrappedLines) { verifyFormat("if (foo)\n" " return { forgot_closing_brace();\n" "test();"); - verifyFormat("int a[] = { void forgot_closing_brace()\n" - "{\n" + verifyFormat("int a[] = { void forgot_closing_brace() { f();\n" + "g();\n" + "}"); +} + +TEST_F(FormatTest, FormatsClosingBracesInEmptyNestedBlocks) { + verifyFormat("class X {\n" + " void f() {\n" + " }\n" + "};", + getLLVMStyleWithColumns(12)); +} + +TEST_F(FormatTest, ConfigurableIndentWidth) { + FormatStyle EightIndent = getLLVMStyleWithColumns(18); + EightIndent.IndentWidth = 8; + verifyFormat("void f() {\n" + " someFunction();\n" + " if (true) {\n" + " f();\n" + " }\n" + "}", + EightIndent); + verifyFormat("class X {\n" + " void f() {\n" + " }\n" + "};", + EightIndent); + verifyFormat("int x[] = {\n" + " call(),\n" + " call(),\n" + "};", + EightIndent); +} + +TEST_F(FormatTest, ConfigurableFunctionDeclarationIndentAfterType) { + verifyFormat("void\n" + "f();", + getLLVMStyleWithColumns(8)); +} + +TEST_F(FormatTest, ConfigurableUseOfTab) { + FormatStyle Tab = getLLVMStyleWithColumns(42); + Tab.IndentWidth = 8; + Tab.UseTab = FormatStyle::UT_Always; + Tab.AlignEscapedNewlinesLeft = true; + + EXPECT_EQ("if (aaaaaaaa && // q\n" + " bb)\t\t// w\n" + "\t;", + format("if (aaaaaaaa &&// q\n" + "bb)// w\n" + ";", + Tab)); + EXPECT_EQ("if (aaa && bbb) // w\n" + "\t;", + format("if(aaa&&bbb)// w\n" + ";", + Tab)); + + verifyFormat("class X {\n" + "\tvoid f() {\n" + "\t\tsomeFunction(parameter1,\n" + "\t\t\t parameter2);\n" + "\t}\n" + "};", + Tab); + verifyFormat("#define A \\\n" + "\tvoid f() { \\\n" + "\t\tsomeFunction( \\\n" + "\t\t parameter1, \\\n" + "\t\t parameter2); \\\n" + "\t}", + Tab); + EXPECT_EQ("void f() {\n" + "\tf();\n" + "\tg();\n" + "}", + format("void f() {\n" + "\tf();\n" + "\tg();\n" + "}", + 0, 0, Tab)); + EXPECT_EQ("void f() {\n" + "\tf();\n" + "\tg();\n" + "}", + format("void f() {\n" + "\tf();\n" + "\tg();\n" + "}", + 16, 0, Tab)); + EXPECT_EQ("void f() {\n" + " \tf();\n" + "\tg();\n" + "}", + format("void f() {\n" + " \tf();\n" + " \tg();\n" + "}", + 21, 0, Tab)); + + Tab.TabWidth = 4; + Tab.IndentWidth = 8; + verifyFormat("class TabWidth4Indent8 {\n" + "\t\tvoid f() {\n" + "\t\t\t\tsomeFunction(parameter1,\n" + "\t\t\t\t\t\t\t parameter2);\n" + "\t\t}\n" + "};", + Tab); + + Tab.TabWidth = 4; + Tab.IndentWidth = 4; + verifyFormat("class TabWidth4Indent4 {\n" + "\tvoid f() {\n" + "\t\tsomeFunction(parameter1,\n" + "\t\t\t\t\t parameter2);\n" + "\t}\n" + "};", + Tab); + + Tab.TabWidth = 8; + Tab.IndentWidth = 4; + verifyFormat("class TabWidth8Indent4 {\n" + " void f() {\n" + "\tsomeFunction(parameter1,\n" + "\t\t parameter2);\n" + " }\n" + "};", + Tab); + + Tab.TabWidth = 8; + Tab.IndentWidth = 8; + EXPECT_EQ("/*\n" + "\t a\t\tcomment\n" + "\t in multiple lines\n" + " */", + format(" /*\t \t \n" + " \t \t a\t\tcomment\t \t\n" + " \t \t in multiple lines\t\n" + " \t */", + Tab)); + + Tab.UseTab = FormatStyle::UT_ForIndentation; + verifyFormat("T t[] = {\n" + "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n" + "\taaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n" + "};", + Tab); + verifyFormat("enum A {\n" + "\ta1,\n" + "\ta2,\n" + "\ta3\n" + "};", + Tab); + EXPECT_EQ("if (aaaaaaaa && // q\n" + " bb) // w\n" + "\t;", + format("if (aaaaaaaa &&// q\n" + "bb)// w\n" + ";", + Tab)); + verifyFormat("class X {\n" + "\tvoid f() {\n" + "\t\tsomeFunction(parameter1,\n" + "\t\t parameter2);\n" + "\t}\n" + "};", + Tab); + verifyFormat("{\n" + "\tQ({\n" + "\t\t int a;\n" + "\t\t someFunction(aaaaaaaaaa,\n" + "\t\t bbbbbbbbb);\n" + "\t },\n" + "\t p);\n" + "}", + Tab); + EXPECT_EQ("{\n" + "\t/* aaaa\n" + "\t bbbb */\n" + "}", + format("{\n" + "/* aaaa\n" + " bbbb */\n" + "}", + Tab)); + EXPECT_EQ("{\n" + "\t/*\n" + "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n" + "\t bbbbbbbbbbbbb\n" + "\t*/\n" + "}", + format("{\n" + "/*\n" + " aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" + "*/\n" + "}", + Tab)); + EXPECT_EQ("{\n" + "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa\n" + "\t// bbbbbbbbbbbbb\n" + "}", + format("{\n" + "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" + "}", + Tab)); + EXPECT_EQ("{\n" + "\t/*\n" + "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n" + "\t bbbbbbbbbbbbb\n" + "\t*/\n" + "}", + format("{\n" + "\t/*\n" + "\t aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n" + "\t*/\n" + "}", + Tab)); + EXPECT_EQ("{\n" + "\t/*\n" + "\n" + "\t*/\n" + "}", + format("{\n" + "\t/*\n" + "\n" + "\t*/\n" + "}", + Tab)); + EXPECT_EQ("{\n" + "\t/*\n" + " asdf\n" + "\t*/\n" + "}", + format("{\n" + "\t/*\n" + " asdf\n" + "\t*/\n" + "}", + Tab)); + + Tab.UseTab = FormatStyle::UT_Never; + EXPECT_EQ("/*\n" + " a\t\tcomment\n" + " in multiple lines\n" + " */", + format(" /*\t \t \n" + " \t \t a\t\tcomment\t \t\n" + " \t \t in multiple lines\t\n" + " \t */", + Tab)); + EXPECT_EQ("/* some\n" + " comment */", + format(" \t \t /* some\n" + " \t \t comment */", + Tab)); + EXPECT_EQ("int a; /* some\n" + " comment */", + format(" \t \t int a; /* some\n" + " \t \t comment */", + Tab)); + + EXPECT_EQ("int a; /* some\n" + "comment */", + format(" \t \t int\ta; /* some\n" + " \t \t comment */", + Tab)); + EXPECT_EQ("f(\"\t\t\"); /* some\n" + " comment */", + format(" \t \t f(\"\t\t\"); /* some\n" + " \t \t comment */", + Tab)); + EXPECT_EQ("{\n" + " /*\n" + " * Comment\n" + " */\n" + " int i;\n" + "}", + format("{\n" + "\t/*\n" + "\t * Comment\n" + "\t */\n" + "\t int i;\n" + "}")); +} + +TEST_F(FormatTest, CalculatesOriginalColumn) { + EXPECT_EQ("\"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" + "q\"; /* some\n" + " comment */", + format(" \"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" + "q\"; /* some\n" + " comment */", + getLLVMStyle())); + EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n" + "/* some\n" + " comment */", + format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n" + " /* some\n" + " comment */", + getLLVMStyle())); + EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" + "qqq\n" + "/* some\n" + " comment */", + format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" + "qqq\n" + " /* some\n" + " comment */", + getLLVMStyle())); + EXPECT_EQ("inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" + "wwww; /* some\n" + " comment */", + format(" inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n" + "wwww; /* some\n" + " comment */", + getLLVMStyle())); +} + +TEST_F(FormatTest, ConfigurableSpaceAfterControlStatementKeyword) { + FormatStyle NoSpace = getLLVMStyle(); + NoSpace.SpaceAfterControlStatementKeyword = false; + + verifyFormat("while(true)\n" + " continue;", NoSpace); + verifyFormat("for(;;)\n" + " continue;", NoSpace); + verifyFormat("if(true)\n" " f();\n" - " g();\n" + "else if(true)\n" + " f();", NoSpace); + verifyFormat("do {\n" + " do_something();\n" + "} while(something());", NoSpace); + verifyFormat("switch(x) {\n" + "default:\n" + " break;\n" + "}", NoSpace); +} + +TEST_F(FormatTest, ConfigurableSpacesInParentheses) { + FormatStyle Spaces = getLLVMStyle(); + + Spaces.SpacesInParentheses = true; + verifyFormat("call( x, y, z );", Spaces); + verifyFormat("while ( (bool)1 )\n" + " continue;", Spaces); + verifyFormat("for ( ;; )\n" + " continue;", Spaces); + verifyFormat("if ( true )\n" + " f();\n" + "else if ( true )\n" + " f();", Spaces); + verifyFormat("do {\n" + " do_something( (int)i );\n" + "} while ( something() );", Spaces); + verifyFormat("switch ( x ) {\n" + "default:\n" + " break;\n" + "}", Spaces); + + Spaces.SpacesInParentheses = false; + Spaces.SpacesInCStyleCastParentheses = true; + verifyFormat("Type *A = ( Type * )P;", Spaces); + verifyFormat("Type *A = ( vector<Type *, int *> )P;", Spaces); + verifyFormat("x = ( int32 )y;", Spaces); + verifyFormat("int a = ( int )(2.0f);", Spaces); + verifyFormat("#define AA(X) sizeof((( X * )NULL)->a)", Spaces); + verifyFormat("my_int a = ( my_int )sizeof(int);", Spaces); + verifyFormat("#define x (( int )-1)", Spaces); + + Spaces.SpacesInParentheses = false; + Spaces.SpaceInEmptyParentheses = true; + verifyFormat("call(x, y, z);", Spaces); + verifyFormat("call( )", Spaces); + + // Run the first set of tests again with + // Spaces.SpacesInParentheses = false, + // Spaces.SpaceInEmptyParentheses = true and + // Spaces.SpacesInCStyleCastParentheses = true + Spaces.SpacesInParentheses = false, + Spaces.SpaceInEmptyParentheses = true; + Spaces.SpacesInCStyleCastParentheses = true; + verifyFormat("call(x, y, z);", Spaces); + verifyFormat("while (( bool )1)\n" + " continue;", Spaces); + verifyFormat("for (;;)\n" + " continue;", Spaces); + verifyFormat("if (true)\n" + " f( );\n" + "else if (true)\n" + " f( );", Spaces); + verifyFormat("do {\n" + " do_something(( int )i);\n" + "} while (something( ));", Spaces); + verifyFormat("switch (x) {\n" + "default:\n" + " break;\n" + "}", Spaces); +} + +TEST_F(FormatTest, ConfigurableSpaceBeforeAssignmentOperators) { + verifyFormat("int a = 5;"); + verifyFormat("a += 42;"); + verifyFormat("a or_eq 8;"); + + FormatStyle Spaces = getLLVMStyle(); + Spaces.SpaceBeforeAssignmentOperators = false; + verifyFormat("int a= 5;", Spaces); + verifyFormat("a+= 42;", Spaces); + verifyFormat("a or_eq 8;", Spaces); +} + +TEST_F(FormatTest, LinuxBraceBreaking) { + FormatStyle BreakBeforeBrace = getLLVMStyle(); + BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Linux; + verifyFormat("namespace a\n" + "{\n" + "class A\n" + "{\n" + " void f()\n" + " {\n" + " if (true) {\n" + " a();\n" + " b();\n" + " }\n" + " }\n" + " void g()\n" + " {\n" + " return;\n" + " }\n" + "}\n" + "}", + BreakBeforeBrace); +} + +TEST_F(FormatTest, StroustrupBraceBreaking) { + FormatStyle BreakBeforeBrace = getLLVMStyle(); + BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Stroustrup; + verifyFormat("namespace a {\n" + "class A {\n" + " void f()\n" + " {\n" + " if (true) {\n" + " a();\n" + " b();\n" + " }\n" + " }\n" + " void g()\n" + " {\n" + " return;\n" + " }\n" + "}\n" + "}", + BreakBeforeBrace); +} + +TEST_F(FormatTest, AllmanBraceBreaking) { + FormatStyle BreakBeforeBrace = getLLVMStyle(); + BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Allman; + verifyFormat("namespace a\n" + "{\n" + "class A\n" + "{\n" + " void f()\n" + " {\n" + " if (true)\n" + " {\n" + " a();\n" + " b();\n" + " }\n" + " }\n" + " void g()\n" + " {\n" + " return;\n" + " }\n" + "}\n" + "}", + BreakBeforeBrace); + + verifyFormat("void f()\n" + "{\n" + " if (true)\n" + " {\n" + " a();\n" + " }\n" + " else if (false)\n" + " {\n" + " b();\n" + " }\n" + " else\n" + " {\n" + " c();\n" + " }\n" + "}\n", + BreakBeforeBrace); + + verifyFormat("void f()\n" + "{\n" + " for (int i = 0; i < 10; ++i)\n" + " {\n" + " a();\n" + " }\n" + " while (false)\n" + " {\n" + " b();\n" + " }\n" + " do\n" + " {\n" + " c();\n" + " } while (false)\n" + "}\n", + BreakBeforeBrace); + + verifyFormat("void f(int a)\n" + "{\n" + " switch (a)\n" + " {\n" + " case 0:\n" + " break;\n" + " case 1:\n" + " {\n" + " break;\n" + " }\n" + " case 2:\n" + " {\n" + " }\n" + " break;\n" + " default:\n" + " break;\n" + " }\n" + "}\n", + BreakBeforeBrace); + + verifyFormat("enum X\n" + "{\n" + " Y = 0,\n" + "}\n", + BreakBeforeBrace); + + FormatStyle BreakBeforeBraceShortIfs = BreakBeforeBrace; + BreakBeforeBraceShortIfs.AllowShortIfStatementsOnASingleLine = true; + BreakBeforeBraceShortIfs.AllowShortLoopsOnASingleLine = true; + verifyFormat("void f(bool b)\n" + "{\n" + " if (b)\n" + " {\n" + " return;\n" + " }\n" + "}\n", + BreakBeforeBraceShortIfs); + verifyFormat("void f(bool b)\n" + "{\n" + " if (b) return;\n" + "}\n", + BreakBeforeBraceShortIfs); + verifyFormat("void f(bool b)\n" + "{\n" + " while (b)\n" + " {\n" + " return;\n" + " }\n" + "}\n", + BreakBeforeBraceShortIfs); +} + +TEST_F(FormatTest, CatchExceptionReferenceBinding) { + verifyFormat("void f() {\n" + " try {\n" + " }\n" + " catch (const Exception &e) {\n" + " }\n" + "}\n", + getLLVMStyle()); +} + +TEST_F(FormatTest, UnderstandsPragmas) { + verifyFormat("#pragma omp reduction(| : var)"); + verifyFormat("#pragma omp reduction(+ : var)"); +} + +bool allStylesEqual(ArrayRef<FormatStyle> Styles) { + for (size_t i = 1; i < Styles.size(); ++i) + if (!(Styles[0] == Styles[i])) + return false; + return true; +} + +TEST_F(FormatTest, GetsPredefinedStyleByName) { + FormatStyle Styles[3]; + + Styles[0] = getLLVMStyle(); + EXPECT_TRUE(getPredefinedStyle("LLVM", &Styles[1])); + EXPECT_TRUE(getPredefinedStyle("lLvM", &Styles[2])); + EXPECT_TRUE(allStylesEqual(Styles)); + + Styles[0] = getGoogleStyle(); + EXPECT_TRUE(getPredefinedStyle("Google", &Styles[1])); + EXPECT_TRUE(getPredefinedStyle("gOOgle", &Styles[2])); + EXPECT_TRUE(allStylesEqual(Styles)); + + Styles[0] = getChromiumStyle(); + EXPECT_TRUE(getPredefinedStyle("Chromium", &Styles[1])); + EXPECT_TRUE(getPredefinedStyle("cHRoMiUM", &Styles[2])); + EXPECT_TRUE(allStylesEqual(Styles)); + + Styles[0] = getMozillaStyle(); + EXPECT_TRUE(getPredefinedStyle("Mozilla", &Styles[1])); + EXPECT_TRUE(getPredefinedStyle("moZILla", &Styles[2])); + EXPECT_TRUE(allStylesEqual(Styles)); + + Styles[0] = getWebKitStyle(); + EXPECT_TRUE(getPredefinedStyle("WebKit", &Styles[1])); + EXPECT_TRUE(getPredefinedStyle("wEbKit", &Styles[2])); + EXPECT_TRUE(allStylesEqual(Styles)); + + EXPECT_FALSE(getPredefinedStyle("qwerty", &Styles[0])); +} + +TEST_F(FormatTest, ParsesConfiguration) { + FormatStyle Style = {}; +#define CHECK_PARSE(TEXT, FIELD, VALUE) \ + EXPECT_NE(VALUE, Style.FIELD); \ + EXPECT_EQ(0, parseConfiguration(TEXT, &Style).value()); \ + EXPECT_EQ(VALUE, Style.FIELD) + +#define CHECK_PARSE_BOOL(FIELD) \ + Style.FIELD = false; \ + EXPECT_EQ(0, parseConfiguration(#FIELD ": true", &Style).value()); \ + EXPECT_TRUE(Style.FIELD); \ + EXPECT_EQ(0, parseConfiguration(#FIELD ": false", &Style).value()); \ + EXPECT_FALSE(Style.FIELD); + + CHECK_PARSE_BOOL(AlignEscapedNewlinesLeft); + CHECK_PARSE_BOOL(AlignTrailingComments); + CHECK_PARSE_BOOL(AllowAllParametersOfDeclarationOnNextLine); + CHECK_PARSE_BOOL(AllowShortIfStatementsOnASingleLine); + CHECK_PARSE_BOOL(AllowShortLoopsOnASingleLine); + CHECK_PARSE_BOOL(AlwaysBreakTemplateDeclarations); + CHECK_PARSE_BOOL(BinPackParameters); + CHECK_PARSE_BOOL(BreakBeforeBinaryOperators); + CHECK_PARSE_BOOL(BreakBeforeTernaryOperators); + CHECK_PARSE_BOOL(BreakConstructorInitializersBeforeComma); + CHECK_PARSE_BOOL(ConstructorInitializerAllOnOneLineOrOnePerLine); + CHECK_PARSE_BOOL(DerivePointerBinding); + CHECK_PARSE_BOOL(IndentCaseLabels); + CHECK_PARSE_BOOL(ObjCSpaceBeforeProtocolList); + CHECK_PARSE_BOOL(PointerBindsToType); + CHECK_PARSE_BOOL(Cpp11BracedListStyle); + CHECK_PARSE_BOOL(IndentFunctionDeclarationAfterType); + CHECK_PARSE_BOOL(SpacesInParentheses); + CHECK_PARSE_BOOL(SpacesInAngles); + CHECK_PARSE_BOOL(SpaceInEmptyParentheses); + CHECK_PARSE_BOOL(SpacesInCStyleCastParentheses); + CHECK_PARSE_BOOL(SpaceAfterControlStatementKeyword); + CHECK_PARSE_BOOL(SpaceBeforeAssignmentOperators); + + CHECK_PARSE("AccessModifierOffset: -1234", AccessModifierOffset, -1234); + CHECK_PARSE("ConstructorInitializerIndentWidth: 1234", + ConstructorInitializerIndentWidth, 1234u); + CHECK_PARSE("ColumnLimit: 1234", ColumnLimit, 1234u); + CHECK_PARSE("MaxEmptyLinesToKeep: 1234", MaxEmptyLinesToKeep, 1234u); + CHECK_PARSE("PenaltyBreakBeforeFirstCallParameter: 1234", + PenaltyBreakBeforeFirstCallParameter, 1234u); + CHECK_PARSE("PenaltyExcessCharacter: 1234", PenaltyExcessCharacter, 1234u); + CHECK_PARSE("PenaltyReturnTypeOnItsOwnLine: 1234", + PenaltyReturnTypeOnItsOwnLine, 1234u); + CHECK_PARSE("SpacesBeforeTrailingComments: 1234", + SpacesBeforeTrailingComments, 1234u); + CHECK_PARSE("IndentWidth: 32", IndentWidth, 32u); + CHECK_PARSE("ContinuationIndentWidth: 11", ContinuationIndentWidth, 11u); + + Style.Standard = FormatStyle::LS_Auto; + CHECK_PARSE("Standard: Cpp03", Standard, FormatStyle::LS_Cpp03); + CHECK_PARSE("Standard: Cpp11", Standard, FormatStyle::LS_Cpp11); + CHECK_PARSE("Standard: C++03", Standard, FormatStyle::LS_Cpp03); + CHECK_PARSE("Standard: C++11", Standard, FormatStyle::LS_Cpp11); + CHECK_PARSE("Standard: Auto", Standard, FormatStyle::LS_Auto); + + Style.UseTab = FormatStyle::UT_ForIndentation; + CHECK_PARSE("UseTab: false", UseTab, FormatStyle::UT_Never); + CHECK_PARSE("UseTab: true", UseTab, FormatStyle::UT_Always); + CHECK_PARSE("UseTab: Never", UseTab, FormatStyle::UT_Never); + CHECK_PARSE("UseTab: ForIndentation", UseTab, FormatStyle::UT_ForIndentation); + CHECK_PARSE("UseTab: Always", UseTab, FormatStyle::UT_Always); + + Style.ColumnLimit = 123; + FormatStyle BaseStyle = getLLVMStyle(); + CHECK_PARSE("BasedOnStyle: LLVM", ColumnLimit, BaseStyle.ColumnLimit); + CHECK_PARSE("BasedOnStyle: LLVM\nColumnLimit: 1234", ColumnLimit, 1234u); + + Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup; + CHECK_PARSE("BreakBeforeBraces: Attach", BreakBeforeBraces, + FormatStyle::BS_Attach); + CHECK_PARSE("BreakBeforeBraces: Linux", BreakBeforeBraces, + FormatStyle::BS_Linux); + CHECK_PARSE("BreakBeforeBraces: Stroustrup", BreakBeforeBraces, + FormatStyle::BS_Stroustrup); + + Style.NamespaceIndentation = FormatStyle::NI_All; + CHECK_PARSE("NamespaceIndentation: None", NamespaceIndentation, + FormatStyle::NI_None); + CHECK_PARSE("NamespaceIndentation: Inner", NamespaceIndentation, + FormatStyle::NI_Inner); + CHECK_PARSE("NamespaceIndentation: All", NamespaceIndentation, + FormatStyle::NI_All); + +#undef CHECK_PARSE +#undef CHECK_PARSE_BOOL +} + +TEST_F(FormatTest, ConfigurationRoundTripTest) { + FormatStyle Style = getLLVMStyle(); + std::string YAML = configurationAsText(Style); + FormatStyle ParsedStyle = {}; + EXPECT_EQ(0, parseConfiguration(YAML, &ParsedStyle).value()); + EXPECT_EQ(Style, ParsedStyle); +} + +TEST_F(FormatTest, WorksFor8bitEncodings) { + EXPECT_EQ("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 \"\n" + "\"\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \"\n" + "\"\xe7\xe8\xec\xed\xfe\xfe \"\n" + "\"\xef\xee\xf0\xf3...\"", + format("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 " + "\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \xe7\xe8\xec\xed\xfe\xfe " + "\xef\xee\xf0\xf3...\"", + getLLVMStyleWithColumns(12))); +} + +TEST_F(FormatTest, HandlesUTF8BOM) { + EXPECT_EQ("\xef\xbb\xbf", format("\xef\xbb\xbf")); + EXPECT_EQ("\xef\xbb\xbf#include <iostream>", + format("\xef\xbb\xbf#include <iostream>")); + EXPECT_EQ("\xef\xbb\xbf\n#include <iostream>", + format("\xef\xbb\xbf\n#include <iostream>")); +} + +// FIXME: Encode Cyrillic and CJK characters below to appease MS compilers. +#if !defined(_MSC_VER) + +TEST_F(FormatTest, CountsUTF8CharactersProperly) { + verifyFormat("\"Однажды в студёную зимнюю пору...\"", + getLLVMStyleWithColumns(35)); + verifyFormat("\"一 二 三 四 五 六 七 八 九 十\"", + getLLVMStyleWithColumns(31)); + verifyFormat("// Однажды в студёную зимнюю пору...", + getLLVMStyleWithColumns(36)); + verifyFormat("// 一 二 三 四 五 六 七 八 九 十", + getLLVMStyleWithColumns(32)); + verifyFormat("/* Однажды в студёную зимнюю пору... */", + getLLVMStyleWithColumns(39)); + verifyFormat("/* 一 二 三 四 五 六 七 八 九 十 */", + getLLVMStyleWithColumns(35)); +} + +TEST_F(FormatTest, SplitsUTF8Strings) { + EXPECT_EQ( + "\"Однажды, в \"\n" + "\"студёную \"\n" + "\"зимнюю \"\n" + "\"пору,\"", + format("\"Однажды, в студёную зимнюю пору,\"", + getLLVMStyleWithColumns(13))); + EXPECT_EQ("\"一 二 三 \"\n" + "\"四 五六 \"\n" + "\"七 八 九 \"\n" + "\"十\"", + format("\"一 二 三 四 五六 七 八 九 十\"", + getLLVMStyleWithColumns(11))); + EXPECT_EQ("\"一\t二 \"\n" + "\"\t三 \"\n" + "\"四 五\t六 \"\n" + "\"\t七 \"\n" + "\"八九十\tqq\"", + format("\"一\t二 \t三 四 五\t六 \t七 八九十\tqq\"", + getLLVMStyleWithColumns(11))); +} + + +TEST_F(FormatTest, HandlesDoubleWidthCharsInMultiLineStrings) { + EXPECT_EQ("const char *sssss =\n" + " \"一二三四五六七八\\\n" + " 九 十\";", + format("const char *sssss = \"一二三四五六七八\\\n" + " 九 十\";", + getLLVMStyleWithColumns(30))); +} + +TEST_F(FormatTest, SplitsUTF8LineComments) { + EXPECT_EQ("// Я из лесу\n" + "// вышел; был\n" + "// сильный\n" + "// мороз.", + format("// Я из лесу вышел; был сильный мороз.", + getLLVMStyleWithColumns(13))); + EXPECT_EQ("// 一二三\n" + "// 四五六七\n" + "// 八 九\n" + "// 十", + format("// 一二三 四五六七 八 九 十", getLLVMStyleWithColumns(9))); +} + +TEST_F(FormatTest, SplitsUTF8BlockComments) { + EXPECT_EQ("/* Гляжу,\n" + " * поднимается\n" + " * медленно в\n" + " * гору\n" + " * Лошадка,\n" + " * везущая\n" + " * хворосту\n" + " * воз. */", + format("/* Гляжу, поднимается медленно в гору\n" + " * Лошадка, везущая хворосту воз. */", + getLLVMStyleWithColumns(13))); + EXPECT_EQ( + "/* 一二三\n" + " * 四五六七\n" + " * 八 九\n" + " * 十 */", + format("/* 一二三 四五六七 八 九 十 */", getLLVMStyleWithColumns(9))); + EXPECT_EQ("/* 𝓣𝓮𝓼𝓽 𝔣𝔬𝔲𝔯\n" + " * 𝕓𝕪𝕥𝕖\n" + " * 𝖀𝕿𝕱-𝟠 */", + format("/* 𝓣𝓮𝓼𝓽 𝔣𝔬𝔲𝔯 𝕓𝕪𝕥𝕖 𝖀𝕿𝕱-𝟠 */", getLLVMStyleWithColumns(12))); +} + +#endif // _MSC_VER + +TEST_F(FormatTest, ConstructorInitializerIndentWidth) { + FormatStyle Style = getLLVMStyle(); + + Style.ConstructorInitializerIndentWidth = 4; + verifyFormat( + "SomeClass::Constructor()\n" + " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", + Style); + + Style.ConstructorInitializerIndentWidth = 2; + verifyFormat( + "SomeClass::Constructor()\n" + " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", + Style); + + Style.ConstructorInitializerIndentWidth = 0; + verifyFormat( + "SomeClass::Constructor()\n" + ": aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n" + " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}", + Style); + + Style.BreakConstructorInitializersBeforeComma = true; + Style.ConstructorInitializerIndentWidth = 4; + verifyFormat("SomeClass::Constructor()\n" + " : a(a)\n" + " , b(b)\n" + " , c(c) {}", + Style); + + Style.ConstructorInitializerIndentWidth = 2; + verifyFormat("SomeClass::Constructor()\n" + " : a(a)\n" + " , b(b)\n" + " , c(c) {}", + Style); + + Style.ConstructorInitializerIndentWidth = 0; + verifyFormat("SomeClass::Constructor()\n" + ": a(a)\n" + ", b(b)\n" + ", c(c) {}", + Style); + + Style.ConstructorInitializerAllOnOneLineOrOnePerLine = true; + Style.ConstructorInitializerIndentWidth = 4; + verifyFormat( + "SomeClass::Constructor()\n" + " : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa) {}", + Style); + Style.ConstructorInitializerIndentWidth = 4; + Style.ColumnLimit = 60; + verifyFormat("SomeClass::Constructor()\n" + " : aaaaaaaa(aaaaaaaa)\n" + " , aaaaaaaa(aaaaaaaa)\n" + " , aaaaaaaa(aaaaaaaa) {}", + Style); +} + +TEST_F(FormatTest, FormatsWithWebKitStyle) { + FormatStyle Style = getWebKitStyle(); + + // Don't indent in outer namespaces. + verifyFormat("namespace outer {\n" + "int i;\n" + "namespace inner {\n" + " int i;\n" + "} // namespace inner\n" + "} // namespace outer\n" + "namespace other_outer {\n" + "int i;\n" + "}", + Style); + + // Don't indent case labels. + verifyFormat("switch (variable) {\n" + "case 1:\n" + "case 2:\n" + " doSomething();\n" + " break;\n" + "default:\n" + " ++variable;\n" + "}", + Style); + + // Wrap before binary operators. + EXPECT_EQ( + "void f()\n" + "{\n" + " if (aaaaaaaaaaaaaaaa\n" + " && bbbbbbbbbbbbbbbbbbbbbbbb\n" + " && (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n" + " return;\n" + "}", + format( + "void f() {\n" + "if (aaaaaaaaaaaaaaaa\n" + "&& bbbbbbbbbbbbbbbbbbbbbbbb\n" + "&& (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n" + "return;\n" + "}", + Style)); + + // Constructor initializers are formatted one per line with the "," on the + // new line. + verifyFormat("Constructor()\n" + " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa)\n" + " , aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaa, // break\n" + " aaaaaaaaaaaaaa)\n" + " , aaaaaaaaaaaaaaaaaaaaaaa()\n{\n}", + Style); + + // Access specifiers should be aligned left. + verifyFormat("class C {\n" + "public:\n" + " int i;\n" + "};", + Style); + + // Do not align comments. + verifyFormat("int a; // Do not\n" + "double b; // align comments.", + Style); + + // Accept input's line breaks. + EXPECT_EQ("if (aaaaaaaaaaaaaaa\n" + " || bbbbbbbbbbbbbbb) {\n" + " i++;\n" + "}", + format("if (aaaaaaaaaaaaaaa\n" + "|| bbbbbbbbbbbbbbb) { i++; }", + Style)); + EXPECT_EQ("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) {\n" + " i++;\n" + "}", + format("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) { i++; }", Style)); + + // Don't automatically break all macro definitions (llvm.org/PR17842). + verifyFormat("#define aNumber 10", Style); + // However, generally keep the line breaks that the user authored. + EXPECT_EQ("#define aNumber \\\n" + " 10", + format("#define aNumber \\\n" + " 10", + Style)); +} + +TEST_F(FormatTest, FormatsProtocolBufferDefinitions) { + // It seems that clang-format can format protocol buffer definitions + // (see https://code.google.com/p/protobuf/). + verifyFormat("message SomeMessage {\n" + " required int32 field1 = 1;\n" + " optional string field2 = 2 [default = \"2\"]\n" "}"); } +TEST_F(FormatTest, FormatsLambdas) { + verifyFormat("int c = [b]() mutable {\n" + " return [&b] { return b++; }();\n" + "}();\n"); + verifyFormat("int c = [&] {\n" + " [=] { return b++; }();\n" + "}();\n"); + verifyFormat("int c = [&, &a, a] {\n" + " [=, c, &d] { return b++; }();\n" + "}();\n"); + verifyFormat("int c = [&a, &a, a] {\n" + " [=, a, b, &c] { return b++; }();\n" + "}();\n"); + verifyFormat("auto c = { [&a, &a, a] {\n" + " [=, a, b, &c] { return b++; }();\n" + "} }\n"); + verifyFormat("auto c = { [&a, &a, a] { [=, a, b, &c] {}(); } }\n"); + verifyFormat("void f() {\n" + " other(x.begin(), x.end(), [&](int, int) { return 1; });\n" + "}\n"); + verifyFormat("void f() {\n" + " other(x.begin(), //\n" + " x.end(), //\n" + " [&](int, int) { return 1; });\n" + "}\n"); + + // Not lambdas. + verifyFormat("constexpr char hello[]{ \"hello\" };"); + verifyFormat("double &operator[](int i) { return 0; }\n" + "int i;"); +} + +TEST_F(FormatTest, FormatsBlocks) { + // FIXME: Make whitespace formatting consistent. Ask a ObjC dev how + // it would ideally look. + verifyFormat("[operation setCompletionBlock:^{ [self onOperationDone]; }];"); + verifyFormat("int i = {[operation setCompletionBlock : ^{ [self " + "onOperationDone]; }] };"); +} + +TEST_F(FormatTest, SupportsCRLF) { + EXPECT_EQ("int a;\r\n" + "int b;\r\n" + "int c;\r\n", + format("int a;\r\n" + " int b;\r\n" + " int c;\r\n", + getLLVMStyle())); + EXPECT_EQ("int a;\r\n" + "int b;\r\n" + "int c;\r\n", + format("int a;\r\n" + " int b;\n" + " int c;\r\n", + getLLVMStyle())); + EXPECT_EQ("int a;\n" + "int b;\n" + "int c;\n", + format("int a;\r\n" + " int b;\n" + " int c;\n", + getLLVMStyle())); + EXPECT_EQ("\"aaaaaaa \"\r\n" + "\"bbbbbbb\";\r\n", + format("\"aaaaaaa bbbbbbb\";\r\n", getLLVMStyleWithColumns(10))); + EXPECT_EQ("#define A \\\r\n" + " b; \\\r\n" + " c; \\\r\n" + " d;\r\n", + format("#define A \\\r\n" + " b; \\\r\n" + " c; d; \r\n", + getGoogleStyle())); + + EXPECT_EQ("/*\r\n" + "multi line block comments\r\n" + "should not introduce\r\n" + "an extra carriage return\r\n" + "*/\r\n", + format("/*\r\n" + "multi line block comments\r\n" + "should not introduce\r\n" + "an extra carriage return\r\n" + "*/\r\n")); +} + +TEST_F(FormatTest, MunchSemicolonAfterBlocks) { + verifyFormat("MY_CLASS(C) {\n" + " int i;\n" + " int j;\n" + "};"); +} + +TEST_F(FormatTest, ConfigurableContinuationIndentWidth) { + FormatStyle TwoIndent = getLLVMStyleWithColumns(15); + TwoIndent.ContinuationIndentWidth = 2; + + EXPECT_EQ("int i =\n" + " longFunction(\n" + " arg);", + format("int i = longFunction(arg);", TwoIndent)); + + FormatStyle SixIndent = getLLVMStyleWithColumns(20); + SixIndent.ContinuationIndentWidth = 6; + + EXPECT_EQ("int i =\n" + " longFunction(\n" + " arg);", + format("int i = longFunction(arg);", SixIndent)); +} + +TEST_F(FormatTest, SpacesInAngles) { + FormatStyle Spaces = getLLVMStyle(); + Spaces.SpacesInAngles = true; + + verifyFormat("static_cast< int >(arg);", Spaces); + verifyFormat("template < typename T0, typename T1 > void f() {}", Spaces); + verifyFormat("f< int, float >();", Spaces); + verifyFormat("template <> g() {}", Spaces); + verifyFormat("template < std::vector< int > > f() {}", Spaces); + + Spaces.Standard = FormatStyle::LS_Cpp03; + Spaces.SpacesInAngles = true; + verifyFormat("A< A< int > >();", Spaces); + + Spaces.SpacesInAngles = false; + verifyFormat("A<A<int> >();", Spaces); + + Spaces.Standard = FormatStyle::LS_Cpp11; + Spaces.SpacesInAngles = true; + verifyFormat("A< A< int > >();", Spaces); + + Spaces.SpacesInAngles = false; + verifyFormat("A<A<int>>();", Spaces); +} + } // end namespace tooling } // end namespace clang diff --git a/unittests/Format/Makefile b/unittests/Format/Makefile index e9d0cbb..7de127c 100644 --- a/unittests/Format/Makefile +++ b/unittests/Format/Makefile @@ -10,7 +10,7 @@ CLANG_LEVEL = ../.. TESTNAME = Format include $(CLANG_LEVEL)/../../Makefile.config -LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc +LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option USEDLIBS = clangFormat.a clangTooling.a clangFrontend.a clangSerialization.a \ clangDriver.a clangParse.a clangRewriteCore.a \ clangRewriteFrontend.a clangSema.a clangAnalysis.a clangEdit.a \ diff --git a/unittests/Frontend/Makefile b/unittests/Frontend/Makefile index f61791b..7de9fb4 100644 --- a/unittests/Frontend/Makefile +++ b/unittests/Frontend/Makefile @@ -10,7 +10,7 @@ CLANG_LEVEL = ../.. TESTNAME = Frontend include $(CLANG_LEVEL)/../../Makefile.config -LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc +LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option USEDLIBS = clangFrontendTool.a clangFrontend.a clangDriver.a \ clangSerialization.a clangCodeGen.a clangParse.a clangSema.a \ clangStaticAnalyzerCheckers.a clangStaticAnalyzerCore.a \ diff --git a/unittests/Lex/CMakeLists.txt b/unittests/Lex/CMakeLists.txt index 78838c0..cb3b927 100644 --- a/unittests/Lex/CMakeLists.txt +++ b/unittests/Lex/CMakeLists.txt @@ -5,5 +5,5 @@ add_clang_unittest(LexTests ) target_link_libraries(LexTests - clangLex + clangLex clangParse clangSema ) diff --git a/unittests/Lex/LexerTest.cpp b/unittests/Lex/LexerTest.cpp index c9b1840..40ce928 100644 --- a/unittests/Lex/LexerTest.cpp +++ b/unittests/Lex/LexerTest.cpp @@ -28,6 +28,20 @@ using namespace clang; namespace { +class VoidModuleLoader : public ModuleLoader { + virtual ModuleLoadResult loadModule(SourceLocation ImportLoc, + ModuleIdPath Path, + Module::NameVisibilityKind Visibility, + bool IsInclusionDirective) { + return ModuleLoadResult(); + } + + virtual void makeModuleVisible(Module *Mod, + Module::NameVisibilityKind Visibility, + SourceLocation ImportLoc, + bool Complain) { } +}; + // The test fixture. class LexerTest : public ::testing::Test { protected: @@ -42,6 +56,48 @@ protected: Target = TargetInfo::CreateTargetInfo(Diags, &*TargetOpts); } + std::vector<Token> CheckLex(StringRef Source, + ArrayRef<tok::TokenKind> ExpectedTokens) { + MemoryBuffer *buf = MemoryBuffer::getMemBuffer(Source); + (void) SourceMgr.createMainFileIDForMemBuffer(buf); + + VoidModuleLoader ModLoader; + HeaderSearch HeaderInfo(new HeaderSearchOptions, SourceMgr, Diags, LangOpts, + Target.getPtr()); + Preprocessor PP(new PreprocessorOptions(), Diags, LangOpts, Target.getPtr(), + SourceMgr, HeaderInfo, ModLoader, /*IILookup =*/ 0, + /*OwnsHeaderSearch =*/ false, + /*DelayInitialization =*/ false); + PP.EnterMainSourceFile(); + + std::vector<Token> toks; + while (1) { + Token tok; + PP.Lex(tok); + if (tok.is(tok::eof)) + break; + toks.push_back(tok); + } + + EXPECT_EQ(ExpectedTokens.size(), toks.size()); + for (unsigned i = 0, e = ExpectedTokens.size(); i != e; ++i) { + EXPECT_EQ(ExpectedTokens[i], toks[i].getKind()); + } + + return toks; + } + + std::string getSourceText(Token Begin, Token End) { + bool Invalid; + StringRef Str = + Lexer::getSourceText(CharSourceRange::getTokenRange(SourceRange( + Begin.getLocation(), End.getLocation())), + SourceMgr, LangOpts, &Invalid); + if (Invalid) + return "<INVALID>"; + return Str; + } + FileSystemOptions FileMgrOpts; FileManager FileMgr; IntrusiveRefCntPtr<DiagnosticIDs> DiagID; @@ -52,65 +108,179 @@ protected: IntrusiveRefCntPtr<TargetInfo> Target; }; -class VoidModuleLoader : public ModuleLoader { - virtual ModuleLoadResult loadModule(SourceLocation ImportLoc, - ModuleIdPath Path, - Module::NameVisibilityKind Visibility, - bool IsInclusionDirective) { - return ModuleLoadResult(); - } +TEST_F(LexerTest, GetSourceTextExpandsToMaximumInMacroArgument) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::l_paren); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_paren); - virtual void makeModuleVisible(Module *Mod, - Module::NameVisibilityKind Visibility, - SourceLocation ImportLoc, - bool Complain) { } -}; + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "M(f(M(i)))", + ExpectedTokens); + + EXPECT_EQ("M(i)", getSourceText(toks[2], toks[2])); +} + +TEST_F(LexerTest, GetSourceTextExpandsToMaximumInMacroArgumentForEndOfMacro) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "M(M(i) c)", + ExpectedTokens); + + EXPECT_EQ("M(i)", getSourceText(toks[0], toks[0])); +} + +TEST_F(LexerTest, GetSourceTextExpandsInMacroArgumentForBeginOfMacro) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "M(c c M(i))", + ExpectedTokens); + + EXPECT_EQ("c M(i)", getSourceText(toks[1], toks[2])); +} + +TEST_F(LexerTest, GetSourceTextExpandsInMacroArgumentForEndOfMacro) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "M(M(i) c c)", + ExpectedTokens); + + EXPECT_EQ("M(i) c", getSourceText(toks[0], toks[1])); +} + +TEST_F(LexerTest, GetSourceTextInSeparateFnMacros) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "M(c M(i)) M(M(i) c)", + ExpectedTokens); + + EXPECT_EQ("<INVALID>", getSourceText(toks[1], toks[2])); +} + +TEST_F(LexerTest, GetSourceTextWorksAcrossTokenPastes) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::l_paren); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_paren); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "#define C(x) M(x##c)\n" + "M(f(C(i)))", + ExpectedTokens); + + EXPECT_EQ("C(i)", getSourceText(toks[2], toks[2])); +} + +TEST_F(LexerTest, GetSourceTextExpandsAcrossMultipleMacroCalls) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::l_paren); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_paren); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "f(M(M(i)))", + ExpectedTokens); + EXPECT_EQ("M(M(i))", getSourceText(toks[2], toks[2])); +} + +TEST_F(LexerTest, GetSourceTextInMiddleOfMacroArgument) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::l_paren); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_paren); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "M(f(i))", + ExpectedTokens); + EXPECT_EQ("i", getSourceText(toks[2], toks[2])); +} + +TEST_F(LexerTest, GetSourceTextExpandsAroundDifferentMacroCalls) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::l_paren); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_paren); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "#define C(x) x\n" + "f(C(M(i)))", + ExpectedTokens); + EXPECT_EQ("C(M(i))", getSourceText(toks[2], toks[2])); +} + +TEST_F(LexerTest, GetSourceTextOnlyExpandsIfFirstTokenInMacro) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::l_paren); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_paren); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "#define C(x) c x\n" + "f(C(M(i)))", + ExpectedTokens); + EXPECT_EQ("M(i)", getSourceText(toks[3], toks[3])); +} + +TEST_F(LexerTest, GetSourceTextExpandsRecursively) { + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::l_paren); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_paren); + + std::vector<Token> toks = CheckLex("#define M(x) x\n" + "#define C(x) c M(x)\n" + "C(f(M(i)))", + ExpectedTokens); + EXPECT_EQ("M(i)", getSourceText(toks[3], toks[3])); +} TEST_F(LexerTest, LexAPI) { - const char *source = - "#define M(x) [x]\n" - "#define N(x) x\n" - "#define INN(x) x\n" - "#define NOF1 INN(val)\n" - "#define NOF2 val\n" - "M(foo) N([bar])\n" - "N(INN(val)) N(NOF1) N(NOF2) N(val)"; - - MemoryBuffer *buf = MemoryBuffer::getMemBuffer(source); - (void)SourceMgr.createMainFileIDForMemBuffer(buf); - - VoidModuleLoader ModLoader; - HeaderSearch HeaderInfo(new HeaderSearchOptions, FileMgr, Diags, LangOpts, - Target.getPtr()); - Preprocessor PP(new PreprocessorOptions(), Diags, LangOpts, Target.getPtr(), - SourceMgr, HeaderInfo, ModLoader, - /*IILookup =*/ 0, - /*OwnsHeaderSearch =*/false, - /*DelayInitialization =*/ false); - PP.EnterMainSourceFile(); - - std::vector<Token> toks; - while (1) { - Token tok; - PP.Lex(tok); - if (tok.is(tok::eof)) - break; - toks.push_back(tok); - } + std::vector<tok::TokenKind> ExpectedTokens; + ExpectedTokens.push_back(tok::l_square); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_square); + ExpectedTokens.push_back(tok::l_square); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::r_square); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + ExpectedTokens.push_back(tok::identifier); + + std::vector<Token> toks = CheckLex("#define M(x) [x]\n" + "#define N(x) x\n" + "#define INN(x) x\n" + "#define NOF1 INN(val)\n" + "#define NOF2 val\n" + "M(foo) N([bar])\n" + "N(INN(val)) N(NOF1) N(NOF2) N(val)", + ExpectedTokens); - // Make sure we got the tokens that we expected. - ASSERT_EQ(10U, toks.size()); - ASSERT_EQ(tok::l_square, toks[0].getKind()); - ASSERT_EQ(tok::identifier, toks[1].getKind()); - ASSERT_EQ(tok::r_square, toks[2].getKind()); - ASSERT_EQ(tok::l_square, toks[3].getKind()); - ASSERT_EQ(tok::identifier, toks[4].getKind()); - ASSERT_EQ(tok::r_square, toks[5].getKind()); - ASSERT_EQ(tok::identifier, toks[6].getKind()); - ASSERT_EQ(tok::identifier, toks[7].getKind()); - ASSERT_EQ(tok::identifier, toks[8].getKind()); - ASSERT_EQ(tok::identifier, toks[9].getKind()); - SourceLocation lsqrLoc = toks[0].getLocation(); SourceLocation idLoc = toks[1].getLocation(); SourceLocation rsqrLoc = toks[2].getLocation(); diff --git a/unittests/Lex/Makefile b/unittests/Lex/Makefile index bb9c6bc..fa233ce 100644 --- a/unittests/Lex/Makefile +++ b/unittests/Lex/Makefile @@ -9,7 +9,8 @@ CLANG_LEVEL = ../.. TESTNAME = Lex -LINK_COMPONENTS := support mc -USEDLIBS = clangLex.a clangBasic.a +LINK_COMPONENTS := mcparser support mc +USEDLIBS = clangParse.a clangSema.a clangAnalysis.a clangEdit.a \ + clangAST.a clangLex.a clangBasic.a include $(CLANG_LEVEL)/unittests/Makefile diff --git a/unittests/Lex/PPCallbacksTest.cpp b/unittests/Lex/PPCallbacksTest.cpp index 36bd5f9..9405a84 100644 --- a/unittests/Lex/PPCallbacksTest.cpp +++ b/unittests/Lex/PPCallbacksTest.cpp @@ -18,8 +18,12 @@ #include "clang/Lex/HeaderSearchOptions.h" #include "clang/Lex/ModuleLoader.h" #include "clang/Lex/PreprocessorOptions.h" +#include "clang/Parse/Parser.h" +#include "clang/Sema/Sema.h" +#include "clang/AST/ASTContext.h" +#include "clang/AST/ASTConsumer.h" #include "llvm/ADT/SmallString.h" -#include "llvm/Support/PathV2.h" +#include "llvm/Support/Path.h" #include "gtest/gtest.h" using namespace llvm; @@ -77,6 +81,31 @@ public: const Module* Imported; }; +// Stub to collect data from PragmaOpenCLExtension callbacks. +class PragmaOpenCLExtensionCallbacks : public PPCallbacks { +public: + typedef struct { + SmallString<16> Name; + unsigned State; + } CallbackParameters; + + PragmaOpenCLExtensionCallbacks() : Name("Not called."), State(99) {}; + + void PragmaOpenCLExtension( + clang::SourceLocation NameLoc, const clang::IdentifierInfo *Name, + clang::SourceLocation StateLoc, unsigned State) { + this->NameLoc = NameLoc; + this->Name = Name->getName(); + this->StateLoc = StateLoc; + this->State = State; + }; + + SourceLocation NameLoc; + SmallString<16> Name; + SourceLocation StateLoc; + unsigned State; +}; + // PPCallbacks test fixture. class PPCallbacksTest : public ::testing::Test { protected: @@ -133,7 +162,8 @@ protected: VoidModuleLoader ModLoader; IntrusiveRefCntPtr<HeaderSearchOptions> HSOpts = new HeaderSearchOptions(); - HeaderSearch HeaderInfo(HSOpts, FileMgr, Diags, LangOpts, Target.getPtr()); + HeaderSearch HeaderInfo(HSOpts, SourceMgr, Diags, LangOpts, + Target.getPtr()); AddFakeHeader(HeaderInfo, HeaderPath, SystemHeader); IntrusiveRefCntPtr<PreprocessorOptions> PPOpts = new PreprocessorOptions(); @@ -159,6 +189,53 @@ protected: // Callbacks have been executed at this point -- return filename range. return Callbacks->FilenameRange; } + + PragmaOpenCLExtensionCallbacks::CallbackParameters + PragmaOpenCLExtensionCall(const char* SourceText) { + LangOptions OpenCLLangOpts; + OpenCLLangOpts.OpenCL = 1; + + MemoryBuffer* sourceBuf = MemoryBuffer::getMemBuffer(SourceText, "test.cl"); + (void)SourceMgr.createMainFileIDForMemBuffer(sourceBuf); + + VoidModuleLoader ModLoader; + HeaderSearch HeaderInfo(new HeaderSearchOptions, SourceMgr, Diags, + OpenCLLangOpts, Target.getPtr()); + + Preprocessor PP(new PreprocessorOptions(), Diags, OpenCLLangOpts, + Target.getPtr(), + SourceMgr, HeaderInfo, ModLoader, + /*IILookup =*/ 0, + /*OwnsHeaderSearch =*/false, + /*DelayInitialization =*/ false); + + // parser actually sets correct pragma handlers for preprocessor + // according to LangOptions, so we init Parser to register opencl + // pragma handlers + ASTContext Context(OpenCLLangOpts, SourceMgr, Target.getPtr(), + PP.getIdentifierTable(), PP.getSelectorTable(), + PP.getBuiltinInfo(), 0); + ASTConsumer Consumer; + Sema S(PP, Context, Consumer); + Parser P(PP, S, false); + PragmaOpenCLExtensionCallbacks* Callbacks = new PragmaOpenCLExtensionCallbacks; + PP.addPPCallbacks(Callbacks); // Takes ownership. + + // Lex source text. + PP.EnterMainSourceFile(); + while (true) { + Token Tok; + PP.Lex(Tok); + if (Tok.is(tok::eof)) + break; + } + + PragmaOpenCLExtensionCallbacks::CallbackParameters RetVal = { + Callbacks->Name, + Callbacks->State + }; + return RetVal; + } }; TEST_F(PPCallbacksTest, QuotedFilename) { @@ -247,4 +324,28 @@ TEST_F(PPCallbacksTest, TrigraphInMacro) { ASSERT_EQ("\"tri\?\?-graph.h\"", GetSourceString(Range)); } +TEST_F(PPCallbacksTest, OpenCLExtensionPragmaEnabled) { + const char* Source = + "#pragma OPENCL EXTENSION cl_khr_fp64 : enable\n"; + + PragmaOpenCLExtensionCallbacks::CallbackParameters Parameters = + PragmaOpenCLExtensionCall(Source); + + ASSERT_EQ("cl_khr_fp64", Parameters.Name); + unsigned ExpectedState = 1; + ASSERT_EQ(ExpectedState, Parameters.State); +} + +TEST_F(PPCallbacksTest, OpenCLExtensionPragmaDisabled) { + const char* Source = + "#pragma OPENCL EXTENSION cl_khr_fp16 : disable\n"; + + PragmaOpenCLExtensionCallbacks::CallbackParameters Parameters = + PragmaOpenCLExtensionCall(Source); + + ASSERT_EQ("cl_khr_fp16", Parameters.Name); + unsigned ExpectedState = 0; + ASSERT_EQ(ExpectedState, Parameters.State); +} + } // anonoymous namespace diff --git a/unittests/Lex/PPConditionalDirectiveRecordTest.cpp b/unittests/Lex/PPConditionalDirectiveRecordTest.cpp index 082eced..58857fa 100644 --- a/unittests/Lex/PPConditionalDirectiveRecordTest.cpp +++ b/unittests/Lex/PPConditionalDirectiveRecordTest.cpp @@ -90,7 +90,7 @@ TEST_F(PPConditionalDirectiveRecordTest, PPRecAPI) { SourceMgr.createMainFileIDForMemBuffer(buf); VoidModuleLoader ModLoader; - HeaderSearch HeaderInfo(new HeaderSearchOptions, FileMgr, Diags, LangOpts, + HeaderSearch HeaderInfo(new HeaderSearchOptions, SourceMgr, Diags, LangOpts, Target.getPtr()); Preprocessor PP(new PreprocessorOptions(), Diags, LangOpts,Target.getPtr(), SourceMgr, HeaderInfo, ModLoader, diff --git a/unittests/Makefile b/unittests/Makefile index e01a6ac..d0dfe47 100644 --- a/unittests/Makefile +++ b/unittests/Makefile @@ -19,14 +19,10 @@ PARALLEL_DIRS = Basic Lex include $(CLANG_LEVEL)/../..//Makefile.config ifeq ($(ENABLE_CLANG_REWRITER),1) -PARALLEL_DIRS += Format +PARALLEL_DIRS += Format ASTMatchers AST Tooling Sema endif -ifeq ($(ENABLE_CLANG_REWRITER),1) -PARALLEL_DIRS += ASTMatchers AST Tooling -endif - -ifeq ($(ENABLE_CLANG_STATIC_ANALYZER),1) +ifeq ($(ENABLE_CLANG_ARCMT),1) PARALLEL_DIRS += Frontend endif diff --git a/unittests/Sema/CMakeLists.txt b/unittests/Sema/CMakeLists.txt new file mode 100644 index 0000000..d491655 --- /dev/null +++ b/unittests/Sema/CMakeLists.txt @@ -0,0 +1,7 @@ +add_clang_unittest(SemaTests + ExternalSemaSourceTest.cpp + ) + +target_link_libraries(SemaTests + clangAST clangASTMatchers clangTooling + ) diff --git a/unittests/Sema/ExternalSemaSourceTest.cpp b/unittests/Sema/ExternalSemaSourceTest.cpp new file mode 100644 index 0000000..e27d0cd --- /dev/null +++ b/unittests/Sema/ExternalSemaSourceTest.cpp @@ -0,0 +1,266 @@ +//=== unittests/Sema/ExternalSemaSourceTest.cpp - ExternalSemaSource tests ===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// + +#include "clang/AST/ASTConsumer.h" +#include "clang/AST/ASTContext.h" +#include "clang/Frontend/CompilerInstance.h" +#include "clang/Lex/Preprocessor.h" +#include "clang/Parse/ParseAST.h" +#include "clang/Sema/ExternalSemaSource.h" +#include "clang/Sema/Sema.h" +#include "clang/Sema/SemaDiagnostic.h" +#include "clang/Sema/TypoCorrection.h" +#include "clang/Tooling/Tooling.h" +#include "gtest/gtest.h" + +using namespace clang; +using namespace clang::tooling; + +namespace { + +// \brief Counts the number of times MaybeDiagnoseMissingCompleteType +// is called. Returns the result it was provided on creation. +class CompleteTypeDiagnoser : public clang::ExternalSemaSource { +public: + CompleteTypeDiagnoser(bool MockResult) : CallCount(0), Result(MockResult) {} + + virtual bool MaybeDiagnoseMissingCompleteType(SourceLocation L, QualType T) { + ++CallCount; + return Result; + } + + int CallCount; + bool Result; +}; + +// \brief Counts the number of err_using_directive_member_suggest diagnostics +// correcting from one namespace to another while still passing all diagnostics +// along a chain of consumers. +class NamespaceDiagnosticWatcher : public clang::DiagnosticConsumer { + DiagnosticConsumer *Chained; + std::string FromNS; + std::string ToNS; + +public: + NamespaceDiagnosticWatcher(StringRef From, StringRef To) + : Chained(NULL), FromNS(From), ToNS("'"), SeenCount(0) { + ToNS.append(To); + ToNS.append("'"); + } + + virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, + const Diagnostic &Info) { + if (Chained) + Chained->HandleDiagnostic(DiagLevel, Info); + if (Info.getID() - 1 == diag::err_using_directive_member_suggest) { + const IdentifierInfo *Ident = Info.getArgIdentifier(0); + const std::string &CorrectedQuotedStr = Info.getArgStdStr(1); + if (Ident->getName() == FromNS && CorrectedQuotedStr == ToNS) + ++SeenCount; + } + } + + virtual void clear() { + DiagnosticConsumer::clear(); + if (Chained) + Chained->clear(); + } + + virtual bool IncludeInDiagnosticCounts() const { + if (Chained) + return Chained->IncludeInDiagnosticCounts(); + return false; + } + + NamespaceDiagnosticWatcher *Chain(DiagnosticConsumer *ToChain) { + Chained = ToChain; + return this; + } + + int SeenCount; +}; + +// \brief Always corrects a typo matching CorrectFrom with a new namespace +// with the name CorrectTo. +class NamespaceTypoProvider : public clang::ExternalSemaSource { + std::string CorrectFrom; + std::string CorrectTo; + Sema *CurrentSema; + +public: + NamespaceTypoProvider(StringRef From, StringRef To) + : CorrectFrom(From), CorrectTo(To), CurrentSema(NULL), CallCount(0) {} + + virtual void InitializeSema(Sema &S) { CurrentSema = &S; } + + virtual void ForgetSema() { CurrentSema = NULL; } + + virtual TypoCorrection CorrectTypo(const DeclarationNameInfo &Typo, + int LookupKind, Scope *S, CXXScopeSpec *SS, + CorrectionCandidateCallback &CCC, + DeclContext *MemberContext, + bool EnteringContext, + const ObjCObjectPointerType *OPT) { + ++CallCount; + if (CurrentSema && Typo.getName().getAsString() == CorrectFrom) { + DeclContext *DestContext = NULL; + ASTContext &Context = CurrentSema->getASTContext(); + if (SS != NULL) + DestContext = CurrentSema->computeDeclContext(*SS, EnteringContext); + if (DestContext == NULL) + DestContext = Context.getTranslationUnitDecl(); + IdentifierInfo *ToIdent = + CurrentSema->getPreprocessor().getIdentifierInfo(CorrectTo); + NamespaceDecl *NewNamespace = + NamespaceDecl::Create(Context, DestContext, false, Typo.getBeginLoc(), + Typo.getLoc(), ToIdent, NULL); + DestContext->addDecl(NewNamespace); + TypoCorrection Correction(ToIdent); + Correction.addCorrectionDecl(NewNamespace); + return Correction; + } + return TypoCorrection(); + } + + int CallCount; +}; + +// \brief Chains together a vector of NamespaceDiagnosticWatchers and +// adds a vector of ExternalSemaSources to the CompilerInstance before +// performing semantic analysis. +class ExternalSemaSourceInstaller : public clang::ASTFrontendAction { + std::vector<NamespaceDiagnosticWatcher *> Watchers; + std::vector<clang::ExternalSemaSource *> Sources; + llvm::OwningPtr<DiagnosticConsumer> OwnedClient; + +protected: + virtual clang::ASTConsumer * + CreateASTConsumer(clang::CompilerInstance &Compiler, + llvm::StringRef /* dummy */) { + return new clang::ASTConsumer(); + } + + virtual void ExecuteAction() { + CompilerInstance &CI = getCompilerInstance(); + ASSERT_FALSE(CI.hasSema()); + CI.createSema(getTranslationUnitKind(), NULL); + ASSERT_TRUE(CI.hasDiagnostics()); + DiagnosticsEngine &Diagnostics = CI.getDiagnostics(); + DiagnosticConsumer *Client = Diagnostics.getClient(); + if (Diagnostics.ownsClient()) + OwnedClient.reset(Diagnostics.takeClient()); + for (size_t I = 0, E = Watchers.size(); I < E; ++I) + Client = Watchers[I]->Chain(Client); + Diagnostics.setClient(Client, false); + for (size_t I = 0, E = Sources.size(); I < E; ++I) { + Sources[I]->InitializeSema(CI.getSema()); + CI.getSema().addExternalSource(Sources[I]); + } + ParseAST(CI.getSema(), CI.getFrontendOpts().ShowStats, + CI.getFrontendOpts().SkipFunctionBodies); + } + +public: + void PushSource(clang::ExternalSemaSource *Source) { + Sources.push_back(Source); + } + + void PushWatcher(NamespaceDiagnosticWatcher *Watcher) { + Watchers.push_back(Watcher); + } +}; + +// Make sure that the NamespaceDiagnosticWatcher is not miscounting. +TEST(ExternalSemaSource, SanityCheck) { + llvm::OwningPtr<ExternalSemaSourceInstaller> Installer( + new ExternalSemaSourceInstaller); + NamespaceDiagnosticWatcher Watcher("AAB", "BBB"); + Installer->PushWatcher(&Watcher); + std::vector<std::string> Args(1, "-std=c++11"); + ASSERT_TRUE(clang::tooling::runToolOnCodeWithArgs( + Installer.take(), "namespace AAA { } using namespace AAB;", Args)); + ASSERT_EQ(0, Watcher.SeenCount); +} + +// Check that when we add a NamespaceTypeProvider, we use that suggestion +// instead of the usual suggestion we would use above. +TEST(ExternalSemaSource, ExternalTypoCorrectionPrioritized) { + llvm::OwningPtr<ExternalSemaSourceInstaller> Installer( + new ExternalSemaSourceInstaller); + NamespaceTypoProvider Provider("AAB", "BBB"); + NamespaceDiagnosticWatcher Watcher("AAB", "BBB"); + Installer->PushSource(&Provider); + Installer->PushWatcher(&Watcher); + std::vector<std::string> Args(1, "-std=c++11"); + ASSERT_TRUE(clang::tooling::runToolOnCodeWithArgs( + Installer.take(), "namespace AAA { } using namespace AAB;", Args)); + ASSERT_LE(0, Provider.CallCount); + ASSERT_EQ(1, Watcher.SeenCount); +} + +// Check that we use the first successful TypoCorrection returned from an +// ExternalSemaSource. +TEST(ExternalSemaSource, ExternalTypoCorrectionOrdering) { + llvm::OwningPtr<ExternalSemaSourceInstaller> Installer( + new ExternalSemaSourceInstaller); + NamespaceTypoProvider First("XXX", "BBB"); + NamespaceTypoProvider Second("AAB", "CCC"); + NamespaceTypoProvider Third("AAB", "DDD"); + NamespaceDiagnosticWatcher Watcher("AAB", "CCC"); + Installer->PushSource(&First); + Installer->PushSource(&Second); + Installer->PushSource(&Third); + Installer->PushWatcher(&Watcher); + std::vector<std::string> Args(1, "-std=c++11"); + ASSERT_TRUE(clang::tooling::runToolOnCodeWithArgs( + Installer.take(), "namespace AAA { } using namespace AAB;", Args)); + ASSERT_LE(1, First.CallCount); + ASSERT_LE(1, Second.CallCount); + ASSERT_EQ(0, Third.CallCount); + ASSERT_EQ(1, Watcher.SeenCount); +} + +// We should only try MaybeDiagnoseMissingCompleteType if we can't otherwise +// solve the problem. +TEST(ExternalSemaSource, TryOtherTacticsBeforeDiagnosing) { + llvm::OwningPtr<ExternalSemaSourceInstaller> Installer( + new ExternalSemaSourceInstaller); + CompleteTypeDiagnoser Diagnoser(false); + Installer->PushSource(&Diagnoser); + std::vector<std::string> Args(1, "-std=c++11"); + // This code hits the class template specialization/class member of a class + // template specialization checks in Sema::RequireCompleteTypeImpl. + ASSERT_TRUE(clang::tooling::runToolOnCodeWithArgs( + Installer.take(), + "template <typename T> struct S { class C { }; }; S<char>::C SCInst;", + Args)); + ASSERT_EQ(0, Diagnoser.CallCount); +} + +// The first ExternalSemaSource where MaybeDiagnoseMissingCompleteType returns +// true should be the last one called. +TEST(ExternalSemaSource, FirstDiagnoserTaken) { + llvm::OwningPtr<ExternalSemaSourceInstaller> Installer( + new ExternalSemaSourceInstaller); + CompleteTypeDiagnoser First(false); + CompleteTypeDiagnoser Second(true); + CompleteTypeDiagnoser Third(true); + Installer->PushSource(&First); + Installer->PushSource(&Second); + Installer->PushSource(&Third); + std::vector<std::string> Args(1, "-std=c++11"); + ASSERT_FALSE(clang::tooling::runToolOnCodeWithArgs( + Installer.take(), "class Incomplete; Incomplete IncompleteInstance;", + Args)); + ASSERT_EQ(1, First.CallCount); + ASSERT_EQ(1, Second.CallCount); + ASSERT_EQ(0, Third.CallCount); +} + +} // anonymous namespace diff --git a/unittests/Sema/Makefile b/unittests/Sema/Makefile new file mode 100644 index 0000000..cd1d93d --- /dev/null +++ b/unittests/Sema/Makefile @@ -0,0 +1,19 @@ +##===- unittests/Sema/Makefile -----------------------------*- Makefile -*-===## +# +# The LLVM Compiler Infrastructure +# +# This file is distributed under the University of Illinois Open Source +# License. See LICENSE.TXT for details. +# +##===----------------------------------------------------------------------===## + +CLANG_LEVEL = ../.. +TESTNAME = Sema +include $(CLANG_LEVEL)/../../Makefile.config +LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option +USEDLIBS = clangTooling.a clangFrontend.a clangSerialization.a clangDriver.a \ + clangRewriteCore.a clangRewriteFrontend.a \ + clangParse.a clangSema.a clangAnalysis.a \ + clangEdit.a clangAST.a clangASTMatchers.a clangLex.a clangBasic.a + +include $(CLANG_LEVEL)/unittests/Makefile diff --git a/unittests/Tooling/CMakeLists.txt b/unittests/Tooling/CMakeLists.txt index 245c059..33d7617 100644 --- a/unittests/Tooling/CMakeLists.txt +++ b/unittests/Tooling/CMakeLists.txt @@ -14,6 +14,7 @@ add_clang_unittest(ToolingTests RefactoringTest.cpp RewriterTest.cpp RefactoringCallbacksTest.cpp + ReplacementsYamlTest.cpp ) target_link_libraries(ToolingTests diff --git a/unittests/Tooling/CompilationDatabaseTest.cpp b/unittests/Tooling/CompilationDatabaseTest.cpp index c453b05..c575dff 100644 --- a/unittests/Tooling/CompilationDatabaseTest.cpp +++ b/unittests/Tooling/CompilationDatabaseTest.cpp @@ -14,7 +14,7 @@ #include "clang/Tooling/FileMatchTrie.h" #include "clang/Tooling/JSONCompilationDatabase.h" #include "clang/Tooling/Tooling.h" -#include "llvm/Support/PathV2.h" +#include "llvm/Support/Path.h" #include "gtest/gtest.h" namespace clang { @@ -450,18 +450,20 @@ TEST(ParseFixedCompilationDatabase, ReturnsNullWithoutDoubleDash) { TEST(ParseFixedCompilationDatabase, ReturnsArgumentsAfterDoubleDash) { int Argc = 5; - const char *Argv[] = { "1", "2", "--\0no-constant-folding", "3", "4" }; + const char *Argv[] = { + "1", "2", "--\0no-constant-folding", "-DDEF3", "-DDEF4" + }; OwningPtr<FixedCompilationDatabase> Database( FixedCompilationDatabase::loadFromCommandLine(Argc, Argv)); - ASSERT_TRUE(Database); + ASSERT_TRUE(Database.isValid()); std::vector<CompileCommand> Result = Database->getCompileCommands("source"); ASSERT_EQ(1ul, Result.size()); ASSERT_EQ(".", Result[0].Directory); std::vector<std::string> CommandLine; CommandLine.push_back("clang-tool"); - CommandLine.push_back("3"); - CommandLine.push_back("4"); + CommandLine.push_back("-DDEF3"); + CommandLine.push_back("-DDEF4"); CommandLine.push_back("source"); ASSERT_EQ(CommandLine, Result[0].CommandLine); EXPECT_EQ(2, Argc); @@ -472,7 +474,7 @@ TEST(ParseFixedCompilationDatabase, ReturnsEmptyCommandLine) { const char *Argv[] = { "1", "2", "--\0no-constant-folding" }; OwningPtr<FixedCompilationDatabase> Database( FixedCompilationDatabase::loadFromCommandLine(Argc, Argv)); - ASSERT_TRUE(Database); + ASSERT_TRUE(Database.isValid()); std::vector<CompileCommand> Result = Database->getCompileCommands("source"); ASSERT_EQ(1ul, Result.size()); @@ -484,5 +486,41 @@ TEST(ParseFixedCompilationDatabase, ReturnsEmptyCommandLine) { EXPECT_EQ(2, Argc); } +TEST(ParseFixedCompilationDatabase, HandlesPositionalArgs) { + const char *Argv[] = {"1", "2", "--", "-c", "somefile.cpp", "-DDEF3"}; + int Argc = sizeof(Argv) / sizeof(char*); + OwningPtr<FixedCompilationDatabase> Database( + FixedCompilationDatabase::loadFromCommandLine(Argc, Argv)); + ASSERT_TRUE(Database.isValid()); + std::vector<CompileCommand> Result = + Database->getCompileCommands("source"); + ASSERT_EQ(1ul, Result.size()); + ASSERT_EQ(".", Result[0].Directory); + std::vector<std::string> Expected; + Expected.push_back("clang-tool"); + Expected.push_back("-c"); + Expected.push_back("-DDEF3"); + Expected.push_back("source"); + ASSERT_EQ(Expected, Result[0].CommandLine); + EXPECT_EQ(2, Argc); +} + +TEST(ParseFixedCompilationDatabase, HandlesArgv0) { + const char *Argv[] = {"1", "2", "--", "mytool", "somefile.cpp"}; + int Argc = sizeof(Argv) / sizeof(char*); + OwningPtr<FixedCompilationDatabase> Database( + FixedCompilationDatabase::loadFromCommandLine(Argc, Argv)); + ASSERT_TRUE(Database.isValid()); + std::vector<CompileCommand> Result = + Database->getCompileCommands("source"); + ASSERT_EQ(1ul, Result.size()); + ASSERT_EQ(".", Result[0].Directory); + std::vector<std::string> Expected; + Expected.push_back("clang-tool"); + Expected.push_back("source"); + ASSERT_EQ(Expected, Result[0].CommandLine); + EXPECT_EQ(2, Argc); +} + } // end namespace tooling } // end namespace clang diff --git a/unittests/Tooling/Makefile b/unittests/Tooling/Makefile index 06fdf88..9d36f1f 100644 --- a/unittests/Tooling/Makefile +++ b/unittests/Tooling/Makefile @@ -10,7 +10,7 @@ CLANG_LEVEL = ../.. TESTNAME = Tooling include $(CLANG_LEVEL)/../../Makefile.config -LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc +LINK_COMPONENTS := $(TARGETS_TO_BUILD) asmparser bitreader support mc option USEDLIBS = clangTooling.a clangFrontend.a clangSerialization.a clangDriver.a \ clangParse.a clangRewriteCore.a clangRewriteFrontend.a \ clangSema.a clangAnalysis.a clangEdit.a \ diff --git a/unittests/Tooling/RecursiveASTVisitorTest.cpp b/unittests/Tooling/RecursiveASTVisitorTest.cpp index 81be190..3234767 100644 --- a/unittests/Tooling/RecursiveASTVisitorTest.cpp +++ b/unittests/Tooling/RecursiveASTVisitorTest.cpp @@ -9,6 +9,8 @@ #include "TestVisitor.h" +#include <stack> + namespace clang { class TypeLocVisitor : public ExpectedLocationVisitor<TypeLocVisitor> { @@ -35,6 +37,17 @@ public: } }; +class ParmVarDeclVisitorForImplicitCode : + public ExpectedLocationVisitor<ParmVarDeclVisitorForImplicitCode> { +public: + bool shouldVisitImplicitCode() const { return true; } + + bool VisitParmVarDecl(ParmVarDecl *ParamVar) { + Match(ParamVar->getNameAsString(), ParamVar->getLocStart()); + return true; + } +}; + class CXXMemberCallVisitor : public ExpectedLocationVisitor<CXXMemberCallVisitor> { public: @@ -79,6 +92,42 @@ public: } }; +class LambdaExprVisitor : public ExpectedLocationVisitor<LambdaExprVisitor> { +public: + bool VisitLambdaExpr(LambdaExpr *Lambda) { + PendingBodies.push(Lambda); + Match("", Lambda->getIntroducerRange().getBegin()); + return true; + } + /// For each call to VisitLambdaExpr, we expect a subsequent call (with + /// proper nesting) to TraverseLambdaBody. + bool TraverseLambdaBody(LambdaExpr *Lambda) { + EXPECT_FALSE(PendingBodies.empty()); + EXPECT_EQ(PendingBodies.top(), Lambda); + PendingBodies.pop(); + return TraverseStmt(Lambda->getBody()); + } + /// Determine whether TraverseLambdaBody has been called for every call to + /// VisitLambdaExpr. + bool allBodiesHaveBeenTraversed() const { + return PendingBodies.empty(); + } +private: + std::stack<LambdaExpr *> PendingBodies; +}; + +// Matches the (optional) capture-default of a lambda-introducer. +class LambdaDefaultCaptureVisitor + : public ExpectedLocationVisitor<LambdaDefaultCaptureVisitor> { +public: + bool VisitLambdaExpr(LambdaExpr *Lambda) { + if (Lambda->getCaptureDefault() != LCD_None) { + Match("", Lambda->getCaptureDefaultLoc()); + } + return true; + } +}; + class TemplateArgumentLocTraverser : public ExpectedLocationVisitor<TemplateArgumentLocTraverser> { public: @@ -106,6 +155,24 @@ public: } }; +// Test RAV visits parameter variable declaration of the implicit +// copy assignment operator and implicit copy constructor. +TEST(RecursiveASTVisitor, VisitsParmVarDeclForImplicitCode) { + ParmVarDeclVisitorForImplicitCode Visitor; + // Match parameter variable name of implicit copy assignment operator and + // implicit copy constructor. + // This parameter name does not have a valid IdentifierInfo, and shares + // same SourceLocation with its class declaration, so we match an empty name + // with the class' source location. + Visitor.ExpectMatch("", 1, 7); + Visitor.ExpectMatch("", 3, 7); + EXPECT_TRUE(Visitor.runOver( + "class X {};\n" + "void foo(X a, X b) {a = b;}\n" + "class Y {};\n" + "void bar(Y a) {Y b = a;}")); +} + TEST(RecursiveASTVisitor, VisitsBaseClassDeclarations) { TypeLocVisitor Visitor; Visitor.ExpectMatch("class X", 1, 30); @@ -150,7 +217,8 @@ TEST(RecursiveASTVisitor, VisitsCXXForRangeStmtRange) { Visitor.ExpectMatch("x", 2, 30); EXPECT_TRUE(Visitor.runOver( "int x[5];\n" - "void f() { for (int i : x) { x[0] = 1; } }")); + "void f() { for (int i : x) { x[0] = 1; } }", + DeclRefExprVisitor::Lang_CXX11)); } TEST(RecursiveASTVisitor, VisitsCXXForRangeStmtLoopVariable) { @@ -158,7 +226,8 @@ TEST(RecursiveASTVisitor, VisitsCXXForRangeStmtLoopVariable) { Visitor.ExpectMatch("i", 2, 17); EXPECT_TRUE(Visitor.runOver( "int x[5];\n" - "void f() { for (int i : x) {} }")); + "void f() { for (int i : x) {} }", + VarDeclVisitor::Lang_CXX11)); } TEST(RecursiveASTVisitor, VisitsCallExpr) { @@ -461,4 +530,51 @@ TEST(RecursiveASTVisitor, VisitsCompoundLiteralType) { TypeLocVisitor::Lang_C)); } +TEST(RecursiveASTVisitor, VisitsLambdaExpr) { + LambdaExprVisitor Visitor; + Visitor.ExpectMatch("", 1, 12); + EXPECT_TRUE(Visitor.runOver("void f() { []{ return; }(); }", + LambdaExprVisitor::Lang_CXX11)); +} + +TEST(RecursiveASTVisitor, TraverseLambdaBodyCanBeOverridden) { + LambdaExprVisitor Visitor; + EXPECT_TRUE(Visitor.runOver("void f() { []{ return; }(); }", + LambdaExprVisitor::Lang_CXX11)); + EXPECT_TRUE(Visitor.allBodiesHaveBeenTraversed()); +} + +TEST(RecursiveASTVisitor, HasCaptureDefaultLoc) { + LambdaDefaultCaptureVisitor Visitor; + Visitor.ExpectMatch("", 1, 20); + EXPECT_TRUE(Visitor.runOver("void f() { int a; [=]{a;}; }", + LambdaDefaultCaptureVisitor::Lang_CXX11)); +} + +// Checks for lambda classes that are not marked as implicitly-generated. +// (There should be none.) +class ClassVisitor : public ExpectedLocationVisitor<ClassVisitor> { +public: + ClassVisitor() : SawNonImplicitLambdaClass(false) {} + bool VisitCXXRecordDecl(CXXRecordDecl* record) { + if (record->isLambda() && !record->isImplicit()) + SawNonImplicitLambdaClass = true; + return true; + } + + bool sawOnlyImplicitLambdaClasses() const { + return !SawNonImplicitLambdaClass; + } + +private: + bool SawNonImplicitLambdaClass; +}; + +TEST(RecursiveASTVisitor, LambdaClosureTypesAreImplicit) { + ClassVisitor Visitor; + EXPECT_TRUE(Visitor.runOver("auto lambda = []{};", + ClassVisitor::Lang_CXX11)); + EXPECT_TRUE(Visitor.sawOnlyImplicitLambdaClasses()); +} + } // end namespace clang diff --git a/unittests/Tooling/RefactoringTest.cpp b/unittests/Tooling/RefactoringTest.cpp index 3e0d728..8c7bfa1 100644 --- a/unittests/Tooling/RefactoringTest.cpp +++ b/unittests/Tooling/RefactoringTest.cpp @@ -120,6 +120,21 @@ TEST_F(ReplacementTest, CanApplyReplacements) { EXPECT_EQ("line1\nreplaced\nother\nline4", Context.getRewrittenText(ID)); } +// FIXME: Remove this test case when Replacements is implemented as std::vector +// instead of std::set. The other ReplacementTest tests will need to be updated +// at that point as well. +TEST_F(ReplacementTest, VectorCanApplyReplacements) { + FileID ID = Context.createInMemoryFile("input.cpp", + "line1\nline2\nline3\nline4"); + std::vector<Replacement> Replaces; + Replaces.push_back(Replacement(Context.Sources, Context.getLocation(ID, 2, 1), + 5, "replaced")); + Replaces.push_back( + Replacement(Context.Sources, Context.getLocation(ID, 3, 1), 5, "other")); + EXPECT_TRUE(applyAllReplacements(Replaces, Context.Rewrite)); + EXPECT_EQ("line1\nreplaced\nother\nline4", Context.getRewrittenText(ID)); +} + TEST_F(ReplacementTest, SkipsDuplicateReplacements) { FileID ID = Context.createInMemoryFile("input.cpp", "line1\nline2\nline3\nline4"); @@ -151,37 +166,87 @@ TEST_F(ReplacementTest, ApplyAllFailsIfOneApplyFails) { EXPECT_EQ("z", Context.getRewrittenText(IDz)); } +TEST(ShiftedCodePositionTest, FindsNewCodePosition) { + Replacements Replaces; + Replaces.insert(Replacement("", 0, 1, "")); + Replaces.insert(Replacement("", 4, 3, " ")); + // Assume ' int i;' is turned into 'int i;' and cursor is located at '|'. + EXPECT_EQ(0u, shiftedCodePosition(Replaces, 0)); // |int i; + EXPECT_EQ(0u, shiftedCodePosition(Replaces, 1)); // |nt i; + EXPECT_EQ(1u, shiftedCodePosition(Replaces, 2)); // i|t i; + EXPECT_EQ(2u, shiftedCodePosition(Replaces, 3)); // in| i; + EXPECT_EQ(3u, shiftedCodePosition(Replaces, 4)); // int| i; + EXPECT_EQ(4u, shiftedCodePosition(Replaces, 5)); // int | i; + EXPECT_EQ(4u, shiftedCodePosition(Replaces, 6)); // int |i; + EXPECT_EQ(4u, shiftedCodePosition(Replaces, 7)); // int |; + EXPECT_EQ(5u, shiftedCodePosition(Replaces, 8)); // int i| +} + +// FIXME: Remove this test case when Replacements is implemented as std::vector +// instead of std::set. The other ReplacementTest tests will need to be updated +// at that point as well. +TEST(ShiftedCodePositionTest, VectorFindsNewCodePositionWithInserts) { + std::vector<Replacement> Replaces; + Replaces.push_back(Replacement("", 0, 1, "")); + Replaces.push_back(Replacement("", 4, 3, " ")); + // Assume ' int i;' is turned into 'int i;' and cursor is located at '|'. + EXPECT_EQ(0u, shiftedCodePosition(Replaces, 0)); // |int i; + EXPECT_EQ(0u, shiftedCodePosition(Replaces, 1)); // |nt i; + EXPECT_EQ(1u, shiftedCodePosition(Replaces, 2)); // i|t i; + EXPECT_EQ(2u, shiftedCodePosition(Replaces, 3)); // in| i; + EXPECT_EQ(3u, shiftedCodePosition(Replaces, 4)); // int| i; + EXPECT_EQ(4u, shiftedCodePosition(Replaces, 5)); // int | i; + EXPECT_EQ(4u, shiftedCodePosition(Replaces, 6)); // int |i; + EXPECT_EQ(4u, shiftedCodePosition(Replaces, 7)); // int |; + EXPECT_EQ(5u, shiftedCodePosition(Replaces, 8)); // int i| +} + +TEST(ShiftedCodePositionTest, FindsNewCodePositionWithInserts) { + Replacements Replaces; + Replaces.insert(Replacement("", 4, 0, "\"\n\"")); + // Assume '"12345678"' is turned into '"1234"\n"5678"'. + EXPECT_EQ(4u, shiftedCodePosition(Replaces, 4)); // "123|5678" + EXPECT_EQ(8u, shiftedCodePosition(Replaces, 5)); // "1234|678" +} + class FlushRewrittenFilesTest : public ::testing::Test { - public: - FlushRewrittenFilesTest() { - std::string ErrorInfo; - TemporaryDirectory = llvm::sys::Path::GetTemporaryDirectory(&ErrorInfo); - assert(ErrorInfo.empty()); - } +public: + FlushRewrittenFilesTest() {} ~FlushRewrittenFilesTest() { - std::string ErrorInfo; - TemporaryDirectory.eraseFromDisk(true, &ErrorInfo); - assert(ErrorInfo.empty()); + for (llvm::StringMap<std::string>::iterator I = TemporaryFiles.begin(), + E = TemporaryFiles.end(); + I != E; ++I) { + llvm::StringRef Name = I->second; + llvm::error_code EC = llvm::sys::fs::remove(Name); + (void)EC; + assert(!EC); + } } FileID createFile(llvm::StringRef Name, llvm::StringRef Content) { - SmallString<1024> Path(TemporaryDirectory.str()); - llvm::sys::path::append(Path, Name); - std::string ErrorInfo; - llvm::raw_fd_ostream OutStream(Path.c_str(), - ErrorInfo, llvm::raw_fd_ostream::F_Binary); - assert(ErrorInfo.empty()); + SmallString<1024> Path; + int FD; + llvm::error_code EC = + llvm::sys::fs::createTemporaryFile(Name, "", FD, Path); + assert(!EC); + (void)EC; + + llvm::raw_fd_ostream OutStream(FD, true); OutStream << Content; OutStream.close(); const FileEntry *File = Context.Files.getFile(Path); assert(File != NULL); + + StringRef Found = TemporaryFiles.GetOrCreateValue(Name, Path.str()).second; + assert(Found == Path); + (void)Found; return Context.Sources.createFileID(File, SourceLocation(), SrcMgr::C_User); } std::string getFileContentFromDisk(llvm::StringRef Name) { - SmallString<1024> Path(TemporaryDirectory.str()); - llvm::sys::path::append(Path, Name); + std::string Path = TemporaryFiles.lookup(Name); + assert(!Path.empty()); // We need to read directly from the FileManager without relaying through // a FileEntry, as otherwise we'd read through an already opened file // descriptor, which might not see the changes made. @@ -190,7 +255,7 @@ class FlushRewrittenFilesTest : public ::testing::Test { return Context.Files.getBufferForFile(Path, NULL)->getBuffer(); } - llvm::sys::Path TemporaryDirectory; + llvm::StringMap<std::string> TemporaryFiles; RewriterTestContext Context; }; @@ -301,5 +366,97 @@ TEST(Replacement, TemplatedFunctionCall) { expectReplacementAt(CallToF.Replace, "input.cc", 43, 8); } +TEST(Range, overlaps) { + EXPECT_TRUE(Range(10, 10).overlapsWith(Range(0, 11))); + EXPECT_TRUE(Range(0, 11).overlapsWith(Range(10, 10))); + EXPECT_FALSE(Range(10, 10).overlapsWith(Range(0, 10))); + EXPECT_FALSE(Range(0, 10).overlapsWith(Range(10, 10))); + EXPECT_TRUE(Range(0, 10).overlapsWith(Range(2, 6))); + EXPECT_TRUE(Range(2, 6).overlapsWith(Range(0, 10))); +} + +TEST(Range, contains) { + EXPECT_TRUE(Range(0, 10).contains(Range(0, 10))); + EXPECT_TRUE(Range(0, 10).contains(Range(2, 6))); + EXPECT_FALSE(Range(2, 6).contains(Range(0, 10))); + EXPECT_FALSE(Range(0, 10).contains(Range(0, 11))); +} + +TEST(DeduplicateTest, removesDuplicates) { + std::vector<Replacement> Input; + Input.push_back(Replacement("fileA", 50, 0, " foo ")); + Input.push_back(Replacement("fileA", 10, 3, " bar ")); + Input.push_back(Replacement("fileA", 10, 2, " bar ")); // Length differs + Input.push_back(Replacement("fileA", 9, 3, " bar ")); // Offset differs + Input.push_back(Replacement("fileA", 50, 0, " foo ")); // Duplicate + Input.push_back(Replacement("fileA", 51, 3, " bar ")); + Input.push_back(Replacement("fileB", 51, 3, " bar ")); // Filename differs! + Input.push_back(Replacement("fileA", 51, 3, " moo ")); // Replacement text + // differs! + + std::vector<Replacement> Expected; + Expected.push_back(Replacement("fileA", 9, 3, " bar ")); + Expected.push_back(Replacement("fileA", 10, 2, " bar ")); + Expected.push_back(Replacement("fileA", 10, 3, " bar ")); + Expected.push_back(Replacement("fileA", 50, 0, " foo ")); + Expected.push_back(Replacement("fileA", 51, 3, " bar ")); + Expected.push_back(Replacement("fileA", 51, 3, " moo ")); + Expected.push_back(Replacement("fileB", 51, 3, " bar ")); + + std::vector<Range> Conflicts; // Ignored for this test + deduplicate(Input, Conflicts); + + ASSERT_TRUE(Expected == Input); +} + +TEST(DeduplicateTest, detectsConflicts) { + { + std::vector<Replacement> Input; + Input.push_back(Replacement("fileA", 0, 5, " foo ")); + Input.push_back(Replacement("fileA", 0, 5, " foo ")); // Duplicate not a + // conflict. + Input.push_back(Replacement("fileA", 2, 6, " bar ")); + Input.push_back(Replacement("fileA", 7, 3, " moo ")); + + std::vector<Range> Conflicts; + deduplicate(Input, Conflicts); + + // One duplicate is removed and the remaining three items form one + // conflicted range. + ASSERT_EQ(3u, Input.size()); + ASSERT_EQ(1u, Conflicts.size()); + ASSERT_EQ(0u, Conflicts.front().getOffset()); + ASSERT_EQ(3u, Conflicts.front().getLength()); + } + { + std::vector<Replacement> Input; + + // Expected sorted order is shown. It is the sorted order to which the + // returned conflict info refers to. + Input.push_back(Replacement("fileA", 0, 5, " foo ")); // 0 + Input.push_back(Replacement("fileA", 5, 5, " bar ")); // 1 + Input.push_back(Replacement("fileA", 6, 0, " bar ")); // 3 + Input.push_back(Replacement("fileA", 5, 5, " moo ")); // 2 + Input.push_back(Replacement("fileA", 7, 2, " bar ")); // 4 + Input.push_back(Replacement("fileA", 15, 5, " golf ")); // 5 + Input.push_back(Replacement("fileA", 16, 5, " bag ")); // 6 + Input.push_back(Replacement("fileA", 10, 3, " club ")); // 7 + + // #3 is special in that it is completely contained by another conflicting + // Replacement. #4 ensures #3 hasn't messed up the conflicting range size. + + std::vector<Range> Conflicts; + deduplicate(Input, Conflicts); + + // No duplicates + ASSERT_EQ(8u, Input.size()); + ASSERT_EQ(2u, Conflicts.size()); + ASSERT_EQ(1u, Conflicts[0].getOffset()); + ASSERT_EQ(4u, Conflicts[0].getLength()); + ASSERT_EQ(6u, Conflicts[1].getOffset()); + ASSERT_EQ(2u, Conflicts[1].getLength()); + } +} + } // end namespace tooling } // end namespace clang diff --git a/unittests/Tooling/ReplacementsYamlTest.cpp b/unittests/Tooling/ReplacementsYamlTest.cpp new file mode 100644 index 0000000..a20dde7 --- /dev/null +++ b/unittests/Tooling/ReplacementsYamlTest.cpp @@ -0,0 +1,106 @@ +//===- unittests/Tooling/ReplacementsYamlTest.cpp - Serialization tests ---===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// Tests for serialization of Replacements. +// +//===----------------------------------------------------------------------===// + +#include "clang/Tooling/ReplacementsYaml.h" +#include "gtest/gtest.h" + +using namespace llvm; +using namespace clang::tooling; + +TEST(ReplacementsYamlTest, serializesReplacements) { + + TranslationUnitReplacements Doc; + + Doc.MainSourceFile = "/path/to/source.cpp"; + Doc.Context = "some context"; + Doc.Replacements + .push_back(Replacement("/path/to/file1.h", 232, 56, "replacement #1")); + Doc.Replacements + .push_back(Replacement("/path/to/file2.h", 301, 2, "replacement #2")); + + std::string YamlContent; + llvm::raw_string_ostream YamlContentStream(YamlContent); + + yaml::Output YAML(YamlContentStream); + YAML << Doc; + + // NOTE: If this test starts to fail for no obvious reason, check whitespace. + ASSERT_STREQ("---\n" + "MainSourceFile: /path/to/source.cpp\n" + "Context: some context\n" + "Replacements: \n" // Extra whitespace here! + " - FilePath: /path/to/file1.h\n" + " Offset: 232\n" + " Length: 56\n" + " ReplacementText: 'replacement #1'\n" + " - FilePath: /path/to/file2.h\n" + " Offset: 301\n" + " Length: 2\n" + " ReplacementText: 'replacement #2'\n" + "...\n", + YamlContentStream.str().c_str()); +} + +TEST(ReplacementsYamlTest, deserializesReplacements) { + std::string YamlContent = "---\n" + "MainSourceFile: /path/to/source.cpp\n" + "Context: some context\n" + "Replacements:\n" + " - FilePath: /path/to/file1.h\n" + " Offset: 232\n" + " Length: 56\n" + " ReplacementText: 'replacement #1'\n" + " - FilePath: /path/to/file2.h\n" + " Offset: 301\n" + " Length: 2\n" + " ReplacementText: 'replacement #2'\n" + "...\n"; + TranslationUnitReplacements DocActual; + yaml::Input YAML(YamlContent); + YAML >> DocActual; + ASSERT_FALSE(YAML.error()); + ASSERT_EQ(2u, DocActual.Replacements.size()); + ASSERT_EQ("/path/to/source.cpp", DocActual.MainSourceFile); + ASSERT_EQ("some context", DocActual.Context); + ASSERT_EQ("/path/to/file1.h", DocActual.Replacements[0].getFilePath()); + ASSERT_EQ(232u, DocActual.Replacements[0].getOffset()); + ASSERT_EQ(56u, DocActual.Replacements[0].getLength()); + ASSERT_EQ("replacement #1", DocActual.Replacements[0].getReplacementText()); + ASSERT_EQ("/path/to/file2.h", DocActual.Replacements[1].getFilePath()); + ASSERT_EQ(301u, DocActual.Replacements[1].getOffset()); + ASSERT_EQ(2u, DocActual.Replacements[1].getLength()); + ASSERT_EQ("replacement #2", DocActual.Replacements[1].getReplacementText()); +} + +TEST(ReplacementsYamlTest, deserializesWithoutContext) { + // Make sure a doc can be read without the context field. + std::string YamlContent = "---\n" + "MainSourceFile: /path/to/source.cpp\n" + "Replacements:\n" + " - FilePath: target_file.h\n" + " Offset: 1\n" + " Length: 10\n" + " ReplacementText: replacement\n" + "...\n"; + TranslationUnitReplacements DocActual; + yaml::Input YAML(YamlContent); + YAML >> DocActual; + ASSERT_FALSE(YAML.error()); + ASSERT_EQ("/path/to/source.cpp", DocActual.MainSourceFile); + ASSERT_EQ(1u, DocActual.Replacements.size()); + ASSERT_EQ(std::string(), DocActual.Context); + ASSERT_EQ("target_file.h", DocActual.Replacements[0].getFilePath()); + ASSERT_EQ(1u, DocActual.Replacements[0].getOffset()); + ASSERT_EQ(10u, DocActual.Replacements[0].getLength()); + ASSERT_EQ("replacement", DocActual.Replacements[0].getReplacementText()); +} diff --git a/unittests/Tooling/RewriterTestContext.h b/unittests/Tooling/RewriterTestContext.h index 13c4202..841cd0f 100644 --- a/unittests/Tooling/RewriterTestContext.h +++ b/unittests/Tooling/RewriterTestContext.h @@ -45,12 +45,7 @@ class RewriterTestContext { Diagnostics.setClient(&DiagnosticPrinter, false); } - ~RewriterTestContext() { - if (!TemporaryDirectory.empty()) { - uint32_t RemovedCount = 0; - llvm::sys::fs::remove_all(TemporaryDirectory.str(), RemovedCount); - } - } + ~RewriterTestContext() {} FileID createInMemoryFile(StringRef Name, StringRef Content) { const llvm::MemoryBuffer *Source = @@ -62,26 +57,25 @@ class RewriterTestContext { return Sources.createFileID(Entry, SourceLocation(), SrcMgr::C_User); } + // FIXME: this code is mostly a duplicate of + // unittests/Tooling/RefactoringTest.cpp. Figure out a way to share it. FileID createOnDiskFile(StringRef Name, StringRef Content) { - if (TemporaryDirectory.empty()) { - int FD; - bool error = - llvm::sys::fs::unique_file("rewriter-test-%%-%%-%%-%%/anchor", FD, - TemporaryDirectory); - assert(!error); (void)error; - llvm::raw_fd_ostream Closer(FD, /*shouldClose=*/true); - TemporaryDirectory = llvm::sys::path::parent_path(TemporaryDirectory); - } - SmallString<1024> Path(TemporaryDirectory); - llvm::sys::path::append(Path, Name); - std::string ErrorInfo; - llvm::raw_fd_ostream OutStream(Path.c_str(), - ErrorInfo, llvm::raw_fd_ostream::F_Binary); - assert(ErrorInfo.empty()); + SmallString<1024> Path; + int FD; + llvm::error_code EC = + llvm::sys::fs::createTemporaryFile(Name, "", FD, Path); + assert(!EC); + (void)EC; + + llvm::raw_fd_ostream OutStream(FD, true); OutStream << Content; OutStream.close(); const FileEntry *File = Files.getFile(Path); assert(File != NULL); + + StringRef Found = TemporaryFiles.GetOrCreateValue(Name, Path.str()).second; + assert(Found == Path); + (void)Found; return Sources.createFileID(File, SourceLocation(), SrcMgr::C_User); } @@ -101,8 +95,8 @@ class RewriterTestContext { } std::string getFileContentFromDisk(StringRef Name) { - SmallString<1024> Path(TemporaryDirectory.str()); - llvm::sys::path::append(Path, Name); + std::string Path = TemporaryFiles.lookup(Name); + assert(!Path.empty()); // We need to read directly from the FileManager without relaying through // a FileEntry, as otherwise we'd read through an already opened file // descriptor, which might not see the changes made. @@ -120,7 +114,7 @@ class RewriterTestContext { Rewriter Rewrite; // Will be set once on disk files are generated. - SmallString<128> TemporaryDirectory; + llvm::StringMap<std::string> TemporaryFiles; }; } // end namespace clang diff --git a/unittests/Tooling/TestVisitor.h b/unittests/Tooling/TestVisitor.h index ce3246a..ec751c3 100644 --- a/unittests/Tooling/TestVisitor.h +++ b/unittests/Tooling/TestVisitor.h @@ -31,7 +31,7 @@ namespace clang { /// This is a drop-in replacement for RecursiveASTVisitor itself, with the /// additional capability of running it over a snippet of code. /// -/// Visits template instantiations (but not implicit code) by default. +/// Visits template instantiations and implicit code by default. template <typename T> class TestVisitor : public RecursiveASTVisitor<T> { public: @@ -39,14 +39,15 @@ public: virtual ~TestVisitor() { } - enum Language { Lang_C, Lang_CXX }; + enum Language { Lang_C, Lang_CXX98, Lang_CXX11, Lang_CXX=Lang_CXX98 }; /// \brief Runs the current AST visitor over the given code. bool runOver(StringRef Code, Language L = Lang_CXX) { std::vector<std::string> Args; switch (L) { case Lang_C: Args.push_back("-std=c99"); break; - case Lang_CXX: Args.push_back("-std=c++98"); break; + case Lang_CXX98: Args.push_back("-std=c++98"); break; + case Lang_CXX11: Args.push_back("-std=c++11"); break; } return tooling::runToolOnCodeWithArgs(CreateTestAction(), Code, Args); } @@ -55,6 +56,10 @@ public: return true; } + bool shouldVisitImplicitCode() const { + return true; + } + protected: virtual ASTFrontendAction* CreateTestAction() { return new TestAction(this); diff --git a/unittests/Tooling/ToolingTest.cpp b/unittests/Tooling/ToolingTest.cpp index a9319f2..2c4a8a7 100644 --- a/unittests/Tooling/ToolingTest.cpp +++ b/unittests/Tooling/ToolingTest.cpp @@ -10,12 +10,14 @@ #include "clang/AST/ASTConsumer.h" #include "clang/AST/DeclCXX.h" #include "clang/AST/DeclGroup.h" +#include "clang/Frontend/ASTUnit.h" #include "clang/Frontend/CompilerInstance.h" #include "clang/Frontend/FrontendAction.h" #include "clang/Frontend/FrontendActions.h" #include "clang/Tooling/CompilationDatabase.h" #include "clang/Tooling/Tooling.h" #include "gtest/gtest.h" +#include "llvm/ADT/STLExtras.h" #include <string> namespace clang { @@ -83,6 +85,18 @@ class FindClassDeclXConsumer : public clang::ASTConsumer { private: bool *FoundClassDeclX; }; +bool FindClassDeclX(ASTUnit *AST) { + for (std::vector<Decl *>::iterator i = AST->top_level_begin(), + e = AST->top_level_end(); + i != e; ++i) { + if (CXXRecordDecl* Record = dyn_cast<clang::CXXRecordDecl>(*i)) { + if (Record->getName() == "X") { + return true; + } + } + } + return false; +} } // end namespace TEST(runToolOnCode, FindsClassDecl) { @@ -97,6 +111,16 @@ TEST(runToolOnCode, FindsClassDecl) { EXPECT_FALSE(FoundClassDeclX); } +TEST(buildASTFromCode, FindsClassDecl) { + OwningPtr<ASTUnit> AST(buildASTFromCode("class X;")); + ASSERT_TRUE(AST.get()); + EXPECT_TRUE(FindClassDeclX(AST.get())); + + AST.reset(buildASTFromCode("class Y;")); + ASSERT_TRUE(AST.get()); + EXPECT_FALSE(FindClassDeclX(AST.get())); +} + TEST(newFrontendActionFactory, CreatesFrontendActionFactoryFromType) { OwningPtr<FrontendActionFactory> Factory( newFrontendActionFactory<SyntaxOnlyAction>()); @@ -119,32 +143,62 @@ TEST(newFrontendActionFactory, CreatesFrontendActionFactoryFromFactoryType) { } TEST(ToolInvocation, TestMapVirtualFile) { - clang::FileManager Files((clang::FileSystemOptions())); + IntrusiveRefCntPtr<clang::FileManager> Files( + new clang::FileManager(clang::FileSystemOptions())); std::vector<std::string> Args; Args.push_back("tool-executable"); Args.push_back("-Idef"); Args.push_back("-fsyntax-only"); Args.push_back("test.cpp"); - clang::tooling::ToolInvocation Invocation(Args, new SyntaxOnlyAction, &Files); + clang::tooling::ToolInvocation Invocation(Args, new SyntaxOnlyAction, + Files.getPtr()); Invocation.mapVirtualFile("test.cpp", "#include <abc>\n"); Invocation.mapVirtualFile("def/abc", "\n"); EXPECT_TRUE(Invocation.run()); } -struct VerifyEndCallback : public EndOfSourceFileCallback { - VerifyEndCallback() : Called(0), Matched(false) {} - virtual void run() { - ++Called; +TEST(ToolInvocation, TestVirtualModulesCompilation) { + // FIXME: Currently, this only tests that we don't exit with an error if a + // mapped module.map is found on the include path. In the future, expand this + // test to run a full modules enabled compilation, so we make sure we can + // rerun modules compilations with a virtual file system. + IntrusiveRefCntPtr<clang::FileManager> Files( + new clang::FileManager(clang::FileSystemOptions())); + std::vector<std::string> Args; + Args.push_back("tool-executable"); + Args.push_back("-Idef"); + Args.push_back("-fsyntax-only"); + Args.push_back("test.cpp"); + clang::tooling::ToolInvocation Invocation(Args, new SyntaxOnlyAction, + Files.getPtr()); + Invocation.mapVirtualFile("test.cpp", "#include <abc>\n"); + Invocation.mapVirtualFile("def/abc", "\n"); + // Add a module.map file in the include directory of our header, so we trigger + // the module.map header search logic. + Invocation.mapVirtualFile("def/module.map", "\n"); + EXPECT_TRUE(Invocation.run()); +} + +struct VerifyEndCallback : public SourceFileCallbacks { + VerifyEndCallback() : BeginCalled(0), EndCalled(0), Matched(false) {} + virtual bool handleBeginSource(CompilerInstance &CI, + StringRef Filename) LLVM_OVERRIDE { + ++BeginCalled; + return true; + } + virtual void handleEndSource() { + ++EndCalled; } ASTConsumer *newASTConsumer() { return new FindTopLevelDeclConsumer(&Matched); } - unsigned Called; + unsigned BeginCalled; + unsigned EndCalled; bool Matched; }; #if !defined(_WIN32) -TEST(newFrontendActionFactory, InjectsEndOfSourceFileCallback) { +TEST(newFrontendActionFactory, InjectsSourceFileCallbacks) { VerifyEndCallback EndCallback; FixedCompilationDatabase Compilations("/", std::vector<std::string>()); @@ -159,7 +213,8 @@ TEST(newFrontendActionFactory, InjectsEndOfSourceFileCallback) { Tool.run(newFrontendActionFactory(&EndCallback, &EndCallback)); EXPECT_TRUE(EndCallback.Matched); - EXPECT_EQ(2u, EndCallback.Called); + EXPECT_EQ(2u, EndCallback.BeginCalled); + EXPECT_EQ(2u, EndCallback.EndCalled); } #endif @@ -186,5 +241,97 @@ TEST(runToolOnCode, TestSkipFunctionBody) { "int skipMeNot() { an_error_here }")); } +struct CheckSyntaxOnlyAdjuster: public ArgumentsAdjuster { + bool &Found; + bool &Ran; + + CheckSyntaxOnlyAdjuster(bool &Found, bool &Ran) : Found(Found), Ran(Ran) { } + + virtual CommandLineArguments + Adjust(const CommandLineArguments &Args) LLVM_OVERRIDE { + Ran = true; + for (unsigned I = 0, E = Args.size(); I != E; ++I) { + if (Args[I] == "-fsyntax-only") { + Found = true; + break; + } + } + return Args; + } +}; + +TEST(ClangToolTest, ArgumentAdjusters) { + FixedCompilationDatabase Compilations("/", std::vector<std::string>()); + + ClangTool Tool(Compilations, std::vector<std::string>(1, "/a.cc")); + Tool.mapVirtualFile("/a.cc", "void a() {}"); + + bool Found = false; + bool Ran = false; + Tool.appendArgumentsAdjuster(new CheckSyntaxOnlyAdjuster(Found, Ran)); + Tool.run(newFrontendActionFactory<SyntaxOnlyAction>()); + EXPECT_TRUE(Ran); + EXPECT_TRUE(Found); + + Ran = Found = false; + Tool.clearArgumentsAdjusters(); + Tool.appendArgumentsAdjuster(new CheckSyntaxOnlyAdjuster(Found, Ran)); + Tool.appendArgumentsAdjuster(new ClangSyntaxOnlyAdjuster()); + Tool.run(newFrontendActionFactory<SyntaxOnlyAction>()); + EXPECT_TRUE(Ran); + EXPECT_FALSE(Found); +} + +#ifndef _WIN32 +TEST(ClangToolTest, BuildASTs) { + FixedCompilationDatabase Compilations("/", std::vector<std::string>()); + + std::vector<std::string> Sources; + Sources.push_back("/a.cc"); + Sources.push_back("/b.cc"); + ClangTool Tool(Compilations, Sources); + + Tool.mapVirtualFile("/a.cc", "void a() {}"); + Tool.mapVirtualFile("/b.cc", "void b() {}"); + + std::vector<ASTUnit *> ASTs; + EXPECT_EQ(0, Tool.buildASTs(ASTs)); + EXPECT_EQ(2u, ASTs.size()); + + llvm::DeleteContainerPointers(ASTs); +} + +struct TestDiagnosticConsumer : public DiagnosticConsumer { + TestDiagnosticConsumer() : NumDiagnosticsSeen(0) {} + virtual void HandleDiagnostic(DiagnosticsEngine::Level DiagLevel, + const Diagnostic &Info) { + ++NumDiagnosticsSeen; + } + unsigned NumDiagnosticsSeen; +}; + +TEST(ClangToolTest, InjectDiagnosticConsumer) { + FixedCompilationDatabase Compilations("/", std::vector<std::string>()); + ClangTool Tool(Compilations, std::vector<std::string>(1, "/a.cc")); + Tool.mapVirtualFile("/a.cc", "int x = undeclared;"); + TestDiagnosticConsumer Consumer; + Tool.setDiagnosticConsumer(&Consumer); + Tool.run(newFrontendActionFactory<SyntaxOnlyAction>()); + EXPECT_EQ(1u, Consumer.NumDiagnosticsSeen); +} + +TEST(ClangToolTest, InjectDiagnosticConsumerInBuildASTs) { + FixedCompilationDatabase Compilations("/", std::vector<std::string>()); + ClangTool Tool(Compilations, std::vector<std::string>(1, "/a.cc")); + Tool.mapVirtualFile("/a.cc", "int x = undeclared;"); + TestDiagnosticConsumer Consumer; + Tool.setDiagnosticConsumer(&Consumer); + std::vector<ASTUnit*> ASTs; + Tool.buildASTs(ASTs); + EXPECT_EQ(1u, ASTs.size()); + EXPECT_EQ(1u, Consumer.NumDiagnosticsSeen); +} +#endif + } // end namespace tooling } // end namespace clang |