LocSubSet.hpp

Go to the documentation of this file.

#ifndef LocSubSet_H
#define LocSubSet_H

#include "Location.hpp"

namespace OA {

class LocSubSet : public Location {
  public:
    LocSubSet(OA_ptr<Location> baseLoc);
    LocSubSet(OA_ptr<Location> baseLoc, bool full);

    LocSubSet(LocSubSet &other) : mLoc(other.mLoc), mFull(other.mFull) {}

    virtual ~LocSubSet() { }

    virtual void acceptVisitor(LocationVisitor& pVisitor);

    //*****************************************************************
    // Location subclass type methods 
    //*****************************************************************
    bool isaSubSet() { return true; }

    //*****************************************************************
    // LocSubSet subclass type methods 
    //*****************************************************************
    bool isSubClassOfLocSubSet() { return isaIdxSubSet() 
                                          || isaFieldSubSet(); }

    virtual bool isaIdxSubSet() { return false; }
    virtual bool isaFieldSubSet() { return false; }

    //*****************************************************************
    // Info methods 
    //*****************************************************************
    OA_ptr<Location> getBaseLoc() { return mLoc; }

    OA_ptr<Location> getLoc() { return mLoc; }

    virtual bool isFull() { return mFull; }

    bool isLocal() { assert(!mLoc.ptrEqual(NULL));  return mLoc->isLocal(); }

    bool isUnique() { assert(!mLoc.ptrEqual(NULL));  return mLoc->isUnique(); }
    // FIXME: does this make sense for a subset?

    //*****************************************************************
    // Relationship methods
    //*****************************************************************
    virtual bool operator<(Location & other);
    virtual bool operator==(Location& other);
    virtual bool mayOverlap(Location& other);

    virtual bool mustOverlap(Location& other);

    virtual bool subSetOf(Location& other);

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

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

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

    virtual int getOrder() { return sOrder; }

  protected:

    OA_ptr<Location> mLoc;

  private:    
    bool mFull;

    void composeWithBaseLoc(OA_ptr<Location> baseLoc);

    static const int sOrder = 600;
};

} // end namespace

#endif