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 <commit.h>
27 #include <base_struct.h>
28 
30 {
31 }
32 
33 
35 {
36  for( COMMIT_LINE& ent : m_changes )
37  {
38  if( ent.m_copy )
39  delete ent.m_copy;
40  }
41 }
42 
43 
44 COMMIT& COMMIT::Stage( EDA_ITEM* aItem, CHANGE_TYPE aChangeType )
45 {
46  // CHT_MODIFY and CHT_DONE are not compatible
47  assert( ( aChangeType & ( CHT_MODIFY | CHT_DONE ) ) != ( CHT_MODIFY | CHT_DONE ) );
48 
49  int flag = aChangeType & CHT_FLAGS;
50 
51  switch( aChangeType & CHT_TYPE )
52  {
53  case CHT_ADD:
54  assert( m_changedItems.find( aItem ) == m_changedItems.end() );
55  makeEntry( aItem, CHT_ADD | flag );
56  return *this;
57 
58  case CHT_REMOVE:
59  makeEntry( aItem, CHT_REMOVE | flag );
60  return *this;
61 
62  case CHT_MODIFY:
63  {
64  EDA_ITEM* parent = parentObject( aItem );
65  return createModified( parent, parent->Clone(), flag );
66  }
67 
68  default:
69  assert( false );
70  }
71 
72  return *this;
73 }
74 
75 
76 COMMIT& COMMIT::Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType )
77 {
78  for( EDA_ITEM* item : container )
79  {
80  Stage( item, aChangeType );
81  }
82 
83  return *this;
84 }
85 
86 
88 {
89  for( unsigned int i = 0; i < aItems.GetCount(); i++ )
90  {
91  UNDO_REDO_T change_type = aItems.GetPickedItemStatus( i );
92  EDA_ITEM* item = aItems.GetPickedItem( i );
93  EDA_ITEM* copy = NULL;
94 
95  if( change_type == UR_UNSPECIFIED )
96  change_type = aItems.m_Status;
97 
98  if( change_type == UR_UNSPECIFIED )
99  change_type = aModFlag;
100 
101  if( ( copy = aItems.GetPickedItemLink( i ) ) )
102  {
103  assert( change_type == UR_CHANGED );
104 
105  // There was already a copy created, so use it
106  Modified( item, copy );
107  }
108  else
109  {
110  Stage( item, convert( change_type ) );
111  }
112  }
113 
114  return *this;
115 }
116 
117 
119 {
120  COMMIT_LINE* entry = findEntry( parentObject( aItem ) );
121 
122  return entry ? entry->m_type : 0;
123 }
124 
125 
126 template <class Container, class F>
127 void eraseIf( Container& c, F&& f )
128 {
129  c.erase( std::remove_if( c.begin(),
130  c.end(),
131  std::forward<F>( f ) ),
132  c.end() );
133 }
134 
135 
136 COMMIT& COMMIT::createModified( EDA_ITEM* aItem, EDA_ITEM* aCopy, int aExtraFlags )
137 {
138  EDA_ITEM* parent = parentObject( aItem );
139  auto entryIt = m_changedItems.find( parent );
140 
141  if( entryIt != m_changedItems.end() )
142  return *this; // item has been already modified once
143 
144  makeEntry( parent, CHT_MODIFY | aExtraFlags, aCopy );
145 
146  return *this;
147 }
148 
149 
150 void COMMIT::makeEntry( EDA_ITEM* aItem, CHANGE_TYPE aType, EDA_ITEM* aCopy )
151 {
152  // Expect an item copy if it is going to be modified
153  assert( !!aCopy == ( ( aType & CHT_TYPE ) == CHT_MODIFY ) );
154 
155  if( m_changedItems.find( aItem ) != m_changedItems.end() )
156  {
157  eraseIf( m_changes, [aItem] ( const COMMIT_LINE& aEnt ) {
158  return aEnt.m_item == aItem;
159  } );
160  }
161 
162  COMMIT_LINE ent;
163 
164  ent.m_item = aItem;
165  ent.m_type = aType;
166  ent.m_copy = aCopy;
167 
168  m_changedItems.insert( aItem );
169  m_changes.push_back( ent );
170 }
171 
172 
174 {
175  for( COMMIT_LINE& change : m_changes )
176  {
177  if( change.m_item == aItem )
178  return &change;
179  }
180 
181  return nullptr;
182 }
183 
184 
186 {
187  switch( aType )
188  {
189  case UR_NEW:
190  return CHT_ADD;
191 
192  case UR_DELETED:
193  return CHT_REMOVE;
194 
195  default:
196  assert( false );
197  // fall through
198 
199  case UR_CHANGED:
200  case UR_MOVED:
201  case UR_MIRRORED_X:
202  case UR_MIRRORED_Y:
203  case UR_ROTATED:
205  case UR_FLIPPED:
206  return CHT_MODIFY;
207  }
208 }
209 
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:44
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
CHANGE_TYPE m_type
Modification type
Definition: commit.h:156
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:118
EDA_ITEM * m_item
Main item that is added/deleted/modified
Definition: commit.h:150
CHANGE_TYPE convert(UNDO_REDO_T aType) const
Definition: commit.cpp:185
UNDO_REDO_T GetPickedItemStatus(unsigned int aIdx) const
Function GetPickedItemStatus.
EDA_ITEM * GetPickedItemLink(unsigned int aIdx) const
Function GetPickedItemLink.
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
COMMIT_LINE * findEntry(EDA_ITEM *aItem)
Searches for an entry describing change for a particular item.
Definition: commit.cpp:173
void eraseIf(Container &c, F &&f)
Definition: commit.cpp:127
virtual ~COMMIT()
Definition: commit.cpp:34
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:180
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:136
unsigned GetCount() const
Function GetCount.
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
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
Function GetPickedItem.
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:181
COMMIT()
Definition: commit.cpp:29
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
EDA_ITEM * m_copy
Optional copy of the item
Definition: commit.h:153
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:150