KiCad PCB EDA Suite
TOOL_MANAGER Class Reference

Class TOOL_MANAGER. More...

#include <tool_manager.h>

Classes

struct  TOOL_STATE
 Struct describing the current execution state of a TOOL. More...
 

Public Types

typedef std::map< TOOL_BASE *, TOOL_STATE * > TOOL_STATE_MAP
 
typedef std::map< std::string, TOOL_STATE * > NAME_STATE_MAP
 
typedef std::map< TOOL_ID, TOOL_STATE * > ID_STATE_MAP
 
typedef std::list< TOOL_IDID_LIST
 

Public Member Functions

 TOOL_MANAGER ()
 
 ~TOOL_MANAGER ()
 
void RegisterTool (TOOL_BASE *aTool)
 Function RegisterTool() Adds a tool to the manager set and sets it up. More...
 
bool InvokeTool (TOOL_ID aToolId)
 Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID. More...
 
bool InvokeTool (const std::string &aToolName)
 Function InvokeTool() Calls a tool by sending a tool activation event to tool of given name. More...
 
void RegisterAction (TOOL_ACTION *aAction)
 Function RegisterAction() Registers an action that can be used to control tools (eg. More...
 
void UnregisterAction (TOOL_ACTION *aAction)
 Function UnregisterAction() Unregisters an action, so it is no longer active. More...
 
template<typename T >
bool RunAction (const std::string &aActionName, bool aNow=false, T aParam=NULL)
 Function RunAction() Runs the specified action. More...
 
bool RunAction (const std::string &aActionName, bool aNow, void *aParam)
 
bool RunAction (const std::string &aActionName, bool aNow=false)
 
template<typename T >
void RunAction (const TOOL_ACTION &aAction, bool aNow=false, T aParam=NULL)
 Function RunAction() Runs the specified action. More...
 
void RunAction (const TOOL_ACTION &aAction, bool aNow, void *aParam)
 
void RunAction (const TOOL_ACTION &aAction, bool aNow=false)
 
int GetHotKey (const TOOL_ACTION &aAction)
 > More...
 
void UpdateHotKeys ()
 > More...
 
TOOL_BASEFindTool (int aId) const
 Function FindTool() Searches for a tool with given ID. More...
 
TOOL_BASEFindTool (const std::string &aName) const
 Function FindTool() Searches for a tool with given name. More...
 
template<typename T >
T * GetTool ()
 
void DeactivateTool ()
 Function DeactivateTool() Deactivates the currently active tool. More...
 
bool IsToolActive (TOOL_ID aId) const
 Function IsToolActive() Returns true if a tool with given id is active (executing) More...
 
void ResetTools (TOOL_BASE::RESET_REASON aReason)
 Function ResetTools() Resets all tools (i.e. More...
 
void InitTools ()
 Function InitTools() Initializes all registered tools. More...
 
bool ProcessEvent (const TOOL_EVENT &aEvent)
 Propagates an event to tools that requested events of matching type(s). More...
 
void PostEvent (const TOOL_EVENT &aEvent)
 Puts an event to the event queue to be processed at the end of event processing cycle. More...
 
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). More...
 
KIGFX::VIEWGetView () const
 
KIGFX::VIEW_CONTROLSGetViewControls () const
 
EDA_ITEMGetModel () const
 
wxWindow * GetEditFrame () const
 
int GetCurrentToolId () const
 Returns id of the tool that is on the top of the active tools stack (was invoked the most recently). More...
 
TOOL_BASEGetCurrentTool () const
 Returns the tool that is on the top of the active tools stack (was invoked the most recently). More...
 
TOOL_STATEGetCurrentToolState () const
 Returns the TOOL_STATE object representing the state of the active tool. More...
 
int GetPriority (int aToolId) const
 Returns priority of a given tool. More...
 
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. More...
 
void ClearTransitions (TOOL_BASE *aTool)
 Clears the state transition map for a tool. More...
 
void RunMainStack (TOOL_BASE *aTool, std::function< void()> aFunc)
 
OPT< TOOL_EVENTScheduleWait (TOOL_BASE *aTool, const TOOL_EVENT_LIST &aConditions)
 Pauses execution of a given tool until one or more events matching aConditions arrives. More...
 
void ScheduleContextMenu (TOOL_BASE *aTool, CONTEXT_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger)
 Sets behaviour of the tool's context popup menu. More...
 
void PassEvent ()
 Allows a tool to pass the already handled event to the next tool on the stack. More...
 
bool SaveClipboard (const std::string &aText)
 Stores an information to the system clipboard. More...
 
std::string GetClipboard () const
 Returns the information currently stored in the system clipboard. More...
 

Static Public Member Functions

static TOOL_ID MakeToolId (const std::string &aToolName)
 Generates a unique ID from for a tool with given name. More...
 

Private Types

typedef std::pair< TOOL_EVENT_LIST, TOOL_STATE_FUNCTRANSITION
 

Private Member Functions

void dispatchInternal (const TOOL_EVENT &aEvent)
 Function dispatchInternal Passes an event at first to the active tools, then to all others. More...
 
bool dispatchStandardEvents (const TOOL_EVENT &aEvent)
 Function dispatchStandardEvents() Handles specific events, that are intended for TOOL_MANAGER rather than tools. More...
 
bool dispatchActivation (const TOOL_EVENT &aEvent)
 Function dispatchActivation() Checks if it is a valid activation event and invokes a proper tool. More...
 
void dispatchContextMenu (const TOOL_EVENT &aEvent)
 Function dispatchContextMenu() Handles context menu related events. More...
 
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). More...
 
bool runTool (TOOL_ID aToolId)
 Function runTool() Makes a tool active, so it can receive events and react to them. More...
 
bool runTool (const std::string &aName)
 Function runTool() Makes a tool active, so it can receive events and react to them. More...
 
bool runTool (TOOL_BASE *aTool)
 Function runTool() Makes a tool active, so it can receive events and react to them. More...
 
template<class Parameters >
void invokeTool (const std::string &aName, const Parameters &aToolParams)
 
ID_LIST::iterator finishTool (TOOL_STATE *aState)
 Function finishTool() Deactivates a tool and does the necessary clean up. More...
 
bool isRegistered (TOOL_BASE *aTool) const
 Function isRegistered() Returns information about a tool registration status. More...
 
bool isActive (TOOL_BASE *aTool)
 Function isActive() Returns information about a tool activation status. More...
 
void saveViewControls (TOOL_STATE *aState)
 Function saveViewControls() Saves the VIEW_CONTROLS settings to the tool state object. More...
 
void applyViewControls (TOOL_STATE *aState)
 Function applyViewControls() Applies VIEW_CONTROLS settings stored in a TOOL_STATE object. More...
 
bool processEvent (const TOOL_EVENT &aEvent)
 

Main function for event processing.

More...
 

Private Attributes

TOOL_STATE_MAP m_toolState
 Index of registered tools current states, associated by tools' objects. More...
 
NAME_STATE_MAP m_toolNameIndex
 Index of the registered tools current states, associated by tools' names. More...
 
ID_STATE_MAP m_toolIdIndex
 Index of the registered tools current states, associated by tools' ID numbers. More...
 
