sch_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 <kiway.h>
#include <tool/picker_tool.h>
#include <tools/sch_edit_tool.h>
#include <tools/ee_selection_tool.h>
#include <tools/sch_line_wire_bus_tool.h>
#include <tools/sch_move_tool.h>
#include <widgets/infobar.h>
#include <ee_actions.h>
#include <bitmaps.h>
#include <confirm.h>
#include <eda_item.h>
#include <reporter.h>
#include <string_utils.h>
#include <sch_item.h>
#include <sch_symbol.h>
#include <sch_sheet.h>
#include <sch_sheet_pin.h>
#include <sch_text.h>
#include <sch_bitmap.h>
#include <sch_view.h>
#include <sch_line.h>
#include <sch_bus_entry.h>
#include <sch_junction.h>
#include <sch_edit_frame.h>
#include <schematic.h>
#include <drawing_sheet/ds_proxy_view_item.h>
#include <drawing_sheet/ds_proxy_undo_item.h>
#include <eeschema_id.h>
#include <status_popup.h>
#include <wx/gdicmn.h>
#include <dialogs/dialog_change_symbols.h>
#include <dialogs/dialog_image_editor.h>
#include <dialogs/dialog_line_wire_bus_properties.h>
#include <dialogs/dialog_symbol_properties.h>
#include <dialogs/dialog_sheet_pin_properties.h>
#include <dialogs/dialog_field_properties.h>
#include <dialogs/dialog_junction_props.h>
#include "sch_drawing_tools.h"
#include <math/util.h> // for KiROUND
#include <pgm_base.h>
#include <settings/settings_manager.h>
#include <symbol_editor_settings.h>
#include <dialogs/dialog_text_and_label_properties.h>
#include <core/kicad_algo.h>
#include <wx/textdlg.h>



class SYMBOL_UNIT_MENU : public ACTION_MENU
{
public:
 SYMBOL_UNIT_MENU() :
 ACTION_MENU( true )
 {
 SetIcon( BITMAPS::component_select_unit );
 SetTitle( _( "Symbol Unit" ) );
 }

protected:
 ACTION_MENU* create() const override
 {
 return new SYMBOL_UNIT_MENU();
 }

private:
 void update() override
 {
 EE_SELECTION_TOOL* selTool = getToolManager()->GetTool<EE_SELECTION_TOOL>();
 EE_SELECTION& selection = selTool->GetSelection();
 SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( selection.Front() );

 Clear();

 if( !symbol )
 {
 Append( ID_POPUP_SCH_SELECT_UNIT_CMP, _( "no symbol selected" ), wxEmptyString );
 Enable( ID_POPUP_SCH_SELECT_UNIT_CMP, false );
 return;
 }

 int unit = symbol->GetUnit();

 if( !symbol->GetLibSymbolRef() || symbol->GetLibSymbolRef()->GetUnitCount() < 2 )
 {
 Append( ID_POPUP_SCH_SELECT_UNIT_CMP, _( "symbol is not multi-unit" ), wxEmptyString );
 Enable( ID_POPUP_SCH_SELECT_UNIT_CMP, false );
 return;
 }

 for( int ii = 0; ii < symbol->GetLibSymbolRef()->GetUnitCount(); ii++ )
 {
 wxString num_unit;
 num_unit.Printf( _( "Unit %s" ), LIB_SYMBOL::SubReference( ii + 1, false ) );

 wxMenuItem * item = Append( ID_POPUP_SCH_SELECT_UNIT1 + ii, num_unit, wxEmptyString,
 wxITEM_CHECK );
 if( unit == ii + 1 )
 item->Check(true);

 // The ID max for these submenus is ID_POPUP_SCH_SELECT_UNIT_SYM_MAX
 // See eeschema_id to modify this value.
 if( ii >= (ID_POPUP_SCH_SELECT_UNIT_SYM_MAX - ID_POPUP_SCH_SELECT_UNIT1) )
 break; // We have used all IDs for these submenus
 }
 }
};


SCH_EDIT_TOOL::SCH_EDIT_TOOL() :
 EE_TOOL_BASE<SCH_EDIT_FRAME>( "eeschema.InteractiveEdit" )
{
 m_pickerItem = nullptr;
}


using E_C = EE_CONDITIONS;

