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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
//===--- Analyzer.cpp - Analysis for indexing information -------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file implements the Analyzer interface.
//
//===----------------------------------------------------------------------===//
#include "clang/Index/Analyzer.h"
#include "clang/Index/Entity.h"
#include "clang/Index/TranslationUnit.h"
#include "clang/Index/Handlers.h"
#include "clang/Index/ASTLocation.h"
#include "clang/Index/GlobalSelector.h"
#include "clang/Index/DeclReferenceMap.h"
#include "clang/Index/SelectorMap.h"
#include "clang/Index/IndexProvider.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/ExprObjC.h"
#include "llvm/ADT/SmallSet.h"
using namespace clang;
using namespace idx;
namespace {
//===----------------------------------------------------------------------===//
// DeclEntityAnalyzer Implementation
//===----------------------------------------------------------------------===//
class DeclEntityAnalyzer : public TranslationUnitHandler {
Entity Ent;
TULocationHandler &TULocHandler;
public:
DeclEntityAnalyzer(Entity ent, TULocationHandler &handler)
: Ent(ent), TULocHandler(handler) { }
virtual void Handle(TranslationUnit *TU) {
assert(TU && "Passed null translation unit");
Decl *D = Ent.getDecl(TU->getASTContext());
assert(D && "Couldn't resolve Entity");
for (Decl::redecl_iterator I = D->redecls_begin(),
E = D->redecls_end(); I != E; ++I)
TULocHandler.Handle(TULocation(TU, ASTLocation(*I)));
}
};
//===----------------------------------------------------------------------===//
// RefEntityAnalyzer Implementation
//===----------------------------------------------------------------------===//
class RefEntityAnalyzer : public TranslationUnitHandler {
Entity Ent;
TULocationHandler &TULocHandler;
public:
RefEntityAnalyzer(Entity ent, TULocationHandler &handler)
: Ent(ent), TULocHandler(handler) { }
virtual void Handle(TranslationUnit *TU) {
assert(TU && "Passed null translation unit");
Decl *D = Ent.getDecl(TU->getASTContext());
assert(D && "Couldn't resolve Entity");
NamedDecl *ND = dyn_cast<NamedDecl>(D);
if (!ND)
return;
DeclReferenceMap &RefMap = TU->getDeclReferenceMap();
for (DeclReferenceMap::astlocation_iterator
I = RefMap.refs_begin(ND), E = RefMap.refs_end(ND); I != E; ++I)
TULocHandler.Handle(TULocation(TU, *I));
}
};
//===----------------------------------------------------------------------===//
// RefSelectorAnalyzer Implementation
//===----------------------------------------------------------------------===//
/// \brief Accepts an ObjC method and finds all message expressions that this
/// method may respond to.
class RefSelectorAnalyzer : public TranslationUnitHandler {
Program &Prog;
TULocationHandler &TULocHandler;
// The original ObjCInterface associated with the method.
Entity IFaceEnt;
GlobalSelector GlobSel;
bool IsInstanceMethod;
/// \brief Super classes of the ObjCInterface.
typedef llvm::SmallSet<Entity, 16> EntitiesSetTy;
EntitiesSetTy HierarchyEntities;
public:
RefSelectorAnalyzer(ObjCMethodDecl *MD,
Program &prog, TULocationHandler &handler)
: Prog(prog), TULocHandler(handler) {
assert(MD);
// FIXME: Protocol methods.
assert(!isa<ObjCProtocolDecl>(MD->getDeclContext()) &&
"Protocol methods not supported yet");
ObjCInterfaceDecl *IFD = MD->getClassInterface();
assert(IFD);
IFaceEnt = Entity::get(IFD, Prog);
GlobSel = GlobalSelector::get(MD->getSelector(), Prog);
IsInstanceMethod = MD->isInstanceMethod();
for (ObjCInterfaceDecl *Cls = IFD->getSuperClass();
Cls; Cls = Cls->getSuperClass())
HierarchyEntities.insert(Entity::get(Cls, Prog));
}
virtual void Handle(TranslationUnit *TU) {
assert(TU && "Passed null translation unit");
ASTContext &Ctx = TU->getASTContext();
// Null means it doesn't exist in this translation unit.
ObjCInterfaceDecl *IFace =
cast_or_null<ObjCInterfaceDecl>(IFaceEnt.getDecl(Ctx));
Selector Sel = GlobSel.getSelector(Ctx);
SelectorMap &SelMap = TU->getSelectorMap();
for (SelectorMap::astlocation_iterator
I = SelMap.refs_begin(Sel), E = SelMap.refs_end(Sel); I != E; ++I) {
if (ValidReference(*I, IFace))
TULocHandler.Handle(TULocation(TU, *I));
}
}
/// \brief Determines whether the given message expression is likely to end
/// up at the given interface decl.
///
/// It returns true "eagerly", meaning it will return false only if it can
/// "prove" statically that the interface cannot accept this message.
bool ValidReference(ASTLocation ASTLoc, ObjCInterfaceDecl *IFace) {
assert(ASTLoc.isStmt());
// FIXME: Finding @selector references should be through another Analyzer
// method, like FindSelectors.
if (isa<ObjCSelectorExpr>(ASTLoc.AsStmt()))
return false;
ObjCInterfaceDecl *MsgD = 0;
ObjCMessageExpr *Msg = cast<ObjCMessageExpr>(ASTLoc.AsStmt());
if (Msg->getReceiver()) {
const ObjCObjectPointerType *OPT =
Msg->getReceiver()->getType()->getAsObjCInterfacePointerType();
// Can be anything! Accept it as a possibility..
if (!OPT || OPT->isObjCIdType() || OPT->isObjCQualifiedIdType())
return true;
// Expecting class method.
if (OPT->isObjCClassType() || OPT->isObjCQualifiedClassType())
return !IsInstanceMethod;
MsgD = OPT->getInterfaceDecl();
assert(MsgD);
// Should be an instance method.
if (!IsInstanceMethod)
return false;
} else {
// Expecting class method.
if (IsInstanceMethod)
return false;
MsgD = Msg->getClassInfo().Decl;
// FIXME: Case when we only have an identifier.
assert(MsgD && "Identifier only");
}
assert(MsgD);
// Same interface ? We have a winner!
if (MsgD == IFace)
return true;
// If the message interface is a superclass of the original interface,
// accept this message as a possibility.
if (HierarchyEntities.count(Entity::get(MsgD, Prog)))
return true;
// If the message interface is a subclass of the original interface, accept
// the message unless there is a subclass in the hierarchy that will
// "steal" the message (thus the message "will go" to the subclass and not
/// the original interface).
if (IFace) {
Selector Sel = Msg->getSelector();
for (ObjCInterfaceDecl *Cls = MsgD; Cls; Cls = Cls->getSuperClass()) {
if (Cls == IFace)
return true;
if (Cls->getMethod(Sel, IsInstanceMethod))
return false;
}
}
// The interfaces are unrelated, don't accept the message.
return false;
}
};
//===----------------------------------------------------------------------===//
// MessageAnalyzer Implementation
//===----------------------------------------------------------------------===//
/// \brief Accepts an ObjC message expression and finds all methods that may
/// respond to it.
class MessageAnalyzer : public TranslationUnitHandler {
Program &Prog;
TULocationHandler &TULocHandler;
// The ObjCInterface associated with the message. Can be null/invalid.
Entity MsgIFaceEnt;
GlobalSelector GlobSel;
bool CanBeInstanceMethod;
bool CanBeClassMethod;
/// \brief Super classes of the ObjCInterface.
typedef llvm::SmallSet<Entity, 16> EntitiesSetTy;
EntitiesSetTy HierarchyEntities;
/// \brief The interface in the message interface hierarchy that "intercepts"
/// the selector.
Entity ReceiverIFaceEnt;
public:
MessageAnalyzer(ObjCMessageExpr *Msg,
Program &prog, TULocationHandler &handler)
: Prog(prog), TULocHandler(handler),
CanBeInstanceMethod(false),
CanBeClassMethod(false) {
assert(Msg);
ObjCInterfaceDecl *MsgD = 0;
while (true) {
if (Msg->getReceiver() == 0) {
CanBeClassMethod = true;
MsgD = Msg->getClassInfo().Decl;
// FIXME: Case when we only have an identifier.
assert(MsgD && "Identifier only");
break;
}
const ObjCObjectPointerType *OPT =
Msg->getReceiver()->getType()->getAsObjCInterfacePointerType();
if (!OPT || OPT->isObjCIdType() || OPT->isObjCQualifiedIdType()) {
CanBeInstanceMethod = CanBeClassMethod = true;
break;
}
if (OPT->isObjCClassType() || OPT->isObjCQualifiedClassType()) {
CanBeClassMethod = true;
break;
}
MsgD = OPT->getInterfaceDecl();
assert(MsgD);
CanBeInstanceMethod = true;
break;
}
assert(CanBeInstanceMethod || CanBeClassMethod);
Selector sel = Msg->getSelector();
assert(!sel.isNull());
MsgIFaceEnt = Entity::get(MsgD, Prog);
GlobSel = GlobalSelector::get(sel, Prog);
if (MsgD) {
for (ObjCInterfaceDecl *Cls = MsgD->getSuperClass();
Cls; Cls = Cls->getSuperClass())
HierarchyEntities.insert(Entity::get(Cls, Prog));
// Find the interface in the hierarchy that "receives" the message.
for (ObjCInterfaceDecl *Cls = MsgD; Cls; Cls = Cls->getSuperClass()) {
bool isReceiver = false;
ObjCInterfaceDecl::lookup_const_iterator Meth, MethEnd;
for (llvm::tie(Meth, MethEnd) = Cls->lookup(sel);
Meth != MethEnd; ++Meth) {
if (ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(*Meth))
if ((MD->isInstanceMethod() && CanBeInstanceMethod) ||
(MD->isClassMethod() && CanBeClassMethod)) {
isReceiver = true;
break;
}
}
if (isReceiver) {
ReceiverIFaceEnt = Entity::get(Cls, Prog);
break;
}
}
}
}
virtual void Handle(TranslationUnit *TU) {
assert(TU && "Passed null translation unit");
ASTContext &Ctx = TU->getASTContext();
// Null means it doesn't exist in this translation unit or there was no
// interface that was determined to receive the original message.
ObjCInterfaceDecl *ReceiverIFace =
cast_or_null<ObjCInterfaceDecl>(ReceiverIFaceEnt.getDecl(Ctx));
// No subclass for the original receiver interface, so it remains the
// receiver.
if (ReceiverIFaceEnt.isValid() && ReceiverIFace == 0)
return;
// Null means it doesn't exist in this translation unit or there was no
// interface associated with the message in the first place.
ObjCInterfaceDecl *MsgIFace =
cast_or_null<ObjCInterfaceDecl>(MsgIFaceEnt.getDecl(Ctx));
Selector Sel = GlobSel.getSelector(Ctx);
SelectorMap &SelMap = TU->getSelectorMap();
for (SelectorMap::method_iterator
I = SelMap.methods_begin(Sel), E = SelMap.methods_end(Sel);
I != E; ++I) {
ObjCMethodDecl *D = *I;
if (ValidMethod(D, MsgIFace, ReceiverIFace)) {
for (ObjCMethodDecl::redecl_iterator
RI = D->redecls_begin(), RE = D->redecls_end(); RI != RE; ++RI)
TULocHandler.Handle(TULocation(TU, ASTLocation(*RI)));
}
}
}
/// \brief Determines whether the given method is likely to accept the
/// original message.
///
/// It returns true "eagerly", meaning it will return false only if it can
/// "prove" statically that the method cannot accept the original message.
bool ValidMethod(ObjCMethodDecl *D, ObjCInterfaceDecl *MsgIFace,
ObjCInterfaceDecl *ReceiverIFace) {
assert(D);
// FIXME: Protocol methods ?
if (isa<ObjCProtocolDecl>(D->getDeclContext()))
return false;
// No specific interface associated with the message. Can be anything.
if (MsgIFaceEnt.isInvalid())
return true;
if ((!CanBeInstanceMethod && D->isInstanceMethod()) ||
(!CanBeClassMethod && D->isClassMethod()))
return false;
ObjCInterfaceDecl *IFace = D->getClassInterface();
assert(IFace);
// If the original message interface is the same or a superclass of the
// given interface, accept the method as a possibility.
if (MsgIFace && MsgIFace->isSuperClassOf(IFace))
return true;
if (ReceiverIFace) {
// The given interface, "overrides" the receiver.
if (ReceiverIFace->isSuperClassOf(IFace))
return true;
} else {
// No receiver was found for the original message.
assert(ReceiverIFaceEnt.isInvalid());
// If the original message interface is a subclass of the given interface,
// accept the message.
if (HierarchyEntities.count(Entity::get(IFace, Prog)))
return true;
}
// The interfaces are unrelated, or the receiver interface wasn't
// "overriden".
return false;
}
};
} // end anonymous namespace
//===----------------------------------------------------------------------===//
// Analyzer Implementation
//===----------------------------------------------------------------------===//
void Analyzer::FindDeclarations(Decl *D, TULocationHandler &Handler) {
assert(D && "Passed null declaration");
Entity Ent = Entity::get(D, Prog);
if (Ent.isInvalid())
return;
DeclEntityAnalyzer DEA(Ent, Handler);
Idxer.GetTranslationUnitsFor(Ent, DEA);
}
void Analyzer::FindReferences(Decl *D, TULocationHandler &Handler) {
assert(D && "Passed null declaration");
if (ObjCMethodDecl *MD = dyn_cast<ObjCMethodDecl>(D)) {
RefSelectorAnalyzer RSA(MD, Prog, Handler);
GlobalSelector Sel = GlobalSelector::get(MD->getSelector(), Prog);
Idxer.GetTranslationUnitsFor(Sel, RSA);
return;
}
Entity Ent = Entity::get(D, Prog);
if (Ent.isInvalid())
return;
RefEntityAnalyzer REA(Ent, Handler);
Idxer.GetTranslationUnitsFor(Ent, REA);
}
/// \brief Find methods that may respond to the given message and pass them
/// to Handler.
void Analyzer::FindObjCMethods(ObjCMessageExpr *Msg,
TULocationHandler &Handler) {
assert(Msg);
MessageAnalyzer MsgAnalyz(Msg, Prog, Handler);
GlobalSelector GlobSel = GlobalSelector::get(Msg->getSelector(), Prog);
Idxer.GetTranslationUnitsFor(GlobSel, MsgAnalyz);
}
|