KiCad PCB EDA Suite
tool_manager.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013-2017 CERN
5  * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
6  * @author Maciej Suminski <maciej.suminski@cern.ch>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #include <map>
27 #include <stack>
28 #include <algorithm>
29 
30 #include <core/optional.h>
31 
32 #include <wx/event.h>
33 #include <wx/clipbrd.h>
34 
35 #include <view/view.h>
36 
37 #include <tool/tool_base.h>
38 #include <tool/tool_interactive.h>
39 #include <tool/tool_manager.h>
40 #include <tool/context_menu.h>
41 #include <tool/coroutine.h>
42 #include <tool/action_manager.h>
43 
44 #include <wxPcbStruct.h>
45 #include <class_draw_panel_gal.h>
46 
49 {
50  TOOL_STATE( TOOL_BASE* aTool ) :
51  theTool( aTool )
52  {
53  clear();
54  }
55 
56  TOOL_STATE( const TOOL_STATE& aState )
57  {
58  theTool = aState.theTool;
59  idle = aState.idle;
60  pendingWait = aState.pendingWait;
62  contextMenu = aState.contextMenu;
64  cofunc = aState.cofunc;
65  wakeupEvent = aState.wakeupEvent;
66  waitEvents = aState.waitEvents;
67  transitions = aState.transitions;
68  vcSettings = aState.vcSettings;
69  // do not copy stateStack
70  }
71 
73  {
74  assert( stateStack.empty() );
75  }
76 
79 
81  bool idle;
82 
86 
89 
92 
95 
98 
101 
104 
107  std::vector<TRANSITION> transitions;
108 
111 
112  void operator=( const TOOL_STATE& aState )
113  {
114  theTool = aState.theTool;
115  idle = aState.idle;
116  pendingWait = aState.pendingWait;
117  pendingContextMenu = aState.pendingContextMenu;
118  contextMenu = aState.contextMenu;
119  contextMenuTrigger = aState.contextMenuTrigger;
120  cofunc = aState.cofunc;
121  wakeupEvent = aState.wakeupEvent;
122  waitEvents = aState.waitEvents;
123  transitions = aState.transitions;
124  vcSettings = aState.vcSettings;
125  // do not copy stateStack
126  }
127 
128  bool operator==( const TOOL_MANAGER::TOOL_STATE& aRhs ) const
129  {
130  return aRhs.theTool == this->theTool;
131  }
132 
133  bool operator!=( const TOOL_MANAGER::TOOL_STATE& aRhs ) const
134  {
135  return aRhs.theTool != this->theTool;
136  }
137 
143  void Push()
144  {
145  auto state = std::make_unique<TOOL_STATE>( *this );
146  stateStack.push( std::move( state ) );
147  clear();
148  }
149 
156  bool Pop()
157  {
158  delete cofunc;
159 
160  if( !stateStack.empty() )
161  {
162  *this = *stateStack.top().get();
163  stateStack.pop();
164  return true;
165  }
166  else
167  {
168  cofunc = NULL;
169  return false;
170  }
171  }
172 
173 private:
175  std::stack<std::unique_ptr<TOOL_STATE>> stateStack;
176 
178  void clear()
179  {
180  idle = true;
181  pendingWait = false;
182  pendingContextMenu = false;
183  cofunc = NULL;
184  contextMenu = NULL;
185  contextMenuTrigger = CMENU_OFF;
186  vcSettings.Reset();
187  transitions.clear();
188  }
189 };
190 
191 
193  m_model( NULL ),
194  m_view( NULL ),
195  m_viewControls( NULL ),
196  m_editFrame( NULL ),
197  m_passEvent( false ),
198  m_menuActive( false )
199 {
200  m_actionMgr = new ACTION_MANAGER( this );
201 }
202 
203 
205 {
206  std::map<TOOL_BASE*, TOOL_STATE*>::iterator it, it_end;
207 
208  for( it = m_toolState.begin(), it_end = m_toolState.end(); it != it_end; ++it )
209  {
210  delete it->second->cofunc; // delete cofunction
211  delete it->second; // delete TOOL_STATE
212  delete it->first; // delete the tool itself
213  }
214 
215  delete m_actionMgr;
216 }
217 
218 
220 {
221  wxASSERT_MSG( m_toolNameIndex.find( aTool->GetName() ) == m_toolNameIndex.end(),
222  wxT( "Adding two tools with the same name may result in unexpected behaviour.") );
223  wxASSERT_MSG( m_toolIdIndex.find( aTool->GetId() ) == m_toolIdIndex.end(),
224  wxT( "Adding two tools with the same ID may result in unexpected behaviour.") );
225  wxASSERT_MSG( m_toolTypes.find( typeid( *aTool ).name() ) == m_toolTypes.end(),
226  wxT( "Adding two tools of the same type may result in unexpected behaviour.") );
227 
228  TOOL_STATE* st = new TOOL_STATE( aTool );
229 
230  m_toolState[aTool] = st;
231  m_toolNameIndex[aTool->GetName()] = st;
232  m_toolIdIndex[aTool->GetId()] = st;
233  m_toolTypes[typeid( *aTool ).name()] = st->theTool;
234 
235  aTool->attachManager( this );
236 }
237 
238 
240 {
241  TOOL_BASE* tool = FindTool( aToolId );
242 
243  if( tool && tool->GetType() == INTERACTIVE )
244  return invokeTool( tool );
245 
246  return false; // there is no tool with the given id
247 }
248 
249 
250 bool TOOL_MANAGER::InvokeTool( const std::string& aToolName )
251 {
252  TOOL_BASE* tool = FindTool( aToolName );
253 
254  if( tool && tool->GetType() == INTERACTIVE )
255  return invokeTool( tool );
256 
257  return false; // there is no tool with the given name
258 }
259 
260 
262 {
263  m_actionMgr->RegisterAction( aAction );
264 }
265 
266 
268 {
269  m_actionMgr->UnregisterAction( aAction );
270 }
271 
272 
273 bool TOOL_MANAGER::RunAction( const std::string& aActionName, bool aNow, void* aParam )
274 {
275  TOOL_ACTION* action = m_actionMgr->FindAction( aActionName );
276 
277  if( !action )
278  {
279  wxASSERT_MSG( false, wxString::Format( wxT( "Could not find action %s." ), aActionName ) );
280  return false;
281  }
282 
283  RunAction( *action, aNow, aParam );
284 
285  return false;
286 }
287 
288 
289 void TOOL_MANAGER::RunAction( const TOOL_ACTION& aAction, bool aNow, void* aParam )
290 {
291  TOOL_EVENT event = aAction.MakeEvent();
292 
293  // Allow to override the action parameter
294  if( aParam )
295  event.SetParameter( aParam );
296 
297  if( aNow )
298  processEvent( event );
299  else
300  PostEvent( event );
301 }
302 
303 
305 {
306  return m_actionMgr->GetHotKey( aAction );
307 }
308 
309 
311 {
313 }
314 
315 
317 {
318  wxASSERT( aTool != NULL );
319 
320  TOOL_EVENT evt( TC_COMMAND, TA_ACTIVATE, aTool->GetName() );
321  processEvent( evt );
322 
323  return true;
324 }
325 
326 
328 {
329  TOOL_BASE* tool = FindTool( aToolId );
330 
331  if( tool && tool->GetType() == INTERACTIVE )
332  return runTool( tool );
333 
334  return false; // there is no tool with the given id
335 }
336 
337 
338 bool TOOL_MANAGER::runTool( const std::string& aToolName )
339 {
340  TOOL_BASE* tool = FindTool( aToolName );
341 
342  if( tool && tool->GetType() == INTERACTIVE )
343  return runTool( tool );
344 
345  return false; // there is no tool with the given name
346 }
347 
348 
350 {
351  wxASSERT( aTool != NULL );
352 
353  if( !isRegistered( aTool ) )
354  {
355  wxASSERT_MSG( false, wxT( "You cannot run unregistered tools" ) );
356  return false;
357  }
358 
359  TOOL_ID id = aTool->GetId();
360 
361  // If the tool is already active, bring it to the top of the active tools stack
362  if( isActive( aTool ) )
363  {
364  m_activeTools.erase( std::find( m_activeTools.begin(), m_activeTools.end(), id ) );
365  m_activeTools.push_front( id );
366  return false;
367  }
368 
369  aTool->Reset( TOOL_INTERACTIVE::RUN );
370 
371  if( aTool->GetType() == INTERACTIVE )
372  static_cast<TOOL_INTERACTIVE*>( aTool )->resetTransitions();
373 
374  // Add the tool on the front of the processing queue (it gets events first)
375  m_activeTools.push_front( id );
376 
377  return true;
378 }
379 
380 
382 {
383  std::map<TOOL_ID, TOOL_STATE*>::const_iterator it = m_toolIdIndex.find( aId );
384 
385  if( it != m_toolIdIndex.end() )
386  return it->second->theTool;
387 
388  return NULL;
389 }
390 
391 
392 TOOL_BASE* TOOL_MANAGER::FindTool( const std::string& aName ) const
393 {
394  std::map<std::string, TOOL_STATE*>::const_iterator it = m_toolNameIndex.find( aName );
395 
396  if( it != m_toolNameIndex.end() )
397  return it->second->theTool;
398 
399  return NULL;
400 }
401 
402 
404 {
405  // Deactivate the active tool, but do not run anything new
407  processEvent( evt );
408 }
409 
410 
412 {
413  DeactivateTool();
414 
415  for( auto& state : m_toolState )
416  {
417  TOOL_BASE* tool = state.first;
418  tool->Reset( aReason );
419 
420  if( tool->GetType() == INTERACTIVE )
421  static_cast<TOOL_INTERACTIVE*>( tool )->resetTransitions();
422  }
423 }
424 
425 
427 {
428  for( auto it = m_toolState.begin(); it != m_toolState.end(); /* iteration in the loop */ )
429  {
430  TOOL_BASE* tool = it->first;
431  TOOL_STATE* state = it->second;
432  ++it; // keep the iterator valid if the element is going to be erased
433 
434  if( !tool->Init() )
435  {
436  wxMessageBox(
437  wxString::Format( "Initialization of tool '%s' failed", tool->GetName() ) );
438 
439  // Unregister the tool
440  m_toolState.erase( tool );
441  m_toolNameIndex.erase( tool->GetName() );
442  m_toolIdIndex.erase( tool->GetId() );
443  m_toolTypes.erase( typeid( *tool ).name() );
444 
445  delete state;
446  delete tool;
447  }
448  }
449 
451 }
452 
453 
454 int TOOL_MANAGER::GetPriority( int aToolId ) const
455 {
456  int priority = 0;
457 
458  for( auto it = m_activeTools.begin(), itEnd = m_activeTools.end(); it != itEnd; ++it )
459  {
460  if( *it == aToolId )
461  return priority;
462 
463  ++priority;
464  }
465 
466  return -1;
467 }
468 
469 
471  const TOOL_EVENT_LIST& aConditions )
472 {
473  TOOL_STATE* st = m_toolState[aTool];
474 
475  st->transitions.push_back( TRANSITION( aConditions, aHandler ) );
476 }
477 
478 
480 {
481  m_toolState[aTool]->transitions.clear();
482 }
483 
484 
485 void TOOL_MANAGER::RunMainStack( TOOL_BASE* aTool, std::function<void()> aFunc )
486 {
487  TOOL_STATE* st = m_toolState[aTool];
488  st->cofunc->RunMainStack( std::move( aFunc ) );
489 }
490 
491 
493  const TOOL_EVENT_LIST& aConditions )
494 {
495  TOOL_STATE* st = m_toolState[aTool];
496 
497  assert( !st->pendingWait ); // everything collapses on two KiYield() in a row
498 
499  // indicate to the manager that we are going to sleep and we shall be
500  // woken up when an event matching aConditions arrive
501  st->pendingWait = true;
502  st->waitEvents = aConditions;
503 
504  // switch context back to event dispatcher loop
505  st->cofunc->KiYield();
506 
507  return st->wakeupEvent;
508 }
509 
510 
512 {
513  // iterate over all registered tools
514  for( auto it = m_activeTools.begin(); it != m_activeTools.end(); ++it )
515  {
516  TOOL_STATE* st = m_toolIdIndex[*it];
517 
518  // the tool state handler is waiting for events (i.e. called Wait() method)
519  if( st->pendingWait )
520  {
521  if( st->waitEvents.Matches( aEvent ) )
522  {
523  // By default, only messages are passed further
524  m_passEvent = ( aEvent.Category() == TC_MESSAGE );
525 
526  // got matching event? clear wait list and wake up the coroutine
527  st->wakeupEvent = aEvent;
528  st->pendingWait = false;
529  st->waitEvents.clear();
530 
531  if( st->cofunc )
532  {
533  applyViewControls( st );
534  bool end = !st->cofunc->Resume();
535  saveViewControls( st );
536 
537  if( end )
538  it = finishTool( st );
539  }
540 
541  // If the tool did not request to propagate
542  // the event to other tools, we should stop it now
543  if( !m_passEvent )
544  break;
545  }
546  }
547  }
548 
549  for( auto& state : m_toolState )
550  {
551  TOOL_STATE* st = state.second;
552  bool finished = false;
553 
554  // no state handler in progress - check if there are any transitions (defined by
555  // Go() method that match the event.
556  if( !st->transitions.empty() )
557  {
558  for( TRANSITION& tr : st->transitions )
559  {
560  if( tr.first.Matches( aEvent ) )
561  {
562  auto func_copy = tr.second;
563 
564  // if there is already a context, then store it
565  if( st->cofunc )
566  st->Push();
567 
568  st->cofunc = new COROUTINE<int, const TOOL_EVENT&>( std::move( func_copy ) );
569 
570  // as the state changes, the transition table has to be set up again
571  st->transitions.clear();
572 
573  // got match? Run the handler.
574  applyViewControls( st );
575  st->idle = false;
576  st->cofunc->Call( aEvent );
577  saveViewControls( st );
578 
579  if( !st->cofunc->Running() )
580  finishTool( st ); // The couroutine has finished immediately?
581 
582  // if it is a message, continue processing
583  finished = !( aEvent.Category() == TC_MESSAGE );
584 
585  // there is no point in further checking, as transitions got cleared
586  break;
587  }
588  }
589  }
590 
591  if( finished )
592  break; // only the first tool gets the event
593  }
594 }
595 
596 
598 {
599  if( aEvent.Action() == TA_KEY_PRESSED )
600  {
601  // Check if there is a hotkey associated
602  if( m_actionMgr->RunHotKey( aEvent.Modifier() | aEvent.KeyCode() ) )
603  return false; // hotkey event was handled so it does not go any further
604  }
605 
606  return true;
607 }
608 
609 
611 {
612  if( aEvent.IsActivate() )
613  {
614  std::map<std::string, TOOL_STATE*>::iterator tool = m_toolNameIndex.find( *aEvent.GetCommandStr() );
615 
616  if( tool != m_toolNameIndex.end() )
617  {
618  runTool( tool->second->theTool );
619  return true;
620  }
621  }
622 
623  return false;
624 }
625 
627 {
628  // Store the current tool ID to decide whether to restore the cursor position
629  TOOL_ID activeTool = GetCurrentToolId();
630 
631  for( TOOL_ID toolId : m_activeTools )
632  {
633  TOOL_STATE* st = m_toolIdIndex[toolId];
634 
635  // the tool requested a context menu. The menu is activated on RMB click (CMENU_BUTTON mode)
636  // or immediately (CMENU_NOW) mode. The latter is used for clarification lists.
637  if( st->contextMenuTrigger == CMENU_OFF )
638  continue;
639 
640  if( st->contextMenuTrigger == CMENU_BUTTON && !aEvent.IsClick( BUT_RIGHT ) )
641  break;
642 
643  st->pendingWait = true;
645 
646  // Store the menu pointer in case it is changed by the TOOL when handling menu events
647  CONTEXT_MENU* m = st->contextMenu;
648 
649  if( st->contextMenuTrigger == CMENU_NOW )
651 
653 
654  // Temporarily store the cursor position, so the tools could execute actions
655  // using the point where the user has invoked a context menu
657  m_origCursor = cursor;
658 
659  m_viewControls->ForceCursorPosition( true, cursor );
660 
661  // Display a copy of menu
662  std::unique_ptr<CONTEXT_MENU> menu( m->Clone() );
663 
664  // Run update handlers on the created copy
665  menu->UpdateAll();
666  m_menuActive = true;
667 
668  auto frame = dynamic_cast<wxFrame*>( m_editFrame );
669 
670  if( frame )
671  {
672  frame->PopupMenu( menu.get() );
673  }
674 
675  m_menuActive = false;
676 
677  m_viewControls->WarpCursor( cursor, true, false );
678 
679  // If nothing was chosen from the context menu, we must notify the tool as well
680  if( menu->GetSelected() < 0 )
681  {
683  evt.SetParameter( m );
684  dispatchInternal( evt );
685  }
686 
687  // Notify the tools that menu has been closed
689  evt.SetParameter( m );
690  dispatchInternal( evt );
691 
692  // Restore the cursor settings if the tool is still active
693  if( activeTool == GetCurrentToolId() )
694  {
696  m_origCursor ? *m_origCursor : VECTOR2D( 0, 0 ) );
697  }
698 
700  break;
701  }
702 }
703 
704 
705 TOOL_MANAGER::ID_LIST::iterator TOOL_MANAGER::finishTool( TOOL_STATE* aState )
706 {
707  auto it = std::find( m_activeTools.begin(), m_activeTools.end(), aState->theTool->GetId() );
708 
709  if( !aState->Pop() )
710  {
711  // Deactivate the tool if there are no other contexts saved on the stack
712  if( it != m_activeTools.end() )
713  it = m_activeTools.erase( it );
714  }
715 
716  // Set transitions to be ready for future TOOL_EVENTs
717  TOOL_BASE* tool = aState->theTool;
718 
719  if( tool->GetType() == INTERACTIVE )
720  static_cast<TOOL_INTERACTIVE*>( tool )->resetTransitions();
721 
722  aState->idle = true;
723 
724  return it;
725 }
726 
727 
729 {
730  if( TOOL_STATE* active = GetCurrentToolState() )
731  saveViewControls( active );
732 
733  bool hotkey_handled = processEvent( aEvent );
734 
735  if( TOOL_STATE* active = GetCurrentToolState() )
736  applyViewControls( active );
737 
738  if( m_view->IsDirty() )
739  {
740  auto f = dynamic_cast<EDA_DRAW_FRAME*>( GetEditFrame() );
741 
742  if( f )
743  f->GetGalCanvas()->Refresh(); // fixme: ugly hack, provide a method in TOOL_DISPATCHER.
744  }
745 
746  return hotkey_handled;
747 }
748 
749 
751  CONTEXT_MENU_TRIGGER aTrigger )
752 {
753  TOOL_STATE* st = m_toolState[aTool];
754 
755  st->contextMenu = aMenu;
756  st->contextMenuTrigger = aTrigger;
757 }
758 
759 
760 bool TOOL_MANAGER::SaveClipboard( const std::string& aText )
761 {
762  if( wxTheClipboard->Open() )
763  {
764  wxTheClipboard->SetData( new wxTextDataObject( wxString( aText.c_str(), wxConvUTF8 ) ) );
765  wxTheClipboard->Close();
766 
767  return true;
768  }
769 
770  return false;
771 }
772 
773 
774 std::string TOOL_MANAGER::GetClipboard() const
775 {
776  std::string result;
777 
778  if( wxTheClipboard->Open() )
779  {
780  if( wxTheClipboard->IsSupported( wxDF_TEXT ) )
781  {
782  wxTextDataObject data;
783  wxTheClipboard->GetData( data );
784 
785  result = data.GetText().mb_str();
786  }
787 
788  wxTheClipboard->Close();
789  }
790 
791  return result;
792 }
793 
794 
795 TOOL_ID TOOL_MANAGER::MakeToolId( const std::string& aToolName )
796 {
797  static int currentId;
798 
799  return currentId++;
800 }
801 
802 
804  KIGFX::VIEW_CONTROLS* aViewControls, wxWindow* aFrame )
805 {
806  m_model = aModel;
807  m_view = aView;
808  m_viewControls = aViewControls;
809  m_editFrame = aFrame;
811 }
812 
813 
815 {
816  if( !isRegistered( aTool ) )
817  return false;
818 
819  // Just check if the tool is on the active tools stack
820  return std::find( m_activeTools.begin(), m_activeTools.end(), aTool->GetId() ) != m_activeTools.end();
821 }
822 
823 
825 {
827 
828  // If context menu has overridden the cursor position, restore the original position
829  // (see dispatchContextMenu())
830  if( m_menuActive )
831  {
832  if( m_origCursor )
833  {
834  aState->vcSettings.m_forceCursorPosition = true;
836  }
837  else
838  {
839  aState->vcSettings.m_forceCursorPosition = false;
840  }
841  }
842 }
843 
844 
846 {
848 }
849 
850 
852 {
853  // Early dispatch of events destined for the TOOL_MANAGER
854  if( !dispatchStandardEvents( aEvent ) )
855  return true;
856 
857  dispatchInternal( aEvent );
858  dispatchActivation( aEvent );
859  dispatchContextMenu( aEvent );
860 
861  // Dispatch queue
862  while( !m_eventQueue.empty() )
863  {
864  TOOL_EVENT event = m_eventQueue.front();
865  m_eventQueue.pop_front();
866  processEvent( event );
867  }
868 
869  return false;
870 }
871 
873 {
874  auto it = m_toolIdIndex.find( aId );
875  return !it->second->idle;
876 }
void RunMainStack(std::function< void()> func)
Function RunMainStack()
Definition: coroutine.h:190
bool m_menuActive
Flag indicating whether a context menu is currently displayed.
Definition: tool_manager.h:519
bool operator==(const TOOL_MANAGER::TOOL_STATE &aRhs) const
bool IsToolActive(TOOL_ID aId) const
Function IsToolActive() Returns true if a tool with given id is active (executing) ...
virtual bool Init()
Function Init() Init() is called once upon a registration of the tool.
Definition: tool_base.h:93
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
void Reset()
Restores the default settings
TOOL_STATE(TOOL_BASE *aTool)
int GetHotKey(const TOOL_ACTION &aAction)
>
TOOL_BASE * theTool
The tool itself.
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
int GetCurrentToolId() const
Returns id of the tool that is on the top of the active tools stack (was invoked the most recently)...
Definition: tool_manager.h:277
bool processEvent(const TOOL_EVENT &aEvent)
Main function for event processing.
static TOOL_ID MakeToolId(const std::string &aToolName)
Generates a unique ID from for a tool with given name.
std::vector< TRANSITION > transitions
List of possible transitions (ie.
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
void ScheduleNextState(TOOL_BASE *aTool, TOOL_STATE_FUNC &aHandler, const TOOL_EVENT_LIST &aConditions)
Defines a state transition - the events that cause a given handler method in the tool to be called...
void RegisterAction(TOOL_ACTION *aAction)
Function RegisterAction() Registers an action that can be used to control tools (eg.
bool dispatchStandardEvents(const TOOL_EVENT &aEvent)
Function dispatchStandardEvents() Handles specific events, that are intended for TOOL_MANAGER rather ...
OPT< VECTOR2D > m_origCursor
Original cursor position, if overridden by the context menu handler.
Definition: tool_manager.h:505
bool SaveClipboard(const std::string &aText)
Stores an information to the system clipboard.
bool Call(ArgType aArg)
Function Call()
Definition: coroutine.h:204
void UpdateHotKeys()
Function UpdateHotKeys() Updates TOOL_ACTIONs hot key assignment according to the current frame's Hot...
Class CONTEXT_MENU.
Definition: context_menu.h:44
void ApplySettings(const VC_SETTINGS &aSettings)
Applies VIEW_CONTROLS settings from an object
KIGFX::VC_SETTINGS vcSettings
VIEW_CONTROLS settings to preserve settings when the tools are switched.
wxWindow * GetEditFrame() const
Definition: tool_manager.h:267
Tool is invoked after being inactive.
Definition: tool_base.h:82
ID_LIST::iterator finishTool(TOOL_STATE *aState)
Function finishTool() Deactivates a tool and does the necessary clean up.
bool dispatchActivation(const TOOL_EVENT &aEvent)
Function dispatchActivation() Checks if it is a valid activation event and invokes a proper tool...
VECTOR2D m_forcedPosition
Forced cursor position (world coordinates)
Definition: view_controls.h:58
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
void attachManager(TOOL_MANAGER *aManager)
Function attachManager()
Definition: tool_base.cpp:59
Class ACTION_MANAGER.
void ScheduleContextMenu(TOOL_BASE *aTool, CONTEXT_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger)
Sets behaviour of the tool's context popup menu.
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:311
TOOL_ACTION * FindAction(const std::string &aActionName) const
Function FindAction() Finds an action with a given name (if there is one available).
void applyViewControls(TOOL_STATE *aState)
Function applyViewControls() Applies VIEW_CONTROLS settings stored in a TOOL_STATE object...
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:54
int KeyCode() const
Definition: tool_event.h:316
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:539
void Push()
Function Push() Stores the current state of the tool on stack.
void dispatchContextMenu(const TOOL_EVENT &aEvent)
Function dispatchContextMenu() Handles context menu related events.
OPT< TOOL_EVENT > ScheduleWait(TOOL_BASE *aTool, const TOOL_EVENT_LIST &aConditions)
Pauses execution of a given tool until one or more events matching aConditions arrives.
bool runTool(TOOL_ID aToolId)
Function runTool() Makes a tool active, so it can receive events and react to them.
void DeactivateTool()
Function DeactivateTool() Deactivates the currently active tool.
bool InvokeTool(TOOL_ID aToolId)
Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID...
bool m_passEvent
Flag saying if the currently processed event should be passed to other tools.
Definition: tool_manager.h:516
EDA_ITEM * m_model
Definition: tool_manager.h:507
bool pendingWait
Flag defining if the tool is waiting for any event (i.e.
void SetParameter(T aParam)
Function SetParameter() Sets a non-standard parameter assigned to the event.
Definition: tool_event.h:385
virtual void Reset(RESET_REASON aReason)=0
Function Reset() Brings the tool to a known, initial state.
bool pendingContextMenu
Is there a context menu being displayed.
NAME_STATE_MAP m_toolNameIndex
Index of the registered tools current states, associated by tools' names.
Definition: tool_manager.h:490
int TOOL_ID
Unique identifier for tools.
Definition: tool_base.h:57
virtual void WarpCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false) const =0
Function WarpCursor() If enabled (.
Class TOOL_EVENT_LIST.
Definition: tool_event.h:468
bool operator!=(const TOOL_MANAGER::TOOL_STATE &aRhs) const
Tool that interacts with the user
Definition: tool_base.h:50
CONTEXT_MENU * Clone() const
Creates a deep, recursive copy of this CONTEXT_MENU.
const auto NULLOPT
Definition: optional.h:9
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
VECTOR2< double > VECTOR2D
Definition: vector2d.h:588
wxWindow * m_editFrame
Definition: tool_manager.h:510
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, wxWindow *aFrame)
Sets the work environment (model, view, view controls and the parent window).
bool ProcessEvent(const TOOL_EVENT &aEvent)
Propagates an event to tools that requested events of matching type(s).
CONTEXT_MENU_TRIGGER
Defines when a context menu is opened.
Definition: tool_event.h:150
VECTOR2D GetCursorPosition() const
Returns the current cursor position in world coordinates.
void dispatchInternal(const TOOL_EVENT &aEvent)
Function dispatchInternal Passes an event at first to the active tools, then to all others...
Class TOOL_EVENT.
Definition: tool_event.h:162
bool idle
Is the tool active (pending execution) or disabled at the moment.
bool IsActivate() const
Definition: tool_event.h:300
std::stack< std::unique_ptr< TOOL_STATE > > stateStack
Stack preserving previous states of a TOOL.
CONTEXT_MENU * contextMenu
Context menu currently used by the tool.
int GetHotKey(const TOOL_ACTION &aAction) const
Function GetHotKey() Returns the hot key associated with a given action or 0 if there is none...
bool RunHotKey(int aHotKey) const
Function RunHotKey() Runs an action associated with a hotkey (if there is one available).
Structure to keep VIEW_CONTROLS settings for easy store/restore operations
Definition: view_controls.h:44
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Function ResetTools() Resets all tools (i.e.
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:395
Class VIEW_CONTROLS is an interface for classes handling user events controlling the view behaviour (...
int GetPriority(int aToolId) const
Returns priority of a given tool.
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
TOOL_ID GetId() const
Function GetId() Returns the unique identifier of the tool.
Definition: tool_base.h:122
Struct describing the current execution state of a TOOL.
KIGFX::VIEW_CONTROLS * m_viewControls
Definition: tool_manager.h:509
bool Resume()
Function Resume()
Definition: coroutine.h:238
TOOL_STATE * GetCurrentToolState() const
Returns the TOOL_STATE object representing the state of the active tool.
Definition: tool_manager.h:296
void UnregisterAction(TOOL_ACTION *aAction)
Function UnregisterAction() Removes a tool action from the manager and makes it unavailable for furth...
std::function< int(const TOOL_EVENT &)> TOOL_STATE_FUNC
Definition: tool_base.h:59
TOOL_ACTIONS Action() const
Returns more specific information about the type of an event.
Definition: tool_event.h:234
bool isActive(TOOL_BASE *aTool)
Function isActive() Returns information about a tool activation status.
KIGFX::VIEW * m_view
Definition: tool_manager.h:508
std::string GetClipboard() const
Returns the information currently stored in the system clipboard.
void RunMainStack(TOOL_BASE *aTool, std::function< void()> aFunc)
OPT< const TOOL_EVENT & > Matches(const TOOL_EVENT &aEvent) const
Definition: tool_event.h:493
void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
TOOL_EVENT_CATEGORY Category() const
Returns the category (eg. mouse/keyboard/action) of an event..
Definition: tool_event.h:228
const VC_SETTINGS & GetSettings() const
Returns the current VIEW_CONTROLS settings
TOOL_EVENT wakeupEvent
The event that triggered the execution/wakeup of the tool after Wait() call.
void RegisterAction(TOOL_ACTION *aAction)
Function RegisterAction() Adds a tool action to the manager and sets it up.
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
TOOL_EVENT MakeEvent() const
Function HasHotKey() Checks if the action has a hot key assigned.
Definition: tool_action.h:104
std::list< TOOL_EVENT > m_eventQueue
Queue that stores events to be processed at the end of the event processing cycle.
Definition: tool_manager.h:513
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void operator=(const TOOL_STATE &aState)
bool Pop()
Function Pop() Restores state of the tool from stack.
COROUTINE< int, const TOOL_EVENT & > * cofunc
Tool execution context.
Class TOOL_BASE.
Definition: tool_base.h:68
Class TOOL_ACTION.
Definition: tool_action.h:46
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
bool isRegistered(TOOL_BASE *aTool) const
Function isRegistered() Returns information about a tool registration status.
Definition: tool_manager.h:455
bool ForcedCursorPosition() const
Function ForcedCursorPosition() Returns true if the current cursor position is forced to a specific l...
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:80
boost::optional< T > OPT
Definition: optional.h:7
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:870
CONTEXT_MENU_TRIGGER contextMenuTrigger
Defines when the context menu is opened.
void InitTools()
Function InitTools() Initializes all registered tools.
Class VIEW.
Definition: view.h:58
void ClearTransitions(TOOL_BASE *aTool)
Clears the state transition map for a tool.
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
TOOL_EVENT_LIST waitEvents
List of events the tool is currently waiting for.
const std::string & GetName() const
Function GetName() Returns the name of the tool.
Definition: tool_base.h:133
bool Running() const
Function Running()
Definition: coroutine.h:279
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:268
void clear()
Restores the initial state.
void PostEvent(const TOOL_EVENT &aEvent)
Puts an event to the event queue to be processed at the end of event processing cycle.
Definition: tool_manager.h:238
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
TOOL_STATE(const TOOL_STATE &aState)
void saveViewControls(TOOL_STATE *aState)
Function saveViewControls() Saves the VIEW_CONTROLS settings to the tool state object.
void UpdateHotKeys()
>
bool invokeTool(TOOL_BASE *aTool)
Function invokeTool() Invokes a tool by sending a proper event (in contrary to runTool, which makes the tool run for real).
void RegisterTool(TOOL_BASE *aTool)
Function RegisterTool() Adds a tool to the manager set and sets it up.
void UnregisterAction(TOOL_ACTION *aAction)
Function UnregisterAction() Unregisters an action, so it is no longer active.
void KiYield()
Function KiYield()
Definition: coroutine.h:155
std::pair< TOOL_EVENT_LIST, TOOL_STATE_FUNC > TRANSITION
Definition: tool_manager.h:370
std::map< const char *, TOOL_BASE * > m_toolTypes
Index of the registered tools to easily lookup by their type.
Definition: tool_manager.h:496