hotkeys_basic.cpp File Reference

#include <kiface_i.h>
#include <hotkeys_basic.h>
#include <id.h>
#include <kicad_string.h>
#include <eda_base_frame.h>
#include <eda_draw_frame.h>
#include <settings/settings_manager.h>
#include <tool/tool_manager.h>
#include "dialogs/dialog_hotkey_list.h"
#include <wx/apptrait.h>
#include <wx/stdpaths.h>
#include <wx/tokenzr.h>
#include <wx/txtstrm.h>
#include <wx/wfstream.h>
#include <tool/tool_action.h>

Go to the source code of this file.

Classes
struct	hotkey_name_descr

Macros
#define	KEY_NON_FOUND   -1
#define	MODIFIER_CTRL   wxT( "Ctrl+" )
#define	MODIFIER_CMD_MAC   wxT( "Cmd+" )
#define	MODIFIER_CTRL_BASE   wxT( "Ctrl+" )
#define	MODIFIER_ALT   wxT( "Alt+" )
#define	MODIFIER_SHIFT   wxT( "Shift+" )

Functions
wxString	KeyNameFromKeyCode (int aKeycode, bool *aIsFound)
	Return the key name from the key code. More...
wxString	AddHotkeyName (const wxString &aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle)
int	KeyCodeFromKeyName (const wxString &keyname)
	Return the key code from its user-friendly key name (ie: "Ctrl+M"). More...
void	DisplayHotkeyList (EDA_BASE_FRAME *aParent, TOOL_MANAGER *aToolManager)
	Display the current hotkey list. More...
void	ReadHotKeyConfig (const wxString &aFileName, std::map< std::string, int > &aHotKeys)
	Reads a hotkey config file into a map. More...
int	WriteHotKeyConfig (const std::map< std::string, TOOL_ACTION * > &aActionMap)
	Update the hotkeys config file with the hotkeys from the given actions map. More...
int	ReadLegacyHotkeyConfig (const wxString &aAppname, std::map< std::string, int > &aMap)
	Read configuration data and fill the current hotkey list with hotkeys. More...
int	ReadLegacyHotkeyConfigFile (const wxString &aFilename, std::map< std::string, int > &aMap)
	Read hotkey configuration for a given app. More...

Variables
static struct hotkey_name_descr	hotkeyNameList []

Macro Definition Documentation

KEY_NON_FOUND

#define KEY_NON_FOUND   -1

Definition at line 61 of file hotkeys_basic.cpp.

MODIFIER_ALT

#define MODIFIER_ALT   wxT( "Alt+" )

Definition at line 139 of file hotkeys_basic.cpp.

MODIFIER_CMD_MAC

#define MODIFIER_CMD_MAC   wxT( "Cmd+" )

Definition at line 137 of file hotkeys_basic.cpp.

MODIFIER_CTRL

#define MODIFIER_CTRL   wxT( "Ctrl+" )

Definition at line 135 of file hotkeys_basic.cpp.

MODIFIER_CTRL_BASE

#define MODIFIER_CTRL_BASE   wxT( "Ctrl+" )

Definition at line 138 of file hotkeys_basic.cpp.

MODIFIER_SHIFT

#define MODIFIER_SHIFT   wxT( "Shift+" )

Definition at line 140 of file hotkeys_basic.cpp.

Function Documentation

AddHotkeyName()

wxString AddHotkeyName	(	const wxString &	aText,
		int	aHotKey,
		HOTKEY_ACTION_TYPE	aStyle
	)

Parameters

aText	the base text on which to append the hotkey.
aHotKey	the hotkey keycode.
aStyle	IS_HOTKEY to add <tab><keyname> (shortcuts in menus, same as hotkeys). IS_COMMENT to add <spaces><(keyname)> mainly in tool tips.

Definition at line 208 of file hotkeys_basic.cpp.

{
    wxString msg = aText;
    wxString keyname = KeyNameFromKeyCode( aHotKey );

    if( !keyname.IsEmpty() )
    {
        switch( aStyle )
        {
        case IS_HOTKEY:
        {
            // Don't add a suffix for unassigned hotkeys:
            // WX spews debug from wxAcceleratorEntry::ParseAccel if it doesn't
            // recognize the keyname, which is the case for <unassigned>.
            if( aHotKey != 0 )
            {
                msg << wxT( "\t" ) << keyname;
            }
            break;
        }
        case IS_COMMENT:
        {
            msg << wxT( " (" ) << keyname << wxT( ")" );
            break;
        }
        }
    }

#ifdef USING_MAC_CMD
    // On OSX, the modifier equivalent to the Ctrl key of PCs
    // is the Cmd key, but in code we should use Ctrl as prefix in menus
    msg.Replace( MODIFIER_CMD_MAC, MODIFIER_CTRL_BASE );
#endif

    return msg;
}

