dialog_choose_symbol.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 Henner Zeller <[email protected]>
 * Copyright (C) 2016-2021 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 <symbol_library.h>
#include <dialog_choose_symbol.h>
#include <eeschema_settings.h>
#include <kiface_base.h>
#include <sch_base_frame.h>
#include <core/kicad_algo.h>
#include <template_fieldnames.h>
#include <widgets/footprint_preview_widget.h>
#include <widgets/footprint_select_widget.h>
#include <widgets/lib_tree.h>
#include <widgets/symbol_preview_widget.h>
#include <wx/button.h>
#include <wx/checkbox.h>
#include <wx/clipbrd.h>
#include <wx/dataview.h>
#include <wx/log.h>
#include <wx/panel.h>
#include <wx/sizer.h>
#include <wx/splitter.h>
#include <wx/timer.h>
#include <wx/utils.h>
#include <wx/wxhtml.h>

std::mutex DIALOG_CHOOSE_SYMBOL::g_Mutex;


DIALOG_CHOOSE_SYMBOL::DIALOG_CHOOSE_SYMBOL( SCH_BASE_FRAME* aParent, const wxString& aTitle,
 wxObjectDataPtr<LIB_TREE_MODEL_ADAPTER>& aAdapter,
 int aDeMorganConvert, bool aAllowFieldEdits,
 bool aShowFootprints, bool aAllowBrowser )
 : DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
 m_symbol_preview( nullptr ),
 m_browser_button( nullptr ),
 m_hsplitter( nullptr ),
 m_vsplitter( nullptr ),
 m_fp_sel_ctrl( nullptr ),
 m_fp_preview( nullptr ),
 m_keepSymbol( nullptr ),
 m_useUnits( nullptr ),
 m_tree( nullptr ),
 m_details( nullptr ),
 m_parent( aParent ),
 m_deMorganConvert( aDeMorganConvert >= 0 ? aDeMorganConvert : 0 ),
 m_allow_field_edits( aAllowFieldEdits ),
 m_show_footprints( aShowFootprints ),
 m_external_browser_requested( false )
{
 // Never show footprints in power symbol mode
 if( aAdapter->GetFilter() == SYMBOL_TREE_MODEL_ADAPTER::SYM_FILTER_POWER )
 m_show_footprints = false;

 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );

 // Use a slightly different layout, with a details pane spanning the entire window,
 // if we're not showing footprints.
 if( m_show_footprints )
 {
 m_hsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );

 //Avoid the splitter window being assigned as the Parent to additional windows
 m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );

 sizer->Add( m_hsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
 }
 else
 {
 m_vsplitter = new wxSplitterWindow( this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );

 m_hsplitter = new wxSplitterWindow( m_vsplitter, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 wxSP_LIVE_UPDATE | wxSP_NOBORDER | wxSP_3DSASH );

 // Avoid the splitter window being assigned as the parent to additional windows.
 m_vsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );
 m_hsplitter->SetExtraStyle( wxWS_EX_TRANSIENT );

 wxPanel* detailsPanel = new wxPanel( m_vsplitter );
 wxBoxSizer* detailsSizer = new wxBoxSizer( wxVERTICAL );
 detailsPanel->SetSizer( detailsSizer );

 m_details = new HTML_WINDOW( detailsPanel, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 wxHW_SCROLLBAR_AUTO );
 detailsSizer->Add( m_details, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
 detailsPanel->Layout();
 detailsSizer->Fit( detailsPanel );

 m_vsplitter->SetSashGravity( 0.5 );
 m_vsplitter->SetMinimumPaneSize( 20 );
 m_vsplitter->SplitHorizontally( m_hsplitter, detailsPanel );

 sizer->Add( m_vsplitter, 1, wxEXPAND | wxLEFT | wxRIGHT | wxTOP, 5 );
 }

 wxPanel* treePanel = new wxPanel( m_hsplitter );
 wxBoxSizer* treeSizer = new wxBoxSizer( wxVERTICAL );
 treePanel->SetSizer( treeSizer );

 m_tree = new LIB_TREE( treePanel, Prj().SchSymbolLibTable(), aAdapter, LIB_TREE::WIDGETS::ALL,
 m_details );

 treeSizer->Add( m_tree, 1, wxEXPAND | wxALL, 5 );
 treePanel->Layout();
 treeSizer->Fit( treePanel );

 aAdapter->FinishTreeInitialization();

 m_hsplitter->SetSashGravity( 0.8 );
 m_hsplitter->SetMinimumPaneSize( 20 );
 m_hsplitter->SplitVertically( treePanel, ConstructRightPanel( m_hsplitter ) );

 m_dbl_click_timer = new wxTimer( this );

 wxBoxSizer* buttonsSizer = new wxBoxSizer( wxHORIZONTAL );

 if( aAllowBrowser )
 {
 m_browser_button = new wxButton( this, wxID_ANY, _( "Select with Browser" ) );
 buttonsSizer->Add( m_browser_button, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
 }

 m_keepSymbol = new wxCheckBox( this, wxID_ANY, _("Place repeated copies"), wxDefaultPosition,
 wxDefaultSize, wxALIGN_RIGHT );
 m_keepSymbol->SetToolTip( _( "Keep the symbol selected for subsequent clicks." ) );

 m_useUnits = new wxCheckBox( this, wxID_ANY, _("Place all units"), wxDefaultPosition,
 wxDefaultSize, wxALIGN_RIGHT );
 m_useUnits->SetToolTip( _( "Sequentially place all units of the symbol." ) );

 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
 {
 m_keepSymbol->SetValue( cfg->m_SymChooserPanel.keep_symbol );
 m_useUnits->SetValue( cfg->m_SymChooserPanel.place_all_units );
 }

 buttonsSizer->Add( m_keepSymbol, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );
 buttonsSizer->Add( m_useUnits, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5 );

 wxStdDialogButtonSizer* sdbSizer = new wxStdDialogButtonSizer();
 wxButton* okButton = new wxButton( this, wxID_OK );
 wxButton* cancelButton = new wxButton( this, wxID_CANCEL );

 sdbSizer->AddButton( okButton );
 sdbSizer->AddButton( cancelButton );
 sdbSizer->Realize();

 buttonsSizer->Add( sdbSizer, 1, wxALL, 5 );

 sizer->Add( buttonsSizer, 0, wxEXPAND | wxLEFT, 5 );
 SetSizer( sizer );

 Layout();

 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
 {
 EESCHEMA_SETTINGS::PANEL_SYM_CHOOSER& panelCfg = cfg->m_SymChooserPanel;

 // We specify the width of the right window (m_symbol_view_panel), because specify
 // the width of the left window does not work as expected when SetSashGravity() is called
 m_hsplitter->SetSashPosition( panelCfg.sash_pos_h > 0 ? panelCfg.sash_pos_h :
 horizPixelsFromDU( 220 ) );

 if( m_vsplitter )
 {
 m_vsplitter->SetSashPosition( panelCfg.sash_pos_v > 0 ? panelCfg.sash_pos_v :
 vertPixelsFromDU( 230 ) );
 }

 wxSize dlgSize( panelCfg.width > 0 ? panelCfg.width : horizPixelsFromDU( 390 ),
 panelCfg.height > 0 ? panelCfg.height : vertPixelsFromDU( 300 ) );
 SetSize( dlgSize );
 }

 SetInitialFocus( m_tree->GetFocusTarget() );
 okButton->SetDefault();

 Bind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_SYMBOL::OnInitDialog, this );
 Bind( wxEVT_TIMER, &DIALOG_CHOOSE_SYMBOL::OnCloseTimer, this, m_dbl_click_timer->GetId() );
 Bind( SYMBOL_PRESELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentPreselected, this );
 Bind( SYMBOL_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentSelected, this );

 if( m_browser_button )
 {
 m_browser_button->Bind( wxEVT_COMMAND_BUTTON_CLICKED, &DIALOG_CHOOSE_SYMBOL::OnUseBrowser,
 this );
 }

 if( m_fp_sel_ctrl )
 {
 m_fp_sel_ctrl->Bind( EVT_FOOTPRINT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnFootprintSelected,
 this );
 }

 if( m_details )
 {
 m_details->Connect( wxEVT_CHAR_HOOK, wxKeyEventHandler( DIALOG_CHOOSE_SYMBOL::OnCharHook ),
 nullptr, this );
 }
}


