multivector.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright 2017 CERN
 * Copyright (C) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 * @author Bernhard Stegmaier <[email protected]>
 *
 * 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, you may find one here:
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * or you may search the http://www.gnu.org website for the version 2 license,
 * or you may write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */
 
#ifndef MULTIVECTOR_H
#define MULTIVECTOR_H
 
#include <wx/debug.h>
#include <boost/ptr_container/ptr_vector.hpp>
#include <stdexcept>
 
template<typename T, int FIRST_TYPE_VAL, int LAST_TYPE_VAL>
class MULTIVECTOR
{
public:
 static constexpr int UNDEFINED_TYPE = 0;
 static_assert( FIRST_TYPE_VAL > UNDEFINED_TYPE,
 "FIRST_TYPE_VAL must be greater than UNDEFINED_TYPE" );
 static_assert( FIRST_TYPE_VAL < LAST_TYPE_VAL,
 "FIRST_TYPE_VAL must be greater than LAST_TYPE_VAL" );
 
 typedef boost::ptr_vector<T> ITEM_PTR_VECTOR;
 
 template<typename ITEM_TYPE, typename ITEM_CONTAINER, typename ITEM_CONTAINER_IT>
 class ITERATOR_BASE
 {
 public:
 ITEM_TYPE& operator*()
 {
 return *m_it;
 }
 
 ITEM_TYPE* operator->()
 {
 return &( *m_it );
 }
 
 ITERATOR_BASE& operator++()
 {
 if( m_it != (*m_parent)[ m_curType ].end() )
 ++m_it;
 
 validate();
 
 return *this;
 }
 
 bool operator!=( const ITERATOR_BASE& aOther ) const
 {
 if( aOther.m_parent != m_parent )
 return true;
 
 if( aOther.m_filter != m_filter )
 return true;
 
 if( aOther.m_curType != m_curType )
 return true;
 
 return aOther.m_it != m_it;
 }
 
 protected:
 ITERATOR_BASE( ITEM_CONTAINER* aItems, ITEM_CONTAINER_IT aIt,
 int aBucket, int aType = UNDEFINED_TYPE )
 : m_parent( aItems ), m_it( aIt ), m_curType( aBucket )
 {
 m_filter = ( aType != UNDEFINED_TYPE );
 }
 
 void validate()
 {
 // for all-items iterators (unfiltered): check if this is the end of the
 // current type container, if so switch to the next non-empty container
 if( !m_filter && m_it == (*m_parent)[ m_curType ].end() )
 {
 // switch to the next type (look for a not empty container)
 int nextType = m_curType;
 
 do
 ++nextType;
 while( ( nextType <= LAST_TYPE ) && (*m_parent)[ nextType ].empty() );
 
 // there is another not empty container, so make the iterator point to it,
 // otherwise it means the iterator points to the last item
 if( nextType <= LAST_TYPE )
 {
 m_curType = nextType;
 m_it = (*m_parent)[ m_curType ].begin();
 }
 }
 }
 
 ITEM_CONTAINER* m_parent;
 
 ITEM_CONTAINER_IT m_it;
 
 bool m_filter;
 
 int m_curType;
 
 friend class MULTIVECTOR;
 };
 
 typedef ITERATOR_BASE<T, MULTIVECTOR<T, FIRST_TYPE_VAL, LAST_TYPE_VAL>,
 typename ITEM_PTR_VECTOR::iterator> ITERATOR;
 typedef ITERATOR_BASE<const T, const MULTIVECTOR<T, FIRST_TYPE_VAL, LAST_TYPE_VAL>,
 typename ITEM_PTR_VECTOR::const_iterator> CONST_ITERATOR;
 
 
 MULTIVECTOR()
 {
 }
 
 void push_back( T* aItem )
 {
 operator[]( aItem->Type() ).push_back( aItem );
 }
 
 ITERATOR erase( const ITERATOR& aIterator )
 {
 ITERATOR it( aIterator );
 it.m_it = (*aIterator.m_parent)[ aIterator.m_curType ].erase( aIterator.m_it );
 it.validate();
 
 return it;
 }
 
