KiCad PCB EDA Suite
BOARD_COMMIT Class Reference

#include <board_commit.h>

Inheritance diagram for BOARD_COMMIT:
COMMIT

Public Member Functions

 BOARD_COMMIT (PCB_TOOL *aTool)
 
 BOARD_COMMIT (PCB_BASE_FRAME *aFrame)
 
virtual ~BOARD_COMMIT ()
 
virtual void Push (const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true) override
 

Executes the changes.

More...
 
virtual void Revert () override
 

Revertes the commit by restoring the modifed items state.

More...
 
COMMITAdd (EDA_ITEM *aItem)
 

Adds a new item to the model

More...
 
COMMITAdded (EDA_ITEM *aItem)
 

Notifies observers that aItem has been added

More...
 
COMMITRemove (EDA_ITEM *aItem)
 

Removes a new item from the model

More...
 
COMMITRemoved (EDA_ITEM *aItem)
 

Notifies observers that aItem has been removed

More...
 
COMMITModify (EDA_ITEM *aItem)
 

Modifies a given item in the model.

More...
 
COMMITModified (EDA_ITEM *aItem, EDA_ITEM *aCopy)
 

Creates an undo entry for an item that has been already modified.

More...
 
template<class Range >
COMMITStageItems (const Range &aRange, CHANGE_TYPE aChangeType)
 
COMMITStage (EDA_ITEM *aItem, CHANGE_TYPE aChangeType)
 

Adds a change of the item aItem of type aChangeType to the change list.

More...
 
COMMITStage (std::vector< EDA_ITEM * > &container, CHANGE_TYPE aChangeType)
 
COMMITStage (const PICKED_ITEMS_LIST &aItems, UNDO_REDO_T aModFlag=UR_UNSPECIFIED)
 
bool Empty () const
 

Protected Member Functions

void clear ()
 
virtual void makeEntry (EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=NULL)
 
CHANGE_TYPE convert (UNDO_REDO_T aType) const
 

Protected Attributes

std::set< EDA_ITEM * > m_changedItems
 
std::vector< COMMIT_LINEm_changes
 

Private Member Functions

virtual EDA_ITEMparentObject (EDA_ITEM *aItem) const override
 

Private Attributes

TOOL_MANAGERm_toolMgr
 
bool m_editModules
 

Detailed Description

Definition at line 36 of file board_commit.h.

Constructor & Destructor Documentation

BOARD_COMMIT::BOARD_COMMIT ( PCB_TOOL aTool)

Definition at line 38 of file board_commit.cpp.

References PCB_TOOL::EditingModules(), and TOOL_BASE::GetManager().

39 {
40  m_toolMgr = aTool->GetManager();
41  m_editModules = aTool->EditingModules();
42 }
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:47
bool EditingModules() const
Definition: pcb_tool.h:91
bool m_editModules
Definition: board_commit.h:48
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool...
Definition: tool_base.h:144
BOARD_COMMIT::BOARD_COMMIT ( PCB_BASE_FRAME aFrame)

Definition at line 45 of file board_commit.cpp.

References FRAME_PCB_MODULE_EDITOR, EDA_DRAW_FRAME::GetToolManager(), and EDA_BASE_FRAME::IsType().

46 {
47  m_toolMgr = aFrame->GetToolManager();
49 }
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:47
TOOL_MANAGER * GetToolManager() const
Function GetToolManager returns the tool manager instance, if any.
Definition: draw_frame.h:824
bool m_editModules
Definition: board_commit.h:48
bool IsType(FRAME_T aType) const
Definition: wxstruct.h:217
BOARD_COMMIT::~BOARD_COMMIT ( )
virtual

Definition at line 52 of file board_commit.cpp.

53 {
54 }

Member Function Documentation

COMMIT& COMMIT::Added ( EDA_ITEM aItem)
inlineinherited

Notifies observers that aItem has been added

Definition at line 84 of file commit.h.

References CHT_ADD, CHT_DONE, and COMMIT::Stage().

Referenced by PCBNEW_CONTROL::AppendBoard().