DIALOG_CHOOSE_SYMBOL::~DIALOG_CHOOSE_SYMBOL()
{
 Unbind( wxEVT_INIT_DIALOG, &DIALOG_CHOOSE_SYMBOL::OnInitDialog, this );
 Unbind( wxEVT_TIMER, &DIALOG_CHOOSE_SYMBOL::OnCloseTimer, this );
 Unbind( SYMBOL_PRESELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentPreselected, this );
 Unbind( SYMBOL_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnComponentSelected, this );

 // Stop the timer during destruction early to avoid potential race conditions (that do happen)
 m_dbl_click_timer->Stop();
 delete m_dbl_click_timer;

 if( m_browser_button )
 {
 m_browser_button->Unbind( wxEVT_COMMAND_BUTTON_CLICKED,
 &DIALOG_CHOOSE_SYMBOL::OnUseBrowser, this );
 }

 if( m_fp_sel_ctrl )
 {
 m_fp_sel_ctrl->Unbind( EVT_FOOTPRINT_SELECTED, &DIALOG_CHOOSE_SYMBOL::OnFootprintSelected,
 this );
 }

 if( m_details )
 {
 m_details->Disconnect( wxEVT_CHAR_HOOK,
 wxKeyEventHandler( DIALOG_CHOOSE_SYMBOL::OnCharHook ), nullptr,
 this );
 }

 if( EESCHEMA_SETTINGS* cfg = dynamic_cast<EESCHEMA_SETTINGS*>( Kiface().KifaceSettings() ) )
 {
 cfg->m_SymChooserPanel.width = GetSize().x;
 cfg->m_SymChooserPanel.height = GetSize().y;

 cfg->m_SymChooserPanel.keep_symbol = m_keepSymbol->GetValue();
 cfg->m_SymChooserPanel.place_all_units = m_useUnits->GetValue();

 cfg->m_SymChooserPanel.sash_pos_h = m_hsplitter->GetSashPosition();

 if( m_vsplitter )
 cfg->m_SymChooserPanel.sash_pos_v = m_vsplitter->GetSashPosition();
 }
}


