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