scope.hpp

Go to the documentation of this file.

/*
  SCOPE.hpp  -  nested search scope for properties of placement

  Copyright (C)         Lumiera.org
    2009,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/


#ifndef STEAM_MOBJECT_SESSION_SCOPE_H
#define STEAM_MOBJECT_SESSION_SCOPE_H

#include "steam/mobject/placement.hpp"
#include "steam/mobject/placement-ref.hpp"
#include "lib/error.hpp"

#include <string>


namespace lumiera {
namespace error {
  LUMIERA_ERROR_DECLARE (EMPTY_SCOPE_PATH); 
  LUMIERA_ERROR_DECLARE (NO_PARENT_SCOPE); 
  LUMIERA_ERROR_DECLARE (INVALID_SCOPE);  
}}

namespace steam {
namespace mobject {
namespace session {
  
  
  
  class Scope
    {
      RefPlacement anchor_;
      
    public:
      Scope (PlacementMO const& constitutingPlacement);
      Scope (); 
      
      explicit
      Scope (PlacementMO::ID const& constitutingPlacement);
      
      Scope (Scope const&);
      Scope& operator= (Scope const&);
      
      static const Scope INVALID;
      
      static Scope containing (PlacementMO const& aPlacement);
      static Scope containing (RefPlacement const& refPlacement);
      
      operator std::string() const;
      Scope getParent()      const;
      PlacementMO& getTop()  const;
      bool isValid()         const;
      bool isRoot()          const;
      
      friend bool operator== (Scope const&, Scope const&);
      friend bool operator!= (Scope const&, Scope const&);
    };
  
  
  
  
  
  inline bool
  operator== (Scope const& scope1, Scope const& scope2)
  {
    return scope1.anchor_ == scope2.anchor_;
  }
  
  inline bool
  operator!= (Scope const& scope1, Scope const& scope2)
  {
    return scope1.anchor_ != scope2.anchor_;
  }
  
  
  
  
}}} // namespace steam::mobject::session
#endif