include/clang/Checker/PathSensitive/GRTransferFuncs.h

   1 //== GRTransferFuncs.h - Path-Sens. Transfer Functions Interface -*- 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 GRTransferFuncs, which provides a base-class that
  11 //  defines an interface for transfer functions used by GRExprEngine.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_CLANG_ANALYSIS_GRTF
  16 #define LLVM_CLANG_ANALYSIS_GRTF
  17
  18 #include "clang/Checker/PathSensitive/GRState.h"
  19 #include "clang/Checker/PathSensitive/SVals.h"
  20 #include <vector>
  21
  22 namespace clang {
  23 class ExplodedNode;
  24 class ExplodedNodeSet;
  25 class GREndPathNodeBuilder;
  26 class GRExprEngine;
  27 class GRStmtNodeBuilder;
  28 class GRStmtNodeBuilderRef;
  29 class ObjCMessageExpr;
  30
  31 class GRTransferFuncs {
  32 public:
  33   GRTransferFuncs() {}
  34   virtual ~GRTransferFuncs() {}
  35
  36   virtual void RegisterPrinters(std::vector<GRState::Printer*>& Printers) {}
  37   virtual void RegisterChecks(GRExprEngine& Eng) {}
  38
  39
  40   // Calls.
  41
  42   virtual void evalCall(ExplodedNodeSet& Dst,
  43                         GRExprEngine& Engine,
  44                         GRStmtNodeBuilder& Builder,
  45                         const CallExpr* CE, SVal L,
  46                         ExplodedNode* Pred) {}
  47
  48   virtual void evalObjCMessageExpr(ExplodedNodeSet& Dst,
  49                                    GRExprEngine& Engine,
  50                                    GRStmtNodeBuilder& Builder,
  51                                    const ObjCMessageExpr* ME,
  52                                    ExplodedNode* Pred,
  53                                    const GRState *state) {}
  54
  55   // Stores.
  56
  57   virtual void evalBind(GRStmtNodeBuilderRef& B, SVal location, SVal val) {}
  58
  59   // End-of-path and dead symbol notification.
  60
  61   virtual void evalEndPath(GRExprEngine& Engine,
  62                            GREndPathNodeBuilder& Builder) {}
  63
  64
  65   virtual void evalDeadSymbols(ExplodedNodeSet& Dst,
  66                                GRExprEngine& Engine,
  67                                GRStmtNodeBuilder& Builder,
  68                                ExplodedNode* Pred,
  69                                const GRState* state,
  70                                SymbolReaper& SymReaper) {}
  71
  72   // Return statements.
  73   virtual void evalReturn(ExplodedNodeSet& Dst,
  74                           GRExprEngine& Engine,
  75                           GRStmtNodeBuilder& Builder,
  76                           const ReturnStmt* S,
  77                           ExplodedNode* Pred) {}
  78
  79   // Assumptions.
  80   virtual const GRState* evalAssume(const GRState *state,
  81                                     SVal Cond, bool Assumption) {
  82     return state;
  83   }
  84 };
  85 } // end clang namespace
  86
  87 #endif