board_item_index.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <unordered_map>
 
#include <kiid.h>
 
class BOARD;
class BOARD_ITEM;

class BOARD_ITEM_INDEX
{
public:
    explicit BOARD_ITEM_INDEX( BOARD& aOwner ) :
            m_owner( aOwner )
    {
    }

    BOARD_ITEM* Find( const KIID& aId );

    void BindItem( BOARD_ITEM& aItem );

    void Unbind( const KIID& aId );

    void UnbindItem( const BOARD_ITEM& aItem );

    void Clear();

    void Rebind( BOARD_ITEM& aItem, const KIID& aNewId );
 
    void BindSubtree( BOARD_ITEM& aItem );
    void BindChildren( const BOARD_ITEM& aParent );
    void UnbindSubtree( const BOARD_ITEM& aItem );
    void UnbindChildren( const BOARD_ITEM& aParent );

    bool IsIndexed( const KIID& aId ) const { return m_itemsById.contains( aId ); }

    bool IsIndexed( const BOARD_ITEM* aItem ) const { return m_idsByItem.contains( aItem ); }
 
private:
    BOARD& m_owner;

    std::unordered_map<KIID, BOARD_ITEM*> m_itemsById;

    std::unordered_map<const BOARD_ITEM*, KIID> m_idsByItem;
};