mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 02:03:12 +02:00
We had been deselecting items after calling edits to be safe in case the item was deleted/exchanged by the edit. The item pointer itself remains valid even when deleting as it is assigned to the undo stack. But it should not remain visible or selected on the schematic if it is removed. This tests for removed items by checking whether it (in the case of first-level BOARD_ITEMS) or its parent (in the case of footprint item components) remain in the view list after editing. If they are still in the view list, then we re-select them. ( cherry-picked from 2c6d0ffe2 ) Fixes: lp:1765774 * https://bugs.launchpad.net/kicad/+bug/1765774 Fixes: lp:1775946 * https://bugs.launchpad.net/kicad/+bug/1775946
371 lines
12 KiB
C++
371 lines
12 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2016 CERN
|
|
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
|
|
*
|
|
* 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 <class_board.h>
|
|
#include <class_module.h>
|
|
#include <pcb_edit_frame.h>
|
|
#include <tool/tool_manager.h>
|
|
#include <ratsnest_data.h>
|
|
#include <view/view.h>
|
|
#include <board_commit.h>
|
|
#include <tools/pcb_tool.h>
|
|
#include <tools/pcb_actions.h>
|
|
#include <connectivity_data.h>
|
|
|
|
#include <functional>
|
|
using namespace std::placeholders;
|
|
|
|
#include "pcb_draw_panel_gal.h"
|
|
|
|
BOARD_COMMIT::BOARD_COMMIT( PCB_TOOL* aTool )
|
|
{
|
|
m_toolMgr = aTool->GetManager();
|
|
m_editModules = aTool->EditingModules();
|
|
}
|
|
|
|
|
|
BOARD_COMMIT::BOARD_COMMIT( EDA_DRAW_FRAME* aFrame )
|
|
{
|
|
m_toolMgr = aFrame->GetToolManager();
|
|
m_editModules = aFrame->IsType( FRAME_PCB_MODULE_EDITOR );
|
|
}
|
|
|
|
|
|
BOARD_COMMIT::~BOARD_COMMIT()
|
|
{
|
|
}
|
|
|
|
|
|
void BOARD_COMMIT::Push( const wxString& aMessage, bool aCreateUndoEntry, bool aSetDirtyBit )
|
|
{
|
|
// Objects potentially interested in changes:
|
|
PICKED_ITEMS_LIST undoList;
|
|
KIGFX::VIEW* view = m_toolMgr->GetView();
|
|
BOARD* board = (BOARD*) m_toolMgr->GetModel();
|
|
PCB_BASE_FRAME* frame = (PCB_BASE_FRAME*) m_toolMgr->GetEditFrame();
|
|
auto connectivity = board->GetConnectivity();
|
|
std::set<EDA_ITEM*> savedModules;
|
|
|
|
if( Empty() )
|
|
return;
|
|
|
|
for( COMMIT_LINE& ent : m_changes )
|
|
{
|
|
int changeType = ent.m_type & CHT_TYPE;
|
|
int changeFlags = ent.m_type & CHT_FLAGS;
|
|
BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
|
|
|
|
// Module items need to be saved in the undo buffer before modification
|
|
if( m_editModules )
|
|
{
|
|
// Be sure that we are storing a module
|
|
if( ent.m_item->Type() != PCB_MODULE_T )
|
|
ent.m_item = ent.m_item->GetParent();
|
|
|
|
// We have not saved the module yet, so let's create an entry
|
|
if( savedModules.count( ent.m_item ) == 0 )
|
|
{
|
|
if( !ent.m_copy )
|
|
{
|
|
wxASSERT( changeType != CHT_MODIFY ); // too late to make a copy..
|
|
ent.m_copy = ent.m_item->Clone();
|
|
}
|
|
|
|
wxASSERT( ent.m_item->Type() == PCB_MODULE_T );
|
|
wxASSERT( ent.m_copy->Type() == PCB_MODULE_T );
|
|
|
|
if( aCreateUndoEntry )
|
|
{
|
|
ITEM_PICKER itemWrapper( ent.m_item, UR_CHANGED );
|
|
itemWrapper.SetLink( ent.m_copy );
|
|
undoList.PushItem( itemWrapper );
|
|
frame->SaveCopyInUndoList( undoList, UR_CHANGED );
|
|
}
|
|
|
|
savedModules.insert( ent.m_item );
|
|
static_cast<MODULE*>( ent.m_item )->SetLastEditTime();
|
|
}
|
|
}
|
|
|
|
switch( changeType )
|
|
{
|
|
case CHT_ADD:
|
|
{
|
|
if( !m_editModules )
|
|
{
|
|
if( aCreateUndoEntry )
|
|
{
|
|
undoList.PushItem( ITEM_PICKER( boardItem, UR_NEW ) );
|
|
}
|
|
|
|
if( !( changeFlags & CHT_DONE ) )
|
|
board->Add( boardItem ); // handles connectivity
|
|
|
|
}
|
|
else
|
|
{
|
|
// modules inside modules are not supported yet
|
|
wxASSERT( boardItem->Type() != PCB_MODULE_T );
|
|
|
|
boardItem->SetParent( board->m_Modules.GetFirst() );
|
|
|
|
if( !( changeFlags & CHT_DONE ) )
|
|
board->m_Modules->Add( boardItem );
|
|
}
|
|
|
|
view->Add( boardItem );
|
|
break;
|
|
}
|
|
|
|
case CHT_REMOVE:
|
|
{
|
|
if( !m_editModules && aCreateUndoEntry )
|
|
{
|
|
undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
|
|
}
|
|
|
|
switch( boardItem->Type() )
|
|
{
|
|
// Module items
|
|
case PCB_PAD_T:
|
|
case PCB_MODULE_EDGE_T:
|
|
case PCB_MODULE_TEXT_T:
|
|
// This level can only handle module items when editing modules
|
|
if( !m_editModules )
|
|
break;
|
|
|
|
if( boardItem->Type() == PCB_MODULE_TEXT_T )
|
|
{
|
|
TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
|
|
|
|
// don't allow deletion of Reference or Value
|
|
if( text->GetType() != TEXTE_MODULE::TEXT_is_DIVERS )
|
|
break;
|
|
}
|
|
|
|
view->Remove( boardItem );
|
|
|
|
// Removing an item should trigger the unselect
|
|
m_toolMgr->RunAction( PCB_ACTIONS::unselectItem, true, boardItem );
|
|
|
|
if( !( changeFlags & CHT_DONE ) )
|
|
{
|
|
MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
|
|
wxASSERT( module && module->Type() == PCB_MODULE_T );
|
|
module->Delete( boardItem );
|
|
}
|
|
|
|
board->m_Status_Pcb = 0; // it is done in the legacy view (ratsnest perhaps?)
|
|
|
|
break;
|
|
|
|
// Board items
|
|
case PCB_LINE_T: // a segment not on copper layers
|
|
case PCB_TEXT_T: // a text on a layer
|
|
case PCB_TRACE_T: // a track segment (segment on a copper layer)
|
|
case PCB_VIA_T: // a via (like track segment on a copper layer)
|
|
case PCB_DIMENSION_T: // a dimension (graphic item)
|
|
case PCB_TARGET_T: // a target (graphic item)
|
|
case PCB_MARKER_T: // a marker used to show something
|
|
case PCB_ZONE_T: // SEG_ZONE items are now deprecated
|
|
case PCB_ZONE_AREA_T:
|
|
view->Remove( boardItem );
|
|
|
|
// Removing an item should trigger the unselect
|
|
m_toolMgr->RunAction( PCB_ACTIONS::unselectItem, true, boardItem );
|
|
|
|
if( !( changeFlags & CHT_DONE ) )
|
|
board->Remove( boardItem );
|
|
|
|
break;
|
|
|
|
case PCB_MODULE_T:
|
|
{
|
|
// There are no modules inside a module yet
|
|
wxASSERT( !m_editModules );
|
|
|
|
MODULE* module = static_cast<MODULE*>( boardItem );
|
|
view->Remove( module );
|
|
|
|
// Removing an item should trigger the unselect
|
|
m_toolMgr->RunAction( PCB_ACTIONS::unselectItem, true, boardItem );
|
|
module->ClearFlags();
|
|
|
|
if( !( changeFlags & CHT_DONE ) )
|
|
board->Remove( module ); // handles connectivity
|
|
|
|
// Clear flags to indicate, that the ratsnest, list of nets & pads are not valid anymore
|
|
board->m_Status_Pcb = 0;
|
|
}
|
|
break;
|
|
|
|
default: // other types do not need to (or should not) be handled
|
|
wxASSERT( false );
|
|
break;
|
|
}
|
|
break;
|
|
}
|
|
|
|
case CHT_MODIFY:
|
|
{
|
|
if( !m_editModules && aCreateUndoEntry )
|
|
{
|
|
ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
|
|
wxASSERT( ent.m_copy );
|
|
itemWrapper.SetLink( ent.m_copy );
|
|
undoList.PushItem( itemWrapper );
|
|
}
|
|
|
|
if( ent.m_copy )
|
|
connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
|
|
|
|
connectivity->Update( boardItem );
|
|
view->Update( boardItem );
|
|
|
|
// if no undo entry is needed, the copy would create a memory leak
|
|
if( !aCreateUndoEntry )
|
|
delete ent.m_copy;
|
|
|
|
break;
|
|
}
|
|
|
|
default:
|
|
wxASSERT( false );
|
|
break;
|
|
}
|
|
}
|
|
|
|
if( !m_editModules && aCreateUndoEntry )
|
|
frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
|
|
|
|
if( TOOL_MANAGER* toolMgr = frame->GetToolManager() )
|
|
toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
|
|
|
|
if ( !m_editModules )
|
|
{
|
|
auto panel = static_cast<PCB_DRAW_PANEL_GAL*>( frame->GetGalCanvas() );
|
|
connectivity->RecalculateRatsnest();
|
|
panel->RedrawRatsnest();
|
|
}
|
|
|
|
if( aSetDirtyBit )
|
|
frame->OnModify();
|
|
|
|
frame->UpdateMsgPanel();
|
|
|
|
clear();
|
|
}
|
|
|
|
|
|
EDA_ITEM* BOARD_COMMIT::parentObject( EDA_ITEM* aItem ) const
|
|
{
|
|
switch( aItem->Type() )
|
|
{
|
|
case PCB_PAD_T:
|
|
case PCB_MODULE_EDGE_T:
|
|
case PCB_MODULE_TEXT_T:
|
|
return aItem->GetParent();
|
|
default:
|
|
return aItem;
|
|
}
|
|
|
|
return aItem;
|
|
}
|
|
|
|
|
|
void BOARD_COMMIT::Revert()
|
|
{
|
|
PICKED_ITEMS_LIST undoList;
|
|
KIGFX::VIEW* view = m_toolMgr->GetView();
|
|
BOARD* board = (BOARD*) m_toolMgr->GetModel();
|
|
auto connectivity = board->GetConnectivity();
|
|
|
|
for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
|
|
{
|
|
COMMIT_LINE& ent = *it;
|
|
BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
|
|
BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
|
|
int changeType = ent.m_type & CHT_TYPE;
|
|
int changeFlags = ent.m_type & CHT_FLAGS;
|
|
|
|
switch( changeType )
|
|
{
|
|
case CHT_ADD:
|
|
if( !( changeFlags & CHT_DONE ) )
|
|
break;
|
|
|
|
view->Remove( item );
|
|
connectivity->Remove( item );
|
|
board->Remove( item );
|
|
break;
|
|
|
|
case CHT_REMOVE:
|
|
if( !( changeFlags & CHT_DONE ) )
|
|
break;
|
|
|
|
if( item->Type() == PCB_MODULE_T )
|
|
{
|
|
MODULE* newModule = static_cast<MODULE*>( item );
|
|
newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
|
|
}
|
|
|
|
view->Add( item );
|
|
connectivity->Add( item );
|
|
board->Add( item );
|
|
break;
|
|
|
|
case CHT_MODIFY:
|
|
{
|
|
view->Remove( item );
|
|
connectivity->Remove( item );
|
|
|
|
item->SwapData( copy );
|
|
item->ClearFlags( SELECTED );
|
|
|
|
// Update all pads/drawings/texts, as they become invalid
|
|
// for the VIEW after SwapData() called for modules
|
|
if( item->Type() == PCB_MODULE_T )
|
|
{
|
|
MODULE* newModule = static_cast<MODULE*>( item );
|
|
newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
|
|
}
|
|
|
|
view->Add( item );
|
|
connectivity->Add( item );
|
|
delete copy;
|
|
break;
|
|
}
|
|
|
|
default:
|
|
wxASSERT( false );
|
|
break;
|
|
}
|
|
}
|
|
|
|
if ( !m_editModules )
|
|
connectivity->RecalculateRatsnest();
|
|
|
|
clear();
|
|
}
|