src/command.c

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