NamedLoc.hpp

Go to the documentation of this file.

#ifndef NamedLoc_H
#define NamedLoc_H

#include "Location.hpp"

namespace OA {

class NamedLoc: public Location {
  public:
    NamedLoc(SymHandle sh, bool isLocal) :
        mSymHandle(sh), mLocal(isLocal) { }

    NamedLoc(NamedLoc &other); 

    ~NamedLoc() { }

    void addFullOverlap(SymHandle s) { mFullOverlap.insert(s); }
    void addPartOverlap(SymHandle s) { mPartOverlap.insert(s); }

    void acceptVisitor(LocationVisitor& pVisitor);

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

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

    bool isLocal() { return mLocal; }
    bool isUnique() { return true; }
    SymHandle getSymHandle() { return mSymHandle; }
    bool staticFullOverlap(SymHandle);
    bool staticPartOverlap(SymHandle);
    OA_ptr<SymHandleIterator> getPartOverlapIter();
    OA_ptr<SymHandleIterator> getFullOverlapIter();

    //*****************************************************************
    // 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:
    SymHandle mSymHandle;

    bool mLocal;
    
    // need sets for these so can use comparison of sets
    std::set<SymHandle>  mFullOverlap;
    std::set<SymHandle>  mPartOverlap;

    static const int sOrder = 100;
};

}

#endif