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