Clang Project

clang_source_code/unittests/AST/ASTTypeTraitsTest.cpp
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
14using namespace clang::ast_matchers;
15
16namespace clang {
17namespace ast_type_traits {
18
19TEST(ASTNodeKind, NoKind) {
20  EXPECT_FALSE(ASTNodeKind().isBaseOf(ASTNodeKind()));
21  EXPECT_FALSE(ASTNodeKind().isSame(ASTNodeKind()));
22}
23
24template <typename T> static ASTNodeKind DNT() {
25  return ASTNodeKind::getFromNodeKind<T>();
26}
27
28TEST(ASTNodeKind, IsNone) {
29  EXPECT_TRUE(ASTNodeKind().isNone());
30  EXPECT_FALSE(DNT<Decl>().isNone());
31  EXPECT_FALSE(DNT<VarDecl>().isNone());
32}
33
34TEST(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
42TEST(ASTNodeKind, BaseDistances) {
43  unsigned Distance = 1;
44  EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<Expr>(), &Distance));
45  EXPECT_EQ(0u, Distance);
46
47  EXPECT_TRUE(DNT<Stmt>().isBaseOf(DNT<IfStmt>(), &Distance));
48  EXPECT_EQ(1u, Distance);
49
50  Distance = 3;
51  EXPECT_TRUE(DNT<DeclaratorDecl>().isBaseOf(DNT<ParmVarDecl>(), &Distance));
52  EXPECT_EQ(2u, Distance);
53}
54
55TEST(ASTNodeKind, SameBase) {
56  EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<CallExpr>()));
57  EXPECT_TRUE(DNT<Expr>().isBaseOf(DNT<BinaryOperator>()));
58  EXPECT_FALSE(DNT<CallExpr>().isBaseOf(DNT<BinaryOperator>()));
59  EXPECT_FALSE(DNT<BinaryOperator>().isBaseOf(DNT<CallExpr>()));
60}
61
62TEST(ASTNodeKind, DiffBase) {
63  EXPECT_FALSE(DNT<Expr>().isBaseOf(DNT<ArrayType>()));
64  EXPECT_FALSE(DNT<QualType>().isBaseOf(DNT<FunctionDecl>()));
65  EXPECT_FALSE(DNT<Type>().isSame(DNT<QualType>()));
66}
67
68TEST(ASTNodeKind, MostDerivedType) {
69  EXPECT_TRUE(DNT<BinaryOperator>().isSame(
70      ASTNodeKind::getMostDerivedType(DNT<Expr>(), DNT<BinaryOperator>())));
71  EXPECT_TRUE(DNT<BinaryOperator>().isSame(
72      ASTNodeKind::getMostDerivedType(DNT<BinaryOperator>(), DNT<Expr>())));
73  EXPECT_TRUE(DNT<VarDecl>().isSame(
74      ASTNodeKind::getMostDerivedType(DNT<VarDecl>(), DNT<VarDecl>())));
75
76  // Not related. Returns nothing.
77  EXPECT_TRUE(
78      ASTNodeKind::getMostDerivedType(DNT<IfStmt>(), DNT<VarDecl>()).isNone());
79  EXPECT_TRUE(ASTNodeKind::getMostDerivedType(DNT<IfStmt>(),
80                                              DNT<BinaryOperator>()).isNone());
81}
82
83TEST(ASTNodeKind, MostDerivedCommonAncestor) {
84  EXPECT_TRUE(DNT<Expr>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
85      DNT<Expr>(), DNT<BinaryOperator>())));
86  EXPECT_TRUE(DNT<Expr>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
87      DNT<BinaryOperator>(), DNT<Expr>())));
88  EXPECT_TRUE(DNT<VarDecl>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
89      DNT<VarDecl>(), DNT<VarDecl>())));
90
91  // A little related. Returns the ancestor.
92  EXPECT_TRUE(
93      DNT<NamedDecl>().isSame(ASTNodeKind::getMostDerivedCommonAncestor(
94          DNT<CXXMethodDecl>(), DNT<RecordDecl>())));
95
96  // Not related. Returns nothing.
97  EXPECT_TRUE(ASTNodeKind::getMostDerivedCommonAncestor(
98                  DNT<IfStmt>(), DNT<VarDecl>()).isNone());
99}
100
101struct Foo {};
102
103TEST(ASTNodeKind, UnknownKind) {
104  // We can construct one, but it is nowhere in the hierarchy.
105  EXPECT_FALSE(DNT<Foo>().isSame(DNT<Foo>()));
106}
107
108TEST(ASTNodeKind, Name) {
109  EXPECT_EQ("<None>", ASTNodeKind().asStringRef());
110#define VERIFY_NAME(Node) EXPECT_EQ(#Node, DNT<Node>().asStringRef());
111  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(TemplateArgument);
112  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(NestedNameSpecifierLoc);
113  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(QualType);
114  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(TypeLoc);
115  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(CXXCtorInitializer);
116  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(NestedNameSpecifier);
117  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(Decl);
118  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(CXXRecordDecl);
119  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(Stmt);
120  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(CallExpr);
121  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(Type);
122  ().asStringRef());" file_link="#110" macro="true">VERIFY_NAME(ConstantArrayType);
123#undef VERIFY_NAME
124}
125
126TEST(DynTypedNode, DeclSourceRange) {
127  RangeVerifier<DynTypedNode> Verifier;
128  Verifier.expectRange(1, 1, 1, 11);
129  EXPECT_TRUE(Verifier.match("void f() {}", decl()));
130}
131
132TEST(DynTypedNode, StmtSourceRange) {
133  RangeVerifier<DynTypedNode> Verifier;
134  Verifier.expectRange(1, 10, 1, 11);
135  EXPECT_TRUE(Verifier.match("void f() {}", stmt()));
136}
137
138TEST(DynTypedNode, TypeLocSourceRange) {
139  RangeVerifier<DynTypedNode> Verifier;
140  Verifier.expectRange(1, 1, 1, 8);
141  EXPECT_TRUE(Verifier.match("void f() {}", typeLoc(loc(functionType()))));
142}
143
144TEST(DynTypedNode, NNSLocSourceRange) {
145  RangeVerifier<DynTypedNode> Verifier;
146  Verifier.expectRange(1, 33, 1, 34);
147  EXPECT_TRUE(Verifier.match("namespace N { typedef void T; } N::T f() {}",
148                             nestedNameSpecifierLoc()));
149}
150
151TEST(DynTypedNode, DeclDump) {
152  DumpVerifier Verifier;
153  Verifier.expectSubstring("FunctionDecl");
154  EXPECT_TRUE(Verifier.match("void f() {}", functionDecl()));
155}
156
157TEST(DynTypedNode, StmtDump) {
158  DumpVerifier Verifier;
159  Verifier.expectSubstring("CompoundStmt");
160  EXPECT_TRUE(Verifier.match("void f() {}", stmt()));
161}
162
163TEST(DynTypedNode, DeclPrint) {
164  PrintVerifier Verifier;
165  Verifier.expectString("void f() {\n}\n");
166  EXPECT_TRUE(Verifier.match("void f() {}", functionDecl()));
167}
168
169TEST(DynTypedNode, StmtPrint) {
170  PrintVerifier Verifier;
171  Verifier.expectString("{\n}\n");
172  EXPECT_TRUE(Verifier.match("void f() {}", stmt()));
173}
174
175TEST(DynTypedNode, QualType) {
176  QualType Q;
177  DynTypedNode Node = DynTypedNode::create(Q);
178  EXPECT_TRUE(Node == Node);
179  EXPECT_FALSE(Node < Node);
180}
181
182}  // namespace ast_type_traits
183}  // namespace clang
184
CodeThinker, Enjoy your reading code