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.AddSourceLocation(D->getLParenLoc(), Record);
569   Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
570   // FIXME: stable encoding
571   Record.push_back((unsigned)D->getPropertyAttributes());
572   Record.push_back((unsigned)D->getPropertyAttributesAsWritten());
573   // FIXME: stable encoding
574   Record.push_back((unsigned)D->getPropertyImplementation());
575   Writer.AddDeclarationName(D->getGetterName(), Record);
576   Writer.AddDeclarationName(D->getSetterName(), Record);
577   Writer.AddDeclRef(D->getGetterMethodDecl(), Record);
578   Writer.AddDeclRef(D->getSetterMethodDecl(), Record);
579   Writer.AddDeclRef(D->getPropertyIvarDecl(), Record);
580   Code = serialization::DECL_OBJC_PROPERTY;
581 }
582 
583 void ASTDeclWriter::VisitObjCImplDecl(ObjCImplDecl *D) {
584   VisitObjCContainerDecl(D);
585   Writer.AddDeclRef(D->getClassInterface(), Record);
586   // Abstract class (no need to define a stable serialization::DECL code).
587 }
588 
589 void ASTDeclWriter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
590   VisitObjCImplDecl(D);
591   Writer.AddIdentifierRef(D->getIdentifier(), Record);
592   Writer.AddSourceLocation(D->getCategoryNameLoc(), Record);
593   Code = serialization::DECL_OBJC_CATEGORY_IMPL;
594 }
595 
596 void ASTDeclWriter::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
597   VisitObjCImplDecl(D);
598   Writer.AddDeclRef(D->getSuperClass(), Record);
599   Writer.AddSourceLocation(D->getIvarLBraceLoc(), Record);
600   Writer.AddSourceLocation(D->getIvarRBraceLoc(), 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->getInitStyle());
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->getFirstDeclaration() == D->getMostRecentDecl() &&
696       D->getInitStyle() == VarDecl::CInit &&
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->getInitStyle() == VarDecl::CInit && // Can params have anything else?
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   Record.push_back(D->isThisDeclarationADefinition());
909   if (D->isThisDeclarationADefinition())
910     Writer.AddCXXDefinitionData(D, Record);
911 
912   enum {
913     CXXRecNotTemplate = 0, CXXRecTemplate, CXXRecMemberSpecialization
914   };
915   if (ClassTemplateDecl *TemplD = D->getDescribedClassTemplate()) {
916     Record.push_back(CXXRecTemplate);
917     Writer.AddDeclRef(TemplD, Record);
918   } else if (MemberSpecializationInfo *MSInfo
919                = D->getMemberSpecializationInfo()) {
920     Record.push_back(CXXRecMemberSpecialization);
921     Writer.AddDeclRef(MSInfo->getInstantiatedFrom(), Record);
922     Record.push_back(MSInfo->getTemplateSpecializationKind());
923     Writer.AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
924   } else {
925     Record.push_back(CXXRecNotTemplate);
926   }
927 
928   // Store the key function to avoid deserializing every method so we can
929   // compute it.
930   if (D->IsCompleteDefinition)
931     Writer.AddDeclRef(Context.getKeyFunction(D), Record);
932 
933   Code = serialization::DECL_CXX_RECORD;
934 }
935 
936 void ASTDeclWriter::VisitCXXMethodDecl(CXXMethodDecl *D) {
937   VisitFunctionDecl(D);
938   Record.push_back(D->size_overridden_methods());
939   for (CXXMethodDecl::method_iterator
940          I = D->begin_overridden_methods(), E = D->end_overridden_methods();
941          I != E; ++I)
942     Writer.AddDeclRef(*I, Record);
943   Code = serialization::DECL_CXX_METHOD;
944 }
945 
946 void ASTDeclWriter::VisitCXXConstructorDecl(CXXConstructorDecl *D) {
947   VisitCXXMethodDecl(D);
948 
949   Record.push_back(D->IsExplicitSpecified);
950   Record.push_back(D->ImplicitlyDefined);
951   Writer.AddCXXCtorInitializers(D->CtorInitializers, D->NumCtorInitializers,
952                                 Record);
953 
954   Code = serialization::DECL_CXX_CONSTRUCTOR;
955 }
956 
957 void ASTDeclWriter::VisitCXXDestructorDecl(CXXDestructorDecl *D) {
958   VisitCXXMethodDecl(D);
959 
960   Record.push_back(D->ImplicitlyDefined);
961   Writer.AddDeclRef(D->OperatorDelete, Record);
962 
963   Code = serialization::DECL_CXX_DESTRUCTOR;
964 }
965 
966 void ASTDeclWriter::VisitCXXConversionDecl(CXXConversionDecl *D) {
967   VisitCXXMethodDecl(D);
968   Record.push_back(D->IsExplicitSpecified);
969   Code = serialization::DECL_CXX_CONVERSION;
970 }
971 
972 void ASTDeclWriter::VisitImportDecl(ImportDecl *D) {
973   VisitDecl(D);
974   ArrayRef<SourceLocation> IdentifierLocs = D->getIdentifierLocs();
975   Record.push_back(!IdentifierLocs.empty());
976   if (IdentifierLocs.empty()) {
977     Writer.AddSourceLocation(D->getLocEnd(), Record);
978     Record.push_back(1);
979   } else {
980     for (unsigned I = 0, N = IdentifierLocs.size(); I != N; ++I)
981       Writer.AddSourceLocation(IdentifierLocs[I], Record);
982     Record.push_back(IdentifierLocs.size());
983   }
984   // Note: the number of source locations must always be the last element in
985   // the record.
986   Code = serialization::DECL_IMPORT;
987 }
988 
989 void ASTDeclWriter::VisitAccessSpecDecl(AccessSpecDecl *D) {
990   VisitDecl(D);
991   Writer.AddSourceLocation(D->getColonLoc(), Record);
992   Code = serialization::DECL_ACCESS_SPEC;
993 }
994 
995 void ASTDeclWriter::VisitFriendDecl(FriendDecl *D) {
996   VisitDecl(D);
997   Record.push_back(D->Friend.is<TypeSourceInfo*>());
998   if (D->Friend.is<TypeSourceInfo*>())
999     Writer.AddTypeSourceInfo(D->Friend.get<TypeSourceInfo*>(), Record);
1000   else
1001     Writer.AddDeclRef(D->Friend.get<NamedDecl*>(), Record);
1002   Writer.AddDeclRef(D->getNextFriend(), Record);
1003   Record.push_back(D->UnsupportedFriend);
1004   Writer.AddSourceLocation(D->FriendLoc, Record);
1005   Code = serialization::DECL_FRIEND;
1006 }
1007 
1008 void ASTDeclWriter::VisitFriendTemplateDecl(FriendTemplateDecl *D) {
1009   VisitDecl(D);
1010   Record.push_back(D->getNumTemplateParameters());
1011   for (unsigned i = 0, e = D->getNumTemplateParameters(); i != e; ++i)
1012     Writer.AddTemplateParameterList(D->getTemplateParameterList(i), Record);
1013   Record.push_back(D->getFriendDecl() != 0);
1014   if (D->getFriendDecl())
1015     Writer.AddDeclRef(D->getFriendDecl(), Record);
1016   else
1017     Writer.AddTypeSourceInfo(D->getFriendType(), Record);
1018   Writer.AddSourceLocation(D->getFriendLoc(), Record);
1019   Code = serialization::DECL_FRIEND_TEMPLATE;
1020 }
1021 
1022 void ASTDeclWriter::VisitTemplateDecl(TemplateDecl *D) {
1023   VisitNamedDecl(D);
1024 
1025   Writer.AddDeclRef(D->getTemplatedDecl(), Record);
1026   Writer.AddTemplateParameterList(D->getTemplateParameters(), Record);
1027 }
1028 
1029 void ASTDeclWriter::VisitRedeclarableTemplateDecl(RedeclarableTemplateDecl *D) {
1030   VisitRedeclarable(D);
1031 
1032   // Emit data to initialize CommonOrPrev before VisitTemplateDecl so that
1033   // getCommonPtr() can be used while this is still initializing.
1034   if (D->isFirstDeclaration()) {
1035     // This declaration owns the 'common' pointer, so serialize that data now.
1036     Writer.AddDeclRef(D->getInstantiatedFromMemberTemplate(), Record);
1037     if (D->getInstantiatedFromMemberTemplate())
1038       Record.push_back(D->isMemberSpecialization());
1039   }
1040 
1041   VisitTemplateDecl(D);
1042   Record.push_back(D->getIdentifierNamespace());
1043 }
1044 
1045 void ASTDeclWriter::VisitClassTemplateDecl(ClassTemplateDecl *D) {
1046   VisitRedeclarableTemplateDecl(D);
1047 
1048   if (D->isFirstDeclaration()) {
1049     typedef llvm::FoldingSet<ClassTemplateSpecializationDecl> CTSDSetTy;
1050     CTSDSetTy &CTSDSet = D->getSpecializations();
1051     Record.push_back(CTSDSet.size());
1052     for (CTSDSetTy::iterator I=CTSDSet.begin(), E = CTSDSet.end(); I!=E; ++I) {
1053       assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
1054       Writer.AddDeclRef(&*I, Record);
1055     }
1056 
1057     typedef llvm::FoldingSet<ClassTemplatePartialSpecializationDecl> CTPSDSetTy;
1058     CTPSDSetTy &CTPSDSet = D->getPartialSpecializations();
1059     Record.push_back(CTPSDSet.size());
1060     for (CTPSDSetTy::iterator I=CTPSDSet.begin(), E=CTPSDSet.end(); I!=E; ++I) {
1061       assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
1062       Writer.AddDeclRef(&*I, Record);
1063     }
1064 
1065     // InjectedClassNameType is computed, no need to write it.
1066   }
1067   Code = serialization::DECL_CLASS_TEMPLATE;
1068 }
1069 
1070 void ASTDeclWriter::VisitClassTemplateSpecializationDecl(
1071                                            ClassTemplateSpecializationDecl *D) {
1072   VisitCXXRecordDecl(D);
1073 
1074   llvm::PointerUnion<ClassTemplateDecl *,
1075                      ClassTemplatePartialSpecializationDecl *> InstFrom
1076     = D->getSpecializedTemplateOrPartial();
1077   if (Decl *InstFromD = InstFrom.dyn_cast<ClassTemplateDecl *>()) {
1078     Writer.AddDeclRef(InstFromD, Record);
1079   } else {
1080     Writer.AddDeclRef(InstFrom.get<ClassTemplatePartialSpecializationDecl *>(),
1081                       Record);
1082     Writer.AddTemplateArgumentList(&D->getTemplateInstantiationArgs(), Record);
1083   }
1084 
1085   // Explicit info.
1086   Writer.AddTypeSourceInfo(D->getTypeAsWritten(), Record);
1087   if (D->getTypeAsWritten()) {
1088     Writer.AddSourceLocation(D->getExternLoc(), Record);
1089     Writer.AddSourceLocation(D->getTemplateKeywordLoc(), Record);
1090   }
1091 
1092   Writer.AddTemplateArgumentList(&D->getTemplateArgs(), Record);
1093   Writer.AddSourceLocation(D->getPointOfInstantiation(), Record);
1094   Record.push_back(D->getSpecializationKind());
1095 
1096   if (D->isCanonicalDecl()) {
1097     // When reading, we'll add it to the folding set of the following template.
1098     Writer.AddDeclRef(D->getSpecializedTemplate()->getCanonicalDecl(), Record);
1099   }
1100 
1101   Code = serialization::DECL_CLASS_TEMPLATE_SPECIALIZATION;
1102 }
1103 
1104 void ASTDeclWriter::VisitClassTemplatePartialSpecializationDecl(
1105                                     ClassTemplatePartialSpecializationDecl *D) {
1106   VisitClassTemplateSpecializationDecl(D);
1107 
1108   Writer.AddTemplateParameterList(D->getTemplateParameters(), Record);
1109 
1110   Record.push_back(D->getNumTemplateArgsAsWritten());
1111   for (int i = 0, e = D->getNumTemplateArgsAsWritten(); i != e; ++i)
1112     Writer.AddTemplateArgumentLoc(D->getTemplateArgsAsWritten()[i], Record);
1113 
1114   Record.push_back(D->getSequenceNumber());
1115 
1116   // These are read/set from/to the first declaration.
1117   if (D->getPreviousDecl() == 0) {
1118     Writer.AddDeclRef(D->getInstantiatedFromMember(), Record);
1119     Record.push_back(D->isMemberSpecialization());
1120   }
1121 
1122   Code = serialization::DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION;
1123 }
1124 
1125 void ASTDeclWriter::VisitClassScopeFunctionSpecializationDecl(
1126                                     ClassScopeFunctionSpecializationDecl *D) {
1127   VisitDecl(D);
1128   Writer.AddDeclRef(D->getSpecialization(), Record);
1129   Code = serialization::DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION;
1130 }
1131 
1132 
1133 void ASTDeclWriter::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
1134   VisitRedeclarableTemplateDecl(D);
1135 
1136   if (D->isFirstDeclaration()) {
1137     // This FunctionTemplateDecl owns the CommonPtr; write it.
1138 
1139     // Write the function specialization declarations.
1140     Record.push_back(D->getSpecializations().size());
1141     for (llvm::FoldingSet<FunctionTemplateSpecializationInfo>::iterator
1142            I = D->getSpecializations().begin(),
1143            E = D->getSpecializations().end()   ; I != E; ++I) {
1144       assert(I->Function->isCanonicalDecl() &&
1145              "Expected only canonical decls in set");
1146       Writer.AddDeclRef(I->Function, Record);
1147     }
1148   }
1149   Code = serialization::DECL_FUNCTION_TEMPLATE;
1150 }
1151 
1152 void ASTDeclWriter::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
1153   VisitTypeDecl(D);
1154 
1155   Record.push_back(D->wasDeclaredWithTypename());
1156   Record.push_back(D->defaultArgumentWasInherited());
1157   Writer.AddTypeSourceInfo(D->getDefaultArgumentInfo(), Record);
1158 
1159   Code = serialization::DECL_TEMPLATE_TYPE_PARM;
1160 }
1161 
1162 void ASTDeclWriter::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
1163   // For an expanded parameter pack, record the number of expansion types here
1164   // so that it's easier for
1165   if (D->isExpandedParameterPack())
1166     Record.push_back(D->getNumExpansionTypes());
1167 
1168   VisitDeclaratorDecl(D);
1169   // TemplateParmPosition.
1170   Record.push_back(D->getDepth());
1171   Record.push_back(D->getPosition());
1172 
1173   if (D->isExpandedParameterPack()) {
1174     for (unsigned I = 0, N = D->getNumExpansionTypes(); I != N; ++I) {
1175       Writer.AddTypeRef(D->getExpansionType(I), Record);
1176       Writer.AddTypeSourceInfo(D->getExpansionTypeSourceInfo(I), Record);
1177     }
1178 
1179     Code = serialization::DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK;
1180   } else {
1181     // Rest of NonTypeTemplateParmDecl.
1182     Record.push_back(D->isParameterPack());
1183     Record.push_back(D->getDefaultArgument() != 0);
1184     if (D->getDefaultArgument()) {
1185       Writer.AddStmt(D->getDefaultArgument());
1186       Record.push_back(D->defaultArgumentWasInherited());
1187     }
1188     Code = serialization::DECL_NON_TYPE_TEMPLATE_PARM;
1189   }
1190 }
1191 
1192 void ASTDeclWriter::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
1193   VisitTemplateDecl(D);
1194   // TemplateParmPosition.
1195   Record.push_back(D->getDepth());
1196   Record.push_back(D->getPosition());
1197   // Rest of TemplateTemplateParmDecl.
1198   Writer.AddTemplateArgumentLoc(D->getDefaultArgument(), Record);
1199   Record.push_back(D->defaultArgumentWasInherited());
1200   Record.push_back(D->isParameterPack());
1201   Code = serialization::DECL_TEMPLATE_TEMPLATE_PARM;
1202 }
1203 
1204 void ASTDeclWriter::VisitTypeAliasTemplateDecl(TypeAliasTemplateDecl *D) {
1205   VisitRedeclarableTemplateDecl(D);
1206   Code = serialization::DECL_TYPE_ALIAS_TEMPLATE;
1207 }
1208 
1209 void ASTDeclWriter::VisitStaticAssertDecl(StaticAssertDecl *D) {
1210   VisitDecl(D);
1211   Writer.AddStmt(D->getAssertExpr());
1212   Writer.AddStmt(D->getMessage());
1213   Writer.AddSourceLocation(D->getRParenLoc(), Record);
1214   Code = serialization::DECL_STATIC_ASSERT;
1215 }
1216 
1217 /// \brief Emit the DeclContext part of a declaration context decl.
1218 ///
1219 /// \param LexicalOffset the offset at which the DECL_CONTEXT_LEXICAL
1220 /// block for this declaration context is stored. May be 0 to indicate
1221 /// that there are no declarations stored within this context.
1222 ///
1223 /// \param VisibleOffset the offset at which the DECL_CONTEXT_VISIBLE
1224 /// block for this declaration context is stored. May be 0 to indicate
1225 /// that there are no declarations visible from this context. Note
1226 /// that this value will not be emitted for non-primary declaration
1227 /// contexts.
1228 void ASTDeclWriter::VisitDeclContext(DeclContext *DC, uint64_t LexicalOffset,
1229                                      uint64_t VisibleOffset) {
1230   Record.push_back(LexicalOffset);
1231   Record.push_back(VisibleOffset);
1232 }
1233 
1234 template <typename T>
1235 void ASTDeclWriter::VisitRedeclarable(Redeclarable<T> *D) {
1236   T *First = D->getFirstDeclaration();
1237   if (First->getMostRecentDecl() != First) {
1238     // There is more than one declaration of this entity, so we will need to
1239     // write a redeclaration chain.
1240     Writer.AddDeclRef(First, Record);
1241     Writer.Redeclarations.insert(First);
1242 
1243     // Make sure that we serialize both the previous and the most-recent
1244     // declarations, which (transitively) ensures that all declarations in the
1245     // chain get serialized.
1246     (void)Writer.GetDeclRef(D->getPreviousDecl());
1247     (void)Writer.GetDeclRef(First->getMostRecentDecl());
1248   } else {
1249     // We use the sentinel value 0 to indicate an only declaration.
1250     Record.push_back(0);
1251   }
1252 
1253 }
1254 
1255 //===----------------------------------------------------------------------===//
1256 // ASTWriter Implementation
1257 //===----------------------------------------------------------------------===//
1258 
1259 void ASTWriter::WriteDeclsBlockAbbrevs() {
1260   using namespace llvm;
1261 
1262   BitCodeAbbrev *Abv;
1263 
1264   // Abbreviation for DECL_FIELD
1265   Abv = new BitCodeAbbrev();
1266   Abv->Add(BitCodeAbbrevOp(serialization::DECL_FIELD));
1267   // Decl
1268   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1269   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1270   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1271   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1272   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1273   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1274   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1275   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1276   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2));  // AccessSpecifier
1277   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1278   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1279   // NamedDecl
1280   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1281   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1282   // ValueDecl
1283   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1284   // DeclaratorDecl
1285   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1286   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1287   // FieldDecl
1288   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isMutable
1289   Abv->Add(BitCodeAbbrevOp(0));                       //getBitWidth
1290   // Type Source Info
1291   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1292   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1293   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1294   DeclFieldAbbrev = Stream.EmitAbbrev(Abv);
1295 
1296   // Abbreviation for DECL_OBJC_IVAR
1297   Abv = new BitCodeAbbrev();
1298   Abv->Add(BitCodeAbbrevOp(serialization::DECL_OBJC_IVAR));
1299   // Decl
1300   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1301   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1302   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1303   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1304   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1305   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1306   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1307   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1308   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2));  // AccessSpecifier
1309   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1310   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1311   // NamedDecl
1312   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1313   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1314   // ValueDecl
1315   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1316   // DeclaratorDecl
1317   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1318   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1319   // FieldDecl
1320   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isMutable
1321   Abv->Add(BitCodeAbbrevOp(0));                       //getBitWidth
1322   // ObjC Ivar
1323   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // getAccessControl
1324   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // getSynthesize
1325   // Type Source Info
1326   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1327   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1328   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1329   DeclObjCIvarAbbrev = Stream.EmitAbbrev(Abv);
1330 
1331   // Abbreviation for DECL_ENUM
1332   Abv = new BitCodeAbbrev();
1333   Abv->Add(BitCodeAbbrevOp(serialization::DECL_ENUM));
1334   // Redeclarable
1335   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1336   // Decl
1337   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1338   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1339   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1340   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1341   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1342   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1343   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1344   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1345   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1346   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1347   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1348   // NamedDecl
1349   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1350   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1351   // TypeDecl
1352   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1353   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1354   // TagDecl
1355   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IdentifierNamespace
1356   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getTagKind
1357   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isCompleteDefinition
1358   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // EmbeddedInDeclarator
1359   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFreeStanding
1360   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // SourceLocation
1361   Abv->Add(BitCodeAbbrevOp(0));                         // hasExtInfo
1362   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // TypedefNameAnonDecl
1363   // EnumDecl
1364   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // AddTypeRef
1365   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IntegerType
1366   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getPromotionType
1367   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getNumPositiveBits
1368   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getNumNegativeBits
1369   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isScoped
1370   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isScopedUsingClassTag
1371   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isFixed
1372   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // InstantiatedMembEnum
1373   // DC
1374   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // LexicalOffset
1375   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // VisibleOffset
1376   DeclEnumAbbrev = Stream.EmitAbbrev(Abv);
1377 
1378   // Abbreviation for DECL_RECORD
1379   Abv = new BitCodeAbbrev();
1380   Abv->Add(BitCodeAbbrevOp(serialization::DECL_RECORD));
1381   // Redeclarable
1382   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1383   // Decl
1384   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1385   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1386   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1387   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1388   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1389   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1390   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1391   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1392   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1393   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1394   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1395   // NamedDecl
1396   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1397   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1398   // TypeDecl
1399   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1400   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1401   // TagDecl
1402   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IdentifierNamespace
1403   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getTagKind
1404   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isCompleteDefinition
1405   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // EmbeddedInDeclarator
1406   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFreeStanding
1407   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // SourceLocation
1408   Abv->Add(BitCodeAbbrevOp(0));                         // hasExtInfo
1409   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // TypedefNameAnonDecl
1410   // RecordDecl
1411   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // FlexibleArrayMember
1412   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // AnonymousStructUnion
1413   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // hasObjectMember
1414   // DC
1415   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // LexicalOffset
1416   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // VisibleOffset
1417   DeclRecordAbbrev = Stream.EmitAbbrev(Abv);
1418 
1419   // Abbreviation for DECL_PARM_VAR
1420   Abv = new BitCodeAbbrev();
1421   Abv->Add(BitCodeAbbrevOp(serialization::DECL_PARM_VAR));
1422   // Redeclarable
1423   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1424   // Decl
1425   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1426   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1427   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1428   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1429   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1430   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1431   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1432   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1433   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1434   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1435   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1436   // NamedDecl
1437   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1438   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1439   // ValueDecl
1440   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1441   // DeclaratorDecl
1442   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1443   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1444   // VarDecl
1445   Abv->Add(BitCodeAbbrevOp(0));                       // StorageClass
1446   Abv->Add(BitCodeAbbrevOp(0));                       // StorageClassAsWritten
1447   Abv->Add(BitCodeAbbrevOp(0));                       // isThreadSpecified
1448   Abv->Add(BitCodeAbbrevOp(0));                       // hasCXXDirectInitializer
1449   Abv->Add(BitCodeAbbrevOp(0));                       // isExceptionVariable
1450   Abv->Add(BitCodeAbbrevOp(0));                       // isNRVOVariable
1451   Abv->Add(BitCodeAbbrevOp(0));                       // isCXXForRangeDecl
1452   Abv->Add(BitCodeAbbrevOp(0));                       // isARCPseudoStrong
1453   Abv->Add(BitCodeAbbrevOp(0));                       // HasInit
1454   Abv->Add(BitCodeAbbrevOp(0));                   // HasMemberSpecializationInfo
1455   // ParmVarDecl
1456   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsObjCMethodParameter
1457   Abv->Add(BitCodeAbbrevOp(0));                       // ScopeDepth
1458   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ScopeIndex
1459   Abv->Add(BitCodeAbbrevOp(0));                       // ObjCDeclQualifier
1460   Abv->Add(BitCodeAbbrevOp(0));                       // KNRPromoted
1461   Abv->Add(BitCodeAbbrevOp(0));                       // HasInheritedDefaultArg
1462   Abv->Add(BitCodeAbbrevOp(0));                   // HasUninstantiatedDefaultArg
1463   // Type Source Info
1464   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1465   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1466   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1467   DeclParmVarAbbrev = Stream.EmitAbbrev(Abv);
1468 
1469   // Abbreviation for DECL_TYPEDEF
1470   Abv = new BitCodeAbbrev();
1471   Abv->Add(BitCodeAbbrevOp(serialization::DECL_TYPEDEF));
1472   // Redeclarable
1473   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1474   // Decl
1475   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1476   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1477   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1478   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1479   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1480   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1481   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1482   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1483   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1484   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1485   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1486   // NamedDecl
1487   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1488   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1489   // TypeDecl
1490   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1491   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1492   // TypedefDecl
1493   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1494   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1495   DeclTypedefAbbrev = Stream.EmitAbbrev(Abv);
1496 
1497   // Abbreviation for DECL_VAR
1498   Abv = new BitCodeAbbrev();
1499   Abv->Add(BitCodeAbbrevOp(serialization::DECL_VAR));
1500   // Redeclarable
1501   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1502   // Decl
1503   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1504   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1505   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1506   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1507   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1508   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1509   Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1510   Abv->Add(BitCodeAbbrevOp(0));                   // TopLevelDeclInObjCContainer
1511   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1512   Abv->Add(BitCodeAbbrevOp(0));                       // ModulePrivate
1513   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // SubmoduleID
1514   // NamedDecl
1515   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1516   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1517   // ValueDecl
1518   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1519   // DeclaratorDecl
1520   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1521   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1522   // VarDecl
1523   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // StorageClass
1524   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // StorageClassAsWritten
1525   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isThreadSpecified
1526   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // CXXDirectInitializer
1527   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isExceptionVariable
1528   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isNRVOVariable
1529   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isCXXForRangeDecl
1530   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isARCPseudoStrong
1531   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // HasInit
1532   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // HasMemberSpecInfo
1533   // Type Source Info
1534   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1535   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1536   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1537   DeclVarAbbrev = Stream.EmitAbbrev(Abv);
1538 
1539   // Abbreviation for EXPR_DECL_REF
1540   Abv = new BitCodeAbbrev();
1541   Abv->Add(BitCodeAbbrevOp(serialization::EXPR_DECL_REF));
1542   //Stmt
1543   //Expr
1544   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1545   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1546   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1547   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1548   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1549   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1550   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1551   //DeclRefExpr
1552   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //HasQualifier
1553   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //GetDeclFound
1554   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ExplicitTemplateArgs
1555   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //HadMultipleCandidates
1556   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclRef
1557   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1558   DeclRefExprAbbrev = Stream.EmitAbbrev(Abv);
1559 
1560   // Abbreviation for EXPR_INTEGER_LITERAL
1561   Abv = new BitCodeAbbrev();
1562   Abv->Add(BitCodeAbbrevOp(serialization::EXPR_INTEGER_LITERAL));
1563   //Stmt
1564   //Expr
1565   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1566   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1567   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1568   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1569   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1570   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1571   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1572   //Integer Literal
1573   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1574   Abv->Add(BitCodeAbbrevOp(32));                      // Bit Width
1575   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Value
1576   IntegerLiteralAbbrev = Stream.EmitAbbrev(Abv);
1577 
1578   // Abbreviation for EXPR_CHARACTER_LITERAL
1579   Abv = new BitCodeAbbrev();
1580   Abv->Add(BitCodeAbbrevOp(serialization::EXPR_CHARACTER_LITERAL));
1581   //Stmt
1582   //Expr
1583   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1584   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1585   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1586   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1587   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1588   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1589   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1590   //Character Literal
1591   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // getValue
1592   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1593   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //IsWide
1594   CharacterLiteralAbbrev = Stream.EmitAbbrev(Abv);
1595 
1596   Abv = new BitCodeAbbrev();
1597   Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_LEXICAL));
1598   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1599   DeclContextLexicalAbbrev = Stream.EmitAbbrev(Abv);
1600 
1601   Abv = new BitCodeAbbrev();
1602   Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_VISIBLE));
1603   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1604   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1605   DeclContextVisibleLookupAbbrev = Stream.EmitAbbrev(Abv);
1606 }
1607 
1608 /// isRequiredDecl - Check if this is a "required" Decl, which must be seen by
1609 /// consumers of the AST.
1610 ///
1611 /// Such decls will always be deserialized from the AST file, so we would like
1612 /// this to be as restrictive as possible. Currently the predicate is driven by
1613 /// code generation requirements, if other clients have a different notion of
1614 /// what is "required" then we may have to consider an alternate scheme where
1615 /// clients can iterate over the top-level decls and get information on them,
1616 /// without necessary deserializing them. We could explicitly require such
1617 /// clients to use a separate API call to "realize" the decl. This should be
1618 /// relatively painless since they would presumably only do it for top-level
1619 /// decls.
1620 static bool isRequiredDecl(const Decl *D, ASTContext &Context) {
1621   // An ObjCMethodDecl is never considered as "required" because its
1622   // implementation container always is.
1623 
1624   // File scoped assembly or obj-c implementation must be seen.
1625   if (isa<FileScopeAsmDecl>(D) || isa<ObjCImplDecl>(D))
1626     return true;
1627 
1628   return Context.DeclMustBeEmitted(D);
1629 }
1630 
1631 void ASTWriter::WriteDecl(ASTContext &Context, Decl *D) {
1632   // Switch case IDs are per Decl.
1633   ClearSwitchCaseIDs();
1634 
1635   RecordData Record;
1636   ASTDeclWriter W(*this, Context, Record);
1637 
1638   // If this declaration is also a DeclContext, write blocks for the
1639   // declarations that lexically stored inside its context and those
1640   // declarations that are visible from its context. These blocks
1641   // are written before the declaration itself so that we can put
1642   // their offsets into the record for the declaration.
1643   uint64_t LexicalOffset = 0;
1644   uint64_t VisibleOffset = 0;
1645   DeclContext *DC = dyn_cast<DeclContext>(D);
1646   if (DC) {
1647     LexicalOffset = WriteDeclContextLexicalBlock(Context, DC);
1648     VisibleOffset = WriteDeclContextVisibleBlock(Context, DC);
1649   }
1650 
1651   // Determine the ID for this declaration.
1652   serialization::DeclID ID;
1653   if (D->isFromASTFile())
1654     ID = getDeclID(D);
1655   else {
1656     serialization::DeclID &IDR = DeclIDs[D];
1657     if (IDR == 0)
1658       IDR = NextDeclID++;
1659 
1660     ID= IDR;
1661   }
1662 
1663   if (ID < FirstDeclID) {
1664     // We're replacing a decl in a previous file.
1665     ReplacedDecls.push_back(ReplacedDeclInfo(ID, Stream.GetCurrentBitNo(),
1666                                              D->getLocation()));
1667   } else {
1668     unsigned Index = ID - FirstDeclID;
1669 
1670     // Record the offset for this declaration
1671     SourceLocation Loc = D->getLocation();
1672     if (DeclOffsets.size() == Index)
1673       DeclOffsets.push_back(DeclOffset(Loc, Stream.GetCurrentBitNo()));
1674     else if (DeclOffsets.size() < Index) {
1675       DeclOffsets.resize(Index+1);
1676       DeclOffsets[Index].setLocation(Loc);
1677       DeclOffsets[Index].BitOffset = Stream.GetCurrentBitNo();
1678     }
1679 
1680     SourceManager &SM = Context.getSourceManager();
1681     if (Loc.isValid() && SM.isLocalSourceLocation(Loc))
1682       associateDeclWithFile(D, ID);
1683   }
1684 
1685   // Build and emit a record for this declaration
1686   Record.clear();
1687   W.Code = (serialization::DeclCode)0;
1688   W.AbbrevToUse = 0;
1689   W.Visit(D);
1690   if (DC) W.VisitDeclContext(DC, LexicalOffset, VisibleOffset);
1691 
1692   if (!W.Code)
1693     llvm::report_fatal_error(StringRef("unexpected declaration kind '") +
1694                             D->getDeclKindName() + "'");
1695   Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
1696 
1697   // Flush any expressions that were written as part of this declaration.
1698   FlushStmts();
1699 
1700   // Flush C++ base specifiers, if there are any.
1701   FlushCXXBaseSpecifiers();
1702 
1703   // Note "external" declarations so that we can add them to a record in the
1704   // AST file later.
1705   //
1706   // FIXME: This should be renamed, the predicate is much more complicated.
1707   if (isRequiredDecl(D, Context))
1708     ExternalDefinitions.push_back(ID);
1709 }
1710