Bug Summary

File:tools/clang/lib/AST/DeclObjC.cpp
Warning:line 1638, column 11
Called C++ object pointer is null

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -disable-llvm-verifier -discard-value-names -main-file-name DeclObjC.cpp -analyzer-store=region -analyzer-opt-analyze-nested-blocks -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mthread-model posix -mframe-pointer=none -relaxed-aliasing -fmath-errno -masm-verbose -mconstructor-aliases -munwind-tables -fuse-init-array -target-cpu x86-64 -dwarf-column-info -debugger-tuning=gdb -ffunction-sections -fdata-sections -resource-dir /usr/lib/llvm-10/lib/clang/10.0.0 -D CLANG_VENDOR="Debian " -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I /build/llvm-toolchain-snapshot-10~svn374877/build-llvm/tools/clang/lib/AST -I /build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST -I /build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include -I /build/llvm-toolchain-snapshot-10~svn374877/build-llvm/tools/clang/include -I /build/llvm-toolchain-snapshot-10~svn374877/build-llvm/include -I /build/llvm-toolchain-snapshot-10~svn374877/include -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/x86_64-linux-gnu/c++/6.3.0 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/6.3.0/../../../../include/c++/6.3.0/backward -internal-isystem /usr/local/include -internal-isystem /usr/lib/llvm-10/lib/clang/10.0.0/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -O2 -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-comment -std=c++14 -fdeprecated-macro -fdebug-compilation-dir /build/llvm-toolchain-snapshot-10~svn374877/build-llvm/tools/clang/lib/AST -fdebug-prefix-map=/build/llvm-toolchain-snapshot-10~svn374877=. -ferror-limit 19 -fmessage-length 0 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fobjc-runtime=gcc -fno-common -fdiagnostics-show-option -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -o /tmp/scan-build-2019-10-15-233810-7101-1 -x c++ /build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp

/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp

