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