kicad-source/pcbnew/dialogs/dialog_find.cpp

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2012 Marco Mattila <marcom99@gmail.com>
 * Copyright (C) 2018 Jean-Pierre Charras jp.charras at wanadoo.fr
 * 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 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
 */

#include <pcb_edit_frame.h> // Keep this include at top to avoid compil issue on MSYS2
#include <board.h>
#include <pcb_marker.h>
#include <footprint.h>
#include <pcb_text.h>
#include <zone.h>
#include <dialog_find.h>
#include <string_utils.h>
#include <hotkeys_basic.h>
#include <string>
#include <tool/tool_manager.h>
#include <tools/pcb_actions.h>
#include <wx/fdrepdlg.h>


//Defined as global because these values have to survive the destructor

bool g_FindOptionCase = false;
bool g_FindOptionWords = false;
bool g_FindOptionWildcards = false;
bool g_FindOptionWrap = true;

bool g_FindIncludeTexts = true;
bool g_FindIncludeValues = true;
bool g_FindIncludeReferences = true;
bool g_FindIncludeMarkers = true;
bool g_FindIncludeNets = true;


DIALOG_FIND::DIALOG_FIND( PCB_EDIT_FRAME *aFrame ) :
        DIALOG_FIND_BASE( aFrame, wxID_ANY, _( "Find" ) ),
        m_frame( aFrame )
{
    GetSizer()->SetSizeHints( this );

    m_searchCombo->Append( m_frame->GetFindHistoryList() );

    while( m_searchCombo->GetCount() > 10 )
    {
        m_frame->GetFindHistoryList().pop_back();
        m_searchCombo->Delete( 9 );
    }

    if( m_searchCombo->GetCount() )
    {
        m_searchCombo->SetSelection( 0 );
        m_searchCombo->SelectAll();
    }

    m_matchCase->SetValue( g_FindOptionCase );
    m_matchWords->SetValue( g_FindOptionWords );
    m_wildcards->SetValue( g_FindOptionWildcards );
    m_wrap->SetValue( g_FindOptionWrap );

    m_includeTexts->SetValue( g_FindIncludeTexts );
    m_includeValues->SetValue( g_FindIncludeValues );
    m_includeReferences->SetValue( g_FindIncludeReferences );
    m_includeMarkers->SetValue( g_FindIncludeMarkers );
    m_includeNets->SetValue( g_FindIncludeNets );

    m_status->SetLabel( wxEmptyString);
    m_upToDate = false;

    m_hitList.clear();
    m_it = m_hitList.begin();

    if( int hotkey = ACTIONS::showSearch.GetHotKey() )
    {
        wxString hotkeyHint = wxString::Format( wxT( " (%s)" ), KeyNameFromKeyCode( hotkey ) );
        m_searchPanelLink->SetLabel( m_searchPanelLink->GetLabel() + hotkeyHint );
    }

    m_findNext->SetDefault();
    SetInitialFocus( m_searchCombo );

    Center();
}


void DIALOG_FIND::Preload( const wxString& aFindString )
{
    if( !aFindString.IsEmpty() )
    {
        m_searchCombo->SetValue( aFindString );
        m_searchCombo->SelectAll();
    }
}


void DIALOG_FIND::onTextEnter( wxCommandEvent& aEvent )
{
    search( true );
}


void DIALOG_FIND::onFindNextClick( wxCommandEvent& aEvent )
{
    search( true );
}


void DIALOG_FIND::onFindPreviousClick( wxCommandEvent& aEvent )
{
    search( false );
}


void DIALOG_FIND::onSearchAgainClick( wxCommandEvent& aEvent )
{
    m_upToDate = false;
    search( true );
}


void DIALOG_FIND::onShowSearchPanel( wxHyperlinkEvent& event )
{
    if( m_frame->IsSearchPaneShown() )
    {
        EndModal( wxID_CANCEL );

        CallAfter(
                []()
                {
                    if( wxWindow* frame = wxWindow::FindWindowByName( PCB_EDIT_FRAME_NAME ) )
                        static_cast<PCB_EDIT_FRAME*>( frame )->FocusSearch();
                } );
    }
    else
    {
        m_frame->GetToolManager()->RunAction( ACTIONS::showSearch );
    }
}


