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