TOOL_MANAGER Class Reference

Master controller class: 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_ID >	ID_LIST

Public Member Functions
	TOOL_MANAGER ()
	~TOOL_MANAGER ()
void	RegisterTool (TOOL_BASE *aTool)
	Add a tool to the manager set and sets it up. More...
bool	InvokeTool (TOOL_ID aToolId)
	Call a tool by sending a tool activation event to tool of given ID. More...
bool	InvokeTool (const std::string &aToolName)
	Call a tool by sending a tool activation event to tool of given name. More...
void	ShutdownAllTools ()
	Shutdown all tools with a currently registered event loop in this tool manager by waking them up with a null event. More...
void	ShutdownTool (TOOL_BASE *aTool)
	Shutdown the specified tool by waking it up with a null event to terminate the processing loop. More...
void	ShutdownTool (TOOL_ID aToolId)
	Shutdown the specified tool by waking it up with a null event to terminate the processing loop. More...
void	ShutdownTool (const std::string &aToolName)
	Shutdown the specified tool by waking it up with a null event to terminate the processing loop. More...
template<typename T >
bool	RunAction (const std::string &aActionName, bool aNow=false, T aParam=NULL)
	Run 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 >
bool	RunAction (const TOOL_ACTION &aAction, bool aNow=false, T aParam=NULL)
	Run the specified action. More...
bool	RunAction (const TOOL_ACTION &aAction, bool aNow, void *aParam)
bool	RunAction (const TOOL_ACTION &aAction, bool aNow=false)
void	CancelTool ()
	Send a cancel event to the tool currently at the top of the tool stack. More...
void	PrimeTool (const VECTOR2D &aPosition)
	"Prime" a tool by sending a cursor left-click event with the mouse position set to the passed in position. More...
int	GetHotKey (const TOOL_ACTION &aAction) const
ACTION_MANAGER *	GetActionManager () const
TOOL_BASE *	FindTool (int aId) const
	Search for a tool with given ID. More...
TOOL_BASE *	FindTool (const std::string &aName) const
	Search for a tool with given name. More...
template<typename T >
T *	GetTool ()
std::vector< TOOL_BASE * >	Tools ()
void	DeactivateTool ()
	Deactivate the currently active tool. More...
bool	IsToolActive (TOOL_ID aId) const
	Return true if a tool with given id is active (executing) More...
