KiCad PCB EDA Suite
Loading...
Searching...
No Matches
symbol_editor_undo_redo.cpp
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) 2007 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2014-2023 KiCad Developers, see AUTHORS.TXT for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#include <symbol_edit_frame.h>
27#include <widgets/lib_tree.h>
28#include <symbol_tree_pane.h>
29#include <tool/tool_manager.h>
30#include <tools/ee_actions.h>
32
33
34void SYMBOL_EDIT_FRAME::PushSymbolToUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbolCopy,
35 UNDO_REDO aUndoType )
36{
37 if( !aSymbolCopy )
38 return;
39
40 PICKED_ITEMS_LIST* lastcmd = new PICKED_ITEMS_LIST();
41
42 // Clear current flags (which can be temporary set by a current edit command).
43 aSymbolCopy->ClearTempFlags();
44 aSymbolCopy->ClearEditFlags();
45 aSymbolCopy->SetFlags( UR_TRANSIENT );
46
47 ITEM_PICKER wrapper( GetScreen(), aSymbolCopy, aUndoType );
48 lastcmd->PushItem( wrapper );
49 lastcmd->SetDescription( aDescription );
50 PushCommandToUndoList( lastcmd );
51
52 // Clear redo list, because after new save there is no redo to do.
54}
55
56
57void SYMBOL_EDIT_FRAME::SaveCopyInUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbol,
58 UNDO_REDO aUndoType )
59{
60 if( aSymbol )
61 PushSymbolToUndoList( aDescription, new LIB_SYMBOL( *aSymbol ), aUndoType );
62}
63
64
66{
67 if( GetRedoCommandCount() <= 0 )
68 return;
69
70 // Load the last redo entry
72 ITEM_PICKER redoWrapper = redoCommand->PopItem();
73 wxString description = redoCommand->GetDescription();
74
75 delete redoCommand;
76
77 LIB_SYMBOL* symbol = (LIB_SYMBOL*) redoWrapper.GetItem();
78 UNDO_REDO undoRedoType = redoWrapper.GetStatus();
79 wxCHECK( symbol, /* void */ );
80 symbol->ClearFlags( UR_TRANSIENT );
81
82 // Store the current symbol in the undo buffer
83 PICKED_ITEMS_LIST* undoCommand = new PICKED_ITEMS_LIST();
84 LIB_SYMBOL* oldSymbol = m_symbol;
85
86 oldSymbol->SetFlags( UR_TRANSIENT );
87 ITEM_PICKER undoWrapper( GetScreen(), oldSymbol, undoRedoType );
88 undoCommand->SetDescription( description );
89 undoCommand->PushItem( undoWrapper );
90 PushCommandToUndoList( undoCommand );
91
92 // Do not delete the previous symbol by calling SetCurSymbol( symbol )
93 // which calls delete <previous symbol>.
94 // <previous symbol> is now put in undo list and is owned by this list
95 // Just set the current symbol to the symbol which come from the redo list
96 m_symbol = symbol;
97
98 if( undoRedoType == UNDO_REDO::LIB_RENAME )
99 {
100 wxString lib = GetCurLib();
101 m_libMgr->UpdateSymbolAfterRename( symbol, oldSymbol->GetName(), lib );
102
103 // Reselect the renamed symbol
104 m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, symbol->GetName() ) );
105 }
106
109 UpdateTitle();
110
111 RebuildView();
112 OnModify();
113}
114
115
117{
118 if( GetUndoCommandCount() <= 0 )
119 return;
120
121 // Load the last undo entry
123 wxString description = undoCommand->GetDescription();
124 ITEM_PICKER undoWrapper = undoCommand->PopItem();
125
126 delete undoCommand;
127
128 LIB_SYMBOL* symbol = (LIB_SYMBOL*) undoWrapper.GetItem();
129 UNDO_REDO undoRedoType = undoWrapper.GetStatus();
130 wxCHECK( symbol, /* void */ );
131 symbol->ClearFlags( UR_TRANSIENT );
132
133 // Store the current symbol in the redo buffer
134 PICKED_ITEMS_LIST* redoCommand = new PICKED_ITEMS_LIST();
135 LIB_SYMBOL* oldSymbol = m_symbol;
136
137 oldSymbol->SetFlags( UR_TRANSIENT );
138 ITEM_PICKER redoWrapper( GetScreen(), oldSymbol, undoRedoType );
139 redoCommand->PushItem( redoWrapper );
140 redoCommand->SetDescription( description );
141 PushCommandToRedoList( redoCommand );
142
143 // Do not delete the previous symbol by calling SetCurSymbol( symbol ),
144 // which calls delete <previous symbol>.
145 // <previous symbol> is now put in redo list and is owned by this list.
146 // Just set the current symbol to the symbol which come from the undo list
147 m_symbol = symbol;
148
149 if( undoRedoType == UNDO_REDO::LIB_RENAME )
150 {
151 wxString lib = GetCurLib();
152 m_libMgr->UpdateSymbolAfterRename( symbol, oldSymbol->GetName(), lib );
153
154 // Reselect the renamed symbol
155 m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, symbol->GetName() ) );
156 }
157
160 UpdateTitle();
161
162 RebuildView();
163 OnModify();
164}
165
166
virtual void PushCommandToUndoList(PICKED_ITEMS_LIST *aItem)
Add a command to undo in the undo list.
virtual int GetRedoCommandCount() const
virtual PICKED_ITEMS_LIST * PopCommandFromRedoList()
Return the last command to undo and remove it from list, nothing is deleted.
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.
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:123
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:125
EDA_ITEM * GetItem() const
UNDO_REDO GetStatus() const
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Define a library symbol object.
Definition: lib_symbol.h:99
bool HasAlternateBodyStyle() const
Test if symbol has more than one body conversion type (DeMorgan).
void ClearTempFlags()
Clears the status flag all draw objects in this symbol.
wxString GetName() const override
Definition: lib_symbol.h:160
void ClearEditFlags()
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:314
A holder to handle information on schematic or board items.
void PushItem(const ITEM_PICKER &aItem)
Push aItem to the top of the list.
void SetDescription(const wxString &aDescription)
wxString GetDescription() const
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
LIB_SYMBOL_LIBRARY_MANAGER * m_libMgr
wxString GetCurLib() const
The nickname of the current library being edited and empty string if none.
void PushSymbolToUndoList(const wxString &aDescription, LIB_SYMBOL *aSymbolCopy, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)
void SaveCopyInUndoList(const wxString &aDescription, LIB_SYMBOL *aSymbol, UNDO_REDO aUndoType=UNDO_REDO::LIBEDIT)
Create a copy of the current symbol, and save it in the undo list.
void ClearUndoORRedoList(UNDO_REDO_LIST whichList, int aItemCount=-1) override
Free the undo or redo list from aList element.
void UpdateTitle()
Update the main window title bar with the current library name and read only status of the library.
SYMBOL_TREE_PANE * m_treePane
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag of the current symbol.
void SetShowDeMorgan(bool show)
bool UpdateSymbolAfterRename(LIB_SYMBOL *aSymbol, const wxString &oldAlias, const wxString &aLibrary)
Update the symbol buffer with a new version of the symbol when the name has changed.
LIB_TREE * GetLibTree() const
#define UR_TRANSIENT
indicates the item is owned by the undo/redo stack
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...