References IS_COMMENT, IS_HOTKEY, KeyNameFromKeyCode(), MODIFIER_CMD_MAC, and MODIFIER_CTRL_BASE.

Referenced by TOOL_ACTION::GetMenuItem(), and PCB_LAYER_BOX_SELECTOR::Resync().

DisplayHotkeyList()

void DisplayHotkeyList	(	EDA_BASE_FRAME *	aFrame,
		TOOL_MANAGER *	aToolMgr
	)

Display the current hotkey list.

Parameters

aFrame	current active frame.
aToolMgr	the tool manager holding the registered actions from which the hotkeys will be harvested.

Definition at line 315 of file hotkeys_basic.cpp.

{
    DIALOG_LIST_HOTKEYS dlg( aParent, aToolManager );
    dlg.ShowModal();
}

Referenced by COMMON_CONTROL::ListHotKeys().

KeyCodeFromKeyName()

int KeyCodeFromKeyName

(

const wxString &

keyname

)

Return the key code from its user-friendly key name (ie: "Ctrl+M").

Definition at line 249 of file hotkeys_basic.cpp.

{
    int ii, keycode = KEY_NON_FOUND;

    // Search for modifiers: Ctrl+ Alt+ and Shift+
    // Note: on Mac OSX, the Cmd key is equiv here to Ctrl
    wxString key = keyname;
    wxString prefix;
    int modifier = 0;

    while( true )
    {
        prefix.Empty();

        if( key.StartsWith( MODIFIER_CTRL_BASE ) )
        {
            modifier |= MD_CTRL;
            prefix = MODIFIER_CTRL_BASE;
        }
        else if( key.StartsWith( MODIFIER_CMD_MAC ) )
        {
            modifier |= MD_CTRL;
            prefix = MODIFIER_CMD_MAC;
        }
        else if( key.StartsWith( MODIFIER_ALT ) )
        {
            modifier |= MD_ALT;
            prefix = MODIFIER_ALT;
        }
        else if( key.StartsWith( MODIFIER_SHIFT ) )
        {
            modifier |= MD_SHIFT;
            prefix = MODIFIER_SHIFT;
        }
        else
        {
            break;
        }

        if( !prefix.IsEmpty() )
            key.Remove( 0, prefix.Len() );
    }

    if( (key.length() == 1) && (key[0] > ' ') && (key[0] < 0x7F) )
    {
        keycode = key[0];
        keycode += modifier;
        return keycode;
    }

    for( ii = 0; hotkeyNameList[ii].m_KeyCode != KEY_NON_FOUND; ii++ )
    {
        if( key.CmpNoCase( hotkeyNameList[ii].m_Name ) == 0 )
        {
            keycode = hotkeyNameList[ii].m_KeyCode + modifier;
            break;
        }
    }

    return keycode;
}

References hotkeyNameList, KEY_NON_FOUND, hotkey_name_descr::m_KeyCode, hotkey_name_descr::m_Name, MD_ALT, MD_CTRL, MD_SHIFT, MODIFIER_ALT, MODIFIER_CMD_MAC, MODIFIER_CTRL_BASE, and MODIFIER_SHIFT.

Referenced by ReadHotKeyConfig(), and ReadLegacyHotkeyConfigFile().

KeyNameFromKeyCode()

wxString KeyNameFromKeyCode	(	int	aKeycode,
		bool *	aIsFound
	)

Return the key name from the key code.

Return the user friendly key name (ie: "Ctrl+M") from the key code.

Only some wxWidgets key values are handled for function key ( see hotkeyNameList[] )

Parameters

aKeycode	key code (ASCII value, or wxWidgets value for function keys).
aIsFound	a pointer to a bool to return true if found, or false. an be nullptr default).

Returns

the key name in a wxString.

Definition at line 152 of file hotkeys_basic.cpp.

