src/command.c

   1 /*
   2  * $Id$
   3  *
   4  * (c) 2004 by Kalle Wallin <kaw@linux.se>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  *
  19  */
  20
  21 #include <ctype.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <ctype.h>
  26 #include <glib.h>
  27 #include <signal.h>
  28 #include <ncurses.h>
  29
  30 #include "config.h"
  31 #include "ncmpc.h"
  32 #include "command.h"
  33
  34 #undef DEBUG_KEYS
  35
  36 #ifdef DEBUG_KEYS
  37 #define DK(x) x
  38 #else
  39 #define DK(x)
  40 #endif
  41
  42 extern void screen_resize(void);
  43
  44 #define BS   KEY_BACKSPACE
  45 #define DEL  KEY_DC
  46 #define UP   KEY_UP
  47 #define DWN  KEY_DOWN
  48 #define LEFT KEY_LEFT
  49 #define RGHT KEY_RIGHT
  50 #define HOME KEY_HOME
  51 #define END  KEY_END
  52 #define PGDN KEY_NPAGE
  53 #define PGUP KEY_PPAGE
  54 #define TAB  0x09
  55 #define STAB 0x161
  56 #define ESC  0x1B
  57 #define F1   KEY_F(1)
  58 #define F2   KEY_F(2)
  59 #define F3   KEY_F(3)
  60 #define F4   KEY_F(4)
  61 #define F5   KEY_F(5)
  62 #define F6   KEY_F(6)
  63
  64
  65 static command_definition_t cmds[] =
  66 {
  67 #ifdef ENABLE_KEYDEF_SCREEN
  68   { {'K',   0,   0 }, 0, CMD_SCREEN_KEYDEF,    "screen-keyedit",
  69     N_("Key configuration screen") },
  70 #endif
  71   { { 'q', 'Q',  3 }, 0, CMD_QUIT,   "quit",
  72     N_("Quit") },
  73
  74   /* movment */
  75   { {  UP,  'k',   0 }, 0, CMD_LIST_PREVIOUS,      "up",
  76     N_("Move cursor up") },
  77   { { DWN,  'j',   0 }, 0, CMD_LIST_NEXT,          "down",
  78     N_("Move cursor down") },
  79   { { HOME, 0x01, 0 }, 0, CMD_LIST_FIRST,          "home",
  80     N_("Home ") },
  81   { { END,  0x05, 0 }, 0, CMD_LIST_LAST,           "end",
  82     N_("End ") },
  83   { { PGUP,   0,   0 }, 0, CMD_LIST_PREVIOUS_PAGE, "pgup",
  84     N_("Page up") },
  85   { { PGDN,   0,   0 }, 0, CMD_LIST_NEXT_PAGE,     "pgdn",
  86     N_("Page down") },
  87
  88
  89   /* basic screens */
  90   { { '1', F1, 'h' }, 0, CMD_SCREEN_HELP,      "screen-help",
  91     N_("Help screen") },
  92   { { '2', F2,  0 }, 0, CMD_SCREEN_PLAY,      "screen-playlist",
  93     N_("Playlist screen") },
  94   { { '3', F3,  0 }, 0, CMD_SCREEN_FILE,      "screen-browse",
  95     N_("Browse screen") },
  96
  97
  98   /* player commands */
  99   { {  13,   0,   0 }, 0, CMD_PLAY, "play",
 100     N_("Play/Enter directory") },
 101   { { 'P',   0,   0 }, 0, CMD_PAUSE,"pause",
 102     N_("Pause") },
 103   { { 's',  BS,   0 }, 0, CMD_STOP, "stop",
 104     N_("Stop") },
 105   { { '>',   0,   0 }, 0, CMD_TRACK_NEXT, "next",
 106     N_("Next track") },
 107   { { '<',   0,   0 }, 0, CMD_TRACK_PREVIOUS, "prev",
 108     N_("Previous track") },
 109   { { 'f',   0,   0 }, 0, CMD_SEEK_FORWARD, "seek-forward",
 110     N_("Seek forward") },
 111   { { 'b',   0,   0 }, 0, CMD_SEEK_BACKWARD, "seek-backward",
 112     N_("Seek backward") },
 113   { { '+', RGHT,  0 }, 0, CMD_VOLUME_UP, "volume-up",
 114     N_("Increase volume") },
 115   { { '-', LEFT,  0 }, 0, CMD_VOLUME_DOWN, "volume-down",
 116     N_("Decrease volume") },
 117   { { ' ',   0,   0 }, 0, CMD_SELECT, "select",
 118     N_("Select/deselect song in playlist") },
 119   { { DEL,  'd',  0 }, 0, CMD_DELETE, "delete",
 120     N_("Delete song from playlist") },
 121   { { 'Z',   0,   0 }, 0, CMD_SHUFFLE, "shuffle",
 122     N_("Shuffle playlist") },
 123   { { 'c',   0,   0 }, 0, CMD_CLEAR, "clear",
 124     N_("Clear playlist") },
 125   { { 'r',   0,   0 }, 0, CMD_REPEAT, "repeat",
 126     N_("Toggle repeat mode") },
 127   { { 'z',   0,   0 }, 0, CMD_RANDOM, "random",
 128     N_("Toggle random mode") },
 129   { { 'x',   0,   0 }, 0, CMD_CROSSFADE, "crossfade",
 130     N_("Toggle crossfade mode") },
 131   { { 21,    0,   0 }, 0, CMD_DB_UPDATE,  "db-update",
 132     N_("Start a music database update") },
 133   { { 'S',   0,   0 }, 0, CMD_SAVE_PLAYLIST, "save",
 134     N_("Save playlist") },
 135   { { 'a',   0,   0 }, 0, CMD_ADD, "add",
 136     N_("Add url/file to playlist") },
 137
 138
 139   /* lists */
 140   { { 11,  0,   0 }, 0, CMD_LIST_MOVE_UP,     "move-up",
 141     N_("Move item up") },
 142   { { 10,  0,   0 }, 0, CMD_LIST_MOVE_DOWN,   "move-down",
 143     N_("Move item down") },
 144   { { 12,  0,   0 }, 0, CMD_SCREEN_UPDATE,    "update",
 145     N_("Update screen") },
 146
 147
 148   /* ncmpc options */
 149   { { 'w',   0,   0 }, 0, CMD_TOGGLE_FIND_WRAP,  "wrap-mode",
 150     N_("Toggle find mode") },
 151   { { 'U',   0,   0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
 152     N_("Toggle auto center mode") },
 153
 154
 155   /* change screen */
 156   { { TAB,   0,   0 }, 0, CMD_SCREEN_NEXT,     "screen-next",
 157     N_("Next screen") },
 158   { { STAB,  0,   0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
 159     N_("Previous screen") },
 160
 161
 162   /* find */
 163   { { '/',   0,   0 }, 0, CMD_LIST_FIND,           "find",
 164     N_("Forward find") },
 165   { { 'n',   0,   0 }, 0, CMD_LIST_FIND_NEXT,      "find-next",
 166     N_("Forward find next") },
 167   { { '?',   0,   0 }, 0, CMD_LIST_RFIND,          "rfind",
 168     N_("Backward find") },
 169   { { 'p',   0,   0 }, 0, CMD_LIST_RFIND_NEXT,     "rfind-next",
 170     N_("Backward find previous") },
 171
 172
 173   /* extra screens */
 174 #ifdef ENABLE_CLOCK_SCREEN
 175   { {'4',  F4,   0 }, 0, CMD_SCREEN_CLOCK,    "screen-clock",
 176     N_("Clock screen") },
 177 #endif
 178
 179   { { -1,  -1,  -1 }, 0, CMD_NONE, NULL, NULL }
 180 };
 181
 182 command_definition_t *
 183 get_command_definitions(void)
 184 {
 185   return cmds;
 186 }
 187
 188 char *
 189 key2str(int key)
 190 {
 191   static char buf[32];
 192   int i;
 193
 194   buf[0] = 0;
 195   switch(key)
 196     {
 197     case 0:
 198       return _("Undefined");
 199     case ' ':
 200       return _("Space");
 201     case 13:
 202       return _("Enter");
 203     case BS:
 204       return _("Backspace");
 205     case DEL:
 206       return _("Delete");
 207     case UP:
 208       return _("Up");
 209     case DWN:
 210       return _("Down");
 211     case LEFT:
 212       return _("Left");
 213     case RGHT:
 214       return _("Right");
 215     case HOME:
 216       return _("Home");
 217     case END:
 218       return _("End");
 219     case PGDN:
 220       return _("PageDown");
 221     case PGUP:
 222       return _("PageUp");
 223     case TAB:
 224       return _("Tab");
 225     case STAB:
 226       return _("Shift+Tab");
 227     case ESC:
 228       return _("Esc");
 229     case KEY_IC:
 230       return _("Insert");
 231     default:
 232       for(i=0; i<=63; i++)
 233         if( key==KEY_F(i) )
 234           {
 235             snprintf(buf, 32, "F%d", i );
 236             return buf;
 237           }
 238       if( !(key & ~037) )
 239         snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 240       else if( (key & ~037) == 224 )
 241         snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 242       else if( key>32 &&  key<256 )
 243         snprintf(buf, 32, "%c", key);
 244       else
 245         snprintf(buf, 32, "0x%03X", key);
 246     }
 247   return buf;
 248 }
 249
 250 void
 251 command_dump_keys(void)
 252 {
 253   int i;
 254
 255   i=0;
 256   while( cmds[i].description )
 257     {
 258       if( cmds[i].command != CMD_NONE )
 259         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 260       i++;
 261     }
 262 }
 263
 264 int
 265 set_key_flags(command_definition_t *cp, command_t command, int flags)
 266 {
 267   int i;
 268
 269   i=0;
 270   while( cp[i].name )
 271     {
 272       if( cp[i].command == command )
 273         {
 274           cp[i].flags |= flags;
 275           return 0;
 276         }
 277       i++;
 278     }
 279   return 1;
 280 }
 281
 282 char *
 283 get_key_names(command_t command, int all)
 284 {
 285   int i;
 286
 287   i=0;
 288   while( cmds[i].description )
 289     {
 290       if( cmds[i].command == command )
 291         {
 292           int j;
 293           static char keystr[80];
 294
 295           strncpy(keystr, key2str(cmds[i].keys[0]), 80);
 296           if( !all )
 297             return keystr;
 298           j=1;
 299           while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
 300             {
 301               strcat(keystr, " ");
 302               strcat(keystr, key2str(cmds[i].keys[j]));
 303               j++;
 304             }
 305           return keystr;
 306         }
 307       i++;
 308     }
 309   return NULL;
 310 }
 311
 312 char *
 313 get_key_description(command_t command)
 314 {
 315   int i;
 316
 317   i=0;
 318   while( cmds[i].description )
 319     {
 320       if( cmds[i].command == command )
 321         return _(cmds[i].description);
 322       i++;
 323     }
 324   return NULL;
 325 }
 326
 327 char *
 328 get_key_command_name(command_t command)
 329 {
 330   int i;
 331
 332   i=0;
 333   while( cmds[i].name )
 334     {
 335       if( cmds[i].command == command )
 336         return cmds[i].name;
 337       i++;
 338     }
 339   return NULL;
 340 }
 341
 342 command_t
 343 get_key_command_from_name(char *name)
 344 {
 345   int i;
 346
 347   i=0;
 348   while( cmds[i].name )
 349     {
 350       if( strcmp(name, cmds[i].name) == 0 )
 351         return cmds[i].command;
 352       i++;
 353     }
 354   return CMD_NONE;
 355 }
 356
 357
 358 command_t
 359 find_key_command(int key, command_definition_t *cmds)
 360 {
 361   int i;
 362
 363   i=0;
 364   while( cmds && cmds[i].name )
 365     {
 366       if( cmds[i].keys[0] == key ||
 367           cmds[i].keys[1] == key ||
 368           cmds[i].keys[2] == key )
 369         return cmds[i].command;
 370       i++;
 371     }
 372   return CMD_NONE;
 373 }
 374
 375 command_t
 376 get_key_command(int key)
 377 {
 378   return find_key_command(key, cmds);
 379 }
 380
 381 command_t
 382 get_keyboard_command_with_timeout(int ms)
 383 {
 384   int key;
 385
 386   if( ms != SCREEN_TIMEOUT)
 387     timeout(ms);
 388   key = wgetch(stdscr);
 389   if( ms != SCREEN_TIMEOUT)
 390     timeout(SCREEN_TIMEOUT);
 391
 392   if( key==KEY_RESIZE )
 393     screen_resize();
 394
 395 #ifdef ENABLE_RAW_MODE
 396   if( key==KEY_SIGSTOP )
 397     sigstop();
 398 #endif
 399
 400   if( key==ERR )
 401     return CMD_NONE;
 402
 403 #ifdef HAVE_GETMOUSE
 404   //  if( key==KEY_MOUSE )
 405   //    return CMD_MOUSE_EVENT;
 406 #endif
 407
 408   return get_key_command(key);
 409 }
 410
 411 command_t
 412 get_keyboard_command(void)
 413 {
 414   return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
 415 }
 416
 417 int
 418 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 419 {
 420  int i;
 421
 422   i=0;
 423   while( cmds[i].name )
 424     {
 425       if( cmds[i].command == command )
 426         {
 427           memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 428           cmds[i].flags |= COMMAND_KEY_MODIFIED;
 429           return 0;
 430         }
 431       i++;
 432     }
 433   return -1;
 434 }
 435
 436 int
 437 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
 438 {
 439   int i;
 440   int retval = 0;
 441
 442   if( cp==NULL )
 443     cp = cmds;
 444
 445   i=0;
 446   while( cp[i].name )
 447     {
 448       cp[i].flags &= ~COMMAND_KEY_CONFLICT;
 449       i++;
 450     }
 451
 452   i=0;
 453   while( cp[i].name )
 454     {
 455       int j;
 456       command_t cmd;
 457
 458       for(j=0; j<MAX_COMMAND_KEYS; j++)
 459         if( cp[i].keys[j] &&
 460             (cmd=find_key_command(cp[i].keys[j],cp)) != cp[i].command )
 461           {
 462             if( buf )
 463 #ifdef ENABLE_KEYDEF_SCREEN
 464               snprintf(buf, bufsize,
 465                        _("Key %s assigned to %s and %s (press %s for the key editor)"),
 466                        key2str(cp[i].keys[j]),
 467                        get_key_command_name(cp[i].command),
 468                        get_key_command_name(cmd),
 469                        get_key_names(CMD_SCREEN_KEYDEF,0));
 470 #else
 471             snprintf(buf, bufsize,
 472                        _("Error: Key %s assigned to %s and %s !!!\n"),
 473                        key2str(cp[i].keys[j]),
 474                        get_key_command_name(cp[i].command),
 475                        get_key_command_name(cmd));
 476 #endif
 477             else
 478               fprintf(stderr,
 479                       _("Error: Key %s assigned to %s and %s !!!\n"),
 480                       key2str(cp[i].keys[j]),
 481                       get_key_command_name(cp[i].command),
 482                       get_key_command_name(cmd));
 483             cp[i].flags |= COMMAND_KEY_CONFLICT;
 484             set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
 485             retval = -1;
 486           }
 487       i++;
 488     }
 489   return retval;
 490 }
 491
 492 int
 493 write_key_bindings(FILE *f)
 494 {
 495   int i,j;
 496
 497   fprintf(f, "# Key bindings for ncmpc (generated by ncmpc)\n\n");
 498
 499   i=0;
 500   while( cmds[i].name && !ferror(f) )
 501     {
 502       if( cmds[i].flags & COMMAND_KEY_MODIFIED )
 503         {
 504           fprintf(f, "# %s\n", cmds[i].description);
 505           fprintf(f, "key %s = ", cmds[i].name);
 506           for(j=0; j<MAX_COMMAND_KEYS; j++)
 507             {
 508               if( j && cmds[i].keys[j] )
 509                 fprintf(f, ",  ");
 510               if( !j || cmds[i].keys[j] )
 511                 {
 512                   if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 513                                               isdigit(cmds[i].keys[j])) )
 514                     fprintf(f, "\'%c\'", cmds[i].keys[j]);
 515                   else
 516                     fprintf(f, "%d", cmds[i].keys[j]);
 517                 }
 518             }
 519           fprintf(f,"\n\n");
 520         }
 521       i++;
 522     }
 523   return ferror(f);
 524 }