contrib/llvm/tools/clang/include/clang/AST/RecursiveASTVisitor.h

   1 //===--- RecursiveASTVisitor.h - Recursive AST Visitor ----------*- C++ -*-===//
   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 defines the RecursiveASTVisitor interface, which recursively
  11 //  traverses the entire AST.
  12 //
  13 //===----------------------------------------------------------------------===//
  14 #ifndef LLVM_CLANG_AST_RECURSIVEASTVISITOR_H
  15 #define LLVM_CLANG_AST_RECURSIVEASTVISITOR_H
  16
  17 #include "clang/AST/Decl.h"
  18 #include "clang/AST/DeclCXX.h"
  19 #include "clang/AST/DeclFriend.h"
  20 #include "clang/AST/DeclObjC.h"
  21 #include "clang/AST/DeclTemplate.h"
  22 #include "clang/AST/Expr.h"
  23 #include "clang/AST/ExprCXX.h"
  24 #include "clang/AST/ExprObjC.h"
  25 #include "clang/AST/NestedNameSpecifier.h"
  26 #include "clang/AST/Stmt.h"
  27 #include "clang/AST/StmtCXX.h"
  28 #include "clang/AST/StmtObjC.h"
  29 #include "clang/AST/TemplateBase.h"
  30 #include "clang/AST/TemplateName.h"
  31 #include "clang/AST/Type.h"
  32 #include "clang/AST/TypeLoc.h"
  33
  34 // The following three macros are used for meta programming.  The code
  35 // using them is responsible for defining macro OPERATOR().
  36
  37 // All unary operators.
  38 #define UNARYOP_LIST()                          \
  39   OPERATOR(PostInc)   OPERATOR(PostDec)         \
  40   OPERATOR(PreInc)    OPERATOR(PreDec)          \
  41   OPERATOR(AddrOf)    OPERATOR(Deref)           \
  42   OPERATOR(Plus)      OPERATOR(Minus)           \
  43   OPERATOR(Not)       OPERATOR(LNot)            \
  44   OPERATOR(Real)      OPERATOR(Imag)            \
  45   OPERATOR(Extension)
  46
  47 // All binary operators (excluding compound assign operators).
  48 #define BINOP_LIST() \
  49   OPERATOR(PtrMemD)              OPERATOR(PtrMemI)    \
  50   OPERATOR(Mul)   OPERATOR(Div)  OPERATOR(Rem)        \
  51   OPERATOR(Add)   OPERATOR(Sub)  OPERATOR(Shl)        \
  52   OPERATOR(Shr)                                       \
  53                                                       \
  54   OPERATOR(LT)    OPERATOR(GT)   OPERATOR(LE)         \
  55   OPERATOR(GE)    OPERATOR(EQ)   OPERATOR(NE)         \
  56   OPERATOR(And)   OPERATOR(Xor)  OPERATOR(Or)         \
  57   OPERATOR(LAnd)  OPERATOR(LOr)                       \
  58                                                       \
  59   OPERATOR(Assign)                                    \
  60   OPERATOR(Comma)
  61
  62 // All compound assign operators.
  63 #define CAO_LIST()                                                      \
  64   OPERATOR(Mul) OPERATOR(Div) OPERATOR(Rem) OPERATOR(Add) OPERATOR(Sub) \
  65   OPERATOR(Shl) OPERATOR(Shr) OPERATOR(And) OPERATOR(Or)  OPERATOR(Xor)
  66
  67 namespace clang {
  68
  69 // A helper macro to implement short-circuiting when recursing.  It
  70 // invokes CALL_EXPR, which must be a method call, on the derived
  71 // object (s.t. a user of RecursiveASTVisitor can override the method
  72 // in CALL_EXPR).
  73 #define TRY_TO(CALL_EXPR) \
  74   do { if (!getDerived().CALL_EXPR) return false; } while (0)
  75
  76 /// \brief A class that does preorder depth-first traversal on the
  77 /// entire Clang AST and visits each node.
  78 ///
  79 /// This class performs three distinct tasks:
  80 ///   1. traverse the AST (i.e. go to each node);
  81 ///   2. at a given node, walk up the class hierarchy, starting from
  82 ///      the node's dynamic type, until the top-most class (e.g. Stmt,
  83 ///      Decl, or Type) is reached.
  84 ///   3. given a (node, class) combination, where 'class' is some base
  85 ///      class of the dynamic type of 'node', call a user-overridable
  86 ///      function to actually visit the node.
  87 ///
  88 /// These tasks are done by three groups of methods, respectively:
  89 ///   1. TraverseDecl(Decl *x) does task #1.  It is the entry point
  90 ///      for traversing an AST rooted at x.  This method simply
  91 ///      dispatches (i.e. forwards) to TraverseFoo(Foo *x) where Foo
  92 ///      is the dynamic type of *x, which calls WalkUpFromFoo(x) and
  93 ///      then recursively visits the child nodes of x.
  94 ///      TraverseStmt(Stmt *x) and TraverseType(QualType x) work
  95 ///      similarly.
  96 ///   2. WalkUpFromFoo(Foo *x) does task #2.  It does not try to visit
  97 ///      any child node of x.  Instead, it first calls WalkUpFromBar(x)
  98 ///      where Bar is the direct parent class of Foo (unless Foo has
  99 ///      no parent), and then calls VisitFoo(x) (see the next list item).
 100 ///   3. VisitFoo(Foo *x) does task #3.
 101 ///
 102 /// These three method groups are tiered (Traverse* > WalkUpFrom* >
 103 /// Visit*).  A method (e.g. Traverse*) may call methods from the same
 104 /// tier (e.g. other Traverse*) or one tier lower (e.g. WalkUpFrom*).
 105 /// It may not call methods from a higher tier.
 106 ///
 107 /// Note that since WalkUpFromFoo() calls WalkUpFromBar() (where Bar
 108 /// is Foo's super class) before calling VisitFoo(), the result is
 109 /// that the Visit*() methods for a given node are called in the
 110 /// top-down order (e.g. for a node of type NamedDecl, the order will
 111 /// be VisitDecl(), VisitNamedDecl(), and then VisitNamespaceDecl()).
 112 ///
 113 /// This scheme guarantees that all Visit*() calls for the same AST
 114 /// node are grouped together.  In other words, Visit*() methods for
 115 /// different nodes are never interleaved.
 116 ///
 117 /// Clients of this visitor should subclass the visitor (providing
 118 /// themselves as the template argument, using the curiously recurring
 119 /// template pattern) and override any of the Traverse*, WalkUpFrom*,
 120 /// and Visit* methods for declarations, types, statements,
 121 /// expressions, or other AST nodes where the visitor should customize
 122 /// behavior.  Most users only need to override Visit*.  Advanced
 123 /// users may override Traverse* and WalkUpFrom* to implement custom
 124 /// traversal strategies.  Returning false from one of these overridden
 125 /// functions will abort the entire traversal.
 126 ///
 127 /// By default, this visitor tries to visit every part of the explicit
 128 /// source code exactly once.  The default policy towards templates
 129 /// is to descend into the 'pattern' class or function body, not any
 130 /// explicit or implicit instantiations.  Explicit specializations
 131 /// are still visited, and the patterns of partial specializations
 132 /// are visited separately.  This behavior can be changed by
 133 /// overriding shouldVisitTemplateInstantiations() in the derived class
 134 /// to return true, in which case all known implicit and explicit
 135 /// instantiations will be visited at the same time as the pattern
 136 /// from which they were produced.
 137 template<typename Derived>
 138 class RecursiveASTVisitor {
 139 public:
 140   /// \brief Return a reference to the derived class.
 141   Derived &getDerived() { return *static_cast<Derived*>(this); }
 142
 143   /// \brief Return whether this visitor should recurse into
 144   /// template instantiations.
 145   bool shouldVisitTemplateInstantiations() const { return false; }
 146
 147   /// \brief Return whether this visitor should recurse into the types of
 148   /// TypeLocs.
 149   bool shouldWalkTypesOfTypeLocs() const { return true; }
 150
 151   /// \brief Return whether this visitor should recurse into implicit
 152   /// code, e.g., implicit constructors and destructors.
 153   bool shouldVisitImplicitCode() const { return false; }
 154
 155   /// \brief Return whether \param S should be traversed using data recursion
 156   /// to avoid a stack overflow with extreme cases.
 157   bool shouldUseDataRecursionFor(Stmt *S) const {
 158     return isa<BinaryOperator>(S) || isa<UnaryOperator>(S) ||
 159            isa<CaseStmt>(S) || isa<CXXOperatorCallExpr>(S);
 160   }
 161
 162   /// \brief Recursively visit a statement or expression, by
 163   /// dispatching to Traverse*() based on the argument's dynamic type.
 164   ///
 165   /// \returns false if the visitation was terminated early, true
 166   /// otherwise (including when the argument is NULL).
 167   bool TraverseStmt(Stmt *S);
 168
 169   /// \brief Recursively visit a type, by dispatching to
 170   /// Traverse*Type() based on the argument's getTypeClass() property.
 171   ///
 172   /// \returns false if the visitation was terminated early, true
 173   /// otherwise (including when the argument is a Null type).
 174   bool TraverseType(QualType T);
 175
 176   /// \brief Recursively visit a type with location, by dispatching to
 177   /// Traverse*TypeLoc() based on the argument type's getTypeClass() property.
 178   ///
 179   /// \returns false if the visitation was terminated early, true
 180   /// otherwise (including when the argument is a Null type location).
 181   bool TraverseTypeLoc(TypeLoc TL);
 182
 183   /// \brief Recursively visit a declaration, by dispatching to
 184   /// Traverse*Decl() based on the argument's dynamic type.
 185   ///
 186   /// \returns false if the visitation was terminated early, true
 187   /// otherwise (including when the argument is NULL).
 188   bool TraverseDecl(Decl *D);
 189
 190   /// \brief Recursively visit a C++ nested-name-specifier.
 191   ///
 192   /// \returns false if the visitation was terminated early, true otherwise.
 193   bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS);
 194
 195   /// \brief Recursively visit a C++ nested-name-specifier with location
 196   /// information.
 197   ///
 198   /// \returns false if the visitation was terminated early, true otherwise.
 199   bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS);
 200
 201   /// \brief Recursively visit a name with its location information.
 202   ///
 203   /// \returns false if the visitation was terminated early, true otherwise.
 204   bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo);
 205
 206   /// \brief Recursively visit a template name and dispatch to the
 207   /// appropriate method.
 208   ///
 209   /// \returns false if the visitation was terminated early, true otherwise.
 210   bool TraverseTemplateName(TemplateName Template);
 211
 212   /// \brief Recursively visit a template argument and dispatch to the
 213   /// appropriate method for the argument type.
 214   ///
 215   /// \returns false if the visitation was terminated early, true otherwise.
 216   // FIXME: migrate callers to TemplateArgumentLoc instead.
 217   bool TraverseTemplateArgument(const TemplateArgument &Arg);
 218
 219   /// \brief Recursively visit a template argument location and dispatch to the
 220   /// appropriate method for the argument type.
 221   ///
 222   /// \returns false if the visitation was terminated early, true otherwise.
 223   bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc);
 224
 225   /// \brief Recursively visit a set of template arguments.
 226   /// This can be overridden by a subclass, but it's not expected that
 227   /// will be needed -- this visitor always dispatches to another.
 228   ///
 229   /// \returns false if the visitation was terminated early, true otherwise.
 230   // FIXME: take a TemplateArgumentLoc* (or TemplateArgumentListInfo) instead.
 231   bool TraverseTemplateArguments(const TemplateArgument *Args,
 232                                  unsigned NumArgs);
 233
 234   /// \brief Recursively visit a constructor initializer.  This
 235   /// automatically dispatches to another visitor for the initializer
 236   /// expression, but not for the name of the initializer, so may
 237   /// be overridden for clients that need access to the name.
 238   ///
 239   /// \returns false if the visitation was terminated early, true otherwise.
 240   bool TraverseConstructorInitializer(CXXCtorInitializer *Init);
 241
 242   /// \brief Recursively visit a lambda capture.
 243   ///
 244   /// \returns false if the visitation was terminated early, true otherwise.
 245   bool TraverseLambdaCapture(LambdaExpr::Capture C);
 246
 247   // ---- Methods on Stmts ----
 248
 249   // Declare Traverse*() for all concrete Stmt classes.
 250 #define ABSTRACT_STMT(STMT)
 251 #define STMT(CLASS, PARENT)                                     \
 252   bool Traverse##CLASS(CLASS *S);
 253 #include "clang/AST/StmtNodes.inc"
 254   // The above header #undefs ABSTRACT_STMT and STMT upon exit.
 255
 256   // Define WalkUpFrom*() and empty Visit*() for all Stmt classes.
 257   bool WalkUpFromStmt(Stmt *S) { return getDerived().VisitStmt(S); }
 258   bool VisitStmt(Stmt *S) { return true; }
 259 #define STMT(CLASS, PARENT)                                     \
 260   bool WalkUpFrom##CLASS(CLASS *S) {                            \
 261     TRY_TO(WalkUpFrom##PARENT(S));                              \
 262     TRY_TO(Visit##CLASS(S));                                    \
 263     return true;                                                \
 264   }                                                             \
 265   bool Visit##CLASS(CLASS *S) { return true; }
 266 #include "clang/AST/StmtNodes.inc"
 267
 268   // Define Traverse*(), WalkUpFrom*(), and Visit*() for unary
 269   // operator methods.  Unary operators are not classes in themselves
 270   // (they're all opcodes in UnaryOperator) but do have visitors.
 271 #define OPERATOR(NAME)                                           \
 272   bool TraverseUnary##NAME(UnaryOperator *S) {                  \
 273     TRY_TO(WalkUpFromUnary##NAME(S));                           \
 274     TRY_TO(TraverseStmt(S->getSubExpr()));                      \
 275     return true;                                                \
 276   }                                                             \
 277   bool WalkUpFromUnary##NAME(UnaryOperator *S) {                \
 278     TRY_TO(WalkUpFromUnaryOperator(S));                         \
 279     TRY_TO(VisitUnary##NAME(S));                                \
 280     return true;                                                \
 281   }                                                             \
 282   bool VisitUnary##NAME(UnaryOperator *S) { return true; }
 283
 284   UNARYOP_LIST()
 285 #undef OPERATOR
 286
 287   // Define Traverse*(), WalkUpFrom*(), and Visit*() for binary
 288   // operator methods.  Binary operators are not classes in themselves
 289   // (they're all opcodes in BinaryOperator) but do have visitors.
 290 #define GENERAL_BINOP_FALLBACK(NAME, BINOP_TYPE)                \
 291   bool TraverseBin##NAME(BINOP_TYPE *S) {                       \
 292     TRY_TO(WalkUpFromBin##NAME(S));                             \
 293     TRY_TO(TraverseStmt(S->getLHS()));                          \
 294     TRY_TO(TraverseStmt(S->getRHS()));                          \
 295     return true;                                                \
 296   }                                                             \
 297   bool WalkUpFromBin##NAME(BINOP_TYPE *S) {                     \
 298     TRY_TO(WalkUpFrom##BINOP_TYPE(S));                          \
 299     TRY_TO(VisitBin##NAME(S));                                  \
 300     return true;                                                \
 301   }                                                             \
 302   bool VisitBin##NAME(BINOP_TYPE *S) { return true; }
 303
 304 #define OPERATOR(NAME) GENERAL_BINOP_FALLBACK(NAME, BinaryOperator)
 305   BINOP_LIST()
 306 #undef OPERATOR
 307
 308   // Define Traverse*(), WalkUpFrom*(), and Visit*() for compound
 309   // assignment methods.  Compound assignment operators are not
 310   // classes in themselves (they're all opcodes in
 311   // CompoundAssignOperator) but do have visitors.
 312 #define OPERATOR(NAME) \
 313   GENERAL_BINOP_FALLBACK(NAME##Assign, CompoundAssignOperator)
 314
 315   CAO_LIST()
 316 #undef OPERATOR
 317 #undef GENERAL_BINOP_FALLBACK
 318
 319   // ---- Methods on Types ----
 320   // FIXME: revamp to take TypeLoc's rather than Types.
 321
 322   // Declare Traverse*() for all concrete Type classes.
 323 #define ABSTRACT_TYPE(CLASS, BASE)
 324 #define TYPE(CLASS, BASE) \
 325   bool Traverse##CLASS##Type(CLASS##Type *T);
 326 #include "clang/AST/TypeNodes.def"
 327   // The above header #undefs ABSTRACT_TYPE and TYPE upon exit.
 328
 329   // Define WalkUpFrom*() and empty Visit*() for all Type classes.
 330   bool WalkUpFromType(Type *T) { return getDerived().VisitType(T); }
 331   bool VisitType(Type *T) { return true; }
 332 #define TYPE(CLASS, BASE)                                       \
 333   bool WalkUpFrom##CLASS##Type(CLASS##Type *T) {                \
 334     TRY_TO(WalkUpFrom##BASE(T));                                \
 335     TRY_TO(Visit##CLASS##Type(T));                              \
 336     return true;                                                \
 337   }                                                             \
 338   bool Visit##CLASS##Type(CLASS##Type *T) { return true; }
 339 #include "clang/AST/TypeNodes.def"
 340
 341   // ---- Methods on TypeLocs ----
 342   // FIXME: this currently just calls the matching Type methods
 343
 344   // Declare Traverse*() for all concrete Type classes.
 345 #define ABSTRACT_TYPELOC(CLASS, BASE)
 346 #define TYPELOC(CLASS, BASE) \
 347   bool Traverse##CLASS##TypeLoc(CLASS##TypeLoc TL);
 348 #include "clang/AST/TypeLocNodes.def"
 349   // The above header #undefs ABSTRACT_TYPELOC and TYPELOC upon exit.
 350
 351   // Define WalkUpFrom*() and empty Visit*() for all TypeLoc classes.
 352   bool WalkUpFromTypeLoc(TypeLoc TL) { return getDerived().VisitTypeLoc(TL); }
 353   bool VisitTypeLoc(TypeLoc TL) { return true; }
 354
 355   // QualifiedTypeLoc and UnqualTypeLoc are not declared in
 356   // TypeNodes.def and thus need to be handled specially.
 357   bool WalkUpFromQualifiedTypeLoc(QualifiedTypeLoc TL) {
 358     return getDerived().VisitUnqualTypeLoc(TL.getUnqualifiedLoc());
 359   }
 360   bool VisitQualifiedTypeLoc(QualifiedTypeLoc TL) { return true; }
 361   bool WalkUpFromUnqualTypeLoc(UnqualTypeLoc TL) {
 362     return getDerived().VisitUnqualTypeLoc(TL.getUnqualifiedLoc());
 363   }
 364   bool VisitUnqualTypeLoc(UnqualTypeLoc TL) { return true; }
 365
 366   // Note that BASE includes trailing 'Type' which CLASS doesn't.
 367 #define TYPE(CLASS, BASE)                                       \
 368   bool WalkUpFrom##CLASS##TypeLoc(CLASS##TypeLoc TL) {          \
 369     TRY_TO(WalkUpFrom##BASE##Loc(TL));                          \
 370     TRY_TO(Visit##CLASS##TypeLoc(TL));                          \
 371     return true;                                                \
 372   }                                                             \
 373   bool Visit##CLASS##TypeLoc(CLASS##TypeLoc TL) { return true; }
 374 #include "clang/AST/TypeNodes.def"
 375
 376   // ---- Methods on Decls ----
 377
 378   // Declare Traverse*() for all concrete Decl classes.
 379 #define ABSTRACT_DECL(DECL)
 380 #define DECL(CLASS, BASE) \
 381   bool Traverse##CLASS##Decl(CLASS##Decl *D);
 382 #include "clang/AST/DeclNodes.inc"
 383   // The above header #undefs ABSTRACT_DECL and DECL upon exit.
 384
 385   // Define WalkUpFrom*() and empty Visit*() for all Decl classes.
 386   bool WalkUpFromDecl(Decl *D) { return getDerived().VisitDecl(D); }
 387   bool VisitDecl(Decl *D) { return true; }
 388 #define DECL(CLASS, BASE)                                       \
 389   bool WalkUpFrom##CLASS##Decl(CLASS##Decl *D) {                \
 390     TRY_TO(WalkUpFrom##BASE(D));                                \
 391     TRY_TO(Visit##CLASS##Decl(D));                              \
 392     return true;                                                \
 393   }                                                             \
 394   bool Visit##CLASS##Decl(CLASS##Decl *D) { return true; }
 395 #include "clang/AST/DeclNodes.inc"
 396
 397 private:
 398   // These are helper methods used by more than one Traverse* method.
 399   bool TraverseTemplateParameterListHelper(TemplateParameterList *TPL);
 400   bool TraverseClassInstantiations(ClassTemplateDecl *D);
 401   bool TraverseFunctionInstantiations(FunctionTemplateDecl *D) ;
 402   bool TraverseTemplateArgumentLocsHelper(const TemplateArgumentLoc *TAL,
 403                                           unsigned Count);
 404   bool TraverseArrayTypeLocHelper(ArrayTypeLoc TL);
 405   bool TraverseRecordHelper(RecordDecl *D);
 406   bool TraverseCXXRecordHelper(CXXRecordDecl *D);
 407   bool TraverseDeclaratorHelper(DeclaratorDecl *D);
 408   bool TraverseDeclContextHelper(DeclContext *DC);
 409   bool TraverseFunctionHelper(FunctionDecl *D);
 410   bool TraverseVarHelper(VarDecl *D);
 411
 412   struct EnqueueJob {
 413     Stmt *S;
 414     Stmt::child_iterator StmtIt;
 415
 416     EnqueueJob(Stmt *S) : S(S), StmtIt() {}
 417   };
 418   bool dataTraverse(Stmt *S);
 419   bool dataTraverseNode(Stmt *S, bool &EnqueueChildren);
 420 };
 421
 422 template<typename Derived>
 423 bool RecursiveASTVisitor<Derived>::dataTraverse(Stmt *S) {
 424
 425   SmallVector<EnqueueJob, 16> Queue;
 426   Queue.push_back(S);
 427
 428   while (!Queue.empty()) {
 429     EnqueueJob &job = Queue.back();
 430     Stmt *CurrS = job.S;
 431     if (!CurrS) {
 432       Queue.pop_back();
 433       continue;
 434     }
 435
 436     if (getDerived().shouldUseDataRecursionFor(CurrS)) {
 437       if (job.StmtIt == Stmt::child_iterator()) {
 438         bool EnqueueChildren = true;
 439         if (!dataTraverseNode(CurrS, EnqueueChildren)) return false;
 440         if (!EnqueueChildren) {
 441           Queue.pop_back();
 442           continue;
 443         }
 444         job.StmtIt = CurrS->child_begin();
 445       } else {
 446         ++job.StmtIt;
 447       }
 448
 449       if (job.StmtIt != CurrS->child_end())
 450         Queue.push_back(*job.StmtIt);
 451       else
 452         Queue.pop_back();
 453       continue;
 454     }
 455
 456     Queue.pop_back();
 457     TRY_TO(TraverseStmt(CurrS));
 458   }
 459
 460   return true;
 461 }
 462
 463 template<typename Derived>
 464 bool RecursiveASTVisitor<Derived>::dataTraverseNode(Stmt *S,
 465                                                     bool &EnqueueChildren) {
 466
 467 // The cast for DISPATCH_WALK is needed for older versions of g++, but causes
 468 // problems for MSVC.  So we'll skip the cast entirely for MSVC.
 469 #if defined(_MSC_VER)
 470   #define GCC_CAST(CLASS)
 471 #else
 472   #define GCC_CAST(CLASS) (bool (RecursiveASTVisitor::*)(CLASS*))
 473 #endif
 474
 475   // Dispatch to the corresponding WalkUpFrom* function only if the derived
 476   // class didn't override Traverse* (and thus the traversal is trivial).
 477 #define DISPATCH_WALK(NAME, CLASS, VAR) \
 478   if (&RecursiveASTVisitor::Traverse##NAME == \
 479       GCC_CAST(CLASS)&Derived::Traverse##NAME) \
 480     return getDerived().WalkUpFrom##NAME(static_cast<CLASS*>(VAR)); \
 481   EnqueueChildren = false; \
 482   return getDerived().Traverse##NAME(static_cast<CLASS*>(VAR));
 483
 484   if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(S)) {
 485     switch (BinOp->getOpcode()) {
 486 #define OPERATOR(NAME) \
 487     case BO_##NAME: DISPATCH_WALK(Bin##NAME, BinaryOperator, S);
 488
 489     BINOP_LIST()
 490 #undef OPERATOR
 491
 492 #define OPERATOR(NAME)                                          \
 493     case BO_##NAME##Assign:                          \
 494     DISPATCH_WALK(Bin##NAME##Assign, CompoundAssignOperator, S);
 495
 496     CAO_LIST()
 497 #undef OPERATOR
 498     }
 499   } else if (UnaryOperator *UnOp = dyn_cast<UnaryOperator>(S)) {
 500     switch (UnOp->getOpcode()) {
 501 #define OPERATOR(NAME)                                                  \
 502     case UO_##NAME: DISPATCH_WALK(Unary##NAME, UnaryOperator, S);
 503
 504     UNARYOP_LIST()
 505 #undef OPERATOR
 506     }
 507   }
 508
 509   // Top switch stmt: dispatch to TraverseFooStmt for each concrete FooStmt.
 510   switch (S->getStmtClass()) {
 511   case Stmt::NoStmtClass: break;
 512 #define ABSTRACT_STMT(STMT)
 513 #define STMT(CLASS, PARENT) \
 514   case Stmt::CLASS##Class: DISPATCH_WALK(CLASS, CLASS, S);
 515 #include "clang/AST/StmtNodes.inc"
 516   }
 517
 518 #undef DISPATCH_WALK
 519 #undef GCC_CAST
 520
 521   return true;
 522 }
 523
 524 #define DISPATCH(NAME, CLASS, VAR) \
 525   return getDerived().Traverse##NAME(static_cast<CLASS*>(VAR))
 526
 527 template<typename Derived>
 528 bool RecursiveASTVisitor<Derived>::TraverseStmt(Stmt *S) {
 529   if (!S)
 530     return true;
 531
 532   if (getDerived().shouldUseDataRecursionFor(S))
 533     return dataTraverse(S);
 534
 535   // If we have a binary expr, dispatch to the subcode of the binop.  A smart
 536   // optimizer (e.g. LLVM) will fold this comparison into the switch stmt
 537   // below.
 538   if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(S)) {
 539     switch (BinOp->getOpcode()) {
 540 #define OPERATOR(NAME) \
 541     case BO_##NAME: DISPATCH(Bin##NAME, BinaryOperator, S);
 542
 543     BINOP_LIST()
 544 #undef OPERATOR
 545 #undef BINOP_LIST
 546
 547 #define OPERATOR(NAME)                                          \
 548     case BO_##NAME##Assign:                          \
 549       DISPATCH(Bin##NAME##Assign, CompoundAssignOperator, S);
 550
 551     CAO_LIST()
 552 #undef OPERATOR
 553 #undef CAO_LIST
 554     }
 555   } else if (UnaryOperator *UnOp = dyn_cast<UnaryOperator>(S)) {
 556     switch (UnOp->getOpcode()) {
 557 #define OPERATOR(NAME)                                                  \
 558     case UO_##NAME: DISPATCH(Unary##NAME, UnaryOperator, S);
 559
 560     UNARYOP_LIST()
 561 #undef OPERATOR
 562 #undef UNARYOP_LIST
 563     }
 564   }
 565
 566   // Top switch stmt: dispatch to TraverseFooStmt for each concrete FooStmt.
 567   switch (S->getStmtClass()) {
 568   case Stmt::NoStmtClass: break;
 569 #define ABSTRACT_STMT(STMT)
 570 #define STMT(CLASS, PARENT) \
 571   case Stmt::CLASS##Class: DISPATCH(CLASS, CLASS, S);
 572 #include "clang/AST/StmtNodes.inc"
 573   }
 574
 575   return true;
 576 }
 577
 578 template<typename Derived>
 579 bool RecursiveASTVisitor<Derived>::TraverseType(QualType T) {
 580   if (T.isNull())
 581     return true;
 582
 583   switch (T->getTypeClass()) {
 584 #define ABSTRACT_TYPE(CLASS, BASE)
 585 #define TYPE(CLASS, BASE) \
 586   case Type::CLASS: DISPATCH(CLASS##Type, CLASS##Type, \
 587                              const_cast<Type*>(T.getTypePtr()));
 588 #include "clang/AST/TypeNodes.def"
 589   }
 590
 591   return true;
 592 }
 593
 594 template<typename Derived>
 595 bool RecursiveASTVisitor<Derived>::TraverseTypeLoc(TypeLoc TL) {
 596   if (TL.isNull())
 597     return true;
 598
 599   switch (TL.getTypeLocClass()) {
 600 #define ABSTRACT_TYPELOC(CLASS, BASE)
 601 #define TYPELOC(CLASS, BASE) \
 602   case TypeLoc::CLASS: \
 603     return getDerived().Traverse##CLASS##TypeLoc(*cast<CLASS##TypeLoc>(&TL));
 604 #include "clang/AST/TypeLocNodes.def"
 605   }
 606
 607   return true;
 608 }
 609
 610
 611 template<typename Derived>
 612 bool RecursiveASTVisitor<Derived>::TraverseDecl(Decl *D) {
 613   if (!D)
 614     return true;
 615
 616   // As a syntax visitor, by default we want to ignore declarations for
 617   // implicit declarations (ones not typed explicitly by the user).
 618   if (!getDerived().shouldVisitImplicitCode() && D->isImplicit())
 619     return true;
 620
 621   switch (D->getKind()) {
 622 #define ABSTRACT_DECL(DECL)
 623 #define DECL(CLASS, BASE) \
 624   case Decl::CLASS: DISPATCH(CLASS##Decl, CLASS##Decl, D);
 625 #include "clang/AST/DeclNodes.inc"
 626  }
 627
 628   return true;
 629 }
 630
 631 #undef DISPATCH
 632
 633 template<typename Derived>
 634 bool RecursiveASTVisitor<Derived>::TraverseNestedNameSpecifier(
 635                                                     NestedNameSpecifier *NNS) {
 636   if (!NNS)
 637     return true;
 638
 639   if (NNS->getPrefix())
 640     TRY_TO(TraverseNestedNameSpecifier(NNS->getPrefix()));
 641
 642   switch (NNS->getKind()) {
 643   case NestedNameSpecifier::Identifier:
 644   case NestedNameSpecifier::Namespace:
 645   case NestedNameSpecifier::NamespaceAlias:
 646   case NestedNameSpecifier::Global:
 647     return true;
 648
 649   case NestedNameSpecifier::TypeSpec:
 650   case NestedNameSpecifier::TypeSpecWithTemplate:
 651     TRY_TO(TraverseType(QualType(NNS->getAsType(), 0)));
 652   }
 653
 654   return true;
 655 }
 656
 657 template<typename Derived>
 658 bool RecursiveASTVisitor<Derived>::TraverseNestedNameSpecifierLoc(
 659                                                   NestedNameSpecifierLoc NNS) {
 660   if (!NNS)
 661     return true;
 662
 663    if (NestedNameSpecifierLoc Prefix = NNS.getPrefix())
 664      TRY_TO(TraverseNestedNameSpecifierLoc(Prefix));
 665
 666   switch (NNS.getNestedNameSpecifier()->getKind()) {
 667   case NestedNameSpecifier::Identifier:
 668   case NestedNameSpecifier::Namespace:
 669   case NestedNameSpecifier::NamespaceAlias:
 670   case NestedNameSpecifier::Global:
 671     return true;
 672
 673   case NestedNameSpecifier::TypeSpec:
 674   case NestedNameSpecifier::TypeSpecWithTemplate:
 675     TRY_TO(TraverseTypeLoc(NNS.getTypeLoc()));
 676     break;
 677   }
 678
 679   return true;
 680 }
 681
 682 template<typename Derived>
 683 bool RecursiveASTVisitor<Derived>::TraverseDeclarationNameInfo(
 684                                                  DeclarationNameInfo NameInfo) {
 685   switch (NameInfo.getName().getNameKind()) {
 686   case DeclarationName::CXXConstructorName:
 687   case DeclarationName::CXXDestructorName:
 688   case DeclarationName::CXXConversionFunctionName:
 689     if (TypeSourceInfo *TSInfo = NameInfo.getNamedTypeInfo())
 690       TRY_TO(TraverseTypeLoc(TSInfo->getTypeLoc()));
 691
 692     break;
 693
 694   case DeclarationName::Identifier:
 695   case DeclarationName::ObjCZeroArgSelector:
 696   case DeclarationName::ObjCOneArgSelector:
 697   case DeclarationName::ObjCMultiArgSelector:
 698   case DeclarationName::CXXOperatorName:
 699   case DeclarationName::CXXLiteralOperatorName:
 700   case DeclarationName::CXXUsingDirective:
 701     break;
 702   }
 703
 704   return true;
 705 }
 706
 707 template<typename Derived>
 708 bool RecursiveASTVisitor<Derived>::TraverseTemplateName(TemplateName Template) {
 709   if (DependentTemplateName *DTN = Template.getAsDependentTemplateName())
 710     TRY_TO(TraverseNestedNameSpecifier(DTN->getQualifier()));
 711   else if (QualifiedTemplateName *QTN = Template.getAsQualifiedTemplateName())
 712     TRY_TO(TraverseNestedNameSpecifier(QTN->getQualifier()));
 713
 714   return true;
 715 }
 716
 717 template<typename Derived>
 718 bool RecursiveASTVisitor<Derived>::TraverseTemplateArgument(
 719                                                 const TemplateArgument &Arg) {
 720   switch (Arg.getKind()) {
 721   case TemplateArgument::Null:
 722   case TemplateArgument::Declaration:
 723   case TemplateArgument::Integral:
 724     return true;
 725
 726   case TemplateArgument::Type:
 727     return getDerived().TraverseType(Arg.getAsType());
 728
 729   case TemplateArgument::Template:
 730   case TemplateArgument::TemplateExpansion:
 731     return getDerived().TraverseTemplateName(
 732                                           Arg.getAsTemplateOrTemplatePattern());
 733
 734   case TemplateArgument::Expression:
 735     return getDerived().TraverseStmt(Arg.getAsExpr());
 736
 737   case TemplateArgument::Pack:
 738     return getDerived().TraverseTemplateArguments(Arg.pack_begin(),
 739                                                   Arg.pack_size());
 740   }
 741
 742   return true;
 743 }
 744
 745 // FIXME: no template name location?
 746 // FIXME: no source locations for a template argument pack?
 747 template<typename Derived>
 748 bool RecursiveASTVisitor<Derived>::TraverseTemplateArgumentLoc(
 749                                            const TemplateArgumentLoc &ArgLoc) {
 750   const TemplateArgument &Arg = ArgLoc.getArgument();
 751
 752   switch (Arg.getKind()) {
 753   case TemplateArgument::Null:
 754   case TemplateArgument::Declaration:
 755   case TemplateArgument::Integral:
 756     return true;
 757
 758   case TemplateArgument::Type: {
 759     // FIXME: how can TSI ever be NULL?
 760     if (TypeSourceInfo *TSI = ArgLoc.getTypeSourceInfo())
 761       return getDerived().TraverseTypeLoc(TSI->getTypeLoc());
 762     else
 763       return getDerived().TraverseType(Arg.getAsType());
 764   }
 765
 766   case TemplateArgument::Template:
 767   case TemplateArgument::TemplateExpansion:
 768     if (ArgLoc.getTemplateQualifierLoc())
 769       TRY_TO(getDerived().TraverseNestedNameSpecifierLoc(
 770                                             ArgLoc.getTemplateQualifierLoc()));
 771     return getDerived().TraverseTemplateName(
 772                                          Arg.getAsTemplateOrTemplatePattern());
 773
 774   case TemplateArgument::Expression:
 775     return getDerived().TraverseStmt(ArgLoc.getSourceExpression());
 776
 777   case TemplateArgument::Pack:
 778     return getDerived().TraverseTemplateArguments(Arg.pack_begin(),
 779                                                   Arg.pack_size());
 780   }
 781
 782   return true;
 783 }
 784
 785 template<typename Derived>
 786 bool RecursiveASTVisitor<Derived>::TraverseTemplateArguments(
 787                                                   const TemplateArgument *Args,
 788                                                             unsigned NumArgs) {
 789   for (unsigned I = 0; I != NumArgs; ++I) {
 790     TRY_TO(TraverseTemplateArgument(Args[I]));
 791   }
 792
 793   return true;
 794 }
 795
 796 template<typename Derived>
 797 bool RecursiveASTVisitor<Derived>::TraverseConstructorInitializer(
 798                                                      CXXCtorInitializer *Init) {
 799   if (TypeSourceInfo *TInfo = Init->getTypeSourceInfo())
 800     TRY_TO(TraverseTypeLoc(TInfo->getTypeLoc()));
 801
 802   if (Init->isWritten())
 803     TRY_TO(TraverseStmt(Init->getInit()));
 804   return true;
 805 }
 806
 807 template<typename Derived>
 808 bool RecursiveASTVisitor<Derived>::TraverseLambdaCapture(LambdaExpr::Capture C){
 809   return true;
 810 }
 811
 812 // ----------------- Type traversal -----------------
 813
 814 // This macro makes available a variable T, the passed-in type.
 815 #define DEF_TRAVERSE_TYPE(TYPE, CODE)                     \
 816   template<typename Derived>                                           \
 817   bool RecursiveASTVisitor<Derived>::Traverse##TYPE (TYPE *T) {        \
 818     TRY_TO(WalkUpFrom##TYPE (T));                                      \
 819     { CODE; }                                                          \
 820     return true;                                                       \
 821   }
 822
 823 DEF_TRAVERSE_TYPE(BuiltinType, { })
 824
 825 DEF_TRAVERSE_TYPE(ComplexType, {
 826     TRY_TO(TraverseType(T->getElementType()));
 827   })
 828
 829 DEF_TRAVERSE_TYPE(PointerType, {
 830     TRY_TO(TraverseType(T->getPointeeType()));
 831   })
 832
 833 DEF_TRAVERSE_TYPE(BlockPointerType, {
 834     TRY_TO(TraverseType(T->getPointeeType()));
 835   })
 836
 837 DEF_TRAVERSE_TYPE(LValueReferenceType, {
 838     TRY_TO(TraverseType(T->getPointeeType()));
 839   })
 840
 841 DEF_TRAVERSE_TYPE(RValueReferenceType, {
 842     TRY_TO(TraverseType(T->getPointeeType()));
 843   })
 844
 845 DEF_TRAVERSE_TYPE(MemberPointerType, {
 846     TRY_TO(TraverseType(QualType(T->getClass(), 0)));
 847     TRY_TO(TraverseType(T->getPointeeType()));
 848   })
 849
 850 DEF_TRAVERSE_TYPE(ConstantArrayType, {
 851     TRY_TO(TraverseType(T->getElementType()));
 852   })
 853
 854 DEF_TRAVERSE_TYPE(IncompleteArrayType, {
 855     TRY_TO(TraverseType(T->getElementType()));
 856   })
 857
 858 DEF_TRAVERSE_TYPE(VariableArrayType, {
 859     TRY_TO(TraverseType(T->getElementType()));
 860     TRY_TO(TraverseStmt(T->getSizeExpr()));
 861   })
 862
 863 DEF_TRAVERSE_TYPE(DependentSizedArrayType, {
 864     TRY_TO(TraverseType(T->getElementType()));
 865     if (T->getSizeExpr())
 866       TRY_TO(TraverseStmt(T->getSizeExpr()));
 867   })
 868
 869 DEF_TRAVERSE_TYPE(DependentSizedExtVectorType, {
 870     if (T->getSizeExpr())
 871       TRY_TO(TraverseStmt(T->getSizeExpr()));
 872     TRY_TO(TraverseType(T->getElementType()));
 873   })
 874
 875 DEF_TRAVERSE_TYPE(VectorType, {
 876     TRY_TO(TraverseType(T->getElementType()));
 877   })
 878
 879 DEF_TRAVERSE_TYPE(ExtVectorType, {
 880     TRY_TO(TraverseType(T->getElementType()));
 881   })
 882
 883 DEF_TRAVERSE_TYPE(FunctionNoProtoType, {
 884     TRY_TO(TraverseType(T->getResultType()));
 885   })
 886
 887 DEF_TRAVERSE_TYPE(FunctionProtoType, {
 888     TRY_TO(TraverseType(T->getResultType()));
 889
 890     for (FunctionProtoType::arg_type_iterator A = T->arg_type_begin(),
 891                                            AEnd = T->arg_type_end();
 892          A != AEnd; ++A) {
 893       TRY_TO(TraverseType(*A));
 894     }
 895
 896     for (FunctionProtoType::exception_iterator E = T->exception_begin(),
 897                                             EEnd = T->exception_end();
 898          E != EEnd; ++E) {
 899       TRY_TO(TraverseType(*E));
 900     }
 901   })
 902
 903 DEF_TRAVERSE_TYPE(UnresolvedUsingType, { })
 904 DEF_TRAVERSE_TYPE(TypedefType, { })
 905
 906 DEF_TRAVERSE_TYPE(TypeOfExprType, {
 907     TRY_TO(TraverseStmt(T->getUnderlyingExpr()));
 908   })
 909
 910 DEF_TRAVERSE_TYPE(TypeOfType, {
 911     TRY_TO(TraverseType(T->getUnderlyingType()));
 912   })
 913
 914 DEF_TRAVERSE_TYPE(DecltypeType, {
 915     TRY_TO(TraverseStmt(T->getUnderlyingExpr()));
 916   })
 917
 918 DEF_TRAVERSE_TYPE(UnaryTransformType, {
 919     TRY_TO(TraverseType(T->getBaseType()));
 920     TRY_TO(TraverseType(T->getUnderlyingType()));
 921     })
 922
 923 DEF_TRAVERSE_TYPE(AutoType, {
 924     TRY_TO(TraverseType(T->getDeducedType()));
 925   })
 926
 927 DEF_TRAVERSE_TYPE(RecordType, { })
 928 DEF_TRAVERSE_TYPE(EnumType, { })
 929 DEF_TRAVERSE_TYPE(TemplateTypeParmType, { })
 930 DEF_TRAVERSE_TYPE(SubstTemplateTypeParmType, { })
 931 DEF_TRAVERSE_TYPE(SubstTemplateTypeParmPackType, { })
 932
 933 DEF_TRAVERSE_TYPE(TemplateSpecializationType, {
 934     TRY_TO(TraverseTemplateName(T->getTemplateName()));
 935     TRY_TO(TraverseTemplateArguments(T->getArgs(), T->getNumArgs()));
 936   })
 937
 938 DEF_TRAVERSE_TYPE(InjectedClassNameType, { })
 939
 940 DEF_TRAVERSE_TYPE(AttributedType, {
 941     TRY_TO(TraverseType(T->getModifiedType()));
 942   })
 943
 944 DEF_TRAVERSE_TYPE(ParenType, {
 945     TRY_TO(TraverseType(T->getInnerType()));
 946   })
 947
 948 DEF_TRAVERSE_TYPE(ElaboratedType, {
 949     if (T->getQualifier()) {
 950       TRY_TO(TraverseNestedNameSpecifier(T->getQualifier()));
 951     }
 952     TRY_TO(TraverseType(T->getNamedType()));
 953   })
 954
 955 DEF_TRAVERSE_TYPE(DependentNameType, {
 956     TRY_TO(TraverseNestedNameSpecifier(T->getQualifier()));
 957   })
 958
 959 DEF_TRAVERSE_TYPE(DependentTemplateSpecializationType, {
 960     TRY_TO(TraverseNestedNameSpecifier(T->getQualifier()));
 961     TRY_TO(TraverseTemplateArguments(T->getArgs(), T->getNumArgs()));
 962   })
 963
 964 DEF_TRAVERSE_TYPE(PackExpansionType, {
 965     TRY_TO(TraverseType(T->getPattern()));
 966   })
 967
 968 DEF_TRAVERSE_TYPE(ObjCInterfaceType, { })
 969
 970 DEF_TRAVERSE_TYPE(ObjCObjectType, {
 971     // We have to watch out here because an ObjCInterfaceType's base
 972     // type is itself.
 973     if (T->getBaseType().getTypePtr() != T)
 974       TRY_TO(TraverseType(T->getBaseType()));
 975   })
 976
 977 DEF_TRAVERSE_TYPE(ObjCObjectPointerType, {
 978     TRY_TO(TraverseType(T->getPointeeType()));
 979   })
 980
 981 DEF_TRAVERSE_TYPE(AtomicType, {
 982     TRY_TO(TraverseType(T->getValueType()));
 983   })
 984
 985 #undef DEF_TRAVERSE_TYPE
 986
 987 // ----------------- TypeLoc traversal -----------------
 988
 989 // This macro makes available a variable TL, the passed-in TypeLoc.
 990 // If requested, it calls WalkUpFrom* for the Type in the given TypeLoc,
 991 // in addition to WalkUpFrom* for the TypeLoc itself, such that existing
 992 // clients that override the WalkUpFrom*Type() and/or Visit*Type() methods
 993 // continue to work.
 994 #define DEF_TRAVERSE_TYPELOC(TYPE, CODE)                                \
 995   template<typename Derived>                                            \
 996   bool RecursiveASTVisitor<Derived>::Traverse##TYPE##Loc(TYPE##Loc TL) { \
 997     if (getDerived().shouldWalkTypesOfTypeLocs())                       \
 998       TRY_TO(WalkUpFrom##TYPE(const_cast<TYPE*>(TL.getTypePtr())));     \
 999     TRY_TO(WalkUpFrom##TYPE##Loc(TL));                                  \
1000     { CODE; }                                                           \
1001     return true;                                                        \
1002   }
1003
1004 template<typename Derived>
1005 bool RecursiveASTVisitor<Derived>::TraverseQualifiedTypeLoc(
1006     QualifiedTypeLoc TL) {
1007   // Move this over to the 'main' typeloc tree.  Note that this is a
1008   // move -- we pretend that we were really looking at the unqualified
1009   // typeloc all along -- rather than a recursion, so we don't follow
1010   // the normal CRTP plan of going through
1011   // getDerived().TraverseTypeLoc.  If we did, we'd be traversing
1012   // twice for the same type (once as a QualifiedTypeLoc version of
1013   // the type, once as an UnqualifiedTypeLoc version of the type),
1014   // which in effect means we'd call VisitTypeLoc twice with the
1015   // 'same' type.  This solves that problem, at the cost of never
1016   // seeing the qualified version of the type (unless the client
1017   // subclasses TraverseQualifiedTypeLoc themselves).  It's not a
1018   // perfect solution.  A perfect solution probably requires making
1019   // QualifiedTypeLoc a wrapper around TypeLoc -- like QualType is a
1020   // wrapper around Type* -- rather than being its own class in the
1021   // type hierarchy.
1022   return TraverseTypeLoc(TL.getUnqualifiedLoc());
1023 }
1024
1025 DEF_TRAVERSE_TYPELOC(BuiltinType, { })
1026
1027 // FIXME: ComplexTypeLoc is unfinished
1028 DEF_TRAVERSE_TYPELOC(ComplexType, {
1029     TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1030   })
1031
1032 DEF_TRAVERSE_TYPELOC(PointerType, {
1033     TRY_TO(TraverseTypeLoc(TL.getPointeeLoc()));
1034   })
1035
1036 DEF_TRAVERSE_TYPELOC(BlockPointerType, {
1037     TRY_TO(TraverseTypeLoc(TL.getPointeeLoc()));
1038   })
1039
1040 DEF_TRAVERSE_TYPELOC(LValueReferenceType, {
1041     TRY_TO(TraverseTypeLoc(TL.getPointeeLoc()));
1042   })
1043
1044 DEF_TRAVERSE_TYPELOC(RValueReferenceType, {
1045     TRY_TO(TraverseTypeLoc(TL.getPointeeLoc()));
1046   })
1047
1048 // FIXME: location of base class?
1049 // We traverse this in the type case as well, but how is it not reached through
1050 // the pointee type?
1051 DEF_TRAVERSE_TYPELOC(MemberPointerType, {
1052     TRY_TO(TraverseType(QualType(TL.getTypePtr()->getClass(), 0)));
1053     TRY_TO(TraverseTypeLoc(TL.getPointeeLoc()));
1054   })
1055
1056 template<typename Derived>
1057 bool RecursiveASTVisitor<Derived>::TraverseArrayTypeLocHelper(ArrayTypeLoc TL) {
1058   // This isn't available for ArrayType, but is for the ArrayTypeLoc.
1059   TRY_TO(TraverseStmt(TL.getSizeExpr()));
1060   return true;
1061 }
1062
1063 DEF_TRAVERSE_TYPELOC(ConstantArrayType, {
1064     TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1065     return TraverseArrayTypeLocHelper(TL);
1066   })
1067
1068 DEF_TRAVERSE_TYPELOC(IncompleteArrayType, {
1069     TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1070     return TraverseArrayTypeLocHelper(TL);
1071   })
1072
1073 DEF_TRAVERSE_TYPELOC(VariableArrayType, {
1074     TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1075     return TraverseArrayTypeLocHelper(TL);
1076   })
1077
1078 DEF_TRAVERSE_TYPELOC(DependentSizedArrayType, {
1079     TRY_TO(TraverseTypeLoc(TL.getElementLoc()));
1080     return TraverseArrayTypeLocHelper(TL);
1081   })
1082
1083 // FIXME: order? why not size expr first?
1084 // FIXME: base VectorTypeLoc is unfinished
1085 DEF_TRAVERSE_TYPELOC(DependentSizedExtVectorType, {
1086     if (TL.getTypePtr()->getSizeExpr())
1087       TRY_TO(TraverseStmt(TL.getTypePtr()->getSizeExpr()));
1088     TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1089   })
1090
1091 // FIXME: VectorTypeLoc is unfinished
1092 DEF_TRAVERSE_TYPELOC(VectorType, {
1093     TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1094   })
1095
1096 // FIXME: size and attributes
1097 // FIXME: base VectorTypeLoc is unfinished
1098 DEF_TRAVERSE_TYPELOC(ExtVectorType, {
1099     TRY_TO(TraverseType(TL.getTypePtr()->getElementType()));
1100   })
1101
1102 DEF_TRAVERSE_TYPELOC(FunctionNoProtoType, {
1103     TRY_TO(TraverseTypeLoc(TL.getResultLoc()));
1104   })
1105
1106 // FIXME: location of exception specifications (attributes?)
1107 DEF_TRAVERSE_TYPELOC(FunctionProtoType, {
1108     TRY_TO(TraverseTypeLoc(TL.getResultLoc()));
1109
1110     const FunctionProtoType *T = TL.getTypePtr();
1111
1112     for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I) {
1113       if (TL.getArg(I)) {
1114         TRY_TO(TraverseDecl(TL.getArg(I)));
1115       } else if (I < T->getNumArgs()) {
1116         TRY_TO(TraverseType(T->getArgType(I)));
1117       }
1118     }
1119
1120     for (FunctionProtoType::exception_iterator E = T->exception_begin(),
1121                                             EEnd = T->exception_end();
1122          E != EEnd; ++E) {
1123       TRY_TO(TraverseType(*E));
1124     }
1125   })
1126
1127 DEF_TRAVERSE_TYPELOC(UnresolvedUsingType, { })
1128 DEF_TRAVERSE_TYPELOC(TypedefType, { })
1129
1130 DEF_TRAVERSE_TYPELOC(TypeOfExprType, {
1131     TRY_TO(TraverseStmt(TL.getUnderlyingExpr()));
1132   })
1133
1134 DEF_TRAVERSE_TYPELOC(TypeOfType, {
1135     TRY_TO(TraverseTypeLoc(TL.getUnderlyingTInfo()->getTypeLoc()));
1136   })
1137
1138 // FIXME: location of underlying expr
1139 DEF_TRAVERSE_TYPELOC(DecltypeType, {
1140     TRY_TO(TraverseStmt(TL.getTypePtr()->getUnderlyingExpr()));
1141   })
1142
1143 DEF_TRAVERSE_TYPELOC(UnaryTransformType, {
1144     TRY_TO(TraverseTypeLoc(TL.getUnderlyingTInfo()->getTypeLoc()));
1145   })
1146
1147 DEF_TRAVERSE_TYPELOC(AutoType, {
1148     TRY_TO(TraverseType(TL.getTypePtr()->getDeducedType()));
1149   })
1150
1151 DEF_TRAVERSE_TYPELOC(RecordType, { })
1152 DEF_TRAVERSE_TYPELOC(EnumType, { })
1153 DEF_TRAVERSE_TYPELOC(TemplateTypeParmType, { })
1154 DEF_TRAVERSE_TYPELOC(SubstTemplateTypeParmType, { })
1155 DEF_TRAVERSE_TYPELOC(SubstTemplateTypeParmPackType, { })
1156
1157 // FIXME: use the loc for the template name?
1158 DEF_TRAVERSE_TYPELOC(TemplateSpecializationType, {
1159     TRY_TO(TraverseTemplateName(TL.getTypePtr()->getTemplateName()));
1160     for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I) {
1161       TRY_TO(TraverseTemplateArgumentLoc(TL.getArgLoc(I)));
1162     }
1163   })
1164
1165 DEF_TRAVERSE_TYPELOC(InjectedClassNameType, { })
1166
1167 DEF_TRAVERSE_TYPELOC(ParenType, {
1168     TRY_TO(TraverseTypeLoc(TL.getInnerLoc()));
1169   })
1170
1171 DEF_TRAVERSE_TYPELOC(AttributedType, {
1172     TRY_TO(TraverseTypeLoc(TL.getModifiedLoc()));
1173   })
1174
1175 DEF_TRAVERSE_TYPELOC(ElaboratedType, {
1176     if (TL.getQualifierLoc()) {
1177       TRY_TO(TraverseNestedNameSpecifierLoc(TL.getQualifierLoc()));
1178     }
1179     TRY_TO(TraverseTypeLoc(TL.getNamedTypeLoc()));
1180   })
1181
1182 DEF_TRAVERSE_TYPELOC(DependentNameType, {
1183     TRY_TO(TraverseNestedNameSpecifierLoc(TL.getQualifierLoc()));
1184   })
1185
1186 DEF_TRAVERSE_TYPELOC(DependentTemplateSpecializationType, {
1187     if (TL.getQualifierLoc()) {
1188       TRY_TO(TraverseNestedNameSpecifierLoc(TL.getQualifierLoc()));
1189     }
1190
1191     for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I) {
1192       TRY_TO(TraverseTemplateArgumentLoc(TL.getArgLoc(I)));
1193     }
1194   })
1195
1196 DEF_TRAVERSE_TYPELOC(PackExpansionType, {
1197     TRY_TO(TraverseTypeLoc(TL.getPatternLoc()));
1198   })
1199
1200 DEF_TRAVERSE_TYPELOC(ObjCInterfaceType, { })
1201
1202 DEF_TRAVERSE_TYPELOC(ObjCObjectType, {
1203     // We have to watch out here because an ObjCInterfaceType's base
1204     // type is itself.
1205     if (TL.getTypePtr()->getBaseType().getTypePtr() != TL.getTypePtr())
1206       TRY_TO(TraverseTypeLoc(TL.getBaseLoc()));
1207   })
1208
1209 DEF_TRAVERSE_TYPELOC(ObjCObjectPointerType, {
1210     TRY_TO(TraverseTypeLoc(TL.getPointeeLoc()));
1211   })
1212
1213 DEF_TRAVERSE_TYPELOC(AtomicType, {
1214     TRY_TO(TraverseTypeLoc(TL.getValueLoc()));
1215   })
1216
1217 #undef DEF_TRAVERSE_TYPELOC
1218
1219 // ----------------- Decl traversal -----------------
1220 //
1221 // For a Decl, we automate (in the DEF_TRAVERSE_DECL macro) traversing
1222 // the children that come from the DeclContext associated with it.
1223 // Therefore each Traverse* only needs to worry about children other
1224 // than those.
1225
1226 template<typename Derived>
1227 bool RecursiveASTVisitor<Derived>::TraverseDeclContextHelper(DeclContext *DC) {
1228   if (!DC)
1229     return true;
1230
1231   for (DeclContext::decl_iterator Child = DC->decls_begin(),
1232            ChildEnd = DC->decls_end();
1233        Child != ChildEnd; ++Child) {
1234     // BlockDecls are traversed through BlockExprs.
1235     if (!isa<BlockDecl>(*Child))
1236       TRY_TO(TraverseDecl(*Child));
1237   }
1238
1239   return true;
1240 }
1241
1242 // This macro makes available a variable D, the passed-in decl.
1243 #define DEF_TRAVERSE_DECL(DECL, CODE)                           \
1244 template<typename Derived>                                      \
1245 bool RecursiveASTVisitor<Derived>::Traverse##DECL (DECL *D) {   \
1246   TRY_TO(WalkUpFrom##DECL (D));                                 \
1247   { CODE; }                                                     \
1248   TRY_TO(TraverseDeclContextHelper(dyn_cast<DeclContext>(D)));  \
1249   return true;                                                  \
1250 }
1251
1252 DEF_TRAVERSE_DECL(AccessSpecDecl, { })
1253
1254 DEF_TRAVERSE_DECL(BlockDecl, {
1255     if (TypeSourceInfo *TInfo = D->getSignatureAsWritten())
1256       TRY_TO(TraverseTypeLoc(TInfo->getTypeLoc()));
1257     TRY_TO(TraverseStmt(D->getBody()));
1258     // This return statement makes sure the traversal of nodes in
1259     // decls_begin()/decls_end() (done in the DEF_TRAVERSE_DECL macro)
1260     // is skipped - don't remove it.
1261     return true;
1262   })
1263
1264 DEF_TRAVERSE_DECL(FileScopeAsmDecl, {
1265     TRY_TO(TraverseStmt(D->getAsmString()));
1266   })
1267
1268 DEF_TRAVERSE_DECL(ImportDecl, { })
1269
1270 DEF_TRAVERSE_DECL(FriendDecl, {
1271     // Friend is either decl or a type.
1272     if (D->getFriendType())
1273       TRY_TO(TraverseTypeLoc(D->getFriendType()->getTypeLoc()));
1274     else
1275       TRY_TO(TraverseDecl(D->getFriendDecl()));
1276   })
1277
1278 DEF_TRAVERSE_DECL(FriendTemplateDecl, {
1279     if (D->getFriendType())
1280       TRY_TO(TraverseTypeLoc(D->getFriendType()->getTypeLoc()));
1281     else
1282       TRY_TO(TraverseDecl(D->getFriendDecl()));
1283     for (unsigned I = 0, E = D->getNumTemplateParameters(); I < E; ++I) {
1284       TemplateParameterList *TPL = D->getTemplateParameterList(I);
1285       for (TemplateParameterList::iterator ITPL = TPL->begin(),
1286                                            ETPL = TPL->end();
1287            ITPL != ETPL; ++ITPL) {
1288         TRY_TO(TraverseDecl(*ITPL));
1289       }
1290     }
1291   })
1292
1293 DEF_TRAVERSE_DECL(ClassScopeFunctionSpecializationDecl, {
1294     TRY_TO(TraverseDecl(D->getSpecialization()));
1295
1296     if (D->hasExplicitTemplateArgs()) {
1297       const TemplateArgumentListInfo& args = D->templateArgs();
1298       TRY_TO(TraverseTemplateArgumentLocsHelper(
1299           args.getArgumentArray(), args.size()));
1300     }
1301  })
1302
1303 DEF_TRAVERSE_DECL(LinkageSpecDecl, { })
1304
1305 DEF_TRAVERSE_DECL(ObjCPropertyImplDecl, {
1306     // FIXME: implement this
1307   })
1308
1309 DEF_TRAVERSE_DECL(StaticAssertDecl, {
1310     TRY_TO(TraverseStmt(D->getAssertExpr()));
1311     TRY_TO(TraverseStmt(D->getMessage()));
1312   })
1313
1314 DEF_TRAVERSE_DECL(TranslationUnitDecl, {
1315     // Code in an unnamed namespace shows up automatically in
1316     // decls_begin()/decls_end().  Thus we don't need to recurse on
1317     // D->getAnonymousNamespace().
1318   })
1319
1320 DEF_TRAVERSE_DECL(NamespaceAliasDecl, {
1321     // We shouldn't traverse an aliased namespace, since it will be
1322     // defined (and, therefore, traversed) somewhere else.
1323     //
1324     // This return statement makes sure the traversal of nodes in
1325     // decls_begin()/decls_end() (done in the DEF_TRAVERSE_DECL macro)
1326     // is skipped - don't remove it.
1327     return true;
1328   })
1329
1330 DEF_TRAVERSE_DECL(LabelDecl, {
1331   // There is no code in a LabelDecl.
1332 })
1333
1334
1335 DEF_TRAVERSE_DECL(NamespaceDecl, {
1336     // Code in an unnamed namespace shows up automatically in
1337     // decls_begin()/decls_end().  Thus we don't need to recurse on
1338     // D->getAnonymousNamespace().
1339   })
1340
1341 DEF_TRAVERSE_DECL(ObjCCompatibleAliasDecl, {
1342     // FIXME: implement
1343   })
1344
1345 DEF_TRAVERSE_DECL(ObjCCategoryDecl, {
1346     // FIXME: implement
1347   })
1348
1349 DEF_TRAVERSE_DECL(ObjCCategoryImplDecl, {
1350     // FIXME: implement
1351   })
1352
1353 DEF_TRAVERSE_DECL(ObjCImplementationDecl, {
1354     // FIXME: implement
1355   })
1356
1357 DEF_TRAVERSE_DECL(ObjCInterfaceDecl, {
1358     // FIXME: implement
1359   })
1360
1361 DEF_TRAVERSE_DECL(ObjCProtocolDecl, {
1362     // FIXME: implement
1363   })
1364
1365 DEF_TRAVERSE_DECL(ObjCMethodDecl, {
1366     if (D->getResultTypeSourceInfo()) {
1367       TRY_TO(TraverseTypeLoc(D->getResultTypeSourceInfo()->getTypeLoc()));
1368     }
1369     for (ObjCMethodDecl::param_iterator
1370            I = D->param_begin(), E = D->param_end(); I != E; ++I) {
1371       TRY_TO(TraverseDecl(*I));
1372     }
1373     if (D->isThisDeclarationADefinition()) {
1374       TRY_TO(TraverseStmt(D->getBody()));
1375     }
1376     return true;
1377   })
1378
1379 DEF_TRAVERSE_DECL(ObjCPropertyDecl, {
1380     // FIXME: implement
1381   })
1382
1383 DEF_TRAVERSE_DECL(UsingDecl, {
1384     TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1385     TRY_TO(TraverseDeclarationNameInfo(D->getNameInfo()));
1386   })
1387
1388 DEF_TRAVERSE_DECL(UsingDirectiveDecl, {
1389     TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1390   })
1391
1392 DEF_TRAVERSE_DECL(UsingShadowDecl, { })
1393
1394 // A helper method for TemplateDecl's children.
1395 template<typename Derived>
1396 bool RecursiveASTVisitor<Derived>::TraverseTemplateParameterListHelper(
1397     TemplateParameterList *TPL) {
1398   if (TPL) {
1399     for (TemplateParameterList::iterator I = TPL->begin(), E = TPL->end();
1400          I != E; ++I) {
1401       TRY_TO(TraverseDecl(*I));
1402     }
1403   }
1404   return true;
1405 }
1406
1407 // A helper method for traversing the implicit instantiations of a
1408 // class template.
1409 template<typename Derived>
1410 bool RecursiveASTVisitor<Derived>::TraverseClassInstantiations(
1411     ClassTemplateDecl *D) {
1412   ClassTemplateDecl::spec_iterator end = D->spec_end();
1413   for (ClassTemplateDecl::spec_iterator it = D->spec_begin(); it != end; ++it) {
1414     ClassTemplateSpecializationDecl* SD = *it;
1415
1416     switch (SD->getSpecializationKind()) {
1417     // Visit the implicit instantiations with the requested pattern.
1418     case TSK_Undeclared:
1419     case TSK_ImplicitInstantiation:
1420       TRY_TO(TraverseDecl(SD));
1421       break;
1422
1423     // We don't need to do anything on an explicit instantiation
1424     // or explicit specialization because there will be an explicit
1425     // node for it elsewhere.
1426     case TSK_ExplicitInstantiationDeclaration:
1427     case TSK_ExplicitInstantiationDefinition:
1428     case TSK_ExplicitSpecialization:
1429       break;
1430     }
1431   }
1432
1433   return true;
1434 }
1435
1436 DEF_TRAVERSE_DECL(ClassTemplateDecl, {
1437     CXXRecordDecl* TempDecl = D->getTemplatedDecl();
1438     TRY_TO(TraverseDecl(TempDecl));
1439     TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters()));
1440
1441     // By default, we do not traverse the instantiations of
1442     // class templates since they do not appear in the user code. The
1443     // following code optionally traverses them.
1444     //
1445     // We only traverse the class instantiations when we see the canonical
1446     // declaration of the template, to ensure we only visit them once.
1447     if (getDerived().shouldVisitTemplateInstantiations() &&
1448         D == D->getCanonicalDecl())
1449       TRY_TO(TraverseClassInstantiations(D));
1450
1451     // Note that getInstantiatedFromMemberTemplate() is just a link
1452     // from a template instantiation back to the template from which
1453     // it was instantiated, and thus should not be traversed.
1454   })
1455
1456 // A helper method for traversing the instantiations of a
1457 // function while skipping its specializations.
1458 template<typename Derived>
1459 bool RecursiveASTVisitor<Derived>::TraverseFunctionInstantiations(
1460     FunctionTemplateDecl *D) {
1461   FunctionTemplateDecl::spec_iterator end = D->spec_end();
1462   for (FunctionTemplateDecl::spec_iterator it = D->spec_begin(); it != end;
1463        ++it) {
1464     FunctionDecl* FD = *it;
1465     switch (FD->getTemplateSpecializationKind()) {
1466     case TSK_Undeclared:
1467     case TSK_ImplicitInstantiation:
1468       // We don't know what kind of FunctionDecl this is.
1469       TRY_TO(TraverseDecl(FD));
1470       break;
1471
1472     // FIXME: For now traverse explicit instantiations here. Change that
1473     // once they are represented as dedicated nodes in the AST.
1474     case TSK_ExplicitInstantiationDeclaration:
1475     case TSK_ExplicitInstantiationDefinition:
1476       TRY_TO(TraverseDecl(FD));
1477       break;
1478
1479     case TSK_ExplicitSpecialization:
1480       break;
1481     }
1482   }
1483
1484   return true;
1485 }
1486
1487 DEF_TRAVERSE_DECL(FunctionTemplateDecl, {
1488     TRY_TO(TraverseDecl(D->getTemplatedDecl()));
1489     TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters()));
1490
1491     // By default, we do not traverse the instantiations of
1492     // function templates since they do not appear in the user code. The
1493     // following code optionally traverses them.
1494     //
1495     // We only traverse the function instantiations when we see the canonical
1496     // declaration of the template, to ensure we only visit them once.
1497     if (getDerived().shouldVisitTemplateInstantiations() &&
1498         D == D->getCanonicalDecl())
1499       TRY_TO(TraverseFunctionInstantiations(D));
1500   })
1501
1502 DEF_TRAVERSE_DECL(TemplateTemplateParmDecl, {
1503     // D is the "T" in something like
1504     //   template <template <typename> class T> class container { };
1505     TRY_TO(TraverseDecl(D->getTemplatedDecl()));
1506     if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited()) {
1507       TRY_TO(TraverseTemplateArgumentLoc(D->getDefaultArgument()));
1508     }
1509     TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters()));
1510   })
1511
1512 DEF_TRAVERSE_DECL(TemplateTypeParmDecl, {
1513     // D is the "T" in something like "template<typename T> class vector;"
1514     if (D->getTypeForDecl())
1515       TRY_TO(TraverseType(QualType(D->getTypeForDecl(), 0)));
1516     if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
1517       TRY_TO(TraverseTypeLoc(D->getDefaultArgumentInfo()->getTypeLoc()));
1518   })
1519
1520 DEF_TRAVERSE_DECL(TypedefDecl, {
1521     TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1522     // We shouldn't traverse D->getTypeForDecl(); it's a result of
1523     // declaring the typedef, not something that was written in the
1524     // source.
1525   })
1526
1527 DEF_TRAVERSE_DECL(TypeAliasDecl, {
1528     TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1529     // We shouldn't traverse D->getTypeForDecl(); it's a result of
1530     // declaring the type alias, not something that was written in the
1531     // source.
1532   })
1533
1534 DEF_TRAVERSE_DECL(TypeAliasTemplateDecl, {
1535     TRY_TO(TraverseDecl(D->getTemplatedDecl()));
1536     TRY_TO(TraverseTemplateParameterListHelper(D->getTemplateParameters()));
1537   })
1538
1539 DEF_TRAVERSE_DECL(UnresolvedUsingTypenameDecl, {
1540     // A dependent using declaration which was marked with 'typename'.
1541     //   template<class T> class A : public B<T> { using typename B<T>::foo; };
1542     TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1543     // We shouldn't traverse D->getTypeForDecl(); it's a result of
1544     // declaring the type, not something that was written in the
1545     // source.
1546   })
1547
1548 DEF_TRAVERSE_DECL(EnumDecl, {
1549     if (D->getTypeForDecl())
1550       TRY_TO(TraverseType(QualType(D->getTypeForDecl(), 0)));
1551
1552     TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1553     // The enumerators are already traversed by
1554     // decls_begin()/decls_end().
1555   })
1556
1557
1558 // Helper methods for RecordDecl and its children.
1559 template<typename Derived>
1560 bool RecursiveASTVisitor<Derived>::TraverseRecordHelper(
1561     RecordDecl *D) {
1562   // We shouldn't traverse D->getTypeForDecl(); it's a result of
1563   // declaring the type, not something that was written in the source.
1564
1565   TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1566   return true;
1567 }
1568
1569 template<typename Derived>
1570 bool RecursiveASTVisitor<Derived>::TraverseCXXRecordHelper(
1571     CXXRecordDecl *D) {
1572   if (!TraverseRecordHelper(D))
1573     return false;
1574   if (D->isCompleteDefinition()) {
1575     for (CXXRecordDecl::base_class_iterator I = D->bases_begin(),
1576                                             E = D->bases_end();
1577          I != E; ++I) {
1578       TRY_TO(TraverseTypeLoc(I->getTypeSourceInfo()->getTypeLoc()));
1579     }
1580     // We don't traverse the friends or the conversions, as they are
1581     // already in decls_begin()/decls_end().
1582   }
1583   return true;
1584 }
1585
1586 DEF_TRAVERSE_DECL(RecordDecl, {
1587     TRY_TO(TraverseRecordHelper(D));
1588   })
1589
1590 DEF_TRAVERSE_DECL(CXXRecordDecl, {
1591     TRY_TO(TraverseCXXRecordHelper(D));
1592   })
1593
1594 DEF_TRAVERSE_DECL(ClassTemplateSpecializationDecl, {
1595     // For implicit instantiations ("set<int> x;"), we don't want to
1596     // recurse at all, since the instatiated class isn't written in
1597     // the source code anywhere.  (Note the instatiated *type* --
1598     // set<int> -- is written, and will still get a callback of
1599     // TemplateSpecializationType).  For explicit instantiations
1600     // ("template set<int>;"), we do need a callback, since this
1601     // is the only callback that's made for this instantiation.
1602     // We use getTypeAsWritten() to distinguish.
1603     if (TypeSourceInfo *TSI = D->getTypeAsWritten())
1604       TRY_TO(TraverseTypeLoc(TSI->getTypeLoc()));
1605
1606     if (!getDerived().shouldVisitTemplateInstantiations() &&
1607         D->getTemplateSpecializationKind() != TSK_ExplicitSpecialization)
1608       // Returning from here skips traversing the
1609       // declaration context of the ClassTemplateSpecializationDecl
1610       // (embedded in the DEF_TRAVERSE_DECL() macro)
1611       // which contains the instantiated members of the class.
1612       return true;
1613   })
1614
1615 template <typename Derived>
1616 bool RecursiveASTVisitor<Derived>::TraverseTemplateArgumentLocsHelper(
1617     const TemplateArgumentLoc *TAL, unsigned Count) {
1618   for (unsigned I = 0; I < Count; ++I) {
1619     TRY_TO(TraverseTemplateArgumentLoc(TAL[I]));
1620   }
1621   return true;
1622 }
1623
1624 DEF_TRAVERSE_DECL(ClassTemplatePartialSpecializationDecl, {
1625     // The partial specialization.
1626     if (TemplateParameterList *TPL = D->getTemplateParameters()) {
1627       for (TemplateParameterList::iterator I = TPL->begin(), E = TPL->end();
1628            I != E; ++I) {
1629         TRY_TO(TraverseDecl(*I));
1630       }
1631     }
1632     // The args that remains unspecialized.
1633     TRY_TO(TraverseTemplateArgumentLocsHelper(
1634         D->getTemplateArgsAsWritten(), D->getNumTemplateArgsAsWritten()));
1635
1636     // Don't need the ClassTemplatePartialSpecializationHelper, even
1637     // though that's our parent class -- we already visit all the
1638     // template args here.
1639     TRY_TO(TraverseCXXRecordHelper(D));
1640
1641     // Instantiations will have been visited with the primary template.
1642   })
1643
1644 DEF_TRAVERSE_DECL(EnumConstantDecl, {
1645     TRY_TO(TraverseStmt(D->getInitExpr()));
1646   })
1647
1648 DEF_TRAVERSE_DECL(UnresolvedUsingValueDecl, {
1649     // Like UnresolvedUsingTypenameDecl, but without the 'typename':
1650     //    template <class T> Class A : public Base<T> { using Base<T>::foo; };
1651     TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1652     TRY_TO(TraverseDeclarationNameInfo(D->getNameInfo()));
1653   })
1654
1655 DEF_TRAVERSE_DECL(IndirectFieldDecl, {})
1656
1657 template<typename Derived>
1658 bool RecursiveASTVisitor<Derived>::TraverseDeclaratorHelper(DeclaratorDecl *D) {
1659   TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1660   if (D->getTypeSourceInfo())
1661     TRY_TO(TraverseTypeLoc(D->getTypeSourceInfo()->getTypeLoc()));
1662   else
1663     TRY_TO(TraverseType(D->getType()));
1664   return true;
1665 }
1666
1667 DEF_TRAVERSE_DECL(FieldDecl, {
1668     TRY_TO(TraverseDeclaratorHelper(D));
1669     if (D->isBitField())
1670       TRY_TO(TraverseStmt(D->getBitWidth()));
1671     else if (D->hasInClassInitializer())
1672       TRY_TO(TraverseStmt(D->getInClassInitializer()));
1673   })
1674
1675 DEF_TRAVERSE_DECL(ObjCAtDefsFieldDecl, {
1676     TRY_TO(TraverseDeclaratorHelper(D));
1677     if (D->isBitField())
1678       TRY_TO(TraverseStmt(D->getBitWidth()));
1679     // FIXME: implement the rest.
1680   })
1681
1682 DEF_TRAVERSE_DECL(ObjCIvarDecl, {
1683     TRY_TO(TraverseDeclaratorHelper(D));
1684     if (D->isBitField())
1685       TRY_TO(TraverseStmt(D->getBitWidth()));
1686     // FIXME: implement the rest.
1687   })
1688
1689 template<typename Derived>
1690 bool RecursiveASTVisitor<Derived>::TraverseFunctionHelper(FunctionDecl *D) {
1691   TRY_TO(TraverseNestedNameSpecifierLoc(D->getQualifierLoc()));
1692   TRY_TO(TraverseDeclarationNameInfo(D->getNameInfo()));
1693
1694   // If we're an explicit template specialization, iterate over the
1695   // template args that were explicitly specified.  If we were doing
1696   // this in typing order, we'd do it between the return type and
1697   // the function args, but both are handled by the FunctionTypeLoc
1698   // above, so we have to choose one side.  I've decided to do before.
1699   if (const FunctionTemplateSpecializationInfo *FTSI =
1700       D->getTemplateSpecializationInfo()) {
1701     if (FTSI->getTemplateSpecializationKind() != TSK_Undeclared &&
1702         FTSI->getTemplateSpecializationKind() != TSK_ImplicitInstantiation) {
1703       // A specialization might not have explicit template arguments if it has
1704       // a templated return type and concrete arguments.
1705       if (const ASTTemplateArgumentListInfo *TALI =
1706           FTSI->TemplateArgumentsAsWritten) {
1707         TRY_TO(TraverseTemplateArgumentLocsHelper(TALI->getTemplateArgs(),
1708                                                   TALI->NumTemplateArgs));
1709       }
1710     }
1711   }
1712
1713   // Visit the function type itself, which can be either
1714   // FunctionNoProtoType or FunctionProtoType, or a typedef.  This
1715   // also covers the return type and the function parameters,
1716   // including exception specifications.
1717   if (clang::TypeSourceInfo *TSI = D->getTypeSourceInfo()) {
1718     TRY_TO(TraverseTypeLoc(TSI->getTypeLoc()));
1719   }
1720
1721   if (CXXConstructorDecl *Ctor = dyn_cast<CXXConstructorDecl>(D)) {
1722     // Constructor initializers.
1723     for (CXXConstructorDecl::init_iterator I = Ctor->init_begin(),
1724                                            E = Ctor->init_end();
1725          I != E; ++I) {
1726       TRY_TO(TraverseConstructorInitializer(*I));
1727     }
1728   }
1729
1730   if (D->isThisDeclarationADefinition()) {
1731     TRY_TO(TraverseStmt(D->getBody()));  // Function body.
1732   }
1733   return true;
1734 }
1735
1736 DEF_TRAVERSE_DECL(FunctionDecl, {
1737     // We skip decls_begin/decls_end, which are already covered by
1738     // TraverseFunctionHelper().
1739     return TraverseFunctionHelper(D);
1740   })
1741
1742 DEF_TRAVERSE_DECL(CXXMethodDecl, {
1743     // We skip decls_begin/decls_end, which are already covered by
1744     // TraverseFunctionHelper().
1745     return TraverseFunctionHelper(D);
1746   })
1747
1748 DEF_TRAVERSE_DECL(CXXConstructorDecl, {
1749     // We skip decls_begin/decls_end, which are already covered by
1750     // TraverseFunctionHelper().
1751     return TraverseFunctionHelper(D);
1752   })
1753
1754 // CXXConversionDecl is the declaration of a type conversion operator.
1755 // It's not a cast expression.
1756 DEF_TRAVERSE_DECL(CXXConversionDecl, {
1757     // We skip decls_begin/decls_end, which are already covered by
1758     // TraverseFunctionHelper().
1759     return TraverseFunctionHelper(D);
1760   })
1761
1762 DEF_TRAVERSE_DECL(CXXDestructorDecl, {
1763     // We skip decls_begin/decls_end, which are already covered by
1764     // TraverseFunctionHelper().
1765     return TraverseFunctionHelper(D);
1766   })
1767
1768 template<typename Derived>
1769 bool RecursiveASTVisitor<Derived>::TraverseVarHelper(VarDecl *D) {
1770   TRY_TO(TraverseDeclaratorHelper(D));
1771   // Default params are taken care of when we traverse the ParmVarDecl.
1772   if (!isa<ParmVarDecl>(D) &&
1773       (!D->isCXXForRangeDecl() || getDerived().shouldVisitImplicitCode()))
1774     TRY_TO(TraverseStmt(D->getInit()));
1775   return true;
1776 }
1777
1778 DEF_TRAVERSE_DECL(VarDecl, {
1779     TRY_TO(TraverseVarHelper(D));
1780   })
1781
1782 DEF_TRAVERSE_DECL(ImplicitParamDecl, {
1783     TRY_TO(TraverseVarHelper(D));
1784   })
1785
1786 DEF_TRAVERSE_DECL(NonTypeTemplateParmDecl, {
1787     // A non-type template parameter, e.g. "S" in template<int S> class Foo ...
1788     TRY_TO(TraverseDeclaratorHelper(D));
1789     if (D->hasDefaultArgument() && !D->defaultArgumentWasInherited())
1790       TRY_TO(TraverseStmt(D->getDefaultArgument()));
1791   })
1792
1793 DEF_TRAVERSE_DECL(ParmVarDecl, {
1794     TRY_TO(TraverseVarHelper(D));
1795
1796     if (D->hasDefaultArg() &&
1797         D->hasUninstantiatedDefaultArg() &&
1798         !D->hasUnparsedDefaultArg())
1799       TRY_TO(TraverseStmt(D->getUninstantiatedDefaultArg()));
1800
1801     if (D->hasDefaultArg() &&
1802         !D->hasUninstantiatedDefaultArg() &&
1803         !D->hasUnparsedDefaultArg())
1804       TRY_TO(TraverseStmt(D->getDefaultArg()));
1805   })
1806
1807 #undef DEF_TRAVERSE_DECL
1808
1809 // ----------------- Stmt traversal -----------------
1810 //
1811 // For stmts, we automate (in the DEF_TRAVERSE_STMT macro) iterating
1812 // over the children defined in children() (every stmt defines these,
1813 // though sometimes the range is empty).  Each individual Traverse*
1814 // method only needs to worry about children other than those.  To see
1815 // what children() does for a given class, see, e.g.,
1816 //   http://clang.llvm.org/doxygen/Stmt_8cpp_source.html
1817
1818 // This macro makes available a variable S, the passed-in stmt.
1819 #define DEF_TRAVERSE_STMT(STMT, CODE)                                   \
1820 template<typename Derived>                                              \
1821 bool RecursiveASTVisitor<Derived>::Traverse##STMT (STMT *S) {           \
1822   TRY_TO(WalkUpFrom##STMT(S));                                          \
1823   { CODE; }                                                             \
1824   for (Stmt::child_range range = S->children(); range; ++range) {       \
1825     TRY_TO(TraverseStmt(*range));                                       \
1826   }                                                                     \
1827   return true;                                                          \
1828 }
1829
1830 DEF_TRAVERSE_STMT(AsmStmt, {
1831     TRY_TO(TraverseStmt(S->getAsmString()));
1832     for (unsigned I = 0, E = S->getNumInputs(); I < E; ++I) {
1833       TRY_TO(TraverseStmt(S->getInputConstraintLiteral(I)));
1834     }
1835     for (unsigned I = 0, E = S->getNumOutputs(); I < E; ++I) {
1836       TRY_TO(TraverseStmt(S->getOutputConstraintLiteral(I)));
1837     }
1838     for (unsigned I = 0, E = S->getNumClobbers(); I < E; ++I) {
1839       TRY_TO(TraverseStmt(S->getClobber(I)));
1840     }
1841     // children() iterates over inputExpr and outputExpr.
1842   })
1843
1844 DEF_TRAVERSE_STMT(MSAsmStmt, {
1845     // FIXME: MS Asm doesn't currently parse Constraints, Clobbers, etc.  Once
1846     // added this needs to be implemented.
1847   })
1848
1849 DEF_TRAVERSE_STMT(CXXCatchStmt, {
1850     TRY_TO(TraverseDecl(S->getExceptionDecl()));
1851     // children() iterates over the handler block.
1852   })
1853
1854 DEF_TRAVERSE_STMT(DeclStmt, {
1855     for (DeclStmt::decl_iterator I = S->decl_begin(), E = S->decl_end();
1856          I != E; ++I) {
1857       TRY_TO(TraverseDecl(*I));
1858     }
1859     // Suppress the default iteration over children() by
1860     // returning.  Here's why: A DeclStmt looks like 'type var [=
1861     // initializer]'.  The decls above already traverse over the
1862     // initializers, so we don't have to do it again (which
1863     // children() would do).
1864     return true;
1865   })
1866
1867
1868 // These non-expr stmts (most of them), do not need any action except
1869 // iterating over the children.
1870 DEF_TRAVERSE_STMT(BreakStmt, { })
1871 DEF_TRAVERSE_STMT(CXXTryStmt, { })
1872 DEF_TRAVERSE_STMT(CaseStmt, { })
1873 DEF_TRAVERSE_STMT(CompoundStmt, { })
1874 DEF_TRAVERSE_STMT(ContinueStmt, { })
1875 DEF_TRAVERSE_STMT(DefaultStmt, { })
1876 DEF_TRAVERSE_STMT(DoStmt, { })
1877 DEF_TRAVERSE_STMT(ForStmt, { })
1878 DEF_TRAVERSE_STMT(GotoStmt, { })
1879 DEF_TRAVERSE_STMT(IfStmt, { })
1880 DEF_TRAVERSE_STMT(IndirectGotoStmt, { })
1881 DEF_TRAVERSE_STMT(LabelStmt, { })
1882 DEF_TRAVERSE_STMT(AttributedStmt, { })
1883 DEF_TRAVERSE_STMT(NullStmt, { })
1884 DEF_TRAVERSE_STMT(ObjCAtCatchStmt, { })
1885 DEF_TRAVERSE_STMT(ObjCAtFinallyStmt, { })
1886 DEF_TRAVERSE_STMT(ObjCAtSynchronizedStmt, { })
1887 DEF_TRAVERSE_STMT(ObjCAtThrowStmt, { })
1888 DEF_TRAVERSE_STMT(ObjCAtTryStmt, { })
1889 DEF_TRAVERSE_STMT(ObjCForCollectionStmt, { })
1890 DEF_TRAVERSE_STMT(ObjCAutoreleasePoolStmt, { })
1891 DEF_TRAVERSE_STMT(CXXForRangeStmt, {
1892   if (!getDerived().shouldVisitImplicitCode()) {
1893     TRY_TO(TraverseStmt(S->getLoopVarStmt()));
1894     TRY_TO(TraverseStmt(S->getRangeInit()));
1895     TRY_TO(TraverseStmt(S->getBody()));
1896     // Visit everything else only if shouldVisitImplicitCode().
1897     return true;
1898   }
1899 })
1900 DEF_TRAVERSE_STMT(MSDependentExistsStmt, {
1901     TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
1902     TRY_TO(TraverseDeclarationNameInfo(S->getNameInfo()));
1903 })
1904 DEF_TRAVERSE_STMT(ReturnStmt, { })
1905 DEF_TRAVERSE_STMT(SwitchStmt, { })
1906 DEF_TRAVERSE_STMT(WhileStmt, { })
1907
1908
1909 DEF_TRAVERSE_STMT(CXXDependentScopeMemberExpr, {
1910     TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
1911     TRY_TO(TraverseDeclarationNameInfo(S->getMemberNameInfo()));
1912     if (S->hasExplicitTemplateArgs()) {
1913       TRY_TO(TraverseTemplateArgumentLocsHelper(
1914           S->getTemplateArgs(), S->getNumTemplateArgs()));
1915     }
1916   })
1917
1918 DEF_TRAVERSE_STMT(DeclRefExpr, {
1919     TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
1920     TRY_TO(TraverseDeclarationNameInfo(S->getNameInfo()));
1921     TRY_TO(TraverseTemplateArgumentLocsHelper(
1922         S->getTemplateArgs(), S->getNumTemplateArgs()));
1923   })
1924
1925 DEF_TRAVERSE_STMT(DependentScopeDeclRefExpr, {
1926     TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
1927     TRY_TO(TraverseDeclarationNameInfo(S->getNameInfo()));
1928     if (S->hasExplicitTemplateArgs()) {
1929       TRY_TO(TraverseTemplateArgumentLocsHelper(
1930           S->getExplicitTemplateArgs().getTemplateArgs(),
1931           S->getNumTemplateArgs()));
1932     }
1933   })
1934
1935 DEF_TRAVERSE_STMT(MemberExpr, {
1936     TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
1937     TRY_TO(TraverseDeclarationNameInfo(S->getMemberNameInfo()));
1938     TRY_TO(TraverseTemplateArgumentLocsHelper(
1939         S->getTemplateArgs(), S->getNumTemplateArgs()));
1940   })
1941
1942 DEF_TRAVERSE_STMT(ImplicitCastExpr, {
1943     // We don't traverse the cast type, as it's not written in the
1944     // source code.
1945   })
1946
1947 DEF_TRAVERSE_STMT(CStyleCastExpr, {
1948     TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
1949   })
1950
1951 DEF_TRAVERSE_STMT(CXXFunctionalCastExpr, {
1952     TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
1953   })
1954
1955 DEF_TRAVERSE_STMT(CXXConstCastExpr, {
1956     TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
1957   })
1958
1959 DEF_TRAVERSE_STMT(CXXDynamicCastExpr, {
1960     TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
1961   })
1962
1963 DEF_TRAVERSE_STMT(CXXReinterpretCastExpr, {
1964     TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
1965   })
1966
1967 DEF_TRAVERSE_STMT(CXXStaticCastExpr, {
1968     TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
1969   })
1970
1971 // InitListExpr is a tricky one, because we want to do all our work on
1972 // the syntactic form of the listexpr, but this method takes the
1973 // semantic form by default.  We can't use the macro helper because it
1974 // calls WalkUp*() on the semantic form, before our code can convert
1975 // to the syntactic form.
1976 template<typename Derived>
1977 bool RecursiveASTVisitor<Derived>::TraverseInitListExpr(InitListExpr *S) {
1978   if (InitListExpr *Syn = S->getSyntacticForm())
1979     S = Syn;
1980   TRY_TO(WalkUpFromInitListExpr(S));
1981   // All we need are the default actions.  FIXME: use a helper function.
1982   for (Stmt::child_range range = S->children(); range; ++range) {
1983     TRY_TO(TraverseStmt(*range));
1984   }
1985   return true;
1986 }
1987
1988 // GenericSelectionExpr is a special case because the types and expressions
1989 // are interleaved.  We also need to watch out for null types (default
1990 // generic associations).
1991 template<typename Derived>
1992 bool RecursiveASTVisitor<Derived>::
1993 TraverseGenericSelectionExpr(GenericSelectionExpr *S) {
1994   TRY_TO(WalkUpFromGenericSelectionExpr(S));
1995   TRY_TO(TraverseStmt(S->getControllingExpr()));
1996   for (unsigned i = 0; i != S->getNumAssocs(); ++i) {
1997     if (TypeSourceInfo *TS = S->getAssocTypeSourceInfo(i))
1998       TRY_TO(TraverseTypeLoc(TS->getTypeLoc()));
1999     TRY_TO(TraverseStmt(S->getAssocExpr(i)));
2000   }
2001   return true;
2002 }
2003
2004 // PseudoObjectExpr is a special case because of the wierdness with
2005 // syntactic expressions and opaque values.
2006 template<typename Derived>
2007 bool RecursiveASTVisitor<Derived>::
2008 TraversePseudoObjectExpr(PseudoObjectExpr *S) {
2009   TRY_TO(WalkUpFromPseudoObjectExpr(S));
2010   TRY_TO(TraverseStmt(S->getSyntacticForm()));
2011   for (PseudoObjectExpr::semantics_iterator
2012          i = S->semantics_begin(), e = S->semantics_end(); i != e; ++i) {
2013     Expr *sub = *i;
2014     if (OpaqueValueExpr *OVE = dyn_cast<OpaqueValueExpr>(sub))
2015       sub = OVE->getSourceExpr();
2016     TRY_TO(TraverseStmt(sub));
2017   }
2018   return true;
2019 }
2020
2021 DEF_TRAVERSE_STMT(CXXScalarValueInitExpr, {
2022     // This is called for code like 'return T()' where T is a built-in
2023     // (i.e. non-class) type.
2024     TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2025   })
2026
2027 DEF_TRAVERSE_STMT(CXXNewExpr, {
2028   // The child-iterator will pick up the other arguments.
2029   TRY_TO(TraverseTypeLoc(S->getAllocatedTypeSourceInfo()->getTypeLoc()));
2030   })
2031
2032 DEF_TRAVERSE_STMT(OffsetOfExpr, {
2033     // The child-iterator will pick up the expression representing
2034     // the field.
2035     // FIMXE: for code like offsetof(Foo, a.b.c), should we get
2036     // making a MemberExpr callbacks for Foo.a, Foo.a.b, and Foo.a.b.c?
2037     TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2038   })
2039
2040 DEF_TRAVERSE_STMT(UnaryExprOrTypeTraitExpr, {
2041     // The child-iterator will pick up the arg if it's an expression,
2042     // but not if it's a type.
2043     if (S->isArgumentType())
2044       TRY_TO(TraverseTypeLoc(S->getArgumentTypeInfo()->getTypeLoc()));
2045   })
2046
2047 DEF_TRAVERSE_STMT(CXXTypeidExpr, {
2048     // The child-iterator will pick up the arg if it's an expression,
2049     // but not if it's a type.
2050     if (S->isTypeOperand())
2051       TRY_TO(TraverseTypeLoc(S->getTypeOperandSourceInfo()->getTypeLoc()));
2052   })
2053
2054 DEF_TRAVERSE_STMT(CXXUuidofExpr, {
2055     // The child-iterator will pick up the arg if it's an expression,
2056     // but not if it's a type.
2057     if (S->isTypeOperand())
2058       TRY_TO(TraverseTypeLoc(S->getTypeOperandSourceInfo()->getTypeLoc()));
2059   })
2060
2061 DEF_TRAVERSE_STMT(UnaryTypeTraitExpr, {
2062     TRY_TO(TraverseTypeLoc(S->getQueriedTypeSourceInfo()->getTypeLoc()));
2063   })
2064
2065 DEF_TRAVERSE_STMT(BinaryTypeTraitExpr, {
2066     TRY_TO(TraverseTypeLoc(S->getLhsTypeSourceInfo()->getTypeLoc()));
2067     TRY_TO(TraverseTypeLoc(S->getRhsTypeSourceInfo()->getTypeLoc()));
2068   })
2069
2070 DEF_TRAVERSE_STMT(TypeTraitExpr, {
2071   for (unsigned I = 0, N = S->getNumArgs(); I != N; ++I)
2072     TRY_TO(TraverseTypeLoc(S->getArg(I)->getTypeLoc()));
2073 })
2074
2075 DEF_TRAVERSE_STMT(ArrayTypeTraitExpr, {
2076     TRY_TO(TraverseTypeLoc(S->getQueriedTypeSourceInfo()->getTypeLoc()));
2077   })
2078
2079 DEF_TRAVERSE_STMT(ExpressionTraitExpr, {
2080     TRY_TO(TraverseStmt(S->getQueriedExpression()));
2081   })
2082
2083 DEF_TRAVERSE_STMT(VAArgExpr, {
2084     // The child-iterator will pick up the expression argument.
2085     TRY_TO(TraverseTypeLoc(S->getWrittenTypeInfo()->getTypeLoc()));
2086   })
2087
2088 DEF_TRAVERSE_STMT(CXXTemporaryObjectExpr, {
2089     // This is called for code like 'return T()' where T is a class type.
2090     TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2091   })
2092
2093 // Walk only the visible parts of lambda expressions.
2094 template<typename Derived>
2095 bool RecursiveASTVisitor<Derived>::TraverseLambdaExpr(LambdaExpr *S) {
2096   for (LambdaExpr::capture_iterator C = S->explicit_capture_begin(),
2097                                  CEnd = S->explicit_capture_end();
2098        C != CEnd; ++C) {
2099     TRY_TO(TraverseLambdaCapture(*C));
2100   }
2101
2102   if (S->hasExplicitParameters() || S->hasExplicitResultType()) {
2103     TypeLoc TL = S->getCallOperator()->getTypeSourceInfo()->getTypeLoc();
2104     if (S->hasExplicitParameters() && S->hasExplicitResultType()) {
2105       // Visit the whole type.
2106       TRY_TO(TraverseTypeLoc(TL));
2107     } else if (isa<FunctionProtoTypeLoc>(TL)) {
2108       FunctionProtoTypeLoc Proto = cast<FunctionProtoTypeLoc>(TL);
2109       if (S->hasExplicitParameters()) {
2110         // Visit parameters.
2111         for (unsigned I = 0, N = Proto.getNumArgs(); I != N; ++I) {
2112           TRY_TO(TraverseDecl(Proto.getArg(I)));
2113         }
2114       } else {
2115         TRY_TO(TraverseTypeLoc(Proto.getResultLoc()));
2116       }
2117     }
2118   }
2119
2120   TRY_TO(TraverseStmt(S->getBody()));
2121   return true;
2122 }
2123
2124 DEF_TRAVERSE_STMT(CXXUnresolvedConstructExpr, {
2125     // This is called for code like 'T()', where T is a template argument.
2126     TRY_TO(TraverseTypeLoc(S->getTypeSourceInfo()->getTypeLoc()));
2127   })
2128
2129 // These expressions all might take explicit template arguments.
2130 // We traverse those if so.  FIXME: implement these.
2131 DEF_TRAVERSE_STMT(CXXConstructExpr, { })
2132 DEF_TRAVERSE_STMT(CallExpr, { })
2133 DEF_TRAVERSE_STMT(CXXMemberCallExpr, { })
2134
2135 // These exprs (most of them), do not need any action except iterating
2136 // over the children.
2137 DEF_TRAVERSE_STMT(AddrLabelExpr, { })
2138 DEF_TRAVERSE_STMT(ArraySubscriptExpr, { })
2139 DEF_TRAVERSE_STMT(BlockExpr, {
2140   TRY_TO(TraverseDecl(S->getBlockDecl()));
2141   return true; // no child statements to loop through.
2142 })
2143 DEF_TRAVERSE_STMT(ChooseExpr, { })
2144 DEF_TRAVERSE_STMT(CompoundLiteralExpr, { })
2145 DEF_TRAVERSE_STMT(CXXBindTemporaryExpr, { })
2146 DEF_TRAVERSE_STMT(CXXBoolLiteralExpr, { })
2147 DEF_TRAVERSE_STMT(CXXDefaultArgExpr, { })
2148 DEF_TRAVERSE_STMT(CXXDeleteExpr, { })
2149 DEF_TRAVERSE_STMT(ExprWithCleanups, { })
2150 DEF_TRAVERSE_STMT(CXXNullPtrLiteralExpr, { })
2151 DEF_TRAVERSE_STMT(CXXPseudoDestructorExpr, {
2152   TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2153   if (TypeSourceInfo *ScopeInfo = S->getScopeTypeInfo())
2154     TRY_TO(TraverseTypeLoc(ScopeInfo->getTypeLoc()));
2155   if (TypeSourceInfo *DestroyedTypeInfo = S->getDestroyedTypeInfo())
2156     TRY_TO(TraverseTypeLoc(DestroyedTypeInfo->getTypeLoc()));
2157 })
2158 DEF_TRAVERSE_STMT(CXXThisExpr, { })
2159 DEF_TRAVERSE_STMT(CXXThrowExpr, { })
2160 DEF_TRAVERSE_STMT(UserDefinedLiteral, { })
2161 DEF_TRAVERSE_STMT(DesignatedInitExpr, { })
2162 DEF_TRAVERSE_STMT(ExtVectorElementExpr, { })
2163 DEF_TRAVERSE_STMT(GNUNullExpr, { })
2164 DEF_TRAVERSE_STMT(ImplicitValueInitExpr, { })
2165 DEF_TRAVERSE_STMT(ObjCBoolLiteralExpr, { })
2166 DEF_TRAVERSE_STMT(ObjCEncodeExpr, {
2167   if (TypeSourceInfo *TInfo = S->getEncodedTypeSourceInfo())
2168     TRY_TO(TraverseTypeLoc(TInfo->getTypeLoc()));
2169 })
2170 DEF_TRAVERSE_STMT(ObjCIsaExpr, { })
2171 DEF_TRAVERSE_STMT(ObjCIvarRefExpr, { })
2172 DEF_TRAVERSE_STMT(ObjCMessageExpr, { })
2173 DEF_TRAVERSE_STMT(ObjCPropertyRefExpr, { })
2174 DEF_TRAVERSE_STMT(ObjCSubscriptRefExpr, { })
2175 DEF_TRAVERSE_STMT(ObjCProtocolExpr, { })
2176 DEF_TRAVERSE_STMT(ObjCSelectorExpr, { })
2177 DEF_TRAVERSE_STMT(ObjCIndirectCopyRestoreExpr, { })
2178 DEF_TRAVERSE_STMT(ObjCBridgedCastExpr, {
2179   TRY_TO(TraverseTypeLoc(S->getTypeInfoAsWritten()->getTypeLoc()));
2180 })
2181 DEF_TRAVERSE_STMT(ParenExpr, { })
2182 DEF_TRAVERSE_STMT(ParenListExpr, { })
2183 DEF_TRAVERSE_STMT(PredefinedExpr, { })
2184 DEF_TRAVERSE_STMT(ShuffleVectorExpr, { })
2185 DEF_TRAVERSE_STMT(StmtExpr, { })
2186 DEF_TRAVERSE_STMT(UnresolvedLookupExpr, {
2187   TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2188   if (S->hasExplicitTemplateArgs()) {
2189     TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2190                                               S->getNumTemplateArgs()));
2191   }
2192 })
2193
2194 DEF_TRAVERSE_STMT(UnresolvedMemberExpr, {
2195   TRY_TO(TraverseNestedNameSpecifierLoc(S->getQualifierLoc()));
2196   if (S->hasExplicitTemplateArgs()) {
2197     TRY_TO(TraverseTemplateArgumentLocsHelper(S->getTemplateArgs(),
2198                                               S->getNumTemplateArgs()));
2199   }
2200 })
2201
2202 DEF_TRAVERSE_STMT(SEHTryStmt, {})
2203 DEF_TRAVERSE_STMT(SEHExceptStmt, {})
2204 DEF_TRAVERSE_STMT(SEHFinallyStmt,{})
2205
2206 DEF_TRAVERSE_STMT(CXXOperatorCallExpr, { })
2207 DEF_TRAVERSE_STMT(OpaqueValueExpr, { })
2208 DEF_TRAVERSE_STMT(CUDAKernelCallExpr, { })
2209
2210 // These operators (all of them) do not need any action except
2211 // iterating over the children.
2212 DEF_TRAVERSE_STMT(BinaryConditionalOperator, { })
2213 DEF_TRAVERSE_STMT(ConditionalOperator, { })
2214 DEF_TRAVERSE_STMT(UnaryOperator, { })
2215 DEF_TRAVERSE_STMT(BinaryOperator, { })
2216 DEF_TRAVERSE_STMT(CompoundAssignOperator, { })
2217 DEF_TRAVERSE_STMT(CXXNoexceptExpr, { })
2218 DEF_TRAVERSE_STMT(PackExpansionExpr, { })
2219 DEF_TRAVERSE_STMT(SizeOfPackExpr, { })
2220 DEF_TRAVERSE_STMT(SubstNonTypeTemplateParmPackExpr, { })
2221 DEF_TRAVERSE_STMT(SubstNonTypeTemplateParmExpr, { })
2222 DEF_TRAVERSE_STMT(MaterializeTemporaryExpr, { })
2223 DEF_TRAVERSE_STMT(AtomicExpr, { })
2224
2225 // These literals (all of them) do not need any action.
2226 DEF_TRAVERSE_STMT(IntegerLiteral, { })
2227 DEF_TRAVERSE_STMT(CharacterLiteral, { })
2228 DEF_TRAVERSE_STMT(FloatingLiteral, { })
2229 DEF_TRAVERSE_STMT(ImaginaryLiteral, { })
2230 DEF_TRAVERSE_STMT(StringLiteral, { })
2231 DEF_TRAVERSE_STMT(ObjCStringLiteral, { })
2232 DEF_TRAVERSE_STMT(ObjCBoxedExpr, { })
2233 DEF_TRAVERSE_STMT(ObjCArrayLiteral, { })
2234 DEF_TRAVERSE_STMT(ObjCDictionaryLiteral, { })
2235
2236 // Traverse OpenCL: AsType, Convert.
2237 DEF_TRAVERSE_STMT(AsTypeExpr, { })
2238
2239 // FIXME: look at the following tricky-seeming exprs to see if we
2240 // need to recurse on anything.  These are ones that have methods
2241 // returning decls or qualtypes or nestednamespecifier -- though I'm
2242 // not sure if they own them -- or just seemed very complicated, or
2243 // had lots of sub-types to explore.
2244 //
2245 // VisitOverloadExpr and its children: recurse on template args? etc?
2246
2247 // FIXME: go through all the stmts and exprs again, and see which of them
2248 // create new types, and recurse on the types (TypeLocs?) of those.
2249 // Candidates:
2250 //
2251 //    http://clang.llvm.org/doxygen/classclang_1_1CXXTypeidExpr.html
2252 //    http://clang.llvm.org/doxygen/classclang_1_1UnaryExprOrTypeTraitExpr.html
2253 //    http://clang.llvm.org/doxygen/classclang_1_1TypesCompatibleExpr.html
2254 //    Every class that has getQualifier.
2255
2256 #undef DEF_TRAVERSE_STMT
2257
2258 #undef TRY_TO
2259
2260 } // end namespace clang
2261
2262 #endif // LLVM_CLANG_AST_RECURSIVEASTVISITOR_H