void	ResetTools (TOOL_BASE::RESET_REASON aReason)
	Reset all tools (i.e. More...
void	InitTools ()
	Initializes all registered tools. More...
bool	ProcessEvent (const TOOL_EVENT &aEvent)
	Propagate an event to tools that requested events of matching type(s). More...
void	PostEvent (const TOOL_EVENT &aEvent)
	Put 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, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
	Set the work environment (model, view, view controls and the parent window). More...
KIGFX::VIEW *	GetView () const
KIGFX::VIEW_CONTROLS *	GetViewControls () const
VECTOR2D	GetMousePosition () const
VECTOR2D	GetCursorPosition () const
EDA_ITEM *	GetModel () const
APP_SETTINGS_BASE *	GetSettings () const
TOOLS_HOLDER *	GetToolHolder () const
int	GetCurrentToolId () const
	Return id of the tool that is on the top of the active tools stack (was invoked the most recently). More...
TOOL_BASE *	GetCurrentTool () const
	Return the tool that is on the top of the active tools stack (was invoked the most recently). More...
TOOL_STATE *	GetCurrentToolState () const
	Return the #TOOL_STATE object representing the state of the active tool. More...
int	GetPriority (int aToolId) const
	Return priority of a given tool. More...
void	ScheduleNextState (TOOL_BASE *aTool, TOOL_STATE_FUNC &aHandler, const TOOL_EVENT_LIST &aConditions)
	Define a state transition. More...
void	ClearTransitions (TOOL_BASE *aTool)
	Clear the state transition map for a tool. More...
void	RunMainStack (TOOL_BASE *aTool, std::function< void()> aFunc)
void	UpdateUI (const TOOL_EVENT &aEvent)
	Update the status bar and synchronizes toolbars. More...
TOOL_EVENT *	ScheduleWait (TOOL_BASE *aTool, const TOOL_EVENT_LIST &aConditions)
	Pause execution of a given tool until one or more events matching aConditions arrives. More...
void	ScheduleContextMenu (TOOL_BASE *aTool, ACTION_MENU *aMenu, CONTEXT_MENU_TRIGGER aTrigger)
	Set behavior of the tool's context popup menu. More...
bool	SaveClipboard (const std::string &aTextUTF8)
	Store information to the system clipboard. More...
std::string	GetClipboardUTF8 () const
	Return the information currently stored in the system clipboard. More...
const KIGFX::VC_SETTINGS &	GetCurrentToolVC () const
	Return the view controls settings for the current tool or the general settings if there is no active tool. More...
bool	IsContextMenuActive () const
	True while processing a context menu. More...
void	VetoContextMenuMouseWarp ()
	Disable mouse warping after the current context menu is closed. More...
void	DispatchContextMenu (const TOOL_EVENT &aEvent)
	Handle context menu related events. More...
bool	DispatchHotKey (const TOOL_EVENT &aEvent)
	Handle specific events, that are intended for TOOL_MANAGER rather than tools. More...
VECTOR2D	GetMenuCursorPos () const

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_FUNC >	TRANSITION

Private Member Functions
bool	dispatchInternal (TOOL_EVENT &aEvent)
	Pass an event at first to the active tools, then to all others. More...
bool	dispatchActivation (const TOOL_EVENT &aEvent)
	Check if it is a valid activation event and invokes a proper tool. More...
bool	invokeTool (TOOL_BASE *aTool)
	Invoke a tool by sending a proper event (in contrary to runTool, which makes the tool run for real). More...
bool	runTool (TOOL_BASE *aTool)
	Make a tool active, so it can receive events and react to them. More...
ID_LIST::iterator	finishTool (TOOL_STATE *aState)
	Deactivate a tool and does the necessary clean up. More...
bool	isRegistered (TOOL_BASE *aTool) const
	Return information about a tool registration status. More...
bool	isActive (TOOL_BASE *aTool) const
	Return information about a tool activation status. More...
void	saveViewControls (TOOL_STATE *aState)
	Save the #VIEW_CONTROLS settings to the tool state object. More...
void	applyViewControls (const TOOL_STATE *aState)
	Apply #VIEW_CONTROLS settings stored in a #TOOL_STATE object. More...
bool	processEvent (const TOOL_EVENT &aEvent)
	Main function for event processing. More...
void	setActiveState (TOOL_STATE *aState)
	Save the previous active state and sets a new one. More...

Private Attributes
std::vector< TOOL_BASE * >	m_toolOrder
	Index of registered tools current states, associated by tools' objects. More...
TOOL_STATE_MAP	m_toolState
	Index of the registered tools current states, associated by tools' names. More...
NAME_STATE_MAP	m_toolNameIndex
	Index of the registered tools current states, associated by tools' ID numbers. More...
ID_STATE_MAP	m_toolIdIndex
	Index of the registered tools to easily lookup by their type. More...
std::map< const char *, TOOL_BASE * >	m_toolTypes
	Stack of the active tools. More...
ID_LIST	m_activeTools
	Instance of ACTION_MANAGER that handles TOOL_ACTIONs. More...
ACTION_MANAGER *	m_actionMgr
	Original cursor position, if overridden by the context menu handler. More...
std::map< TOOL_ID, std::optional< VECTOR2D > >	m_cursorSettings
EDA_ITEM *	m_model
KIGFX::VIEW *	m_view
KIGFX::VIEW_CONTROLS *	m_viewControls
TOOLS_HOLDER *	m_frame
APP_SETTINGS_BASE *	m_settings
	Queue that stores events to be processed at the end of the event processing cycle. More...
std::list< TOOL_EVENT >	m_eventQueue
	Right click context menu position. More...
VECTOR2D	m_menuCursor
bool	m_warpMouseAfterContextMenu
	Flag indicating whether a context menu is currently displayed. More...
bool	m_menuActive
	Tool currently displaying a popup menu. It is negative when there is no menu displayed. More...
TOOL_ID	m_menuOwner
	Pointer to the state object corresponding to the currently executed tool. More...
TOOL_STATE *	m_activeState
	True if the tool manager is shutting down (don't process additional events) More...
bool	m_shuttingDown

Detailed Description

Master controller class:

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

Definition at line 54 of file tool_manager.h.

Member Typedef Documentation

ID_LIST

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

Definition at line 68 of file tool_manager.h.

ID_STATE_MAP

typedef std::map<TOOL_ID, TOOL_STATE*> TOOL_MANAGER::ID_STATE_MAP

Definition at line 67 of file tool_manager.h.

NAME_STATE_MAP

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

Definition at line 66 of file tool_manager.h.

TOOL_STATE_MAP

typedef std::map<TOOL_BASE*, TOOL_STATE*> TOOL_MANAGER::TOOL_STATE_MAP

Definition at line 65 of file tool_manager.h.

TRANSITION

typedef std::pair<TOOL_EVENT_LIST, TOOL_STATE_FUNC> TOOL_MANAGER::TRANSITION

private

Definition at line 448 of file tool_manager.h.

Constructor & Destructor Documentation

TOOL_MANAGER()

TOOL_MANAGER::TOOL_MANAGER

(

)

Definition at line 205 of file tool_manager.cpp.

 :
 m_model( nullptr ),
 m_view( nullptr ),
 m_viewControls( nullptr ),
 m_frame( nullptr ),
 m_settings( nullptr ),
 m_warpMouseAfterContextMenu( true ),
 m_menuActive( false ),
 m_menuOwner( -1 ),
 m_activeState( nullptr ),
 m_shuttingDown( false )
{
 m_actionMgr = new ACTION_MANAGER( this );
}

References m_actionMgr.

~TOOL_MANAGER()

TOOL_MANAGER::~TOOL_MANAGER

(

)

Definition at line 221 of file tool_manager.cpp.

{
 std::map<TOOL_BASE*, TOOL_STATE*>::iterator it, it_end;
 
 for( it = m_toolState.begin(), it_end = m_toolState.end(); it != it_end; ++it )
 {
 delete it->second->cofunc; // delete cofunction
 delete it->second; // delete TOOL_STATE
 delete it->first; // delete the tool itself
 }
 
 delete m_actionMgr;
}

References m_actionMgr, and m_toolState.

Member Function Documentation

applyViewControls()

void TOOL_MANAGER::applyViewControls ( const TOOL_STATE *  aState )

private

Apply #VIEW_CONTROLS settings stored in a #TOOL_STATE object.

Definition at line 1135 of file tool_manager.cpp.

{
 m_viewControls->ApplySettings( aState->vcSettings );
}

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

Referenced by setActiveState().

CancelTool()

void TOOL_MANAGER::CancelTool

(

)

Send a cancel event to the tool currently at the top of the tool stack.

Definition at line 351 of file tool_manager.cpp.

{
 TOOL_EVENT evt( TC_COMMAND, TA_CANCEL_TOOL );
 
 processEvent( evt );
}

References processEvent(), TA_CANCEL_TOOL, and TC_COMMAND.

Referenced by ACTION_TOOLBAR::onToolEvent().

ClearTransitions()

void TOOL_MANAGER::ClearTransitions

(

TOOL_BASE *

aTool

)

Clear the state transition map for a tool.

Parameters

aTool

is the tool that should have the transition map cleared.

Definition at line 647 of file tool_manager.cpp.

{
 m_toolState[aTool]->transitions.clear();
}

References m_toolState.

Referenced by TOOL_INTERACTIVE::resetTransitions().

DeactivateTool()

void TOOL_MANAGER::DeactivateTool

(

)

Deactivate the currently active tool.

Definition at line 565 of file tool_manager.cpp.

{
 // Deactivate the active tool, but do not run anything new
 TOOL_EVENT evt( TC_COMMAND, TA_CANCEL_TOOL );
 processEvent( evt );
}

References processEvent(), TA_CANCEL_TOOL, and TC_COMMAND.

Referenced by GERBVIEW_FRAME::doCloseWindow(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DIALOG_UPDATE_PCB::PerformUpdate(), ResetTools(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

dispatchActivation()

bool TOOL_MANAGER::dispatchActivation ( const TOOL_EVENT &  aEvent )

private

Check if it is a valid activation event and invokes a proper tool.

Parameters

aEvent

is an event to be tested.

Returns

True if a tool was invoked, false otherwise.

Definition at line 825 of file tool_manager.cpp.

{
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::dispatchActivation - Received event: %s",
 aEvent.Format() );
 
 if( aEvent.IsActivate() )
 {
 auto tool = m_toolNameIndex.find( aEvent.getCommandStr() );
 
 if( tool != m_toolNameIndex.end() )
 {
 wxLogTrace( kicadTraceToolStack,
 "TOOL_MANAGER::dispatchActivation - Running tool %s for event: %s",
 tool->second->theTool->GetName(), aEvent.Format() );
 
 runTool( tool->second->theTool );
 return true;
 }
 }
 
 return false;
}

References TOOL_EVENT::Format(), TOOL_EVENT::getCommandStr(), TOOL_EVENT::IsActivate(), kicadTraceToolStack, m_toolNameIndex, and runTool().

Referenced by processEvent().

DispatchContextMenu()

void TOOL_MANAGER::DispatchContextMenu

(

const TOOL_EVENT &

aEvent

)

Handle context menu related events.

Definition at line 848 of file tool_manager.cpp.

{
 for( TOOL_ID toolId : m_activeTools )
 {
 TOOL_STATE* st = m_toolIdIndex[toolId];
 
 // the tool requested a context menu. The menu is activated on RMB click (CMENU_BUTTON mode)
 // or immediately (CMENU_NOW) mode. The latter is used for clarification lists.
 if( st->contextMenuTrigger == CMENU_OFF )
 continue;
 
 if( st->contextMenuTrigger == CMENU_BUTTON && !aEvent.IsClick( BUT_RIGHT ) )
 break;
 
 if( st->cofunc )
 {
 st->pendingWait = true;
 st->waitEvents = TOOL_EVENT( TC_ANY, TA_ANY );
 }
 
 // Store the menu pointer in case it is changed by the TOOL when handling menu events
 ACTION_MENU* m = st->contextMenu;
 
 if( st->contextMenuTrigger == CMENU_NOW )
 st->contextMenuTrigger = CMENU_OFF;
 
 // Store the cursor position, so the tools could execute actions
 // using the point where the user has invoked a context menu
 if( m_viewControls )
 m_menuCursor = m_viewControls->GetCursorPosition();
 
 // Save all tools cursor settings, as they will be overridden
 for( const std::pair<const TOOL_ID, TOOL_STATE*>& idState : m_toolIdIndex )
 {
 TOOL_STATE* s = idState.second;
 const auto& vc = s->vcSettings;
 
 if( vc.m_forceCursorPosition )
 m_cursorSettings[idState.first] = vc.m_forcedPosition;
 else
 m_cursorSettings[idState.first] = std::nullopt;
 }
 
 if( m_viewControls )
 m_viewControls->ForceCursorPosition( true, m_menuCursor );
 
 // Display a copy of menu
 std::unique_ptr<ACTION_MENU> menu( m->Clone() );
 
 m_menuOwner = toolId;
 m_menuActive = true;
 
 if( wxWindow* frame = dynamic_cast<wxWindow*>( m_frame ) )
 frame->PopupMenu( menu.get() );
 
 // If a menu is canceled then notify tool
 if( menu->GetSelected() < 0 )
 {
 TOOL_EVENT evt( TC_COMMAND, TA_CHOICE_MENU_CHOICE, -1 );
 evt.SetHasPosition( false );
 evt.SetParameter( m );
 dispatchInternal( evt );
 }
 
 // Restore setting in case it was vetoed
 m_warpMouseAfterContextMenu = true;
 
 // Notify the tools that menu has been closed
 TOOL_EVENT evt( TC_COMMAND, TA_CHOICE_MENU_CLOSED );
 evt.SetHasPosition( false );
 evt.SetParameter( m );
 dispatchInternal( evt );
 
 m_menuActive = false;
 m_menuOwner = -1;
 
 // Restore cursor settings
 for( const std::pair<const TOOL_ID, std::optional<VECTOR2D>>& cursorSetting : m_cursorSettings )
 {
 auto it = m_toolIdIndex.find( cursorSetting.first );
 wxASSERT( it != m_toolIdIndex.end() );
 
 if( it == m_toolIdIndex.end() )
 continue;
 
 KIGFX::VC_SETTINGS& vc = it->second->vcSettings;
 vc.m_forceCursorPosition = (bool) cursorSetting.second;
 vc.m_forcedPosition = cursorSetting.second ? *cursorSetting.second : VECTOR2D( 0, 0 );
 }
 
 m_cursorSettings.clear();
 break;
 }
}

References BUT_RIGHT, ACTION_MENU::Clone(), CMENU_BUTTON, CMENU_NOW, CMENU_OFF, TOOL_MANAGER::TOOL_STATE::cofunc, TOOL_MANAGER::TOOL_STATE::contextMenu, TOOL_MANAGER::TOOL_STATE::contextMenuTrigger, dispatchInternal(), KIGFX::VIEW_CONTROLS::ForceCursorPosition(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), TOOL_EVENT::IsClick(), m_activeTools, m_cursorSettings, KIGFX::VC_SETTINGS::m_forceCursorPosition, KIGFX::VC_SETTINGS::m_forcedPosition, m_frame, m_menuActive, m_menuCursor, m_menuOwner, m_toolIdIndex, m_viewControls, m_warpMouseAfterContextMenu, TOOL_MANAGER::TOOL_STATE::pendingWait, TOOL_EVENT::SetHasPosition(), TOOL_EVENT::SetParameter(), TA_ANY, TA_CHOICE_MENU_CHOICE, TA_CHOICE_MENU_CLOSED, TC_ANY, TC_COMMAND, TOOL_MANAGER::TOOL_STATE::vcSettings, and TOOL_MANAGER::TOOL_STATE::waitEvents.

Referenced by processEvent().

DispatchHotKey()

bool TOOL_MANAGER::DispatchHotKey

(

const TOOL_EVENT &

aEvent

)

Handle specific events, that are intended for TOOL_MANAGER rather than tools.

Parameters

aEvent

is the event to be processed.

Returns

true if the event was processed and should not go any further.

Definition at line 816 of file tool_manager.cpp.

{
 if( aEvent.Action() == TA_KEY_PRESSED )
 return m_actionMgr->RunHotKey( aEvent.Modifier() | aEvent.KeyCode() );
 
 return false;
}

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

Referenced by processEvent().

dispatchInternal()

bool TOOL_MANAGER::dispatchInternal ( TOOL_EVENT &  aEvent )

private

Pass an event at first to the active tools, then to all others.

Definition at line 683 of file tool_manager.cpp.

{
 bool handled = false;
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::dispatchInternal - received event: %s",
 aEvent.Format() );
 
 auto it = m_activeTools.begin();
 
 // iterate over active tool stack
 while( it != m_activeTools.end() )
 {
 TOOL_STATE* st = m_toolIdIndex[*it];
 bool increment = true;
 
 // forward context menu events to the tool that created the menu
 if( aEvent.IsChoiceMenu() )
 {
 if( *it != m_menuOwner )
 {
 ++it;
 continue;
 }
 }
 
 // If we're pendingWait then we had better have a cofunc to process the wait.
 wxASSERT( !st || !st->pendingWait || st->cofunc );
 
 // the tool state handler is waiting for events (i.e. called Wait() method)
 if( st && st->cofunc && st->pendingWait && st->waitEvents.Matches( aEvent ) )
 {
 if( !aEvent.FirstResponder() )
 aEvent.SetFirstResponder( st->theTool );
 
 // got matching event? clear wait list and wake up the coroutine
 st->wakeupEvent = aEvent;
 st->pendingWait = false;
 st->waitEvents.clear();
 
 wxLogTrace( kicadTraceToolStack,
 "TOOL_MANAGER::dispatchInternal - Waking tool %s for event: %s",
 st->theTool->GetName(), aEvent.Format() );
 
 setActiveState( st );
 bool end = !st->cofunc->Resume();
 
 if( end )
 {
 it = finishTool( st );
 increment = false;
 }
 
 // If the tool did not request the event be passed to other tools, we're done
 if( !st->wakeupEvent.PassEvent() )
 {
 wxLogTrace( kicadTraceToolStack,
 "TOOL_MANAGER::dispatchInternal - tool %s stopped passing event: %s",
 st->theTool->GetName(), aEvent.Format() );
 
 return true;
 }
 }
 
 if( increment )
 ++it;
 }
 
 for( const auto& state : m_toolState )
 {
 TOOL_STATE* st = state.second;
 bool finished = false;
 
 // no state handler in progress - check if there are any transitions (defined by
 // Go() method that match the event.
 if( !st->transitions.empty() )
 {
 for( const TRANSITION& tr : st->transitions )
 {
 if( tr.first.Matches( aEvent ) )
 {
 auto func_copy = tr.second;
 
 if( !aEvent.FirstResponder() )
 aEvent.SetFirstResponder( st->theTool );
 
 // if there is already a context, then push it on the stack
 // and transfer the previous view control settings to the new context
 if( st->cofunc )
 {
 auto vc = st->vcSettings;
 st->Push();
 st->vcSettings = vc;
 }
 
 st->cofunc = new COROUTINE<int, const TOOL_EVENT&>( std::move( func_copy ) );
 
 // as the state changes, the transition table has to be set up again
 st->transitions.clear();
 
 wxLogTrace( kicadTraceToolStack,
 "TOOL_MANAGER::dispatchInternal - Running tool %s for event: %s",
 st->theTool->GetName(), aEvent.Format() );
 
 // got match? Run the handler.
 setActiveState( st );
 st->idle = false;
 st->initialEvent = aEvent;
 st->cofunc->Call( st->initialEvent );
 handled = true;
 
 if( !st->cofunc->Running() )
 finishTool( st ); // The coroutine has finished immediately?
 
 // if it is a message, continue processing
 finished = !( aEvent.Category() == TC_MESSAGE );
 
 // there is no point in further checking, as transitions got cleared
 break;
 }
 }
 }
 
 if( finished )
 break; // only the first tool gets the event
 }
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::dispatchInternal - %s handle event: %s",
 ( handled ? "Did" : "Did not" ), aEvent.Format() );
 
 return handled;
}

References COROUTINE< ReturnType, ArgType >::Call(), TOOL_EVENT::Category(), TOOL_EVENT_LIST::clear(), TOOL_MANAGER::TOOL_STATE::cofunc, finishTool(), TOOL_EVENT::FirstResponder(), TOOL_EVENT::Format(), TOOL_BASE::GetName(), TOOL_MANAGER::TOOL_STATE::idle, TOOL_MANAGER::TOOL_STATE::initialEvent, TOOL_EVENT::IsChoiceMenu(), kicadTraceToolStack, m_activeTools, m_menuOwner, m_toolIdIndex, m_toolState, TOOL_EVENT_LIST::Matches(), TOOL_EVENT::PassEvent(), TOOL_MANAGER::TOOL_STATE::pendingWait, TOOL_MANAGER::TOOL_STATE::Push(), COROUTINE< ReturnType, ArgType >::Resume(), COROUTINE< ReturnType, ArgType >::Running(), setActiveState(), TOOL_EVENT::SetFirstResponder(), TC_MESSAGE, TOOL_MANAGER::TOOL_STATE::theTool, TOOL_MANAGER::TOOL_STATE::transitions, TOOL_MANAGER::TOOL_STATE::vcSettings, TOOL_MANAGER::TOOL_STATE::waitEvents, and TOOL_MANAGER::TOOL_STATE::wakeupEvent.

Referenced by DispatchContextMenu(), and processEvent().

FindTool() [1/2]

TOOL_BASE * TOOL_MANAGER::FindTool

(

const std::string &

aName

)

const

Search for a tool with given name.

Parameters

aName

is the name of the requested tool.

Returns

Pointer to the requested tool or NULL in case of failure.

Definition at line 554 of file tool_manager.cpp.

{
 std::map<std::string, TOOL_STATE*>::const_iterator it = m_toolNameIndex.find( aName );
 
 if( it != m_toolNameIndex.end() )
 return it->second->theTool;
 
 return nullptr;
}

References m_toolNameIndex.

FindTool() [2/2]

TOOL_BASE * TOOL_MANAGER::FindTool

(

int

aId

)

const

Search for a tool with given ID.

Parameters

aId	is the ID number of the requested tool.

Returns

Pointer to the requested tool or NULL in case of failure.

Definition at line 543 of file tool_manager.cpp.

{
 std::map<TOOL_ID, TOOL_STATE*>::const_iterator it = m_toolIdIndex.find( aId );
 
 if( it != m_toolIdIndex.end() )
 return it->second->theTool;
 
 return nullptr;
}

References m_toolIdIndex.

Referenced by GetCurrentTool(), InvokeTool(), ACTION_MANAGER::RunHotKey(), and ShutdownTool().

finishTool()

TOOL_MANAGER::ID_LIST::iterator TOOL_MANAGER::finishTool ( TOOL_STATE *  aState )

private

Deactivate a tool and does the necessary clean up.

Parameters

aState

is 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 944 of file tool_manager.cpp.

{
 auto it = std::find( m_activeTools.begin(), m_activeTools.end(), aState->theTool->GetId() );
 
 if( !aState->Pop() )
 {
 // Deactivate the tool if there are no other contexts saved on the stack
 if( it != m_activeTools.end() )
 it = m_activeTools.erase( it );
 
 aState->idle = true;
 }
 
 if( aState == m_activeState )
 setActiveState( nullptr );
 
 // Set transitions to be ready for future TOOL_EVENTs
 TOOL_BASE* tool = aState->theTool;
 
 if( tool->GetType() == INTERACTIVE )
 static_cast<TOOL_INTERACTIVE*>( tool )->resetTransitions();
 
 return it;
}

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

Referenced by dispatchInternal(), and ShutdownTool().

GetActionManager()

ACTION_MANAGER * TOOL_MANAGER::GetActionManager ( ) const

inline

Definition at line 196 of file tool_manager.h.

{ return m_actionMgr; }

References m_actionMgr.

Referenced by TOOLS_HOLDER::CommonSettingsChanged(), ACTION_TOOLBAR::doSelectAction(), TOOLS_HOLDER::PopTool(), TOOLS_HOLDER::PushTool(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand(), EDA_3D_VIEWER_FRAME::setupUIConditions(), CVPCB_MAINFRAME::setupUIConditions(), DISPLAY_FOOTPRINTS_FRAME::setupUIConditions(), SCH_EDIT_FRAME::setupUIConditions(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), GERBVIEW_FRAME::setupUIConditions(), KICAD_MANAGER_FRAME::setupUIConditions(), PL_EDITOR_FRAME::setupUIConditions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), FOOTPRINT_VIEWER_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), and TOOLS_HOLDER::ShowChangedLanguage().

