Debian Codegraph @

llvm-project/clang/unittests/AST/ASTTypeTraitsTest.cpp

raw
1 //===- unittest/AST/ASTTypeTraits.cpp - AST type traits unit tests ------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===--------------------------------------------------------------------===//
8
9
10 #include "clang/AST/ASTTypeTraits.h"
11 #include "MatchVerifier.h"
12 #include "gtest/gtest.h"
13
14 using namespace clang::ast_matchers;
15
16 namespace clang {
17 namespace {
18
19 TEST(ASTNodeKind, NoKind) {
20 EXPECT_FALSE(ASTNodeKind().isBaseOf(ASTNodeKind()));
21 EXPECT_FALSE(ASTNodeKind().isSame(ASTNodeKind()));
22 }
23
24 template <typename T> static ASTNodeKind DNT() {
25 return ASTNodeKind::getFromNodeKind<T>();
26 }
27
28 TEST(ASTNodeKind, IsNone) {
29 EXPECT_TRUE(ASTNodeKind().isNone());
30 EXPECT_FALSE(DNT<Decl>().isNone());
31 EXPECT_FALSE(DNT<VarDecl>().isNone());
32 }
33
34 TEST(ASTNodeKind, Bases) {
35 EXPECT_TRUE(DNT<Decl>().isBaseOf(DNT<VarDecl>()));
36 EXPECT_FALSE(DNT<Decl>().isSame(DNT<VarDecl>()));
37 EXPECT_FALSE(DNT<VarDecl>().isBaseOf(DNT<Decl>()));
38
39 EXPECT_TRUE(DNT<Decl>().isSame(DNT<Decl>()));
40 }
41
42 TEST(DynTypedNode, Clades) {
43 EXPECT_TRUE(DNT<Stmt>().getCladeKind().isSame(DNT<Stmt>()));
44 EXPECT_TRUE(DNT<Decl>().getCladeKind().isSame(DNT<Decl>()));
45
46 EXPECT_TRUE(DNT<CXXMethodDecl>().getCladeKind().isSame(DNT<Decl>()));
47 EXPECT_TRUE(DNT<CXXMemberCallExpr>().getCladeKind().isSame(DNT<Stmt>()));
48
49 EXPECT_FALSE(DNT<CXXMemberCallExpr>().getCladeKind().isSame(DNT<Decl>()));
50
51 EXPECT_TRUE(ASTNodeKind().getCladeKind().isNone());
52 }
53
54 TEST(ASTNodeKind, BaseDistances) {
55 unsigned Distance = 1;
56 EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<Expr>(), &Distance));
57 EXPECT_EQ(0u, Distance);
58
59 EXPECT_TRUE(DNT<Stmt>().isBaseOf(DNT<IfStmt>(), &Distance));
60 EXPECT_EQ(1u, Distance);
61
62 Distance = 3;
63 EXPECT_TRUE(DNT<DeclaratorDecl>().isBaseOf(DNT<ParmVarDecl>(), &Distance));
64 EXPECT_EQ(2u, Distance);
65 }
66
67 TEST(ASTNodeKind, SameBase) {
68 EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<CallExpr>()));
69 EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<BinaryOperator>()));
70 EXPECT_FALSE(DNT<CallExpr>().isBaseOf(DNT<BinaryOperator>()));
71 EXPECT_FALSE(DNT<BinaryOperator>().isBaseOf(DNT<CallExpr>()));
72 }
73
74 TEST(ASTNodeKind, DiffBase) {
75 EXPECT_FALSE(DNT<Expr>().isBaseOf(DNT<ArrayType>()));
76 EXPECT_FALSE(DNT<QualType>().isBaseOf(DNT<FunctionDecl>()));
77 EXPECT_FALSE(DNT<Type>().isSame(DNT<QualType>()));
78 }
79
80 TEST(ASTNodeKind, MostDerivedType) {
81 EXPECT_TRUE(DNT<BinaryOperator>().isSame(
82 ASTNodeKind::getMostDerivedType(DNT<Expr>(), DNT<BinaryOperator>())));
83 EXPECT_TRUE(DNT<BinaryOperator>().isSame(
84 ASTNodeKind::getMostDerivedType(DNT<BinaryOperator>(), DNT<Expr>())));
85 EXPECT_TRUE(DNT<VarDecl>().isSame(
86 ASTNodeKind::getMostDerivedType(DNT<VarDecl>(), DNT<VarDecl>())));
87
88 // Not related. Returns nothing.
89 EXPECT_TRUE(
90 ASTNodeKind::getMostDerivedType(DNT<IfStmt>(), DNT<VarDecl>()).isNone());
91 EXPECT_TRUE(ASTNodeKind::getMostDerivedType(DNT<IfStmt>(),
92 DNT<BinaryOperator>()).isNone());
93 }
94
95 TEST(ASTNodeKind, MostDerivedCommonAncestor) {
96 EXPECT_TRUE(DNT<Expr>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
97 DNT<Expr>(), DNT<BinaryOperator>())));
98 EXPECT_TRUE(DNT<Expr>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
99 DNT<BinaryOperator>(), DNT<Expr>())));
100 EXPECT_TRUE(DNT<VarDecl>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
101 DNT<VarDecl>(), DNT<VarDecl>())));
102
103 // A little related. Returns the ancestor.
104 EXPECT_TRUE(
105 DNT<NamedDecl>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
106 DNT<CXXMethodDecl>(), DNT<RecordDecl>())));
107
108 // Not related. Returns nothing.
109 EXPECT_TRUE(ASTNodeKind::getMostDerivedCommonAncestor(
110 DNT<IfStmt>(), DNT<VarDecl>()).isNone());
111 }
112
113 struct Foo {};
114
115 TEST(ASTNodeKind, UnknownKind) {
116 // We can construct one, but it is nowhere in the hierarchy.
117 EXPECT_FALSE(DNT<Foo>().isSame(DNT<Foo>()));
118 }
119
120 template <typename T>
121 constexpr bool HasPointerIdentity =
122 ASTNodeKind::getFromNodeKind<T>().hasPointerIdentity();
123
124 TEST(ASTNodeKind, ConstexprHasPointerIdentity) {
125 EXPECT_TRUE(HasPointerIdentity<Decl>);
126 EXPECT_TRUE(HasPointerIdentity<Stmt>);
127 EXPECT_FALSE(HasPointerIdentity<TypeLoc>);
128 EXPECT_FALSE(HasPointerIdentity<QualType>);
129 EXPECT_FALSE(HasPointerIdentity<Foo>);
130
131 constexpr bool DefaultConstructedHasPointerIdentity =
132 ASTNodeKind().hasPointerIdentity();
133 EXPECT_FALSE(DefaultConstructedHasPointerIdentity);
134 }
135
136 template <typename T, typename U>
137 constexpr bool NodeKindIsSame =
138 ASTNodeKind::getFromNodeKind<T>().isSame(ASTNodeKind::getFromNodeKind<U>());
139
140 TEST(ASTNodeKind, ConstexprIsSame) {
141 EXPECT_TRUE((NodeKindIsSame<Decl, Decl>));
142 EXPECT_FALSE((NodeKindIsSame<Decl, VarDecl>));
143 EXPECT_FALSE((NodeKindIsSame<Foo, Foo>));
144
145 constexpr bool DefaultConstructedIsSameToDefaultConstructed =
146 ASTNodeKind().isSame(ASTNodeKind());
147 EXPECT_FALSE(DefaultConstructedIsSameToDefaultConstructed);
148 }
149
150 template <typename T>
151 constexpr bool NodeKindIsNone = ASTNodeKind::getFromNodeKind<T>().isNone();
152
153 TEST(ASTNodeKind, ConstexprIsNone) {
154 EXPECT_FALSE(NodeKindIsNone<Decl>);
155 EXPECT_TRUE(NodeKindIsNone<Foo>);
156
157 constexpr bool DefaultConstructedIsNone = ASTNodeKind().isNone();
158 EXPECT_TRUE(DefaultConstructedIsNone);
159 }
160
161 TEST(ASTNodeKind, Name) {
162 EXPECT_EQ("<None>", ASTNodeKind().asStringRef());
163 #define VERIFY_NAME(Node) EXPECT_EQ(#Node, DNT<Node>().asStringRef());
164 VERIFY_NAME(TemplateArgument);
165 VERIFY_NAME(NestedNameSpecifierLoc);
166 VERIFY_NAME(QualType);
167 VERIFY_NAME(TypeLoc);
168 VERIFY_NAME(CXXCtorInitializer);
169 VERIFY_NAME(NestedNameSpecifier);
170 VERIFY_NAME(Decl);
171 VERIFY_NAME(CXXRecordDecl);
172 VERIFY_NAME(Stmt);
173 VERIFY_NAME(CallExpr);
174 VERIFY_NAME(Type);
175 VERIFY_NAME(ConstantArrayType);
176 VERIFY_NAME(NonNullAttr);
177 #undef VERIFY_NAME
178 }
179
180 TEST(DynTypedNode, DeclSourceRange) {
181 RangeVerifier<DynTypedNode> Verifier;
182 Verifier.expectRange(1, 1, 1, 11);
183 EXPECT_TRUE(Verifier.match("void f() {}", decl()));
184 }
185
186 TEST(DynTypedNode, StmtSourceRange) {
187 RangeVerifier<DynTypedNode> Verifier;
188 Verifier.expectRange(1, 10, 1, 11);
189 EXPECT_TRUE(Verifier.match("void f() {}", stmt()));
190 }
191
192 TEST(DynTypedNode, TypeLocSourceRange) {
193 RangeVerifier<DynTypedNode> Verifier;
194 Verifier.expectRange(1, 1, 1, 8);
195 EXPECT_TRUE(Verifier.match("void f() {}", typeLoc(loc(functionType()))));
196 }
197
198 TEST(DynTypedNode, NNSLocSourceRange) {
199 RangeVerifier<DynTypedNode> Verifier;
200 Verifier.expectRange(1, 33, 1, 34);
201 EXPECT_TRUE(Verifier.match("namespace N { typedef void T; } N::T f() {}",
202 nestedNameSpecifierLoc()));
203 }
204
205 TEST(DynTypedNode, AttrSourceRange) {
206 RangeVerifier<DynTypedNode> Verifier;
207 Verifier.expectRange(1, 31, 1, 31);
208 EXPECT_TRUE(Verifier.match("void x(char *y __attribute__((nonnull)) );",
209 ast_matchers::attr()));
210 }
211
212 TEST(DynTypedNode, DeclDump) {
213 DumpVerifier Verifier;
214 Verifier.expectSubstring("FunctionDecl");
215 EXPECT_TRUE(Verifier.match("void f() {}", functionDecl()));
216 }
217
218 TEST(DynTypedNode, StmtDump) {
219 DumpVerifier Verifier;
220 Verifier.expectSubstring("CompoundStmt");
221 EXPECT_TRUE(Verifier.match("void f() {}", stmt()));
222 }
223
224 TEST(DynTypedNode, DeclPrint) {
225 PrintVerifier Verifier;
226 Verifier.expectString("void f() {\n}\n");
227 EXPECT_TRUE(Verifier.match("void f() {}", functionDecl()));
228 }
229
230 TEST(DynTypedNode, StmtPrint) {
231 PrintVerifier Verifier;
232 Verifier.expectString("{\n}\n");
233 EXPECT_TRUE(Verifier.match("void f() {}", stmt()));
234 }
235
236 TEST(DynTypedNode, QualType) {
237 QualType Q;
238 DynTypedNode Node = DynTypedNode::create(Q);
239 EXPECT_TRUE(Node == Node);
240 EXPECT_FALSE(Node < Node);
241 }
242
243 TEST(DynTypedNode, TypeLoc) {
244 std::string code = R"cc(void example() { int abc; })cc";
245 auto AST = clang::tooling::buildASTFromCode(code);
246 auto matches =
247 match(traverse(TK_AsIs,
248 varDecl(hasName("abc"), hasTypeLoc(typeLoc().bind("tl")))),
249 AST->getASTContext());
250 EXPECT_EQ(matches.size(), 1u);
251
252 const auto &tl = *matches[0].getNodeAs<TypeLoc>("tl");
253 DynTypedNode Node = DynTypedNode::create(tl);
254 EXPECT_TRUE(Node == Node);
255 EXPECT_FALSE(Node < Node);
256 }
257
258 TEST(DynTypedNode, PointerTypeLoc) {
259 std::string code = R"cc(void example() { int *abc; })cc";
260 auto AST = clang::tooling::buildASTFromCode(code);
261 auto matches =
262 match(traverse(TK_AsIs, varDecl(hasName("abc"),
263 hasTypeLoc(typeLoc().bind("ptl")))),
264 AST->getASTContext());
265 EXPECT_EQ(matches.size(), 1u);
266
267 const auto &tl = *matches[0].getNodeAs<TypeLoc>("ptl");
268 DynTypedNode TypeLocNode = DynTypedNode::create(tl);
269 EXPECT_TRUE(TypeLocNode == TypeLocNode);
270 EXPECT_FALSE(TypeLocNode < TypeLocNode);
271
272 const auto &ptl = *matches[0].getNodeAs<PointerTypeLoc>("ptl");
273 EXPECT_EQ(&tl, &ptl);
274 DynTypedNode PointerTypeLocNode = DynTypedNode::create(ptl);
275 EXPECT_TRUE(PointerTypeLocNode == PointerTypeLocNode);
276 EXPECT_FALSE(PointerTypeLocNode < PointerTypeLocNode);
277 }
278
279 } // namespace
280 } // namespace clang