sch_search_pane.cpp

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, see AUTHORS.txt for contributors.
 *
 * 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 3 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/>.
 */
 
#include <sch_edit_frame.h>
#include "sch_search_pane.h"
#include "search_handlers.h"
 
 
SCH_SEARCH_PANE::SCH_SEARCH_PANE( SCH_EDIT_FRAME* aFrame ) :
        SEARCH_PANE( aFrame ),
        m_schFrame( aFrame )
{
    m_sch = &m_schFrame->Schematic();
 
    if( m_sch != nullptr )
        m_sch->AddListener( this );
 
    m_schFrame->Bind( EDA_EVT_UNITS_CHANGED, &SCH_SEARCH_PANE::onUnitsChanged, this );
    m_schFrame->Bind( EDA_EVT_SCHEMATIC_CHANGING, &SCH_SEARCH_PANE::onSchChanging, this );
    m_schFrame->Bind( EDA_EVT_SCHEMATIC_CHANGED, &SCH_SEARCH_PANE::onSchChanged, this );
 
    wxFont infoFont = KIUI::GetDockedPaneFont( this );
    SetFont( infoFont );
    m_notebook->SetFont( infoFont );
 
    m_searchHandlers = { std::make_shared<SYMBOL_SEARCH_HANDLER>( aFrame ),
                         std::make_shared<POWER_SEARCH_HANDLER>( aFrame ),
                         std::make_shared<TEXT_SEARCH_HANDLER>( aFrame ),
                         std::make_shared<LABEL_SEARCH_HANDLER>( aFrame ),
                         std::make_shared<GROUP_SEARCH_HANDLER>( aFrame ) };
 
    for( const auto& handler : m_searchHandlers )
        AddSearcher( handler );
}
 
 
SCH_SEARCH_PANE::~SCH_SEARCH_PANE()
{
    m_schFrame->Unbind( EDA_EVT_UNITS_CHANGED, &SCH_SEARCH_PANE::onUnitsChanged, this );
    m_schFrame->Unbind( EDA_EVT_SCHEMATIC_CHANGING, &SCH_SEARCH_PANE::onSchChanging, this );
    m_schFrame->Unbind( EDA_EVT_SCHEMATIC_CHANGED, &SCH_SEARCH_PANE::onSchChanged, this );
}
 
 
void SCH_SEARCH_PANE::onUnitsChanged( wxCommandEvent& event )
{
    ClearAllResults();
    RefreshSearch();
    event.Skip();
}
 
 
void SCH_SEARCH_PANE::onSchChanging( wxCommandEvent& event )
{
    if( m_sch )
        m_sch->RemoveListener( this );
 
    m_sch = nullptr;
    invalidateSearchResults();
    ClearAllResults();
    event.Skip();
}
 
 
void SCH_SEARCH_PANE::onSchChanged( wxCommandEvent& event )
{
    m_sch = &m_schFrame->Schematic();
 
    if( m_sch != nullptr )
        m_sch->AddListener( this );
 
    ClearAllResults();
    RefreshSearch();
    event.Skip();
}
 
 
void SCH_SEARCH_PANE::OnSchItemsAdded( SCHEMATIC& aBoard, std::vector<SCH_ITEM*>& aBoardItems )
{
    queueSearchRefresh();
}
 
 
void SCH_SEARCH_PANE::OnSchItemsRemoved( SCHEMATIC& aBoard, std::vector<SCH_ITEM*>& aBoardItems )
{
    queueSearchRefresh();
}
 
 
void SCH_SEARCH_PANE::OnSchItemsChanged( SCHEMATIC& aBoard, std::vector<SCH_ITEM*>& aBoardItems )
{
    queueSearchRefresh();
}
 
 
void SCH_SEARCH_PANE::invalidateSearchResults()
{
    for( const auto& handler : m_searchHandlers )
        handler->InvalidateResults();
}
 
 
void SCH_SEARCH_PANE::queueSearchRefresh()
{
    invalidateSearchResults();
 
    if( m_refreshPending || !m_sch || !IsShownOnScreen() )
        return;
 
    m_refreshPending = true;
 
    // Item notifications precede cleanup and connectivity publication; search their final state once.
    CallAfter( [this]()
    {
        m_refreshPending = false;
 
        if( !m_sch || m_schFrame->IsClosing() || !IsShownOnScreen() )
            return;
 
        RefreshSearch();
    } );
}