KiCad PCB EDA Suite
BOARD_COMMIT Class Reference

#include <board_commit.h>

Inheritance diagram for BOARD_COMMIT:
COMMIT

Public Member Functions

 BOARD_COMMIT (EDA_DRAW_FRAME *aFrame)
 
 BOARD_COMMIT (PCB_TOOL *aTool)
 
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
 
int GetStatus (EDA_ITEM *aItem)
 

Returns status of an item.

More...
 

Protected Member Functions

void clear ()
 
COMMITcreateModified (EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
 
virtual void makeEntry (EDA_ITEM *aItem, CHANGE_TYPE aType, EDA_ITEM *aCopy=NULL)
 
COMMIT_LINEfindEntry (EDA_ITEM *aItem)
 Searches for an entry describing change for a particular item. More...
 
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 37 of file board_commit.h.

Constructor & Destructor Documentation

BOARD_COMMIT::BOARD_COMMIT ( EDA_DRAW_FRAME aFrame)

Definition at line 47 of file board_commit.cpp.

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

48 {
49  m_toolMgr = aFrame->GetToolManager();
51 }
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:49
TOOL_MANAGER * GetToolManager() const
Function GetToolManager returns the tool manager instance, if any.
Definition: draw_frame.h:871
bool m_editModules
Definition: board_commit.h:50
bool IsType(FRAME_T aType) const
Definition: wxstruct.h:229
BOARD_COMMIT::BOARD_COMMIT ( PCB_TOOL aTool)

Definition at line 40 of file board_commit.cpp.

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

41 {
42  m_toolMgr = aTool->GetManager();
43  m_editModules = aTool->EditingModules();
44 }
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:49
bool EditingModules() const
Definition: pcb_tool.h:97
bool m_editModules
Definition: board_commit.h:50
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 ( )
virtual

Definition at line 54 of file board_commit.cpp.

55 {
56 }

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().

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:46
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 160 of file commit.h.

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

161  {
162  m_changedItems.clear();
163  m_changes.clear();
164  }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:180
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:181
CHANGE_TYPE COMMIT::convert ( UNDO_REDO_T  aType) const
protectedinherited

Definition at line 187 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().

188 {
189  switch( aType )
190  {
191  case UR_NEW:
192  return CHT_ADD;
193 
194  case UR_DELETED:
195  return CHT_REMOVE;
196 
197  default:
198  assert( false );
199  // fall through
200 
201  case UR_CHANGED:
202  case UR_MOVED:
203  case UR_MIRRORED_X:
204  case UR_MIRRORED_Y:
205  case UR_ROTATED:
207  case UR_FLIPPED:
208  return CHT_MODIFY;
209  }
210 }
Definition: commit.h:38
COMMIT & COMMIT::createModified ( EDA_ITEM aItem,
EDA_ITEM aCopy,
int  aExtraFlags = 0 
)
protectedinherited

Definition at line 138 of file commit.cpp.

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

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

139 {
140  EDA_ITEM* parent = parentObject( aItem );
141  auto entryIt = m_changedItems.find( parent );
142 
143  if( entryIt != m_changedItems.end() )
144  return *this; // item has been already modified once
145 
146  makeEntry( parent, CHT_MODIFY | aExtraFlags, aCopy );
147 
148  return *this;
149 }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:180
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:178
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:152
bool COMMIT::Empty ( ) const
inlineinherited

Definition at line 138 of file commit.h.

References COMMIT::m_changes.

139  {
140  return m_changes.empty();
141  }
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:181
COMMIT::COMMIT_LINE * COMMIT::findEntry ( EDA_ITEM aItem)
protectedinherited

Searches for an entry describing change for a particular item.

Returns
null if there is no related entry.

Definition at line 175 of file commit.cpp.

References COMMIT::m_changes.

Referenced by COMMIT::GetStatus().

176 {
177  for( COMMIT_LINE& change : m_changes )
178  {
179  if( change.m_item == aItem )
180  return &change;
181  }
182 
183  return nullptr;
184 }
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:181
int COMMIT::GetStatus ( EDA_ITEM aItem)
inherited

Returns status of an item.

Definition at line 120 of file commit.cpp.

References COMMIT::findEntry(), COMMIT::COMMIT_LINE::m_type, and COMMIT::parentObject().

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

121 {
122  COMMIT_LINE* entry = findEntry( parentObject( aItem ) );
123 
124  return entry ? entry->m_type : 0;
125 }
COMMIT_LINE * findEntry(EDA_ITEM *aItem)
Searches for an entry describing change for a particular item.
Definition: commit.cpp:175
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const =0
void COMMIT::makeEntry ( EDA_ITEM aItem,
CHANGE_TYPE  aType,
EDA_ITEM aCopy = NULL 
)
protectedvirtualinherited

Definition at line 152 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::createModified(), and COMMIT::Stage().

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

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

Requires a copy done

before the modification.

Definition at line 110 of file commit.h.

References COMMIT::createModified().

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

111  {
112  return createModified( aItem, aCopy );
113  }
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
Definition: commit.cpp:138
EDA_ITEM * BOARD_COMMIT::parentObject ( EDA_ITEM aItem) const
overrideprivatevirtual

Implements COMMIT.

Definition at line 292 of file board_commit.cpp.

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

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

Executes the changes.

Implements COMMIT.

Definition at line 59 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(), DLIST< T >::GetFirst(), EDA_DRAW_FRAME::GetGalCanvas(), BOARD_ITEM::GetParent(), EDA_DRAW_FRAME::GetToolManager(), TEXTE_MODULE::GetType(), BOARD::m_Modules, BOARD::m_Status_Pcb, 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(), PCB_DRAW_PANEL_GAL::RedrawRatsnest(), KIGFX::VIEW::Remove(), BOARD::Remove(), PCB_BASE_FRAME::SaveCopyInUndoList(), ITEM_PICKER::SetLink(), EDA_ITEM::SetParent(), 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::AlignTop(), PAD_TOOL::applyPadSettings(), PCB_EDIT_FRAME::Clean_Pcb(), MICROWAVE_TOOL::createInductorBetween(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), 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(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), ARRAY_CREATOR::Invoke(), DIALOG_EXCHANGE_MODULE::OnOkClick(), TARGET_PROPERTIES_DIALOG_EDITOR::OnOkClick(), DIALOG_DIMENSION_EDITOR::OnOKClick(), POINT_EDITOR::OnSelectionChange(), 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(), DRC::TestZoneToZoneOutline(), 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(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

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();
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  }
125  else
126  {
127  // modules inside modules are not supported yet
128  wxASSERT( boardItem->Type() != PCB_MODULE_T );
129 
130  boardItem->SetParent( board->m_Modules.GetFirst() );
131  if( !( changeFlags & CHT_DONE ) )
132  board->m_Modules->Add( boardItem );
133  }
134 
135  view->Add( boardItem );
136  break;
137  }
138 
139  case CHT_REMOVE:
140  {
141  if( !m_editModules && aCreateUndoEntry )
142  {
143  undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
144  }
145 
146  switch( boardItem->Type() )
147  {
148  // Module items
149  case PCB_PAD_T:
150  case PCB_MODULE_EDGE_T:
151  case PCB_MODULE_TEXT_T:
152  {
153  // Do not allow footprint text removal when not editing a module
154  if( !m_editModules )
155  break;
156 
157  bool remove = true;
158 
159  if( boardItem->Type() == PCB_MODULE_TEXT_T )
160  {
161  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
162 
163  switch( text->GetType() )
164  {
166  //DisplayError( frame, _( "Cannot delete component reference." ) );
167  remove = false;
168  break;
169 
171  //DisplayError( frame, _( "Cannot delete component value." ) );
172  remove = false;
173  break;
174 
175  case TEXTE_MODULE::TEXT_is_DIVERS: // suppress warnings
176  break;
177 
178  default:
179  wxASSERT( false );
180  break;
181  }
182  }
183 
184  if( remove )
185  {
186  view->Remove( boardItem );
187 
188  if( !( changeFlags & CHT_DONE ) )
189  {
190  MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
191  wxASSERT( module && module->Type() == PCB_MODULE_T );
192  module->Delete( boardItem );
193  }
194 
195  board->m_Status_Pcb = 0; // it is done in the legacy view (ratsnest perhaps?)
196  }
197 
198  break;
199  }
200 
201  // Board items
202  case PCB_LINE_T: // a segment not on copper layers
203  case PCB_TEXT_T: // a text on a layer
204  case PCB_TRACE_T: // a track segment (segment on a copper layer)
205  case PCB_VIA_T: // a via (like track segment on a copper layer)
206  case PCB_DIMENSION_T: // a dimension (graphic item)
207  case PCB_TARGET_T: // a target (graphic item)
208  case PCB_MARKER_T: // a marker used to show something
209  case PCB_ZONE_T: // SEG_ZONE items are now deprecated
210  case PCB_ZONE_AREA_T:
211  view->Remove( boardItem );
212 
213  if( !( changeFlags & CHT_DONE ) )
214  board->Remove( boardItem );
215 
216  break;
217 
218  case PCB_MODULE_T:
219  {
220  // There are no modules inside a module yet
221  wxASSERT( !m_editModules );
222 
223  MODULE* module = static_cast<MODULE*>( boardItem );
224  module->ClearFlags();
225 
226  view->Remove( module );
227 
228  if( !( changeFlags & CHT_DONE ) )
229  board->Remove( module );
230 
231  // Clear flags to indicate, that the ratsnest, list of nets & pads are not valid anymore
232  board->m_Status_Pcb = 0;
233  }
234  break;
235 
236  default: // other types do not need to (or should not) be handled
237  wxASSERT( false );
238  break;
239  }
240  break;
241  }
242 
243  case CHT_MODIFY:
244  {
245  if( !m_editModules && aCreateUndoEntry )
246  {
247  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
248  wxASSERT( ent.m_copy );
249  itemWrapper.SetLink( ent.m_copy );
250  undoList.PushItem( itemWrapper );
251  }
252 
253  if( ent.m_copy )
254  connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
255 
256  connectivity->Update( boardItem );
257  view->Update( boardItem );
258 
259  // if no undo entry is needed, the copy would create a memory leak
260  if( !aCreateUndoEntry )
261  delete ent.m_copy;
262 
263  break;
264  }
265 
266  default:
267  wxASSERT( false );
268  break;
269  }
270  }
271 
272  if( !m_editModules && aCreateUndoEntry )
273  frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
274 
275  if( TOOL_MANAGER* toolMgr = frame->GetToolManager() )
276  toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
277 
278  if ( !m_editModules )
279  {
280  auto panel = static_cast<PCB_DRAW_PANEL_GAL*>( frame->GetGalCanvas() );
281  connectivity->RecalculateRatsnest();
282  panel->RedrawRatsnest();
283  }
284 
285  frame->OnModify();
286  frame->UpdateMsgPanel();
287 
288  clear();
289 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:225
BOARD_ITEM_CONTAINER * GetParent() const
void clear()
Definition: commit.h:160
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:267
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:342
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
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:90
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:49
bool Empty() const
Definition: commit.h:138
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
void RedrawRatsnest()
Forces refresh of the ratsnest visual representation
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
Class TOOL_MANAGER.
Definition: tool_manager.h:49
class MODULE, a footprint
Definition: typeinfo.h:89
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
>
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:240
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:97
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
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:1385
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:100
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:101
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
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:871
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:99
EDA_ITEM * GetModel() const
Definition: tool_manager.h:262
bool m_editModules
Definition: board_commit.h:50
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:181
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:281
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:864
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:312
Class VIEW.
Definition: view.h:58
void UpdateMsgPanel() override
>
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:252
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:290
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(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), 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:46
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:46
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 308 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(), and POINT_EDITOR::OnSelectionChange().

