Location.hpp

Go to the documentation of this file.

#ifndef Location_H
#define Location_H

#include <iostream>
#include <cassert>
#include <list>
#include <set>
#include <algorithm>
#include <OpenAnalysis/IRInterface/IRHandles.hpp>
#include <OpenAnalysis/OABase/Annotation.hpp>
#include <OpenAnalysis/Utils/OA_ptr.hpp>

using namespace std;
namespace OA {

class Location;

// forward-decl to avoid circular reference in header files
class LocationVisitor;



// Location set abstraction
typedef std::set<OA_ptr<Location> > LocSet;

void dumpLocSet(std::set<OA_ptr<Location> >& set, std::ostream& os, 
                OA_ptr<IRHandlesIRInterface> pIR, bool succinct=false);

OA_ptr<std::set<OA_ptr<Location> > > 
intersectLocSets(std::set<OA_ptr<Location> >& set1,
                 std::set<OA_ptr<Location> >& set2);
                 
OA_ptr<std::set<OA_ptr<Location> > > 
    unionLocSets(
        std::set<OA_ptr<Location> >& set1,
        std::set<OA_ptr<Location> >& set2);

bool mayOverlapLocSets(std::set<OA_ptr<Location> >& set1,
                       std::set<OA_ptr<Location> >& set2);

bool subSetOf(std::set<OA_ptr<Location> >& set1, 
              std::set<OA_ptr<Location> >& set2);


class Location : public Annotation {
  public:
    Location();
    Location(Location &loc) {}
    virtual ~Location() {}

    virtual void acceptVisitor(LocationVisitor& pVisitor) = 0;

    //*****************************************************************
    // Subclass type methods 
    //*****************************************************************
    virtual bool isaNamed() { return false; }
    virtual bool isaUnnamed() { return false; }
    virtual bool isaUnknown() { return false; }
    virtual bool isaInvisible() { return false; }
    virtual bool isaSubSet() { return false; }

    //*****************************************************************
    // Info methods 
    //*****************************************************************
    
    virtual OA_ptr<Location> getBaseLoc() = 0;
    
    virtual bool isLocal() { return false; }

    virtual bool isUnique() { return false; }
    
    
    /* PLM 1/23/07 deprecated hasFullAccuracy
    virtual bool hasFullAccuracy() { return true; }
    */

    //*****************************************************************
    // Relationship methods 
    //*****************************************************************

    virtual bool operator<(Location & other) = 0;

    virtual bool operator==(Location & other) = 0;

    virtual bool operator!=(Location & other) { return ! operator==(other); }

    virtual bool mayOverlap(Location & other) { return true; }

    virtual bool mustOverlap(Location & other) { return false; }

    virtual bool subSetOf(Location & other) { return true; }

    //*****************************************************************
    // Debugging
    //*****************************************************************
    virtual void dump(ostream& os, OA_ptr<IRHandlesIRInterface> pIR) = 0;
    virtual void dump(ostream& os) = 0;

    virtual string toString(OA_ptr<IRHandlesIRInterface> pIR) = 0;

    virtual int getOrder() { return sOrder; }

  private:
    static const int sOrder = -100;
};


} // end of OA namespace
#endif