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