std::map< const char *, TOOL_BASE * > m_toolTypes
 Index of the registered tools to easily lookup by their type. More...
 
ID_LIST m_activeTools
 Stack of the active tools. More...
 
ACTION_MANAGERm_actionMgr
 Instance of ACTION_MANAGER that handles TOOL_ACTIONs. More...
 
OPT< VECTOR2Dm_origCursor
 Original cursor position, if overridden by the context menu handler. More...
 
EDA_ITEMm_model
 
KIGFX::VIEWm_view
 
KIGFX::VIEW_CONTROLSm_viewControls
 
wxWindow * m_editFrame
 
std::list< TOOL_EVENTm_eventQueue
 Queue that stores events to be processed at the end of the event processing cycle. More...
 
bool m_passEvent
 Flag saying if the currently processed event should be passed to other tools. More...
 
bool m_menuActive
 Flag indicating whether a context menu is currently displayed. More...
 

Detailed Description

Class TOOL_MANAGER.

Master controller class:

  • registers editing tools
  • pumps UI events to tools requesting them
  • manages tool state machines (transitions and wait requests)

Definition at line 49 of file tool_manager.h.

Member Typedef Documentation

typedef std::list<TOOL_ID> TOOL_MANAGER::ID_LIST

Definition at line 63 of file tool_manager.h.

Definition at line 62 of file tool_manager.h.

typedef std::map<std::string, TOOL_STATE*> TOOL_MANAGER::NAME_STATE_MAP

Definition at line 61 of file tool_manager.h.

Definition at line 60 of file tool_manager.h.

Definition at line 370 of file tool_manager.h.

Constructor & Destructor Documentation

TOOL_MANAGER::TOOL_MANAGER ( )

Definition at line 192 of file tool_manager.cpp.

References m_actionMgr.

192  :
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 }
bool m_menuActive
Flag indicating whether a context menu is currently displayed.
Definition: tool_manager.h:519
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
Class ACTION_MANAGER.
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
wxWindow * m_editFrame
Definition: tool_manager.h:510
KIGFX::VIEW_CONTROLS * m_viewControls
Definition: tool_manager.h:509
KIGFX::VIEW * m_view
Definition: tool_manager.h:508
TOOL_MANAGER::~TOOL_MANAGER ( )

Definition at line 204 of file tool_manager.cpp.

References m_actionMgr, and m_toolState.

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 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487

Member Function Documentation

void TOOL_MANAGER::applyViewControls ( TOOL_STATE aState)
private

Function applyViewControls() Applies VIEW_CONTROLS settings stored in a TOOL_STATE object.

Definition at line 845 of file tool_manager.cpp.

References KIGFX::VIEW_CONTROLS::ApplySettings(), m_viewControls, and TOOL_MANAGER::TOOL_STATE::vcSettings.

Referenced by dispatchInternal(), and ProcessEvent().

846 {
847  m_viewControls->ApplySettings( aState->vcSettings );
848 }
void ApplySettings(const VC_SETTINGS &aSettings)
Applies VIEW_CONTROLS settings from an object
KIGFX::VIEW_CONTROLS * m_viewControls
Definition: tool_manager.h:509
void TOOL_MANAGER::ClearTransitions ( TOOL_BASE aTool)

Clears the state transition map for a tool.

Parameters
aToolis the tool that should have the transition map cleared.

Definition at line 479 of file tool_manager.cpp.

References m_toolState.

Referenced by TOOL_INTERACTIVE::resetTransitions().

480 {
481  m_toolState[aTool]->transitions.clear();
482 }
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
void TOOL_MANAGER::DeactivateTool ( )

Function DeactivateTool() Deactivates the currently active tool.

Definition at line 403 of file tool_manager.cpp.

References processEvent(), TA_CANCEL_TOOL, and TC_COMMAND.

Referenced by ResetTools(), and GERBVIEW_FRAME::~GERBVIEW_FRAME().

404 {
405  // Deactivate the active tool, but do not run anything new
407  processEvent( evt );
408 }
bool processEvent(const TOOL_EVENT &aEvent)
Main function for event processing.
Class TOOL_EVENT.
Definition: tool_event.h:162
bool TOOL_MANAGER::dispatchActivation ( const TOOL_EVENT aEvent)
private

Function dispatchActivation() Checks if it is a valid activation event and invokes a proper tool.

Parameters
aEventis an event to be tested.
Returns
True if a tool was invoked, false otherwise.

Definition at line 610 of file tool_manager.cpp.

References TOOL_EVENT::GetCommandStr(), TOOL_EVENT::IsActivate(), m_toolNameIndex, and runTool().

Referenced by processEvent().

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 }
bool runTool(TOOL_ID aToolId)
Function runTool() Makes a tool active, so it can receive events and react to them.
NAME_STATE_MAP m_toolNameIndex
Index of the registered tools current states, associated by tools' names.
Definition: tool_manager.h:490
bool IsActivate() const
Definition: tool_event.h:300
OPT< std::string > GetCommandStr() const
Definition: tool_event.h:395
void TOOL_MANAGER::dispatchContextMenu ( const TOOL_EVENT aEvent)
private

Function dispatchContextMenu() Handles context menu related events.

Definition at line 626 of file tool_manager.cpp.