bool SCH_EDIT_TOOL::Init()
{
 EE_TOOL_BASE::Init();

 SCH_DRAWING_TOOLS* drawingTools = m_toolMgr->GetTool<SCH_DRAWING_TOOLS>();
 SCH_MOVE_TOOL* moveTool = m_toolMgr->GetTool<SCH_MOVE_TOOL>();

 wxASSERT_MSG( drawingTools, "eeshema.InteractiveDrawing tool is not available" );

 auto hasElements =
 [this]( const SELECTION& aSel )
 {
 return !m_frame->GetScreen()->Items().empty();
 };

 auto sheetHasUndefinedPins =
 []( const SELECTION& aSel )
 {
 if( aSel.Size() != 1 )
 return false;

 if( !aSel.HasType( SCH_SHEET_T ) )
 return false;

 SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( aSel.Front() );

 wxCHECK( item, false );

 SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( item );

 wxCHECK( sheet, false );

 return sheet->HasUndefinedPins();
 };

 auto anyTextTool =
 [this]( const SELECTION& aSel )
 {
 return ( m_frame->IsCurrentTool( EE_ACTIONS::placeLabel )
  || m_frame->IsCurrentTool( EE_ACTIONS::placeGlobalLabel )
 || m_frame->IsCurrentTool( EE_ACTIONS::placeHierLabel )
 || m_frame->IsCurrentTool( EE_ACTIONS::placeSchematicText ) );
 };

 auto duplicateCondition =
 []( const SELECTION& aSel )
 {
 if( SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus( aSel ) )
 return false;

 return true;
 };

 auto orientCondition =
 []( const SELECTION& aSel )
 {
 if( aSel.Empty() )
 return false;

 if( SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus( aSel ) )
 return false;

 if( aSel.GetSize() > 1 )
 return true;

 SCH_ITEM* item = (SCH_ITEM*) aSel.Front();

 switch( item->Type() )
 {
 case SCH_MARKER_T:
 case SCH_JUNCTION_T:
 case SCH_NO_CONNECT_T:
 case SCH_PIN_T:
 return false;
 case SCH_LINE_T:
 return item->GetLayer() != LAYER_WIRE && item->GetLayer() != LAYER_BUS;
 default:
 return true;
 }
 };

 auto propertiesCondition =
 [&]( const SELECTION& aSel )
 {
 if( aSel.GetSize() == 0 )
 {
 if( getView()->IsLayerVisible( LAYER_SCHEMATIC_DRAWINGSHEET ) )
 {
 DS_PROXY_VIEW_ITEM* ds = m_frame->GetCanvas()->GetView()->GetDrawingSheet();
 VECTOR2D cursor = getViewControls()->GetCursorPosition( false );

 if( ds && ds->HitTestDrawingSheetItems( getView(), (wxPoint) cursor ) )
 return true;
 }

 return false;
 }

 SCH_ITEM* firstItem = dynamic_cast<SCH_ITEM*>( aSel.Front() );
 const EE_SELECTION* eeSelection = dynamic_cast<const EE_SELECTION*>( &aSel );

 if( !firstItem || !eeSelection )
 return false;

 switch( firstItem->Type() )
 {
 case SCH_SYMBOL_T:
 case SCH_SHEET_T:
 case SCH_SHEET_PIN_T:
 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_FIELD_T:
 case SCH_BITMAP_T:
 return aSel.GetSize() == 1;

 case SCH_LINE_T:
 case SCH_BUS_WIRE_ENTRY_T:
 return eeSelection->AllItemsHaveLineStroke();

 case SCH_JUNCTION_T:
 return eeSelection->AreAllItemsIdentical();

 default:
 return false;
 }
 };

 auto autoplaceCondition =
 []( const SELECTION& aSel )
 {
 for( const EDA_ITEM* item : aSel )
 {
 if( item->IsType( EE_COLLECTOR::FieldOwners ) )
 return true;
 }

 return false;
 };

 static KICAD_T allLabelTypes[] = { SCH_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_TEXT_T, EOT };

 static KICAD_T toLabelTypes[] = { SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_TEXT_T, EOT };
 auto toLabelCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( toLabelTypes ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allLabelTypes ) );

 static KICAD_T toHLableTypes[] = { SCH_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_TEXT_T, EOT };
 auto toHLabelCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( toHLableTypes ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allLabelTypes ) );

 static KICAD_T toGLableTypes[] = { SCH_LABEL_T, SCH_HIER_LABEL_T, SCH_TEXT_T, EOT };
 auto toGLabelCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( toGLableTypes ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allLabelTypes ) );

 static KICAD_T toTextTypes[] = { SCH_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, EOT };
 auto toTextlCondition = ( E_C::Count( 1 ) && E_C::OnlyTypes( toTextTypes ) )
 || ( E_C::MoreThan( 1 ) && E_C::OnlyTypes( allLabelTypes ) );

 static KICAD_T entryTypes[] = { SCH_BUS_WIRE_ENTRY_T, SCH_BUS_BUS_ENTRY_T, EOT };
 auto entryCondition = E_C::MoreThan( 0 ) && E_C::OnlyTypes( entryTypes );

 auto singleSheetCondition = E_C::Count( 1 ) && E_C::OnlyType( SCH_SHEET_T );

 //
 // Add edit actions to the move tool menu
 //
 if( moveTool )
 {
 CONDITIONAL_MENU& moveMenu = moveTool->GetToolMenu().GetMenu();

 moveMenu.AddSeparator();
 moveMenu.AddItem( EE_ACTIONS::rotateCCW, orientCondition );
 moveMenu.AddItem( EE_ACTIONS::rotateCW, orientCondition );
 moveMenu.AddItem( EE_ACTIONS::mirrorV, orientCondition );
 moveMenu.AddItem( EE_ACTIONS::mirrorH, orientCondition );

 moveMenu.AddItem( EE_ACTIONS::properties, propertiesCondition );
 moveMenu.AddItem( EE_ACTIONS::editReference, E_C::SingleSymbol );
 moveMenu.AddItem( EE_ACTIONS::editValue, E_C::SingleSymbol );
 moveMenu.AddItem( EE_ACTIONS::editFootprint, E_C::SingleSymbol );
 moveMenu.AddItem( EE_ACTIONS::toggleDeMorgan, E_C::SingleDeMorganSymbol );

 std::shared_ptr<SYMBOL_UNIT_MENU> symUnitMenu = std::make_shared<SYMBOL_UNIT_MENU>();
 symUnitMenu->SetTool( this );
 m_menu.AddSubMenu( symUnitMenu );
 moveMenu.AddMenu( symUnitMenu.get(), E_C::SingleMultiUnitSymbol, 1 );

 moveMenu.AddSeparator();
 moveMenu.AddItem( ACTIONS::cut, E_C::IdleSelection );
 moveMenu.AddItem( ACTIONS::copy, E_C::IdleSelection );
 moveMenu.AddItem( ACTIONS::doDelete, E_C::NotEmpty );
 moveMenu.AddItem( ACTIONS::duplicate, duplicateCondition );

 moveMenu.AddSeparator();
 moveMenu.AddItem( ACTIONS::selectAll, hasElements );
 }

 //
 // Add editing actions to the drawing tool menu
 //
 CONDITIONAL_MENU& drawMenu = drawingTools->GetToolMenu().GetMenu();

 drawMenu.AddItem( EE_ACTIONS::rotateCCW, orientCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::rotateCW, orientCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::mirrorV, orientCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::mirrorH, orientCondition, 200 );

 drawMenu.AddItem( EE_ACTIONS::properties, propertiesCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::editReference, E_C::SingleSymbol, 200 );
 drawMenu.AddItem( EE_ACTIONS::editValue, E_C::SingleSymbol, 200 );
 drawMenu.AddItem( EE_ACTIONS::editFootprint, E_C::SingleSymbol, 200 );
 drawMenu.AddItem( EE_ACTIONS::autoplaceFields, autoplaceCondition, 200 );
 drawMenu.AddItem( EE_ACTIONS::toggleDeMorgan, E_C::SingleDeMorganSymbol, 200 );

 std::shared_ptr<SYMBOL_UNIT_MENU> symUnitMenu2 = std::make_shared<SYMBOL_UNIT_MENU>();
 symUnitMenu2->SetTool( drawingTools );
 drawingTools->GetToolMenu().AddSubMenu( symUnitMenu2 );
 drawMenu.AddMenu( symUnitMenu2.get(), E_C::SingleMultiUnitSymbol, 1 );

 drawMenu.AddItem( EE_ACTIONS::editWithLibEdit, E_C::SingleSymbolOrPower && E_C::Idle, 200 );

 drawMenu.AddItem( EE_ACTIONS::toLabel, anyTextTool && E_C::Idle, 200 );
 drawMenu.AddItem( EE_ACTIONS::toHLabel, anyTextTool && E_C::Idle, 200 );
 drawMenu.AddItem( EE_ACTIONS::toGLabel, anyTextTool && E_C::Idle, 200 );
 drawMenu.AddItem( EE_ACTIONS::toText, anyTextTool && E_C::Idle, 200 );

 //
 // Add editing actions to the selection tool menu
  //
 CONDITIONAL_MENU& selToolMenu = m_selectionTool->GetToolMenu().GetMenu();

 selToolMenu.AddItem( EE_ACTIONS::rotateCCW, orientCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::rotateCW, orientCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::mirrorV, orientCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::mirrorH, orientCondition, 200 );

 selToolMenu.AddItem( EE_ACTIONS::properties, propertiesCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::editReference, E_C::SingleSymbol, 200 );
 selToolMenu.AddItem( EE_ACTIONS::editValue, E_C::SingleSymbol, 200 );
 selToolMenu.AddItem( EE_ACTIONS::editFootprint, E_C::SingleSymbol, 200 );
 selToolMenu.AddItem( EE_ACTIONS::autoplaceFields, autoplaceCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::toggleDeMorgan, E_C::SingleSymbol, 200 );

 std::shared_ptr<SYMBOL_UNIT_MENU> symUnitMenu3 = std::make_shared<SYMBOL_UNIT_MENU>();
 symUnitMenu3->SetTool( m_selectionTool );
 m_selectionTool->GetToolMenu().AddSubMenu( symUnitMenu3 );
 selToolMenu.AddMenu( symUnitMenu3.get(), E_C::SingleMultiUnitSymbol, 1 );

 selToolMenu.AddItem( EE_ACTIONS::editWithLibEdit, E_C::SingleSymbolOrPower && E_C::Idle, 200 );
 selToolMenu.AddItem( EE_ACTIONS::changeSymbol, E_C::SingleSymbolOrPower, 200 );
 selToolMenu.AddItem( EE_ACTIONS::updateSymbol, E_C::SingleSymbolOrPower, 200 );

 selToolMenu.AddItem( EE_ACTIONS::toLabel, toLabelCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::toHLabel, toHLabelCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::toGLabel, toGLabelCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::toText, toTextlCondition, 200 );
 selToolMenu.AddItem( EE_ACTIONS::cleanupSheetPins, sheetHasUndefinedPins, 250 );

 selToolMenu.AddSeparator( 300 );
 selToolMenu.AddItem( ACTIONS::cut, E_C::IdleSelection, 300 );
 selToolMenu.AddItem( ACTIONS::copy, E_C::IdleSelection, 300 );
 selToolMenu.AddItem( ACTIONS::paste, E_C::Idle, 300 );
 selToolMenu.AddItem( ACTIONS::pasteSpecial, E_C::Idle, 300 );
 selToolMenu.AddItem( ACTIONS::doDelete, E_C::NotEmpty, 300 );
 selToolMenu.AddItem( ACTIONS::duplicate, duplicateCondition, 300 );

 selToolMenu.AddSeparator( 400 );
 selToolMenu.AddItem( ACTIONS::selectAll, hasElements, 400 );


 return true;
}


