StmtVisitor.h revision f494b579b22f9950f5af021f0bf9879a91bb8b41 
1//===--- StmtVisitor.h - Visitor for Stmt subclasses ------------*- 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 StmtVisitor interface.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CLANG_AST_STMTVISITOR_H
15#define LLVM_CLANG_AST_STMTVISITOR_H
16
17#include "clang/AST/ExprCXX.h"
18#include "clang/AST/ExprObjC.h"
19
20namespace clang {
21
22#define DISPATCH(NAME, CLASS) \
23  return static_cast<ImplClass*>(this)->Visit ## NAME(static_cast<CLASS*>(S))
24
25/// StmtVisitor - This class implements a simple visitor for Stmt subclasses.
26/// Since Expr derives from Stmt, this also includes support for visiting Exprs.
27template<typename ImplClass, typename RetTy=void>
28class StmtVisitor {
29public:
30  RetTy Visit(Stmt *S) {
31
32    // If we have a binary expr, dispatch to the subcode of the binop.  A smart
33    // optimizer (e.g. LLVM) will fold this comparison into the switch stmt
34    // below.
35    if (BinaryOperator *BinOp = dyn_cast<BinaryOperator>(S)) {
36      switch (BinOp->getOpcode()) {
37      default: assert(0 && "Unknown binary operator!");
38      case BinaryOperator::Mul:       DISPATCH(BinMul,       BinaryOperator);
39      case BinaryOperator::Div:       DISPATCH(BinDiv,       BinaryOperator);
40      case BinaryOperator::Rem:       DISPATCH(BinRem,       BinaryOperator);
41      case BinaryOperator::Add:       DISPATCH(BinAdd,       BinaryOperator);
42      case BinaryOperator::Sub:       DISPATCH(BinSub,       BinaryOperator);
43      case BinaryOperator::Shl:       DISPATCH(BinShl,       BinaryOperator);
44      case BinaryOperator::Shr:       DISPATCH(BinShr,       BinaryOperator);
45
46      case BinaryOperator::LT:        DISPATCH(BinLT,        BinaryOperator);
47      case BinaryOperator::GT:        DISPATCH(BinGT,        BinaryOperator);
48      case BinaryOperator::LE:        DISPATCH(BinLE,        BinaryOperator);
49      case BinaryOperator::GE:        DISPATCH(BinGE,        BinaryOperator);
50      case BinaryOperator::EQ:        DISPATCH(BinEQ,        BinaryOperator);
51      case BinaryOperator::NE:        DISPATCH(BinNE,        BinaryOperator);
52
53      case BinaryOperator::And:       DISPATCH(BinAnd,       BinaryOperator);
54      case BinaryOperator::Xor:       DISPATCH(BinXor,       BinaryOperator);
55      case BinaryOperator::Or :       DISPATCH(BinOr,        BinaryOperator);
56      case BinaryOperator::LAnd:      DISPATCH(BinLAnd,      BinaryOperator);
57      case BinaryOperator::LOr :      DISPATCH(BinLOr,       BinaryOperator);
58      case BinaryOperator::Assign:    DISPATCH(BinAssign,    BinaryOperator);
59      case BinaryOperator::MulAssign:
60        DISPATCH(BinMulAssign, CompoundAssignOperator);
61      case BinaryOperator::DivAssign:
62        DISPATCH(BinDivAssign, CompoundAssignOperator);
63      case BinaryOperator::RemAssign:
64        DISPATCH(BinRemAssign, CompoundAssignOperator);
65      case BinaryOperator::AddAssign:
66        DISPATCH(BinAddAssign, CompoundAssignOperator);
67      case BinaryOperator::SubAssign:
68        DISPATCH(BinSubAssign, CompoundAssignOperator);
69      case BinaryOperator::ShlAssign:
70        DISPATCH(BinShlAssign, CompoundAssignOperator);
71      case BinaryOperator::ShrAssign:
72        DISPATCH(BinShrAssign, CompoundAssignOperator);
73      case BinaryOperator::AndAssign:
74        DISPATCH(BinAndAssign, CompoundAssignOperator);
75      case BinaryOperator::OrAssign:
76        DISPATCH(BinOrAssign,  CompoundAssignOperator);
77      case BinaryOperator::XorAssign:
78        DISPATCH(BinXorAssign, CompoundAssignOperator);
79      case BinaryOperator::Comma:     DISPATCH(BinComma,     BinaryOperator);
80      }
81    } else if (UnaryOperator *UnOp = dyn_cast<UnaryOperator>(S)) {
82      switch (UnOp->getOpcode()) {
83      default: assert(0 && "Unknown unary operator!");
84      case UnaryOperator::PostInc:      DISPATCH(UnaryPostInc,   UnaryOperator);
85      case UnaryOperator::PostDec:      DISPATCH(UnaryPostDec,   UnaryOperator);
86      case UnaryOperator::PreInc:       DISPATCH(UnaryPreInc,    UnaryOperator);
87      case UnaryOperator::PreDec:       DISPATCH(UnaryPreDec,    UnaryOperator);
88      case UnaryOperator::AddrOf:       DISPATCH(UnaryAddrOf,    UnaryOperator);
89      case UnaryOperator::Deref:        DISPATCH(UnaryDeref,     UnaryOperator);
90      case UnaryOperator::Plus:         DISPATCH(UnaryPlus,      UnaryOperator);
91      case UnaryOperator::Minus:        DISPATCH(UnaryMinus,     UnaryOperator);
92      case UnaryOperator::Not:          DISPATCH(UnaryNot,       UnaryOperator);
93      case UnaryOperator::LNot:         DISPATCH(UnaryLNot,      UnaryOperator);
94      case UnaryOperator::SizeOf:       DISPATCH(UnarySizeOf,    UnaryOperator);
95      case UnaryOperator::AlignOf:      DISPATCH(UnaryAlignOf,   UnaryOperator);
96      case UnaryOperator::Real:         DISPATCH(UnaryReal,      UnaryOperator);
97      case UnaryOperator::Imag:         DISPATCH(UnaryImag,      UnaryOperator);
98      case UnaryOperator::Extension:    DISPATCH(UnaryExtension, UnaryOperator);
99      case UnaryOperator::OffsetOf:     DISPATCH(UnaryOffsetOf,  UnaryOperator);
100      }
101    }
102
103    // Top switch stmt: dispatch to VisitFooStmt for each FooStmt.
104    switch (S->getStmtClass()) {
105    default: assert(0 && "Unknown stmt kind!");
106#define STMT(N, CLASS, PARENT)                              \
107    case Stmt::CLASS ## Class: DISPATCH(CLASS, CLASS);
108#include "clang/AST/StmtNodes.def"
109    }
110  }
111
112  // If the implementation chooses not to implement a certain visit method, fall
113  // back on VisitExpr or whatever else is the superclass.
114#define STMT(N, CLASS, PARENT)                                   \
115  RetTy Visit ## CLASS(CLASS *S) { DISPATCH(PARENT, PARENT); }
116#include "clang/AST/StmtNodes.def"
117
118  // If the implementation doesn't implement binary operator methods, fall back
119  // on VisitBinaryOperator.
120#define BINOP_FALLBACK(NAME) \
121  RetTy VisitBin ## NAME(BinaryOperator *S) { \
122    DISPATCH(BinaryOperator, BinaryOperator); \
123  }
124  BINOP_FALLBACK(Mul)   BINOP_FALLBACK(Div)  BINOP_FALLBACK(Rem)
125  BINOP_FALLBACK(Add)   BINOP_FALLBACK(Sub)  BINOP_FALLBACK(Shl)
126  BINOP_FALLBACK(Shr)
127
128  BINOP_FALLBACK(LT)    BINOP_FALLBACK(GT)   BINOP_FALLBACK(LE)
129  BINOP_FALLBACK(GE)    BINOP_FALLBACK(EQ)   BINOP_FALLBACK(NE)
130  BINOP_FALLBACK(And)   BINOP_FALLBACK(Xor)  BINOP_FALLBACK(Or)
131  BINOP_FALLBACK(LAnd)  BINOP_FALLBACK(LOr)
132
133  BINOP_FALLBACK(Assign)
134  BINOP_FALLBACK(Comma)
135#undef BINOP_FALLBACK
136
137  // If the implementation doesn't implement compound assignment operator
138  // methods, fall back on VisitCompoundAssignOperator.
139#define CAO_FALLBACK(NAME) \
140  RetTy VisitBin ## NAME(CompoundAssignOperator *S) { \
141    DISPATCH(CompoundAssignOperator, CompoundAssignOperator); \
142  }
143  CAO_FALLBACK(MulAssign) CAO_FALLBACK(DivAssign) CAO_FALLBACK(RemAssign)
144  CAO_FALLBACK(AddAssign) CAO_FALLBACK(SubAssign) CAO_FALLBACK(ShlAssign)
145  CAO_FALLBACK(ShrAssign) CAO_FALLBACK(AndAssign) CAO_FALLBACK(OrAssign)
146  CAO_FALLBACK(XorAssign)
147#undef CAO_FALLBACK
148
149  // If the implementation doesn't implement unary operator methods, fall back
150  // on VisitUnaryOperator.
151#define UNARYOP_FALLBACK(NAME) \
152  RetTy VisitUnary ## NAME(UnaryOperator *S) { \
153    DISPATCH(UnaryOperator, UnaryOperator);    \
154  }
155  UNARYOP_FALLBACK(PostInc)   UNARYOP_FALLBACK(PostDec)
156  UNARYOP_FALLBACK(PreInc)    UNARYOP_FALLBACK(PreDec)
157  UNARYOP_FALLBACK(AddrOf)    UNARYOP_FALLBACK(Deref)
158
159  UNARYOP_FALLBACK(Plus)      UNARYOP_FALLBACK(Minus)
160  UNARYOP_FALLBACK(Not)       UNARYOP_FALLBACK(LNot)
161  UNARYOP_FALLBACK(SizeOf)    UNARYOP_FALLBACK(AlignOf)
162  UNARYOP_FALLBACK(Real)      UNARYOP_FALLBACK(Imag)
163  UNARYOP_FALLBACK(Extension) UNARYOP_FALLBACK(OffsetOf)
164#undef UNARYOP_FALLBACK
165
166  // Base case, ignore it. :)
167  RetTy VisitStmt(Stmt *Node) { return RetTy(); }
168};
169
170#undef DISPATCH
171
172}  // end namespace clang
173
174#endif
175