wxPanel* DIALOG_CHOOSE_SYMBOL::ConstructRightPanel( wxWindow* aParent )
{
 wxPanel* panel = new wxPanel( aParent );
 wxBoxSizer* sizer = new wxBoxSizer( wxVERTICAL );
 EDA_DRAW_PANEL_GAL::GAL_TYPE backend = m_parent->GetCanvas()->GetBackend();

 m_symbol_preview = new SYMBOL_PREVIEW_WIDGET( panel, Kiway(), backend );
 m_symbol_preview->SetLayoutDirection( wxLayout_LeftToRight );

 if( m_show_footprints )
 {
 FOOTPRINT_LIST* fp_list = FOOTPRINT_LIST::GetInstance( Kiway() );

 sizer->Add( m_symbol_preview, 1, wxEXPAND | wxALL, 5 );

 if ( fp_list )
 {
 if( m_allow_field_edits )
 m_fp_sel_ctrl = new FOOTPRINT_SELECT_WIDGET( m_parent, panel, fp_list, true );

 m_fp_preview = new FOOTPRINT_PREVIEW_WIDGET( panel, Kiway() );
 }

 if( m_fp_sel_ctrl )
 sizer->Add( m_fp_sel_ctrl, 0, wxEXPAND | wxTOP | wxLEFT | wxRIGHT, 3 );

 if( m_fp_preview )
 sizer->Add( m_fp_preview, 1, wxEXPAND | wxALL, 5 );
 }
 else
 {
 sizer->Add( m_symbol_preview, 1, wxEXPAND | wxALL, 5 );
 }

 panel->SetSizer( sizer );
 panel->Layout();
 sizer->Fit( panel );

 return panel;
}