GetClipboardUTF8()

std::string TOOL_MANAGER::GetClipboardUTF8

(

)

const

Return the information currently stored in the system clipboard.

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

Note

The clipboard is expected containing Unicode chars, not only ASCII7 chars. The returned string is UTF8 encoded

Definition at line 1030 of file tool_manager.cpp.

{
 std::string result;
 
 wxLogNull doNotLog; // disable logging of failed clipboard actions
 
 if( wxTheClipboard->Open() )
 {
 if( wxTheClipboard->IsSupported( wxDF_TEXT )
 || wxTheClipboard->IsSupported( wxDF_UNICODETEXT ) )
 {
 wxTextDataObject data;
 wxTheClipboard->GetData( data );
 
 // The clipboard is expected containing a Unicode string, so return it
 // as UTF8 string
 result = data.GetText().utf8_str();
 }
 
 wxTheClipboard->Close();
 }
 
 return result;
}

Referenced by SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), and PL_EDIT_TOOL::Paste().

GetCurrentTool()

TOOL_BASE * TOOL_MANAGER::GetCurrentTool ( ) const

inline

Return 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 315 of file tool_manager.h.

 {
 return FindTool( GetCurrentToolId() );
 }

References FindTool(), and GetCurrentToolId().

Referenced by PCB_GRID_HELPER::queryVisible().

GetCurrentToolId()

int TOOL_MANAGER::GetCurrentToolId ( ) const

inline

Return 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 304 of file tool_manager.h.

 {
 return m_activeTools.empty() ? -1 : m_activeTools.front();
 }

References m_activeTools.

Referenced by GetCurrentTool(), and GetCurrentToolState().

GetCurrentToolState()

TOOL_STATE * TOOL_MANAGER::GetCurrentToolState ( ) const

inline

Return the #TOOL_STATE object representing the state of the active tool.

If there are no tools active, it returns nullptr.

Definition at line 324 of file tool_manager.h.

 {
 auto it = m_toolIdIndex.find( GetCurrentToolId() );
 return ( it != m_toolIdIndex.end() ) ? it->second : nullptr;
 }

References GetCurrentToolId(), and m_toolIdIndex.

Referenced by GetCurrentToolVC(), invokeTool(), and ProcessEvent().

GetCurrentToolVC()

const KIGFX::VC_SETTINGS & TOOL_MANAGER::GetCurrentToolVC

(

)

const

Return the view controls settings for the current tool or the general settings if there is no active tool.

Definition at line 1056 of file tool_manager.cpp.

{
 if( TOOL_STATE* active = GetCurrentToolState() )
 return active->vcSettings;
 
 return m_viewControls->GetSettings();
}

References GetCurrentToolState(), KIGFX::VIEW_CONTROLS::GetSettings(), and m_viewControls.

Referenced by COMMON_TOOLS::ResetLocalCoords().

GetCursorPosition()

VECTOR2D TOOL_MANAGER::GetCursorPosition

(

)

const

Definition at line 311 of file tool_manager.cpp.

{
 if( m_viewControls )
 return m_viewControls->GetCursorPosition();
 else
 return wxGetMousePosition();
}

References KIGFX::VIEW_CONTROLS::GetCursorPosition(), and m_viewControls.

Referenced by invokeTool(), and RunAction().

GetHotKey()

int TOOL_MANAGER::GetHotKey

(

const TOOL_ACTION &

aAction

)

const

Definition at line 390 of file tool_manager.cpp.

{
 return m_actionMgr->GetHotKey( aAction );
}

References ACTION_MANAGER::GetHotKey(), and m_actionMgr.

Referenced by ACTION_MENU::updateHotKeys().

GetMenuCursorPos()

VECTOR2D TOOL_MANAGER::GetMenuCursorPos ( ) const

inline

Definition at line 442 of file tool_manager.h.

 {
 return m_menuCursor;
 }

References m_menuCursor.

Referenced by ROUTER_TOOL::InlineBreakTrack().

GetModel()

EDA_ITEM * TOOL_MANAGER::GetModel ( ) const

inline

Definition at line 292 of file tool_manager.h.

{ return m_model; }

References m_model.

Referenced by BOARD_INSPECTION_TOOL::ClearHighlight(), BOARD_COMMIT::dirtyIntersectingZones(), BOARD_COMMIT::GetBoard(), TOOL_BASE::getModelInt(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_POSITION_RELATIVE::OnUseGridOriginClick(), BOARD_COMMIT::Push(), BOARD_COMMIT::Revert(), and GROUP_CONTEXT_MENU::update().

GetMousePosition()

VECTOR2D TOOL_MANAGER::GetMousePosition

(

)

const

Definition at line 302 of file tool_manager.cpp.

{
 if( m_viewControls )
 return m_viewControls->GetMousePosition();
 else
 return wxGetMousePosition();
}

References KIGFX::VIEW_CONTROLS::GetMousePosition(), and m_viewControls.

Referenced by EE_SELECTION_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), and ACTION_MENU::OnMenuEvent().

GetPriority()

int TOOL_MANAGER::GetPriority

(

int

aToolId

)

const

Return 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

aToolId

is 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 622 of file tool_manager.cpp.

{
 int priority = 0;
 
 for( TOOL_ID tool : m_activeTools )
 {
 if( tool == aToolId )
 return priority;
 
 ++priority;
 }
 
 return -1;
}

References m_activeTools.

Referenced by ACTION_MANAGER::RunHotKey().

GetSettings()

APP_SETTINGS_BASE * TOOL_MANAGER::GetSettings ( ) const

inline

Definition at line 294 of file tool_manager.h.

{ return m_settings; }

References m_settings.

Referenced by PNS_KICAD_IFACE::DisplayItem(), COMMON_TOOLS::doZoomInOut(), COMMON_TOOLS::doZoomToPreset(), PNS_KICAD_IFACE::GetUnits(), COMMON_TOOLS::GridNext(), COMMON_TOOLS::GridPreset(), COMMON_TOOLS::GridPrev(), COMMON_TOOLS::OnGridChanged(), COMMON_TOOLS::Reset(), COMMON_TOOLS::ToggleCursor(), and COMMON_TOOLS::ToggleCursorStyle().

GetTool()

template<typename T >

T * TOOL_MANAGER::GetTool ( )

inline

Definition at line 218 of file tool_manager.h.

 {
 std::map<const char*, TOOL_BASE*>::iterator tool = m_toolTypes.find( typeid( T ).name() );
 
 if( tool != m_toolTypes.end() )
 return static_cast<T*>( tool->second );
 
 return nullptr;
 }

