undo_redo.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2012 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2016 CERN
 * Copyright (C) 2012-2021 KiCad Developers, see AUTHORS.txt for contributors.
 * @author Maciej Suminski <[email protected]>
 *
 * 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 <functional>
using namespace std::placeholders;
#include <macros.h>
#include <pcb_edit_frame.h>
#include <board.h>
#include <pcb_track.h>
#include <pcb_group.h>
#include <pcb_target.h>
#include <footprint.h>
#include <pad.h>
#include <pcb_dimension.h>
#include <origin_viewitem.h>
#include <connectivity/connectivity_data.h>
#include <pcbnew_settings.h>
#include <tool/tool_manager.h>
#include <tool/actions.h>
#include <tools/pcb_selection_tool.h>
#include <tools/pcb_control.h>
#include <tools/board_editor_control.h>
#include <drawing_sheet/ds_proxy_undo_item.h>
#include <wx/msgdlg.h>

/* Functions to undo and redo edit commands.
 * commands to undo are stored in CurrentScreen->m_UndoList
 * commands to redo are stored in CurrentScreen->m_RedoList
 *
 * m_UndoList and m_RedoList handle a std::vector of PICKED_ITEMS_LIST
 * Each PICKED_ITEMS_LIST handle a std::vector of pickers (class ITEM_PICKER),
 * that store the list of schematic items that are concerned by the command to undo or redo
 * and is created for each command to undo (handle also a command to redo).
 * each picker has a pointer pointing to an item to undo or redo (in fact: deleted, added or
 * modified),
 * and has a pointer to a copy of this item, when this item has been modified
 * (the old values of parameters are therefore saved)
 *
 * there are 3 cases:
 * - delete item(s) command
 * - change item(s) command
 * - add item(s) command
 *
 * Undo command
 * - delete item(s) command:
 * => deleted items are moved in undo list
 *
 * - change item(s) command
 * => A copy of item(s) is made (a DrawPickedStruct list of wrappers)
 * the .m_Link member of each wrapper points the modified item.
 * the .m_Item member of each wrapper points the old copy of this item.
 *
 * - add item(s) command
 * =>A list of item(s) is made. The .m_Item member of each wrapper points the new item.
 *
 * Redo command
 * - delete item(s) old command:
 * => deleted items are moved in EEDrawList list, and in
 *
 * - change item(s) command
 * => the copy of item(s) is moved in Undo list
 *
 * - add item(s) command
 * => The list of item(s) is used to create a deleted list in undo list(same as a delete
 * command)
 *
 * Some block operations that change items can be undone without memorize items, just the
 * coordinates of the transform:
 * move list of items (undo/redo is made by moving with the opposite move vector)
 * mirror (Y) and flip list of items (undo/redo is made by mirror or flip items)
 * so they are handled specifically.
 *
 */


static bool TestForExistingItem( BOARD* aPcb, BOARD_ITEM* aItem )
{
 for( PCB_TRACK* item : aPcb->Tracks() )
 {
 if( aItem == static_cast<BOARD_ITEM*>( item ) )
 return true;
 }

 for( FOOTPRINT* item : aPcb->Footprints() )
 {
 if( aItem == static_cast<BOARD_ITEM*>( item ) )
 return true;
 }

 for( BOARD_ITEM* item : aPcb->Drawings() )
 {
 if( aItem == static_cast<BOARD_ITEM*>( item ) )
 return true;
 }

 for( ZONE* item : aPcb->Zones() )
 {
 if( aItem == static_cast<BOARD_ITEM*>( item ) )
 return true;
 }

 NETINFO_LIST& netInfo = aPcb->GetNetInfo();

 for( NETINFO_LIST::iterator i = netInfo.begin(); i != netInfo.end(); ++i )
 {
 if( aItem == static_cast<BOARD_ITEM*>( *i ) )
 return true;
 }

 for( PCB_GROUP* item : aPcb->Groups() )
 {
 if( aItem == static_cast<BOARD_ITEM*>( item ) )
 return true;
 }

 return false;
}


static void SwapItemData( BOARD_ITEM* aItem, BOARD_ITEM* aImage )
{
 if( aImage == nullptr )
 return;

 wxASSERT( aItem->Type() == aImage->Type() );

 // Remark: to create images of edited items to undo, we are using Clone method
 // which does not do a deep copy.
 // So we have to use the current values of these parameters.

 wxASSERT( aItem->m_Uuid == aImage->m_Uuid );

 EDA_ITEM* parent = aItem->GetParent();

 aItem->SwapData( aImage );

 // Restore pointers to be sure they are not broken
 aItem->SetParent( parent );
}


