lib/keybind.c

lib/keybind.c
/* */
This source file includes following definitions.
name_keymap_comparator
sort_command_names
keymap_add
keybind_cmd_bind
keybind_lookup_action
keybind_lookup_actionname
keybind_lookup_keymap_shortcut
keybind_lookup_keymap_command
   1 /*
   2    Definitions of key bindings.
   3 
   4    Copyright (C) 2005-2025
   5    Free Software Foundation, Inc.
   6 
   7    Written by:
   8    Vitja Makarov, 2005
   9    Ilia Maslakov <il.smind@gmail.com>, 2009, 2012
  10    Andrew Borodin <aborodin@vmail.ru>, 2009-2020
  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 <https://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 #define ADD_KEYMAP_NAME(name) { #name, CK_##name }
  44 
  45 /*** file scope type declarations ****************************************************************/
  46 
  47 typedef struct name_keymap_t
  48 {
  49     const char *name;
  50     long val;
  51 } name_keymap_t;
  52 
  53 /*** forward declarations (file scope functions) *************************************************/
  54 
  55 /*** file scope variables ************************************************************************/
  56 
  57 static name_keymap_t command_names[] = {
  58     // common
  59     ADD_KEYMAP_NAME (InsertChar),
  60     ADD_KEYMAP_NAME (Enter),
  61     ADD_KEYMAP_NAME (ChangePanel),
  62     ADD_KEYMAP_NAME (Up),
  63     ADD_KEYMAP_NAME (Down),
  64     ADD_KEYMAP_NAME (Left),
  65     ADD_KEYMAP_NAME (Right),
  66     ADD_KEYMAP_NAME (LeftQuick),
  67     ADD_KEYMAP_NAME (RightQuick),
  68     ADD_KEYMAP_NAME (Home),
  69     ADD_KEYMAP_NAME (End),
  70     ADD_KEYMAP_NAME (PageUp),
  71     ADD_KEYMAP_NAME (PageDown),
  72     ADD_KEYMAP_NAME (HalfPageUp),
  73     ADD_KEYMAP_NAME (HalfPageDown),
  74     ADD_KEYMAP_NAME (Top),
  75     ADD_KEYMAP_NAME (Bottom),
  76     ADD_KEYMAP_NAME (TopOnScreen),
  77     ADD_KEYMAP_NAME (MiddleOnScreen),
  78     ADD_KEYMAP_NAME (BottomOnScreen),
  79     ADD_KEYMAP_NAME (WordLeft),
  80     ADD_KEYMAP_NAME (WordRight),
  81     ADD_KEYMAP_NAME (Copy),
  82     ADD_KEYMAP_NAME (Move),
  83     ADD_KEYMAP_NAME (Delete),
  84     ADD_KEYMAP_NAME (MakeDir),
  85     ADD_KEYMAP_NAME (ChangeMode),
  86     ADD_KEYMAP_NAME (ChangeOwn),
  87     ADD_KEYMAP_NAME (ChangeOwnAdvanced),
  88 #ifdef ENABLE_EXT2FS_ATTR
  89     ADD_KEYMAP_NAME (ChangeAttributes),
  90 #endif
  91     ADD_KEYMAP_NAME (Remove),
  92     ADD_KEYMAP_NAME (BackSpace),
  93     ADD_KEYMAP_NAME (Redo),
  94     ADD_KEYMAP_NAME (Clear),
  95     ADD_KEYMAP_NAME (Menu),
  96     ADD_KEYMAP_NAME (MenuLastSelected),
  97     ADD_KEYMAP_NAME (UserMenu),
  98     ADD_KEYMAP_NAME (EditUserMenu),
  99     ADD_KEYMAP_NAME (Search),
 100     ADD_KEYMAP_NAME (SearchContinue),
 101     ADD_KEYMAP_NAME (Replace),
 102     ADD_KEYMAP_NAME (ReplaceContinue),
 103     ADD_KEYMAP_NAME (Help),
 104     ADD_KEYMAP_NAME (Shell),
 105     ADD_KEYMAP_NAME (Edit),
 106     ADD_KEYMAP_NAME (EditNew),
 107 #ifdef HAVE_CHARSET
 108     ADD_KEYMAP_NAME (SelectCodepage),
 109 #endif
 110     ADD_KEYMAP_NAME (EditorViewerHistory),
 111     ADD_KEYMAP_NAME (History),
 112     ADD_KEYMAP_NAME (HistoryNext),
 113     ADD_KEYMAP_NAME (HistoryPrev),
 114     ADD_KEYMAP_NAME (Complete),
 115     ADD_KEYMAP_NAME (Save),
 116     ADD_KEYMAP_NAME (SaveAs),
 117     ADD_KEYMAP_NAME (Goto),
 118     ADD_KEYMAP_NAME (Reread),
 119     ADD_KEYMAP_NAME (Refresh),
 120     ADD_KEYMAP_NAME (Suspend),
 121     ADD_KEYMAP_NAME (Swap),
 122     ADD_KEYMAP_NAME (HotList),
 123     ADD_KEYMAP_NAME (SelectInvert),
 124     ADD_KEYMAP_NAME (ScreenList),
 125     ADD_KEYMAP_NAME (ScreenNext),
 126     ADD_KEYMAP_NAME (ScreenPrev),
 127     ADD_KEYMAP_NAME (FileNext),
 128     ADD_KEYMAP_NAME (FilePrev),
 129     ADD_KEYMAP_NAME (DeleteToHome),
 130     ADD_KEYMAP_NAME (DeleteToEnd),
 131     ADD_KEYMAP_NAME (DeleteToWordBegin),
 132     ADD_KEYMAP_NAME (DeleteToWordEnd),
 133     ADD_KEYMAP_NAME (Cut),
 134     ADD_KEYMAP_NAME (Store),
 135     ADD_KEYMAP_NAME (Paste),
 136     ADD_KEYMAP_NAME (Mark),
 137     ADD_KEYMAP_NAME (MarkLeft),
 138     ADD_KEYMAP_NAME (MarkRight),
 139     ADD_KEYMAP_NAME (MarkUp),
 140     ADD_KEYMAP_NAME (MarkDown),
 141     ADD_KEYMAP_NAME (MarkToWordBegin),
 142     ADD_KEYMAP_NAME (MarkToWordEnd),
 143     ADD_KEYMAP_NAME (MarkToHome),
 144     ADD_KEYMAP_NAME (MarkToEnd),
 145     ADD_KEYMAP_NAME (ToggleNavigation),
 146     ADD_KEYMAP_NAME (Sort),
 147     ADD_KEYMAP_NAME (Options),
 148     ADD_KEYMAP_NAME (LearnKeys),
 149     ADD_KEYMAP_NAME (Bookmark),
 150     ADD_KEYMAP_NAME (Quit),
 151     ADD_KEYMAP_NAME (QuitQuiet),
 152     ADD_KEYMAP_NAME (ExtendedKeyMap),
 153 
 154 // main commands
 155 #ifdef USE_INTERNAL_EDIT
 156     ADD_KEYMAP_NAME (EditForceInternal),
 157 #endif
 158     ADD_KEYMAP_NAME (View),
 159     ADD_KEYMAP_NAME (ViewRaw),
 160     ADD_KEYMAP_NAME (ViewFile),
 161     ADD_KEYMAP_NAME (ViewFiltered),
 162     ADD_KEYMAP_NAME (Find),
 163     ADD_KEYMAP_NAME (DirSize),
 164     ADD_KEYMAP_NAME (CompareDirs),
 165 #ifdef USE_DIFF_VIEW
 166     ADD_KEYMAP_NAME (CompareFiles),
 167 #endif
 168     ADD_KEYMAP_NAME (OptionsVfs),
 169     ADD_KEYMAP_NAME (OptionsConfirm),
 170     ADD_KEYMAP_NAME (OptionsDisplayBits),
 171     ADD_KEYMAP_NAME (EditExtensionsFile),
 172     ADD_KEYMAP_NAME (EditFileHighlightFile),
 173     ADD_KEYMAP_NAME (LinkSymbolicEdit),
 174     ADD_KEYMAP_NAME (ExternalPanelize),
 175     ADD_KEYMAP_NAME (Filter),
 176 #ifdef ENABLE_VFS_SHELL
 177     ADD_KEYMAP_NAME (ConnectShell),
 178 #endif
 179 #ifdef ENABLE_VFS_FTP
 180     ADD_KEYMAP_NAME (ConnectFtp),
 181 #endif
 182 #ifdef ENABLE_VFS_SFTP
 183     ADD_KEYMAP_NAME (ConnectSftp),
 184 #endif
 185     ADD_KEYMAP_NAME (PanelInfo),
 186 #ifdef ENABLE_BACKGROUND
 187     ADD_KEYMAP_NAME (Jobs),
 188 #endif
 189     ADD_KEYMAP_NAME (OptionsLayout),
 190     ADD_KEYMAP_NAME (OptionsAppearance),
 191     ADD_KEYMAP_NAME (Link),
 192     ADD_KEYMAP_NAME (SetupListingFormat),
 193     ADD_KEYMAP_NAME (PanelListing),
 194 #ifdef LISTMODE_EDITOR
 195     ADD_KEYMAP_NAME (ListMode),
 196 #endif
 197     ADD_KEYMAP_NAME (OptionsPanel),
 198     ADD_KEYMAP_NAME (CdQuick),
 199     ADD_KEYMAP_NAME (PanelQuickView),
 200     ADD_KEYMAP_NAME (LinkSymbolicRelative),
 201     ADD_KEYMAP_NAME (VfsList),
 202     ADD_KEYMAP_NAME (SaveSetup),
 203     ADD_KEYMAP_NAME (LinkSymbolic),
 204     ADD_KEYMAP_NAME (PanelTree),
 205     ADD_KEYMAP_NAME (Tree),
 206 #ifdef ENABLE_VFS_UNDELFS
 207     ADD_KEYMAP_NAME (Undelete),
 208 #endif
 209     ADD_KEYMAP_NAME (PutCurrentLink),
 210     ADD_KEYMAP_NAME (PutOtherLink),
 211     ADD_KEYMAP_NAME (HotListAdd),
 212     ADD_KEYMAP_NAME (ShowHidden),
 213     ADD_KEYMAP_NAME (SplitVertHoriz),
 214     ADD_KEYMAP_NAME (SplitEqual),
 215     ADD_KEYMAP_NAME (SplitMore),
 216     ADD_KEYMAP_NAME (SplitLess),
 217     ADD_KEYMAP_NAME (PutCurrentPath),
 218     ADD_KEYMAP_NAME (PutOtherPath),
 219     ADD_KEYMAP_NAME (PutCurrentSelected),
 220     ADD_KEYMAP_NAME (PutCurrentFullSelected),
 221     ADD_KEYMAP_NAME (PutCurrentTagged),
 222     ADD_KEYMAP_NAME (PutOtherTagged),
 223     ADD_KEYMAP_NAME (Select),
 224     ADD_KEYMAP_NAME (Unselect),
 225 
 226     // panel
 227     ADD_KEYMAP_NAME (SelectExt),
 228     ADD_KEYMAP_NAME (ScrollLeft),
 229     ADD_KEYMAP_NAME (ScrollRight),
 230     ADD_KEYMAP_NAME (PanelOtherCd),
 231     ADD_KEYMAP_NAME (PanelOtherCdLink),
 232     ADD_KEYMAP_NAME (CopySingle),
 233     ADD_KEYMAP_NAME (MoveSingle),
 234     ADD_KEYMAP_NAME (DeleteSingle),
 235     ADD_KEYMAP_NAME (CdParent),
 236     ADD_KEYMAP_NAME (CdChild),
 237     ADD_KEYMAP_NAME (Panelize),
 238     ADD_KEYMAP_NAME (PanelOtherSync),
 239     ADD_KEYMAP_NAME (SortNext),
 240     ADD_KEYMAP_NAME (SortPrev),
 241     ADD_KEYMAP_NAME (SortReverse),
 242     ADD_KEYMAP_NAME (SortByName),
 243     ADD_KEYMAP_NAME (SortByExt),
 244     ADD_KEYMAP_NAME (SortBySize),
 245     ADD_KEYMAP_NAME (SortByMTime),
 246     ADD_KEYMAP_NAME (CdParentSmart),
 247     ADD_KEYMAP_NAME (CycleListingFormat),
 248 
 249     // dialog
 250     ADD_KEYMAP_NAME (Ok),
 251     ADD_KEYMAP_NAME (Cancel),
 252 
 253     // input line
 254     ADD_KEYMAP_NAME (Yank),
 255 
 256     // help
 257     ADD_KEYMAP_NAME (Index),
 258     ADD_KEYMAP_NAME (Back),
 259     ADD_KEYMAP_NAME (LinkNext),
 260     ADD_KEYMAP_NAME (LinkPrev),
 261     ADD_KEYMAP_NAME (NodeNext),
 262     ADD_KEYMAP_NAME (NodePrev),
 263 
 264     // tree
 265     ADD_KEYMAP_NAME (Forget),
 266 
 267 #if defined(USE_INTERNAL_EDIT) || defined(USE_DIFF_VIEW)
 268     ADD_KEYMAP_NAME (ShowNumbers),
 269 #endif
 270 
 271     // chattr dialog
 272     ADD_KEYMAP_NAME (MarkAndDown),
 273 
 274 #ifdef USE_INTERNAL_EDIT
 275     ADD_KEYMAP_NAME (Close),
 276     ADD_KEYMAP_NAME (Tab),
 277     ADD_KEYMAP_NAME (Undo),
 278     ADD_KEYMAP_NAME (ScrollUp),
 279     ADD_KEYMAP_NAME (ScrollDown),
 280     ADD_KEYMAP_NAME (Return),
 281     ADD_KEYMAP_NAME (ParagraphUp),
 282     ADD_KEYMAP_NAME (ParagraphDown),
 283     ADD_KEYMAP_NAME (EditFile),
 284     ADD_KEYMAP_NAME (MarkWord),
 285     ADD_KEYMAP_NAME (MarkLine),
 286     ADD_KEYMAP_NAME (MarkAll),
 287     ADD_KEYMAP_NAME (Unmark),
 288     ADD_KEYMAP_NAME (MarkColumn),
 289     ADD_KEYMAP_NAME (BlockSave),
 290     ADD_KEYMAP_NAME (InsertFile),
 291     ADD_KEYMAP_NAME (InsertOverwrite),
 292     ADD_KEYMAP_NAME (Date),
 293     ADD_KEYMAP_NAME (DeleteLine),
 294     ADD_KEYMAP_NAME (EditMail),
 295     ADD_KEYMAP_NAME (ParagraphFormat),
 296     ADD_KEYMAP_NAME (MatchBracket),
 297     ADD_KEYMAP_NAME (ExternalCommand),
 298     ADD_KEYMAP_NAME (MacroStartRecord),
 299     ADD_KEYMAP_NAME (MacroStopRecord),
 300     ADD_KEYMAP_NAME (MacroStartStopRecord),
 301     ADD_KEYMAP_NAME (MacroDelete),
 302     ADD_KEYMAP_NAME (RepeatStartStopRecord),
 303 #    ifdef HAVE_ASPELL
 304     ADD_KEYMAP_NAME (SpellCheck),
 305     ADD_KEYMAP_NAME (SpellCheckCurrentWord),
 306     ADD_KEYMAP_NAME (SpellCheckSelectLang),
 307 #    endif
 308     ADD_KEYMAP_NAME (BookmarkFlush),
 309     ADD_KEYMAP_NAME (BookmarkNext),
 310     ADD_KEYMAP_NAME (BookmarkPrev),
 311     ADD_KEYMAP_NAME (MarkPageUp),
 312     ADD_KEYMAP_NAME (MarkPageDown),
 313     ADD_KEYMAP_NAME (MarkToFileBegin),
 314     ADD_KEYMAP_NAME (MarkToFileEnd),
 315     ADD_KEYMAP_NAME (MarkToPageBegin),
 316     ADD_KEYMAP_NAME (MarkToPageEnd),
 317     ADD_KEYMAP_NAME (MarkScrollUp),
 318     ADD_KEYMAP_NAME (MarkScrollDown),
 319     ADD_KEYMAP_NAME (MarkParagraphUp),
 320     ADD_KEYMAP_NAME (MarkParagraphDown),
 321     ADD_KEYMAP_NAME (MarkColumnPageUp),
 322     ADD_KEYMAP_NAME (MarkColumnPageDown),
 323     ADD_KEYMAP_NAME (MarkColumnLeft),
 324     ADD_KEYMAP_NAME (MarkColumnRight),
 325     ADD_KEYMAP_NAME (MarkColumnUp),
 326     ADD_KEYMAP_NAME (MarkColumnDown),
 327     ADD_KEYMAP_NAME (MarkColumnScrollUp),
 328     ADD_KEYMAP_NAME (MarkColumnScrollDown),
 329     ADD_KEYMAP_NAME (MarkColumnParagraphUp),
 330     ADD_KEYMAP_NAME (MarkColumnParagraphDown),
 331     ADD_KEYMAP_NAME (BlockShiftLeft),
 332     ADD_KEYMAP_NAME (BlockShiftRight),
 333     ADD_KEYMAP_NAME (InsertLiteral),
 334     ADD_KEYMAP_NAME (ShowTabTws),
 335     ADD_KEYMAP_NAME (SyntaxOnOff),
 336     ADD_KEYMAP_NAME (SyntaxChoose),
 337     ADD_KEYMAP_NAME (ShowMargin),
 338     ADD_KEYMAP_NAME (OptionsSaveMode),
 339     ADD_KEYMAP_NAME (About),
 340     // An action to run external script from macro
 341     { "ExecuteScript", CK_PipeBlock (0) },
 342     ADD_KEYMAP_NAME (WindowMove),
 343     ADD_KEYMAP_NAME (WindowResize),
 344     ADD_KEYMAP_NAME (WindowFullscreen),
 345     ADD_KEYMAP_NAME (WindowList),
 346     ADD_KEYMAP_NAME (WindowNext),
 347     ADD_KEYMAP_NAME (WindowPrev),
 348 #endif
 349 
 350     // viewer
 351     ADD_KEYMAP_NAME (WrapMode),
 352     ADD_KEYMAP_NAME (HexEditMode),
 353     ADD_KEYMAP_NAME (HexMode),
 354     ADD_KEYMAP_NAME (MagicMode),
 355     ADD_KEYMAP_NAME (NroffMode),
 356     ADD_KEYMAP_NAME (BookmarkGoto),
 357     ADD_KEYMAP_NAME (Ruler),
 358     ADD_KEYMAP_NAME (SearchForward),
 359     ADD_KEYMAP_NAME (SearchBackward),
 360     ADD_KEYMAP_NAME (SearchForwardContinue),
 361     ADD_KEYMAP_NAME (SearchBackwardContinue),
 362     ADD_KEYMAP_NAME (SearchOppositeContinue),
 363 
 364 #ifdef USE_DIFF_VIEW
 365     // diff viewer
 366     ADD_KEYMAP_NAME (ShowSymbols),
 367     ADD_KEYMAP_NAME (SplitFull),
 368     ADD_KEYMAP_NAME (Tab2),
 369     ADD_KEYMAP_NAME (Tab3),
 370     ADD_KEYMAP_NAME (Tab4),
 371     ADD_KEYMAP_NAME (Tab8),
 372     ADD_KEYMAP_NAME (HunkNext),
 373     ADD_KEYMAP_NAME (HunkPrev),
 374     ADD_KEYMAP_NAME (EditOther),
 375     ADD_KEYMAP_NAME (Merge),
 376     ADD_KEYMAP_NAME (MergeOther),
 377 #endif
 378 
 379     { NULL, CK_IgnoreKey }
 380 };
 381 
 382 static const size_t num_command_names = G_N_ELEMENTS (command_names) - 1;
 383 
 384 /* --------------------------------------------------------------------------------------------- */
 385 /*** file scope functions ************************************************************************/
 386 /* --------------------------------------------------------------------------------------------- */
 387 
 388 static int
 389 name_keymap_comparator (const void *p1, const void *p2)
     /*   */
 390 {
 391     const name_keymap_t *m1 = (const name_keymap_t *) p1;
 392     const name_keymap_t *m2 = (const name_keymap_t *) p2;
 393 
 394     return g_ascii_strcasecmp (m1->name, m2->name);
 395 }
 396 
 397 /* --------------------------------------------------------------------------------------------- */
 398 
 399 static inline void
 400 sort_command_names (void)
     /*   */
 401 {
 402     static gboolean has_been_sorted = FALSE;
 403 
 404     if (!has_been_sorted)
 405     {
 406         qsort (command_names, num_command_names, sizeof (command_names[0]),
 407                &name_keymap_comparator);
 408         has_been_sorted = TRUE;
 409     }
 410 }
 411 
 412 /* --------------------------------------------------------------------------------------------- */
 413 
 414 static void
 415 keymap_add (GArray *keymap, long key, long cmd, const char *caption)
     /*   */
 416 {
 417     if (key != 0 && cmd != CK_IgnoreKey)
 418     {
 419         global_keymap_t new_bind;
 420 
 421         new_bind.key = key;
 422         new_bind.command = cmd;
 423         g_snprintf (new_bind.caption, sizeof (new_bind.caption), "%s", caption);
 424         g_array_append_val (keymap, new_bind);
 425     }
 426 }
 427 
 428 /* --------------------------------------------------------------------------------------------- */
 429 /*** public functions ****************************************************************************/
 430 /* --------------------------------------------------------------------------------------------- */
 431 
 432 void
 433 keybind_cmd_bind (GArray *keymap, const char *keybind, long action)
     /*   */
 434 {
 435     char *caption = NULL;
 436     long key;
 437 
 438     key = tty_keyname_to_keycode (keybind, &caption);
 439     keymap_add (keymap, key, action, caption);
 440     g_free (caption);
 441 }
 442 
 443 /* --------------------------------------------------------------------------------------------- */
 444 
 445 long
 446 keybind_lookup_action (const char *name)
     /*   */
 447 {
 448     const name_keymap_t key = { name, 0 };
 449     name_keymap_t *res;
 450 
 451     sort_command_names ();
 452 
 453     res = bsearch (&key, command_names, num_command_names, sizeof (command_names[0]),
 454                    name_keymap_comparator);
 455 
 456     return (res != NULL) ? res->val : CK_IgnoreKey;
 457 }
 458 
 459 /* --------------------------------------------------------------------------------------------- */
 460 
 461 const char *
 462 keybind_lookup_actionname (long action)
     /*   */
 463 {
 464     size_t i;
 465 
 466     for (i = 0; command_names[i].name != NULL; i++)
 467         if (command_names[i].val == action)
 468             return command_names[i].name;
 469 
 470     return NULL;
 471 }
 472 
 473 /* --------------------------------------------------------------------------------------------- */
 474 
 475 const char *
 476 keybind_lookup_keymap_shortcut (const global_keymap_t *keymap, long action)
     /*   */
 477 {
 478     if (keymap != NULL)
 479     {
 480         size_t i;
 481 
 482         for (i = 0; keymap[i].key != 0; i++)
 483             if (keymap[i].command == action)
 484                 return (keymap[i].caption[0] != '\0') ? keymap[i].caption : NULL;
 485     }
 486     return NULL;
 487 }
 488 
 489 /* --------------------------------------------------------------------------------------------- */
 490 
 491 long
 492 keybind_lookup_keymap_command (const global_keymap_t *keymap, long key)
     /*   */
 493 {
 494     if (keymap != NULL)
 495     {
 496         size_t i;
 497 
 498         for (i = 0; keymap[i].key != 0; i++)
 499             if (keymap[i].key == key)
 500                 return keymap[i].command;
 501     }
 502 
 503     return CK_IgnoreKey;
 504 }
 505 
 506 /* --------------------------------------------------------------------------------------------- */
/* */
root/lib/keybind.c

DEFINITIONS