References BUT_RIGHT, CONTEXT_MENU::Clone(), CMENU_BUTTON, CMENU_NOW, CMENU_OFF, TOOL_MANAGER::TOOL_STATE::contextMenu, TOOL_MANAGER::TOOL_STATE::contextMenuTrigger, dispatchInternal(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), KIGFX::VIEW_CONTROLS::ForcedCursorPosition(), GetCurrentToolId(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_EVENT::IsClick(), m_activeTools, m_editFrame, m_menuActive, m_origCursor, m_toolIdIndex, m_viewControls, NULLOPT, TOOL_MANAGER::TOOL_STATE::pendingWait, TOOL_EVENT::SetParameter(), TA_ANY, TA_CONTEXT_MENU_CHOICE, TA_CONTEXT_MENU_CLOSED, TC_ANY, TC_COMMAND, TOOL_MANAGER::TOOL_STATE::waitEvents, and KIGFX::VIEW_CONTROLS::WarpCursor().

Referenced by processEvent().

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;
644  st->waitEvents = TOOL_EVENT( TC_ANY, TA_ANY );
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 )
650  st->contextMenuTrigger = CMENU_OFF;
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 
699  m_origCursor = NULLOPT;
700  break;
701  }
702 }
bool m_menuActive
Flag indicating whether a context menu is currently displayed.
Definition: tool_manager.h:519
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
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
OPT< VECTOR2D > m_origCursor
Original cursor position, if overridden by the context menu handler.
Definition: tool_manager.h:505
Class CONTEXT_MENU.
Definition: context_menu.h:44
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 (.
CONTEXT_MENU * Clone() const
Creates a deep, recursive copy of this CONTEXT_MENU.
const auto NULLOPT
Definition: optional.h:9
VECTOR2< double > VECTOR2D
Definition: vector2d.h:588
wxWindow * m_editFrame
Definition: tool_manager.h:510
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
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Function ForceCursorPosition() Places the cursor immediately at a given point.
KIGFX::VIEW_CONTROLS * m_viewControls
Definition: tool_manager.h:509
bool ForcedCursorPosition() const
Function ForcedCursorPosition() Returns true if the current cursor position is forced to a specific l...
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
bool IsClick(int aButtonMask=BUT_ANY) const
Definition: tool_event.h:268
void TOOL_MANAGER::dispatchInternal ( const TOOL_EVENT aEvent)
private

Function dispatchInternal Passes an event at first to the active tools, then to all others.

Definition at line 511 of file tool_manager.cpp.

References applyViewControls(), COROUTINE< ReturnType, ArgType >::Call(), TOOL_EVENT::Category(), TOOL_EVENT_LIST::clear(), TOOL_MANAGER::TOOL_STATE::cofunc, finishTool(), TOOL_MANAGER::TOOL_STATE::idle, m_activeTools, m_passEvent, m_toolIdIndex, m_toolState, TOOL_EVENT_LIST::Matches(), TOOL_MANAGER::TOOL_STATE::pendingWait, TOOL_MANAGER::TOOL_STATE::Push(), COROUTINE< ReturnType, ArgType >::Resume(), COROUTINE< ReturnType, ArgType >::Running(), saveViewControls(), TC_MESSAGE, TOOL_MANAGER::TOOL_STATE::transitions, TOOL_MANAGER::TOOL_STATE::waitEvents, and TOOL_MANAGER::TOOL_STATE::wakeupEvent.

Referenced by dispatchContextMenu(), and processEvent().

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 }
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
ID_LIST::iterator finishTool(TOOL_STATE *aState)
Function finishTool() Deactivates a tool and does the necessary clean up.
void applyViewControls(TOOL_STATE *aState)
Function applyViewControls() Applies VIEW_CONTROLS settings stored in a TOOL_STATE object...
bool m_passEvent
Flag saying if the currently processed event should be passed to other tools.
Definition: tool_manager.h:516
TOOL_EVENT_CATEGORY Category() const
Returns the category (eg. mouse/keyboard/action) of an event..
Definition: tool_event.h:228
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
void saveViewControls(TOOL_STATE *aState)
Function saveViewControls() Saves the VIEW_CONTROLS settings to the tool state object.
std::pair< TOOL_EVENT_LIST, TOOL_STATE_FUNC > TRANSITION
Definition: tool_manager.h:370
bool TOOL_MANAGER::dispatchStandardEvents ( const TOOL_EVENT aEvent)
private

Function dispatchStandardEvents() Handles specific events, that are intended for TOOL_MANAGER rather than tools.

Parameters
aEventis the event to be processed.
Returns
False if the event was processed and should not go any further.

Definition at line 597 of file tool_manager.cpp.

References TOOL_EVENT::Action(), TOOL_EVENT::KeyCode(), m_actionMgr, TOOL_EVENT::Modifier(), ACTION_MANAGER::RunHotKey(), and TA_KEY_PRESSED.

Referenced by processEvent().

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 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
int Modifier(int aMask=MD_MODIFIER_MASK) const
Returns information about key modifiers state (Ctrl, Alt, etc.)
Definition: tool_event.h:311
int KeyCode() const
Definition: tool_event.h:316
bool RunHotKey(int aHotKey) const
Function RunHotKey() Runs an action associated with a hotkey (if there is one available).
TOOL_ACTIONS Action() const
Returns more specific information about the type of an event.
Definition: tool_event.h:234
TOOL_BASE * TOOL_MANAGER::FindTool ( int  aId) const

Function FindTool() Searches for a tool with given ID.

Parameters
aIdis the ID number of the requested tool.
Returns
Pointer to the requested tool or NULL in case of failure.

Definition at line 381 of file tool_manager.cpp.

References m_toolIdIndex.

Referenced by GetCurrentTool(), ALIGN_DISTRIBUTE_TOOL::Init(), POINT_EDITOR::Init(), POSITION_RELATIVE_TOOL::Init(), EDIT_TOOL::Init(), EDIT_TOOL::invokeInlineRouter(), InvokeTool(), EDIT_TOOL::isInteractiveDragEnabled(), ACTION_MANAGER::RunHotKey(), and runTool().

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 }
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
TOOL_BASE * TOOL_MANAGER::FindTool ( const std::string &  aName) const

Function FindTool() Searches for a tool with given name.

Parameters
aNameis the name of the requested tool.
Returns
Pointer to the requested tool or NULL in case of failure.

Definition at line 392 of file tool_manager.cpp.

References m_toolNameIndex.

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 }
NAME_STATE_MAP m_toolNameIndex
Index of the registered tools current states, associated by tools' names.
Definition: tool_manager.h:490
TOOL_MANAGER::ID_LIST::iterator TOOL_MANAGER::finishTool ( TOOL_STATE aState)
private

Function finishTool() Deactivates a tool and does the necessary clean up.

Parameters
aStateis the state variable of the tool to be stopped.
Returns
m_activeTools iterator. If the tool has been completely deactivated, it points to the next active tool on the list. Otherwise it is an iterator pointing to aState.

Definition at line 705 of file tool_manager.cpp.

References TOOL_BASE::GetId(), TOOL_BASE::GetType(), TOOL_MANAGER::TOOL_STATE::idle, INTERACTIVE, m_activeTools, TOOL_MANAGER::TOOL_STATE::Pop(), and TOOL_MANAGER::TOOL_STATE::theTool.

Referenced by dispatchInternal().

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 }
Tool that interacts with the user
Definition: tool_base.h:50
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
Class TOOL_BASE.
Definition: tool_base.h:68
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
std::string TOOL_MANAGER::GetClipboard ( ) const

Returns the information currently stored in the system clipboard.

If data stored in the clipboard is in non-text format, empty string is returned.

Definition at line 774 of file tool_manager.cpp.

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 }
TOOL_BASE* TOOL_MANAGER::GetCurrentTool ( ) const
inline

Returns the tool that is on the top of the active tools stack (was invoked the most recently).

Returns
Pointer to the currently used tool.

Definition at line 287 of file tool_manager.h.

References FindTool(), and GetCurrentToolId().

288  {
289  return FindTool( GetCurrentToolId() );
290  }
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
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
int TOOL_MANAGER::GetCurrentToolId ( ) const
inline

Returns id of the tool that is on the top of the active tools stack (was invoked the most recently).

Returns
Id of the currently used tool.

Definition at line 277 of file tool_manager.h.

References m_activeTools.

Referenced by dispatchContextMenu(), GetCurrentTool(), GetCurrentToolState(), and EDIT_TOOL::updateModificationPoint().

278  {
279  return m_activeTools.empty() ? -1 : m_activeTools.front();
280  }
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
TOOL_STATE* TOOL_MANAGER::GetCurrentToolState ( ) const
inline

Returns the TOOL_STATE object representing the state of the active tool.

If there are no tools active, it returns nullptr.

Definition at line 296 of file tool_manager.h.

References GetCurrentToolId(), and m_toolIdIndex.

Referenced by ProcessEvent().

297  {
298  auto it = m_toolIdIndex.find( GetCurrentToolId() );
299  return ( it != m_toolIdIndex.end() ) ? it->second : nullptr;
300  }
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
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
wxWindow* TOOL_MANAGER::GetEditFrame ( ) const
inline
int TOOL_MANAGER::GetHotKey ( const TOOL_ACTION aAction)

