KiCad PCB EDA Suite
action_manager.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013 CERN
5  * @author Maciej Suminski <maciej.suminski@cern.ch>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #include <tool/action_manager.h>
26 #include <tool/tool_manager.h>
27 #include <tool/tool_action.h>
28 #include <draw_frame.h>
29 
30 #include <hotkeys_basic.h>
31 #include <cctype>
32 #include <cassert>
33 
35  m_toolMgr( aToolManager )
36 {
37  // Register known actions
38  std::list<TOOL_ACTION*>& actionList = GetActionList();
39 
40  for( TOOL_ACTION* action : actionList )
41  {
42  if( action->m_id == -1 )
43  action->m_id = MakeActionId( action->m_name );
44 
45  RegisterAction( new TOOL_ACTION( *action ) );
46  }
47 }
48 
49 
51 {
52  while( !m_actionNameIndex.empty() )
53  {
54  TOOL_ACTION* action = m_actionNameIndex.begin()->second;
55  UnregisterAction( action );
56  delete action;
57  }
58 }
59 
60 
62 {
63  // TOOL_ACTIONs are supposed to be named [appName.]toolName.actionName (with dots between)
64  // action name without specifying at least toolName is not valid
65  assert( aAction->GetName().find( '.', 0 ) != std::string::npos );
66 
67  // TOOL_ACTIONs must have unique names & ids
68  assert( m_actionNameIndex.find( aAction->m_name ) == m_actionNameIndex.end() );
69 
70  m_actionNameIndex[aAction->m_name] = aAction;
71 }
72 
73 
75 {
76  m_actionNameIndex.erase( aAction->m_name );
77  int hotkey = GetHotKey( *aAction );
78 
79  if( hotkey )
80  {
81  std::list<TOOL_ACTION*>& actions = m_actionHotKeys[hotkey];
82  std::list<TOOL_ACTION*>::iterator action = std::find( actions.begin(), actions.end(), aAction );
83 
84  if( action != actions.end() )
85  actions.erase( action );
86  else
87  assert( false );
88  }
89 }
90 
91 
92 int ACTION_MANAGER::MakeActionId( const std::string& aActionName )
93 {
94  static int currentActionId = 1;
95 
96  return currentActionId++;
97 }
98 
99 
100 TOOL_ACTION* ACTION_MANAGER::FindAction( const std::string& aActionName ) const
101 {
102  std::map<std::string, TOOL_ACTION*>::const_iterator it = m_actionNameIndex.find( aActionName );
103 
104  if( it != m_actionNameIndex.end() )
105  return it->second;
106 
107  return NULL;
108 }
109 
110 
111 bool ACTION_MANAGER::RunHotKey( int aHotKey ) const
112 {
113  int key = aHotKey & ~MD_MODIFIER_MASK;
114  int mod = aHotKey & MD_MODIFIER_MASK;
115 
116  if( key >= 'a' && key <= 'z' )
117  key = std::toupper( key );
118 
119  HOTKEY_LIST::const_iterator it = m_actionHotKeys.find( key | mod );
120 
121  // If no luck, try without Shift, to handle keys that require it
122  // e.g. to get ? you need to press Shift+/ without US keyboard layout
123  // Hardcoding ? as Shift+/ is a bad idea, as on another layout you may need to press a
124  // different combination
125  if( it == m_actionHotKeys.end() )
126  {
127  it = m_actionHotKeys.find( key | ( mod & ~MD_SHIFT ) );
128 
129  if( it == m_actionHotKeys.end() )
130  return false; // no appropriate action found for the hotkey
131  }
132 
133  const std::list<TOOL_ACTION*>& actions = it->second;
134 
135  // Choose the action that has the highest priority on the active tools stack
136  // If there is none, run the global action associated with the hot key
137  int highestPriority = -1, priority = -1;
138  const TOOL_ACTION* context = NULL; // pointer to context action of the highest priority tool
139  const TOOL_ACTION* global = NULL; // pointer to global action, if there is no context action
140 
141  for( const TOOL_ACTION* action : actions )
142  {
143  if( action->GetScope() == AS_GLOBAL )
144  {
145  // Store the global action for the hot key in case there was no possible
146  // context actions to run
147  assert( global == NULL ); // there should be only one global action per hot key
148  global = action;
149  continue;
150  }
151 
152  TOOL_BASE* tool = m_toolMgr->FindTool( action->GetToolName() );
153 
154  if( tool )
155  {
156  // Choose the action that goes to the tool with highest priority
157  // (i.e. is on the top of active tools stack)
158  priority = m_toolMgr->GetPriority( tool->GetId() );
159 
160  if( priority >= 0 && priority > highestPriority )
161  {
162  highestPriority = priority;
163  context = action;
164  }
165  }
166  }
167 
168  if( context )
169  {
170  m_toolMgr->RunAction( *context, true );
171  return true;
172  }
173  else if( global )
174  {
175  m_toolMgr->RunAction( *global, true );
176  return true;
177  }
178 
179  return false;
180 }
181 
182 
183 int ACTION_MANAGER::GetHotKey( const TOOL_ACTION& aAction ) const
184 {
185  std::map<int, int>::const_iterator it = m_hotkeys.find( aAction.GetId() );
186 
187  if( it == m_hotkeys.end() )
188  return 0;
189 
190  return it->second;
191 }
192 
193 
195 {
196  m_actionHotKeys.clear();
197  m_hotkeys.clear();
198 
199  for( const auto& actionName : m_actionNameIndex )
200  {
201  TOOL_ACTION* action = actionName.second;
202  int hotkey = processHotKey( action );
203 
204  if( hotkey > 0 )
205  {
206  m_actionHotKeys[hotkey].push_back( action );
207  m_hotkeys[action->GetId()] = hotkey;
208  }
209  }
210 
211 #ifdef DEBUG
212  // Check if there are two global actions assigned to the same hotkey
213  for( const auto& action_list : m_actionHotKeys )
214  {
215  int global_actions_cnt = 0;
216 
217  for( const TOOL_ACTION* action : action_list.second )
218  {
219  if( action->GetScope() == AS_GLOBAL )
220  ++global_actions_cnt;
221  }
222 
223  assert( global_actions_cnt <= 1 );
224  }
225 #endif /* not NDEBUG */
226 }
227 
228 
230 {
231  int hotkey = aAction->getDefaultHotKey();
232 
233  if( ( hotkey & TOOL_ACTION::LEGACY_HK ) )
234  {
235  hotkey = hotkey & ~TOOL_ACTION::LEGACY_HK; // it leaves only HK_xxx identifier
236  EDA_DRAW_FRAME* frame = static_cast<EDA_DRAW_FRAME*>( m_toolMgr->GetEditFrame() );
237  EDA_HOTKEY* hk_desc = frame->GetHotKeyDescription( hotkey );
238 
239  if( hk_desc )
240  {
241  hotkey = hk_desc->m_KeyCode;
242 
243  // Convert modifiers to the ones used by the Tool Framework
244  if( hotkey & GR_KB_CTRL )
245  {
246  hotkey &= ~GR_KB_CTRL;
247  hotkey |= MD_CTRL;
248  }
249 
250  if( hotkey & GR_KB_ALT )
251  {
252  hotkey &= ~GR_KB_ALT;
253  hotkey |= MD_ALT;
254  }
255 
256  if( hotkey & GR_KB_SHIFT )
257  {
258  hotkey &= ~GR_KB_SHIFT;
259  hotkey |= MD_SHIFT;
260  }
261  }
262  else
263  {
264  hotkey = 0;
265  }
266  }
267 
268  return hotkey;
269 }
std::map< int, int > m_hotkeys
Quick action<->hot key lookup
TOOL_BASE * FindTool(int aId) const
Function FindTool() Searches for a tool with given ID.
static int MakeActionId(const std::string &aActionName)
Generates an unique ID from for an action with given name.
void UpdateHotKeys()
Function UpdateHotKeys() Updates TOOL_ACTIONs hot key assignment according to the current frame's Hot...
wxWindow * GetEditFrame() const
Definition: tool_manager.h:266
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:125
~ACTION_MANAGER()
Destructor.
TOOL_ACTION * FindAction(const std::string &aActionName) const
Function FindAction() Finds an action with a given name (if there is one available).
Class EDA_DRAW_FRAME is the base class for create windows for drawing purpose.
Definition: draw_frame.h:53
static std::list< TOOL_ACTION * > & GetActionList()
Function GetActionList() Returns list of TOOL_ACTIONs.
std::string m_name
Name of the action (convention is: app.[tool.]action.name)
Definition: tool_action.h:192
#define GR_KB_ALT
Definition: common.h:65
virtual EDA_HOTKEY * GetHotKeyDescription(int aCommand) const =0
Function GetHotKeyDescription Searches lists of hot key identifiers (HK_xxx) used in the frame to fin...
Class TOOL_MANAGER.
Definition: tool_manager.h:49
TOOL_ACTION_SCOPE GetScope() const
Definition: tool_action.h:134
#define GR_KB_SHIFT
Definition: common.h:66
static const int LEGACY_HK
Flag to determine the hot key settings is not a particular key, but a reference to legacy hot key set...
Definition: tool_action.h:220
int GetHotKey(const TOOL_ACTION &aAction) const
Function GetHotKey() Returns the hot key associated with a given action or 0 if there is none...
bool RunHotKey(int aHotKey) const
Function RunHotKey() Runs an action associated with a hotkey (if there is one available).
ACTION_MANAGER(TOOL_MANAGER *aToolManager)
Constructor.
int GetPriority(int aToolId) const
Returns priority of a given tool.
TOOL_ID GetId() const
Function GetId() Returns the unique identifier of the tool.
Definition: tool_base.h:122
All active tools
Definition: tool_event.h:138
void UnregisterAction(TOOL_ACTION *aAction)
Function UnregisterAction() Removes a tool action from the manager and makes it unavailable for furth...
std::map< std::string, TOOL_ACTION * > m_actionNameIndex
Map for indexing actions by their names
int processHotKey(TOOL_ACTION *aAction)
Resolves a reference to legacy hot key settings to a particular hot key.
const std::string & GetName() const
Function GetName() Returns name of the action.
Definition: tool_action.h:73
HOTKEY_LIST m_actionHotKeys
TOOL_MANAGER * m_toolMgr
Tool manager needed to run actions
void RegisterAction(TOOL_ACTION *aAction)
Function RegisterAction() Adds a tool action to the manager and sets it up.
class EDA_HOTKEY is a class to handle hot key commands.
Definition: hotkeys_basic.h:57
Class TOOL_BASE.
Definition: tool_base.h:68
Class TOOL_ACTION.
Definition: tool_action.h:46
int GetId() const
Function GetId() Returns the unique id of the TOOL_ACTION object.
Definition: tool_action.h:85
Some functions to handle hotkeys in KiCad.
int getDefaultHotKey()
Returns the hot key assigned in the object definition.
Definition: tool_action.h:186
#define GR_KB_CTRL
Definition: common.h:64
#define mod(a, n)
Definition: greymap.cpp:24