{
    wxString keyname, modifier, fullkeyname;
    int      ii;
    bool     found = false;

    // Assume keycode of 0 is "unassigned"
    if( (aKeycode & MD_CTRL) != 0 )
        modifier << MODIFIER_CTRL;

    if( (aKeycode & MD_ALT) != 0 )
        modifier << MODIFIER_ALT;

    if( (aKeycode & MD_SHIFT) != 0 )
        modifier << MODIFIER_SHIFT;

    aKeycode &= ~( MD_CTRL | MD_ALT | MD_SHIFT );

    if( (aKeycode > ' ') && (aKeycode < 0x7F ) )
    {
        found   = true;
        keyname.Append( (wxChar)aKeycode );
    }
    else
    {
        for( ii = 0; ; ii++ )
        {
            if( hotkeyNameList[ii].m_KeyCode == KEY_NON_FOUND ) // End of list
            {
                keyname = wxT( "<unknown>" );
                break;
            }

            if( hotkeyNameList[ii].m_KeyCode == aKeycode )
            {
                keyname = hotkeyNameList[ii].m_Name;
                found   = true;
                break;
            }
        }
    }

    if( aIsFound )
        *aIsFound = found;

    fullkeyname = modifier + keyname;
    return fullkeyname;
}

References hotkeyNameList, KEY_NON_FOUND, hotkey_name_descr::m_KeyCode, hotkey_name_descr::m_Name, MD_ALT, MD_CTRL, MD_SHIFT, MODIFIER_ALT, MODIFIER_CTRL, and MODIFIER_SHIFT.

Referenced by AddHotkeyName(), WIDGET_HOTKEY_LIST::changeHotkey(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), PAD_TOOL::EditPad(), HOTKEY_FILTER::FilterMatches(), TOOL_ACTION::GetDescription(), WIDGET_HOTKEY_LIST::resolveKeyConflicts(), ACTION_MANAGER::RunHotKey(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), WIDGET_HOTKEY_LIST::updateFromClientData(), and WriteHotKeyConfig().

ReadHotKeyConfig()

void ReadHotKeyConfig	(	const wxString &	aFileName,
		std::map< std::string, int > &	aHotKeys
	)

Reads a hotkey config file into a map.

If aFileName is empty it will read in the default hotkeys file.

Definition at line 322 of file hotkeys_basic.cpp.

{
    wxString fileName = aFileName;

    if( fileName.IsEmpty() )
    {
        wxFileName fn( "user" );
        fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
        fn.SetPath( SETTINGS_MANAGER::GetUserSettingsPath() );
        fileName = fn.GetFullPath();
    }

    if( !wxFile::Exists( fileName ) )
        return;

    wxFFile file( fileName, "rb" );

    if( !file.IsOpened() )       // There is a problem to open file
        return;

    wxString input;
    file.ReadAll( &input );
    input.Replace( "\r\n", "\n" );  // Convert Windows files to Unix line-ends
    wxStringTokenizer fileTokenizer( input, "\n", wxTOKEN_STRTOK );

    while( fileTokenizer.HasMoreTokens() )
    {
        wxStringTokenizer lineTokenizer( fileTokenizer.GetNextToken(), "\t" );

        wxString cmdName = lineTokenizer.GetNextToken();
        wxString keyName = lineTokenizer.GetNextToken();

        if( !cmdName.IsEmpty() )
            aHotKeys[ cmdName.ToStdString() ] = KeyCodeFromKeyName( keyName );
    }
}

References DEFAULT_HOTKEY_FILENAME_EXT, SETTINGS_MANAGER::GetUserSettingsPath(), and KeyCodeFromKeyName().

Referenced by PANEL_HOTKEYS_EDITOR::ImportHotKeys(), ACTION_MANAGER::UpdateHotKeys(), and WriteHotKeyConfig().

ReadLegacyHotkeyConfig()

int ReadLegacyHotkeyConfig	(	const wxString &	aAppname,
		std::map< std::string, int > &	aMap
	)

Read configuration data and fill the current hotkey list with hotkeys.

Parameters

aAppname	the value of the app's m_FrameName.
aMap	The list of keycodes mapped by legacy property names.

Definition at line 390 of file hotkeys_basic.cpp.

{
    // For Eeschema and Pcbnew frames, we read the new combined file.
    // For other kifaces, we read the frame-based file
    if( aAppname == LIB_EDIT_FRAME_NAME || aAppname == SCH_EDIT_FRAME_NAME )
    {
        return ReadLegacyHotkeyConfigFile( EESCHEMA_HOTKEY_NAME, aMap );
    }
    else if( aAppname == PCB_EDIT_FRAME_NAME || aAppname == FOOTPRINT_EDIT_FRAME_NAME )
    {
        return ReadLegacyHotkeyConfigFile( PCBNEW_HOTKEY_NAME, aMap );
    }

    return ReadLegacyHotkeyConfigFile( aAppname, aMap );
}

References EESCHEMA_HOTKEY_NAME, FOOTPRINT_EDIT_FRAME_NAME, LIB_EDIT_FRAME_NAME, PCB_EDIT_FRAME_NAME, PCBNEW_HOTKEY_NAME, ReadLegacyHotkeyConfigFile(), and SCH_EDIT_FRAME_NAME.

