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