williamr@2: /* Copyright 2003-2005 Joaquín M López Muñoz.
williamr@2:  * Distributed under the Boost Software License, Version 1.0.
williamr@2:  * (See accompanying file LICENSE_1_0.txt or copy at
williamr@2:  * http://www.boost.org/LICENSE_1_0.txt)
williamr@2:  *
williamr@2:  * See http://www.boost.org/libs/multi_index for library home page.
williamr@2:  */
williamr@2: 
williamr@2: #ifndef BOOST_MULTI_INDEX_DETAIL_INDEX_BASE_HPP
williamr@2: #define BOOST_MULTI_INDEX_DETAIL_INDEX_BASE_HPP
williamr@2: 
williamr@2: #if defined(_MSC_VER)&&(_MSC_VER>=1200)
williamr@2: #pragma once
williamr@2: #endif
williamr@2: 
williamr@2: #include <boost/config.hpp> /* keep it first to prevent nasty warns in MSVC */
williamr@2: #include <boost/call_traits.hpp>
williamr@2: #include <boost/detail/workaround.hpp>
williamr@2: #include <boost/mpl/vector.hpp>
williamr@2: #include <boost/multi_index/detail/copy_map.hpp>
williamr@2: #include <boost/multi_index/detail/node_type.hpp>
williamr@2: #include <boost/multi_index_container_fwd.hpp>
williamr@2: #include <boost/tuple/tuple.hpp>
williamr@2: #include <utility>
williamr@2: 
williamr@2: #if !defined(BOOST_MULTI_INDEX_DISABLE_SERIALIZATION)
williamr@2: #include <boost/multi_index/detail/index_loader.hpp>
williamr@2: #include <boost/multi_index/detail/index_saver.hpp>
williamr@2: #endif
williamr@2: 
williamr@2: namespace boost{
williamr@2: 
williamr@2: namespace multi_index{
williamr@2: 
williamr@2: namespace detail{
williamr@2: 
williamr@2: /* The role of this class is threefold:
williamr@2:  *   - tops the linear hierarchy of indices.
williamr@2:  *   - terminates some cascading backbone function calls (insert_, etc.),
williamr@2:  *   - grants access to the backbone functions of the final
williamr@2:  *     multi_index_container class (for access restriction reasons, these
williamr@2:  *     cannot be called directly from the index classes.)
williamr@2:  */
williamr@2: 
williamr@2: template<typename Value,typename IndexSpecifierList,typename Allocator>
williamr@2: class index_base
williamr@2: {
williamr@2: protected:
williamr@2:   typedef index_node_base<Value>              node_type;
williamr@2:   typedef typename multi_index_node_type<
williamr@2:     Value,IndexSpecifierList,Allocator>::type final_node_type;
williamr@2:   typedef multi_index_container<
williamr@2:     Value,IndexSpecifierList,Allocator>       final_type;
williamr@2:   typedef tuples::null_type                   ctor_args_list;
williamr@2:   typedef typename 
williamr@2:     boost::detail::allocator::rebind_to<
williamr@2:       Allocator,
williamr@2:       typename Allocator::value_type>::type   final_allocator_type;
williamr@2:   typedef mpl::vector0<>                      index_type_list;
williamr@2:   typedef mpl::vector0<>                      iterator_type_list;
williamr@2:   typedef mpl::vector0<>                      const_iterator_type_list;
williamr@2:   typedef copy_map<
williamr@2:     final_node_type,
williamr@2:     final_allocator_type>                     copy_map_type;
williamr@2: 
williamr@2: #if !defined(BOOST_MULTI_INDEX_DISABLE_SERIALIZATION)
williamr@2:   typedef index_saver<
williamr@2:     node_type,
williamr@2:     final_allocator_type>                     index_saver_type;
williamr@2:   typedef index_loader<
williamr@2:     node_type,
williamr@2:     final_node_type,
williamr@2:     final_allocator_type>                     index_loader_type;
williamr@2: #endif
williamr@2: 
williamr@2: private:
williamr@2:   typedef typename call_traits<Value>::param_type value_param_type;
williamr@2: 
williamr@2: protected:
williamr@2:   explicit index_base(const ctor_args_list&,const Allocator&){}
williamr@2: 
williamr@2:   void copy_(
williamr@2:     const index_base<Value,IndexSpecifierList,Allocator>&,const copy_map_type&)
williamr@2:   {}
williamr@2: 
williamr@2:   node_type* insert_(value_param_type v,node_type* x)
williamr@2:   {
williamr@2:     boost::detail::allocator::construct(&x->value(),v);
williamr@2:     return x;
williamr@2:   }
williamr@2: 
williamr@2:   node_type* insert_(value_param_type v,node_type*,node_type* x)
williamr@2:   {
williamr@2:     boost::detail::allocator::construct(&x->value(),v);
williamr@2:     return x;
williamr@2:   }
williamr@2: 
williamr@2:   void erase_(node_type* x)
williamr@2:   {
williamr@2:     boost::detail::allocator::destroy(&x->value());
williamr@2:   }
williamr@2: 
williamr@2:   void delete_node_(node_type* x)
williamr@2:   {
williamr@2:     boost::detail::allocator::destroy(&x->value());
williamr@2:   }
williamr@2: 
williamr@2:   void clear_(){}
williamr@2: 
williamr@2:   void swap_(index_base<Value,IndexSpecifierList,Allocator>&){}
williamr@2: 
williamr@2:   bool replace_(value_param_type v,node_type* x)
williamr@2:   {
williamr@2:     x->value()=v;
williamr@2:     return true;
williamr@2:   }
williamr@2: 
williamr@2:   bool modify_(node_type*){return true;}
williamr@2: 
williamr@2: #if !defined(BOOST_MULTI_INDEX_DISABLE_SERIALIZATION)
williamr@2:   /* serialization */
williamr@2: 
williamr@2:   template<typename Archive>
williamr@2:   void save_(Archive&,const unsigned int,const index_saver_type&)const{}
williamr@2: 
williamr@2:   template<typename Archive>
williamr@2:   void load_(Archive&,const unsigned int,const index_loader_type&){}
williamr@2: #endif
williamr@2: 
williamr@2: #if defined(BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING)
williamr@2:   /* invariant stuff */
williamr@2: 
williamr@2:   bool invariant_()const{return true;}
williamr@2: #endif
williamr@2: 
williamr@2:   /* access to backbone memfuns of Final class */
williamr@2: 
williamr@2:   final_type&       final(){return *static_cast<final_type*>(this);}
williamr@2:   const final_type& final()const{return *static_cast<const final_type*>(this);}
williamr@2: 
williamr@2:   final_node_type* final_header()const{return final().header();}
williamr@2: 
williamr@2:   bool        final_empty_()const{return final().empty_();}
williamr@2:   std::size_t final_size_()const{return final().size_();}
williamr@2:   std::size_t final_max_size_()const{return final().max_size_();}
williamr@2: 
williamr@2:   std::pair<final_node_type*,bool> final_insert_(value_param_type x)
williamr@2:     {return final().insert_(x);}
williamr@2:   std::pair<final_node_type*,bool> final_insert_(
williamr@2:     value_param_type x,final_node_type* position)
williamr@2:     {return final().insert_(x,position);}
williamr@2: 
williamr@2:   void final_erase_(final_node_type* x){final().erase_(x);}
williamr@2: 
williamr@2:   void final_delete_node_(final_node_type* x){final().delete_node_(x);}
williamr@2:   void final_delete_all_nodes_(){final().delete_all_nodes_();}
williamr@2:   void final_clear_(){final().clear_();}
williamr@2: 
williamr@2:   void final_swap_(final_type& x){final().swap_(x);}
williamr@2:   bool final_replace_(
williamr@2:     value_param_type k,final_node_type* x)
williamr@2:     {return final().replace_(k,x);}
williamr@2: 
williamr@2:   template<typename Modifier>
williamr@2:   bool final_modify_(Modifier mod,final_node_type* x)
williamr@2:     {return final().modify_(mod,x);}
williamr@2: 
williamr@2: #if defined(BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING)
williamr@2:   void final_check_invariant_()const{final().check_invariant_();}
williamr@2: #endif
williamr@2: };
williamr@2: 
williamr@2: } /* namespace multi_index::detail */
williamr@2: 
williamr@2: } /* namespace multi_index */
williamr@2: 
williamr@2: } /* namespace boost */
williamr@2: 
williamr@2: #endif