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