KiCad PCB EDA Suite
TOOL_MANAGER::TOOL_STATE Struct Reference

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

Public Member Functions

 TOOL_STATE (TOOL_BASE *aTool)
 
 TOOL_STATE (const TOOL_STATE &aState)
 
 ~TOOL_STATE ()
 
TOOL_STATEoperator= (const TOOL_STATE &aState)
 
bool operator== (const TOOL_MANAGER::TOOL_STATE &aRhs) const
 
bool operator!= (const TOOL_MANAGER::TOOL_STATE &aRhs) const
 
void Push ()
 Function Push() Stores the current state of the tool on stack. More...
 
bool Pop ()
 Function Pop() Restores state of the tool from stack. More...
 

Public Attributes

TOOL_BASEtheTool
 The tool itself. More...
 
bool idle
 Is the tool active (pending execution) or disabled at the moment. More...
 
bool pendingWait
 Flag defining if the tool is waiting for any event (i.e. More...
 
bool pendingContextMenu
 Is there a context menu being displayed. More...
 
ACTION_MENUcontextMenu
 Context menu currently used by the tool. More...
 
CONTEXT_MENU_TRIGGER contextMenuTrigger
 Defines when the context menu is opened. More...
 
COROUTINE< int, const TOOL_EVENT & > * cofunc
 Tool execution context. More...
 
TOOL_EVENT wakeupEvent
 The event that triggered the execution/wakeup of the tool after Wait() call. More...
 
TOOL_EVENT_LIST waitEvents
 List of events the tool is currently waiting for. More...
 
std::vector< TRANSITIONtransitions
 List of possible transitions (ie. More...
 
KIGFX::VC_SETTINGS vcSettings
 VIEW_CONTROLS settings to preserve settings when the tools are switched. More...
 

Private Member Functions

void clear ()
 

Restores the initial state.

More...
 

Private Attributes

std::stack< std::unique_ptr< TOOL_STATE > > stateStack
 

Stack preserving previous states of a TOOL.

More...
 

Detailed Description

Struct describing the current execution state of a TOOL.

Definition at line 48 of file tool_manager.cpp.

Constructor & Destructor Documentation

◆ TOOL_STATE() [1/2]

TOOL_MANAGER::TOOL_STATE::TOOL_STATE ( TOOL_BASE aTool)
inline

Definition at line 50 of file tool_manager.cpp.

50  :
51  theTool( aTool )
52  {
53  clear();
54  }
TOOL_BASE * theTool
The tool itself.
void clear()
Restores the initial state.

References clear().

◆ TOOL_STATE() [2/2]

TOOL_MANAGER::TOOL_STATE::TOOL_STATE ( const TOOL_STATE aState)
inline

Definition at line 56 of file tool_manager.cpp.

57  {
58  theTool = aState.theTool;
59  idle = aState.idle;
60  pendingWait = aState.pendingWait;
61  pendingContextMenu = aState.pendingContextMenu;
62  contextMenu = aState.contextMenu;
63  contextMenuTrigger = aState.contextMenuTrigger;
64  cofunc = aState.cofunc;
65  wakeupEvent = aState.wakeupEvent;
66  waitEvents = aState.waitEvents;
67  transitions = aState.transitions;
68  vcSettings = aState.vcSettings;
69  // do not copy stateStack
70  }
TOOL_BASE * theTool
The tool itself.
std::vector< TRANSITION > transitions
List of possible transitions (ie.
KIGFX::VC_SETTINGS vcSettings
VIEW_CONTROLS settings to preserve settings when the tools are switched.
ACTION_MENU * contextMenu
Context menu currently used by the tool.
bool pendingWait
Flag defining if the tool is waiting for any event (i.e.
bool pendingContextMenu
Is there a context menu being displayed.
bool idle
Is the tool active (pending execution) or disabled at the moment.
TOOL_EVENT wakeupEvent
The event that triggered the execution/wakeup of the tool after Wait() call.
COROUTINE< int, const TOOL_EVENT & > * cofunc
Tool execution context.
CONTEXT_MENU_TRIGGER contextMenuTrigger
Defines when the context menu is opened.
TOOL_EVENT_LIST waitEvents
List of events the tool is currently waiting for.

References cofunc, contextMenu, contextMenuTrigger, idle, pendingContextMenu, pendingWait, theTool, transitions, vcSettings, waitEvents, and wakeupEvent.

◆ ~TOOL_STATE()

TOOL_MANAGER::TOOL_STATE::~TOOL_STATE ( )
inline

Definition at line 72 of file tool_manager.cpp.

73  {
74  if( !stateStack.empty() )
75  wxFAIL;
76  }
std::stack< std::unique_ptr< TOOL_STATE > > stateStack
Stack preserving previous states of a TOOL.

References stateStack.

Member Function Documentation

◆ clear()

void TOOL_MANAGER::TOOL_STATE::clear ( )
inlineprivate

Restores the initial state.

Definition at line 180 of file tool_manager.cpp.

181  {
182  idle = true;
183  pendingWait = false;
184  pendingContextMenu = false;
185  cofunc = NULL;
186  contextMenu = NULL;
188  vcSettings.Reset();
189  transitions.clear();
190  }
void Reset()
Restores the default settings
std::vector< TRANSITION > transitions
List of possible transitions (ie.
KIGFX::VC_SETTINGS vcSettings
VIEW_CONTROLS settings to preserve settings when the tools are switched.
ACTION_MENU * contextMenu
Context menu currently used by the tool.
bool pendingWait
Flag defining if the tool is waiting for any event (i.e.
bool pendingContextMenu
Is there a context menu being displayed.
bool idle
Is the tool active (pending execution) or disabled at the moment.
COROUTINE< int, const TOOL_EVENT & > * cofunc
Tool execution context.
CONTEXT_MENU_TRIGGER contextMenuTrigger
Defines when the context menu is opened.

References CMENU_OFF, cofunc, contextMenu, contextMenuTrigger, idle, pendingContextMenu, pendingWait, KIGFX::VC_SETTINGS::Reset(), transitions, and vcSettings.

Referenced by Push(), and TOOL_STATE().

◆ operator!=()

bool TOOL_MANAGER::TOOL_STATE::operator!= ( const TOOL_MANAGER::TOOL_STATE aRhs) const
inline

Definition at line 135 of file tool_manager.cpp.

136  {
137  return aRhs.theTool != this->theTool;
138  }
TOOL_BASE * theTool
The tool itself.

References theTool.

◆ operator=()

TOOL_STATE& TOOL_MANAGER::TOOL_STATE::operator= ( const TOOL_STATE aState)
inline

Definition at line 113 of file tool_manager.cpp.

114  {
115  theTool = aState.theTool;
116  idle = aState.idle;
117  pendingWait = aState.pendingWait;
118  pendingContextMenu = aState.pendingContextMenu;
119  contextMenu = aState.contextMenu;
120  contextMenuTrigger = aState.contextMenuTrigger;
121  cofunc = aState.cofunc;
122  wakeupEvent = aState.wakeupEvent;
123  waitEvents = aState.waitEvents;
124  transitions = aState.transitions;
125  vcSettings = aState.vcSettings;
126  // do not copy stateStack
127  return *this;
128  }
TOOL_BASE * theTool
The tool itself.
std::vector< TRANSITION > transitions
List of possible transitions (ie.
KIGFX::VC_SETTINGS vcSettings
VIEW_CONTROLS settings to preserve settings when the tools are switched.
ACTION_MENU * contextMenu
Context menu currently used by the tool.
bool pendingWait
Flag defining if the tool is waiting for any event (i.e.
bool pendingContextMenu
Is there a context menu being displayed.
bool idle
Is the tool active (pending execution) or disabled at the moment.
TOOL_EVENT wakeupEvent
The event that triggered the execution/wakeup of the tool after Wait() call.
COROUTINE< int, const TOOL_EVENT & > * cofunc
Tool execution context.
CONTEXT_MENU_TRIGGER contextMenuTrigger
Defines when the context menu is opened.
TOOL_EVENT_LIST waitEvents
List of events the tool is currently waiting for.

References cofunc, contextMenu, contextMenuTrigger, idle, pendingContextMenu, pendingWait, theTool, transitions, vcSettings, waitEvents, and wakeupEvent.

◆ operator==()

bool TOOL_MANAGER::TOOL_STATE::operator== ( const TOOL_MANAGER::TOOL_STATE aRhs) const
inline

Definition at line 130 of file tool_manager.cpp.

131  {
132  return aRhs.theTool == this->theTool;
133  }
TOOL_BASE * theTool
The tool itself.

References theTool.

◆ Pop()

bool TOOL_MANAGER::TOOL_STATE::Pop ( )
inline

Function Pop() Restores state of the tool from stack.

Stacks are stored internally and are not shared between different TOOL_STATE objects.

Returns
True if state was restored, false if the stack was empty.

Definition at line 158 of file tool_manager.cpp.

159  {
160  delete cofunc;
161 
162  if( !stateStack.empty() )
163  {
164  *this = *stateStack.top().get();
165  stateStack.pop();
166  return true;
167  }
168  else
169  {
170  cofunc = NULL;
171  return false;
172  }
173  }
std::stack< std::unique_ptr< TOOL_STATE > > stateStack
Stack preserving previous states of a TOOL.
COROUTINE< int, const TOOL_EVENT & > * cofunc
Tool execution context.

References cofunc, and stateStack.

Referenced by TOOL_MANAGER::finishTool().

◆ Push()

void TOOL_MANAGER::TOOL_STATE::Push ( )
inline

Function Push() Stores the current state of the tool on stack.

Stacks are stored internally and are not shared between different TOOL_STATE objects.

Definition at line 145 of file tool_manager.cpp.

146  {
147  auto state = std::make_unique<TOOL_STATE>( *this );
148  stateStack.push( std::move( state ) );
149  clear();
150  }
std::stack< std::unique_ptr< TOOL_STATE > > stateStack
Stack preserving previous states of a TOOL.
void clear()
Restores the initial state.

References clear(), and stateStack.

Referenced by TOOL_MANAGER::dispatchInternal().

Member Data Documentation

◆ cofunc

COROUTINE<int, const TOOL_EVENT&>* TOOL_MANAGER::TOOL_STATE::cofunc

◆ contextMenu

ACTION_MENU* TOOL_MANAGER::TOOL_STATE::contextMenu

Context menu currently used by the tool.

Definition at line 92 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::DispatchContextMenu(), operator=(), TOOL_MANAGER::ScheduleContextMenu(), and TOOL_STATE().

◆ contextMenuTrigger

CONTEXT_MENU_TRIGGER TOOL_MANAGER::TOOL_STATE::contextMenuTrigger

Defines when the context menu is opened.

Definition at line 95 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::DispatchContextMenu(), operator=(), TOOL_MANAGER::ScheduleContextMenu(), and TOOL_STATE().

◆ idle

bool TOOL_MANAGER::TOOL_STATE::idle

Is the tool active (pending execution) or disabled at the moment.

Definition at line 82 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::dispatchInternal(), TOOL_MANAGER::finishTool(), operator=(), and TOOL_STATE().

◆ pendingContextMenu

bool TOOL_MANAGER::TOOL_STATE::pendingContextMenu

Is there a context menu being displayed.

Definition at line 89 of file tool_manager.cpp.

Referenced by clear(), operator=(), and TOOL_STATE().

◆ pendingWait

bool TOOL_MANAGER::TOOL_STATE::pendingWait

Flag defining if the tool is waiting for any event (i.e.

if it issued a Wait() call).

Definition at line 86 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::DispatchContextMenu(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleWait(), and TOOL_STATE().

◆ stateStack

std::stack<std::unique_ptr<TOOL_STATE> > TOOL_MANAGER::TOOL_STATE::stateStack
private

Stack preserving previous states of a TOOL.

Definition at line 177 of file tool_manager.cpp.

Referenced by Pop(), Push(), and ~TOOL_STATE().

◆ theTool

TOOL_BASE* TOOL_MANAGER::TOOL_STATE::theTool

◆ transitions

std::vector<TRANSITION> TOOL_MANAGER::TOOL_STATE::transitions

List of possible transitions (ie.

association of events and state handlers that are executed upon the event reception

Definition at line 108 of file tool_manager.cpp.

Referenced by clear(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleNextState(), and TOOL_STATE().

◆ vcSettings

KIGFX::VC_SETTINGS TOOL_MANAGER::TOOL_STATE::vcSettings

VIEW_CONTROLS settings to preserve settings when the tools are switched.

Definition at line 111 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::applyViewControls(), clear(), TOOL_MANAGER::DispatchContextMenu(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::saveViewControls(), and TOOL_STATE().

◆ waitEvents

TOOL_EVENT_LIST TOOL_MANAGER::TOOL_STATE::waitEvents

List of events the tool is currently waiting for.

Definition at line 104 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::DispatchContextMenu(), TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleWait(), and TOOL_STATE().

◆ wakeupEvent

TOOL_EVENT TOOL_MANAGER::TOOL_STATE::wakeupEvent

The event that triggered the execution/wakeup of the tool after Wait() call.

Definition at line 101 of file tool_manager.cpp.

Referenced by TOOL_MANAGER::dispatchInternal(), operator=(), TOOL_MANAGER::ScheduleWait(), and TOOL_STATE().


The documentation for this struct was generated from the following file: