clang/AST/StmtVisitor.h

0001 //===- StmtVisitor.h - Visitor for Stmt subclasses --------------*- C++ -*-===//
0002 //
0003 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
0004 // See https://llvm.org/LICENSE.txt for license information.
0005 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
0006 //
0007 //===----------------------------------------------------------------------===//
0008 //
0009 //  This file defines the StmtVisitor and ConstStmtVisitor interfaces.
0010 //
0011 //===----------------------------------------------------------------------===//
0012
0013 #ifndef LLVM_CLANG_AST_STMTVISITOR_H
0014 #define LLVM_CLANG_AST_STMTVISITOR_H
0015
0016 #include "clang/AST/ExprCXX.h"
0017 #include "clang/AST/ExprConcepts.h"
0018 #include "clang/AST/ExprObjC.h"
0019 #include "clang/AST/ExprOpenMP.h"
0020 #include "clang/AST/Stmt.h"
0021 #include "clang/AST/StmtCXX.h"
0022 #include "clang/AST/StmtObjC.h"
0023 #include "clang/AST/StmtOpenACC.h"
0024 #include "clang/AST/StmtOpenMP.h"
0025 #include "clang/AST/StmtSYCL.h"
0026 #include "clang/Basic/LLVM.h"
0027 #include "llvm/ADT/STLExtras.h"
0028 #include "llvm/Support/Casting.h"
0029 #include "llvm/Support/ErrorHandling.h"
0030 #include <utility>
0031
0032 namespace clang {
0033 /// StmtVisitorBase - This class implements a simple visitor for Stmt
0034 /// subclasses. Since Expr derives from Stmt, this also includes support for
0035 /// visiting Exprs.
0036 template<template <typename> class Ptr, typename ImplClass, typename RetTy=void,
0037          class... ParamTys>
0038 class StmtVisitorBase {
0039 public:
0040 #define PTR(CLASS) typename Ptr<CLASS>::type
0041 #define DISPATCH(NAME, CLASS) \
0042   return static_cast<ImplClass*>(this)->Visit ## NAME( \
0043     static_cast<PTR(CLASS)>(S), std::forward<ParamTys>(P)...)
0044
0045   RetTy Visit(PTR(Stmt) S, ParamTys... P) {
0046     // If we have a binary expr, dispatch to the subcode of the binop.  A smart
0047     // optimizer (e.g. LLVM) will fold this comparison into the switch stmt
0048     // below.
0049     if (PTR(BinaryOperator) BinOp = dyn_cast<BinaryOperator>(S)) {
0050       switch (BinOp->getOpcode()) {
0051       case BO_PtrMemD:   DISPATCH(BinPtrMemD,   BinaryOperator);
0052       case BO_PtrMemI:   DISPATCH(BinPtrMemI,   BinaryOperator);
0053       case BO_Mul:       DISPATCH(BinMul,       BinaryOperator);
0054       case BO_Div:       DISPATCH(BinDiv,       BinaryOperator);
0055       case BO_Rem:       DISPATCH(BinRem,       BinaryOperator);
0056       case BO_Add:       DISPATCH(BinAdd,       BinaryOperator);
0057       case BO_Sub:       DISPATCH(BinSub,       BinaryOperator);
0058       case BO_Shl:       DISPATCH(BinShl,       BinaryOperator);
0059       case BO_Shr:       DISPATCH(BinShr,       BinaryOperator);
0060
0061       case BO_LT:        DISPATCH(BinLT,        BinaryOperator);
0062       case BO_GT:        DISPATCH(BinGT,        BinaryOperator);
0063       case BO_LE:        DISPATCH(BinLE,        BinaryOperator);
0064       case BO_GE:        DISPATCH(BinGE,        BinaryOperator);
0065       case BO_EQ:        DISPATCH(BinEQ,        BinaryOperator);
0066       case BO_NE:        DISPATCH(BinNE,        BinaryOperator);
0067       case BO_Cmp:       DISPATCH(BinCmp,       BinaryOperator);
0068
0069       case BO_And:       DISPATCH(BinAnd,       BinaryOperator);
0070       case BO_Xor:       DISPATCH(BinXor,       BinaryOperator);
0071       case BO_Or :       DISPATCH(BinOr,        BinaryOperator);
0072       case BO_LAnd:      DISPATCH(BinLAnd,      BinaryOperator);
0073       case BO_LOr :      DISPATCH(BinLOr,       BinaryOperator);
0074       case BO_Assign:    DISPATCH(BinAssign,    BinaryOperator);
0075       case BO_MulAssign: DISPATCH(BinMulAssign, CompoundAssignOperator);
0076       case BO_DivAssign: DISPATCH(BinDivAssign, CompoundAssignOperator);
0077       case BO_RemAssign: DISPATCH(BinRemAssign, CompoundAssignOperator);
0078       case BO_AddAssign: DISPATCH(BinAddAssign, CompoundAssignOperator);
0079       case BO_SubAssign: DISPATCH(BinSubAssign, CompoundAssignOperator);
0080       case BO_ShlAssign: DISPATCH(BinShlAssign, CompoundAssignOperator);
0081       case BO_ShrAssign: DISPATCH(BinShrAssign, CompoundAssignOperator);
0082       case BO_AndAssign: DISPATCH(BinAndAssign, CompoundAssignOperator);
0083       case BO_OrAssign:  DISPATCH(BinOrAssign,  CompoundAssignOperator);
0084       case BO_XorAssign: DISPATCH(BinXorAssign, CompoundAssignOperator);
0085       case BO_Comma:     DISPATCH(BinComma,     BinaryOperator);
0086       }
0087     } else if (PTR(UnaryOperator) UnOp = dyn_cast<UnaryOperator>(S)) {
0088       switch (UnOp->getOpcode()) {
0089       case UO_PostInc:   DISPATCH(UnaryPostInc,   UnaryOperator);
0090       case UO_PostDec:   DISPATCH(UnaryPostDec,   UnaryOperator);
0091       case UO_PreInc:    DISPATCH(UnaryPreInc,    UnaryOperator);
0092       case UO_PreDec:    DISPATCH(UnaryPreDec,    UnaryOperator);
0093       case UO_AddrOf:    DISPATCH(UnaryAddrOf,    UnaryOperator);
0094       case UO_Deref:     DISPATCH(UnaryDeref,     UnaryOperator);
0095       case UO_Plus:      DISPATCH(UnaryPlus,      UnaryOperator);
0096       case UO_Minus:     DISPATCH(UnaryMinus,     UnaryOperator);
0097       case UO_Not:       DISPATCH(UnaryNot,       UnaryOperator);
0098       case UO_LNot:      DISPATCH(UnaryLNot,      UnaryOperator);
0099       case UO_Real:      DISPATCH(UnaryReal,      UnaryOperator);
0100       case UO_Imag:      DISPATCH(UnaryImag,      UnaryOperator);
0101       case UO_Extension: DISPATCH(UnaryExtension, UnaryOperator);
0102       case UO_Coawait:   DISPATCH(UnaryCoawait,   UnaryOperator);
0103       }
0104     }
0105
0106     // Top switch stmt: dispatch to VisitFooStmt for each FooStmt.
0107     switch (S->getStmtClass()) {
0108     default: llvm_unreachable("Unknown stmt kind!");
0109 #define ABSTRACT_STMT(STMT)
0110 #define STMT(CLASS, PARENT)                              \
0111     case Stmt::CLASS ## Class: DISPATCH(CLASS, CLASS);
0112 #include "clang/AST/StmtNodes.inc"
0113     }
0114   }
0115
0116   // If the implementation chooses not to implement a certain visit method, fall
0117   // back on VisitExpr or whatever else is the superclass.
0118 #define STMT(CLASS, PARENT)                                   \
0119   RetTy Visit ## CLASS(PTR(CLASS) S, ParamTys... P) { DISPATCH(PARENT, PARENT); }
0120 #include "clang/AST/StmtNodes.inc"
0121
0122   // If the implementation doesn't implement binary operator methods, fall back
0123   // on VisitBinaryOperator.
0124 #define BINOP_FALLBACK(NAME) \
0125   RetTy VisitBin ## NAME(PTR(BinaryOperator) S, ParamTys... P) { \
0126     DISPATCH(BinaryOperator, BinaryOperator); \
0127   }
0128   BINOP_FALLBACK(PtrMemD)                    BINOP_FALLBACK(PtrMemI)
0129   BINOP_FALLBACK(Mul)   BINOP_FALLBACK(Div)  BINOP_FALLBACK(Rem)
0130   BINOP_FALLBACK(Add)   BINOP_FALLBACK(Sub)  BINOP_FALLBACK(Shl)
0131   BINOP_FALLBACK(Shr)
0132
0133   BINOP_FALLBACK(LT)    BINOP_FALLBACK(GT)   BINOP_FALLBACK(LE)
0134   BINOP_FALLBACK(GE)    BINOP_FALLBACK(EQ)   BINOP_FALLBACK(NE)
0135   BINOP_FALLBACK(Cmp)
0136
0137   BINOP_FALLBACK(And)   BINOP_FALLBACK(Xor)  BINOP_FALLBACK(Or)
0138   BINOP_FALLBACK(LAnd)  BINOP_FALLBACK(LOr)
0139
0140   BINOP_FALLBACK(Assign)
0141   BINOP_FALLBACK(Comma)
0142 #undef BINOP_FALLBACK
0143
0144   // If the implementation doesn't implement compound assignment operator
0145   // methods, fall back on VisitCompoundAssignOperator.
0146 #define CAO_FALLBACK(NAME) \
0147   RetTy VisitBin ## NAME(PTR(CompoundAssignOperator) S, ParamTys... P) { \
0148     DISPATCH(CompoundAssignOperator, CompoundAssignOperator); \
0149   }
0150   CAO_FALLBACK(MulAssign) CAO_FALLBACK(DivAssign) CAO_FALLBACK(RemAssign)
0151   CAO_FALLBACK(AddAssign) CAO_FALLBACK(SubAssign) CAO_FALLBACK(ShlAssign)
0152   CAO_FALLBACK(ShrAssign) CAO_FALLBACK(AndAssign) CAO_FALLBACK(OrAssign)
0153   CAO_FALLBACK(XorAssign)
0154 #undef CAO_FALLBACK
0155
0156   // If the implementation doesn't implement unary operator methods, fall back
0157   // on VisitUnaryOperator.
0158 #define UNARYOP_FALLBACK(NAME) \
0159   RetTy VisitUnary ## NAME(PTR(UnaryOperator) S, ParamTys... P) { \
0160     DISPATCH(UnaryOperator, UnaryOperator);    \
0161   }
0162   UNARYOP_FALLBACK(PostInc)   UNARYOP_FALLBACK(PostDec)
0163   UNARYOP_FALLBACK(PreInc)    UNARYOP_FALLBACK(PreDec)
0164   UNARYOP_FALLBACK(AddrOf)    UNARYOP_FALLBACK(Deref)
0165
0166   UNARYOP_FALLBACK(Plus)      UNARYOP_FALLBACK(Minus)
0167   UNARYOP_FALLBACK(Not)       UNARYOP_FALLBACK(LNot)
0168   UNARYOP_FALLBACK(Real)      UNARYOP_FALLBACK(Imag)
0169   UNARYOP_FALLBACK(Extension) UNARYOP_FALLBACK(Coawait)
0170 #undef UNARYOP_FALLBACK
0171
0172   // Base case, ignore it. :)
0173   RetTy VisitStmt(PTR(Stmt) Node, ParamTys... P) { return RetTy(); }
0174
0175 #undef PTR
0176 #undef DISPATCH
0177 };
0178
0179 /// StmtVisitor - This class implements a simple visitor for Stmt subclasses.
0180 /// Since Expr derives from Stmt, this also includes support for visiting Exprs.
0181 ///
0182 /// This class does not preserve constness of Stmt pointers (see also
0183 /// ConstStmtVisitor).
0184 template <typename ImplClass, typename RetTy = void, typename... ParamTys>
0185 class StmtVisitor
0186     : public StmtVisitorBase<std::add_pointer, ImplClass, RetTy, ParamTys...> {
0187 };
0188
0189 /// ConstStmtVisitor - This class implements a simple visitor for Stmt
0190 /// subclasses. Since Expr derives from Stmt, this also includes support for
0191 /// visiting Exprs.
0192 ///
0193 /// This class preserves constness of Stmt pointers (see also StmtVisitor).
0194 template <typename ImplClass, typename RetTy = void, typename... ParamTys>
0195 class ConstStmtVisitor : public StmtVisitorBase<llvm::make_const_ptr, ImplClass,
0196                                                 RetTy, ParamTys...> {};
0197
0198 } // namespace clang
0199
0200 #endif // LLVM_CLANG_AST_STMTVISITOR_H