85  {
86  return Stage( aItem, CHT_ADD | CHT_DONE );
87  }
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
Definition: commit.h:38
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
void COMMIT::clear ( )
inlineprotectedinherited

Definition at line 154 of file commit.h.

References COMMIT::m_changedItems, and COMMIT::m_changes.

155  {
156  m_changedItems.clear();
157  m_changes.clear();
158  }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:166
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:167
CHANGE_TYPE COMMIT::convert ( UNDO_REDO_T  aType) const
protectedinherited

Definition at line 168 of file commit.cpp.

References CHT_ADD, CHT_MODIFY, CHT_REMOVE, UR_CHANGED, UR_DELETED, UR_FLIPPED, UR_MIRRORED_X, UR_MIRRORED_Y, UR_MOVED, UR_NEW, UR_ROTATED, and UR_ROTATED_CLOCKWISE.

Referenced by COMMIT::Stage().

169 {
170  switch( aType )
171  {
172  case UR_NEW:
173  return CHT_ADD;
174 
175  case UR_DELETED:
176  return CHT_REMOVE;
177 
178  default:
179  assert( false );
180  // fall through
181 
182  case UR_CHANGED:
183  case UR_MOVED:
184  case UR_MIRRORED_X:
185  case UR_MIRRORED_Y:
186  case UR_ROTATED:
188  case UR_FLIPPED:
189  return CHT_MODIFY;
190  }
191 }
Definition: commit.h:38
bool COMMIT::Empty ( ) const
inlineinherited

Definition at line 135 of file commit.h.

References COMMIT::m_changes.

Referenced by PCBNEW_CONTROL::AppendBoard().

136  {
137  return m_changes.empty();
138  }
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:167
void COMMIT::makeEntry ( EDA_ITEM aItem,
CHANGE_TYPE  aType,
EDA_ITEM aCopy = NULL 
)
protectedvirtualinherited

Definition at line 145 of file commit.cpp.

References CHT_MODIFY, CHT_TYPE, eraseIf(), COMMIT::m_changedItems, COMMIT::m_changes, COMMIT::COMMIT_LINE::m_copy, COMMIT::COMMIT_LINE::m_item, and COMMIT::COMMIT_LINE::m_type.

Referenced by COMMIT::Modified(), and COMMIT::Stage().

146 {
147  // Expect an item copy if it is going to be modified
148  assert( !!aCopy == ( ( aType & CHT_TYPE ) == CHT_MODIFY ) );
149 
150  if( m_changedItems.find( aItem ) != m_changedItems.end() )
151  {
152  eraseIf( m_changes, [aItem] ( const COMMIT_LINE& aEnt ) {
153  return aEnt.m_item == aItem;
154  } );
155  }
156 
157  COMMIT_LINE ent;
158 
159  ent.m_item = aItem;
160  ent.m_type = aType;
161  ent.m_copy = aCopy;
162 
163  m_changedItems.insert( aItem );
164  m_changes.push_back( ent );
165 }
void eraseIf(Container &c, F &&f)
Definition: commit.cpp:137
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:166
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:167
COMMIT & COMMIT::Modified ( EDA_ITEM aItem,
EDA_ITEM aCopy 
)
inherited

Creates an undo entry for an item that has been already modified.

Requires a copy done

before the modification.

Definition at line 82 of file commit.cpp.

References CHT_MODIFY, COMMIT::m_changedItems, COMMIT::makeEntry(), and COMMIT::parentObject().

Referenced by COMMIT::Stage(), BOARD_NETLIST_UPDATER::updateComponentPadConnections(), and BOARD_NETLIST_UPDATER::updateComponentParameters().

83 {
84  EDA_ITEM* parent = parentObject( aItem );
85 
86  if( m_changedItems.find( parent ) != m_changedItems.end() )
87  return *this; // item has been already modified once
88 
89  makeEntry( parent, CHT_MODIFY, aCopy );
90 
91  return *this;
92 }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:166
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
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:145
EDA_ITEM * BOARD_COMMIT::parentObject ( EDA_ITEM aItem) const
overrideprivatevirtual

Implements COMMIT.

Definition at line 290 of file board_commit.cpp.

