CallGraphInterface.hpp

Go to the documentation of this file.

#ifndef CallGraphInterface_H
#define CallGraphInterface_H

//--------------------------------------------------------------------
// standard headers
#ifdef NO_STD_CHEADERS
# include <string.h>
#else
# include <cstring>
#endif

// STL headers
#include <list>
#include <map>

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

#include <OpenAnalysis/Utils/Iterator.hpp>
//--------------------------------------------------------------------

namespace OA {
  namespace CallGraph {

//--------------------------------------------------------------------
  class CallGraphInterface;    
  class NodesIteratorInterface;
  class EdgesIteratorInterface;
  class NodeInterface;
  class EdgeInterface;
  
  
  // Changes here must be also reflected in CallGraph.C:edgeTypeToString?
  enum EdgeType { NORMAL_EDGE = 0 };
 

class CallGraphInterface : public virtual DGraph::DGraphInterface {
  
public:
  ~CallGraphInterface() { }  
  //-------------------------------------
  // CallGraph information access
  //-------------------------------------
  
  virtual OA_ptr<ProcHandleIterator> getCalleeProcIter(CallHandle) = 0;

  //---------------------------------------------------------
  // CallGraph iterators
  //---------------------------------------------------------

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

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

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

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

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

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

  virtual const SymHandle subprog_name ()  = 0;

  virtual void dump (std::ostream& os, OA_ptr<IRHandlesIRInterface>) = 0;

};




  //------------------------------------------------------------------
  class NodesIteratorInterface : public virtual DGraph::NodesIteratorInterface {
  public:
  
    ~NodesIteratorInterface() { }
    
    virtual OA_ptr<NodeInterface> currentCallGraphNode() const = 0;
    
  };


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

    ~EdgesIteratorInterface() { }  
    
    virtual OA_ptr<EdgeInterface> currentCallGraphEdge() const = 0;
    
  };
  

  class NodeCallsIterator;
  //--------------------------------------------------------
  class NodeInterface : public virtual DGraph::NodeInterface {
  public:
      
    ~NodeInterface() { }  
      
    //virtual unsigned int getId() const = 0;
    
    virtual bool isDefined() const = 0;
    
    virtual bool isCalled() const  = 0;
    
    virtual ProcHandle getProc() const = 0;
    
    virtual SymHandle getProcSym() const = 0;
    
    virtual OA_ptr<EdgesIteratorInterface> getCallGraphIncomingEdgesIterator() const = 0;

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

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

    virtual OA_ptr<NodesIteratorInterface> getCallGraphSinkNodesIterator() const = 0;
    
  };
  


  //--------------------------------------------------------
  class EdgeInterface : public virtual DGraph::EdgeInterface {
  public:
   
    ~EdgeInterface() { }  
    
    //virtual unsigned int getId() const = 0;
    
    virtual CallHandle getCallHandle() const = 0;
    
    virtual EdgeType getType() const = 0;

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

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

    
  };  


  //--------------------------------------------------------
  
  class NodeCallsIteratorInterface : public Iterator 
  {
  public:
      
    ~NodeCallsIteratorInterface() { }  
      
    virtual void operator ++ () = 0;
    
    virtual bool isValid() = 0;
    
    virtual CallHandle current() = 0;
    
  };
  
//--------------------------------------------------------------------

  } // end of CallGraph namespace
} // end of OA namespace

#endif