From: Zhongxing Xu <xuzhongxing@gmail.com>
Date: Thu, 6 Aug 2009 12:49:15 +0000 (+0000)
Subject: I forgot adding this header for r78298.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=d91bb0c0c47e2219e94238468f0df0e354bdff29;p=clang

I forgot adding this header for r78298.


git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@78302 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/clang/Analysis/PathSensitive/GRSubEngine.h b/include/clang/Analysis/PathSensitive/GRSubEngine.h
new file mode 100644
index 0000000000..9f9cbcbe3a
--- /dev/null
+++ b/include/clang/Analysis/PathSensitive/GRSubEngine.h
@@ -0,0 +1,65 @@
+//== GRSubEngine.h - Interface of the subengine of GRCoreEngine ----*- C++ -*-//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// This file defines the interface of a subengine of the GRCoreEngine. 
+//
+//===----------------------------------------------------------------------===//
+#ifndef LLVM_CLANG_ANALYSIS_GRSUBENGINE_H
+#define LLVM_CLANG_ANALYSIS_GRSUBENGINE_H
+
+namespace clang {
+
+class Stmt;
+class CFGBlock;
+class GRState;
+class GRStateManager;
+class GRBlockCounter;
+class GRStmtNodeBuilder;
+class GRBranchNodeBuilder;
+class GRIndirectGotoNodeBuilder;
+class GRSwitchNodeBuilder;
+class GREndPathNodeBuilder;
+
+class GRSubEngine {
+public:
+  virtual const GRState* getInitialState() = 0;
+
+  virtual GRStateManager& getStateManager() = 0;
+
+  /// ProcessStmt - Called by GRCoreEngine. Used to generate new successor
+  ///  nodes by processing the 'effects' of a block-level statement.  
+  virtual void ProcessStmt(Stmt* S, GRStmtNodeBuilder& builder) = 0; 
+  
+  /// ProcessBlockEntrance - Called by GRCoreEngine when start processing
+  ///  a CFGBlock.  This method returns true if the analysis should continue
+  ///  exploring the given path, and false otherwise.
+  virtual bool ProcessBlockEntrance(CFGBlock* B, const GRState* St,
+                                    GRBlockCounter BC) = 0;
+  
+  /// ProcessBranch - Called by GRCoreEngine.  Used to generate successor
+  ///  nodes by processing the 'effects' of a branch condition.
+  virtual void ProcessBranch(Stmt* Condition, Stmt* Term, 
+                             GRBranchNodeBuilder& builder) = 0;
+  
+  /// ProcessIndirectGoto - Called by GRCoreEngine.  Used to generate successor
+  ///  nodes by processing the 'effects' of a computed goto jump.
+  virtual void ProcessIndirectGoto(GRIndirectGotoNodeBuilder& builder) = 0;
+  
+  /// ProcessSwitch - Called by GRCoreEngine.  Used to generate successor
+  ///  nodes by processing the 'effects' of a switch statement.
+  virtual void ProcessSwitch(GRSwitchNodeBuilder& builder) = 0;
+  
+  /// ProcessEndPath - Called by GRCoreEngine.  Used to generate end-of-path
+  ///  nodes when the control reaches the end of a function.
+  virtual void ProcessEndPath(GREndPathNodeBuilder& builder) = 0;
+};
+
+}
+
+#endif