scope-path.hpp

Go to the documentation of this file.

/*
  SCOPE-PATH.hpp  -  logical access path down from Session root

  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_PATH_H
#define STEAM_MOBJECT_SESSION_SCOPE_PATH_H

#include "steam/mobject/session/scope.hpp"
#include "lib/iter-adapter.hpp"
#include "lib/error.hpp"

#include <vector>
#include <string>


namespace lib {
namespace meta{

  using steam::mobject::session::Scope;

  template<>
  struct ValueTypeBinding<vector<Scope>::const_reverse_iterator>
    {
      typedef const Scope   value_type;
      typedef Scope const&  reference;
      typedef const Scope*  pointer;
    };
}}

namespace steam {
namespace mobject {
namespace session {
  
  
  class ScopePath
    {
      size_t refcount_;
      std::vector<Scope> path_;
      
      typedef vector<Scope>                  _VType;
      typedef _VType::const_reverse_iterator _VIter;
      typedef lib::RangeIter<_VIter>      _IterType;
      
    public:
     ~ScopePath ();
      ScopePath ();
      ScopePath (Scope const& leaf);
      
      ScopePath (ScopePath const&);
      ScopePath&
      operator= (ScopePath const&);
      
      static const ScopePath INVALID;
      
      explicit operator bool()  const { return isValid(); }
      
      
      /* == state diagnostics == */
      bool isValid()    const;
      bool empty()      const;
      bool isRoot()     const;
      size_t size()     const;
      size_t length()   const;
      size_t ref_count()const;
      operator string() const;
      
      typedef _IterType iterator;
      iterator begin()  const;
      iterator end()    const;
      
      
      /* == relations == */
      Scope const& getLeaf()           const;
      bool endsAt (Scope const&)       const;
      bool contains (Scope const&)     const;
      bool contains (ScopePath const&) const;
      
      friend ScopePath commonPrefix (ScopePath const&, ScopePath const&);
      friend bool      disjoint     (ScopePath const&, ScopePath const&);
      
      friend bool operator== (ScopePath const&, ScopePath const&);
      
      friend void intrusive_ptr_add_ref (ScopePath*);
      friend void intrusive_ptr_release (ScopePath*);
      
      
      /* == mutations == */
      void clear();
      Scope const& moveUp();
      Scope const& goRoot();
      void navigate (Scope const&);
      
      
    private:
      bool hasValidRoot()                 const;
      PlacementMO const& currModelRoot()  const;
      void appendScope (Scope const&);
    };
  
  
  
  
  
  
  
  inline bool
  operator== (ScopePath const& path1, ScopePath const& path2)
  {
    return path1.path_ == path2.path_;
  }
  
  inline bool
  operator!= (ScopePath const& path1, ScopePath const& path2)
  {
    return not (path1 == path2);
  }
  
  
  inline void
  intrusive_ptr_add_ref (ScopePath* pathFrame)
  {
    REQUIRE (pathFrame);
    ++(pathFrame->refcount_);
  }
  
  inline void
  intrusive_ptr_release (ScopePath* pathFrame)
  {
    REQUIRE (pathFrame);
    if (0 < pathFrame->refcount_)
      --(pathFrame->refcount_);
  }

  
  
  inline size_t
  ScopePath::ref_count()  const
  {
    return refcount_;
  }
  
  
  inline size_t
  ScopePath::length()  const
  {
    return path_.size();
  }
  
  
  inline size_t
  ScopePath::size()  const
  {
    return path_.size();
  }
  
  inline bool
  ScopePath::empty()  const
  {
    return path_.empty();
  }
  
  inline bool
  ScopePath::isRoot() const
  {
    return (1 == size())
#if NOBUG_MODE_ALPHA
        && path_[0].isRoot()
#endif
        ;
  }
  
  
  
   inline ScopePath::iterator
  ScopePath::begin()  const
  {
    return iterator (path_.rbegin(), path_.rend());
  }
  
  inline ScopePath::iterator
  ScopePath::end()    const
  {
    return iterator();
  }
  
  
}}} // namespace mobject::session
#endif