void DIALOG_CHOOSE_SYMBOL::OnInitDialog( wxInitDialogEvent& aEvent )
{
 if( m_fp_preview && m_fp_preview->IsInitialized() )
 {
 // This hides the GAL panel and shows the status label
 m_fp_preview->SetStatusText( wxEmptyString );
 }

 if( m_fp_sel_ctrl )
 m_fp_sel_ctrl->Load( Kiway(), Prj() );
}


void DIALOG_CHOOSE_SYMBOL::OnCharHook( wxKeyEvent& e )
{
 if( m_details && e.GetKeyCode() == 'C' && e.ControlDown() &&
 !e.AltDown() && !e.ShiftDown() && !e.MetaDown() )
 {
 wxString txt = m_details->SelectionToText();
 wxLogNull doNotLog; // disable logging of failed clipboard actions

 if( wxTheClipboard->Open() )
 {
 wxTheClipboard->SetData( new wxTextDataObject( txt ) );
 wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
 wxTheClipboard->Close();
 }
 }
 else
 {
 e.Skip();
 }
}


LIB_ID DIALOG_CHOOSE_SYMBOL::GetSelectedLibId( int* aUnit ) const
{
 return m_tree->GetSelectedLibId( aUnit );
}


void DIALOG_CHOOSE_SYMBOL::OnUseBrowser( wxCommandEvent& aEvent )
{
 m_external_browser_requested = true;

 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
}


void DIALOG_CHOOSE_SYMBOL::OnCloseTimer( wxTimerEvent& aEvent )
{
 // Hack handler because of eaten MouseUp event. See
 // DIALOG_CHOOSE_SYMBOL::OnComponentSelected for the beginning
 // of this spaghetti noodle.

 auto state = wxGetMouseState();

 if( state.LeftIsDown() )
 {
 // Mouse hasn't been raised yet, so fire the timer again. Otherwise the
 // purpose of this timer is defeated.
 m_dbl_click_timer->StartOnce( DIALOG_CHOOSE_SYMBOL::DblClickDelay );
 }
 else
 {
 wxPostEvent( this, wxCommandEvent( wxEVT_COMMAND_BUTTON_CLICKED, wxID_OK ) );
 }
}


void DIALOG_CHOOSE_SYMBOL::ShowFootprintFor( LIB_ID const& aLibId )
{
 if( !m_fp_preview || !m_fp_preview->IsInitialized() )
 return;

 LIB_SYMBOL* symbol = nullptr;

 try
 {
 symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
 }
 catch( const IO_ERROR& ioe )
 {
 wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
 aLibId.GetLibItemName().wx_str(),
 aLibId.GetLibNickname().wx_str(),
 ioe.What() );
 }

 if( !symbol )
 return;

 LIB_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
 wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );

 ShowFootprint( fp_name );
}


void DIALOG_CHOOSE_SYMBOL::ShowFootprint( wxString const& aName )
{
 if( !m_fp_preview || !m_fp_preview->IsInitialized() )
 return;

 if( aName == wxEmptyString )
 {
 m_fp_preview->SetStatusText( _( "No footprint specified" ) );
 }
 else
 {
 LIB_ID lib_id;

 if( lib_id.Parse( aName ) == -1 && lib_id.IsValid() )
 {
 m_fp_preview->ClearStatus();
 m_fp_preview->DisplayFootprint( lib_id );
 }
 else
 {
 m_fp_preview->SetStatusText( _( "Invalid footprint specified" ) );
 }
 }
}


