InvisibleLoc.hpp

Go to the documentation of this file.

#ifndef InvisibleLoc_H
#define InvisibleLoc_H

#include "Location.hpp"
#include <OpenAnalysis/MemRefExpr/MemRefExpr.hpp>
#include <OpenAnalysis/MemRefExpr/MemRefExprVisitor.hpp>

namespace OA {

class InvisibleLoc : public Location {
  public:
    InvisibleLoc(OA_ptr<MemRefExpr> mre) : mMRE(mre) { }

    InvisibleLoc(InvisibleLoc &other);

    ~InvisibleLoc() { }

    void acceptVisitor(LocationVisitor& pVisitor);

    //*****************************************************************
    // Subclass type methods 
    //*****************************************************************
    bool isaInvisible() { return true; }

    //*****************************************************************
    // Info methods 
    //*****************************************************************
    OA_ptr<Location> getBaseLoc(); 

    bool isLocal() { return false; }
    bool isUnique() { return false; } // actually unknown

    /* PLM 1/23/07 deprecated hasFullAccuracy
    bool hasFullAccuracy() { return mMRE->hasFullAccuracy(); }
    */

    OA_ptr<MemRefExpr> getMemRefExpr() { return mMRE; }
    SymHandle getBaseSym();
    
    //*****************************************************************
    // Relationship methods 
    //*****************************************************************
    bool operator<(Location & other);
    bool operator==(Location& other);

    bool mayOverlap(Location& other);

    bool mustOverlap(Location& other);

    bool subSetOf(Location& other);

    //*****************************************************************
    // Annotation Interface
    //*****************************************************************
    void output(IRHandlesIRInterface& ir);

    //*****************************************************************
    // Debugging
    //*****************************************************************
    void dump(std::ostream& os);
    void dump(std::ostream& os, OA_ptr<IRHandlesIRInterface> pIR);

    std::string toString(OA_ptr<IRHandlesIRInterface> pIR);

    virtual int getOrder() { return sOrder; }

  private:
    OA_ptr<MemRefExpr> mMRE;

    static const int sOrder = 300;
};

} // end namespace
#endif