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 <wxPcbStruct.h>
28 #include <tool/tool_manager.h>
29 #include <ratsnest_data.h>
30 #include <view/view.h>
31 #include <board_commit.h>
32 #include <tools/pcb_tool.h>
33 #include <connectivity.h>
34 
35 #include <functional>
36 using namespace std::placeholders;
37 
38 #include "pcb_draw_panel_gal.h"
39 
41 {
42  m_toolMgr = aTool->GetManager();
43  m_editModules = aTool->EditingModules();
44 }
45 
46 
48 {
49  m_toolMgr = aFrame->GetToolManager();
50  m_editModules = aFrame->IsType( FRAME_PCB_MODULE_EDITOR );
51 }
52 
53 
55 {
56 }
57 
58 
59 void BOARD_COMMIT::Push( const wxString& aMessage, bool aCreateUndoEntry )
60 {
61  // Objects potentially interested in changes:
62  PICKED_ITEMS_LIST undoList;
63  KIGFX::VIEW* view = m_toolMgr->GetView();
64  BOARD* board = (BOARD*) m_toolMgr->GetModel();
65  PCB_BASE_FRAME* frame = (PCB_BASE_FRAME*) m_toolMgr->GetEditFrame();
66  auto connectivity = board->GetConnectivity();
67  std::set<EDA_ITEM*> savedModules;
68 
69  if( Empty() )
70  return;
71 
72  for( COMMIT_LINE& ent : m_changes )
73  {
74  int changeType = ent.m_type & CHT_TYPE;
75  int changeFlags = ent.m_type & CHT_FLAGS;
76  BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
77 
78  // Module items need to be saved in the undo buffer before modification
79  if( m_editModules )
80  {
81  // Be sure that we are storing a module
82  if( ent.m_item->Type() != PCB_MODULE_T )
83  ent.m_item = ent.m_item->GetParent();
84 
85  // We have not saved the module yet, so let's create an entry
86  if( savedModules.count( ent.m_item ) == 0 )
87  {
88  if( !ent.m_copy )
89  {
90  wxASSERT( changeType != CHT_MODIFY ); // too late to make a copy..
91  ent.m_copy = ent.m_item->Clone();
92  }
93 
94  wxASSERT( ent.m_item->Type() == PCB_MODULE_T );
95  wxASSERT( ent.m_copy->Type() == PCB_MODULE_T );
96 
97  if( aCreateUndoEntry )
98  {
99  ITEM_PICKER itemWrapper( ent.m_item, UR_CHANGED );
100  itemWrapper.SetLink( ent.m_copy );
101  undoList.PushItem( itemWrapper );
102  frame->SaveCopyInUndoList( undoList, UR_CHANGED );
103  }
104 
105  savedModules.insert( ent.m_item );
106  static_cast<MODULE*>( ent.m_item )->SetLastEditTime();
107  }
108  }
109 
110  switch( changeType )
111  {
112  case CHT_ADD:
113  {
114  if( !m_editModules )
115  {
116  if( aCreateUndoEntry )
117  {
118  undoList.PushItem( ITEM_PICKER( boardItem, UR_NEW ) );
119  }
120 
121  if( !( changeFlags & CHT_DONE ) )
122  board->Add( boardItem );
123 
124  //ratsnest->Add( boardItem ); // TODO currently done by BOARD::Add()
125 
126  if( boardItem->Type() == PCB_MODULE_T )
127  {
128  MODULE* mod = static_cast<MODULE*>( boardItem );
129  mod->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
130  }
131  }
132  else
133  {
134  // modules inside modules are not supported yet
135  wxASSERT( boardItem->Type() != PCB_MODULE_T );
136 
137  boardItem->SetParent( board->m_Modules.GetFirst() );
138  if( !( changeFlags & CHT_DONE ) )
139  board->m_Modules->Add( boardItem );
140  }
141 
142  view->Add( boardItem );
143  break;
144  }
145 
146  case CHT_REMOVE:
147  {
148  if( !m_editModules && aCreateUndoEntry )
149  {
150  undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
151  }
152 
153  switch( boardItem->Type() )
154  {
155  // Module items
156  case PCB_PAD_T:
157  case PCB_MODULE_EDGE_T:
158  case PCB_MODULE_TEXT_T:
159  {
160  // Do not allow footprint text removal when not editing a module
161  if( !m_editModules )
162  break;
163 
164  bool remove = true;
165 
166  if( boardItem->Type() == PCB_MODULE_TEXT_T )
167  {
168  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
169 
170  switch( text->GetType() )
171  {
173  //DisplayError( frame, _( "Cannot delete component reference." ) );
174  remove = false;
175  break;
176 
178  //DisplayError( frame, _( "Cannot delete component value." ) );
179  remove = false;
180  break;
181 
182  case TEXTE_MODULE::TEXT_is_DIVERS: // suppress warnings
183  break;
184 
185  default:
186  wxASSERT( false );
187  break;
188  }
189  }
190 
191  if( remove )
192  {
193  view->Remove( boardItem );
194 
195  if( !( changeFlags & CHT_DONE ) )
196  {
197  MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
198  wxASSERT( module && module->Type() == PCB_MODULE_T );
199  module->Delete( boardItem );
200  }
201 
202  board->m_Status_Pcb = 0; // it is done in the legacy view (ratsnest perhaps?)
203  }
204 
205  break;
206  }
207 
208  // Board items
209  case PCB_LINE_T: // a segment not on copper layers
210  case PCB_TEXT_T: // a text on a layer
211  case PCB_TRACE_T: // a track segment (segment on a copper layer)
212  case PCB_VIA_T: // a via (like track segment on a copper layer)
213  case PCB_DIMENSION_T: // a dimension (graphic item)
214  case PCB_TARGET_T: // a target (graphic item)
215  case PCB_MARKER_T: // a marker used to show something
216  case PCB_ZONE_T: // SEG_ZONE items are now deprecated
217  case PCB_ZONE_AREA_T:
218  view->Remove( boardItem );
219 
220  if( !( changeFlags & CHT_DONE ) )
221  board->Remove( boardItem );
222 
223  break;
224 
225  case PCB_MODULE_T:
226  {
227  // There are no modules inside a module yet
228  wxASSERT( !m_editModules );
229 
230  MODULE* module = static_cast<MODULE*>( boardItem );
231  module->ClearFlags();
232  module->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
233 
234  view->Remove( module );
235 
236  if( !( changeFlags & CHT_DONE ) )
237  board->Remove( module );
238 
239  // Clear flags to indicate, that the ratsnest, list of nets & pads are not valid anymore
240  board->m_Status_Pcb = 0;
241  }
242  break;
243 
244  default: // other types do not need to (or should not) be handled
245  wxASSERT( false );
246  break;
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( boardItem->Type() == PCB_MODULE_T )
262  {
263  MODULE* module = static_cast<MODULE*>( boardItem );
264  module->RunOnChildren( [&view] ( BOARD_ITEM* aItem ) { view->Update( aItem ); } );
265  }
266 
267  view->Update ( boardItem );
268  connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
269  connectivity->Update( boardItem );
270  break;
271  }
272 
273  default:
274  wxASSERT( false );
275  break;
276  }
277  }
278 
279  if( !m_editModules && aCreateUndoEntry )
280  frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
281 
282  if( TOOL_MANAGER* toolMgr = frame->GetToolManager() )
283  toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
284 
285  if ( !m_editModules )
286  {
287  auto panel = static_cast<PCB_DRAW_PANEL_GAL*>( frame->GetGalCanvas() );
288  connectivity->RecalculateRatsnest();
289  panel->RedrawRatsnest();
290  }
291 
292  frame->OnModify();
293  frame->UpdateMsgPanel();
294 
295  clear();
296 }
297 
298 
300 {
301  switch( aItem->Type() )
302  {
303  case PCB_PAD_T:
304  case PCB_MODULE_EDGE_T:
305  case PCB_MODULE_TEXT_T:
306  return aItem->GetParent();
307  default:
308  return aItem;
309  }
310 
311  return aItem;
312 }
313 
314 
316 {
317  PICKED_ITEMS_LIST undoList;
318  KIGFX::VIEW* view = m_toolMgr->GetView();
319  BOARD* board = (BOARD*) m_toolMgr->GetModel();
320  auto connectivity = board->GetConnectivity();
321 
322  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
323  {
324  COMMIT_LINE& ent = *it;
325  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
326  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
327 
328  switch( ent.m_type )
329  {
330  case CHT_ADD:
331  if( item->Type() == PCB_MODULE_T )
332  {
333  MODULE* oldModule = static_cast<MODULE*>( item );
334  oldModule->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
335  }
336 
337  view->Remove( item );
338  connectivity->Remove( item );
339  break;
340 
341  case CHT_REMOVE:
342  if( item->Type() == PCB_MODULE_T )
343  {
344  MODULE* newModule = static_cast<MODULE*>( item );
345  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
346  newModule->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
347  }
348 
349  view->Add( item );
350  connectivity->Add( item );
351  break;
352 
353  case CHT_MODIFY:
354  {
355  if( item->Type() == PCB_MODULE_T )
356  {
357  MODULE* oldModule = static_cast<MODULE*>( item );
358  oldModule->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
359  }
360 
361  view->Remove( item );
362  connectivity->Remove( item );
363 
364  item->SwapData( copy );
365 
366  item->ClearFlags( SELECTED );
367 
368  // Update all pads/drawings/texts, as they become invalid
369  // for the VIEW after SwapData() called for modules
370  if( item->Type() == PCB_MODULE_T )
371  {
372  MODULE* newModule = static_cast<MODULE*>( item );
373  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
374  newModule->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
375  }
376 
377  view->Add( item );
378  connectivity->Add( item );
379  delete copy;
380  break;
381  }
382 
383  default:
384  wxASSERT( false );
385  break;
386  }
387  }
388 
389  if ( !m_editModules )
390  connectivity->RecalculateRatsnest();
391 
392  clear();
393 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
BOARD_ITEM_CONTAINER * GetParent() const
BOARD_COMMIT(PCB_TOOL *aTool)
void RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)
Function RunOnChildren.
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
TEXT_TYPE GetType() const
Class BOARD to handle a board.
virtual void Revert() override
Revertes the commit by restoring the modifed items state.
Class that computes missing connections on a PCB.
CHANGE_TYPE m_type
Modification type
Definition: commit.h:156
Definition: commit.h:38
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:114
void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:342
EDA_ITEM * GetParent() const
Definition: base_struct.h:222
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:104
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
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:102
EDA_ITEM * m_item
Main item that is added/deleted/modified
Definition: commit.h:150
virtual ~BOARD_COMMIT()
void SetLink(EDA_ITEM *aItem)
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:106
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const override
virtual void Push(const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true) override
Executes the changes.
void RedrawRatsnest()
Forces refresh of the ratsnest visual representation
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:107
Class TOOL_MANAGER.
Definition: tool_manager.h:49
void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
Definition: undo_redo.cpp:567
#define SELECTED
Definition: base_struct.h:134
class MODULE, a footprint
Definition: typeinfo.h:101
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
>
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:227
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
T * GetFirst() const
Function GetFirst returns the first T* in the list without removing it, or NULL if the list is empty...
Definition: dlist.h:163
class SEGZONE, a segment used to fill a zone area (segment on a copper layer)
Definition: typeinfo.h:109
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
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:1385
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:112
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:113
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:105
bool EditingModules() const
Definition: pcb_tool.h:91
virtual void OnModify()
Function OnModify Virtual Must be called after a change in order to set the "modify" flag of the curr...
TOOL_MANAGER * GetToolManager() const
Function GetToolManager returns the tool manager instance, if any.
Definition: draw_frame.h:877
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:111
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
DLIST< MODULE > m_Modules
Definition: class_board.h:245
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.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool...
Definition: tool_base.h:144
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:268
virtual void Delete(BOARD_ITEM *aItem)
Removes an item from the containter and deletes it.
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:870
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:108
void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:312
bool IsType(FRAME_T aType) const
Definition: wxstruct.h:229
EDA_ITEM * m_copy
Optional copy of the item
Definition: commit.h:153
Module description (excepted pads)
Class VIEW.
Definition: view.h:58
void UpdateMsgPanel() override
>
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:103
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
#define mod(a, n)
Definition: greymap.cpp:24
class 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.
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:237