>

Function GetHotKey() Returns the hot key associated with a given action or 0 if there is none.

Parameters
aActionis the queried action.

Definition at line 304 of file tool_manager.cpp.

References ACTION_MANAGER::GetHotKey(), and m_actionMgr.

Referenced by CONTEXT_MENU::updateHotKeys().

305 {
306  return m_actionMgr->GetHotKey( aAction );
307 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
int GetHotKey(const TOOL_ACTION &aAction) const
Function GetHotKey() Returns the hot key associated with a given action or 0 if there is none...
EDA_ITEM* TOOL_MANAGER::GetModel ( ) const
inline

Definition at line 262 of file tool_manager.h.

References m_model.

Referenced by TOOL_BASE::getModelInt(), and highlightNet().

263  {
264  return m_model;
265  }
EDA_ITEM * m_model
Definition: tool_manager.h:507
int TOOL_MANAGER::GetPriority ( int  aToolId) const

Returns priority of a given tool.

Higher number means that the tool is closer to the beginning of the active tools queue (i.e. receives events earlier, tools with lower priority receive events later).

Parameters
aToolIdis the id of queried tool.
Returns
The priority of a given tool. If returned number is negative, then it means that the tool id is invalid or the tool is not active.

Definition at line 454 of file tool_manager.cpp.

References m_activeTools.

Referenced by ACTION_MANAGER::RunHotKey().

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 }
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
template<typename T >
T* TOOL_MANAGER::GetTool ( )
inline

Definition at line 189 of file tool_manager.h.

References m_toolTypes, and name.

Referenced by PAD_TOOL::applyPadSettings(), PCB_EDITOR_CONTROL::calculateSelectionRatsnest(), PAD_TOOL::copyPadSettings(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), PCB_EDITOR_CONTROL::CrossProbePcbToSch(), deleteItem(), PCBNEW_CONTROL::DeleteItemCursor(), PCB_EDITOR_CONTROL::DrillOrigin(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), DRAWING_TOOL::getSourceZoneForAction(), PCBNEW_CONTROL::GridSetOrigin(), GERBVIEW_CONTROL::HighlightControl(), PCB_EDITOR_CONTROL::HighlightNetCursor(), PAD_TOOL::Init(), PCB_EDITOR_CONTROL::Init(), ROUTER_TOOL::InlineDrag(), PCB_EDITOR_CONTROL::modifyLockSelected(), DIALOG_POSITION_RELATIVE::OnOkClick(), DIALOG_POSITION_RELATIVE::OnSelectItemClick(), EDIT_TOOL::pickCopyReferencePoint(), PCBNEW_CONTROL::placeBoardItems(), PAD_TOOL::pushPadSettings(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), selectPRitem(), FOOTPRINT_EDIT_FRAME::setupTools(), PCB_EDITOR_CONTROL::ShowLocalRatsnest(), showLocalRatsnest(), PAD_CONTEXT_MENU::update(), PCB_EDITOR_CONTROL::UpdateSelectionRatsnest(), PCB_EDITOR_CONTROL::ZoneDuplicate(), PCB_EDITOR_CONTROL::ZoneFill(), PCB_EDITOR_CONTROL::ZoneMerge(), and PCB_EDITOR_CONTROL::ZoneUnfill().

190  {
191  std::map<const char*, TOOL_BASE*>::iterator tool = m_toolTypes.find( typeid( T ).name() );
192 
193  if( tool != m_toolTypes.end() )
194  return static_cast<T*>( tool->second );
195 
196  return NULL;
197  }
T
enum T contains all this lexer's tokens.
const char * name
std::map< const char *, TOOL_BASE * > m_toolTypes
Index of the registered tools to easily lookup by their type.
Definition: tool_manager.h:496
KIGFX::VIEW* TOOL_MANAGER::GetView ( ) const
inline

Definition at line 252 of file tool_manager.h.

References m_view.

Referenced by MODULE_EDITOR_TOOLS::EnumeratePads(), TOOL_DISPATCHER::getView(), TOOL_BASE::getView(), PCB_EDITOR_CONTROL::HighlightNet(), and highlightNet().

253  {
254  return m_view;
255  }
KIGFX::VIEW * m_view
Definition: tool_manager.h:508
KIGFX::VIEW_CONTROLS* TOOL_MANAGER::GetViewControls ( ) const
inline

Definition at line 257 of file tool_manager.h.

References m_viewControls.

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), and TOOL_BASE::getViewControls().

258  {
259  return m_viewControls;
260  }
KIGFX::VIEW_CONTROLS * m_viewControls
Definition: tool_manager.h:509
void TOOL_MANAGER::InitTools ( )

Function InitTools() Initializes all registered tools.

If a tool fails during the initialization, it is deactivated and becomes unavailable for further use. Initialization should be done only once.

Definition at line 426 of file tool_manager.cpp.

References Format(), TOOL_BASE::GetId(), TOOL_BASE::GetName(), TOOL_BASE::Init(), m_toolIdIndex, m_toolNameIndex, m_toolState, m_toolTypes, ResetTools(), and TOOL_BASE::RUN.

Referenced by FOOTPRINT_EDIT_FRAME::setupTools(), and GERBVIEW_FRAME::setupTools().

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 }
virtual bool Init()
Function Init() Init() is called once upon a registration of the tool.
Definition: tool_base.h:93
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
Tool is invoked after being inactive.
Definition: tool_base.h:82
NAME_STATE_MAP m_toolNameIndex
Index of the registered tools current states, associated by tools' names.
Definition: tool_manager.h:490
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Function ResetTools() Resets all tools (i.e.
TOOL_ID GetId() const
Function GetId() Returns the unique identifier of the tool.
Definition: tool_base.h:122
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
Class TOOL_BASE.
Definition: tool_base.h:68
const std::string & GetName() const
Function GetName() Returns the name of the tool.
Definition: tool_base.h:133
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
std::map< const char *, TOOL_BASE * > m_toolTypes
Index of the registered tools to easily lookup by their type.
Definition: tool_manager.h:496
bool TOOL_MANAGER::InvokeTool ( TOOL_ID  aToolId)

Function InvokeTool() Calls a tool by sending a tool activation event to tool of given ID.

Parameters
aToolIdis the ID number of the requested tool.
Returns
True if the requested tool was invoked successfully.

Definition at line 239 of file tool_manager.cpp.

References FindTool(), TOOL_BASE::GetType(), INTERACTIVE, and invokeTool().

Referenced by TOOL_INTERACTIVE::Activate(), SELECTION_TOOL::findMove(), SELECTION_TOOL::Main(), DIALOG_UPDATE_PCB::PerformUpdate(), FOOTPRINT_EDIT_FRAME::setupTools(), and GERBVIEW_FRAME::setupTools().

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 }
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
Tool that interacts with the user
Definition: tool_base.h:50
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
Class TOOL_BASE.
Definition: tool_base.h:68
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).
bool TOOL_MANAGER::InvokeTool ( const std::string &  aToolName)

