lib/keybind.c

   1 /*
   2    Definitions of key bindings.
   3
   4    Copyright (C) 2009, 2011
   5    The Free Software Foundation, Inc.
   6
   7    Written by:
   8    Vitja Makarov, 2005
   9    Ilia Maslakov <il.smind@gmail.com>, 2009
  10    Andrew Borodin <aborodin@vmail.ru>, 2009, 2010
  11
  12    This file is part of the Midnight Commander.
  13
  14    The Midnight Commander is free software: you can redistribute it
  15    and/or modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation, either version 3 of the License,
  17    or (at your option) any later version.
  18
  19    The Midnight Commander is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22    GNU General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public License
  25    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  26  */
  27
  28 #include <config.h>
  29
  30 #include <ctype.h>
  31 #include <stdlib.h>
  32 #include <string.h>
  33 #include <sys/types.h>
  34
  35 #include "lib/global.h"
  36 #include "lib/tty/key.h"        /* KEY_M_ */
  37 #include "lib/keybind.h"
  38
  39 /*** global variables ****************************************************************************/
  40
  41 /*** file scope macro definitions ****************************************************************/
  42
  43 /*** file scope type declarations ****************************************************************/
  44
  45 /*** file scope variables ************************************************************************/
  46
  47 static name_keymap_t command_names[] = {
  48     /* common */
  49     {"Enter", CK_Enter},
  50     {"Up", CK_Up},
  51     {"Down", CK_Down},
  52     {"Left", CK_Left},
  53     {"Right", CK_Right},
  54     {"LeftQuick", CK_LeftQuick},
  55     {"RightQuick", CK_RightQuick},
  56     {"Home", CK_Home},
  57     {"End", CK_End},
  58     {"PageUp", CK_PageUp},
  59     {"PageDown", CK_PageDown},
  60     {"HalfPageUp", CK_HalfPageUp},
  61     {"HalfPageDown", CK_HalfPageDown},
  62     {"Top", CK_Top},
  63     {"Bottom", CK_Bottom},
  64     {"TopOnScreen", CK_TopOnScreen},
  65     {"MiddleOnScreen", CK_MiddleOnScreen},
  66     {"BottomOnScreen", CK_BottomOnScreen},
  67     {"WordLeft", CK_WordLeft},
  68     {"WordRight", CK_WordRight},
  69     {"Copy", CK_Copy},
  70     {"Move", CK_Move},
  71     {"Delete", CK_Delete},
  72     {"MakeDir", CK_MakeDir},
  73     {"ChangeMode", CK_ChangeMode},
  74     {"ChangeOwn", CK_ChangeOwn},
  75     {"ChangeOwnAdvanced", CK_ChangeOwnAdvanced},
  76     {"Remove", CK_Remove},
  77     {"BackSpace", CK_BackSpace},
  78     {"Redo", CK_Redo},
  79     {"Clear", CK_Clear},
  80     {"Menu", CK_Menu},
  81     {"MenuLastSelected", CK_MenuLastSelected},
  82     {"UserMenu", CK_UserMenu},
  83     {"EditUserMenu", CK_EditUserMenu},
  84     {"Search", CK_Search},
  85     {"SearchContinue", CK_SearchContinue},
  86     {"Replace", CK_Replace},
  87     {"ReplaceContinue", CK_ReplaceContinue},
  88     {"Help", CK_Help},
  89     {"Shell", CK_Shell},
  90     {"Edit", CK_Edit},
  91     {"EditNew", CK_EditNew},
  92 #ifdef HAVE_CHARSET
  93     {"SelectCodepage", CK_SelectCodepage},
  94 #endif
  95     {"History", CK_History},
  96     {"HistoryNext", CK_HistoryNext},
  97     {"HistoryPrev", CK_HistoryPrev},
  98     {"Complete", CK_Complete},
  99     {"Save", CK_Save},
 100     {"SaveAs", CK_SaveAs},
 101     {"Goto", CK_Goto},
 102     {"Reread", CK_Reread},
 103     {"Refresh", CK_Refresh},
 104     {"Suspend", CK_Suspend},
 105     {"Swap", CK_Swap},
 106     {"HotList", CK_HotList},
 107     {"SelectInvert", CK_SelectInvert},
 108     {"ScreenList", CK_ScreenList},
 109     {"ScreenNext", CK_ScreenNext},
 110     {"ScreenPrev", CK_ScreenPrev},
 111     {"FileNext", CK_FileNext},
 112     {"FilePrev", CK_FilePrev},
 113     {"DeleteToHome", CK_DeleteToHome},
 114     {"DeleteToEnd", CK_DeleteToEnd},
 115     {"DeleteToWordBegin", CK_DeleteToWordBegin},
 116     {"DeleteToWordEnd", CK_DeleteToWordEnd},
 117     {"Cut", CK_Cut},
 118     {"Store", CK_Store},
 119     {"Paste", CK_Paste},
 120     {"Mark", CK_Mark},
 121     {"MarkLeft", CK_MarkLeft},
 122     {"MarkRight", CK_MarkRight},
 123     {"MarkUp", CK_MarkUp},
 124     {"MarkDown", CK_MarkDown},
 125     {"MarkToWordBegin", CK_MarkToWordBegin},
 126     {"MarkToWordEnd", CK_MarkToWordEnd},
 127     {"MarkToHome", CK_MarkToHome},
 128     {"MarkToEnd", CK_MarkToEnd},
 129     {"ToggleNavigation", CK_ToggleNavigation},
 130     {"Sort", CK_Sort},
 131     {"Options", CK_Options},
 132     {"LearnKeys", CK_LearnKeys},
 133     {"Bookmark", CK_Bookmark},
 134     {"Quit", CK_Quit},
 135     {"QuitQuiet", CK_QuitQuiet},
 136     {"ExtendedKeyMap", CK_ExtendedKeyMap},
 137
 138     /* main commands */
 139 #ifdef USE_INTERNAL_EDIT
 140     {"EditForceInternal", CK_EditForceInternal},
 141 #endif
 142     {"View", CK_View},
 143     {"ViewRaw", CK_ViewRaw},
 144     {"ViewFile", CK_ViewFile},
 145     {"ViewFiltered", CK_ViewFiltered},
 146     {"Find", CK_Find},
 147     {"DirSize", CK_DirSize},
 148     {"PanelListingSwitch", CK_PanelListingSwitch},
 149     {"CompareDirs", CK_CompareDirs},
 150 #ifdef USE_DIFF_VIEW
 151     {"CompareFiles", CK_CompareFiles},
 152 #endif
 153     {"OptionsVfs", CK_OptionsVfs},
 154     {"OptionsConfirm", CK_OptionsConfirm},
 155     {"OptionsDisplayBits", CK_OptionsDisplayBits},
 156     {"EditExtensionsFile", CK_EditExtensionsFile},
 157     {"EditFileHighlightFile", CK_EditFileHighlightFile},
 158     {"LinkSymbolicEdit", CK_LinkSymbolicEdit},
 159     {"ExternalPanelize", CK_ExternalPanelize},
 160     {"Filter", CK_Filter},
 161 #ifdef ENABLE_VFS_FISH
 162     {"ConnectFish", CK_ConnectFish},
 163 #endif
 164 #ifdef ENABLE_VFS_FTP
 165     {"ConnectFtp", CK_ConnectFtp},
 166 #endif
 167 #ifdef ENABLE_VFS_SMB
 168     {"ConnectSmb", CK_ConnectSmb},
 169 #endif
 170     {"PanelInfo", CK_PanelInfo},
 171 #ifdef ENABLE_BACKGROUND
 172     {"Jobs", CK_Jobs},
 173 #endif
 174     {"OptionsLayout", CK_OptionsLayout},
 175     {"Link", CK_Link},
 176     {"PanelListingChange", CK_PanelListingChange},
 177     {"PanelListing", CK_PanelListing},
 178 #ifdef LISTMODE_EDITOR
 179     {"ListMode", CK_ListMode}.
 180 #endif
 181     {"OptionsPanel", CK_OptionsPanel},
 182     {"CdQuick", CK_CdQuick},
 183     {"PanelQuickView", CK_PanelQuickView},
 184     {"LinkSymbolicRelative", CK_LinkSymbolicRelative},
 185     {"VfsList", CK_VfsList},
 186     {"SaveSetup", CK_SaveSetup},
 187     {"LinkSymbolic", CK_LinkSymbolic},
 188     {"PanelTree", CK_PanelTree},
 189     {"Tree", CK_Tree},
 190 #ifdef ENABLE_VFS_UNDELFS
 191     {"Undelete", CK_Undelete},
 192 #endif
 193     {"PutCurrentLink", CK_PutCurrentLink},
 194     {"PutOtherLink", CK_PutOtherLink},
 195     {"HotListAdd", CK_HotListAdd},
 196     {"ShowHidden", CK_ShowHidden},
 197     {"SplitVertHoriz", CK_SplitVertHoriz},
 198     {"SplitEqual", CK_SplitEqual},
 199     {"SplitMore", CK_SplitMore},
 200     {"SplitLess", CK_SplitLess},
 201     {"PutCurrentPath", CK_PutCurrentPath},
 202     {"PutOtherPath", CK_PutOtherPath},
 203     {"PutCurrentTagged", CK_PutCurrentTagged},
 204     {"PutOtherTagged", CK_PutOtherTagged},
 205     {"Select", CK_Select},
 206     {"Unselect", CK_Unselect},
 207
 208     /* panel */
 209     {"ScrollLeft", CK_ScrollLeft},
 210     {"ScrollRight", CK_ScrollRight},
 211     {"PanelOtherCd", CK_PanelOtherCd},
 212     {"PanelOtherCdLink", CK_PanelOtherCdLink},
 213     {"CopySingle", CK_CopySingle},
 214     {"MoveSingle", CK_MoveSingle},
 215     {"DeleteSingle", CK_DeleteSingle},
 216     {"CdParent", CK_CdParent},
 217     {"CdChild", CK_CdChild},
 218     {"Panelize", CK_Panelize},
 219     {"PanelOtherSync", CK_PanelOtherSync},
 220     {"SortNext", CK_SortNext},
 221     {"SortPrev", CK_SortPrev},
 222     {"SortReverse", CK_SortReverse},
 223     {"SortByName", CK_SortByName},
 224     {"SortByExt", CK_SortByExt},
 225     {"SortBySize", CK_SortBySize},
 226     {"SortByMTime", CK_SortByMTime},
 227     {"CdParentSmart", CK_CdParentSmart},
 228
 229     /* dialog */
 230     {"Ok", CK_Ok},
 231     {"Cancel", CK_Cancel},
 232
 233     /* input line */
 234     {"Yank", CK_Yank},
 235
 236     /* help */
 237     {"Index", CK_Index},
 238     {"Back", CK_Back},
 239     {"LinkNext", CK_LinkNext},
 240     {"LinkPrev", CK_LinkPrev},
 241     {"NodeNext", CK_NodeNext},
 242     {"NodePrev", CK_NodePrev},
 243
 244     /* tree */
 245     {"Forget", CK_Forget},
 246
 247 #if defined (USE_INTERNAL_EDIT) || defined (USE_DIFF_VIEW)
 248     {"ShowNumbers", CK_ShowNumbers},
 249 #endif
 250
 251 #ifdef USE_INTERNAL_EDIT
 252     {"Tab", CK_Tab},
 253     {"Undo", CK_Undo},
 254     {"ScrollUp", CK_ScrollUp},
 255     {"ScrollDown", CK_ScrollDown},
 256     {"Return", CK_Return},
 257     {"ParagraphUp", CK_ParagraphUp},
 258     {"ParagraphDown", CK_ParagraphDown},
 259     {"EditFile", CK_EditFile},
 260     {"MarkWord", CK_MarkWord},
 261     {"MarkLine", CK_MarkLine},
 262     {"MarkAll", CK_MarkAll},
 263     {"Unmark", CK_Unmark},
 264     {"MarkColumn", CK_MarkColumn},
 265     {"BlockSave", CK_BlockSave},
 266     {"InsertFile", CK_InsertFile},
 267     {"InsertOverwrite", CK_InsertOverwrite},
 268     {"Date", CK_Date},
 269     {"DeleteLine", CK_DeleteLine},
 270     {"EditMail", CK_Mail},
 271     {"ParagraphFormat", CK_ParagraphFormat},
 272     {"MatchBracket", CK_MatchBracket},
 273     {"ExternalCommand", CK_ExternalCommand},
 274     {"MacroStartRecord", CK_MacroStartRecord},
 275     {"MacroStopRecord", CK_MacroStopRecord},
 276     {"MacroStartStopRecord", CK_MacroStartStopRecord},
 277     {"MacroDelete", CK_MacroDelete},
 278     {"RepeatStartStopRecord", CK_RepeatStartStopRecord},
 279     {"BookmarkFlush", CK_BookmarkFlush},
 280     {"BookmarkNext", CK_BookmarkNext},
 281     {"BookmarkPrev", CK_BookmarkPrev},
 282     {"MarkPageUp", CK_MarkPageUp},
 283     {"MarkPageDown", CK_MarkPageDown},
 284     {"MarkToFileBegin", CK_MarkToFileBegin},
 285     {"MarkToFileEnd", CK_MarkToFileEnd},
 286     {"MarkToPageBegin", CK_MarkToPageBegin},
 287     {"MarkToPageEnd", CK_MarkToPageEnd},
 288     {"MarkScrollUp", CK_MarkScrollUp},
 289     {"MarkScrollDown", CK_MarkScrollDown},
 290     {"MarkParagraphUp", CK_MarkParagraphUp},
 291     {"MarkParagraphDown", CK_MarkParagraphDown},
 292     {"MarkColumnPageUp", CK_MarkColumnPageUp},
 293     {"MarkColumnPageDown", CK_MarkColumnPageDown},
 294     {"MarkColumnLeft", CK_MarkColumnLeft},
 295     {"MarkColumnRight", CK_MarkColumnRight},
 296     {"MarkColumnUp", CK_MarkColumnUp},
 297     {"MarkColumnDown", CK_MarkColumnDown},
 298     {"MarkColumnScrollUp", CK_MarkColumnScrollUp},
 299     {"MarkColumnScrollDown", CK_MarkColumnScrollDown},
 300     {"MarkColumnParagraphUp", CK_MarkColumnParagraphUp},
 301     {"MarkColumnParagraphDown", CK_MarkColumnParagraphDown},
 302     {"BlockShiftLeft", CK_BlockShiftLeft},
 303     {"BlockShiftRight", CK_BlockShiftRight},
 304     {"InsertLiteral", CK_InsertLiteral},
 305     {"ShowTabTws", CK_ShowTabTws},
 306     {"SyntaxOnOff", CK_SyntaxOnOff},
 307     {"SyntaxChoose", CK_SyntaxChoose},
 308     {"ShowMargin", CK_ShowMargin},
 309     {"OptionsSaveMode", CK_OptionsSaveMode},
 310     {"About", CK_About},
 311     /* An action to run external script from macro */
 312     {"ExecuteScript", CK_PipeBlock (0)},
 313 #endif /* USE_INTERNAL_EDIT */
 314
 315     /* viewer */
 316     {"WrapMode", CK_WrapMode},
 317     {"HexEditMode", CK_HexEditMode},
 318     {"HexMode", CK_HexMode},
 319     {"MagicMode", CK_MagicMode},
 320     {"NroffMode", CK_NroffMode},
 321     {"BookmarkGoto", CK_BookmarkGoto},
 322     {"Ruler", CK_Ruler},
 323     {"SearchForward", CK_SearchForward},
 324     {"SearchBackward", CK_SearchBackward},
 325     {"SearchForwardContinue", CK_SearchForwardContinue},
 326     {"SearchBackwardContinue", CK_SearchBackwardContinue},
 327
 328 #ifdef USE_DIFF_VIEW
 329     /* diff viewer */
 330     {"ShowSymbols", CK_ShowSymbols},
 331     {"SplitFull", CK_SplitFull},
 332     {"Tab2", CK_Tab2},
 333     {"Tab3", CK_Tab3},
 334     {"Tab4", CK_Tab4},
 335     {"Tab8", CK_Tab8},
 336     {"HunkNext", CK_HunkNext},
 337     {"HunkPrev", CK_HunkPrev},
 338     {"EditOther", CK_EditOther},
 339     {"Merge", CK_Merge},
 340 #endif /* USE_DIFF_VIEW */
 341
 342     {NULL, CK_IgnoreKey}
 343 };
 344
 345 /* *INDENT-OFF* */
 346 static const size_t num_command_names = G_N_ELEMENTS (command_names) - 1;
 347 /* *INDENT-ON* */
 348
 349 /*** file scope functions ************************************************************************/
 350 /* --------------------------------------------------------------------------------------------- */
 351
 352 static int
 353 name_keymap_comparator (const void *p1, const void *p2)
 354 {
 355     const name_keymap_t *m1 = (const name_keymap_t *) p1;
 356     const name_keymap_t *m2 = (const name_keymap_t *) p2;
 357
 358     return g_ascii_strcasecmp (m1->name, m2->name);
 359 }
 360
 361 /* --------------------------------------------------------------------------------------------- */
 362
 363 static inline void
 364 sort_command_names (void)
 365 {
 366     static gboolean has_been_sorted = FALSE;
 367
 368     if (!has_been_sorted)
 369     {
 370         qsort (command_names, num_command_names,
 371                sizeof (command_names[0]), &name_keymap_comparator);
 372         has_been_sorted = TRUE;
 373     }
 374 }
 375
 376 /* --------------------------------------------------------------------------------------------- */
 377
 378 static void
 379 keymap_add (GArray * keymap, long key, unsigned long cmd, const char *caption)
 380 {
 381     if (key != 0 && cmd != CK_IgnoreKey)
 382     {
 383         global_keymap_t new_bind;
 384
 385         new_bind.key = key;
 386         new_bind.command = cmd;
 387         g_snprintf (new_bind.caption, sizeof (new_bind.caption), "%s", caption);
 388         g_array_append_val (keymap, new_bind);
 389     }
 390 }
 391
 392 /* --------------------------------------------------------------------------------------------- */
 393 /*** public functions ****************************************************************************/
 394 /* --------------------------------------------------------------------------------------------- */
 395
 396 void
 397 keybind_cmd_bind (GArray * keymap, const char *keybind, unsigned long action)
 398 {
 399     char *caption = NULL;
 400     long key;
 401
 402     key = lookup_key (keybind, &caption);
 403     keymap_add (keymap, key, action, caption);
 404     g_free (caption);
 405 }
 406
 407 /* --------------------------------------------------------------------------------------------- */
 408
 409 unsigned long
 410 keybind_lookup_action (const char *name)
 411 {
 412     const name_keymap_t key = { name, 0 };
 413     name_keymap_t *res;
 414
 415     sort_command_names ();
 416
 417     res = bsearch (&key, command_names, num_command_names,
 418                    sizeof (command_names[0]), name_keymap_comparator);
 419
 420     return (res != NULL) ? res->val : CK_IgnoreKey;
 421 }
 422
 423 /* --------------------------------------------------------------------------------------------- */
 424
 425 const char *
 426 keybind_lookup_actionname (unsigned long action)
 427 {
 428     size_t i;
 429
 430     for (i = 0; command_names[i].name != NULL; i++)
 431         if (command_names[i].val == action)
 432             return command_names[i].name;
 433
 434     return NULL;
 435 }
 436
 437 /* --------------------------------------------------------------------------------------------- */
 438
 439 const char *
 440 keybind_lookup_keymap_shortcut (const global_keymap_t * keymap, unsigned long action)
 441 {
 442     size_t i;
 443
 444     if (keymap != NULL)
 445         for (i = 0; keymap[i].key != 0; i++)
 446             if (keymap[i].command == action)
 447                 return (keymap[i].caption[0] != '\0') ? keymap[i].caption : NULL;
 448
 449     return NULL;
 450 }
 451
 452 /* --------------------------------------------------------------------------------------------- */
 453
 454 unsigned long
 455 keybind_lookup_keymap_command (const global_keymap_t * keymap, long key)
 456 {
 457     size_t i;
 458
 459     if (keymap != NULL)
 460         for (i = 0; keymap[i].key != 0; i++)
 461             if (keymap[i].key == key)
 462                 return keymap[i].command;
 463
 464     return CK_IgnoreKey;
 465 }
 466
 467 /* --------------------------------------------------------------------------------------------- */