309 {
310  PICKED_ITEMS_LIST undoList;
311  KIGFX::VIEW* view = m_toolMgr->GetView();
312  BOARD* board = (BOARD*) m_toolMgr->GetModel();
313  auto connectivity = board->GetConnectivity();
314 
315  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
316  {
317  COMMIT_LINE& ent = *it;
318  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
319  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
320 
321  switch( ent.m_type )
322  {
323  case CHT_ADD:
324 
325  view->Remove( item );
326  connectivity->Remove( item );
327  break;
328 
329  case CHT_REMOVE:
330  if( item->Type() == PCB_MODULE_T )
331  {
332  MODULE* newModule = static_cast<MODULE*>( item );
333  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
334  }
335 
336  view->Add( item );
337  connectivity->Add( item );
338  break;
339 
340  case CHT_MODIFY:
341  {
342  view->Remove( item );
343  connectivity->Remove( item );
344 
345  item->SwapData( copy );
346 
347  item->ClearFlags( SELECTED );
348 
349  // Update all pads/drawings/texts, as they become invalid
350  // for the VIEW after SwapData() called for modules
351  if( item->Type() == PCB_MODULE_T )
352  {
353  MODULE* newModule = static_cast<MODULE*>( item );
354  newModule->RunOnChildren( std::bind( &EDA_ITEM::ClearFlags, _1, SELECTED ) );
355  }
356 
357  view->Add( item );
358  connectivity->Add( item );
359  delete copy;
360  break;
361  }
362 
363  default:
364  wxASSERT( false );
365  break;
366  }
367  }
368 
369  if ( !m_editModules )
370  connectivity->RecalculateRatsnest();
371 
372  clear();
373 }
KICAD_T Type() const
Function Type()
Definition: base_struct.h:225
void RunOnChildren(std::function< void(BOARD_ITEM *)> aFunction)
Function RunOnChildren.
void clear()
Definition: commit.h:160
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class...
Definition: commit.h:38
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:342
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:49
virtual void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
#define SELECTED
Definition: base_struct.h:134
class MODULE, a footprint
Definition: typeinfo.h:89
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
EDA_ITEM * GetModel() const
Definition: tool_manager.h:262
bool m_editModules
Definition: board_commit.h:50
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:181
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:281
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:312
Class VIEW.
Definition: view.h:58
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:252
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 46 of file commit.cpp.