Function InvokeTool() Calls a tool by sending a tool activation event to tool of given name.

Parameters
aToolNameis the name of the requested tool.
Returns
True if the requested tool was invoked successfully.

Definition at line 250 of file tool_manager.cpp.

References FindTool(), TOOL_BASE::GetType(), INTERACTIVE, and invokeTool().

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 }
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
Tool that interacts with the user
Definition: tool_base.h:50
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
Class TOOL_BASE.
Definition: tool_base.h:68
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).
bool TOOL_MANAGER::invokeTool ( TOOL_BASE aTool)
private

Function invokeTool() Invokes a tool by sending a proper event (in contrary to runTool, which makes the tool run for real).

Parameters
aToolis the tool to be invoked.

Definition at line 316 of file tool_manager.cpp.

References TOOL_BASE::GetName(), processEvent(), TA_ACTIVATE, and TC_COMMAND.

Referenced by InvokeTool().

317 {
318  wxASSERT( aTool != NULL );
319 
320  TOOL_EVENT evt( TC_COMMAND, TA_ACTIVATE, aTool->GetName() );
321  processEvent( evt );
322 
323  return true;
324 }
bool processEvent(const TOOL_EVENT &aEvent)
Main function for event processing.
Class TOOL_EVENT.
Definition: tool_event.h:162
const std::string & GetName() const
Function GetName() Returns the name of the tool.
Definition: tool_base.h:133
template<class Parameters >
void TOOL_MANAGER::invokeTool ( const std::string &  aName,
const Parameters &  aToolParams 
)
private
bool TOOL_MANAGER::isActive ( TOOL_BASE aTool)
private

Function isActive() Returns information about a tool activation status.

Parameters
aToolis the tool to be checked.
Returns
True if the tool is on the active tools stack, false otherwise.

Definition at line 814 of file tool_manager.cpp.

References TOOL_BASE::GetId(), isRegistered(), and m_activeTools.

Referenced by runTool().

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 }
TOOL_ID GetId() const
Function GetId() Returns the unique identifier of the tool.
Definition: tool_base.h:122
bool isRegistered(TOOL_BASE *aTool) const
Function isRegistered() Returns information about a tool registration status.
Definition: tool_manager.h:455
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
bool TOOL_MANAGER::isRegistered ( TOOL_BASE aTool) const
inlineprivate

Function isRegistered() Returns information about a tool registration status.

Parameters
aToolis the tool to be checked.
Returns
true if the tool is in the registered tools list, false otherwise.

Definition at line 455 of file tool_manager.h.

References m_toolState.

Referenced by isActive(), and runTool().

456  {
457  return m_toolState.count( aTool ) > 0;
458  }
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
bool TOOL_MANAGER::IsToolActive ( TOOL_ID  aId) const

Function IsToolActive() Returns true if a tool with given id is active (executing)

Definition at line 872 of file tool_manager.cpp.

References m_toolIdIndex.

Referenced by TOOL_BASE::IsToolActive().

873 {
874  auto it = m_toolIdIndex.find( aId );
875  return !it->second->idle;
876 }
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
TOOL_ID TOOL_MANAGER::MakeToolId ( const std::string &  aToolName)
static

Generates a unique ID from for a tool with given name.

Definition at line 795 of file tool_manager.cpp.

796 {
797  static int currentId;
798 
799  return currentId++;
800 }
void TOOL_MANAGER::PassEvent ( )
inline

Allows a tool to pass the already handled event to the next tool on the stack.

Definition at line 351 of file tool_manager.h.

References m_passEvent.

Referenced by ZOOM_TOOL::Main(), PICKER_TOOL::Main(), EDIT_TOOL::MeasureTool(), and POINT_EDITOR::OnSelectionChange().

352  {
353  m_passEvent = true;
354  }
bool m_passEvent
Flag saying if the currently processed event should be passed to other tools.
Definition: tool_manager.h:516
void TOOL_MANAGER::PostEvent ( const TOOL_EVENT aEvent)
inline

Puts an event to the event queue to be processed at the end of event processing cycle.

Parameters
aEventis the event to be put into the queue.

Definition at line 238 of file tool_manager.h.

References m_eventQueue.

Referenced by RunAction().

239  {
240  m_eventQueue.push_back( aEvent );
241  }
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
bool TOOL_MANAGER::ProcessEvent ( const TOOL_EVENT aEvent)

Propagates an event to tools that requested events of matching type(s).

Parameters
aEventis the event to be processed.
Returns
true if the event is a managed hotkey

Definition at line 728 of file tool_manager.cpp.

References applyViewControls(), GetCurrentToolState(), GetEditFrame(), EDA_DRAW_FRAME::GetGalCanvas(), KIGFX::VIEW::IsDirty(), m_view, processEvent(), EDA_DRAW_PANEL_GAL::Refresh(), and saveViewControls().

Referenced by GERBVIEW_SELECTION_TOOL::clearSelection(), SELECTION_TOOL::clearSelection(), PCBNEW_CONTROL::CursorControl(), TOOL_DISPATCHER::DispatchWxCommand(), TOOL_DISPATCHER::DispatchWxEvent(), SELECTION_TOOL::findCallback(), TOOL_DISPATCHER::handleMouseButton(), CONTEXT_MENU::onMenuEvent(), PCBNEW_CONTROL::placeBoardItems(), SELECTION_TOOL::SanitizeSelection(), SELECTION_TOOL::selectConnection(), SELECTION_TOOL::selectCopper(), GERBVIEW_SELECTION_TOOL::SelectItem(), SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), SELECTION_TOOL::SelectItems(), GERBVIEW_SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectMultiple(), SELECTION_TOOL::selectNet(), SELECTION_TOOL::selectOnSheetFromEeschema(), SELECTION_TOOL::selectSameSheet(), GERBVIEW_SELECTION_TOOL::toggleSelection(), SELECTION_TOOL::toggleSelection(), DIALOG_SET_GRID::TransferDataFromWindow(), GERBVIEW_SELECTION_TOOL::UnselectItem(), SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), and SELECTION_TOOL::UnselectItems().

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 }
bool processEvent(const TOOL_EVENT &aEvent)
Main function for event processing.
wxWindow * GetEditFrame() const
Definition: tool_manager.h:267
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
bool IsDirty() const
Function IsDirty() Returns true if any of the VIEW layers needs to be refreshened.
Definition: view.h:539
TOOL_STATE * GetCurrentToolState() const
Returns the TOOL_STATE object representing the state of the active tool.
Definition: tool_manager.h:296
KIGFX::VIEW * m_view
Definition: tool_manager.h:508
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...
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
void saveViewControls(TOOL_STATE *aState)
Function saveViewControls() Saves the VIEW_CONTROLS settings to the tool state object.
bool TOOL_MANAGER::processEvent ( const TOOL_EVENT aEvent)
private

Main function for event processing.

Returns
true if a hotkey was handled

Definition at line 851 of file tool_manager.cpp.

References dispatchActivation(), dispatchContextMenu(), dispatchInternal(), dispatchStandardEvents(), and m_eventQueue.

