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 "command.h"
  22 #include "config.h"
  23 #include "ncmpc.h"
  24 #include "mpdclient.h"
  25 #include "screen.h"
  26
  27 #include <ctype.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <ctype.h>
  31 #include <glib.h>
  32 #include <signal.h>
  33 #include <unistd.h>
  34
  35 #undef DEBUG_KEYS
  36
  37 #ifdef DEBUG_KEYS
  38 #define DK(x) x
  39 #else
  40 #define DK(x)
  41 #endif
  42
  43 #define BS   KEY_BACKSPACE
  44 #define DEL  KEY_DC
  45 #define UP   KEY_UP
  46 #define DWN  KEY_DOWN
  47 #define LEFT KEY_LEFT
  48 #define RGHT KEY_RIGHT
  49 #define HOME KEY_HOME
  50 #define END  KEY_END
  51 #define PGDN KEY_NPAGE
  52 #define PGUP KEY_PPAGE
  53 #define TAB  0x09
  54 #define STAB 0x161
  55 #define ESC  0x1B
  56 #define F1   KEY_F(1)
  57 #define F2   KEY_F(2)
  58 #define F3   KEY_F(3)
  59 #define F4   KEY_F(4)
  60 #define F5   KEY_F(5)
  61 #define F6   KEY_F(6)
  62 #define F7   KEY_F(7)
  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   { { 'o',  0,   0 }, 0, CMD_CROP, "crop",
 106     N_("Crop") },
 107   { { '>',   0,   0 }, 0, CMD_TRACK_NEXT, "next",
 108     N_("Next track") },
 109   { { '<',   0,   0 }, 0, CMD_TRACK_PREVIOUS, "prev",
 110     N_("Previous track") },
 111   { { 'f',   0,   0 }, 0, CMD_SEEK_FORWARD, "seek-forward",
 112     N_("Seek forward") },
 113   { { 'b',   0,   0 }, 0, CMD_SEEK_BACKWARD, "seek-backward",
 114     N_("Seek backward") },
 115   { { '+', RGHT,  0 }, 0, CMD_VOLUME_UP, "volume-up",
 116     N_("Increase volume") },
 117   { { '-', LEFT,  0 }, 0, CMD_VOLUME_DOWN, "volume-down",
 118     N_("Decrease volume") },
 119   { { ' ',   0,   0 }, 0, CMD_SELECT, "select",
 120     N_("Select/deselect song in playlist") },
 121   { { 't',   0,   0 }, 0, CMD_SELECT_ALL, "select_all",
 122     N_("Select all listed items") },
 123   { { DEL,  'd',  0 }, 0, CMD_DELETE, "delete",
 124     N_("Delete song from playlist") },
 125   { { 'Z',   0,   0 }, 0, CMD_SHUFFLE, "shuffle",
 126     N_("Shuffle playlist") },
 127   { { 'c',   0,   0 }, 0, CMD_CLEAR, "clear",
 128     N_("Clear playlist") },
 129   { { 'r',   0,   0 }, 0, CMD_REPEAT, "repeat",
 130     N_("Toggle repeat mode") },
 131   { { 'z',   0,   0 }, 0, CMD_RANDOM, "random",
 132     N_("Toggle random mode") },
 133   { { 'x',   0,   0 }, 0, CMD_CROSSFADE, "crossfade",
 134     N_("Toggle crossfade mode") },
 135   { { 21,    0,   0 }, 0, CMD_DB_UPDATE,  "db-update",
 136     N_("Start a music database update") },
 137   { { 'S',   0,   0 }, 0, CMD_SAVE_PLAYLIST, "save",
 138     N_("Save playlist") },
 139   { { 'a',   0,   0 }, 0, CMD_ADD, "add",
 140     N_("Add url/file to playlist") },
 141
 142   { { '!',   0,   0 }, 0, CMD_GO_ROOT_DIRECTORY, "go-root-directory",
 143     N_("Go to root directory") },
 144   { { '"',   0,   0 }, 0, CMD_GO_PARENT_DIRECTORY, "go-parent-directory",
 145     N_("Go to parent directory") },
 146
 147   /* lists */
 148   { { 11,  0,   0 }, 0, CMD_LIST_MOVE_UP,     "move-up",
 149     N_("Move item up") },
 150   { { 10,  0,   0 }, 0, CMD_LIST_MOVE_DOWN,   "move-down",
 151     N_("Move item down") },
 152   { { 12,  0,   0 }, 0, CMD_SCREEN_UPDATE,    "update",
 153     N_("Update screen") },
 154
 155
 156   /* ncmpc options */
 157   { { 'w',   0,   0 }, 0, CMD_TOGGLE_FIND_WRAP,  "wrap-mode",
 158     N_("Toggle find mode") },
 159   { { 'U',   0,   0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
 160     N_("Toggle auto center mode") },
 161
 162
 163   /* change screen */
 164   { { TAB,   0,   0 }, 0, CMD_SCREEN_NEXT,     "screen-next",
 165     N_("Next screen") },
 166   { { STAB,  0,   0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
 167     N_("Previous screen") },
 168
 169
 170   /* find */
 171   { { '/',   0,   0 }, 0, CMD_LIST_FIND,           "find",
 172     N_("Forward find") },
 173   { { 'n',   0,   0 }, 0, CMD_LIST_FIND_NEXT,      "find-next",
 174     N_("Forward find next") },
 175   { { '?',   0,   0 }, 0, CMD_LIST_RFIND,          "rfind",
 176     N_("Backward find") },
 177   { { 'p',   0,   0 }, 0, CMD_LIST_RFIND_NEXT,     "rfind-next",
 178     N_("Backward find previous") },
 179
 180
 181   /* extra screens */
 182 #ifdef ENABLE_ARTIST_SCREEN
 183   { {'4',  F4,   0 }, 0, CMD_SCREEN_ARTIST,    "screen-artist",
 184     N_("Artist screen") },
 185 #endif
 186 #ifdef ENABLE_SEARCH_SCREEN
 187   { {'5',  F5,   0 }, 0, CMD_SCREEN_SEARCH,    "screen-search",
 188     N_("Search screen") },
 189   { {'m',   0,   0 }, 0, CMD_SEARCH_MODE,      "search-mode",
 190     N_("Change search mode") },
 191 #endif
 192
 193 #ifdef ENABLE_LYRICS_SCREEN
 194   { {'7',  F7,   0 }, 0, CMD_SCREEN_LYRICS,    "screen-lyrics",
 195     N_("Lyrics screen") },
 196   { {ESC,  0,   0 }, 0, CMD_INTERRUPT,    "lyrics-interrupt",
 197     N_("Interrupt action") },
 198   { {'u',  0,   0 }, 0, CMD_LYRICS_UPDATE,    "lyrics-update",
 199     N_("Update Lyrics") },
 200 #endif
 201
 202
 203   { { -1,  -1,  -1 }, 0, CMD_NONE, NULL, NULL }
 204 };
 205
 206 command_definition_t *
 207 get_command_definitions(void)
 208 {
 209         return cmds;
 210 }
 211
 212 const char *
 213 key2str(int key)
 214 {
 215         static char buf[32];
 216         int i;
 217
 218         buf[0] = 0;
 219         switch(key) {
 220         case 0:
 221                 return _("Undefined");
 222         case ' ':
 223                 return _("Space");
 224         case 13:
 225                 return _("Enter");
 226         case BS:
 227                 return _("Backspace");
 228         case DEL:
 229                 return _("Delete");
 230         case UP:
 231                 return _("Up");
 232         case DWN:
 233                 return _("Down");
 234         case LEFT:
 235                 return _("Left");
 236         case RGHT:
 237                 return _("Right");
 238         case HOME:
 239                 return _("Home");
 240         case END:
 241                 return _("End");
 242         case PGDN:
 243                 return _("PageDown");
 244         case PGUP:
 245                 return _("PageUp");
 246         case TAB:
 247                 return _("Tab");
 248         case STAB:
 249                 return _("Shift+Tab");
 250         case ESC:
 251                 return _("Esc");
 252         case KEY_IC:
 253                 return _("Insert");
 254         default:
 255                 for (i = 0; i <= 63; i++)
 256                         if (key == KEY_F(i)) {
 257                                 g_snprintf(buf, 32, "F%d", i );
 258                                 return buf;
 259                         }
 260                 if (!(key & ~037))
 261                         g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
 262                 else if ((key & ~037) == 224)
 263                         g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
 264                 else if (key > 32 && key < 256)
 265                         g_snprintf(buf, 32, "%c", key);
 266                 else
 267                         g_snprintf(buf, 32, "0x%03X", key);
 268         }
 269
 270         return buf;
 271 }
 272
 273 void
 274 command_dump_keys(void)
 275 {
 276         int i;
 277
 278         i = 0;
 279         while (cmds[i].description) {
 280                 if (cmds[i].command != CMD_NONE)
 281                         printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
 282                 i++;
 283         }
 284 }
 285
 286 static int
 287 set_key_flags(command_definition_t *cp, command_t command, int flags)
 288 {
 289         int i;
 290
 291         i = 0;
 292         while (cp[i].name) {
 293                 if (cp[i].command == command) {
 294                         cp[i].flags |= flags;
 295                         return 0;
 296                 }
 297                 i++;
 298         }
 299
 300         return 1;
 301 }
 302
 303 const char *
 304 get_key_names(command_t command, int all)
 305 {
 306   int i;
 307
 308   i=0;
 309   while (cmds[i].description) {
 310           if (cmds[i].command == command) {
 311                   int j;
 312                   static char keystr[80];
 313
 314                   g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
 315                   if (!all)
 316                           return keystr;
 317                   j=1;
 318                   while (j < MAX_COMMAND_KEYS && cmds[i].keys[j] > 0) {
 319                           g_strlcat(keystr, " ", sizeof(keystr));
 320                           g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
 321                           j++;
 322                   }
 323                   return keystr;
 324           }
 325           i++;
 326   }
 327   return NULL;
 328 }
 329
 330 const char *
 331 get_key_description(command_t command)
 332 {
 333         int i;
 334
 335         i=0;
 336         while (cmds[i].description) {
 337                 if (cmds[i].command == command)
 338                         return _(cmds[i].description);
 339                 i++;
 340         }
 341
 342         return NULL;
 343 }
 344
 345 const char *
 346 get_key_command_name(command_t command)
 347 {
 348         int i;
 349
 350         i=0;
 351         while (cmds[i].name) {
 352                 if (cmds[i].command == command)
 353                         return cmds[i].name;
 354                 i++;
 355         }
 356         return NULL;
 357 }
 358
 359 command_t
 360 get_key_command_from_name(char *name)
 361 {
 362         int i;
 363
 364         i=0;
 365         while (cmds[i].name) {
 366                 if (strcmp(name, cmds[i].name) == 0)
 367                         return cmds[i].command;
 368                 i++;
 369         }
 370
 371         return CMD_NONE;
 372 }
 373
 374 command_t
 375 find_key_command(int key, command_definition_t *c)
 376 {
 377         int i;
 378
 379         i=0;
 380         while (key && c && c[i].name) {
 381                 if (c[i].keys[0] == key ||
 382                     c[i].keys[1] == key ||
 383                     c[i].keys[2] == key)
 384                         return c[i].command;
 385                 i++;
 386         }
 387
 388         return CMD_NONE;
 389 }
 390
 391 command_t
 392 get_key_command(int key)
 393 {
 394         return find_key_command(key, cmds);
 395 }
 396
 397 int
 398 my_wgetch(WINDOW *w)
 399 {
 400         int c;
 401
 402         c = wgetch(w);
 403
 404         /* handle resize event */
 405         if (c == KEY_RESIZE)
 406                 screen_resize();
 407
 408 #ifdef ENABLE_RAW_MODE
 409         /* handle SIGSTOP (Ctrl-Z) */
 410         if (c == 26 || c == 407)
 411                 sigstop();
 412         /* handle SIGINT (Ctrl-C) */
 413         if (c == 3)
 414                 kill(getpid(), SIGTERM);
 415 #endif
 416
 417         return c;
 418 }
 419
 420 command_t
 421 get_keyboard_command(void)
 422 {
 423         int key;
 424
 425         key = my_wgetch(stdscr);
 426         if (key == ERR)
 427                 return CMD_NONE;
 428
 429 #ifdef HAVE_GETMOUSE
 430         if (key == KEY_MOUSE)
 431                 return CMD_MOUSE_EVENT;
 432 #endif
 433
 434         return get_key_command(key);
 435 }
 436
 437 int
 438 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
 439 {
 440         int i;
 441
 442         i=0;
 443         while (cmds[i].name) {
 444                 if (cmds[i].command == command) {
 445                         memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
 446                         cmds[i].flags |= COMMAND_KEY_MODIFIED;
 447                         return 0;
 448                 }
 449                 i++;
 450         }
 451         return -1;
 452 }
 453
 454 int
 455 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
 456 {
 457         int i;
 458         int retval = 0;
 459
 460         if (cp == NULL)
 461                 cp = cmds;
 462
 463         i=0;
 464         while (cp[i].name) {
 465                 cp[i].flags &= ~COMMAND_KEY_CONFLICT;
 466                 i++;
 467         }
 468
 469         i=0;
 470         while (cp[i].name) {
 471                 int j;
 472                 command_t cmd;
 473
 474                 for(j=0; j<MAX_COMMAND_KEYS; j++)
 475                         if (cp[i].keys[j] &&
 476                             (cmd = find_key_command(cp[i].keys[j],cp)) != cp[i].command) {
 477                                 if (buf) {
 478 #ifdef ENABLE_KEYDEF_SCREEN
 479                                         g_snprintf(buf, bufsize,
 480                                                    _("Key %s assigned to %s and %s (press %s for the key editor)"),
 481                                                    key2str(cp[i].keys[j]),
 482                                                    get_key_command_name(cp[i].command),
 483                                                    get_key_command_name(cmd),
 484                                                    get_key_names(CMD_SCREEN_KEYDEF,0));
 485 #else
 486                                         g_snprintf(buf, bufsize,
 487                                                    _("Error: Key %s assigned to %s and %s !!!\n"),
 488                                                    key2str(cp[i].keys[j]),
 489                                                    get_key_command_name(cp[i].command),
 490                                                    get_key_command_name(cmd));
 491 #endif
 492                                 } else
 493                                         fprintf(stderr,
 494                                                 _("Error: Key %s assigned to %s and %s !!!\n"),
 495                                                 key2str(cp[i].keys[j]),
 496                                                 get_key_command_name(cp[i].command),
 497                                                 get_key_command_name(cmd));
 498                                 cp[i].flags |= COMMAND_KEY_CONFLICT;
 499                                 set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
 500                                 retval = -1;
 501                         }
 502                 i++;
 503         }
 504         return retval;
 505 }
 506
 507 int
 508 write_key_bindings(FILE *f, int flags)
 509 {
 510         int i,j;
 511
 512         if( flags & KEYDEF_WRITE_HEADER )
 513                 fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");
 514
 515         i=0;
 516         while (cmds[i].name && !ferror(f)) {
 517                 if (cmds[i].flags & COMMAND_KEY_MODIFIED ||
 518                     flags & KEYDEF_WRITE_ALL) {
 519                         fprintf(f, "## %s\n", cmds[i].description);
 520                         if (flags & KEYDEF_COMMENT_ALL)
 521                                 fprintf(f, "#");
 522                         fprintf(f, "key %s = ", cmds[i].name);
 523                         for (j = 0; j < MAX_COMMAND_KEYS; j++) {
 524                                 if (j && cmds[i].keys[j])
 525                                         fprintf(f, ",  ");
 526                                 if (!j || cmds[i].keys[j]) {
 527                                         if (cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
 528                                                                     isdigit(cmds[i].keys[j])))
 529                                                 fprintf(f, "\'%c\'", cmds[i].keys[j]);
 530                                         else
 531                                                 fprintf(f, "%d", cmds[i].keys[j]);
 532                                 }
 533                         }
 534                         fprintf(f,"\n\n");
 535                 }
 536                 i++;
 537         }
 538
 539         return ferror(f);
 540 }