References m_toolTypes, and name.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), EDA_BASE_FRAME::AddStandardHelpMenu(), EDA_DRAW_FRAME::AddStandardSubMenus(), SCH_EDIT_FRAME::AnnotateSymbols(), SCH_EDITOR_CONTROL::AssignNetclass(), BOARD_EDITOR_CONTROL::AssignNetclass(), EE_SELECTION_TOOL::autostartEvent(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::CanInlineDrag(), SCH_EDIT_FRAME::CheckAnnotate(), PCB_EDIT_FRAME::CommonSettingsChanged(), PAD_TOOL::copyPadSettings(), EDA_3D_VIEWER_FRAME::CreateMenuBar(), ZONE_CREATE_HELPER::createNewZone(), EE_INSPECTION_TOOL::CrossProbe(), DRC_TOOL::CrossProbe(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), SCH_EDIT_FRAME::DeleteJunction(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), BOARD_COMMIT::dirtyIntersectingZones(), SCH_EDIT_FRAME::DisplayCurrentSheet(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_EDITOR_CONTROL::doCopy(), BOARD_EDITOR_CONTROL::doCrossProbePcbToSch(), SCH_EDITOR_CONTROL::doCrossProbeSchToPcb(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), SCH_FIELD::DoHypertextAction(), SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), DRAWING_TOOL::DrawVia(), BOARD_EDITOR_CONTROL::DrillOrigin(), EDIT_TOOL::Duplicate(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_EDIT_TOOL::editShapeProperties(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), GROUP_TOOL::EnterGroup(), SCH_NAVIGATE_TOOL::EnterSheet(), EE_INSPECTION_TOOL::ExcludeMarker(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), EDIT_TOOL::GetAndPlace(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), DISPLAY_FOOTPRINTS_FRAME::GetCurrentSelection(), SCH_EDIT_FRAME::GetCurrentSelection(), SYMBOL_EDIT_FRAME::GetCurrentSelection(), SYMBOL_VIEWER_FRAME::GetCurrentSelection(), GERBVIEW_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetCurrentSelection(), FOOTPRINT_EDIT_FRAME::GetCurrentSelection(), FOOTPRINT_VIEWER_FRAME::GetCurrentSelection(), PCB_EDIT_FRAME::GetCurrentSelection(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), DRAWING_TOOL::getSourceZoneForAction(), EDA_DRAW_FRAME::GetUnitPair(), PCB_CONTROL::GridSetOrigin(), GROUP_TOOL::Group(), SYMBOL_EDIT_FRAME::HardRedraw(), PL_EDITOR_FRAME::HardRedraw(), GERBVIEW_CONTROL::HighlightControl(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), SCH_EDITOR_CONTROL::HighlightNetCursor(), EE_TOOL_BASE< T >::Init(), SCH_EDIT_TOOL::Init(), SYMBOL_EDITOR_CONTROL::Init(), SYMBOL_EDITOR_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PL_EDIT_TOOL::Init(), PL_POINT_EDITOR::Init(), BOARD_EDITOR_CONTROL::Init(), BOARD_INSPECTION_TOOL::Init(), BOARD_REANNOTATE_TOOL::Init(), CONVERT_TOOL::Init(), EDIT_TOOL::Init(), GLOBAL_EDIT_TOOL::Init(), GROUP_TOOL::Init(), PAD_TOOL::Init(), PCB_POINT_EDITOR::Init(), ALIGN_DISTRIBUTE_TOOL::Init(), POSITION_RELATIVE_TOOL::Init(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), ARRAY_CREATOR::Invoke(), EDIT_TOOL::invokeInlineRouter(), EDIT_TOOL::isRouterActive(), SCH_EDIT_FRAME::KiwayMailIn(), GROUP_TOOL::LeaveGroup(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), EE_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), GRAPHICS_CLEANER::mergePads(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveIndividually(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), PCB_EDIT_FRAME::onBoardLoaded(), DIALOG_DRC::OnCancelClick(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_POSITION_RELATIVE::OnClear(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_DRC::OnDRCItemRClick(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), SCH_EDIT_FRAME::OnImportProject(), DIALOG_POSITION_RELATIVE::OnOkClick(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), DIALOG_POSITION_RELATIVE::OnSelectItemClick(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), SCH_EDITOR_CONTROL::Paste(), PAD_TOOL::pastePadProperties(), PCB_BASE_EDIT_FRAME::PCB_BASE_EDIT_FRAME(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), PCB_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceImage(), DIALOG_PLOT::Plot(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), PCB_EDIT_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateOptToolbar(), SYMBOL_EDIT_FRAME::ReCreateOptToolbar(), FOOTPRINT_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateOptToolbar(), PCB_EDIT_FRAME::ReCreateVToolbar(), SCH_EDITOR_CONTROL::Redo(), SYMBOL_EDITOR_EDIT_TOOL::Redo(), SCH_BASE_FRAME::RefreshZoomDependentItems(), GROUP_TOOL::RemoveFromGroup(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), BOARD_COMMIT::Revert(), PL_EDITOR_FRAME::RollbackFromUndo(), SCH_EDIT_FRAME::RollbackSchematicFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), ROUTER_TOOL::RouteSelected(), DRC_TOOL::RunTests(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), EDA_DRAW_FRAME::SaveSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), SCH_BASE_FRAME::SCH_BASE_FRAME(), SCH_EDIT_FRAME::SchematicCleanUp(), PCB_TOOL_BASE::selection(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), CVPCB_MAINFRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), SCH_EDIT_FRAME::setupUIConditions(), PCB_EDIT_FRAME::setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_EDIT_FRAME::ShowFindReplaceDialog(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), EDA_DRAW_FRAME::ToggleUserUnits(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), SCH_EDITOR_CONTROL::Undo(), SYMBOL_EDITOR_EDIT_TOOL::Undo(), GROUP_TOOL::Ungroup(), SYMBOL_UNIT_MENU::update(), BUS_UNFOLD_MENU::update(), HIGHLIGHT_MENU::update(), GROUP_CONTEXT_MENU::update(), PCB_PROPERTIES_PANEL::UpdateData(), DIALOG_DRC::updateDisplayedCounts(), SCH_EDIT_FRAME::UpdateHierarchyNavigator(), BOARD_INSPECTION_TOOL::UpdateLocalRatsnest(), EE_INSPECTION_TOOL::UpdateMessagePanel(), GERBVIEW_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), PCB_CONTROL::UpdateMessagePanel(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), PCB_PROPERTIES_PANEL::valueChanged(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneDuplicate(), and BOARD_EDITOR_CONTROL::ZoneMerge().

GetToolHolder()

TOOLS_HOLDER * TOOL_MANAGER::GetToolHolder ( ) const

inline

Definition at line 296 of file tool_manager.h.

{ return m_frame; }

References m_frame.

Referenced by TOOL_DISPATCHER::DispatchWxEvent(), ACTION_TOOLBAR::doSelectAction(), VIA_SIZE_MENU::eventHandler(), TOOL_BASE::getToolHolderInt(), highlightNet(), EDA_3D_CONTROLLER::Main(), ACTION_TOOLBAR::onPaletteEvent(), ACTION_TOOLBAR::onToolEvent(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), ACTION_TOOLBAR::popupPalette(), ProcessEvent(), processEvent(), BOARD_COMMIT::Push(), EDA_3D_CONTROLLER::Reset(), ACTION_MANAGER::RunHotKey(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand(), ACTION_MANAGER::SetConditions(), EDA_3D_CONTROLLER::SetMaterial(), EDA_3D_CONTROLLER::ToggleVisibility(), BUS_UNFOLD_MENU::update(), VIA_SIZE_MENU::update(), ACTION_MANAGER::UpdateHotKeys(), and UpdateUI().

GetView()

KIGFX::VIEW * TOOL_MANAGER::GetView ( ) const

inline

Definition at line 285 of file tool_manager.h.

{ return m_view; }

References m_view.

Referenced by EE_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestDragOrigin(), PCB_GRID_HELPER::BestSnapAnchor(), EE_GRID_HELPER::BestSnapAnchor(), GRID_HELPER::canUseGrid(), BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_GRID_HELPER::computeAnchors(), BOARD_INSPECTION_TOOL::doHideRatsnestNet(), EDIT_TOOL::doMoveSelection(), EE_GRID_HELPER::EE_GRID_HELPER(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), GRID_HELPER::GetGrid(), GRID_HELPER::GetOrigin(), TOOL_DISPATCHER::getView(), TOOL_BASE::getView(), BOARD_INSPECTION_TOOL::HighlightNet(), BOARD_INSPECTION_TOOL::highlightNet(), ROUTER_TOOL::Init(), DRAWING_TOOL::Init(), PCB_SELECTION_TOOL::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), PCB_GRID_HELPER::PCB_GRID_HELPER(), BOARD_COMMIT::Push(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), BOARD_COMMIT::Revert(), GRID_HELPER::SetAuxAxes(), PNS::TOOL_BASE::updateEndItem(), and PNS::TOOL_BASE::updateStartItem().

GetViewControls()

KIGFX::VIEW_CONTROLS * TOOL_MANAGER::GetViewControls ( ) const

inline

Definition at line 287 of file tool_manager.h.

{ return m_viewControls; }

References m_viewControls.

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

InitTools()

void TOOL_MANAGER::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 589 of file tool_manager.cpp.

{
 for( auto it = m_toolOrder.begin(); it != m_toolOrder.end(); /* iter inside */ )
 {
 TOOL_BASE* tool = *it;
 wxASSERT( m_toolState.count( tool ) );
 TOOL_STATE* state = m_toolState[tool];
 setActiveState( state );
 ++it; // keep the iterator valid if the element is going to be erased
 
 if( !tool->Init() )
 {
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER initialization of tool '%s' failed",
 tool->GetName() );
 
 // Unregister the tool
 setActiveState( nullptr );
 m_toolState.erase( tool );
 m_toolNameIndex.erase( tool->GetName() );
 m_toolIdIndex.erase( tool->GetId() );
 m_toolTypes.erase( typeid( *tool ).name() );
 
 delete state;
 delete tool;
 }
 }
 
 m_actionMgr->UpdateHotKeys( true );
 
 ResetTools( TOOL_BASE::RUN );
}

References TOOL_BASE::GetId(), TOOL_BASE::GetName(), TOOL_BASE::Init(), kicadTraceToolStack, m_actionMgr, m_toolIdIndex, m_toolNameIndex, m_toolOrder, m_toolState, m_toolTypes, ResetTools(), TOOL_BASE::RUN, setActiveState(), and ACTION_MANAGER::UpdateHotKeys().

Referenced by PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), and PCB_EDIT_FRAME::setupTools().

InvokeTool() [1/2]

bool TOOL_MANAGER::InvokeTool

(

const std::string &

aToolName

)

Call a tool by sending a tool activation event to tool of given name.

Parameters

aToolName

is the name of the requested tool.

Returns

True if the requested tool was invoked successfully.

Definition at line 272 of file tool_manager.cpp.

{
 TOOL_BASE* tool = FindTool( aToolName );
 
 if( tool && tool->GetType() == INTERACTIVE )
 return invokeTool( tool );
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::InvokeTool - no tool with name %s",
 aToolName );
 
 return false; // there is no tool with the given name
}

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

invokeTool()