 ITERATOR begin( int aType = UNDEFINED_TYPE )
 {
 int bucket = ( aType != UNDEFINED_TYPE ) ? aType : first();
 return ITERATOR( this, operator[]( bucket ).begin(), bucket, aType );
 }
 
 ITERATOR end( int aType = UNDEFINED_TYPE )
 {
 int bucket = ( aType != UNDEFINED_TYPE ) ? aType : last();
 return ITERATOR( this, operator[]( bucket ).end(), bucket, aType );
 }
 
 CONST_ITERATOR begin( int aType = UNDEFINED_TYPE ) const
 {
 int bucket = ( aType != UNDEFINED_TYPE ) ? aType : first();
 return CONST_ITERATOR( this, operator[]( bucket ).begin(), bucket, aType );
 }
 
 CONST_ITERATOR end( int aType = UNDEFINED_TYPE ) const
 {
 int bucket = ( aType != UNDEFINED_TYPE ) ? aType : last();
 return CONST_ITERATOR( this, operator[]( bucket ).end(), bucket, aType );
 }
 
 void clear( int aType = UNDEFINED_TYPE )
 {
 if( aType != UNDEFINED_TYPE )
 {
 operator[]( aType ).clear();
 }
 else
 {
 for( int i = 0; i < TYPES_COUNT; ++i)
 m_data[ i ].clear();
 }
 }
 
 size_t size( int aType = UNDEFINED_TYPE ) const
 {
 if( aType != UNDEFINED_TYPE )
 {
 return operator[]( aType ).size();
 }
 else
 {
 size_t cnt = 0;
 
 for( int i = 0; i < TYPES_COUNT; ++i)
 cnt += m_data[ i ].size();
 
 return cnt;
 }
 }
 
 bool empty( int aType = UNDEFINED_TYPE ) const
 {
 return ( size( aType ) == 0 );
 }
 
 void sort()
 {
 for( int i = 0; i < TYPES_COUNT; ++i )
 m_data[ i ].sort();
 }
 
 void unique()
 {
 for( int i = 0; i < TYPES_COUNT; ++i )
 {
 if( m_data[ i ].size() > 1 )
 m_data[ i ].unique();
 }
 }
 
 ITEM_PTR_VECTOR& operator[]( int aType )
 {
 if( ( aType < FIRST_TYPE ) || ( aType > LAST_TYPE ) )
 {
 wxFAIL_MSG( wxT( "Attempted access to type not within MULTIVECTOR" ) );
 
 // return type is a reference so we have to return something...
 aType = FIRST_TYPE;
 }
 
 return m_data[ aType - FIRST_TYPE ];
 }
 
 const ITEM_PTR_VECTOR& operator[]( int aType ) const
 {
 if( ( aType < FIRST_TYPE ) || ( aType > LAST_TYPE ) )
 {
 wxFAIL_MSG( wxT( "Attempted access to type not within MULTIVECTOR" ) );
 
 // return type is a reference so we have to return something...
 aType = FIRST_TYPE;
 }
 
 return m_data[ aType - FIRST_TYPE ];
 }
 
 // Range of valid types handled by the iterator
 static constexpr int FIRST_TYPE = FIRST_TYPE_VAL;
 static constexpr int LAST_TYPE = LAST_TYPE_VAL;
 static constexpr int TYPES_COUNT = LAST_TYPE - FIRST_TYPE + 1;
 
private:
 int first() const
 {
 int i = 0;
 
 while( ( i < TYPES_COUNT ) && ( m_data[ i ].empty() ) )
 ++i;
 
 return ( i == TYPES_COUNT ) ? FIRST_TYPE : FIRST_TYPE + i;
 }
 
 int last() const
 {
 int i = TYPES_COUNT - 1;
 
 while( ( i >= 0 ) && ( m_data[ i ].empty() ) )
 --i;
 
 return ( i < 0 ) ? FIRST_TYPE : FIRST_TYPE + i;
 }
 
 ITEM_PTR_VECTOR m_data[TYPES_COUNT];
};
 
#endif /* MULTIVECTOR_H */