Referenced by ACTION_MANAGER::UpdateHotKeys().

ReadLegacyHotkeyConfigFile()

int ReadLegacyHotkeyConfigFile	(	const wxString &	aFilename,
		std::map< std::string, int > &	aMap
	)

Read hotkey configuration for a given app.

Parameters

aFilename	the filename to save the hotkeys as.
aMap	The list of keycodes mapped by legacy property names.

Returns

1 on success, 0 on failure.

Definition at line 407 of file hotkeys_basic.cpp.

{
    wxFileName fn( aFilename );

    fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
    fn.SetPath( SETTINGS_MANAGER::GetUserSettingsPath() );

    if( !wxFile::Exists( fn.GetFullPath() ) )
        return 0;

    wxFFile cfgfile( fn.GetFullPath(), "rb" );

    if( !cfgfile.IsOpened() )       // There is a problem to open file
        return 0;

    // get length
    wxFileOffset size = cfgfile.Length();

    // read data
    std::vector<char> buffer( size );
    cfgfile.Read( buffer.data(), size );
    wxString data( buffer.data(), wxConvUTF8, size );

    // Is this the wxConfig format? If so, remove "Keys=" and parse the newlines.
    if( data.StartsWith( wxT("Keys="), &data ) )
        data.Replace( "\\n", "\n", true );

    // parse
    wxStringTokenizer tokenizer( data, L"\r\n", wxTOKEN_STRTOK );

    while( tokenizer.HasMoreTokens() )
    {
        wxString          line = tokenizer.GetNextToken();
        wxStringTokenizer lineTokenizer( line );

        wxString          line_type = lineTokenizer.GetNextToken();

        if( line_type[0]  == '#' ) // comment
            continue;

        if( line_type[0]  == '[' ) // tags ignored reading legacy hotkeys
            continue;

        if( line_type == wxT( "$Endlist" ) )
            break;

        if( line_type != wxT( "shortcut" ) )
            continue;

        // Get the key name
        lineTokenizer.SetString( lineTokenizer.GetString(), L"\"\r\n\t ", wxTOKEN_STRTOK );
        wxString keyname = lineTokenizer.GetNextToken();

        wxString remainder = lineTokenizer.GetString();

        // Get the command name
        wxString fctname = remainder.AfterFirst( '\"' ).BeforeFirst( '\"' );

        // Add the pair to the map
        aMap[ fctname.ToStdString() ] = KeyCodeFromKeyName( keyname );
    }

    // cleanup
    cfgfile.Close();
    return 1;
}

References DEFAULT_HOTKEY_FILENAME_EXT, SETTINGS_MANAGER::GetUserSettingsPath(), and KeyCodeFromKeyName().

Referenced by ReadLegacyHotkeyConfig().

WriteHotKeyConfig()

int WriteHotKeyConfig

(

const std::map< std::string, TOOL_ACTION * > &

aActionMap

)

Update the hotkeys config file with the hotkeys from the given actions map.

Definition at line 360 of file hotkeys_basic.cpp.

{
    std::map<std::string, int> hotkeys;
    wxFileName fn( "user" );

    fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
    fn.SetPath( SETTINGS_MANAGER::GetUserSettingsPath() );

    // Read the existing config (all hotkeys)
    ReadHotKeyConfig( fn.GetFullPath(), hotkeys );

    // Overlay the current app's hotkey definitions onto the map
    for( const auto& ii : aActionMap )
        hotkeys[ ii.first ] = ii.second->GetHotKey();

    // Write entire hotkey set
    wxFFileOutputStream outStream( fn.GetFullPath() );
    wxTextOutputStream  txtStream( outStream, wxEOL_UNIX );

    for( const auto& ii : hotkeys )
        txtStream << wxString::Format( "%s\t%s", ii.first,
                                       KeyNameFromKeyCode( ii.second ) ) << endl;

    txtStream.Flush();
    outStream.Close();

    return 1;
}

References DEFAULT_HOTKEY_FILENAME_EXT, Format(), SETTINGS_MANAGER::GetUserSettingsPath(), hotkeys, KeyNameFromKeyCode(), and ReadHotKeyConfig().

Referenced by PANEL_HOTKEYS_EDITOR::TransferDataFromWindow().

Variable Documentation

hotkeyNameList

struct hotkey_name_descr hotkeyNameList[]

static

Definition at line 62 of file hotkeys_basic.cpp.

Referenced by KeyCodeFromKeyName(), and KeyNameFromKeyCode().