const KICAD_T rotatableItems[] = {
 SCH_TEXT_T,
 SCH_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_FIELD_T,
 SCH_SYMBOL_T,
 SCH_SHEET_PIN_T,
 SCH_SHEET_T,
 SCH_BITMAP_T,
 SCH_BUS_BUS_ENTRY_T,
 SCH_BUS_WIRE_ENTRY_T,
 SCH_LINE_T,
 SCH_JUNCTION_T,
 SCH_NO_CONNECT_T,
 EOT
};


int SCH_EDIT_TOOL::Rotate( const TOOL_EVENT& aEvent )
{
 bool clockwise = ( aEvent.Matches( EE_ACTIONS::rotateCW.MakeEvent() ) );
 EE_SELECTION& selection = m_selectionTool->RequestSelection( rotatableItems );

 if( selection.GetSize() == 0 )
 return 0;

 SCH_ITEM* head = nullptr;
 int principalItemCount = 0; // User-selected items (as opposed to connected wires)
 wxPoint rotPoint;
 bool moving = false;

 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );

 if( item->HasFlag( TEMP_SELECTED ) )
 continue;

 principalItemCount++;

 if( !head )
 head = item;
 }

 if( head && head->IsMoving() )
 moving = true;

 if( principalItemCount == 1 )
 {
 if( moving && selection.HasReferencePoint() )
 rotPoint = (wxPoint) selection.GetReferencePoint();
 else
 rotPoint = head->GetPosition();

 if( !moving )
 saveCopyInUndoList( head, UNDO_REDO::CHANGED );

 switch( head->Type() )
 {
 case SCH_SYMBOL_T:
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( head );

 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 symbol->Rotate( rotPoint );

 if( m_frame->eeconfig()->m_AutoplaceFields.enable )
 symbol->AutoAutoplaceFields( m_frame->GetScreen() );

 break;
 }

 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 {
 SCH_TEXT* textItem = static_cast<SCH_TEXT*>( head );
 textItem->Rotate90( clockwise );
 break;
 }

 case SCH_SHEET_PIN_T:
 {
 // Rotate pin within parent sheet
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( head );
 SCH_SHEET* sheet = pin->GetParent();

 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 pin->Rotate( sheet->GetBodyBoundingBox().GetCenter() );

 break;
 }

 case SCH_LINE_T:
 {
 SCH_LINE* line = static_cast<SCH_LINE*>( head );

 // Equal checks for both and neither. We need this because on undo
 // the item will have both flags cleared, but will be selected, so it is possible
 // for the user to get a selected line with neither endpoint selected. We
 // set flags to make sure Rotate() works when we call it.
 if( line->HasFlag( STARTPOINT ) == line->HasFlag( ENDPOINT ) )
 {
 line->SetFlags( STARTPOINT | ENDPOINT );
 // When we allow off grid items, the rotPoint should be set to the midpoint
 // of the line to allow rotation around the center, and the next if
 // should become an else-if
 }

 if( line->HasFlag( STARTPOINT ) )
 rotPoint = line->GetEndPoint();
 else if( line->HasFlag( ENDPOINT ) )
 rotPoint = line->GetStartPoint();
 }

 KI_FALLTHROUGH;
 case SCH_BUS_BUS_ENTRY_T:
 case SCH_BUS_WIRE_ENTRY_T:
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 head->Rotate( rotPoint );

 break;

 case SCH_FIELD_T:
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( head );

 if( field->GetTextAngle() == TEXT_ANGLE_HORIZ )
 field->SetTextAngle( TEXT_ANGLE_VERT );
 else
 field->SetTextAngle( TEXT_ANGLE_HORIZ );

 // Now that we're moving a field, they're no longer autoplaced.
 static_cast<SCH_ITEM*>( head->GetParent() )->ClearFieldsAutoplaced();

 break;
 }

 case SCH_BITMAP_T:
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 head->Rotate( rotPoint );

 // The bitmap is cached in Opengl: clear the cache to redraw
 getView()->RecacheAllItems();
 break;

 case SCH_SHEET_T:
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( head );
 rotPoint = m_frame->GetNearestHalfGridPosition( sheet->GetRotationCenter() );

 // Rotate the sheet on itself. Sheets do not have an anchor point.
 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 sheet->Rotate( rotPoint );

 break;
 }

 default:
 break;
 }

 m_frame->UpdateItem( head, false, true );
 }
 else
 {
 if( moving && selection.HasReferencePoint() )
 rotPoint = (wxPoint) selection.GetReferencePoint();
 else
 rotPoint = m_frame->GetNearestHalfGridPosition( (wxPoint) selection.GetCenter() );
 }

 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );

 // We've already rotated the user selected item if there was only one. We're just
 // here to rotate the ends of wires that were attached to it.
 if( principalItemCount == 1 && !item->HasFlag( TEMP_SELECTED ) )
 continue;

 if( !moving )
 saveCopyInUndoList( item, UNDO_REDO::CHANGED, ii > 0 );

 for( int i = 0; clockwise ? i < 3 : i < 1; ++i )
 {
 if( item->Type() == SCH_LINE_T )
 {
 SCH_LINE* line = (SCH_LINE*) item;

 // If we are rotating more than one item, we do not have start/end
 // points separately selected
 if( item->HasFlag( STARTPOINT ) )
 line->RotateStart( rotPoint );

 if( item->HasFlag( ENDPOINT ) )
 line->RotateEnd( rotPoint );
 }
 else if( item->Type() == SCH_SHEET_PIN_T )
 {
 if( item->GetParent()->IsSelected() )
 {
 // parent will rotate us
 }
 else
 {
 // rotate within parent
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( item );
 SCH_SHEET* sheet = pin->GetParent();

 pin->Rotate( sheet->GetBodyBoundingBox().GetCenter() );
 }
 }
 else if( item->Type() == SCH_FIELD_T )
 {
 if( item->GetParent()->IsSelected() )
 {
 // parent will rotate us
 }
 else
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );

 field->Rotate( rotPoint );

 if( field->GetTextAngle() == TEXT_ANGLE_HORIZ )
 field->SetTextAngle( TEXT_ANGLE_VERT );
 else
 field->SetTextAngle( TEXT_ANGLE_HORIZ );

 // Now that we're moving a field, they're no longer autoplaced.
 static_cast<SCH_ITEM*>( field->GetParent() )->ClearFieldsAutoplaced();
 }
 }
 else
 {
 item->Rotate( rotPoint );
 }
 }

 m_frame->UpdateItem( item, false, true );
 updateItem( item, true );
 }

 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );

 if( moving )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 EE_SELECTION selectionCopy = selection;
 m_toolMgr->RunAction( EE_ACTIONS::trimOverlappingWires, true, &selectionCopy );
 m_toolMgr->RunAction( EE_ACTIONS::addNeededJunctions, true, &selectionCopy );

 m_frame->RecalculateConnections( LOCAL_CLEANUP );
 m_frame->TestDanglingEnds();

 m_frame->OnModify();
 }

 return 0;
}