Referenced by DeactivateTool(), invokeTool(), ProcessEvent(), and RunAction().

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 }
bool processEvent(const TOOL_EVENT &aEvent)
Main function for event processing.
bool dispatchStandardEvents(const TOOL_EVENT &aEvent)
Function dispatchStandardEvents() Handles specific events, that are intended for TOOL_MANAGER rather ...
bool dispatchActivation(const TOOL_EVENT &aEvent)
Function dispatchActivation() Checks if it is a valid activation event and invokes a proper tool...
void dispatchContextMenu(const TOOL_EVENT &aEvent)
Function dispatchContextMenu() Handles context menu related events.
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
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 TOOL_MANAGER::RegisterAction ( TOOL_ACTION aAction)

Function RegisterAction() Registers an action that can be used to control tools (eg.

invoke, trigger specific behaviours).

Parameters
aActionis the action to be registered.

Definition at line 261 of file tool_manager.cpp.

References m_actionMgr, and ACTION_MANAGER::RegisterAction().

262 {
263  m_actionMgr->RegisterAction( aAction );
264 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
void RegisterAction(TOOL_ACTION *aAction)
Function RegisterAction() Adds a tool action to the manager and sets it up.
void TOOL_MANAGER::RegisterTool ( TOOL_BASE aTool)

Function RegisterTool() Adds a tool to the manager set and sets it up.

Called once for each tool during application initialization.

Parameters
aTooltool to be added. Ownership is transferred.

Definition at line 219 of file tool_manager.cpp.

References TOOL_BASE::attachManager(), TOOL_BASE::GetId(), TOOL_BASE::GetName(), m_toolIdIndex, m_toolNameIndex, m_toolState, and m_toolTypes.

Referenced by GERBVIEW_ACTIONS::RegisterAllTools(), PCB_ACTIONS::RegisterAllTools(), and FOOTPRINT_EDIT_FRAME::setupTools().

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 }
ID_STATE_MAP m_toolIdIndex
Index of the registered tools current states, associated by tools' ID numbers.
Definition: tool_manager.h:493
void attachManager(TOOL_MANAGER *aManager)
Function attachManager()
Definition: tool_base.cpp:59
NAME_STATE_MAP m_toolNameIndex
Index of the registered tools current states, associated by tools' names.
Definition: tool_manager.h:490
TOOL_ID GetId() const
Function GetId() Returns the unique identifier of the tool.
Definition: tool_base.h:122
const std::string & GetName() const
Function GetName() Returns the name of the tool.
Definition: tool_base.h:133
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
std::map< const char *, TOOL_BASE * > m_toolTypes
Index of the registered tools to easily lookup by their type.
Definition: tool_manager.h:496
void TOOL_MANAGER::ResetTools ( TOOL_BASE::RESET_REASON  aReason)

Function ResetTools() Resets all tools (i.e.

calls their Reset() method).

Definition at line 411 of file tool_manager.cpp.

References DeactivateTool(), TOOL_BASE::GetType(), INTERACTIVE, m_toolState, and TOOL_BASE::Reset().

Referenced by InitTools(), PCB_BASE_EDIT_FRAME::SetBoard(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::updateView(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

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 }
void DeactivateTool()
Function DeactivateTool() Deactivates the currently active tool.
virtual void Reset(RESET_REASON aReason)=0
Function Reset() Brings the tool to a known, initial state.
Tool that interacts with the user
Definition: tool_base.h:50
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
Class TOOL_BASE.
Definition: tool_base.h:68
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
template<typename T >
bool TOOL_MANAGER::RunAction ( const std::string &  aActionName,
bool  aNow = false,
aParam = NULL 
)
inline

Function RunAction() Runs the specified action.

The common format for action names is "application.ToolName.Action".

Parameters
aActionNameis the name of action to be invoked.
aNowdecides if the action has to be run immediately or after the current coroutine is preemptied.
aParamis an optional parameter that might be used by the invoked action. Its meaning depends on the action.
Returns
False if the action was not found.

Definition at line 125 of file tool_manager.h.

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), PAD_TOOL::applyPadSettings(), MODULE_EDITOR_TOOLS::CreatePadFromShapes(), PCB_EDITOR_CONTROL::CrossProbeSchToPcb(), ROUTER_TOOL::CustomTrackWidthDialog(), deleteItem(), PCB_TOOL::doInteractiveItemPlacement(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::drawZone(), EDIT_TOOL::Duplicate(), EDIT_TOOL::editFootprintInFpEditor(), MODULE_EDITOR_TOOLS::EnumeratePads(), EDIT_TOOL::ExchangeFootprints(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), MODULE_EDITOR_TOOLS::ExplodePadToShapes(), EDIT_TOOL::Flip(), DRAWING_TOOL::getSourceZoneForAction(), ROUTER_TOOL::InlineDrag(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::Main(), SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::mainLoop(), ROUTER_TOOL::mainLoop(), EDIT_TOOL::Mirror(), PCB_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), EDA_DRAW_FRAME::OnSelectGrid(), DIALOG_POSITION_RELATIVE::OnSelectItemClick(), EDA_DRAW_FRAME::OnSelectZoom(), DIALOG_UPDATE_PCB::PerformUpdate(), PCBNEW_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceDXF(), PCB_EDITOR_CONTROL::PlaceModule(), PCB_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), GERBVIEW_SELECTION_TOOL::RequestSelection(), SELECTION_TOOL::RequestSelection(), EDIT_TOOL::Rotate(), RunAction(), ACTION_MANAGER::RunHotKey(), selectPRitem(), GERBVIEW_FRAME::SetActiveLayer(), DRC::ShowDRCDialog(), showLocalRatsnest(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), DIALOG_SET_GRID::TransferDataFromWindow(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::updateView(), PCB_EDITOR_CONTROL::ViaSizeDec(), PCB_EDITOR_CONTROL::ViaSizeInc(), PCB_EDITOR_CONTROL::ZoneMerge(), and EDA_DRAW_FRAME::Zoom_Automatique().

126  {
127  return RunAction( aActionName, aNow, reinterpret_cast<void*>( aParam ) );
128  }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
bool TOOL_MANAGER::RunAction ( const std::string &  aActionName,
bool  aNow,
void *  aParam 
)

Definition at line 273 of file tool_manager.cpp.

References ACTION_MANAGER::FindAction(), Format(), m_actionMgr, and RunAction().

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 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
TOOL_ACTION * FindAction(const std::string &aActionName) const
Function FindAction() Finds an action with a given name (if there is one available).
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
Class TOOL_ACTION.
Definition: tool_action.h:46
bool TOOL_MANAGER::RunAction ( const std::string &  aActionName,
bool  aNow = false 
)
inline

Definition at line 132 of file tool_manager.h.

References RunAction().

133  {
134  return RunAction( aActionName, aNow, (void*) NULL );
135  }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
template<typename T >
void TOOL_MANAGER::RunAction ( const TOOL_ACTION aAction,
bool  aNow = false,
aParam = NULL 
)
inline

Function RunAction() Runs the specified action.

Parameters
aActionis the action to be invoked.
aNowdecides if the action has to be run immediately or after the current coroutine is preemptied.
aParamis an optional parameter that might be used by the invoked action. Its meaning depends on the action.

Definition at line 148 of file tool_manager.h.

References RunAction().

149  {
150  RunAction( aAction, aNow, reinterpret_cast<void*>( aParam ) );
151  }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
void TOOL_MANAGER::RunAction ( const TOOL_ACTION aAction,
bool  aNow,
void *  aParam 
)

Definition at line 289 of file tool_manager.cpp.

References TOOL_ACTION::MakeEvent(), PostEvent(), processEvent(), and TOOL_EVENT::SetParameter().

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 }
bool processEvent(const TOOL_EVENT &aEvent)
Main function for event processing.
void SetParameter(T aParam)
Function SetParameter() Sets a non-standard parameter assigned to the event.
Definition: tool_event.h:385
Class TOOL_EVENT.
Definition: tool_event.h:162
TOOL_EVENT MakeEvent() const
Function HasHotKey() Checks if the action has a hot key assigned.
Definition: tool_action.h:104
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
void TOOL_MANAGER::RunAction ( const TOOL_ACTION aAction,
bool  aNow = false 
)
inline

