296 lines
9.4 KiB
C++
296 lines
9.4 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2013 CERN
|
|
* Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
|
|
* @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 <eda_draw_frame.h>
|
|
#include <tool/action_manager.h>
|
|
#include <tool/tool_action.h>
|
|
#include <tool/tool_manager.h>
|
|
#include <trace_helpers.h>
|
|
#include <wx/log.h>
|
|
|
|
#include <hotkeys_basic.h>
|
|
#include <cctype>
|
|
|
|
ACTION_MANAGER::ACTION_MANAGER( TOOL_MANAGER* aToolManager ) :
|
|
m_toolMgr( aToolManager )
|
|
{
|
|
// Register known actions
|
|
std::list<TOOL_ACTION*>& actionList = GetActionList();
|
|
|
|
for( TOOL_ACTION* action : actionList )
|
|
{
|
|
if( action->m_id == -1 )
|
|
action->m_id = MakeActionId( action->m_name );
|
|
|
|
RegisterAction( action );
|
|
}
|
|
}
|
|
|
|
|
|
ACTION_MANAGER::~ACTION_MANAGER()
|
|
{
|
|
}
|
|
|
|
|
|
void ACTION_MANAGER::RegisterAction( TOOL_ACTION* aAction )
|
|
{
|
|
// TOOL_ACTIONs are supposed to be named [appName.]toolName.actionName (with dots between)
|
|
// action name without specifying at least toolName is not valid
|
|
wxASSERT( aAction->GetName().find( '.', 0 ) != std::string::npos );
|
|
|
|
// TOOL_ACTIONs must have unique names & ids
|
|
wxASSERT( m_actionNameIndex.find( aAction->m_name ) == m_actionNameIndex.end() );
|
|
|
|
m_actionNameIndex[aAction->m_name] = aAction;
|
|
}
|
|
|
|
|
|
void ACTION_MANAGER::SetConditions( const TOOL_ACTION& aAction,
|
|
const ACTION_CONDITIONS& aConditions )
|
|
{
|
|
// Remove any existing handlers with the old conditions to ensure the UI layer doesn't have
|
|
// stale data.
|
|
if( m_toolMgr )
|
|
m_toolMgr->GetToolHolder()->UnregisterUIUpdateHandler( aAction );
|
|
|
|
m_uiConditions[aAction.GetId()] = aConditions;
|
|
|
|
wxLogTrace( kicadTraceToolStack,
|
|
wxS( "ACTION_MANAGER::SetConditions: Registering conditions for ID %d - %s" ),
|
|
aAction.GetId(), aAction.GetName() );
|
|
|
|
// Register a new handler with the new conditions
|
|
if( m_toolMgr )
|
|
m_toolMgr->GetToolHolder()->RegisterUIUpdateHandler( aAction, aConditions );
|
|
}
|
|
|
|
|
|
const ACTION_CONDITIONS* ACTION_MANAGER::GetCondition( const TOOL_ACTION& aAction ) const
|
|
{
|
|
const auto it = m_uiConditions.find( aAction.GetId() );
|
|
|
|
// If the action doesn't have something registered, then return null
|
|
if( it == m_uiConditions.end() )
|
|
return nullptr;
|
|
else
|
|
return &it->second;
|
|
}
|
|
|
|
|
|
int ACTION_MANAGER::MakeActionId( const std::string& aActionName )
|
|
{
|
|
static int currentActionId = 1;
|
|
|
|
return currentActionId++;
|
|
}
|
|
|
|
|
|
TOOL_ACTION* ACTION_MANAGER::FindAction( const std::string& aActionName ) const
|
|
{
|
|
std::map<std::string, TOOL_ACTION*>::const_iterator it = m_actionNameIndex.find( aActionName );
|
|
|
|
if( it != m_actionNameIndex.end() )
|
|
return it->second;
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
|
|
bool ACTION_MANAGER::RunHotKey( int aHotKey ) const
|
|
{
|
|
int key = aHotKey & ~MD_MODIFIER_MASK;
|
|
int mod = aHotKey & MD_MODIFIER_MASK;
|
|
|
|
if( key >= 'a' && key <= 'z' )
|
|
key = std::toupper( key );
|
|
|
|
wxLogTrace( kicadTraceToolStack, wxS( "ACTION_MANAGER::RunHotKey Key: %s" ),
|
|
KeyNameFromKeyCode( aHotKey ) );
|
|
|
|
HOTKEY_LIST::const_iterator it = m_actionHotKeys.find( key | mod );
|
|
|
|
// If no luck, try without Shift, to handle keys that require it
|
|
// 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
|
|
if( it == m_actionHotKeys.end() )
|
|
{
|
|
wxLogTrace( kicadTraceToolStack,
|
|
wxS( "ACTION_MANAGER::RunHotKey No actions found, searching with key: %s" ),
|
|
KeyNameFromKeyCode( key | ( mod & ~MD_SHIFT ) ) );
|
|
|
|
it = m_actionHotKeys.find( key | ( mod & ~MD_SHIFT ) );
|
|
|
|
if( it == m_actionHotKeys.end() )
|
|
return false; // no appropriate action found for the hotkey
|
|
}
|
|
|
|
const std::list<TOOL_ACTION*>& actions = it->second;
|
|
|
|
// 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 = nullptr; // pointer to context action of the highest priority tool
|
|
std::vector<const TOOL_ACTION*> global; // pointers to global actions
|
|
// if there is no context action
|
|
|
|
for( const TOOL_ACTION* action : actions )
|
|
{
|
|
if( action->GetScope() == AS_GLOBAL )
|
|
{
|
|
// Store the global action in case there are no context actions to run
|
|
global.emplace_back( action );
|
|
continue;
|
|
}
|
|
|
|
TOOL_BASE* tool = m_toolMgr->FindTool( action->GetToolName() );
|
|
|
|
if( tool )
|
|
{
|
|
// Choose the action that goes to the tool with highest priority
|
|
// (i.e. is on the top of active tools stack)
|
|
priority = m_toolMgr->GetPriority( tool->GetId() );
|
|
|
|
if( priority >= 0 && priority > highestPriority )
|
|
{
|
|
highestPriority = priority;
|
|
context = action;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Get the selection to use to test if the action is enabled
|
|
SELECTION& sel = m_toolMgr->GetToolHolder()->GetCurrentSelection();
|
|
|
|
if( context )
|
|
{
|
|
bool runAction = true;
|
|
|
|
if( const ACTION_CONDITIONS* aCond = GetCondition( *context ) )
|
|
runAction = aCond->enableCondition( sel );
|
|
|
|
wxLogTrace( kicadTraceToolStack,
|
|
wxS( "ACTION_MANAGER::RunHotKey %s context action: %s for hotkey %s" ),
|
|
runAction ? wxS( "Running" ) : wxS( "Not running" ),
|
|
context->GetName(),
|
|
KeyNameFromKeyCode( aHotKey ) );
|
|
|
|
if( runAction )
|
|
return m_toolMgr->RunAction( *context, true );
|
|
}
|
|
else if( !global.empty() )
|
|
{
|
|
for( const TOOL_ACTION* act : global )
|
|
{
|
|
bool runAction = true;
|
|
|
|
if( const ACTION_CONDITIONS* aCond = GetCondition( *act ) )
|
|
runAction = aCond->enableCondition( sel );
|
|
|
|
wxLogTrace( kicadTraceToolStack,
|
|
wxS( "ACTION_MANAGER::RunHotKey %s global action: %s for hotkey %s" ),
|
|
runAction ? wxS( "Running" ) : wxS( "Not running" ),
|
|
act->GetName(),
|
|
KeyNameFromKeyCode( aHotKey ) );
|
|
|
|
if( runAction && m_toolMgr->RunAction( *act, true ) )
|
|
return true;
|
|
}
|
|
}
|
|
|
|
wxLogTrace( kicadTraceToolStack,
|
|
wxS( "ACTION_MANAGER::RunHotKey No action found for key %s" ),
|
|
KeyNameFromKeyCode( aHotKey ) );
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
const std::map<std::string, TOOL_ACTION*>& ACTION_MANAGER::GetActions() const
|
|
{
|
|
return m_actionNameIndex;
|
|
}
|
|
|
|
|
|
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;
|
|
}
|
|
|
|
|
|
void ACTION_MANAGER::UpdateHotKeys( bool aFullUpdate )
|
|
{
|
|
static std::map<std::string, int> legacyHotKeyMap;
|
|
static std::map<std::string, int> userHotKeyMap;
|
|
static bool mapsInitialized = false;
|
|
|
|
m_actionHotKeys.clear();
|
|
m_hotkeys.clear();
|
|
|
|
if( aFullUpdate && !mapsInitialized && m_toolMgr->GetToolHolder() )
|
|
{
|
|
ReadLegacyHotkeyConfig( m_toolMgr->GetToolHolder()->ConfigBaseName(), legacyHotKeyMap );
|
|
ReadHotKeyConfig( wxEmptyString, userHotKeyMap );
|
|
mapsInitialized = true;
|
|
}
|
|
|
|
for( const auto& ii : m_actionNameIndex )
|
|
{
|
|
TOOL_ACTION* action = ii.second;
|
|
int hotkey = 0;
|
|
|
|
if( aFullUpdate )
|
|
hotkey = processHotKey( action, legacyHotKeyMap, userHotKeyMap );
|
|
else
|
|
hotkey = action->GetHotKey();
|
|
|
|
if( hotkey > 0 )
|
|
m_actionHotKeys[hotkey].push_back( action );
|
|
|
|
m_hotkeys[action->GetId()] = hotkey;
|
|
}
|
|
}
|
|
|
|
|
|
int ACTION_MANAGER::processHotKey( TOOL_ACTION* aAction,
|
|
const std::map<std::string, int>& aLegacyMap,
|
|
const std::map<std::string, int>& aHotKeyMap )
|
|
{
|
|
aAction->m_hotKey = aAction->m_defaultHotKey;
|
|
|
|
if( !aAction->m_legacyName.empty() && aLegacyMap.count( aAction->m_legacyName ) )
|
|
aAction->SetHotKey( aLegacyMap.at( aAction->m_legacyName ) );
|
|
|
|
if( aHotKeyMap.count( aAction->m_name ) )
|
|
aAction->SetHotKey( aHotKeyMap.at( aAction->m_name ) );
|
|
|
|
return aAction->m_hotKey;
|
|
}
|