1//===- DeclObjC.cpp - ObjC Declaration AST Node Implementation ------------===//
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// This file implements the Objective-C related Decl classes.
10//
11//===----------------------------------------------------------------------===//
12
13#include "clang/AST/DeclObjC.h"
14#include "clang/AST/ASTContext.h"
15#include "clang/AST/ASTMutationListener.h"
16#include "clang/AST/Attr.h"
17#include "clang/AST/Decl.h"
18#include "clang/AST/DeclBase.h"
19#include "clang/AST/Stmt.h"
20#include "clang/AST/Type.h"
21#include "clang/AST/TypeLoc.h"
22#include "clang/Basic/IdentifierTable.h"
23#include "clang/Basic/LLVM.h"
24#include "clang/Basic/LangOptions.h"
25#include "clang/Basic/SourceLocation.h"
26#include "llvm/ADT/None.h"
27#include "llvm/ADT/SmallString.h"
28#include "llvm/ADT/SmallVector.h"
29#include "llvm/Support/Casting.h"
30#include "llvm/Support/ErrorHandling.h"
31#include "llvm/Support/raw_ostream.h"
32#include <algorithm>
33#include <cassert>
34#include <cstdint>
35#include <cstring>
36#include <utility>
37
38using namespace clang;
39
40//===----------------------------------------------------------------------===//
41// ObjCListBase
42//===----------------------------------------------------------------------===//
43
44void ObjCListBase::set(void *const* InList, unsigned Elts, ASTContext &Ctx) {
45 List = nullptr;
46 if (Elts == 0) return; // Setting to an empty list is a noop.
47
48 List = new (Ctx) void*[Elts];
49 NumElts = Elts;
50 memcpy(List, InList, sizeof(void*)*Elts);
51}
52
53void ObjCProtocolList::set(ObjCProtocolDecl* const* InList, unsigned Elts,
54 const SourceLocation *Locs, ASTContext &Ctx) {
55 if (Elts == 0)
56 return;
57
58 Locations = new (Ctx) SourceLocation[Elts];
59 memcpy(Locations, Locs, sizeof(SourceLocation) * Elts);
60 set(InList, Elts, Ctx);
61}
62
63//===----------------------------------------------------------------------===//
64// ObjCInterfaceDecl
65//===----------------------------------------------------------------------===//
66
67ObjCContainerDecl::ObjCContainerDecl(Kind DK, DeclContext *DC,
68 IdentifierInfo *Id, SourceLocation nameLoc,
69 SourceLocation atStartLoc)
70 : NamedDecl(DK, DC, nameLoc, Id), DeclContext(DK) {
71 setAtStartLoc(atStartLoc);
72}
73
74void ObjCContainerDecl::anchor() {}
75
76/// getIvarDecl - This method looks up an ivar in this ContextDecl.
77///
78ObjCIvarDecl *
79ObjCContainerDecl::getIvarDecl(IdentifierInfo *Id) const {
80 lookup_result R = lookup(Id);
81 for (lookup_iterator Ivar = R.begin(), IvarEnd = R.end();
82 Ivar != IvarEnd; ++Ivar) {
83 if (auto *ivar = dyn_cast<ObjCIvarDecl>(*Ivar))
84 return ivar;
85 }
86 return nullptr;
87}
88
89// Get the local instance/class method declared in this interface.
90ObjCMethodDecl *
91ObjCContainerDecl::getMethod(Selector Sel, bool isInstance,
92 bool AllowHidden) const {
93 // If this context is a hidden protocol definition, don't find any
94 // methods there.
95 if (const auto *Proto = dyn_cast<ObjCProtocolDecl>(this)) {
96 if (const ObjCProtocolDecl *Def = Proto->getDefinition())
97 if (Def->isHidden() && !AllowHidden)
98 return nullptr;
99 }
100
101 // Since instance & class methods can have the same name, the loop below
102 // ensures we get the correct method.
103 //
104 // @interface Whatever
105 // - (int) class_method;
106 // + (float) class_method;
107 // @end
108 lookup_result R = lookup(Sel);
109 for (lookup_iterator Meth = R.begin(), MethEnd = R.end();
110 Meth != MethEnd; ++Meth) {
111 auto *MD = dyn_cast<ObjCMethodDecl>(*Meth);
112 if (MD && MD->isInstanceMethod() == isInstance)
113 return MD;
114 }
115 return nullptr;
116}
117
118/// This routine returns 'true' if a user declared setter method was
119/// found in the class, its protocols, its super classes or categories.
120/// It also returns 'true' if one of its categories has declared a 'readwrite'
121/// property. This is because, user must provide a setter method for the
122/// category's 'readwrite' property.
123bool ObjCContainerDecl::HasUserDeclaredSetterMethod(
124 const ObjCPropertyDecl *Property) const {
125 Selector Sel = Property->getSetterName();
126 lookup_result R = lookup(Sel);
127 for (lookup_iterator Meth = R.begin(), MethEnd = R.end();
128 Meth != MethEnd; ++Meth) {
129 auto *MD = dyn_cast<ObjCMethodDecl>(*Meth);
130 if (MD && MD->isInstanceMethod() && !MD->isImplicit())
131 return true;
132 }
133
134 if (const auto *ID = dyn_cast<ObjCInterfaceDecl>(this)) {
135 // Also look into categories, including class extensions, looking
136 // for a user declared instance method.
137 for (const auto *Cat : ID->visible_categories()) {
138 if (ObjCMethodDecl *MD = Cat->getInstanceMethod(Sel))
139 if (!MD->isImplicit())
140 return true;
141 if (Cat->IsClassExtension())
142 continue;
143 // Also search through the categories looking for a 'readwrite'
144 // declaration of this property. If one found, presumably a setter will
145 // be provided (properties declared in categories will not get
146 // auto-synthesized).
147 for (const auto *P : Cat->properties())
148 if (P->getIdentifier() == Property->getIdentifier()) {
149 if (P->getPropertyAttributes() & ObjCPropertyDecl::OBJC_PR_readwrite)
150 return true;
151 break;
152 }
153 }
154
155 // Also look into protocols, for a user declared instance method.
156 for (const auto *Proto : ID->all_referenced_protocols())
157 if (Proto->HasUserDeclaredSetterMethod(Property))
158 return true;
159
160 // And in its super class.
161 ObjCInterfaceDecl *OSC = ID->getSuperClass();
162 while (OSC) {
163 if (OSC->HasUserDeclaredSetterMethod(Property))
164 return true;
165 OSC = OSC->getSuperClass();
166 }
167 }
168 if (const auto *PD = dyn_cast<ObjCProtocolDecl>(this))
169 for (const auto *PI : PD->protocols())
170 if (PI->HasUserDeclaredSetterMethod(Property))
171 return true;
172 return false;
173}
174
175ObjCPropertyDecl *
176ObjCPropertyDecl::findPropertyDecl(const DeclContext *DC,
177 const IdentifierInfo *propertyID,
178 ObjCPropertyQueryKind queryKind) {
179 // If this context is a hidden protocol definition, don't find any
180 // property.
181 if (const auto *Proto = dyn_cast<ObjCProtocolDecl>(DC)) {
182 if (const ObjCProtocolDecl *Def = Proto->getDefinition())
183 if (Def->isHidden())
184 return nullptr;
185 }
186
187 // If context is class, then lookup property in its visible extensions.
188 // This comes before property is looked up in primary class.
189 if (auto *IDecl = dyn_cast<ObjCInterfaceDecl>(DC)) {
190 for (const auto *Ext : IDecl->visible_extensions())
191 if (ObjCPropertyDecl *PD = ObjCPropertyDecl::findPropertyDecl(Ext,
192 propertyID,
193 queryKind))
194 return PD;
195 }
196
197 DeclContext::lookup_result R = DC->lookup(propertyID);
198 ObjCPropertyDecl *classProp = nullptr;
199 for (DeclContext::lookup_iterator I = R.begin(), E = R.end(); I != E;
200 ++I)
201 if (auto *PD = dyn_cast<ObjCPropertyDecl>(*I)) {
202 // If queryKind is unknown, we return the instance property if one
203 // exists; otherwise we return the class property.
204 if ((queryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown &&
205 !PD->isClassProperty()) ||
206 (queryKind == ObjCPropertyQueryKind::OBJC_PR_query_class &&
207 PD->isClassProperty()) ||
208 (queryKind == ObjCPropertyQueryKind::OBJC_PR_query_instance &&
209 !PD->isClassProperty()))
210 return PD;
211
212 if (PD->isClassProperty())
213 classProp = PD;
214 }
215
216 if (queryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown)
217 // We can't find the instance property, return the class property.
218 return classProp;
219
220 return nullptr;
221}
222
223IdentifierInfo *
224ObjCPropertyDecl::getDefaultSynthIvarName(ASTContext &Ctx) const {
225 SmallString<128> ivarName;
226 {
227 llvm::raw_svector_ostream os(ivarName);
228 os << '_' << getIdentifier()->getName();
229 }
230 return &Ctx.Idents.get(ivarName.str());
231}
232
233/// FindPropertyDeclaration - Finds declaration of the property given its name
234/// in 'PropertyId' and returns it. It returns 0, if not found.
235ObjCPropertyDecl *ObjCContainerDecl::FindPropertyDeclaration(
236 const IdentifierInfo *PropertyId,
237 ObjCPropertyQueryKind QueryKind) const {
238 // Don't find properties within hidden protocol definitions.
239 if (const auto *Proto = dyn_cast<ObjCProtocolDecl>(this)) {
240 if (const ObjCProtocolDecl *Def = Proto->getDefinition())
241 if (Def->isHidden())
242 return nullptr;
243 }
244
245 // Search the extensions of a class first; they override what's in
246 // the class itself.
247 if (const auto *ClassDecl = dyn_cast<ObjCInterfaceDecl>(this)) {
248 for (const auto *Ext : ClassDecl->visible_extensions()) {
249 if (auto *P = Ext->FindPropertyDeclaration(PropertyId, QueryKind))
250 return P;
251 }
252 }
253
254 if (ObjCPropertyDecl *PD =
255 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(this), PropertyId,
256 QueryKind))
257 return PD;
258
259 switch (getKind()) {
260 default:
261 break;
262 case Decl::ObjCProtocol: {
263 const auto *PID = cast<ObjCProtocolDecl>(this);
264 for (const auto *I : PID->protocols())
265 if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
266 QueryKind))
267 return P;
268 break;
269 }
270 case Decl::ObjCInterface: {
271 const auto *OID = cast<ObjCInterfaceDecl>(this);
272 // Look through categories (but not extensions; they were handled above).
273 for (const auto *Cat : OID->visible_categories()) {
274 if (!Cat->IsClassExtension())
275 if (ObjCPropertyDecl *P = Cat->FindPropertyDeclaration(
276 PropertyId, QueryKind))
277 return P;
278 }
279
280 // Look through protocols.
281 for (const auto *I : OID->all_referenced_protocols())
282 if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
283 QueryKind))
284 return P;
285
286 // Finally, check the super class.
287 if (const ObjCInterfaceDecl *superClass = OID->getSuperClass())
288 return superClass->FindPropertyDeclaration(PropertyId, QueryKind);
289 break;
290 }
291 case Decl::ObjCCategory: {
292 const auto *OCD = cast<ObjCCategoryDecl>(this);
293 // Look through protocols.
294 if (!OCD->IsClassExtension())
295 for (const auto *I : OCD->protocols())
296 if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
297 QueryKind))
298 return P;
299 break;
300 }
301 }
302 return nullptr;
303}
304
305void ObjCInterfaceDecl::anchor() {}
306
307ObjCTypeParamList *ObjCInterfaceDecl::getTypeParamList() const {
308 // If this particular declaration has a type parameter list, return it.
309 if (ObjCTypeParamList *written = getTypeParamListAsWritten())
310 return written;
311
312 // If there is a definition, return its type parameter list.
313 if (const ObjCInterfaceDecl *def = getDefinition())
314 return def->getTypeParamListAsWritten();
315
316 // Otherwise, look at previous declarations to determine whether any
317 // of them has a type parameter list, skipping over those
318 // declarations that do not.
319 for (const ObjCInterfaceDecl *decl = getMostRecentDecl(); decl;
320 decl = decl->getPreviousDecl()) {
321 if (ObjCTypeParamList *written = decl->getTypeParamListAsWritten())
322 return written;
323 }
324
325 return nullptr;
326}
327
328void ObjCInterfaceDecl::setTypeParamList(ObjCTypeParamList *TPL) {
329 TypeParamList = TPL;
330 if (!TPL)
331 return;
332 // Set the declaration context of each of the type parameters.
333 for (auto *typeParam : *TypeParamList)
334 typeParam->setDeclContext(this);
335}
336
337ObjCInterfaceDecl *ObjCInterfaceDecl::getSuperClass() const {
338 // FIXME: Should make sure no callers ever do this.
339 if (!hasDefinition())
340 return nullptr;
341
342 if (data().ExternallyCompleted)
343 LoadExternalDefinition();
344
345 if (const ObjCObjectType *superType = getSuperClassType()) {
346 if (ObjCInterfaceDecl *superDecl = superType->getInterface()) {
347 if (ObjCInterfaceDecl *superDef = superDecl->getDefinition())
348 return superDef;
349
350 return superDecl;
351 }
352 }
353
354 return nullptr;
355}
356
357SourceLocation ObjCInterfaceDecl::getSuperClassLoc() const {
358 if (TypeSourceInfo *superTInfo = getSuperClassTInfo())
359 return superTInfo->getTypeLoc().getBeginLoc();
360
361 return SourceLocation();
362}
363
364/// FindPropertyVisibleInPrimaryClass - Finds declaration of the property
365/// with name 'PropertyId' in the primary class; including those in protocols
366/// (direct or indirect) used by the primary class.
367ObjCPropertyDecl *
368ObjCInterfaceDecl::FindPropertyVisibleInPrimaryClass(
369 IdentifierInfo *PropertyId,
370 ObjCPropertyQueryKind QueryKind) const {
371 // FIXME: Should make sure no callers ever do this.
372 if (!hasDefinition())
373 return nullptr;
374
375 if (data().ExternallyCompleted)
376 LoadExternalDefinition();
377
378 if (ObjCPropertyDecl *PD =
379 ObjCPropertyDecl::findPropertyDecl(cast<DeclContext>(this), PropertyId,
380 QueryKind))
381 return PD;
382
383 // Look through protocols.
384 for (const auto *I : all_referenced_protocols())
385 if (ObjCPropertyDecl *P = I->FindPropertyDeclaration(PropertyId,
386 QueryKind))
387 return P;
388
389 return nullptr;
390}
391
392void ObjCInterfaceDecl::collectPropertiesToImplement(PropertyMap &PM,
393 PropertyDeclOrder &PO) const {
394 for (auto *Prop : properties()) {
395 PM[std::make_pair(Prop->getIdentifier(), Prop->isClassProperty())] = Prop;
396 PO.push_back(Prop);
397 }
398 for (const auto *Ext : known_extensions()) {
399 const ObjCCategoryDecl *ClassExt = Ext;
400 for (auto *Prop : ClassExt->properties()) {
401 PM[std::make_pair(Prop->getIdentifier(), Prop->isClassProperty())] = Prop;
402 PO.push_back(Prop);
403 }
404 }
405 for (const auto *PI : all_referenced_protocols())
406 PI->collectPropertiesToImplement(PM, PO);
407 // Note, the properties declared only in class extensions are still copied
408 // into the main @interface's property list, and therefore we don't
409 // explicitly, have to search class extension properties.
410}
411
412bool ObjCInterfaceDecl::isArcWeakrefUnavailable() const {
413 const ObjCInterfaceDecl *Class = this;
414 while (Class) {
415 if (Class->hasAttr<ArcWeakrefUnavailableAttr>())
416 return true;
417 Class = Class->getSuperClass();
418 }
419 return false;
420}
421
422const ObjCInterfaceDecl *ObjCInterfaceDecl::isObjCRequiresPropertyDefs() const {
423 const ObjCInterfaceDecl *Class = this;
424 while (Class) {
425 if (Class->hasAttr<ObjCRequiresPropertyDefsAttr>())
426 return Class;
427 Class = Class->getSuperClass();
428 }
429 return nullptr;
430}
431
432void ObjCInterfaceDecl::mergeClassExtensionProtocolList(
433 ObjCProtocolDecl *const* ExtList, unsigned ExtNum,
434 ASTContext &C) {
435 if (data().ExternallyCompleted)
436 LoadExternalDefinition();
437
438 if (data().AllReferencedProtocols.empty() &&
439 data().ReferencedProtocols.empty()) {
440 data().AllReferencedProtocols.set(ExtList, ExtNum, C);
441 return;
442 }
443
444 // Check for duplicate protocol in class's protocol list.
445 // This is O(n*m). But it is extremely rare and number of protocols in
446 // class or its extension are very few.
447 SmallVector<ObjCProtocolDecl *, 8> ProtocolRefs;
448 for (unsigned i = 0; i < ExtNum; i++) {
449 bool protocolExists = false;
450 ObjCProtocolDecl *ProtoInExtension = ExtList[i];
451 for (auto *Proto : all_referenced_protocols()) {
452 if (C.ProtocolCompatibleWithProtocol(ProtoInExtension, Proto)) {
453 protocolExists = true;
454 break;
455 }
456 }
457 // Do we want to warn on a protocol in extension class which
458 // already exist in the class? Probably not.
459 if (!protocolExists)
460 ProtocolRefs.push_back(ProtoInExtension);
461 }
462
463 if (ProtocolRefs.empty())
464 return;
465
466 // Merge ProtocolRefs into class's protocol list;
467 ProtocolRefs.append(all_referenced_protocol_begin(),
468 all_referenced_protocol_end());
469
470 data().AllReferencedProtocols.set(ProtocolRefs.data(), ProtocolRefs.size(),C);
471}
472
473const ObjCInterfaceDecl *
474ObjCInterfaceDecl::findInterfaceWithDesignatedInitializers() const {
475 const ObjCInterfaceDecl *IFace = this;
476 while (IFace) {
477 if (IFace->hasDesignatedInitializers())
478 return IFace;
479 if (!IFace->inheritsDesignatedInitializers())
480 break;
481 IFace = IFace->getSuperClass();
482 }
483 return nullptr;
484}
485
486static bool isIntroducingInitializers(const ObjCInterfaceDecl *D) {
487 for (const auto *MD : D->instance_methods()) {
488 if (MD->getMethodFamily() == OMF_init && !MD->isOverriding())
489 return true;
490 }
491 for (const auto *Ext : D->visible_extensions()) {
492 for (const auto *MD : Ext->instance_methods()) {
493 if (MD->getMethodFamily() == OMF_init && !MD->isOverriding())
494 return true;
495 }
496 }
497 if (const auto *ImplD = D->getImplementation()) {
498 for (const auto *MD : ImplD->instance_methods()) {
499 if (MD->getMethodFamily() == OMF_init && !MD->isOverriding())
500 return true;
501 }
502 }
503 return false;
504}
505
506bool ObjCInterfaceDecl::inheritsDesignatedInitializers() const {
507 switch (data().InheritedDesignatedInitializers) {
508 case DefinitionData::IDI_Inherited:
509 return true;
510 case DefinitionData::IDI_NotInherited:
511 return false;
512 case DefinitionData::IDI_Unknown:
513 // If the class introduced initializers we conservatively assume that we
514 // don't know if any of them is a designated initializer to avoid possible
515 // misleading warnings.
516 if (isIntroducingInitializers(this)) {
517 data().InheritedDesignatedInitializers = DefinitionData::IDI_NotInherited;
518 } else {
519 if (auto SuperD = getSuperClass()) {
520 data().InheritedDesignatedInitializers =
521 SuperD->declaresOrInheritsDesignatedInitializers() ?
522 DefinitionData::IDI_Inherited :
523 DefinitionData::IDI_NotInherited;
524 } else {
525 data().InheritedDesignatedInitializers =
526 DefinitionData::IDI_NotInherited;
527 }
528 }
529 assert(data().InheritedDesignatedInitializers((data().InheritedDesignatedInitializers != DefinitionData::IDI_Unknown
) ? static_cast<void> (0) : __assert_fail ("data().InheritedDesignatedInitializers != DefinitionData::IDI_Unknown"
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 530, __PRETTY_FUNCTION__))
530 != DefinitionData::IDI_Unknown)((data().InheritedDesignatedInitializers != DefinitionData::IDI_Unknown
) ? static_cast<void> (0) : __assert_fail ("data().InheritedDesignatedInitializers != DefinitionData::IDI_Unknown"
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 530, __PRETTY_FUNCTION__))
;
531 return data().InheritedDesignatedInitializers ==
532 DefinitionData::IDI_Inherited;
533 }
534
535 llvm_unreachable("unexpected InheritedDesignatedInitializers value")::llvm::llvm_unreachable_internal("unexpected InheritedDesignatedInitializers value"
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 535)
;
536}
537
538void ObjCInterfaceDecl::getDesignatedInitializers(
539 llvm::SmallVectorImpl<const ObjCMethodDecl *> &Methods) const {
540 // Check for a complete definition and recover if not so.
541 if (!isThisDeclarationADefinition())
542 return;
543 if (data().ExternallyCompleted)
544 LoadExternalDefinition();
545
546 const ObjCInterfaceDecl *IFace= findInterfaceWithDesignatedInitializers();
547 if (!IFace)
548 return;
549
550 for (const auto *MD : IFace->instance_methods())
551 if (MD->isThisDeclarationADesignatedInitializer())
552 Methods.push_back(MD);
553 for (const auto *Ext : IFace->visible_extensions()) {
554 for (const auto *MD : Ext->instance_methods())
555 if (MD->isThisDeclarationADesignatedInitializer())
556 Methods.push_back(MD);
557 }
558}
559
560bool ObjCInterfaceDecl::isDesignatedInitializer(Selector Sel,
561 const ObjCMethodDecl **InitMethod) const {
562 bool HasCompleteDef = isThisDeclarationADefinition();
563 // During deserialization the data record for the ObjCInterfaceDecl could
564 // be made invariant by reusing the canonical decl. Take this into account
565 // when checking for the complete definition.
566 if (!HasCompleteDef && getCanonicalDecl()->hasDefinition() &&
567 getCanonicalDecl()->getDefinition() == getDefinition())
568 HasCompleteDef = true;
569
570 // Check for a complete definition and recover if not so.
571 if (!HasCompleteDef)
572 return false;
573
574 if (data().ExternallyCompleted)
575 LoadExternalDefinition();
576
577 const ObjCInterfaceDecl *IFace= findInterfaceWithDesignatedInitializers();
578 if (!IFace)
579 return false;
580
581 if (const ObjCMethodDecl *MD = IFace->getInstanceMethod(Sel)) {
582 if (MD->isThisDeclarationADesignatedInitializer()) {
583 if (InitMethod)
584 *InitMethod = MD;
585 return true;
586 }
587 }
588 for (const auto *Ext : IFace->visible_extensions()) {
589 if (const ObjCMethodDecl *MD = Ext->getInstanceMethod(Sel)) {
590 if (MD->isThisDeclarationADesignatedInitializer()) {
591 if (InitMethod)
592 *InitMethod = MD;
593 return true;
594 }
595 }
596 }
597 return false;
598}
599
600void ObjCInterfaceDecl::allocateDefinitionData() {
601 assert(!hasDefinition() && "ObjC class already has a definition")((!hasDefinition() && "ObjC class already has a definition"
) ? static_cast<void> (0) : __assert_fail ("!hasDefinition() && \"ObjC class already has a definition\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 601, __PRETTY_FUNCTION__))
;
602 Data.setPointer(new (getASTContext()) DefinitionData());
603 Data.getPointer()->Definition = this;
604
605 // Make the type point at the definition, now that we have one.
606 if (TypeForDecl)
607 cast<ObjCInterfaceType>(TypeForDecl)->Decl = this;
608}
609
610void ObjCInterfaceDecl::startDefinition() {
611 allocateDefinitionData();
612
613 // Update all of the declarations with a pointer to the definition.
614 for (auto *RD : redecls()) {
615 if (RD != this)
616 RD->Data = Data;
617 }
618}
619
620ObjCIvarDecl *ObjCInterfaceDecl::lookupInstanceVariable(IdentifierInfo *ID,
621 ObjCInterfaceDecl *&clsDeclared) {
622 // FIXME: Should make sure no callers ever do this.
623 if (!hasDefinition())
624 return nullptr;
625
626 if (data().ExternallyCompleted)
627 LoadExternalDefinition();
628
629 ObjCInterfaceDecl* ClassDecl = this;
630 while (ClassDecl != nullptr) {
631 if (ObjCIvarDecl *I = ClassDecl->getIvarDecl(ID)) {
632 clsDeclared = ClassDecl;
633 return I;
634 }
635
636 for (const auto *Ext : ClassDecl->visible_extensions()) {
637 if (ObjCIvarDecl *I = Ext->getIvarDecl(ID)) {
638 clsDeclared = ClassDecl;
639 return I;
640 }
641 }
642
643 ClassDecl = ClassDecl->getSuperClass();
644 }
645 return nullptr;
646}
647
648/// lookupInheritedClass - This method returns ObjCInterfaceDecl * of the super
649/// class whose name is passed as argument. If it is not one of the super classes
650/// the it returns NULL.
651ObjCInterfaceDecl *ObjCInterfaceDecl::lookupInheritedClass(
652 const IdentifierInfo*ICName) {
653 // FIXME: Should make sure no callers ever do this.
654 if (!hasDefinition())
655 return nullptr;
656
657 if (data().ExternallyCompleted)
658 LoadExternalDefinition();
659
660 ObjCInterfaceDecl* ClassDecl = this;
661 while (ClassDecl != nullptr) {
662 if (ClassDecl->getIdentifier() == ICName)
663 return ClassDecl;
664 ClassDecl = ClassDecl->getSuperClass();
665 }
666 return nullptr;
667}
668
669ObjCProtocolDecl *
670ObjCInterfaceDecl::lookupNestedProtocol(IdentifierInfo *Name) {
671 for (auto *P : all_referenced_protocols())
672 if (P->lookupProtocolNamed(Name))
673 return P;
674 ObjCInterfaceDecl *SuperClass = getSuperClass();
675 return SuperClass ? SuperClass->lookupNestedProtocol(Name) : nullptr;
676}
677
678/// lookupMethod - This method returns an instance/class method by looking in
679/// the class, its categories, and its super classes (using a linear search).
680/// When argument category "C" is specified, any implicit method found
681/// in this category is ignored.
682ObjCMethodDecl *ObjCInterfaceDecl::lookupMethod(Selector Sel,
683 bool isInstance,
684 bool shallowCategoryLookup,
685 bool followSuper,
686 const ObjCCategoryDecl *C) const
687{
688 // FIXME: Should make sure no callers ever do this.
689 if (!hasDefinition())
690 return nullptr;
691
692 const ObjCInterfaceDecl* ClassDecl = this;
693 ObjCMethodDecl *MethodDecl = nullptr;
694
695 if (data().ExternallyCompleted)
696 LoadExternalDefinition();
697
698 while (ClassDecl) {
699 // 1. Look through primary class.
700 if ((MethodDecl = ClassDecl->getMethod(Sel, isInstance)))
701 return MethodDecl;
702
703 // 2. Didn't find one yet - now look through categories.
704 for (const auto *Cat : ClassDecl->visible_categories())
705 if ((MethodDecl = Cat->getMethod(Sel, isInstance)))
706 if (C != Cat || !MethodDecl->isImplicit())
707 return MethodDecl;
708
709 // 3. Didn't find one yet - look through primary class's protocols.
710 for (const auto *I : ClassDecl->protocols())
711 if ((MethodDecl = I->lookupMethod(Sel, isInstance)))
712 return MethodDecl;
713
714 // 4. Didn't find one yet - now look through categories' protocols
715 if (!shallowCategoryLookup)
716 for (const auto *Cat : ClassDecl->visible_categories()) {
717 // Didn't find one yet - look through protocols.
718 const ObjCList<ObjCProtocolDecl> &Protocols =
719 Cat->getReferencedProtocols();
720 for (auto *Protocol : Protocols)
721 if ((MethodDecl = Protocol->lookupMethod(Sel, isInstance)))
722 if (C != Cat || !MethodDecl->isImplicit())
723 return MethodDecl;
724 }
725
726
727 if (!followSuper)
728 return nullptr;
729
730 // 5. Get to the super class (if any).
731 ClassDecl = ClassDecl->getSuperClass();
732 }
733 return nullptr;
734}
735
736// Will search "local" class/category implementations for a method decl.
737// If failed, then we search in class's root for an instance method.
738// Returns 0 if no method is found.
739ObjCMethodDecl *ObjCInterfaceDecl::lookupPrivateMethod(
740 const Selector &Sel,
741 bool Instance) const {
742 // FIXME: Should make sure no callers ever do this.
743 if (!hasDefinition())
744 return nullptr;
745
746 if (data().ExternallyCompleted)
747 LoadExternalDefinition();
748
749 ObjCMethodDecl *Method = nullptr;
750 if (ObjCImplementationDecl *ImpDecl = getImplementation())
751 Method = Instance ? ImpDecl->getInstanceMethod(Sel)
752 : ImpDecl->getClassMethod(Sel);
753
754 // Look through local category implementations associated with the class.
755 if (!Method)
756 Method = getCategoryMethod(Sel, Instance);
757
758 // Before we give up, check if the selector is an instance method.
759 // But only in the root. This matches gcc's behavior and what the
760 // runtime expects.
761 if (!Instance && !Method && !getSuperClass()) {
762 Method = lookupInstanceMethod(Sel);
763 // Look through local category implementations associated
764 // with the root class.
765 if (!Method)
766 Method = lookupPrivateMethod(Sel, true);
767 }
768
769 if (!Method && getSuperClass())
770 return getSuperClass()->lookupPrivateMethod(Sel, Instance);
771 return Method;
772}
773
774//===----------------------------------------------------------------------===//
775// ObjCMethodDecl
776//===----------------------------------------------------------------------===//
777
778ObjCMethodDecl::ObjCMethodDecl(SourceLocation beginLoc, SourceLocation endLoc,
779 Selector SelInfo, QualType T,
780 TypeSourceInfo *ReturnTInfo,
781 DeclContext *contextDecl, bool isInstance,
782 bool isVariadic, bool isPropertyAccessor,
783 bool isImplicitlyDeclared, bool isDefined,
784 ImplementationControl impControl,
785 bool HasRelatedResultType)
786 : NamedDecl(ObjCMethod, contextDecl, beginLoc, SelInfo),
787 DeclContext(ObjCMethod), MethodDeclType(T), ReturnTInfo(ReturnTInfo),
788 DeclEndLoc(endLoc) {
789
790 // Initialized the bits stored in DeclContext.
791 ObjCMethodDeclBits.Family =
792 static_cast<ObjCMethodFamily>(InvalidObjCMethodFamily);
793 setInstanceMethod(isInstance);
794 setVariadic(isVariadic);
795 setPropertyAccessor(isPropertyAccessor);
796 setDefined(isDefined);
797 setIsRedeclaration(false);
798 setHasRedeclaration(false);
799 setDeclImplementation(impControl);
800 setObjCDeclQualifier(OBJC_TQ_None);
801 setRelatedResultType(HasRelatedResultType);
802 setSelLocsKind(SelLoc_StandardNoSpace);
803 setOverriding(false);
804 setHasSkippedBody(false);
805
806 setImplicit(isImplicitlyDeclared);
807}
808
809ObjCMethodDecl *ObjCMethodDecl::Create(
810 ASTContext &C, SourceLocation beginLoc, SourceLocation endLoc,
811 Selector SelInfo, QualType T, TypeSourceInfo *ReturnTInfo,
812 DeclContext *contextDecl, bool isInstance, bool isVariadic,
813 bool isPropertyAccessor, bool isImplicitlyDeclared, bool isDefined,
814 ImplementationControl impControl, bool HasRelatedResultType) {
815 return new (C, contextDecl) ObjCMethodDecl(
816 beginLoc, endLoc, SelInfo, T, ReturnTInfo, contextDecl, isInstance,
817 isVariadic, isPropertyAccessor, isImplicitlyDeclared, isDefined,
818 impControl, HasRelatedResultType);
819}
820
821ObjCMethodDecl *ObjCMethodDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
822 return new (C, ID) ObjCMethodDecl(SourceLocation(), SourceLocation(),
823 Selector(), QualType(), nullptr, nullptr);
824}
825
826bool ObjCMethodDecl::isThisDeclarationADesignatedInitializer() const {
827 return getMethodFamily() == OMF_init &&
828 hasAttr<ObjCDesignatedInitializerAttr>();
829}
830
831bool ObjCMethodDecl::definedInNSObject(const ASTContext &Ctx) const {
832 if (const auto *PD = dyn_cast<const ObjCProtocolDecl>(getDeclContext()))
833 return PD->getIdentifier() == Ctx.getNSObjectName();
834 if (const auto *ID = dyn_cast<const ObjCInterfaceDecl>(getDeclContext()))
835 return ID->getIdentifier() == Ctx.getNSObjectName();
836 return false;
837}
838
839bool ObjCMethodDecl::isDesignatedInitializerForTheInterface(
840 const ObjCMethodDecl **InitMethod) const {
841 if (getMethodFamily() != OMF_init)
842 return false;
843 const DeclContext *DC = getDeclContext();
844 if (isa<ObjCProtocolDecl>(DC))
845 return false;
846 if (const ObjCInterfaceDecl *ID = getClassInterface())
847 return ID->isDesignatedInitializer(getSelector(), InitMethod);
848 return false;
849}
850
851Stmt *ObjCMethodDecl::getBody() const {
852 return Body.get(getASTContext().getExternalSource());
853}
854
855void ObjCMethodDecl::setAsRedeclaration(const ObjCMethodDecl *PrevMethod) {
856 assert(PrevMethod)((PrevMethod) ? static_cast<void> (0) : __assert_fail (
"PrevMethod", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 856, __PRETTY_FUNCTION__))
;
857 getASTContext().setObjCMethodRedeclaration(PrevMethod, this);
858 setIsRedeclaration(true);
859 PrevMethod->setHasRedeclaration(true);
860}
861
862void ObjCMethodDecl::setParamsAndSelLocs(ASTContext &C,
863 ArrayRef<ParmVarDecl*> Params,
864 ArrayRef<SourceLocation> SelLocs) {
865 ParamsAndSelLocs = nullptr;
866 NumParams = Params.size();
867 if (Params.empty() && SelLocs.empty())
868 return;
869
870 static_assert(alignof(ParmVarDecl *) >= alignof(SourceLocation),
871 "Alignment not sufficient for SourceLocation");
872
873 unsigned Size = sizeof(ParmVarDecl *) * NumParams +
874 sizeof(SourceLocation) * SelLocs.size();
875 ParamsAndSelLocs = C.Allocate(Size);
876 std::copy(Params.begin(), Params.end(), getParams());
877 std::copy(SelLocs.begin(), SelLocs.end(), getStoredSelLocs());
878}
879
880void ObjCMethodDecl::getSelectorLocs(
881 SmallVectorImpl<SourceLocation> &SelLocs) const {
882 for (unsigned i = 0, e = getNumSelectorLocs(); i != e; ++i)
883 SelLocs.push_back(getSelectorLoc(i));
884}
885
886void ObjCMethodDecl::setMethodParams(ASTContext &C,
887 ArrayRef<ParmVarDecl*> Params,
888 ArrayRef<SourceLocation> SelLocs) {
889 assert((!SelLocs.empty() || isImplicit()) &&(((!SelLocs.empty() || isImplicit()) && "No selector locs for non-implicit method"
) ? static_cast<void> (0) : __assert_fail ("(!SelLocs.empty() || isImplicit()) && \"No selector locs for non-implicit method\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 890, __PRETTY_FUNCTION__))
890 "No selector locs for non-implicit method")(((!SelLocs.empty() || isImplicit()) && "No selector locs for non-implicit method"
) ? static_cast<void> (0) : __assert_fail ("(!SelLocs.empty() || isImplicit()) && \"No selector locs for non-implicit method\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 890, __PRETTY_FUNCTION__))
;
891 if (isImplicit())
892 return setParamsAndSelLocs(C, Params, llvm::None);
893
894 setSelLocsKind(hasStandardSelectorLocs(getSelector(), SelLocs, Params,
895 DeclEndLoc));
896 if (getSelLocsKind() != SelLoc_NonStandard)
897 return setParamsAndSelLocs(C, Params, llvm::None);
898
899 setParamsAndSelLocs(C, Params, SelLocs);
900}
901
902/// A definition will return its interface declaration.
903/// An interface declaration will return its definition.
904/// Otherwise it will return itself.
905ObjCMethodDecl *ObjCMethodDecl::getNextRedeclarationImpl() {
906 ASTContext &Ctx = getASTContext();
907 ObjCMethodDecl *Redecl = nullptr;
908 if (hasRedeclaration())
909 Redecl = const_cast<ObjCMethodDecl*>(Ctx.getObjCMethodRedeclaration(this));
910 if (Redecl)
911 return Redecl;
912
913 auto *CtxD = cast<Decl>(getDeclContext());
914
915 if (!CtxD->isInvalidDecl()) {
916 if (auto *IFD = dyn_cast<ObjCInterfaceDecl>(CtxD)) {
917 if (ObjCImplementationDecl *ImplD = Ctx.getObjCImplementation(IFD))
918 if (!ImplD->isInvalidDecl())
919 Redecl = ImplD->getMethod(getSelector(), isInstanceMethod());
920
921 } else if (auto *CD = dyn_cast<ObjCCategoryDecl>(CtxD)) {
922 if (ObjCCategoryImplDecl *ImplD = Ctx.getObjCImplementation(CD))
923 if (!ImplD->isInvalidDecl())
924 Redecl = ImplD->getMethod(getSelector(), isInstanceMethod());
925
926 } else if (auto *ImplD = dyn_cast<ObjCImplementationDecl>(CtxD)) {
927 if (ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
928 if (!IFD->isInvalidDecl())
929 Redecl = IFD->getMethod(getSelector(), isInstanceMethod());
930
931 } else if (auto *CImplD = dyn_cast<ObjCCategoryImplDecl>(CtxD)) {
932 if (ObjCCategoryDecl *CatD = CImplD->getCategoryDecl())
933 if (!CatD->isInvalidDecl())
934 Redecl = CatD->getMethod(getSelector(), isInstanceMethod());
935 }
936 }
937
938 // Ensure that the discovered method redeclaration has a valid declaration
939 // context. Used to prevent infinite loops when iterating redeclarations in
940 // a partially invalid AST.
941 if (Redecl && cast<Decl>(Redecl->getDeclContext())->isInvalidDecl())
942 Redecl = nullptr;
943
944 if (!Redecl && isRedeclaration()) {
945 // This is the last redeclaration, go back to the first method.
946 return cast<ObjCContainerDecl>(CtxD)->getMethod(getSelector(),
947 isInstanceMethod());
948 }
949
950 return Redecl ? Redecl : this;
951}
952
953ObjCMethodDecl *ObjCMethodDecl::getCanonicalDecl() {
954 auto *CtxD = cast<Decl>(getDeclContext());
955
956 if (auto *ImplD = dyn_cast<ObjCImplementationDecl>(CtxD)) {
957 if (ObjCInterfaceDecl *IFD = ImplD->getClassInterface())
958 if (ObjCMethodDecl *MD = IFD->getMethod(getSelector(),
959 isInstanceMethod()))
960 return MD;
961 } else if (auto *CImplD = dyn_cast<ObjCCategoryImplDecl>(CtxD)) {
962 if (ObjCCategoryDecl *CatD = CImplD->getCategoryDecl())
963 if (ObjCMethodDecl *MD = CatD->getMethod(getSelector(),
964 isInstanceMethod()))
965 return MD;
966 }
967
968 if (isRedeclaration()) {
969 // It is possible that we have not done deserializing the ObjCMethod yet.
970 ObjCMethodDecl *MD =
971 cast<ObjCContainerDecl>(CtxD)->getMethod(getSelector(),
972 isInstanceMethod());
973 return MD ? MD : this;
974 }
975
976 return this;
977}
978
979SourceLocation ObjCMethodDecl::getEndLoc() const {
980 if (Stmt *Body = getBody())
981 return Body->getEndLoc();
982 return DeclEndLoc;
983}
984
985ObjCMethodFamily ObjCMethodDecl::getMethodFamily() const {
986 auto family = static_cast<ObjCMethodFamily>(ObjCMethodDeclBits.Family);
987 if (family != static_cast<unsigned>(InvalidObjCMethodFamily))
988 return family;
989
990 // Check for an explicit attribute.
991 if (const ObjCMethodFamilyAttr *attr = getAttr<ObjCMethodFamilyAttr>()) {
992 // The unfortunate necessity of mapping between enums here is due
993 // to the attributes framework.
994 switch (attr->getFamily()) {
995 case ObjCMethodFamilyAttr::OMF_None: family = OMF_None; break;
996 case ObjCMethodFamilyAttr::OMF_alloc: family = OMF_alloc; break;
997 case ObjCMethodFamilyAttr::OMF_copy: family = OMF_copy; break;
998 case ObjCMethodFamilyAttr::OMF_init: family = OMF_init; break;
999 case ObjCMethodFamilyAttr::OMF_mutableCopy: family = OMF_mutableCopy; break;
1000 case ObjCMethodFamilyAttr::OMF_new: family = OMF_new; break;
1001 }
1002 ObjCMethodDeclBits.Family = family;
1003 return family;
1004 }
1005
1006 family = getSelector().getMethodFamily();
1007 switch (family) {
1008 case OMF_None: break;
1009
1010 // init only has a conventional meaning for an instance method, and
1011 // it has to return an object.
1012 case OMF_init:
1013 if (!isInstanceMethod() || !getReturnType()->isObjCObjectPointerType())
1014 family = OMF_None;
1015 break;
1016
1017 // alloc/copy/new have a conventional meaning for both class and
1018 // instance methods, but they require an object return.
1019 case OMF_alloc:
1020 case OMF_copy:
1021 case OMF_mutableCopy:
1022 case OMF_new:
1023 if (!getReturnType()->isObjCObjectPointerType())
1024 family = OMF_None;
1025 break;
1026
1027 // These selectors have a conventional meaning only for instance methods.
1028 case OMF_dealloc:
1029 case OMF_finalize:
1030 case OMF_retain:
1031 case OMF_release:
1032 case OMF_autorelease:
1033 case OMF_retainCount:
1034 case OMF_self:
1035 if (!isInstanceMethod())
1036 family = OMF_None;
1037 break;
1038
1039 case OMF_initialize:
1040 if (isInstanceMethod() || !getReturnType()->isVoidType())
1041 family = OMF_None;
1042 break;
1043
1044 case OMF_performSelector:
1045 if (!isInstanceMethod() || !getReturnType()->isObjCIdType())
1046 family = OMF_None;
1047 else {
1048 unsigned noParams = param_size();
1049 if (noParams < 1 || noParams > 3)
1050 family = OMF_None;
1051 else {
1052 ObjCMethodDecl::param_type_iterator it = param_type_begin();
1053 QualType ArgT = (*it);
1054 if (!ArgT->isObjCSelType()) {
1055 family = OMF_None;
1056 break;
1057 }
1058 while (--noParams) {
1059 it++;
1060 ArgT = (*it);
1061 if (!ArgT->isObjCIdType()) {
1062 family = OMF_None;
1063 break;
1064 }
1065 }
1066 }
1067 }
1068 break;
1069
1070 }
1071
1072 // Cache the result.
1073 ObjCMethodDeclBits.Family = family;
1074 return family;
1075}
1076
1077QualType ObjCMethodDecl::getSelfType(ASTContext &Context,
1078 const ObjCInterfaceDecl *OID,
1079 bool &selfIsPseudoStrong,
1080 bool &selfIsConsumed) {
1081 QualType selfTy;
1082 selfIsPseudoStrong = false;
1083 selfIsConsumed = false;
1084 if (isInstanceMethod()) {
1085 // There may be no interface context due to error in declaration
1086 // of the interface (which has been reported). Recover gracefully.
1087 if (OID) {
1088 selfTy = Context.getObjCInterfaceType(OID);
1089 selfTy = Context.getObjCObjectPointerType(selfTy);
1090 } else {
1091 selfTy = Context.getObjCIdType();
1092 }
1093 } else // we have a factory method.
1094 selfTy = Context.getObjCClassType();
1095
1096 if (Context.getLangOpts().ObjCAutoRefCount) {
1097 if (isInstanceMethod()) {
1098 selfIsConsumed = hasAttr<NSConsumesSelfAttr>();
1099
1100 // 'self' is always __strong. It's actually pseudo-strong except
1101 // in init methods (or methods labeled ns_consumes_self), though.
1102 Qualifiers qs;
1103 qs.setObjCLifetime(Qualifiers::OCL_Strong);
1104 selfTy = Context.getQualifiedType(selfTy, qs);
1105
1106 // In addition, 'self' is const unless this is an init method.
1107 if (getMethodFamily() != OMF_init && !selfIsConsumed) {
1108 selfTy = selfTy.withConst();
1109 selfIsPseudoStrong = true;
1110 }
1111 }
1112 else {
1113 assert(isClassMethod())((isClassMethod()) ? static_cast<void> (0) : __assert_fail
("isClassMethod()", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1113, __PRETTY_FUNCTION__))
;
1114 // 'self' is always const in class methods.
1115 selfTy = selfTy.withConst();
1116 selfIsPseudoStrong = true;
1117 }
1118 }
1119 return selfTy;
1120}
1121
1122void ObjCMethodDecl::createImplicitParams(ASTContext &Context,
1123 const ObjCInterfaceDecl *OID) {
1124 bool selfIsPseudoStrong, selfIsConsumed;
1125 QualType selfTy =
1126 getSelfType(Context, OID, selfIsPseudoStrong, selfIsConsumed);
1127 auto *Self = ImplicitParamDecl::Create(Context, this, SourceLocation(),
1128 &Context.Idents.get("self"), selfTy,
1129 ImplicitParamDecl::ObjCSelf);
1130 setSelfDecl(Self);
1131
1132 if (selfIsConsumed)
1133 Self->addAttr(NSConsumedAttr::CreateImplicit(Context));
1134
1135 if (selfIsPseudoStrong)
1136 Self->setARCPseudoStrong(true);
1137
1138 setCmdDecl(ImplicitParamDecl::Create(
1139 Context, this, SourceLocation(), &Context.Idents.get("_cmd"),
1140 Context.getObjCSelType(), ImplicitParamDecl::ObjCCmd));
1141}
1142
1143ObjCInterfaceDecl *ObjCMethodDecl::getClassInterface() {
1144 if (auto *ID = dyn_cast<ObjCInterfaceDecl>(getDeclContext()))
1145 return ID;
1146 if (auto *CD = dyn_cast<ObjCCategoryDecl>(getDeclContext()))
1147 return CD->getClassInterface();
1148 if (auto *IMD = dyn_cast<ObjCImplDecl>(getDeclContext()))
1149 return IMD->getClassInterface();
1150 if (isa<ObjCProtocolDecl>(getDeclContext()))
1151 return nullptr;
1152 llvm_unreachable("unknown method context")::llvm::llvm_unreachable_internal("unknown method context", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1152)
;
1153}
1154
1155SourceRange ObjCMethodDecl::getReturnTypeSourceRange() const {
1156 const auto *TSI = getReturnTypeSourceInfo();
1157 if (TSI)
1158 return TSI->getTypeLoc().getSourceRange();
1159 return SourceRange();
1160}
1161
1162QualType ObjCMethodDecl::getSendResultType() const {
1163 ASTContext &Ctx = getASTContext();
1164 return getReturnType().getNonLValueExprType(Ctx)
1165 .substObjCTypeArgs(Ctx, {}, ObjCSubstitutionContext::Result);
1166}
1167
1168QualType ObjCMethodDecl::getSendResultType(QualType receiverType) const {
1169 // FIXME: Handle related result types here.
1170
1171 return getReturnType().getNonLValueExprType(getASTContext())
1172 .substObjCMemberType(receiverType, getDeclContext(),
1173 ObjCSubstitutionContext::Result);
1174}
1175
1176static void CollectOverriddenMethodsRecurse(const ObjCContainerDecl *Container,
1177 const ObjCMethodDecl *Method,
1178 SmallVectorImpl<const ObjCMethodDecl *> &Methods,
1179 bool MovedToSuper) {
1180 if (!Container)
1181 return;
1182
1183 // In categories look for overridden methods from protocols. A method from
1184 // category is not "overridden" since it is considered as the "same" method
1185 // (same USR) as the one from the interface.
1186 if (const auto *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
1187 // Check whether we have a matching method at this category but only if we
1188 // are at the super class level.
1189 if (MovedToSuper)
1190 if (ObjCMethodDecl *
1191 Overridden = Container->getMethod(Method->getSelector(),
1192 Method->isInstanceMethod(),
1193 /*AllowHidden=*/true))
1194 if (Method != Overridden) {
1195 // We found an override at this category; there is no need to look
1196 // into its protocols.
1197 Methods.push_back(Overridden);
1198 return;
1199 }
1200
1201 for (const auto *P : Category->protocols())
1202 CollectOverriddenMethodsRecurse(P, Method, Methods, MovedToSuper);
1203 return;
1204 }
1205
1206 // Check whether we have a matching method at this level.
1207 if (const ObjCMethodDecl *
1208 Overridden = Container->getMethod(Method->getSelector(),
1209 Method->isInstanceMethod(),
1210 /*AllowHidden=*/true))
1211 if (Method != Overridden) {
1212 // We found an override at this level; there is no need to look
1213 // into other protocols or categories.
1214 Methods.push_back(Overridden);
1215 return;
1216 }
1217
1218 if (const auto *Protocol = dyn_cast<ObjCProtocolDecl>(Container)){
1219 for (const auto *P : Protocol->protocols())
1220 CollectOverriddenMethodsRecurse(P, Method, Methods, MovedToSuper);
1221 }
1222
1223 if (const auto *Interface = dyn_cast<ObjCInterfaceDecl>(Container)) {
1224 for (const auto *P : Interface->protocols())
1225 CollectOverriddenMethodsRecurse(P, Method, Methods, MovedToSuper);
1226
1227 for (const auto *Cat : Interface->known_categories())
1228 CollectOverriddenMethodsRecurse(Cat, Method, Methods, MovedToSuper);
1229
1230 if (const ObjCInterfaceDecl *Super = Interface->getSuperClass())
1231 return CollectOverriddenMethodsRecurse(Super, Method, Methods,
1232 /*MovedToSuper=*/true);
1233 }
1234}
1235
1236static inline void CollectOverriddenMethods(const ObjCContainerDecl *Container,
1237 const ObjCMethodDecl *Method,
1238 SmallVectorImpl<const ObjCMethodDecl *> &Methods) {
1239 CollectOverriddenMethodsRecurse(Container, Method, Methods,
1240 /*MovedToSuper=*/false);
1241}
1242
1243static void collectOverriddenMethodsSlow(const ObjCMethodDecl *Method,
1244 SmallVectorImpl<const ObjCMethodDecl *> &overridden) {
1245 assert(Method->isOverriding())((Method->isOverriding()) ? static_cast<void> (0) : __assert_fail
("Method->isOverriding()", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1245, __PRETTY_FUNCTION__))
;
1246
1247 if (const auto *ProtD =
1248 dyn_cast<ObjCProtocolDecl>(Method->getDeclContext())) {
1249 CollectOverriddenMethods(ProtD, Method, overridden);
1250
1251 } else if (const auto *IMD =
1252 dyn_cast<ObjCImplDecl>(Method->getDeclContext())) {
1253 const ObjCInterfaceDecl *ID = IMD->getClassInterface();
1254 if (!ID)
1255 return;
1256 // Start searching for overridden methods using the method from the
1257 // interface as starting point.
1258 if (const ObjCMethodDecl *IFaceMeth = ID->getMethod(Method->getSelector(),
1259 Method->isInstanceMethod(),
1260 /*AllowHidden=*/true))
1261 Method = IFaceMeth;
1262 CollectOverriddenMethods(ID, Method, overridden);
1263
1264 } else if (const auto *CatD =
1265 dyn_cast<ObjCCategoryDecl>(Method->getDeclContext())) {
1266 const ObjCInterfaceDecl *ID = CatD->getClassInterface();
1267 if (!ID)
1268 return;
1269 // Start searching for overridden methods using the method from the
1270 // interface as starting point.
1271 if (const ObjCMethodDecl *IFaceMeth = ID->getMethod(Method->getSelector(),
1272 Method->isInstanceMethod(),
1273 /*AllowHidden=*/true))
1274 Method = IFaceMeth;
1275 CollectOverriddenMethods(ID, Method, overridden);
1276
1277 } else {
1278 CollectOverriddenMethods(
1279 dyn_cast_or_null<ObjCContainerDecl>(Method->getDeclContext()),
1280 Method, overridden);
1281 }
1282}
1283
1284void ObjCMethodDecl::getOverriddenMethods(
1285 SmallVectorImpl<const ObjCMethodDecl *> &Overridden) const {
1286 const ObjCMethodDecl *Method = this;
1287
1288 if (Method->isRedeclaration()) {
1289 Method = cast<ObjCContainerDecl>(Method->getDeclContext())->
1290 getMethod(Method->getSelector(), Method->isInstanceMethod());
1291 }
1292
1293 if (Method->isOverriding()) {
1294 collectOverriddenMethodsSlow(Method, Overridden);
1295 assert(!Overridden.empty() &&((!Overridden.empty() && "ObjCMethodDecl's overriding bit is not as expected"
) ? static_cast<void> (0) : __assert_fail ("!Overridden.empty() && \"ObjCMethodDecl's overriding bit is not as expected\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1296, __PRETTY_FUNCTION__))
1296 "ObjCMethodDecl's overriding bit is not as expected")((!Overridden.empty() && "ObjCMethodDecl's overriding bit is not as expected"
) ? static_cast<void> (0) : __assert_fail ("!Overridden.empty() && \"ObjCMethodDecl's overriding bit is not as expected\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1296, __PRETTY_FUNCTION__))
;
1297 }
1298}
1299
1300const ObjCPropertyDecl *
1301ObjCMethodDecl::findPropertyDecl(bool CheckOverrides) const {
1302 Selector Sel = getSelector();
1303 unsigned NumArgs = Sel.getNumArgs();
1304 if (NumArgs > 1)
1305 return nullptr;
1306
1307 if (isPropertyAccessor()) {
1308 const auto *Container = cast<ObjCContainerDecl>(getParent());
1309 bool IsGetter = (NumArgs == 0);
1310 bool IsInstance = isInstanceMethod();
1311
1312 /// Local function that attempts to find a matching property within the
1313 /// given Objective-C container.
1314 auto findMatchingProperty =
1315 [&](const ObjCContainerDecl *Container) -> const ObjCPropertyDecl * {
1316 if (IsInstance) {
1317 for (const auto *I : Container->instance_properties()) {
1318 Selector NextSel = IsGetter ? I->getGetterName()
1319 : I->getSetterName();
1320 if (NextSel == Sel)
1321 return I;
1322 }
1323 } else {
1324 for (const auto *I : Container->class_properties()) {
1325 Selector NextSel = IsGetter ? I->getGetterName()
1326 : I->getSetterName();
1327 if (NextSel == Sel)
1328 return I;
1329 }
1330 }
1331
1332 return nullptr;
1333 };
1334
1335 // Look in the container we were given.
1336 if (const auto *Found = findMatchingProperty(Container))
1337 return Found;
1338
1339 // If we're in a category or extension, look in the main class.
1340 const ObjCInterfaceDecl *ClassDecl = nullptr;
1341 if (const auto *Category = dyn_cast<ObjCCategoryDecl>(Container)) {
1342 ClassDecl = Category->getClassInterface();
1343 if (const auto *Found = findMatchingProperty(ClassDecl))
1344 return Found;
1345 } else {
1346 // Determine whether the container is a class.
1347 ClassDecl = dyn_cast<ObjCInterfaceDecl>(Container);
1348 }
1349
1350 // If we have a class, check its visible extensions.
1351 if (ClassDecl) {
1352 for (const auto *Ext : ClassDecl->visible_extensions()) {
1353 if (Ext == Container)
1354 continue;
1355
1356 if (const auto *Found = findMatchingProperty(Ext))
1357 return Found;
1358 }
1359 }
1360
1361 llvm_unreachable("Marked as a property accessor but no property found!")::llvm::llvm_unreachable_internal("Marked as a property accessor but no property found!"
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1361)
;
1362 }
1363
1364 if (!CheckOverrides)
1365 return nullptr;
1366
1367 using OverridesTy = SmallVector<const ObjCMethodDecl *, 8>;
1368
1369 OverridesTy Overrides;
1370 getOverriddenMethods(Overrides);
1371 for (const auto *Override : Overrides)
1372 if (const ObjCPropertyDecl *Prop = Override->findPropertyDecl(false))
1373 return Prop;
1374
1375 return nullptr;
1376}
1377
1378//===----------------------------------------------------------------------===//
1379// ObjCTypeParamDecl
1380//===----------------------------------------------------------------------===//
1381
1382void ObjCTypeParamDecl::anchor() {}
1383
1384ObjCTypeParamDecl *ObjCTypeParamDecl::Create(ASTContext &ctx, DeclContext *dc,
1385 ObjCTypeParamVariance variance,
1386 SourceLocation varianceLoc,
1387 unsigned index,
1388 SourceLocation nameLoc,
1389 IdentifierInfo *name,
1390 SourceLocation colonLoc,
1391 TypeSourceInfo *boundInfo) {
1392 auto *TPDecl =
1393 new (ctx, dc) ObjCTypeParamDecl(ctx, dc, variance, varianceLoc, index,
1394 nameLoc, name, colonLoc, boundInfo);
1395 QualType TPType = ctx.getObjCTypeParamType(TPDecl, {});
1396 TPDecl->setTypeForDecl(TPType.getTypePtr());
1397 return TPDecl;
1398}
1399
1400ObjCTypeParamDecl *ObjCTypeParamDecl::CreateDeserialized(ASTContext &ctx,
1401 unsigned ID) {
1402 return new (ctx, ID) ObjCTypeParamDecl(ctx, nullptr,
1403 ObjCTypeParamVariance::Invariant,
1404 SourceLocation(), 0, SourceLocation(),
1405 nullptr, SourceLocation(), nullptr);
1406}
1407
1408SourceRange ObjCTypeParamDecl::getSourceRange() const {
1409 SourceLocation startLoc = VarianceLoc;
1410 if (startLoc.isInvalid())
1411 startLoc = getLocation();
1412
1413 if (hasExplicitBound()) {
1414 return SourceRange(startLoc,
1415 getTypeSourceInfo()->getTypeLoc().getEndLoc());
1416 }
1417
1418 return SourceRange(startLoc);
1419}
1420
1421//===----------------------------------------------------------------------===//
1422// ObjCTypeParamList
1423//===----------------------------------------------------------------------===//
1424ObjCTypeParamList::ObjCTypeParamList(SourceLocation lAngleLoc,
1425 ArrayRef<ObjCTypeParamDecl *> typeParams,
1426 SourceLocation rAngleLoc)
1427 : NumParams(typeParams.size()) {
1428 Brackets.Begin = lAngleLoc.getRawEncoding();
1429 Brackets.End = rAngleLoc.getRawEncoding();
1430 std::copy(typeParams.begin(), typeParams.end(), begin());
1431}
1432
1433ObjCTypeParamList *ObjCTypeParamList::create(
1434 ASTContext &ctx,
1435 SourceLocation lAngleLoc,
1436 ArrayRef<ObjCTypeParamDecl *> typeParams,
1437 SourceLocation rAngleLoc) {
1438 void *mem =
1439 ctx.Allocate(totalSizeToAlloc<ObjCTypeParamDecl *>(typeParams.size()),
1440 alignof(ObjCTypeParamList));
1441 return new (mem) ObjCTypeParamList(lAngleLoc, typeParams, rAngleLoc);
1442}
1443
1444void ObjCTypeParamList::gatherDefaultTypeArgs(
1445 SmallVectorImpl<QualType> &typeArgs) const {
1446 typeArgs.reserve(size());
1447 for (auto typeParam : *this)
1448 typeArgs.push_back(typeParam->getUnderlyingType());
1449}
1450
1451//===----------------------------------------------------------------------===//
1452// ObjCInterfaceDecl
1453//===----------------------------------------------------------------------===//
1454
1455ObjCInterfaceDecl *ObjCInterfaceDecl::Create(const ASTContext &C,
1456 DeclContext *DC,
1457 SourceLocation atLoc,
1458 IdentifierInfo *Id,
1459 ObjCTypeParamList *typeParamList,
1460 ObjCInterfaceDecl *PrevDecl,
1461 SourceLocation ClassLoc,
1462 bool isInternal){
1463 auto *Result = new (C, DC)
1464 ObjCInterfaceDecl(C, DC, atLoc, Id, typeParamList, ClassLoc, PrevDecl,
1465 isInternal);
1466 Result->Data.setInt(!C.getLangOpts().Modules);
1467 C.getObjCInterfaceType(Result, PrevDecl);
1468 return Result;
1469}
1470
1471ObjCInterfaceDecl *ObjCInterfaceDecl::CreateDeserialized(const ASTContext &C,
1472 unsigned ID) {
1473 auto *Result = new (C, ID)
1474 ObjCInterfaceDecl(C, nullptr, SourceLocation(), nullptr, nullptr,
1475 SourceLocation(), nullptr, false);
1476 Result->Data.setInt(!C.getLangOpts().Modules);
1477 return Result;
1478}
1479
1480ObjCInterfaceDecl::ObjCInterfaceDecl(const ASTContext &C, DeclContext *DC,
1481 SourceLocation AtLoc, IdentifierInfo *Id,
1482 ObjCTypeParamList *typeParamList,
1483 SourceLocation CLoc,
1484 ObjCInterfaceDecl *PrevDecl,
1485 bool IsInternal)
1486 : ObjCContainerDecl(ObjCInterface, DC, Id, CLoc, AtLoc),
1487 redeclarable_base(C) {
1488 setPreviousDecl(PrevDecl);
1489
1490 // Copy the 'data' pointer over.
1491 if (PrevDecl)
1492 Data = PrevDecl->Data;
1493
1494 setImplicit(IsInternal);
1495
1496 setTypeParamList(typeParamList);
1497}
1498
1499void ObjCInterfaceDecl::LoadExternalDefinition() const {
1500 assert(data().ExternallyCompleted && "Class is not externally completed")((data().ExternallyCompleted && "Class is not externally completed"
) ? static_cast<void> (0) : __assert_fail ("data().ExternallyCompleted && \"Class is not externally completed\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1500, __PRETTY_FUNCTION__))
;
1501 data().ExternallyCompleted = false;
1502 getASTContext().getExternalSource()->CompleteType(
1503 const_cast<ObjCInterfaceDecl *>(this));
1504}
1505
1506void ObjCInterfaceDecl::setExternallyCompleted() {
1507 assert(getASTContext().getExternalSource() &&((getASTContext().getExternalSource() && "Class can't be externally completed without an external source"
) ? static_cast<void> (0) : __assert_fail ("getASTContext().getExternalSource() && \"Class can't be externally completed without an external source\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1508, __PRETTY_FUNCTION__))
1508 "Class can't be externally completed without an external source")((getASTContext().getExternalSource() && "Class can't be externally completed without an external source"
) ? static_cast<void> (0) : __assert_fail ("getASTContext().getExternalSource() && \"Class can't be externally completed without an external source\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1508, __PRETTY_FUNCTION__))
;
1509 assert(hasDefinition() &&((hasDefinition() && "Forward declarations can't be externally completed"
) ? static_cast<void> (0) : __assert_fail ("hasDefinition() && \"Forward declarations can't be externally completed\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1510, __PRETTY_FUNCTION__))
1510 "Forward declarations can't be externally completed")((hasDefinition() && "Forward declarations can't be externally completed"
) ? static_cast<void> (0) : __assert_fail ("hasDefinition() && \"Forward declarations can't be externally completed\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1510, __PRETTY_FUNCTION__))
;
1511 data().ExternallyCompleted = true;
1512}
1513
1514void ObjCInterfaceDecl::setHasDesignatedInitializers() {
1515 // Check for a complete definition and recover if not so.
1516 if (!isThisDeclarationADefinition())
1517 return;
1518 data().HasDesignatedInitializers = true;
1519}
1520
1521bool ObjCInterfaceDecl::hasDesignatedInitializers() const {
1522 // Check for a complete definition and recover if not so.
1523 if (!isThisDeclarationADefinition())
1524 return false;
1525 if (data().ExternallyCompleted)
1526 LoadExternalDefinition();
1527
1528 return data().HasDesignatedInitializers;
1529}
1530
1531StringRef
1532ObjCInterfaceDecl::getObjCRuntimeNameAsString() const {
1533 if (const auto *ObjCRTName = getAttr<ObjCRuntimeNameAttr>())
1534 return ObjCRTName->getMetadataName();
1535
1536 return getName();
1537}
1538
1539StringRef
1540ObjCImplementationDecl::getObjCRuntimeNameAsString() const {
1541 if (ObjCInterfaceDecl *ID =
1542 const_cast<ObjCImplementationDecl*>(this)->getClassInterface())
1543 return ID->getObjCRuntimeNameAsString();
1544
1545 return getName();
1546}
1547
1548ObjCImplementationDecl *ObjCInterfaceDecl::getImplementation() const {
1549 if (const ObjCInterfaceDecl *Def = getDefinition()) {
14
Calling 'ObjCInterfaceDecl::getDefinition'
18
Returning from 'ObjCInterfaceDecl::getDefinition'
19
Assuming 'Def' is non-null
20
Taking true branch
1550 if (data().ExternallyCompleted)
21
Assuming field 'ExternallyCompleted' is 0
22
Taking false branch
1551 LoadExternalDefinition();
1552
1553 return getASTContext().getObjCImplementation(
23
Returning pointer, which participates in a condition later
1554 const_cast<ObjCInterfaceDecl*>(Def));
1555 }
1556
1557 // FIXME: Should make sure no callers ever do this.
1558 return nullptr;
1559}
1560
1561void ObjCInterfaceDecl::setImplementation(ObjCImplementationDecl *ImplD) {
1562 getASTContext().setObjCImplementation(getDefinition(), ImplD);
1563}
1564
1565namespace {
1566
1567struct SynthesizeIvarChunk {
1568 uint64_t Size;
1569 ObjCIvarDecl *Ivar;
1570
1571 SynthesizeIvarChunk(uint64_t size, ObjCIvarDecl *ivar)
1572 : Size(size), Ivar(ivar) {}
1573};
1574
1575bool operator<(const SynthesizeIvarChunk & LHS,
1576 const SynthesizeIvarChunk &RHS) {
1577 return LHS.Size < RHS.Size;
1578}
1579
1580} // namespace
1581
1582/// all_declared_ivar_begin - return first ivar declared in this class,
1583/// its extensions and its implementation. Lazily build the list on first
1584/// access.
1585///
1586/// Caveat: The list returned by this method reflects the current
1587/// state of the parser. The cache will be updated for every ivar
1588/// added by an extension or the implementation when they are
1589/// encountered.
1590/// See also ObjCIvarDecl::Create().
1591ObjCIvarDecl *ObjCInterfaceDecl::all_declared_ivar_begin() {
1592 // FIXME: Should make sure no callers ever do this.
1593 if (!hasDefinition())
1
Calling 'ObjCInterfaceDecl::hasDefinition'
5
Returning from 'ObjCInterfaceDecl::hasDefinition'
6
Assuming the condition is false
7
Taking false branch
1594 return nullptr;
1595
1596 ObjCIvarDecl *curIvar = nullptr;
8
'curIvar' initialized to a null pointer value
1597 if (!data().IvarList) {
9
Assuming field 'IvarList' is non-null
10
Taking false branch
1598 if (!ivar_empty()) {
1599 ObjCInterfaceDecl::ivar_iterator I = ivar_begin(), E = ivar_end();
1600 data().IvarList = *I; ++I;
1601 for (curIvar = data().IvarList; I != E; curIvar = *I, ++I)
1602 curIvar->setNextIvar(*I);
1603 }
1604
1605 for (const auto *Ext : known_extensions()) {
1606 if (!Ext->ivar_empty()) {
1607 ObjCCategoryDecl::ivar_iterator
1608 I = Ext->ivar_begin(),
1609 E = Ext->ivar_end();
1610 if (!data().IvarList) {
1611 data().IvarList = *I; ++I;
1612 curIvar = data().IvarList;
1613 }
1614 for ( ;I != E; curIvar = *I, ++I)
1615 curIvar->setNextIvar(*I);
1616 }
1617 }
1618 data().IvarListMissingImplementation = true;
1619 }
1620
1621 // cached and complete!
1622 if (!data().IvarListMissingImplementation)
11
Assuming field 'IvarListMissingImplementation' is not equal to 0
12
Taking false branch
1623 return data().IvarList;
1624
1625 if (ObjCImplementationDecl *ImplDecl = getImplementation()) {
13
Calling 'ObjCInterfaceDecl::getImplementation'
24
Returning from 'ObjCInterfaceDecl::getImplementation'
25
Assuming 'ImplDecl' is non-null
26
Taking true branch
1626 data().IvarListMissingImplementation = false;
1627 if (!ImplDecl->ivar_empty()) {
27
Calling 'ObjCImplementationDecl::ivar_empty'
36
Returning from 'ObjCImplementationDecl::ivar_empty'
37
Taking true branch
1628 SmallVector<SynthesizeIvarChunk, 16> layout;
1629 for (auto *IV : ImplDecl->ivars()) {
1630 if (IV->getSynthesize() && !IV->isInvalidDecl()) {
38
Assuming the condition is false
1631 layout.push_back(SynthesizeIvarChunk(
1632 IV->getASTContext().getTypeSize(IV->getType()), IV));
1633 continue;
1634 }
1635 if (!data().IvarList)
39
Assuming field 'IvarList' is non-null
40
Taking false branch
1636 data().IvarList = IV;
1637 else
1638 curIvar->setNextIvar(IV);
41
Called C++ object pointer is null
1639 curIvar = IV;
1640 }
1641
1642 if (!layout.empty()) {
1643 // Order synthesized ivars by their size.
1644 llvm::stable_sort(layout);
1645 unsigned Ix = 0, EIx = layout.size();
1646 if (!data().IvarList) {
1647 data().IvarList = layout[0].Ivar; Ix++;
1648 curIvar = data().IvarList;
1649 }
1650 for ( ; Ix != EIx; curIvar = layout[Ix].Ivar, Ix++)
1651 curIvar->setNextIvar(layout[Ix].Ivar);
1652 }
1653 }
1654 }
1655 return data().IvarList;
1656}
1657
1658/// FindCategoryDeclaration - Finds category declaration in the list of
1659/// categories for this class and returns it. Name of the category is passed
1660/// in 'CategoryId'. If category not found, return 0;
1661///
1662ObjCCategoryDecl *
1663ObjCInterfaceDecl::FindCategoryDeclaration(IdentifierInfo *CategoryId) const {
1664 // FIXME: Should make sure no callers ever do this.
1665 if (!hasDefinition())
1666 return nullptr;
1667
1668 if (data().ExternallyCompleted)
1669 LoadExternalDefinition();
1670
1671 for (auto *Cat : visible_categories())
1672 if (Cat->getIdentifier() == CategoryId)
1673 return Cat;
1674
1675 return nullptr;
1676}
1677
1678ObjCMethodDecl *
1679ObjCInterfaceDecl::getCategoryInstanceMethod(Selector Sel) const {
1680 for (const auto *Cat : visible_categories()) {
1681 if (ObjCCategoryImplDecl *Impl = Cat->getImplementation())
1682 if (ObjCMethodDecl *MD = Impl->getInstanceMethod(Sel))
1683 return MD;
1684 }
1685
1686 return nullptr;
1687}
1688
1689ObjCMethodDecl *ObjCInterfaceDecl::getCategoryClassMethod(Selector Sel) const {
1690 for (const auto *Cat : visible_categories()) {
1691 if (ObjCCategoryImplDecl *Impl = Cat->getImplementation())
1692 if (ObjCMethodDecl *MD = Impl->getClassMethod(Sel))
1693 return MD;
1694 }
1695
1696 return nullptr;
1697}
1698
1699/// ClassImplementsProtocol - Checks that 'lProto' protocol
1700/// has been implemented in IDecl class, its super class or categories (if
1701/// lookupCategory is true).
1702bool ObjCInterfaceDecl::ClassImplementsProtocol(ObjCProtocolDecl *lProto,
1703 bool lookupCategory,
1704 bool RHSIsQualifiedID) {
1705 if (!hasDefinition())
1706 return false;
1707
1708 ObjCInterfaceDecl *IDecl = this;
1709 // 1st, look up the class.
1710 for (auto *PI : IDecl->protocols()){
1711 if (getASTContext().ProtocolCompatibleWithProtocol(lProto, PI))
1712 return true;
1713 // This is dubious and is added to be compatible with gcc. In gcc, it is
1714 // also allowed assigning a protocol-qualified 'id' type to a LHS object
1715 // when protocol in qualified LHS is in list of protocols in the rhs 'id'
1716 // object. This IMO, should be a bug.
1717 // FIXME: Treat this as an extension, and flag this as an error when GCC
1718 // extensions are not enabled.
1719 if (RHSIsQualifiedID &&
1720 getASTContext().ProtocolCompatibleWithProtocol(PI, lProto))
1721 return true;
1722 }
1723
1724 // 2nd, look up the category.
1725 if (lookupCategory)
1726 for (const auto *Cat : visible_categories()) {
1727 for (auto *PI : Cat->protocols())
1728 if (getASTContext().ProtocolCompatibleWithProtocol(lProto, PI))
1729 return true;
1730 }
1731
1732 // 3rd, look up the super class(s)
1733 if (IDecl->getSuperClass())
1734 return
1735 IDecl->getSuperClass()->ClassImplementsProtocol(lProto, lookupCategory,
1736 RHSIsQualifiedID);
1737
1738 return false;
1739}
1740
1741//===----------------------------------------------------------------------===//
1742// ObjCIvarDecl
1743//===----------------------------------------------------------------------===//
1744
1745void ObjCIvarDecl::anchor() {}
1746
1747ObjCIvarDecl *ObjCIvarDecl::Create(ASTContext &C, ObjCContainerDecl *DC,
1748 SourceLocation StartLoc,
1749 SourceLocation IdLoc, IdentifierInfo *Id,
1750 QualType T, TypeSourceInfo *TInfo,
1751 AccessControl ac, Expr *BW,
1752 bool synthesized) {
1753 if (DC) {
1754 // Ivar's can only appear in interfaces, implementations (via synthesized
1755 // properties), and class extensions (via direct declaration, or synthesized
1756 // properties).
1757 //
1758 // FIXME: This should really be asserting this:
1759 // (isa<ObjCCategoryDecl>(DC) &&
1760 // cast<ObjCCategoryDecl>(DC)->IsClassExtension()))
1761 // but unfortunately we sometimes place ivars into non-class extension
1762 // categories on error. This breaks an AST invariant, and should not be
1763 // fixed.
1764 assert((isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl>(DC) ||(((isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl
>(DC) || isa<ObjCCategoryDecl>(DC)) && "Invalid ivar decl context!"
) ? static_cast<void> (0) : __assert_fail ("(isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl>(DC) || isa<ObjCCategoryDecl>(DC)) && \"Invalid ivar decl context!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1766, __PRETTY_FUNCTION__))
1765 isa<ObjCCategoryDecl>(DC)) &&(((isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl
>(DC) || isa<ObjCCategoryDecl>(DC)) && "Invalid ivar decl context!"
) ? static_cast<void> (0) : __assert_fail ("(isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl>(DC) || isa<ObjCCategoryDecl>(DC)) && \"Invalid ivar decl context!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1766, __PRETTY_FUNCTION__))
1766 "Invalid ivar decl context!")(((isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl
>(DC) || isa<ObjCCategoryDecl>(DC)) && "Invalid ivar decl context!"
) ? static_cast<void> (0) : __assert_fail ("(isa<ObjCInterfaceDecl>(DC) || isa<ObjCImplementationDecl>(DC) || isa<ObjCCategoryDecl>(DC)) && \"Invalid ivar decl context!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1766, __PRETTY_FUNCTION__))
;
1767 // Once a new ivar is created in any of class/class-extension/implementation
1768 // decl contexts, the previously built IvarList must be rebuilt.
1769 auto *ID = dyn_cast<ObjCInterfaceDecl>(DC);
1770 if (!ID) {
1771 if (auto *IM = dyn_cast<ObjCImplementationDecl>(DC))
1772 ID = IM->getClassInterface();
1773 else
1774 ID = cast<ObjCCategoryDecl>(DC)->getClassInterface();
1775 }
1776 ID->setIvarList(nullptr);
1777 }
1778
1779 return new (C, DC) ObjCIvarDecl(DC, StartLoc, IdLoc, Id, T, TInfo, ac, BW,
1780 synthesized);
1781}
1782
1783ObjCIvarDecl *ObjCIvarDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
1784 return new (C, ID) ObjCIvarDecl(nullptr, SourceLocation(), SourceLocation(),
1785 nullptr, QualType(), nullptr,
1786 ObjCIvarDecl::None, nullptr, false);
1787}
1788
1789const ObjCInterfaceDecl *ObjCIvarDecl::getContainingInterface() const {
1790 const auto *DC = cast<ObjCContainerDecl>(getDeclContext());
1791
1792 switch (DC->getKind()) {
1793 default:
1794 case ObjCCategoryImpl:
1795 case ObjCProtocol:
1796 llvm_unreachable("invalid ivar container!")::llvm::llvm_unreachable_internal("invalid ivar container!", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1796)
;
1797
1798 // Ivars can only appear in class extension categories.
1799 case ObjCCategory: {
1800 const auto *CD = cast<ObjCCategoryDecl>(DC);
1801 assert(CD->IsClassExtension() && "invalid container for ivar!")((CD->IsClassExtension() && "invalid container for ivar!"
) ? static_cast<void> (0) : __assert_fail ("CD->IsClassExtension() && \"invalid container for ivar!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1801, __PRETTY_FUNCTION__))
;
1802 return CD->getClassInterface();
1803 }
1804
1805 case ObjCImplementation:
1806 return cast<ObjCImplementationDecl>(DC)->getClassInterface();
1807
1808 case ObjCInterface:
1809 return cast<ObjCInterfaceDecl>(DC);
1810 }
1811}
1812
1813QualType ObjCIvarDecl::getUsageType(QualType objectType) const {
1814 return getType().substObjCMemberType(objectType, getDeclContext(),
1815 ObjCSubstitutionContext::Property);
1816}
1817
1818//===----------------------------------------------------------------------===//
1819// ObjCAtDefsFieldDecl
1820//===----------------------------------------------------------------------===//
1821
1822void ObjCAtDefsFieldDecl::anchor() {}
1823
1824ObjCAtDefsFieldDecl
1825*ObjCAtDefsFieldDecl::Create(ASTContext &C, DeclContext *DC,
1826 SourceLocation StartLoc, SourceLocation IdLoc,
1827 IdentifierInfo *Id, QualType T, Expr *BW) {
1828 return new (C, DC) ObjCAtDefsFieldDecl(DC, StartLoc, IdLoc, Id, T, BW);
1829}
1830
1831ObjCAtDefsFieldDecl *ObjCAtDefsFieldDecl::CreateDeserialized(ASTContext &C,
1832 unsigned ID) {
1833 return new (C, ID) ObjCAtDefsFieldDecl(nullptr, SourceLocation(),
1834 SourceLocation(), nullptr, QualType(),
1835 nullptr);
1836}
1837
1838//===----------------------------------------------------------------------===//
1839// ObjCProtocolDecl
1840//===----------------------------------------------------------------------===//
1841
1842void ObjCProtocolDecl::anchor() {}
1843
1844ObjCProtocolDecl::ObjCProtocolDecl(ASTContext &C, DeclContext *DC,
1845 IdentifierInfo *Id, SourceLocation nameLoc,
1846 SourceLocation atStartLoc,
1847 ObjCProtocolDecl *PrevDecl)
1848 : ObjCContainerDecl(ObjCProtocol, DC, Id, nameLoc, atStartLoc),
1849 redeclarable_base(C) {
1850 setPreviousDecl(PrevDecl);
1851 if (PrevDecl)
1852 Data = PrevDecl->Data;
1853}
1854
1855ObjCProtocolDecl *ObjCProtocolDecl::Create(ASTContext &C, DeclContext *DC,
1856 IdentifierInfo *Id,
1857 SourceLocation nameLoc,
1858 SourceLocation atStartLoc,
1859 ObjCProtocolDecl *PrevDecl) {
1860 auto *Result =
1861 new (C, DC) ObjCProtocolDecl(C, DC, Id, nameLoc, atStartLoc, PrevDecl);
1862 Result->Data.setInt(!C.getLangOpts().Modules);
1863 return Result;
1864}
1865
1866ObjCProtocolDecl *ObjCProtocolDecl::CreateDeserialized(ASTContext &C,
1867 unsigned ID) {
1868 ObjCProtocolDecl *Result =
1869 new (C, ID) ObjCProtocolDecl(C, nullptr, nullptr, SourceLocation(),
1870 SourceLocation(), nullptr);
1871 Result->Data.setInt(!C.getLangOpts().Modules);
1872 return Result;
1873}
1874
1875ObjCProtocolDecl *ObjCProtocolDecl::lookupProtocolNamed(IdentifierInfo *Name) {
1876 ObjCProtocolDecl *PDecl = this;
1877
1878 if (Name == getIdentifier())
1879 return PDecl;
1880
1881 for (auto *I : protocols())
1882 if ((PDecl = I->lookupProtocolNamed(Name)))
1883 return PDecl;
1884
1885 return nullptr;
1886}
1887
1888// lookupMethod - Lookup a instance/class method in the protocol and protocols
1889// it inherited.
1890ObjCMethodDecl *ObjCProtocolDecl::lookupMethod(Selector Sel,
1891 bool isInstance) const {
1892 ObjCMethodDecl *MethodDecl = nullptr;
1893
1894 // If there is no definition or the definition is hidden, we don't find
1895 // anything.
1896 const ObjCProtocolDecl *Def = getDefinition();
1897 if (!Def || Def->isHidden())
1898 return nullptr;
1899
1900 if ((MethodDecl = getMethod(Sel, isInstance)))
1901 return MethodDecl;
1902
1903 for (const auto *I : protocols())
1904 if ((MethodDecl = I->lookupMethod(Sel, isInstance)))
1905 return MethodDecl;
1906 return nullptr;
1907}
1908
1909void ObjCProtocolDecl::allocateDefinitionData() {
1910 assert(!Data.getPointer() && "Protocol already has a definition!")((!Data.getPointer() && "Protocol already has a definition!"
) ? static_cast<void> (0) : __assert_fail ("!Data.getPointer() && \"Protocol already has a definition!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/lib/AST/DeclObjC.cpp"
, 1910, __PRETTY_FUNCTION__))
;
1911 Data.setPointer(new (getASTContext()) DefinitionData);
1912 Data.getPointer()->Definition = this;
1913}
1914
1915void ObjCProtocolDecl::startDefinition() {
1916 allocateDefinitionData();
1917
1918 // Update all of the declarations with a pointer to the definition.
1919 for (auto *RD : redecls())
1920 RD->Data = this->Data;
1921}
1922
1923void ObjCProtocolDecl::collectPropertiesToImplement(PropertyMap &PM,
1924 PropertyDeclOrder &PO) const {
1925 if (const ObjCProtocolDecl *PDecl = getDefinition()) {
1926 for (auto *Prop : PDecl->properties()) {
1927 // Insert into PM if not there already.
1928 PM.insert(std::make_pair(
1929 std::make_pair(Prop->getIdentifier(), Prop->isClassProperty()),
1930 Prop));
1931 PO.push_back(Prop);
1932 }
1933 // Scan through protocol's protocols.
1934 for (const auto *PI : PDecl->protocols())
1935 PI->collectPropertiesToImplement(PM, PO);
1936 }
1937}
1938
1939void ObjCProtocolDecl::collectInheritedProtocolProperties(
1940 const ObjCPropertyDecl *Property, ProtocolPropertySet &PS,
1941 PropertyDeclOrder &PO) const {
1942 if (const ObjCProtocolDecl *PDecl = getDefinition()) {
1943 if (!PS.insert(PDecl).second)
1944 return;
1945 for (auto *Prop : PDecl->properties()) {
1946 if (Prop == Property)
1947 continue;
1948 if (Prop->getIdentifier() == Property->getIdentifier()) {
1949 PO.push_back(Prop);
1950 return;
1951 }
1952 }
1953 // Scan through protocol's protocols which did not have a matching property.
1954 for (const auto *PI : PDecl->protocols())
1955 PI->collectInheritedProtocolProperties(Property, PS, PO);
1956 }
1957}
1958
1959StringRef
1960ObjCProtocolDecl::getObjCRuntimeNameAsString() const {
1961 if (const auto *ObjCRTName = getAttr<ObjCRuntimeNameAttr>())
1962 return ObjCRTName->getMetadataName();
1963
1964 return getName();
1965}
1966
1967//===----------------------------------------------------------------------===//
1968// ObjCCategoryDecl
1969//===----------------------------------------------------------------------===//
1970
1971void ObjCCategoryDecl::anchor() {}
1972
1973ObjCCategoryDecl::ObjCCategoryDecl(DeclContext *DC, SourceLocation AtLoc,
1974 SourceLocation ClassNameLoc,
1975 SourceLocation CategoryNameLoc,
1976 IdentifierInfo *Id, ObjCInterfaceDecl *IDecl,
1977 ObjCTypeParamList *typeParamList,
1978 SourceLocation IvarLBraceLoc,
1979 SourceLocation IvarRBraceLoc)
1980 : ObjCContainerDecl(ObjCCategory, DC, Id, ClassNameLoc, AtLoc),
1981 ClassInterface(IDecl), CategoryNameLoc(CategoryNameLoc),
1982 IvarLBraceLoc(IvarLBraceLoc), IvarRBraceLoc(IvarRBraceLoc) {
1983 setTypeParamList(typeParamList);
1984}
1985
1986ObjCCategoryDecl *ObjCCategoryDecl::Create(ASTContext &C, DeclContext *DC,
1987 SourceLocation AtLoc,
1988 SourceLocation ClassNameLoc,
1989 SourceLocation CategoryNameLoc,
1990 IdentifierInfo *Id,
1991 ObjCInterfaceDecl *IDecl,
1992 ObjCTypeParamList *typeParamList,
1993 SourceLocation IvarLBraceLoc,
1994 SourceLocation IvarRBraceLoc) {
1995 auto *CatDecl =
1996 new (C, DC) ObjCCategoryDecl(DC, AtLoc, ClassNameLoc, CategoryNameLoc, Id,
1997 IDecl, typeParamList, IvarLBraceLoc,
1998 IvarRBraceLoc);
1999 if (IDecl) {
2000 // Link this category into its class's category list.
2001 CatDecl->NextClassCategory = IDecl->getCategoryListRaw();
2002 if (IDecl->hasDefinition()) {
2003 IDecl->setCategoryListRaw(CatDecl);
2004 if (ASTMutationListener *L = C.getASTMutationListener())
2005 L->AddedObjCCategoryToInterface(CatDecl, IDecl);
2006 }
2007 }
2008
2009 return CatDecl;
2010}
2011
2012ObjCCategoryDecl *ObjCCategoryDecl::CreateDeserialized(ASTContext &C,
2013 unsigned ID) {
2014 return new (C, ID) ObjCCategoryDecl(nullptr, SourceLocation(),
2015 SourceLocation(), SourceLocation(),
2016 nullptr, nullptr, nullptr);
2017}
2018
2019ObjCCategoryImplDecl *ObjCCategoryDecl::getImplementation() const {
2020 return getASTContext().getObjCImplementation(
2021 const_cast<ObjCCategoryDecl*>(this));
2022}
2023
2024void ObjCCategoryDecl::setImplementation(ObjCCategoryImplDecl *ImplD) {
2025 getASTContext().setObjCImplementation(this, ImplD);
2026}
2027
2028void ObjCCategoryDecl::setTypeParamList(ObjCTypeParamList *TPL) {
2029 TypeParamList = TPL;
2030 if (!TPL)
2031 return;
2032 // Set the declaration context of each of the type parameters.
2033 for (auto *typeParam : *TypeParamList)
2034 typeParam->setDeclContext(this);
2035}
2036
2037//===----------------------------------------------------------------------===//
2038// ObjCCategoryImplDecl
2039//===----------------------------------------------------------------------===//
2040
2041void ObjCCategoryImplDecl::anchor() {}
2042
2043ObjCCategoryImplDecl *
2044ObjCCategoryImplDecl::Create(ASTContext &C, DeclContext *DC,
2045 IdentifierInfo *Id,
2046 ObjCInterfaceDecl *ClassInterface,
2047 SourceLocation nameLoc,
2048 SourceLocation atStartLoc,
2049 SourceLocation CategoryNameLoc) {
2050 if (ClassInterface && ClassInterface->hasDefinition())
2051 ClassInterface = ClassInterface->getDefinition();
2052 return new (C, DC) ObjCCategoryImplDecl(DC, Id, ClassInterface, nameLoc,
2053 atStartLoc, CategoryNameLoc);
2054}
2055
2056ObjCCategoryImplDecl *ObjCCategoryImplDecl::CreateDeserialized(ASTContext &C,
2057 unsigned ID) {
2058 return new (C, ID) ObjCCategoryImplDecl(nullptr, nullptr, nullptr,
2059 SourceLocation(), SourceLocation(),
2060 SourceLocation());
2061}
2062
2063ObjCCategoryDecl *ObjCCategoryImplDecl::getCategoryDecl() const {
2064 // The class interface might be NULL if we are working with invalid code.
2065 if (const ObjCInterfaceDecl *ID = getClassInterface())
2066 return ID->FindCategoryDeclaration(getIdentifier());
2067 return nullptr;
2068}
2069
2070void ObjCImplDecl::anchor() {}
2071
2072void ObjCImplDecl::addPropertyImplementation(ObjCPropertyImplDecl *property) {
2073 // FIXME: The context should be correct before we get here.
2074 property->setLexicalDeclContext(this);
2075 addDecl(property);
2076}
2077
2078void ObjCImplDecl::setClassInterface(ObjCInterfaceDecl *IFace) {
2079 ASTContext &Ctx = getASTContext();
2080
2081 if (auto *ImplD = dyn_cast_or_null<ObjCImplementationDecl>(this)) {
2082 if (IFace)
2083 Ctx.setObjCImplementation(IFace, ImplD);
2084
2085 } else if (auto *ImplD = dyn_cast_or_null<ObjCCategoryImplDecl>(this)) {
2086 if (ObjCCategoryDecl *CD = IFace->FindCategoryDeclaration(getIdentifier()))
2087 Ctx.setObjCImplementation(CD, ImplD);
2088 }
2089
2090 ClassInterface = IFace;
2091}
2092
2093/// FindPropertyImplIvarDecl - This method lookup the ivar in the list of
2094/// properties implemented in this \@implementation block and returns
2095/// the implemented property that uses it.
2096ObjCPropertyImplDecl *ObjCImplDecl::
2097FindPropertyImplIvarDecl(IdentifierInfo *ivarId) const {
2098 for (auto *PID : property_impls())
2099 if (PID->getPropertyIvarDecl() &&
2100 PID->getPropertyIvarDecl()->getIdentifier() == ivarId)
2101 return PID;
2102 return nullptr;
2103}
2104
2105/// FindPropertyImplDecl - This method looks up a previous ObjCPropertyImplDecl
2106/// added to the list of those properties \@synthesized/\@dynamic in this
2107/// category \@implementation block.
2108ObjCPropertyImplDecl *ObjCImplDecl::
2109FindPropertyImplDecl(IdentifierInfo *Id,
2110 ObjCPropertyQueryKind QueryKind) const {
2111 ObjCPropertyImplDecl *ClassPropImpl = nullptr;
2112 for (auto *PID : property_impls())
2113 // If queryKind is unknown, we return the instance property if one
2114 // exists; otherwise we return the class property.
2115 if (PID->getPropertyDecl()->getIdentifier() == Id) {
2116 if ((QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown &&
2117 !PID->getPropertyDecl()->isClassProperty()) ||
2118 (QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_class &&
2119 PID->getPropertyDecl()->isClassProperty()) ||
2120 (QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_instance &&
2121 !PID->getPropertyDecl()->isClassProperty()))
2122 return PID;
2123
2124 if (PID->getPropertyDecl()->isClassProperty())
2125 ClassPropImpl = PID;
2126 }
2127
2128 if (QueryKind == ObjCPropertyQueryKind::OBJC_PR_query_unknown)
2129 // We can't find the instance property, return the class property.
2130 return ClassPropImpl;
2131
2132 return nullptr;
2133}
2134
2135raw_ostream &clang::operator<<(raw_ostream &OS,
2136 const ObjCCategoryImplDecl &CID) {
2137 OS << CID.getName();
2138 return OS;
2139}
2140
2141//===----------------------------------------------------------------------===//
2142// ObjCImplementationDecl
2143//===----------------------------------------------------------------------===//
2144
2145void ObjCImplementationDecl::anchor() {}
2146
2147ObjCImplementationDecl *
2148ObjCImplementationDecl::Create(ASTContext &C, DeclContext *DC,
2149 ObjCInterfaceDecl *ClassInterface,
2150 ObjCInterfaceDecl *SuperDecl,
2151 SourceLocation nameLoc,
2152 SourceLocation atStartLoc,
2153 SourceLocation superLoc,
2154 SourceLocation IvarLBraceLoc,
2155 SourceLocation IvarRBraceLoc) {
2156 if (ClassInterface && ClassInterface->hasDefinition())
2157 ClassInterface = ClassInterface->getDefinition();
2158 return new (C, DC) ObjCImplementationDecl(DC, ClassInterface, SuperDecl,
2159 nameLoc, atStartLoc, superLoc,
2160 IvarLBraceLoc, IvarRBraceLoc);
2161}
2162
2163ObjCImplementationDecl *
2164ObjCImplementationDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
2165 return new (C, ID) ObjCImplementationDecl(nullptr, nullptr, nullptr,
2166 SourceLocation(), SourceLocation());
2167}
2168
2169void ObjCImplementationDecl::setIvarInitializers(ASTContext &C,
2170 CXXCtorInitializer ** initializers,
2171 unsigned numInitializers) {
2172 if (numInitializers > 0) {
2173 NumIvarInitializers = numInitializers;
2174 auto **ivarInitializers = new (C) CXXCtorInitializer*[NumIvarInitializers];
2175 memcpy(ivarInitializers, initializers,
2176 numInitializers * sizeof(CXXCtorInitializer*));
2177 IvarInitializers = ivarInitializers;
2178 }
2179}
2180
2181ObjCImplementationDecl::init_const_iterator
2182ObjCImplementationDecl::init_begin() const {
2183 return IvarInitializers.get(getASTContext().getExternalSource());
2184}
2185
2186raw_ostream &clang::operator<<(raw_ostream &OS,
2187 const ObjCImplementationDecl &ID) {
2188 OS << ID.getName();
2189 return OS;
2190}
2191
2192//===----------------------------------------------------------------------===//
2193// ObjCCompatibleAliasDecl
2194//===----------------------------------------------------------------------===//
2195
2196void ObjCCompatibleAliasDecl::anchor() {}
2197
2198ObjCCompatibleAliasDecl *
2199ObjCCompatibleAliasDecl::Create(ASTContext &C, DeclContext *DC,
2200 SourceLocation L,
2201 IdentifierInfo *Id,
2202 ObjCInterfaceDecl* AliasedClass) {
2203 return new (C, DC) ObjCCompatibleAliasDecl(DC, L, Id, AliasedClass);
2204}
2205
2206ObjCCompatibleAliasDecl *
2207ObjCCompatibleAliasDecl::CreateDeserialized(ASTContext &C, unsigned ID) {
2208 return new (C, ID) ObjCCompatibleAliasDecl(nullptr, SourceLocation(),
2209 nullptr, nullptr);
2210}
2211
2212//===----------------------------------------------------------------------===//
2213// ObjCPropertyDecl
2214//===----------------------------------------------------------------------===//
2215
2216void ObjCPropertyDecl::anchor() {}
2217
2218ObjCPropertyDecl *ObjCPropertyDecl::Create(ASTContext &C, DeclContext *DC,
2219 SourceLocation L,
2220 IdentifierInfo *Id,
2221 SourceLocation AtLoc,
2222 SourceLocation LParenLoc,
2223 QualType T,
2224 TypeSourceInfo *TSI,
2225 PropertyControl propControl) {
2226 return new (C, DC) ObjCPropertyDecl(DC, L, Id, AtLoc, LParenLoc, T, TSI,
2227 propControl);
2228}
2229
2230ObjCPropertyDecl *ObjCPropertyDecl::CreateDeserialized(ASTContext &C,
2231 unsigned ID) {
2232 return new (C, ID) ObjCPropertyDecl(nullptr, SourceLocation(), nullptr,
2233 SourceLocation(), SourceLocation(),
2234 QualType(), nullptr, None);
2235}
2236
2237QualType ObjCPropertyDecl::getUsageType(QualType objectType) const {
2238 return DeclType.substObjCMemberType(objectType, getDeclContext(),
2239 ObjCSubstitutionContext::Property);
2240}
2241
2242//===----------------------------------------------------------------------===//
2243// ObjCPropertyImplDecl
2244//===----------------------------------------------------------------------===//
2245
2246ObjCPropertyImplDecl *ObjCPropertyImplDecl::Create(ASTContext &C,
2247 DeclContext *DC,
2248 SourceLocation atLoc,
2249 SourceLocation L,
2250 ObjCPropertyDecl *property,
2251 Kind PK,
2252 ObjCIvarDecl *ivar,
2253 SourceLocation ivarLoc) {
2254 return new (C, DC) ObjCPropertyImplDecl(DC, atLoc, L, property, PK, ivar,
2255 ivarLoc);
2256}
2257
2258ObjCPropertyImplDecl *ObjCPropertyImplDecl::CreateDeserialized(ASTContext &C,
2259 unsigned ID) {
2260 return new (C, ID) ObjCPropertyImplDecl(nullptr, SourceLocation(),
2261 SourceLocation(), nullptr, Dynamic,
2262 nullptr, SourceLocation());
2263}
2264
2265SourceRange ObjCPropertyImplDecl::getSourceRange() const {
2266 SourceLocation EndLoc = getLocation();
2267 if (IvarLoc.isValid())
2268 EndLoc = IvarLoc;
2269
2270 return SourceRange(AtLoc, EndLoc);
2271}

/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h

1//===- DeclObjC.h - Classes for representing declarations -------*- C++ -*-===//
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// This file defines the DeclObjC interface and subclasses.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_AST_DECLOBJC_H
14#define LLVM_CLANG_AST_DECLOBJC_H
15
16#include "clang/AST/Decl.h"
17#include "clang/AST/DeclBase.h"
18#include "clang/AST/ExternalASTSource.h"
19#include "clang/AST/Redeclarable.h"
20#include "clang/AST/SelectorLocationsKind.h"
21#include "clang/AST/Type.h"
22#include "clang/Basic/IdentifierTable.h"
23#include "clang/Basic/LLVM.h"
24#include "clang/Basic/SourceLocation.h"
25#include "clang/Basic/Specifiers.h"
26#include "llvm/ADT/ArrayRef.h"
27#include "llvm/ADT/DenseMap.h"
28#include "llvm/ADT/DenseSet.h"
29#include "llvm/ADT/None.h"
30#include "llvm/ADT/PointerIntPair.h"
31#include "llvm/ADT/STLExtras.h"
32#include "llvm/ADT/StringRef.h"
33#include "llvm/ADT/iterator_range.h"
34#include "llvm/Support/Compiler.h"
35#include "llvm/Support/TrailingObjects.h"
36#include <cassert>
37#include <cstddef>
38#include <cstdint>
39#include <iterator>
40#include <string>
41#include <utility>
42
43namespace clang {
44
45class ASTContext;
46class CompoundStmt;
47class CXXCtorInitializer;
48class Expr;
49class ObjCCategoryDecl;
50class ObjCCategoryImplDecl;
51class ObjCImplementationDecl;
52class ObjCInterfaceDecl;
53class ObjCIvarDecl;
54class ObjCPropertyDecl;
55class ObjCPropertyImplDecl;
56class ObjCProtocolDecl;
57class Stmt;
58
59class ObjCListBase {
60protected:
61 /// List is an array of pointers to objects that are not owned by this object.
62 void **List = nullptr;
63 unsigned NumElts = 0;
64
65public:
66 ObjCListBase() = default;
67 ObjCListBase(const ObjCListBase &) = delete;
68 ObjCListBase &operator=(const ObjCListBase &) = delete;
69
70 unsigned size() const { return NumElts; }
71 bool empty() const { return NumElts == 0; }
72
73protected:
74 void set(void *const* InList, unsigned Elts, ASTContext &Ctx);
75};
76
77/// ObjCList - This is a simple template class used to hold various lists of
78/// decls etc, which is heavily used by the ObjC front-end. This only use case
79/// this supports is setting the list all at once and then reading elements out
80/// of it.
81template <typename T>
82class ObjCList : public ObjCListBase {
83public:
84 void set(T* const* InList, unsigned Elts, ASTContext &Ctx) {
85 ObjCListBase::set(reinterpret_cast<void*const*>(InList), Elts, Ctx);
86 }
87
88 using iterator = T* const *;
89
90 iterator begin() const { return (iterator)List; }
91 iterator end() const { return (iterator)List+NumElts; }
92
93 T* operator[](unsigned Idx) const {
94 assert(Idx < NumElts && "Invalid access")((Idx < NumElts && "Invalid access") ? static_cast
<void> (0) : __assert_fail ("Idx < NumElts && \"Invalid access\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 94, __PRETTY_FUNCTION__))
;
95 return (T*)List[Idx];
96 }
97};
98
99/// A list of Objective-C protocols, along with the source
100/// locations at which they were referenced.
101class ObjCProtocolList : public ObjCList<ObjCProtocolDecl> {
102 SourceLocation *Locations = nullptr;
103
104 using ObjCList<ObjCProtocolDecl>::set;
105
106public:
107 ObjCProtocolList() = default;
108
109 using loc_iterator = const SourceLocation *;
110
111 loc_iterator loc_begin() const { return Locations; }
112 loc_iterator loc_end() const { return Locations + size(); }
113
114 void set(ObjCProtocolDecl* const* InList, unsigned Elts,
115 const SourceLocation *Locs, ASTContext &Ctx);
116};
117
118/// ObjCMethodDecl - Represents an instance or class method declaration.
119/// ObjC methods can be declared within 4 contexts: class interfaces,
120/// categories, protocols, and class implementations. While C++ member
121/// functions leverage C syntax, Objective-C method syntax is modeled after
122/// Smalltalk (using colons to specify argument types/expressions).
123/// Here are some brief examples:
124///
125/// Setter/getter instance methods:
126/// - (void)setMenu:(NSMenu *)menu;
127/// - (NSMenu *)menu;
128///
129/// Instance method that takes 2 NSView arguments:
130/// - (void)replaceSubview:(NSView *)oldView with:(NSView *)newView;
131///
132/// Getter class method:
133/// + (NSMenu *)defaultMenu;
134///
135/// A selector represents a unique name for a method. The selector names for
136/// the above methods are setMenu:, menu, replaceSubview:with:, and defaultMenu.
137///
138class ObjCMethodDecl : public NamedDecl, public DeclContext {
139 // This class stores some data in DeclContext::ObjCMethodDeclBits
140 // to save some space. Use the provided accessors to access it.
141
142public:
143 enum ImplementationControl { None, Required, Optional };
144
145private:
146 /// Return type of this method.
147 QualType MethodDeclType;
148
149 /// Type source information for the return type.
150 TypeSourceInfo *ReturnTInfo;
151
152 /// Array of ParmVarDecls for the formal parameters of this method
153 /// and optionally followed by selector locations.
154 void *ParamsAndSelLocs = nullptr;
155 unsigned NumParams = 0;
156
157 /// List of attributes for this method declaration.
158 SourceLocation DeclEndLoc; // the location of the ';' or '{'.
159
160 /// The following are only used for method definitions, null otherwise.
161 LazyDeclStmtPtr Body;
162
163 /// SelfDecl - Decl for the implicit self parameter. This is lazily
164 /// constructed by createImplicitParams.
165 ImplicitParamDecl *SelfDecl = nullptr;
166
167 /// CmdDecl - Decl for the implicit _cmd parameter. This is lazily
168 /// constructed by createImplicitParams.
169 ImplicitParamDecl *CmdDecl = nullptr;
170
171 ObjCMethodDecl(SourceLocation beginLoc, SourceLocation endLoc,
172 Selector SelInfo, QualType T, TypeSourceInfo *ReturnTInfo,
173 DeclContext *contextDecl, bool isInstance = true,
174 bool isVariadic = false, bool isPropertyAccessor = false,
175 bool isImplicitlyDeclared = false, bool isDefined = false,
176 ImplementationControl impControl = None,
177 bool HasRelatedResultType = false);
178
179 SelectorLocationsKind getSelLocsKind() const {
180 return static_cast<SelectorLocationsKind>(ObjCMethodDeclBits.SelLocsKind);
181 }
182
183 void setSelLocsKind(SelectorLocationsKind Kind) {
184 ObjCMethodDeclBits.SelLocsKind = Kind;
185 }
186
187 bool hasStandardSelLocs() const {
188 return getSelLocsKind() != SelLoc_NonStandard;
189 }
190
191 /// Get a pointer to the stored selector identifiers locations array.
192 /// No locations will be stored if HasStandardSelLocs is true.
193 SourceLocation *getStoredSelLocs() {
194 return reinterpret_cast<SourceLocation *>(getParams() + NumParams);
195 }
196 const SourceLocation *getStoredSelLocs() const {
197 return reinterpret_cast<const SourceLocation *>(getParams() + NumParams);
198 }
199
200 /// Get a pointer to the stored selector identifiers locations array.
201 /// No locations will be stored if HasStandardSelLocs is true.
202 ParmVarDecl **getParams() {
203 return reinterpret_cast<ParmVarDecl **>(ParamsAndSelLocs);
204 }
205 const ParmVarDecl *const *getParams() const {
206 return reinterpret_cast<const ParmVarDecl *const *>(ParamsAndSelLocs);
207 }
208
209 /// Get the number of stored selector identifiers locations.
210 /// No locations will be stored if HasStandardSelLocs is true.
211 unsigned getNumStoredSelLocs() const {
212 if (hasStandardSelLocs())
213 return 0;
214 return getNumSelectorLocs();
215 }
216
217 void setParamsAndSelLocs(ASTContext &C,
218 ArrayRef<ParmVarDecl*> Params,
219 ArrayRef<SourceLocation> SelLocs);
220
221 /// A definition will return its interface declaration.
222 /// An interface declaration will return its definition.
223 /// Otherwise it will return itself.
224 ObjCMethodDecl *getNextRedeclarationImpl() override;
225
226public:
227 friend class ASTDeclReader;
228 friend class ASTDeclWriter;
229
230 static ObjCMethodDecl *
231 Create(ASTContext &C, SourceLocation beginLoc, SourceLocation endLoc,
232 Selector SelInfo, QualType T, TypeSourceInfo *ReturnTInfo,
233 DeclContext *contextDecl, bool isInstance = true,
234 bool isVariadic = false, bool isPropertyAccessor = false,
235 bool isImplicitlyDeclared = false, bool isDefined = false,
236 ImplementationControl impControl = None,
237 bool HasRelatedResultType = false);
238
239 static ObjCMethodDecl *CreateDeserialized(ASTContext &C, unsigned ID);
240
241 ObjCMethodDecl *getCanonicalDecl() override;
242 const ObjCMethodDecl *getCanonicalDecl() const {
243 return const_cast<ObjCMethodDecl*>(this)->getCanonicalDecl();
244 }
245
246 ObjCDeclQualifier getObjCDeclQualifier() const {
247 return static_cast<ObjCDeclQualifier>(ObjCMethodDeclBits.objcDeclQualifier);
248 }
249
250 void setObjCDeclQualifier(ObjCDeclQualifier QV) {
251 ObjCMethodDeclBits.objcDeclQualifier = QV;
252 }
253
254 /// Determine whether this method has a result type that is related
255 /// to the message receiver's type.
256 bool hasRelatedResultType() const {
257 return ObjCMethodDeclBits.RelatedResultType;
258 }
259
260 /// Note whether this method has a related result type.
261 void setRelatedResultType(bool RRT = true) {
262 ObjCMethodDeclBits.RelatedResultType = RRT;
263 }
264
265 /// True if this is a method redeclaration in the same interface.
266 bool isRedeclaration() const { return ObjCMethodDeclBits.IsRedeclaration; }
267 void setIsRedeclaration(bool RD) { ObjCMethodDeclBits.IsRedeclaration = RD; }
268 void setAsRedeclaration(const ObjCMethodDecl *PrevMethod);
269
270 /// True if redeclared in the same interface.
271 bool hasRedeclaration() const { return ObjCMethodDeclBits.HasRedeclaration; }
272 void setHasRedeclaration(bool HRD) const {
273 ObjCMethodDeclBits.HasRedeclaration = HRD;
274 }
275
276 /// Returns the location where the declarator ends. It will be
277 /// the location of ';' for a method declaration and the location of '{'
278 /// for a method definition.
279 SourceLocation getDeclaratorEndLoc() const { return DeclEndLoc; }
280
281 // Location information, modeled after the Stmt API.
282 SourceLocation getBeginLoc() const LLVM_READONLY__attribute__((__pure__)) { return getLocation(); }
283 SourceLocation getEndLoc() const LLVM_READONLY__attribute__((__pure__));
284 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__)) {
285 return SourceRange(getLocation(), getEndLoc());
286 }
287
288 SourceLocation getSelectorStartLoc() const {
289 if (isImplicit())
290 return getBeginLoc();
291 return getSelectorLoc(0);
292 }
293
294 SourceLocation getSelectorLoc(unsigned Index) const {
295 assert(Index < getNumSelectorLocs() && "Index out of range!")((Index < getNumSelectorLocs() && "Index out of range!"
) ? static_cast<void> (0) : __assert_fail ("Index < getNumSelectorLocs() && \"Index out of range!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 295, __PRETTY_FUNCTION__))
;
296 if (hasStandardSelLocs())
297 return getStandardSelectorLoc(Index, getSelector(),
298 getSelLocsKind() == SelLoc_StandardWithSpace,
299 parameters(),
300 DeclEndLoc);
301 return getStoredSelLocs()[Index];
302 }
303
304 void getSelectorLocs(SmallVectorImpl<SourceLocation> &SelLocs) const;
305
306 unsigned getNumSelectorLocs() const {
307 if (isImplicit())
308 return 0;
309 Selector Sel = getSelector();
310 if (Sel.isUnarySelector())
311 return 1;
312 return Sel.getNumArgs();
313 }
314
315 ObjCInterfaceDecl *getClassInterface();
316 const ObjCInterfaceDecl *getClassInterface() const {
317 return const_cast<ObjCMethodDecl*>(this)->getClassInterface();
318 }
319
320 Selector getSelector() const { return getDeclName().getObjCSelector(); }
321
322 QualType getReturnType() const { return MethodDeclType; }
323 void setReturnType(QualType T) { MethodDeclType = T; }
324 SourceRange getReturnTypeSourceRange() const;
325
326 /// Determine the type of an expression that sends a message to this
327 /// function. This replaces the type parameters with the types they would
328 /// get if the receiver was parameterless (e.g. it may replace the type
329 /// parameter with 'id').
330 QualType getSendResultType() const;
331
332 /// Determine the type of an expression that sends a message to this
333 /// function with the given receiver type.
334 QualType getSendResultType(QualType receiverType) const;
335
336 TypeSourceInfo *getReturnTypeSourceInfo() const { return ReturnTInfo; }
337 void setReturnTypeSourceInfo(TypeSourceInfo *TInfo) { ReturnTInfo = TInfo; }
338
339 // Iterator access to formal parameters.
340 unsigned param_size() const { return NumParams; }
341
342 using param_const_iterator = const ParmVarDecl *const *;
343 using param_iterator = ParmVarDecl *const *;
344 using param_range = llvm::iterator_range<param_iterator>;
345 using param_const_range = llvm::iterator_range<param_const_iterator>;
346
347 param_const_iterator param_begin() const {
348 return param_const_iterator(getParams());
349 }
350
351 param_const_iterator param_end() const {
352 return param_const_iterator(getParams() + NumParams);
353 }
354
355 param_iterator param_begin() { return param_iterator(getParams()); }
356 param_iterator param_end() { return param_iterator(getParams() + NumParams); }
357
358 // This method returns and of the parameters which are part of the selector
359 // name mangling requirements.
360 param_const_iterator sel_param_end() const {
361 return param_begin() + getSelector().getNumArgs();
362 }
363
364 // ArrayRef access to formal parameters. This should eventually
365 // replace the iterator interface above.
366 ArrayRef<ParmVarDecl*> parameters() const {
367 return llvm::makeArrayRef(const_cast<ParmVarDecl**>(getParams()),
368 NumParams);
369 }
370
371 ParmVarDecl *getParamDecl(unsigned Idx) {
372 assert(Idx < NumParams && "Index out of bounds!")((Idx < NumParams && "Index out of bounds!") ? static_cast
<void> (0) : __assert_fail ("Idx < NumParams && \"Index out of bounds!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 372, __PRETTY_FUNCTION__))
;
373 return getParams()[Idx];
374 }
375 const ParmVarDecl *getParamDecl(unsigned Idx) const {
376 return const_cast<ObjCMethodDecl *>(this)->getParamDecl(Idx);
377 }
378
379 /// Sets the method's parameters and selector source locations.
380 /// If the method is implicit (not coming from source) \p SelLocs is
381 /// ignored.
382 void setMethodParams(ASTContext &C,
383 ArrayRef<ParmVarDecl*> Params,
384 ArrayRef<SourceLocation> SelLocs = llvm::None);
385
386 // Iterator access to parameter types.
387 struct GetTypeFn {
388 QualType operator()(const ParmVarDecl *PD) const { return PD->getType(); }
389 };
390
391 using param_type_iterator =
392 llvm::mapped_iterator<param_const_iterator, GetTypeFn>;
393
394 param_type_iterator param_type_begin() const {
395 return llvm::map_iterator(param_begin(), GetTypeFn());
396 }
397
398 param_type_iterator param_type_end() const {
399 return llvm::map_iterator(param_end(), GetTypeFn());
400 }
401
402 /// createImplicitParams - Used to lazily create the self and cmd
403 /// implict parameters. This must be called prior to using getSelfDecl()
404 /// or getCmdDecl(). The call is ignored if the implicit parameters
405 /// have already been created.
406 void createImplicitParams(ASTContext &Context, const ObjCInterfaceDecl *ID);
407
408 /// \return the type for \c self and set \arg selfIsPseudoStrong and
409 /// \arg selfIsConsumed accordingly.
410 QualType getSelfType(ASTContext &Context, const ObjCInterfaceDecl *OID,
411 bool &selfIsPseudoStrong, bool &selfIsConsumed);
412
413 ImplicitParamDecl * getSelfDecl() const { return SelfDecl; }
414 void setSelfDecl(ImplicitParamDecl *SD) { SelfDecl = SD; }
415 ImplicitParamDecl * getCmdDecl() const { return CmdDecl; }
416 void setCmdDecl(ImplicitParamDecl *CD) { CmdDecl = CD; }
417
418 /// Determines the family of this method.
419 ObjCMethodFamily getMethodFamily() const;
420
421 bool isInstanceMethod() const { return ObjCMethodDeclBits.IsInstance; }
422 void setInstanceMethod(bool isInst) {
423 ObjCMethodDeclBits.IsInstance = isInst;
424 }
425
426 bool isVariadic() const { return ObjCMethodDeclBits.IsVariadic; }
427 void setVariadic(bool isVar) { ObjCMethodDeclBits.IsVariadic = isVar; }
428
429 bool isClassMethod() const { return !isInstanceMethod(); }
430
431 bool isPropertyAccessor() const {
432 return ObjCMethodDeclBits.IsPropertyAccessor;
433 }
434
435 void setPropertyAccessor(bool isAccessor) {
436 ObjCMethodDeclBits.IsPropertyAccessor = isAccessor;
437 }
438
439 bool isDefined() const { return ObjCMethodDeclBits.IsDefined; }
440 void setDefined(bool isDefined) { ObjCMethodDeclBits.IsDefined = isDefined; }
441
442 /// Whether this method overrides any other in the class hierarchy.
443 ///
444 /// A method is said to override any method in the class's
445 /// base classes, its protocols, or its categories' protocols, that has
446 /// the same selector and is of the same kind (class or instance).
447 /// A method in an implementation is not considered as overriding the same
448 /// method in the interface or its categories.
449 bool isOverriding() const { return ObjCMethodDeclBits.IsOverriding; }
450 void setOverriding(bool IsOver) { ObjCMethodDeclBits.IsOverriding = IsOver; }
451
452 /// Return overridden methods for the given \p Method.
453 ///
454 /// An ObjC method is considered to override any method in the class's
455 /// base classes (and base's categories), its protocols, or its categories'
456 /// protocols, that has
457 /// the same selector and is of the same kind (class or instance).
458 /// A method in an implementation is not considered as overriding the same
459 /// method in the interface or its categories.
460 void getOverriddenMethods(
461 SmallVectorImpl<const ObjCMethodDecl *> &Overridden) const;
462
463 /// True if the method was a definition but its body was skipped.
464 bool hasSkippedBody() const { return ObjCMethodDeclBits.HasSkippedBody; }
465 void setHasSkippedBody(bool Skipped = true) {
466 ObjCMethodDeclBits.HasSkippedBody = Skipped;
467 }
468
469 /// Returns the property associated with this method's selector.
470 ///
471 /// Note that even if this particular method is not marked as a property
472 /// accessor, it is still possible for it to match a property declared in a
473 /// superclass. Pass \c false if you only want to check the current class.
474 const ObjCPropertyDecl *findPropertyDecl(bool CheckOverrides = true) const;
475
476 // Related to protocols declared in \@protocol
477 void setDeclImplementation(ImplementationControl ic) {
478 ObjCMethodDeclBits.DeclImplementation = ic;
479 }
480
481 ImplementationControl getImplementationControl() const {
482 return ImplementationControl(ObjCMethodDeclBits.DeclImplementation);
483 }
484
485 bool isOptional() const {
486 return getImplementationControl() == Optional;
487 }
488
489 /// Returns true if this specific method declaration is marked with the
490 /// designated initializer attribute.
491 bool isThisDeclarationADesignatedInitializer() const;
492
493 /// Returns true if the method selector resolves to a designated initializer
494 /// in the class's interface.
495 ///
496 /// \param InitMethod if non-null and the function returns true, it receives
497 /// the method declaration that was marked with the designated initializer
498 /// attribute.
499 bool isDesignatedInitializerForTheInterface(
500 const ObjCMethodDecl **InitMethod = nullptr) const;
501
502 /// Determine whether this method has a body.
503 bool hasBody() const override { return Body.isValid(); }
504
505 /// Retrieve the body of this method, if it has one.
506 Stmt *getBody() const override;
507
508 void setLazyBody(uint64_t Offset) { Body = Offset; }
509
510 CompoundStmt *getCompoundBody() { return (CompoundStmt*)getBody(); }
511 void setBody(Stmt *B) { Body = B; }
512
513 /// Returns whether this specific method is a definition.
514 bool isThisDeclarationADefinition() const { return hasBody(); }
515
516 /// Is this method defined in the NSObject base class?
517 bool definedInNSObject(const ASTContext &) const;
518
519 // Implement isa/cast/dyncast/etc.
520 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
521 static bool classofKind(Kind K) { return K == ObjCMethod; }
522
523 static DeclContext *castToDeclContext(const ObjCMethodDecl *D) {
524 return static_cast<DeclContext *>(const_cast<ObjCMethodDecl*>(D));
525 }
526
527 static ObjCMethodDecl *castFromDeclContext(const DeclContext *DC) {
528 return static_cast<ObjCMethodDecl *>(const_cast<DeclContext*>(DC));
529 }
530};
531
532/// Describes the variance of a given generic parameter.
533enum class ObjCTypeParamVariance : uint8_t {
534 /// The parameter is invariant: must match exactly.
535 Invariant,
536
537 /// The parameter is covariant, e.g., X<T> is a subtype of X<U> when
538 /// the type parameter is covariant and T is a subtype of U.
539 Covariant,
540
541 /// The parameter is contravariant, e.g., X<T> is a subtype of X<U>
542 /// when the type parameter is covariant and U is a subtype of T.
543 Contravariant,
544};
545
546/// Represents the declaration of an Objective-C type parameter.
547///
548/// \code
549/// @interface NSDictionary<Key : id<NSCopying>, Value>
550/// @end
551/// \endcode
552///
553/// In the example above, both \c Key and \c Value are represented by
554/// \c ObjCTypeParamDecl. \c Key has an explicit bound of \c id<NSCopying>,
555/// while \c Value gets an implicit bound of \c id.
556///
557/// Objective-C type parameters are typedef-names in the grammar,
558class ObjCTypeParamDecl : public TypedefNameDecl {
559 /// Index of this type parameter in the type parameter list.
560 unsigned Index : 14;
561
562 /// The variance of the type parameter.
563 unsigned Variance : 2;
564
565 /// The location of the variance, if any.
566 SourceLocation VarianceLoc;
567
568 /// The location of the ':', which will be valid when the bound was
569 /// explicitly specified.
570 SourceLocation ColonLoc;
571
572 ObjCTypeParamDecl(ASTContext &ctx, DeclContext *dc,
573 ObjCTypeParamVariance variance, SourceLocation varianceLoc,
574 unsigned index,
575 SourceLocation nameLoc, IdentifierInfo *name,
576 SourceLocation colonLoc, TypeSourceInfo *boundInfo)
577 : TypedefNameDecl(ObjCTypeParam, ctx, dc, nameLoc, nameLoc, name,
578 boundInfo),
579 Index(index), Variance(static_cast<unsigned>(variance)),
580 VarianceLoc(varianceLoc), ColonLoc(colonLoc) {}
581
582 void anchor() override;
583
584public:
585 friend class ASTDeclReader;
586 friend class ASTDeclWriter;
587
588 static ObjCTypeParamDecl *Create(ASTContext &ctx, DeclContext *dc,
589 ObjCTypeParamVariance variance,
590 SourceLocation varianceLoc,
591 unsigned index,
592 SourceLocation nameLoc,
593 IdentifierInfo *name,
594 SourceLocation colonLoc,
595 TypeSourceInfo *boundInfo);
596 static ObjCTypeParamDecl *CreateDeserialized(ASTContext &ctx, unsigned ID);
597
598 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__));
599
600 /// Determine the variance of this type parameter.
601 ObjCTypeParamVariance getVariance() const {
602 return static_cast<ObjCTypeParamVariance>(Variance);
603 }
604
605 /// Set the variance of this type parameter.
606 void setVariance(ObjCTypeParamVariance variance) {
607 Variance = static_cast<unsigned>(variance);
608 }
609
610 /// Retrieve the location of the variance keyword.
611 SourceLocation getVarianceLoc() const { return VarianceLoc; }
612
613 /// Retrieve the index into its type parameter list.
614 unsigned getIndex() const { return Index; }
615
616 /// Whether this type parameter has an explicitly-written type bound, e.g.,
617 /// "T : NSView".
618 bool hasExplicitBound() const { return ColonLoc.isValid(); }
619
620 /// Retrieve the location of the ':' separating the type parameter name
621 /// from the explicitly-specified bound.
622 SourceLocation getColonLoc() const { return ColonLoc; }
623
624 // Implement isa/cast/dyncast/etc.
625 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
626 static bool classofKind(Kind K) { return K == ObjCTypeParam; }
627};
628
629/// Stores a list of Objective-C type parameters for a parameterized class
630/// or a category/extension thereof.
631///
632/// \code
633/// @interface NSArray<T> // stores the <T>
634/// @end
635/// \endcode
636class ObjCTypeParamList final
637 : private llvm::TrailingObjects<ObjCTypeParamList, ObjCTypeParamDecl *> {
638 /// Stores the components of a SourceRange as a POD.
639 struct PODSourceRange {
640 unsigned Begin;
641 unsigned End;
642 };
643
644 union {
645 /// Location of the left and right angle brackets.
646 PODSourceRange Brackets;
647
648 // Used only for alignment.
649 ObjCTypeParamDecl *AlignmentHack;
650 };
651
652 /// The number of parameters in the list, which are tail-allocated.
653 unsigned NumParams;
654
655 ObjCTypeParamList(SourceLocation lAngleLoc,
656 ArrayRef<ObjCTypeParamDecl *> typeParams,
657 SourceLocation rAngleLoc);
658
659public:
660 friend TrailingObjects;
661
662 /// Create a new Objective-C type parameter list.
663 static ObjCTypeParamList *create(ASTContext &ctx,
664 SourceLocation lAngleLoc,
665 ArrayRef<ObjCTypeParamDecl *> typeParams,
666 SourceLocation rAngleLoc);
667
668 /// Iterate through the type parameters in the list.
669 using iterator = ObjCTypeParamDecl **;
670
671 iterator begin() { return getTrailingObjects<ObjCTypeParamDecl *>(); }
672
673 iterator end() { return begin() + size(); }
674
675 /// Determine the number of type parameters in this list.
676 unsigned size() const { return NumParams; }
677
678 // Iterate through the type parameters in the list.
679 using const_iterator = ObjCTypeParamDecl * const *;
680
681 const_iterator begin() const {
682 return getTrailingObjects<ObjCTypeParamDecl *>();
683 }
684
685 const_iterator end() const {
686 return begin() + size();
687 }
688
689 ObjCTypeParamDecl *front() const {
690 assert(size() > 0 && "empty Objective-C type parameter list")((size() > 0 && "empty Objective-C type parameter list"
) ? static_cast<void> (0) : __assert_fail ("size() > 0 && \"empty Objective-C type parameter list\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 690, __PRETTY_FUNCTION__))
;
691 return *begin();
692 }
693
694 ObjCTypeParamDecl *back() const {
695 assert(size() > 0 && "empty Objective-C type parameter list")((size() > 0 && "empty Objective-C type parameter list"
) ? static_cast<void> (0) : __assert_fail ("size() > 0 && \"empty Objective-C type parameter list\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 695, __PRETTY_FUNCTION__))
;
696 return *(end() - 1);
697 }
698
699 SourceLocation getLAngleLoc() const {
700 return SourceLocation::getFromRawEncoding(Brackets.Begin);
701 }
702
703 SourceLocation getRAngleLoc() const {
704 return SourceLocation::getFromRawEncoding(Brackets.End);
705 }
706
707 SourceRange getSourceRange() const {
708 return SourceRange(getLAngleLoc(), getRAngleLoc());
709 }
710
711 /// Gather the default set of type arguments to be substituted for
712 /// these type parameters when dealing with an unspecialized type.
713 void gatherDefaultTypeArgs(SmallVectorImpl<QualType> &typeArgs) const;
714};
715
716enum class ObjCPropertyQueryKind : uint8_t {
717 OBJC_PR_query_unknown = 0x00,
718 OBJC_PR_query_instance,
719 OBJC_PR_query_class
720};
721
722/// Represents one property declaration in an Objective-C interface.
723///
724/// For example:
725/// \code{.mm}
726/// \@property (assign, readwrite) int MyProperty;
727/// \endcode
728class ObjCPropertyDecl : public NamedDecl {
729 void anchor() override;
730
731public:
732 enum PropertyAttributeKind {
733 OBJC_PR_noattr = 0x00,
734 OBJC_PR_readonly = 0x01,
735 OBJC_PR_getter = 0x02,
736 OBJC_PR_assign = 0x04,
737 OBJC_PR_readwrite = 0x08,
738 OBJC_PR_retain = 0x10,
739 OBJC_PR_copy = 0x20,
740 OBJC_PR_nonatomic = 0x40,
741 OBJC_PR_setter = 0x80,
742 OBJC_PR_atomic = 0x100,
743 OBJC_PR_weak = 0x200,
744 OBJC_PR_strong = 0x400,
745 OBJC_PR_unsafe_unretained = 0x800,
746 /// Indicates that the nullability of the type was spelled with a
747 /// property attribute rather than a type qualifier.
748 OBJC_PR_nullability = 0x1000,
749 OBJC_PR_null_resettable = 0x2000,
750 OBJC_PR_class = 0x4000
751 // Adding a property should change NumPropertyAttrsBits
752 };
753
754 enum {
755 /// Number of bits fitting all the property attributes.
756 NumPropertyAttrsBits = 15
757 };
758
759 enum SetterKind { Assign, Retain, Copy, Weak };
760 enum PropertyControl { None, Required, Optional };
761
762private:
763 // location of \@property
764 SourceLocation AtLoc;
765
766 // location of '(' starting attribute list or null.
767 SourceLocation LParenLoc;
768
769 QualType DeclType;
770 TypeSourceInfo *DeclTypeSourceInfo;
771 unsigned PropertyAttributes : NumPropertyAttrsBits;
772 unsigned PropertyAttributesAsWritten : NumPropertyAttrsBits;
773
774 // \@required/\@optional
775 unsigned PropertyImplementation : 2;
776
777 // getter name of NULL if no getter
778 Selector GetterName;
779
780 // setter name of NULL if no setter
781 Selector SetterName;
782
783 // location of the getter attribute's value
784 SourceLocation GetterNameLoc;
785
786 // location of the setter attribute's value
787 SourceLocation SetterNameLoc;
788
789 // Declaration of getter instance method
790 ObjCMethodDecl *GetterMethodDecl = nullptr;
791
792 // Declaration of setter instance method
793 ObjCMethodDecl *SetterMethodDecl = nullptr;
794
795 // Synthesize ivar for this property
796 ObjCIvarDecl *PropertyIvarDecl = nullptr;
797
798 ObjCPropertyDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
799 SourceLocation AtLocation, SourceLocation LParenLocation,
800 QualType T, TypeSourceInfo *TSI,
801 PropertyControl propControl)
802 : NamedDecl(ObjCProperty, DC, L, Id), AtLoc(AtLocation),
803 LParenLoc(LParenLocation), DeclType(T), DeclTypeSourceInfo(TSI),
804 PropertyAttributes(OBJC_PR_noattr),
805 PropertyAttributesAsWritten(OBJC_PR_noattr),
806 PropertyImplementation(propControl), GetterName(Selector()),
807 SetterName(Selector()) {}
808
809public:
810 static ObjCPropertyDecl *Create(ASTContext &C, DeclContext *DC,
811 SourceLocation L,
812 IdentifierInfo *Id, SourceLocation AtLocation,
813 SourceLocation LParenLocation,
814 QualType T,
815 TypeSourceInfo *TSI,
816 PropertyControl propControl = None);
817
818 static ObjCPropertyDecl *CreateDeserialized(ASTContext &C, unsigned ID);
819
820 SourceLocation getAtLoc() const { return AtLoc; }
821 void setAtLoc(SourceLocation L) { AtLoc = L; }
822
823 SourceLocation getLParenLoc() const { return LParenLoc; }
824 void setLParenLoc(SourceLocation L) { LParenLoc = L; }
825
826 TypeSourceInfo *getTypeSourceInfo() const { return DeclTypeSourceInfo; }
827
828 QualType getType() const { return DeclType; }
829
830 void setType(QualType T, TypeSourceInfo *TSI) {
831 DeclType = T;
832 DeclTypeSourceInfo = TSI;
833 }
834
835 /// Retrieve the type when this property is used with a specific base object
836 /// type.
837 QualType getUsageType(QualType objectType) const;
838
839 PropertyAttributeKind getPropertyAttributes() const {
840 return PropertyAttributeKind(PropertyAttributes);
841 }
842
843 void setPropertyAttributes(PropertyAttributeKind PRVal) {
844 PropertyAttributes |= PRVal;
845 }
846
847 void overwritePropertyAttributes(unsigned PRVal) {
848 PropertyAttributes = PRVal;
849 }
850
851 PropertyAttributeKind getPropertyAttributesAsWritten() const {
852 return PropertyAttributeKind(PropertyAttributesAsWritten);
853 }
854
855 void setPropertyAttributesAsWritten(PropertyAttributeKind PRVal) {
856 PropertyAttributesAsWritten = PRVal;
857 }
858
859 // Helper methods for accessing attributes.
860
861 /// isReadOnly - Return true iff the property has a setter.
862 bool isReadOnly() const {
863 return (PropertyAttributes & OBJC_PR_readonly);
864 }
865
866 /// isAtomic - Return true if the property is atomic.
867 bool isAtomic() const {
868 return (PropertyAttributes & OBJC_PR_atomic);
869 }
870
871 /// isRetaining - Return true if the property retains its value.
872 bool isRetaining() const {
873 return (PropertyAttributes &
874 (OBJC_PR_retain | OBJC_PR_strong | OBJC_PR_copy));
875 }
876
877 bool isInstanceProperty() const { return !isClassProperty(); }
878 bool isClassProperty() const { return PropertyAttributes & OBJC_PR_class; }
879
880 ObjCPropertyQueryKind getQueryKind() const {
881 return isClassProperty() ? ObjCPropertyQueryKind::OBJC_PR_query_class :
882 ObjCPropertyQueryKind::OBJC_PR_query_instance;
883 }
884
885 static ObjCPropertyQueryKind getQueryKind(bool isClassProperty) {
886 return isClassProperty ? ObjCPropertyQueryKind::OBJC_PR_query_class :
887 ObjCPropertyQueryKind::OBJC_PR_query_instance;
888 }
889
890 /// getSetterKind - Return the method used for doing assignment in
891 /// the property setter. This is only valid if the property has been
892 /// defined to have a setter.
893 SetterKind getSetterKind() const {
894 if (PropertyAttributes & OBJC_PR_strong)
895 return getType()->isBlockPointerType() ? Copy : Retain;
896 if (PropertyAttributes & OBJC_PR_retain)
897 return Retain;
898 if (PropertyAttributes & OBJC_PR_copy)
899 return Copy;
900 if (PropertyAttributes & OBJC_PR_weak)
901 return Weak;
902 return Assign;
903 }
904
905 Selector getGetterName() const { return GetterName; }
906 SourceLocation getGetterNameLoc() const { return GetterNameLoc; }
907
908 void setGetterName(Selector Sel, SourceLocation Loc = SourceLocation()) {
909 GetterName = Sel;
910 GetterNameLoc = Loc;
911 }
912
913 Selector getSetterName() const { return SetterName; }
914 SourceLocation getSetterNameLoc() const { return SetterNameLoc; }
915
916 void setSetterName(Selector Sel, SourceLocation Loc = SourceLocation()) {
917 SetterName = Sel;
918 SetterNameLoc = Loc;
919 }
920
921 ObjCMethodDecl *getGetterMethodDecl() const { return GetterMethodDecl; }
922 void setGetterMethodDecl(ObjCMethodDecl *gDecl) { GetterMethodDecl = gDecl; }
923
924 ObjCMethodDecl *getSetterMethodDecl() const { return SetterMethodDecl; }
925 void setSetterMethodDecl(ObjCMethodDecl *gDecl) { SetterMethodDecl = gDecl; }
926
927 // Related to \@optional/\@required declared in \@protocol
928 void setPropertyImplementation(PropertyControl pc) {
929 PropertyImplementation = pc;
930 }
931
932 PropertyControl getPropertyImplementation() const {
933 return PropertyControl(PropertyImplementation);
934 }
935
936 bool isOptional() const {
937 return getPropertyImplementation() == PropertyControl::Optional;
938 }
939
940 void setPropertyIvarDecl(ObjCIvarDecl *Ivar) {
941 PropertyIvarDecl = Ivar;
942 }
943
944 ObjCIvarDecl *getPropertyIvarDecl() const {
945 return PropertyIvarDecl;
946 }
947
948 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__)) {
949 return SourceRange(AtLoc, getLocation());
950 }
951
952 /// Get the default name of the synthesized ivar.
953 IdentifierInfo *getDefaultSynthIvarName(ASTContext &Ctx) const;
954
955 /// Lookup a property by name in the specified DeclContext.
956 static ObjCPropertyDecl *findPropertyDecl(const DeclContext *DC,
957 const IdentifierInfo *propertyID,
958 ObjCPropertyQueryKind queryKind);
959
960 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
961 static bool classofKind(Kind K) { return K == ObjCProperty; }
962};
963
964/// ObjCContainerDecl - Represents a container for method declarations.
965/// Current sub-classes are ObjCInterfaceDecl, ObjCCategoryDecl,
966/// ObjCProtocolDecl, and ObjCImplDecl.
967///
968class ObjCContainerDecl : public NamedDecl, public DeclContext {
969 // This class stores some data in DeclContext::ObjCContainerDeclBits
970 // to save some space. Use the provided accessors to access it.
971
972 // These two locations in the range mark the end of the method container.
973 // The first points to the '@' token, and the second to the 'end' token.
974 SourceRange AtEnd;
975
976 void anchor() override;
977
978public:
979 ObjCContainerDecl(Kind DK, DeclContext *DC, IdentifierInfo *Id,
980 SourceLocation nameLoc, SourceLocation atStartLoc);
981
982 // Iterator access to instance/class properties.
983 using prop_iterator = specific_decl_iterator<ObjCPropertyDecl>;
984 using prop_range =
985 llvm::iterator_range<specific_decl_iterator<ObjCPropertyDecl>>;
986
987 prop_range properties() const { return prop_range(prop_begin(), prop_end()); }
988
989 prop_iterator prop_begin() const {
990 return prop_iterator(decls_begin());
991 }
992
993 prop_iterator prop_end() const {
994 return prop_iterator(decls_end());
995 }
996
997 using instprop_iterator =
998 filtered_decl_iterator<ObjCPropertyDecl,
999 &ObjCPropertyDecl::isInstanceProperty>;
1000 using instprop_range = llvm::iterator_range<instprop_iterator>;
1001
1002 instprop_range instance_properties() const {
1003 return instprop_range(instprop_begin(), instprop_end());
1004 }
1005
1006 instprop_iterator instprop_begin() const {
1007 return instprop_iterator(decls_begin());
1008 }
1009
1010 instprop_iterator instprop_end() const {
1011 return instprop_iterator(decls_end());
1012 }
1013
1014 using classprop_iterator =
1015 filtered_decl_iterator<ObjCPropertyDecl,
1016 &ObjCPropertyDecl::isClassProperty>;
1017 using classprop_range = llvm::iterator_range<classprop_iterator>;
1018
1019 classprop_range class_properties() const {
1020 return classprop_range(classprop_begin(), classprop_end());
1021 }
1022
1023 classprop_iterator classprop_begin() const {
1024 return classprop_iterator(decls_begin());
1025 }
1026
1027 classprop_iterator classprop_end() const {
1028 return classprop_iterator(decls_end());
1029 }
1030
1031 // Iterator access to instance/class methods.
1032 using method_iterator = specific_decl_iterator<ObjCMethodDecl>;
1033 using method_range =
1034 llvm::iterator_range<specific_decl_iterator<ObjCMethodDecl>>;
1035
1036 method_range methods() const {
1037 return method_range(meth_begin(), meth_end());
1038 }
1039
1040 method_iterator meth_begin() const {
1041 return method_iterator(decls_begin());
1042 }
1043
1044 method_iterator meth_end() const {
1045 return method_iterator(decls_end());
1046 }
1047
1048 using instmeth_iterator =
1049 filtered_decl_iterator<ObjCMethodDecl,
1050 &ObjCMethodDecl::isInstanceMethod>;
1051 using instmeth_range = llvm::iterator_range<instmeth_iterator>;
1052
1053 instmeth_range instance_methods() const {
1054 return instmeth_range(instmeth_begin(), instmeth_end());
1055 }
1056
1057 instmeth_iterator instmeth_begin() const {
1058 return instmeth_iterator(decls_begin());
1059 }
1060
1061 instmeth_iterator instmeth_end() const {
1062 return instmeth_iterator(decls_end());
1063 }
1064
1065 using classmeth_iterator =
1066 filtered_decl_iterator<ObjCMethodDecl,
1067 &ObjCMethodDecl::isClassMethod>;
1068 using classmeth_range = llvm::iterator_range<classmeth_iterator>;
1069
1070 classmeth_range class_methods() const {
1071 return classmeth_range(classmeth_begin(), classmeth_end());
1072 }
1073
1074 classmeth_iterator classmeth_begin() const {
1075 return classmeth_iterator(decls_begin());
1076 }
1077
1078 classmeth_iterator classmeth_end() const {
1079 return classmeth_iterator(decls_end());
1080 }
1081
1082 // Get the local instance/class method declared in this interface.
1083 ObjCMethodDecl *getMethod(Selector Sel, bool isInstance,
1084 bool AllowHidden = false) const;
1085
1086 ObjCMethodDecl *getInstanceMethod(Selector Sel,
1087 bool AllowHidden = false) const {
1088 return getMethod(Sel, true/*isInstance*/, AllowHidden);
1089 }
1090
1091 ObjCMethodDecl *getClassMethod(Selector Sel, bool AllowHidden = false) const {
1092 return getMethod(Sel, false/*isInstance*/, AllowHidden);
1093 }
1094
1095 bool HasUserDeclaredSetterMethod(const ObjCPropertyDecl *P) const;
1096 ObjCIvarDecl *getIvarDecl(IdentifierInfo *Id) const;
1097
1098 ObjCPropertyDecl *
1099 FindPropertyDeclaration(const IdentifierInfo *PropertyId,
1100 ObjCPropertyQueryKind QueryKind) const;
1101
1102 using PropertyMap =
1103 llvm::DenseMap<std::pair<IdentifierInfo *, unsigned/*isClassProperty*/>,
1104 ObjCPropertyDecl *>;
1105 using ProtocolPropertySet = llvm::SmallDenseSet<const ObjCProtocolDecl *, 8>;
1106 using PropertyDeclOrder = llvm::SmallVector<ObjCPropertyDecl *, 8>;
1107
1108 /// This routine collects list of properties to be implemented in the class.
1109 /// This includes, class's and its conforming protocols' properties.
1110 /// Note, the superclass's properties are not included in the list.
1111 virtual void collectPropertiesToImplement(PropertyMap &PM,
1112 PropertyDeclOrder &PO) const {}
1113
1114 SourceLocation getAtStartLoc() const { return ObjCContainerDeclBits.AtStart; }
1115
1116 void setAtStartLoc(SourceLocation Loc) {
1117 ObjCContainerDeclBits.AtStart = Loc;
1118 }
1119
1120 // Marks the end of the container.
1121 SourceRange getAtEndRange() const { return AtEnd; }
1122
1123 void setAtEndRange(SourceRange atEnd) { AtEnd = atEnd; }
1124
1125 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__)) {
1126 return SourceRange(getAtStartLoc(), getAtEndRange().getEnd());
1127 }
1128
1129 // Implement isa/cast/dyncast/etc.
1130 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1131
1132 static bool classofKind(Kind K) {
1133 return K >= firstObjCContainer &&
1134 K <= lastObjCContainer;
1135 }
1136
1137 static DeclContext *castToDeclContext(const ObjCContainerDecl *D) {
1138 return static_cast<DeclContext *>(const_cast<ObjCContainerDecl*>(D));
1139 }
1140
1141 static ObjCContainerDecl *castFromDeclContext(const DeclContext *DC) {
1142 return static_cast<ObjCContainerDecl *>(const_cast<DeclContext*>(DC));
1143 }
1144};
1145
1146/// Represents an ObjC class declaration.
1147///
1148/// For example:
1149///
1150/// \code
1151/// // MostPrimitive declares no super class (not particularly useful).
1152/// \@interface MostPrimitive
1153/// // no instance variables or methods.
1154/// \@end
1155///
1156/// // NSResponder inherits from NSObject & implements NSCoding (a protocol).
1157/// \@interface NSResponder : NSObject \<NSCoding>
1158/// { // instance variables are represented by ObjCIvarDecl.
1159/// id nextResponder; // nextResponder instance variable.
1160/// }
1161/// - (NSResponder *)nextResponder; // return a pointer to NSResponder.
1162/// - (void)mouseMoved:(NSEvent *)theEvent; // return void, takes a pointer
1163/// \@end // to an NSEvent.
1164/// \endcode
1165///
1166/// Unlike C/C++, forward class declarations are accomplished with \@class.
1167/// Unlike C/C++, \@class allows for a list of classes to be forward declared.
1168/// Unlike C++, ObjC is a single-rooted class model. In Cocoa, classes
1169/// typically inherit from NSObject (an exception is NSProxy).
1170///
1171class ObjCInterfaceDecl : public ObjCContainerDecl
1172 , public Redeclarable<ObjCInterfaceDecl> {
1173 friend class ASTContext;
1174
1175 /// TypeForDecl - This indicates the Type object that represents this
1176 /// TypeDecl. It is a cache maintained by ASTContext::getObjCInterfaceType
1177 mutable const Type *TypeForDecl = nullptr;
1178
1179 struct DefinitionData {
1180 /// The definition of this class, for quick access from any
1181 /// declaration.
1182 ObjCInterfaceDecl *Definition = nullptr;
1183
1184 /// When non-null, this is always an ObjCObjectType.
1185 TypeSourceInfo *SuperClassTInfo = nullptr;
1186
1187 /// Protocols referenced in the \@interface declaration
1188 ObjCProtocolList ReferencedProtocols;
1189
1190 /// Protocols reference in both the \@interface and class extensions.
1191 ObjCList<ObjCProtocolDecl> AllReferencedProtocols;
1192
1193 /// List of categories and class extensions defined for this class.
1194 ///
1195 /// Categories are stored as a linked list in the AST, since the categories
1196 /// and class extensions come long after the initial interface declaration,
1197 /// and we avoid dynamically-resized arrays in the AST wherever possible.
1198 ObjCCategoryDecl *CategoryList = nullptr;
1199
1200 /// IvarList - List of all ivars defined by this class; including class
1201 /// extensions and implementation. This list is built lazily.
1202 ObjCIvarDecl *IvarList = nullptr;
1203
1204 /// Indicates that the contents of this Objective-C class will be
1205 /// completed by the external AST source when required.
1206 mutable unsigned ExternallyCompleted : 1;
1207
1208 /// Indicates that the ivar cache does not yet include ivars
1209 /// declared in the implementation.
1210 mutable unsigned IvarListMissingImplementation : 1;
1211
1212 /// Indicates that this interface decl contains at least one initializer
1213 /// marked with the 'objc_designated_initializer' attribute.
1214 unsigned HasDesignatedInitializers : 1;
1215
1216 enum InheritedDesignatedInitializersState {
1217 /// We didn't calculate whether the designated initializers should be
1218 /// inherited or not.
1219 IDI_Unknown = 0,
1220
1221 /// Designated initializers are inherited for the super class.
1222 IDI_Inherited = 1,
1223
1224 /// The class does not inherit designated initializers.
1225 IDI_NotInherited = 2
1226 };
1227
1228 /// One of the \c InheritedDesignatedInitializersState enumeratos.
1229 mutable unsigned InheritedDesignatedInitializers : 2;
1230
1231 /// The location of the last location in this declaration, before
1232 /// the properties/methods. For example, this will be the '>', '}', or
1233 /// identifier,
1234 SourceLocation EndLoc;
1235
1236 DefinitionData()
1237 : ExternallyCompleted(false), IvarListMissingImplementation(true),
1238 HasDesignatedInitializers(false),
1239 InheritedDesignatedInitializers(IDI_Unknown) {}
1240 };
1241
1242 /// The type parameters associated with this class, if any.
1243 ObjCTypeParamList *TypeParamList = nullptr;
1244
1245 /// Contains a pointer to the data associated with this class,
1246 /// which will be NULL if this class has not yet been defined.
1247 ///
1248 /// The bit indicates when we don't need to check for out-of-date
1249 /// declarations. It will be set unless modules are enabled.
1250 llvm::PointerIntPair<DefinitionData *, 1, bool> Data;
1251
1252 ObjCInterfaceDecl(const ASTContext &C, DeclContext *DC, SourceLocation AtLoc,
1253 IdentifierInfo *Id, ObjCTypeParamList *typeParamList,
1254 SourceLocation CLoc, ObjCInterfaceDecl *PrevDecl,
1255 bool IsInternal);
1256
1257 void anchor() override;
1258
1259 void LoadExternalDefinition() const;
1260
1261 DefinitionData &data() const {
1262 assert(Data.getPointer() && "Declaration has no definition!")((Data.getPointer() && "Declaration has no definition!"
) ? static_cast<void> (0) : __assert_fail ("Data.getPointer() && \"Declaration has no definition!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 1262, __PRETTY_FUNCTION__))
;
1263 return *Data.getPointer();
1264 }
1265
1266 /// Allocate the definition data for this class.
1267 void allocateDefinitionData();
1268
1269 using redeclarable_base = Redeclarable<ObjCInterfaceDecl>;
1270
1271 ObjCInterfaceDecl *getNextRedeclarationImpl() override {
1272 return getNextRedeclaration();
1273 }
1274
1275 ObjCInterfaceDecl *getPreviousDeclImpl() override {
1276 return getPreviousDecl();
1277 }
1278
1279 ObjCInterfaceDecl *getMostRecentDeclImpl() override {
1280 return getMostRecentDecl();
1281 }
1282
1283public:
1284 static ObjCInterfaceDecl *Create(const ASTContext &C, DeclContext *DC,
1285 SourceLocation atLoc,
1286 IdentifierInfo *Id,
1287 ObjCTypeParamList *typeParamList,
1288 ObjCInterfaceDecl *PrevDecl,
1289 SourceLocation ClassLoc = SourceLocation(),
1290 bool isInternal = false);
1291
1292 static ObjCInterfaceDecl *CreateDeserialized(const ASTContext &C, unsigned ID);
1293
1294 /// Retrieve the type parameters of this class.
1295 ///
1296 /// This function looks for a type parameter list for the given
1297 /// class; if the class has been declared (with \c \@class) but not
1298 /// defined (with \c \@interface), it will search for a declaration that
1299 /// has type parameters, skipping any declarations that do not.
1300 ObjCTypeParamList *getTypeParamList() const;
1301
1302 /// Set the type parameters of this class.
1303 ///
1304 /// This function is used by the AST importer, which must import the type
1305 /// parameters after creating their DeclContext to avoid loops.
1306 void setTypeParamList(ObjCTypeParamList *TPL);
1307
1308 /// Retrieve the type parameters written on this particular declaration of
1309 /// the class.
1310 ObjCTypeParamList *getTypeParamListAsWritten() const {
1311 return TypeParamList;
1312 }
1313
1314 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__)) {
1315 if (isThisDeclarationADefinition())
1316 return ObjCContainerDecl::getSourceRange();
1317
1318 return SourceRange(getAtStartLoc(), getLocation());
1319 }
1320
1321 /// Indicate that this Objective-C class is complete, but that
1322 /// the external AST source will be responsible for filling in its contents
1323 /// when a complete class is required.
1324 void setExternallyCompleted();
1325
1326 /// Indicate that this interface decl contains at least one initializer
1327 /// marked with the 'objc_designated_initializer' attribute.
1328 void setHasDesignatedInitializers();
1329
1330 /// Returns true if this interface decl contains at least one initializer
1331 /// marked with the 'objc_designated_initializer' attribute.
1332 bool hasDesignatedInitializers() const;
1333
1334 /// Returns true if this interface decl declares a designated initializer
1335 /// or it inherites one from its super class.
1336 bool declaresOrInheritsDesignatedInitializers() const {
1337 return hasDesignatedInitializers() || inheritsDesignatedInitializers();
1338 }
1339
1340 const ObjCProtocolList &getReferencedProtocols() const {
1341 assert(hasDefinition() && "Caller did not check for forward reference!")((hasDefinition() && "Caller did not check for forward reference!"
) ? static_cast<void> (0) : __assert_fail ("hasDefinition() && \"Caller did not check for forward reference!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 1341, __PRETTY_FUNCTION__))
;
1342 if (data().ExternallyCompleted)
1343 LoadExternalDefinition();
1344
1345 return data().ReferencedProtocols;
1346 }
1347
1348 ObjCImplementationDecl *getImplementation() const;
1349 void setImplementation(ObjCImplementationDecl *ImplD);
1350
1351 ObjCCategoryDecl *FindCategoryDeclaration(IdentifierInfo *CategoryId) const;
1352
1353 // Get the local instance/class method declared in a category.
1354 ObjCMethodDecl *getCategoryInstanceMethod(Selector Sel) const;
1355 ObjCMethodDecl *getCategoryClassMethod(Selector Sel) const;
1356
1357 ObjCMethodDecl *getCategoryMethod(Selector Sel, bool isInstance) const {
1358 return isInstance ? getCategoryInstanceMethod(Sel)
1359 : getCategoryClassMethod(Sel);
1360 }
1361
1362 using protocol_iterator = ObjCProtocolList::iterator;
1363 using protocol_range = llvm::iterator_range<protocol_iterator>;
1364
1365 protocol_range protocols() const {
1366 return protocol_range(protocol_begin(), protocol_end());
1367 }
1368
1369 protocol_iterator protocol_begin() const {
1370 // FIXME: Should make sure no callers ever do this.
1371 if (!hasDefinition())
1372 return protocol_iterator();
1373
1374 if (data().ExternallyCompleted)
1375 LoadExternalDefinition();
1376
1377 return data().ReferencedProtocols.begin();
1378 }
1379
1380 protocol_iterator protocol_end() const {
1381 // FIXME: Should make sure no callers ever do this.
1382 if (!hasDefinition())
1383 return protocol_iterator();
1384
1385 if (data().ExternallyCompleted)
1386 LoadExternalDefinition();
1387
1388 return data().ReferencedProtocols.end();
1389 }
1390
1391 using protocol_loc_iterator = ObjCProtocolList::loc_iterator;
1392 using protocol_loc_range = llvm::iterator_range<protocol_loc_iterator>;
1393
1394 protocol_loc_range protocol_locs() const {
1395 return protocol_loc_range(protocol_loc_begin(), protocol_loc_end());
1396 }
1397
1398 protocol_loc_iterator protocol_loc_begin() const {
1399 // FIXME: Should make sure no callers ever do this.
1400 if (!hasDefinition())
1401 return protocol_loc_iterator();
1402
1403 if (data().ExternallyCompleted)
1404 LoadExternalDefinition();
1405
1406 return data().ReferencedProtocols.loc_begin();
1407 }
1408
1409 protocol_loc_iterator protocol_loc_end() const {
1410 // FIXME: Should make sure no callers ever do this.
1411 if (!hasDefinition())
1412 return protocol_loc_iterator();
1413
1414 if (data().ExternallyCompleted)
1415 LoadExternalDefinition();
1416
1417 return data().ReferencedProtocols.loc_end();
1418 }
1419
1420 using all_protocol_iterator = ObjCList<ObjCProtocolDecl>::iterator;
1421 using all_protocol_range = llvm::iterator_range<all_protocol_iterator>;
1422
1423 all_protocol_range all_referenced_protocols() const {
1424 return all_protocol_range(all_referenced_protocol_begin(),
1425 all_referenced_protocol_end());
1426 }
1427
1428 all_protocol_iterator all_referenced_protocol_begin() const {
1429 // FIXME: Should make sure no callers ever do this.
1430 if (!hasDefinition())
1431 return all_protocol_iterator();
1432
1433 if (data().ExternallyCompleted)
1434 LoadExternalDefinition();
1435
1436 return data().AllReferencedProtocols.empty()
1437 ? protocol_begin()
1438 : data().AllReferencedProtocols.begin();
1439 }
1440
1441 all_protocol_iterator all_referenced_protocol_end() const {
1442 // FIXME: Should make sure no callers ever do this.
1443 if (!hasDefinition())
1444 return all_protocol_iterator();
1445
1446 if (data().ExternallyCompleted)
1447 LoadExternalDefinition();
1448
1449 return data().AllReferencedProtocols.empty()
1450 ? protocol_end()
1451 : data().AllReferencedProtocols.end();
1452 }
1453
1454 using ivar_iterator = specific_decl_iterator<ObjCIvarDecl>;
1455 using ivar_range = llvm::iterator_range<specific_decl_iterator<ObjCIvarDecl>>;
1456
1457 ivar_range ivars() const { return ivar_range(ivar_begin(), ivar_end()); }
1458
1459 ivar_iterator ivar_begin() const {
1460 if (const ObjCInterfaceDecl *Def = getDefinition())
1461 return ivar_iterator(Def->decls_begin());
1462
1463 // FIXME: Should make sure no callers ever do this.
1464 return ivar_iterator();
1465 }
1466
1467 ivar_iterator ivar_end() const {
1468 if (const ObjCInterfaceDecl *Def = getDefinition())
1469 return ivar_iterator(Def->decls_end());
1470
1471 // FIXME: Should make sure no callers ever do this.
1472 return ivar_iterator();
1473 }
1474
1475 unsigned ivar_size() const {
1476 return std::distance(ivar_begin(), ivar_end());
1477 }
1478
1479 bool ivar_empty() const { return ivar_begin() == ivar_end(); }
1480
1481 ObjCIvarDecl *all_declared_ivar_begin();
1482 const ObjCIvarDecl *all_declared_ivar_begin() const {
1483 // Even though this modifies IvarList, it's conceptually const:
1484 // the ivar chain is essentially a cached property of ObjCInterfaceDecl.
1485 return const_cast<ObjCInterfaceDecl *>(this)->all_declared_ivar_begin();
1486 }
1487 void setIvarList(ObjCIvarDecl *ivar) { data().IvarList = ivar; }
1488
1489 /// setProtocolList - Set the list of protocols that this interface
1490 /// implements.
1491 void setProtocolList(ObjCProtocolDecl *const* List, unsigned Num,
1492 const SourceLocation *Locs, ASTContext &C) {
1493 data().ReferencedProtocols.set(List, Num, Locs, C);
1494 }
1495
1496 /// mergeClassExtensionProtocolList - Merge class extension's protocol list
1497 /// into the protocol list for this class.
1498 void mergeClassExtensionProtocolList(ObjCProtocolDecl *const* List,
1499 unsigned Num,
1500 ASTContext &C);
1501
1502 /// Produce a name to be used for class's metadata. It comes either via
1503 /// objc_runtime_name attribute or class name.
1504 StringRef getObjCRuntimeNameAsString() const;
1505
1506 /// Returns the designated initializers for the interface.
1507 ///
1508 /// If this declaration does not have methods marked as designated
1509 /// initializers then the interface inherits the designated initializers of
1510 /// its super class.
1511 void getDesignatedInitializers(
1512 llvm::SmallVectorImpl<const ObjCMethodDecl *> &Methods) const;
1513
1514 /// Returns true if the given selector is a designated initializer for the
1515 /// interface.
1516 ///
1517 /// If this declaration does not have methods marked as designated
1518 /// initializers then the interface inherits the designated initializers of
1519 /// its super class.
1520 ///
1521 /// \param InitMethod if non-null and the function returns true, it receives
1522 /// the method that was marked as a designated initializer.
1523 bool
1524 isDesignatedInitializer(Selector Sel,
1525 const ObjCMethodDecl **InitMethod = nullptr) const;
1526
1527 /// Determine whether this particular declaration of this class is
1528 /// actually also a definition.
1529 bool isThisDeclarationADefinition() const {
1530 return getDefinition() == this;
1531 }
1532
1533 /// Determine whether this class has been defined.
1534 bool hasDefinition() const {
1535 // If the name of this class is out-of-date, bring it up-to-date, which
1536 // might bring in a definition.
1537 // Note: a null value indicates that we don't have a definition and that
1538 // modules are enabled.
1539 if (!Data.getOpaqueValue())
2
Assuming the condition is false
3
Taking false branch
1540 getMostRecentDecl();
1541
1542 return Data.getPointer();
4
Returning value, which participates in a condition later
1543 }
1544
1545 /// Retrieve the definition of this class, or NULL if this class
1546 /// has been forward-declared (with \@class) but not yet defined (with
1547 /// \@interface).
1548 ObjCInterfaceDecl *getDefinition() {
1549 return hasDefinition()? Data.getPointer()->Definition : nullptr;
1550 }
1551
1552 /// Retrieve the definition of this class, or NULL if this class
1553 /// has been forward-declared (with \@class) but not yet defined (with
1554 /// \@interface).
1555 const ObjCInterfaceDecl *getDefinition() const {
1556 return hasDefinition()? Data.getPointer()->Definition : nullptr;
15
Assuming the condition is true
16
'?' condition is true
17
Returning pointer, which participates in a condition later
1557 }
1558
1559 /// Starts the definition of this Objective-C class, taking it from
1560 /// a forward declaration (\@class) to a definition (\@interface).
1561 void startDefinition();
1562
1563 /// Retrieve the superclass type.
1564 const ObjCObjectType *getSuperClassType() const {
1565 if (TypeSourceInfo *TInfo = getSuperClassTInfo())
1566 return TInfo->getType()->castAs<ObjCObjectType>();
1567
1568 return nullptr;
1569 }
1570
1571 // Retrieve the type source information for the superclass.
1572 TypeSourceInfo *getSuperClassTInfo() const {
1573 // FIXME: Should make sure no callers ever do this.
1574 if (!hasDefinition())
1575 return nullptr;
1576
1577 if (data().ExternallyCompleted)
1578 LoadExternalDefinition();
1579
1580 return data().SuperClassTInfo;
1581 }
1582
1583 // Retrieve the declaration for the superclass of this class, which
1584 // does not include any type arguments that apply to the superclass.
1585 ObjCInterfaceDecl *getSuperClass() const;
1586
1587 void setSuperClass(TypeSourceInfo *superClass) {
1588 data().SuperClassTInfo = superClass;
1589 }
1590
1591 /// Iterator that walks over the list of categories, filtering out
1592 /// those that do not meet specific criteria.
1593 ///
1594 /// This class template is used for the various permutations of category
1595 /// and extension iterators.
1596 template<bool (*Filter)(ObjCCategoryDecl *)>
1597 class filtered_category_iterator {
1598 ObjCCategoryDecl *Current = nullptr;
1599
1600 void findAcceptableCategory();
1601
1602 public:
1603 using value_type = ObjCCategoryDecl *;
1604 using reference = value_type;
1605 using pointer = value_type;
1606 using difference_type = std::ptrdiff_t;
1607 using iterator_category = std::input_iterator_tag;
1608
1609 filtered_category_iterator() = default;
1610 explicit filtered_category_iterator(ObjCCategoryDecl *Current)
1611 : Current(Current) {
1612 findAcceptableCategory();
1613 }
1614
1615 reference operator*() const { return Current; }
1616 pointer operator->() const { return Current; }
1617
1618 filtered_category_iterator &operator++();
1619
1620 filtered_category_iterator operator++(int) {
1621 filtered_category_iterator Tmp = *this;
1622 ++(*this);
1623 return Tmp;
1624 }
1625
1626 friend bool operator==(filtered_category_iterator X,
1627 filtered_category_iterator Y) {
1628 return X.Current == Y.Current;
1629 }
1630
1631 friend bool operator!=(filtered_category_iterator X,
1632 filtered_category_iterator Y) {
1633 return X.Current != Y.Current;
1634 }
1635 };
1636
1637private:
1638 /// Test whether the given category is visible.
1639 ///
1640 /// Used in the \c visible_categories_iterator.
1641 static bool isVisibleCategory(ObjCCategoryDecl *Cat);
1642
1643public:
1644 /// Iterator that walks over the list of categories and extensions
1645 /// that are visible, i.e., not hidden in a non-imported submodule.
1646 using visible_categories_iterator =
1647 filtered_category_iterator<isVisibleCategory>;
1648
1649 using visible_categories_range =
1650 llvm::iterator_range<visible_categories_iterator>;
1651
1652 visible_categories_range visible_categories() const {
1653 return visible_categories_range(visible_categories_begin(),
1654 visible_categories_end());
1655 }
1656
1657 /// Retrieve an iterator to the beginning of the visible-categories
1658 /// list.
1659 visible_categories_iterator visible_categories_begin() const {
1660 return visible_categories_iterator(getCategoryListRaw());
1661 }
1662
1663 /// Retrieve an iterator to the end of the visible-categories list.
1664 visible_categories_iterator visible_categories_end() const {
1665 return visible_categories_iterator();
1666 }
1667
1668 /// Determine whether the visible-categories list is empty.
1669 bool visible_categories_empty() const {
1670 return visible_categories_begin() == visible_categories_end();
1671 }
1672
1673private:
1674 /// Test whether the given category... is a category.
1675 ///
1676 /// Used in the \c known_categories_iterator.
1677 static bool isKnownCategory(ObjCCategoryDecl *) { return true; }
1678
1679public:
1680 /// Iterator that walks over all of the known categories and
1681 /// extensions, including those that are hidden.
1682 using known_categories_iterator = filtered_category_iterator<isKnownCategory>;
1683 using known_categories_range =
1684 llvm::iterator_range<known_categories_iterator>;
1685
1686 known_categories_range known_categories() const {
1687 return known_categories_range(known_categories_begin(),
1688 known_categories_end());
1689 }
1690
1691 /// Retrieve an iterator to the beginning of the known-categories
1692 /// list.
1693 known_categories_iterator known_categories_begin() const {
1694 return known_categories_iterator(getCategoryListRaw());
1695 }
1696
1697 /// Retrieve an iterator to the end of the known-categories list.
1698 known_categories_iterator known_categories_end() const {
1699 return known_categories_iterator();
1700 }
1701
1702 /// Determine whether the known-categories list is empty.
1703 bool known_categories_empty() const {
1704 return known_categories_begin() == known_categories_end();
1705 }
1706
1707private:
1708 /// Test whether the given category is a visible extension.
1709 ///
1710 /// Used in the \c visible_extensions_iterator.
1711 static bool isVisibleExtension(ObjCCategoryDecl *Cat);
1712
1713public:
1714 /// Iterator that walks over all of the visible extensions, skipping
1715 /// any that are known but hidden.
1716 using visible_extensions_iterator =
1717 filtered_category_iterator<isVisibleExtension>;
1718
1719 using visible_extensions_range =
1720 llvm::iterator_range<visible_extensions_iterator>;
1721
1722 visible_extensions_range visible_extensions() const {
1723 return visible_extensions_range(visible_extensions_begin(),
1724 visible_extensions_end());
1725 }
1726
1727 /// Retrieve an iterator to the beginning of the visible-extensions
1728 /// list.
1729 visible_extensions_iterator visible_extensions_begin() const {
1730 return visible_extensions_iterator(getCategoryListRaw());
1731 }
1732
1733 /// Retrieve an iterator to the end of the visible-extensions list.
1734 visible_extensions_iterator visible_extensions_end() const {
1735 return visible_extensions_iterator();
1736 }
1737
1738 /// Determine whether the visible-extensions list is empty.
1739 bool visible_extensions_empty() const {
1740 return visible_extensions_begin() == visible_extensions_end();
1741 }
1742
1743private:
1744 /// Test whether the given category is an extension.
1745 ///
1746 /// Used in the \c known_extensions_iterator.
1747 static bool isKnownExtension(ObjCCategoryDecl *Cat);
1748
1749public:
1750 friend class ASTDeclReader;
1751 friend class ASTDeclWriter;
1752 friend class ASTReader;
1753
1754 /// Iterator that walks over all of the known extensions.
1755 using known_extensions_iterator =
1756 filtered_category_iterator<isKnownExtension>;
1757 using known_extensions_range =
1758 llvm::iterator_range<known_extensions_iterator>;
1759
1760 known_extensions_range known_extensions() const {
1761 return known_extensions_range(known_extensions_begin(),
1762 known_extensions_end());
1763 }
1764
1765 /// Retrieve an iterator to the beginning of the known-extensions
1766 /// list.
1767 known_extensions_iterator known_extensions_begin() const {
1768 return known_extensions_iterator(getCategoryListRaw());
1769 }
1770
1771 /// Retrieve an iterator to the end of the known-extensions list.
1772 known_extensions_iterator known_extensions_end() const {
1773 return known_extensions_iterator();
1774 }
1775
1776 /// Determine whether the known-extensions list is empty.
1777 bool known_extensions_empty() const {
1778 return known_extensions_begin() == known_extensions_end();
1779 }
1780
1781 /// Retrieve the raw pointer to the start of the category/extension
1782 /// list.
1783 ObjCCategoryDecl* getCategoryListRaw() const {
1784 // FIXME: Should make sure no callers ever do this.
1785 if (!hasDefinition())
1786 return nullptr;
1787
1788 if (data().ExternallyCompleted)
1789 LoadExternalDefinition();
1790
1791 return data().CategoryList;
1792 }
1793
1794 /// Set the raw pointer to the start of the category/extension
1795 /// list.
1796 void setCategoryListRaw(ObjCCategoryDecl *category) {
1797 data().CategoryList = category;
1798 }
1799
1800 ObjCPropertyDecl
1801 *FindPropertyVisibleInPrimaryClass(IdentifierInfo *PropertyId,
1802 ObjCPropertyQueryKind QueryKind) const;
1803
1804 void collectPropertiesToImplement(PropertyMap &PM,
1805 PropertyDeclOrder &PO) const override;
1806
1807 /// isSuperClassOf - Return true if this class is the specified class or is a
1808 /// super class of the specified interface class.
1809 bool isSuperClassOf(const ObjCInterfaceDecl *I) const {
1810 // If RHS is derived from LHS it is OK; else it is not OK.
1811 while (I != nullptr) {
1812 if (declaresSameEntity(this, I))
1813 return true;
1814
1815 I = I->getSuperClass();
1816 }
1817 return false;
1818 }
1819
1820 /// isArcWeakrefUnavailable - Checks for a class or one of its super classes
1821 /// to be incompatible with __weak references. Returns true if it is.
1822 bool isArcWeakrefUnavailable() const;
1823
1824 /// isObjCRequiresPropertyDefs - Checks that a class or one of its super
1825 /// classes must not be auto-synthesized. Returns class decl. if it must not
1826 /// be; 0, otherwise.
1827 const ObjCInterfaceDecl *isObjCRequiresPropertyDefs() const;
1828
1829 ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName,
1830 ObjCInterfaceDecl *&ClassDeclared);
1831 ObjCIvarDecl *lookupInstanceVariable(IdentifierInfo *IVarName) {
1832 ObjCInterfaceDecl *ClassDeclared;
1833 return lookupInstanceVariable(IVarName, ClassDeclared);
1834 }
1835
1836 ObjCProtocolDecl *lookupNestedProtocol(IdentifierInfo *Name);
1837
1838 // Lookup a method. First, we search locally. If a method isn't
1839 // found, we search referenced protocols and class categories.
1840 ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance,
1841 bool shallowCategoryLookup = false,
1842 bool followSuper = true,
1843 const ObjCCategoryDecl *C = nullptr) const;
1844
1845 /// Lookup an instance method for a given selector.
1846 ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const {
1847 return lookupMethod(Sel, true/*isInstance*/);
1848 }
1849
1850 /// Lookup a class method for a given selector.
1851 ObjCMethodDecl *lookupClassMethod(Selector Sel) const {
1852 return lookupMethod(Sel, false/*isInstance*/);
1853 }
1854
1855 ObjCInterfaceDecl *lookupInheritedClass(const IdentifierInfo *ICName);
1856
1857 /// Lookup a method in the classes implementation hierarchy.
1858 ObjCMethodDecl *lookupPrivateMethod(const Selector &Sel,
1859 bool Instance=true) const;
1860
1861 ObjCMethodDecl *lookupPrivateClassMethod(const Selector &Sel) {
1862 return lookupPrivateMethod(Sel, false);
1863 }
1864
1865 /// Lookup a setter or getter in the class hierarchy,
1866 /// including in all categories except for category passed
1867 /// as argument.
1868 ObjCMethodDecl *lookupPropertyAccessor(const Selector Sel,
1869 const ObjCCategoryDecl *Cat,
1870 bool IsClassProperty) const {
1871 return lookupMethod(Sel, !IsClassProperty/*isInstance*/,
1872 false/*shallowCategoryLookup*/,
1873 true /* followsSuper */,
1874 Cat);
1875 }
1876
1877 SourceLocation getEndOfDefinitionLoc() const {
1878 if (!hasDefinition())
1879 return getLocation();
1880
1881 return data().EndLoc;
1882 }
1883
1884 void setEndOfDefinitionLoc(SourceLocation LE) { data().EndLoc = LE; }
1885
1886 /// Retrieve the starting location of the superclass.
1887 SourceLocation getSuperClassLoc() const;
1888
1889 /// isImplicitInterfaceDecl - check that this is an implicitly declared
1890 /// ObjCInterfaceDecl node. This is for legacy objective-c \@implementation
1891 /// declaration without an \@interface declaration.
1892 bool isImplicitInterfaceDecl() const {
1893 return hasDefinition() ? data().Definition->isImplicit() : isImplicit();
1894 }
1895
1896 /// ClassImplementsProtocol - Checks that 'lProto' protocol
1897 /// has been implemented in IDecl class, its super class or categories (if
1898 /// lookupCategory is true).
1899 bool ClassImplementsProtocol(ObjCProtocolDecl *lProto,
1900 bool lookupCategory,
1901 bool RHSIsQualifiedID = false);
1902
1903 using redecl_range = redeclarable_base::redecl_range;
1904 using redecl_iterator = redeclarable_base::redecl_iterator;
1905
1906 using redeclarable_base::redecls_begin;
1907 using redeclarable_base::redecls_end;
1908 using redeclarable_base::redecls;
1909 using redeclarable_base::getPreviousDecl;
1910 using redeclarable_base::getMostRecentDecl;
1911 using redeclarable_base::isFirstDecl;
1912
1913 /// Retrieves the canonical declaration of this Objective-C class.
1914 ObjCInterfaceDecl *getCanonicalDecl() override { return getFirstDecl(); }
1915 const ObjCInterfaceDecl *getCanonicalDecl() const { return getFirstDecl(); }
1916
1917 // Low-level accessor
1918 const Type *getTypeForDecl() const { return TypeForDecl; }
1919 void setTypeForDecl(const Type *TD) const { TypeForDecl = TD; }
1920
1921 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1922 static bool classofKind(Kind K) { return K == ObjCInterface; }
1923
1924private:
1925 const ObjCInterfaceDecl *findInterfaceWithDesignatedInitializers() const;
1926 bool inheritsDesignatedInitializers() const;
1927};
1928
1929/// ObjCIvarDecl - Represents an ObjC instance variable. In general, ObjC
1930/// instance variables are identical to C. The only exception is Objective-C
1931/// supports C++ style access control. For example:
1932///
1933/// \@interface IvarExample : NSObject
1934/// {
1935/// id defaultToProtected;
1936/// \@public:
1937/// id canBePublic; // same as C++.
1938/// \@protected:
1939/// id canBeProtected; // same as C++.
1940/// \@package:
1941/// id canBePackage; // framework visibility (not available in C++).
1942/// }
1943///
1944class ObjCIvarDecl : public FieldDecl {
1945 void anchor() override;
1946
1947public:
1948 enum AccessControl {
1949 None, Private, Protected, Public, Package
1950 };
1951
1952private:
1953 ObjCIvarDecl(ObjCContainerDecl *DC, SourceLocation StartLoc,
1954 SourceLocation IdLoc, IdentifierInfo *Id,
1955 QualType T, TypeSourceInfo *TInfo, AccessControl ac, Expr *BW,
1956 bool synthesized)
1957 : FieldDecl(ObjCIvar, DC, StartLoc, IdLoc, Id, T, TInfo, BW,
1958 /*Mutable=*/false, /*HasInit=*/ICIS_NoInit),
1959 DeclAccess(ac), Synthesized(synthesized) {}
1960
1961public:
1962 static ObjCIvarDecl *Create(ASTContext &C, ObjCContainerDecl *DC,
1963 SourceLocation StartLoc, SourceLocation IdLoc,
1964 IdentifierInfo *Id, QualType T,
1965 TypeSourceInfo *TInfo,
1966 AccessControl ac, Expr *BW = nullptr,
1967 bool synthesized=false);
1968
1969 static ObjCIvarDecl *CreateDeserialized(ASTContext &C, unsigned ID);
1970
1971 /// Return the class interface that this ivar is logically contained
1972 /// in; this is either the interface where the ivar was declared, or the
1973 /// interface the ivar is conceptually a part of in the case of synthesized
1974 /// ivars.
1975 const ObjCInterfaceDecl *getContainingInterface() const;
1976
1977 ObjCIvarDecl *getNextIvar() { return NextIvar; }
1978 const ObjCIvarDecl *getNextIvar() const { return NextIvar; }
1979 void setNextIvar(ObjCIvarDecl *ivar) { NextIvar = ivar; }
1980
1981 void setAccessControl(AccessControl ac) { DeclAccess = ac; }
1982
1983 AccessControl getAccessControl() const { return AccessControl(DeclAccess); }
1984
1985 AccessControl getCanonicalAccessControl() const {
1986 return DeclAccess == None ? Protected : AccessControl(DeclAccess);
1987 }
1988
1989 void setSynthesize(bool synth) { Synthesized = synth; }
1990 bool getSynthesize() const { return Synthesized; }
1991
1992 /// Retrieve the type of this instance variable when viewed as a member of a
1993 /// specific object type.
1994 QualType getUsageType(QualType objectType) const;
1995
1996 // Implement isa/cast/dyncast/etc.
1997 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
1998 static bool classofKind(Kind K) { return K == ObjCIvar; }
1999
2000private:
2001 /// NextIvar - Next Ivar in the list of ivars declared in class; class's
2002 /// extensions and class's implementation
2003 ObjCIvarDecl *NextIvar = nullptr;
2004
2005 // NOTE: VC++ treats enums as signed, avoid using the AccessControl enum
2006 unsigned DeclAccess : 3;
2007 unsigned Synthesized : 1;
2008};
2009
2010/// Represents a field declaration created by an \@defs(...).
2011class ObjCAtDefsFieldDecl : public FieldDecl {
2012 ObjCAtDefsFieldDecl(DeclContext *DC, SourceLocation StartLoc,
2013 SourceLocation IdLoc, IdentifierInfo *Id,
2014 QualType T, Expr *BW)
2015 : FieldDecl(ObjCAtDefsField, DC, StartLoc, IdLoc, Id, T,
2016 /*TInfo=*/nullptr, // FIXME: Do ObjCAtDefs have declarators ?
2017 BW, /*Mutable=*/false, /*HasInit=*/ICIS_NoInit) {}
2018
2019 void anchor() override;
2020
2021public:
2022 static ObjCAtDefsFieldDecl *Create(ASTContext &C, DeclContext *DC,
2023 SourceLocation StartLoc,
2024 SourceLocation IdLoc, IdentifierInfo *Id,
2025 QualType T, Expr *BW);
2026
2027 static ObjCAtDefsFieldDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2028
2029 // Implement isa/cast/dyncast/etc.
2030 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2031 static bool classofKind(Kind K) { return K == ObjCAtDefsField; }
2032};
2033
2034/// Represents an Objective-C protocol declaration.
2035///
2036/// Objective-C protocols declare a pure abstract type (i.e., no instance
2037/// variables are permitted). Protocols originally drew inspiration from
2038/// C++ pure virtual functions (a C++ feature with nice semantics and lousy
2039/// syntax:-). Here is an example:
2040///
2041/// \code
2042/// \@protocol NSDraggingInfo <refproto1, refproto2>
2043/// - (NSWindow *)draggingDestinationWindow;
2044/// - (NSImage *)draggedImage;
2045/// \@end
2046/// \endcode
2047///
2048/// This says that NSDraggingInfo requires two methods and requires everything
2049/// that the two "referenced protocols" 'refproto1' and 'refproto2' require as
2050/// well.
2051///
2052/// \code
2053/// \@interface ImplementsNSDraggingInfo : NSObject \<NSDraggingInfo>
2054/// \@end
2055/// \endcode
2056///
2057/// ObjC protocols inspired Java interfaces. Unlike Java, ObjC classes and
2058/// protocols are in distinct namespaces. For example, Cocoa defines both
2059/// an NSObject protocol and class (which isn't allowed in Java). As a result,
2060/// protocols are referenced using angle brackets as follows:
2061///
2062/// id \<NSDraggingInfo> anyObjectThatImplementsNSDraggingInfo;
2063class ObjCProtocolDecl : public ObjCContainerDecl,
2064 public Redeclarable<ObjCProtocolDecl> {
2065 struct DefinitionData {
2066 // The declaration that defines this protocol.
2067 ObjCProtocolDecl *Definition;
2068
2069 /// Referenced protocols
2070 ObjCProtocolList ReferencedProtocols;
2071 };
2072
2073 /// Contains a pointer to the data associated with this class,
2074 /// which will be NULL if this class has not yet been defined.
2075 ///
2076 /// The bit indicates when we don't need to check for out-of-date
2077 /// declarations. It will be set unless modules are enabled.
2078 llvm::PointerIntPair<DefinitionData *, 1, bool> Data;
2079
2080 ObjCProtocolDecl(ASTContext &C, DeclContext *DC, IdentifierInfo *Id,
2081 SourceLocation nameLoc, SourceLocation atStartLoc,
2082 ObjCProtocolDecl *PrevDecl);
2083
2084 void anchor() override;
2085
2086 DefinitionData &data() const {
2087 assert(Data.getPointer() && "Objective-C protocol has no definition!")((Data.getPointer() && "Objective-C protocol has no definition!"
) ? static_cast<void> (0) : __assert_fail ("Data.getPointer() && \"Objective-C protocol has no definition!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 2087, __PRETTY_FUNCTION__))
;
2088 return *Data.getPointer();
2089 }
2090
2091 void allocateDefinitionData();
2092
2093 using redeclarable_base = Redeclarable<ObjCProtocolDecl>;
2094
2095 ObjCProtocolDecl *getNextRedeclarationImpl() override {
2096 return getNextRedeclaration();
2097 }
2098
2099 ObjCProtocolDecl *getPreviousDeclImpl() override {
2100 return getPreviousDecl();
2101 }
2102
2103 ObjCProtocolDecl *getMostRecentDeclImpl() override {
2104 return getMostRecentDecl();
2105 }
2106
2107public:
2108 friend class ASTDeclReader;
2109 friend class ASTDeclWriter;
2110 friend class ASTReader;
2111
2112 static ObjCProtocolDecl *Create(ASTContext &C, DeclContext *DC,
2113 IdentifierInfo *Id,
2114 SourceLocation nameLoc,
2115 SourceLocation atStartLoc,
2116 ObjCProtocolDecl *PrevDecl);
2117
2118 static ObjCProtocolDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2119
2120 const ObjCProtocolList &getReferencedProtocols() const {
2121 assert(hasDefinition() && "No definition available!")((hasDefinition() && "No definition available!") ? static_cast
<void> (0) : __assert_fail ("hasDefinition() && \"No definition available!\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 2121, __PRETTY_FUNCTION__))
;
2122 return data().ReferencedProtocols;
2123 }
2124
2125 using protocol_iterator = ObjCProtocolList::iterator;
2126 using protocol_range = llvm::iterator_range<protocol_iterator>;
2127
2128 protocol_range protocols() const {
2129 return protocol_range(protocol_begin(), protocol_end());
2130 }
2131
2132 protocol_iterator protocol_begin() const {
2133 if (!hasDefinition())
2134 return protocol_iterator();
2135
2136 return data().ReferencedProtocols.begin();
2137 }
2138
2139 protocol_iterator protocol_end() const {
2140 if (!hasDefinition())
2141 return protocol_iterator();
2142
2143 return data().ReferencedProtocols.end();
2144 }
2145
2146 using protocol_loc_iterator = ObjCProtocolList::loc_iterator;
2147 using protocol_loc_range = llvm::iterator_range<protocol_loc_iterator>;
2148
2149 protocol_loc_range protocol_locs() const {
2150 return protocol_loc_range(protocol_loc_begin(), protocol_loc_end());
2151 }
2152
2153 protocol_loc_iterator protocol_loc_begin() const {
2154 if (!hasDefinition())
2155 return protocol_loc_iterator();
2156
2157 return data().ReferencedProtocols.loc_begin();
2158 }
2159
2160 protocol_loc_iterator protocol_loc_end() const {
2161 if (!hasDefinition())
2162 return protocol_loc_iterator();
2163
2164 return data().ReferencedProtocols.loc_end();
2165 }
2166
2167 unsigned protocol_size() const {
2168 if (!hasDefinition())
2169 return 0;
2170
2171 return data().ReferencedProtocols.size();
2172 }
2173
2174 /// setProtocolList - Set the list of protocols that this interface
2175 /// implements.
2176 void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num,
2177 const SourceLocation *Locs, ASTContext &C) {
2178 assert(hasDefinition() && "Protocol is not defined")((hasDefinition() && "Protocol is not defined") ? static_cast
<void> (0) : __assert_fail ("hasDefinition() && \"Protocol is not defined\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 2178, __PRETTY_FUNCTION__))
;
2179 data().ReferencedProtocols.set(List, Num, Locs, C);
2180 }
2181
2182 ObjCProtocolDecl *lookupProtocolNamed(IdentifierInfo *PName);
2183
2184 // Lookup a method. First, we search locally. If a method isn't
2185 // found, we search referenced protocols and class categories.
2186 ObjCMethodDecl *lookupMethod(Selector Sel, bool isInstance) const;
2187
2188 ObjCMethodDecl *lookupInstanceMethod(Selector Sel) const {
2189 return lookupMethod(Sel, true/*isInstance*/);
2190 }
2191
2192 ObjCMethodDecl *lookupClassMethod(Selector Sel) const {
2193 return lookupMethod(Sel, false/*isInstance*/);
2194 }
2195
2196 /// Determine whether this protocol has a definition.
2197 bool hasDefinition() const {
2198 // If the name of this protocol is out-of-date, bring it up-to-date, which
2199 // might bring in a definition.
2200 // Note: a null value indicates that we don't have a definition and that
2201 // modules are enabled.
2202 if (!Data.getOpaqueValue())
2203 getMostRecentDecl();
2204
2205 return Data.getPointer();
2206 }
2207
2208 /// Retrieve the definition of this protocol, if any.
2209 ObjCProtocolDecl *getDefinition() {
2210 return hasDefinition()? Data.getPointer()->Definition : nullptr;
2211 }
2212
2213 /// Retrieve the definition of this protocol, if any.
2214 const ObjCProtocolDecl *getDefinition() const {
2215 return hasDefinition()? Data.getPointer()->Definition : nullptr;
2216 }
2217
2218 /// Determine whether this particular declaration is also the
2219 /// definition.
2220 bool isThisDeclarationADefinition() const {
2221 return getDefinition() == this;
2222 }
2223
2224 /// Starts the definition of this Objective-C protocol.
2225 void startDefinition();
2226
2227 /// Produce a name to be used for protocol's metadata. It comes either via
2228 /// objc_runtime_name attribute or protocol name.
2229 StringRef getObjCRuntimeNameAsString() const;
2230
2231 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__)) {
2232 if (isThisDeclarationADefinition())
2233 return ObjCContainerDecl::getSourceRange();
2234
2235 return SourceRange(getAtStartLoc(), getLocation());
2236 }
2237
2238 using redecl_range = redeclarable_base::redecl_range;
2239 using redecl_iterator = redeclarable_base::redecl_iterator;
2240
2241 using redeclarable_base::redecls_begin;
2242 using redeclarable_base::redecls_end;
2243 using redeclarable_base::redecls;
2244 using redeclarable_base::getPreviousDecl;
2245 using redeclarable_base::getMostRecentDecl;
2246 using redeclarable_base::isFirstDecl;
2247
2248 /// Retrieves the canonical declaration of this Objective-C protocol.
2249 ObjCProtocolDecl *getCanonicalDecl() override { return getFirstDecl(); }
2250 const ObjCProtocolDecl *getCanonicalDecl() const { return getFirstDecl(); }
2251
2252 void collectPropertiesToImplement(PropertyMap &PM,
2253 PropertyDeclOrder &PO) const override;
2254
2255 void collectInheritedProtocolProperties(const ObjCPropertyDecl *Property,
2256 ProtocolPropertySet &PS,
2257 PropertyDeclOrder &PO) const;
2258
2259 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2260 static bool classofKind(Kind K) { return K == ObjCProtocol; }
2261};
2262
2263/// ObjCCategoryDecl - Represents a category declaration. A category allows
2264/// you to add methods to an existing class (without subclassing or modifying
2265/// the original class interface or implementation:-). Categories don't allow
2266/// you to add instance data. The following example adds "myMethod" to all
2267/// NSView's within a process:
2268///
2269/// \@interface NSView (MyViewMethods)
2270/// - myMethod;
2271/// \@end
2272///
2273/// Categories also allow you to split the implementation of a class across
2274/// several files (a feature more naturally supported in C++).
2275///
2276/// Categories were originally inspired by dynamic languages such as Common
2277/// Lisp and Smalltalk. More traditional class-based languages (C++, Java)
2278/// don't support this level of dynamism, which is both powerful and dangerous.
2279class ObjCCategoryDecl : public ObjCContainerDecl {
2280 /// Interface belonging to this category
2281 ObjCInterfaceDecl *ClassInterface;
2282
2283 /// The type parameters associated with this category, if any.
2284 ObjCTypeParamList *TypeParamList = nullptr;
2285
2286 /// referenced protocols in this category.
2287 ObjCProtocolList ReferencedProtocols;
2288
2289 /// Next category belonging to this class.
2290 /// FIXME: this should not be a singly-linked list. Move storage elsewhere.
2291 ObjCCategoryDecl *NextClassCategory = nullptr;
2292
2293 /// The location of the category name in this declaration.
2294 SourceLocation CategoryNameLoc;
2295
2296 /// class extension may have private ivars.
2297 SourceLocation IvarLBraceLoc;
2298 SourceLocation IvarRBraceLoc;
2299
2300 ObjCCategoryDecl(DeclContext *DC, SourceLocation AtLoc,
2301 SourceLocation ClassNameLoc, SourceLocation CategoryNameLoc,
2302 IdentifierInfo *Id, ObjCInterfaceDecl *IDecl,
2303 ObjCTypeParamList *typeParamList,
2304 SourceLocation IvarLBraceLoc = SourceLocation(),
2305 SourceLocation IvarRBraceLoc = SourceLocation());
2306
2307 void anchor() override;
2308
2309public:
2310 friend class ASTDeclReader;
2311 friend class ASTDeclWriter;
2312
2313 static ObjCCategoryDecl *Create(ASTContext &C, DeclContext *DC,
2314 SourceLocation AtLoc,
2315 SourceLocation ClassNameLoc,
2316 SourceLocation CategoryNameLoc,
2317 IdentifierInfo *Id,
2318 ObjCInterfaceDecl *IDecl,
2319 ObjCTypeParamList *typeParamList,
2320 SourceLocation IvarLBraceLoc=SourceLocation(),
2321 SourceLocation IvarRBraceLoc=SourceLocation());
2322 static ObjCCategoryDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2323
2324 ObjCInterfaceDecl *getClassInterface() { return ClassInterface; }
2325 const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; }
2326
2327 /// Retrieve the type parameter list associated with this category or
2328 /// extension.
2329 ObjCTypeParamList *getTypeParamList() const { return TypeParamList; }
2330
2331 /// Set the type parameters of this category.
2332 ///
2333 /// This function is used by the AST importer, which must import the type
2334 /// parameters after creating their DeclContext to avoid loops.
2335 void setTypeParamList(ObjCTypeParamList *TPL);
2336
2337
2338 ObjCCategoryImplDecl *getImplementation() const;
2339 void setImplementation(ObjCCategoryImplDecl *ImplD);
2340
2341 /// setProtocolList - Set the list of protocols that this interface
2342 /// implements.
2343 void setProtocolList(ObjCProtocolDecl *const*List, unsigned Num,
2344 const SourceLocation *Locs, ASTContext &C) {
2345 ReferencedProtocols.set(List, Num, Locs, C);
2346 }
2347
2348 const ObjCProtocolList &getReferencedProtocols() const {
2349 return ReferencedProtocols;
2350 }
2351
2352 using protocol_iterator = ObjCProtocolList::iterator;
2353 using protocol_range = llvm::iterator_range<protocol_iterator>;
2354
2355 protocol_range protocols() const {
2356 return protocol_range(protocol_begin(), protocol_end());
2357 }
2358
2359 protocol_iterator protocol_begin() const {
2360 return ReferencedProtocols.begin();
2361 }
2362
2363 protocol_iterator protocol_end() const { return ReferencedProtocols.end(); }
2364 unsigned protocol_size() const { return ReferencedProtocols.size(); }
2365
2366 using protocol_loc_iterator = ObjCProtocolList::loc_iterator;
2367 using protocol_loc_range = llvm::iterator_range<protocol_loc_iterator>;
2368
2369 protocol_loc_range protocol_locs() const {
2370 return protocol_loc_range(protocol_loc_begin(), protocol_loc_end());
2371 }
2372
2373 protocol_loc_iterator protocol_loc_begin() const {
2374 return ReferencedProtocols.loc_begin();
2375 }
2376
2377 protocol_loc_iterator protocol_loc_end() const {
2378 return ReferencedProtocols.loc_end();
2379 }
2380
2381 ObjCCategoryDecl *getNextClassCategory() const { return NextClassCategory; }
2382
2383 /// Retrieve the pointer to the next stored category (or extension),
2384 /// which may be hidden.
2385 ObjCCategoryDecl *getNextClassCategoryRaw() const {
2386 return NextClassCategory;
2387 }
2388
2389 bool IsClassExtension() const { return getIdentifier() == nullptr; }
2390
2391 using ivar_iterator = specific_decl_iterator<ObjCIvarDecl>;
2392 using ivar_range = llvm::iterator_range<specific_decl_iterator<ObjCIvarDecl>>;
2393
2394 ivar_range ivars() const { return ivar_range(ivar_begin(), ivar_end()); }
2395
2396 ivar_iterator ivar_begin() const {
2397 return ivar_iterator(decls_begin());
2398 }
2399
2400 ivar_iterator ivar_end() const {
2401 return ivar_iterator(decls_end());
2402 }
2403
2404 unsigned ivar_size() const {
2405 return std::distance(ivar_begin(), ivar_end());
2406 }
2407
2408 bool ivar_empty() const {
2409 return ivar_begin() == ivar_end();
2410 }
2411
2412 SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; }
2413 void setCategoryNameLoc(SourceLocation Loc) { CategoryNameLoc = Loc; }
2414
2415 void setIvarLBraceLoc(SourceLocation Loc) { IvarLBraceLoc = Loc; }
2416 SourceLocation getIvarLBraceLoc() const { return IvarLBraceLoc; }
2417 void setIvarRBraceLoc(SourceLocation Loc) { IvarRBraceLoc = Loc; }
2418 SourceLocation getIvarRBraceLoc() const { return IvarRBraceLoc; }
2419
2420 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2421 static bool classofKind(Kind K) { return K == ObjCCategory; }
2422};
2423
2424class ObjCImplDecl : public ObjCContainerDecl {
2425 /// Class interface for this class/category implementation
2426 ObjCInterfaceDecl *ClassInterface;
2427
2428 void anchor() override;
2429
2430protected:
2431 ObjCImplDecl(Kind DK, DeclContext *DC,
2432 ObjCInterfaceDecl *classInterface,
2433 IdentifierInfo *Id,
2434 SourceLocation nameLoc, SourceLocation atStartLoc)
2435 : ObjCContainerDecl(DK, DC, Id, nameLoc, atStartLoc),
2436 ClassInterface(classInterface) {}
2437
2438public:
2439 const ObjCInterfaceDecl *getClassInterface() const { return ClassInterface; }
2440 ObjCInterfaceDecl *getClassInterface() { return ClassInterface; }
2441 void setClassInterface(ObjCInterfaceDecl *IFace);
2442
2443 void addInstanceMethod(ObjCMethodDecl *method) {
2444 // FIXME: Context should be set correctly before we get here.
2445 method->setLexicalDeclContext(this);
2446 addDecl(method);
2447 }
2448
2449 void addClassMethod(ObjCMethodDecl *method) {
2450 // FIXME: Context should be set correctly before we get here.
2451 method->setLexicalDeclContext(this);
2452 addDecl(method);
2453 }
2454
2455 void addPropertyImplementation(ObjCPropertyImplDecl *property);
2456
2457 ObjCPropertyImplDecl *FindPropertyImplDecl(IdentifierInfo *propertyId,
2458 ObjCPropertyQueryKind queryKind) const;
2459 ObjCPropertyImplDecl *FindPropertyImplIvarDecl(IdentifierInfo *ivarId) const;
2460
2461 // Iterator access to properties.
2462 using propimpl_iterator = specific_decl_iterator<ObjCPropertyImplDecl>;
2463 using propimpl_range =
2464 llvm::iterator_range<specific_decl_iterator<ObjCPropertyImplDecl>>;
2465
2466 propimpl_range property_impls() const {
2467 return propimpl_range(propimpl_begin(), propimpl_end());
2468 }
2469
2470 propimpl_iterator propimpl_begin() const {
2471 return propimpl_iterator(decls_begin());
2472 }
2473
2474 propimpl_iterator propimpl_end() const {
2475 return propimpl_iterator(decls_end());
2476 }
2477
2478 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2479
2480 static bool classofKind(Kind K) {
2481 return K >= firstObjCImpl && K <= lastObjCImpl;
2482 }
2483};
2484
2485/// ObjCCategoryImplDecl - An object of this class encapsulates a category
2486/// \@implementation declaration. If a category class has declaration of a
2487/// property, its implementation must be specified in the category's
2488/// \@implementation declaration. Example:
2489/// \@interface I \@end
2490/// \@interface I(CATEGORY)
2491/// \@property int p1, d1;
2492/// \@end
2493/// \@implementation I(CATEGORY)
2494/// \@dynamic p1,d1;
2495/// \@end
2496///
2497/// ObjCCategoryImplDecl
2498class ObjCCategoryImplDecl : public ObjCImplDecl {
2499 // Category name location
2500 SourceLocation CategoryNameLoc;
2501
2502 ObjCCategoryImplDecl(DeclContext *DC, IdentifierInfo *Id,
2503 ObjCInterfaceDecl *classInterface,
2504 SourceLocation nameLoc, SourceLocation atStartLoc,
2505 SourceLocation CategoryNameLoc)
2506 : ObjCImplDecl(ObjCCategoryImpl, DC, classInterface, Id,
2507 nameLoc, atStartLoc),
2508 CategoryNameLoc(CategoryNameLoc) {}
2509
2510 void anchor() override;
2511
2512public:
2513 friend class ASTDeclReader;
2514 friend class ASTDeclWriter;
2515
2516 static ObjCCategoryImplDecl *Create(ASTContext &C, DeclContext *DC,
2517 IdentifierInfo *Id,
2518 ObjCInterfaceDecl *classInterface,
2519 SourceLocation nameLoc,
2520 SourceLocation atStartLoc,
2521 SourceLocation CategoryNameLoc);
2522 static ObjCCategoryImplDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2523
2524 ObjCCategoryDecl *getCategoryDecl() const;
2525
2526 SourceLocation getCategoryNameLoc() const { return CategoryNameLoc; }
2527
2528 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2529 static bool classofKind(Kind K) { return K == ObjCCategoryImpl;}
2530};
2531
2532raw_ostream &operator<<(raw_ostream &OS, const ObjCCategoryImplDecl &CID);
2533
2534/// ObjCImplementationDecl - Represents a class definition - this is where
2535/// method definitions are specified. For example:
2536///
2537/// @code
2538/// \@implementation MyClass
2539/// - (void)myMethod { /* do something */ }
2540/// \@end
2541/// @endcode
2542///
2543/// In a non-fragile runtime, instance variables can appear in the class
2544/// interface, class extensions (nameless categories), and in the implementation
2545/// itself, as well as being synthesized as backing storage for properties.
2546///
2547/// In a fragile runtime, instance variables are specified in the class
2548/// interface, \em not in the implementation. Nevertheless (for legacy reasons),
2549/// we allow instance variables to be specified in the implementation. When
2550/// specified, they need to be \em identical to the interface.
2551class ObjCImplementationDecl : public ObjCImplDecl {
2552 /// Implementation Class's super class.
2553 ObjCInterfaceDecl *SuperClass;
2554 SourceLocation SuperLoc;
2555
2556 /// \@implementation may have private ivars.
2557 SourceLocation IvarLBraceLoc;
2558 SourceLocation IvarRBraceLoc;
2559
2560 /// Support for ivar initialization.
2561 /// The arguments used to initialize the ivars
2562 LazyCXXCtorInitializersPtr IvarInitializers;
2563 unsigned NumIvarInitializers = 0;
2564
2565 /// Do the ivars of this class require initialization other than
2566 /// zero-initialization?
2567 bool HasNonZeroConstructors : 1;
2568
2569 /// Do the ivars of this class require non-trivial destruction?
2570 bool HasDestructors : 1;
2571
2572 ObjCImplementationDecl(DeclContext *DC,
2573 ObjCInterfaceDecl *classInterface,
2574 ObjCInterfaceDecl *superDecl,
2575 SourceLocation nameLoc, SourceLocation atStartLoc,
2576 SourceLocation superLoc = SourceLocation(),
2577 SourceLocation IvarLBraceLoc=SourceLocation(),
2578 SourceLocation IvarRBraceLoc=SourceLocation())
2579 : ObjCImplDecl(ObjCImplementation, DC, classInterface,
2580 classInterface ? classInterface->getIdentifier()
2581 : nullptr,
2582 nameLoc, atStartLoc),
2583 SuperClass(superDecl), SuperLoc(superLoc),
2584 IvarLBraceLoc(IvarLBraceLoc), IvarRBraceLoc(IvarRBraceLoc),
2585 HasNonZeroConstructors(false), HasDestructors(false) {}
2586
2587 void anchor() override;
2588
2589public:
2590 friend class ASTDeclReader;
2591 friend class ASTDeclWriter;
2592
2593 static ObjCImplementationDecl *Create(ASTContext &C, DeclContext *DC,
2594 ObjCInterfaceDecl *classInterface,
2595 ObjCInterfaceDecl *superDecl,
2596 SourceLocation nameLoc,
2597 SourceLocation atStartLoc,
2598 SourceLocation superLoc = SourceLocation(),
2599 SourceLocation IvarLBraceLoc=SourceLocation(),
2600 SourceLocation IvarRBraceLoc=SourceLocation());
2601
2602 static ObjCImplementationDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2603
2604 /// init_iterator - Iterates through the ivar initializer list.
2605 using init_iterator = CXXCtorInitializer **;
2606
2607 /// init_const_iterator - Iterates through the ivar initializer list.
2608 using init_const_iterator = CXXCtorInitializer * const *;
2609
2610 using init_range = llvm::iterator_range<init_iterator>;
2611 using init_const_range = llvm::iterator_range<init_const_iterator>;
2612
2613 init_range inits() { return init_range(init_begin(), init_end()); }
2614
2615 init_const_range inits() const {
2616 return init_const_range(init_begin(), init_end());
2617 }
2618
2619 /// init_begin() - Retrieve an iterator to the first initializer.
2620 init_iterator init_begin() {
2621 const auto *ConstThis = this;
2622 return const_cast<init_iterator>(ConstThis->init_begin());
2623 }
2624
2625 /// begin() - Retrieve an iterator to the first initializer.
2626 init_const_iterator init_begin() const;
2627
2628 /// init_end() - Retrieve an iterator past the last initializer.
2629 init_iterator init_end() {
2630 return init_begin() + NumIvarInitializers;
2631 }
2632
2633 /// end() - Retrieve an iterator past the last initializer.
2634 init_const_iterator init_end() const {
2635 return init_begin() + NumIvarInitializers;
2636 }
2637
2638 /// getNumArgs - Number of ivars which must be initialized.
2639 unsigned getNumIvarInitializers() const {
2640 return NumIvarInitializers;
2641 }
2642
2643 void setNumIvarInitializers(unsigned numNumIvarInitializers) {
2644 NumIvarInitializers = numNumIvarInitializers;
2645 }
2646
2647 void setIvarInitializers(ASTContext &C,
2648 CXXCtorInitializer ** initializers,
2649 unsigned numInitializers);
2650
2651 /// Do any of the ivars of this class (not counting its base classes)
2652 /// require construction other than zero-initialization?
2653 bool hasNonZeroConstructors() const { return HasNonZeroConstructors; }
2654 void setHasNonZeroConstructors(bool val) { HasNonZeroConstructors = val; }
2655
2656 /// Do any of the ivars of this class (not counting its base classes)
2657 /// require non-trivial destruction?
2658 bool hasDestructors() const { return HasDestructors; }
2659 void setHasDestructors(bool val) { HasDestructors = val; }
2660
2661 /// getIdentifier - Get the identifier that names the class
2662 /// interface associated with this implementation.
2663 IdentifierInfo *getIdentifier() const {
2664 return getClassInterface()->getIdentifier();
2665 }
2666
2667 /// getName - Get the name of identifier for the class interface associated
2668 /// with this implementation as a StringRef.
2669 //
2670 // FIXME: This is a bad API, we are hiding NamedDecl::getName with a different
2671 // meaning.
2672 StringRef getName() const {
2673 assert(getIdentifier() && "Name is not a simple identifier")((getIdentifier() && "Name is not a simple identifier"
) ? static_cast<void> (0) : __assert_fail ("getIdentifier() && \"Name is not a simple identifier\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 2673, __PRETTY_FUNCTION__))
;
2674 return getIdentifier()->getName();
2675 }
2676
2677 /// Get the name of the class associated with this interface.
2678 //
2679 // FIXME: Move to StringRef API.
2680 std::string getNameAsString() const {
2681 return getName();
2682 }
2683
2684 /// Produce a name to be used for class's metadata. It comes either via
2685 /// class's objc_runtime_name attribute or class name.
2686 StringRef getObjCRuntimeNameAsString() const;
2687
2688 const ObjCInterfaceDecl *getSuperClass() const { return SuperClass; }
2689 ObjCInterfaceDecl *getSuperClass() { return SuperClass; }
2690 SourceLocation getSuperClassLoc() const { return SuperLoc; }
2691
2692 void setSuperClass(ObjCInterfaceDecl * superCls) { SuperClass = superCls; }
2693
2694 void setIvarLBraceLoc(SourceLocation Loc) { IvarLBraceLoc = Loc; }
2695 SourceLocation getIvarLBraceLoc() const { return IvarLBraceLoc; }
2696 void setIvarRBraceLoc(SourceLocation Loc) { IvarRBraceLoc = Loc; }
2697 SourceLocation getIvarRBraceLoc() const { return IvarRBraceLoc; }
2698
2699 using ivar_iterator = specific_decl_iterator<ObjCIvarDecl>;
2700 using ivar_range = llvm::iterator_range<specific_decl_iterator<ObjCIvarDecl>>;
2701
2702 ivar_range ivars() const { return ivar_range(ivar_begin(), ivar_end()); }
2703
2704 ivar_iterator ivar_begin() const {
2705 return ivar_iterator(decls_begin());
2706 }
2707
2708 ivar_iterator ivar_end() const {
2709 return ivar_iterator(decls_end());
2710 }
2711
2712 unsigned ivar_size() const {
2713 return std::distance(ivar_begin(), ivar_end());
2714 }
2715
2716 bool ivar_empty() const {
2717 return ivar_begin() == ivar_end();
28
Calling 'operator=='
34
Returning from 'operator=='
35
Returning zero, which participates in a condition later
2718 }
2719
2720 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2721 static bool classofKind(Kind K) { return K == ObjCImplementation; }
2722};
2723
2724raw_ostream &operator<<(raw_ostream &OS, const ObjCImplementationDecl &ID);
2725
2726/// ObjCCompatibleAliasDecl - Represents alias of a class. This alias is
2727/// declared as \@compatibility_alias alias class.
2728class ObjCCompatibleAliasDecl : public NamedDecl {
2729 /// Class that this is an alias of.
2730 ObjCInterfaceDecl *AliasedClass;
2731
2732 ObjCCompatibleAliasDecl(DeclContext *DC, SourceLocation L, IdentifierInfo *Id,
2733 ObjCInterfaceDecl* aliasedClass)
2734 : NamedDecl(ObjCCompatibleAlias, DC, L, Id), AliasedClass(aliasedClass) {}
2735
2736 void anchor() override;
2737
2738public:
2739 static ObjCCompatibleAliasDecl *Create(ASTContext &C, DeclContext *DC,
2740 SourceLocation L, IdentifierInfo *Id,
2741 ObjCInterfaceDecl* aliasedClass);
2742
2743 static ObjCCompatibleAliasDecl *CreateDeserialized(ASTContext &C,
2744 unsigned ID);
2745
2746 const ObjCInterfaceDecl *getClassInterface() const { return AliasedClass; }
2747 ObjCInterfaceDecl *getClassInterface() { return AliasedClass; }
2748 void setClassInterface(ObjCInterfaceDecl *D) { AliasedClass = D; }
2749
2750 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2751 static bool classofKind(Kind K) { return K == ObjCCompatibleAlias; }
2752};
2753
2754/// ObjCPropertyImplDecl - Represents implementation declaration of a property
2755/// in a class or category implementation block. For example:
2756/// \@synthesize prop1 = ivar1;
2757///
2758class ObjCPropertyImplDecl : public Decl {
2759public:
2760 enum Kind {
2761 Synthesize,
2762 Dynamic
2763 };
2764
2765private:
2766 SourceLocation AtLoc; // location of \@synthesize or \@dynamic
2767
2768 /// For \@synthesize, the location of the ivar, if it was written in
2769 /// the source code.
2770 ///
2771 /// \code
2772 /// \@synthesize int a = b
2773 /// \endcode
2774 SourceLocation IvarLoc;
2775
2776 /// Property declaration being implemented
2777 ObjCPropertyDecl *PropertyDecl;
2778
2779 /// Null for \@dynamic. Required for \@synthesize.
2780 ObjCIvarDecl *PropertyIvarDecl;
2781
2782 /// Null for \@dynamic. Non-null if property must be copy-constructed in
2783 /// getter.
2784 Expr *GetterCXXConstructor = nullptr;
2785
2786 /// Null for \@dynamic. Non-null if property has assignment operator to call
2787 /// in Setter synthesis.
2788 Expr *SetterCXXAssignment = nullptr;
2789
2790 ObjCPropertyImplDecl(DeclContext *DC, SourceLocation atLoc, SourceLocation L,
2791 ObjCPropertyDecl *property,
2792 Kind PK,
2793 ObjCIvarDecl *ivarDecl,
2794 SourceLocation ivarLoc)
2795 : Decl(ObjCPropertyImpl, DC, L), AtLoc(atLoc),
2796 IvarLoc(ivarLoc), PropertyDecl(property), PropertyIvarDecl(ivarDecl) {
2797 assert(PK == Dynamic || PropertyIvarDecl)((PK == Dynamic || PropertyIvarDecl) ? static_cast<void>
(0) : __assert_fail ("PK == Dynamic || PropertyIvarDecl", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclObjC.h"
, 2797, __PRETTY_FUNCTION__))
;
2798 }
2799
2800public:
2801 friend class ASTDeclReader;
2802
2803 static ObjCPropertyImplDecl *Create(ASTContext &C, DeclContext *DC,
2804 SourceLocation atLoc, SourceLocation L,
2805 ObjCPropertyDecl *property,
2806 Kind PK,
2807 ObjCIvarDecl *ivarDecl,
2808 SourceLocation ivarLoc);
2809
2810 static ObjCPropertyImplDecl *CreateDeserialized(ASTContext &C, unsigned ID);
2811
2812 SourceRange getSourceRange() const override LLVM_READONLY__attribute__((__pure__));
2813
2814 SourceLocation getBeginLoc() const LLVM_READONLY__attribute__((__pure__)) { return AtLoc; }
2815 void setAtLoc(SourceLocation Loc) { AtLoc = Loc; }
2816
2817 ObjCPropertyDecl *getPropertyDecl() const {
2818 return PropertyDecl;
2819 }
2820 void setPropertyDecl(ObjCPropertyDecl *Prop) { PropertyDecl = Prop; }
2821
2822 Kind getPropertyImplementation() const {
2823 return PropertyIvarDecl ? Synthesize : Dynamic;
2824 }
2825
2826 ObjCIvarDecl *getPropertyIvarDecl() const {
2827 return PropertyIvarDecl;
2828 }
2829 SourceLocation getPropertyIvarDeclLoc() const { return IvarLoc; }
2830
2831 void setPropertyIvarDecl(ObjCIvarDecl *Ivar,
2832 SourceLocation IvarLoc) {
2833 PropertyIvarDecl = Ivar;
2834 this->IvarLoc = IvarLoc;
2835 }
2836
2837 /// For \@synthesize, returns true if an ivar name was explicitly
2838 /// specified.
2839 ///
2840 /// \code
2841 /// \@synthesize int a = b; // true
2842 /// \@synthesize int a; // false
2843 /// \endcode
2844 bool isIvarNameSpecified() const {
2845 return IvarLoc.isValid() && IvarLoc != getLocation();
2846 }
2847
2848 Expr *getGetterCXXConstructor() const {
2849 return GetterCXXConstructor;
2850 }
2851
2852 void setGetterCXXConstructor(Expr *getterCXXConstructor) {
2853 GetterCXXConstructor = getterCXXConstructor;
2854 }
2855
2856 Expr *getSetterCXXAssignment() const {
2857 return SetterCXXAssignment;
2858 }
2859
2860 void setSetterCXXAssignment(Expr *setterCXXAssignment) {
2861 SetterCXXAssignment = setterCXXAssignment;
2862 }
2863
2864 static bool classof(const Decl *D) { return classofKind(D->getKind()); }
2865 static bool classofKind(Decl::Kind K) { return K == ObjCPropertyImpl; }
2866};
2867
2868template<bool (*Filter)(ObjCCategoryDecl *)>
2869void
2870ObjCInterfaceDecl::filtered_category_iterator<Filter>::
2871findAcceptableCategory() {
2872 while (Current && !Filter(Current))
2873 Current = Current->getNextClassCategoryRaw();
2874}
2875
2876template<bool (*Filter)(ObjCCategoryDecl *)>
2877inline ObjCInterfaceDecl::filtered_category_iterator<Filter> &
2878ObjCInterfaceDecl::filtered_category_iterator<Filter>::operator++() {
2879 Current = Current->getNextClassCategoryRaw();
2880 findAcceptableCategory();
2881 return *this;
2882}
2883
2884inline bool ObjCInterfaceDecl::isVisibleCategory(ObjCCategoryDecl *Cat) {
2885 return !Cat->isHidden();
2886}
2887
2888inline bool ObjCInterfaceDecl::isVisibleExtension(ObjCCategoryDecl *Cat) {
2889 return Cat->IsClassExtension() && !Cat->isHidden();
2890}
2891
2892inline bool ObjCInterfaceDecl::isKnownExtension(ObjCCategoryDecl *Cat) {
2893 return Cat->IsClassExtension();
2894}
2895
2896} // namespace clang
2897
2898#endif // LLVM_CLANG_AST_DECLOBJC_H

/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h

1//===- DeclBase.h - Base Classes for representing declarations --*- C++ -*-===//
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// This file defines the Decl and DeclContext interfaces.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_AST_DECLBASE_H
14#define LLVM_CLANG_AST_DECLBASE_H
15
16#include "clang/AST/ASTDumperUtils.h"
17#include "clang/AST/AttrIterator.h"
18#include "clang/AST/DeclarationName.h"
19#include "clang/Basic/IdentifierTable.h"
20#include "clang/Basic/LLVM.h"
21#include "clang/Basic/SourceLocation.h"
22#include "clang/Basic/Specifiers.h"
23#include "llvm/ADT/ArrayRef.h"
24#include "llvm/ADT/PointerIntPair.h"
25#include "llvm/ADT/PointerUnion.h"
26#include "llvm/ADT/iterator.h"
27#include "llvm/ADT/iterator_range.h"
28#include "llvm/Support/Casting.h"
29#include "llvm/Support/Compiler.h"
30#include "llvm/Support/PrettyStackTrace.h"
31#include "llvm/Support/VersionTuple.h"
32#include <algorithm>
33#include <cassert>
34#include <cstddef>
35#include <iterator>
36#include <string>
37#include <type_traits>
38#include <utility>
39
40namespace clang {
41
42class ASTContext;
43class ASTMutationListener;
44class Attr;
45class BlockDecl;
46class DeclContext;
47class ExternalSourceSymbolAttr;
48class FunctionDecl;
49class FunctionType;
50class IdentifierInfo;
51enum Linkage : unsigned char;
52class LinkageSpecDecl;
53class Module;
54class NamedDecl;
55class ObjCCategoryDecl;
56class ObjCCategoryImplDecl;
57class ObjCContainerDecl;
58class ObjCImplDecl;
59class ObjCImplementationDecl;
60class ObjCInterfaceDecl;
61class ObjCMethodDecl;
62class ObjCProtocolDecl;
63struct PrintingPolicy;
64class RecordDecl;
65class SourceManager;
66class Stmt;
67class StoredDeclsMap;
68class TemplateDecl;
69class TranslationUnitDecl;
70class UsingDirectiveDecl;
71
72/// Captures the result of checking the availability of a
73/// declaration.
74enum AvailabilityResult {
75 AR_Available = 0,
76 AR_NotYetIntroduced,
77 AR_Deprecated,
78 AR_Unavailable
79};
80
81/// Decl - This represents one declaration (or definition), e.g. a variable,
82/// typedef, function, struct, etc.
83///
84/// Note: There are objects tacked on before the *beginning* of Decl
85/// (and its subclasses) in its Decl::operator new(). Proper alignment
86/// of all subclasses (not requiring more than the alignment of Decl) is
87/// asserted in DeclBase.cpp.
88class alignas(8) Decl {
89public:
90 /// Lists the kind of concrete classes of Decl.
91 enum Kind {
92#define DECL(DERIVED, BASE) DERIVED,
93#define ABSTRACT_DECL(DECL)
94#define DECL_RANGE(BASE, START, END) \
95 first##BASE = START, last##BASE = END,
96#define LAST_DECL_RANGE(BASE, START, END) \
97 first##BASE = START, last##BASE = END
98#include "clang/AST/DeclNodes.inc"
99 };
100
101 /// A placeholder type used to construct an empty shell of a
102 /// decl-derived type that will be filled in later (e.g., by some
103 /// deserialization method).
104 struct EmptyShell {};
105
106 /// IdentifierNamespace - The different namespaces in which
107 /// declarations may appear. According to C99 6.2.3, there are
108 /// four namespaces, labels, tags, members and ordinary
109 /// identifiers. C++ describes lookup completely differently:
110 /// certain lookups merely "ignore" certain kinds of declarations,
111 /// usually based on whether the declaration is of a type, etc.
112 ///
113 /// These are meant as bitmasks, so that searches in
114 /// C++ can look into the "tag" namespace during ordinary lookup.
115 ///
116 /// Decl currently provides 15 bits of IDNS bits.
117 enum IdentifierNamespace {
118 /// Labels, declared with 'x:' and referenced with 'goto x'.
119 IDNS_Label = 0x0001,
120
121 /// Tags, declared with 'struct foo;' and referenced with
122 /// 'struct foo'. All tags are also types. This is what
123 /// elaborated-type-specifiers look for in C.
124 /// This also contains names that conflict with tags in the
125 /// same scope but that are otherwise ordinary names (non-type
126 /// template parameters and indirect field declarations).
127 IDNS_Tag = 0x0002,
128
129 /// Types, declared with 'struct foo', typedefs, etc.
130 /// This is what elaborated-type-specifiers look for in C++,
131 /// but note that it's ill-formed to find a non-tag.
132 IDNS_Type = 0x0004,
133
134 /// Members, declared with object declarations within tag
135 /// definitions. In C, these can only be found by "qualified"
136 /// lookup in member expressions. In C++, they're found by
137 /// normal lookup.
138 IDNS_Member = 0x0008,
139
140 /// Namespaces, declared with 'namespace foo {}'.
141 /// Lookup for nested-name-specifiers find these.
142 IDNS_Namespace = 0x0010,
143
144 /// Ordinary names. In C, everything that's not a label, tag,
145 /// member, or function-local extern ends up here.
146 IDNS_Ordinary = 0x0020,
147
148 /// Objective C \@protocol.
149 IDNS_ObjCProtocol = 0x0040,
150
151 /// This declaration is a friend function. A friend function
152 /// declaration is always in this namespace but may also be in
153 /// IDNS_Ordinary if it was previously declared.
154 IDNS_OrdinaryFriend = 0x0080,
155
156 /// This declaration is a friend class. A friend class
157 /// declaration is always in this namespace but may also be in
158 /// IDNS_Tag|IDNS_Type if it was previously declared.
159 IDNS_TagFriend = 0x0100,
160
161 /// This declaration is a using declaration. A using declaration
162 /// *introduces* a number of other declarations into the current
163 /// scope, and those declarations use the IDNS of their targets,
164 /// but the actual using declarations go in this namespace.
165 IDNS_Using = 0x0200,
166
167 /// This declaration is a C++ operator declared in a non-class
168 /// context. All such operators are also in IDNS_Ordinary.
169 /// C++ lexical operator lookup looks for these.
170 IDNS_NonMemberOperator = 0x0400,
171
172 /// This declaration is a function-local extern declaration of a
173 /// variable or function. This may also be IDNS_Ordinary if it
174 /// has been declared outside any function. These act mostly like
175 /// invisible friend declarations, but are also visible to unqualified
176 /// lookup within the scope of the declaring function.
177 IDNS_LocalExtern = 0x0800,
178
179 /// This declaration is an OpenMP user defined reduction construction.
180 IDNS_OMPReduction = 0x1000,
181
182 /// This declaration is an OpenMP user defined mapper.
183 IDNS_OMPMapper = 0x2000,
184 };
185
186 /// ObjCDeclQualifier - 'Qualifiers' written next to the return and
187 /// parameter types in method declarations. Other than remembering
188 /// them and mangling them into the method's signature string, these
189 /// are ignored by the compiler; they are consumed by certain
190 /// remote-messaging frameworks.
191 ///
192 /// in, inout, and out are mutually exclusive and apply only to
193 /// method parameters. bycopy and byref are mutually exclusive and
194 /// apply only to method parameters (?). oneway applies only to
195 /// results. All of these expect their corresponding parameter to
196 /// have a particular type. None of this is currently enforced by
197 /// clang.
198 ///
199 /// This should be kept in sync with ObjCDeclSpec::ObjCDeclQualifier.
200 enum ObjCDeclQualifier {
201 OBJC_TQ_None = 0x0,
202 OBJC_TQ_In = 0x1,
203 OBJC_TQ_Inout = 0x2,
204 OBJC_TQ_Out = 0x4,
205 OBJC_TQ_Bycopy = 0x8,
206 OBJC_TQ_Byref = 0x10,
207 OBJC_TQ_Oneway = 0x20,
208
209 /// The nullability qualifier is set when the nullability of the
210 /// result or parameter was expressed via a context-sensitive
211 /// keyword.
212 OBJC_TQ_CSNullability = 0x40
213 };
214
215 /// The kind of ownership a declaration has, for visibility purposes.
216 /// This enumeration is designed such that higher values represent higher
217 /// levels of name hiding.
218 enum class ModuleOwnershipKind : unsigned {
219 /// This declaration is not owned by a module.
220 Unowned,
221
222 /// This declaration has an owning module, but is globally visible
223 /// (typically because its owning module is visible and we know that
224 /// modules cannot later become hidden in this compilation).
225 /// After serialization and deserialization, this will be converted
226 /// to VisibleWhenImported.
227 Visible,
228
229 /// This declaration has an owning module, and is visible when that
230 /// module is imported.
231 VisibleWhenImported,
232
233 /// This declaration has an owning module, but is only visible to
234 /// lookups that occur within that module.
235 ModulePrivate
236 };
237
238protected:
239 /// The next declaration within the same lexical
240 /// DeclContext. These pointers form the linked list that is
241 /// traversed via DeclContext's decls_begin()/decls_end().
242 ///
243 /// The extra two bits are used for the ModuleOwnershipKind.
244 llvm::PointerIntPair<Decl *, 2, ModuleOwnershipKind> NextInContextAndBits;
245
246private:
247 friend class DeclContext;
248
249 struct MultipleDC {
250 DeclContext *SemanticDC;
251 DeclContext *LexicalDC;
252 };
253
254 /// DeclCtx - Holds either a DeclContext* or a MultipleDC*.
255 /// For declarations that don't contain C++ scope specifiers, it contains
256 /// the DeclContext where the Decl was declared.
257 /// For declarations with C++ scope specifiers, it contains a MultipleDC*
258 /// with the context where it semantically belongs (SemanticDC) and the
259 /// context where it was lexically declared (LexicalDC).
260 /// e.g.:
261 ///
262 /// namespace A {
263 /// void f(); // SemanticDC == LexicalDC == 'namespace A'
264 /// }
265 /// void A::f(); // SemanticDC == namespace 'A'
266 /// // LexicalDC == global namespace
267 llvm::PointerUnion<DeclContext*, MultipleDC*> DeclCtx;
268
269 bool isInSemaDC() const { return DeclCtx.is<DeclContext*>(); }
270 bool isOutOfSemaDC() const { return DeclCtx.is<MultipleDC*>(); }
271
272 MultipleDC *getMultipleDC() const {
273 return DeclCtx.get<MultipleDC*>();
274 }
275
276 DeclContext *getSemanticDC() const {
277 return DeclCtx.get<DeclContext*>();
278 }
279
280 /// Loc - The location of this decl.
281 SourceLocation Loc;
282
283 /// DeclKind - This indicates which class this is.
284 unsigned DeclKind : 7;
285
286 /// InvalidDecl - This indicates a semantic error occurred.
287 unsigned InvalidDecl : 1;
288
289 /// HasAttrs - This indicates whether the decl has attributes or not.
290 unsigned HasAttrs : 1;
291
292 /// Implicit - Whether this declaration was implicitly generated by
293 /// the implementation rather than explicitly written by the user.
294 unsigned Implicit : 1;
295
296 /// Whether this declaration was "used", meaning that a definition is
297 /// required.
298 unsigned Used : 1;
299
300 /// Whether this declaration was "referenced".
301 /// The difference with 'Used' is whether the reference appears in a
302 /// evaluated context or not, e.g. functions used in uninstantiated templates
303 /// are regarded as "referenced" but not "used".
304 unsigned Referenced : 1;
305
306 /// Whether this declaration is a top-level declaration (function,
307 /// global variable, etc.) that is lexically inside an objc container
308 /// definition.
309 unsigned TopLevelDeclInObjCContainer : 1;
310
311 /// Whether statistic collection is enabled.
312 static bool StatisticsEnabled;
313
314protected:
315 friend class ASTDeclReader;
316 friend class ASTDeclWriter;
317 friend class ASTNodeImporter;
318 friend class ASTReader;
319 friend class CXXClassMemberWrapper;
320 friend class LinkageComputer;
321 template<typename decl_type> friend class Redeclarable;
322
323 /// Access - Used by C++ decls for the access specifier.
324 // NOTE: VC++ treats enums as signed, avoid using the AccessSpecifier enum
325 unsigned Access : 2;
326
327 /// Whether this declaration was loaded from an AST file.
328 unsigned FromASTFile : 1;
329
330 /// IdentifierNamespace - This specifies what IDNS_* namespace this lives in.
331 unsigned IdentifierNamespace : 14;
332
333 /// If 0, we have not computed the linkage of this declaration.
334 /// Otherwise, it is the linkage + 1.
335 mutable unsigned CacheValidAndLinkage : 3;
336
337 /// Allocate memory for a deserialized declaration.
338 ///
339 /// This routine must be used to allocate memory for any declaration that is
340 /// deserialized from a module file.
341 ///
342 /// \param Size The size of the allocated object.
343 /// \param Ctx The context in which we will allocate memory.
344 /// \param ID The global ID of the deserialized declaration.
345 /// \param Extra The amount of extra space to allocate after the object.
346 void *operator new(std::size_t Size, const ASTContext &Ctx, unsigned ID,
347 std::size_t Extra = 0);
348
349 /// Allocate memory for a non-deserialized declaration.
350 void *operator new(std::size_t Size, const ASTContext &Ctx,
351 DeclContext *Parent, std::size_t Extra = 0);
352
353private:
354 bool AccessDeclContextSanity() const;
355
356 /// Get the module ownership kind to use for a local lexical child of \p DC,
357 /// which may be either a local or (rarely) an imported declaration.
358 static ModuleOwnershipKind getModuleOwnershipKindForChildOf(DeclContext *DC) {
359 if (DC) {
360 auto *D = cast<Decl>(DC);
361 auto MOK = D->getModuleOwnershipKind();
362 if (MOK != ModuleOwnershipKind::Unowned &&
363 (!D->isFromASTFile() || D->hasLocalOwningModuleStorage()))
364 return MOK;
365 // If D is not local and we have no local module storage, then we don't
366 // need to track module ownership at all.
367 }
368 return ModuleOwnershipKind::Unowned;
369 }
370
371public:
372 Decl() = delete;
373 Decl(const Decl&) = delete;
374 Decl(Decl &&) = delete;
375 Decl &operator=(const Decl&) = delete;
376 Decl &operator=(Decl&&) = delete;
377
378protected:
379 Decl(Kind DK, DeclContext *DC, SourceLocation L)
380 : NextInContextAndBits(nullptr, getModuleOwnershipKindForChildOf(DC)),
381 DeclCtx(DC), Loc(L), DeclKind(DK), InvalidDecl(false), HasAttrs(false),
382 Implicit(false), Used(false), Referenced(false),
383 TopLevelDeclInObjCContainer(false), Access(AS_none), FromASTFile(0),
384 IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
385 CacheValidAndLinkage(0) {
386 if (StatisticsEnabled) add(DK);
387 }
388
389 Decl(Kind DK, EmptyShell Empty)
390 : DeclKind(DK), InvalidDecl(false), HasAttrs(false), Implicit(false),
391 Used(false), Referenced(false), TopLevelDeclInObjCContainer(false),
392 Access(AS_none), FromASTFile(0),
393 IdentifierNamespace(getIdentifierNamespaceForKind(DK)),
394 CacheValidAndLinkage(0) {
395 if (StatisticsEnabled) add(DK);
396 }
397
398 virtual ~Decl();
399
400 /// Update a potentially out-of-date declaration.
401 void updateOutOfDate(IdentifierInfo &II) const;
402
403 Linkage getCachedLinkage() const {
404 return Linkage(CacheValidAndLinkage - 1);
405 }
406
407 void setCachedLinkage(Linkage L) const {
408 CacheValidAndLinkage = L + 1;
409 }
410
411 bool hasCachedLinkage() const {
412 return CacheValidAndLinkage;
413 }
414
415public:
416 /// Source range that this declaration covers.
417 virtual SourceRange getSourceRange() const LLVM_READONLY__attribute__((__pure__)) {
418 return SourceRange(getLocation(), getLocation());
419 }
420
421 SourceLocation getBeginLoc() const LLVM_READONLY__attribute__((__pure__)) {
422 return getSourceRange().getBegin();
423 }
424
425 SourceLocation getEndLoc() const LLVM_READONLY__attribute__((__pure__)) {
426 return getSourceRange().getEnd();
427 }
428
429 SourceLocation getLocation() const { return Loc; }
430 void setLocation(SourceLocation L) { Loc = L; }
431
432 Kind getKind() const { return static_cast<Kind>(DeclKind); }
433 const char *getDeclKindName() const;
434
435 Decl *getNextDeclInContext() { return NextInContextAndBits.getPointer(); }
436 const Decl *getNextDeclInContext() const {return NextInContextAndBits.getPointer();}
437
438 DeclContext *getDeclContext() {
439 if (isInSemaDC())
440 return getSemanticDC();
441 return getMultipleDC()->SemanticDC;
442 }
443 const DeclContext *getDeclContext() const {
444 return const_cast<Decl*>(this)->getDeclContext();
445 }
446
447 /// Find the innermost non-closure ancestor of this declaration,
448 /// walking up through blocks, lambdas, etc. If that ancestor is
449 /// not a code context (!isFunctionOrMethod()), returns null.
450 ///
451 /// A declaration may be its own non-closure context.
452 Decl *getNonClosureContext();
453 const Decl *getNonClosureContext() const {
454 return const_cast<Decl*>(this)->getNonClosureContext();
455 }
456
457 TranslationUnitDecl *getTranslationUnitDecl();
458 const TranslationUnitDecl *getTranslationUnitDecl() const {
459 return const_cast<Decl*>(this)->getTranslationUnitDecl();
460 }
461
462 bool isInAnonymousNamespace() const;
463
464 bool isInStdNamespace() const;
465
466 ASTContext &getASTContext() const LLVM_READONLY__attribute__((__pure__));
467
468 void setAccess(AccessSpecifier AS) {
469 Access = AS;
470 assert(AccessDeclContextSanity())((AccessDeclContextSanity()) ? static_cast<void> (0) : __assert_fail
("AccessDeclContextSanity()", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 470, __PRETTY_FUNCTION__))
;
471 }
472
473 AccessSpecifier getAccess() const {
474 assert(AccessDeclContextSanity())((AccessDeclContextSanity()) ? static_cast<void> (0) : __assert_fail
("AccessDeclContextSanity()", "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 474, __PRETTY_FUNCTION__))
;
475 return AccessSpecifier(Access);
476 }
477
478 /// Retrieve the access specifier for this declaration, even though
479 /// it may not yet have been properly set.
480 AccessSpecifier getAccessUnsafe() const {
481 return AccessSpecifier(Access);
482 }
483
484 bool hasAttrs() const { return HasAttrs; }
485
486 void setAttrs(const AttrVec& Attrs) {
487 return setAttrsImpl(Attrs, getASTContext());
488 }
489
490 AttrVec &getAttrs() {
491 return const_cast<AttrVec&>(const_cast<const Decl*>(this)->getAttrs());
492 }
493
494 const AttrVec &getAttrs() const;
495 void dropAttrs();
496 void addAttr(Attr *A);
497
498 using attr_iterator = AttrVec::const_iterator;
499 using attr_range = llvm::iterator_range<attr_iterator>;
500
501 attr_range attrs() const {
502 return attr_range(attr_begin(), attr_end());
503 }
504
505 attr_iterator attr_begin() const {
506 return hasAttrs() ? getAttrs().begin() : nullptr;
507 }
508 attr_iterator attr_end() const {
509 return hasAttrs() ? getAttrs().end() : nullptr;
510 }
511
512 template <typename T>
513 void dropAttr() {
514 if (!HasAttrs) return;
515
516 AttrVec &Vec = getAttrs();
517 Vec.erase(std::remove_if(Vec.begin(), Vec.end(), isa<T, Attr*>), Vec.end());
518
519 if (Vec.empty())
520 HasAttrs = false;
521 }
522
523 template <typename T>
524 llvm::iterator_range<specific_attr_iterator<T>> specific_attrs() const {
525 return llvm::make_range(specific_attr_begin<T>(), specific_attr_end<T>());
526 }
527
528 template <typename T>
529 specific_attr_iterator<T> specific_attr_begin() const {
530 return specific_attr_iterator<T>(attr_begin());
531 }
532
533 template <typename T>
534 specific_attr_iterator<T> specific_attr_end() const {
535 return specific_attr_iterator<T>(attr_end());
536 }
537
538 template<typename T> T *getAttr() const {
539 return hasAttrs() ? getSpecificAttr<T>(getAttrs()) : nullptr;
540 }
541
542 template<typename T> bool hasAttr() const {
543 return hasAttrs() && hasSpecificAttr<T>(getAttrs());
544 }
545
546 /// getMaxAlignment - return the maximum alignment specified by attributes
547 /// on this decl, 0 if there are none.
548 unsigned getMaxAlignment() const;
549
550 /// setInvalidDecl - Indicates the Decl had a semantic error. This
551 /// allows for graceful error recovery.
552 void setInvalidDecl(bool Invalid = true);
553 bool isInvalidDecl() const { return (bool) InvalidDecl; }
554
555 /// isImplicit - Indicates whether the declaration was implicitly
556 /// generated by the implementation. If false, this declaration
557 /// was written explicitly in the source code.
558 bool isImplicit() const { return Implicit; }
559 void setImplicit(bool I = true) { Implicit = I; }
560
561 /// Whether *any* (re-)declaration of the entity was used, meaning that
562 /// a definition is required.
563 ///
564 /// \param CheckUsedAttr When true, also consider the "used" attribute
565 /// (in addition to the "used" bit set by \c setUsed()) when determining
566 /// whether the function is used.
567 bool isUsed(bool CheckUsedAttr = true) const;
568
569 /// Set whether the declaration is used, in the sense of odr-use.
570 ///
571 /// This should only be used immediately after creating a declaration.
572 /// It intentionally doesn't notify any listeners.
573 void setIsUsed() { getCanonicalDecl()->Used = true; }
574
575 /// Mark the declaration used, in the sense of odr-use.
576 ///
577 /// This notifies any mutation listeners in addition to setting a bit
578 /// indicating the declaration is used.
579 void markUsed(ASTContext &C);
580
581 /// Whether any declaration of this entity was referenced.
582 bool isReferenced() const;
583
584 /// Whether this declaration was referenced. This should not be relied
585 /// upon for anything other than debugging.
586 bool isThisDeclarationReferenced() const { return Referenced; }
587
588 void setReferenced(bool R = true) { Referenced = R; }
589
590 /// Whether this declaration is a top-level declaration (function,
591 /// global variable, etc.) that is lexically inside an objc container
592 /// definition.
593 bool isTopLevelDeclInObjCContainer() const {
594 return TopLevelDeclInObjCContainer;
595 }
596
597 void setTopLevelDeclInObjCContainer(bool V = true) {
598 TopLevelDeclInObjCContainer = V;
599 }
600
601 /// Looks on this and related declarations for an applicable
602 /// external source symbol attribute.
603 ExternalSourceSymbolAttr *getExternalSourceSymbolAttr() const;
604
605 /// Whether this declaration was marked as being private to the
606 /// module in which it was defined.
607 bool isModulePrivate() const {
608 return getModuleOwnershipKind() == ModuleOwnershipKind::ModulePrivate;
609 }
610
611 /// Return true if this declaration has an attribute which acts as
612 /// definition of the entity, such as 'alias' or 'ifunc'.
613 bool hasDefiningAttr() const;
614
615 /// Return this declaration's defining attribute if it has one.
616 const Attr *getDefiningAttr() const;
617
618protected:
619 /// Specify that this declaration was marked as being private
620 /// to the module in which it was defined.
621 void setModulePrivate() {
622 // The module-private specifier has no effect on unowned declarations.
623 // FIXME: We should track this in some way for source fidelity.
624 if (getModuleOwnershipKind() == ModuleOwnershipKind::Unowned)
625 return;
626 setModuleOwnershipKind(ModuleOwnershipKind::ModulePrivate);
627 }
628
629 /// Set the owning module ID.
630 void setOwningModuleID(unsigned ID) {
631 assert(isFromASTFile() && "Only works on a deserialized declaration")((isFromASTFile() && "Only works on a deserialized declaration"
) ? static_cast<void> (0) : __assert_fail ("isFromASTFile() && \"Only works on a deserialized declaration\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 631, __PRETTY_FUNCTION__))
;
632 *((unsigned*)this - 2) = ID;
633 }
634
635public:
636 /// Determine the availability of the given declaration.
637 ///
638 /// This routine will determine the most restrictive availability of
639 /// the given declaration (e.g., preferring 'unavailable' to
640 /// 'deprecated').
641 ///
642 /// \param Message If non-NULL and the result is not \c
643 /// AR_Available, will be set to a (possibly empty) message
644 /// describing why the declaration has not been introduced, is
645 /// deprecated, or is unavailable.
646 ///
647 /// \param EnclosingVersion The version to compare with. If empty, assume the
648 /// deployment target version.
649 ///
650 /// \param RealizedPlatform If non-NULL and the availability result is found
651 /// in an available attribute it will set to the platform which is written in
652 /// the available attribute.
653 AvailabilityResult
654 getAvailability(std::string *Message = nullptr,
655 VersionTuple EnclosingVersion = VersionTuple(),
656 StringRef *RealizedPlatform = nullptr) const;
657
658 /// Retrieve the version of the target platform in which this
659 /// declaration was introduced.
660 ///
661 /// \returns An empty version tuple if this declaration has no 'introduced'
662 /// availability attributes, or the version tuple that's specified in the
663 /// attribute otherwise.
664 VersionTuple getVersionIntroduced() const;
665
666 /// Determine whether this declaration is marked 'deprecated'.
667 ///
668 /// \param Message If non-NULL and the declaration is deprecated,
669 /// this will be set to the message describing why the declaration
670 /// was deprecated (which may be empty).
671 bool isDeprecated(std::string *Message = nullptr) const {
672 return getAvailability(Message) == AR_Deprecated;
673 }
674
675 /// Determine whether this declaration is marked 'unavailable'.
676 ///
677 /// \param Message If non-NULL and the declaration is unavailable,
678 /// this will be set to the message describing why the declaration
679 /// was made unavailable (which may be empty).
680 bool isUnavailable(std::string *Message = nullptr) const {
681 return getAvailability(Message) == AR_Unavailable;
682 }
683
684 /// Determine whether this is a weak-imported symbol.
685 ///
686 /// Weak-imported symbols are typically marked with the
687 /// 'weak_import' attribute, but may also be marked with an
688 /// 'availability' attribute where we're targing a platform prior to
689 /// the introduction of this feature.
690 bool isWeakImported() const;
691
692 /// Determines whether this symbol can be weak-imported,
693 /// e.g., whether it would be well-formed to add the weak_import
694 /// attribute.
695 ///
696 /// \param IsDefinition Set to \c true to indicate that this
697 /// declaration cannot be weak-imported because it has a definition.
698 bool canBeWeakImported(bool &IsDefinition) const;
699
700 /// Determine whether this declaration came from an AST file (such as
701 /// a precompiled header or module) rather than having been parsed.
702 bool isFromASTFile() const { return FromASTFile; }
703
704 /// Retrieve the global declaration ID associated with this
705 /// declaration, which specifies where this Decl was loaded from.
706 unsigned getGlobalID() const {
707 if (isFromASTFile())
708 return *((const unsigned*)this - 1);
709 return 0;
710 }
711
712 /// Retrieve the global ID of the module that owns this particular
713 /// declaration.
714 unsigned getOwningModuleID() const {
715 if (isFromASTFile())
716 return *((const unsigned*)this - 2);
717 return 0;
718 }
719
720private:
721 Module *getOwningModuleSlow() const;
722
723protected:
724 bool hasLocalOwningModuleStorage() const;
725
726public:
727 /// Get the imported owning module, if this decl is from an imported
728 /// (non-local) module.
729 Module *getImportedOwningModule() const {
730 if (!isFromASTFile() || !hasOwningModule())
731 return nullptr;
732
733 return getOwningModuleSlow();
734 }
735
736 /// Get the local owning module, if known. Returns nullptr if owner is
737 /// not yet known or declaration is not from a module.
738 Module *getLocalOwningModule() const {
739 if (isFromASTFile() || !hasOwningModule())
740 return nullptr;
741
742 assert(hasLocalOwningModuleStorage() &&((hasLocalOwningModuleStorage() && "owned local decl but no local module storage"
) ? static_cast<void> (0) : __assert_fail ("hasLocalOwningModuleStorage() && \"owned local decl but no local module storage\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 743, __PRETTY_FUNCTION__))
743 "owned local decl but no local module storage")((hasLocalOwningModuleStorage() && "owned local decl but no local module storage"
) ? static_cast<void> (0) : __assert_fail ("hasLocalOwningModuleStorage() && \"owned local decl but no local module storage\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 743, __PRETTY_FUNCTION__))
;
744 return reinterpret_cast<Module *const *>(this)[-1];
745 }
746 void setLocalOwningModule(Module *M) {
747 assert(!isFromASTFile() && hasOwningModule() &&((!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage
() && "should not have a cached owning module") ? static_cast
<void> (0) : __assert_fail ("!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage() && \"should not have a cached owning module\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 749, __PRETTY_FUNCTION__))
748 hasLocalOwningModuleStorage() &&((!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage
() && "should not have a cached owning module") ? static_cast
<void> (0) : __assert_fail ("!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage() && \"should not have a cached owning module\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 749, __PRETTY_FUNCTION__))
749 "should not have a cached owning module")((!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage
() && "should not have a cached owning module") ? static_cast
<void> (0) : __assert_fail ("!isFromASTFile() && hasOwningModule() && hasLocalOwningModuleStorage() && \"should not have a cached owning module\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 749, __PRETTY_FUNCTION__))
;
750 reinterpret_cast<Module **>(this)[-1] = M;
751 }
752
753 /// Is this declaration owned by some module?
754 bool hasOwningModule() const {
755 return getModuleOwnershipKind() != ModuleOwnershipKind::Unowned;
756 }
757
758 /// Get the module that owns this declaration (for visibility purposes).
759 Module *getOwningModule() const {
760 return isFromASTFile() ? getImportedOwningModule() : getLocalOwningModule();
761 }
762
763 /// Get the module that owns this declaration for linkage purposes.
764 /// There only ever is such a module under the C++ Modules TS.
765 ///
766 /// \param IgnoreLinkage Ignore the linkage of the entity; assume that
767 /// all declarations in a global module fragment are unowned.
768 Module *getOwningModuleForLinkage(bool IgnoreLinkage = false) const;
769
770 /// Determine whether this declaration might be hidden from name
771 /// lookup. Note that the declaration might be visible even if this returns
772 /// \c false, if the owning module is visible within the query context.
773 // FIXME: Rename this to make it clearer what it does.
774 bool isHidden() const {
775 return (int)getModuleOwnershipKind() > (int)ModuleOwnershipKind::Visible;
776 }
777
778 /// Set that this declaration is globally visible, even if it came from a
779 /// module that is not visible.
780 void setVisibleDespiteOwningModule() {
781 if (isHidden())
782 setModuleOwnershipKind(ModuleOwnershipKind::Visible);
783 }
784
785 /// Get the kind of module ownership for this declaration.
786 ModuleOwnershipKind getModuleOwnershipKind() const {
787 return NextInContextAndBits.getInt();
788 }
789
790 /// Set whether this declaration is hidden from name lookup.
791 void setModuleOwnershipKind(ModuleOwnershipKind MOK) {
792 assert(!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&((!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&
MOK != ModuleOwnershipKind::Unowned && !isFromASTFile
() && !hasLocalOwningModuleStorage()) && "no storage available for owning module for this declaration"
) ? static_cast<void> (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 795, __PRETTY_FUNCTION__))
793 MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() &&((!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&
MOK != ModuleOwnershipKind::Unowned && !isFromASTFile
() && !hasLocalOwningModuleStorage()) && "no storage available for owning module for this declaration"
) ? static_cast<void> (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 795, __PRETTY_FUNCTION__))
794 !hasLocalOwningModuleStorage()) &&((!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&
MOK != ModuleOwnershipKind::Unowned && !isFromASTFile
() && !hasLocalOwningModuleStorage()) && "no storage available for owning module for this declaration"
) ? static_cast<void> (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 795, __PRETTY_FUNCTION__))
795 "no storage available for owning module for this declaration")((!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned &&
MOK != ModuleOwnershipKind::Unowned && !isFromASTFile
() && !hasLocalOwningModuleStorage()) && "no storage available for owning module for this declaration"
) ? static_cast<void> (0) : __assert_fail ("!(getModuleOwnershipKind() == ModuleOwnershipKind::Unowned && MOK != ModuleOwnershipKind::Unowned && !isFromASTFile() && !hasLocalOwningModuleStorage()) && \"no storage available for owning module for this declaration\""
, "/build/llvm-toolchain-snapshot-10~svn374877/tools/clang/include/clang/AST/DeclBase.h"
, 795, __PRETTY_FUNCTION__))
;
796 NextInContextAndBits.setInt(MOK);
797 }
798
799 unsigned getIdentifierNamespace() const {
800 return IdentifierNamespace;
801 }
802
803 bool isInIdentifierNamespace(unsigned NS) const {
804 return getIdentifierNamespace() & NS;
805 }
806
807 static unsigned getIdentifierNamespaceForKind(Kind DK);
808
809 bool hasTagIdentifierNamespace() const {
810 return isTagIdentifierNamespace(getIdentifierNamespace());
811 }
812
813 static bool isTagIdentifierNamespace(unsigned NS) {
814 // TagDecls have Tag and Type set and may also have TagFriend.
815 return (NS & ~IDNS_TagFriend) == (IDNS_Tag | IDNS_Type);
816 }
817
818 /// getLexicalDeclContext - The declaration context where this Decl was
819 /// lexically declared (LexicalDC). May be different from
820 /// getDeclContext() (SemanticDC).
821 /// e.g.:
822 ///
823 /// namespace A {
824 /// void f(); // SemanticDC == LexicalDC == 'namespace A'
825 /// }
826 /// void A::f(); // SemanticDC == namespace 'A'
827 /// // LexicalDC == global namespace
828 DeclContext *getLexicalDeclContext() {
829 if (isInSemaDC())
830 return getSemanticDC();
831 return getMultipleDC()->LexicalDC;
832 }
833 const DeclContext *getLexicalDeclContext() const {
834 return const_cast<Decl*>(this)->getLexicalDeclContext();
835 }
836
837 /// Determine whether this declaration is declared out of line (outside its
838 /// semantic context).
839 virtual bool isOutOfLine() const;
840
841 /// setDeclContext - Set both the semantic and lexical DeclContext
842 /// to DC.
843 void setDeclContext(DeclContext *DC);
844
845 void setLexicalDeclContext(DeclContext *DC);
846
847 /// Determine whether this declaration is a templated entity (whether it is
848 // within the scope of a template parameter).
849 bool isTemplated() const;
850
851 /// isDefinedOutsideFunctionOrMethod - This predicate returns true if this
852 /// scoped decl is defined outside the current function or method. This is
853 /// roughly global variables and functions, but also handles enums (which
854 /// could be defined inside or outside a function etc).
855 bool isDefinedOutsideFunctionOrMethod() const {
856 return getParentFunctionOrMethod() == nullptr;
857 }
858
859 /// Returns true if this declaration lexically is inside a function.
860 /// It recognizes non-defining declarations as well as members of local
861 /// classes: