OgreIteratorRange.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __Ogre_Iterator_Range_H__
#define __Ogre_Iterator_Range_H__


//#define OGRE_USE_BOOST 1 - picked up by CMake
#if OGRE_USE_BOOST
#include <boost/range.hpp>
#endif

namespace Ogre {

template <typename T>
class iterator_range{

#if !OGRE_USE_BOOST
    
    T mBegin, mEnd;
    
    public : 
    
        iterator_range( T b , T e ) : mBegin(b) , mEnd(e){}

        T begin() const { return mBegin; }
        
        T end() const   { return mEnd;  }   

        bool empty() const { return mBegin = mEnd ; }

        bool equal( const iterator_range& other ) const  
        {return mBegin == other.mBegin && mEnd == other.mEnd;}

        bool operator==( const iterator_range& rhs ) const
        {return equal( rhs ) ;}
    
        bool operator!=( const iterator_range& rhs ) const { return !operator==(rhs); }

        typedef T iterator;
        
        typedef T const_iterator;
        

        typedef iterator_range<T> type;
#else
        public: typedef boost::iterator_range<T> type ;

#endif
}; 


template<typename T>
struct VectorRange : public iterator_range<typename T::iterator>::type
{

    VectorRange( T& c )
    : iterator_range<typename T::iterator>::type( c.begin(), c.end() )
    {}

    VectorRange( typename T::iterator b, typename T::iterator e )
    : iterator_range<typename T::iterator>::type( b, e )
    {}

    bool operator==( const VectorRange& rhs ) const { return equal( rhs) ; }
    bool operator!=( const VectorRange& rhs ) const { return !equal( rhs) ; }


#ifdef __Ogre_Iterator_Wrapper_H__
    operator VectorIterator<T>(){return VectorIterator<T>( this->begin(), this->end());}
    operator ConstVectorIterator<T>(){return ConstVectorIterator<T>( this->begin(), this->end());}
#endif
    
};

template<typename T>
struct ConstVectorRange : public iterator_range<typename T::const_iterator>::type
{

    ConstVectorRange( const T& c )
    : iterator_range<typename T::const_iterator>::type( c.begin(), c.end() )
    {}

    ConstVectorRange( typename T::iterator b, typename T::iterator e )
    : iterator_range<typename T::const_iterator>::type( b, e )
    {}

    ConstVectorRange( typename T::const_iterator b, typename T::const_iterator e )
    : iterator_range<typename T::const_iterator>::type( b, e )
    {}

    ConstVectorRange( const VectorRange<T>& rhs  )
    : iterator_range<typename T::const_iterator>::type( rhs.begin(), rhs.end() )
    {}

    bool operator==( const ConstVectorRange& rhs ) const { return equal( rhs) ; }
    bool operator!=( const ConstVectorRange& rhs ) const { return !equal( rhs) ; }
    
    


#ifdef __Ogre_Iterator_Wrapper_H__
    operator ConstVectorIterator<T>(){return  ConstVectorIterator<T>( this->begin(),this->end());}
#endif
    
};



template<typename T>
struct MapRange : public iterator_range<typename T::iterator>::type
{
    MapRange( T& c )
    : iterator_range<typename T::iterator>::type( c.begin(), c.end() )
    {}

    MapRange( typename T::iterator b, typename T::iterator e )
    : iterator_range<typename T::iterator>::type( b, e )
    {}

    bool operator==( const MapRange& rhs ) const { return equal( rhs) ; }
    bool operator!=( const MapRange& rhs ) const { return !equal( rhs) ; }


#ifdef __Ogre_Iterator_Wrapper_H__
    operator MapIterator<T>(){return MapIterator<T>( this->begin(), this->end());}
    operator ConstMapIterator<T>(){return ConstMapIterator<T>( this->begin(), this->end());}
#endif
    
};

template<typename T>
struct ConstMapRange : public iterator_range<typename T::const_iterator>::type
{

    ConstMapRange( const T& c )
    : iterator_range<typename T::const_iterator>::type( c.begin(), c.end() )
    {}

    ConstMapRange( typename T::iterator b, typename T::iterator e )
    : iterator_range<typename T::const_iterator>::type( b, e )
    {}
    
    ConstMapRange( typename T::const_iterator b, typename T::const_iterator e )
    : iterator_range<typename T::const_iterator>::type( b, e )
    {}

    ConstMapRange( const MapRange<T>& rhs  )
    : iterator_range<typename T::const_iterator>::type( rhs.begin(), rhs.end() )
    {}
    
    bool operator==( const ConstMapRange& rhs ) const { return equal( rhs) ; }
    bool operator!=( const ConstMapRange& rhs ) const { return !equal( rhs) ; }


#ifdef __Ogre_Iterator_Wrapper_H__
    operator ConstMapIterator<T>(){return  ConstMapIterator<T>( this->begin(),this->end());}
#endif
    
};



}
#endif