KiCad PCB EDA Suite
hotkeys_basic.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) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 2010 Wayne Stambaugh <stambaughw@gmail.com>
6  * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #include <kiface_i.h>
27 #include <hotkeys_basic.h>
28 #include <id.h>
29 #include <kicad_string.h>
30 #include <eda_base_frame.h>
31 #include <eda_draw_frame.h>
33 
34 #include <tool/tool_manager.h>
36 #include <wx/apptrait.h>
37 #include <wx/stdpaths.h>
38 #include <wx/tokenzr.h>
39 #include <wx/txtstrm.h>
40 #include <wx/wfstream.h>
41 #include <tool/tool_action.h>
42 
43 
44 /*
45  * class to handle the printable name and the keycode
46  */
48 {
49  const wxChar* m_Name;
50  int m_KeyCode;
51 };
52 
53 /* table giving the hotkey name from the hotkey code, for special keys
54  * Note : when modifiers (ATL, SHIFT, CTRL) do not modify
55  * the code of the key, do need to enter the modified key code
56  * For instance wxT( "F1" ), WXK_F1 handle F1, AltF1, CtrlF1 ...
57  * Key names are:
58  * "Space","Ctrl+Space","Alt+Space" or
59  * "Alt+A","Ctrl+F1", ...
60  */
61 #define KEY_NON_FOUND -1
63 {
64  { wxT( "F1" ), WXK_F1 },
65  { wxT( "F2" ), WXK_F2 },
66  { wxT( "F3" ), WXK_F3 },
67  { wxT( "F4" ), WXK_F4 },
68  { wxT( "F5" ), WXK_F5 },
69  { wxT( "F6" ), WXK_F6 },
70  { wxT( "F7" ), WXK_F7 },
71  { wxT( "F8" ), WXK_F8 },
72  { wxT( "F9" ), WXK_F9 },
73  { wxT( "F10" ), WXK_F10 },
74  { wxT( "F11" ), WXK_F11 },
75  { wxT( "F12" ), WXK_F12 },
76 
77  { wxT( "Esc" ), WXK_ESCAPE },
78  { wxT( "Del" ), WXK_DELETE },
79  { wxT( "Tab" ), WXK_TAB },
80  { wxT( "Back" ), WXK_BACK },
81  { wxT( "Ins" ), WXK_INSERT },
82 
83  { wxT( "Home" ), WXK_HOME },
84  { wxT( "End" ), WXK_END },
85  { wxT( "PgUp" ), WXK_PAGEUP },
86  { wxT( "PgDn" ), WXK_PAGEDOWN },
87 
88  { wxT( "Up" ), WXK_UP },
89  { wxT( "Down" ), WXK_DOWN },
90  { wxT( "Left" ), WXK_LEFT },
91  { wxT( "Right" ), WXK_RIGHT },
92 
93  { wxT( "Return" ), WXK_RETURN },
94 
95  { wxT( "Space" ), WXK_SPACE },
96 
97  { wxT( "Num Pad 0" ), WXK_NUMPAD0 },
98  { wxT( "Num Pad 1" ), WXK_NUMPAD1 },
99  { wxT( "Num Pad 2" ), WXK_NUMPAD2 },
100  { wxT( "Num Pad 3" ), WXK_NUMPAD3 },
101  { wxT( "Num Pad 4" ), WXK_NUMPAD4 },
102  { wxT( "Num Pad 5" ), WXK_NUMPAD5 },
103  { wxT( "Num Pad 6" ), WXK_NUMPAD6 },
104  { wxT( "Num Pad 7" ), WXK_NUMPAD7 },
105  { wxT( "Num Pad 8" ), WXK_NUMPAD8 },
106  { wxT( "Num Pad 9" ), WXK_NUMPAD9 },
107  { wxT( "Num Pad +" ), WXK_NUMPAD_ADD },
108  { wxT( "Num Pad -" ), WXK_NUMPAD_SUBTRACT },
109  { wxT( "Num Pad *" ), WXK_NUMPAD_MULTIPLY },
110  { wxT( "Num Pad /" ), WXK_NUMPAD_DIVIDE },
111  { wxT( "Num Pad ." ), WXK_NUMPAD_SEPARATOR },
112 
113  { wxT( "" ), 0 },
114 
115  { wxT( "Click" ), PSEUDO_WXK_CLICK },
116  { wxT( "DblClick" ), PSEUDO_WXK_DBLCLICK },
117  { wxT( "Wheel" ), PSEUDO_WXK_WHEEL },
118 
119  // Do not change this line: end of list
120  { wxT( "" ), KEY_NON_FOUND }
121 };
122 
123 // name of modifier keys.
124 // Note: the Ctrl key is Cmd key on Mac OS X.
125 // However, in wxWidgets defs, the key WXK_CONTROL is the Cmd key,
126 // so the code using WXK_CONTROL should be ok on any system.
127 // (on Mac OS X the actual Ctrl key code is WXK_RAW_CONTROL)
128 #ifdef __WXMAC__
129 #define USING_MAC_CMD
130 #endif
131 
132 #ifdef USING_MAC_CMD
133 #define MODIFIER_CTRL wxT( "Cmd+" )
134 #else
135 #define MODIFIER_CTRL wxT( "Ctrl+" )
136 #endif
137 #define MODIFIER_CMD_MAC wxT( "Cmd+" )
138 #define MODIFIER_CTRL_BASE wxT( "Ctrl+" )
139 #define MODIFIER_ALT wxT( "Alt+" )
140 #define MODIFIER_SHIFT wxT( "Shift+" )
141 
142 
152 wxString KeyNameFromKeyCode( int aKeycode, bool* aIsFound )
153 {
154  wxString keyname, modifier, fullkeyname;
155  int ii;
156  bool found = false;
157 
158  // Assume keycode of 0 is "unassigned"
159  if( (aKeycode & MD_CTRL) != 0 )
160  modifier << MODIFIER_CTRL;
161 
162  if( (aKeycode & MD_ALT) != 0 )
163  modifier << MODIFIER_ALT;
164 
165  if( (aKeycode & MD_SHIFT) != 0 )
166  modifier << MODIFIER_SHIFT;
167 
168  aKeycode &= ~( MD_CTRL | MD_ALT | MD_SHIFT );
169 
170  if( (aKeycode > ' ') && (aKeycode < 0x7F ) )
171  {
172  found = true;
173  keyname.Append( (wxChar)aKeycode );
174  }
175  else
176  {
177  for( ii = 0; ; ii++ )
178  {
179  if( hotkeyNameList[ii].m_KeyCode == KEY_NON_FOUND ) // End of list
180  {
181  keyname = wxT( "<unknown>" );
182  break;
183  }
184 
185  if( hotkeyNameList[ii].m_KeyCode == aKeycode )
186  {
187  keyname = hotkeyNameList[ii].m_Name;
188  found = true;
189  break;
190  }
191  }
192  }
193 
194  if( aIsFound )
195  *aIsFound = found;
196 
197  fullkeyname = modifier + keyname;
198  return fullkeyname;
199 }
200 
201 
208 wxString AddHotkeyName( const wxString& aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle )
209 {
210  wxString msg = aText;
211  wxString keyname = KeyNameFromKeyCode( aHotKey );
212 
213  if( !keyname.IsEmpty() )
214  {
215  switch( aStyle )
216  {
217  case IS_HOTKEY:
218  {
219  // Don't add a suffix for unassigned hotkeys:
220  // WX spews debug from wxAcceleratorEntry::ParseAccel if it doesn't
221  // recognize the keyname, which is the case for <unassigned>.
222  if( aHotKey != 0 )
223  {
224  msg << wxT( "\t" ) << keyname;
225  }
226  break;
227  }
228  case IS_COMMENT:
229  {
230  msg << wxT( " (" ) << keyname << wxT( ")" );
231  break;
232  }
233  }
234  }
235 
236 #ifdef USING_MAC_CMD
237  // On OSX, the modifier equivalent to the Ctrl key of PCs
238  // is the Cmd key, but in code we should use Ctrl as prefix in menus
239  msg.Replace( MODIFIER_CMD_MAC, MODIFIER_CTRL_BASE );
240 #endif
241 
242  return msg;
243 }
244 
245 
249 int KeyCodeFromKeyName( const wxString& keyname )
250 {
251  int ii, keycode = KEY_NON_FOUND;
252 
253  // Search for modifiers: Ctrl+ Alt+ and Shift+
254  // Note: on Mac OSX, the Cmd key is equiv here to Ctrl
255  wxString key = keyname;
256  wxString prefix;
257  int modifier = 0;
258 
259  while( true )
260  {
261  prefix.Empty();
262 
263  if( key.StartsWith( MODIFIER_CTRL_BASE ) )
264  {
265  modifier |= MD_CTRL;
266  prefix = MODIFIER_CTRL_BASE;
267  }
268  else if( key.StartsWith( MODIFIER_CMD_MAC ) )
269  {
270  modifier |= MD_CTRL;
271  prefix = MODIFIER_CMD_MAC;
272  }
273  else if( key.StartsWith( MODIFIER_ALT ) )
274  {
275  modifier |= MD_ALT;
276  prefix = MODIFIER_ALT;
277  }
278  else if( key.StartsWith( MODIFIER_SHIFT ) )
279  {
280  modifier |= MD_SHIFT;
281  prefix = MODIFIER_SHIFT;
282  }
283  else
284  {
285  break;
286  }
287 
288  if( !prefix.IsEmpty() )
289  key.Remove( 0, prefix.Len() );
290  }
291 
292  if( (key.length() == 1) && (key[0] > ' ') && (key[0] < 0x7F) )
293  {
294  keycode = key[0];
295  keycode += modifier;
296  return keycode;
297  }
298 
299  for( ii = 0; hotkeyNameList[ii].m_KeyCode != KEY_NON_FOUND; ii++ )
300  {
301  if( key.CmpNoCase( hotkeyNameList[ii].m_Name ) == 0 )
302  {
303  keycode = hotkeyNameList[ii].m_KeyCode + modifier;
304  break;
305  }
306  }
307 
308  return keycode;
309 }
310 
311 
312 /*
313  * Displays the hotkeys registered with the given tool manager.
314  */
315 void DisplayHotkeyList( EDA_BASE_FRAME* aParent, TOOL_MANAGER* aToolManager )
316 {
317  DIALOG_LIST_HOTKEYS dlg( aParent, aToolManager );
318  dlg.ShowModal();
319 }
320 
321 
322 void ReadHotKeyConfig( const wxString& aFileName, std::map<std::string, int>& aHotKeys )
323 {
324  wxString fileName = aFileName;
325 
326  if( fileName.IsEmpty() )
327  {
328  wxFileName fn( "user" );
329  fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
331  fileName = fn.GetFullPath();
332  }
333 
334  if( !wxFile::Exists( fileName ) )
335  return;
336 
337  wxFFile file( fileName, "rb" );
338 
339  if( !file.IsOpened() ) // There is a problem to open file
340  return;
341 
342  wxString input;
343  file.ReadAll( &input );
344  input.Replace( "\r\n", "\n" ); // Convert Windows files to Unix line-ends
345  wxStringTokenizer fileTokenizer( input, "\n", wxTOKEN_STRTOK );
346 
347  while( fileTokenizer.HasMoreTokens() )
348  {
349  wxStringTokenizer lineTokenizer( fileTokenizer.GetNextToken(), "\t" );
350 
351  wxString cmdName = lineTokenizer.GetNextToken();
352  wxString keyName = lineTokenizer.GetNextToken();
353 
354  if( !cmdName.IsEmpty() )
355  aHotKeys[ cmdName.ToStdString() ] = KeyCodeFromKeyName( keyName );
356  }
357 }
358 
359 
360 int WriteHotKeyConfig( const std::map<std::string, TOOL_ACTION*>& aActionMap )
361 {
362  std::map<std::string, int> hotkeys;
363  wxFileName fn( "user" );
364 
365  fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
367 
368  // Read the existing config (all hotkeys)
369  ReadHotKeyConfig( fn.GetFullPath(), hotkeys );
370 
371  // Overlay the current app's hotkey definitions onto the map
372  for( const auto& ii : aActionMap )
373  hotkeys[ ii.first ] = ii.second->GetHotKey();
374 
375  // Write entire hotkey set
376  wxFFileOutputStream outStream( fn.GetFullPath() );
377  wxTextOutputStream txtStream( outStream, wxEOL_UNIX );
378 
379  for( const auto& ii : hotkeys )
380  txtStream << wxString::Format( "%s\t%s", ii.first,
381  KeyNameFromKeyCode( ii.second ) ) << endl;
382 
383  txtStream.Flush();
384  outStream.Close();
385 
386  return 1;
387 }
388 
389 
390 int ReadLegacyHotkeyConfig( const wxString& aAppname, std::map<std::string, int>& aMap )
391 {
392  // For Eeschema and Pcbnew frames, we read the new combined file.
393  // For other kifaces, we read the frame-based file
394  if( aAppname == LIB_EDIT_FRAME_NAME || aAppname == SCH_EDIT_FRAME_NAME )
395  {
397  }
398  else if( aAppname == PCB_EDIT_FRAME_NAME || aAppname == FOOTPRINT_EDIT_FRAME_NAME )
399  {
401  }
402 
403  return ReadLegacyHotkeyConfigFile( aAppname, aMap );
404 }
405 
406 
407 int ReadLegacyHotkeyConfigFile( const wxString& aFilename, std::map<std::string, int>& aMap )
408 {
409  wxFileName fn( aFilename );
410 
411  fn.SetExt( DEFAULT_HOTKEY_FILENAME_EXT );
413 
414  if( !wxFile::Exists( fn.GetFullPath() ) )
415  return 0;
416 
417  wxFFile cfgfile( fn.GetFullPath(), "rb" );
418 
419  if( !cfgfile.IsOpened() ) // There is a problem to open file
420  return 0;
421 
422  // get length
423  wxFileOffset size = cfgfile.Length();
424 
425  // read data
426  std::vector<char> buffer( size );
427  cfgfile.Read( buffer.data(), size );
428  wxString data( buffer.data(), wxConvUTF8, size );
429 
430  // Is this the wxConfig format? If so, remove "Keys=" and parse the newlines.
431  if( data.StartsWith( wxT("Keys="), &data ) )
432  data.Replace( "\\n", "\n", true );
433 
434  // parse
435  wxStringTokenizer tokenizer( data, L"\r\n", wxTOKEN_STRTOK );
436 
437  while( tokenizer.HasMoreTokens() )
438  {
439  wxString line = tokenizer.GetNextToken();
440  wxStringTokenizer lineTokenizer( line );
441 
442  wxString line_type = lineTokenizer.GetNextToken();
443 
444  if( line_type[0] == '#' ) // comment
445  continue;
446 
447  if( line_type[0] == '[' ) // tags ignored reading legacy hotkeys
448  continue;
449 
450  if( line_type == wxT( "$Endlist" ) )
451  break;
452 
453  if( line_type != wxT( "shortcut" ) )
454  continue;
455 
456  // Get the key name
457  lineTokenizer.SetString( lineTokenizer.GetString(), L"\"\r\n\t ", wxTOKEN_STRTOK );
458  wxString keyname = lineTokenizer.GetNextToken();
459 
460  wxString remainder = lineTokenizer.GetString();
461 
462  // Get the command name
463  wxString fctname = remainder.AfterFirst( '\"' ).BeforeFirst( '\"' );
464 
465  // Add the pair to the map
466  aMap[ fctname.ToStdString() ] = KeyCodeFromKeyName( keyname );
467  }
468 
469  // cleanup
470  cfgfile.Close();
471  return 1;
472 }
473 
474 
const wxChar * m_Name
#define MODIFIER_CTRL_BASE
#define KEY_NON_FOUND
Hotkey list dialog (as opposed to editor)
A dialog that presents the user with a read-only list of hotkeys and their current bindings.
wxString AddHotkeyName(const wxString &aText, int aHotKey, HOTKEY_ACTION_TYPE aStyle)
#define PSEUDO_WXK_WHEEL
Definition: hotkeys_basic.h:52
void ReadHotKeyConfig(const wxString &aFileName, std::map< std::string, int > &aHotKeys)
Reads a hotkey config file into a map.
int ReadLegacyHotkeyConfigFile(const wxString &aFilename, std::map< std::string, int > &aMap)
Read hotkey configuration for a given app.
#define LIB_EDIT_FRAME_NAME
Master controller class:
Definition: tool_manager.h:52
#define MODIFIER_CTRL
#define SCH_EDIT_FRAME_NAME
int ReadLegacyHotkeyConfig(const wxString &aAppname, std::map< std::string, int > &aMap)
Read configuration data and fill the current hotkey list with hotkeys.
void DisplayHotkeyList(EDA_BASE_FRAME *aParent, TOOL_MANAGER *aToolManager)
Display the current hotkey list.
#define PSEUDO_WXK_CLICK
Definition: hotkeys_basic.h:50
int KeyCodeFromKeyName(const wxString &keyname)
Return the key code from its user-friendly key name (ie: "Ctrl+M").
#define MODIFIER_SHIFT
Base window classes and related definitions.
#define FOOTPRINT_EDIT_FRAME_NAME
static wxString GetUserSettingsPath()
Return the user configuration path used to store KiCad's configuration files.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
The base frame for deriving all KiCad main window classes.
#define MODIFIER_ALT
#define MODIFIER_CMD_MAC
#define EESCHEMA_HOTKEY_NAME
Definition: hotkeys_basic.h:31
wxString KeyNameFromKeyCode(int aKeycode, bool *aIsFound)
Return the key name from the key code.
#define PCB_EDIT_FRAME_NAME
#define DEFAULT_HOTKEY_FILENAME_EXT
Definition: hotkeys_basic.h:30
#define PSEUDO_WXK_DBLCLICK
Definition: hotkeys_basic.h:51
HOTKEY_ACTION_TYPE
In menus we can add a hot key, or an accelerator, or sometimes just a comment.
Definition: hotkeys_basic.h:75
#define PCBNEW_HOTKEY_NAME
Definition: hotkeys_basic.h:32
int WriteHotKeyConfig(const std::map< std::string, TOOL_ACTION * > &aActionMap)
Update the hotkeys config file with the hotkeys from the given actions map.
static struct hotkey_name_descr hotkeyNameList[]