symbol_editor_edit_tool.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2019 CERN
 * Copyright (C) 2019-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 <tool/picker_tool.h>
#include <tools/ee_selection_tool.h>
#include <tools/symbol_editor_pin_tool.h>
#include <tools/symbol_editor_drawing_tools.h>
#include <tools/symbol_editor_move_tool.h>
#include <ee_actions.h>
#include <string_utils.h>
#include <symbol_edit_frame.h>
#include <sch_commit.h>
#include <dialogs/dialog_shape_properties.h>
#include <dialogs/dialog_text_properties.h>
#include <dialogs/dialog_field_properties.h>
#include <dialogs/dialog_lib_symbol_properties.h>
#include <dialogs/dialog_lib_edit_pin_table.h>
#include <dialogs/dialog_update_symbol_fields.h>
#include <sch_io/kicad_sexpr/sch_io_kicad_sexpr.h>
#include <sch_textbox.h>
#include "symbol_editor_edit_tool.h"
#include <wx/textdlg.h> // for wxTextEntryDialog
#include <math/util.h> // for KiROUND
 
SYMBOL_EDITOR_EDIT_TOOL::SYMBOL_EDITOR_EDIT_TOOL() :
 EE_TOOL_BASE( "eeschema.SymbolEditTool" ),
 m_pickerItem( nullptr )
{
}
 
 
bool SYMBOL_EDITOR_EDIT_TOOL::Init()
{
 EE_TOOL_BASE::Init();
 
 SYMBOL_EDITOR_DRAWING_TOOLS* drawingTools = m_toolMgr->GetTool<SYMBOL_EDITOR_DRAWING_TOOLS>();
 SYMBOL_EDITOR_MOVE_TOOL* moveTool = m_toolMgr->GetTool<SYMBOL_EDITOR_MOVE_TOOL>();
 
 wxASSERT_MSG( drawingTools, "eeschema.SymbolDrawing tool is not available" );
 
 auto haveSymbolCondition =
 [&]( const SELECTION& sel )
 {
 return m_isSymbolEditor && m_frame->GetCurSymbol();
 };
 
 auto canEdit =
 [&]( const SELECTION& sel )
 {
 if( !m_frame->IsSymbolEditable() )
 return false;
 
 if( m_frame->IsSymbolAlias() )
 {
 for( EDA_ITEM* item : sel )
 {
 if( item->Type() != SCH_FIELD_T )
 return false;
 }
 }
 
 return true;
 };
 
 // Add edit actions to the move tool menu
 if( moveTool )
 {
 CONDITIONAL_MENU& moveMenu = moveTool->GetToolMenu().GetMenu();
 
 moveMenu.AddSeparator( 200 );
 moveMenu.AddItem( EE_ACTIONS::rotateCCW, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 moveMenu.AddItem( EE_ACTIONS::rotateCW, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 moveMenu.AddItem( EE_ACTIONS::mirrorV, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 moveMenu.AddItem( EE_ACTIONS::mirrorH, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 
 moveMenu.AddItem( EE_ACTIONS::properties, canEdit && EE_CONDITIONS::Count( 1 ), 200 );
 
 moveMenu.AddSeparator( 300 );
 moveMenu.AddItem( ACTIONS::cut, EE_CONDITIONS::IdleSelection, 300 );
 moveMenu.AddItem( ACTIONS::copy, EE_CONDITIONS::IdleSelection, 300 );
 moveMenu.AddItem( ACTIONS::duplicate, canEdit && EE_CONDITIONS::NotEmpty, 300 );
 moveMenu.AddItem( ACTIONS::doDelete, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 
 moveMenu.AddSeparator( 400 );
 moveMenu.AddItem( ACTIONS::selectAll, haveSymbolCondition, 400 );
 moveMenu.AddItem( ACTIONS::unselectAll, haveSymbolCondition, 400 );
 }
 
 // Add editing actions to the drawing tool menu
 CONDITIONAL_MENU& drawMenu = drawingTools->GetToolMenu().GetMenu();
 
 drawMenu.AddSeparator( 200 );
 drawMenu.AddItem( EE_ACTIONS::rotateCCW, canEdit && EE_CONDITIONS::IdleSelection, 200 );
 drawMenu.AddItem( EE_ACTIONS::rotateCW, canEdit && EE_CONDITIONS::IdleSelection, 200 );
 drawMenu.AddItem( EE_ACTIONS::mirrorV, canEdit && EE_CONDITIONS::IdleSelection, 200 );
 drawMenu.AddItem( EE_ACTIONS::mirrorH, canEdit && EE_CONDITIONS::IdleSelection, 200 );
 
 drawMenu.AddItem( EE_ACTIONS::properties, canEdit && EE_CONDITIONS::Count( 1 ), 200 );
 
 // Add editing actions to the selection tool menu
 CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();
 
 selToolMenu.AddItem( EE_ACTIONS::rotateCCW, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 selToolMenu.AddItem( EE_ACTIONS::rotateCW, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 selToolMenu.AddItem( EE_ACTIONS::mirrorV, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 selToolMenu.AddItem( EE_ACTIONS::mirrorH, canEdit && EE_CONDITIONS::NotEmpty, 200 );
 
 selToolMenu.AddItem( EE_ACTIONS::properties, canEdit && EE_CONDITIONS::Count( 1 ), 200 );
 
 selToolMenu.AddSeparator( 300 );
 selToolMenu.AddItem( ACTIONS::cut, EE_CONDITIONS::IdleSelection, 300 );
 selToolMenu.AddItem( ACTIONS::copy, EE_CONDITIONS::IdleSelection, 300 );
 selToolMenu.AddItem( ACTIONS::paste, canEdit && EE_CONDITIONS::Idle, 300 );
 selToolMenu.AddItem( ACTIONS::duplicate, canEdit && EE_CONDITIONS::NotEmpty, 300 );
 selToolMenu.AddItem( ACTIONS::doDelete, canEdit && EE_CONDITIONS::NotEmpty, 300 );
 
 selToolMenu.AddSeparator( 400 );
 selToolMenu.AddItem( ACTIONS::selectAll, haveSymbolCondition, 400 );
 selToolMenu.AddItem( ACTIONS::unselectAll, haveSymbolCondition, 400 );
 
 return true;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Rotate( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection();
 
 if( selection.GetSize() == 0 )
 return 0;
 
 VECTOR2I rotPoint;
 bool ccw = ( aEvent.Matches( EE_ACTIONS::rotateCCW.MakeEvent() ) );
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.Front() );
 SCH_COMMIT localCommit( m_toolMgr );
 SCH_COMMIT* commit = dynamic_cast<SCH_COMMIT*>( aEvent.Commit() );
 
 if( !commit )
 commit = &localCommit;
 
 if( !item->IsMoving() )
 commit->Modify( m_frame->GetCurSymbol(), m_frame->GetScreen() );
 
 if( selection.GetSize() == 1 )
 rotPoint = item->GetPosition();
 else
 rotPoint = m_frame->GetNearestHalfGridPosition( mapCoords( selection.GetCenter(), true ) );
 
 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );
 item->Rotate( rotPoint, ccw );
 m_frame->UpdateItem( item, false, true );
 }
 
 if( item->IsMoving() )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 
 if( !localCommit.Empty() )
 localCommit.Push( _( "Rotate" ) );
 }
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Mirror( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection();
 
 if( selection.GetSize() == 0 )
 return 0;
 
 VECTOR2I mirrorPoint;
 bool xAxis = ( aEvent.Matches( EE_ACTIONS::mirrorV.MakeEvent() ) );
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.Front() );
 
 if( !item->IsMoving() )
 saveCopyInUndoList( m_frame->GetCurSymbol(), UNDO_REDO::LIBEDIT );
 
 if( selection.GetSize() == 1 )
 {
 mirrorPoint = item->GetPosition();
 
 switch( item->Type() )
 {
 case SCH_FIELD_T:
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );
 
 if( xAxis )
 field->SetVertJustify( TO_VJUSTIFY( -field->GetVertJustify() ) );
 else
 field->SetHorizJustify( TO_HJUSTIFY( -field->GetHorizJustify() ) );
 
 break;
 }
 
 default:
 if( xAxis )
 item->MirrorVertically( mirrorPoint.y );
 else
 item->MirrorHorizontally( mirrorPoint.x );
 
 break;
 }
 
 
 m_frame->UpdateItem( item, false, true );
 }
 else
 {
 mirrorPoint = m_frame->GetNearestHalfGridPosition( mapCoords( selection.GetCenter(), true ) );
 
 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );
 
 if( xAxis )
 item->MirrorVertically( mirrorPoint.y );
 else
 item->MirrorHorizontally( mirrorPoint.x );
 
 m_frame->UpdateItem( item, false, true );
 }
 }
 
 if( item->IsMoving() )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 
 m_frame->OnModify();
 }
 
 return 0;
}
 
 
static std::vector<KICAD_T> nonFields =
{
 LIB_SYMBOL_T,
 SCH_SHAPE_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T,
 SCH_PIN_T
};
 
 
int SYMBOL_EDITOR_EDIT_TOOL::DoDelete( const TOOL_EVENT& aEvent )
{
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 std::deque<EDA_ITEM*> items = m_selectionTool->RequestSelection().GetItems();
 SCH_COMMIT commit( m_frame );
 
 if( items.empty() )
 return 0;
 
 // Don't leave a freed pointer in the selection
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 
 commit.Modify( symbol, m_frame->GetScreen() );
 
 std::set<SCH_ITEM*> toDelete;
 int fieldsHidden = 0;
 int fieldsAlreadyHidden = 0;
 
 for( EDA_ITEM* item : items )
 {
 if( item->Type() == SCH_PIN_T )
 {
 SCH_PIN* curr_pin = static_cast<SCH_PIN*>( item );
 VECTOR2I pos = curr_pin->GetPosition();
 
 toDelete.insert( curr_pin );
 
 // when pin editing is synchronized, pins in the same position, with the same name
 // in different units are also removed. But only one pin per unit (matching)
 if( m_frame->SynchronizePins() )
 {
 std::vector<bool> got_unit( symbol->GetUnitCount() + 1 );
 
 got_unit[curr_pin->GetUnit()] = true;
 
 for( SCH_PIN* pin : symbol->GetAllLibPins() )
 {
 if( got_unit[pin->GetUnit()] )
 continue;
 
 if( pin->GetPosition() != pos )
 continue;
 
 if( pin->GetBodyStyle() != curr_pin->GetBodyStyle() )
 continue;
 
 if( pin->GetType() != curr_pin->GetType() )
 continue;
 
 if( pin->GetName() != curr_pin->GetName() )
 continue;
 
 toDelete.insert( pin );
 got_unit[pin->GetUnit()] = true;
 }
 }
 }
 else if( item->Type() == SCH_FIELD_T )
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );
 
 // Hide "deleted" fields
 if( field->IsVisible() )
 {
 field->SetVisible( false );
 fieldsHidden++;
 }
 else
 {
 fieldsAlreadyHidden++;
 }
 }
 else if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( item ) )
 {
 toDelete.insert( schItem );
 }
 }
 
 for( SCH_ITEM* item : toDelete )
 symbol->RemoveDrawItem( item );
 
 if( toDelete.size() == 0 )
 {
 if( fieldsHidden == 1 )
 commit.Push( _( "Hide Field" ) );
 else if( fieldsHidden > 1 )
 commit.Push( _( "Hide Fields" ) );
 else if( fieldsAlreadyHidden > 0 )
 m_frame->ShowInfoBarError( _( "Use the Symbol Properties dialog to remove fields." ) );
 }
 else
 {
 commit.Push( _( "Delete" ) );
 }
 
 m_frame->RebuildView();
 return 0;
}
 
 
#define HITTEST_THRESHOLD_PIXELS 5
 
 
int SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete( const TOOL_EVENT& aEvent )
{
 PICKER_TOOL* picker = m_toolMgr->GetTool<PICKER_TOOL>();
 
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 m_pickerItem = nullptr;
 
 // Deactivate other tools; particularly important if another PICKER is currently running
 Activate();
 
 picker->SetCursor( KICURSOR::REMOVE );
 
 picker->SetClickHandler(
 [this]( const VECTOR2D& aPosition ) -> bool
 {
 if( m_pickerItem )
 {
 EE_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<EE_SELECTION_TOOL>();
 selectionTool->UnbrightenItem( m_pickerItem );
 selectionTool->AddItemToSel( m_pickerItem, true /*quiet mode*/ );
 m_toolMgr->RunAction( ACTIONS::doDelete );
 m_pickerItem = nullptr;
 }
 
 return true;
 } );
 
 picker->SetMotionHandler(
 [this]( const VECTOR2D& aPos )
 {
 EE_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<EE_SELECTION_TOOL>();
 EE_COLLECTOR collector;
 
 selectionTool->CollectHits( collector, aPos, nonFields );
 
 // Remove unselectable items
 for( int i = collector.GetCount() - 1; i >= 0; --i )
 {
 if( !selectionTool->Selectable( collector[ i ] ) )
 collector.Remove( i );
 }
 
 if( collector.GetCount() > 1 )
 selectionTool->GuessSelectionCandidates( collector, aPos );
 
 EDA_ITEM* item = collector.GetCount() == 1 ? collector[ 0 ] : nullptr;
 
 if( m_pickerItem != item )
 {
 if( m_pickerItem )
 selectionTool->UnbrightenItem( m_pickerItem );
 
 m_pickerItem = item;
 
 if( m_pickerItem )
 selectionTool->BrightenItem( m_pickerItem );
 }
 } );
 
 picker->SetFinalizeHandler(
 [this]( const int& aFinalState )
 {
 if( m_pickerItem )
 m_toolMgr->GetTool<EE_SELECTION_TOOL>()->UnbrightenItem( m_pickerItem );
 
 // Wake the selection tool after exiting to ensure the cursor gets updated
 m_toolMgr->PostAction( EE_ACTIONS::selectionActivate );
 } );
 
 m_toolMgr->RunAction( ACTIONS::pickerTool, &aEvent );
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Properties( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection();
 
 if( selection.Empty() || aEvent.IsAction( &EE_ACTIONS::symbolProperties ) )
 {
 if( m_frame->GetCurSymbol() )
 editSymbolProperties();
 }
 else if( selection.Size() == 1 )
 {
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.Front() );
 
 // Save copy for undo if not in edit (edit command already handle the save copy)
 if( item->GetEditFlags() == 0 )
 saveCopyInUndoList( item->GetParent(), UNDO_REDO::LIBEDIT );
 
 switch( item->Type() )
 {
 case SCH_PIN_T:
 if( SYMBOL_EDITOR_PIN_TOOL* pinTool = m_toolMgr->GetTool<SYMBOL_EDITOR_PIN_TOOL>() )
 pinTool->EditPinProperties( static_cast<SCH_PIN*>( item ) );
 
 break;
 
 case SCH_SHAPE_T:
 editShapeProperties( static_cast<SCH_SHAPE*>( item ) );
 break;
 
 case SCH_TEXT_T:
 editTextProperties( item );
 break;
 
 case SCH_TEXTBOX_T:
 editTextBoxProperties( item );
 break;
 
 case SCH_FIELD_T:
 editFieldProperties( static_cast<SCH_FIELD*>( item ) );
 break;
 
 default:
 wxFAIL_MSG( wxT( "Unhandled item <" ) + item->GetClass() + wxT( ">" ) );
 break;
 }
 }
 
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 
 return 0;
}
 
 
void SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties( SCH_SHAPE* aShape )
{
 DIALOG_SHAPE_PROPERTIES dlg( m_frame, aShape );
 
 if( dlg.ShowModal() != wxID_OK )
 return;
 
 updateItem( aShape, true );
 m_frame->GetCanvas()->Refresh();
 m_frame->OnModify();
 
 SYMBOL_EDITOR_DRAWING_TOOLS* drawingTools = m_toolMgr->GetTool<SYMBOL_EDITOR_DRAWING_TOOLS>();
 drawingTools->SetDrawSpecificBodyStyle( !dlg.GetApplyToAllConversions() );
 drawingTools->SetDrawSpecificUnit( !dlg.GetApplyToAllUnits() );
 
 std::vector<MSG_PANEL_ITEM> items;
 aShape->GetMsgPanelInfo( m_frame, items );
 m_frame->SetMsgPanel( items );
}
 
 
void SYMBOL_EDITOR_EDIT_TOOL::editTextProperties( SCH_ITEM* aItem )
{
 if ( aItem->Type() != SCH_TEXT_T )
 return;
 
 DIALOG_TEXT_PROPERTIES dlg( m_frame, static_cast<SCH_TEXT*>( aItem ) );
 
 if( dlg.ShowModal() != wxID_OK )
 return;
 
 updateItem( aItem, true );
 m_frame->GetCanvas()->Refresh();
 m_frame->OnModify( );
}
 
 
void SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties( SCH_ITEM* aItem )
{
 if ( aItem->Type() != SCH_TEXTBOX_T )
 return;
 
 DIALOG_TEXT_PROPERTIES dlg( m_frame, static_cast<SCH_TEXTBOX*>( aItem ) );
 
 if( dlg.ShowModal() != wxID_OK )
 return;
 
 updateItem( aItem, true );
 m_frame->GetCanvas()->Refresh();
 m_frame->OnModify( );
}
 
 
void SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties( SCH_FIELD* aField )
{
 if( aField == nullptr )
 return;
 
 wxString caption;
 
 if( aField->IsMandatory() )
 caption.Printf( _( "Edit %s Field" ), TitleCaps( aField->GetName() ) );
 else
 caption.Printf( _( "Edit '%s' Field" ), aField->GetName() );
 
 DIALOG_FIELD_PROPERTIES dlg( m_frame, caption, aField );
 
 // The dialog may invoke a kiway player for footprint fields
 // so we must use a quasimodal dialog.
 if( dlg.ShowQuasiModal() != wxID_OK )
 return;
 
 wxString newFieldValue = EscapeString( dlg.GetText(), CTX_LIBID );
 wxString oldFieldValue = aField->GetFullText( m_frame->GetUnit() );
 
 SCH_COMMIT commit( m_toolMgr );
 commit.Modify( aField, m_frame->GetScreen() );
 
 dlg.UpdateField( aField );
 
 commit.Push( caption );
 
 m_frame->GetCanvas()->Refresh();
 m_frame->UpdateSymbolMsgPanelInfo();
}
 
 
void SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties()
{
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 bool partLocked = symbol->UnitsLocked();
 
 m_toolMgr->RunAction( ACTIONS::cancelInteractive );
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 
 DIALOG_LIB_SYMBOL_PROPERTIES dlg( m_frame, symbol );
 
 // This dialog itself subsequently can invoke a KIWAY_PLAYER as a quasimodal
 // frame. Therefore this dialog as a modal frame parent, MUST be run under
 // quasimodal mode for the quasimodal frame support to work. So don't use
 // the QUASIMODAL macros here.
 if( dlg.ShowQuasiModal() != wxID_OK )
 return;
 
 m_frame->OnModify();
 
 // if m_UnitSelectionLocked has changed, set some edit options or defaults
 // to the best value
 if( partLocked != symbol->UnitsLocked() )
 {
 SYMBOL_EDITOR_DRAWING_TOOLS* tools = m_toolMgr->GetTool<SYMBOL_EDITOR_DRAWING_TOOLS>();
 
 // Enable synchronized pin edit mode for symbols with interchangeable units
 m_frame->m_SyncPinEdit = !symbol->UnitsLocked();
 
 // also set default edit options to the better value
 // Usually if units are locked, graphic items are specific to each unit
 // and if units are interchangeable, graphic items are common to units
 tools->SetDrawSpecificUnit( symbol->UnitsLocked() );
 }
}
 