void PCB_BASE_EDIT_FRAME::SaveCopyInUndoList( EDA_ITEM* aItem, UNDO_REDO aCommandType )
{
 PICKED_ITEMS_LIST commandToUndo;
 commandToUndo.PushItem( ITEM_PICKER( nullptr, aItem, aCommandType ) );
 SaveCopyInUndoList( commandToUndo, aCommandType );
}


void PCB_BASE_EDIT_FRAME::SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
 UNDO_REDO aCommandType )
{
 PICKED_ITEMS_LIST* commandToUndo = new PICKED_ITEMS_LIST();

 // First, filter unnecessary stuff from the list (i.e. for multiple pads / labels modified),
 // take the first occurrence of the footprint (we save copies of footprints when one of its
 // subitems is changed).
 for( unsigned ii = 0; ii < aItemsList.GetCount(); ii++ )
 {
 ITEM_PICKER curr_picker = aItemsList.GetItemWrapper(ii);
 BOARD_ITEM* item = dynamic_cast<BOARD_ITEM*>( aItemsList.GetPickedItem( ii ) );

 // For items belonging to footprints, we need to save state of the parent footprint
 if( item && item->GetParent() && item->GetParent()->Type() == PCB_FOOTPRINT_T )
 {
 item = item->GetParent();

 // Check if the parent footprint has already been saved in another entry
 bool found = false;

 for( unsigned j = 0; j < commandToUndo->GetCount(); j++ )
 {
 if( commandToUndo->GetPickedItem( j ) == item
 && commandToUndo->GetPickedItemStatus( j ) == UNDO_REDO::CHANGED )
 {
 found = true;
 break;
 }
 }

 if( !found )
 {
 // Create a clean copy of the parent footprint
 FOOTPRINT* orig = static_cast<FOOTPRINT*>( item );
 FOOTPRINT* clone = new FOOTPRINT( *orig );
 clone->SetParent( GetBoard() );

 // Clear current flags (which can be temporary set by a current edit command)
 for( BOARD_ITEM* child : clone->GraphicalItems() )
 child->ClearEditFlags();

 for( PAD* pad : clone->Pads() )
 pad->ClearEditFlags();

 clone->Reference().ClearEditFlags();
 clone->Value().ClearEditFlags();

 ITEM_PICKER picker( nullptr, item, UNDO_REDO::CHANGED );
 picker.SetLink( clone );
 commandToUndo->PushItem( picker );
 }
 else
 {
 continue;
 }
 }
 else
 {
 // Normal case: all other BOARD_ITEMs, are simply copied to the new list
 commandToUndo->PushItem( curr_picker );
 }
 }

 for( unsigned ii = 0; ii < commandToUndo->GetCount(); ii++ )
 {
 EDA_ITEM* item = aItemsList.GetPickedItem( ii );
 UNDO_REDO command = commandToUndo->GetPickedItemStatus( ii );

 if( command == UNDO_REDO::UNSPECIFIED )
 {
 command = aCommandType;
 commandToUndo->SetPickedItemStatus( command, ii );
 }

 wxASSERT( item );

 switch( command )
 {
 case UNDO_REDO::CHANGED:
 case UNDO_REDO::DRILLORIGIN:
 case UNDO_REDO::GRIDORIGIN:

 /* If needed, create a copy of item, and put in undo list
 * in the picker, as link
 * If this link is not null, the copy is already done
 */
 if( commandToUndo->GetPickedItemLink( ii ) == nullptr )
 {
 EDA_ITEM* cloned = item->Clone();
 commandToUndo->SetPickedItemLink( cloned, ii );
 }

 break;

 case UNDO_REDO::NEWITEM:
 case UNDO_REDO::DELETED:
 case UNDO_REDO::PAGESETTINGS:
 case UNDO_REDO::REGROUP:
 case UNDO_REDO::UNGROUP:
 break;

 default:
 wxFAIL_MSG( wxString::Format( wxT( "SaveCopyInUndoList() error (unknown code %X)" ),
 command ) );
 break;
 }
 }

 if( commandToUndo->GetCount() )
 {
 /* Save the copy in undo list */
 PushCommandToUndoList( commandToUndo );

 /* Clear redo list, because after a new command one cannot redo a command */
 ClearUndoORRedoList( REDO_LIST );
 }
 else
 {
 // Should not occur
 wxASSERT( false );
 delete commandToUndo;
 }
}


void PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList( wxCommandEvent& aEvent )
{
 if( UndoRedoBlocked() )
 return;

 if( GetUndoCommandCount() <= 0 )
 return;

 // Inform tools that undo command was issued
 m_toolManager->ProcessEvent( { TC_MESSAGE, TA_UNDO_REDO_PRE, AS_GLOBAL } );

 // Get the old list
 PICKED_ITEMS_LIST* list = PopCommandFromUndoList();

 // Undo the command
 PutDataInPreviousState( list );

 // Put the old list in RedoList
 list->ReversePickersListOrder();
 PushCommandToRedoList( list );

 OnModify();

 m_toolManager->ProcessEvent( { TC_MESSAGE, TA_UNDO_REDO_POST, AS_GLOBAL } );
 m_toolManager->PostEvent( EVENTS::SelectedItemsModified );

 GetCanvas()->Refresh();
}


void PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList( wxCommandEvent& aEvent )
{
 if( UndoRedoBlocked() )
 return;

 if( GetRedoCommandCount() == 0 )
 return;

 // Inform tools that redo command was issued
 m_toolManager->ProcessEvent( { TC_MESSAGE, TA_UNDO_REDO_PRE, AS_GLOBAL } );

 // Get the old list
 PICKED_ITEMS_LIST* list = PopCommandFromRedoList();

 // Redo the command
 PutDataInPreviousState( list );

 // Put the old list in UndoList
 list->ReversePickersListOrder();
 PushCommandToUndoList( list );

 OnModify();

 m_toolManager->ProcessEvent( { TC_MESSAGE, TA_UNDO_REDO_POST, AS_GLOBAL } );
 m_toolManager->PostEvent( EVENTS::SelectedItemsModified );

 GetCanvas()->Refresh();
}


void PCB_BASE_EDIT_FRAME::PutDataInPreviousState( PICKED_ITEMS_LIST* aList )
{
 bool not_found = false;
 bool reBuild_ratsnest = false;
 bool deep_reBuild_ratsnest = false; // true later if pointers must be rebuilt

 auto view = GetCanvas()->GetView();
 auto connectivity = GetBoard()->GetConnectivity();

 PCB_GROUP* group = nullptr;

 // Undo in the reverse order of list creation: (this can allow stacked changes
 // like the same item can be changes and deleted in the same complex command

 // Restore changes in reverse order
 for( int ii = aList->GetCount() - 1; ii >= 0 ; ii-- )
 {
 EDA_ITEM* eda_item = aList->GetPickedItem( (unsigned) ii );

 /* Test for existence of item on board.
 * It could be deleted, and no more on board:
 * - if a call to SaveCopyInUndoList was forgotten in Pcbnew
 * - in zones outlines, when a change in one zone merges this zone with an other
 * This test avoids a Pcbnew crash
 * Obviously, this test is not made for deleted items
 */
 UNDO_REDO status = aList->GetPickedItemStatus( ii );

 if( status != UNDO_REDO::DELETED
 && status != UNDO_REDO::DRILLORIGIN // origin markers never on board
 && status != UNDO_REDO::GRIDORIGIN // origin markers never on board
 && status != UNDO_REDO::PAGESETTINGS ) // nor are page settings proxy items
 {
 if( !TestForExistingItem( GetBoard(), (BOARD_ITEM*) eda_item ) )
 {
 // Checking if it ever happens
 wxASSERT_MSG( false, wxT( "Item in the undo buffer does not exist" ) );

 // Remove this non existent item
 aList->RemovePicker( ii );
 not_found = true;

 if( aList->GetCount() == 0 )
 break;

 continue;
 }
 }

 // see if we must rebuild ratsnets and pointers lists
 switch( eda_item->Type() )
 {
 case PCB_FOOTPRINT_T:
 deep_reBuild_ratsnest = true; // Pointers on pads can be invalid
 KI_FALLTHROUGH;

 case PCB_ZONE_T:
 case PCB_TRACE_T:
 case PCB_ARC_T:
 case PCB_VIA_T:
 case PCB_PAD_T:
 reBuild_ratsnest = true;
 break;

 case PCB_NETINFO_T:
 reBuild_ratsnest = true;
 deep_reBuild_ratsnest = true;
 break;

 default:
 break;
 }

 switch( aList->GetPickedItemStatus( ii ) )
 {
 case UNDO_REDO::CHANGED: /* Exchange old and new data for each item */
 {
 BOARD_ITEM* item = (BOARD_ITEM*) eda_item;
 BOARD_ITEM* image = (BOARD_ITEM*) aList->GetPickedItemLink( ii );

 // Remove all pads/drawings/texts, as they become invalid
 // for the VIEW after SwapData() called for footprints
 view->Remove( item );
 connectivity->Remove( item );

 SwapItemData( item, image );

 view->Add( item );
 view->Hide( item, false );
 connectivity->Add( item );
 item->GetBoard()->OnItemChanged( item );
 break;
 }

 case UNDO_REDO::NEWITEM: /* new items are deleted */
 aList->SetPickedItemStatus( UNDO_REDO::DELETED, ii );
 GetModel()->Remove( (BOARD_ITEM*) eda_item );

 if( eda_item->Type() != PCB_NETINFO_T )
 view->Remove( eda_item );

 break;

 case UNDO_REDO::DELETED: /* deleted items are put in List, as new items */
 aList->SetPickedItemStatus( UNDO_REDO::NEWITEM, ii );
 GetModel()->Add( (BOARD_ITEM*) eda_item );

 if( eda_item->Type() != PCB_NETINFO_T )
 view->Add( eda_item );

 if( eda_item->Type() == PCB_GROUP_T )
 group = static_cast<PCB_GROUP*>( eda_item );

 break;

 case UNDO_REDO::REGROUP:
 aList->SetPickedItemStatus( UNDO_REDO::UNGROUP, ii );
 static_cast<BOARD_ITEM*>( eda_item )->SetParentGroup( nullptr );
 break;

 case UNDO_REDO::UNGROUP:
 aList->SetPickedItemStatus( UNDO_REDO::REGROUP, ii );

 if( group )
 group->AddItem( static_cast<BOARD_ITEM*>( eda_item ) );

 break;

 case UNDO_REDO::DRILLORIGIN:
 case UNDO_REDO::GRIDORIGIN:
 {
 BOARD_ITEM* item = (BOARD_ITEM*) eda_item;
 BOARD_ITEM* image = (BOARD_ITEM*) aList->GetPickedItemLink( ii );
 VECTOR2D origin = image->GetPosition();
 image->SetPosition( eda_item->GetPosition() );

 if( aList->GetPickedItemStatus( ii ) == UNDO_REDO::DRILLORIGIN )
 BOARD_EDITOR_CONTROL::DoSetDrillOrigin( view, this, item, origin );
 else
 PCB_CONTROL::DoSetGridOrigin( view, this, item, origin );

 break;
 }

 case UNDO_REDO::PAGESETTINGS:
 {
 // swap current settings with stored settings
 DS_PROXY_UNDO_ITEM alt_item( this );
 DS_PROXY_UNDO_ITEM* item = static_cast<DS_PROXY_UNDO_ITEM*>( eda_item );
 item->Restore( this );
 *item = alt_item;
 break;
 }

 default:
 wxFAIL_MSG( wxString::Format( wxT( "PutDataInPreviousState() error (unknown code %X)" ),
 aList->GetPickedItemStatus( ii ) ) );
 break;
 }
 }

 if( not_found )
 wxMessageBox( _( "Incomplete undo/redo operation: some items not found" ) );

 // Rebuild pointers and connectivity that can be changed.
 // connectivity can be rebuilt only in the board editor frame
 if( IsType( FRAME_PCB_EDITOR ) && ( reBuild_ratsnest || deep_reBuild_ratsnest ) )
 {
 Compile_Ratsnest( false );
 }

 PCB_SELECTION_TOOL* selTool = m_toolManager->GetTool<PCB_SELECTION_TOOL>();
 selTool->RebuildSelection();

 GetBoard()->SanitizeNetcodes();
}


void PCB_BASE_EDIT_FRAME::ClearUndoORRedoList( UNDO_REDO_LIST whichList, int aItemCount )
{
 if( aItemCount == 0 )
 return;

 UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
 unsigned icnt = list.m_CommandsList.size();

 if( aItemCount > 0 )
 icnt = aItemCount;

 for( unsigned ii = 0; ii < icnt; ii++ )
 {
 if( list.m_CommandsList.size() == 0 )
 break;

 PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
 list.m_CommandsList.erase( list.m_CommandsList.begin() );

 curr_cmd->ClearListAndDeleteItems();
 delete curr_cmd; // Delete command
 }
}


void PCB_BASE_EDIT_FRAME::RollbackFromUndo()
{
 PICKED_ITEMS_LIST* undo = PopCommandFromUndoList();
 PutDataInPreviousState( undo );

 undo->ClearListAndDeleteItems();
 delete undo;

 GetCanvas()->Refresh();
}