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 <class_board.h>
26 #include <class_module.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_editModules = aTool->EditingModules();
45 }
46 
47 
49 {
50  m_toolMgr = aFrame->GetToolManager();
51  m_editModules = 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_MODULE_T && aChangeType == CHT_MODIFY )
64  {
65  EDA_ITEM* item = aItem->GetParent();
66 
67  if( item && item->Type() == PCB_MODULE_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_editModules )
107  {
108  // Be sure that we are storing a module
109  if( ent.m_item->Type() != PCB_MODULE_T )
110  ent.m_item = ent.m_item->GetParent();
111 
112  // We have not saved the module 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_MODULE_T );
122  wxASSERT( ent.m_copy->Type() == PCB_MODULE_T );
123 
124  if( aCreateUndoEntry )
125  {
126  ITEM_PICKER itemWrapper( ent.m_item, UR_CHANGED );
127  itemWrapper.SetLink( ent.m_copy );
128  undoList.PushItem( itemWrapper );
129  frame->SaveCopyInUndoList( undoList, UR_CHANGED );
130  }
131 
132  savedModules.insert( ent.m_item );
133  static_cast<MODULE*>( ent.m_item )->SetLastEditTime();
134  }
135  }
136 
137  switch( changeType )
138  {
139  case CHT_ADD:
140  {
141  if( m_editModules )
142  {
143  // modules inside modules are not supported yet
144  wxASSERT( boardItem->Type() != PCB_MODULE_T );
145 
146  boardItem->SetParent( board->Modules().front() );
147 
148  if( !( changeFlags & CHT_DONE ) )
149  board->Modules().front()->Add( boardItem );
150  }
151  else if( boardItem->Type() == PCB_MODULE_TEXT_T ||
152  boardItem->Type() == PCB_MODULE_EDGE_T ||
153  boardItem->Type() == PCB_MODULE_ZONE_AREA_T )
154  {
155  wxASSERT( boardItem->GetParent() &&
156  boardItem->GetParent()->Type() == PCB_MODULE_T );
157  }
158  else
159  {
160  if( aCreateUndoEntry )
161  undoList.PushItem( ITEM_PICKER( boardItem, UR_NEW ) );
162 
163  if( !( changeFlags & CHT_DONE ) )
164  board->Add( boardItem ); // handles connectivity
165  }
166 
167  view->Add( boardItem );
168  break;
169  }
170 
171  case CHT_REMOVE:
172  {
173  if( !m_editModules && aCreateUndoEntry )
174  undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
175 
176  if( boardItem->IsSelected() )
177  {
178  selTool->RemoveItemFromSel( boardItem, true /* quiet mode */ );
179  itemsDeselected = true;
180  }
181 
182  switch( boardItem->Type() )
183  {
184  // Module items
185  case PCB_PAD_T:
186  case PCB_MODULE_EDGE_T:
187  case PCB_MODULE_TEXT_T:
189  // This level can only handle module items when editing modules
190  wxASSERT( m_editModules );
191 
192  if( boardItem->Type() == PCB_MODULE_TEXT_T )
193  {
194  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
195 
196  // don't allow deletion of Reference or Value
197  if( text->GetType() != TEXTE_MODULE::TEXT_is_DIVERS )
198  break;
199  }
200 
201  view->Remove( boardItem );
202 
203  if( !( changeFlags & CHT_DONE ) )
204  {
205  MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
206  wxASSERT( module && module->Type() == PCB_MODULE_T );
207  module->Delete( boardItem );
208  }
209 
210  break;
211 
212  // Board items
213  case PCB_LINE_T: // a segment not on copper layers
214  case PCB_TEXT_T: // a text on a layer
215  case PCB_TRACE_T: // a track segment (segment on a copper layer)
216  case PCB_ARC_T: // an arced track segment (segment on a copper layer)
217  case PCB_VIA_T: // a via (like track segment on a copper layer)
218  case PCB_DIMENSION_T: // a dimension (graphic item)
219  case PCB_TARGET_T: // a target (graphic item)
220  case PCB_MARKER_T: // a marker used to show something
221  case PCB_ZONE_AREA_T:
222  view->Remove( boardItem );
223 
224  if( !( changeFlags & CHT_DONE ) )
225  board->Remove( boardItem );
226 
227  break;
228 
229  case PCB_MODULE_T:
230  {
231  // There are no modules inside a module yet
232  wxASSERT( !m_editModules );
233 
234  MODULE* module = static_cast<MODULE*>( boardItem );
235  view->Remove( module );
236  module->ClearFlags();
237 
238  if( !( changeFlags & CHT_DONE ) )
239  board->Remove( module ); // handles connectivity
240  }
241  break;
242 
243  default: // other types do not need to (or should not) be handled
244  wxASSERT( false );
245  break;
246  }
247 
248  break;
249  }
250 
251  case CHT_MODIFY:
252  {
253  if( !m_editModules && aCreateUndoEntry )
254  {
255  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
256  wxASSERT( ent.m_copy );
257  itemWrapper.SetLink( ent.m_copy );
258  undoList.PushItem( itemWrapper );
259  }
260 
261  if( ent.m_copy )
262  connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
263 
264  connectivity->Update( boardItem );
265  view->Update( boardItem );
266  board->OnItemChanged( boardItem );
267 
268  // if no undo entry is needed, the copy would create a memory leak
269  if( !aCreateUndoEntry )
270  delete ent.m_copy;
271 
272  break;
273  }
274 
275  default:
276  wxASSERT( false );
277  break;
278  }
279  }
280 
281  if ( !m_editModules )
282  {
283  size_t num_changes = m_changes.size();
284 
285  connectivity->RecalculateRatsnest( this );
286  connectivity->ClearDynamicRatsnest();
287  frame->GetCanvas()->RedrawRatsnest();
288 
289  if( m_changes.size() > num_changes )
290  {
291  for( size_t i = num_changes; i < m_changes.size(); ++i )
292  {
293  COMMIT_LINE& ent = m_changes[i];
294 
295  // This should only be modifications from the connectivity algo
296  wxASSERT( ( ent.m_type & CHT_TYPE ) == CHT_MODIFY );
297 
298  auto boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
299 
300  if( aCreateUndoEntry )
301  {
302  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
303  wxASSERT( ent.m_copy );
304  itemWrapper.SetLink( ent.m_copy );
305  undoList.PushItem( itemWrapper );
306  }
307  else
308  {
309  delete ent.m_copy;
310  }
311 
312  view->Update( boardItem );
313  }
314  }
315  }
316 
317  if( !m_editModules && aCreateUndoEntry )
318  frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
319 
320  m_toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
321 
322  if( itemsDeselected )
323  m_toolMgr->PostEvent( EVENTS::UnselectedEvent );
324 
325  if( aSetDirtyBit )
326  frame->OnModify();
327 
328  frame->UpdateMsgPanel();
329 
330  clear();
331 }
332 
333 
335 {
336  switch( aItem->Type() )
337  {
338  case PCB_PAD_T:
339  case PCB_MODULE_EDGE_T:
340  case PCB_MODULE_TEXT_T:
342  return aItem->GetParent();
343 
344  case PCB_ZONE_AREA_T:
345  wxASSERT( !dynamic_cast<MODULE*>( aItem->GetParent() ) );
346  return aItem;
347 
348  default:
349  break;
350  }
351 
352  return aItem;
353 }
354 
355 
357 {
358  PICKED_ITEMS_LIST undoList;
359  KIGFX::VIEW* view = m_toolMgr->GetView();
360  BOARD* board = (BOARD*) m_toolMgr->GetModel();
361  auto connectivity = board->GetConnectivity();
362 
363  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
364  {
365  COMMIT_LINE& ent = *it;
366  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
367  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
368  int changeType = ent.m_type & CHT_TYPE;
369  int changeFlags = ent.m_type & CHT_FLAGS;
370 
371  switch( changeType )
372  {
373  case CHT_ADD:
374  if( !( changeFlags & CHT_DONE ) )
375  break;
376 
377  view->Remove( item );
378  connectivity->Remove( item );
379  board->Remove( item );
380  break;
381 
382  case CHT_REMOVE:
383  if( !( changeFlags & CHT_DONE ) )
384  break;
385 
386  view->Add( item );
387  connectivity->Add( item );
388  board->Add( item );
389  break;
390 
391  case CHT_MODIFY:
392  {
393  view->Remove( item );
394  connectivity->Remove( item );
395 
396  item->SwapData( copy );
397 
398  view->Add( item );
399  connectivity->Add( item );
400  board->OnItemChanged( item );
401  delete copy;
402  break;
403  }
404 
405  default:
406  wxASSERT( false );
407  break;
408  }
409  }
410 
411  if ( !m_editModules )
412  connectivity->RecalculateRatsnest();
413 
414  SELECTION_TOOL* selTool = m_toolMgr->GetTool<SELECTION_TOOL>();
415  selTool->RebuildSelection();
416 
417  clear();
418 }
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
bool IsSelected() const
Definition: base_struct.h:203
static const TOOL_EVENT UnselectedEvent
Definition: actions.h:203
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
SELECTION_TOOL.
UNDO_REDO_T
Undo Redo considerations: Basically we have 3 cases New item Deleted item Modified item there is also...
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
Modification type
Definition: commit.h:157
Definition: commit.h:38
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:102
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
class TEXTE_PCB, 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 D_PAD, a pad in a footprint
Definition: typeinfo.h:90
EDA_ITEM * m_item
Main item that is added/deleted/modified
Definition: commit.h:151
BOARD_COMMIT(EDA_DRAW_FRAME *aFrame)
The base class for create windows for drawing purpose.
virtual ~BOARD_COMMIT()
void SetLink(EDA_ITEM *aItem)
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
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: base_struct.h:196
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.
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
class MODULE, a footprint
Definition: typeinfo.h:89
MODULES & Modules()
Definition: class_board.h:266
TOOL_TYPE m_type
Stores the type of the tool.
Definition: tool_base.h:211
TEXT_TYPE GetType() const
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:355
void RemoveItemFromSel(BOARD_ITEM *aItem, bool aQuietMode=false)
EDA_ITEM * GetParent() const
Definition: base_struct.h:195
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
All active tools
Definition: tool_event.h:147
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags)
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: view.cpp:1540
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
bool EditingModules() const
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
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...
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:99
bool IsType(FRAME_T aType) const
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:180
virtual void SaveCopyInUndoList(BOARD_ITEM *aItemToCopy, UNDO_REDO_T aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0))=0
Function SaveCopyInUndoList (virtual pure) Creates a new entry in undo list of commands.
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.
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
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: base_struct.h:233
virtual void Delete(BOARD_ITEM *aItem)
Removes an item from the container and deletes it.
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:346
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:74
EDA_ITEM * m_copy
Optional copy of the item
Definition: commit.h:154
class ZONE_CONTAINER, managed by a footprint
Definition: typeinfo.h:95
VIEW.
Definition: view.h:61
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
BOARD_ITEM_CONTAINER * GetParent() const
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.
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: base_struct.h:193
virtual void UpdateMsgPanel()
Redraw the message panel.