int SCH_EDIT_TOOL::Mirror( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( rotatableItems );

 if( selection.GetSize() == 0 )
 return 0;

 wxPoint mirrorPoint;
 bool vertical = ( aEvent.Matches( EE_ACTIONS::mirrorV.MakeEvent() ) );
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.Front() );
 bool connections = false;
 bool moving = item->IsMoving();

 if( selection.GetSize() == 1 )
 {
 if( !moving )
 saveCopyInUndoList( item, UNDO_REDO::CHANGED );

 switch( item->Type() )
 {
 case SCH_SYMBOL_T:
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );

 if( vertical )
 symbol->SetOrientation( SYM_MIRROR_X );
 else
 symbol->SetOrientation( SYM_MIRROR_Y );

 if( m_frame->eeconfig()->m_AutoplaceFields.enable )
 symbol->AutoAutoplaceFields( m_frame->GetScreen() );

 break;
 }

 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 {
 SCH_TEXT* textItem = static_cast<SCH_TEXT*>( item );
 textItem->MirrorSpinStyle( !vertical );
 break;
 }

 case SCH_SHEET_PIN_T:
 {
 // mirror within parent sheet
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( item );
 SCH_SHEET* sheet = pin->GetParent();

 if( vertical )
 pin->MirrorVertically( sheet->GetBoundingBox().GetCenter().y );
 else
 pin->MirrorHorizontally( sheet->GetBoundingBox().GetCenter().x );

 break;
 }

 case SCH_BUS_BUS_ENTRY_T:
 case SCH_BUS_WIRE_ENTRY_T:
 if( vertical )
 item->MirrorVertically( item->GetPosition().y );
 else
 item->MirrorHorizontally( item->GetPosition().x );
 break;

 case SCH_FIELD_T:
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );

 if( vertical )
 field->SetVertJustify( (EDA_TEXT_VJUSTIFY_T)-field->GetVertJustify() );
 else
 field->SetHorizJustify( (EDA_TEXT_HJUSTIFY_T)-field->GetHorizJustify() );

 // Now that we're re-justifying a field, they're no longer autoplaced.
 static_cast<SCH_ITEM*>( item->GetParent() )->ClearFieldsAutoplaced();

 break;
 }

 case SCH_BITMAP_T:
 if( vertical )
 item->MirrorVertically( item->GetPosition().y );
 else
 item->MirrorHorizontally( item->GetPosition().x );

 // The bitmap is cached in Opengl: clear the cache to redraw
 getView()->RecacheAllItems();
 break;

 case SCH_SHEET_T:
 // Mirror the sheet on itself. Sheets do not have a anchor point.
 mirrorPoint = m_frame->GetNearestHalfGridPosition( item->GetBoundingBox().Centre() );

 if( vertical )
 item->MirrorVertically( mirrorPoint.y );
 else
 item->MirrorHorizontally( mirrorPoint.x );

 break;

 default:
 break;
 }

 connections = item->IsConnectable();
 m_frame->UpdateItem( item, false, true );
 }
 else if( selection.GetSize() > 1 )
 {
 mirrorPoint = m_frame->GetNearestHalfGridPosition( (wxPoint)selection.GetCenter() );

 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );

 if( !moving )
 saveCopyInUndoList( item, UNDO_REDO::CHANGED, ii > 0 );

 if( item->Type() == SCH_SHEET_PIN_T )
 {
 if( item->GetParent()->IsSelected() )
 {
 // parent will mirror us
 }
 else
 {
 // mirror within parent sheet
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( item );
 SCH_SHEET* sheet = pin->GetParent();

 if( vertical )
 pin->MirrorVertically( sheet->GetBoundingBox().GetCenter().y );
 else
 pin->MirrorHorizontally( sheet->GetBoundingBox().GetCenter().x );
 }
 }
 else
 {
 if( vertical )
 item->MirrorVertically( mirrorPoint.y );
 else
 item->MirrorHorizontally( mirrorPoint.x );
 }

 connections |= item->IsConnectable();
 m_frame->UpdateItem( item, false, true );
 }
 }

 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );

 // Update R-Tree for modified items
 for( EDA_ITEM* selected : selection )
 updateItem( selected, true );

 if( item->IsMoving() )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 if( connections )
 m_frame->TestDanglingEnds();

 m_frame->OnModify();
 }

 return 0;
}


int SCH_EDIT_TOOL::RepeatDrawItem( const TOOL_EVENT& aEvent )
{
 SCH_ITEM* sourceItem = m_frame->GetRepeatItem();

 if( !sourceItem )
 return 0;

 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 SCH_ITEM* newItem = sourceItem->Duplicate();
 bool performDrag = false;

 // If cloning a symbol then put into 'move' mode.
 if( newItem->Type() == SCH_SYMBOL_T )
 {
 wxPoint cursorPos = (wxPoint) getViewControls()->GetCursorPosition( true );
 newItem->Move( cursorPos - newItem->GetPosition() );
 performDrag = true;
 }
 else
 {
 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();

 if( dynamic_cast<SCH_TEXT*>( newItem ) )
 {
 SCH_TEXT* text = static_cast<SCH_TEXT*>( newItem );

 // If incrementing tries to go below zero, tell user why the value is repeated

 if( !text->IncrementLabel( cfg->m_Drawing.repeat_label_increment ) )
 m_frame->ShowInfoBarWarning( _( "Label value cannot go below zero" ), true );
 }

 newItem->Move( wxPoint( Mils2iu( cfg->m_Drawing.default_repeat_offset_x ),
 Mils2iu( cfg->m_Drawing.default_repeat_offset_y ) ) );
 }

 m_toolMgr->RunAction( EE_ACTIONS::addItemToSel, true, newItem );
 newItem->SetFlags( IS_NEW );
 m_frame->AddToScreen( newItem, m_frame->GetScreen() );
 m_frame->SaveCopyInUndoList( m_frame->GetScreen(), newItem, UNDO_REDO::NEWITEM, false );

 // Symbols need to be handled by the move tool. The move tool will handle schematic
 // cleanup routines
 if( performDrag )
 m_toolMgr->RunAction( EE_ACTIONS::move, true );

 newItem->ClearFlags();

 if( !performDrag && newItem->IsConnectable() )
 {
 EE_SELECTION new_sel;
 new_sel.Add( newItem );

 m_toolMgr->RunAction( EE_ACTIONS::trimOverlappingWires, true, &new_sel );
 m_toolMgr->RunAction( EE_ACTIONS::addNeededJunctions, true, &new_sel );

 m_frame->RecalculateConnections( LOCAL_CLEANUP );
 m_frame->TestDanglingEnds();
 }

 m_frame->GetCanvas()->Refresh();
 m_frame->OnModify();

 // Save newItem at the new position.
 m_frame->SaveCopyForRepeatItem( newItem );

 return 0;
}


