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 "clang/AST/DeclVisitor.h"
16 #include "clang/AST/DeclCXX.h"
17 #include "clang/AST/DeclTemplate.h"
18 #include "clang/AST/Expr.h"
19 #include "clang/AST/DeclContextInternals.h"
20 #include "llvm/ADT/Twine.h"
21 #include "llvm/Bitcode/BitstreamWriter.h"
22 #include "llvm/Support/ErrorHandling.h"
23 using namespace clang;
24 
25 //===----------------------------------------------------------------------===//
26 // Declaration serialization
27 //===----------------------------------------------------------------------===//
28 
29 namespace clang {
30   class ASTDeclWriter : public DeclVisitor<ASTDeclWriter, void> {
31 
32     ASTWriter &Writer;
33     ASTContext &Context;
34     typedef ASTWriter::RecordData RecordData;
35     RecordData &Record;
36 
37   public:
38     serialization::DeclCode Code;
39     unsigned AbbrevToUse;
40 
41     ASTDeclWriter(ASTWriter &Writer, ASTContext &Context, RecordData &Record)
42       : Writer(Writer), Context(Context), Record(Record) {
43     }
44 
45     void Visit(Decl *D);
46 
47     void VisitDecl(Decl *D);
48     void VisitTranslationUnitDecl(TranslationUnitDecl *D);
49     void VisitNamedDecl(NamedDecl *D);
50     void VisitLabelDecl(LabelDecl *LD);
51     void VisitNamespaceDecl(NamespaceDecl *D);
52     void VisitUsingDirectiveDecl(UsingDirectiveDecl *D);
53     void VisitNamespaceAliasDecl(NamespaceAliasDecl *D);
54     void VisitTypeDecl(TypeDecl *D);
55     void VisitTypedefDecl(TypedefDecl *D);
56     void VisitTypeAliasDecl(TypeAliasDecl *D);
57     void VisitUnresolvedUsingTypenameDecl(UnresolvedUsingTypenameDecl *D);
58     void VisitTagDecl(TagDecl *D);
59     void VisitEnumDecl(EnumDecl *D);
60     void VisitRecordDecl(RecordDecl *D);
61     void VisitCXXRecordDecl(CXXRecordDecl *D);
62     void VisitClassTemplateSpecializationDecl(
63                                             ClassTemplateSpecializationDecl *D);
64     void VisitClassTemplatePartialSpecializationDecl(
65                                      ClassTemplatePartialSpecializationDecl *D);
66     void VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D);
67     void VisitValueDecl(ValueDecl *D);
68     void VisitEnumConstantDecl(EnumConstantDecl *D);
69     void VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D);
70     void VisitDeclaratorDecl(DeclaratorDecl *D);
71     void VisitFunctionDecl(FunctionDecl *D);
72     void VisitCXXMethodDecl(CXXMethodDecl *D);
73     void VisitCXXConstructorDecl(CXXConstructorDecl *D);
74     void VisitCXXDestructorDecl(CXXDestructorDecl *D);
75     void VisitCXXConversionDecl(CXXConversionDecl *D);
76     void VisitFieldDecl(FieldDecl *D);
77     void VisitIndirectFieldDecl(IndirectFieldDecl *D);
78     void VisitVarDecl(VarDecl *D);
79     void VisitImplicitParamDecl(ImplicitParamDecl *D);
80     void VisitParmVarDecl(ParmVarDecl *D);
81     void VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D);
82     void VisitTemplateDecl(TemplateDecl *D);
83     void VisitRedeclarableTemplateDecl(RedeclarableTemplateDecl *D);
84     void VisitClassTemplateDecl(ClassTemplateDecl *D);
85     void VisitFunctionTemplateDecl(FunctionTemplateDecl *D);
86     void VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D);
87     void VisitUsingDecl(UsingDecl *D);
88     void VisitUsingShadowDecl(UsingShadowDecl *D);
89     void VisitLinkageSpecDecl(LinkageSpecDecl *D);
90     void VisitFileScopeAsmDecl(FileScopeAsmDecl *D);
91     void VisitAccessSpecDecl(AccessSpecDecl *D);
92     void VisitFriendDecl(FriendDecl *D);
93     void VisitFriendTemplateDecl(FriendTemplateDecl *D);
94     void VisitStaticAssertDecl(StaticAssertDecl *D);
95     void VisitBlockDecl(BlockDecl *D);
96 
97     void VisitDeclContext(DeclContext *DC, uint64_t LexicalOffset,
98                           uint64_t VisibleOffset);
99     template <typename T> void VisitRedeclarable(Redeclarable<T> *D);
100 
101 
102     // FIXME: Put in the same order is DeclNodes.td?
103     void VisitObjCMethodDecl(ObjCMethodDecl *D);
104     void VisitObjCContainerDecl(ObjCContainerDecl *D);
105     void VisitObjCInterfaceDecl(ObjCInterfaceDecl *D);
106     void VisitObjCIvarDecl(ObjCIvarDecl *D);
107     void VisitObjCProtocolDecl(ObjCProtocolDecl *D);
108     void VisitObjCAtDefsFieldDecl(ObjCAtDefsFieldDecl *D);
109     void VisitObjCClassDecl(ObjCClassDecl *D);
110     void VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D);
111     void VisitObjCCategoryDecl(ObjCCategoryDecl *D);
112     void VisitObjCImplDecl(ObjCImplDecl *D);
113     void VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D);
114     void VisitObjCImplementationDecl(ObjCImplementationDecl *D);
115     void VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D);
116     void VisitObjCPropertyDecl(ObjCPropertyDecl *D);
117     void VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D);
118   };
119 }
120 
121 void ASTDeclWriter::Visit(Decl *D) {
122   DeclVisitor<ASTDeclWriter>::Visit(D);
123 
124   // Handle FunctionDecl's body here and write it after all other Stmts/Exprs
125   // have been written. We want it last because we will not read it back when
126   // retrieving it from the AST, we'll just lazily set the offset.
127   if (FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) {
128     Record.push_back(FD->isThisDeclarationADefinition());
129     if (FD->isThisDeclarationADefinition())
130       Writer.AddStmt(FD->getBody());
131   }
132 }
133 
134 void ASTDeclWriter::VisitDecl(Decl *D) {
135   Writer.AddDeclRef(cast_or_null<Decl>(D->getDeclContext()), Record);
136   Writer.AddDeclRef(cast_or_null<Decl>(D->getLexicalDeclContext()), Record);
137   Writer.AddSourceLocation(D->getLocation(), Record);
138   Record.push_back(D->isInvalidDecl());
139   Record.push_back(D->hasAttrs());
140   if (D->hasAttrs())
141     Writer.WriteAttributes(D->getAttrs(), Record);
142   Record.push_back(D->isImplicit());
143   Record.push_back(D->isUsed(false));
144   Record.push_back(D->getAccess());
145   Record.push_back(D->getPCHLevel());
146 }
147 
148 void ASTDeclWriter::VisitTranslationUnitDecl(TranslationUnitDecl *D) {
149   VisitDecl(D);
150   Writer.AddDeclRef(D->getAnonymousNamespace(), Record);
151   Code = serialization::DECL_TRANSLATION_UNIT;
152 }
153 
154 void ASTDeclWriter::VisitNamedDecl(NamedDecl *D) {
155   VisitDecl(D);
156   Writer.AddDeclarationName(D->getDeclName(), Record);
157 }
158 
159 void ASTDeclWriter::VisitTypeDecl(TypeDecl *D) {
160   VisitNamedDecl(D);
161   Writer.AddSourceLocation(D->getLocStart(), Record);
162   Writer.AddTypeRef(QualType(D->getTypeForDecl(), 0), Record);
163 }
164 
165 void ASTDeclWriter::VisitTypedefDecl(TypedefDecl *D) {
166   VisitTypeDecl(D);
167   Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
168   Code = serialization::DECL_TYPEDEF;
169 }
170 
171 void ASTDeclWriter::VisitTypeAliasDecl(TypeAliasDecl *D) {
172   VisitTypeDecl(D);
173   Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
174   Code = serialization::DECL_TYPEALIAS;
175 }
176 
177 void ASTDeclWriter::VisitTagDecl(TagDecl *D) {
178   VisitTypeDecl(D);
179   VisitRedeclarable(D);
180   Record.push_back(D->getIdentifierNamespace());
181   Record.push_back((unsigned)D->getTagKind()); // FIXME: stable encoding
182   Record.push_back(D->isDefinition());
183   Record.push_back(D->isEmbeddedInDeclarator());
184   Writer.AddSourceLocation(D->getRBraceLoc(), Record);
185   Record.push_back(D->hasExtInfo());
186   if (D->hasExtInfo())
187     Writer.AddQualifierInfo(*D->getExtInfo(), Record);
188   else
189     Writer.AddDeclRef(D->getTypedefNameForAnonDecl(), Record);
190 }
191 
192 void ASTDeclWriter::VisitEnumDecl(EnumDecl *D) {
193   VisitTagDecl(D);
194   Writer.AddTypeSourceInfo(D->getIntegerTypeSourceInfo(), Record);
195   if (!D->getIntegerTypeSourceInfo())
196     Writer.AddTypeRef(D->getIntegerType(), Record);
197   Writer.AddTypeRef(D->getPromotionType(), Record);
198   Record.push_back(D->getNumPositiveBits());
199   Record.push_back(D->getNumNegativeBits());
200   Record.push_back(D->isScoped());
201   Record.push_back(D->isScopedUsingClassTag());
202   Record.push_back(D->isFixed());
203   Writer.AddDeclRef(D->getInstantiatedFromMemberEnum(), Record);
204   Code = serialization::DECL_ENUM;
205 }
206 
207 void ASTDeclWriter::VisitRecordDecl(RecordDecl *D) {
208   VisitTagDecl(D);
209   Record.push_back(D->hasFlexibleArrayMember());
210   Record.push_back(D->isAnonymousStructOrUnion());
211   Record.push_back(D->hasObjectMember());
212   Code = serialization::DECL_RECORD;
213 }
214 
215 void ASTDeclWriter::VisitValueDecl(ValueDecl *D) {
216   VisitNamedDecl(D);
217   Writer.AddTypeRef(D->getType(), Record);
218 }
219 
220 void ASTDeclWriter::VisitEnumConstantDecl(EnumConstantDecl *D) {
221   VisitValueDecl(D);
222   Record.push_back(D->getInitExpr()? 1 : 0);
223   if (D->getInitExpr())
224     Writer.AddStmt(D->getInitExpr());
225   Writer.AddAPSInt(D->getInitVal(), Record);
226   Code = serialization::DECL_ENUM_CONSTANT;
227 }
228 
229 void ASTDeclWriter::VisitDeclaratorDecl(DeclaratorDecl *D) {
230   VisitValueDecl(D);
231   Writer.AddSourceLocation(D->getInnerLocStart(), Record);
232   Record.push_back(D->hasExtInfo());
233   if (D->hasExtInfo())
234     Writer.AddQualifierInfo(*D->getExtInfo(), Record);
235   Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
236 }
237 
238 void ASTDeclWriter::VisitFunctionDecl(FunctionDecl *D) {
239   VisitDeclaratorDecl(D);
240   VisitRedeclarable(D);
241 
242   Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
243   Record.push_back(D->getIdentifierNamespace());
244   Record.push_back(D->getTemplatedKind());
245   switch (D->getTemplatedKind()) {
246   default: assert(false && "Unhandled TemplatedKind!");
247     break;
248   case FunctionDecl::TK_NonTemplate:
249     break;
250   case FunctionDecl::TK_FunctionTemplate:
251     Writer.AddDeclRef(D->getDescribedFunctionTemplate(), Record);
252     break;
253   case FunctionDecl::TK_MemberSpecialization: {
254     MemberSpecializationInfo *MemberInfo = D->getMemberSpecializationInfo();
255     Writer.AddDeclRef(MemberInfo->getInstantiatedFrom(), Record);
256     Record.push_back(MemberInfo->getTemplateSpecializationKind());
257     Writer.AddSourceLocation(MemberInfo->getPointOfInstantiation(), Record);
258     break;
259   }
260   case FunctionDecl::TK_FunctionTemplateSpecialization: {
261     FunctionTemplateSpecializationInfo *
262       FTSInfo = D->getTemplateSpecializationInfo();
263     Writer.AddDeclRef(FTSInfo->getTemplate(), Record);
264     Record.push_back(FTSInfo->getTemplateSpecializationKind());
265 
266     // Template arguments.
267     Writer.AddTemplateArgumentList(FTSInfo->TemplateArguments, Record);
268 
269     // Template args as written.
270     Record.push_back(FTSInfo->TemplateArgumentsAsWritten != 0);
271     if (FTSInfo->TemplateArgumentsAsWritten) {
272       Record.push_back(FTSInfo->TemplateArgumentsAsWritten->size());
273       for (int i=0, e = FTSInfo->TemplateArgumentsAsWritten->size(); i!=e; ++i)
274         Writer.AddTemplateArgumentLoc((*FTSInfo->TemplateArgumentsAsWritten)[i],
275                                       Record);
276       Writer.AddSourceLocation(FTSInfo->TemplateArgumentsAsWritten->getLAngleLoc(),
277                                Record);
278       Writer.AddSourceLocation(FTSInfo->TemplateArgumentsAsWritten->getRAngleLoc(),
279                                Record);
280     }
281 
282     Writer.AddSourceLocation(FTSInfo->getPointOfInstantiation(), Record);
283 
284     if (D->isCanonicalDecl()) {
285       // Write the template that contains the specializations set. We will
286       // add a FunctionTemplateSpecializationInfo to it when reading.
287       Writer.AddDeclRef(FTSInfo->getTemplate()->getCanonicalDecl(), Record);
288     }
289     break;
290   }
291   case FunctionDecl::TK_DependentFunctionTemplateSpecialization: {
292     DependentFunctionTemplateSpecializationInfo *
293       DFTSInfo = D->getDependentSpecializationInfo();
294 
295     // Templates.
296     Record.push_back(DFTSInfo->getNumTemplates());
297     for (int i=0, e = DFTSInfo->getNumTemplates(); i != e; ++i)
298       Writer.AddDeclRef(DFTSInfo->getTemplate(i), Record);
299 
300     // Templates args.
301     Record.push_back(DFTSInfo->getNumTemplateArgs());
302     for (int i=0, e = DFTSInfo->getNumTemplateArgs(); i != e; ++i)
303       Writer.AddTemplateArgumentLoc(DFTSInfo->getTemplateArg(i), Record);
304     Writer.AddSourceLocation(DFTSInfo->getLAngleLoc(), Record);
305     Writer.AddSourceLocation(DFTSInfo->getRAngleLoc(), Record);
306     break;
307   }
308   }
309 
310   // FunctionDecl's body is handled last at ASTWriterDecl::Visit,
311   // after everything else is written.
312 
313   Record.push_back(D->getStorageClass()); // FIXME: stable encoding
314   Record.push_back(D->getStorageClassAsWritten());
315   Record.push_back(D->IsInline);
316   Record.push_back(D->isInlineSpecified());
317   Record.push_back(D->isVirtualAsWritten());
318   Record.push_back(D->isPure());
319   Record.push_back(D->hasInheritedPrototype());
320   Record.push_back(D->hasWrittenPrototype());
321   Record.push_back(D->isDeleted());
322   Record.push_back(D->isTrivial());
323   Record.push_back(D->hasImplicitReturnZero());
324   Writer.AddSourceLocation(D->getLocEnd(), Record);
325 
326   Record.push_back(D->param_size());
327   for (FunctionDecl::param_iterator P = D->param_begin(), PEnd = D->param_end();
328        P != PEnd; ++P)
329     Writer.AddDeclRef(*P, Record);
330   Code = serialization::DECL_FUNCTION;
331 }
332 
333 void ASTDeclWriter::VisitObjCMethodDecl(ObjCMethodDecl *D) {
334   VisitNamedDecl(D);
335   // FIXME: convert to LazyStmtPtr?
336   // Unlike C/C++, method bodies will never be in header files.
337   bool HasBodyStuff = D->getBody() != 0     ||
338                       D->getSelfDecl() != 0 || D->getCmdDecl() != 0;
339   Record.push_back(HasBodyStuff);
340   if (HasBodyStuff) {
341     Writer.AddStmt(D->getBody());
342     Writer.AddDeclRef(D->getSelfDecl(), Record);
343     Writer.AddDeclRef(D->getCmdDecl(), Record);
344   }
345   Record.push_back(D->isInstanceMethod());
346   Record.push_back(D->isVariadic());
347   Record.push_back(D->isSynthesized());
348   Record.push_back(D->isDefined());
349   // FIXME: stable encoding for @required/@optional
350   Record.push_back(D->getImplementationControl());
351   // FIXME: stable encoding for in/out/inout/bycopy/byref/oneway
352   Record.push_back(D->getObjCDeclQualifier());
353   Record.push_back(D->getNumSelectorArgs());
354   Writer.AddTypeRef(D->getResultType(), Record);
355   Writer.AddTypeSourceInfo(D->getResultTypeSourceInfo(), Record);
356   Writer.AddSourceLocation(D->getLocEnd(), Record);
357   Record.push_back(D->param_size());
358   for (ObjCMethodDecl::param_iterator P = D->param_begin(),
359                                    PEnd = D->param_end(); P != PEnd; ++P)
360     Writer.AddDeclRef(*P, Record);
361   Code = serialization::DECL_OBJC_METHOD;
362 }
363 
364 void ASTDeclWriter::VisitObjCContainerDecl(ObjCContainerDecl *D) {
365   VisitNamedDecl(D);
366   Writer.AddSourceRange(D->getAtEndRange(), Record);
367   // Abstract class (no need to define a stable serialization::DECL code).
368 }
369 
370 void ASTDeclWriter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
371   VisitObjCContainerDecl(D);
372   Writer.AddTypeRef(QualType(D->getTypeForDecl(), 0), Record);
373   Writer.AddDeclRef(D->getSuperClass(), Record);
374 
375   // Write out the protocols that are directly referenced by the @interface.
376   Record.push_back(D->ReferencedProtocols.size());
377   for (ObjCInterfaceDecl::protocol_iterator P = D->protocol_begin(),
378          PEnd = D->protocol_end();
379        P != PEnd; ++P)
380     Writer.AddDeclRef(*P, Record);
381   for (ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin(),
382          PLEnd = D->protocol_loc_end();
383        PL != PLEnd; ++PL)
384     Writer.AddSourceLocation(*PL, Record);
385 
386   // Write out the protocols that are transitively referenced.
387   Record.push_back(D->AllReferencedProtocols.size());
388   for (ObjCList<ObjCProtocolDecl>::iterator
389         P = D->AllReferencedProtocols.begin(),
390         PEnd = D->AllReferencedProtocols.end();
391        P != PEnd; ++P)
392     Writer.AddDeclRef(*P, Record);
393 
394   // Write out the ivars.
395   Record.push_back(D->ivar_size());
396   for (ObjCInterfaceDecl::ivar_iterator I = D->ivar_begin(),
397                                      IEnd = D->ivar_end(); I != IEnd; ++I)
398     Writer.AddDeclRef(*I, Record);
399   Writer.AddDeclRef(D->getCategoryList(), Record);
400   Record.push_back(D->isForwardDecl());
401   Record.push_back(D->isImplicitInterfaceDecl());
402   Writer.AddSourceLocation(D->getClassLoc(), Record);
403   Writer.AddSourceLocation(D->getSuperClassLoc(), Record);
404   Writer.AddSourceLocation(D->getLocEnd(), Record);
405   Code = serialization::DECL_OBJC_INTERFACE;
406 }
407 
408 void ASTDeclWriter::VisitObjCIvarDecl(ObjCIvarDecl *D) {
409   VisitFieldDecl(D);
410   // FIXME: stable encoding for @public/@private/@protected/@package
411   Record.push_back(D->getAccessControl());
412   Record.push_back(D->getSynthesize());
413   Code = serialization::DECL_OBJC_IVAR;
414 }
415 
416 void ASTDeclWriter::VisitObjCProtocolDecl(ObjCProtocolDecl *D) {
417   VisitObjCContainerDecl(D);
418   Record.push_back(D->isForwardDecl());
419   Writer.AddSourceLocation(D->getLocEnd(), Record);
420   Record.push_back(D->protocol_size());
421   for (ObjCProtocolDecl::protocol_iterator
422        I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
423     Writer.AddDeclRef(*I, Record);
424   for (ObjCProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin(),
425          PLEnd = D->protocol_loc_end();
426        PL != PLEnd; ++PL)
427     Writer.AddSourceLocation(*PL, Record);
428   Code = serialization::DECL_OBJC_PROTOCOL;
429 }
430 
431 void ASTDeclWriter::VisitObjCAtDefsFieldDecl(ObjCAtDefsFieldDecl *D) {
432   VisitFieldDecl(D);
433   Code = serialization::DECL_OBJC_AT_DEFS_FIELD;
434 }
435 
436 void ASTDeclWriter::VisitObjCClassDecl(ObjCClassDecl *D) {
437   VisitDecl(D);
438   Record.push_back(D->size());
439   for (ObjCClassDecl::iterator I = D->begin(), IEnd = D->end(); I != IEnd; ++I)
440     Writer.AddDeclRef(I->getInterface(), Record);
441   for (ObjCClassDecl::iterator I = D->begin(), IEnd = D->end(); I != IEnd; ++I)
442     Writer.AddSourceLocation(I->getLocation(), Record);
443   Code = serialization::DECL_OBJC_CLASS;
444 }
445 
446 void ASTDeclWriter::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
447   VisitDecl(D);
448   Record.push_back(D->protocol_size());
449   for (ObjCForwardProtocolDecl::protocol_iterator
450        I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
451     Writer.AddDeclRef(*I, Record);
452   for (ObjCForwardProtocolDecl::protocol_loc_iterator
453          PL = D->protocol_loc_begin(), PLEnd = D->protocol_loc_end();
454        PL != PLEnd; ++PL)
455     Writer.AddSourceLocation(*PL, Record);
456   Code = serialization::DECL_OBJC_FORWARD_PROTOCOL;
457 }
458 
459 void ASTDeclWriter::VisitObjCCategoryDecl(ObjCCategoryDecl *D) {
460   VisitObjCContainerDecl(D);
461   Writer.AddDeclRef(D->getClassInterface(), Record);
462   Record.push_back(D->protocol_size());
463   for (ObjCCategoryDecl::protocol_iterator
464        I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
465     Writer.AddDeclRef(*I, Record);
466   for (ObjCCategoryDecl::protocol_loc_iterator
467          PL = D->protocol_loc_begin(), PLEnd = D->protocol_loc_end();
468        PL != PLEnd; ++PL)
469     Writer.AddSourceLocation(*PL, Record);
470   Writer.AddDeclRef(D->getNextClassCategory(), Record);
471   Record.push_back(D->hasSynthBitfield());
472   Writer.AddSourceLocation(D->getAtLoc(), Record);
473   Writer.AddSourceLocation(D->getCategoryNameLoc(), Record);
474   Code = serialization::DECL_OBJC_CATEGORY;
475 }
476 
477 void ASTDeclWriter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D) {
478   VisitNamedDecl(D);
479   Writer.AddDeclRef(D->getClassInterface(), Record);
480   Code = serialization::DECL_OBJC_COMPATIBLE_ALIAS;
481 }
482 
483 void ASTDeclWriter::VisitObjCPropertyDecl(ObjCPropertyDecl *D) {
484   VisitNamedDecl(D);
485   Writer.AddSourceLocation(D->getAtLoc(), Record);
486   Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
487   // FIXME: stable encoding
488   Record.push_back((unsigned)D->getPropertyAttributes());
489   Record.push_back((unsigned)D->getPropertyAttributesAsWritten());
490   // FIXME: stable encoding
491   Record.push_back((unsigned)D->getPropertyImplementation());
492   Writer.AddDeclarationName(D->getGetterName(), Record);
493   Writer.AddDeclarationName(D->getSetterName(), Record);
494   Writer.AddDeclRef(D->getGetterMethodDecl(), Record);
495   Writer.AddDeclRef(D->getSetterMethodDecl(), Record);
496   Writer.AddDeclRef(D->getPropertyIvarDecl(), Record);
497   Code = serialization::DECL_OBJC_PROPERTY;
498 }
499 
500 void ASTDeclWriter::VisitObjCImplDecl(ObjCImplDecl *D) {
501   VisitObjCContainerDecl(D);
502   Writer.AddDeclRef(D->getClassInterface(), Record);
503   // Abstract class (no need to define a stable serialization::DECL code).
504 }
505 
506 void ASTDeclWriter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
507   VisitObjCImplDecl(D);
508   Writer.AddIdentifierRef(D->getIdentifier(), Record);
509   Code = serialization::DECL_OBJC_CATEGORY_IMPL;
510 }
511 
512 void ASTDeclWriter::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
513   VisitObjCImplDecl(D);
514   Writer.AddDeclRef(D->getSuperClass(), Record);
515   Writer.AddCXXCtorInitializers(D->IvarInitializers, D->NumIvarInitializers,
516                                 Record);
517   Record.push_back(D->hasSynthBitfield());
518   Code = serialization::DECL_OBJC_IMPLEMENTATION;
519 }
520 
521 void ASTDeclWriter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D) {
522   VisitDecl(D);
523   Writer.AddSourceLocation(D->getLocStart(), Record);
524   Writer.AddDeclRef(D->getPropertyDecl(), Record);
525   Writer.AddDeclRef(D->getPropertyIvarDecl(), Record);
526   Writer.AddSourceLocation(D->getPropertyIvarDeclLoc(), Record);
527   Writer.AddStmt(D->getGetterCXXConstructor());
528   Writer.AddStmt(D->getSetterCXXAssignment());
529   Code = serialization::DECL_OBJC_PROPERTY_IMPL;
530 }
531 
532 void ASTDeclWriter::VisitFieldDecl(FieldDecl *D) {
533   VisitDeclaratorDecl(D);
534   Record.push_back(D->isMutable());
535   Record.push_back(D->getBitWidth()? 1 : 0);
536   if (D->getBitWidth())
537     Writer.AddStmt(D->getBitWidth());
538   if (!D->getDeclName())
539     Writer.AddDeclRef(Context.getInstantiatedFromUnnamedFieldDecl(D), Record);
540   Code = serialization::DECL_FIELD;
541 }
542 
543 void ASTDeclWriter::VisitIndirectFieldDecl(IndirectFieldDecl *D) {
544   VisitValueDecl(D);
545   Record.push_back(D->getChainingSize());
546 
547   for (IndirectFieldDecl::chain_iterator
548        P = D->chain_begin(),
549        PEnd = D->chain_end(); P != PEnd; ++P)
550     Writer.AddDeclRef(*P, Record);
551   Code = serialization::DECL_INDIRECTFIELD;
552 }
553 
554 void ASTDeclWriter::VisitVarDecl(VarDecl *D) {
555   VisitDeclaratorDecl(D);
556   VisitRedeclarable(D);
557   Record.push_back(D->getStorageClass()); // FIXME: stable encoding
558   Record.push_back(D->getStorageClassAsWritten());
559   Record.push_back(D->isThreadSpecified());
560   Record.push_back(D->hasCXXDirectInitializer());
561   Record.push_back(D->isExceptionVariable());
562   Record.push_back(D->isNRVOVariable());
563   Record.push_back(D->isCXXForRangeDecl());
564   Record.push_back(D->getInit() ? 1 : 0);
565   if (D->getInit())
566     Writer.AddStmt(D->getInit());
567 
568   MemberSpecializationInfo *SpecInfo
569     = D->isStaticDataMember() ? D->getMemberSpecializationInfo() : 0;
570   Record.push_back(SpecInfo != 0);
571   if (SpecInfo) {
572     Writer.AddDeclRef(SpecInfo->getInstantiatedFrom(), Record);
573     Record.push_back(SpecInfo->getTemplateSpecializationKind());
574     Writer.AddSourceLocation(SpecInfo->getPointOfInstantiation(), Record);
575   }
576 
577   Code = serialization::DECL_VAR;
578 }
579 
580 void ASTDeclWriter::VisitImplicitParamDecl(ImplicitParamDecl *D) {
581   VisitVarDecl(D);
582   Code = serialization::DECL_IMPLICIT_PARAM;
583 }
584 
585 void ASTDeclWriter::VisitParmVarDecl(ParmVarDecl *D) {
586   VisitVarDecl(D);
587   Record.push_back(D->getObjCDeclQualifier()); // FIXME: stable encoding
588   Record.push_back(D->isKNRPromoted());
589   Record.push_back(D->hasInheritedDefaultArg());
590   Record.push_back(D->hasUninstantiatedDefaultArg());
591   if (D->hasUninstantiatedDefaultArg())
592     Writer.AddStmt(D->getUninstantiatedDefaultArg());
593   Code = serialization::DECL_PARM_VAR;
594 
595   // If the assumptions about the DECL_PARM_VAR abbrev are true, use it.  Here
596   // we dynamically check for the properties that we optimize for, but don't
597   // know are true of all PARM_VAR_DECLs.
598   if (!D->getTypeSourceInfo() &&
599       !D->hasAttrs() &&
600       !D->isImplicit() &&
601       !D->isUsed(false) &&
602       D->getAccess() == AS_none &&
603       D->getPCHLevel() == 0 &&
604       D->getStorageClass() == 0 &&
605       !D->hasCXXDirectInitializer() && // Can params have this ever?
606       D->getObjCDeclQualifier() == 0 &&
607       !D->isKNRPromoted() &&
608       !D->hasInheritedDefaultArg() &&
609       D->getInit() == 0 &&
610       !D->hasUninstantiatedDefaultArg())  // No default expr.
611     AbbrevToUse = Writer.getParmVarDeclAbbrev();
612 
613   // Check things we know are true of *every* PARM_VAR_DECL, which is more than
614   // just us assuming it.
615   assert(!D->isInvalidDecl() && "Shouldn't emit invalid decls");
616   assert(!D->isThreadSpecified() && "PARM_VAR_DECL can't be __thread");
617   assert(D->getAccess() == AS_none && "PARM_VAR_DECL can't be public/private");
618   assert(!D->isExceptionVariable() && "PARM_VAR_DECL can't be exception var");
619   assert(D->getPreviousDeclaration() == 0 && "PARM_VAR_DECL can't be redecl");
620   assert(!D->isStaticDataMember() &&
621          "PARM_VAR_DECL can't be static data member");
622 }
623 
624 void ASTDeclWriter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) {
625   VisitDecl(D);
626   Writer.AddStmt(D->getAsmString());
627   Writer.AddSourceLocation(D->getRParenLoc(), Record);
628   Code = serialization::DECL_FILE_SCOPE_ASM;
629 }
630 
631 void ASTDeclWriter::VisitBlockDecl(BlockDecl *D) {
632   VisitDecl(D);
633   Writer.AddStmt(D->getBody());
634   Writer.AddTypeSourceInfo(D->getSignatureAsWritten(), Record);
635   Record.push_back(D->param_size());
636   for (FunctionDecl::param_iterator P = D->param_begin(), PEnd = D->param_end();
637        P != PEnd; ++P)
638     Writer.AddDeclRef(*P, Record);
639   Record.push_back(D->capturesCXXThis());
640   Record.push_back(D->getNumCaptures());
641   for (BlockDecl::capture_iterator
642          i = D->capture_begin(), e = D->capture_end(); i != e; ++i) {
643     const BlockDecl::Capture &capture = *i;
644     Writer.AddDeclRef(capture.getVariable(), Record);
645 
646     unsigned flags = 0;
647     if (capture.isByRef()) flags |= 1;
648     if (capture.isNested()) flags |= 2;
649     if (capture.hasCopyExpr()) flags |= 4;
650     Record.push_back(flags);
651 
652     if (capture.hasCopyExpr()) Writer.AddStmt(capture.getCopyExpr());
653   }
654 
655   Code = serialization::DECL_BLOCK;
656 }
657 
658 void ASTDeclWriter::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
659   VisitDecl(D);
660   Record.push_back(D->getLanguage());
661   Writer.AddSourceLocation(D->getExternLoc(), Record);
662   Writer.AddSourceLocation(D->getRBraceLoc(), Record);
663   Code = serialization::DECL_LINKAGE_SPEC;
664 }
665 
666 void ASTDeclWriter::VisitLabelDecl(LabelDecl *D) {
667   VisitNamedDecl(D);
668   Writer.AddSourceLocation(D->getLocStart(), Record);
669   Code = serialization::DECL_LABEL;
670 }
671 
672 
673 void ASTDeclWriter::VisitNamespaceDecl(NamespaceDecl *D) {
674   VisitNamedDecl(D);
675   Record.push_back(D->isInline());
676   Writer.AddSourceLocation(D->getLocStart(), Record);
677   Writer.AddSourceLocation(D->getRBraceLoc(), Record);
678   Writer.AddDeclRef(D->getNextNamespace(), Record);
679 
680   // Only write one reference--original or anonymous
681   Record.push_back(D->isOriginalNamespace());
682   if (D->isOriginalNamespace())
683     Writer.AddDeclRef(D->getAnonymousNamespace(), Record);
684   else
685     Writer.AddDeclRef(D->getOriginalNamespace(), Record);
686   Code = serialization::DECL_NAMESPACE;
687 
688   if (Writer.hasChain() && !D->isOriginalNamespace() &&
689       D->getOriginalNamespace()->getPCHLevel() > 0) {
690     NamespaceDecl *NS = D->getOriginalNamespace();
691     Writer.AddUpdatedDeclContext(NS);
692 
693     // Make sure all visible decls are written. They will be recorded later.
694     NS->lookup(DeclarationName());
695     StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(NS->getLookupPtr());
696     if (Map) {
697       for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
698            D != DEnd; ++D) {
699         DeclContext::lookup_result Result = D->second.getLookupResult();
700         while (Result.first != Result.second) {
701           Writer.GetDeclRef(*Result.first);
702           ++Result.first;
703         }
704       }
705     }
706   }
707 }
708 
709 void ASTDeclWriter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
710   VisitNamedDecl(D);
711   Writer.AddSourceLocation(D->getNamespaceLoc(), Record);
712   Writer.AddSourceLocation(D->getTargetNameLoc(), Record);
713   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
714   Writer.AddDeclRef(D->getNamespace(), Record);
715   Code = serialization::DECL_NAMESPACE_ALIAS;
716 }
717 
718 void ASTDeclWriter::VisitUsingDecl(UsingDecl *D) {
719   VisitNamedDecl(D);
720   Writer.AddSourceLocation(D->getUsingLocation(), Record);
721   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
722   Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
723   Writer.AddDeclRef(D->FirstUsingShadow, Record);
724   Record.push_back(D->isTypeName());
725   Writer.AddDeclRef(Context.getInstantiatedFromUsingDecl(D), Record);
726   Code = serialization::DECL_USING;
727 }
728 
729 void ASTDeclWriter::VisitUsingShadowDecl(UsingShadowDecl *D) {
730   VisitNamedDecl(D);
731   Writer.AddDeclRef(D->getTargetDecl(), Record);
732   Writer.AddDeclRef(D->UsingOrNextShadow, Record);
733   Writer.AddDeclRef(Context.getInstantiatedFromUsingShadowDecl(D), Record);
734   Code = serialization::DECL_USING_SHADOW;
735 }
736 
737 void ASTDeclWriter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
738   VisitNamedDecl(D);
739   Writer.AddSourceLocation(D->getUsingLoc(), Record);
740   Writer.AddSourceLocation(D->getNamespaceKeyLocation(), Record);
741   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
742   Writer.AddDeclRef(D->getNominatedNamespace(), Record);
743   Writer.AddDeclRef(dyn_cast<Decl>(D->getCommonAncestor()), Record);
744   Code = serialization::DECL_USING_DIRECTIVE;
745 }
746 
747 void ASTDeclWriter::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
748   VisitValueDecl(D);
749   Writer.AddSourceLocation(D->getUsingLoc(), Record);
750   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
751   Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
752   Code = serialization::DECL_UNRESOLVED_USING_VALUE;
753 }
754 
755 void ASTDeclWriter::VisitUnresolvedUsingTypenameDecl(
756                                                UnresolvedUsingTypenameDecl *D) {
757   VisitTypeDecl(D);
758   Writer.AddSourceLocation(D->getTypenameLoc(), Record);
759   Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
760   Code = serialization::DECL_UNRESOLVED_USING_TYPENAME;
761 }
762 
763 void ASTDeclWriter::VisitCXXRecordDecl(CXXRecordDecl *D) {
764   VisitRecordDecl(D);
765 
766   CXXRecordDecl *DefinitionDecl = 0;
767   if (D->DefinitionData)
768     DefinitionDecl = D->DefinitionData->Definition;
769   Writer.AddDeclRef(DefinitionDecl, Record);
770   if (D == DefinitionDecl)
771     Writer.AddCXXDefinitionData(D, Record);
772 
773   enum {
774     CXXRecNotTemplate = 0, CXXRecTemplate, CXXRecMemberSpecialization
775   };
776   if (ClassTemplateDecl *TemplD = D->getDescribedClassTemplate()) {
777     Record.push_back(CXXRecTemplate);
778     Writer.AddDeclRef(TemplD, Record);
779   } else if (MemberSpecializationInfo *MSInfo
780                = D->getMemberSpecializationInfo()) {
781     Record.push_back(CXXRecMemberSpecialization);
782     Writer.AddDeclRef(MSInfo->getInstantiatedFrom(), Record);
783     Record.push_back(MSInfo->getTemplateSpecializationKind());
784     Writer.AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
785   } else {
786     Record.push_back(CXXRecNotTemplate);
787   }
788 
789   // Store the key function to avoid deserializing every method so we can
790   // compute it.
791   if (D->IsDefinition)
792     Writer.AddDeclRef(Context.getKeyFunction(D), Record);
793 
794   Code = serialization::DECL_CXX_RECORD;
795 }
796 
797 void ASTDeclWriter::VisitCXXMethodDecl(CXXMethodDecl *D) {
798   VisitFunctionDecl(D);
799   Record.push_back(D->size_overridden_methods());
800   for (CXXMethodDecl::method_iterator
801          I = D->begin_overridden_methods(), E = D->end_overridden_methods();
802          I != E; ++I)
803     Writer.AddDeclRef(*I, Record);
804   Code = serialization::DECL_CXX_METHOD;
805 }
806 
807 void ASTDeclWriter::VisitCXXConstructorDecl(CXXConstructorDecl *D) {
808   VisitCXXMethodDecl(D);
809 
810   Record.push_back(D->IsExplicitSpecified);
811   Record.push_back(D->ImplicitlyDefined);
812   Writer.AddCXXCtorInitializers(D->CtorInitializers, D->NumCtorInitializers,
813                                 Record);
814 
815   Code = serialization::DECL_CXX_CONSTRUCTOR;
816 }
817 
818 void ASTDeclWriter::VisitCXXDestructorDecl(CXXDestructorDecl *D) {
819   VisitCXXMethodDecl(D);
820 
821   Record.push_back(D->ImplicitlyDefined);
822   Writer.AddDeclRef(D->OperatorDelete, Record);
823 
824   Code = serialization::DECL_CXX_DESTRUCTOR;
825 }
826 
827 void ASTDeclWriter::VisitCXXConversionDecl(CXXConversionDecl *D) {
828   VisitCXXMethodDecl(D);
829   Record.push_back(D->IsExplicitSpecified);
830   Code = serialization::DECL_CXX_CONVERSION;
831 }
832 
833 void ASTDeclWriter::VisitAccessSpecDecl(AccessSpecDecl *D) {
834   VisitDecl(D);
835   Writer.AddSourceLocation(D->getColonLoc(), Record);
836   Code = serialization::DECL_ACCESS_SPEC;
837 }
838 
839 void ASTDeclWriter::VisitFriendDecl(FriendDecl *D) {
840   VisitDecl(D);
841   Record.push_back(D->Friend.is<TypeSourceInfo*>());
842   if (D->Friend.is<TypeSourceInfo*>())
843     Writer.AddTypeSourceInfo(D->Friend.get<TypeSourceInfo*>(), Record);
844   else
845     Writer.AddDeclRef(D->Friend.get<NamedDecl*>(), Record);
846   Writer.AddDeclRef(D->getNextFriend(), Record);
847   Record.push_back(D->UnsupportedFriend);
848   Writer.AddSourceLocation(D->FriendLoc, Record);
849   Code = serialization::DECL_FRIEND;
850 }
851 
852 void ASTDeclWriter::VisitFriendTemplateDecl(FriendTemplateDecl *D) {
853   VisitDecl(D);
854   Record.push_back(D->getNumTemplateParameters());
855   for (unsigned i = 0, e = D->getNumTemplateParameters(); i != e; ++i)
856     Writer.AddTemplateParameterList(D->getTemplateParameterList(i), Record);
857   Record.push_back(D->getFriendDecl() != 0);
858   if (D->getFriendDecl())
859     Writer.AddDeclRef(D->getFriendDecl(), Record);
860   else
861     Writer.AddTypeSourceInfo(D->getFriendType(), Record);
862   Writer.AddSourceLocation(D->getFriendLoc(), Record);
863   Code = serialization::DECL_FRIEND_TEMPLATE;
864 }
865 
866 void ASTDeclWriter::VisitTemplateDecl(TemplateDecl *D) {
867   VisitNamedDecl(D);
868 
869   Writer.AddDeclRef(D->getTemplatedDecl(), Record);
870   Writer.AddTemplateParameterList(D->getTemplateParameters(), Record);
871 }
872 
873 void ASTDeclWriter::VisitRedeclarableTemplateDecl(RedeclarableTemplateDecl *D) {
874   // Emit data to initialize CommonOrPrev before VisitTemplateDecl so that
875   // getCommonPtr() can be used while this is still initializing.
876 
877   Writer.AddDeclRef(D->getPreviousDeclaration(), Record);
878   if (D->getPreviousDeclaration())
879     Writer.AddDeclRef(D->getFirstDeclaration(), Record);
880 
881   if (D->getPreviousDeclaration() == 0) {
882     // This TemplateDecl owns the CommonPtr; write it.
883     assert(D->isCanonicalDecl());
884 
885     Writer.AddDeclRef(D->getInstantiatedFromMemberTemplate(), Record);
886     if (D->getInstantiatedFromMemberTemplate())
887       Record.push_back(D->isMemberSpecialization());
888 
889     Writer.AddDeclRef(D->getCommonPtr()->Latest, Record);
890   } else {
891     RedeclarableTemplateDecl *First = D->getFirstDeclaration();
892     assert(First != D);
893     // If this is a most recent redeclaration that is pointed to by a first decl
894     // in a chained PCH, keep track of the association with the map so we can
895     // update the first decl during AST reading.
896     if (First->getMostRecentDeclaration() == D &&
897         First->getPCHLevel() > D->getPCHLevel()) {
898       assert(Writer.FirstLatestDecls.find(First)==Writer.FirstLatestDecls.end()
899              && "The latest is already set");
900       Writer.FirstLatestDecls[First] = D;
901     }
902   }
903 
904   VisitTemplateDecl(D);
905   Record.push_back(D->getIdentifierNamespace());
906 }
907 
908 void ASTDeclWriter::VisitClassTemplateDecl(ClassTemplateDecl *D) {
909   VisitRedeclarableTemplateDecl(D);
910 
911   if (D->getPreviousDeclaration() == 0) {
912     typedef llvm::FoldingSet<ClassTemplateSpecializationDecl> CTSDSetTy;
913     CTSDSetTy &CTSDSet = D->getSpecializations();
914     Record.push_back(CTSDSet.size());
915     for (CTSDSetTy::iterator I=CTSDSet.begin(), E = CTSDSet.end(); I!=E; ++I) {
916       assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
917       Writer.AddDeclRef(&*I, Record);
918     }
919 
920     typedef llvm::FoldingSet<ClassTemplatePartialSpecializationDecl> CTPSDSetTy;
921     CTPSDSetTy &CTPSDSet = D->getPartialSpecializations();
922     Record.push_back(CTPSDSet.size());
923     for (CTPSDSetTy::iterator I=CTPSDSet.begin(), E=CTPSDSet.end(); I!=E; ++I) {
924       assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
925       Writer.AddDeclRef(&*I, Record);
926     }
927 
928     // InjectedClassNameType is computed, no need to write it.
929   }
930   Code = serialization::DECL_CLASS_TEMPLATE;
931 }
932 
933 void ASTDeclWriter::VisitClassTemplateSpecializationDecl(
934                                            ClassTemplateSpecializationDecl *D) {
935   VisitCXXRecordDecl(D);
936 
937   llvm::PointerUnion<ClassTemplateDecl *,
938                      ClassTemplatePartialSpecializationDecl *> InstFrom
939     = D->getSpecializedTemplateOrPartial();
940   Decl *InstFromD;
941   if (InstFrom.is<ClassTemplateDecl *>()) {
942     InstFromD = InstFrom.get<ClassTemplateDecl *>();
943     Writer.AddDeclRef(InstFromD, Record);
944   } else {
945     InstFromD = InstFrom.get<ClassTemplatePartialSpecializationDecl *>();
946     Writer.AddDeclRef(InstFromD, Record);
947     Writer.AddTemplateArgumentList(&D->getTemplateInstantiationArgs(), Record);
948     InstFromD = cast<ClassTemplatePartialSpecializationDecl>(InstFromD)->
949                     getSpecializedTemplate();
950   }
951 
952   // Explicit info.
953   Writer.AddTypeSourceInfo(D->getTypeAsWritten(), Record);
954   if (D->getTypeAsWritten()) {
955     Writer.AddSourceLocation(D->getExternLoc(), Record);
956     Writer.AddSourceLocation(D->getTemplateKeywordLoc(), Record);
957   }
958 
959   Writer.AddTemplateArgumentList(&D->getTemplateArgs(), Record);
960   Writer.AddSourceLocation(D->getPointOfInstantiation(), Record);
961   Record.push_back(D->getSpecializationKind());
962 
963   if (D->isCanonicalDecl()) {
964     // When reading, we'll add it to the folding set of the following template.
965     Writer.AddDeclRef(D->getSpecializedTemplate()->getCanonicalDecl(), Record);
966   }
967 
968   Code = serialization::DECL_CLASS_TEMPLATE_SPECIALIZATION;
969 }
970 
971 void ASTDeclWriter::VisitClassTemplatePartialSpecializationDecl(
972                                     ClassTemplatePartialSpecializationDecl *D) {
973   VisitClassTemplateSpecializationDecl(D);
974 
975   Writer.AddTemplateParameterList(D->getTemplateParameters(), Record);
976 
977   Record.push_back(D->getNumTemplateArgsAsWritten());
978   for (int i = 0, e = D->getNumTemplateArgsAsWritten(); i != e; ++i)
979     Writer.AddTemplateArgumentLoc(D->getTemplateArgsAsWritten()[i], Record);
980 
981   Record.push_back(D->getSequenceNumber());
982 
983   // These are read/set from/to the first declaration.
984   if (D->getPreviousDeclaration() == 0) {
985     Writer.AddDeclRef(D->getInstantiatedFromMember(), Record);
986     Record.push_back(D->isMemberSpecialization());
987   }
988 
989   Code = serialization::DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION;
990 }
991 
992 void ASTDeclWriter::VisitFunctionTemplateDecl(FunctionTemplateDecl *D) {
993   VisitRedeclarableTemplateDecl(D);
994 
995   if (D->getPreviousDeclaration() == 0) {
996     // This FunctionTemplateDecl owns the CommonPtr; write it.
997 
998     // Write the function specialization declarations.
999     Record.push_back(D->getSpecializations().size());
1000     for (llvm::FoldingSet<FunctionTemplateSpecializationInfo>::iterator
1001            I = D->getSpecializations().begin(),
1002            E = D->getSpecializations().end()   ; I != E; ++I) {
1003       assert(I->Function->isCanonicalDecl() &&
1004              "Expected only canonical decls in set");
1005       Writer.AddDeclRef(I->Function, Record);
1006     }
1007   }
1008   Code = serialization::DECL_FUNCTION_TEMPLATE;
1009 }
1010 
1011 void ASTDeclWriter::VisitTemplateTypeParmDecl(TemplateTypeParmDecl *D) {
1012   VisitTypeDecl(D);
1013 
1014   Record.push_back(D->wasDeclaredWithTypename());
1015   Record.push_back(D->isParameterPack());
1016   Record.push_back(D->defaultArgumentWasInherited());
1017   Writer.AddTypeSourceInfo(D->getDefaultArgumentInfo(), Record);
1018 
1019   Code = serialization::DECL_TEMPLATE_TYPE_PARM;
1020 }
1021 
1022 void ASTDeclWriter::VisitNonTypeTemplateParmDecl(NonTypeTemplateParmDecl *D) {
1023   // For an expanded parameter pack, record the number of expansion types here
1024   // so that it's easier for
1025   if (D->isExpandedParameterPack())
1026     Record.push_back(D->getNumExpansionTypes());
1027 
1028   VisitDeclaratorDecl(D);
1029   // TemplateParmPosition.
1030   Record.push_back(D->getDepth());
1031   Record.push_back(D->getPosition());
1032 
1033   if (D->isExpandedParameterPack()) {
1034     for (unsigned I = 0, N = D->getNumExpansionTypes(); I != N; ++I) {
1035       Writer.AddTypeRef(D->getExpansionType(I), Record);
1036       Writer.AddTypeSourceInfo(D->getExpansionTypeSourceInfo(I), Record);
1037     }
1038 
1039     Code = serialization::DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK;
1040   } else {
1041     // Rest of NonTypeTemplateParmDecl.
1042     Record.push_back(D->isParameterPack());
1043     Record.push_back(D->getDefaultArgument() != 0);
1044     if (D->getDefaultArgument()) {
1045       Writer.AddStmt(D->getDefaultArgument());
1046       Record.push_back(D->defaultArgumentWasInherited());
1047     }
1048     Code = serialization::DECL_NON_TYPE_TEMPLATE_PARM;
1049   }
1050 }
1051 
1052 void ASTDeclWriter::VisitTemplateTemplateParmDecl(TemplateTemplateParmDecl *D) {
1053   VisitTemplateDecl(D);
1054   // TemplateParmPosition.
1055   Record.push_back(D->getDepth());
1056   Record.push_back(D->getPosition());
1057   // Rest of TemplateTemplateParmDecl.
1058   Writer.AddTemplateArgumentLoc(D->getDefaultArgument(), Record);
1059   Record.push_back(D->defaultArgumentWasInherited());
1060   Record.push_back(D->isParameterPack());
1061   Code = serialization::DECL_TEMPLATE_TEMPLATE_PARM;
1062 }
1063 
1064 void ASTDeclWriter::VisitStaticAssertDecl(StaticAssertDecl *D) {
1065   VisitDecl(D);
1066   Writer.AddStmt(D->getAssertExpr());
1067   Writer.AddStmt(D->getMessage());
1068   Writer.AddSourceLocation(D->getRParenLoc(), Record);
1069   Code = serialization::DECL_STATIC_ASSERT;
1070 }
1071 
1072 /// \brief Emit the DeclContext part of a declaration context decl.
1073 ///
1074 /// \param LexicalOffset the offset at which the DECL_CONTEXT_LEXICAL
1075 /// block for this declaration context is stored. May be 0 to indicate
1076 /// that there are no declarations stored within this context.
1077 ///
1078 /// \param VisibleOffset the offset at which the DECL_CONTEXT_VISIBLE
1079 /// block for this declaration context is stored. May be 0 to indicate
1080 /// that there are no declarations visible from this context. Note
1081 /// that this value will not be emitted for non-primary declaration
1082 /// contexts.
1083 void ASTDeclWriter::VisitDeclContext(DeclContext *DC, uint64_t LexicalOffset,
1084                                      uint64_t VisibleOffset) {
1085   Record.push_back(LexicalOffset);
1086   Record.push_back(VisibleOffset);
1087 }
1088 
1089 template <typename T>
1090 void ASTDeclWriter::VisitRedeclarable(Redeclarable<T> *D) {
1091   enum { NoRedeclaration = 0, PointsToPrevious, PointsToLatest };
1092   if (D->RedeclLink.getNext() == D) {
1093     Record.push_back(NoRedeclaration);
1094   } else {
1095     if (D->RedeclLink.NextIsPrevious()) {
1096       Record.push_back(PointsToPrevious);
1097       Writer.AddDeclRef(D->getPreviousDeclaration(), Record);
1098       Writer.AddDeclRef(D->getFirstDeclaration(), Record);
1099     } else {
1100       Record.push_back(PointsToLatest);
1101       Writer.AddDeclRef(D->RedeclLink.getPointer(), Record);
1102     }
1103   }
1104 
1105   T *First = D->getFirstDeclaration();
1106   T *ThisDecl = static_cast<T*>(D);
1107   // If this is a most recent redeclaration that is pointed to by a first decl
1108   // in a chained PCH, keep track of the association with the map so we can
1109   // update the first decl during AST reading.
1110   if (ThisDecl != First && First->getMostRecentDeclaration() == ThisDecl &&
1111       First->getPCHLevel() > ThisDecl->getPCHLevel()) {
1112     assert(Writer.FirstLatestDecls.find(First) == Writer.FirstLatestDecls.end()
1113            && "The latest is already set");
1114     Writer.FirstLatestDecls[First] = ThisDecl;
1115   }
1116 }
1117 
1118 //===----------------------------------------------------------------------===//
1119 // ASTWriter Implementation
1120 //===----------------------------------------------------------------------===//
1121 
1122 void ASTWriter::WriteDeclsBlockAbbrevs() {
1123   using namespace llvm;
1124   // Abbreviation for DECL_PARM_VAR.
1125   BitCodeAbbrev *Abv = new BitCodeAbbrev();
1126   Abv->Add(BitCodeAbbrevOp(serialization::DECL_PARM_VAR));
1127 
1128   // Decl
1129   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1130   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1131   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1132   Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1133   Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1134   Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1135   Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1136   Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1137   Abv->Add(BitCodeAbbrevOp(0));                       // PCH level
1138 
1139   // NamedDecl
1140   Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1141   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1142   // ValueDecl
1143   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1144   // DeclaratorDecl
1145   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1146   Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1147   Abv->Add(BitCodeAbbrevOp(serialization::PREDEF_TYPE_NULL_ID)); // InfoType
1148   // VarDecl
1149   Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1150   Abv->Add(BitCodeAbbrevOp(0));                       // StorageClass
1151   Abv->Add(BitCodeAbbrevOp(0));                       // StorageClassAsWritten
1152   Abv->Add(BitCodeAbbrevOp(0));                       // isThreadSpecified
1153   Abv->Add(BitCodeAbbrevOp(0));                       // hasCXXDirectInitializer
1154   Abv->Add(BitCodeAbbrevOp(0));                       // isExceptionVariable
1155   Abv->Add(BitCodeAbbrevOp(0));                       // isNRVOVariable
1156   Abv->Add(BitCodeAbbrevOp(0));                       // isCXXForRangeDecl
1157   Abv->Add(BitCodeAbbrevOp(0));                       // HasInit
1158   Abv->Add(BitCodeAbbrevOp(0));                   // HasMemberSpecializationInfo
1159   // ParmVarDecl
1160   Abv->Add(BitCodeAbbrevOp(0));                       // ObjCDeclQualifier
1161   Abv->Add(BitCodeAbbrevOp(0));                       // KNRPromoted
1162   Abv->Add(BitCodeAbbrevOp(0));                       // HasInheritedDefaultArg
1163   Abv->Add(BitCodeAbbrevOp(0));                   // HasUninstantiatedDefaultArg
1164 
1165   ParmVarDeclAbbrev = Stream.EmitAbbrev(Abv);
1166 
1167   Abv = new BitCodeAbbrev();
1168   Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_LEXICAL));
1169   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1170   DeclContextLexicalAbbrev = Stream.EmitAbbrev(Abv);
1171 
1172   Abv = new BitCodeAbbrev();
1173   Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_VISIBLE));
1174   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1175   Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1176   DeclContextVisibleLookupAbbrev = Stream.EmitAbbrev(Abv);
1177 }
1178 
1179 /// isRequiredDecl - Check if this is a "required" Decl, which must be seen by
1180 /// consumers of the AST.
1181 ///
1182 /// Such decls will always be deserialized from the AST file, so we would like
1183 /// this to be as restrictive as possible. Currently the predicate is driven by
1184 /// code generation requirements, if other clients have a different notion of
1185 /// what is "required" then we may have to consider an alternate scheme where
1186 /// clients can iterate over the top-level decls and get information on them,
1187 /// without necessary deserializing them. We could explicitly require such
1188 /// clients to use a separate API call to "realize" the decl. This should be
1189 /// relatively painless since they would presumably only do it for top-level
1190 /// decls.
1191 static bool isRequiredDecl(const Decl *D, ASTContext &Context) {
1192   // File scoped assembly or obj-c implementation must be seen.
1193   if (isa<FileScopeAsmDecl>(D) || isa<ObjCImplementationDecl>(D))
1194     return true;
1195 
1196   return Context.DeclMustBeEmitted(D);
1197 }
1198 
1199 void ASTWriter::WriteDecl(ASTContext &Context, Decl *D) {
1200   // Switch case IDs are per Decl.
1201   ClearSwitchCaseIDs();
1202 
1203   RecordData Record;
1204   ASTDeclWriter W(*this, Context, Record);
1205 
1206   // If this declaration is also a DeclContext, write blocks for the
1207   // declarations that lexically stored inside its context and those
1208   // declarations that are visible from its context. These blocks
1209   // are written before the declaration itself so that we can put
1210   // their offsets into the record for the declaration.
1211   uint64_t LexicalOffset = 0;
1212   uint64_t VisibleOffset = 0;
1213   DeclContext *DC = dyn_cast<DeclContext>(D);
1214   if (DC) {
1215     LexicalOffset = WriteDeclContextLexicalBlock(Context, DC);
1216     VisibleOffset = WriteDeclContextVisibleBlock(Context, DC);
1217   }
1218 
1219   // Determine the ID for this declaration
1220   serialization::DeclID &IDR = DeclIDs[D];
1221   if (IDR == 0)
1222     IDR = NextDeclID++;
1223   serialization::DeclID ID = IDR;
1224 
1225   if (ID < FirstDeclID) {
1226     // We're replacing a decl in a previous file.
1227     ReplacedDecls.push_back(std::make_pair(ID, Stream.GetCurrentBitNo()));
1228   } else {
1229     unsigned Index = ID - FirstDeclID;
1230 
1231     // Record the offset for this declaration
1232     if (DeclOffsets.size() == Index)
1233       DeclOffsets.push_back(Stream.GetCurrentBitNo());
1234     else if (DeclOffsets.size() < Index) {
1235       DeclOffsets.resize(Index+1);
1236       DeclOffsets[Index] = Stream.GetCurrentBitNo();
1237     }
1238   }
1239 
1240   // Build and emit a record for this declaration
1241   Record.clear();
1242   W.Code = (serialization::DeclCode)0;
1243   W.AbbrevToUse = 0;
1244   W.Visit(D);
1245   if (DC) W.VisitDeclContext(DC, LexicalOffset, VisibleOffset);
1246 
1247   if (!W.Code)
1248     llvm::report_fatal_error(llvm::StringRef("unexpected declaration kind '") +
1249                             D->getDeclKindName() + "'");
1250   Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
1251 
1252   // Flush any expressions that were written as part of this declaration.
1253   FlushStmts();
1254 
1255   // Flush C++ base specifiers, if there are any.
1256   FlushCXXBaseSpecifiers();
1257 
1258   // Note "external" declarations so that we can add them to a record in the
1259   // AST file later.
1260   //
1261   // FIXME: This should be renamed, the predicate is much more complicated.
1262   if (isRequiredDecl(D, Context))
1263     ExternalDefinitions.push_back(ID);
1264 }
1265