References CHT_ADD, CHT_DONE, CHT_FLAGS, CHT_MODIFY, CHT_REMOVE, CHT_TYPE, EDA_ITEM::Clone(), COMMIT::createModified(), 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().

47 {
48  // CHT_MODIFY and CHT_DONE are not compatible
49  assert( ( aChangeType & ( CHT_MODIFY | CHT_DONE ) ) != ( CHT_MODIFY | CHT_DONE ) );
50 
51  int flag = aChangeType & CHT_FLAGS;
52 
53  switch( aChangeType & CHT_TYPE )
54  {
55  case CHT_ADD:
56  assert( m_changedItems.find( aItem ) == m_changedItems.end() );
57  makeEntry( aItem, CHT_ADD | flag );
58  return *this;
59 
60  case CHT_REMOVE:
61  makeEntry( aItem, CHT_REMOVE | flag );
62  return *this;
63 
64  case CHT_MODIFY:
65  {
66  EDA_ITEM* parent = parentObject( aItem );
67  return createModified( parent, parent->Clone(), flag );
68  }
69 
70  default:
71  assert( false );
72  }
73 
74  return *this;
75 }
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:180
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
Definition: commit.cpp:138
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:178
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:152
COMMIT & COMMIT::Stage ( std::vector< EDA_ITEM * > &  container,
CHANGE_TYPE  aChangeType 
)
inherited