void DIALOG_CHOOSE_SYMBOL::PopulateFootprintSelector( LIB_ID const& aLibId )
{
 if( !m_fp_sel_ctrl )
 return;

 m_fp_sel_ctrl->ClearFilters();

 LIB_SYMBOL* symbol = nullptr;

 if( aLibId.IsValid() )
 {
 try
 {
 symbol = Prj().SchSymbolLibTable()->LoadSymbol( aLibId );
 }
 catch( const IO_ERROR& ioe )
 {
 wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
 aLibId.GetLibItemName().wx_str(),
 aLibId.GetLibNickname().wx_str(),
 ioe.What() );
 }
 }

 if( symbol != nullptr )
 {
 LIB_PINS temp_pins;
 LIB_FIELD* fp_field = symbol->GetFieldById( FOOTPRINT_FIELD );
 wxString fp_name = fp_field ? fp_field->GetFullText() : wxString( "" );

 symbol->GetPins( temp_pins );

 m_fp_sel_ctrl->FilterByPinCount( temp_pins.size() );
 m_fp_sel_ctrl->FilterByFootprintFilters( symbol->GetFPFilters(), true );
 m_fp_sel_ctrl->SetDefaultFootprint( fp_name );
 m_fp_sel_ctrl->UpdateList();
 m_fp_sel_ctrl->Enable();
 }
 else
 {
 m_fp_sel_ctrl->UpdateList();
 m_fp_sel_ctrl->Disable();
 }
}


void DIALOG_CHOOSE_SYMBOL::OnFootprintSelected( wxCommandEvent& aEvent )
{
 m_fp_override = aEvent.GetString();

 alg::delete_if( m_field_edits, []( std::pair<int, wxString> const& i )
 {
 return i.first == FOOTPRINT_FIELD;
 } );

 m_field_edits.emplace_back( std::make_pair( FOOTPRINT_FIELD, m_fp_override ) );

 ShowFootprint( m_fp_override );
}


void DIALOG_CHOOSE_SYMBOL::OnComponentPreselected( wxCommandEvent& aEvent )
{
 int unit = 0;

 LIB_ID id = m_tree->GetSelectedLibId( &unit );

 if( id.IsValid() )
 {
 m_symbol_preview->DisplaySymbol( id, unit );

 ShowFootprintFor( id );
 PopulateFootprintSelector( id );
 }
 else
 {
 m_symbol_preview->SetStatusText( _( "No symbol selected" ) );

 if( m_fp_preview && m_fp_preview->IsInitialized() )
 m_fp_preview->SetStatusText( wxEmptyString );

 PopulateFootprintSelector( id );
 }
}


void DIALOG_CHOOSE_SYMBOL::OnComponentSelected( wxCommandEvent& aEvent )
{
 if( m_tree->GetSelectedLibId().IsValid() )
 {
 // Got a selection. We can't just end the modal dialog here, because
 // wx leaks some events back to the parent window (in particular, the
 // MouseUp following a double click).
 //
 // NOW, here's where it gets really fun. wxTreeListCtrl eats MouseUp.
 // This isn't really feasible to bypass without a fully custom
 // wxDataViewCtrl implementation, and even then might not be fully
 // possible (docs are vague). To get around this, we use a one-shot
 // timer to schedule the dialog close.
 //
 // See DIALOG_CHOOSE_SYMBOL::OnCloseTimer for the other end of this
 // spaghetti noodle.
 m_dbl_click_timer->StartOnce( DIALOG_CHOOSE_SYMBOL::DblClickDelay );
 }
}


bool DIALOG_CHOOSE_SYMBOL::GetUseAllUnits() const
{
 return m_useUnits->GetValue();
}


bool DIALOG_CHOOSE_SYMBOL::GetKeepSymbol() const
{
 return m_keepSymbol->GetValue();
}