References EDA_ITEM::GetParent(), PCB_MODULE_EDGE_T, PCB_MODULE_TEXT_T, PCB_PAD_T, and EDA_ITEM::Type().

291 {
292  switch( aItem->Type() )
293  {
294  case PCB_PAD_T:
295  case PCB_MODULE_EDGE_T:
296  case PCB_MODULE_TEXT_T:
297  return aItem->GetParent();
298  default:
299  return aItem;
300  }
301 
302  return aItem;
303 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
EDA_ITEM * GetParent() const
Definition: base_struct.h:208
class D_PAD, a pad in a footprint
Definition: typeinfo.h:102
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:106
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:105
void BOARD_COMMIT::Push ( const wxString &  aMessage = wxT("A commit"),
bool  aCreateUndoEntry = true 
)
overridevirtual

Executes the changes.

Implements COMMIT.

Definition at line 57 of file board_commit.cpp.

References KIGFX::VIEW::Add(), MODULE::Add(), BOARD::Add(), CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, EDA_ITEM::ClearFlags(), BOARD_ITEM_CONTAINER::Delete(), BOARD::GetConnectivity(), BOARD_ITEM::GetParent(), EDA_DRAW_FRAME::GetToolManager(), TEXTE_MODULE::GetType(), BOARD::m_Modules, BOARD::m_Status_Pcb, mod, PCB_BASE_FRAME::OnModify(), PCB_DIMENSION_T, PCB_LINE_T, PCB_MARKER_T, PCB_MODULE_EDGE_T, PCB_MODULE_T, PCB_MODULE_TEXT_T, PCB_PAD_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, PCB_ZONE_T, PICKED_ITEMS_LIST::PushItem(), KIGFX::VIEW::Remove(), BOARD::Remove(), MODULE::RunOnChildren(), PCB_BASE_FRAME::SaveCopyInUndoList(), ITEM_PICKER::SetLink(), TEXTE_MODULE::TEXT_is_DIVERS, TEXTE_MODULE::TEXT_is_REFERENCE, TEXTE_MODULE::TEXT_is_VALUE, EDA_ITEM::Type(), KIGFX::VIEW::Update(), PCB_BASE_FRAME::UpdateMsgPanel(), UR_CHANGED, UR_DELETED, UR_NEW, and UR_UNSPECIFIED.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), POINT_EDITOR::addCorner(), DRC::addMarkerToPcb(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCBNEW_CONTROL::AppendBoard(), PAD_TOOL::applyPadSettings(), PCB_EDIT_FRAME::Clean_Pcb(), MICROWAVE_TOOL::createInductorBetween(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::drawSegment(), PCB_EDIT_FRAME::Edit_Zone_Params(), MODULE_EDITOR_TOOLS::EnumeratePads(), PCB_EDIT_FRAME::Fill_Zone(), ARRAY_CREATOR::Invoke(), DIALOG_EXCHANGE_MODULE::OnOkClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), DIALOG_DIMENSION_EDITOR::OnOKClick(), POINT_EDITOR::OnSelectionChange(), MODULE_EDITOR_TOOLS::PasteItems(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PAD_TOOL::pushPadSettings(), PCB_EDIT_FRAME::RemoveMisConnectedTracks(), PCB_BASE_FRAME::ResetModuleTextSizes(), DRAWING_TOOL::SetAnchor(), DialogEditModuleText::TransferDataFromWindow(), DIALOG_PCB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_MODULE_MODULE_EDITOR::TransferDataFromWindow(), DIALOG_MODULE_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::UpdateNetlist(), PCB_EDITOR_CONTROL::ZoneDuplicate(), PCB_EDITOR_CONTROL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneFillAll(), PCB_EDITOR_CONTROL::ZoneUnfill(), and PCB_EDITOR_CONTROL::ZoneUnfillAll().

58 {
59  // Objects potentially interested in changes:
60  PICKED_ITEMS_LIST undoList;
61  KIGFX::VIEW* view = m_toolMgr->GetView();
62  BOARD* board = (BOARD*) m_toolMgr->GetModel();
64  auto connectivity = board->GetConnectivity();
65  std::set<EDA_ITEM*> savedModules;
66 
67  if( Empty() )
68  return;
69 
70  for( COMMIT_LINE& ent : m_changes )
71  {
72  int changeType = ent.m_type & CHT_TYPE;
73  int changeFlags = ent.m_type & CHT_FLAGS;
74  BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
75 
76  // Module items need to be saved in the undo buffer before modification
77  if( m_editModules )
78  {
79  // Be sure that we are storing a module
80  if( ent.m_item->Type() != PCB_MODULE_T )
81  ent.m_item = ent.m_item->GetParent();
82 
83  // We have not saved the module yet, so let's create an entry
84  if( savedModules.count( ent.m_item ) == 0 )
85  {
86  if( !ent.m_copy )
87  {
88  assert( changeType != CHT_MODIFY ); // too late to make a copy..
89  ent.m_copy = ent.m_item->Clone();
90  }
91 
92  assert( ent.m_item->Type() == PCB_MODULE_T );
93  assert( ent.m_copy->Type() == PCB_MODULE_T );
94 
95  if( aCreateUndoEntry )
96  {
97  ITEM_PICKER itemWrapper( ent.m_item, UR_CHANGED );
98  itemWrapper.SetLink( ent.m_copy );
99  undoList.PushItem( itemWrapper );
100  frame->SaveCopyInUndoList( undoList, UR_CHANGED );
101  }
102 
103  savedModules.insert( ent.m_item );
104  static_cast<MODULE*>( ent.m_item )->SetLastEditTime();
105  }
106  }
107 
108  switch( changeType )
109  {
110  case CHT_ADD:
111  {
112  if( !m_editModules )
113  {
114  if( aCreateUndoEntry )
115  {
116  undoList.PushItem( ITEM_PICKER( boardItem, UR_NEW ) );
117  }
118 
119  if( !( changeFlags & CHT_DONE ) )
120  board->Add( boardItem );
121 
122  //ratsnest->Add( boardItem ); // TODO currently done by BOARD::Add()
123 
124  if( boardItem->Type() == PCB_MODULE_T )
125  {
126  MODULE* mod = static_cast<MODULE*>( boardItem );
127  mod->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
128  }
129  }
130  else
131  {
132  // modules inside modules are not supported yet
133  assert( boardItem->Type() != PCB_MODULE_T );
134 
135  if( !( changeFlags & CHT_DONE ) )
136  board->m_Modules->Add( boardItem );
137  }
138 
139  view->Add( boardItem );
140  break;
141  }
142 
143  case CHT_REMOVE:
144  {
145  if( !m_editModules && aCreateUndoEntry )
146  {
147  undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
148  }
149 
150  switch( boardItem->Type() )
151  {
152  // Module items
153  case PCB_PAD_T:
154  case PCB_MODULE_EDGE_T:
155  case PCB_MODULE_TEXT_T:
156  {
157  // Do not allow footprint text removal when not editing a module
158  if( !m_editModules )
159  break;
160 
161  bool remove = true;
162 
163  if( boardItem->Type() == PCB_MODULE_TEXT_T )
164  {
165  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
166 
167  switch( text->GetType() )
168  {
170  //DisplayError( frame, _( "Cannot delete component reference." ) );
171  remove = false;
172  break;
173 
175  //DisplayError( frame, _( "Cannot delete component value." ) );
176  remove = false;
177  break;
178 
179  case TEXTE_MODULE::TEXT_is_DIVERS: // suppress warnings
180  break;
181 
182  default:
183  assert( false );
184  break;
185  }
186  }
187 
188  if( remove )
189  {
190  view->Remove( boardItem );
191 
192  if( !( changeFlags & CHT_DONE ) )
193  {
194  MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
195  assert( module && module->Type() == PCB_MODULE_T );
196  module->Delete( boardItem );
197  }
198 
199  board->m_Status_Pcb = 0; // it is done in the legacy view (ratsnest perhaps?)
200  }
201 
202  break;
203  }
204 
205  // Board items
206  case PCB_LINE_T: // a segment not on copper layers
207  case PCB_TEXT_T: // a text on a layer
208  case PCB_TRACE_T: // a track segment (segment on a copper layer)
209  case PCB_VIA_T: // a via (like track segment on a copper layer)
210  case PCB_DIMENSION_T: // a dimension (graphic item)
211  case PCB_TARGET_T: // a target (graphic item)
212  case PCB_MARKER_T: // a marker used to show something
213  case PCB_ZONE_T: // SEG_ZONE items are now deprecated
214  case PCB_ZONE_AREA_T:
215  view->Remove( boardItem );
216 
217  if( !( changeFlags & CHT_DONE ) )
218  board->Remove( boardItem );
219 
220  //ratsnest->Remove( boardItem ); // currently done by BOARD::Remove()
221  break;
222 
223  case PCB_MODULE_T:
224  {
225  // There are no modules inside a module yet
226  assert( !m_editModules );
227 
228  MODULE* module = static_cast<MODULE*>( boardItem );
229  module->ClearFlags();
230  module->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
231 
232  view->Remove( module );
233 
234  if( !( changeFlags & CHT_DONE ) )
235  board->Remove( module );
236 
237  // Clear flags to indicate, that the ratsnest, list of nets & pads are not valid anymore
238  board->m_Status_Pcb = 0;
239  }
240  break;
241 
242  default: // other types do not need to (or should not) be handled
243  assert( false );
244  break;
245  }
246  break;
247  }
248 
249  case CHT_MODIFY:
250  {
251  if( !m_editModules && aCreateUndoEntry )
252  {
253  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
254  assert( ent.m_copy );
255  itemWrapper.SetLink( ent.m_copy );
256  undoList.PushItem( itemWrapper );
257  }
258 
259  if( boardItem->Type() == PCB_MODULE_T )
260  {
261  MODULE* module = static_cast<MODULE*>( boardItem );
262  module->RunOnChildren( [&view] ( BOARD_ITEM* aItem ) { view->Update( aItem ); } );
263  }
264 
265  view->Update ( boardItem );
266  connectivity->Update( boardItem );
267  break;
268  }
269 
270  default:
271  assert( false );
272  break;
273  }
274  }
275 
276  if( !m_editModules && aCreateUndoEntry )
277  frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
278 
279  if( TOOL_MANAGER* toolMgr = frame->GetToolManager() )
280  toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
281 
282  connectivity->RecalculateRatsnest();
283  frame->OnModify();
284  frame->UpdateMsgPanel();
285 
286  clear();
287 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
BOARD_ITEM_CONTAINER * GetParent() const
void RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)
Function RunOnChildren.
void clear()
Definition: commit.h:154
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
TEXT_TYPE GetType() const
wxWindow * GetEditFrame() const
Definition: tool_manager.h:258
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
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
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:47
bool Empty() const
Definition: commit.h:135
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:106
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:107
Class TOOL_MANAGER.
Definition: tool_manager.h:49
class MODULE, a footprint
Definition: typeinfo.h:101
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
>
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
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
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:824
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:111
EDA_ITEM * GetModel() const
Definition: tool_manager.h:253
bool m_editModules
Definition: board_commit.h:48
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
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:167
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 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
Class VIEW.
Definition: view.h:58
void UpdateMsgPanel() override
>
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:243
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
COMMIT& COMMIT::Remove ( EDA_ITEM aItem)
inlineinherited

Removes a new item from the model

Definition at line 90 of file commit.h.

References CHT_REMOVE, and COMMIT::Stage().

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), BOARD_NETLIST_UPDATER::deleteUnusedComponents(), PCB_EDIT_FRAME::Exchange_Module(), mergeZones(), and BOARD_NETLIST_UPDATER::replaceComponent().

91  {
92  return Stage( aItem, CHT_REMOVE );
93  }
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
COMMIT& COMMIT::Removed ( EDA_ITEM aItem)
inlineinherited

Notifies observers that aItem has been removed

Definition at line 96 of file commit.h.

References CHT_DONE, CHT_REMOVE, and COMMIT::Stage().

Referenced by TRACKS_CLEANER::deleteDanglingTracks(), TRACKS_CLEANER::MergeCollinearTracks(), and TRACKS_CLEANER::removeItems().

97  {
98  return Stage( aItem, CHT_REMOVE | CHT_DONE );
99  }
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
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
void BOARD_COMMIT::Revert ( )
overridevirtual

Revertes the commit by restoring the modifed items state.

Implements COMMIT.

Definition at line 306 of file board_commit.cpp.

References KIGFX::VIEW::Add(), CHT_ADD, CHT_MODIFY, CHT_REMOVE, EDA_ITEM::ClearFlags(), BOARD::GetConnectivity(), COMMIT::COMMIT_LINE::m_copy, COMMIT::COMMIT_LINE::m_item, COMMIT::COMMIT_LINE::m_type, PCB_MODULE_T, KIGFX::VIEW::Remove(), MODULE::RunOnChildren(), SELECTED, BOARD_ITEM::SwapData(), and EDA_ITEM::Type().

Referenced by MODULE_EDITOR_TOOLS::EnumeratePads(), POINT_EDITOR::OnSelectionChange(), and PCB_EDITOR_CONTROL::ZoneFillAll().

307 {
308  PICKED_ITEMS_LIST undoList;
309  KIGFX::VIEW* view = m_toolMgr->GetView();
310  BOARD* board = (BOARD*) m_toolMgr->GetModel();
311  auto connectivity = board->GetConnectivity();
312 
313  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
314  {
315  COMMIT_LINE& ent = *it;
316  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
317  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
318 
319  switch( ent.m_type )
320  {
321  case CHT_ADD:
322  if( item->Type() == PCB_MODULE_T )
323  {
324  MODULE* oldModule = static_cast<MODULE*>( item );
325  oldModule->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
326  }
327 
328  view->Remove( item );
329  connectivity->Remove( item );
330  break;
331 
332  case CHT_REMOVE:
333  if( item->Type() == PCB_MODULE_T )
334  {
335  MODULE* newModule = static_cast<MODULE*>( item );
336  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
337  newModule->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
338  }
339 
340  view->Add( item );
341  connectivity->Add( item );
342  break;
343 
344  case CHT_MODIFY:
345  {
346  if( item->Type() == PCB_MODULE_T )
347  {
348  MODULE* oldModule = static_cast<MODULE*>( item );
349  oldModule->RunOnChildren( std::bind( &KIGFX::VIEW::Remove, view, _1 ) );
350  }
351 
352  view->Remove( item );
353  connectivity->Remove( item );
354 
355  item->SwapData( copy );
356 
357  item->ClearFlags( SELECTED );
358 
359  // Update all pads/drawings/texts, as they become invalid
360  // for the VIEW after SwapData() called for modules
361  if( item->Type() == PCB_MODULE_T )
362  {
363  MODULE* newModule = static_cast<MODULE*>( item );
364  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
365  newModule->RunOnChildren( std::bind( &KIGFX::VIEW::Add, view, _1, -1 ) );
366  }
367 
368  view->Add( item );
369  connectivity->Add( item );
370  delete copy;
371  break;
372  }
373 
374  default:
375  assert( false );
376  break;
377  }
378  }
379 
380  connectivity->RecalculateRatsnest();
381 
382  clear();
383 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
void RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)
Function RunOnChildren.
void clear()
Definition: commit.h:154
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Definition: commit.h:38
void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:341
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:47
void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
Definition: undo_redo.cpp:566
#define SELECTED
Definition: base_struct.h:120
class MODULE, a footprint
Definition: typeinfo.h:101
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
EDA_ITEM * GetModel() const
Definition: tool_manager.h:253
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:167
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:254
void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:311
Class VIEW.
Definition: view.h:58
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:243
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
COMMIT & COMMIT::Stage ( EDA_ITEM aItem,
CHANGE_TYPE  aChangeType 
)
inherited

Adds a change of the item aItem of type aChangeType to the change list.

Definition at line 44 of file commit.cpp.

References CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, EDA_ITEM::Clone(), COMMIT::m_changedItems, COMMIT::makeEntry(), and COMMIT::parentObject().

Referenced by COMMIT::Add(), COMMIT::Added(), PCB_EDIT_FRAME::Edit_Zone_Params(), COMMIT::Modify(), COMMIT::Remove(), COMMIT::Removed(), COMMIT::Stage(), and COMMIT::StageItems().

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 
66  if( m_changedItems.find( parent ) != m_changedItems.end() )
67  return *this; // item has been already modified once
68 
69  makeEntry( parent, CHT_MODIFY | flag, parent->Clone() );
70 
71  return *this;
72  }
73 
74  default:
75  assert( false );
76  }
77 
78  return *this;
79 }
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: commit.h:38
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:166
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
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:145
COMMIT & COMMIT::Stage ( std::vector< EDA_ITEM * > &  container,
CHANGE_TYPE  aChangeType 
)
inherited

