AliasTagInterface.hpp

Go to the documentation of this file.

#ifndef AliasTagInterface_H
#define AliasTagInterface_H

#include <OpenAnalysis/Utils/OA_ptr.hpp>
#include <OpenAnalysis/IRInterface/IRHandles.hpp>
#include <OpenAnalysis/MemRefExpr/MemRefExpr.hpp>
#include <OpenAnalysis/Alias/AliasTag.hpp>

namespace OA {
  namespace AliasTag {

     
typedef enum {
    NOALIAS,     
    MAYALIAS,  
    MUSTALIAS   
} AliasResultType;

class AliasTagIterator {
public:
  AliasTagIterator() { }
  virtual ~AliasTagIterator() { }

  virtual AliasTag current() = 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 AliasTagInterface {
  public:
    AliasTagInterface() {}
    virtual ~AliasTagInterface() {};

    virtual AliasResultType alias(MemRefHandle ref1, 
                                  MemRefHandle ref2) = 0;
       
    
    //virtual OA_ptr<TagIterator> getAliasTags( OA_ptr<MemRefExpr> mre, 
    //                    CallContext context, SymHandle stmt ) = 0;
    
    virtual OA_ptr<AliasTagIterator> getAliasTags( OA_ptr<MemRefExpr> mre )=0;

    //virtual OA_ptr<TagIterator> getAliasTags( MemRefHandle memref,
    //                    CallContext context, SymHandle stmt ) = 0;
                
    virtual OA_ptr<AliasTagIterator> getAliasTags( MemRefHandle memref )=0;

    //FIXME: will need to uncomment at some point, MMS 12/16/07
    // virtual OA_ptr<MemRefExprIterator> getMemRefExprIterator(AliasTag tag)=0;
   
    // FIXME: MMS 12/16/07, is this used anymore?
    //virtual OA_ptr<MemRefIterator> getMemRefIter() = 0;

};

//typedef MemRefHandleIterator MemRefIterator;

  } // end of Alias namespace
} // end of OA namespace

#endif