29using namespace std::placeholders;
103 int preExisting = commandToUndo->
GetCount();
105 for(
unsigned ii = 0; ii < aItemsList.
GetCount(); ii++ )
108 for(
unsigned ii = preExisting; ii < commandToUndo->
GetCount(); ii++ )
113 if( command == UNDO_REDO::UNSPECIFIED )
115 command = aCommandType;
123 case UNDO_REDO::CHANGED:
124 case UNDO_REDO::DRILLORIGIN:
125 case UNDO_REDO::GRIDORIGIN:
132 case UNDO_REDO::NEWITEM:
133 case UNDO_REDO::DELETED:
134 case UNDO_REDO::PAGESETTINGS:
135 case UNDO_REDO::REGROUP:
136 case UNDO_REDO::UNGROUP:
140 wxFAIL_MSG( wxString::Format( wxT(
"Unrecognized undo command: %X" ), command ) );
157 delete commandToUndo;
259 bool not_found =
false;
260 bool reBuild_ratsnest =
false;
261 bool deep_reBuild_ratsnest =
false;
262 bool solder_mask_dirty =
false;
271 enum ITEM_CHANGE_TYPE
278 std::unordered_map<EDA_ITEM*, ITEM_CHANGE_TYPE> item_changes;
280 auto update_item_change_state = [&](
EDA_ITEM* item, ITEM_CHANGE_TYPE change_type )
282 auto item_itr = item_changes.find( item );
284 if( item_itr == item_changes.end() )
287 item_changes.insert( { item, change_type } );
292 switch( item_itr->second )
294 case ITEM_CHANGE_TYPE::ADDED:
296 if( change_type == ITEM_CHANGE_TYPE::DELETED )
300 item_changes.erase( item_itr );
302 else if( change_type == ITEM_CHANGE_TYPE::ADDED )
305 wxASSERT_MSG(
false, wxT(
"UndoRedo: should not add already added item" ) );
311 case ITEM_CHANGE_TYPE::DELETED:
315 wxASSERT_MSG(
false, wxT(
"UndoRedo: should not alter already deleted item" ) );
318 case ITEM_CHANGE_TYPE::CHANGED:
320 if( change_type == ITEM_CHANGE_TYPE::DELETED )
322 item_itr->second = ITEM_CHANGE_TYPE::DELETED;
324 else if( change_type == ITEM_CHANGE_TYPE::ADDED )
329 wxT(
"UndoRedo: should not add already changed item" ) );
342 for(
int ii = (
int) aList->
GetCount() - 1; ii >= 0 ; ii-- )
355 if( status != UNDO_REDO::DELETED
356 && status != UNDO_REDO::REGROUP
357 && status != UNDO_REDO::UNGROUP
358 && status != UNDO_REDO::DRILLORIGIN
359 && status != UNDO_REDO::GRIDORIGIN
360 && status != UNDO_REDO::PAGESETTINGS )
365 wxASSERT_MSG(
false, wxT(
"Item in the undo buffer does not exist" ) );
379 switch( eda_item->
Type() )
382 deep_reBuild_ratsnest =
true;
390 reBuild_ratsnest =
true;
394 reBuild_ratsnest =
true;
395 deep_reBuild_ratsnest =
true;
402 switch( eda_item->
Type() )
405 solder_mask_dirty =
true;
409 solder_mask_dirty =
true;
418 LSET layers =
static_cast<BOARD_ITEM*
>( eda_item )->GetLayerSet();
421 solder_mask_dirty =
true;
432 case UNDO_REDO::CHANGED:
447 view->Remove( item );
464 view->Hide( item,
false );
466 update_item_change_state( item, ITEM_CHANGE_TYPE::CHANGED );
470 case UNDO_REDO::NEWITEM:
473 update_item_change_state( eda_item, ITEM_CHANGE_TYPE::DELETED );
476 view->Remove( eda_item );
482 case UNDO_REDO::DELETED:
488 update_item_change_state( eda_item, ITEM_CHANGE_TYPE::ADDED );
491 view->Add( eda_item );
495 case UNDO_REDO::REGROUP:
504 group->RemoveItem( boardItem );
510 case UNDO_REDO::UNGROUP:
519 group->AddItem( boardItem );
524 case UNDO_REDO::DRILLORIGIN:
525 case UNDO_REDO::GRIDORIGIN:
541 case UNDO_REDO::PAGESETTINGS:
547 *item = std::move( alt_item );
552 wxFAIL_MSG( wxString::Format( wxT(
"PutDataInPreviousState() error (unknown code %X)" ),
559 wxMessageBox(
_(
"Incomplete undo/redo operation: some items not found" ) );
563 if( reBuild_ratsnest || deep_reBuild_ratsnest )
570 if( solder_mask_dirty )
580 std::vector<BOARD_ITEM*> added_items, deleted_items, changed_items;
582 for(
auto& item_itr : item_changes )
584 switch( item_itr.second )
586 case ITEM_CHANGE_TYPE::ADDED:
588 added_items.push_back(
static_cast<BOARD_ITEM*
>( item_itr.first ) );
591 case ITEM_CHANGE_TYPE::DELETED:
593 deleted_items.push_back(
static_cast<BOARD_ITEM*
>( item_itr.first ) );
596 case ITEM_CHANGE_TYPE::CHANGED:
598 changed_items.push_back(
static_cast<BOARD_ITEM*
>( item_itr.first ) );
604 if( added_items.size() > 0 || deleted_items.size() > 0 || changed_items.size() > 0 )
611 if( aItemCount == 0 )
622 for(
int ii = 0; ii < aItemCount; ii++ )
642 "Item on undo/redo list not owned by undo/redo!" );
645 boardItem->SetParentGroup(
nullptr );
static EDA_ITEM * MakeImage(EDA_ITEM *aItem)
static void DoSetDrillOrigin(KIGFX::VIEW *aView, PCB_BASE_FRAME *aFrame, EDA_ITEM *aItem, const VECTOR2D &aPoint)
Abstract interface for BOARD_ITEMs capable of storing other items inside.
virtual void Remove(BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL)=0
Removes an item from the container.
virtual void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false)=0
Adds an item to the container.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
void SetParentGroup(PCB_GROUP *aGroup)
void SwapItemData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
FOOTPRINT * GetParentFootprint() const
BOARD_ITEM * GetItem(const KIID &aID) const
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
void OnItemsCompositeUpdate(std::vector< BOARD_ITEM * > &aAddedItems, std::vector< BOARD_ITEM * > &aRemovedItems, std::vector< BOARD_ITEM * > &aChangedItems)
Notify the board and its listeners that items on the board have been modified in a composite operatio...
void IncrementTimeStamp()
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
static DELETED_BOARD_ITEM * GetInstance()
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
virtual void PushCommandToUndoList(PICKED_ITEMS_LIST *aItem)
Add a command to undo in the undo list.
virtual int GetRedoCommandCount() const
UNDO_REDO_CONTAINER m_undoList
UNDO_REDO_LIST
Specifies whether we are interacting with the undo or redo stacks.
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
Return the last command to undo and remove it from list, nothing is deleted.
UNDO_REDO_CONTAINER m_redoList
virtual PICKED_ITEMS_LIST * PopCommandFromUndoList()
Return the last command to undo and remove it from list, nothing is deleted.
virtual int GetUndoCommandCount() const
virtual void PushCommandToRedoList(PICKED_ITEMS_LIST *aItem)
Add a command to redo in the redo list.
bool IsType(FRAME_T aType) const
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
A base class for most all the KiCad significant classes used in schematics and boards.
virtual VECTOR2I GetPosition() const
void SetFlags(EDA_ITEM_FLAGS aMask)
KICAD_T Type() const
Returns the type of object.
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
static const TOOL_EVENT UndoRedoPreEvent
static const TOOL_EVENT SelectedItemsModified
Selected items were moved, this can be very high frequency on the canvas, use with care.
static const TOOL_EVENT UndoRedoPostEvent
LSET is a set of PCB_LAYER_IDs.
void ClearUndoORRedoList(UNDO_REDO_LIST whichList, int aItemCount=-1) override
Free the undo or redo list from List element.
void RestoreCopyFromUndoList(wxCommandEvent &aEvent)
Undo the last edit:
void saveCopyInUndoList(PICKED_ITEMS_LIST *commandToUndo, const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType)
void AppendCopyToUndoList(const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
As SaveCopyInUndoList, but appends the changes to the last undo item on the stack.
void SaveCopyInUndoList(EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand) override
Create a new entry in undo list of commands.
void ClearListAndDeleteItems(PICKED_ITEMS_LIST *aList)
void RollbackFromUndo()
Perform an undo of the last edit without logging a corresponding redo.
bool UndoRedoBlocked() const
Check if the undo and redo operations are currently blocked.
void PutDataInPreviousState(PICKED_ITEMS_LIST *aList)
Used in undo or redo command.
void RestoreCopyFromRedoList(wxCommandEvent &aEvent)
Redo the last edit:
EDA_ITEM * GetItem(const KIID &aId) const override
Fetch an item by KIID.
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual BOARD_ITEM_CONTAINER * GetModel() const =0
void Compile_Ratsnest(bool aDisplayStatus)
Create the entire board ratsnest.
static void DoSetGridOrigin(KIGFX::VIEW *aView, PCB_BASE_FRAME *aFrame, EDA_ITEM *originViewItem, const VECTOR2D &aPoint)
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
A set of BOARD_ITEMs (i.e., without duplicates).
A holder to handle information on schematic or board items.
bool SetPickedItemStatus(UNDO_REDO aStatus, unsigned aIdx)
Set the type of undo/redo operation for a given picked item.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
void SetDescription(const wxString &aDescription)
UNDO_REDO GetPickedItemStatus(unsigned int aIdx) const
ITEM_PICKER GetItemWrapper(unsigned int aIdx) const
EDA_ITEM * GetPickedItemLink(unsigned int aIdx) const
wxString GetDescription() const
bool RemovePicker(unsigned aIdx)
Remove one entry (one picker) from the list of picked items.
KIID GetPickedItemGroupId(unsigned int aIdx) const
unsigned GetCount() const
void ReversePickersListOrder()
Reverse the order of pickers stored in this list.
bool SetPickedItemLink(EDA_ITEM *aLink, unsigned aIdx)
Set the link associated to a given picked item.
void ClearListAndDeleteItems(std::function< void(EDA_ITEM *)> aItemDeleter)
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...
bool SetPickedItemGroupId(KIID aId, unsigned aIdx)
Set the group id associated to a given picked item.
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
#define UR_TRANSIENT
indicates the item is owned by the undo/redo stack
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Class to handle a set of BOARD_ITEMs.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_PAD_T
class PAD, a pad in a footprint
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_NETINFO_T
class NETINFO_ITEM, a description of a net
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...