KiCad PCB EDA Suite
Loading...
Searching...
No Matches
commit.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 2016-2017 CERN
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Tomasz Wlostowski <[email protected]>
8 * @author Maciej Suminski <[email protected]>
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, you may find one here:
22 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
23 * or you may search the http://www.gnu.org website for the version 2 license,
24 * or you may write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 */
27
28#pragma once
29
30#include <set>
31#include <vector>
32#include <wx/string.h>
33#include <undo_redo_container.h>
34#include <kiid.h>
35#include <eda_item.h>
36
37class EDA_GROUP;
38class BASE_SCREEN;
39
50
51template<typename T>
53{
54 return CHANGE_TYPE( (int) aTypeA | (int) aTypeB );
55}
56
57template<typename T>
59{
60 return CHANGE_TYPE( (int) aTypeA & (int) aTypeB );
61}
62
63
71class COMMIT
72{
73public:
74 COMMIT();
75 virtual ~COMMIT();
76
78 COMMIT& Add( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
79 {
80 return Stage( aItem, CHT_ADD, aScreen );
81 }
82
84 COMMIT& Added( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
85 {
86 return Stage( aItem, CHT_ADD | CHT_DONE, aScreen );
87 }
88
90 COMMIT& Remove( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
91 {
92 return Stage( aItem, CHT_REMOVE, aScreen );
93 }
94
96 COMMIT& Removed( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
97 {
98 return Stage( aItem, CHT_REMOVE | CHT_DONE, aScreen );
99 }
100
106 COMMIT& Modify( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr,
108 {
109 return Stage( aItem, CHT_MODIFY, aScreen, aRecurse );
110 }
111
117 COMMIT& Modified( EDA_ITEM* aItem, EDA_ITEM* aCopy, BASE_SCREEN *aScreen = nullptr );
118
120 virtual COMMIT& Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen = nullptr,
122
123 virtual COMMIT& Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType,
124 BASE_SCREEN *aScreen = nullptr );
125
126 virtual COMMIT& Stage( const PICKED_ITEMS_LIST& aItems, UNDO_REDO aModFlag = UNDO_REDO::UNSPECIFIED,
127 BASE_SCREEN *aScreen = nullptr );
128
129 void Unstage( EDA_ITEM* aItem, BASE_SCREEN* aScreen );
130
132 virtual void Push( const wxString& aMessage = wxT( "A commit" ), int aFlags = 0 ) = 0;
133
135 virtual void Revert() = 0;
136
137 bool Empty() const
138 {
139 return m_entries.empty();
140 }
141
143 int GetStatus( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr );
144
145 EDA_ITEM* GetFirst() const { return m_entries.empty() ? nullptr : m_entries[0].m_item; }
146
147protected:
155
157 void clear()
158 {
159 m_changedItems.clear();
160 m_deletedItems.clear();
161 m_entries.clear();
162 }
163
164 virtual void makeEntry( EDA_ITEM* aItem, CHANGE_TYPE aType, EDA_ITEM* aCopy = nullptr,
165 BASE_SCREEN *aScreen = nullptr );
166
172 COMMIT_LINE* findEntry( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr );
173
174 virtual EDA_ITEM* undoLevelItem( EDA_ITEM* aItem ) const = 0;
175
176 virtual EDA_ITEM* makeImage( EDA_ITEM* aItem ) const = 0;
177
178 CHANGE_TYPE convert( UNDO_REDO aType ) const;
179 UNDO_REDO convert( CHANGE_TYPE aType ) const;
180
181protected:
182 std::set<std::pair<EDA_ITEM*, BASE_SCREEN*>> m_addedItems;
183 std::set<std::pair<EDA_ITEM*, BASE_SCREEN*>> m_changedItems;
184 std::set<std::pair<EDA_ITEM*, BASE_SCREEN*>> m_deletedItems;
185 std::vector<COMMIT_LINE> m_entries;
186};
187
Handles how to draw a screen (a board, a schematic ...)
Definition base_screen.h:41
Represent a set of changes (additions, deletions or modifications) of a data model (e....
Definition commit.h:72
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Remove a new item from the model.
Definition commit.h:90
std::set< std::pair< EDA_ITEM *, BASE_SCREEN * > > m_deletedItems
Definition commit.h:184
virtual EDA_ITEM * undoLevelItem(EDA_ITEM *aItem) const =0
virtual void Revert()=0
Revert the commit by restoring the modified items state.
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
Definition commit.h:84
void Unstage(EDA_ITEM *aItem, BASE_SCREEN *aScreen)
Definition commit.cpp:136
COMMIT & Modified(EDA_ITEM *aItem, EDA_ITEM *aCopy, BASE_SCREEN *aScreen=nullptr)
Create an undo entry for an item that has been already modified.
Definition commit.cpp:156
virtual void Push(const wxString &aMessage=wxT("A commit"), int aFlags=0)=0
Execute the changes.
bool Empty() const
Definition commit.h:137
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition commit.h:106
COMMIT()
Definition commit.cpp:34
virtual ~COMMIT()
Definition commit.cpp:39
COMMIT_LINE * findEntry(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Search for an entry describing change for a particular item.
Definition commit.cpp:199
std::set< std::pair< EDA_ITEM *, BASE_SCREEN * > > m_addedItems
Definition commit.h:182
virtual void makeEntry(EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=nullptr, BASE_SCREEN *aScreen=nullptr)
Definition commit.cpp:175
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
Definition commit.h:78
std::vector< COMMIT_LINE > m_entries
Definition commit.h:185
EDA_ITEM * GetFirst() const
Definition commit.h:145
std::set< std::pair< EDA_ITEM *, BASE_SCREEN * > > m_changedItems
Definition commit.h:183
COMMIT & Removed(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Definition commit.h:96
virtual EDA_ITEM * makeImage(EDA_ITEM *aItem) const =0
int GetStatus(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Returns status of an item.
Definition commit.cpp:167
void clear()
Should be called in Push() & Revert() methods.
Definition commit.h:157
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Add a change of the item aItem of type aChangeType to the change list.
Definition commit.cpp:46
A set of EDA_ITEMs (i.e., without duplicates).
Definition eda_group.h:46
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
A holder to handle information on schematic or board items.
CHANGE_TYPE operator|(CHANGE_TYPE aTypeA, T aTypeB)
Definition commit.h:52
CHANGE_TYPE
Types of changes.
Definition commit.h:41
@ CHT_MODIFY
Definition commit.h:44
@ CHT_REMOVE
Definition commit.h:43
@ CHT_DONE
Flag to indicate the change is already applied.
Definition commit.h:47
@ CHT_TYPE
Definition commit.h:45
@ CHT_ADD
Definition commit.h:42
@ CHT_FLAGS
Definition commit.h:48
CHANGE_TYPE operator&(CHANGE_TYPE aTypeA, T aTypeB)
Definition commit.h:58
RECURSE_MODE
Definition eda_item.h:50
@ NO_RECURSE
Definition eda_item.h:52
EDA_ITEM * m_copy
Optional copy of the item.
Definition commit.h:151
CHANGE_TYPE m_type
Modification type.
Definition commit.h:152
EDA_ITEM * m_item
Main item that is added/deleted/modified.
Definition commit.h:150
BASE_SCREEN * m_screen
Definition commit.h:153
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...