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 <base_struct.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 
102 {
103  for( unsigned int i = 0; i < aItems.GetCount(); i++ )
104  {
105  UNDO_REDO_T change_type = aItems.GetPickedItemStatus( i );
106  EDA_ITEM* item = aItems.GetPickedItem( i );
107  EDA_ITEM* copy = NULL;
108 
109  if( change_type == UR_UNSPECIFIED )
110  change_type = aItems.m_Status;
111 
112  if( change_type == UR_UNSPECIFIED )
113  change_type = aModFlag;
114 
115  if( ( copy = aItems.GetPickedItemLink( i ) ) )
116  {
117  assert( change_type == UR_CHANGED );
118 
119  // There was already a copy created, so use it
120  Modified( item, copy );
121  }
122  else
123  {
124  Stage( item, convert( change_type ) );
125  }
126  }
127 
128  return *this;
129 }
130 
131 
133 {
134  COMMIT_LINE* entry = findEntry( parentObject( aItem ) );
135 
136  return entry ? entry->m_type : 0;
137 }
138 
139 
140 template <class Container, class F>
141 void eraseIf( Container& c, F&& f )
142 {
143  c.erase( std::remove_if( c.begin(),
144  c.end(),
145  std::forward<F>( f ) ),
146  c.end() );
147 }
148 
149 
150 COMMIT& COMMIT::createModified( EDA_ITEM* aItem, EDA_ITEM* aCopy, int aExtraFlags )
151 {
152  EDA_ITEM* parent = parentObject( aItem );
153  auto entryIt = m_changedItems.find( parent );
154 
155  if( entryIt != m_changedItems.end() )
156  {
157  delete aCopy;
158  return *this; // item has been already modified once
159  }
160 
161  makeEntry( parent, CHT_MODIFY | aExtraFlags, aCopy );
162 
163  return *this;
164 }
165 
166 
167 void COMMIT::makeEntry( EDA_ITEM* aItem, CHANGE_TYPE aType, EDA_ITEM* aCopy )
168 {
169  // Expect an item copy if it is going to be modified
170  assert( !!aCopy == ( ( aType & CHT_TYPE ) == CHT_MODIFY ) );
171 
172  if( m_changedItems.find( aItem ) != m_changedItems.end() )
173  {
174  eraseIf( m_changes, [aItem] ( const COMMIT_LINE& aEnt ) {
175  return aEnt.m_item == aItem;
176  } );
177  }
178 
179  COMMIT_LINE ent;
180 
181  ent.m_item = aItem;
182  ent.m_type = aType;
183  ent.m_copy = aCopy;
184 
185  m_changedItems.insert( aItem );
186  m_changes.push_back( ent );
187 }
188 
189 
191 {
192  for( COMMIT_LINE& change : m_changes )
193  {
194  if( change.m_item == aItem )
195  return &change;
196  }
197 
198  return nullptr;
199 }
200 
201 
203 {
204  switch( aType )
205  {
206  case UR_NEW:
207  return CHT_ADD;
208 
209  case UR_DELETED:
210  return CHT_REMOVE;
211 
212  default:
213  assert( false );
214  // fall through
215 
216  case UR_CHANGED:
217  case UR_MOVED:
218  case UR_MIRRORED_X:
219  case UR_MIRRORED_Y:
220  case UR_ROTATED:
222  case UR_FLIPPED:
223  return CHT_MODIFY;
224  }
225 }
226 
EDA_ITEM * GetPickedItemLink(unsigned int aIdx) const
Function GetPickedItemLink.
COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
Adds a change of the item aItem of type aChangeType to the change list.
Definition: commit.cpp:46
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
CHANGE_TYPE m_type
Modification type
Definition: commit.h:157
Definition: commit.h:38
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
Class COMMIT.
Definition: commit.h:71
int GetStatus(EDA_ITEM *aItem)
Returns status of an item.
Definition: commit.cpp:132
EDA_ITEM * m_item
Main item that is added/deleted/modified
Definition: commit.h:151
unsigned GetCount() const
Function GetCount.
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
COMMIT_LINE * findEntry(EDA_ITEM *aItem)
Searches for an entry describing change for a particular item.
Definition: commit.cpp:190
void eraseIf(Container &c, F &&f)
Definition: commit.cpp:141
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
Function GetPickedItem.
virtual ~COMMIT()
Definition: commit.cpp:36
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
#define F(x, y, z)
Definition: md5_hash.cpp:15
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
Definition: commit.cpp:150
COMMIT & Modified(EDA_ITEM *aItem, EDA_ITEM *aCopy)
Creates an undo entry for an item that has been already modified.
Definition: commit.h:110
CHANGE_TYPE
Types of changes
Definition: commit.h:37
UNDO_REDO_T GetPickedItemStatus(unsigned int aIdx) const
Function GetPickedItemStatus.
size_t i
Definition: json11.cpp:597
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182
COMMIT()
Definition: commit.cpp:31
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
CHANGE_TYPE convert(UNDO_REDO_T aType) const
Definition: commit.cpp:202
EDA_ITEM * m_copy
Optional copy of the item
Definition: commit.h:154
Basic classes for most KiCad items.
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const =0
virtual void makeEntry(EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=NULL)
Definition: commit.cpp:167