bool TOOL_MANAGER::invokeTool ( TOOL_BASE *  aTool )

private

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

Parameters

aTool

is the tool to be invoked.

Definition at line 396 of file tool_manager.cpp.

{
 wxASSERT( aTool != nullptr );
 
 TOOL_EVENT evt( TC_COMMAND, TA_ACTIVATE, aTool->GetName() );
 evt.SetMousePosition( GetCursorPosition() );
 processEvent( evt );
 
 if( TOOL_STATE* active = GetCurrentToolState() )
 setActiveState( active );
 
 return true;
}

References GetCurrentToolState(), GetCursorPosition(), TOOL_BASE::GetName(), processEvent(), setActiveState(), TOOL_EVENT::SetMousePosition(), TA_ACTIVATE, and TC_COMMAND.

Referenced by InvokeTool().

InvokeTool() [2/2]

bool TOOL_MANAGER::InvokeTool

(

TOOL_ID

aToolId

)

Call a tool by sending a tool activation event to tool of given ID.

Parameters

aToolId

is the ID number of the requested tool.

Returns

True if the requested tool was invoked successfully.

Definition at line 258 of file tool_manager.cpp.

{
 TOOL_BASE* tool = FindTool( aToolId );
 
 if( tool && tool->GetType() == INTERACTIVE )
 return invokeTool( tool );
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::InvokeTool - no tool with ID %d",
 aToolId );
 
 return false; // there is no tool with the given id
}

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

Referenced by TOOL_INTERACTIVE::Activate(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), EE_SELECTION_TOOL::Main(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), and PCB_EDIT_FRAME::setupTools().

isActive()

bool TOOL_MANAGER::isActive ( TOOL_BASE *  aTool ) const

private

Return information about a tool activation status.

Parameters

aTool

is the tool to be checked.

Returns

True if the tool is on the active tools stack, false otherwise.

Definition at line 1085 of file tool_manager.cpp.

{
 if( !isRegistered( aTool ) )
 return false;
 
 // Just check if the tool is on the active tools stack
 return alg::contains( m_activeTools, aTool->GetId() );
}

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

Referenced by runTool(), and ShutdownTool().

IsContextMenuActive()

bool TOOL_MANAGER::IsContextMenuActive ( ) const

inline

True while processing a context menu.

Definition at line 413 of file tool_manager.h.

 {
 return m_menuActive;
 }

References m_menuActive.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), and ROUTER_TOOL::InlineBreakTrack().

isRegistered()

bool TOOL_MANAGER::isRegistered ( TOOL_BASE *  aTool ) const

inlineprivate

Return information about a tool registration status.

Parameters

aTool

is the tool to be checked.

Returns

true if the tool is in the registered tools list, false otherwise.

Definition at line 497 of file tool_manager.h.

 {
 return m_toolState.count( aTool ) > 0;
 }

References m_toolState.

Referenced by isActive(), and runTool().

IsToolActive()

bool TOOL_MANAGER::IsToolActive

(

TOOL_ID

aId

)

const

Return true if a tool with given id is active (executing)

Definition at line 1200 of file tool_manager.cpp.

{
 auto it = m_toolIdIndex.find( aId );
 return !it->second->idle;
}

References m_toolIdIndex.

Referenced by TOOL_BASE::IsToolActive().

MakeToolId()

TOOL_ID TOOL_MANAGER::MakeToolId ( const std::string &  aToolName )

static

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

Definition at line 1065 of file tool_manager.cpp.

{
 static int currentId;
 
 return currentId++;
}

PostEvent()

void TOOL_MANAGER::PostEvent

(

const TOOL_EVENT &

aEvent

)

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

Parameters

aEvent

is the event to be put into the queue.

Definition at line 379 of file tool_manager.cpp.

{
 // Horrific hack, but it's a crash bug. Don't let inter-frame commands stack up
 // waiting to be processed.
 if( aEvent.IsSimulator() && m_eventQueue.size() > 0 && m_eventQueue.back().IsSimulator() )
 m_eventQueue.pop_back();
 
 m_eventQueue.push_back( aEvent );
}

References TOOL_EVENT::IsSimulator(), and m_eventQueue.

