ASTWriterDecl.cpp revision bc84532e762a41141bd94037cd5d1133f234088e 
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->getPCHLevel());
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->getPCHLevel() == 0 &&
184      D->RedeclLink.getNext() == D &&
185      !D->isInvalidDecl() &&
186      !D->isReferenced() &&
187      D->getAccess() == AS_none &&
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  Writer.AddSourceLocation(D->getRBraceLoc(), Record);
208  Record.push_back(D->hasExtInfo());
209  if (D->hasExtInfo())
210    Writer.AddQualifierInfo(*D->getExtInfo(), Record);
211  else
212    Writer.AddDeclRef(D->getTypedefNameForAnonDecl(), Record);
213}
214
215void ASTDeclWriter::VisitEnumDecl(EnumDecl *D) {
216  VisitTagDecl(D);
217  Writer.AddTypeSourceInfo(D->getIntegerTypeSourceInfo(), Record);
218  if (!D->getIntegerTypeSourceInfo())
219    Writer.AddTypeRef(D->getIntegerType(), Record);
220  Writer.AddTypeRef(D->getPromotionType(), Record);
221  Record.push_back(D->getNumPositiveBits());
222  Record.push_back(D->getNumNegativeBits());
223  Record.push_back(D->isScoped());
224  Record.push_back(D->isScopedUsingClassTag());
225  Record.push_back(D->isFixed());
226  Writer.AddDeclRef(D->getInstantiatedFromMemberEnum(), Record);
227
228  if (!D->hasAttrs() &&
229      !D->isImplicit() &&
230      !D->isUsed(false) &&
231      D->getPCHLevel() == 0 &&
232      !D->hasExtInfo() &&
233      D->RedeclLink.getNext() == D &&
234      !D->isInvalidDecl() &&
235      !D->isReferenced() &&
236      D->getAccess() == AS_none &&
237      !CXXRecordDecl::classofKind(D->getKind()) &&
238      !D->getIntegerTypeSourceInfo() &&
239      D->getDeclName().getNameKind() == DeclarationName::Identifier)
240    AbbrevToUse = Writer.getDeclEnumAbbrev();
241
242  Code = serialization::DECL_ENUM;
243}
244
245void ASTDeclWriter::VisitRecordDecl(RecordDecl *D) {
246  VisitTagDecl(D);
247  Record.push_back(D->hasFlexibleArrayMember());
248  Record.push_back(D->isAnonymousStructOrUnion());
249  Record.push_back(D->hasObjectMember());
250
251  if (!D->hasAttrs() &&
252      !D->isImplicit() &&
253      !D->isUsed(false) &&
254      D->getPCHLevel() == 0 &&
255      !D->hasExtInfo() &&
256      D->RedeclLink.getNext() == D &&
257      !D->isInvalidDecl() &&
258      !D->isReferenced() &&
259      D->getAccess() == AS_none &&
260      !CXXRecordDecl::classofKind(D->getKind()) &&
261      D->getDeclName().getNameKind() == DeclarationName::Identifier)
262    AbbrevToUse = Writer.getDeclRecordAbbrev();
263
264  Code = serialization::DECL_RECORD;
265}
266
267void ASTDeclWriter::VisitValueDecl(ValueDecl *D) {
268  VisitNamedDecl(D);
269  Writer.AddTypeRef(D->getType(), Record);
270}
271
272void ASTDeclWriter::VisitEnumConstantDecl(EnumConstantDecl *D) {
273  VisitValueDecl(D);
274  Record.push_back(D->getInitExpr()? 1 : 0);
275  if (D->getInitExpr())
276    Writer.AddStmt(D->getInitExpr());
277  Writer.AddAPSInt(D->getInitVal(), Record);
278
279  Code = serialization::DECL_ENUM_CONSTANT;
280}
281
282void ASTDeclWriter::VisitDeclaratorDecl(DeclaratorDecl *D) {
283  VisitValueDecl(D);
284  Writer.AddSourceLocation(D->getInnerLocStart(), Record);
285  Record.push_back(D->hasExtInfo());
286  if (D->hasExtInfo())
287    Writer.AddQualifierInfo(*D->getExtInfo(), Record);
288}
289
290void ASTDeclWriter::VisitFunctionDecl(FunctionDecl *D) {
291  VisitDeclaratorDecl(D);
292  VisitRedeclarable(D);
293
294  Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
295  Record.push_back(D->getIdentifierNamespace());
296  Record.push_back(D->getTemplatedKind());
297  switch (D->getTemplatedKind()) {
298  default: assert(false && "Unhandled TemplatedKind!");
299    break;
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->size());
325      for (int i=0, e = FTSInfo->TemplateArgumentsAsWritten->size(); i!=e; ++i)
326        Writer.AddTemplateArgumentLoc((*FTSInfo->TemplateArgumentsAsWritten)[i],
327                                      Record);
328      Writer.AddSourceLocation(FTSInfo->TemplateArgumentsAsWritten->getLAngleLoc(),
329                               Record);
330      Writer.AddSourceLocation(FTSInfo->TemplateArgumentsAsWritten->getRAngleLoc(),
331                               Record);
332    }
333
334    Writer.AddSourceLocation(FTSInfo->getPointOfInstantiation(), Record);
335
336    if (D->isCanonicalDecl()) {
337      // Write the template that contains the specializations set. We will
338      // add a FunctionTemplateSpecializationInfo to it when reading.
339      Writer.AddDeclRef(FTSInfo->getTemplate()->getCanonicalDecl(), Record);
340    }
341    break;
342  }
343  case FunctionDecl::TK_DependentFunctionTemplateSpecialization: {
344    DependentFunctionTemplateSpecializationInfo *
345      DFTSInfo = D->getDependentSpecializationInfo();
346
347    // Templates.
348    Record.push_back(DFTSInfo->getNumTemplates());
349    for (int i=0, e = DFTSInfo->getNumTemplates(); i != e; ++i)
350      Writer.AddDeclRef(DFTSInfo->getTemplate(i), Record);
351
352    // Templates args.
353    Record.push_back(DFTSInfo->getNumTemplateArgs());
354    for (int i=0, e = DFTSInfo->getNumTemplateArgs(); i != e; ++i)
355      Writer.AddTemplateArgumentLoc(DFTSInfo->getTemplateArg(i), Record);
356    Writer.AddSourceLocation(DFTSInfo->getLAngleLoc(), Record);
357    Writer.AddSourceLocation(DFTSInfo->getRAngleLoc(), Record);
358    break;
359  }
360  }
361
362  // FunctionDecl's body is handled last at ASTWriterDecl::Visit,
363  // after everything else is written.
364
365  Record.push_back(D->getStorageClass()); // FIXME: stable encoding
366  Record.push_back(D->getStorageClassAsWritten());
367  Record.push_back(D->IsInline);
368  Record.push_back(D->isInlineSpecified());
369  Record.push_back(D->isVirtualAsWritten());
370  Record.push_back(D->isPure());
371  Record.push_back(D->hasInheritedPrototype());
372  Record.push_back(D->hasWrittenPrototype());
373  Record.push_back(D->isDeletedAsWritten());
374  Record.push_back(D->isTrivial());
375  Record.push_back(D->isDefaulted());
376  Record.push_back(D->isExplicitlyDefaulted());
377  Record.push_back(D->hasImplicitReturnZero());
378  Record.push_back(D->isConstexpr());
379  Writer.AddSourceLocation(D->getLocEnd(), Record);
380
381  Record.push_back(D->param_size());
382  for (FunctionDecl::param_iterator P = D->param_begin(), PEnd = D->param_end();
383       P != PEnd; ++P)
384    Writer.AddDeclRef(*P, Record);
385  Code = serialization::DECL_FUNCTION;
386}
387
388void ASTDeclWriter::VisitObjCMethodDecl(ObjCMethodDecl *D) {
389  VisitNamedDecl(D);
390  // FIXME: convert to LazyStmtPtr?
391  // Unlike C/C++, method bodies will never be in header files.
392  bool HasBodyStuff = D->getBody() != 0     ||
393                      D->getSelfDecl() != 0 || D->getCmdDecl() != 0;
394  Record.push_back(HasBodyStuff);
395  if (HasBodyStuff) {
396    Writer.AddStmt(D->getBody());
397    Writer.AddDeclRef(D->getSelfDecl(), Record);
398    Writer.AddDeclRef(D->getCmdDecl(), Record);
399  }
400  Record.push_back(D->isInstanceMethod());
401  Record.push_back(D->isVariadic());
402  Record.push_back(D->isSynthesized());
403  Record.push_back(D->isDefined());
404  // FIXME: stable encoding for @required/@optional
405  Record.push_back(D->getImplementationControl());
406  // FIXME: stable encoding for in/out/inout/bycopy/byref/oneway
407  Record.push_back(D->getObjCDeclQualifier());
408  Record.push_back(D->hasRelatedResultType());
409  Record.push_back(D->getNumSelectorArgs());
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  Code = serialization::DECL_OBJC_METHOD;
418}
419
420void ASTDeclWriter::VisitObjCContainerDecl(ObjCContainerDecl *D) {
421  VisitNamedDecl(D);
422  Writer.AddSourceRange(D->getAtEndRange(), Record);
423  // Abstract class (no need to define a stable serialization::DECL code).
424}
425
426void ASTDeclWriter::VisitObjCInterfaceDecl(ObjCInterfaceDecl *D) {
427  VisitObjCContainerDecl(D);
428  Writer.AddTypeRef(QualType(D->getTypeForDecl(), 0), Record);
429  Writer.AddDeclRef(D->getSuperClass(), Record);
430
431  // Write out the protocols that are directly referenced by the @interface.
432  Record.push_back(D->ReferencedProtocols.size());
433  for (ObjCInterfaceDecl::protocol_iterator P = D->protocol_begin(),
434         PEnd = D->protocol_end();
435       P != PEnd; ++P)
436    Writer.AddDeclRef(*P, Record);
437  for (ObjCInterfaceDecl::protocol_loc_iterator PL = D->protocol_loc_begin(),
438         PLEnd = D->protocol_loc_end();
439       PL != PLEnd; ++PL)
440    Writer.AddSourceLocation(*PL, Record);
441
442  // Write out the protocols that are transitively referenced.
443  Record.push_back(D->AllReferencedProtocols.size());
444  for (ObjCList<ObjCProtocolDecl>::iterator
445        P = D->AllReferencedProtocols.begin(),
446        PEnd = D->AllReferencedProtocols.end();
447       P != PEnd; ++P)
448    Writer.AddDeclRef(*P, Record);
449
450  // Write out the ivars.
451  Record.push_back(D->ivar_size());
452  for (ObjCInterfaceDecl::ivar_iterator I = D->ivar_begin(),
453                                     IEnd = D->ivar_end(); I != IEnd; ++I)
454    Writer.AddDeclRef(*I, Record);
455  Writer.AddDeclRef(D->getCategoryList(), Record);
456  Record.push_back(D->isForwardDecl());
457  Record.push_back(D->isImplicitInterfaceDecl());
458  Writer.AddSourceLocation(D->getClassLoc(), Record);
459  Writer.AddSourceLocation(D->getSuperClassLoc(), Record);
460  Writer.AddSourceLocation(D->getLocEnd(), Record);
461  Code = serialization::DECL_OBJC_INTERFACE;
462}
463
464void ASTDeclWriter::VisitObjCIvarDecl(ObjCIvarDecl *D) {
465  VisitFieldDecl(D);
466  // FIXME: stable encoding for @public/@private/@protected/@package
467  Record.push_back(D->getAccessControl());
468  Record.push_back(D->getSynthesize());
469
470  if (!D->hasAttrs() &&
471      !D->isImplicit() &&
472      !D->isUsed(false) &&
473      !D->isInvalidDecl() &&
474      !D->isReferenced() &&
475      D->getPCHLevel() == 0 &&
476      !D->getBitWidth() &&
477      !D->hasExtInfo() &&
478      D->getDeclName())
479    AbbrevToUse = Writer.getDeclObjCIvarAbbrev();
480
481  Code = serialization::DECL_OBJC_IVAR;
482}
483
484void ASTDeclWriter::VisitObjCProtocolDecl(ObjCProtocolDecl *D) {
485  VisitObjCContainerDecl(D);
486  Record.push_back(D->isForwardDecl());
487  Writer.AddSourceLocation(D->getLocEnd(), Record);
488  Record.push_back(D->protocol_size());
489  for (ObjCProtocolDecl::protocol_iterator
490       I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
491    Writer.AddDeclRef(*I, Record);
492  for (ObjCProtocolDecl::protocol_loc_iterator PL = D->protocol_loc_begin(),
493         PLEnd = D->protocol_loc_end();
494       PL != PLEnd; ++PL)
495    Writer.AddSourceLocation(*PL, Record);
496  Code = serialization::DECL_OBJC_PROTOCOL;
497}
498
499void ASTDeclWriter::VisitObjCAtDefsFieldDecl(ObjCAtDefsFieldDecl *D) {
500  VisitFieldDecl(D);
501  Code = serialization::DECL_OBJC_AT_DEFS_FIELD;
502}
503
504void ASTDeclWriter::VisitObjCClassDecl(ObjCClassDecl *D) {
505  VisitDecl(D);
506  Record.push_back(D->size());
507  for (ObjCClassDecl::iterator I = D->begin(), IEnd = D->end(); I != IEnd; ++I)
508    Writer.AddDeclRef(I->getInterface(), Record);
509  for (ObjCClassDecl::iterator I = D->begin(), IEnd = D->end(); I != IEnd; ++I)
510    Writer.AddSourceLocation(I->getLocation(), Record);
511  Code = serialization::DECL_OBJC_CLASS;
512}
513
514void ASTDeclWriter::VisitObjCForwardProtocolDecl(ObjCForwardProtocolDecl *D) {
515  VisitDecl(D);
516  Record.push_back(D->protocol_size());
517  for (ObjCForwardProtocolDecl::protocol_iterator
518       I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
519    Writer.AddDeclRef(*I, Record);
520  for (ObjCForwardProtocolDecl::protocol_loc_iterator
521         PL = D->protocol_loc_begin(), PLEnd = D->protocol_loc_end();
522       PL != PLEnd; ++PL)
523    Writer.AddSourceLocation(*PL, Record);
524  Code = serialization::DECL_OBJC_FORWARD_PROTOCOL;
525}
526
527void ASTDeclWriter::VisitObjCCategoryDecl(ObjCCategoryDecl *D) {
528  VisitObjCContainerDecl(D);
529  Writer.AddDeclRef(D->getClassInterface(), Record);
530  Record.push_back(D->protocol_size());
531  for (ObjCCategoryDecl::protocol_iterator
532       I = D->protocol_begin(), IEnd = D->protocol_end(); I != IEnd; ++I)
533    Writer.AddDeclRef(*I, Record);
534  for (ObjCCategoryDecl::protocol_loc_iterator
535         PL = D->protocol_loc_begin(), PLEnd = D->protocol_loc_end();
536       PL != PLEnd; ++PL)
537    Writer.AddSourceLocation(*PL, Record);
538  Writer.AddDeclRef(D->getNextClassCategory(), Record);
539  Record.push_back(D->hasSynthBitfield());
540  Writer.AddSourceLocation(D->getAtLoc(), Record);
541  Writer.AddSourceLocation(D->getCategoryNameLoc(), Record);
542  Code = serialization::DECL_OBJC_CATEGORY;
543}
544
545void ASTDeclWriter::VisitObjCCompatibleAliasDecl(ObjCCompatibleAliasDecl *D) {
546  VisitNamedDecl(D);
547  Writer.AddDeclRef(D->getClassInterface(), Record);
548  Code = serialization::DECL_OBJC_COMPATIBLE_ALIAS;
549}
550
551void ASTDeclWriter::VisitObjCPropertyDecl(ObjCPropertyDecl *D) {
552  VisitNamedDecl(D);
553  Writer.AddSourceLocation(D->getAtLoc(), Record);
554  Writer.AddTypeSourceInfo(D->getTypeSourceInfo(), Record);
555  // FIXME: stable encoding
556  Record.push_back((unsigned)D->getPropertyAttributes());
557  Record.push_back((unsigned)D->getPropertyAttributesAsWritten());
558  // FIXME: stable encoding
559  Record.push_back((unsigned)D->getPropertyImplementation());
560  Writer.AddDeclarationName(D->getGetterName(), Record);
561  Writer.AddDeclarationName(D->getSetterName(), Record);
562  Writer.AddDeclRef(D->getGetterMethodDecl(), Record);
563  Writer.AddDeclRef(D->getSetterMethodDecl(), Record);
564  Writer.AddDeclRef(D->getPropertyIvarDecl(), Record);
565  Code = serialization::DECL_OBJC_PROPERTY;
566}
567
568void ASTDeclWriter::VisitObjCImplDecl(ObjCImplDecl *D) {
569  VisitObjCContainerDecl(D);
570  Writer.AddDeclRef(D->getClassInterface(), Record);
571  // Abstract class (no need to define a stable serialization::DECL code).
572}
573
574void ASTDeclWriter::VisitObjCCategoryImplDecl(ObjCCategoryImplDecl *D) {
575  VisitObjCImplDecl(D);
576  Writer.AddIdentifierRef(D->getIdentifier(), Record);
577  Code = serialization::DECL_OBJC_CATEGORY_IMPL;
578}
579
580void ASTDeclWriter::VisitObjCImplementationDecl(ObjCImplementationDecl *D) {
581  VisitObjCImplDecl(D);
582  Writer.AddDeclRef(D->getSuperClass(), Record);
583  Writer.AddCXXCtorInitializers(D->IvarInitializers, D->NumIvarInitializers,
584                                Record);
585  Record.push_back(D->hasSynthBitfield());
586  Code = serialization::DECL_OBJC_IMPLEMENTATION;
587}
588
589void ASTDeclWriter::VisitObjCPropertyImplDecl(ObjCPropertyImplDecl *D) {
590  VisitDecl(D);
591  Writer.AddSourceLocation(D->getLocStart(), Record);
592  Writer.AddDeclRef(D->getPropertyDecl(), Record);
593  Writer.AddDeclRef(D->getPropertyIvarDecl(), Record);
594  Writer.AddSourceLocation(D->getPropertyIvarDeclLoc(), Record);
595  Writer.AddStmt(D->getGetterCXXConstructor());
596  Writer.AddStmt(D->getSetterCXXAssignment());
597  Code = serialization::DECL_OBJC_PROPERTY_IMPL;
598}
599
600void ASTDeclWriter::VisitFieldDecl(FieldDecl *D) {
601  VisitDeclaratorDecl(D);
602  Record.push_back(D->isMutable());
603  Record.push_back(D->getBitWidth()? 1 : D->hasInClassInitializer() ? 2 : 0);
604  if (D->getBitWidth())
605    Writer.AddStmt(D->getBitWidth());
606  else if (D->hasInClassInitializer())
607    Writer.AddStmt(D->getInClassInitializer());
608  if (!D->getDeclName())
609    Writer.AddDeclRef(Context.getInstantiatedFromUnnamedFieldDecl(D), Record);
610
611  if (!D->hasAttrs() &&
612      !D->isImplicit() &&
613      !D->isUsed(false) &&
614      !D->isInvalidDecl() &&
615      !D->isReferenced() &&
616      D->getPCHLevel() == 0 &&
617      !D->getBitWidth() &&
618      !D->hasInClassInitializer() &&
619      !D->hasExtInfo() &&
620      !ObjCIvarDecl::classofKind(D->getKind()) &&
621      !ObjCAtDefsFieldDecl::classofKind(D->getKind()) &&
622      D->getDeclName())
623    AbbrevToUse = Writer.getDeclFieldAbbrev();
624
625  Code = serialization::DECL_FIELD;
626}
627
628void ASTDeclWriter::VisitIndirectFieldDecl(IndirectFieldDecl *D) {
629  VisitValueDecl(D);
630  Record.push_back(D->getChainingSize());
631
632  for (IndirectFieldDecl::chain_iterator
633       P = D->chain_begin(),
634       PEnd = D->chain_end(); P != PEnd; ++P)
635    Writer.AddDeclRef(*P, Record);
636  Code = serialization::DECL_INDIRECTFIELD;
637}
638
639void ASTDeclWriter::VisitVarDecl(VarDecl *D) {
640  VisitDeclaratorDecl(D);
641  VisitRedeclarable(D);
642  Record.push_back(D->getStorageClass()); // FIXME: stable encoding
643  Record.push_back(D->getStorageClassAsWritten());
644  Record.push_back(D->isThreadSpecified());
645  Record.push_back(D->hasCXXDirectInitializer());
646  Record.push_back(D->isExceptionVariable());
647  Record.push_back(D->isNRVOVariable());
648  Record.push_back(D->isCXXForRangeDecl());
649  Record.push_back(D->isARCPseudoStrong());
650  Record.push_back(D->getInit() ? 1 : 0);
651  if (D->getInit())
652    Writer.AddStmt(D->getInit());
653
654  MemberSpecializationInfo *SpecInfo
655    = D->isStaticDataMember() ? D->getMemberSpecializationInfo() : 0;
656  Record.push_back(SpecInfo != 0);
657  if (SpecInfo) {
658    Writer.AddDeclRef(SpecInfo->getInstantiatedFrom(), Record);
659    Record.push_back(SpecInfo->getTemplateSpecializationKind());
660    Writer.AddSourceLocation(SpecInfo->getPointOfInstantiation(), Record);
661  }
662
663  if (!D->hasAttrs() &&
664      !D->isImplicit() &&
665      !D->isUsed(false) &&
666      !D->isInvalidDecl() &&
667      !D->isReferenced() &&
668      D->getAccess() == AS_none &&
669      D->getPCHLevel() == 0 &&
670      D->getDeclName().getNameKind() == DeclarationName::Identifier &&
671      !D->hasExtInfo() &&
672      D->RedeclLink.getNext() == D &&
673      !D->hasCXXDirectInitializer() &&
674      D->getInit() == 0 &&
675      !isa<ParmVarDecl>(D) &&
676      !SpecInfo)
677    AbbrevToUse = Writer.getDeclVarAbbrev();
678
679  Code = serialization::DECL_VAR;
680}
681
682void ASTDeclWriter::VisitImplicitParamDecl(ImplicitParamDecl *D) {
683  VisitVarDecl(D);
684  Code = serialization::DECL_IMPLICIT_PARAM;
685}
686
687void ASTDeclWriter::VisitParmVarDecl(ParmVarDecl *D) {
688  VisitVarDecl(D);
689  Record.push_back(D->isObjCMethodParameter());
690  Record.push_back(D->getFunctionScopeDepth());
691  Record.push_back(D->getFunctionScopeIndex());
692  Record.push_back(D->getObjCDeclQualifier()); // FIXME: stable encoding
693  Record.push_back(D->isKNRPromoted());
694  Record.push_back(D->hasInheritedDefaultArg());
695  Record.push_back(D->hasUninstantiatedDefaultArg());
696  if (D->hasUninstantiatedDefaultArg())
697    Writer.AddStmt(D->getUninstantiatedDefaultArg());
698  Code = serialization::DECL_PARM_VAR;
699
700  assert(!D->isARCPseudoStrong()); // can be true of ImplicitParamDecl
701
702  // If the assumptions about the DECL_PARM_VAR abbrev are true, use it.  Here
703  // we dynamically check for the properties that we optimize for, but don't
704  // know are true of all PARM_VAR_DECLs.
705  if (!D->hasAttrs() &&
706      !D->hasExtInfo() &&
707      !D->isImplicit() &&
708      !D->isUsed(false) &&
709      D->getAccess() == AS_none &&
710      D->getPCHLevel() == 0 &&
711      D->getStorageClass() == 0 &&
712      !D->hasCXXDirectInitializer() && // Can params have this ever?
713      D->getFunctionScopeDepth() == 0 &&
714      D->getObjCDeclQualifier() == 0 &&
715      !D->isKNRPromoted() &&
716      !D->hasInheritedDefaultArg() &&
717      D->getInit() == 0 &&
718      !D->hasUninstantiatedDefaultArg())  // No default expr.
719    AbbrevToUse = Writer.getDeclParmVarAbbrev();
720
721  // Check things we know are true of *every* PARM_VAR_DECL, which is more than
722  // just us assuming it.
723  assert(!D->isInvalidDecl() && "Shouldn't emit invalid decls");
724  assert(!D->isThreadSpecified() && "PARM_VAR_DECL can't be __thread");
725  assert(D->getAccess() == AS_none && "PARM_VAR_DECL can't be public/private");
726  assert(!D->isExceptionVariable() && "PARM_VAR_DECL can't be exception var");
727  assert(D->getPreviousDeclaration() == 0 && "PARM_VAR_DECL can't be redecl");
728  assert(!D->isStaticDataMember() &&
729         "PARM_VAR_DECL can't be static data member");
730}
731
732void ASTDeclWriter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) {
733  VisitDecl(D);
734  Writer.AddStmt(D->getAsmString());
735  Writer.AddSourceLocation(D->getRParenLoc(), Record);
736  Code = serialization::DECL_FILE_SCOPE_ASM;
737}
738
739void ASTDeclWriter::VisitBlockDecl(BlockDecl *D) {
740  VisitDecl(D);
741  Writer.AddStmt(D->getBody());
742  Writer.AddTypeSourceInfo(D->getSignatureAsWritten(), Record);
743  Record.push_back(D->param_size());
744  for (FunctionDecl::param_iterator P = D->param_begin(), PEnd = D->param_end();
745       P != PEnd; ++P)
746    Writer.AddDeclRef(*P, Record);
747  Record.push_back(D->capturesCXXThis());
748  Record.push_back(D->getNumCaptures());
749  for (BlockDecl::capture_iterator
750         i = D->capture_begin(), e = D->capture_end(); i != e; ++i) {
751    const BlockDecl::Capture &capture = *i;
752    Writer.AddDeclRef(capture.getVariable(), Record);
753
754    unsigned flags = 0;
755    if (capture.isByRef()) flags |= 1;
756    if (capture.isNested()) flags |= 2;
757    if (capture.hasCopyExpr()) flags |= 4;
758    Record.push_back(flags);
759
760    if (capture.hasCopyExpr()) Writer.AddStmt(capture.getCopyExpr());
761  }
762
763  Code = serialization::DECL_BLOCK;
764}
765
766void ASTDeclWriter::VisitLinkageSpecDecl(LinkageSpecDecl *D) {
767  VisitDecl(D);
768  Record.push_back(D->getLanguage());
769  Writer.AddSourceLocation(D->getExternLoc(), Record);
770  Writer.AddSourceLocation(D->getRBraceLoc(), Record);
771  Code = serialization::DECL_LINKAGE_SPEC;
772}
773
774void ASTDeclWriter::VisitLabelDecl(LabelDecl *D) {
775  VisitNamedDecl(D);
776  Writer.AddSourceLocation(D->getLocStart(), Record);
777  Code = serialization::DECL_LABEL;
778}
779
780
781void ASTDeclWriter::VisitNamespaceDecl(NamespaceDecl *D) {
782  VisitNamedDecl(D);
783  Record.push_back(D->isInline());
784  Writer.AddSourceLocation(D->getLocStart(), Record);
785  Writer.AddSourceLocation(D->getRBraceLoc(), Record);
786  Writer.AddDeclRef(D->getNextNamespace(), Record);
787
788  // Only write one reference--original or anonymous
789  Record.push_back(D->isOriginalNamespace());
790  if (D->isOriginalNamespace())
791    Writer.AddDeclRef(D->getAnonymousNamespace(), Record);
792  else
793    Writer.AddDeclRef(D->getOriginalNamespace(), Record);
794  Code = serialization::DECL_NAMESPACE;
795
796  if (Writer.hasChain() && !D->isOriginalNamespace() &&
797      D->getOriginalNamespace()->getPCHLevel() > 0) {
798    NamespaceDecl *NS = D->getOriginalNamespace();
799    Writer.AddUpdatedDeclContext(NS);
800
801    // Make sure all visible decls are written. They will be recorded later.
802    NS->lookup(DeclarationName());
803    StoredDeclsMap *Map = static_cast<StoredDeclsMap*>(NS->getLookupPtr());
804    if (Map) {
805      for (StoredDeclsMap::iterator D = Map->begin(), DEnd = Map->end();
806           D != DEnd; ++D) {
807        DeclContext::lookup_result Result = D->second.getLookupResult();
808        while (Result.first != Result.second) {
809          Writer.GetDeclRef(*Result.first);
810          ++Result.first;
811        }
812      }
813    }
814  }
815
816  if (Writer.hasChain() && D->isAnonymousNamespace() && !D->getNextNamespace()){
817    // This is a most recent reopening of the anonymous namespace. If its parent
818    // is in a previous PCH (or is the TU), mark that parent for update, because
819    // the original namespace always points to the latest re-opening of its
820    // anonymous namespace.
821    Decl *Parent = cast<Decl>(
822        D->getParent()->getRedeclContext()->getPrimaryContext());
823    if (Parent->getPCHLevel() > 0 || isa<TranslationUnitDecl>(Parent)) {
824      ASTWriter::UpdateRecord &Record = Writer.DeclUpdates[Parent];
825      Record.push_back(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE);
826      Writer.AddDeclRef(D, Record);
827    }
828  }
829}
830
831void ASTDeclWriter::VisitNamespaceAliasDecl(NamespaceAliasDecl *D) {
832  VisitNamedDecl(D);
833  Writer.AddSourceLocation(D->getNamespaceLoc(), Record);
834  Writer.AddSourceLocation(D->getTargetNameLoc(), Record);
835  Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
836  Writer.AddDeclRef(D->getNamespace(), Record);
837  Code = serialization::DECL_NAMESPACE_ALIAS;
838}
839
840void ASTDeclWriter::VisitUsingDecl(UsingDecl *D) {
841  VisitNamedDecl(D);
842  Writer.AddSourceLocation(D->getUsingLocation(), Record);
843  Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
844  Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
845  Writer.AddDeclRef(D->FirstUsingShadow, Record);
846  Record.push_back(D->isTypeName());
847  Writer.AddDeclRef(Context.getInstantiatedFromUsingDecl(D), Record);
848  Code = serialization::DECL_USING;
849}
850
851void ASTDeclWriter::VisitUsingShadowDecl(UsingShadowDecl *D) {
852  VisitNamedDecl(D);
853  Writer.AddDeclRef(D->getTargetDecl(), Record);
854  Writer.AddDeclRef(D->UsingOrNextShadow, Record);
855  Writer.AddDeclRef(Context.getInstantiatedFromUsingShadowDecl(D), Record);
856  Code = serialization::DECL_USING_SHADOW;
857}
858
859void ASTDeclWriter::VisitUsingDirectiveDecl(UsingDirectiveDecl *D) {
860  VisitNamedDecl(D);
861  Writer.AddSourceLocation(D->getUsingLoc(), Record);
862  Writer.AddSourceLocation(D->getNamespaceKeyLocation(), Record);
863  Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
864  Writer.AddDeclRef(D->getNominatedNamespace(), Record);
865  Writer.AddDeclRef(dyn_cast<Decl>(D->getCommonAncestor()), Record);
866  Code = serialization::DECL_USING_DIRECTIVE;
867}
868
869void ASTDeclWriter::VisitUnresolvedUsingValueDecl(UnresolvedUsingValueDecl *D) {
870  VisitValueDecl(D);
871  Writer.AddSourceLocation(D->getUsingLoc(), Record);
872  Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
873  Writer.AddDeclarationNameLoc(D->DNLoc, D->getDeclName(), Record);
874  Code = serialization::DECL_UNRESOLVED_USING_VALUE;
875}
876
877void ASTDeclWriter::VisitUnresolvedUsingTypenameDecl(
878                                               UnresolvedUsingTypenameDecl *D) {
879  VisitTypeDecl(D);
880  Writer.AddSourceLocation(D->getTypenameLoc(), Record);
881  Writer.AddNestedNameSpecifierLoc(D->getQualifierLoc(), Record);
882  Code = serialization::DECL_UNRESOLVED_USING_TYPENAME;
883}
884
885void ASTDeclWriter::VisitCXXRecordDecl(CXXRecordDecl *D) {
886  VisitRecordDecl(D);
887
888  CXXRecordDecl *DefinitionDecl = 0;
889  if (D->DefinitionData)
890    DefinitionDecl = D->DefinitionData->Definition;
891  Writer.AddDeclRef(DefinitionDecl, Record);
892  if (D == DefinitionDecl)
893    Writer.AddCXXDefinitionData(D, Record);
894
895  enum {
896    CXXRecNotTemplate = 0, CXXRecTemplate, CXXRecMemberSpecialization
897  };
898  if (ClassTemplateDecl *TemplD = D->getDescribedClassTemplate()) {
899    Record.push_back(CXXRecTemplate);
900    Writer.AddDeclRef(TemplD, Record);
901  } else if (MemberSpecializationInfo *MSInfo
902               = D->getMemberSpecializationInfo()) {
903    Record.push_back(CXXRecMemberSpecialization);
904    Writer.AddDeclRef(MSInfo->getInstantiatedFrom(), Record);
905    Record.push_back(MSInfo->getTemplateSpecializationKind());
906    Writer.AddSourceLocation(MSInfo->getPointOfInstantiation(), Record);
907  } else {
908    Record.push_back(CXXRecNotTemplate);
909  }
910
911  // Store the key function to avoid deserializing every method so we can
912  // compute it.
913  if (D->IsDefinition)
914    Writer.AddDeclRef(Context.getKeyFunction(D), Record);
915
916  Code = serialization::DECL_CXX_RECORD;
917}
918
919void ASTDeclWriter::VisitCXXMethodDecl(CXXMethodDecl *D) {
920  VisitFunctionDecl(D);
921  Record.push_back(D->size_overridden_methods());
922  for (CXXMethodDecl::method_iterator
923         I = D->begin_overridden_methods(), E = D->end_overridden_methods();
924         I != E; ++I)
925    Writer.AddDeclRef(*I, Record);
926  Code = serialization::DECL_CXX_METHOD;
927}
928
929void ASTDeclWriter::VisitCXXConstructorDecl(CXXConstructorDecl *D) {
930  VisitCXXMethodDecl(D);
931
932  Record.push_back(D->IsExplicitSpecified);
933  Record.push_back(D->ImplicitlyDefined);
934  Writer.AddCXXCtorInitializers(D->CtorInitializers, D->NumCtorInitializers,
935                                Record);
936
937  Code = serialization::DECL_CXX_CONSTRUCTOR;
938}
939
940void ASTDeclWriter::VisitCXXDestructorDecl(CXXDestructorDecl *D) {
941  VisitCXXMethodDecl(D);
942
943  Record.push_back(D->ImplicitlyDefined);
944  Writer.AddDeclRef(D->OperatorDelete, Record);
945
946  Code = serialization::DECL_CXX_DESTRUCTOR;
947}
948
949void ASTDeclWriter::VisitCXXConversionDecl(CXXConversionDecl *D) {
950  VisitCXXMethodDecl(D);
951  Record.push_back(D->IsExplicitSpecified);
952  Code = serialization::DECL_CXX_CONVERSION;
953}
954
955void ASTDeclWriter::VisitAccessSpecDecl(AccessSpecDecl *D) {
956  VisitDecl(D);
957  Writer.AddSourceLocation(D->getColonLoc(), Record);
958  Code = serialization::DECL_ACCESS_SPEC;
959}
960
961void ASTDeclWriter::VisitFriendDecl(FriendDecl *D) {
962  VisitDecl(D);
963  Record.push_back(D->Friend.is<TypeSourceInfo*>());
964  if (D->Friend.is<TypeSourceInfo*>())
965    Writer.AddTypeSourceInfo(D->Friend.get<TypeSourceInfo*>(), Record);
966  else
967    Writer.AddDeclRef(D->Friend.get<NamedDecl*>(), Record);
968  Writer.AddDeclRef(D->getNextFriend(), Record);
969  Record.push_back(D->UnsupportedFriend);
970  Writer.AddSourceLocation(D->FriendLoc, Record);
971  Code = serialization::DECL_FRIEND;
972}
973
974void ASTDeclWriter::VisitFriendTemplateDecl(FriendTemplateDecl *D) {
975  VisitDecl(D);
976  Record.push_back(D->getNumTemplateParameters());
977  for (unsigned i = 0, e = D->getNumTemplateParameters(); i != e; ++i)
978    Writer.AddTemplateParameterList(D->getTemplateParameterList(i), Record);
979  Record.push_back(D->getFriendDecl() != 0);
980  if (D->getFriendDecl())
981    Writer.AddDeclRef(D->getFriendDecl(), Record);
982  else
983    Writer.AddTypeSourceInfo(D->getFriendType(), Record);
984  Writer.AddSourceLocation(D->getFriendLoc(), Record);
985  Code = serialization::DECL_FRIEND_TEMPLATE;
986}
987
988void ASTDeclWriter::VisitTemplateDecl(TemplateDecl *D) {
989  VisitNamedDecl(D);
990
991  Writer.AddDeclRef(D->getTemplatedDecl(), Record);
992  Writer.AddTemplateParameterList(D->getTemplateParameters(), Record);
993}
994
995void ASTDeclWriter::VisitRedeclarableTemplateDecl(RedeclarableTemplateDecl *D) {
996  // Emit data to initialize CommonOrPrev before VisitTemplateDecl so that
997  // getCommonPtr() can be used while this is still initializing.
998
999  Writer.AddDeclRef(D->getPreviousDeclaration(), Record);
1000  if (D->getPreviousDeclaration())
1001    Writer.AddDeclRef(D->getFirstDeclaration(), Record);
1002
1003  if (D->getPreviousDeclaration() == 0) {
1004    // This TemplateDecl owns the CommonPtr; write it.
1005    assert(D->isCanonicalDecl());
1006
1007    Writer.AddDeclRef(D->getInstantiatedFromMemberTemplate(), Record);
1008    if (D->getInstantiatedFromMemberTemplate())
1009      Record.push_back(D->isMemberSpecialization());
1010
1011    Writer.AddDeclRef(D->getCommonPtr()->Latest, Record);
1012  } else {
1013    RedeclarableTemplateDecl *First = D->getFirstDeclaration();
1014    assert(First != D);
1015    // If this is a most recent redeclaration that is pointed to by a first decl
1016    // in a chained PCH, keep track of the association with the map so we can
1017    // update the first decl during AST reading.
1018    if (First->getMostRecentDeclaration() == D &&
1019        First->getPCHLevel() > D->getPCHLevel()) {
1020      assert(Writer.FirstLatestDecls.find(First)==Writer.FirstLatestDecls.end()
1021             && "The latest is already set");
1022      Writer.FirstLatestDecls[First] = D;
1023    }
1024  }
1025
1026  VisitTemplateDecl(D);
1027  Record.push_back(D->getIdentifierNamespace());
1028}
1029
1030void ASTDeclWriter::VisitClassTemplateDecl(ClassTemplateDecl *D) {
1031  VisitRedeclarableTemplateDecl(D);
1032
1033  if (D->getPreviousDeclaration() == 0) {
1034    typedef llvm::FoldingSet<ClassTemplateSpecializationDecl> CTSDSetTy;
1035    CTSDSetTy &CTSDSet = D->getSpecializations();
1036    Record.push_back(CTSDSet.size());
1037    for (CTSDSetTy::iterator I=CTSDSet.begin(), E = CTSDSet.end(); I!=E; ++I) {
1038      assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
1039      Writer.AddDeclRef(&*I, Record);
1040    }
1041
1042    typedef llvm::FoldingSet<ClassTemplatePartialSpecializationDecl> CTPSDSetTy;
1043    CTPSDSetTy &CTPSDSet = D->getPartialSpecializations();
1044    Record.push_back(CTPSDSet.size());
1045    for (CTPSDSetTy::iterator I=CTPSDSet.begin(), E=CTPSDSet.end(); I!=E; ++I) {
1046      assert(I->isCanonicalDecl() && "Expected only canonical decls in set");
1047      Writer.AddDeclRef(&*I, Record);
1048    }
1049
1050    // InjectedClassNameType is computed, no need to write it.
1051  }
1052  Code = serialization::DECL_CLASS_TEMPLATE;
1053}
1054
1055void ASTDeclWriter::VisitClassTemplateSpecializationDecl(
1056                                           ClassTemplateSpecializationDecl *D) {
1057  VisitCXXRecordDecl(D);
1058
1059  llvm::PointerUnion<ClassTemplateDecl *,
1060                     ClassTemplatePartialSpecializationDecl *> InstFrom
1061    = D->getSpecializedTemplateOrPartial();
1062  Decl *InstFromD;
1063  if (InstFrom.is<ClassTemplateDecl *>()) {
1064    InstFromD = InstFrom.get<ClassTemplateDecl *>();
1065    Writer.AddDeclRef(InstFromD, Record);
1066  } else {
1067    InstFromD = InstFrom.get<ClassTemplatePartialSpecializationDecl *>();
1068    Writer.AddDeclRef(InstFromD, Record);
1069    Writer.AddTemplateArgumentList(&D->getTemplateInstantiationArgs(), Record);
1070    InstFromD = cast<ClassTemplatePartialSpecializationDecl>(InstFromD)->
1071                    getSpecializedTemplate();
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->getPCHLevel() > ThisDecl->getPCHLevel()) {
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));                       // PCH level
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));                       // PCH level
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));                       // PCH level
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::VBR, 6));   // SourceLocation
1354  Abv->Add(BitCodeAbbrevOp(0));                         // hasExtInfo
1355  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // TypedefNameAnonDecl
1356  // EnumDecl
1357  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // AddTypeRef
1358  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IntegerType
1359  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getPromotionType
1360  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getNumPositiveBits
1361  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getNumNegativeBits
1362  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isScoped
1363  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isScopedUsingClassTag
1364  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isFixed
1365  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // InstantiatedMembEnum
1366  // DC
1367  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // LexicalOffset
1368  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // VisibleOffset
1369  DeclEnumAbbrev = Stream.EmitAbbrev(Abv);
1370
1371  // Abbreviation for DECL_RECORD
1372  Abv = new BitCodeAbbrev();
1373  Abv->Add(BitCodeAbbrevOp(serialization::DECL_RECORD));
1374  // Decl
1375  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1376  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1377  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1378  Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1379  Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1380  Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1381  Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1382  Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1383  Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1384  Abv->Add(BitCodeAbbrevOp(0));                       // PCH level
1385  // NamedDecl
1386  Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1387  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1388  // TypeDecl
1389  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1390  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1391  // Redeclarable
1392  Abv->Add(BitCodeAbbrevOp(0));                         // No redeclaration
1393  // TagDecl
1394  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // IdentifierNamespace
1395  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // getTagKind
1396  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isDefinition
1397  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // EmbeddedInDeclarator
1398  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // SourceLocation
1399  Abv->Add(BitCodeAbbrevOp(0));                         // hasExtInfo
1400  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // TypedefNameAnonDecl
1401  // RecordDecl
1402  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // FlexibleArrayMember
1403  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // AnonymousStructUnion
1404  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // hasObjectMember
1405  // DC
1406  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // LexicalOffset
1407  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));   // VisibleOffset
1408  DeclRecordAbbrev = Stream.EmitAbbrev(Abv);
1409
1410  // Abbreviation for DECL_PARM_VAR
1411  Abv = new BitCodeAbbrev();
1412  Abv->Add(BitCodeAbbrevOp(serialization::DECL_PARM_VAR));
1413  // Decl
1414  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1415  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1416  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1417  Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1418  Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1419  Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1420  Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1421  Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1422  Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1423  Abv->Add(BitCodeAbbrevOp(0));                       // PCH level
1424  // NamedDecl
1425  Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1426  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1427  // ValueDecl
1428  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1429  // DeclaratorDecl
1430  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1431  Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1432  // VarDecl
1433  Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1434  Abv->Add(BitCodeAbbrevOp(0));                       // StorageClass
1435  Abv->Add(BitCodeAbbrevOp(0));                       // StorageClassAsWritten
1436  Abv->Add(BitCodeAbbrevOp(0));                       // isThreadSpecified
1437  Abv->Add(BitCodeAbbrevOp(0));                       // hasCXXDirectInitializer
1438  Abv->Add(BitCodeAbbrevOp(0));                       // isExceptionVariable
1439  Abv->Add(BitCodeAbbrevOp(0));                       // isNRVOVariable
1440  Abv->Add(BitCodeAbbrevOp(0));                       // isCXXForRangeDecl
1441  Abv->Add(BitCodeAbbrevOp(0));                       // isARCPseudoStrong
1442  Abv->Add(BitCodeAbbrevOp(0));                       // HasInit
1443  Abv->Add(BitCodeAbbrevOp(0));                   // HasMemberSpecializationInfo
1444  // ParmVarDecl
1445  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsObjCMethodParameter
1446  Abv->Add(BitCodeAbbrevOp(0));                       // ScopeDepth
1447  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ScopeIndex
1448  Abv->Add(BitCodeAbbrevOp(0));                       // ObjCDeclQualifier
1449  Abv->Add(BitCodeAbbrevOp(0));                       // KNRPromoted
1450  Abv->Add(BitCodeAbbrevOp(0));                       // HasInheritedDefaultArg
1451  Abv->Add(BitCodeAbbrevOp(0));                   // HasUninstantiatedDefaultArg
1452  // Type Source Info
1453  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1454  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1455  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1456  DeclParmVarAbbrev = Stream.EmitAbbrev(Abv);
1457
1458  // Abbreviation for DECL_TYPEDEF
1459  Abv = new BitCodeAbbrev();
1460  Abv->Add(BitCodeAbbrevOp(serialization::DECL_TYPEDEF));
1461  // Decl
1462  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1463  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1464  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1465  Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1466  Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1467  Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1468  Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1469  Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1470  Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1471  Abv->Add(BitCodeAbbrevOp(0));                       // PCH level
1472  // NamedDecl
1473  Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1474  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1475  // TypeDecl
1476  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Source Location
1477  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type Ref
1478  // TypedefDecl
1479  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1480  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1481  DeclTypedefAbbrev = Stream.EmitAbbrev(Abv);
1482
1483  // Abbreviation for DECL_VAR
1484  Abv = new BitCodeAbbrev();
1485  Abv->Add(BitCodeAbbrevOp(serialization::DECL_VAR));
1486  // Decl
1487  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclContext
1488  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // LexicalDeclContext
1489  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1490  Abv->Add(BitCodeAbbrevOp(0));                       // isInvalidDecl (!?)
1491  Abv->Add(BitCodeAbbrevOp(0));                       // HasAttrs
1492  Abv->Add(BitCodeAbbrevOp(0));                       // isImplicit
1493  Abv->Add(BitCodeAbbrevOp(0));                       // isUsed
1494  Abv->Add(BitCodeAbbrevOp(0));                       // isReferenced
1495  Abv->Add(BitCodeAbbrevOp(AS_none));                 // C++ AccessSpecifier
1496  Abv->Add(BitCodeAbbrevOp(0));                       // PCH level
1497  // NamedDecl
1498  Abv->Add(BitCodeAbbrevOp(0));                       // NameKind = Identifier
1499  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Name
1500  // ValueDecl
1501  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1502  // DeclaratorDecl
1503  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // InnerStartLoc
1504  Abv->Add(BitCodeAbbrevOp(0));                       // hasExtInfo
1505  // VarDecl
1506  Abv->Add(BitCodeAbbrevOp(0));                       // No redeclaration
1507  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // StorageClass
1508  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // StorageClassAsWritten
1509  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isThreadSpecified
1510  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // CXXDirectInitializer
1511  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isExceptionVariable
1512  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isNRVOVariable
1513  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isCXXForRangeDecl
1514  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // isARCPseudoStrong
1515  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // HasInit
1516  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // HasMemberSpecInfo
1517  // Type Source Info
1518  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6));
1519  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
1520  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // TypeLoc
1521  DeclVarAbbrev = Stream.EmitAbbrev(Abv);
1522
1523  // Abbreviation for EXPR_DECL_REF
1524  Abv = new BitCodeAbbrev();
1525  Abv->Add(BitCodeAbbrevOp(serialization::EXPR_DECL_REF));
1526  //Stmt
1527  //Expr
1528  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1529  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1530  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1531  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1532  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1533  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1534  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1535  //DeclRefExpr
1536  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //HasQualifier
1537  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //GetDeclFound
1538  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ExplicitTemplateArgs
1539  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // DeclRef
1540  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1541  DeclRefExprAbbrev = Stream.EmitAbbrev(Abv);
1542
1543  // Abbreviation for EXPR_INTEGER_LITERAL
1544  Abv = new BitCodeAbbrev();
1545  Abv->Add(BitCodeAbbrevOp(serialization::EXPR_INTEGER_LITERAL));
1546  //Stmt
1547  //Expr
1548  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1549  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1550  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1551  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1552  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1553  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1554  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1555  //Integer Literal
1556  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1557  Abv->Add(BitCodeAbbrevOp(32));                      // Bit Width
1558  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Value
1559  IntegerLiteralAbbrev = Stream.EmitAbbrev(Abv);
1560
1561  // Abbreviation for EXPR_CHARACTER_LITERAL
1562  Abv = new BitCodeAbbrev();
1563  Abv->Add(BitCodeAbbrevOp(serialization::EXPR_CHARACTER_LITERAL));
1564  //Stmt
1565  //Expr
1566  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
1567  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //TypeDependent
1568  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //ValueDependent
1569  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //InstantiationDependent
1570  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //UnexpandedParamPack
1571  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetValueKind
1572  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); //GetObjectKind
1573  //Character Literal
1574  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // getValue
1575  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Location
1576  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); //IsWide
1577  CharacterLiteralAbbrev = Stream.EmitAbbrev(Abv);
1578
1579  Abv = new BitCodeAbbrev();
1580  Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_LEXICAL));
1581  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1582  DeclContextLexicalAbbrev = Stream.EmitAbbrev(Abv);
1583
1584  Abv = new BitCodeAbbrev();
1585  Abv->Add(BitCodeAbbrevOp(serialization::DECL_CONTEXT_VISIBLE));
1586  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1587  Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
1588  DeclContextVisibleLookupAbbrev = Stream.EmitAbbrev(Abv);
1589}
1590
1591/// isRequiredDecl - Check if this is a "required" Decl, which must be seen by
1592/// consumers of the AST.
1593///
1594/// Such decls will always be deserialized from the AST file, so we would like
1595/// this to be as restrictive as possible. Currently the predicate is driven by
1596/// code generation requirements, if other clients have a different notion of
1597/// what is "required" then we may have to consider an alternate scheme where
1598/// clients can iterate over the top-level decls and get information on them,
1599/// without necessary deserializing them. We could explicitly require such
1600/// clients to use a separate API call to "realize" the decl. This should be
1601/// relatively painless since they would presumably only do it for top-level
1602/// decls.
1603static bool isRequiredDecl(const Decl *D, ASTContext &Context) {
1604  // File scoped assembly or obj-c implementation must be seen.
1605  if (isa<FileScopeAsmDecl>(D) || isa<ObjCImplementationDecl>(D))
1606    return true;
1607
1608  return Context.DeclMustBeEmitted(D);
1609}
1610
1611void ASTWriter::WriteDecl(ASTContext &Context, Decl *D) {
1612  // Switch case IDs are per Decl.
1613  ClearSwitchCaseIDs();
1614
1615  RecordData Record;
1616  ASTDeclWriter W(*this, Context, Record);
1617
1618  // If this declaration is also a DeclContext, write blocks for the
1619  // declarations that lexically stored inside its context and those
1620  // declarations that are visible from its context. These blocks
1621  // are written before the declaration itself so that we can put
1622  // their offsets into the record for the declaration.
1623  uint64_t LexicalOffset = 0;
1624  uint64_t VisibleOffset = 0;
1625  DeclContext *DC = dyn_cast<DeclContext>(D);
1626  if (DC) {
1627    LexicalOffset = WriteDeclContextLexicalBlock(Context, DC);
1628    VisibleOffset = WriteDeclContextVisibleBlock(Context, DC);
1629  }
1630
1631  // Determine the ID for this declaration
1632  serialization::DeclID &IDR = DeclIDs[D];
1633  if (IDR == 0)
1634    IDR = NextDeclID++;
1635  serialization::DeclID ID = IDR;
1636
1637  if (ID < FirstDeclID) {
1638    // We're replacing a decl in a previous file.
1639    ReplacedDecls.push_back(std::make_pair(ID, Stream.GetCurrentBitNo()));
1640  } else {
1641    unsigned Index = ID - FirstDeclID;
1642
1643    // Record the offset for this declaration
1644    if (DeclOffsets.size() == Index)
1645      DeclOffsets.push_back(Stream.GetCurrentBitNo());
1646    else if (DeclOffsets.size() < Index) {
1647      DeclOffsets.resize(Index+1);
1648      DeclOffsets[Index] = Stream.GetCurrentBitNo();
1649    }
1650  }
1651
1652  // Build and emit a record for this declaration
1653  Record.clear();
1654  W.Code = (serialization::DeclCode)0;
1655  W.AbbrevToUse = 0;
1656  W.Visit(D);
1657  if (DC) W.VisitDeclContext(DC, LexicalOffset, VisibleOffset);
1658
1659  if (!W.Code)
1660    llvm::report_fatal_error(StringRef("unexpected declaration kind '") +
1661                            D->getDeclKindName() + "'");
1662  Stream.EmitRecord(W.Code, Record, W.AbbrevToUse);
1663
1664  // Flush any expressions that were written as part of this declaration.
1665  FlushStmts();
1666
1667  // Flush C++ base specifiers, if there are any.
1668  FlushCXXBaseSpecifiers();
1669
1670  // Note "external" declarations so that we can add them to a record in the
1671  // AST file later.
1672  //
1673  // FIXME: This should be renamed, the predicate is much more complicated.
1674  if (isRequiredDecl(D, Context))
1675    ExternalDefinitions.push_back(ID);
1676}
1677