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 (C) 2020-2021 KiCad Developers, see change_log.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#ifndef __COMMIT_H
29#define __COMMIT_H
30
31#include <set>
32#include <vector>
33#include <wx/string.h>
34#include <undo_redo_container.h>
35#include <kiid.h>
36
37class EDA_ITEM;
38class BASE_SCREEN;
39
48
49 CHT_DONE = 32,
51};
52
53template<typename T>
55{
56 return CHANGE_TYPE( (int) aTypeA | (int) aTypeB );
57}
58
59template<typename T>
61{
62 return CHANGE_TYPE( (int) aTypeA & (int) aTypeB );
63}
64
65
73class COMMIT
74{
75public:
76 COMMIT();
77 virtual ~COMMIT();
78
80 COMMIT& Add( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
81 {
82 return Stage( aItem, CHT_ADD, aScreen );
83 }
84
86 COMMIT& Added( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
87 {
88 return Stage( aItem, CHT_ADD | CHT_DONE, aScreen );
89 }
90
92 COMMIT& Remove( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
93 {
94 return Stage( aItem, CHT_REMOVE, aScreen );
95 }
96
98 COMMIT& Removed( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
99 {
100 return Stage( aItem, CHT_REMOVE | CHT_DONE, aScreen );
101 }
102
105 COMMIT& Modify( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr )
106 {
107 return Stage( aItem, CHT_MODIFY, aScreen );
108 }
109
112 COMMIT& Modified( EDA_ITEM* aItem, EDA_ITEM* aCopy, BASE_SCREEN *aScreen = nullptr )
113 {
114 return createModified( aItem, aCopy );
115 }
116
117 template<class Range>
118
119 COMMIT& StageItems( const Range& aRange, CHANGE_TYPE aChangeType )
120 {
121 for( const auto& item : aRange )
122 Stage( item, aChangeType );
123
124 return *this;
125 }
126
128 virtual COMMIT& Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType,
129 BASE_SCREEN *aScreen = nullptr );
130
131 virtual COMMIT& Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType,
132 BASE_SCREEN *aScreen = nullptr );
133
134 virtual COMMIT& Stage( const PICKED_ITEMS_LIST& aItems,
135 UNDO_REDO aModFlag = UNDO_REDO::UNSPECIFIED,
136 BASE_SCREEN *aScreen = nullptr );
137
139 virtual void Push( const wxString& aMessage = wxT( "A commit" ), int aFlags = 0 ) = 0;
140
142 virtual void Revert() = 0;
143
144 bool Empty() const
145 {
146 return m_changes.empty();
147 }
148
150 int GetStatus( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr );
151
152 EDA_ITEM* GetFirst() const { return m_changes.empty() ? nullptr : m_changes[0].m_item; }
153
154protected:
156 {
162 };
163
164 // Should be called in Push() & Revert() methods
165 void clear()
166 {
167 m_changedItems.clear();
168 m_deletedItems.clear();
169 m_changes.clear();
170 }
171
172 COMMIT& createModified( EDA_ITEM* aItem, EDA_ITEM* aCopy, int aExtraFlags = 0,
173 BASE_SCREEN *aScreen = nullptr );
174
175 virtual void makeEntry( EDA_ITEM* aItem, CHANGE_TYPE aType, EDA_ITEM* aCopy = nullptr,
176 BASE_SCREEN *aScreen = nullptr );
177
183 COMMIT_LINE* findEntry( EDA_ITEM* aItem, BASE_SCREEN *aScreen = nullptr );
184
185 virtual EDA_ITEM* parentObject( EDA_ITEM* aItem ) const = 0;
186
187 virtual EDA_ITEM* makeImage( EDA_ITEM* aItem ) const = 0;
188
189 CHANGE_TYPE convert( UNDO_REDO aType ) const;
190 UNDO_REDO convert( CHANGE_TYPE aType ) const;
191
192protected:
193 std::set<EDA_ITEM*> m_changedItems;
194 std::set<EDA_ITEM*> m_deletedItems;
195 std::vector<COMMIT_LINE> m_changes;
196};
197
198#endif
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:74
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been removed.
Definition: commit.h:92
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType, BASE_SCREEN *aScreen=nullptr)
Definition: commit.cpp:48
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Create an undo entry for an item that has been already modified.
Definition: commit.h:105
virtual void Revert()=0
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Remove a new item from the model.
Definition: commit.h:86
COMMIT & StageItems(const Range &aRange, CHANGE_TYPE aChangeType)
Add a change of the item aItem of type aChangeType to the change list.
Definition: commit.h:119
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0, BASE_SCREEN *aScreen=nullptr)
Definition: commit.cpp:137
std::set< EDA_ITEM * > m_deletedItems
Definition: commit.h:194
COMMIT & Modified(EDA_ITEM *aItem, EDA_ITEM *aCopy, BASE_SCREEN *aScreen=nullptr)
Definition: commit.h:112
virtual void Push(const wxString &aMessage=wxT("A commit"), int aFlags=0)=0
Revert the commit by restoring the modified items state.
bool Empty() const
Returns status of an item.
Definition: commit.h:144
COMMIT()
Definition: commit.cpp:33
virtual ~COMMIT()
Add a new item to the model.
Definition: commit.cpp:38
COMMIT_LINE * findEntry(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Search for an entry describing change for a particular item.
Definition: commit.cpp:170
virtual void makeEntry(EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=nullptr, BASE_SCREEN *aScreen=nullptr)
Definition: commit.cpp:153
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
Definition: commit.h:80
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:193
EDA_ITEM * GetFirst() const
Definition: commit.h:152
COMMIT & Removed(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Modify a given item in the model.
Definition: commit.h:98
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const =0
virtual EDA_ITEM * makeImage(EDA_ITEM *aItem) const =0
int GetStatus(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Definition: commit.cpp:129
void clear()
Definition: commit.h:165
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:195
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
Definition: kiid.h:49
A holder to handle information on schematic or board items.
CHANGE_TYPE operator|(CHANGE_TYPE aTypeA, T aTypeB)
Definition: commit.h:54
CHANGE_TYPE
Types of changes.
Definition: commit.h:41
@ CHT_MODIFY
Definition: commit.h:44
@ CHT_GROUP
Definition: commit.h:45
@ CHT_REMOVE
Definition: commit.h:43
@ CHT_DONE
Flag to indicate the change is already applied.
Definition: commit.h:49
@ CHT_TYPE
Definition: commit.h:47
@ CHT_ADD
Definition: commit.h:42
@ CHT_UNGROUP
Definition: commit.h:46
@ CHT_FLAGS
Definition: commit.h:50
CHANGE_TYPE operator&(CHANGE_TYPE aTypeA, T aTypeB)
Definition: commit.h:60
KIID & NilUuid()
Definition: kiid.cpp:67
EDA_ITEM * m_copy
Optional copy of the item.
Definition: commit.h:158
CHANGE_TYPE m_type
Modification type.
Definition: commit.h:159
KIID m_parent
Parent item (primarily for undo of deleted items)
Definition: commit.h:160
EDA_ITEM * m_item
Main item that is added/deleted/modified.
Definition: commit.h:157
BASE_SCREEN * m_screen
Definition: commit.h:161
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...