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 
34 #include <functional>
35 using namespace std::placeholders;
36 
38 {
39  m_toolMgr = aTool->GetManager();
40  m_editModules = aTool->EditingModules();
41 }
42 
43 
45 {
46  m_toolMgr = aFrame->GetToolManager();
47  m_editModules = aFrame->IsType( FRAME_PCB_MODULE_EDITOR );
48 }
49 
50 
52 {
53 }
54 
55 
56 void BOARD_COMMIT::Push( const wxString& aMessage, bool aCreateUndoEntry )
57 {
58  // Objects potentially interested in changes:
59  PICKED_ITEMS_LIST undoList;
60  KIGFX::VIEW* view = m_toolMgr->GetView();
61  BOARD* board = (BOARD*) m_toolMgr->GetModel();
62  PCB_BASE_FRAME* frame = (PCB_BASE_FRAME*) m_toolMgr->GetEditFrame();
63  RN_DATA* ratsnest = board->GetRatsnest();
64  std::set<EDA_ITEM*> savedModules;
65 
66  if( Empty() )
67  return;
68 
69  for( COMMIT_LINE& ent : m_changes )
70  {
71  int changeType = ent.m_type & CHT_TYPE;
72  int changeFlags = ent.m_type & CHT_FLAGS;
73  BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
74 
75  // Module items need to be saved in the undo buffer before modification
76  if( m_editModules )
77  {
78  // Be sure that we are storing a module
79  if( ent.m_item->Type() != PCB_MODULE_T )
80  ent.m_item = ent.m_item->GetParent();
81 
82  // We have not saved the module yet, so let's create an entry
83  if( savedModules.count( ent.m_item ) == 0 )
84  {
85  if( !ent.m_copy )
86  {
87  assert( changeType != CHT_MODIFY ); // too late to make a copy..
88  ent.m_copy = ent.m_item->Clone();
89  }
90 
91  assert( ent.m_item->Type() == PCB_MODULE_T );
92  assert( ent.m_copy->Type() == PCB_MODULE_T );
93 
94  if( aCreateUndoEntry )
95  {
96  ITEM_PICKER itemWrapper( ent.m_item, UR_CHANGED );
97  itemWrapper.SetLink( ent.m_copy );
98  undoList.PushItem( itemWrapper );
99  frame->SaveCopyInUndoList( undoList, UR_CHANGED );
100  }
101 
102  savedModules.insert( ent.m_item );
103  static_cast<MODULE*>( ent.m_item )->SetLastEditTime();
104  }
105  }
106 
107  switch( changeType )
108  {
109  case CHT_ADD:
110  {
111  if( !m_editModules )
112  {
113  if( aCreateUndoEntry )
114  {
115  undoList.PushItem( ITEM_PICKER( boardItem, UR_NEW ) );
116  }
117 
118  if( !( changeFlags & CHT_DONE ) )
119  board->Add( boardItem );
120 
121  //ratsnest->Add( boardItem ); // TODO currently done by BOARD::Add()
122 
123  if( boardItem->Type() == PCB_MODULE_T )
124  {
125  MODULE* mod = static_cast<MODULE*>( boardItem );
126  mod->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
127  }
128  }
129  else
130  {
131  // modules inside modules are not supported yet
132  assert( boardItem->Type() != PCB_MODULE_T );
133 
134  if( !( changeFlags & CHT_DONE ) )
135  board->m_Modules->Add( boardItem );
136  }
137 
138  view->Add( boardItem );
139  break;
140  }
141 
142  case CHT_REMOVE:
143  {
144  if( !m_editModules && aCreateUndoEntry )
145  {
146  undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
147  }
148 
149  switch( boardItem->Type() )
150  {
151  // Module items
152  case PCB_PAD_T:
153  case PCB_MODULE_EDGE_T:
154  case PCB_MODULE_TEXT_T:
155  {
156  // Do not allow footprint text removal when not editing a module
157  if( !m_editModules )
158  break;
159 
160  bool remove = true;
161 
162  if( boardItem->Type() == PCB_MODULE_TEXT_T )
163  {
164  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
165 
166  switch( text->GetType() )
167  {
169  //DisplayError( frame, _( "Cannot delete component reference." ) );
170  remove = false;
171  break;
172 
174  //DisplayError( frame, _( "Cannot delete component value." ) );
175  remove = false;
176  break;
177 
178  case TEXTE_MODULE::TEXT_is_DIVERS: // suppress warnings
179  break;
180 
181  default:
182  assert( false );
183  break;
184  }
185  }
186 
187  if( remove )
188  {
189  view->Remove( boardItem );
190 
191  if( !( changeFlags & CHT_DONE ) )
192  {
193  MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
194  assert( module && module->Type() == PCB_MODULE_T );
195  module->Delete( boardItem );
196  }
197 
198  board->m_Status_Pcb = 0; // it is done in the legacy view (ratsnest perhaps?)
199  }
200 
201  break;
202  }
203 
204  // Board items
205  case PCB_LINE_T: // a segment not on copper layers
206  case PCB_TEXT_T: // a text on a layer
207  case PCB_TRACE_T: // a track segment (segment on a copper layer)
208  case PCB_VIA_T: // a via (like track segment on a copper layer)
209  case PCB_DIMENSION_T: // a dimension (graphic item)
210  case PCB_TARGET_T: // a target (graphic item)
211  case PCB_MARKER_T: // a marker used to show something
212  case PCB_ZONE_T: // SEG_ZONE items are now deprecated
213  case PCB_ZONE_AREA_T:
214  view->Remove( boardItem );
215 
216  if( !( changeFlags & CHT_DONE ) )
217  board->Remove( boardItem );
218 
219  //ratsnest->Remove( boardItem ); // currently done by BOARD::Remove()
220  break;
221 
222  case PCB_MODULE_T:
223  {
224  // There are no modules inside a module yet
225  assert( !m_editModules );
226 
227  MODULE* module = static_cast<MODULE*>( boardItem );
228  module->ClearFlags();
229  module->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
230 
231  view->Remove( module );
232 
233  if( !( changeFlags & CHT_DONE ) )
234  board->Remove( module );
235 
236  // Clear flags to indicate, that the ratsnest, list of nets & pads are not valid anymore
237  board->m_Status_Pcb = 0;
238  }
239  break;
240 
241  default: // other types do not need to (or should not) be handled
242  assert( false );
243  break;
244  }
245  break;
246  }
247 
248  case CHT_MODIFY:
249  {
250  if( !m_editModules && aCreateUndoEntry )
251  {
252  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
253  assert( ent.m_copy );
254  itemWrapper.SetLink( ent.m_copy );
255  undoList.PushItem( itemWrapper );
256  }
257 
258  if( boardItem->Type() == PCB_MODULE_T )
259  {
260  MODULE* module = static_cast<MODULE*>( boardItem );
261  module->RunOnChildren( [&view] ( BOARD_ITEM* aItem ) { view->Update( aItem ); } );
262  }
263 
264  view->Update ( boardItem );
265  ratsnest->Update( boardItem );
266  break;
267  }
268 
269  default:
270  assert( false );
271  break;
272  }
273  }
274 
275  if( !m_editModules && aCreateUndoEntry )
276  frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
277 
278  if( TOOL_MANAGER* toolMgr = frame->GetToolManager() )
279  toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
280 
281  ratsnest->Recalculate();
282  frame->OnModify();
283  frame->UpdateMsgPanel();
284 
285  clear();
286 }
287 
288 
290 {
291  switch( aItem->Type() )
292  {
293  case PCB_PAD_T:
294  case PCB_MODULE_EDGE_T:
295  case PCB_MODULE_TEXT_T:
296  return aItem->GetParent();
297  default:
298  return aItem;
299  }
300 
301  return aItem;
302 }
303 
304 
306 {
307  PICKED_ITEMS_LIST undoList;
308  KIGFX::VIEW* view = m_toolMgr->GetView();
309  BOARD* board = (BOARD*) m_toolMgr->GetModel();
310  RN_DATA* ratsnest = board->GetRatsnest();
311 
312  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
313  {
314  COMMIT_LINE& ent = *it;
315  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
316  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
317 
318  switch( ent.m_type )
319  {
320  case CHT_ADD:
321  if( item->Type() == PCB_MODULE_T )
322  {
323  MODULE* oldModule = static_cast<MODULE*>( item );
324  oldModule->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
325  }
326 
327  view->Remove( item );
328  ratsnest->Remove( item );
329  break;
330 
331  case CHT_REMOVE:
332  if( item->Type() == PCB_MODULE_T )
333  {
334  MODULE* newModule = static_cast<MODULE*>( item );
335  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
336  newModule->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
337  }
338 
339  view->Add( item );
340  ratsnest->Add( item );
341  break;
342 
343  case CHT_MODIFY:
344  {
345  if( item->Type() == PCB_MODULE_T )
346  {
347  MODULE* oldModule = static_cast<MODULE*>( item );
348  oldModule->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
349  }
350 
351  view->Remove( item );
352  ratsnest->Remove( item );
353 
354  item->SwapData( copy );
355 
356  item->ClearFlags( SELECTED );
357 
358  // Update all pads/drawings/texts, as they become invalid
359  // for the VIEW after SwapData() called for modules
360  if( item->Type() == PCB_MODULE_T )
361  {
362  MODULE* newModule = static_cast<MODULE*>( item );
363  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
364  newModule->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
365  }
366 
367  view->Add( item );
368  ratsnest->Add( item );
369  delete copy;
370  break;
371  }
372 
373  default:
374  assert( false );
375  break;
376  }
377  }
378 
379  ratsnest->Recalculate();
380 
381  clear();
382 }
void Add(BOARD_ITEM *aBoardItem, ADD_MODE aMode=ADD_INSERT) override
>
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
BOARD_ITEM_CONTAINER * GetParent() const
BOARD_COMMIT(PCB_TOOL *aTool)
void RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)
Function RunOnChildren.
Class RN_DATA.
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:150
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:341
EDA_ITEM * GetParent() const
Definition: base_struct.h:208
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:144
bool Update(const BOARD_ITEM *aItem)
Function Update() Updates the ratsnest data for an item.
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.
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:107
bool Remove(const BOARD_ITEM *aItem)
Function Remove() Removes an item from the ratsnest data.
Class TOOL_MANAGER.
Definition: tool_manager.h:49
void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
Definition: undo_redo.cpp:577
#define SELECTED
Definition: base_struct.h:120
class MODULE, a footprint
Definition: typeinfo.h:101
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
>
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.
Class PCB_TOOL.
Definition: pcb_tool.h:45
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:112
void Update(VIEW_ITEM *aItem)
Function Update() For dynamic VIEWs, informs the associated VIEW that the graphical representation of...
Definition: view.cpp:1379
RN_DATA * GetRatsnest() const
Function GetRatsnest() returns list of missing connections between components/tracks.
Definition: class_board.h:287
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:113
void Recalculate(int aNet=-1)
Function Recalculate() Recomputes ratsnest for selected net number or all nets that need updating...
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:105
bool EditingModules() const
Definition: pcb_tool.h:78
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:810
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:166
DLIST< MODULE > m_Modules
Definition: class_board.h:243
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:151
bool Add(const BOARD_ITEM *aItem)
Function Add() Adds an item to the ratsnest data.
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:254
virtual void Delete(BOARD_ITEM *aItem)
Removes an item from the containter and deletes it.
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:311
bool IsType(FRAME_T aType) const
Definition: wxstruct.h:216
EDA_ITEM * m_copy
Optional copy of the item
Definition: commit.h:147
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
#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
>
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:240