KiCad PCB EDA Suite
commit.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 2016-2017 CERN
5  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6  * @author Maciej Suminski <maciej.suminski@cern.ch>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #include <algorithm>
27 
28 #include <commit.h>
29 #include <eda_item.h>
30 
32 {
33 }
34 
35 
37 {
38  for( COMMIT_LINE& ent : m_changes )
39  {
40  if( ent.m_copy )
41  delete ent.m_copy;
42  }
43 }
44 
45 
46 COMMIT& COMMIT::Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType )
47 {
48  // CHT_MODIFY and CHT_DONE are not compatible
49  assert( ( aChangeType & ( CHT_MODIFY | CHT_DONE ) ) != ( CHT_MODIFY | CHT_DONE ) );
50 
51  int flag = aChangeType & CHT_FLAGS;
52 
53  switch( aChangeType & CHT_TYPE )
54  {
55  case CHT_ADD:
56  assert( m_changedItems.find( aItem ) == m_changedItems.end() );
57  makeEntry( aItem, CHT_ADD | flag );
58  return *this;
59 
60  case CHT_REMOVE:
61  makeEntry( aItem, CHT_REMOVE | flag );
62  return *this;
63 
64  case CHT_MODIFY:
65  {
66  EDA_ITEM* parent = parentObject( aItem );
67  EDA_ITEM* clone = nullptr;
68 
69  assert( parent );
70 
71  if( parent )
72  clone = parent->Clone();
73 
74  assert( clone );
75 
76  if( clone )
77  return createModified( parent, clone, flag );
78 
79  break;
80  }
81 
82  default:
83  assert( false );
84  }
85 
86  return *this;
87 }
88 
89 
90 COMMIT& COMMIT::Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType )
91 {
92  for( EDA_ITEM* item : container )
93  {
94  Stage( item, aChangeType );
95  }
96 
97  return *this;
98 }
99 
100 
101 COMMIT& COMMIT::Stage( const PICKED_ITEMS_LIST& aItems, UNDO_REDO aModFlag )
102 {
103  for( unsigned int i = 0; i < aItems.GetCount(); i++ )
104  {
105  UNDO_REDO change_type = aItems.GetPickedItemStatus( i );
106  EDA_ITEM* item = aItems.GetPickedItem( i );
107  EDA_ITEM* copy = NULL;
108 
109  if( change_type == UNDO_REDO::UNSPECIFIED )
110  change_type = aModFlag;
111 
112  if( ( copy = aItems.GetPickedItemLink( i ) ) )
113  {
114  assert( change_type == UNDO_REDO::CHANGED );
115 
116  // There was already a copy created, so use it
117  Modified( item, copy );
118  }
119  else
120  {
121  Stage( item, convert( change_type ) );
122  }
123  }
124 
125  return *this;
126 }
127 
128 
130 {
131  COMMIT_LINE* entry = findEntry( parentObject( aItem ) );
132 
133  return entry ? entry->m_type : 0;
134 }
135 
136 
137 template <class Container, class F>
138 void eraseIf( Container& c, F&& f )
139 {
140  c.erase( std::remove_if( c.begin(),
141  c.end(),
142  std::forward<F>( f ) ),
143  c.end() );
144 }
145 
146 
147 COMMIT& COMMIT::createModified( EDA_ITEM* aItem, EDA_ITEM* aCopy, int aExtraFlags )
148 {
149  EDA_ITEM* parent = parentObject( aItem );
150  auto entryIt = m_changedItems.find( parent );
151 
152  if( entryIt != m_changedItems.end() )
153  {
154  delete aCopy;
155  return *this; // item has been already modified once
156  }
157 
158  makeEntry( parent, CHT_MODIFY | aExtraFlags, aCopy );
159 
160  return *this;
161 }
162 
163 
164 void COMMIT::makeEntry( EDA_ITEM* aItem, CHANGE_TYPE aType, EDA_ITEM* aCopy )
165 {
166  // Expect an item copy if it is going to be modified
167  wxASSERT( !!aCopy == ( ( aType & CHT_TYPE ) == CHT_MODIFY ) );
168 
169  if( m_changedItems.find( aItem ) != m_changedItems.end() )
170  {
171  eraseIf( m_changes, [aItem] ( const COMMIT_LINE& aEnt ) {
172  return aEnt.m_item == aItem;
173  } );
174  }
175 
176  COMMIT_LINE ent;
177 
178  ent.m_item = aItem;
179  ent.m_type = aType;
180  ent.m_copy = aCopy;
181 
182  m_changedItems.insert( aItem );
183  m_changes.push_back( ent );
184 }
185 
186 
188 {
189  for( COMMIT_LINE& change : m_changes )
190  {
191  if( change.m_item == aItem )
192  return &change;
193  }
194 
195  return nullptr;
196 }
197 
198 
200 {
201  switch( aType )
202  {
203  case UNDO_REDO::NEWITEM:
204  return CHT_ADD;
205 
206  case UNDO_REDO::DELETED:
207  return CHT_REMOVE;
208 
209  default:
210  assert( false );
211  // fall through
212 
213  case UNDO_REDO::CHANGED:
214  return CHT_MODIFY;
215  }
216 }
217 
EDA_ITEM * GetPickedItemLink(unsigned int aIdx) const
virtual COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Definition: commit.cpp:46
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:43
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:129
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:164
unsigned GetCount() const
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:97
#define NULL
COMMIT_LINE * findEntry(EDA_ITEM *aItem)
Search for an entry describing change for a particular item.
Definition: commit.cpp:187
void eraseIf(Container &c, F &&f)
Definition: commit.cpp:138
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
virtual ~COMMIT()
Add a new item to the model.
Definition: commit.cpp:36
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:178
#define F(x, y, z)
Definition: md5_hash.cpp:15
A holder to handle information on schematic or board items.
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
Definition: commit.cpp:147
COMMIT & Modified(EDA_ITEM *aItem, EDA_ITEM *aCopy)
Definition: commit.h:110
CHANGE_TYPE
Types of changes.
Definition: commit.h:39
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:179
COMMIT()
Definition: commit.cpp:31
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:149
UNDO_REDO GetPickedItemStatus(unsigned int aIdx) const
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:199