CFGInterface.hpp

Go to the documentation of this file.

#ifndef CFGINTERFACE_H
#define CFGINTERFACE_H

#include <OpenAnalysis/IRInterface/IRHandles.hpp>
#include <OpenAnalysis/Utils/DGraph/DGraphInterface.hpp>
#include <OpenAnalysis/Utils/DGraph/DGraphImplement.hpp>

namespace OA {
  namespace CFG {


//======================================================================
//=====================================================================
  enum EdgeType { TRUE_EDGE = 0, FALLTHROUGH_EDGE, FALSE_EDGE,
                  BACK_EDGE, MULTIWAY_EDGE, BREAK_EDGE,
                  CONTINUE_EDGE, RETURN_EDGE };

  //------------------------------------------------------------------
  typedef StmtHandleIterator NodeStatementsIteratorInterface;
  typedef StmtHandleIterator NodeStatementsRevIteratorInterface;
  class NodeInterface;
  class EdgeInterface;
  class NodesIteratorInterface;
  class EdgesIteratorInterface;
  class CFGInterface;

  //------------------------------------------------------------------
  //------------------------------------------------------------------
  class NodeInterface : public virtual DGraph::NodeInterface 
  {
  public:
    NodeInterface () { };
    
    NodeInterface (OA::StmtHandle n) { };
    
    //virtual ~Node () = 0;
    virtual ~NodeInterface () { };
    
    //virtual unsigned int getId() const = 0;
    
    virtual unsigned int size () const = 0;

    virtual OA_ptr<NodeStatementsIteratorInterface> getNodeStatementsIterator() const = 0;

    virtual OA_ptr<NodeStatementsRevIteratorInterface> 
        getNodeStatementsRevIterator() const = 0;

    virtual OA_ptr<EdgesIteratorInterface> 
        getCFGIncomingEdgesIterator() const = 0;

    virtual OA_ptr<EdgesIteratorInterface> 
        getCFGOutgoingEdgesIterator() const = 0;

    virtual OA_ptr<NodesIteratorInterface> 
        getCFGSourceNodesIterator() const = 0;

    virtual OA_ptr<NodesIteratorInterface> 
        getCFGPredNodesIterator() const = 0;

    virtual OA_ptr<NodesIteratorInterface> 
        getCFGSinkNodesIterator() const = 0;

    virtual OA_ptr<NodesIteratorInterface> 
        getCFGSuccNodesIterator() const = 0;

  
  };
  
  //------------------------------------------------------------------
  //------------------------------------------------------------------
  class EdgeInterface : public virtual DGraph::EdgeInterface
  {
  public:
    EdgeInterface () { };
    
    virtual ~EdgeInterface () { };
    
    virtual OA_ptr<NodeInterface> 
        getCFGSource() const = 0;
    
    virtual OA_ptr<NodeInterface> 
        getCFGSink() const = 0;
    
  public:
    // get an id unique within instances of Interface::Edge
    //virtual unsigned int getId() const = 0;

    virtual EdgeType getType() const = 0;
    
    virtual ExprHandle getExpr() const = 0;

  };  


class CFGInterface : public virtual DGraph::DGraphInterface
{ 
public:
  CFGInterface() {}
  virtual ~CFGInterface () {}

  //-------------------------------------
  // CFG information access
  //-------------------------------------
  
  virtual OA_ptr<NodeInterface> getEntry() const = 0;
  
  virtual OA_ptr<NodeInterface> getExit() const = 0;

  virtual SymHandle getName () const = 0; 
    
  virtual OA_ptr<NodesIteratorInterface> 
      getCFGNodesIterator() const = 0;

  // method to get a more specific iterator
  virtual OA_ptr<EdgesIteratorInterface> 
      getCFGEdgesIterator() const = 0;


  virtual OA_ptr<NodesIteratorInterface> 
      getCFGEntryNodesIterator() const = 0;

  virtual OA_ptr<NodesIteratorInterface> 
      getCFGExitNodesIterator() const = 0;


  virtual OA_ptr<NodesIteratorInterface>
      getCFGReversePostDFSIterator(DGraph::DGraphEdgeDirection pOrient) = 0;

  virtual OA_ptr<NodesIteratorInterface>  
      getCFGDFSIterator(OA_ptr<NodeInterface> n) = 0;

  };


  //------------------------------------------------------------------
  class NodesIteratorInterface : 
      public virtual DGraph::NodesIteratorInterface {
  public:

    virtual OA_ptr<NodeInterface> 
        currentCFGNode() const = 0;

  };
  
//------------------------------------------------------------------
  class EdgesIteratorInterface :
      public virtual DGraph::EdgesIteratorInterface {
  public:

     virtual OA_ptr<EdgeInterface> 
         currentCFGEdge() const = 0;
    
  };

  } // end of CFG namespace
} // end of OA namespace

#endif