KiCad PCB EDA Suite
undo_redo_container.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2009 [email protected]
5 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
6 * Copyright (C) 2009-2021 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#ifndef _CLASS_UNDOREDO_CONTAINER_H
27#define _CLASS_UNDOREDO_CONTAINER_H
28
29#include <core/typeinfo.h>
30#include <eda_item_flags.h>
31#include <functional>
32#include <vector>
33
34class EDA_ITEM;
36class BASE_SCREEN;
37
38
57enum class UNDO_REDO {
58 UNSPECIFIED = 0, // illegal
59 NOP, // Undo/redo will ignore this entry. Only forces the start of a new stack
60 CHANGED, // params of items have a value changed: undo is made by exchange
61 // values with a copy of these values
62 NEWITEM, // new item, undo by changing in deleted
63 DELETED, // deleted item, undo by changing in deleted
64 LIBEDIT, // Specific to the component editor (symbol_editor creates a full copy
65 // of the current component when changed)
66 LIB_RENAME, // As LIBEDIT, but old copy should be removed from library
67 EXCHANGE_T, // Use for changing the schematic text type where swapping
68 // data structure is insufficient to restore the change.
69 DRILLORIGIN, // origin changed (like CHANGED, contains the origin and a copy)
70 GRIDORIGIN, // origin changed (like CHANGED, contains the origin and a copy)
71 PAGESETTINGS, // page settings or title block changes
72 REGROUP, // new group of items created (do not use GROUP to avoid collision
73 // with an header on msys2)
74 UNGROUP // existing group destroyed (items not destroyed)
75};
76
77
79{
80public:
81// ITEM_PICKER( EDA_ITEM* aItem = NULL, UNDO_REDO aStatus = UNSPECIFIED );
83 ITEM_PICKER( BASE_SCREEN* aScreen, EDA_ITEM* aItem,
85
86 EDA_ITEM* GetItem() const { return m_pickedItem; }
87
88 void SetItem( EDA_ITEM* aItem );
89
91
92 void SetStatus( UNDO_REDO aStatus ) { m_undoRedoStatus = aStatus; }
93
95
96 void SetFlags( EDA_ITEM_FLAGS aFlags ) { m_pickerFlags = aFlags; }
97
99
100 void SetLink( EDA_ITEM* aItem ) { m_link = aItem; }
101
102 EDA_ITEM* GetLink() const { return m_link; }
103
104 BASE_SCREEN* GetScreen() const { return m_screen; }
105
106private:
107 EDA_ITEM_FLAGS m_pickerFlags; /* a copy of m_flags member. useful in mode/drag
108 * undo/redo commands */
109 UNDO_REDO m_undoRedoStatus; /* type of operation to undo/redo for this item */
110 EDA_ITEM* m_pickedItem; /* Pointer on the schematic or board item that is concerned
111 * (picked), or in undo redo commands, the copy of an
112 * edited item. */
113 KICAD_T m_pickedItemType; /* type of schematic or board item that is concerned */
114
115 EDA_ITEM* m_link; /* Pointer on another item. Used in undo redo command
116 * used when a duplicate exists i.e. when an item is
117 * modified, and the copy of initial item exists (the
118 * duplicate) m_Item points the duplicate (i.e the old
119 * copy of an active item) and m_Link points the active
120 * item in schematic */
121
122 BASE_SCREEN* m_screen; /* For new and deleted items the screen the item should
123 * be added to/removed from. */
124
125};
126
127
134{
135private:
136 std::vector <ITEM_PICKER> m_ItemsList;
137
138public:
141
147 void PushItem( const ITEM_PICKER& aItem );
148
153
157 bool ContainsItem( const EDA_ITEM* aItem ) const;
158
163 int FindItem( const EDA_ITEM* aItem ) const;
164
168 void ClearItemsList();
169
174 void ClearListAndDeleteItems( std::function<void(EDA_ITEM*)> aItemDeleter );
175
179 unsigned GetCount() const
180 {
181 return m_ItemsList.size();
182 }
183
192
198 ITEM_PICKER GetItemWrapper( unsigned int aIdx ) const;
199
204 EDA_ITEM* GetPickedItem( unsigned int aIdx ) const;
205
210 BASE_SCREEN* GetScreenForItem( unsigned int aIdx ) const;
211
216 EDA_ITEM* GetPickedItemLink( unsigned int aIdx ) const;
217
223 UNDO_REDO GetPickedItemStatus( unsigned int aIdx ) const;
224
231 EDA_ITEM_FLAGS GetPickerFlags( unsigned aIdx ) const;
232
238 bool SetPickedItem( EDA_ITEM* aItem, unsigned aIdx );
239
246 bool SetPickedItem( EDA_ITEM* aItem, UNDO_REDO aStatus, unsigned aIdx );
247
255 bool SetPickedItemLink( EDA_ITEM* aLink, unsigned aIdx );
256
264 bool SetPickedItemStatus( UNDO_REDO aStatus, unsigned aIdx );
265
273 bool SetPickerFlags( EDA_ITEM_FLAGS aFlags, unsigned aIdx );
274
281 bool RemovePicker( unsigned aIdx );
282
290 void CopyList( const PICKED_ITEMS_LIST& aSource );
291};
292
293
298{
299public:
302
303 void PushCommand( PICKED_ITEMS_LIST* aCommand );
304
306
307 void ClearCommandList();
308
309 std::vector <PICKED_ITEMS_LIST*> m_CommandsList; // the list of possible undo/redo commands
310};
311
312
313#endif // _CLASS_UNDOREDO_CONTAINER_H
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
void SetItem(EDA_ITEM *aItem)
void SetLink(EDA_ITEM *aItem)
BASE_SCREEN * m_screen
EDA_ITEM * GetItem() const
KICAD_T m_pickedItemType
void SetStatus(UNDO_REDO aStatus)
BASE_SCREEN * GetScreen() const
EDA_ITEM * GetLink() const
EDA_ITEM_FLAGS GetFlags() const
EDA_ITEM_FLAGS m_pickerFlags
EDA_ITEM * m_pickedItem
UNDO_REDO m_undoRedoStatus
UNDO_REDO GetStatus() const
void SetFlags(EDA_ITEM_FLAGS aFlags)
KICAD_T GetItemType() const
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.
EDA_ITEM_FLAGS GetPickerFlags(unsigned aIdx) const
Return the value of the picker flag.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
int FindItem(const EDA_ITEM *aItem) const
UNDO_REDO GetPickedItemStatus(unsigned int aIdx) const
ITEM_PICKER GetItemWrapper(unsigned int aIdx) const
EDA_ITEM * GetPickedItemLink(unsigned int aIdx) const
std::vector< ITEM_PICKER > m_ItemsList
bool RemovePicker(unsigned aIdx)
Remove one entry (one picker) from the list of picked items.
bool ContainsItem(const EDA_ITEM *aItem) const
unsigned GetCount() const
bool SetPickedItem(EDA_ITEM *aItem, unsigned aIdx)
void CopyList(const PICKED_ITEMS_LIST &aSource)
Copy all data from aSource to the list.
void ReversePickersListOrder()
Reverse the order of pickers stored in this list.
void ClearItemsList()
Delete only the list of pickers NOT the picked data itself.
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...
BASE_SCREEN * GetScreenForItem(unsigned int aIdx) const
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
bool SetPickerFlags(EDA_ITEM_FLAGS aFlags, unsigned aIdx)
Set the flags of the picker (usually to the picked item m_flags value).
A holder to handle a list of undo (or redo) commands.
void PushCommand(PICKED_ITEMS_LIST *aCommand)
PICKED_ITEMS_LIST * PopCommand()
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
std::uint32_t EDA_ITEM_FLAGS
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...