dialog_sch_find.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010 Wayne Stambaugh <[email protected]>
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#include <dialog_sch_find.h>
#include <tool/actions.h>
#include <sch_edit_frame.h>
#include <tools/sch_find_replace_tool.h>
#include <tool/tool_dispatcher.h>
#include <tool/tool_manager.h>
 
 
DIALOG_SCH_FIND::DIALOG_SCH_FIND( SCH_BASE_FRAME* aParent, SCH_SEARCH_DATA* aData,
                                  const wxPoint& aPosition, const wxSize& aSize, int aStyle ) :
        DIALOG_SCH_FIND_BASE( aParent, wxID_ANY, _( "Find" ), aPosition, aSize,
                              wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | aStyle ),
        m_frame( aParent ),
        m_findReplaceTool( m_frame->GetToolManager()->GetTool<SCH_FIND_REPLACE_TOOL>() ),
        m_findReplaceData( aData ),
        m_findDirty( true )
{
    wxASSERT_MSG( m_findReplaceData, wxT( "can't create find dialog without data" ) );
 
    OptOut( m_comboFind );
    OptOut( m_comboReplace );
 
    if( aStyle & wxFR_REPLACEDIALOG )
    {
        SetTitle( _( "Find and Replace" ) );
        m_buttonReplace->Show( true );
        m_buttonReplaceAll->Show( true );
        m_staticReplace->Show( true );
        m_comboReplace->Show( true );
        m_cbSelectedOnly->Show( true );
        m_cbReplaceReferences->Show( true );
        m_checkRegexMatch->Show( true );
    }
 
    if( m_frame->GetFrameType() == FRAME_SCH_SYMBOL_EDITOR )
    {
        m_findReplaceData->searchAllPins = true;
 
        m_cbCurrentSheetOnly->Hide();
        m_cbSearchPins->Hide();
        m_cbSearchNetNames->Hide();
        m_cbReplaceReferences->Hide();
 
        m_staticline1->Hide();
        m_searchPanelLink->Hide();
    }
 
    m_checkMatchCase->SetValue( m_findReplaceData->matchCase );
    m_checkWholeWord->SetValue( m_findReplaceData->matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD );
    m_checkRegexMatch->SetValue( m_findReplaceData->matchMode == EDA_SEARCH_MATCH_MODE::REGEX );
 
    m_cbSearchHiddenFields->SetValue( m_findReplaceData->searchAllFields );
    m_cbReplaceReferences->SetValue( m_findReplaceData->replaceReferences );
    m_cbSearchPins->SetValue( m_findReplaceData->searchAllPins );
    m_cbSelectedOnly->SetValue( m_findReplaceData->searchSelectedOnly );
 
    m_cbCurrentSheetOnly->SetValue( m_findReplaceData->searchCurrentSheetOnly );
    m_cbCurrentSheetOnly->Enable( !m_findReplaceData->searchSelectedOnly );
    m_cbSearchNetNames->SetValue( m_findReplaceData->searchNetNames );
 
    if( int hotkey = ACTIONS::showSearch.GetHotKey() )
    {
        wxString hotkeyHint = wxString::Format( wxT( " (%s)" ), KeyNameFromKeyCode( hotkey ) );
        m_searchPanelLink->SetLabel( m_searchPanelLink->GetLabel() + hotkeyHint );
        m_searchPanelLink->GetParent()->Layout();
    }
 
    m_buttonFind->SetDefault();
    SetInitialFocus( m_comboFind );
 
    // Adjust the height of the dialog to prevent controls from being hidden when
    // switching between the find and find/replace modes of the dialog.  This ignores
    // the users preferred height if any of the controls would be hidden.
    GetSizer()->SetSizeHints( this );
    wxSize size = aSize;
 
    if( aSize != wxDefaultSize )
    {
        wxSize bestSize = GetBestSize();
 
        if( size.GetHeight() != bestSize.GetHeight() )
            size.SetHeight( bestSize.GetHeight() );
    }
 
    SetSize( size );
 
    GetSizer()->Fit( this ); // Needed on Ubuntu/Unity to display the dialog
 
    // Set up tab order for proper keyboard navigation.
    // This is needed because wxComboBox on GTK has issues with Tab key navigation.
    m_tabOrder = {
        m_comboFind,
        m_comboReplace,
        m_radioForward,
        m_radioBackward,
        m_checkMatchCase,
        m_checkWholeWord,
        m_checkRegexMatch,
        m_cbSearchPins,
        m_cbSearchHiddenFields,
        m_cbCurrentSheetOnly,
        m_cbSelectedOnly,
        m_cbReplaceReferences,
        m_cbSearchNetNames,
        m_buttonFind,
        m_buttonReplace,
        m_buttonReplaceAll,
        m_buttonCancel
    };
}
 
 
void DIALOG_SCH_FIND::OnClose( wxCloseEvent& aEvent )
{
    // Notify the SCH_BASE_FRAME
    m_frame->OnFindDialogClose();
}
 
 
void DIALOG_SCH_FIND::OnIdle( wxIdleEvent& aEvent )
{
    if( m_findDirty )
    {
        m_findReplaceTool->UpdateFind( ACTIONS::updateFind.MakeEvent() );
        m_findDirty = false;
    }
}
 
 
void DIALOG_SCH_FIND::OnCancel( wxCommandEvent& aEvent )
{
    wxCloseEvent dummy;
    OnClose( dummy );
}
 
 
void DIALOG_SCH_FIND::OnCharHook( wxKeyEvent& aEvent )
{
    bool                      special = false;
    std::optional<TOOL_EVENT> evt = m_frame->GetToolDispatcher()->GetToolEvent( &aEvent, &special );
 
    if( evt && evt->IsKeyPressed() && evt->KeyCode() )
    {
        // Match the user's hotkeys for the find actions, so they work while the dialog has focus
        int hotkey = evt->Modifier() | evt->KeyCode();
 
        for( TOOL_ACTION* action : { &ACTIONS::findNext, &ACTIONS::findPrevious, &ACTIONS::findNextMarker } )
        {
            if( hotkey == action->GetHotKey() || hotkey == action->GetHotKeyAlt() )
            {
                updateFlags();
                m_findReplaceData->findString = m_comboFind->GetValue();
                m_findReplaceTool->FindNext( action->MakeEvent() );
                return;
            }
        }
    }
 
    DIALOG_SCH_FIND_BASE::OnCharHook( aEvent );
}
 
 
void DIALOG_SCH_FIND::onShowSearchPanel( wxHyperlinkEvent& event )
{
    wxCHECK2( m_frame->GetFrameType() == FRAME_SCH, /* void */ );
 
    m_frame->GetToolManager()->RunAction( ACTIONS::showSearch );
 
    Show( false );
 
    CallAfter(
            []()
            {
                if( wxWindow* frame = wxWindow::FindWindowByName( SCH_EDIT_FRAME_NAME ) )
                    static_cast<SCH_EDIT_FRAME*>( frame )->FocusSearch();
            } );
}
 
 
void DIALOG_SCH_FIND::OnUpdateReplaceUI( wxUpdateUIEvent& aEvent )
{
    aEvent.Enable( HasFlag( wxFR_REPLACEDIALOG ) && !m_comboFind->GetValue().empty()
                   && m_findReplaceTool->HasMatch() );
}
 
 
void DIALOG_SCH_FIND::OnUpdateReplaceAllUI( wxUpdateUIEvent& aEvent )
{
    aEvent.Enable( HasFlag( wxFR_REPLACEDIALOG ) && !m_comboFind->GetValue().empty() );
}
 
 
void DIALOG_SCH_FIND::OnSearchForText( wxCommandEvent& aEvent )
{
    m_findReplaceData->findString = m_comboFind->GetValue();
    m_findDirty = true;
}
 
 
void DIALOG_SCH_FIND::OnSearchForSelect( wxCommandEvent& aEvent )
{
    m_findReplaceData->findString = m_comboFind->GetValue();
 
    // Move the search string to the top of the list if it isn't already there.
    if( aEvent.GetSelection() != 0 )
    {
        wxString tmp = m_comboFind->GetValue();
        m_comboFind->Delete( aEvent.GetSelection() );
        m_comboFind->Insert( tmp, 0 );
        m_comboFind->SetSelection( 0 );
    }
 
    m_findReplaceTool->UpdateFind( ACTIONS::updateFind.MakeEvent() );
}
 
 
void DIALOG_SCH_FIND::OnReplaceWithText( wxCommandEvent& aEvent )
{
    m_findReplaceData->replaceString = m_comboReplace->GetValue();
}
 
 
void DIALOG_SCH_FIND::OnReplaceWithSelect( wxCommandEvent& aEvent )
{
    m_findReplaceData->replaceString = m_comboReplace->GetValue();
 
    // Move the replace string to the top of the list if it isn't already there.
    if( aEvent.GetSelection() != 0 )
    {
        wxString tmp = m_comboReplace->GetValue();
        m_comboReplace->Delete( aEvent.GetSelection() );
        m_comboReplace->Insert( tmp, 0 );
        m_comboReplace->SetSelection( 0 );
    }
}
 
 
void DIALOG_SCH_FIND::OnSearchForEnter( wxCommandEvent& aEvent )
{
    OnFind( aEvent );
}
 
 
void DIALOG_SCH_FIND::OnReplaceWithEnter( wxCommandEvent& aEvent )
{
    OnFind( aEvent );
}
 
 
void DIALOG_SCH_FIND::OnOptions( wxCommandEvent& aEvent )
{
    if( aEvent.GetEventObject() == m_checkRegexMatch )
    {
        m_checkWholeWord->SetValue( false );
        m_checkMatchCase->SetValue( false );
    }
    else if( aEvent.GetEventObject() == m_checkMatchCase || aEvent.GetEventObject() == m_checkWholeWord )
    {
        m_checkRegexMatch->SetValue( false );
    }
 
    updateFlags();
    m_findDirty = true;
}
 