static KICAD_T deletableItems[] =
{
 SCH_MARKER_T,
 SCH_JUNCTION_T,
 SCH_LINE_T,
 SCH_BUS_BUS_ENTRY_T,
 SCH_BUS_WIRE_ENTRY_T,
 SCH_TEXT_T,
 SCH_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_NO_CONNECT_T,
 SCH_SHEET_T,
 SCH_SHEET_PIN_T,
 SCH_SYMBOL_T,
 SCH_BITMAP_T,
 EOT
};


int SCH_EDIT_TOOL::DoDelete( const TOOL_EVENT& aEvent )
{
 SCH_SCREEN* screen = m_frame->GetScreen();
 auto items = m_selectionTool->RequestSelection( deletableItems ).GetItems();
 bool appendToUndo = false;
 std::vector<wxPoint> pts;

 if( items.empty() )
 return 0;

 // Don't leave a freed pointer in the selection
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 for( EDA_ITEM* item : items )
 item->ClearFlags( STRUCT_DELETED );

 for( EDA_ITEM* item : items )
 {
 SCH_ITEM* sch_item = dynamic_cast<SCH_ITEM*>( item );

 if( !sch_item )
 continue;

 if( sch_item->IsConnectable() )
 {
 std::vector<wxPoint> tmp_pts = sch_item->GetConnectionPoints();
 pts.insert( pts.end(), tmp_pts.begin(), tmp_pts.end() );
 }

 if( sch_item->Type() == SCH_JUNCTION_T )
 {
 sch_item->SetFlags( STRUCT_DELETED );
 // clean up junctions at the end
 }
 else if( sch_item->Type() == SCH_SHEET_PIN_T )
 {
 SCH_SHEET_PIN* pin = (SCH_SHEET_PIN*) sch_item;
 SCH_SHEET* sheet = pin->GetParent();

 if( !alg::contains( items, sheet ) )
 {
 pin->SetFlags( STRUCT_DELETED );
 saveCopyInUndoList( item, UNDO_REDO::DELETED, appendToUndo );
 appendToUndo = true;

 updateItem( pin, false );

 sheet->RemovePin( pin );
 }
 }
 else
 {
 sch_item->SetFlags( STRUCT_DELETED );
 saveCopyInUndoList( item, UNDO_REDO::DELETED, appendToUndo );
 appendToUndo = true;

 updateItem( sch_item, false );

 m_frame->RemoveFromScreen( sch_item, m_frame->GetScreen() );

 if( sch_item->Type() == SCH_SHEET_T )
 m_frame->UpdateHierarchyNavigator();
 }
 }

 for( const wxPoint& point : pts )
 {
 SCH_ITEM* junction = screen->GetItem( point, 0, SCH_JUNCTION_T );

 if( !junction )
 continue;

 if( junction->HasFlag( STRUCT_DELETED ) || !screen->IsExplicitJunction( point ) )
 m_frame->DeleteJunction( junction, appendToUndo );
 }

 m_frame->TestDanglingEnds();

 m_frame->GetCanvas()->Refresh();
 m_frame->OnModify();

 return 0;
}


#define HITTEST_THRESHOLD_PIXELS 5


int SCH_EDIT_TOOL::DeleteItemCursor( const TOOL_EVENT& aEvent )
{
 std::string tool = aEvent.GetCommandStr().get();
 PICKER_TOOL* picker = m_toolMgr->GetTool<PICKER_TOOL>();

 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );
 m_pickerItem = nullptr;

 // Deactivate other tools; particularly important if another PICKER is currently running
 Activate();

 picker->SetCursor( KICURSOR::REMOVE );
 picker->SetSnapping( false );

 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, true );
 m_pickerItem = nullptr;
 }

 return true;
 } );

 picker->SetMotionHandler(
 [this]( const VECTOR2D& aPos )
 {
 EE_COLLECTOR collector;
 collector.m_Threshold = KiROUND( getView()->ToWorld( HITTEST_THRESHOLD_PIXELS ) );
 collector.Collect( m_frame->GetScreen(), deletableItems, (wxPoint) aPos );

 EE_SELECTION_TOOL* selectionTool = m_toolMgr->GetTool<EE_SELECTION_TOOL>();
 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->RunAction( EE_ACTIONS::selectionActivate, false );
 } );

 m_toolMgr->RunAction( ACTIONS::pickerTool, true, &tool );

 return 0;
}


void SCH_EDIT_TOOL::editFieldText( SCH_FIELD* aField )
{
 // Save old symbol in undo list if not already in edit, or moving.
 if( aField->GetEditFlags() == 0 ) // i.e. not edited, or moved
 saveCopyInUndoList( aField, UNDO_REDO::CHANGED );

 KICAD_T parentType = aField->GetParent() ? aField->GetParent()->Type() : SCHEMATIC_T;
 wxString caption;

 // Use title caps for mandatory fields. "Edit Sheet name Field" looks dorky.
 if( parentType == SCH_SYMBOL_T && aField->GetId() < MANDATORY_FIELDS )
 caption.Printf( _( "Edit %s Field" ), TitleCaps( aField->GetName() ) );
 else if( parentType == SCH_SHEET_T && aField->GetId() < SHEET_MANDATORY_FIELDS )
 caption.Printf( _( "Edit %s Field" ), TitleCaps( aField->GetName() ) );
 else
 caption.Printf( _( "Edit '%s' Field" ), aField->GetName() );

 DIALOG_SCH_FIELD_PROPERTIES dlg( m_frame, caption, aField );

 // The footprint field dialog can invoke a KIWAY_PLAYER so we must use a quasi-modal
 if( dlg.ShowQuasiModal() != wxID_OK )
 return;

 dlg.UpdateField( aField, &m_frame->GetCurrentSheet() );

 if( m_frame->eeconfig()->m_AutoplaceFields.enable || parentType == SCH_SHEET_T )
 static_cast<SCH_ITEM*>( aField->GetParent() )->AutoAutoplaceFields( m_frame->GetScreen() );

 m_frame->UpdateItem( aField, false, true );
 m_frame->OnModify();

 // This must go after OnModify() so that the connectivity graph will have been updated.
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
}


int SCH_EDIT_TOOL::EditField( const TOOL_EVENT& aEvent )
{
 static KICAD_T Nothing[] = { EOT };
 static KICAD_T CmpOrReference[] = { SCH_FIELD_LOCATE_REFERENCE_T, SCH_SYMBOL_T, EOT };
 static KICAD_T CmpOrValue[] = { SCH_FIELD_LOCATE_VALUE_T, SCH_SYMBOL_T, EOT };
 static KICAD_T CmpOrFootprint[] = { SCH_FIELD_LOCATE_FOOTPRINT_T, SCH_SYMBOL_T, EOT };

 KICAD_T* filter = Nothing;

 if( aEvent.IsAction( &EE_ACTIONS::editReference ) )
 filter = CmpOrReference;
 else if( aEvent.IsAction( &EE_ACTIONS::editValue ) )
 filter = CmpOrValue;
 else if( aEvent.IsAction( &EE_ACTIONS::editFootprint ) )
 filter = CmpOrFootprint;

 EE_SELECTION& selection = m_selectionTool->RequestSelection( filter );

 if( selection.Size() != 1 )
 return 0;

 bool clearSelection = selection.IsHover();
 EDA_ITEM* item = selection.Front();

 if( item->Type() == SCH_SYMBOL_T )
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );

 if( aEvent.IsAction( &EE_ACTIONS::editReference ) )
 editFieldText( symbol->GetField( REFERENCE_FIELD ) );
 else if( aEvent.IsAction( &EE_ACTIONS::editValue ) )
 editFieldText( symbol->GetField( VALUE_FIELD ) );
 else if( aEvent.IsAction( &EE_ACTIONS::editFootprint ) )
 editFieldText( symbol->GetField( FOOTPRINT_FIELD ) );
 }
 else if( item->Type() == SCH_FIELD_T )
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );

 editFieldText( field );

 if( !field->IsVisible() )
 clearSelection = true;
 }

 if( clearSelection )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 return 0;
}