void SYMBOL_EDITOR_EDIT_TOOL::handlePinDuplication( SCH_PIN* aOldPin, SCH_PIN* aNewPin,
 int& aSymbolLastPinNumber )
{
 if( !aNewPin->GetNumber().IsEmpty() )
 {
 // when duplicating a pin in symbol editor, assigning identical pin number
 // to the old one does not makes any sense, so assign the next unassigned number to it
 aSymbolLastPinNumber++;
 aNewPin->SetNumber( wxString::Format( wxT( "%i" ), aSymbolLastPinNumber ) );
 }
}
 
int SYMBOL_EDITOR_EDIT_TOOL::PinTable( const TOOL_EVENT& aEvent )
{
 SCH_COMMIT commit( m_frame );
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 
 if( !symbol )
 return 0;
 
 commit.Modify( symbol );
 
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 
 DIALOG_LIB_EDIT_PIN_TABLE dlg( m_frame, symbol );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return -1;
 
 commit.Push( _( "Edit Pins" ) );
 m_frame->RebuildView();
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields( const TOOL_EVENT& aEvent )
{
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 
 if( !symbol )
 return 0;
 
 if( !symbol->IsAlias() )
 {
 m_frame->ShowInfoBarError( _( "Symbol is not derived from another symbol." ) );
 }
 else
 {
 DIALOG_UPDATE_SYMBOL_FIELDS dlg( m_frame, symbol );
 
 if( dlg.ShowModal() == wxID_CANCEL )
 return -1;
 }
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName( const TOOL_EVENT& aEvent )
{
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 
 if( !symbol )
 return 0;
 
 int unitid = m_frame->GetUnit();
 
 if( unitid == 0 )
 {
 return -1;
 }
 
 wxString promptText = wxString::Format( _( "Enter display name for unit %s" ),
 symbol->GetUnitReference( unitid ) );
 wxString currentvalue;
 
 if( symbol->HasUnitDisplayName( unitid ) )
 {
 currentvalue = symbol->GetUnitDisplayName( unitid );
 }
 
 wxTextEntryDialog dlg( m_frame, promptText, _( "Set Unit Display Name" ), currentvalue );
 
 if( dlg.ShowModal() == wxID_OK )
 {
 saveCopyInUndoList( symbol, UNDO_REDO::LIBEDIT );
 symbol->SetUnitDisplayName( unitid, dlg.GetValue() );
 m_frame->RebuildSymbolUnitsList();
 m_frame->OnModify();
 }
 else
 {
 return -1;
 }
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Undo( const TOOL_EVENT& aEvent )
{
 EE_SELECTION_TOOL* selTool = m_toolMgr->GetTool<EE_SELECTION_TOOL>();
 
 // Nuke the selection for later rebuilding. This does *not* clear the flags on any items;
 // it just clears the SELECTION's reference to them.
 selTool->GetSelection().Clear();
 {
 m_frame->GetSymbolFromUndoList();
 }
 selTool->RebuildSelection();
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Redo( const TOOL_EVENT& aEvent )
{
 EE_SELECTION_TOOL* selTool = m_toolMgr->GetTool<EE_SELECTION_TOOL>();
 
 // Nuke the selection for later rebuilding. This does *not* clear the flags on any items;
 // it just clears the SELECTION's reference to them.
 selTool->GetSelection().Clear();
 {
 m_frame->GetSymbolFromRedoList();
 }
 selTool->RebuildSelection();
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Cut( const TOOL_EVENT& aEvent )
{
 int retVal = Copy( aEvent );
 
 if( retVal == 0 )
 retVal = DoDelete( aEvent );
 
 return retVal;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Copy( const TOOL_EVENT& aEvent )
{
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 EE_SELECTION& selection = m_selectionTool->RequestSelection( nonFields );
 
 if( !symbol || !selection.GetSize() )
 return 0;
 
 for( SCH_ITEM& item : symbol->GetDrawItems() )
 {
 if( item.Type() == SCH_FIELD_T )
 continue;
 
 wxASSERT( !item.HasFlag( STRUCT_DELETED ) );
 
 if( !item.IsSelected() )
 item.SetFlags( STRUCT_DELETED );
 }
 
 LIB_SYMBOL* partCopy = new LIB_SYMBOL( *symbol );
 
 STRING_FORMATTER formatter;
 SCH_IO_KICAD_SEXPR::FormatLibSymbol( partCopy, formatter );
 
 delete partCopy;
 
 for( SCH_ITEM& item : symbol->GetDrawItems() )
 item.ClearFlags( STRUCT_DELETED );
 
 if( m_toolMgr->SaveClipboard( formatter.GetString() ) )
 return 0;
 else
 return -1;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Paste( const TOOL_EVENT& aEvent )
{
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 LIB_SYMBOL* newPart = nullptr;
 
 if( !symbol || symbol->IsAlias() )
 return 0;
 
 std::string clipboardData = m_toolMgr->GetClipboardUTF8();
 
 try
 {
 std::vector<LIB_SYMBOL*> newParts = SCH_IO_KICAD_SEXPR::ParseLibSymbols( clipboardData, "Clipboard" );
 
 if( newParts.empty() || !newParts[0] )
 return -1;
 
 newPart = newParts[0];
 }
 catch( IO_ERROR& )
 {
 // If it's not a symbol then paste as text
 newPart = new LIB_SYMBOL( "dummy_part" );
 SCH_TEXT* newText = new SCH_TEXT( { 0, 0 }, clipboardData, LAYER_DEVICE );
 newPart->AddDrawItem( newText );
 }
 
 SCH_COMMIT commit( m_toolMgr );
 
 commit.Modify( symbol );
 m_selectionTool->ClearSelection();
 
 for( SCH_ITEM& item : symbol->GetDrawItems() )
 item.ClearFlags( IS_NEW | IS_PASTED | SELECTED );
 
 for( SCH_ITEM& item : newPart->GetDrawItems() )
 {
 if( item.Type() == SCH_FIELD_T )
 continue;
 
 SCH_ITEM* newItem = item.Duplicate();
 newItem->SetParent( symbol );
 newItem->SetFlags( IS_NEW | IS_PASTED | SELECTED );
 
 newItem->SetUnit( newItem->GetUnit() ? m_frame->GetUnit() : 0 );
 newItem->SetBodyStyle( newItem->GetBodyStyle() ? m_frame->GetBodyStyle() : 0 );
 
 symbol->AddDrawItem( newItem );
 getView()->Add( newItem );
 }
 
 delete newPart;
 
 m_selectionTool->RebuildSelection();
 
 EE_SELECTION& selection = m_selectionTool->GetSelection();
 
 if( !selection.Empty() )
 {
 selection.SetReferencePoint( getViewControls()->GetCursorPosition( true ) );
 
 if( m_toolMgr->RunSynchronousAction( EE_ACTIONS::move, &commit ) )
 commit.Push( _( "Paste" ) );
 else
 commit.Revert();
 }
 
 return 0;
}
 
 
int SYMBOL_EDITOR_EDIT_TOOL::Duplicate( const TOOL_EVENT& aEvent )
{
 LIB_SYMBOL* symbol = m_frame->GetCurSymbol();
 EE_SELECTION& selection = m_selectionTool->RequestSelection( nonFields );
 SCH_COMMIT commit( m_toolMgr );
 
 if( selection.GetSize() == 0 )
 return 0;
 
 commit.Modify( symbol, m_frame->GetScreen() );
 
 EDA_ITEMS newItems;
 
 for( unsigned ii = 0; ii < selection.GetSize(); ++ii )
 {
 SCH_ITEM* oldItem = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );
 SCH_ITEM* newItem = oldItem->Duplicate();
 
 if( newItem->Type() == SCH_PIN_T )
 {
 SCH_PIN* newPin = static_cast<SCH_PIN*>( newItem );
 
 if( !newPin->GetNumber().IsEmpty() )
 newPin->SetNumber( wxString::Format( wxT( "%i" ), symbol->GetMaxPinNumber() + 1 ) );
 }
 
 oldItem->ClearFlags( IS_NEW | IS_PASTED | SELECTED );
 newItem->SetFlags( IS_NEW | IS_PASTED | SELECTED );
 newItem->SetParent( symbol );
 newItems.push_back( newItem );
 
 symbol->AddDrawItem( newItem );
 getView()->Add( newItem );
 }
 
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection );
 m_toolMgr->RunAction<EDA_ITEMS*>( EE_ACTIONS::addItemsToSel, &newItems );
 
 selection.SetReferencePoint( mapCoords( getViewControls()->GetCursorPosition( true ), true ) );
 
 if( m_toolMgr->RunSynchronousAction( EE_ACTIONS::move, &commit ) )
 commit.Push( _( "Duplicate" ) );
 else
 commit.Revert();
 
 return 0;
}
 
 
void SYMBOL_EDITOR_EDIT_TOOL::setTransitions()
{
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Undo, ACTIONS::undo.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Redo, ACTIONS::redo.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Cut, ACTIONS::cut.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Copy, ACTIONS::copy.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Paste, ACTIONS::paste.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Duplicate, ACTIONS::duplicate.MakeEvent() );
 
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Rotate, EE_ACTIONS::rotateCW.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Rotate, EE_ACTIONS::rotateCCW.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Mirror, EE_ACTIONS::mirrorV.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Mirror, EE_ACTIONS::mirrorH.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::DoDelete, ACTIONS::doDelete.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::InteractiveDelete, ACTIONS::deleteTool.MakeEvent() );
 
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Properties, EE_ACTIONS::properties.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::Properties, EE_ACTIONS::symbolProperties.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::PinTable, EE_ACTIONS::pinTable.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::UpdateSymbolFields, EE_ACTIONS::updateSymbolFields.MakeEvent() );
 Go( &SYMBOL_EDITOR_EDIT_TOOL::SetUnitDisplayName, EE_ACTIONS::setUnitDisplayName.MakeEvent() );
}