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