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