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>
33
34
35void SYMBOL_EDIT_FRAME::PushSymbolToUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbolCopy,
36 UNDO_REDO aUndoType )
37{
38 if( !aSymbolCopy )
39 return;
40
41 auto* drawingTool = GetToolManager()->GetTool<SYMBOL_EDITOR_DRAWING_TOOLS>();
42
43 PICKED_ITEMS_LIST* lastcmd = new PICKED_ITEMS_LIST();
44
45 // Clear current flags (which can be temporary set by a current edit command).
46 aSymbolCopy->ClearTempFlags();
47 aSymbolCopy->ClearEditFlags();
48 aSymbolCopy->SetFlags( UR_TRANSIENT );
49
50 ITEM_PICKER wrapper( GetScreen(), aSymbolCopy, aUndoType );
51 wrapper.SetGroupId( drawingTool->GetLastPin() );
52 lastcmd->PushItem( wrapper );
53 lastcmd->SetDescription( aDescription );
54 PushCommandToUndoList( lastcmd );
55
56 // Clear redo list, because after new save there is no redo to do.
58}
59
60
61void SYMBOL_EDIT_FRAME::SaveCopyInUndoList( const wxString& aDescription, LIB_SYMBOL* aSymbol,
62 UNDO_REDO aUndoType )
63{
64 if( aSymbol )
65 PushSymbolToUndoList( aDescription, new LIB_SYMBOL( *aSymbol ), aUndoType );
66}
67
68
70{
71 if( GetRedoCommandCount() <= 0 )
72 return;
73
74 auto* drawingTool = GetToolManager()->GetTool<SYMBOL_EDITOR_DRAWING_TOOLS>();
75
76 // Load the last redo entry
78 ITEM_PICKER redoWrapper = redoCommand->PopItem();
79 wxString description = redoCommand->GetDescription();
80
81 delete redoCommand;
82
83 LIB_SYMBOL* symbol = (LIB_SYMBOL*) redoWrapper.GetItem();
84 KIID lastPin = redoWrapper.GetGroupId();
85 UNDO_REDO undoRedoType = redoWrapper.GetStatus();
86 wxCHECK( symbol, /* void */ );
87 symbol->ClearFlags( UR_TRANSIENT );
88
89 // Store the current symbol in the undo buffer
90 PICKED_ITEMS_LIST* undoCommand = new PICKED_ITEMS_LIST();
91 LIB_SYMBOL* oldSymbol = m_symbol;
92
93 oldSymbol->SetFlags( UR_TRANSIENT );
94 ITEM_PICKER undoWrapper( GetScreen(), oldSymbol, undoRedoType );
95 undoWrapper.SetGroupId( drawingTool->GetLastPin() );
96 undoCommand->SetDescription( description );
97 undoCommand->PushItem( undoWrapper );
98 PushCommandToUndoList( undoCommand );
99
100 // Do not delete the previous symbol by calling SetCurSymbol( symbol )
101 // which calls delete <previous symbol>.
102 // <previous symbol> is now put in undo list and is owned by this list
103 // Just set the current symbol to the symbol which come from the redo list
104 m_symbol = symbol;
105 drawingTool->SetLastPin( lastPin );
106
107 if( undoRedoType == UNDO_REDO::LIB_RENAME )
108 {
109 wxString lib = GetCurLib();
110 m_libMgr->UpdateSymbolAfterRename( symbol, oldSymbol->GetName(), lib );
111
112 // Reselect the renamed symbol
113 m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, symbol->GetName() ) );
114 }
115
118 UpdateTitle();
119
120 RebuildView();
121 OnModify();
122}
123
124
126{
127 if( GetUndoCommandCount() <= 0 )
128 return;
129
130 auto* drawingTool = GetToolManager()->GetTool<SYMBOL_EDITOR_DRAWING_TOOLS>();
131
132 // Load the last undo entry
134 wxString description = undoCommand->GetDescription();
135 ITEM_PICKER undoWrapper = undoCommand->PopItem();
136
137 delete undoCommand;
138
139 LIB_SYMBOL* symbol = (LIB_SYMBOL*) undoWrapper.GetItem();
140 KIID lastPin = undoWrapper.GetGroupId();
141 UNDO_REDO undoRedoType = undoWrapper.GetStatus();
142 wxCHECK( symbol, /* void */ );
143 symbol->ClearFlags( UR_TRANSIENT );
144
145 // Store the current symbol in the redo buffer
146 PICKED_ITEMS_LIST* redoCommand = new PICKED_ITEMS_LIST();
147 LIB_SYMBOL* oldSymbol = m_symbol;
148
149 oldSymbol->SetFlags( UR_TRANSIENT );
150 ITEM_PICKER redoWrapper( GetScreen(), oldSymbol, undoRedoType );
151 redoWrapper.SetGroupId( drawingTool->GetLastPin() );
152 redoCommand->PushItem( redoWrapper );
153 redoCommand->SetDescription( description );
154 PushCommandToRedoList( redoCommand );
155
156 // Do not delete the previous symbol by calling SetCurSymbol( symbol ),
157 // which calls delete <previous symbol>.
158 // <previous symbol> is now put in redo list and is owned by this list.
159 // Just set the current symbol to the symbol which come from the undo list
160 m_symbol = symbol;
161 drawingTool->SetLastPin( lastPin );
162
163 if( undoRedoType == UNDO_REDO::LIB_RENAME )
164 {
165 wxString lib = GetCurLib();
166 m_libMgr->UpdateSymbolAfterRename( symbol, oldSymbol->GetName(), lib );
167
168 // Reselect the renamed symbol
169 m_treePane->GetLibTree()->SelectLibId( LIB_ID( lib, symbol->GetName() ) );
170 }
171
174 UpdateTitle();
175
176 RebuildView();
177 OnModify();
178}
179
180
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:127
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:129
void SetGroupId(KIID aId)
EDA_ITEM * GetItem() const
KIID GetGroupId() const
UNDO_REDO GetStatus() const
Definition: kiid.h:49
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:78
void ClearTempFlags() override
Clears the status flag all draw objects in this symbol.
bool HasAlternateBodyStyle() const override
Test if symbol has more than one body conversion type (DeMorgan).
wxString GetName() const override
Definition: lib_symbol.h:137
void ClearEditFlags() override
void SelectLibId(const LIB_ID &aLibId)
Select an item in the tree widget.
Definition: lib_tree.cpp:343
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)
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
SYMBOL_EDITOR_DRAWING_TOOLS.
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
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
#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...