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_BASE *aTool)
 
virtual ~BOARD_COMMIT ()
 
virtual void Push (const wxString &aMessage=wxT("A commit"), bool aCreateUndoEntry=true, bool aSetDirtyBit=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() [1/2]

BOARD_COMMIT::BOARD_COMMIT ( EDA_DRAW_FRAME aFrame)

Definition at line 48 of file board_commit.cpp.

49 {
50  m_toolMgr = aFrame->GetToolManager();
52 }
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:51
TOOL_MANAGER * GetToolManager() const override
Return the tool manager instance, if any.
Definition: draw_frame.h:937
bool IsType(FRAME_T aType) const
bool m_editModules
Definition: board_commit.h:52

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

◆ BOARD_COMMIT() [2/2]

BOARD_COMMIT::BOARD_COMMIT ( PCB_TOOL_BASE aTool)

Definition at line 41 of file board_commit.cpp.

42 {
43  m_toolMgr = aTool->GetManager();
44  m_editModules = aTool->EditingModules();
45 }
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:51
TOOL_MANAGER * GetManager() const
Function GetManager() Returns the instance of TOOL_MANAGER that takes care of the tool.
Definition: tool_base.h:144
bool EditingModules() const
bool m_editModules
Definition: board_commit.h:52

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

◆ ~BOARD_COMMIT()

BOARD_COMMIT::~BOARD_COMMIT ( )
virtual

Definition at line 55 of file board_commit.cpp.

56 {
57 }

Member Function Documentation

◆ Add()

◆ Added()

COMMIT& COMMIT::Added ( EDA_ITEM aItem)
inlineinherited

Notifies observers that aItem has been added

Definition at line 84 of file commit.h.

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

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

◆ clear()

void COMMIT::clear ( )
inlineprotectedinherited

Definition at line 161 of file commit.h.

162  {
163  m_changedItems.clear();
164  m_changes.clear();
165  }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

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

◆ convert()

CHANGE_TYPE COMMIT::convert ( UNDO_REDO_T  aType) const
protectedinherited

Definition at line 202 of file commit.cpp.

203 {
204  switch( aType )
205  {
206  case UR_NEW:
207  return CHT_ADD;
208 
209  case UR_DELETED:
210  return CHT_REMOVE;
211 
212  default:
213  assert( false );
214  // fall through
215 
216  case UR_CHANGED:
217  case UR_MOVED:
218  case UR_MIRRORED_X:
219  case UR_MIRRORED_Y:
220  case UR_ROTATED:
222  case UR_FLIPPED:
223  return CHT_MODIFY;
224  }
225 }
Definition: commit.h:38

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

◆ createModified()

COMMIT & COMMIT::createModified ( EDA_ITEM aItem,
EDA_ITEM aCopy,
int  aExtraFlags = 0 
)
protectedinherited

Definition at line 150 of file commit.cpp.

151 {
152  EDA_ITEM* parent = parentObject( aItem );
153  auto entryIt = m_changedItems.find( parent );
154 
155  if( entryIt != m_changedItems.end() )
156  {
157  delete aCopy;
158  return *this; // item has been already modified once
159  }
160 
161  makeEntry( parent, CHT_MODIFY | aExtraFlags, aCopy );
162 
163  return *this;
164 }
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:157
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:167

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

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

◆ Empty()

bool COMMIT::Empty ( ) const
inlineinherited

Definition at line 139 of file commit.h.

140  {
141  return m_changes.empty();
142  }
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

References COMMIT::m_changes.

Referenced by DRAWING_TOOL::drawSegment().

◆ findEntry()

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 190 of file commit.cpp.

191 {
192  for( COMMIT_LINE& change : m_changes )
193  {
194  if( change.m_item == aItem )
195  return &change;
196  }
197 
198  return nullptr;
199 }
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

References COMMIT::m_changes.

Referenced by COMMIT::GetStatus().

◆ GetStatus()

int COMMIT::GetStatus ( EDA_ITEM aItem)
inherited

Returns status of an item.

Definition at line 132 of file commit.cpp.

133 {
134  COMMIT_LINE* entry = findEntry( parentObject( aItem ) );
135 
136  return entry ? entry->m_type : 0;
137 }
COMMIT_LINE * findEntry(EDA_ITEM *aItem)
Searches for an entry describing change for a particular item.
Definition: commit.cpp:190
virtual EDA_ITEM * parentObject(EDA_ITEM *aItem) const =0

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

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

◆ makeEntry()

void COMMIT::makeEntry ( EDA_ITEM aItem,
CHANGE_TYPE  aType,
EDA_ITEM aCopy = NULL 
)
protectedvirtualinherited

Definition at line 167 of file commit.cpp.

168 {
169  // Expect an item copy if it is going to be modified
170  assert( !!aCopy == ( ( aType & CHT_TYPE ) == CHT_MODIFY ) );
171 
172  if( m_changedItems.find( aItem ) != m_changedItems.end() )
173  {
174  eraseIf( m_changes, [aItem] ( const COMMIT_LINE& aEnt ) {
175  return aEnt.m_item == aItem;
176  } );
177  }
178 
179  COMMIT_LINE ent;
180 
181  ent.m_item = aItem;
182  ent.m_type = aType;
183  ent.m_copy = aCopy;
184 
185  m_changedItems.insert( aItem );
186  m_changes.push_back( ent );
187 }
void eraseIf(Container &c, F &&f)
Definition: commit.cpp:141
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182

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

◆ Modified()

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.

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

References COMMIT::createModified().

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

◆ Modify()

◆ parentObject()

EDA_ITEM * BOARD_COMMIT::parentObject ( EDA_ITEM aItem) const
overrideprivatevirtual

Implements COMMIT.

Definition at line 282 of file board_commit.cpp.

283 {
284  switch( aItem->Type() )
285  {
286  case PCB_PAD_T:
287  case PCB_MODULE_EDGE_T:
288  case PCB_MODULE_TEXT_T:
289  return aItem->GetParent();
290  default:
291  return aItem;
292  }
293 
294  return aItem;
295 }
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
EDA_ITEM * GetParent() const
Definition: base_struct.h:214
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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

◆ Push()

void BOARD_COMMIT::Push ( const wxString &  aMessage = wxT("A commit"),
bool  aCreateUndoEntry = true,
bool  aSetDirtyBit = true 
)
overridevirtual

Executes the changes.

Implements COMMIT.

Definition at line 60 of file board_commit.cpp.

61 {
62  // Objects potentially interested in changes:
63  PICKED_ITEMS_LIST undoList;
64  KIGFX::VIEW* view = m_toolMgr->GetView();
65  BOARD* board = (BOARD*) m_toolMgr->GetModel();
67  auto connectivity = board->GetConnectivity();
68  std::set<EDA_ITEM*> savedModules;
69  std::vector<BOARD_ITEM*> itemsToDeselect;
70 
71  if( Empty() )
72  return;
73 
74  for( COMMIT_LINE& ent : m_changes )
75  {
76  int changeType = ent.m_type & CHT_TYPE;
77  int changeFlags = ent.m_type & CHT_FLAGS;
78  BOARD_ITEM* boardItem = static_cast<BOARD_ITEM*>( ent.m_item );
79 
80  // Module items need to be saved in the undo buffer before modification
81  if( m_editModules )
82  {
83  // Be sure that we are storing a module
84  if( ent.m_item->Type() != PCB_MODULE_T )
85  ent.m_item = ent.m_item->GetParent();
86 
87  // We have not saved the module yet, so let's create an entry
88  if( savedModules.count( ent.m_item ) == 0 )
89  {
90  if( !ent.m_copy )
91  {
92  wxASSERT( changeType != CHT_MODIFY ); // too late to make a copy..
93  ent.m_copy = ent.m_item->Clone();
94  }
95 
96  wxASSERT( ent.m_item->Type() == PCB_MODULE_T );
97  wxASSERT( ent.m_copy->Type() == PCB_MODULE_T );
98 
99  if( aCreateUndoEntry )
100  {
101  ITEM_PICKER itemWrapper( ent.m_item, UR_CHANGED );
102  itemWrapper.SetLink( ent.m_copy );
103  undoList.PushItem( itemWrapper );
104  frame->SaveCopyInUndoList( undoList, UR_CHANGED );
105  }
106 
107  savedModules.insert( ent.m_item );
108  static_cast<MODULE*>( ent.m_item )->SetLastEditTime();
109  }
110  }
111 
112  switch( changeType )
113  {
114  case CHT_ADD:
115  {
116  if( !m_editModules )
117  {
118  if( aCreateUndoEntry )
119  {
120  undoList.PushItem( ITEM_PICKER( boardItem, UR_NEW ) );
121  }
122 
123  if( !( changeFlags & CHT_DONE ) )
124  board->Add( boardItem ); // handles connectivity
125 
126  }
127  else
128  {
129  // modules inside modules are not supported yet
130  wxASSERT( boardItem->Type() != PCB_MODULE_T );
131 
132  boardItem->SetParent( board->m_Modules.GetFirst() );
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  undoList.PushItem( ITEM_PICKER( boardItem, UR_DELETED ) );
146 
147  switch( boardItem->Type() )
148  {
149  // Module items
150  case PCB_PAD_T:
151  case PCB_MODULE_EDGE_T:
152  case PCB_MODULE_TEXT_T:
153  // This level can only handle module items when editing modules
154  if( !m_editModules )
155  break;
156 
157  if( boardItem->Type() == PCB_MODULE_TEXT_T )
158  {
159  TEXTE_MODULE* text = static_cast<TEXTE_MODULE*>( boardItem );
160 
161  // don't allow deletion of Reference or Value
162  if( text->GetType() != TEXTE_MODULE::TEXT_is_DIVERS )
163  break;
164  }
165 
166  view->Remove( boardItem );
167 
168  if( !( changeFlags & CHT_DONE ) )
169  {
170  MODULE* module = static_cast<MODULE*>( boardItem->GetParent() );
171  wxASSERT( module && module->Type() == PCB_MODULE_T );
172  module->Delete( boardItem );
173  }
174 
175  board->m_Status_Pcb = 0; // it is done in the legacy view (ratsnest perhaps?)
176 
177  break;
178 
179  // Board items
180  case PCB_LINE_T: // a segment not on copper layers
181  case PCB_TEXT_T: // a text on a layer
182  case PCB_TRACE_T: // a track segment (segment on a copper layer)
183  case PCB_VIA_T: // a via (like track segment on a copper layer)
184  case PCB_DIMENSION_T: // a dimension (graphic item)
185  case PCB_TARGET_T: // a target (graphic item)
186  case PCB_MARKER_T: // a marker used to show something
187  case PCB_ZONE_AREA_T:
188  itemsToDeselect.push_back( boardItem );
189 
190  view->Remove( boardItem );
191 
192  if( !( changeFlags & CHT_DONE ) )
193  board->Remove( boardItem );
194 
195  break;
196 
197  case PCB_MODULE_T:
198  {
199  itemsToDeselect.push_back( boardItem );
200 
201  // There are no modules inside a module yet
202  wxASSERT( !m_editModules );
203 
204  MODULE* module = static_cast<MODULE*>( boardItem );
205  view->Remove( module );
206  module->ClearFlags();
207 
208  if( !( changeFlags & CHT_DONE ) )
209  board->Remove( module ); // handles connectivity
210 
211  // Clear flags to indicate, that the ratsnest, list of nets & pads are not valid anymore
212  board->m_Status_Pcb = 0;
213  }
214  break;
215 
216  default: // other types do not need to (or should not) be handled
217  wxASSERT( false );
218  break;
219  }
220 
221  break;
222  }
223 
224  case CHT_MODIFY:
225  {
226  if( !m_editModules && aCreateUndoEntry )
227  {
228  ITEM_PICKER itemWrapper( boardItem, UR_CHANGED );
229  wxASSERT( ent.m_copy );
230  itemWrapper.SetLink( ent.m_copy );
231  undoList.PushItem( itemWrapper );
232  }
233 
234  if( ent.m_copy )
235  connectivity->MarkItemNetAsDirty( static_cast<BOARD_ITEM*>( ent.m_copy ) );
236 
237  connectivity->Update( boardItem );
238  view->Update( boardItem );
239 
240  // if no undo entry is needed, the copy would create a memory leak
241  if( !aCreateUndoEntry )
242  delete ent.m_copy;
243 
244  break;
245  }
246 
247  default:
248  wxASSERT( false );
249  break;
250  }
251  }
252 
253  // Removing an item should trigger the unselect action
254  // but only after all items are removed otherwise we can get
255  // flickering depending on the system
256  if( itemsToDeselect.size() > 0 )
257  m_toolMgr->RunAction( PCB_ACTIONS::unselectItems, true, &itemsToDeselect );
258 
259  if( !m_editModules && aCreateUndoEntry )
260  frame->SaveCopyInUndoList( undoList, UR_UNSPECIFIED );
261 
262  if( TOOL_MANAGER* toolMgr = frame->GetToolManager() )
263  toolMgr->PostEvent( { TC_MESSAGE, TA_MODEL_CHANGE, AS_GLOBAL } );
264 
265  if ( !m_editModules )
266  {
267  auto panel = static_cast<PCB_DRAW_PANEL_GAL*>( frame->GetGalCanvas() );
268  connectivity->RecalculateRatsnest();
269  connectivity->ClearDynamicRatsnest();
270  panel->RedrawRatsnest();
271  }
272 
273  if( aSetDirtyBit )
274  frame->OnModify();
275 
276  frame->UpdateMsgPanel();
277 
278  clear();
279 }
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:252
void clear()
Definition: commit.h:161
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:931
static TOOL_ACTION unselectItems
Definition: pcb_actions.h:61
Definition: commit.h:38
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:100
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
EDA_DRAW_FRAME * GetEditFrame() const
Definition: tool_manager.h:267
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
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:51
EDA_ITEM * GetModel() const
Definition: tool_manager.h:262
class EDGE_MODULE, a footprint edge
Definition: typeinfo.h:94
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 SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:219
TOOL_MANAGER * GetToolManager() const override
Return the tool manager instance, if any.
Definition: draw_frame.h:937
TEXT_TYPE GetType() const
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:292
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
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
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:1539
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:98
bool Empty() const
Definition: commit.h:139
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:99
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...
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:97
bool m_editModules
Definition: board_commit.h:52
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
DLIST< MODULE > m_Modules
Definition: class_board.h:248
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182
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:260
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:96
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
Class VIEW.
Definition: view.h:61
void UpdateMsgPanel() override
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
BOARD_ITEM_CONTAINER * GetParent() const
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.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204
int m_Status_Pcb
Flags used in ratsnest calculation and update.
Definition: class_board.h:240

References KIGFX::VIEW::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, PICKED_ITEMS_LIST::PushItem(), KIGFX::VIEW::Remove(), BOARD::Remove(), PCB_BASE_FRAME::SaveCopyInUndoList(), ITEM_PICKER::SetLink(), EDA_ITEM::SetParent(), TEXTE_MODULE::TEXT_is_DIVERS, EDA_ITEM::Type(), PCB_ACTIONS::unselectItems, 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(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), DRC::addMarkerToPcb(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), AUTOPLACE_TOOL::autoplace(), ZONE_CREATE_HELPER::commitZone(), MICROWAVE_TOOL::createInductorBetween(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PCB_TOOL_BASE::doInteractiveItemPlacement(), DRC::doTrackDrc(), 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_FOOTPRINTS::OnApplyClicked(), POINT_EDITOR::OnSelectionChange(), PAD_TOOL::pastePadProperties(), ZONE_CREATE_HELPER::performZoneCutout(), DRAWING_TOOL::PlaceImportedGraphics(), PCB_EDITOR_CONTROL::PlaceModule(), DRAWING_TOOL::PlaceText(), PAD_TOOL::pushPadSettings(), POINT_EDITOR::removeCorner(), PCB_EDIT_FRAME::RemoveMisConnectedTracks(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), DRAWING_TOOL::SetAnchor(), PCB_EDIT_FRAME::Swap_Layers(), DRC::TestZoneToZoneOutline(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataFromWindow(), DIALOG_TARGET_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_BOARD_EDITOR::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::UpdateNetlist(), PCB_EDITOR_CONTROL::ZoneDuplicate(), PCB_EDITOR_CONTROL::ZoneMerge(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

◆ Remove()

COMMIT& COMMIT::Remove ( EDA_ITEM aItem)
inlineinherited

Removes a new item from the model

Definition at line 90 of file commit.h.

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

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(), ZONE_CREATE_HELPER::performZoneCutout(), and POINT_EDITOR::removeCorner().

◆ Removed()

COMMIT& COMMIT::Removed ( EDA_ITEM aItem)
inlineinherited

Notifies observers that aItem has been removed

Definition at line 96 of file commit.h.

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

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

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

◆ Revert()

void BOARD_COMMIT::Revert ( )
overridevirtual

Revertes the commit by restoring the modifed items state.

Implements COMMIT.

Definition at line 298 of file board_commit.cpp.

299 {
300  PICKED_ITEMS_LIST undoList;
301  KIGFX::VIEW* view = m_toolMgr->GetView();
302  BOARD* board = (BOARD*) m_toolMgr->GetModel();
303  auto connectivity = board->GetConnectivity();
304 
305  for( auto it = m_changes.rbegin(); it != m_changes.rend(); ++it )
306  {
307  COMMIT_LINE& ent = *it;
308  BOARD_ITEM* item = static_cast<BOARD_ITEM*>( ent.m_item );
309  BOARD_ITEM* copy = static_cast<BOARD_ITEM*>( ent.m_copy );
310  int changeType = ent.m_type & CHT_TYPE;
311  int changeFlags = ent.m_type & CHT_FLAGS;
312 
313  switch( changeType )
314  {
315  case CHT_ADD:
316  if( !( changeFlags & CHT_DONE ) )
317  break;
318 
319  view->Remove( item );
320  connectivity->Remove( item );
321  board->Remove( item );
322  break;
323 
324  case CHT_REMOVE:
325  if( !( changeFlags & CHT_DONE ) )
326  break;
327 
328  view->Add( item );
329  connectivity->Add( item );
330  board->Add( item );
331  break;
332 
333  case CHT_MODIFY:
334  {
335  view->Remove( item );
336  connectivity->Remove( item );
337 
338  item->SwapData( copy );
339 
340  // Update all pads/drawings/texts, as they become invalid
341  // for the VIEW after SwapData() called for modules
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  }
347 
348  view->Add( item );
349  connectivity->Add( item );
350  delete copy;
351  break;
352  }
353 
354  default:
355  wxASSERT( false );
356  break;
357  }
358  }
359 
360  if ( !m_editModules )
361  connectivity->RecalculateRatsnest();
362 
364  selTool->RebuildSelection();
365 
366  clear();
367 }
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:252
void clear()
Definition: commit.h:161
void RunOnChildren(const 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,...
Class SELECTION_TOOL.
Definition: commit.h:38
virtual void Remove(VIEW_ITEM *aItem)
Function Remove() Removes a VIEW_ITEM from the view.
Definition: view.cpp:376
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
TOOL_MANAGER * m_toolMgr
Definition: board_commit.h:51
EDA_ITEM * GetModel() const
Definition: tool_manager.h:262
virtual void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
#define SELECTED
Definition: base_struct.h:121
class MODULE, a footprint
Definition: typeinfo.h:89
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_INSERT) override
Adds an item to the container.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:292
Class PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
bool m_editModules
Definition: board_commit.h:52
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
std::vector< COMMIT_LINE > m_changes
Definition: commit.h:182
void RebuildSelection()
Rebuilds the selection from the EDA_ITEMs' selection flags.
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:260
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Function Add() Adds a VIEW_ITEM to the view.
Definition: view.cpp:346
Class VIEW.
Definition: view.h:61
void Remove(BOARD_ITEM *aBoardItem) override
Removes an item from the container.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204

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

Referenced by AUTOPLACE_TOOL::autoplace(), MODULE_EDITOR_TOOLS::EnumeratePads(), POINT_EDITOR::OnSelectionChange(), PCB_EDITOR_CONTROL::PlaceModule(), and POINT_EDITOR::removeCorner().

◆ Stage() [1/3]

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.

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  EDA_ITEM* clone = nullptr;
68 
69  assert( parent );
70 
71  if( parent )
72  clone = parent->Clone();
73 
74  assert( clone );
75 
76  if( clone )
77  return createModified( parent, clone, flag );
78 
79  break;
80  }
81 
82  default:
83  assert( false );
84  }
85 
86  return *this;
87 }
Definition: commit.h:38
Flag to indicate the change is already applied, just notify observers (not compatible with CHT_MODIFY...
Definition: commit.h:45
virtual EDA_ITEM * Clone() const
Function Clone creates a duplicate of this item with linked list members set to NULL.
std::set< EDA_ITEM * > m_changedItems
Definition: commit.h:181
COMMIT & createModified(EDA_ITEM *aItem, EDA_ITEM *aCopy, int aExtraFlags=0)
Definition: commit.cpp:150
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:157
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:167

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

◆ Stage() [2/3]

COMMIT & COMMIT::Stage ( std::vector< EDA_ITEM * > &  container,
CHANGE_TYPE  aChangeType 
)
inherited

Definition at line 90 of file commit.cpp.

91 {
92  for( EDA_ITEM* item : container )
93  {
94  Stage( item, aChangeType );
95  }
96 
97  return *this;
98 }
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:157

References COMMIT::Stage().

◆ Stage() [3/3]

COMMIT & COMMIT::Stage ( const PICKED_ITEMS_LIST aItems,
UNDO_REDO_T  aModFlag = UR_UNSPECIFIED 
)
inherited

Definition at line 101 of file commit.cpp.

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

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

◆ StageItems()

template<class Range >
COMMIT& COMMIT::StageItems ( const Range &  aRange,
CHANGE_TYPE  aChangeType 
)
inlineinherited

Definition at line 116 of file commit.h.

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

References COMMIT::Stage().

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

Member Data Documentation

◆ m_changedItems

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

Definition at line 181 of file commit.h.

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

◆ m_changes

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

◆ m_editModules

bool BOARD_COMMIT::m_editModules
private

Definition at line 52 of file board_commit.h.

◆ m_toolMgr

TOOL_MANAGER* BOARD_COMMIT::m_toolMgr
private

Definition at line 51 of file board_commit.h.


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