SSAIRInterface.hpp

Go to the documentation of this file.

#ifndef SSAIRInterface_h
#define SSAIRInterface_h

//-----------------------------------------------------------------------------
// This file contains the abstract base classes for the IR interface.
//
// See the top level README for a description of the IRInterface and
// how to use it.
//-----------------------------------------------------------------------------

#include <iostream>
#include "IRHandles.hpp"
#include <OpenAnalysis/Utils/OA_ptr.hpp>

namespace OA {
  namespace SSA {


// Enumerate all the variable uses or variable definitions in a statement.
// This is useful for analyses that require information about variable
// references or definitions, such as SSA construction.
// 
// FIXME: Move to IRHandles; even better, merge with MemRefHandleIterator
class IRUseDefIterator {
public:
  enum { Uses, Defs };

  IRUseDefIterator() { }
  virtual ~IRUseDefIterator() { }

  virtual LeafHandle current() const = 0;   // Returns the current item.
  virtual bool isValid () = 0;        // False when all items are exhausted. 
  
  virtual void operator++() = 0;
  void operator++(int) { ++*this; }
  
  virtual void reset() = 0;
};


//-----------------------------------------------------------------------------
//
//-----------------------------------------------------------------------------

class SSAIRInterface : public virtual IRHandlesIRInterface {
 public:
  SSAIRInterface() { }
  virtual ~SSAIRInterface() { }

  // FIXME: this should probably be merged with MemRefHandleIterator
  
  
  virtual OA_ptr<IRUseDefIterator> getUses(StmtHandle h) = 0;

  virtual OA_ptr<IRUseDefIterator> getDefs(StmtHandle h) = 0;

  // Getsymhandle Given a LeafHandle containing a use or def, return
  // the referened SymHandle.
  virtual SymHandle getSymHandle(LeafHandle h) = 0;
  
};


  } // end of namespace SSA
} // end of namespace OA

#endif // SSAIRInterface_h