1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/*
This file is part of the clazy static checker.
Copyright (C) 2016 Sergio Martins <smartins@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef CLAZY_CONTEXT_UTILS_H
#define CLAZY_CONTEXT_UTILS_H
#include "clazy_export.h"
#include "TypeUtils.h"
#include <clang/AST/DeclBase.h>
#include <clang/AST/Decl.h>
#include <clang/AST/DeclCXX.h>
#include <clang/AST/Stmt.h>
#include <vector>
#include <string>
namespace clang {
class ValueDecl;
class DeclContext;
class SourceManager;
class SourceLocation;
class CXXMethodDecl;
class ParentMap;
}
namespace clazy
{
/**
* Returns true if a decl is inside a function, instead of say a class field.
* This returns true if "QList<int> l;" is a local variable, instead of being a class field such
* as struct Foo { QList<int> l; }
*/
inline bool isValueDeclInFunctionContext(const clang::ValueDecl *valueDecl)
{
auto context = valueDecl ? valueDecl->getDeclContext() : nullptr;
return context && llvm::isa<clang::FunctionDecl>(context) && !llvm::isa<clang::ParmVarDecl>(valueDecl);
}
/**
* Returns the list of scopes for a decl context (namespaces, classes, inner classes, etc)
* The inner ones are at the beginning of the list
*/
CLAZYLIB_EXPORT std::vector<clang::DeclContext *> contextsForDecl(clang::DeclContext *);
/**
* Returns the first context for a decl.
*/
inline clang::DeclContext * contextForDecl(clang::Decl *decl)
{
if (!decl)
return nullptr;
if (auto context = llvm::dyn_cast<clang::DeclContext>(decl))
return context;
return decl->getDeclContext();
}
inline clang::NamespaceDecl *namespaceForDecl(clang::Decl *decl)
{
if (!decl)
return nullptr;
clang::DeclContext *declContext = decl->getDeclContext();
while (declContext) {
if (auto ns = llvm::dyn_cast<clang::NamespaceDecl>(declContext))
return ns;
declContext = declContext->getParent();
}
return nullptr;
}
inline clang::NamespaceDecl *namespaceForType(clang::QualType q)
{
if (q.isNull())
return nullptr;
q = TypeUtils::pointeeQualType(q);
// Check if it's a class, struct, union or enum
clang::TagDecl *rec = q->getAsTagDecl();
if (rec)
return namespaceForDecl(rec);
// Or maybe it's a typedef to a builtin type:
auto typeDefType = q->getAs<clang::TypedefType>();
if (typeDefType) {
clang::TypedefNameDecl* typedeff = typeDefType->getDecl();
return namespaceForDecl(typedeff);
}
return nullptr;
}
inline clang::NamespaceDecl *namespaceForFunction(clang::FunctionDecl *func)
{
if (auto ns = llvm::dyn_cast<clang::NamespaceDecl>(func->getDeclContext()))
return ns;
return namespaceForDecl(func);
}
/**
* Returns the first context of type T in which the specified context is in.
* Contexts are namespaces, classes, inner classes, functions, etc.
*/
template <typename T>
T* firstContextOfType(clang::DeclContext *context)
{
if (!context)
return nullptr;
if (llvm::isa<T>(context))
return llvm::cast<T>(context);
return clazy::firstContextOfType<T>(context->getParent());
}
/**
* Returns fully/semi-fully qualified name for a method, but doesn't over-qualify with namespaces
* which we're already in.
*
* if currentScope == nullptr will return a fully qualified name
*/
CLAZYLIB_EXPORT std::string getMostNeededQualifiedName(const clang::SourceManager &sourceManager,
clang::CXXMethodDecl *method,
clang::DeclContext *currentScope,
clang::SourceLocation usageLoc,
bool honourUsingDirectives);
/**
* Returns true, if in a specific context, we can take the address of a method
* for example doing &ClassName::SomePrivateMember might not be possible if the member is private
* but might be possible if we're in a context which is friend of ClassName
* Or it might be protected but context is a derived class
*
* When inside a derived class scope it's possible to take the address of a protected base method
* but only if you qualify it with the derived class name, so &Derived::baseMethod, instead of &Base::baseMethod
* If this was the case then isSpecialProtectedCase will be true
*/
CLAZYLIB_EXPORT bool canTakeAddressOf(clang::CXXMethodDecl *method,
clang::DeclContext *context,
bool &isSpecialProtectedCase);
}
#endif
|