void DIALOG_SCH_FIND::updateFlags()
{
    // Rebuild the search flags in m_findReplaceData from dialog settings
    m_findReplaceData->matchCase         = m_checkMatchCase->GetValue();
    m_findReplaceData->searchAllFields   = m_cbSearchHiddenFields->GetValue();
    m_findReplaceData->searchAllPins     = m_cbSearchPins->GetValue();
    m_findReplaceData->replaceReferences = m_cbReplaceReferences->GetValue();
    m_findReplaceData->searchNetNames    = m_cbSearchNetNames->GetValue();
 
    // Only read the current-sheet-only widget when the user can actually toggle it.
    // While selection-only forces it on, its value doesn't reflect user intent.
    if( m_cbCurrentSheetOnly->IsEnabled() )
        m_findReplaceData->searchCurrentSheetOnly = m_cbCurrentSheetOnly->GetValue();
 
    if( m_checkWholeWord->GetValue() )
        m_findReplaceData->matchMode = EDA_SEARCH_MATCH_MODE::WHOLEWORD;
    else if( m_checkRegexMatch->IsShown() && m_checkRegexMatch->GetValue() )
        m_findReplaceData->matchMode = EDA_SEARCH_MATCH_MODE::REGEX;
    else
        m_findReplaceData->matchMode = EDA_SEARCH_MATCH_MODE::PLAIN;
 
    if( m_cbSelectedOnly->GetValue() )
    {
        m_cbCurrentSheetOnly->Enable( false );
        m_findReplaceData->searchSelectedOnly = true;
    }
    else
    {
        m_cbCurrentSheetOnly->SetValue( m_findReplaceData->searchCurrentSheetOnly );
        m_cbCurrentSheetOnly->Enable( true );
        m_findReplaceData->searchSelectedOnly = false;
    }
}
 
 
void DIALOG_SCH_FIND::OnFind( wxCommandEvent& aEvent )
{
    updateFlags();      // Ensure search flags are up to date
 
    int index = m_comboFind->FindString( m_comboFind->GetValue(), true );
 
    if( index == wxNOT_FOUND )
    {
        m_comboFind->Insert( m_comboFind->GetValue(), 0 );
    }
    else if( index != 0 )
    {
        /* Move the search string to the top of the list if it isn't already there. */
        wxString tmp = m_comboFind->GetValue();
        m_comboFind->Delete( index );
        m_comboFind->Insert( tmp, 0 );
        m_comboFind->SetSelection( 0 );
    }
 
    m_findReplaceTool->FindNext( ACTIONS::findNext.MakeEvent() );
}
 
 
void DIALOG_SCH_FIND::OnReplace( wxCommandEvent& aEvent )
{
    updateFlags();      // Ensure search flags are up to date
 
    int index = m_comboReplace->FindString( m_comboReplace->GetValue(), true );
 
    if( index == wxNOT_FOUND )
    {
        m_comboReplace->Insert( m_comboReplace->GetValue(), 0 );
    }
    else if( index != 0 )
    {
        /* Move the search string to the top of the list if it isn't already there. */
        wxString tmp = m_comboReplace->GetValue();
        m_comboReplace->Delete( index );
        m_comboReplace->Insert( tmp, 0 );
        m_comboReplace->SetSelection( 0 );
    }
 
    if( aEvent.GetId() == wxID_REPLACE )
        m_findReplaceTool->ReplaceAndFindNext( ACTIONS::replaceAndFindNext.MakeEvent() );
    else if( aEvent.GetId() == wxID_REPLACE_ALL )
        m_findReplaceTool->ReplaceAll( ACTIONS::replaceAll.MakeEvent() );
}
 
 
wxArrayString DIALOG_SCH_FIND::GetFindEntries() const
{
    int index = m_comboFind->FindString( m_comboFind->GetValue(), true );
 
    if( index == wxNOT_FOUND )
    {
        m_comboFind->Insert( m_comboFind->GetValue(), 0 );
    }
    else if( index != 0 )
    {
        /* Move the search string to the top of the list if it isn't already there. */
        wxString tmp = m_comboFind->GetValue();
        m_comboFind->Delete( index );
        m_comboFind->Insert( tmp, 0 );
    }
 
    return m_comboFind->GetStrings();
}
 
 
void DIALOG_SCH_FIND::SetFindEntries( const wxArrayString& aEntries, const wxString& aFindString )
{
    m_comboFind->Append( aEntries );
 
    while( m_comboFind->GetCount() > 10 )
    {
        m_frame->GetFindHistoryList().pop_back();
        m_comboFind->Delete( m_comboFind->GetCount() - 1 );
    }
 
    if( !aFindString.IsEmpty() )
    {
        m_comboFind->SetValue( aFindString );
        m_comboFind->SelectAll();
    }
    else if( m_comboFind->GetCount() )
    {
        m_comboFind->SetSelection( 0 );
        m_comboFind->SelectAll();
    }
}
 
 
void DIALOG_SCH_FIND::SetReplaceEntries( const wxArrayString& aEntries )
{
    m_comboReplace->Append( aEntries );
 
    while( m_comboReplace->GetCount() > 10 )
    {
        m_frame->GetReplaceHistoryList().pop_back();
        m_comboReplace->Delete( m_comboReplace->GetCount() - 1 );
    }
 
    if( m_comboReplace->GetCount() )
    {
        m_comboReplace->SetSelection( 0 );
        m_comboReplace->SelectAll();
    }
}