void DIALOG_FIND::search( bool aDirection )
{
    PCB_SCREEN* screen = m_frame->GetScreen();
    int         index;
    wxString    msg;
    wxString    searchString;
    bool        endIsReached = false;
    bool        isFirstSearch = false;

    searchString = m_searchCombo->GetValue();

    if( searchString.IsEmpty() )
    {
        Show();
        return;
    }

    // Add/move the search string to the top of the list if it isn't already there
    index = m_searchCombo->FindString( searchString, true );

    if( index == wxNOT_FOUND )
    {
        m_searchCombo->Insert( searchString, 0 );
        m_searchCombo->SetSelection( 0 );
        m_upToDate = false;
        m_frame->GetFindHistoryList().Insert( searchString, 0 );

        if( m_searchCombo->GetCount() > 10 )
        {
            m_frame->GetFindHistoryList().pop_back();
            m_searchCombo->Delete( 10 );
        }
    }
    else if( index != 0 )
    {
        m_searchCombo->Delete( index );
        m_searchCombo->Insert( searchString, 0 );
        m_searchCombo->SetSelection( 0 );
        m_upToDate = false;

        if( m_frame->GetFindHistoryList().Index( searchString ) )
            m_frame->GetFindHistoryList().Remove( searchString );

        m_frame->GetFindHistoryList().Insert( searchString, 0 );
    }

    if( g_FindOptionCase != m_matchCase->GetValue() )
    {
        g_FindOptionCase = m_matchCase->GetValue();
        m_upToDate = false;
    }

    if( g_FindOptionWords != m_matchWords->GetValue() )
    {
        g_FindOptionWords = m_matchWords->GetValue();
        m_upToDate = false;
    }

    if( g_FindOptionWildcards != m_wildcards->GetValue() )
    {
        g_FindOptionWildcards = m_wildcards->GetValue();
        m_upToDate = false;
    }

    g_FindOptionWrap = m_wrap->GetValue();

    if( g_FindIncludeTexts != m_includeTexts->GetValue() )
    {
        g_FindIncludeTexts = m_includeTexts->GetValue();
        m_upToDate = false;
    }

    if( g_FindIncludeValues != m_includeValues->GetValue() )
    {
        g_FindIncludeValues = m_includeValues->GetValue();
        m_upToDate = false;
    }

    if( g_FindIncludeReferences != m_includeReferences->GetValue() )
    {
        g_FindIncludeReferences = m_includeReferences->GetValue();
        m_upToDate = false;
    }

    if( g_FindIncludeMarkers != m_includeMarkers->GetValue() )
    {
        g_FindIncludeMarkers = m_includeMarkers->GetValue();
        m_upToDate = false;
    }

    if( g_FindIncludeNets != m_includeNets->GetValue() )
    {
        g_FindIncludeNets = m_includeNets->GetValue();
        m_upToDate = false;
    }

    EDA_SEARCH_DATA& frd = m_frame->GetFindReplaceData();

    if( g_FindOptionCase )
        frd.matchCase = true;

    if( g_FindOptionWords )
        frd.matchMode = EDA_SEARCH_MATCH_MODE::WHOLEWORD;
    else if( g_FindOptionWildcards )
        frd.matchMode = EDA_SEARCH_MATCH_MODE::WILDCARD;
    else
        frd.matchMode = EDA_SEARCH_MATCH_MODE::PLAIN;

    // Search parameters
    frd.findString = searchString;

    m_frame->GetToolManager()->RunAction( ACTIONS::selectionClear );
    m_frame->GetCanvas()->GetViewStart( &screen->m_StartVisu.x, &screen->m_StartVisu.y );

    BOARD* board = m_frame->GetBoard();

    // Refresh the list of results
    if( !m_upToDate )
    {
        m_status->SetLabel( _( "Searching..." ) );
        m_hitList.clear();

        if( g_FindIncludeTexts || g_FindIncludeValues || g_FindIncludeReferences )
        {
            for( FOOTPRINT* fp : board->Footprints() )
            {
                bool found = false;

                if( g_FindIncludeReferences && fp->Reference().Matches( frd, nullptr ) )
                    found = true;

                if( !found && g_FindIncludeValues && fp->Value().Matches( frd, nullptr ) )
                    found = true;

                if( !found && m_includeTexts->GetValue() )
                {
                    for( BOARD_ITEM* item : fp->GraphicalItems() )
                    {
                        if( item->Type() == PCB_TEXT_T )
                        {
                            PCB_TEXT* text = static_cast<PCB_TEXT*>( item );

                            if( text->Matches( frd, nullptr ) )
                            {
                                found = true;
                                break;
                            }
                        }
                    }
                }

                if( !found && m_includeTexts->GetValue() )
                {
                    for( PCB_FIELD* field : fp->GetFields() )
                    {
                        if( field->Matches( frd, nullptr ) )
                        {
                            found = true;
                            break;
                        }
                    }
                }

                if( found )
                    m_hitList.push_back( fp );
            }

            if( g_FindIncludeTexts )
            {
                for( BOARD_ITEM* item : board->Drawings() )
                {
                    if( item->Type() == PCB_TEXT_T )
                    {
                        PCB_TEXT* text = static_cast<PCB_TEXT*>( item );

                        if( text && text->Matches( frd, nullptr ) )
                            m_hitList.push_back( text );
                    }
                }

                for( BOARD_ITEM* item : board->Zones() )
                {
                    ZONE* zone = static_cast<ZONE*>( item );

                    if( zone->Matches( frd, nullptr ) )
                        m_hitList.push_back( zone );
                }
            }
        }

        if( g_FindIncludeMarkers )
        {
            for( PCB_MARKER* marker : board->Markers() )
            {
                if( marker->Matches( frd, nullptr ) )
                    m_hitList.push_back( marker );
            }
        }

        if( g_FindIncludeNets )
        {
            for( NETINFO_ITEM* net : board->GetNetInfo() )
            {
                if( net && net->Matches( frd, nullptr ) )
                    m_hitList.push_back( net );
            }
        }

        m_upToDate = true;
        isFirstSearch = true;

        if( aDirection )
            m_it = m_hitList.begin();
        else
            m_it = m_hitList.end();
    }

    // Do we want a sorting algorithm ? If so, implement it here.

    // Get the item to display
    if( m_hitList.empty() )
    {
        m_frame->SetStatusText( wxEmptyString );
    }
    else
    {
        if( aDirection )
        {
            if( m_it != m_hitList.end() && !isFirstSearch )
                m_it++;

            if( m_it == m_hitList.end() )
            {
                if( m_wrap->GetValue() )
                {
                    m_it = m_hitList.begin();
                }
                else
                {
                    endIsReached = true;
                    m_it--; // point to the last REAL result
                }
            }
        }
        else
        {
            if( m_it == m_hitList.begin() )
            {
                if( m_wrap->GetValue() )
                    m_it = m_hitList.end();
                else
                    endIsReached = true;
            }

            if( m_it != m_hitList.begin() )
                m_it--;
        }
    }

    // Display the item
    if( m_hitList.empty() )
    {
        m_frame->SetStatusText( wxEmptyString );
        msg.Printf( _( "'%s' not found" ), searchString );
        m_frame->ShowInfoBarMsg( msg );

        m_status->SetLabel( msg );
    }
    else if( endIsReached )
    {
        m_frame->SetStatusText( wxEmptyString );
        m_frame->ShowInfoBarMsg( _( "No more items to show" ) );

        m_status->SetLabel( _( "No hits" ) );
    }
    else
    {
        m_frame->GetToolManager()->RunAction<EDA_ITEM*>( ACTIONS::selectItem, *m_it );

        msg.Printf( _( "'%s' found" ), searchString );
        m_frame->SetStatusText( msg );

        msg.Printf( _( "Hit(s): %d / %zu" ),
                    (int)std::distance( m_hitList.begin(), m_it ) + 1,
                    m_hitList.size() );
        m_status->SetLabel( msg );
    }

    if( m_highlightCallback )
        m_highlightCallback( GetItem() );
}


void DIALOG_FIND::OnCloseButtonClick( wxCommandEvent& aEvent )
{
    wxCloseEvent tmp;

    OnClose( tmp );

    aEvent.Skip();
}

bool DIALOG_FIND::Show( bool show )
{
    bool ret = DIALOG_FIND_BASE::Show( show );

    if( show )
        m_searchCombo->SetFocus();

    return ret;
}


void DIALOG_FIND::OnClose( wxCloseEvent& aEvent )
{
    g_FindOptionCase = m_matchCase->GetValue();
    g_FindOptionWords = m_matchWords->GetValue();
    g_FindOptionWildcards = m_wildcards->GetValue();
    g_FindOptionWrap = m_wrap->GetValue();

    g_FindIncludeTexts = m_includeTexts->GetValue();
    g_FindIncludeValues = m_includeValues->GetValue();
    g_FindIncludeMarkers = m_includeMarkers->GetValue();
    g_FindIncludeReferences = m_includeReferences->GetValue();
    g_FindIncludeNets = m_includeNets->GetValue();

    aEvent.Skip();
}