int SCH_EDIT_TOOL::AutoplaceFields( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( rotatableItems );
 SCH_ITEM* head = static_cast<SCH_ITEM*>( selection.Front() );
 bool moving = head && head->IsMoving();

 if( selection.Empty() )
 return 0;

 std::vector<SCH_ITEM*> autoplaceItems;

 for( unsigned ii = 0; ii < selection.GetSize(); ii++ )
 {
 SCH_ITEM* item = static_cast<SCH_ITEM*>( selection.GetItem( ii ) );

 if( item->IsType( EE_COLLECTOR::FieldOwners ) )
 autoplaceItems.push_back( item );
 else if( item->GetParent() && item->GetParent()->IsType( EE_COLLECTOR::FieldOwners ) )
 autoplaceItems.push_back( static_cast<SCH_ITEM*>( item->GetParent() ) );
 }

 bool appendUndo = false;

 for( SCH_ITEM* sch_item : autoplaceItems )
 {
 if( !moving && !sch_item->IsNew() )
 {
 saveCopyInUndoList( sch_item, UNDO_REDO::CHANGED, appendUndo );
 appendUndo = true;
 }

 sch_item->AutoplaceFields( m_frame->GetScreen(), /* aManual */ true );

 updateItem( sch_item, true );
 }

 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );

 if( moving )
 {
 m_toolMgr->RunAction( ACTIONS::refreshPreview );
 }
 else
 {
 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 m_frame->OnModify();
 }

 return 0;
}


int SCH_EDIT_TOOL::ChangeSymbols( const TOOL_EVENT& aEvent )
{
 SCH_SYMBOL* selectedSymbol = nullptr;
 EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::SymbolsOnly );

 if( !selection.Empty() )
 selectedSymbol = dynamic_cast<SCH_SYMBOL*>( selection.Front() );

 DIALOG_CHANGE_SYMBOLS::MODE mode = DIALOG_CHANGE_SYMBOLS::MODE::UPDATE;

 if( aEvent.IsAction( &EE_ACTIONS::changeSymbol )
 || aEvent.IsAction( &EE_ACTIONS::changeSymbols ) )
 {
 mode = DIALOG_CHANGE_SYMBOLS::MODE::CHANGE;
 }

 DIALOG_CHANGE_SYMBOLS dlg( m_frame, selectedSymbol, mode );

 dlg.ShowQuasiModal();

 return 0;
}


int SCH_EDIT_TOOL::ConvertDeMorgan( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::SymbolsOnly );

 if( selection.Empty() )
 return 0;

 SCH_SYMBOL* symbol = (SCH_SYMBOL*) selection.Front();

 if( aEvent.IsAction( &EE_ACTIONS::showDeMorganStandard )
 && symbol->GetConvert() == LIB_ITEM::LIB_CONVERT::BASE )
 {
 return 0;
 }

 if( aEvent.IsAction( &EE_ACTIONS::showDeMorganAlternate )
 && symbol->GetConvert() != LIB_ITEM::LIB_CONVERT::DEMORGAN )
 {
 return 0;
 }

 if( !symbol->IsNew() )
 saveCopyInUndoList( symbol, UNDO_REDO::CHANGED );

 m_frame->ConvertPart( symbol );

 if( symbol->IsNew() )
 m_toolMgr->RunAction( ACTIONS::refreshPreview );

 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 return 0;
}


