| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef OOX_HELPER_REFVECTOR_HXX |
| #define OOX_HELPER_REFVECTOR_HXX |
| |
| #include <vector> |
| #include <boost/bind.hpp> |
| #include <boost/shared_ptr.hpp> |
| #include <sal/types.h> |
| |
| namespace oox { |
| |
| // ============================================================================ |
| |
| /** Template for a vector of ref-counted objects with additional accessor functions. |
| |
| An instance of the class RefVector< Type > stores elements of the type |
| ::boost::shared_ptr< Type >. The new accessor functions has() and get() |
| work correctly for indexes out of the current range, there is no need to |
| check the passed index before. |
| */ |
| template< typename ObjType > |
| class RefVector : public ::std::vector< ::boost::shared_ptr< ObjType > > |
| { |
| public: |
| typedef ::std::vector< ::boost::shared_ptr< ObjType > > container_type; |
| typedef typename container_type::value_type value_type; |
| typedef typename container_type::size_type size_type; |
| |
| public: |
| /** Returns true, if the object with the passed index exists. Returns |
| false, if the vector element exists but is an empty reference. */ |
| inline bool has( sal_Int32 nIndex ) const |
| { |
| const value_type* pxRef = getRef( nIndex ); |
| return pxRef && pxRef->get(); |
| } |
| |
| /** Returns a reference to the object with the passed index, or 0 on error. */ |
| inline value_type get( sal_Int32 nIndex ) const |
| { |
| if( const value_type* pxRef = getRef( nIndex ) ) return *pxRef; |
| return value_type(); |
| } |
| |
| /** Returns the index of the last element, or -1, if the vector is empty. |
| Does *not* check whether the last element is an empty reference. */ |
| inline sal_Int32 getLastIndex() const { return static_cast< sal_Int32 >( this->size() ) - 1; } |
| |
| /** Calls the passed functor for every contained object, automatically |
| skips all elements that are empty references. */ |
| template< typename FunctorType > |
| inline void forEach( FunctorType aFunctor ) const |
| { |
| ::std::for_each( this->begin(), this->end(), ForEachFunctor< FunctorType >( aFunctor ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object, |
| automatically skips all elements that are empty references. */ |
| template< typename FuncType > |
| inline void forEachMem( FuncType pFunc ) const |
| { |
| forEach( ::boost::bind( pFunc, _1 ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object, |
| automatically skips all elements that are empty references. */ |
| template< typename FuncType, typename ParamType > |
| inline void forEachMem( FuncType pFunc, ParamType aParam ) const |
| { |
| forEach( ::boost::bind( pFunc, _1, aParam ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object, |
| automatically skips all elements that are empty references. */ |
| template< typename FuncType, typename ParamType1, typename ParamType2 > |
| inline void forEachMem( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2 ) const |
| { |
| forEach( ::boost::bind( pFunc, _1, aParam1, aParam2 ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object, |
| automatically skips all elements that are empty references. */ |
| template< typename FuncType, typename ParamType1, typename ParamType2, typename ParamType3 > |
| inline void forEachMem( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2, ParamType3 aParam3 ) const |
| { |
| forEach( ::boost::bind( pFunc, _1, aParam1, aParam2, aParam3 ) ); |
| } |
| |
| /** Calls the passed functor for every contained object. Passes the index as |
| first argument and the object reference as second argument to rFunctor. */ |
| template< typename FunctorType > |
| inline void forEachWithIndex( const FunctorType& rFunctor ) const |
| { |
| ::std::for_each( this->begin(), this->end(), ForEachFunctorWithIndex< FunctorType >( rFunctor ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object. |
| Passes the vector index to the member function. */ |
| template< typename FuncType > |
| inline void forEachMemWithIndex( FuncType pFunc ) const |
| { |
| forEachWithIndex( ::boost::bind( pFunc, _2, _1 ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object. |
| Passes the vector index as first argument to the member function. */ |
| template< typename FuncType, typename ParamType > |
| inline void forEachMemWithIndex( FuncType pFunc, ParamType aParam ) const |
| { |
| forEachWithIndex( ::boost::bind( pFunc, _2, _1, aParam ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object. |
| Passes the vector index as first argument to the member function. */ |
| template< typename FuncType, typename ParamType1, typename ParamType2 > |
| inline void forEachMemWithIndex( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2 ) const |
| { |
| forEachWithIndex( ::boost::bind( pFunc, _2, _1, aParam1, aParam2 ) ); |
| } |
| |
| /** Calls the passed member function of ObjType on every contained object. |
| Passes the vector index as first argument to the member function. */ |
| template< typename FuncType, typename ParamType1, typename ParamType2, typename ParamType3 > |
| inline void forEachMemWithIndex( FuncType pFunc, ParamType1 aParam1, ParamType2 aParam2, ParamType3 aParam3 ) const |
| { |
| forEachWithIndex( ::boost::bind( pFunc, _2, _1, aParam1, aParam2, aParam3 ) ); |
| } |
| |
| /** Searches for an element by using the passed functor that takes a |
| constant reference of the object type (const ObjType&). */ |
| template< typename FunctorType > |
| inline value_type findIf( const FunctorType& rFunctor ) const |
| { |
| typename container_type::const_iterator aIt = ::std::find_if( this->begin(), this->end(), FindFunctor< FunctorType >( rFunctor ) ); |
| return (aIt == this->end()) ? value_type() : *aIt; |
| } |
| |
| private: |
| template< typename FunctorType > |
| struct ForEachFunctor |
| { |
| FunctorType maFunctor; |
| inline explicit ForEachFunctor( const FunctorType& rFunctor ) : maFunctor( rFunctor ) {} |
| inline void operator()( const value_type& rxValue ) { if( rxValue.get() ) maFunctor( *rxValue ); } |
| }; |
| |
| template< typename FunctorType > |
| struct ForEachFunctorWithIndex |
| { |
| FunctorType maFunctor; |
| sal_Int32 mnIndex; |
| inline explicit ForEachFunctorWithIndex( const FunctorType& rFunctor ) : maFunctor( rFunctor ), mnIndex( 0 ) {} |
| inline void operator()( const value_type& rxValue ) { if( rxValue.get() ) maFunctor( mnIndex, *rxValue ); ++mnIndex; } |
| }; |
| |
| template< typename FunctorType > |
| struct FindFunctor |
| { |
| FunctorType maFunctor; |
| inline explicit FindFunctor( const FunctorType& rFunctor ) : maFunctor( rFunctor ) {} |
| inline bool operator()( const value_type& rxValue ) { return rxValue.get() && maFunctor( *rxValue ); } |
| }; |
| |
| inline const value_type* getRef( sal_Int32 nIndex ) const |
| { |
| return ((0 <= nIndex) && (static_cast< size_type >( nIndex ) < this->size())) ? |
| &(*this)[ static_cast< size_type >( nIndex ) ] : 0; |
| } |
| }; |
| |
| // ============================================================================ |
| |
| } // namespace oox |
| |
| #endif |
