Alias/Interface.hpp

Go to the documentation of this file.

#ifndef AliasInterface_H
#define AliasInterface_H

#include <OpenAnalysis/Utils/OA_ptr.hpp>
#include <OpenAnalysis/Location/Locations.hpp>

namespace OA {
  namespace Alias {

/* Mapping of Location to following enum sets
 * LocSubSet                        => 1
 * InvisibleLoc(MRE: not SubSetRef) => 2
 * InvisibleLoc(MRE: SubSetRef)     => 1 
 * NamedLoc                         => 2
 * UnnamedLoc                       => 1
 * Multiple Locations mapped 
   to the same set                  => 1
*/
      
typedef enum {
    NOALIAS,     
    MAYALIAS,  
    MUSTALIAS   
} AliasResultType;

typedef MemRefHandleIterator MemRefIterator;


class Interface {
  public:
    Interface() {}
    virtual ~Interface() {};

    virtual AliasResultType alias(MemRefHandle ref1, 
                                  MemRefHandle ref2) = 0;
       
    virtual OA_ptr<LocIterator> getMayLocs(MemRefHandle ref) = 0;

    virtual OA_ptr<LocIterator> getMustLocs(MemRefHandle ref) = 0;

    virtual OA_ptr<LocIterator> getMayLocs(MemRefExpr &ref, ProcHandle proc) = 0;

    virtual OA_ptr<LocIterator> getMustLocs(MemRefExpr &ref, ProcHandle proc) = 0;

    //FIXME: Deprecate
    //virtual OA_ptr<MemRefIterator> getMustAliases(MemRefHandle ref) = 0;

    //FIXME: Deprecate
    //virtual OA_ptr<MemRefIterator> getMayAliases(MemRefHandle ref) = 0;
    
    //FIXME: Deprecate
    //virtual OA_ptr<MemRefIterator> 
    //    getMustAliases(OA_ptr<Location> loc) = 0;

    //FIXME: Deprecate
    //virtual OA_ptr<MemRefIterator> 
    //    getMayAliases(OA_ptr<Location> loc) = 0;
    
    virtual OA_ptr<MemRefIterator> getMemRefIter() = 0;

};

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

#endif