KiCad PCB EDA Suite
board_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 (C) 2016 CERN
5  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <board.h>
26 #include <footprint.h>
27 #include <pcb_edit_frame.h>
28 #include <tool/tool_manager.h>
29 #include <tools/selection_tool.h>
30 #include <view/view.h>
31 #include <board_commit.h>
32 #include <tools/pcb_tool_base.h>
33 #include <tools/pcb_actions.h>
35 
36 #include <functional>
37 using namespace std::placeholders;
38 
39 #include "pcb_draw_panel_gal.h"
40 
42 {
43  m_toolMgr = aTool->GetManager();
44  m_isFootprintEditor = aTool->IsFootprintEditor();
45 }
46 
47 
49 {
50  m_toolMgr = aFrame->GetToolManager();
51  m_isFootprintEditor = aFrame->IsType( FRAME_FOOTPRINT_EDITOR );
52 }
53 
54 
56 {
57 }
58 
60 {
61  // if aItem belongs a footprint, the full footprint will be saved
62  // because undo/redo does not handle "sub items" modifications
63  if( aItem && aItem->Type() != PCB_FOOTPRINT_T && aChangeType == CHT_MODIFY )
64  {
65  EDA_ITEM* item = aItem->GetParent();
66 
67  if( item && item->Type() == PCB_FOOTPRINT_T ) // means aItem belongs a footprint
68  aItem = item;
69  }
70 
71  return COMMIT::Stage( aItem, aChangeType );
72 }
73 
74 COMMIT& BOARD_COMMIT::Stage( std::vector<EDA_ITEM*>& container, CHANGE_TYPE aChangeType )
75 {
76  return COMMIT::Stage( container, aChangeType );
77 }
78 
80 {
81  return COMMIT::Stage( aItems, aModFlag );
82 }
83 
84 void BOARD_COMMIT::Push( const wxString& aMessage, bool aCreateUndoEntry, bool aSetDirtyBit )
85 {
86  // Objects potentially interested in changes:
87  PICKED_ITEMS_LIST undoList;
88  KIGFX::VIEW* view = m_toolMgr->GetView();
89  BOARD* board = (BOARD*) m_toolMgr->GetModel();
90  PCB_BASE_FRAME* frame = (PCB_BASE_FRAME*) m_toolMgr->GetToolHolder();
91  auto connectivity = board->GetConnectivity();
92  std::set<EDA_ITEM*> savedModules;
93  SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
94  bool itemsDeselected = false;
95 
96  if( Empty() )
97  return;
98 
99  for( COMMIT_LINE& ent : m_changes )
100  {
101  int changeType = ent.m_type & CHT_TYPE;
102  int changeFlags = ent.m_type & CHT_FLAGS;
103  BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
104 
105  // Module items need to be saved in the undo buffer before modification
106  if( m_isFootprintEditor )
107  {
108  // Be sure that we are storing a footprint
109  if( ent.m_item->Type() != PCB_FOOTPRINT_T )
110  ent.m_item = ent.m_item->GetParent();
111 
112  // We have not saved the footprint yet, so let's create an entry
113  if( savedModules.count( ent.m_item ) == 0 )
114  {
115  if( !ent.m_copy )
116  {
117  wxASSERT( changeType != CHT_MODIFY ); // too late to make a copy..
118  ent.m_copy = ent.m_item->Clone();
119  }
120 
121  wxASSERT( ent.m_item->Type() == PCB_FOOTPRINT_T );
122  wxASSERT( ent.m_copy->Type() == PCB_FOOTPRINT_T );
123 
124  if( aCreateUndoEntry )
125  {
126  ITEM_PICKER itemWrapper( nullptr, ent.m_item, UNDO_REDO::CHANGED );
127  itemWrapper.SetLink( ent.m_copy );
128  undoList.PushItem( itemWrapper );
129  frame->SaveCopyInUndoList( undoList, UNDO_REDO::CHANGED );
130  }
131 
132  savedModules.insert( ent.m_item );
133  static_cast<FOOTPRINT*>( ent.m_item )->SetLastEditTime();
134  }
135  }
136 
137  switch( changeType )
138  {
139  case CHT_ADD:
140  {
141  if( m_isFootprintEditor )
142  {
143  // footprints inside footprints are not supported yet
144  wxASSERT( boardItem->Type() != PCB_FOOTPRINT_T );
145 
146  boardItem->SetParent( board->Footprints().front() );
147 
148  if( !( changeFlags & CHT_DONE ) )
149  board->Footprints().front()->Add( boardItem );
150  }
151  else if( boardItem->Type() == PCB_FP_TEXT_T ||
152  boardItem->Type() == PCB_FP_SHAPE_T ||
153  boardItem->Type() == PCB_FP_ZONE_T )
154  {
155  wxASSERT( boardItem->GetParent() &&
156  boardItem->GetParent()->Type() == PCB_FOOTPRINT_T );
157  }
158  else
159  {
160  if( aCreateUndoEntry )
161  undoList.PushItem( ITEM_PICKER( nullptr, boardItem, UNDO_REDO::NEWITEM ) );
162 
163  if( !( changeFlags & CHT_DONE ) )
164  board->Add( boardItem ); // handles connectivity
165  }
166 
167  if( boardItem->Type() != PCB_NETINFO_T && boardItem->Type() != PCB_GROUP_T )
168  view->Add( boardItem );
169 
170  break;
171  }
172 
173  case CHT_REMOVE:
174  {
175  if( !m_isFootprintEditor && aCreateUndoEntry )
176  undoList.PushItem( ITEM_PICKER( nullptr, boardItem, UNDO_REDO::DELETED ) );
177 
178  if( boardItem->IsSelected() )
179  {
180  selTool->RemoveItemFromSel( boardItem, true /* quiet mode */ );
181  itemsDeselected = true;
182  }
183 
184  switch( boardItem->Type() )
185  {
186  // Module items
187  case PCB_PAD_T:
188  case PCB_FP_SHAPE_T:
189  case PCB_FP_TEXT_T:
190  case PCB_FP_ZONE_T:
191  // This level can only handle footprint children when editing footprints
192  wxASSERT( m_isFootprintEditor );
193 
194  if( boardItem->Type() == PCB_FP_TEXT_T )
195  {
196  FP_TEXT* text = static_cast<FP_TEXT*>( boardItem );
197 
198  // don't allow deletion of Reference or Value
199  if( text->GetType() != FP_TEXT::TEXT_is_DIVERS )
200  break;
201  }
202 
203  view->Remove( boardItem );
204 
205  if( !( changeFlags & CHT_DONE ) )
206  {
207  FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem->GetParent() );
208  wxASSERT( footprint && footprint->Type() == PCB_FOOTPRINT_T );
209  footprint->Delete( boardItem );
210  }
211 
212  break;
213 
214  // Board items
215  case PCB_SHAPE_T: // a shape (normally not on copper layers)
216  case PCB_TEXT_T: // a text on a layer
217  case PCB_TRACE_T: // a track segment (segment on a copper layer)
218  case PCB_ARC_T: // an arced track segment (segment on a copper layer)
219  case PCB_VIA_T: // a via (like track segment on a copper layer)
220  case PCB_DIM_ALIGNED_T: // a dimension (graphic item)
221  case PCB_DIM_CENTER_T:
223  case PCB_DIM_LEADER_T: // a leader dimension
224  case PCB_TARGET_T: // a target (graphic item)
225  case PCB_MARKER_T: // a marker used to show something
226  case PCB_ZONE_T:
227  view->Remove( boardItem );
228 
229  if( !( changeFlags & CHT_DONE ) )
230  board->Remove( boardItem );
231 
232  break;
233 
234  case PCB_FOOTPRINT_T:
235  {
236  // No support for nested footprints (yet)
237  wxASSERT( !m_isFootprintEditor );
238 
239  FOOTPRINT* footprint = static_cast<FOOTPRINT*>( boardItem );
240  view->Remove( footprint );
241  footprint->ClearFlags();
242 
243  if( !( changeFlags & CHT_DONE ) )
244  board->Remove( footprint ); // handles connectivity
245  }
246  break;
247 
248  case PCB_GROUP_T:
249  if( !( changeFlags & CHT_DONE ) )
250  {
251  if( m_isFootprintEditor )
252  board->GetFirstFootprint()->Remove( boardItem );
253  else
254  board->Remove( boardItem );
255  }
256  break;
257 
258  // Metadata items
259  case PCB_NETINFO_T:
260  board->Remove( boardItem );
261  break;
262 
263  default: // other types do not need to (or should not) be handled
264  wxASSERT( false );
265  break;
266  }
267 
268  break;
269  }
270 
271  case CHT_MODIFY:
272  {
273  if( !m_isFootprintEditor && aCreateUndoEntry )
274  {
275  ITEM_PICKER itemWrapper( nullptr, boardItem, UNDO_REDO::CHANGED );
276  wxASSERT( ent.m_copy );
277  itemWrapper.SetLink( ent.m_copy );
278  undoList.PushItem( itemWrapper );
279  }
280 
281  if( ent.m_copy )
282  connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
283 
284  connectivity->Update( boardItem );
285  view->Update( boardItem );
286 
287  if( m_isFootprintEditor )
288  {
289  static_cast<FOOTPRINT*>( boardItem )->RunOnChildren(
290  [&]( BOARD_ITEM* aChild )
291  {
292  view->Update( aChild );
293  });
294  }
295 
296  board->OnItemChanged( boardItem );
297 
298  // if no undo entry is needed, the copy would create a memory leak
299  if( !aCreateUndoEntry )
300  delete ent.m_copy;
301 
302  break;
303  }
304 
305  default:
306  wxASSERT( false );
307  break;
308  }
309  }
310 
311  if ( !m_isFootprintEditor )
312  {
313  size_t num_changes = m_changes.size();
314 
315  connectivity->RecalculateRatsnest( this );
316  connectivity->ClearDynamicRatsnest();
317  frame->GetCanvas()->RedrawRatsnest();
318 
319  if( m_changes.size() > num_changes )
320  {
321  for( size_t i = num_changes; i < m_changes.size(); ++i )
322  {
323  COMMIT_LINE& ent = m_changes[i];
324 
325  // This should only be modifications from the connectivity algo
326  wxASSERT( ( ent.m_type & CHT_TYPE ) == CHT_MODIFY );
327 
328  auto boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
329 
330  if( aCreateUndoEntry )
331  {
332  ITEM_PICKER itemWrapper( nullptr, boardItem, UNDO_REDO::CHANGED );
333  wxASSERT( ent.m_copy );
334  itemWrapper.SetLink( ent.m_copy );
335  undoList.PushItem( itemWrapper );
336  }
337  else
338  {
339  delete ent.m_copy;
340  }
341 
342  view->Update( boardItem );
343  }
344  }
345  }
346 
347  if( !m_isFootprintEditor && aCreateUndoEntry )
348  frame->SaveCopyInUndoList( undoList, UNDO_REDO::UNSPECIFIED );
349 
350  m_toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
351 
352  if( itemsDeselected )
353  m_toolMgr->PostEvent( EVENTS::UnselectedEvent );
354 
355  if( aSetDirtyBit )
356  frame->OnModify();
357  else
358  frame->Update3DView( false );
359 
360  frame->UpdateMsgPanel();
361 
362  clear();
363 }
364 
365 
367 {
368  switch( aItem->Type() )
369  {
370  case PCB_PAD_T:
371  case PCB_FP_SHAPE_T:
372  case PCB_FP_TEXT_T:
373  case PCB_FP_ZONE_T:
374  return aItem->GetParent();
375 
376  case PCB_ZONE_T:
377  wxASSERT( !dynamic_cast<FOOTPRINT*>( aItem->GetParent() ) );
378  return aItem;
379 
380  default:
381  break;
382  }
383 
384  return aItem;
385 }
386 
387 
389 {
390  PICKED_ITEMS_LIST undoList;
391  KIGFX::VIEW* view = m_toolMgr->GetView();
392  BOARD* board = (BOARD*) m_toolMgr->GetModel();
393  auto connectivity = board->GetConnectivity();
394 
395  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
396  {
397  COMMIT_LINE& ent = *it;
398  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
399  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
400  int changeType = ent.m_type & CHT_TYPE;
401  int changeFlags = ent.m_type & CHT_FLAGS;
402 
403  switch( changeType )
404  {
405  case CHT_ADD:
406  if( !( changeFlags & CHT_DONE ) )
407  break;
408 
409  view->Remove( item );
410  connectivity->Remove( item );
411  board->Remove( item );
412  break;
413 
414  case CHT_REMOVE:
415  if( !( changeFlags & CHT_DONE ) )
416  break;
417 
418  view->Add( item );
419  connectivity->Add( item );
420  board->Add( item );
421  break;
422 
423  case CHT_MODIFY:
424  {
425  view->Remove( item );
426  connectivity->Remove( item );
427 
428  item->SwapData( copy );
429 
430  view->Add( item );
431  connectivity->Add( item );
432  board->OnItemChanged( item );
433  delete copy;
434  break;
435  }
436 
437  default:
438  wxASSERT( false );
439  break;
440  }
441  }
442 
443  if ( !m_isFootprintEditor )
444  connectivity->RecalculateRatsnest();
445 
446  SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
447  selTool->RebuildSelection();
448 
449  clear();
450 }
451 
453 {
454  COMMIT::COMMIT_LINE* line = findEntry( aItem );
455  return line != nullptr && line->m_type == CHT_REMOVE;
456 }
virtual 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
class ALIGNED_DIMENSION, a linear dimension (graphic item)
Definition: typeinfo.h:101
class LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:102
class FP_TEXT, text in a footprint
Definition: typeinfo.h:93
bool IsSelected() const
Definition: eda_item.h:191
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:209
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
Definition: board_item.h:86
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
SELECTION_TOOL.
class CENTER_DIMENSION, a center point marking (graphic item)
Definition: typeinfo.h:103
virtual void Revert() override
Revertes the commit by restoring the modifed items state.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
CHANGE_TYPE m_type
Optional copy of the item
Definition: commit.h:152
Definition: commit.h:38
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:357
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
COMMIT.
Definition: commit.h:71
void PushItem(const ITEM_PICKER &aItem)
Function PushItem pushes aItem to the top of the list.
class FP_SHAPE, a footprint edge
Definition: typeinfo.h:94
class PAD, a pad in a footprint
Definition: typeinfo.h:90
EDA_ITEM * m_item
Definition: commit.h:150
BOARD_COMMIT(EDA_DRAW_FRAME *aFrame)
The base class for create windows for drawing purpose.
virtual ~BOARD_COMMIT()
void SetLink(EDA_ITEM *aItem)
UNDO_REDO
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const override
void RedrawRatsnest()
Forces refresh of the ratsnest visual representation
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:184
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:143
virtual void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
Definition: board_item.cpp:124
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
Definition: board.cpp:553
FOOTPRINT * GetFirstFootprint() const
Gets the first footprint on the board or nullptr.
Definition: board.h:348
TOOL_TYPE m_type
Stores the type of the tool.
Definition: tool_base.h:211
TEXT_TYPE GetType() const
Definition: fp_text.h:139
FOOTPRINTS & Footprints()
Definition: board.h:283
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:382
void RemoveItemFromSel(BOARD_ITEM *aItem, bool aQuietMode=false)
EDA_ITEM * GetParent() const
Definition: eda_item.h:183
class ZONE, a copper pour area
Definition: typeinfo.h:106
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
All active tools
Definition: tool_event.h:147
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:105
class FOOTPRINT, a footprint
Definition: typeinfo.h:89
CHANGE_TYPE
Types of changes
Definition: commit.h:37
virtual void OnModify()
Function OnModify Must be called after a change in order to set the "modify" flag of the current scre...
void Remove(BOARD_ITEM *aItem) override
Definition: footprint.cpp:495
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:99
bool IsType(FRAME_T aType) const
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:186
class NETINFO_ITEM, a description of a net
Definition: typeinfo.h:108
class ZONE, managed by a footprint
Definition: typeinfo.h:95
bool HasRemoveEntry(EDA_ITEM *aItem)
void RebuildSelection()
Rebuilds the selection from the EDA_ITEMs' selection flags.
void OnItemChanged(BOARD_ITEM *aItem)
Notify the board and its listeners that an item on the board has been modified in some way.
Definition: board.cpp:1953
EDA_ITEM is a base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:148
bool IsFootprintEditor() const
virtual void Push(const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true, bool aSetDirtyBit=true) override
Executes the changes.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:221
virtual void Delete(BOARD_ITEM *aItem)
Removes an item from the container and deletes it.
class ORTHOGONAL_DIMENSION, a linear dimension constrained to x/y
Definition: typeinfo.h:104
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:97
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:327
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:76
EDA_ITEM * m_copy
Main item that is added/deleted/modified
Definition: commit.h:151
virtual void SaveCopyInUndoList(EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))=0
Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands.
VIEW.
Definition: view.h:63
virtual void Update3DView(bool aForceReload, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:179
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:91
PCB_BASE_FRAME basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
void Remove(BOARD_ITEM *aBoardItem) override
Removes an item from the container.
Definition: board.cpp:642
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1513
COMMIT & Stage(EDA_ITEM *aItem, CHANGE_TYPE aChangeType) override
Adds a change of the item aItem of type aChangeType to the change list.
KICAD_T Type() const
Function Type()
Definition: eda_item.h:181
virtual void UpdateMsgPanel()
Redraw the message panel.