Definition at line 155 of file tool_manager.h.

References RunAction().

156  {
157  RunAction( aAction, aNow, (void*) NULL );
158  }
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
void TOOL_MANAGER::RunMainStack ( TOOL_BASE aTool,
std::function< void()>  aFunc 
)

Definition at line 485 of file tool_manager.cpp.

References TOOL_MANAGER::TOOL_STATE::cofunc, m_toolState, and COROUTINE< ReturnType, ArgType >::RunMainStack().

Referenced by TOOL_INTERACTIVE::RunMainStack().

486 {
487  TOOL_STATE* st = m_toolState[aTool];
488  st->cofunc->RunMainStack( std::move( aFunc ) );
489 }
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
bool TOOL_MANAGER::runTool ( TOOL_ID  aToolId)
private

Function runTool() Makes a tool active, so it can receive events and react to them.

Activated tool is pushed on the active tools stack, so the last activated tool receives events first.

Parameters
aToolIdis the ID number of tool to be run.

Definition at line 327 of file tool_manager.cpp.

References FindTool(), TOOL_BASE::GetType(), and INTERACTIVE.

Referenced by dispatchActivation(), and runTool().

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 }
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
bool runTool(TOOL_ID aToolId)
Function runTool() Makes a tool active, so it can receive events and react to them.
Tool that interacts with the user
Definition: tool_base.h:50
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
Class TOOL_BASE.
Definition: tool_base.h:68
bool TOOL_MANAGER::runTool ( const std::string &  aName)
private

Function runTool() Makes a tool active, so it can receive events and react to them.

Activated tool is pushed on the active tools stack, so the last activated tool receives events first.

Parameters
aNameis the name of tool to be run.

Definition at line 338 of file tool_manager.cpp.

References FindTool(), TOOL_BASE::GetType(), INTERACTIVE, and runTool().

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 }
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
bool runTool(TOOL_ID aToolId)
Function runTool() Makes a tool active, so it can receive events and react to them.
Tool that interacts with the user
Definition: tool_base.h:50
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
Class TOOL_BASE.
Definition: tool_base.h:68
bool TOOL_MANAGER::runTool ( TOOL_BASE aTool)
private

Function runTool() Makes a tool active, so it can receive events and react to them.

Activated tool is pushed on the active tools stack, so the last activated tool receives events first.

Parameters
aToolis the tool to be run.

Definition at line 349 of file tool_manager.cpp.

References TOOL_BASE::GetId(), TOOL_BASE::GetType(), INTERACTIVE, isActive(), isRegistered(), m_activeTools, TOOL_BASE::Reset(), and TOOL_BASE::RUN.

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 }
Tool is invoked after being inactive.
Definition: tool_base.h:82
virtual void Reset(RESET_REASON aReason)=0
Function Reset() Brings the tool to a known, initial state.
int TOOL_ID
Unique identifier for tools.
Definition: tool_base.h:57
Tool that interacts with the user
Definition: tool_base.h:50
TOOL_ID GetId() const
Function GetId() Returns the unique identifier of the tool.
Definition: tool_base.h:122
bool isActive(TOOL_BASE *aTool)
Function isActive() Returns information about a tool activation status.
TOOL_TYPE GetType() const
Function GetType() Returns the type of the tool.
Definition: tool_base.h:111
bool isRegistered(TOOL_BASE *aTool) const
Function isRegistered() Returns information about a tool registration status.
Definition: tool_manager.h:455
ID_LIST m_activeTools
Stack of the active tools.
Definition: tool_manager.h:499
bool TOOL_MANAGER::SaveClipboard ( const std::string &  aText)

Stores an information to the system clipboard.

Parameters
aTextis the information to be stored.
Returns
False if error occured.

Definition at line 760 of file tool_manager.cpp.

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 }
void TOOL_MANAGER::saveViewControls ( TOOL_STATE aState)
private

Function saveViewControls() Saves the VIEW_CONTROLS settings to the tool state object.

If VIEW_CONTROLS settings are affected by TOOL_MANAGER, the original settings are saved.

Definition at line 824 of file tool_manager.cpp.

References KIGFX::VIEW_CONTROLS::GetSettings(), KIGFX::VC_SETTINGS::m_forceCursorPosition, KIGFX::VC_SETTINGS::m_forcedPosition, m_menuActive, m_origCursor, m_viewControls, and TOOL_MANAGER::TOOL_STATE::vcSettings.

Referenced by dispatchInternal(), and ProcessEvent().

825 {
826  aState->vcSettings = m_viewControls->GetSettings();
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;
835  aState->vcSettings.m_forcedPosition = *m_origCursor;
836  }
837  else
838  {
839  aState->vcSettings.m_forceCursorPosition = false;
840  }
841  }
842 }
bool m_menuActive
Flag indicating whether a context menu is currently displayed.
Definition: tool_manager.h:519
OPT< VECTOR2D > m_origCursor
Original cursor position, if overridden by the context menu handler.
Definition: tool_manager.h:505
bool m_forceCursorPosition
Is the forced cursor position enabled
Definition: view_controls.h:61
KIGFX::VIEW_CONTROLS * m_viewControls
Definition: tool_manager.h:509
const VC_SETTINGS & GetSettings() const
Returns the current VIEW_CONTROLS settings
void TOOL_MANAGER::ScheduleContextMenu ( TOOL_BASE aTool,
CONTEXT_MENU aMenu,
CONTEXT_MENU_TRIGGER  aTrigger 
)

Sets behaviour of the tool's context popup menu.

Parameters
aTool- the parent tool
aMenu- the menu structure, defined by the tool
aTrigger- when the menu is activated: CMENU_NOW: opens the menu right now CMENU_BUTTON: opens the menu when RMB is pressed CMENU_OFF: menu is disabled. May be called from a coroutine context.

Definition at line 750 of file tool_manager.cpp.

References TOOL_MANAGER::TOOL_STATE::contextMenu, TOOL_MANAGER::TOOL_STATE::contextMenuTrigger, and m_toolState.

Referenced by TOOL_INTERACTIVE::SetContextMenu().

752 {
753  TOOL_STATE* st = m_toolState[aTool];
754 
755  st->contextMenu = aMenu;
756  st->contextMenuTrigger = aTrigger;
757 }
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
void TOOL_MANAGER::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.

