scope-locator.hpp

Go to the documentation of this file.

/*
  SCOPE-LOCATOR.hpp  -  management and registration point for the QueryFocus-system

  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_LOCATOR_H
#define STEAM_MOBJECT_SESSION_SCOPE_LOCATOR_H

#include "steam/mobject/session/scope.hpp"
#include "steam/mobject/session/scope-query.hpp"
#include "steam/mobject/placement.hpp"
#include "lib/iter-source.hpp"                 
#include "lib/depend.hpp"

#include <memory>


namespace steam {
namespace mobject {
namespace session {
  
  class QueryFocusStack;
  class ScopePath;
  
  
  
  class ScopeLocator
    {
      std::unique_ptr<QueryFocusStack> focusStack_;
      
    public:
      static lib::Depend<ScopeLocator> instance;
      
      ScopePath& currPath();
      ScopePath& pushPath();
      
      template<typename MO>
      typename ScopeQuery<MO>::iterator
      explore (Scope const&);
      
      template<typename MO>
      typename ScopeQuery<MO>::iterator
      query (Scope const&);
      
      template<typename MO>
      typename ScopeQuery<MO>::iterator
      getRawPath (Scope const&);
      
      ScopeQuery<MObject>::iterator
      getRawPath (Scope const&);
      
      lib::IterSource<const Scope>::iterator
      locate (Scope const& target);
      
      size_t stackSize()  const;
      
      
     ~ScopeLocator();
      
    protected:
      ScopeLocator();
      
      friend class lib::DependencyFactory<ScopeLocator>;
      
    private:
      lumiera::QueryResolver const& theResolver();
    };
  
  
  
  
  template<typename MO>
  inline typename ScopeQuery<MO>::iterator
  ScopeLocator::explore (Scope const& scope)
  {
    return ScopeQuery<MO> (scope.getTop(), CHILDREN).resolveBy (theResolver());
  }
  
  
  template<typename MO>
  inline typename ScopeQuery<MO>::iterator
  ScopeLocator::query (Scope const& scope)
  {
    return ScopeQuery<MO> (scope.getTop(), CONTENTS).resolveBy (theResolver());
  }
  
  
  template<typename MO>
  inline typename ScopeQuery<MO>::iterator
  ScopeLocator::getRawPath (Scope const& scope)
  {
    return ScopeQuery<MO> (scope.getTop(), PATH).resolveBy (theResolver());
  }

  inline ScopeQuery<MObject>::iterator
  ScopeLocator::getRawPath (Scope const& scope)
  {
    return ScopeQuery<MObject> (scope.getTop(), PATH).resolveBy (theResolver());
  }
  
  
}}} // namespace steam::mobject::session
#endif