Definition at line 78 of file commit.cpp.

References COMMIT::Stage().

79 {
80  for( EDA_ITEM* item : container )
81  {
82  Stage( item, aChangeType );
83  }
84 
85  return *this;
86 }
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 EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:178
COMMIT & COMMIT::Stage ( const PICKED_ITEMS_LIST aItems,
UNDO_REDO_T  aModFlag = UR_UNSPECIFIED 
)
inherited

Definition at line 89 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.

90 {
91  for( unsigned int i = 0; i < aItems.GetCount(); i++ )
92  {
93  UNDO_REDO_T change_type = aItems.GetPickedItemStatus( i );
94  EDA_ITEM* item = aItems.GetPickedItem( i );
95  EDA_ITEM* copy = NULL;
96 
97  if( change_type == UR_UNSPECIFIED )
98  change_type = aItems.m_Status;
99 
100  if( change_type == UR_UNSPECIFIED )
101  change_type = aModFlag;
102 
103  if( ( copy = aItems.GetPickedItemLink( i ) ) )
104  {
105  assert( change_type == UR_CHANGED );
106 
107  // There was already a copy created, so use it
108  Modified( item, copy );
109  }
110  else
111  {
112  Stage( item, convert( change_type ) );
113  }
114  }
115 
116  return *this;
117 }
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
CHANGE_TYPE convert(UNDO_REDO_T aType) const
Definition: commit.cpp:187
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.
COMMIT & Modified(EDA_ITEM *aItem, EDA_ITEM *aCopy)
Creates an undo entry for an item that has been already modified.
Definition: commit.h:110
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:178
template<class Range >
COMMIT& COMMIT::StageItems ( const Range &  aRange,
CHANGE_TYPE  aChangeType 
)
inlineinherited

Definition at line 116 of file commit.h.

References COMMIT::Stage().

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), and POINT_EDITOR::OnSelectionChange().

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

Member Data Documentation

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

Definition at line 180 of file commit.h.

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

std::vector<COMMIT_LINE> COMMIT::m_changes
protectedinherited
bool BOARD_COMMIT::m_editModules
private

Definition at line 50 of file board_commit.h.

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr
private

Definition at line 49 of file board_commit.h.


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