2013-09-20 16:21:01 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2013 CERN
|
|
|
|
* @author Maciej Suminski <maciej.suminski@cern.ch>
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, you may find one here:
|
|
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <tool/action_manager.h>
|
|
|
|
#include <tool/tool_manager.h>
|
|
|
|
#include <tool/tool_action.h>
|
2015-05-05 18:39:42 +00:00
|
|
|
#include <draw_frame.h>
|
|
|
|
|
|
|
|
#include <hotkeys_basic.h>
|
2016-05-28 16:46:29 +00:00
|
|
|
#include <cctype>
|
2013-09-26 16:38:58 +00:00
|
|
|
#include <cassert>
|
2013-09-20 16:21:01 +00:00
|
|
|
|
|
|
|
ACTION_MANAGER::ACTION_MANAGER( TOOL_MANAGER* aToolManager ) :
|
|
|
|
m_toolMgr( aToolManager )
|
|
|
|
{
|
2015-05-05 18:39:41 +00:00
|
|
|
// Register known actions
|
|
|
|
std::list<TOOL_ACTION*>& actionList = GetActionList();
|
2015-07-28 08:29:00 +00:00
|
|
|
|
2016-06-29 20:07:55 +00:00
|
|
|
for( TOOL_ACTION* action : actionList )
|
2015-07-28 08:29:00 +00:00
|
|
|
{
|
|
|
|
if( action->m_id == -1 )
|
|
|
|
action->m_id = MakeActionId( action->m_name );
|
|
|
|
|
|
|
|
RegisterAction( new TOOL_ACTION( *action ) );
|
|
|
|
}
|
2013-09-20 16:21:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2013-11-28 14:24:19 +00:00
|
|
|
ACTION_MANAGER::~ACTION_MANAGER()
|
|
|
|
{
|
2015-07-28 08:29:00 +00:00
|
|
|
while( !m_actionNameIndex.empty() )
|
|
|
|
{
|
|
|
|
TOOL_ACTION* action = m_actionNameIndex.begin()->second;
|
|
|
|
UnregisterAction( action );
|
|
|
|
delete action;
|
|
|
|
}
|
2013-11-28 14:24:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2013-09-20 16:21:01 +00:00
|
|
|
void ACTION_MANAGER::RegisterAction( TOOL_ACTION* aAction )
|
|
|
|
{
|
2014-04-09 15:05:05 +00:00
|
|
|
// TOOL_ACTIONs are supposed to be named [appName.]toolName.actionName (with dots between)
|
|
|
|
// action name without specifying at least toolName is not valid
|
|
|
|
assert( aAction->GetName().find( '.', 0 ) != std::string::npos );
|
|
|
|
|
2014-05-14 14:29:53 +00:00
|
|
|
// TOOL_ACTIONs must have unique names & ids
|
2013-12-03 14:17:43 +00:00
|
|
|
assert( m_actionNameIndex.find( aAction->m_name ) == m_actionNameIndex.end() );
|
2013-09-20 16:21:01 +00:00
|
|
|
|
|
|
|
m_actionNameIndex[aAction->m_name] = aAction;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void ACTION_MANAGER::UnregisterAction( TOOL_ACTION* aAction )
|
|
|
|
{
|
2013-12-06 12:57:56 +00:00
|
|
|
m_actionNameIndex.erase( aAction->m_name );
|
2015-07-28 08:29:00 +00:00
|
|
|
int hotkey = GetHotKey( *aAction );
|
2013-12-06 12:57:56 +00:00
|
|
|
|
2015-07-28 08:29:00 +00:00
|
|
|
if( hotkey )
|
2014-04-09 15:05:05 +00:00
|
|
|
{
|
2015-07-28 08:29:00 +00:00
|
|
|
std::list<TOOL_ACTION*>& actions = m_actionHotKeys[hotkey];
|
2014-04-09 15:05:05 +00:00
|
|
|
std::list<TOOL_ACTION*>::iterator action = std::find( actions.begin(), actions.end(), aAction );
|
|
|
|
|
|
|
|
if( action != actions.end() )
|
|
|
|
actions.erase( action );
|
|
|
|
else
|
|
|
|
assert( false );
|
|
|
|
}
|
2013-09-20 16:21:01 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
int ACTION_MANAGER::MakeActionId( const std::string& aActionName )
|
|
|
|
{
|
2013-09-27 18:52:34 +00:00
|
|
|
static int currentActionId = 1;
|
2013-10-14 14:13:35 +00:00
|
|
|
|
2013-09-20 16:21:01 +00:00
|
|
|
return currentActionId++;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2014-07-09 14:25:50 +00:00
|
|
|
TOOL_ACTION* ACTION_MANAGER::FindAction( const std::string& aActionName ) const
|
2013-09-20 16:21:01 +00:00
|
|
|
{
|
|
|
|
std::map<std::string, TOOL_ACTION*>::const_iterator it = m_actionNameIndex.find( aActionName );
|
|
|
|
|
2014-07-09 14:25:50 +00:00
|
|
|
if( it != m_actionNameIndex.end() )
|
|
|
|
return it->second;
|
2013-09-20 16:21:01 +00:00
|
|
|
|
2014-07-09 14:25:50 +00:00
|
|
|
return NULL;
|
2014-02-28 14:46:05 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2013-09-20 16:21:01 +00:00
|
|
|
bool ACTION_MANAGER::RunHotKey( int aHotKey ) const
|
|
|
|
{
|
2015-06-16 12:22:12 +00:00
|
|
|
int key = aHotKey & ~MD_MODIFIER_MASK;
|
2014-04-09 15:33:22 +00:00
|
|
|
int mod = aHotKey & MD_MODIFIER_MASK;
|
2013-09-20 16:21:01 +00:00
|
|
|
|
2015-07-24 07:42:45 +00:00
|
|
|
if( key >= 'a' && key <= 'z' )
|
|
|
|
key = std::toupper( key );
|
2015-06-16 12:22:12 +00:00
|
|
|
|
2014-04-09 15:33:22 +00:00
|
|
|
HOTKEY_LIST::const_iterator it = m_actionHotKeys.find( key | mod );
|
|
|
|
|
2015-03-16 09:34:45 +00:00
|
|
|
// If no luck, try without Shift, to handle keys that require it
|
2014-04-09 15:33:22 +00:00
|
|
|
// e.g. to get ? you need to press Shift+/ without US keyboard layout
|
|
|
|
// Hardcoding ? as Shift+/ is a bad idea, as on another layout you may need to press a
|
|
|
|
// different combination
|
2013-09-20 16:21:01 +00:00
|
|
|
if( it == m_actionHotKeys.end() )
|
2014-04-09 15:33:22 +00:00
|
|
|
{
|
2015-06-16 12:51:39 +00:00
|
|
|
it = m_actionHotKeys.find( key | ( mod & ~MD_SHIFT ) );
|
2014-04-09 15:33:22 +00:00
|
|
|
|
|
|
|
if( it == m_actionHotKeys.end() )
|
|
|
|
return false; // no appropriate action found for the hotkey
|
|
|
|
}
|
2013-09-20 16:21:01 +00:00
|
|
|
|
2014-04-09 15:05:05 +00:00
|
|
|
const std::list<TOOL_ACTION*>& actions = it->second;
|
2013-09-20 16:21:01 +00:00
|
|
|
|
2014-04-09 15:05:05 +00:00
|
|
|
// Choose the action that has the highest priority on the active tools stack
|
|
|
|
// If there is none, run the global action associated with the hot key
|
|
|
|
int highestPriority = -1, priority = -1;
|
|
|
|
const TOOL_ACTION* context = NULL; // pointer to context action of the highest priority tool
|
|
|
|
const TOOL_ACTION* global = NULL; // pointer to global action, if there is no context action
|
|
|
|
|
2016-06-29 20:07:55 +00:00
|
|
|
for( const TOOL_ACTION* action : actions )
|
2014-04-09 15:05:05 +00:00
|
|
|
{
|
|
|
|
if( action->GetScope() == AS_GLOBAL )
|
|
|
|
{
|
|
|
|
// Store the global action for the hot key in case there was no possible
|
|
|
|
// context actions to run
|
|
|
|
assert( global == NULL ); // there should be only one global action per hot key
|
|
|
|
global = action;
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
TOOL_BASE* tool = m_toolMgr->FindTool( action->GetToolName() );
|
|
|
|
|
|
|
|
if( tool )
|
|
|
|
{
|
2014-07-09 14:25:50 +00:00
|
|
|
// Choose the action that goes to the tool with highest priority
|
|
|
|
// (i.e. is on the top of active tools stack)
|
2014-04-09 15:05:05 +00:00
|
|
|
priority = m_toolMgr->GetPriority( tool->GetId() );
|
|
|
|
|
|
|
|
if( priority >= 0 && priority > highestPriority )
|
|
|
|
{
|
|
|
|
highestPriority = priority;
|
|
|
|
context = action;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2013-09-20 16:21:01 +00:00
|
|
|
|
2014-04-09 15:05:05 +00:00
|
|
|
if( context )
|
2014-07-09 14:25:50 +00:00
|
|
|
{
|
|
|
|
m_toolMgr->RunAction( *context, true );
|
|
|
|
return true;
|
|
|
|
}
|
2014-04-09 15:05:05 +00:00
|
|
|
else if( global )
|
2014-07-09 14:25:50 +00:00
|
|
|
{
|
|
|
|
m_toolMgr->RunAction( *global, true );
|
|
|
|
return true;
|
|
|
|
}
|
2014-04-09 15:05:05 +00:00
|
|
|
|
2014-07-09 14:25:50 +00:00
|
|
|
return false;
|
2013-12-05 13:48:44 +00:00
|
|
|
}
|
2015-05-05 18:39:42 +00:00
|
|
|
|
|
|
|
|
2015-07-28 08:29:00 +00:00
|
|
|
int ACTION_MANAGER::GetHotKey( const TOOL_ACTION& aAction ) const
|
|
|
|
{
|
|
|
|
std::map<int, int>::const_iterator it = m_hotkeys.find( aAction.GetId() );
|
|
|
|
|
|
|
|
if( it == m_hotkeys.end() )
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
return it->second;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2015-05-05 18:39:42 +00:00
|
|
|
void ACTION_MANAGER::UpdateHotKeys()
|
|
|
|
{
|
|
|
|
m_actionHotKeys.clear();
|
2015-07-28 08:29:00 +00:00
|
|
|
m_hotkeys.clear();
|
2015-05-05 18:39:42 +00:00
|
|
|
|
2017-07-27 11:54:47 +00:00
|
|
|
for( const auto& actionName : m_actionNameIndex )
|
2015-05-05 18:39:42 +00:00
|
|
|
{
|
2017-07-27 11:54:47 +00:00
|
|
|
TOOL_ACTION* action = actionName.second;
|
2015-07-28 08:29:00 +00:00
|
|
|
int hotkey = processHotKey( action );
|
2015-05-05 18:39:42 +00:00
|
|
|
|
|
|
|
if( hotkey > 0 )
|
2015-07-28 08:29:00 +00:00
|
|
|
{
|
|
|
|
m_actionHotKeys[hotkey].push_back( action );
|
|
|
|
m_hotkeys[action->GetId()] = hotkey;
|
|
|
|
}
|
2015-05-05 18:39:42 +00:00
|
|
|
}
|
|
|
|
|
2017-07-27 11:54:47 +00:00
|
|
|
#ifdef DEBUG
|
2015-05-05 18:39:42 +00:00
|
|
|
// Check if there are two global actions assigned to the same hotkey
|
2017-07-27 11:54:47 +00:00
|
|
|
for( const auto& action_list : m_actionHotKeys )
|
2015-05-05 18:39:42 +00:00
|
|
|
{
|
|
|
|
int global_actions_cnt = 0;
|
|
|
|
|
2017-07-27 11:54:47 +00:00
|
|
|
for( const TOOL_ACTION* action : action_list.second )
|
2015-05-05 18:39:42 +00:00
|
|
|
{
|
|
|
|
if( action->GetScope() == AS_GLOBAL )
|
|
|
|
++global_actions_cnt;
|
|
|
|
}
|
|
|
|
|
2017-04-25 09:06:24 +00:00
|
|
|
assert( global_actions_cnt <= 1 );
|
2015-05-05 18:39:42 +00:00
|
|
|
}
|
|
|
|
#endif /* not NDEBUG */
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2015-07-28 08:29:00 +00:00
|
|
|
int ACTION_MANAGER::processHotKey( TOOL_ACTION* aAction )
|
2015-05-05 18:39:42 +00:00
|
|
|
{
|
2015-07-28 08:29:00 +00:00
|
|
|
int hotkey = aAction->getDefaultHotKey();
|
2015-05-05 18:39:42 +00:00
|
|
|
|
|
|
|
if( ( hotkey & TOOL_ACTION::LEGACY_HK ) )
|
|
|
|
{
|
|
|
|
hotkey = hotkey & ~TOOL_ACTION::LEGACY_HK; // it leaves only HK_xxx identifier
|
|
|
|
EDA_DRAW_FRAME* frame = static_cast<EDA_DRAW_FRAME*>( m_toolMgr->GetEditFrame() );
|
|
|
|
EDA_HOTKEY* hk_desc = frame->GetHotKeyDescription( hotkey );
|
|
|
|
|
|
|
|
if( hk_desc )
|
|
|
|
{
|
|
|
|
hotkey = hk_desc->m_KeyCode;
|
|
|
|
|
|
|
|
// Convert modifiers to the ones used by the Tool Framework
|
|
|
|
if( hotkey & GR_KB_CTRL )
|
|
|
|
{
|
|
|
|
hotkey &= ~GR_KB_CTRL;
|
|
|
|
hotkey |= MD_CTRL;
|
|
|
|
}
|
|
|
|
|
|
|
|
if( hotkey & GR_KB_ALT )
|
|
|
|
{
|
|
|
|
hotkey &= ~GR_KB_ALT;
|
|
|
|
hotkey |= MD_ALT;
|
|
|
|
}
|
|
|
|
|
|
|
|
if( hotkey & GR_KB_SHIFT )
|
|
|
|
{
|
|
|
|
hotkey &= ~GR_KB_SHIFT;
|
|
|
|
hotkey |= MD_SHIFT;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
hotkey = 0;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return hotkey;
|
|
|
|
}
|