Definition at line 95 of file commit.cpp.

References COMMIT::Stage().

96 {
97  for( EDA_ITEM* item : container )
98  {
99  Stage( item, aChangeType );
100  }
101 
102  return *this;
103 }
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
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
COMMIT & COMMIT::Stage ( const PICKED_ITEMS_LIST aItems,
UNDO_REDO_T  aModFlag = UR_UNSPECIFIED 
)
inherited

Definition at line 106 of file commit.cpp.

References COMMIT::convert(), PICKED_ITEMS_LIST::GetCount(), PICKED_ITEMS_LIST::GetPickedItem(), PICKED_ITEMS_LIST::GetPickedItemLink(), PICKED_ITEMS_LIST::GetPickedItemStatus(), PICKED_ITEMS_LIST::m_Status, COMMIT::Modified(), COMMIT::Stage(), UR_CHANGED, and UR_UNSPECIFIED.

107 {
108  for( unsigned int i = 0; i < aItems.GetCount(); i++ )
109  {
110  UNDO_REDO_T change_type = aItems.GetPickedItemStatus( i );
111  EDA_ITEM* item = aItems.GetPickedItem( i );
112  EDA_ITEM* copy = NULL;
113 
114  if( change_type == UR_UNSPECIFIED )
115  change_type = aItems.m_Status;
116 
117  if( change_type == UR_UNSPECIFIED )
118  change_type = aModFlag;
119 
120  if( ( copy = aItems.GetPickedItemLink( i ) ) )
121  {
122  assert( change_type == UR_CHANGED );
123 
124  // There was already a copy created, so use it
125  Modified( item, copy );
126  }
127  else
128  {
129  Stage( item, convert( change_type ) );
130  }
131  }
132 
133  return *this;
134 }
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
COMMIT & Modified(EDA_ITEM *aItem, EDA_ITEM *aCopy)
Creates an undo entry for an item that has been already modified.
Definition: commit.cpp:82
CHANGE_TYPE convert(UNDO_REDO_T aType) const
Definition: commit.cpp:168
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...
unsigned GetCount() const
Function GetCount.
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
Function GetPickedItem.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
template<class Range >
COMMIT& COMMIT::StageItems ( const Range &  aRange,
CHANGE_TYPE  aChangeType 
)
inlineinherited

Definition at line 113 of file commit.h.

References COMMIT::Stage().

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignLeft(), ALIGN_DISTRIBUTE_TOOL::AlignRight(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), and POINT_EDITOR::OnSelectionChange().

114  {
115  for( const auto& item : aRange )
116  Stage( item, aChangeType );
117 
118  return *this;
119  }
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

Member Data Documentation

std::set<EDA_ITEM*> COMMIT::m_changedItems
protectedinherited

Definition at line 166 of file commit.h.

Referenced by COMMIT::clear(), COMMIT::makeEntry(), COMMIT::Modified(), and COMMIT::Stage().

std::vector<COMMIT_LINE> COMMIT::m_changes
protectedinherited

Definition at line 167 of file commit.h.

Referenced by COMMIT::clear(), COMMIT::Empty(), COMMIT::makeEntry(), and COMMIT::~COMMIT().

bool BOARD_COMMIT::m_editModules
private

Definition at line 48 of file board_commit.h.

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr
private

Definition at line 47 of file board_commit.h.


The documentation for this class was generated from the following files: