29using namespace std::placeholders;
107 int preExisting = (int) commandToUndo->
GetCount();
109 for(
unsigned ii = 0; ii < aItemsList.
GetCount(); ii++ )
112 for(
unsigned ii = preExisting; ii < commandToUndo->
GetCount(); ii++ )
117 if( command == UNDO_REDO::UNSPECIFIED )
119 command = aCommandType;
127 case UNDO_REDO::CHANGED:
128 case UNDO_REDO::DRILLORIGIN:
129 case UNDO_REDO::GRIDORIGIN:
136 case UNDO_REDO::NEWITEM:
137 case UNDO_REDO::DELETED:
138 case UNDO_REDO::PAGESETTINGS:
142 wxFAIL_MSG( wxString::Format( wxT(
"Unrecognized undo command: %X" ), command ) );
159 delete commandToUndo;
265 bool not_found =
false;
266 bool reBuild_ratsnest =
false;
267 bool deep_reBuild_ratsnest =
false;
268 bool solder_mask_dirty =
false;
269 std::vector<BOX2I> dirty_rule_areas;
278 enum ITEM_CHANGE_TYPE
285 std::unordered_map<EDA_ITEM*, ITEM_CHANGE_TYPE> item_changes;
287 auto update_item_change_state =
288 [&](
EDA_ITEM* item, ITEM_CHANGE_TYPE change_type )
290 auto item_itr = item_changes.find( item );
292 if( item_itr == item_changes.end() )
295 item_changes.insert( { item, change_type } );
300 switch( item_itr->second )
302 case ITEM_CHANGE_TYPE::ADDED:
304 if( change_type == ITEM_CHANGE_TYPE::DELETED )
308 item_changes.erase( item_itr );
310 else if( change_type == ITEM_CHANGE_TYPE::ADDED )
313 wxASSERT_MSG(
false, wxT(
"UndoRedo: should not add already added item" ) );
319 case ITEM_CHANGE_TYPE::DELETED:
323 wxASSERT_MSG(
false, wxT(
"UndoRedo: should not alter already deleted item" ) );
326 case ITEM_CHANGE_TYPE::CHANGED:
328 if( change_type == ITEM_CHANGE_TYPE::DELETED )
330 item_itr->second = ITEM_CHANGE_TYPE::DELETED;
332 else if( change_type == ITEM_CHANGE_TYPE::ADDED )
336 wxASSERT_MSG(
false, wxT(
"UndoRedo: should not add already changed item" ) );
349 for(
int ii = (
int) aList->
GetCount() - 1; ii >= 0 ; ii-- )
362 if( status != UNDO_REDO::DELETED
363 && status != UNDO_REDO::DRILLORIGIN
364 && status != UNDO_REDO::GRIDORIGIN
365 && status != UNDO_REDO::PAGESETTINGS )
381 switch( eda_item->
Type() )
384 deep_reBuild_ratsnest =
true;
392 reBuild_ratsnest =
true;
396 reBuild_ratsnest =
true;
397 deep_reBuild_ratsnest =
true;
404 switch( eda_item->
Type() )
407 solder_mask_dirty =
true;
411 solder_mask_dirty =
true;
420 LSET layers =
static_cast<BOARD_ITEM*
>( eda_item )->GetLayerSet();
423 solder_mask_dirty =
true;
434 case UNDO_REDO::CHANGED:
459 view->
Hide( item,
false );
465 dirty_rule_areas.push_back(
image->GetBoundingBox() );
468 update_item_change_state( item, ITEM_CHANGE_TYPE::CHANGED );
472 case UNDO_REDO::NEWITEM:
475 update_item_change_state( eda_item, ITEM_CHANGE_TYPE::DELETED );
487 case UNDO_REDO::DELETED:
493 update_item_change_state( eda_item, ITEM_CHANGE_TYPE::ADDED );
496 view->
Add( eda_item );
503 case UNDO_REDO::DRILLORIGIN:
504 case UNDO_REDO::GRIDORIGIN:
520 case UNDO_REDO::PAGESETTINGS:
526 *item = std::move( alt_item );
531 wxFAIL_MSG( wxString::Format( wxT(
"PutDataInPreviousState() error (unknown code %X)" ),
545 wxMessageBox(
_(
"Incomplete undo/redo operation: some items not found" ) );
549 for(
int ii = 0; ii < (int) aList->
GetCount(); ++ii )
553 if(
wrapper.GetStatus() == UNDO_REDO::DELETED )
557 wrapper.GetItem()->SetParentGroup(
dynamic_cast<PCB_GROUP*
>( parentGroup ) );
562 group->GetItems().clear();
564 for(
const KIID& member :
wrapper.GetGroupMembers() )
567 group->AddItem( memberItem );
584 if( reBuild_ratsnest || deep_reBuild_ratsnest )
591 if( solder_mask_dirty )
603 std::vector<BOARD_ITEM*> added_items, deleted_items, changed_items;
605 for(
auto& [item, changeType] : item_changes )
609 case ITEM_CHANGE_TYPE::ADDED:
610 added_items.push_back(
static_cast<BOARD_ITEM*
>( item ) );
613 case ITEM_CHANGE_TYPE::DELETED:
614 deleted_items.push_back(
static_cast<BOARD_ITEM*
>( item ) );
617 case ITEM_CHANGE_TYPE::CHANGED:
618 changed_items.push_back(
static_cast<BOARD_ITEM*
>( item ) );
625 if( added_items.size() > 0 || deleted_items.size() > 0 || changed_items.size() > 0 )
632 if( aItemCount == 0 )
643 for(
int ii = 0; ii < aItemCount; ii++ )
663 "Item on undo/redo list not owned by undo/redo!" );
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 SwapItemData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
FOOTPRINT * GetParentFootprint() const
PCB_BOARD_OUTLINE * BoardOutline()
void UpdateBoardOutline()
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()
COMPONENT_CLASS_MANAGER & GetComponentClassManager()
Gets the component class manager.
BOARD_ITEM * ResolveItem(const KIID &aID, bool aAllowNullptrReturn=false) const
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
void InvalidateComponentClasses()
Invalidates any caches component classes and recomputes caches if required.
void RebuildRequiredCaches(FOOTPRINT *aFootprint=nullptr) const
Rebuilds any caches that may be required by custom assignment rules.
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
Specify 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 set of EDA_ITEMs (i.e., without duplicates).
A base class for most all the KiCad significant classes used in schematics and boards.
virtual VECTOR2I GetPosition() const
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
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
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1) override
Add a VIEW_ITEM to the view.
void UpdateCollidingItems(const std::vector< BOX2I > &aStaleAreas, std::initializer_list< KICAD_T > aTypes)
Sets the KIGFX::REPAINT on all items matching aTypes which intersect aStaleAreas.
virtual void Remove(VIEW_ITEM *aItem) override
Remove a VIEW_ITEM from the view.
void Hide(VIEW_ITEM *aItem, bool aHide=true, bool aHideOverlay=false)
Temporarily hide the item in the view (e.g.
LSET is a set of PCB_LAYER_IDs.
static TOOL_ACTION rehatchShapes
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:
PCBNEW_SETTINGS * GetPcbNewSettings() const
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
EDA_ITEM * ResolveItem(const KIID &aId, bool aAllowNullptrReturn=false) const override
Fetch an item by KIID.
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
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.
const ITEM_PICKER & GetItemWrapper(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...
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
Handle a list of polygons defining a copper zone.
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
#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...