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