int SCH_EDIT_TOOL::Properties( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::EditableItems );
 bool clearSelection = selection.IsHover();

 if( selection.Empty() )
 {
 if( getView()->IsLayerVisible( LAYER_SCHEMATIC_DRAWINGSHEET ) )
 {
 DS_PROXY_VIEW_ITEM* ds = m_frame->GetCanvas()->GetView()->GetDrawingSheet();
 VECTOR2D cursorPos = getViewControls()->GetCursorPosition( false );

 if( ds && ds->HitTestDrawingSheetItems( getView(), (wxPoint) cursorPos ) )
 m_toolMgr->RunAction( ACTIONS::pageSettings );
 }

 return 0;
 }

 EDA_ITEM* item = selection.Front();

 switch( item->Type() )
 {
 case SCH_LINE_T:
 case SCH_BUS_WIRE_ENTRY_T:
 if( !selection.AllItemsHaveLineStroke() )
 return 0;

 break;

 case SCH_JUNCTION_T:
 if( !selection.AreAllItemsIdentical() )
 return 0;

 break;

 default:
 if( selection.Size() > 1 )
 return 0;

 break;
 }

 auto doTextAndLabelProps =
 [&]( SCH_TEXT* aText )
 {
 DIALOG_TEXT_AND_LABEL_PROPERTIES dlg( m_frame, aText );

 // Must be quasi modal for syntax help
 if( dlg.ShowQuasiModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 };

 switch( item->Type() )
 {
 case SCH_SYMBOL_T:
 {
 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 DIALOG_SYMBOL_PROPERTIES symbolPropsDialog( 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.
 int retval = symbolPropsDialog.ShowQuasiModal();

 if( retval == SYMBOL_PROPS_EDIT_OK )
 {
 if( m_frame->eeconfig()->m_AutoplaceFields.enable )
 symbol->AutoAutoplaceFields( m_frame->GetScreen() );

 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 else if( retval == SYMBOL_PROPS_EDIT_SCHEMATIC_SYMBOL )
 {
 auto editor = (SYMBOL_EDIT_FRAME*) m_frame->Kiway().Player( FRAME_SCH_SYMBOL_EDITOR,
 true );

 editor->LoadSymbolFromSchematic( symbol );

 editor->Show( true );
 editor->Raise();
 }
 else if( retval == SYMBOL_PROPS_EDIT_LIBRARY_SYMBOL )
 {
 auto editor = (SYMBOL_EDIT_FRAME*) m_frame->Kiway().Player( FRAME_SCH_SYMBOL_EDITOR,
 true );

 editor->LoadSymbol( symbol->GetLibId(), symbol->GetUnit(), symbol->GetConvert() );

 editor->Show( true );
 editor->Raise();
 }
 else if( retval == SYMBOL_PROPS_WANT_UPDATE_SYMBOL )
 {
 DIALOG_CHANGE_SYMBOLS dlg( m_frame, symbol, DIALOG_CHANGE_SYMBOLS::MODE::UPDATE );
 dlg.ShowQuasiModal();
 }
 else if( retval == SYMBOL_PROPS_WANT_EXCHANGE_SYMBOL )
 {
 DIALOG_CHANGE_SYMBOLS dlg( m_frame, symbol, DIALOG_CHANGE_SYMBOLS::MODE::CHANGE );
 dlg.ShowQuasiModal();
 }
 }
 break;

 case SCH_SHEET_T:
 {
 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( item );
 bool doClearAnnotation;
 bool doRefresh = false;

 // Keep track of existing sheet paths. EditSheet() can modify this list.
 // Note that we use the validity checking/repairing version here just to make sure
 // we've got a valid hierarchy to begin with.
 SCH_SHEET_LIST initial_sheetpathList( &m_frame->Schematic().Root(), true );

 doRefresh = m_frame->EditSheetProperties( sheet, &m_frame->GetCurrentSheet(),
 &doClearAnnotation );

 // If the sheet file is changed and new sheet contents are loaded then we have to
 // clear the annotations on the new content (as it may have been set from some other
 // sheet path reference)
 if( doClearAnnotation )
 {
 SCH_SCREENS screensList( &m_frame->Schematic().Root() );
 // We clear annotation of new sheet paths here:
 screensList.ClearAnnotationOfNewSheetPaths( initial_sheetpathList );
 // Clear annotation of g_CurrentSheet itself, because its sheetpath is not a new
 // path, but symbols managed by its sheet path must have their annotation cleared
 // because they are new:
 sheet->GetScreen()->ClearAnnotation( &m_frame->GetCurrentSheet() );
 }

 if( doRefresh )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->GetCanvas()->Refresh();
 m_frame->UpdateHierarchyNavigator();
 }

 break;
 }

 case SCH_SHEET_PIN_T:
 {
 SCH_SHEET_PIN* pin = static_cast<SCH_SHEET_PIN*>( item );
 DIALOG_SHEET_PIN_PROPERTIES dlg( m_frame, pin );

 // QuasiModal required for help dialog
 if( dlg.ShowQuasiModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;

 case SCH_TEXT_T:
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 doTextAndLabelProps( static_cast<SCH_TEXT*>( item ) );
 break;

 case SCH_FIELD_T:
 {
 SCH_FIELD* field = static_cast<SCH_FIELD*>( item );
 EDA_ITEM* parent = field->GetParent();

 if( parent->Type() == SCH_GLOBAL_LABEL_T )
 doTextAndLabelProps( static_cast<SCH_TEXT*>( parent ) );
 else
 editFieldText( field );

 if( !field->IsVisible() )
 clearSelection = true;
 }
 break;

 case SCH_BITMAP_T:
 {
 SCH_BITMAP* bitmap = static_cast<SCH_BITMAP*>( item );
 DIALOG_IMAGE_EDITOR dlg( m_frame, bitmap->GetImage() );

 if( dlg.ShowModal() == wxID_OK )
 {
 // save old image in undo list if not already in edit
 if( bitmap->GetEditFlags() == 0 )
 saveCopyInUndoList( bitmap, UNDO_REDO::CHANGED );

 dlg.TransferToImage( bitmap->GetImage() );

 // The bitmap is cached in Opengl: clear the cache in case it has become invalid
 getView()->RecacheAllItems();
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;

 case SCH_LINE_T:
 case SCH_BUS_WIRE_ENTRY_T:
 {
 std::deque<SCH_ITEM*> strokeItems;

 for( EDA_ITEM* selItem : selection.Items() )
 {
 SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( selItem );

 if( schItem && schItem->HasLineStroke() )
 strokeItems.push_back( schItem );
 else
 return 0;
 }

 DIALOG_LINE_WIRE_BUS_PROPERTIES dlg( m_frame, strokeItems );

 if( dlg.ShowModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;

 case SCH_JUNCTION_T:
 {
 std::deque<SCH_JUNCTION*> junctions;

 for( EDA_ITEM* selItem : selection.Items() )
 {
 SCH_JUNCTION* junction = dynamic_cast<SCH_JUNCTION*>( selItem );

 wxCHECK( junction, 0 );

 junctions.push_back( junction );
 }

 DIALOG_JUNCTION_PROPS dlg( m_frame, junctions );

 if( dlg.ShowModal() == wxID_OK )
 {
 m_toolMgr->PostEvent( EVENTS::SelectedItemsModified );
 m_frame->OnModify();
 }
 }
 break;

 case SCH_MARKER_T: // These items have no properties to edit
 case SCH_NO_CONNECT_T:
 break;

 default: // Unexpected item
 wxFAIL_MSG( wxString( wxT( "Cannot edit schematic item type " ) ) + item->GetClass() );
 }

 updateItem( item, true );

 if( clearSelection )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 return 0;
}


int SCH_EDIT_TOOL::ChangeTextType( const TOOL_EVENT& aEvent )
{
 KICAD_T convertTo = aEvent.Parameter<KICAD_T>();
 KICAD_T allTextTypes[] = { SCH_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_TEXT_T, EOT };
 EE_SELECTION selection = m_selectionTool->RequestSelection( allTextTypes );

 for( unsigned int i = 0; i < selection.GetSize(); ++i )
 {
 SCH_TEXT* text = dynamic_cast<SCH_TEXT*>( selection.GetItem( i ) );

 if( text && text->Type() != convertTo )
 {
 bool selected = text->IsSelected();
 SCH_TEXT* newtext = nullptr;
 const wxPoint& position = text->GetPosition();
 LABEL_SPIN_STYLE orientation = text->GetLabelSpinStyle();
 wxString txt = UnescapeString( text->GetText() );

 // There can be characters in a SCH_TEXT object that can break labels so we have to
 // fix them here.
 if( text->Type() == SCH_TEXT_T )
 {
 txt.Replace( wxT( "\n" ), wxT( "_" ) );
 txt.Replace( wxT( "\r" ), wxT( "_" ) );
 txt.Replace( wxT( "\t" ), wxT( "_" ) );
 txt.Replace( wxT( " " ), wxT( "_" ) );
 }

 // label strings are "escaped" i.e. a '/' is replaced by "{slash}"
 if( convertTo != SCH_TEXT_T )
 txt = EscapeString( txt, CTX_NETNAME );

 switch( convertTo )
 {
 case SCH_LABEL_T: newtext = new SCH_LABEL( position, txt ); break;
 case SCH_GLOBAL_LABEL_T: newtext = new SCH_GLOBALLABEL( position, txt ); break;
 case SCH_HIER_LABEL_T: newtext = new SCH_HIERLABEL( position, txt ); break;
 case SCH_TEXT_T: newtext = new SCH_TEXT( position, txt ); break;

 default:
 wxFAIL_MSG( wxString::Format( wxT( "Invalid text type: %d." ), convertTo ) );
 return 0;
 }

 // Copy the old text item settings to the new one. Justifications are not copied
 // because they are not used in labels. Justifications will be set to default value
 // in the new text item type.
 //
 newtext->SetFlags( text->GetEditFlags() );
 newtext->SetShape( text->GetShape() );
 newtext->SetLabelSpinStyle( orientation );
 newtext->SetTextSize( text->GetTextSize() );
 newtext->SetTextThickness( text->GetTextThickness() );
 newtext->SetItalic( text->IsItalic() );
 newtext->SetBold( text->IsBold() );
 newtext->SetIsDangling( text->IsDangling() );

 if( selected )
 m_toolMgr->RunAction( EE_ACTIONS::removeItemFromSel, true, text );

 if( !text->IsNew() )
  {
 saveCopyInUndoList( text, UNDO_REDO::DELETED, i != 0 );
 saveCopyInUndoList( newtext, UNDO_REDO::NEWITEM, true );

 m_frame->RemoveFromScreen( text, m_frame->GetScreen() );
 m_frame->AddToScreen( newtext, m_frame->GetScreen() );

 if( convertTo == SCH_GLOBAL_LABEL_T )
 static_cast<SCH_GLOBALLABEL*>( newtext )->UpdateIntersheetRefProps();
 }

 if( selected )
 m_toolMgr->RunAction( EE_ACTIONS::addItemToSel, true, newtext );

 // Otherwise, pointer is owned by the undo stack
 if( text->IsNew() )
 delete text;

 if( convertTo == SCH_TEXT_T )
 {
 if( newtext->IsDangling() )
 {
 newtext->SetIsDangling( false );
 getView()->Update( newtext, KIGFX::REPAINT );
 }
 }
 else
 {
 m_frame->TestDanglingEnds();
 }

 m_frame->OnModify();
 }
 }

 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 return 0;
}


int SCH_EDIT_TOOL::BreakWire( const TOOL_EVENT& aEvent )
{
 wxPoint cursorPos = (wxPoint) getViewControls()->GetCursorPosition( !aEvent.DisableGridSnapping() );
 EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::WiresOnly );

 std::vector<SCH_LINE*> lines;

 for( EDA_ITEM* item : selection )
 {
 if( SCH_LINE* line = dyn_cast<SCH_LINE*>( item ) )
 {
 if( !line->IsEndPoint( cursorPos ) )
 lines.push_back( line );
 }
 }

 m_selectionTool->ClearSelection();
 m_frame->StartNewUndo();

 for( SCH_LINE* line : lines )
 m_frame->BreakSegment( line, cursorPos );

 if( !lines.empty() )
 {
 if( m_frame->GetScreen()->IsExplicitJunctionNeeded( cursorPos ) )
 m_frame->AddJunction( m_frame->GetScreen(), cursorPos, true, false );

 m_frame->TestDanglingEnds();

 m_frame->OnModify();
 m_frame->GetCanvas()->Refresh();

 SCH_MOVE_TOOL_PARAMS params;

 params.appendToLastUndo = true;
 params.placingNewItems = false;

 m_toolMgr->RunAction( EE_ACTIONS::drag, true, &params );
 }

 return 0;
}


int SCH_EDIT_TOOL::CleanupSheetPins( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::SheetsOnly );
 SCH_SHEET* sheet = (SCH_SHEET*) selection.Front();

 if( !sheet || !sheet->HasUndefinedPins() )
 return 0;

 if( !IsOK( m_frame, _( "Do you wish to delete the unreferenced pins from this sheet?" ) ) )
 return 0;

 saveCopyInUndoList( sheet, UNDO_REDO::CHANGED );

 sheet->CleanupSheet();

 updateItem( sheet, true );
 m_frame->OnModify();

 if( selection.IsHover() )
 m_toolMgr->RunAction( EE_ACTIONS::clearSelection, true );

 return 0;
}


int SCH_EDIT_TOOL::EditPageNumber( const TOOL_EVENT& aEvent )
{
 EE_SELECTION& selection = m_selectionTool->RequestSelection( EE_COLLECTOR::SheetsOnly );

 if( selection.GetSize() > 1 )
 return 0;

 SCH_SHEET* sheet = (SCH_SHEET*) selection.Front();

 SCH_SHEET_PATH instance = m_frame->GetCurrentSheet();

 SCH_SCREEN* screen;

 if( sheet )
 {
 // When changing the page number of a selected sheet, the current screen owns the sheet.
 screen = m_frame->GetScreen();

 instance.push_back( sheet );
 }
 else
 {
 SCH_SHEET_PATH prevInstance = instance;

 // When change the page number in the screen, the previous screen owns the sheet.
 if( prevInstance.size() )
 {
 prevInstance.pop_back();
 screen = prevInstance.LastScreen();
 }
 else
 {
 // The root sheet and root screen are effectively the same thing.
 screen = m_frame->GetScreen();
 }

 sheet = m_frame->GetCurrentSheet().Last();
 }

 wxString msg;
 wxString sheetPath = instance.PathHumanReadable( false );
 wxString pageNumber = instance.GetPageNumber();

 msg.Printf( _( "Enter page number for sheet path%s" ),
 ( sheetPath.Length() > 20 ) ? wxT( "\n" ) + sheetPath : wxT( " " ) + sheetPath );

 wxTextEntryDialog dlg( m_frame, msg, _( "Edit Sheet Page Number" ), pageNumber );

 dlg.SetTextValidator( wxFILTER_ALPHANUMERIC ); // No white space.

 if( dlg.ShowModal() == wxID_CANCEL || dlg.GetValue() == instance.GetPageNumber() )
 return 0;

 m_frame->SaveCopyInUndoList( screen, sheet, UNDO_REDO::CHANGED, false );

 instance.SetPageNumber( dlg.GetValue() );

 if( instance == m_frame->GetCurrentSheet() )
 {
 m_frame->GetScreen()->SetPageNumber( dlg.GetValue() );
 m_frame->OnPageSettingsChange();
 }

 m_frame->OnModify();

 return 0;
}


void SCH_EDIT_TOOL::setTransitions()
{
 Go( &SCH_EDIT_TOOL::RepeatDrawItem, EE_ACTIONS::repeatDrawItem.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Rotate, EE_ACTIONS::rotateCW.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Rotate, EE_ACTIONS::rotateCCW.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Mirror, EE_ACTIONS::mirrorV.MakeEvent() );
 Go( &SCH_EDIT_TOOL::Mirror, EE_ACTIONS::mirrorH.MakeEvent() );
 Go( &SCH_EDIT_TOOL::DoDelete, ACTIONS::doDelete.MakeEvent() );
 Go( &SCH_EDIT_TOOL::DeleteItemCursor, ACTIONS::deleteTool.MakeEvent() );

 Go( &SCH_EDIT_TOOL::Properties, EE_ACTIONS::properties.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditField, EE_ACTIONS::editReference.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditField, EE_ACTIONS::editValue.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditField, EE_ACTIONS::editFootprint.MakeEvent() );
 Go( &SCH_EDIT_TOOL::AutoplaceFields, EE_ACTIONS::autoplaceFields.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::changeSymbols.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::updateSymbols.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::changeSymbol.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeSymbols, EE_ACTIONS::updateSymbol.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ConvertDeMorgan, EE_ACTIONS::toggleDeMorgan.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ConvertDeMorgan, EE_ACTIONS::showDeMorganStandard.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ConvertDeMorgan, EE_ACTIONS::showDeMorganAlternate.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toLabel.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toHLabel.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toGLabel.MakeEvent() );
 Go( &SCH_EDIT_TOOL::ChangeTextType, EE_ACTIONS::toText.MakeEvent() );

 Go( &SCH_EDIT_TOOL::BreakWire, EE_ACTIONS::breakWire.MakeEvent() );
 Go( &SCH_EDIT_TOOL::BreakWire, EE_ACTIONS::breakBus.MakeEvent() );

 Go( &SCH_EDIT_TOOL::CleanupSheetPins, EE_ACTIONS::cleanupSheetPins.MakeEvent() );
 Go( &SCH_EDIT_TOOL::GlobalEdit, EE_ACTIONS::editTextAndGraphics.MakeEvent() );
 Go( &SCH_EDIT_TOOL::EditPageNumber, EE_ACTIONS::editPageNumber.MakeEvent() );
}