Referenced by SCH_EDIT_FRAME::AddJunction(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::AutoplaceFields(), EDIT_TOOL::doMoveSelection(), SCH_EDIT_TOOL::editFieldText(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), GROUP_TOOL::Group(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), TOOLS_HOLDER::PopTool(), PrimeTool(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), GROUP_TOOL::RemoveFromGroup(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), RunAction(), PCB_BASE_EDIT_FRAME::ShowBitmapPropertiesDialog(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), GROUP_TOOL::Ungroup(), and PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

PrimeTool()

void TOOL_MANAGER::PrimeTool

(

const VECTOR2D &

aPosition

)

"Prime" a tool by sending a cursor left-click event with the mouse position set to the passed in position.

Parameters

aPosition	is the mouse position to use in the event Return the hot key associated with a given action or 0 if there is none.
aAction	is the queried action.

Definition at line 359 of file tool_manager.cpp.

{
 int modifiers = 0;
 
 /*
 * Don't include any modifiers. They're part of the hotkey, not part of the resulting
 * click.
 *
 * modifiers |= wxGetKeyState( WXK_SHIFT ) ? MD_SHIFT : 0;
 * modifiers |= wxGetKeyState( WXK_CONTROL ) ? MD_CTRL : 0;
 * modifiers |= wxGetKeyState( WXK_ALT ) ? MD_ALT : 0;
 */
 
 TOOL_EVENT evt( TC_MOUSE, TA_PRIME, BUT_LEFT | modifiers );
 evt.SetMousePosition( aPosition );
 
 PostEvent( evt );
}

References BUT_LEFT, PostEvent(), TOOL_EVENT::SetMousePosition(), TA_PRIME, and TC_MOUSE.

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawZone(), DRAWING_TOOL::InteractivePlaceWithPreview(), ROUTER_TOOL::MainLoop(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

ProcessEvent()

bool TOOL_MANAGER::ProcessEvent

(

const TOOL_EVENT &

aEvent

)

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

Parameters

aEvent

is the event to be processed.

Returns

true if the event is a managed hotkey

Definition at line 970 of file tool_manager.cpp.

{
 // Once the tool manager is shutting down, don't start
 // activating more tools
 if( m_shuttingDown )
 return true;
 
 bool handled = processEvent( aEvent );
 
 TOOL_STATE* activeTool = GetCurrentToolState();
 
 if( activeTool )
 setActiveState( activeTool );
 
 if( m_view && m_view->IsDirty() )
 {
 if( GetToolHolder() )
 GetToolHolder()->RefreshCanvas();
 
#if defined( __WXMAC__ )
 wxTheApp->ProcessPendingEvents(); // required for updating brightening behind a popup menu
#endif
 }
 
 UpdateUI( aEvent );
 
 return handled;
}

References GetCurrentToolState(), GetToolHolder(), KIGFX::VIEW::IsDirty(), m_shuttingDown, m_view, processEvent(), TOOLS_HOLDER::RefreshCanvas(), setActiveState(), and UpdateUI().

Referenced by SELECTION_TOOL::AddItemsToSel(), SELECTION_TOOL::AddItemToSel(), EDIT_TOOL::ChangeTrackWidth(), GERBVIEW_SELECTION_TOOL::clearSelection(), PL_SELECTION_TOOL::ClearSelection(), EE_SELECTION_TOOL::ClearSelection(), PCB_SELECTION_TOOL::ClearSelection(), PANEL_KICAD_LAUNCHER::CreateLaunchers(), COMMON_TOOLS::CursorControl(), TOOL_DISPATCHER::DispatchWxEvent(), PCB_TOOL_BASE::doInteractiveItemPlacement(), PCB_SELECTION_TOOL::doSyncSelection(), PCB_SELECTION_TOOL::expandConnection(), PCB_SELECTION_TOOL::filterSelection(), PCB_SELECTION_TOOL::FindItem(), EDIT_TOOL::Flip(), TOOL_DISPATCHER::handleMouseButton(), EE_SELECTION_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PCB_SELECTION_TOOL::Main(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SELECTION_TOOL::onDisambiguationExpire(), ACTION_MENU::OnMenuEvent(), ACTION_TOOLBAR::onPaletteEvent(), ACTION_TOOLBAR::onToolEvent(), PAD_TOOL::pastePadProperties(), PCB_CONTROL::placeBoardItems(), EDIT_TOOL::Properties(), PAD_TOOL::pushPadSettings(), EE_SELECTION_TOOL::RebuildSelection(), SCH_EDITOR_CONTROL::Redo(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), SELECTION_TOOL::RemoveItemFromSel(), SELECTION_TOOL::RemoveItemsFromSel(), EE_SELECTION_TOOL::RequestSelection(), PCB_BASE_EDIT_FRAME::RestoreCopyFromRedoList(), PCB_BASE_EDIT_FRAME::RestoreCopyFromUndoList(), EDIT_TOOL::Rotate(), EE_SELECTION_TOOL::SelectConnection(), COMMON_TOOLS::SelectionTool(), GERBVIEW_SELECTION_TOOL::SelectItem(), GERBVIEW_SELECTION_TOOL::SelectItems(), EE_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectNet(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectSheetContents(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EE_SELECTION_TOOL::SyncSelection(), SCH_EDITOR_CONTROL::Undo(), GERBVIEW_SELECTION_TOOL::UnselectItem(), GERBVIEW_SELECTION_TOOL::UnselectItems(), and EDA_DRAW_FRAME::UpdateMsgPanel().

processEvent()

bool TOOL_MANAGER::processEvent ( const TOOL_EVENT &  aEvent )

private

Main function for event processing.

Returns

true if a hotkey was handled.

Definition at line 1141 of file tool_manager.cpp.

{
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::processEvent - %s", aEvent.Format() );
 
 // First try to dispatch the action associated with the event if it is a key press event
 bool handled = DispatchHotKey( aEvent );
 
 if( !handled )
 {
 TOOL_EVENT mod_event( aEvent );
 
 // Only immediate actions get the position. Otherwise clear for tool activation
 if( GetToolHolder() && !GetToolHolder()->GetDoImmediateActions() )
 {
 // An tool-selection-event has no position
 if( !mod_event.getCommandStr().empty()
 && mod_event.getCommandStr() != GetToolHolder()->CurrentToolName()
 && !mod_event.ForceImmediate() )
 {
 mod_event.SetHasPosition( false );
 }
 }
 
 // If the event is not handled through a hotkey activation, pass it to the currently
 // running tool loops
 handled |= dispatchInternal( mod_event );
 handled |= dispatchActivation( mod_event );
 
 // Open the context menu if requested by a tool
 DispatchContextMenu( mod_event );
 
 // Dispatch any remaining events in the event queue
 while( !m_eventQueue.empty() )
 {
 TOOL_EVENT event = m_eventQueue.front();
 m_eventQueue.pop_front();
 processEvent( event );
 }
 }
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::processEvent - %s handle event: %s",
 ( handled ? "Did" : "Did not" ), aEvent.Format() );
 
 return handled;
}

References dispatchActivation(), DispatchContextMenu(), DispatchHotKey(), dispatchInternal(), TOOL_EVENT::ForceImmediate(), TOOL_EVENT::Format(), TOOL_EVENT::getCommandStr(), GetToolHolder(), kicadTraceToolStack, m_eventQueue, processEvent(), and TOOL_EVENT::SetHasPosition().

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

RegisterTool()

void TOOL_MANAGER::RegisterTool

(

TOOL_BASE *

aTool

)

Add a tool to the manager set and sets it up.

Called once for each tool during application initialization.

Parameters

aTool

tool to be added. Ownership is transferred.

Definition at line 236 of file tool_manager.cpp.

{
 wxASSERT_MSG( m_toolNameIndex.find( aTool->GetName() ) == m_toolNameIndex.end(),
 wxT( "Adding two tools with the same name may result in unexpected behavior.") );
 wxASSERT_MSG( m_toolIdIndex.find( aTool->GetId() ) == m_toolIdIndex.end(),
 wxT( "Adding two tools with the same ID may result in unexpected behavior.") );
 wxASSERT_MSG( m_toolTypes.find( typeid( *aTool ).name() ) == m_toolTypes.end(),
 wxT( "Adding two tools of the same type may result in unexpected behavior.") );
 
 m_toolOrder.push_back( aTool );
 
 TOOL_STATE* st = new TOOL_STATE( aTool );
 
 m_toolState[aTool] = st;
 m_toolNameIndex[aTool->GetName()] = st;
 m_toolIdIndex[aTool->GetId()] = st;
 m_toolTypes[typeid( *aTool ).name()] = st->theTool;
 
 aTool->attachManager( this );
}

References TOOL_BASE::attachManager(), TOOL_BASE::GetId(), TOOL_BASE::GetName(), m_toolIdIndex, m_toolNameIndex, m_toolOrder, m_toolState, m_toolTypes, and TOOL_MANAGER::TOOL_STATE::theTool.

Referenced by PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), and PCB_EDIT_FRAME::setupTools().

ResetTools()

void TOOL_MANAGER::ResetTools

(

TOOL_BASE::RESET_REASON

aReason

)

Reset all tools (i.e.

calls their Reset() method).

Definition at line 573 of file tool_manager.cpp.

{
 DeactivateTool();
 
 for( auto& state : m_toolState )
 {
 TOOL_BASE* tool = state.first;
 setActiveState( state.second );
 tool->Reset( aReason );
 
 if( tool->GetType() == INTERACTIVE )
 static_cast<TOOL_INTERACTIVE*>( tool )->resetTransitions();
 }
}

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::Clear_DrawLayers(), FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList(), GERBVIEW_FRAME::Erase_Current_DrawLayer(), InitTools(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), SYMBOL_EDIT_FRAME::OnSelectUnit(), Refresh(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), PCB_BASE_EDIT_FRAME::SetBoard(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), FOOTPRINT_VIEWER_FRAME::updateView(), and FOOTPRINT_WIZARD_FRAME::updateView().

RunAction() [1/6]

bool TOOL_MANAGER::RunAction	(	const std::string &	aActionName,
		bool	aNow,
		void *	aParam
	)

Definition at line 286 of file tool_manager.cpp.

{
 TOOL_ACTION* action = m_actionMgr->FindAction( aActionName );
 
 if( !action )
 {
 wxASSERT_MSG( false, wxString::Format( "Could not find action %s.", aActionName ) );
 return false;
 }
 
 RunAction( *action, aNow, aParam );
 
 return false;
}

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

RunAction() [2/6]

bool TOOL_MANAGER::RunAction ( const std::string &  aActionName, bool  aNow = false  )

inline

Definition at line 149 of file tool_manager.h.

 {
 return RunAction( aActionName, aNow, (void*) NULL );
 }

References RunAction().

RunAction() [3/6]

template<typename T >

bool TOOL_MANAGER::RunAction ( const std::string &  aActionName, bool  aNow = false, T  aParam = NULL  )

inline

Run the specified action.

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

Parameters

aActionName	is the name of action to be invoked.
aNow	decides if the action has to be run immediately or after the current coroutine is preemptied.
aParam	is 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 142 of file tool_manager.h.

 {
 return RunAction( aActionName, aNow, reinterpret_cast<void*>( aParam ) );
 }

References RunAction().

Referenced by PROJECT_TREE_ITEM::Activate(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_MOVE_TOOL::AlignElements(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_EDITOR_CONTROL::AssignNetclass(), CVPCB_ASSOCIATION_TOOL::Associate(), SCH_EDIT_TOOL::AutoplaceFields(), SCH_NAVIGATE_TOOL::Back(), SCH_EDIT_TOOL::BreakWire(), SCH_EDIT_FRAME::canCloseWindow(), ROUTER_TOOL::CanInlineDrag(), SCH_EDITOR_CONTROL::ChangeLineMode(), SCH_NAVIGATE_TOOL::changeSheet(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::ChangeTrackWidth(), SCH_EDIT_TOOL::CleanupSheetPins(), GERBVIEW_CONTROL::ClearAllLayers(), PCB_SELECTION_TOOL::ClearSelection(), ZONE_CREATE_HELPER::commitZone(), EDA_DRAW_FRAME::CommonSettingsChanged(), SCH_EDIT_TOOL::ConvertDeMorgan(), SCH_EDIT_FRAME::ConvertPart(), MICROWAVE_TOOL::createInductorBetween(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), COMMON_TOOLS::CursorControl(), SCH_EDITOR_CONTROL::Cut(), SYMBOL_VIEWER_FRAME::DClickOnSymbolList(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), SCH_EDIT_TOOL::DeleteItemCursor(), SYMBOL_EDITOR_EDIT_TOOL::DeleteItemCursor(), PL_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), SCH_EDIT_FRAME::DisplayCurrentSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), SCH_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), EDA_BASE_FRAME::DoWithAcceptedFiles(), GERBVIEW_FRAME::DoWithAcceptedFiles(), KICAD_MANAGER_FRAME::DoWithAcceptedFiles(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawCircle(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawRectangle(), SCH_LINE_WIRE_BUS_TOOL::DrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), DRAWING_TOOL::drawShape(), SCH_DRAWING_TOOLS::DrawSheet(), BOARD_EDITOR_CONTROL::DrillOrigin(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::EditField(), BOARD_EDITOR_CONTROL::EditFpInFpEditor(), PAD_TOOL::EditPad(), SYMBOL_EDITOR_EDIT_TOOL::editSymbolProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), SYMBOL_EDIT_FRAME::emptyScreen(), PAD_TOOL::EnumeratePads(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PAD_TOOL::explodePad(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), SCH_EDIT_FRAME::FixupJunctions(), EDIT_TOOL::Flip(), SCH_NAVIGATE_TOOL::Forward(), GERBVIEW_FRAME::GERBVIEW_FRAME(), EDIT_TOOL::GetAndPlace(), DRAWING_TOOL::getSourceZoneForAction(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), PCB_SELECTION_TOOL::grabUnconnected(), PCB_CONTROL::GridSetOrigin(), BOARD_INSPECTION_TOOL::HighlightItem(), SCH_EDITOR_CONTROL::HighlightNetCursor(), PL_EDIT_TOOL::ImportDrawingSheetContent(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SCH_EDIT_FRAME::initScreenZoom(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), ARRAY_CREATOR::Invoke(), EDIT_TOOL::invokeInlineRouter(), SCH_EDIT_FRAME::KiwayMailIn(), PCB_EDIT_FRAME::KiwayMailIn(), SYMBOL_EDIT_FRAME::LoadOneLibrarySymbolAux(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), CVPCB_CONTROL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), GERBVIEW_SELECTION_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Main(), LENGTH_TUNER_TOOL::MainLoop(), ROUTER_TOOL::MainLoop(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), EDIT_TOOL::Mirror(), BOARD_EDITOR_CONTROL::modifyLockSelected(), EDIT_TOOL::MoveExact(), SCH_EDITOR_CONTROL::NextLineMode(), DIALOG_GROUP_PROPERTIES::OnAddMember(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ERC::OnDeleteOneClick(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), SYMBOL_EDITOR_CONTROL::OnDeMorgan(), DIALOG_DRC::OnDRCItemSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), SCH_EDIT_FRAME::OnFindDialogClose(), ZONE_CREATE_HELPER::OnFirstPoint(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), ACTION_MENU::OnMenuEvent(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PCB_EDIT_FRAME::OnNetlistChanged(), PL_EDITOR_FRAME::OnNewDrawingSheet(), KICAD_MANAGER_FRAME::OnOpenFileInTextEditor(), GERBER_LAYER_WIDGET::onPopupSelection(), SIM_PLOT_FRAME::onProbe(), EDA_DRAW_FRAME::OnSelectGrid(), DIALOG_POSITION_RELATIVE::OnSelectItemClick(), HIERARCHY_NAVIG_PANEL::onSelectSheetPath(), SYMBOL_EDIT_FRAME::OnSelectUnit(), EDA_DRAW_FRAME::OnSelectZoom(), SCH_EDIT_FRAME::onSize(), PCB_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), SIM_PLOT_FRAME::onTune(), SCH_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PL_EDIT_TOOL::Paste(), ROUTER_TOOL::performDragging(), ROUTER_TOOL::performRouting(), DIALOG_UPDATE_PCB::PerformUpdate(), ZONE_CREATE_HELPER::performZoneCutout(), GROUP_TOOL::PickNewMember(), EDIT_TOOL::pickReferencePoint(), SYMBOL_EDITOR_EDIT_TOOL::PinTable(), PCB_CONTROL::placeBoardItems(), BOARD_EDITOR_CONTROL::PlaceFootprint(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), DRAWING_TOOL::PlaceImportedGraphics(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), DRAWING_TOOL::PlaceText(), GERBVIEW_CONTROL::Print(), PCB_CONTROL::Print(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), PAD_TOOL::RecombinePad(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), EDIT_TOOL::Remove(), PCB_POINT_EDITOR::removeCorner(), GROUP_TOOL::RemoveFromGroup(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_DRAWING_TOOLS::RepeatDrawItem(), PCB_SELECTION_TOOL::RequestSelection(), PAD_TOOL::Reset(), SCH_EDITOR_CONTROL::Revert(), PL_EDITOR_FRAME::RollbackFromUndo(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), EDIT_TOOL::Rotate(), ROUTER_TOOL::RouteSelected(), RunAction(), ACTION_MANAGER::RunHotKey(), FOOTPRINT_EDIT_FRAME::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SYMBOL_EDIT_FRAME::saveLibrary(), DIALOG_FIND::search(), FOOTPRINT_SEARCH_HANDLER::SelectItems(), ZONE_SEARCH_HANDLER::SelectItems(), TEXT_SEARCH_HANDLER::SelectItems(), EE_SELECTION_TOOL::selectPoint(), POSITION_RELATIVE_TOOL::SelectPositionRelativeItem(), NL_3D_VIEWER_PLUGIN_IMPL::SetActiveCommand(), NL_SCHEMATIC_PLUGIN_IMPL::SetActiveCommand(), NL_PCBNEW_PLUGIN_IMPL::SetActiveCommand(), GERBVIEW_FRAME::SetActiveLayer(), FOOTPRINT_EDIT_FRAME::SetActiveLayer(), PCB_EDIT_FRAME::SetActiveLayer(), DRAWING_TOOL::SetAnchor(), SYMBOL_EDIT_FRAME::SetCurSymbol(), SCH_EDIT_FRAME::SetScreen(), CVPCB_MAINFRAME::setupEventHandlers(), SCH_EDIT_FRAME::setupTools(), EDA_DRAW_FRAME::setupUnits(), DRC_TOOL::ShowDRCDialog(), APPEARANCE_CONTROLS::showNetclass(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_EDIT_TOOL::Swap(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), BOARD_EDITOR_CONTROL::TrackWidthDec(), BOARD_EDITOR_CONTROL::TrackWidthInc(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), GROUP_TOOL::Ungroup(), EDA_DRAW_FRAME::unitsChangeRefresh(), PCB_SELECTION_TOOL::unrouteSelected(), CVPCB_MAINFRAME::updateFootprintViewerOnIdle(), NET_GRID_TABLE::updateNetVisibility(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_VIEWER_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), BOARD_EDITOR_CONTROL::ViaSizeDec(), BOARD_EDITOR_CONTROL::ViaSizeInc(), BOARD_EDITOR_CONTROL::ZoneMerge(), EDA_DRAW_FRAME::Zoom_Automatique(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

RunAction() [4/6]

bool TOOL_MANAGER::RunAction	(	const TOOL_ACTION &	aAction,
		bool	aNow,
		void *	aParam
	)

Definition at line 320 of file tool_manager.cpp.

{
 if( m_shuttingDown )
 return true;
 
 bool handled = false;
 TOOL_EVENT event = aAction.MakeEvent();
 
 if( event.Category() == TC_COMMAND )
 event.SetMousePosition( GetCursorPosition() );
 
 // Allow to override the action parameter
 if( aParam )
 event.SetParameter( aParam );
 
 if( aNow )
 {
 TOOL_STATE* current = m_activeState;
 handled = processEvent( event );
 setActiveState( current );
 UpdateUI( event );
 }
 else
 {
 PostEvent( event );
 }
 
 return handled;
}

References GetCursorPosition(), m_activeState, m_shuttingDown, TOOL_ACTION::MakeEvent(), PostEvent(), processEvent(), setActiveState(), TOOL_EVENT::SetMousePosition(), TC_COMMAND, and UpdateUI().

RunAction() [5/6]

bool TOOL_MANAGER::RunAction ( const TOOL_ACTION &  aAction, bool  aNow = false  )

inline

Definition at line 175 of file tool_manager.h.

 {
 return RunAction( aAction, aNow, (void*) NULL );
 }

References RunAction().

RunAction() [6/6]

template<typename T >

bool TOOL_MANAGER::RunAction ( const TOOL_ACTION &  aAction, bool  aNow = false, T  aParam = NULL  )

inline

Run the specified action.

This function will only return if the action has been handled when the action is run immediately (aNow = true), otherwise it will always return false.

Parameters

aAction	is the action to be invoked.
aNow	decides if the action has to be run immediately or after the current coroutine is preemptied.
aParam	is an optional parameter that might be used by the invoked action. Its meaning depends on the action.

Returns

True if the action was handled immediately

Definition at line 168 of file tool_manager.h.

 {
 return RunAction( aAction, aNow, reinterpret_cast<void*>( aParam ) );
 }

References RunAction().

RunMainStack()

void TOOL_MANAGER::RunMainStack	(	TOOL_BASE *	aTool,
		std::function< void()>	aFunc
	)

Definition at line 653 of file tool_manager.cpp.

{
 TOOL_STATE* st = m_toolState[aTool];
 setActiveState( st );
 st->cofunc->RunMainStack( std::move( aFunc ) );
}

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

Referenced by TOOL_INTERACTIVE::RunMainStack().

runTool()

bool TOOL_MANAGER::runTool ( TOOL_BASE *  aTool )

private

Make a tool active, so it can receive events and react to them.

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

Parameters

aTool

is the tool to be run.

Definition at line 411 of file tool_manager.cpp.

{
 wxASSERT( aTool != nullptr );
 
 if( !isRegistered( aTool ) )
 {
 wxASSERT_MSG( false, wxT( "You cannot run unregistered tools" ) );
 return false;
 }
 
 TOOL_ID id = aTool->GetId();
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::runTool - running tool %s",
 aTool->GetName() );
 
 if( aTool->GetType() == INTERACTIVE )
 static_cast<TOOL_INTERACTIVE*>( aTool )->resetTransitions();
 
 // If the tool is already active, bring it to the top of the active tools stack
 if( isActive( aTool ) && m_activeTools.size() > 1 )
 {
 auto it = std::find( m_activeTools.begin(), m_activeTools.end(), id );
 
 if( it != m_activeTools.end() )
 {
 if( it != m_activeTools.begin() )
 {
 m_activeTools.erase( it );
 m_activeTools.push_front( id );
 }
 
 return false;
 }
 }
 
 setActiveState( m_toolIdIndex[id] );
 aTool->Reset( TOOL_INTERACTIVE::RUN );
 
 // Add the tool on the front of the processing queue (it gets events first)
 m_activeTools.push_front( id );
 
 return true;
}

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

Referenced by dispatchActivation().

SaveClipboard()

bool TOOL_MANAGER::SaveClipboard

(

const std::string &

aTextUTF8

)

Store information to the system clipboard.

Parameters

aText

is the information to be stored, expected UTF8 encoding. The text will be stored as Unicode string (not stored as UTF8 string).

Returns

False if error occurred.

Definition at line 1010 of file tool_manager.cpp.

{
 wxLogNull doNotLog; // disable logging of failed clipboard actions
 
 if( wxTheClipboard->Open() )
 {
 // Store the UTF8 string as Unicode string in clipboard:
 wxTheClipboard->SetData( new wxTextDataObject( wxString( aTextUTF8.c_str(),
 wxConvUTF8 ) ) );
 
 wxTheClipboard->Flush(); // Allow data to be available after closing KiCad
 wxTheClipboard->Close();
 
 return true;
 }
 
 return false;
}

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Copy(), PL_EDIT_TOOL::Copy(), and SCH_EDITOR_CONTROL::doCopy().

saveViewControls()

void TOOL_MANAGER::saveViewControls ( TOOL_STATE *  aState )

private

Save 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 1095 of file tool_manager.cpp.

{
 aState->vcSettings = m_viewControls->GetSettings();
 
 if( m_menuActive )
 {
 // Context menu is active, so the cursor settings are overridden (see DispatchContextMenu())
 auto it = m_cursorSettings.find( aState->theTool->GetId() );
 
 if( it != m_cursorSettings.end() )
 {
 const KIGFX::VC_SETTINGS& curr = m_viewControls->GetSettings();
 
 // Tool has overridden the cursor position, so store the new settings
 if( !curr.m_forceCursorPosition || curr.m_forcedPosition != m_menuCursor )
 {
 if( !curr.m_forceCursorPosition )
 it->second = std::nullopt;
 else
 it->second = curr.m_forcedPosition;
 }
 else
 {
 std::optional<VECTOR2D> cursor = it->second;
 
 if( cursor )
 {
 aState->vcSettings.m_forceCursorPosition = true;
 aState->vcSettings.m_forcedPosition = *cursor;
 }
 else
 {
 aState->vcSettings.m_forceCursorPosition = false;
 }
 }
 }
 }
}

References cursor, TOOL_BASE::GetId(), KIGFX::VIEW_CONTROLS::GetSettings(), m_cursorSettings, KIGFX::VC_SETTINGS::m_forceCursorPosition, KIGFX::VC_SETTINGS::m_forcedPosition, m_menuActive, m_menuCursor, m_viewControls, TOOL_MANAGER::TOOL_STATE::theTool, and TOOL_MANAGER::TOOL_STATE::vcSettings.

Referenced by setActiveState().

ScheduleContextMenu()

void TOOL_MANAGER::ScheduleContextMenu	(	TOOL_BASE *	aTool,
		ACTION_MENU *	aMenu,
		CONTEXT_MENU_TRIGGER	aTrigger
	)

Set behavior of the tool's context popup menu.

Parameters

aTool	is the parent tool.
aMenu	is the menu structure, defined by the tool.
aTrigger	determines 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 1000 of file tool_manager.cpp.

{
 TOOL_STATE* st = m_toolState[aTool];
 
 st->contextMenu = aMenu;
 st->contextMenuTrigger = aTrigger;
}

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

Referenced by TOOL_INTERACTIVE::SetContextMenu().

ScheduleNextState()

void TOOL_MANAGER::ScheduleNextState	(	TOOL_BASE *	aTool,
		TOOL_STATE_FUNC &	aHandler,
		const TOOL_EVENT_LIST &	aConditions
	)

Define 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 638 of file tool_manager.cpp.

{
 TOOL_STATE* st = m_toolState[aTool];
 
 st->transitions.emplace_back( TRANSITION( aConditions, aHandler ) );
}

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

Referenced by TOOL_INTERACTIVE::goInternal().

ScheduleWait()

TOOL_EVENT * TOOL_MANAGER::ScheduleWait	(	TOOL_BASE *	aTool,
		const TOOL_EVENT_LIST &	aConditions
	)

Pause 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 661 of file tool_manager.cpp.

{
 TOOL_STATE* st = m_toolState[aTool];
 
 wxASSERT( !st->pendingWait ); // everything collapses on two KiYield() in a row
 
 // indicate to the manager that we are going to sleep and we shall be
 // woken up when an event matching aConditions arrive
 st->pendingWait = true;
 st->waitEvents = aConditions;
 
 // switch context back to event dispatcher loop
 st->cofunc->KiYield();
 
 // If the tool should shutdown, it gets a null event to break the loop
 if( st->shutdown )
 return nullptr;
 else
 return &st->wakeupEvent;
}

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

Referenced by TOOL_INTERACTIVE::Wait().

setActiveState()

void TOOL_MANAGER::setActiveState ( TOOL_STATE *  aState )

private

Save the previous active state and sets a new one.

Parameters

aState

is the new active state. Might be null to indicate there is no new active state. List of tools in the order they were registered

Definition at line 1188 of file tool_manager.cpp.

{
 if( m_activeState && m_viewControls )
 saveViewControls( m_activeState );
 
 m_activeState = aState;
 
 if( m_activeState && m_viewControls )
 applyViewControls( aState );
}

References applyViewControls(), m_activeState, m_viewControls, and saveViewControls().

Referenced by dispatchInternal(), finishTool(), InitTools(), invokeTool(), ProcessEvent(), ResetTools(), RunAction(), RunMainStack(), runTool(), and ShutdownTool().

SetEnvironment()

void TOOL_MANAGER::SetEnvironment	(	EDA_ITEM *	aModel,
		KIGFX::VIEW *	aView,
		KIGFX::VIEW_CONTROLS *	aViewControls,
		APP_SETTINGS_BASE *	aSettings,
		TOOLS_HOLDER *	aFrame
	)

Set the work environment (model, view, view controls and the parent window).

These are made available to the tool. Called by the parent frame when it is set up.

Definition at line 1073 of file tool_manager.cpp.

{
 m_model = aModel;
 m_view = aView;
 m_viewControls = aViewControls;
 m_frame = aFrame;
 m_settings = aSettings;
}

References m_frame, m_model, m_settings, m_view, and m_viewControls.

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), BOOST_FIXTURE_TEST_CASE(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), EVT_GRID_CMD_CELL_CHANGED(), EVT_TOOL_RANGE(), KI_TEST::FillZones(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::SetBoard(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SYMBOL_EDIT_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), KICAD_MANAGER_FRAME::setupTools(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), and PCB_EDIT_FRAME::setupTools().

ShutdownAllTools()

void TOOL_MANAGER::ShutdownAllTools

(

)

Shutdown all tools with a currently registered event loop in this tool manager by waking them up with a null event.

Definition at line 456 of file tool_manager.cpp.

{
 m_shuttingDown = true;
 
 // Create a temporary list of tools to iterate over since when the tools shutdown
 // they remove themselves from the list automatically (invalidating the iterator)
 ID_LIST tmpList = m_activeTools;
 
 // Make sure each tool knows that it is shutting down, so that loops get shut down
 // at the dispatcher
 for( auto id : tmpList )
 {
 if( m_toolIdIndex.count( id ) == 0 )
 continue;
 
 m_toolIdIndex[id]->shutdown = true;
 }
 
 for( auto id : tmpList )
 {
 ShutdownTool( id );
 }
}

References m_activeTools, m_shuttingDown, m_toolIdIndex, and ShutdownTool().

Referenced by SCH_EDIT_FRAME::doCloseWindow(), CVPCB_MAINFRAME::~CVPCB_MAINFRAME(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), FOOTPRINT_EDIT_FRAME::~FOOTPRINT_EDIT_FRAME(), FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::~GERBVIEW_FRAME(), KICAD_MANAGER_FRAME::~KICAD_MANAGER_FRAME(), PCB_EDIT_FRAME::~PCB_EDIT_FRAME(), PL_EDITOR_FRAME::~PL_EDITOR_FRAME(), SCH_EDIT_FRAME::~SCH_EDIT_FRAME(), SYMBOL_EDIT_FRAME::~SYMBOL_EDIT_FRAME(), and SYMBOL_VIEWER_FRAME::~SYMBOL_VIEWER_FRAME().

ShutdownTool() [1/3]

void TOOL_MANAGER::ShutdownTool

(

const std::string &

aToolName

)

Shutdown the specified tool by waking it up with a null event to terminate the processing loop.

Parameters

aToolName

is name of the tool to shutdown

Definition at line 493 of file tool_manager.cpp.

{
 TOOL_BASE* tool = FindTool( aToolName );
 
 if( tool && tool->GetType() == INTERACTIVE )
 ShutdownTool( tool );
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::ShutdownTool - no tool with name %s",
 aToolName );
}

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

ShutdownTool() [2/3]

void TOOL_MANAGER::ShutdownTool

(

TOOL_BASE *

aTool

)

Shutdown the specified tool by waking it up with a null event to terminate the processing loop.

Parameters

aTool

is the tool to shutdown

Definition at line 505 of file tool_manager.cpp.

{
 wxASSERT( aTool != nullptr );
 
 TOOL_ID id = aTool->GetId();
 
 if( isActive( aTool ) )
 {
 TOOL_MANAGER::ID_LIST::iterator it = std::find( m_activeTools.begin(),
 m_activeTools.end(), id );
 
 TOOL_STATE* st = m_toolIdIndex[*it];
 
 // the tool state handler is waiting for events (i.e. called Wait() method)
 if( st && st->pendingWait )
 {
 // Wake up the tool and tell it to shutdown
 st->shutdown = true;
 st->pendingWait = false;
 st->waitEvents.clear();
 
 if( st->cofunc )
 {
 wxLogTrace( kicadTraceToolStack,
 "TOOL_MANAGER::ShutdownTool - Shutting down tool %s",
 st->theTool->GetName() );
 
 setActiveState( st );
 bool end = !st->cofunc->Resume();
 
 if( end )
 finishTool( st );
 }
 }
 }
}

References TOOL_EVENT_LIST::clear(), TOOL_MANAGER::TOOL_STATE::cofunc, finishTool(), TOOL_BASE::GetId(), TOOL_BASE::GetName(), isActive(), kicadTraceToolStack, m_activeTools, m_toolIdIndex, TOOL_MANAGER::TOOL_STATE::pendingWait, COROUTINE< ReturnType, ArgType >::Resume(), setActiveState(), TOOL_MANAGER::TOOL_STATE::shutdown, TOOL_MANAGER::TOOL_STATE::theTool, and TOOL_MANAGER::TOOL_STATE::waitEvents.

Referenced by ShutdownAllTools(), and ShutdownTool().

ShutdownTool() [3/3]

void TOOL_MANAGER::ShutdownTool

(

TOOL_ID

aToolId

)

Shutdown the specified tool by waking it up with a null event to terminate the processing loop.

Parameters

aToolId

is the ID of the tool to shutdown

Definition at line 481 of file tool_manager.cpp.

{
 TOOL_BASE* tool = FindTool( aToolId );
 
 if( tool && tool->GetType() == INTERACTIVE )
 ShutdownTool( tool );
 
 wxLogTrace( kicadTraceToolStack, "TOOL_MANAGER::ShutdownTool - no tool with ID %d",
 aToolId );
}

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

Tools()

std::vector< TOOL_BASE * > TOOL_MANAGER::Tools ( )

inline

Definition at line 231 of file tool_manager.h.

{ return m_toolOrder; }

References m_toolOrder.

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

UpdateUI()

void TOOL_MANAGER::UpdateUI

(

const TOOL_EVENT &

aEvent

)

Update the status bar and synchronizes toolbars.

Definition at line 1207 of file tool_manager.cpp.

{
 EDA_BASE_FRAME* frame = dynamic_cast<EDA_BASE_FRAME*>( GetToolHolder() );
 
 if( frame )
 frame->UpdateStatusBar();
}

References GetToolHolder(), and EDA_BASE_FRAME::UpdateStatusBar().

Referenced by ProcessEvent(), and RunAction().

VetoContextMenuMouseWarp()

void TOOL_MANAGER::VetoContextMenuMouseWarp ( )

inline

Disable mouse warping after the current context menu is closed.

This must be called before invoking each context menu. It's a good idea to call this from non-modal dialogs (e.g. DRC window).

Definition at line 424 of file tool_manager.h.

 {
 m_warpMouseAfterContextMenu = false;
 }

References m_warpMouseAfterContextMenu.

Referenced by DIALOG_SHIM::DIALOG_SHIM(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), PL_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), SCH_DRAWING_TOOLS::PlaceImage(), DRAWING_TOOL::PlaceImage(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_DRAWING_TOOLS::TwoClickPlace(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

Member Data Documentation

m_actionMgr

ACTION_MANAGER* TOOL_MANAGER::m_actionMgr

private

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

Definition at line 556 of file tool_manager.h.

Referenced by DispatchHotKey(), GetActionManager(), GetHotKey(), InitTools(), RunAction(), TOOL_MANAGER(), and ~TOOL_MANAGER().

m_activeState

TOOL_STATE* TOOL_MANAGER::m_activeState

private

True if the tool manager is shutting down (don't process additional events)

Definition at line 582 of file tool_manager.h.

Referenced by finishTool(), RunAction(), and setActiveState().

m_activeTools

ID_LIST TOOL_MANAGER::m_activeTools

private

Instance of ACTION_MANAGER that handles TOOL_ACTIONs.

Definition at line 553 of file tool_manager.h.

Referenced by DispatchContextMenu(), dispatchInternal(), finishTool(), GetCurrentToolId(), GetPriority(), isActive(), runTool(), ShutdownAllTools(), and ShutdownTool().

m_cursorSettings

std::map<TOOL_ID, std::optional<VECTOR2D> > TOOL_MANAGER::m_cursorSettings

private

Definition at line 559 of file tool_manager.h.

Referenced by DispatchContextMenu(), and saveViewControls().

m_eventQueue

std::list<TOOL_EVENT> TOOL_MANAGER::m_eventQueue

private

Right click context menu position.

Definition at line 568 of file tool_manager.h.

Referenced by PostEvent(), and processEvent().

m_frame

TOOLS_HOLDER* TOOL_MANAGER::m_frame

private

Definition at line 564 of file tool_manager.h.

Referenced by DispatchContextMenu(), GetToolHolder(), and SetEnvironment().

m_menuActive

bool TOOL_MANAGER::m_menuActive

private

Tool currently displaying a popup menu. It is negative when there is no menu displayed.

Definition at line 576 of file tool_manager.h.

Referenced by DispatchContextMenu(), IsContextMenuActive(), and saveViewControls().

m_menuCursor

VECTOR2D TOOL_MANAGER::m_menuCursor

private

Definition at line 571 of file tool_manager.h.

Referenced by DispatchContextMenu(), GetMenuCursorPos(), and saveViewControls().

m_menuOwner

TOOL_ID TOOL_MANAGER::m_menuOwner

private

Pointer to the state object corresponding to the currently executed tool.

Definition at line 579 of file tool_manager.h.

Referenced by DispatchContextMenu(), and dispatchInternal().

m_model

EDA_ITEM* TOOL_MANAGER::m_model

private

Definition at line 561 of file tool_manager.h.

Referenced by GetModel(), and SetEnvironment().

m_settings

APP_SETTINGS_BASE* TOOL_MANAGER::m_settings

private

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

Definition at line 565 of file tool_manager.h.

Referenced by GetSettings(), and SetEnvironment().

m_shuttingDown

bool TOOL_MANAGER::m_shuttingDown

private

Definition at line 585 of file tool_manager.h.

Referenced by ProcessEvent(), RunAction(), and ShutdownAllTools().

m_toolIdIndex

ID_STATE_MAP TOOL_MANAGER::m_toolIdIndex

private

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

Definition at line 547 of file tool_manager.h.

Referenced by DispatchContextMenu(), dispatchInternal(), FindTool(), GetCurrentToolState(), InitTools(), IsToolActive(), RegisterTool(), runTool(), ShutdownAllTools(), and ShutdownTool().

m_toolNameIndex

NAME_STATE_MAP TOOL_MANAGER::m_toolNameIndex

private

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

Definition at line 544 of file tool_manager.h.

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

m_toolOrder

std::vector<TOOL_BASE*> TOOL_MANAGER::m_toolOrder

private

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

Definition at line 538 of file tool_manager.h.

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

m_toolState

TOOL_STATE_MAP TOOL_MANAGER::m_toolState

private

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

Definition at line 541 of file tool_manager.h.

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

m_toolTypes

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

private

Stack of the active tools.

Definition at line 550 of file tool_manager.h.

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

m_view

KIGFX::VIEW* TOOL_MANAGER::m_view

private

Definition at line 562 of file tool_manager.h.

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

m_viewControls

KIGFX::VIEW_CONTROLS* TOOL_MANAGER::m_viewControls

private

Definition at line 563 of file tool_manager.h.

Referenced by applyViewControls(), DispatchContextMenu(), GetCurrentToolVC(), GetCursorPosition(), GetMousePosition(), GetViewControls(), saveViewControls(), setActiveState(), and SetEnvironment().

m_warpMouseAfterContextMenu

bool TOOL_MANAGER::m_warpMouseAfterContextMenu

private

Flag indicating whether a context menu is currently displayed.

Definition at line 573 of file tool_manager.h.

Referenced by DispatchContextMenu(), and VetoContextMenuMouseWarp().

---

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

• tool_manager.h
• tool_manager.cpp