/* Multiply indexed container. * * Copyright 2003-2007 Joaquín M López Muñoz. * Distributed under the Boost Software License, Version 1.0. * (See accompanying file LICENSE_1_0.txt or copy at * http://www.boost.org/LICENSE_1_0.txt) * * See http://www.boost.org/libs/multi_index for library home page. */ #ifndef BOOST_MULTI_INDEX_HPP #define BOOST_MULTI_INDEX_HPP #if defined(_MSC_VER)&&(_MSC_VER>=1200) #pragma once #endif #include /* keep it first to prevent nasty warns in MSVC */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if !defined(BOOST_MULTI_INDEX_DISABLE_SERIALIZATION) #include #include #include #include #endif #if defined(BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING) #include #define BOOST_MULTI_INDEX_CHECK_INVARIANT \ detail::scope_guard BOOST_JOIN(check_invariant_,__LINE__)= \ detail::make_obj_guard(*this,&multi_index_container::check_invariant_); \ BOOST_JOIN(check_invariant_,__LINE__).touch(); #else #define BOOST_MULTI_INDEX_CHECK_INVARIANT #endif namespace boost{ namespace multi_index{ template class multi_index_container: private ::boost::base_from_member< typename boost::detail::allocator::rebind_to< Allocator, typename detail::multi_index_node_type< Value,IndexSpecifierList,Allocator>::type >::type>, BOOST_MULTI_INDEX_PRIVATE_IF_MEMBER_TEMPLATE_FRIENDS detail::header_holder< typename detail::multi_index_node_type< Value,IndexSpecifierList,Allocator>::type, multi_index_container >, public detail::multi_index_base_type< Value,IndexSpecifierList,Allocator>::type { #if defined(BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING)&&\ BOOST_WORKAROUND(__MWERKS__,<=0x3003) /* The "ISO C++ Template Parser" option in CW8.3 has a problem with the * lifetime of const references bound to temporaries --precisely what * scopeguards are. */ #pragma parse_mfunc_templ off #endif private: #if !defined(BOOST_NO_MEMBER_TEMPLATE_FRIENDS) template friend class detail::index_base; template friend class detail::header_holder; template friend class detail::converter; #endif typedef typename detail::multi_index_base_type< Value,IndexSpecifierList,Allocator>::type super; typedef ::boost::base_from_member< typename boost::detail::allocator::rebind_to< Allocator, typename super::node_type >::type> bfm_allocator; typedef detail::header_holder< typename super::node_type, multi_index_container> bfm_header; #if BOOST_WORKAROUND(BOOST_MSVC,<1300) /* see definition of index_type_list below */ typedef typename super::index_type_list super_index_type_list; #endif public: /* All types are inherited from super, a few are explicitly * brought forward here to save us some typename's. */ #if defined(BOOST_MSVC) typedef detail::default_constructible_tuple_cons< typename super::ctor_args_list> ctor_args_list; #else typedef typename super::ctor_args_list ctor_args_list; #endif typedef IndexSpecifierList index_specifier_type_list; #if BOOST_WORKAROUND(BOOST_MSVC,<1300) /* MSVC++ 6.0 chokes on moderately long index lists (around 6 indices * or more), with errors ranging from corrupt exes to duplicate * comdats. The following type hiding hack alleviates this condition; * best results combined with type hiding of the indexed_by construct * itself, as explained in the "Compiler specifics" section of * the documentation. */ struct index_type_list:super_index_type_list { typedef index_type_list type; typedef typename super_index_type_list::back back; typedef mpl::v_iter begin; typedef mpl::v_iter< type, mpl::size::value> end; }; #else typedef typename super::index_type_list index_type_list; #endif typedef typename super::iterator_type_list iterator_type_list; typedef typename super::const_iterator_type_list const_iterator_type_list; typedef typename super::value_type value_type; typedef typename super::final_allocator_type allocator_type; typedef typename super::iterator iterator; typedef typename super::const_iterator const_iterator; BOOST_STATIC_ASSERT( detail::no_duplicate_tags_in_index_list::value); /* global project() needs to see this publicly */ typedef typename super::node_type node_type; /* construct/copy/destroy */ explicit multi_index_container( #if BOOST_WORKAROUND(__IBMCPP__,<=600) /* VisualAge seems to have an ETI issue with the default values * for arguments args_list and al. */ const ctor_args_list& args_list= typename mpl::identity::type:: ctor_args_list(), const allocator_type& al= typename mpl::identity::type:: allocator_type()): #else const ctor_args_list& args_list=ctor_args_list(), const allocator_type& al=allocator_type()): #endif bfm_allocator(al), super(args_list,bfm_allocator::member), node_count(0) { BOOST_MULTI_INDEX_CHECK_INVARIANT; } template multi_index_container( InputIterator first,InputIterator last, #if BOOST_WORKAROUND(__IBMCPP__,<=600) /* VisualAge seems to have an ETI issue with the default values * for arguments args_list and al. */ const ctor_args_list& args_list= typename mpl::identity::type:: ctor_args_list(), const allocator_type& al= typename mpl::identity::type:: allocator_type()): #else const ctor_args_list& args_list=ctor_args_list(), const allocator_type& al=allocator_type()): #endif bfm_allocator(al), super(args_list,bfm_allocator::member), node_count(0) { BOOST_MULTI_INDEX_CHECK_INVARIANT; BOOST_TRY{ iterator hint=super::end(); for(;first!=last;++first){ hint=super::make_iterator(insert_(*first,hint.get_node()).first); } } BOOST_CATCH(...){ clear_(); BOOST_RETHROW; } BOOST_CATCH_END } multi_index_container( const multi_index_container& x): bfm_allocator(x.bfm_allocator::member), bfm_header(), super(x), node_count(0) { copy_map_type map(bfm_allocator::member,x.size(),x.header(),header()); for(const_iterator it=x.begin(),it_end=x.end();it!=it_end;++it){ map.clone(it.get_node()); } super::copy_(x,map); map.release(); node_count=x.size(); /* Not until this point are the indices required to be consistent, * hence the position of the invariant checker. */ BOOST_MULTI_INDEX_CHECK_INVARIANT; } ~multi_index_container() { delete_all_nodes_(); } multi_index_container& operator=( const multi_index_container& x) { BOOST_MULTI_INDEX_CHECK_INVARIANT; multi_index_container tmp(x); this->swap(tmp); return *this; } allocator_type get_allocator()const { return allocator_type(bfm_allocator::member); } /* retrieval of indices by number */ #if !defined(BOOST_NO_MEMBER_TEMPLATES) template struct nth_index { BOOST_STATIC_ASSERT(N>=0&&N::type::value); typedef typename mpl::at_c::type type; }; template typename nth_index::type& get(BOOST_EXPLICIT_TEMPLATE_NON_TYPE(int,N)) { BOOST_STATIC_ASSERT(N>=0&&N::type::value); return *this; } template const typename nth_index::type& get( BOOST_EXPLICIT_TEMPLATE_NON_TYPE(int,N))const { BOOST_STATIC_ASSERT(N>=0&&N::type::value); return *this; } #endif /* retrieval of indices by tag */ #if !defined(BOOST_NO_MEMBER_TEMPLATES) template struct index { typedef typename mpl::find_if< index_type_list, detail::has_tag >::type iter; BOOST_STATIC_CONSTANT( bool,index_found=!(is_same::type >::value)); BOOST_STATIC_ASSERT(index_found); typedef typename mpl::deref::type type; }; template typename index::type& get(BOOST_EXPLICIT_TEMPLATE_TYPE(Tag)) { return *this; } template const typename index::type& get( BOOST_EXPLICIT_TEMPLATE_TYPE(Tag))const { return *this; } #endif /* projection of iterators by number */ #if !defined(BOOST_NO_MEMBER_TEMPLATES) template struct nth_index_iterator { typedef typename nth_index::type::iterator type; }; template struct nth_index_const_iterator { typedef typename nth_index::type::const_iterator type; }; template typename nth_index_iterator::type project( IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_NON_TYPE(int,N)) { typedef typename nth_index::type index; BOOST_STATIC_ASSERT( (mpl::contains::value)); BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); BOOST_MULTI_INDEX_CHECK_IS_OWNER( it,static_cast(*this)); return index::make_iterator(static_cast(it.get_node())); } template typename nth_index_const_iterator::type project( IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_NON_TYPE(int,N))const { typedef typename nth_index::type index; BOOST_STATIC_ASSERT(( mpl::contains::value|| mpl::contains::value)); BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); BOOST_MULTI_INDEX_CHECK_IS_OWNER( it,static_cast(*this)); return index::make_iterator(static_cast(it.get_node())); } #endif /* projection of iterators by tag */ #if !defined(BOOST_NO_MEMBER_TEMPLATES) template struct index_iterator { typedef typename index::type::iterator type; }; template struct index_const_iterator { typedef typename index::type::const_iterator type; }; template typename index_iterator::type project( IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_TYPE(Tag)) { typedef typename index::type index; BOOST_STATIC_ASSERT( (mpl::contains::value)); BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); BOOST_MULTI_INDEX_CHECK_IS_OWNER( it,static_cast(*this)); return index::make_iterator(static_cast(it.get_node())); } template typename index_const_iterator::type project( IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_TYPE(Tag))const { typedef typename index::type index; BOOST_STATIC_ASSERT(( mpl::contains::value|| mpl::contains::value)); BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); BOOST_MULTI_INDEX_CHECK_IS_OWNER( it,static_cast(*this)); return index::make_iterator(static_cast(it.get_node())); } #endif BOOST_MULTI_INDEX_PROTECTED_IF_MEMBER_TEMPLATE_FRIENDS: typedef typename super::copy_map_type copy_map_type; node_type* header()const { return bfm_header::member; } node_type* allocate_node() { return bfm_allocator::member.allocate(1); } void deallocate_node(node_type* x) { bfm_allocator::member.deallocate(x,1); } bool empty_()const { return node_count==0; } std::size_t size_()const { return node_count; } std::size_t max_size_()const { return static_cast(-1); } std::pair insert_(const Value& v) { node_type* x=allocate_node(); BOOST_TRY{ node_type* res=super::insert_(v,x); if(res==x){ ++node_count; return std::pair(res,true); } else{ deallocate_node(x); return std::pair(res,false); } } BOOST_CATCH(...){ deallocate_node(x); BOOST_RETHROW; } BOOST_CATCH_END } std::pair insert_(const Value& v,node_type* position) { node_type* x=allocate_node(); BOOST_TRY{ node_type* res=super::insert_(v,position,x); if(res==x){ ++node_count; return std::pair(res,true); } else{ deallocate_node(x); return std::pair(res,false); } } BOOST_CATCH(...){ deallocate_node(x); BOOST_RETHROW; } BOOST_CATCH_END } void erase_(node_type* x) { super::erase_(x); deallocate_node(x); --node_count; } void delete_node_(node_type* x) { super::delete_node_(x); deallocate_node(x); } void delete_all_nodes_() { super::delete_all_nodes_(); } void clear_() { delete_all_nodes_(); super::clear_(); node_count=0; } void swap_(multi_index_container& x) { std::swap(bfm_header::member,x.bfm_header::member); super::swap_(x); std::swap(node_count,x.node_count); } bool replace_(const Value& k,node_type* x) { return super::replace_(k,x); } template bool modify_(Modifier mod,node_type* x) { mod(const_cast(x->value())); BOOST_TRY{ if(!super::modify_(x)){ deallocate_node(x); --node_count; return false; } else return true; } BOOST_CATCH(...){ deallocate_node(x); --node_count; BOOST_RETHROW; } BOOST_CATCH_END } #if !defined(BOOST_MULTI_INDEX_DISABLE_SERIALIZATION) /* serialization */ friend class boost::serialization::access; BOOST_SERIALIZATION_SPLIT_MEMBER() typedef typename super::index_saver_type index_saver_type; typedef typename super::index_loader_type index_loader_type; template void save(Archive& ar,const unsigned int version)const { const std::size_t s=size_(); ar< void load(Archive& ar,const unsigned int version) { BOOST_MULTI_INDEX_CHECK_INVARIANT; clear_(); std::size_t s; ar>>serialization::make_nvp("count",s); index_loader_type lm(bfm_allocator::member,s); for(std::size_t n=0;n value("item",ar,version); std::pair p=insert_( value.get(),super::end().get_node()); if(!p.second)throw_exception( archive::archive_exception( archive::archive_exception::other_exception)); ar.reset_object_address(&p.first->value(),&value.get()); lm.add(p.first,ar,version); } lm.add_track(header(),ar,version); super::load_(ar,version,lm); } #endif #if defined(BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING) /* invariant stuff */ bool invariant_()const { return super::invariant_(); } void check_invariant_()const { BOOST_MULTI_INDEX_INVARIANT_ASSERT(invariant_()); } #endif private: std::size_t node_count; #if defined(BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING)&&\ BOOST_WORKAROUND(__MWERKS__,<=0x3003) #pragma parse_mfunc_templ reset #endif }; /* retrieval of indices by number */ template struct nth_index { BOOST_STATIC_CONSTANT( int, M=mpl::size::type::value); BOOST_STATIC_ASSERT(N>=0&&N::type type; }; template typename nth_index< multi_index_container,N>::type& get( multi_index_container& m BOOST_APPEND_EXPLICIT_TEMPLATE_NON_TYPE(int,N)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename nth_index< multi_index_container< Value,IndexSpecifierList,Allocator>, N >::type index; BOOST_STATIC_ASSERT(N>=0&& N< mpl::size< BOOST_DEDUCED_TYPENAME multi_index_type::index_type_list >::type::value); return detail::converter::index(m); } template const typename nth_index< multi_index_container,N>::type& get( const multi_index_container& m BOOST_APPEND_EXPLICIT_TEMPLATE_NON_TYPE(int,N)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename nth_index< multi_index_container< Value,IndexSpecifierList,Allocator>, N >::type index; BOOST_STATIC_ASSERT(N>=0&& N< mpl::size< BOOST_DEDUCED_TYPENAME multi_index_type::index_type_list >::type::value); return detail::converter::index(m); } /* retrieval of indices by tag */ template struct index { typedef typename MultiIndexContainer::index_type_list index_type_list; typedef typename mpl::find_if< index_type_list, detail::has_tag >::type iter; BOOST_STATIC_CONSTANT( bool,index_found=!(is_same::type >::value)); BOOST_STATIC_ASSERT(index_found); typedef typename mpl::deref::type type; }; template< typename Tag,typename Value,typename IndexSpecifierList,typename Allocator > typename ::boost::multi_index::index< multi_index_container,Tag>::type& get( multi_index_container& m BOOST_APPEND_EXPLICIT_TEMPLATE_TYPE(Tag)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename ::boost::multi_index::index< multi_index_container< Value,IndexSpecifierList,Allocator>, Tag >::type index; return detail::converter::index(m); } template< typename Tag,typename Value,typename IndexSpecifierList,typename Allocator > const typename ::boost::multi_index::index< multi_index_container,Tag>::type& get( const multi_index_container& m BOOST_APPEND_EXPLICIT_TEMPLATE_TYPE(Tag)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename ::boost::multi_index::index< multi_index_container< Value,IndexSpecifierList,Allocator>, Tag >::type index; return detail::converter::index(m); } /* projection of iterators by number */ template struct nth_index_iterator { typedef typename detail::prevent_eti< nth_index, typename nth_index::type>::type::iterator type; }; template struct nth_index_const_iterator { typedef typename detail::prevent_eti< nth_index, typename nth_index::type >::type::const_iterator type; }; template< int N,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator> typename nth_index_iterator< multi_index_container,N>::type project( multi_index_container& m, IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_NON_TYPE(int,N)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename nth_index::type index; #if !defined(BOOST_MSVC)||!(BOOST_MSVC<1310) /* ain't work in MSVC++ 6.0/7.0 */ BOOST_STATIC_ASSERT(( mpl::contains< BOOST_DEDUCED_TYPENAME multi_index_type::iterator_type_list, IteratorType>::value)); #endif BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); #if defined(BOOST_MULTI_INDEX_ENABLE_SAFE_MODE) typedef detail::converter< multi_index_type, BOOST_DEDUCED_TYPENAME IteratorType::container_type> converter; BOOST_MULTI_INDEX_CHECK_IS_OWNER(it,converter::index(m)); #endif return detail::converter::iterator( m,static_cast(it.get_node())); } template< int N,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator> typename nth_index_const_iterator< multi_index_container,N>::type project( const multi_index_container& m, IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_NON_TYPE(int,N)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename nth_index::type index; #if !defined(BOOST_MSVC)||!(BOOST_MSVC<1310) /* ain't work in MSVC++ 6.0/7.0 */ BOOST_STATIC_ASSERT(( mpl::contains< BOOST_DEDUCED_TYPENAME multi_index_type::iterator_type_list, IteratorType>::value|| mpl::contains< BOOST_DEDUCED_TYPENAME multi_index_type::const_iterator_type_list, IteratorType>::value)); #endif BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); #if defined(BOOST_MULTI_INDEX_ENABLE_SAFE_MODE) typedef detail::converter< multi_index_type, BOOST_DEDUCED_TYPENAME IteratorType::container_type> converter; BOOST_MULTI_INDEX_CHECK_IS_OWNER(it,converter::index(m)); #endif return detail::converter::const_iterator( m,static_cast(it.get_node())); } /* projection of iterators by tag */ template struct index_iterator { typedef typename ::boost::multi_index::index< MultiIndexContainer,Tag>::type::iterator type; }; template struct index_const_iterator { typedef typename ::boost::multi_index::index< MultiIndexContainer,Tag>::type::const_iterator type; }; template< typename Tag,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator> typename index_iterator< multi_index_container,Tag>::type project( multi_index_container& m, IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_TYPE(Tag)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename ::boost::multi_index::index< multi_index_type,Tag>::type index; #if !defined(BOOST_MSVC)||!(BOOST_MSVC<1310) /* ain't work in MSVC++ 6.0/7.0 */ BOOST_STATIC_ASSERT(( mpl::contains< BOOST_DEDUCED_TYPENAME multi_index_type::iterator_type_list, IteratorType>::value)); #endif BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); #if defined(BOOST_MULTI_INDEX_ENABLE_SAFE_MODE) typedef detail::converter< multi_index_type, BOOST_DEDUCED_TYPENAME IteratorType::container_type> converter; BOOST_MULTI_INDEX_CHECK_IS_OWNER(it,converter::index(m)); #endif return detail::converter::iterator( m,static_cast(it.get_node())); } template< typename Tag,typename IteratorType, typename Value,typename IndexSpecifierList,typename Allocator> typename index_const_iterator< multi_index_container,Tag>::type project( const multi_index_container& m, IteratorType it BOOST_APPEND_EXPLICIT_TEMPLATE_TYPE(Tag)) { typedef multi_index_container< Value,IndexSpecifierList,Allocator> multi_index_type; typedef typename ::boost::multi_index::index< multi_index_type,Tag>::type index; #if !defined(BOOST_MSVC)||!(BOOST_MSVC<1310) /* ain't work in MSVC++ 6.0/7.0 */ BOOST_STATIC_ASSERT(( mpl::contains< BOOST_DEDUCED_TYPENAME multi_index_type::iterator_type_list, IteratorType>::value|| mpl::contains< BOOST_DEDUCED_TYPENAME multi_index_type::const_iterator_type_list, IteratorType>::value)); #endif BOOST_MULTI_INDEX_CHECK_VALID_ITERATOR(it); #if defined(BOOST_MULTI_INDEX_ENABLE_SAFE_MODE) typedef detail::converter< multi_index_type, BOOST_DEDUCED_TYPENAME IteratorType::container_type> converter; BOOST_MULTI_INDEX_CHECK_IS_OWNER(it,converter::index(m)); #endif return detail::converter::const_iterator( m,static_cast(it.get_node())); } /* Comparison. Simple forward to first index. */ template< typename Value1,typename IndexSpecifierList1,typename Allocator1, typename Value2,typename IndexSpecifierList2,typename Allocator2 > bool operator==( const multi_index_container& x, const multi_index_container& y) { return get<0>(x)==get<0>(y); } template< typename Value1,typename IndexSpecifierList1,typename Allocator1, typename Value2,typename IndexSpecifierList2,typename Allocator2 > bool operator<( const multi_index_container& x, const multi_index_container& y) { return get<0>(x)(y); } template< typename Value1,typename IndexSpecifierList1,typename Allocator1, typename Value2,typename IndexSpecifierList2,typename Allocator2 > bool operator!=( const multi_index_container& x, const multi_index_container& y) { return get<0>(x)!=get<0>(y); } template< typename Value1,typename IndexSpecifierList1,typename Allocator1, typename Value2,typename IndexSpecifierList2,typename Allocator2 > bool operator>( const multi_index_container& x, const multi_index_container& y) { return get<0>(x)>get<0>(y); } template< typename Value1,typename IndexSpecifierList1,typename Allocator1, typename Value2,typename IndexSpecifierList2,typename Allocator2 > bool operator>=( const multi_index_container& x, const multi_index_container& y) { return get<0>(x)>=get<0>(y); } template< typename Value1,typename IndexSpecifierList1,typename Allocator1, typename Value2,typename IndexSpecifierList2,typename Allocator2 > bool operator<=( const multi_index_container& x, const multi_index_container& y) { return get<0>(x)<=get<0>(y); } /* specialized algorithms */ template void swap( multi_index_container& x, multi_index_container& y) { x.swap(y); } } /* namespace multi_index */ /* Associated global functions are promoted to namespace boost, except * comparison operators and swap, which are meant to be Koenig looked-up. */ using multi_index::get; using multi_index::project; } /* namespace boost */ #undef BOOST_MULTI_INDEX_CHECK_INVARIANT #endif