KiCad PCB EDA Suite
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 <tomasz.wlostowski@cern.ch>
8  * @author Maciej Suminski <maciej.suminski@cern.ch>
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 
36 class EDA_ITEM;
37 
40  CHT_ADD = 1,
44 
47  CHT_DONE = 8,
49 };
50 
51 template<typename T>
52 CHANGE_TYPE operator|( CHANGE_TYPE aTypeA, T aTypeB )
53 {
54  return CHANGE_TYPE( (int) aTypeA | (int) aTypeB );
55 }
56 
57 template<typename T>
58 CHANGE_TYPE operator&( CHANGE_TYPE aTypeA, T aTypeB )
59 {
60  return CHANGE_TYPE( (int) aTypeA & (int) aTypeB );
61 }
62 
63 
71 class COMMIT
72 {
73 public:
74  COMMIT();
75  virtual ~COMMIT();
76 
78  COMMIT& Add( EDA_ITEM* aItem )
79  {
80  return Stage( aItem, CHT_ADD );
81  }
82 
84  COMMIT& Added( EDA_ITEM* aItem )
85  {
86  return Stage( aItem, CHT_ADD | CHT_DONE );
87  }
88 
90  COMMIT& Remove( EDA_ITEM* aItem )
91  {
92  return Stage( aItem, CHT_REMOVE );
93  }
94 
96  COMMIT& Removed( EDA_ITEM* aItem )
97  {
98  return Stage( aItem, CHT_REMOVE | CHT_DONE );
99  }
100 
103  COMMIT& Modify( EDA_ITEM* aItem )
104  {
105  return Stage( aItem, CHT_MODIFY );
106  }
107 
110  COMMIT& Modified( EDA_ITEM* aItem, EDA_ITEM* aCopy )
111  {
112  return createModified( aItem, aCopy );
113  }
114 
115  template<class Range>
116 
117  COMMIT& StageItems( const Range& aRange, CHANGE_TYPE aChangeType )
118  {
119  for( const auto& item : aRange )
120  Stage( item, aChangeType );
121 
122  return *this;
123  }
124 
126  virtual COMMIT& Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType );
127 
128  virtual COMMIT& Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType );
129 
130  virtual COMMIT& Stage( const PICKED_ITEMS_LIST& aItems,
131  UNDO_REDO aModFlag = UNDO_REDO::UNSPECIFIED );
132 
134  virtual void Push( const wxString& aMessage = wxT( "A commit" ),
135  bool aCreateUndoEntry = true, bool aSetDirtyBit = true ) = 0;
136 
138  virtual void Revert() = 0;
139 
140  bool Empty() const
141  {
142  return m_changes.empty();
143  }
144 
146  int GetStatus( EDA_ITEM* aItem );
147 
148 protected:
149  struct COMMIT_LINE
150  {
154  };
155 
156  // Should be called in Push() & Revert() methods
157  void clear()
158  {
159  m_changedItems.clear();
160  m_changes.clear();
161  }
162 
163  COMMIT& createModified( EDA_ITEM* aItem, EDA_ITEM* aCopy, int aExtraFlags = 0 );
164 
165  virtual void makeEntry( EDA_ITEM* aItem, CHANGE_TYPE aType, EDA_ITEM* aCopy = nullptr );
166 
172  COMMIT_LINE* findEntry( EDA_ITEM* aItem );
173 
174  virtual EDA_ITEM* parentObject( EDA_ITEM* aItem ) const = 0;
175 
176  CHANGE_TYPE convert( UNDO_REDO aType ) const;
177 
178  std::set<EDA_ITEM*> m_changedItems;
179  std::vector<COMMIT_LINE> m_changes;
180 };
181 
182 #endif
virtual void Revert()=0
COMMIT & Modify(EDA_ITEM *aItem)
Create an undo entry for an item that has been already modified.
Definition: commit.h:103
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Definition: commit.cpp:47
COMMIT & Added(EDA_ITEM *aItem)
Remove a new item from the model.
Definition: commit.h:84
void clear()
Definition: commit.h:157
COMMIT & Add(EDA_ITEM *aItem)
Notify observers that aItem has been added.
Definition: commit.h:78
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:43
CHANGE_TYPE operator &(CHANGE_TYPE aTypeA, T aTypeB)
Definition: commit.h:58
CHANGE_TYPE m_type
Modification type.
Definition: commit.h:153
Definition: commit.h:40
Represent a set of changes (additions, deletions or modifications) of a data model (e....
Definition: commit.h:71
int GetStatus(EDA_ITEM *aItem)
Definition: commit.cpp:130
EDA_ITEM * m_item
Main item that is added/deleted/modified.
Definition: commit.h:151
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
virtual void makeEntry(EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=nullptr)
Definition: commit.cpp:165
CHANGE_TYPE operator|(CHANGE_TYPE aTypeA, T aTypeB)
Definition: commit.h:52
COMMIT & Removed(EDA_ITEM *aItem)
Modify a given item in the model.
Definition: commit.h:96
COMMIT_LINE * findEntry(EDA_ITEM *aItem)
Search for an entry describing change for a particular item.
Definition: commit.cpp:188
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:117
virtual ~COMMIT()
Add a new item to the model.
Definition: commit.cpp:37
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:178
COMMIT & Remove(EDA_ITEM *aItem)
Notify observers that aItem has been removed.
Definition: commit.h:90
A holder to handle information on schematic or board items.
bool Empty() const
Returns status of an item.
Definition: commit.h:140
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
Definition: commit.cpp:148
COMMIT & Modified(EDA_ITEM *aItem, EDA_ITEM *aCopy)
Definition: commit.h:110
CHANGE_TYPE
Types of changes.
Definition: commit.h:39
virtual void Push(const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true, bool aSetDirtyBit=true)=0
Revert the commit by restoring the modified items state.
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:179
COMMIT()
Definition: commit.cpp:32
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
EDA_ITEM * m_copy
Optional copy of the item.
Definition: commit.h:152
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const =0
CHANGE_TYPE convert(UNDO_REDO aType) const
Definition: commit.cpp:200