query-focus.hpp

Go to the documentation of this file.

/*
  QUERY-FOCUS.hpp  -  management of current scope within the Session

  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 MOBJECT_SESSION_QUERY_FOCUS_H
#define MOBJECT_SESSION_QUERY_FOCUS_H

#include "steam/mobject/session/scope-path.hpp"
#include "steam/mobject/session/scope-query.hpp"
#include "steam/mobject/session/scope-locator.hpp"
#include "steam/mobject/placement-ref.hpp"

#include <boost/intrusive_ptr.hpp>
#include <string>

namespace steam {
namespace mobject {
namespace session {
  
  
  
  class QueryFocus
    {
      boost::intrusive_ptr<ScopePath> focus_;
      
    public:
      QueryFocus();
      
      ScopePath const& currentPath()  const;
      RefPlacement     currentPoint() const;
      operator Scope()                const;
      operator string()               const;
      
      QueryFocus&      shift (Scope const&);
      static QueryFocus push (Scope const&);
      static QueryFocus push ();
      QueryFocus& reset ();
      QueryFocus& pop ();
      
      
      template<class MO>
      typename ScopeQuery<MO>::iterator
      query()  const;
      
      template<class MO>
      typename ScopeQuery<MO>::iterator
      explore()  const;
      
      lib::IterSource<const Scope>::iterator
      locate (Scope const& toTarget);
      
      
    private:
      QueryFocus (ScopePath&);
      static ScopePath& currPath();
    };
  
  
  
  
  
  
  inline QueryFocus::operator Scope() const
  {
    return focus_->getLeaf();
  }
  
  inline ScopePath const&
  QueryFocus::currentPath()  const
  {
    return *focus_;
  }
  
  inline RefPlacement
  QueryFocus::currentPoint() const
  {
    return RefPlacement (focus_->getLeaf().getTop());
  }
  
  
  template<class MO>
  inline typename ScopeQuery<MO>::iterator
  QueryFocus::query()  const
  {
    return ScopeLocator::instance().query<MO> (*this);
  }
  
  
  template<class MO>
  inline typename ScopeQuery<MO>::iterator
  QueryFocus::explore()  const
  {
    return ScopeLocator::instance().explore<MO> (*this);
  }
  
  
  inline lib::IterSource<const Scope>::iterator
  QueryFocus::locate (Scope const& toTarget)
  {
    return ScopeLocator::instance().locate (toTarget);
  }
  
  
  
}}} // namespace steam::mobject::session
#endif