1 //===--- ASTWriterDecl.cpp - Declaration Serialization --------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 //  This file implements serialization for Declarations.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/Serialization/ASTWriter.h"
15 #include "ASTCommon.h"
16 #include "clang/AST/DeclVisitor.h"
17 #include "clang/AST/DeclCXX.h"
18 #include "clang/AST/DeclTemplate.h"
19 #include "clang/AST/Expr.h"
20 #include "clang/AST/DeclContextInternals.h"
21 #include "clang/Basic/SourceManager.h"
22 #include "llvm/ADT/Twine.h"
23 #include "llvm/Bitcode/BitstreamWriter.h"
24 #include "llvm/Support/ErrorHandling.h"
25 using namespace clang;
26 using namespace serialization;
27 
28 //===----------------------------------------------------------------------===//
29 // Declaration serialization
30 //===----------------------------------------------------------------------===//
31 
32 namespace clang {
33   class ASTDeclWriter : public DeclVisitor<ASTDeclWriter, void> {
34 
35     ASTWriter &Writer;
36     ASTContext &Context;
37     typedef ASTWriter::RecordData RecordData;
38     RecordData &Record;
39 
40   public:
41     serialization::DeclCode Code;
42     unsigned AbbrevToUse;
43 
44     ASTDeclWriter(ASTWriter &Writer, ASTContext &Context, RecordData &Record)
45       : Writer(Writer), Context(Context), Record(Record) {
46     }
47 
48     void Visit(Decl *D);
49 
50     void VisitDecl(Decl *D);
51     void VisitTranslationUnitDecl(TranslationUnitDecl *D);
52     void VisitNamedDecl(NamedDecl *D);
53     void VisitLabelDecl(LabelDecl *LD);
54     void VisitNamespaceDecl(NamespaceDecl *D);
55     void VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
56     void VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
57     void VisitTypeDecl(TypeDecl *D);
58     void VisitTypedefNameDecl(TypedefNameDecl *D);
59     void VisitTypedefDecl(TypedefDecl *D);
60     void VisitTypeAliasDecl(TypeAliasDecl *D);
61     void VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
62     void VisitTagDecl(TagDecl *D);
63     void VisitEnumDecl(EnumDecl *D);
64     void VisitRecordDecl(RecordDecl *D);
65     void VisitCXXRecordDecl(CXXRecordDecl *D);
66     void VisitClassTemplateSpecializationDecl(
67                                             ClassTemplateSpecializationDecl *D);
68     void VisitClassTemplatePartialSpecializationDecl(
69                                      ClassTemplatePartialSpecializationDecl *D);
70     void VisitClassScopeFunctionSpecializationDecl(
71                                        ClassScopeFunctionSpecializationDecl *D);
72     void VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D);
73     void VisitValueDecl(ValueDecl *D);
74     void VisitEnumConstantDecl(EnumConstantDecl *D);
75     void VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
76     void VisitDeclaratorDecl(DeclaratorDecl *D);
77     void VisitFunctionDecl(FunctionDecl *D);
78     void VisitCXXMethodDecl(CXXMethodDecl *D);
79     void VisitCXXConstructorDecl(CXXConstructorDecl *D);
80     void VisitCXXDestructorDecl(CXXDestructorDecl *D);
81     void VisitCXXConversionDecl(CXXConversionDecl *D);
82     void VisitFieldDecl(FieldDecl *D);
83     void VisitIndirectFieldDecl(IndirectFieldDecl *D);
84     void VisitVarDecl(VarDecl *D);
85     void VisitImplicitParamDecl(ImplicitParamDecl *D);
86     void VisitParmVarDecl(ParmVarDecl *D);
87     void VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D);
88     void VisitTemplateDecl(TemplateDecl *D);
89     void VisitRedeclarableTemplateDecl(RedeclarableTemplateDecl *D);
90     void VisitClassTemplateDecl(ClassTemplateDecl *D);
91     void VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
92     void VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D);
93     void VisitTypeAliasTemplateDecl(TypeAliasTemplateDecl *D);
94     void VisitUsingDecl(UsingDecl *D);
95     void VisitUsingShadowDecl(UsingShadowDecl *D);
96     void VisitLinkageSpecDecl(LinkageSpecDecl *D);
97     void VisitFileScopeAsmDecl(FileScopeAsmDecl *D);
98     void VisitImportDecl(ImportDecl *D);
99     void VisitAccessSpecDecl(AccessSpecDecl *D);
100     void VisitFriendDecl(FriendDecl *D);
101     void VisitFriendTemplateDecl(FriendTemplateDecl *D);
102     void VisitStaticAssertDecl(StaticAssertDecl *D);
103     void VisitBlockDecl(BlockDecl *D);
104 
105     void VisitDeclContext(DeclContext *DC, uint64_t LexicalOffset,
106                           uint64_t VisibleOffset);
107     template <typename T> void VisitRedeclarable(Redeclarable<T> *D);
108 
109 
110     // FIXME: Put in the same order is DeclNodes.td?
111     void VisitObjCMethodDecl(ObjCMethodDecl *D);
112     void VisitObjCContainerDecl(ObjCContainerDecl *D);
113     void VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
114     void VisitObjCIvarDecl(ObjCIvarDecl *D);
115     void VisitObjCProtocolDecl(ObjCProtocolDecl *D);
116     void VisitObjCAtDefsFieldDecl(ObjCAtDefsFieldDecl *D);
117     void VisitObjCCategoryDecl(ObjCCategoryDecl *D);
118     void VisitObjCImplDecl(ObjCImplDecl *D);
119     void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
120     void VisitObjCImplementationDecl(ObjCImplementationDecl *D);
121     void VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D);
122     void VisitObjCPropertyDecl(ObjCPropertyDecl *D);
123     void VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D);
124   };
125 }
126 
127 void ASTDeclWriter::Visit(Decl *D) {
128   DeclVisitor<ASTDeclWriter>::Visit(D);
129 
130   // Source locations require array (variable-length) abbreviations.  The
131   // abbreviation infrastructure requires that arrays are encoded last, so
132   // we handle it here in the case of those classes derived from DeclaratorDecl
133   if (DeclaratorDecl *DD = dyn_cast<DeclaratorDecl>(D)){
134     Writer.AddTypeSourceInfo(DD->getTypeSourceInfo(), Record);
135   }
136 
137   // Handle FunctionDecl's body here and write it after all other Stmts/Exprs
138   // have been written. We want it last because we will not read it back when
139   // retrieving it from the AST, we'll just lazily set the offset.
140   if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
141     Record.push_back(FD->doesThisDeclarationHaveABody());
142     if (FD->doesThisDeclarationHaveABody())
143       Writer.AddStmt(FD->getBody());
144   }
145 }
146 
147 void ASTDeclWriter::VisitDecl(Decl *D) {
148   Writer.AddDeclRef(cast_or_null<Decl>(D->getDeclContext()), Record);
149   Writer.AddDeclRef(cast_or_null<Decl>(D->getLexicalDeclContext()), Record);
150   Record.push_back(D->isInvalidDecl());
151   Record.push_back(D->hasAttrs());
152   if (D->hasAttrs())
153     Writer.WriteAttributes(D->getAttrs(), Record);
154   Record.push_back(D->isImplicit());
155   Record.push_back(D->isUsed(false));
156   Record.push_back(D->isReferenced());
157   Record.push_back(D->isTopLevelDeclInObjCContainer());
158   Record.push_back(D->getAccess());
159   Record.push_back(D->isModulePrivate());
160   Record.push_back(Writer.inferSubmoduleIDFromLocation(D->getLocation()));
161 }
162 
163 void ASTDeclWriter::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
164   llvm_unreachable("Translation units aren't directly serialized");
165 }
166 
167 void ASTDeclWriter::VisitNamedDecl(NamedDecl *D) {
168   VisitDecl(D);
169   Writer.AddDeclarationName(D->getDeclName(), Record);
170 }
171 
172 void ASTDeclWriter::VisitTypeDecl(TypeDecl *D) {
173   VisitNamedDecl(D);
174   Writer.AddSourceLocation(D->getLocStart(), Record);
175   Writer.AddTypeRef(QualType(D->getTypeForDecl(), 0), Record);
176 }
177 
178 void ASTDeclWriter::VisitTypedefNameDecl(TypedefNameDecl *D) {
179   VisitRedeclarable(D);
180   VisitTypeDecl(D);
181   Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
182 }
183 
184 void ASTDeclWriter::VisitTypedefDecl(TypedefDecl *D) {
185   VisitTypedefNameDecl(D);
186   if (!D->hasAttrs() &&
187       !D->isImplicit() &&
188       !D->isUsed(false) &&
189       !D->getPreviousDecl() &&
190       !D->isInvalidDecl() &&
191       !D->isReferenced() &&
192       !D->isTopLevelDeclInObjCContainer() &&
193       D->getAccess() == AS_none &&
194       !D->isModulePrivate() &&
195       D->getDeclName().getNameKind() == DeclarationName::Identifier)
196     AbbrevToUse = Writer.getDeclTypedefAbbrev();
197 
198   Code = serialization::DECL_TYPEDEF;
199 }
200 
201 void ASTDeclWriter::VisitTypeAliasDecl(TypeAliasDecl *D) {
202   VisitTypedefNameDecl(D);
203   Code = serialization::DECL_TYPEALIAS;
204 }
205 
206 void ASTDeclWriter::VisitTagDecl(TagDecl *D) {
207   VisitRedeclarable(D);
208   VisitTypeDecl(D);
209   Record.push_back(D->getIdentifierNamespace());
210   Record.push_back((unsigned)D->getTagKind()); // FIXME: stable encoding
211   Record.push_back(D->isCompleteDefinition());
212   Record.push_back(D->isEmbeddedInDeclarator());
213   Record.push_back(D->isFreeStanding());
214   Writer.AddSourceLocation(D->getRBraceLoc(), Record);
215   Record.push_back(D->hasExtInfo());
216   if (D->hasExtInfo())
217     Writer.AddQualifierInfo(*D->getExtInfo(), Record);
218   else
219     Writer.AddDeclRef(D->getTypedefNameForAnonDecl(), Record);
220 }
221 
222 void ASTDeclWriter::VisitEnumDecl(EnumDecl *D) {
223   VisitTagDecl(D);
224   Writer.AddTypeSourceInfo(D->getIntegerTypeSourceInfo(), Record);
225   if (!D->getIntegerTypeSourceInfo())
226     Writer.AddTypeRef(D->getIntegerType(), Record);
227   Writer.AddTypeRef(D->getPromotionType(), Record);
228   Record.push_back(D->getNumPositiveBits());
229   Record.push_back(D->getNumNegativeBits());
230   Record.push_back(D->isScoped());
231   Record.push_back(D->isScopedUsingClassTag());
232   Record.push_back(D->isFixed());
233   Writer.AddDeclRef(D->getInstantiatedFromMemberEnum(), Record);
234 
235   if (!D->hasAttrs() &&
236       !D->isImplicit() &&
237       !D->isUsed(false) &&
238       !D->hasExtInfo() &&
239       !D->getPreviousDecl() &&
240       !D->isInvalidDecl() &&
241       !D->isReferenced() &&
242       !D->isTopLevelDeclInObjCContainer() &&
243       D->getAccess() == AS_none &&
244       !D->isModulePrivate() &&
245       !CXXRecordDecl::classofKind(D->getKind()) &&
246       !D->getIntegerTypeSourceInfo() &&
247       D->getDeclName().getNameKind() == DeclarationName::Identifier)
248     AbbrevToUse = Writer.getDeclEnumAbbrev();
249 
250   Code = serialization::DECL_ENUM;
251 }
252 
253 void ASTDeclWriter::VisitRecordDecl(RecordDecl *D) {
254   VisitTagDecl(D);
255   Record.push_back(D->hasFlexibleArrayMember());
256   Record.push_back(D->isAnonymousStructOrUnion());
257   Record.push_back(D->hasObjectMember());
258 
259   if (!D->hasAttrs() &&
260       !D->isImplicit() &&
261       !D->isUsed(false) &&
262       !D->hasExtInfo() &&
263       !D->getPreviousDecl() &&
264       !D->isInvalidDecl() &&
265       !D->isReferenced() &&
266       !D->isTopLevelDeclInObjCContainer() &&
267       D->getAccess() == AS_none &&
268       !D->isModulePrivate() &&
269       !CXXRecordDecl::classofKind(D->getKind()) &&
270       D->getDeclName().getNameKind() == DeclarationName::Identifier)
271     AbbrevToUse = Writer.getDeclRecordAbbrev();
272 
273   Code = serialization::DECL_RECORD;
274 }
275 
276 void ASTDeclWriter::VisitValueDecl(ValueDecl *D) {
277   VisitNamedDecl(D);
278   Writer.AddTypeRef(D->getType(), Record);
279 }
280 
281 void ASTDeclWriter::VisitEnumConstantDecl(EnumConstantDecl *D) {
282   VisitValueDecl(D);
283   Record.push_back(D->getInitExpr()? 1 : 0);
284   if (D->getInitExpr())
285     Writer.AddStmt(D->getInitExpr());
286   Writer.AddAPSInt(D->getInitVal(), Record);
287 
288   Code = serialization::DECL_ENUM_CONSTANT;
289 }
290 
291 void ASTDeclWriter::VisitDeclaratorDecl(DeclaratorDecl *D) {
292   VisitValueDecl(D);
293   Writer.AddSourceLocation(D->getInnerLocStart(), Record);
294   Record.push_back(D->hasExtInfo());
295   if (D->hasExtInfo())
296     Writer.AddQualifierInfo(*D->getExtInfo(), Record);
297 }
298 
299 void ASTDeclWriter::VisitFunctionDecl(FunctionDecl *D) {
300   VisitRedeclarable(D);
301   VisitDeclaratorDecl(D);
302 
303   Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
304   Record.push_back(D->getIdentifierNamespace());
305 
306   // FunctionDecl's body is handled last at ASTWriterDecl::Visit,
307   // after everything else is written.
308 
309   Record.push_back(D->getStorageClass()); // FIXME: stable encoding
310   Record.push_back(D->getStorageClassAsWritten());
311   Record.push_back(D->IsInline);
312   Record.push_back(D->isInlineSpecified());
313   Record.push_back(D->isVirtualAsWritten());
314   Record.push_back(D->isPure());
315   Record.push_back(D->hasInheritedPrototype());
316   Record.push_back(D->hasWrittenPrototype());
317   Record.push_back(D->isDeletedAsWritten());
318   Record.push_back(D->isTrivial());
319   Record.push_back(D->isDefaulted());
320   Record.push_back(D->isExplicitlyDefaulted());
321   Record.push_back(D->hasImplicitReturnZero());
322   Record.push_back(D->isConstexpr());
323   Writer.AddSourceLocation(D->getLocEnd(), Record);
324 
325   Record.push_back(D->getTemplatedKind());
326   switch (D->getTemplatedKind()) {
327   default: llvm_unreachable("Unhandled TemplatedKind!");
328   case FunctionDecl::TK_NonTemplate:
329     break;
330   case FunctionDecl::TK_FunctionTemplate:
331     Writer.AddDeclRef(D->getDescribedFunctionTemplate(), Record);
332     break;
333   case FunctionDecl::TK_MemberSpecialization: {
334     MemberSpecializationInfo *MemberInfo = D->getMemberSpecializationInfo();
335     Writer.AddDeclRef(MemberInfo->getInstantiatedFrom(), Record);
336     Record.push_back(MemberInfo->getTemplateSpecializationKind());
337     Writer.AddSourceLocation(MemberInfo->getPointOfInstantiation(), Record);
338     break;
339   }
340   case FunctionDecl::TK_FunctionTemplateSpecialization: {
341     FunctionTemplateSpecializationInfo *
342       FTSInfo = D->getTemplateSpecializationInfo();
343     Writer.AddDeclRef(FTSInfo->getTemplate(), Record);
344     Record.push_back(FTSInfo->getTemplateSpecializationKind());
345 
346     // Template arguments.
347     Writer.AddTemplateArgumentList(FTSInfo->TemplateArguments, Record);
348 
349     // Template args as written.
350     Record.push_back(FTSInfo->TemplateArgumentsAsWritten != 0);
351     if (FTSInfo->TemplateArgumentsAsWritten) {
352       Record.push_back(FTSInfo->TemplateArgumentsAsWritten->NumTemplateArgs);
353       for (int i=0, e = FTSInfo->TemplateArgumentsAsWritten->NumTemplateArgs;
354              i!=e; ++i)
355         Writer.AddTemplateArgumentLoc((*FTSInfo->TemplateArgumentsAsWritten)[i],
356                                       Record);
357       Writer.AddSourceLocation(FTSInfo->TemplateArgumentsAsWritten->LAngleLoc,
358                                Record);
359       Writer.AddSourceLocation(FTSInfo->TemplateArgumentsAsWritten->RAngleLoc,
360                                Record);
361     }
362 
363     Writer.AddSourceLocation(FTSInfo->getPointOfInstantiation(), Record);
364 
365     if (D->isCanonicalDecl()) {
366       // Write the template that contains the specializations set. We will
367       // add a FunctionTemplateSpecializationInfo to it when reading.
368       Writer.AddDeclRef(FTSInfo->getTemplate()->getCanonicalDecl(), Record);
369     }
370     break;
371   }
372   case FunctionDecl::TK_DependentFunctionTemplateSpecialization: {
373     DependentFunctionTemplateSpecializationInfo *
374       DFTSInfo = D->getDependentSpecializationInfo();
375 
376     // Templates.
377     Record.push_back(DFTSInfo->getNumTemplates());
378     for (int i=0, e = DFTSInfo->getNumTemplates(); i != e; ++i)
379       Writer.AddDeclRef(DFTSInfo->getTemplate(i), Record);
380 
381     // Templates args.
382     Record.push_back(DFTSInfo->getNumTemplateArgs());
383     for (int i=0, e = DFTSInfo->getNumTemplateArgs(); i != e; ++i)
384       Writer.AddTemplateArgumentLoc(DFTSInfo->getTemplateArg(i), Record);
385     Writer.AddSourceLocation(DFTSInfo->getLAngleLoc(), Record);
386     Writer.AddSourceLocation(DFTSInfo->getRAngleLoc(), Record);
387     break;
388   }
389   }
390 
391   Record.push_back(D->param_size());
392   for (FunctionDecl::param_iterator P = D->param_begin(), PEnd = D->param_end();
393        P != PEnd; ++P)
394     Writer.AddDeclRef(*P, Record);
395   Code = serialization::DECL_FUNCTION;
396 }
397 
398 void ASTDeclWriter::VisitObjCMethodDecl(ObjCMethodDecl *D) {
399   VisitNamedDecl(D);
400   // FIXME: convert to LazyStmtPtr?
401   // Unlike C/C++, method bodies will never be in header files.
402   bool HasBodyStuff = D->getBody() != 0     ||
403                       D->getSelfDecl() != 0 || D->getCmdDecl() != 0;
404   Record.push_back(HasBodyStuff);
405   if (HasBodyStuff) {
406     Writer.AddStmt(D->getBody());
407     Writer.AddDeclRef(D->getSelfDecl(), Record);
408     Writer.AddDeclRef(D->getCmdDecl(), Record);
409   }
410   Record.push_back(D->isInstanceMethod());
411   Record.push_back(D->isVariadic());
412   Record.push_back(D->isSynthesized());
413   Record.push_back(D->isDefined());
414 
415   Record.push_back(D->IsRedeclaration);
416   Record.push_back(D->HasRedeclaration);
417   if (D->HasRedeclaration) {
418     assert(Context.getObjCMethodRedeclaration(D));
419     Writer.AddDeclRef(Context.getObjCMethodRedeclaration(D), Record);
420   }
421 
422   // FIXME: stable encoding for @required/@optional
423   Record.push_back(D->getImplementationControl());
424   // FIXME: stable encoding for in/out/inout/bycopy/byref/oneway
425   Record.push_back(D->getObjCDeclQualifier());
426   Record.push_back(D->hasRelatedResultType());
427   Writer.AddTypeRef(D->getResultType(), Record);
428   Writer.AddTypeSourceInfo(D->getResultTypeSourceInfo(), Record);
429   Writer.AddSourceLocation(D->getLocEnd(), Record);
430   Record.push_back(D->param_size());
431   for (ObjCMethodDecl::param_iterator P = D->param_begin(),
432                                    PEnd = D->param_end(); P != PEnd; ++P)
433     Writer.AddDeclRef(*P, Record);
434 
435   Record.push_back(D->SelLocsKind);
436   unsigned NumStoredSelLocs = D->getNumStoredSelLocs();
437   SourceLocation *SelLocs = D->getStoredSelLocs();
438   Record.push_back(NumStoredSelLocs);
439   for (unsigned i = 0; i != NumStoredSelLocs; ++i)
440     Writer.AddSourceLocation(SelLocs[i], Record);
441 
442   Code = serialization::DECL_OBJC_METHOD;
443 }
444 
445 void ASTDeclWriter::VisitObjCContainerDecl(ObjCContainerDecl *D) {
446   VisitNamedDecl(D);
447   Writer.AddSourceLocation(D->getAtStartLoc(), Record);
448   Writer.AddSourceRange(D->getAtEndRange(), Record);
449   // Abstract class (no need to define a stable serialization::DECL code).
450 }
451 
452 void ASTDeclWriter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
453   VisitRedeclarable(D);
454   VisitObjCContainerDecl(D);
455   Writer.AddTypeRef(QualType(D->getTypeForDecl(), 0), Record);
456 
457   ObjCInterfaceDecl *Def = D->getDefinition();
458   Writer.AddDeclRef(Def, Record);
459 
460   if (D == Def) {
461     // Write the DefinitionData
462     ObjCInterfaceDecl::DefinitionData &Data = D->data();
463 
464     Writer.AddDeclRef(D->getSuperClass(), Record);
465     Writer.AddSourceLocation(D->getSuperClassLoc(), Record);
466     Writer.AddSourceLocation(D->getEndOfDefinitionLoc(), Record);
467 
468     // Write out the protocols that are directly referenced by the @interface.
469     Record.push_back(Data.ReferencedProtocols.size());
470     for (ObjCInterfaceDecl::protocol_iterator P = D->protocol_begin(),
471                                            PEnd = D->protocol_end();
472          P != PEnd; ++P)
473       Writer.AddDeclRef(*P, Record);
474     for (ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin(),
475          PLEnd = D->protocol_loc_end();
476          PL != PLEnd; ++PL)
477       Writer.AddSourceLocation(*PL, Record);
478 
479     // Write out the protocols that are transitively referenced.
480     Record.push_back(Data.AllReferencedProtocols.size());
481     for (ObjCList<ObjCProtocolDecl>::iterator
482               P = Data.AllReferencedProtocols.begin(),
483            PEnd = Data.AllReferencedProtocols.end();
484          P != PEnd; ++P)
485       Writer.AddDeclRef(*P, Record);
486 
487     // Write out the ivars.
488     Record.push_back(D->ivar_size());
489     for (ObjCInterfaceDecl::ivar_iterator I = D->ivar_begin(),
490                                        IEnd = D->ivar_end(); I != IEnd; ++I)
491       Writer.AddDeclRef(*I, Record);
492 
493     Writer.AddDeclRef(D->getCategoryList(), Record);
494   }
495 
496   Code = serialization::DECL_OBJC_INTERFACE;
497 }
498 
499 void ASTDeclWriter::VisitObjCIvarDecl(ObjCIvarDecl *D) {
500   VisitFieldDecl(D);
501   // FIXME: stable encoding for @public/@private/@protected/@package
502   Record.push_back(D->getAccessControl());
503   Record.push_back(D->getSynthesize());
504 
505   if (!D->hasAttrs() &&
506       !D->isImplicit() &&
507       !D->isUsed(false) &&
508       !D->isInvalidDecl() &&
509       !D->isReferenced() &&
510       !D->isModulePrivate() &&
511       !D->getBitWidth() &&
512       !D->hasExtInfo() &&
513       D->getDeclName())
514     AbbrevToUse = Writer.getDeclObjCIvarAbbrev();
515 
516   Code = serialization::DECL_OBJC_IVAR;
517 }
518 
519 void ASTDeclWriter::VisitObjCProtocolDecl(ObjCProtocolDecl *D) {
520   VisitRedeclarable(D);
521   VisitObjCContainerDecl(D);
522 
523   ObjCProtocolDecl *Def = D->getDefinition();
524   Writer.AddDeclRef(Def, Record);
525 
526   if (D == Def) {
527     Record.push_back(D->protocol_size());
528     for (ObjCProtocolDecl::protocol_iterator
529          I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
530       Writer.AddDeclRef(*I, Record);
531     for (ObjCProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin(),
532            PLEnd = D->protocol_loc_end();
533          PL != PLEnd; ++PL)
534       Writer.AddSourceLocation(*PL, Record);
535   }
536 
537   Code = serialization::DECL_OBJC_PROTOCOL;
538 }
539 
540 void ASTDeclWriter::VisitObjCAtDefsFieldDecl(ObjCAtDefsFieldDecl *D) {
541   VisitFieldDecl(D);
542   Code = serialization::DECL_OBJC_AT_DEFS_FIELD;
543 }
544 
545 void ASTDeclWriter::VisitObjCCategoryDecl(ObjCCategoryDecl *D) {
546   VisitObjCContainerDecl(D);
547   Writer.AddDeclRef(D->getClassInterface(), Record);
548   Record.push_back(D->protocol_size());
549   for (ObjCCategoryDecl::protocol_iterator
550        I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
551     Writer.AddDeclRef(*I, Record);
552   for (ObjCCategoryDecl::protocol_loc_iterator
553          PL = D->protocol_loc_begin(), PLEnd = D->protocol_loc_end();
554        PL != PLEnd; ++PL)
555     Writer.AddSourceLocation(*PL, Record);
556   Writer.AddDeclRef(D->getNextClassCategory(), Record);
557   Record.push_back(D->hasSynthBitfield());
558   Writer.AddSourceLocation(D->getCategoryNameLoc(), Record);
559   Code = serialization::DECL_OBJC_CATEGORY;
560 }
561 
562 void ASTDeclWriter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D) {
563   VisitNamedDecl(D);
564   Writer.AddDeclRef(D->getClassInterface(), Record);
565   Code = serialization::DECL_OBJC_COMPATIBLE_ALIAS;
566 }
567 
568 void ASTDeclWriter::VisitObjCPropertyDecl(ObjCPropertyDecl *D) {
569   VisitNamedDecl(D);
570   Writer.AddSourceLocation(D->getAtLoc(), Record);
571   Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
572   // FIXME: stable encoding
573   Record.push_back((unsigned)D->getPropertyAttributes());
574   Record.push_back((unsigned)D->getPropertyAttributesAsWritten());
575   // FIXME: stable encoding
576   Record.push_back((unsigned)D->getPropertyImplementation());
577   Writer.AddDeclarationName(D->getGetterName(), Record);
578   Writer.AddDeclarationName(D->getSetterName(), Record);
579   Writer.AddDeclRef(D->getGetterMethodDecl(), Record);
580   Writer.AddDeclRef(D->getSetterMethodDecl(), Record);
581   Writer.AddDeclRef(D->getPropertyIvarDecl(), Record);
582   Code = serialization::DECL_OBJC_PROPERTY;
583 }
584 
585 void ASTDeclWriter::VisitObjCImplDecl(ObjCImplDecl *D) {
586   VisitObjCContainerDecl(D);
587   Writer.AddDeclRef(D->getClassInterface(), Record);
588   // Abstract class (no need to define a stable serialization::DECL code).
589 }
590 
591 void ASTDeclWriter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
592   VisitObjCImplDecl(D);
593   Writer.AddIdentifierRef(D->getIdentifier(), Record);
594   Writer.AddSourceLocation(D->getCategoryNameLoc(), Record);
595   Code = serialization::DECL_OBJC_CATEGORY_IMPL;
596 }
597 
598 void ASTDeclWriter::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
599   VisitObjCImplDecl(D);
600   Writer.AddDeclRef(D->getSuperClass(), Record);
601   Writer.AddCXXCtorInitializers(D->IvarInitializers, D->NumIvarInitializers,
602                                 Record);
603   Record.push_back(D->hasSynthBitfield());
604   Code = serialization::DECL_OBJC_IMPLEMENTATION;
605 }
606 
607 void ASTDeclWriter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D) {
608   VisitDecl(D);
609   Writer.AddSourceLocation(D->getLocStart(), Record);
610   Writer.AddDeclRef(D->getPropertyDecl(), Record);
611   Writer.AddDeclRef(D->getPropertyIvarDecl(), Record);
612   Writer.AddSourceLocation(D->getPropertyIvarDeclLoc(), Record);
613   Writer.AddStmt(D->getGetterCXXConstructor());
614   Writer.AddStmt(D->getSetterCXXAssignment());
615   Code = serialization::DECL_OBJC_PROPERTY_IMPL;
616 }
617 
618 void ASTDeclWriter::VisitFieldDecl(FieldDecl *D) {
619   VisitDeclaratorDecl(D);
620   Record.push_back(D->isMutable());
621   Record.push_back(D->getBitWidth()? 1 : D->hasInClassInitializer() ? 2 : 0);
622   if (D->getBitWidth())
623     Writer.AddStmt(D->getBitWidth());
624   else if (D->hasInClassInitializer())
625     Writer.AddStmt(D->getInClassInitializer());
626   if (!D->getDeclName())
627     Writer.AddDeclRef(Context.getInstantiatedFromUnnamedFieldDecl(D), Record);
628 
629   if (!D->hasAttrs() &&
630       !D->isImplicit() &&
631       !D->isUsed(false) &&
632       !D->isInvalidDecl() &&
633       !D->isReferenced() &&
634       !D->isTopLevelDeclInObjCContainer() &&
635       !D->isModulePrivate() &&
636       !D->getBitWidth() &&
637       !D->hasInClassInitializer() &&
638       !D->hasExtInfo() &&
639       !ObjCIvarDecl::classofKind(D->getKind()) &&
640       !ObjCAtDefsFieldDecl::classofKind(D->getKind()) &&
641       D->getDeclName())
642     AbbrevToUse = Writer.getDeclFieldAbbrev();
643 
644   Code = serialization::DECL_FIELD;
645 }
646 
647 void ASTDeclWriter::VisitIndirectFieldDecl(IndirectFieldDecl *D) {
648   VisitValueDecl(D);
649   Record.push_back(D->getChainingSize());
650 
651   for (IndirectFieldDecl::chain_iterator
652        P = D->chain_begin(),
653        PEnd = D->chain_end(); P != PEnd; ++P)
654     Writer.AddDeclRef(*P, Record);
655   Code = serialization::DECL_INDIRECTFIELD;
656 }
657 
658 void ASTDeclWriter::VisitVarDecl(VarDecl *D) {
659   VisitRedeclarable(D);
660   VisitDeclaratorDecl(D);
661   Record.push_back(D->getStorageClass()); // FIXME: stable encoding
662   Record.push_back(D->getStorageClassAsWritten());
663   Record.push_back(D->isThreadSpecified());
664   Record.push_back(D->hasCXXDirectInitializer());
665   Record.push_back(D->isExceptionVariable());
666   Record.push_back(D->isNRVOVariable());
667   Record.push_back(D->isCXXForRangeDecl());
668   Record.push_back(D->isARCPseudoStrong());
669   if (D->getInit()) {
670     Record.push_back(!D->isInitKnownICE() ? 1 : (D->isInitICE() ? 3 : 2));
671     Writer.AddStmt(D->getInit());
672   } else {
673     Record.push_back(0);
674   }
675 
676   MemberSpecializationInfo *SpecInfo
677     = D->isStaticDataMember() ? D->getMemberSpecializationInfo() : 0;
678   Record.push_back(SpecInfo != 0);
679   if (SpecInfo) {
680     Writer.AddDeclRef(SpecInfo->getInstantiatedFrom(), Record);
681     Record.push_back(SpecInfo->getTemplateSpecializationKind());
682     Writer.AddSourceLocation(SpecInfo->getPointOfInstantiation(), Record);
683   }
684 
685   if (!D->hasAttrs() &&
686       !D->isImplicit() &&
687       !D->isUsed(false) &&
688       !D->isInvalidDecl() &&
689       !D->isReferenced() &&
690       !D->isTopLevelDeclInObjCContainer() &&
691       D->getAccess() == AS_none &&
692       !D->isModulePrivate() &&
693       D->getDeclName().getNameKind() == DeclarationName::Identifier &&
694       !D->hasExtInfo() &&
695       !D->getPreviousDecl() &&
696       !D->hasCXXDirectInitializer() &&
697       D->getInit() == 0 &&
698       !isa<ParmVarDecl>(D) &&
699       !SpecInfo)
700     AbbrevToUse = Writer.getDeclVarAbbrev();
701 
702   Code = serialization::DECL_VAR;
703 }
704 
705 void ASTDeclWriter::VisitImplicitParamDecl(ImplicitParamDecl *D) {
706   VisitVarDecl(D);
707   Code = serialization::DECL_IMPLICIT_PARAM;
708 }
709 
710 void ASTDeclWriter::VisitParmVarDecl(ParmVarDecl *D) {
711   VisitVarDecl(D);
712   Record.push_back(D->isObjCMethodParameter());
713   Record.push_back(D->getFunctionScopeDepth());
714   Record.push_back(D->getFunctionScopeIndex());
715   Record.push_back(D->getObjCDeclQualifier()); // FIXME: stable encoding
716   Record.push_back(D->isKNRPromoted());
717   Record.push_back(D->hasInheritedDefaultArg());
718   Record.push_back(D->hasUninstantiatedDefaultArg());
719   if (D->hasUninstantiatedDefaultArg())
720     Writer.AddStmt(D->getUninstantiatedDefaultArg());
721   Code = serialization::DECL_PARM_VAR;
722 
723   assert(!D->isARCPseudoStrong()); // can be true of ImplicitParamDecl
724 
725   // If the assumptions about the DECL_PARM_VAR abbrev are true, use it.  Here
726   // we dynamically check for the properties that we optimize for, but don't
727   // know are true of all PARM_VAR_DECLs.
728   if (!D->hasAttrs() &&
729       !D->hasExtInfo() &&
730       !D->isImplicit() &&
731       !D->isUsed(false) &&
732       !D->isReferenced() &&
733       D->getAccess() == AS_none &&
734       !D->isModulePrivate() &&
735       D->getStorageClass() == 0 &&
736       !D->hasCXXDirectInitializer() && // Can params have this ever?
737       D->getFunctionScopeDepth() == 0 &&
738       D->getObjCDeclQualifier() == 0 &&
739       !D->isKNRPromoted() &&
740       !D->hasInheritedDefaultArg() &&
741       D->getInit() == 0 &&
742       !D->hasUninstantiatedDefaultArg())  // No default expr.
743     AbbrevToUse = Writer.getDeclParmVarAbbrev();
744 
745   // Check things we know are true of *every* PARM_VAR_DECL, which is more than
746   // just us assuming it.
747   assert(!D->isInvalidDecl() && "Shouldn't emit invalid decls");
748   assert(!D->isThreadSpecified() && "PARM_VAR_DECL can't be __thread");
749   assert(D->getAccess() == AS_none && "PARM_VAR_DECL can't be public/private");
750   assert(!D->isExceptionVariable() && "PARM_VAR_DECL can't be exception var");
751   assert(D->getPreviousDecl() == 0 && "PARM_VAR_DECL can't be redecl");
752   assert(!D->isStaticDataMember() &&
753          "PARM_VAR_DECL can't be static data member");
754 }
755 
756 void ASTDeclWriter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) {
757   VisitDecl(D);
758   Writer.AddStmt(D->getAsmString());
759   Writer.AddSourceLocation(D->getRParenLoc(), Record);
760   Code = serialization::DECL_FILE_SCOPE_ASM;
761 }
762 
763 void ASTDeclWriter::VisitBlockDecl(BlockDecl *D) {
764   VisitDecl(D);
765   Writer.AddStmt(D->getBody());
766   Writer.AddTypeSourceInfo(D->getSignatureAsWritten(), Record);
767   Record.push_back(D->param_size());
768   for (FunctionDecl::param_iterator P = D->param_begin(), PEnd = D->param_end();
769        P != PEnd; ++P)
770     Writer.AddDeclRef(*P, Record);
771   Record.push_back(D->capturesCXXThis());
772   Record.push_back(D->getNumCaptures());
773   for (BlockDecl::capture_iterator
774          i = D->capture_begin(), e = D->capture_end(); i != e; ++i) {
775     const BlockDecl::Capture &capture = *i;
776     Writer.AddDeclRef(capture.getVariable(), Record);
777 
778     unsigned flags = 0;
779     if (capture.isByRef()) flags |= 1;
780     if (capture.isNested()) flags |= 2;
781     if (capture.hasCopyExpr()) flags |= 4;
782     Record.push_back(flags);
783 
784     if (capture.hasCopyExpr()) Writer.AddStmt(capture.getCopyExpr());
785   }
786 
787   Code = serialization::DECL_BLOCK;
788 }
789 
790 void ASTDeclWriter::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
791   VisitDecl(D);
792   Record.push_back(D->getLanguage());
793   Writer.AddSourceLocation(D->getExternLoc(), Record);
794   Writer.AddSourceLocation(D->getRBraceLoc(), Record);
795   Code = serialization::DECL_LINKAGE_SPEC;
796 }
797 
798 void ASTDeclWriter::VisitLabelDecl(LabelDecl *D) {
799   VisitNamedDecl(D);
800   Writer.AddSourceLocation(D->getLocStart(), Record);
801   Code = serialization::DECL_LABEL;
802 }
803 
804 
805 void ASTDeclWriter::VisitNamespaceDecl(NamespaceDecl *D) {
806   VisitRedeclarable(D);
807   VisitNamedDecl(D);
808   Record.push_back(D->isInline());
809   Writer.AddSourceLocation(D->getLocStart(), Record);
810   Writer.AddSourceLocation(D->getRBraceLoc(), Record);
811 
812   if (D->isOriginalNamespace())
813     Writer.AddDeclRef(D->getAnonymousNamespace(), Record);
814   Code = serialization::DECL_NAMESPACE;
815 
816   if (Writer.hasChain() && !D->isOriginalNamespace() &&
817       D->getOriginalNamespace()->isFromASTFile()) {
818     NamespaceDecl *NS = D->getOriginalNamespace();
819     Writer.AddUpdatedDeclContext(NS);
820 
821     // Make sure all visible decls are written. They will be recorded later.
822     NS->lookup(DeclarationName());
823     StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(NS->getLookupPtr());
824     if (Map) {
825       for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
826            D != DEnd; ++D) {
827         DeclContext::lookup_result Result = D->second.getLookupResult();
828         while (Result.first != Result.second) {
829           Writer.GetDeclRef(*Result.first);
830           ++Result.first;
831         }
832       }
833     }
834   }
835 
836   if (Writer.hasChain() && D->isAnonymousNamespace() &&
837       D == D->getMostRecentDecl()) {
838     // This is a most recent reopening of the anonymous namespace. If its parent
839     // is in a previous PCH (or is the TU), mark that parent for update, because
840     // the original namespace always points to the latest re-opening of its
841     // anonymous namespace.
842     Decl *Parent = cast<Decl>(
843         D->getParent()->getRedeclContext()->getPrimaryContext());
844     if (Parent->isFromASTFile() || isa<TranslationUnitDecl>(Parent)) {
845       ASTWriter::UpdateRecord &Record = Writer.DeclUpdates[Parent];
846       Record.push_back(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE);
847       Writer.AddDeclRef(D, Record);
848     }
849   }
850 }
851 
852 void ASTDeclWriter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
853   VisitNamedDecl(D);
854   Writer.AddSourceLocation(D->getNamespaceLoc(), Record);
855   Writer.AddSourceLocation(D->getTargetNameLoc(), Record);
856   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
857   Writer.AddDeclRef(D->getNamespace(), Record);
858   Code = serialization::DECL_NAMESPACE_ALIAS;
859 }
860 
861 void ASTDeclWriter::VisitUsingDecl(UsingDecl *D) {
862   VisitNamedDecl(D);
863   Writer.AddSourceLocation(D->getUsingLocation(), Record);
864   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
865   Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
866   Writer.AddDeclRef(D->FirstUsingShadow.getPointer(), Record);
867   Record.push_back(D->isTypeName());
868   Writer.AddDeclRef(Context.getInstantiatedFromUsingDecl(D), Record);
869   Code = serialization::DECL_USING;
870 }
871 
872 void ASTDeclWriter::VisitUsingShadowDecl(UsingShadowDecl *D) {
873   VisitNamedDecl(D);
874   Writer.AddDeclRef(D->getTargetDecl(), Record);
875   Writer.AddDeclRef(D->UsingOrNextShadow, Record);
876   Writer.AddDeclRef(Context.getInstantiatedFromUsingShadowDecl(D), Record);
877   Code = serialization::DECL_USING_SHADOW;
878 }
879 
880 void ASTDeclWriter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
881   VisitNamedDecl(D);
882   Writer.AddSourceLocation(D->getUsingLoc(), Record);
883   Writer.AddSourceLocation(D->getNamespaceKeyLocation(), Record);
884   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
885   Writer.AddDeclRef(D->getNominatedNamespace(), Record);
886   Writer.AddDeclRef(dyn_cast<Decl>(D->getCommonAncestor()), Record);
887   Code = serialization::DECL_USING_DIRECTIVE;
888 }
889 
890 void ASTDeclWriter::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
891   VisitValueDecl(D);
892   Writer.AddSourceLocation(D->getUsingLoc(), Record);
893   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
894   Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
895   Code = serialization::DECL_UNRESOLVED_USING_VALUE;
896 }
897 
898 void ASTDeclWriter::VisitUnresolvedUsingTypenameDecl(
899                                                UnresolvedUsingTypenameDecl *D) {
900   VisitTypeDecl(D);
901   Writer.AddSourceLocation(D->getTypenameLoc(), Record);
902   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
903   Code = serialization::DECL_UNRESOLVED_USING_TYPENAME;
904 }
905 
906 void ASTDeclWriter::VisitCXXRecordDecl(CXXRecordDecl *D) {
907   VisitRecordDecl(D);
908 
909   CXXRecordDecl *DefinitionDecl = 0;
910   if (D->DefinitionData)
911     DefinitionDecl = D->DefinitionData->Definition;
912   Writer.AddDeclRef(DefinitionDecl, Record);
913   if (D == DefinitionDecl)
914     Writer.AddCXXDefinitionData(D, Record);
915 
916   enum {
917     CXXRecNotTemplate = 0, CXXRecTemplate, CXXRecMemberSpecialization
918   };
919   if (ClassTemplateDecl *TemplD = D->getDescribedClassTemplate()) {
920     Record.push_back(CXXRecTemplate);
921     Writer.AddDeclRef(TemplD, Record);
922   } else if (MemberSpecializationInfo *MSInfo
923                = D->getMemberSpecializationInfo()) {
924     Record.push_back(CXXRecMemberSpecialization);
925     Writer.AddDeclRef(MSInfo->getInstantiatedFrom(), Record);
926     Record.push_back(MSInfo->getTemplateSpecializationKind());
927     Writer.AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
928   } else {
929     Record.push_back(CXXRecNotTemplate);
930   }
931 
932   // Store the key function to avoid deserializing every method so we can
933   // compute it.
934   if (D->IsCompleteDefinition)
935     Writer.AddDeclRef(Context.getKeyFunction(D), Record);
936 
937   Code = serialization::DECL_CXX_RECORD;
938 }
939 
940 void ASTDeclWriter::VisitCXXMethodDecl(CXXMethodDecl *D) {
941   VisitFunctionDecl(D);
942   Record.push_back(D->size_overridden_methods());
943   for (CXXMethodDecl::method_iterator
944          I = D->begin_overridden_methods(), E = D->end_overridden_methods();
945          I != E; ++I)
946     Writer.AddDeclRef(*I, Record);
947   Code = serialization::DECL_CXX_METHOD;
948 }
949 
950 void ASTDeclWriter::VisitCXXConstructorDecl(CXXConstructorDecl *D) {
951   VisitCXXMethodDecl(D);
952 
953   Record.push_back(D->IsExplicitSpecified);
954   Record.push_back(D->ImplicitlyDefined);
955   Writer.AddCXXCtorInitializers(D->CtorInitializers, D->NumCtorInitializers,
956                                 Record);
957 
958   Code = serialization::DECL_CXX_CONSTRUCTOR;
959 }
960 
961 void ASTDeclWriter::VisitCXXDestructorDecl(CXXDestructorDecl *D) {
962   VisitCXXMethodDecl(D);
963 
964   Record.push_back(D->ImplicitlyDefined);
965   Writer.AddDeclRef(D->OperatorDelete, Record);
966 
967   Code = serialization::DECL_CXX_DESTRUCTOR;
968 }
969 
970 void ASTDeclWriter::VisitCXXConversionDecl(CXXConversionDecl *D) {
971   VisitCXXMethodDecl(D);
972   Record.push_back(D->IsExplicitSpecified);
973   Code = serialization::DECL_CXX_CONVERSION;
974 }
975 
976 void ASTDeclWriter::VisitImportDecl(ImportDecl *D) {
977   VisitDecl(D);
978   ArrayRef<SourceLocation> IdentifierLocs = D->getIdentifierLocs();
979   Record.push_back(!IdentifierLocs.empty());
980   if (IdentifierLocs.empty()) {
981     Writer.AddSourceLocation(D->getLocEnd(), Record);
982     Record.push_back(1);
983   } else {
984     for (unsigned I = 0, N = IdentifierLocs.size(); I != N; ++I)
985       Writer.AddSourceLocation(IdentifierLocs[I], Record);
986     Record.push_back(IdentifierLocs.size());
987   }
988   // Note: the number of source locations must always be the last element in
989   // the record.
990   Code = serialization::DECL_IMPORT;
991 }
992 
993 void ASTDeclWriter::VisitAccessSpecDecl(AccessSpecDecl *D) {
994   VisitDecl(D);
995   Writer.AddSourceLocation(D->getColonLoc(), Record);
996   Code = serialization::DECL_ACCESS_SPEC;
997 }
998 
999 void ASTDeclWriter::VisitFriendDecl(FriendDecl *D) {
1000   VisitDecl(D);
1001   Record.push_back(D->Friend.is<TypeSourceInfo*>());
1002   if (D->Friend.is<TypeSourceInfo*>())
1003     Writer.AddTypeSourceInfo(D->Friend.get<TypeSourceInfo*>(), Record);
1004   else
1005     Writer.AddDeclRef(D->Friend.get<NamedDecl*>(), Record);
1006   Writer.AddDeclRef(D->getNextFriend(), Record);
1007   Record.push_back(D->UnsupportedFriend);
1008   Writer.AddSourceLocation(D->FriendLoc, Record);
1009   Code = serialization::DECL_FRIEND;
1010 }
1011 
1012 void ASTDeclWriter::VisitFriendTemplateDecl(FriendTemplateDecl *D) {
1013   VisitDecl(D);
1014   Record.push_back(D->getNumTemplateParameters());
1015   for (unsigned i = 0, e = D->getNumTemplateParameters(); i != e; ++i)
1016     Writer.AddTemplateParameterList(D->getTemplateParameterList(i), Record);
1017   Record.push_back(D->getFriendDecl() != 0);
1018   if (D->getFriendDecl())
1019     Writer.AddDeclRef(D->getFriendDecl(), Record);
1020   else
1021     Writer.AddTypeSourceInfo(D->getFriendType(), Record);
1022   Writer.AddSourceLocation(D->getFriendLoc(), Record);
1023   Code = serialization::DECL_FRIEND_TEMPLATE;
1024 }
1025 
1026 void ASTDeclWriter::VisitTemplateDecl(TemplateDecl *D) {
1027   VisitNamedDecl(D);
1028 
1029   Writer.AddDeclRef(D->getTemplatedDecl(), Record);
1030   Writer.AddTemplateParameterList(D->getTemplateParameters(), Record);
1031 }
1032 
1033 void ASTDeclWriter::VisitRedeclarableTemplateDecl(RedeclarableTemplateDecl *D) {
1034   VisitRedeclarable(D);
1035 
1036   // Emit data to initialize CommonOrPrev before VisitTemplateDecl so that
1037   // getCommonPtr() can be used while this is still initializing.
1038   if (D->isFirstDeclaration()) {
1039     // This declaration owns the 'common' pointer, so serialize that data now.
1040     Writer.AddDeclRef(D->getInstantiatedFromMemberTemplate(), Record);
1041     if (D->getInstantiatedFromMemberTemplate())
1042       Record.push_back(D->isMemberSpecialization());
1043   }
1044 
1045   VisitTemplateDecl(D);
1046   Record.push_back(D->getIdentifierNamespace());
1047 }
1048 
1049 void ASTDeclWriter::VisitClassTemplateDecl(ClassTemplateDecl *D) {
1050   VisitRedeclarableTemplateDecl(D);
1051 
1052   if (D->isFirstDeclaration()) {
1053     typedef llvm::FoldingSet<ClassTemplateSpecializationDecl> CTSDSetTy;
1054     CTSDSetTy &CTSDSet = D->getSpecializations();
1055     Record.push_back(CTSDSet.size());
1056     for (CTSDSetTy::iterator I=CTSDSet.begin(), E = CTSDSet.end(); I!=E; ++I) {
1057       assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
1058       Writer.AddDeclRef(&*I, Record);
1059     }
1060 
1061     typedef llvm::FoldingSet<ClassTemplatePartialSpecializationDecl> CTPSDSetTy;
1062     CTPSDSetTy &CTPSDSet = D->getPartialSpecializations();
1063     Record.push_back(CTPSDSet.size());
1064     for (CTPSDSetTy::iterator I=CTPSDSet.begin(), E=CTPSDSet.end(); I!=E; ++I) {
1065       assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
1066       Writer.AddDeclRef(&*I, Record);
1067     }
1068 
1069     // InjectedClassNameType is computed, no need to write it.
1070   }
1071   Code = serialization::DECL_CLASS_TEMPLATE;
1072 }
1073 
1074 void ASTDeclWriter::VisitClassTemplateSpecializationDecl(
1075                                            ClassTemplateSpecializationDecl *D) {
1076   VisitCXXRecordDecl(D);
1077 
1078   llvm::PointerUnion<ClassTemplateDecl *,
1079                      ClassTemplatePartialSpecializationDecl *> InstFrom
1080     = D->getSpecializedTemplateOrPartial();
1081   if (Decl *InstFromD = InstFrom.dyn_cast<ClassTemplateDecl *>()) {
1082     Writer.AddDeclRef(InstFromD, Record);
1083   } else {
1084     Writer.AddDeclRef(InstFrom.get<ClassTemplatePartialSpecializationDecl *>(),
1085                       Record);
1086     Writer.AddTemplateArgumentList(&D->getTemplateInstantiationArgs(), Record);
1087   }
1088 
1089   // Explicit info.
1090   Writer.AddTypeSourceInfo(D->getTypeAsWritten(), Record);
1091   if (D->getTypeAsWritten()) {
1092     Writer.AddSourceLocation(D->getExternLoc(), Record);
1093     Writer.AddSourceLocation(D->getTemplateKeywordLoc(), Record);
1094   }
1095 
1096   Writer.AddTemplateArgumentList(&D->getTemplateArgs(), Record);
1097   Writer.AddSourceLocation(D->getPointOfInstantiation(), Record);
1098   Record.push_back(D->getSpecializationKind());
1099 
1100   if (D->isCanonicalDecl()) {
1101     // When reading, we'll add it to the folding set of the following template.
1102     Writer.AddDeclRef(D->getSpecializedTemplate()->getCanonicalDecl(), Record);
1103   }
1104 
1105   Code = serialization::DECL_CLASS_TEMPLATE_SPECIALIZATION;
1106 }
1107 
1108 void ASTDeclWriter::VisitClassTemplatePartialSpecializationDecl(
1109                                     ClassTemplatePartialSpecializationDecl *D) {
1110   VisitClassTemplateSpecializationDecl(D);
1111 
1112   Writer.AddTemplateParameterList(D->getTemplateParameters(), Record);
1113 
1114   Record.push_back(D->getNumTemplateArgsAsWritten());
1115   for (int i = 0, e = D->getNumTemplateArgsAsWritten(); i != e; ++i)
1116     Writer.AddTemplateArgumentLoc(D->getTemplateArgsAsWritten()[i], Record);
1117 
1118   Record.push_back(D->getSequenceNumber());
1119 
1120   // These are read/set from/to the first declaration.
1121   if (D->getPreviousDecl() == 0) {
1122     Writer.AddDeclRef(D->getInstantiatedFromMember(), Record);
1123     Record.push_back(D->isMemberSpecialization());
1124   }
1125 
1126   Code = serialization::DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION;
1127 }
1128 
1129 void ASTDeclWriter::VisitClassScopeFunctionSpecializationDecl(
1130                                     ClassScopeFunctionSpecializationDecl *D) {
1131   VisitDecl(D);
1132   Writer.AddDeclRef(D->getSpecialization(), Record);
1133   Code = serialization::DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION;
1134 }
1135 
1136 
1137 void ASTDeclWriter::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
1138   VisitRedeclarableTemplateDecl(D);
1139 
1140   if (D->isFirstDeclaration()) {
1141     // This FunctionTemplateDecl owns the CommonPtr; write it.
1142 
1143     // Write the function specialization declarations.
1144     Record.push_back(D->getSpecializations().size());
1145     for (llvm::FoldingSet<FunctionTemplateSpecializationInfo>::iterator
1146            I = D->getSpecializations().begin(),
1147            E = D->getSpecializations().end()   ; I != E; ++I) {
1148       assert(I->Function->isCanonicalDecl() &&
1149              "Expected only canonical decls in set");
1150       Writer.AddDeclRef(I->Function, Record);
1151     }
1152   }
1153   Code = serialization::DECL_FUNCTION_TEMPLATE;
1154 }
1155 
1156 void ASTDeclWriter::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
1157   VisitTypeDecl(D);
1158 
1159   Record.push_back(D->wasDeclaredWithTypename());
1160   Record.push_back(D->defaultArgumentWasInherited());
1161   Writer.AddTypeSourceInfo(D->getDefaultArgumentInfo(), Record);
1162 
1163   Code = serialization::DECL_TEMPLATE_TYPE_PARM;
1164 }
1165 
1166 void ASTDeclWriter::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
1167   // For an expanded parameter pack, record the number of expansion types here
1168   // so that it's easier for
1169   if (D->isExpandedParameterPack())
1170     Record.push_back(D->getNumExpansionTypes());
1171 
1172   VisitDeclaratorDecl(D);
1173   // TemplateParmPosition.
1174   Record.push_back(D->getDepth());
1175   Record.push_back(D->getPosition());
1176 
1177   if (D->isExpandedParameterPack()) {
1178     for (unsigned I = 0, N = D->getNumExpansionTypes(); I != N; ++I) {
1179       Writer.AddTypeRef(D->getExpansionType(I), Record);
1180       Writer.AddTypeSourceInfo(D->getExpansionTypeSourceInfo(I), Record);
1181     }
1182 
1183     Code = serialization::DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK;
1184   } else {
1185     // Rest of NonTypeTemplateParmDecl.
1186     Record.push_back(D->isParameterPack());
1187     Record.push_back(D->getDefaultArgument() != 0);
1188     if (D->getDefaultArgument()) {
1189       Writer.AddStmt(D->getDefaultArgument());
1190       Record.push_back(D->defaultArgumentWasInherited());
1191     }
1192     Code = serialization::DECL_NON_TYPE_TEMPLATE_PARM;
1193   }
1194 }
1195 
1196 void ASTDeclWriter::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
1197   VisitTemplateDecl(D);
1198   // TemplateParmPosition.
1199   Record.push_back(D->getDepth());
1200   Record.push_back(D->getPosition());
1201   // Rest of TemplateTemplateParmDecl.
1202   Writer.AddTemplateArgumentLoc(D->getDefaultArgument(), Record);
1203   Record.push_back(D->defaultArgumentWasInherited());
1204   Record.push_back(D->isParameterPack());
1205   Code = serialization::DECL_TEMPLATE_TEMPLATE_PARM;
1206 }
1207 
1208 void ASTDeclWriter::VisitTypeAliasTemplateDecl(TypeAliasTemplateDecl *D) {
1209   VisitRedeclarableTemplateDecl(D);
1210   Code = serialization::DECL_TYPE_ALIAS_TEMPLATE;
1211 }
1212 
1213 void ASTDeclWriter::VisitStaticAssertDecl(StaticAssertDecl *D) {
1214   VisitDecl(D);
1215   Writer.AddStmt(D->getAssertExpr());
1216   Writer.AddStmt(D->getMessage());
1217   Writer.AddSourceLocation(D->getRParenLoc(), Record);
1218   Code = serialization::DECL_STATIC_ASSERT;
1219 }
1220 
1221 /// \brief Emit the DeclContext part of a declaration context decl.
1222 ///
1223 /// \param LexicalOffset the offset at which the DECL_CONTEXT_LEXICAL
1224 /// block for this declaration context is stored. May be 0 to indicate
1225 /// that there are no declarations stored within this context.
1226 ///
1227 /// \param VisibleOffset the offset at which the DECL_CONTEXT_VISIBLE
1228 /// block for this declaration context is stored. May be 0 to indicate
1229 /// that there are no declarations visible from this context. Note
1230 /// that this value will not be emitted for non-primary declaration
1231 /// contexts.
1232 void ASTDeclWriter::VisitDeclContext(DeclContext *DC, uint64_t LexicalOffset,
1233                                      uint64_t VisibleOffset) {
1234   Record.push_back(LexicalOffset);
1235   Record.push_back(VisibleOffset);
1236 }
1237 
1238 template <typename T>
1239 void ASTDeclWriter::VisitRedeclarable(Redeclarable<T> *D) {
1240   enum { FirstDeclaration = 0, FirstInFile, PointsToPrevious };
1241   T *Prev = D->getPreviousDecl();
1242   T *First = D->getFirstDeclaration();
1243 
1244   if (!Prev) {
1245     Record.push_back(FirstDeclaration);
1246   } else {
1247     Record.push_back(Prev->isFromASTFile()? FirstInFile : PointsToPrevious);
1248     Writer.AddDeclRef(First, Record);
1249     Writer.AddDeclRef(D->getPreviousDecl(), Record);
1250   }
1251 
1252   if (D->RedeclLink.getPointer() != D && (!Prev || Prev->isFromASTFile())) {
1253     // Capture the set of redeclarations in this file.
1254     LocalRedeclarationsInfo LocalInfo = {
1255       Writer.GetDeclRef(First),
1256       Writer.GetDeclRef(static_cast<T*>(D)),
1257       Writer.GetDeclRef(D->getMostRecentDecl())
1258     };
1259     Writer.LocalRedeclarations.push_back(LocalInfo);
1260   }
1261 }
1262 
1263 //===----------------------------------------------------------------------===//
1264 // ASTWriter Implementation
1265 //===----------------------------------------------------------------------===//
1266 
1267 void ASTWriter::WriteDeclsBlockAbbrevs() {
1268   using namespace llvm;
1269 
1270   BitCodeAbbrev *Abv;
1271 
1272   // Abbreviation for DECL_FIELD
1273   Abv = new BitCodeAbbrev();
1274   Abv->Add(BitCodeAbbrevOp(serialization::DECL_FIELD));
1275   // Decl
1276   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1277   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1278   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1279   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1280   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1281   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1282   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1283   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1284   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2));  // AccessSpecifier
1285   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1286   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1287   // NamedDecl
1288   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1289   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1290   // ValueDecl
1291   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1292   // DeclaratorDecl
1293   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1294   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1295   // FieldDecl
1296   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isMutable
1297   Abv->Add(BitCodeAbbrevOp(0));                       //getBitWidth
1298   // Type Source Info
1299   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1300   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1301   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1302   DeclFieldAbbrev = Stream.EmitAbbrev(Abv);
1303 
1304   // Abbreviation for DECL_OBJC_IVAR
1305   Abv = new BitCodeAbbrev();
1306   Abv->Add(BitCodeAbbrevOp(serialization::DECL_OBJC_IVAR));
1307   // Decl
1308   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1309   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1310   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1311   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1312   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1313   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1314   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1315   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1316   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2));  // AccessSpecifier
1317   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1318   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1319   // NamedDecl
1320   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1321   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1322   // ValueDecl
1323   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1324   // DeclaratorDecl
1325   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1326   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1327   // FieldDecl
1328   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isMutable
1329   Abv->Add(BitCodeAbbrevOp(0));                       //getBitWidth
1330   // ObjC Ivar
1331   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // getAccessControl
1332   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // getSynthesize
1333   // Type Source Info
1334   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1335   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1336   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1337   DeclObjCIvarAbbrev = Stream.EmitAbbrev(Abv);
1338 
1339   // Abbreviation for DECL_ENUM
1340   Abv = new BitCodeAbbrev();
1341   Abv->Add(BitCodeAbbrevOp(serialization::DECL_ENUM));
1342   // Redeclarable
1343   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1344   // Decl
1345   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1346   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1347   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1348   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1349   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1350   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1351   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1352   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1353   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1354   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1355   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1356   // NamedDecl
1357   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1358   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1359   // TypeDecl
1360   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1361   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1362   // TagDecl
1363   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IdentifierNamespace
1364   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getTagKind
1365   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isCompleteDefinition
1366   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // EmbeddedInDeclarator
1367   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFreeStanding
1368   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // SourceLocation
1369   Abv->Add(BitCodeAbbrevOp(0));                         // hasExtInfo
1370   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // TypedefNameAnonDecl
1371   // EnumDecl
1372   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // AddTypeRef
1373   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IntegerType
1374   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getPromotionType
1375   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getNumPositiveBits
1376   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getNumNegativeBits
1377   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isScoped
1378   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isScopedUsingClassTag
1379   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isFixed
1380   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // InstantiatedMembEnum
1381   // DC
1382   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // LexicalOffset
1383   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // VisibleOffset
1384   DeclEnumAbbrev = Stream.EmitAbbrev(Abv);
1385 
1386   // Abbreviation for DECL_RECORD
1387   Abv = new BitCodeAbbrev();
1388   Abv->Add(BitCodeAbbrevOp(serialization::DECL_RECORD));
1389   // Redeclarable
1390   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1391   // Decl
1392   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1393   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1394   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1395   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1396   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1397   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1398   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1399   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1400   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1401   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1402   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1403   // NamedDecl
1404   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1405   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1406   // TypeDecl
1407   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1408   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1409   // TagDecl
1410   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IdentifierNamespace
1411   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getTagKind
1412   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isCompleteDefinition
1413   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // EmbeddedInDeclarator
1414   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFreeStanding
1415   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // SourceLocation
1416   Abv->Add(BitCodeAbbrevOp(0));                         // hasExtInfo
1417   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // TypedefNameAnonDecl
1418   // RecordDecl
1419   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // FlexibleArrayMember
1420   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // AnonymousStructUnion
1421   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // hasObjectMember
1422   // DC
1423   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // LexicalOffset
1424   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // VisibleOffset
1425   DeclRecordAbbrev = Stream.EmitAbbrev(Abv);
1426 
1427   // Abbreviation for DECL_PARM_VAR
1428   Abv = new BitCodeAbbrev();
1429   Abv->Add(BitCodeAbbrevOp(serialization::DECL_PARM_VAR));
1430   // Redeclarable
1431   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1432   // Decl
1433   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1434   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1435   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1436   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1437   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1438   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1439   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1440   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1441   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1442   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1443   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1444   // NamedDecl
1445   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1446   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1447   // ValueDecl
1448   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1449   // DeclaratorDecl
1450   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1451   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1452   // VarDecl
1453   Abv->Add(BitCodeAbbrevOp(0));                       // StorageClass
1454   Abv->Add(BitCodeAbbrevOp(0));                       // StorageClassAsWritten
1455   Abv->Add(BitCodeAbbrevOp(0));                       // isThreadSpecified
1456   Abv->Add(BitCodeAbbrevOp(0));                       // hasCXXDirectInitializer
1457   Abv->Add(BitCodeAbbrevOp(0));                       // isExceptionVariable
1458   Abv->Add(BitCodeAbbrevOp(0));                       // isNRVOVariable
1459   Abv->Add(BitCodeAbbrevOp(0));                       // isCXXForRangeDecl
1460   Abv->Add(BitCodeAbbrevOp(0));                       // isARCPseudoStrong
1461   Abv->Add(BitCodeAbbrevOp(0));                       // HasInit
1462   Abv->Add(BitCodeAbbrevOp(0));                   // HasMemberSpecializationInfo
1463   // ParmVarDecl
1464   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsObjCMethodParameter
1465   Abv->Add(BitCodeAbbrevOp(0));                       // ScopeDepth
1466   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ScopeIndex
1467   Abv->Add(BitCodeAbbrevOp(0));                       // ObjCDeclQualifier
1468   Abv->Add(BitCodeAbbrevOp(0));                       // KNRPromoted
1469   Abv->Add(BitCodeAbbrevOp(0));                       // HasInheritedDefaultArg
1470   Abv->Add(BitCodeAbbrevOp(0));                   // HasUninstantiatedDefaultArg
1471   // Type Source Info
1472   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1473   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1474   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1475   DeclParmVarAbbrev = Stream.EmitAbbrev(Abv);
1476 
1477   // Abbreviation for DECL_TYPEDEF
1478   Abv = new BitCodeAbbrev();
1479   Abv->Add(BitCodeAbbrevOp(serialization::DECL_TYPEDEF));
1480   // Redeclarable
1481   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1482   // Decl
1483   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1484   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1485   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1486   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1487   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1488   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1489   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1490   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1491   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1492   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1493   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1494   // NamedDecl
1495   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1496   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1497   // TypeDecl
1498   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1499   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1500   // TypedefDecl
1501   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1502   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1503   DeclTypedefAbbrev = Stream.EmitAbbrev(Abv);
1504 
1505   // Abbreviation for DECL_VAR
1506   Abv = new BitCodeAbbrev();
1507   Abv->Add(BitCodeAbbrevOp(serialization::DECL_VAR));
1508   // Redeclarable
1509   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1510   // Decl
1511   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1512   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1513   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1514   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1515   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1516   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1517   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1518   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1519   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1520   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1521   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1522   // NamedDecl
1523   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1524   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1525   // ValueDecl
1526   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1527   // DeclaratorDecl
1528   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1529   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1530   // VarDecl
1531   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // StorageClass
1532   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // StorageClassAsWritten
1533   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isThreadSpecified
1534   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // CXXDirectInitializer
1535   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isExceptionVariable
1536   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isNRVOVariable
1537   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isCXXForRangeDecl
1538   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isARCPseudoStrong
1539   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // HasInit
1540   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // HasMemberSpecInfo
1541   // Type Source Info
1542   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1543   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1544   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1545   DeclVarAbbrev = Stream.EmitAbbrev(Abv);
1546 
1547   // Abbreviation for EXPR_DECL_REF
1548   Abv = new BitCodeAbbrev();
1549   Abv->Add(BitCodeAbbrevOp(serialization::EXPR_DECL_REF));
1550   //Stmt
1551   //Expr
1552   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1553   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1554   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1555   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1556   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1557   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1558   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1559   //DeclRefExpr
1560   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //HasQualifier
1561   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //GetDeclFound
1562   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ExplicitTemplateArgs
1563   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //HadMultipleCandidates
1564   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclRef
1565   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1566   DeclRefExprAbbrev = Stream.EmitAbbrev(Abv);
1567 
1568   // Abbreviation for EXPR_INTEGER_LITERAL
1569   Abv = new BitCodeAbbrev();
1570   Abv->Add(BitCodeAbbrevOp(serialization::EXPR_INTEGER_LITERAL));
1571   //Stmt
1572   //Expr
1573   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1574   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1575   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1576   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1577   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1578   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1579   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1580   //Integer Literal
1581   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1582   Abv->Add(BitCodeAbbrevOp(32));                      // Bit Width
1583   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Value
1584   IntegerLiteralAbbrev = Stream.EmitAbbrev(Abv);
1585 
1586   // Abbreviation for EXPR_CHARACTER_LITERAL
1587   Abv = new BitCodeAbbrev();
1588   Abv->Add(BitCodeAbbrevOp(serialization::EXPR_CHARACTER_LITERAL));
1589   //Stmt
1590   //Expr
1591   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1592   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1593   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1594   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1595   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1596   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1597   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1598   //Character Literal
1599   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // getValue
1600   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1601   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //IsWide
1602   CharacterLiteralAbbrev = Stream.EmitAbbrev(Abv);
1603 
1604   Abv = new BitCodeAbbrev();
1605   Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_LEXICAL));
1606   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1607   DeclContextLexicalAbbrev = Stream.EmitAbbrev(Abv);
1608 
1609   Abv = new BitCodeAbbrev();
1610   Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_VISIBLE));
1611   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1612   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1613   DeclContextVisibleLookupAbbrev = Stream.EmitAbbrev(Abv);
1614 }
1615 
1616 /// isRequiredDecl - Check if this is a "required" Decl, which must be seen by
1617 /// consumers of the AST.
1618 ///
1619 /// Such decls will always be deserialized from the AST file, so we would like
1620 /// this to be as restrictive as possible. Currently the predicate is driven by
1621 /// code generation requirements, if other clients have a different notion of
1622 /// what is "required" then we may have to consider an alternate scheme where
1623 /// clients can iterate over the top-level decls and get information on them,
1624 /// without necessary deserializing them. We could explicitly require such
1625 /// clients to use a separate API call to "realize" the decl. This should be
1626 /// relatively painless since they would presumably only do it for top-level
1627 /// decls.
1628 static bool isRequiredDecl(const Decl *D, ASTContext &Context) {
1629   // An ObjCMethodDecl is never considered as "required" because its
1630   // implementation container always is.
1631 
1632   // File scoped assembly or obj-c implementation must be seen.
1633   if (isa<FileScopeAsmDecl>(D) || isa<ObjCImplDecl>(D))
1634     return true;
1635 
1636   return Context.DeclMustBeEmitted(D);
1637 }
1638 
1639 void ASTWriter::WriteDecl(ASTContext &Context, Decl *D) {
1640   // Switch case IDs are per Decl.
1641   ClearSwitchCaseIDs();
1642 
1643   RecordData Record;
1644   ASTDeclWriter W(*this, Context, Record);
1645 
1646   // If this declaration is also a DeclContext, write blocks for the
1647   // declarations that lexically stored inside its context and those
1648   // declarations that are visible from its context. These blocks
1649   // are written before the declaration itself so that we can put
1650   // their offsets into the record for the declaration.
1651   uint64_t LexicalOffset = 0;
1652   uint64_t VisibleOffset = 0;
1653   DeclContext *DC = dyn_cast<DeclContext>(D);
1654   if (DC) {
1655     LexicalOffset = WriteDeclContextLexicalBlock(Context, DC);
1656     VisibleOffset = WriteDeclContextVisibleBlock(Context, DC);
1657   }
1658 
1659   // Determine the ID for this declaration.
1660   serialization::DeclID ID;
1661   if (D->isFromASTFile())
1662     ID = getDeclID(D);
1663   else {
1664     serialization::DeclID &IDR = DeclIDs[D];
1665     if (IDR == 0)
1666       IDR = NextDeclID++;
1667 
1668     ID= IDR;
1669   }
1670 
1671   if (ID < FirstDeclID) {
1672     // We're replacing a decl in a previous file.
1673     ReplacedDecls.push_back(ReplacedDeclInfo(ID, Stream.GetCurrentBitNo(),
1674                                              D->getLocation()));
1675   } else {
1676     unsigned Index = ID - FirstDeclID;
1677 
1678     // Record the offset for this declaration
1679     SourceLocation Loc = D->getLocation();
1680     if (DeclOffsets.size() == Index)
1681       DeclOffsets.push_back(DeclOffset(Loc, Stream.GetCurrentBitNo()));
1682     else if (DeclOffsets.size() < Index) {
1683       DeclOffsets.resize(Index+1);
1684       DeclOffsets[Index].setLocation(Loc);
1685       DeclOffsets[Index].BitOffset = Stream.GetCurrentBitNo();
1686     }
1687 
1688     SourceManager &SM = Context.getSourceManager();
1689     if (Loc.isValid() && SM.isLocalSourceLocation(Loc))
1690       associateDeclWithFile(D, ID);
1691   }
1692 
1693   // Build and emit a record for this declaration
1694   Record.clear();
1695   W.Code = (serialization::DeclCode)0;
1696   W.AbbrevToUse = 0;
1697   W.Visit(D);
1698   if (DC) W.VisitDeclContext(DC, LexicalOffset, VisibleOffset);
1699 
1700   if (!W.Code)
1701     llvm::report_fatal_error(StringRef("unexpected declaration kind '") +
1702                             D->getDeclKindName() + "'");
1703   Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
1704 
1705   // Flush any expressions that were written as part of this declaration.
1706   FlushStmts();
1707 
1708   // Flush C++ base specifiers, if there are any.
1709   FlushCXXBaseSpecifiers();
1710 
1711   // Note "external" declarations so that we can add them to a record in the
1712   // AST file later.
1713   //
1714   // FIXME: This should be renamed, the predicate is much more complicated.
1715   if (isRequiredDecl(D, Context))
1716     ExternalDefinitions.push_back(ID);
1717 }
1718