Called by TOOL_INTERACTIVE::Go(). May be called from a coroutine context.

Definition at line 470 of file tool_manager.cpp.

References m_toolState, and TOOL_MANAGER::TOOL_STATE::transitions.

Referenced by TOOL_INTERACTIVE::goInternal().

472 {
473  TOOL_STATE* st = m_toolState[aTool];
474 
475  st->transitions.push_back( TRANSITION( aConditions, aHandler ) );
476 }
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
std::pair< TOOL_EVENT_LIST, TOOL_STATE_FUNC > TRANSITION
Definition: tool_manager.h:370
OPT< TOOL_EVENT > TOOL_MANAGER::ScheduleWait ( TOOL_BASE aTool,
const TOOL_EVENT_LIST aConditions 
)

Pauses execution of a given tool until one or more events matching aConditions arrives.

The pause/resume operation is done through COROUTINE object. Called only from coroutines.

Definition at line 492 of file tool_manager.cpp.

References TOOL_MANAGER::TOOL_STATE::cofunc, COROUTINE< ReturnType, ArgType >::KiYield(), m_toolState, TOOL_MANAGER::TOOL_STATE::pendingWait, TOOL_MANAGER::TOOL_STATE::waitEvents, and TOOL_MANAGER::TOOL_STATE::wakeupEvent.

Referenced by TOOL_INTERACTIVE::Wait().

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 }
TOOL_STATE_MAP m_toolState
Index of registered tools current states, associated by tools' objects.
Definition: tool_manager.h:487
void TOOL_MANAGER::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).

These are made available to the tool. Called by the parent frame (PCB_EDIT_FRAME) when the board is set up.

Definition at line 803 of file tool_manager.cpp.

References m_actionMgr, m_editFrame, m_model, m_view, m_viewControls, and ACTION_MANAGER::UpdateHotKeys().

Referenced by EVT_TOOL(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_EDIT_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PCB_BASE_FRAME::UseGalCanvas(), and GERBVIEW_FRAME::UseGalCanvas().

805 {
806  m_model = aModel;
807  m_view = aView;
808  m_viewControls = aViewControls;
809  m_editFrame = aFrame;
811 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
void UpdateHotKeys()
Function UpdateHotKeys() Updates TOOL_ACTIONs hot key assignment according to the current frame's Hot...
EDA_ITEM * m_model
Definition: tool_manager.h:507
wxWindow * m_editFrame
Definition: tool_manager.h:510
KIGFX::VIEW_CONTROLS * m_viewControls
Definition: tool_manager.h:509
KIGFX::VIEW * m_view
Definition: tool_manager.h:508
void TOOL_MANAGER::UnregisterAction ( TOOL_ACTION aAction)

Function UnregisterAction() Unregisters an action, so it is no longer active.

Parameters
aActionis the action to be unregistered.

Definition at line 267 of file tool_manager.cpp.

References m_actionMgr, and ACTION_MANAGER::UnregisterAction().

268 {
269  m_actionMgr->UnregisterAction( aAction );
270 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
void UnregisterAction(TOOL_ACTION *aAction)
Function UnregisterAction() Removes a tool action from the manager and makes it unavailable for furth...
void TOOL_MANAGER::UpdateHotKeys ( )

>

Function UpdateHotKeys() Updates TOOL_ACTIONs hot key assignment according to the current frame's Hot Key Editor settings.

Definition at line 310 of file tool_manager.cpp.

References m_actionMgr, and ACTION_MANAGER::UpdateHotKeys().

Referenced by EDA_DRAW_FRAME::WriteHotkeyConfig().

311 {
313 }
ACTION_MANAGER * m_actionMgr
Instance of ACTION_MANAGER that handles TOOL_ACTIONs.
Definition: tool_manager.h:502
void UpdateHotKeys()
Function UpdateHotKeys() Updates TOOL_ACTIONs hot key assignment according to the current frame's Hot...

Member Data Documentation

ACTION_MANAGER* TOOL_MANAGER::m_actionMgr
private
ID_LIST TOOL_MANAGER::m_activeTools
private

Stack of the active tools.

Definition at line 499 of file tool_manager.h.

Referenced by dispatchContextMenu(), dispatchInternal(), finishTool(), GetCurrentToolId(), GetPriority(), isActive(), and runTool().

wxWindow* TOOL_MANAGER::m_editFrame
private

Definition at line 510 of file tool_manager.h.

Referenced by dispatchContextMenu(), GetEditFrame(), and SetEnvironment().

std::list<TOOL_EVENT> TOOL_MANAGER::m_eventQueue
private

Queue that stores events to be processed at the end of the event processing cycle.

Definition at line 513 of file tool_manager.h.

Referenced by PostEvent(), and processEvent().

bool TOOL_MANAGER::m_menuActive
private

Flag indicating whether a context menu is currently displayed.

Definition at line 519 of file tool_manager.h.

Referenced by dispatchContextMenu(), and saveViewControls().

EDA_ITEM* TOOL_MANAGER::m_model
private

Definition at line 507 of file tool_manager.h.

Referenced by GetModel(), and SetEnvironment().

OPT<VECTOR2D> TOOL_MANAGER::m_origCursor
private

Original cursor position, if overridden by the context menu handler.

Definition at line 505 of file tool_manager.h.

Referenced by dispatchContextMenu(), and saveViewControls().

bool TOOL_MANAGER::m_passEvent
private

Flag saying if the currently processed event should be passed to other tools.

Definition at line 516 of file tool_manager.h.

Referenced by dispatchInternal(), and PassEvent().

ID_STATE_MAP TOOL_MANAGER::m_toolIdIndex
private

Index of the registered tools current states, associated by tools' ID numbers.

Definition at line 493 of file tool_manager.h.

Referenced by dispatchContextMenu(), dispatchInternal(), FindTool(), GetCurrentToolState(), InitTools(), IsToolActive(), and RegisterTool().

NAME_STATE_MAP TOOL_MANAGER::m_toolNameIndex
private

Index of the registered tools current states, associated by tools' names.

Definition at line 490 of file tool_manager.h.

Referenced by dispatchActivation(), FindTool(), InitTools(), and RegisterTool().

TOOL_STATE_MAP TOOL_MANAGER::m_toolState
private

Index of registered tools current states, associated by tools' objects.

Definition at line 487 of file tool_manager.h.

Referenced by ClearTransitions(), dispatchInternal(), InitTools(), isRegistered(), RegisterTool(), ResetTools(), RunMainStack(), ScheduleContextMenu(), ScheduleNextState(), ScheduleWait(), and ~TOOL_MANAGER().

std::map<const char*, TOOL_BASE*> TOOL_MANAGER::m_toolTypes
private

Index of the registered tools to easily lookup by their type.

Definition at line 496 of file tool_manager.h.

Referenced by GetTool(), InitTools(), and RegisterTool().

KIGFX::VIEW* TOOL_MANAGER::m_view
private

Definition at line 508 of file tool_manager.h.

Referenced by GetView(), ProcessEvent(), and SetEnvironment().

KIGFX::VIEW_CONTROLS* TOOL_MANAGER::m_viewControls
private

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