695c11bececcb43e2c3ae35851ac89731217c857
1 /* ncmpc (Ncurses MPD Client)
2 * (c) 2004-2009 The Music Player Daemon Project
3 * Project homepage: http://musicpd.org
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
20 #include "command.h"
21 #include "config.h"
22 #include "ncmpc.h"
23 #include "i18n.h"
24 #include "mpdclient.h"
25 #include "screen.h"
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>
35 #undef DEBUG_KEYS
37 #ifdef DEBUG_KEYS
38 #define DK(x) x
39 #else
40 #define DK(x)
41 #endif
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 #define F8 KEY_F(8)
66 static command_definition_t cmds[] = {
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") },
74 /* movement */
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 { { 'H', 0, 0 }, 0, CMD_LIST_TOP, "top",
80 N_("Move cursor to top of screen") },
81 { { 'M', 0, 0 }, 0, CMD_LIST_MIDDLE, "middle",
82 N_("Move cursor to middle of screen") },
83 { { 'L', 0, 0 }, 0, CMD_LIST_BOTTOM, "bottom",
84 N_("Move cursor to bottom of screen") },
85 { { HOME, 0x01, 0 }, 0, CMD_LIST_FIRST, "home",
86 N_("Home") },
87 { { END, 0x05, 0 }, 0, CMD_LIST_LAST, "end",
88 N_("End") },
89 { { PGUP, 0, 0 }, 0, CMD_LIST_PREVIOUS_PAGE, "pgup",
90 N_("Page up") },
91 { { PGDN, 0, 0 }, 0, CMD_LIST_NEXT_PAGE, "pgdn",
92 N_("Page down") },
93 { { 'v', 0, 0 }, 0, CMD_LIST_RANGE_SELECT, "range-select",
94 N_("Range selection") },
95 { { 14, 0, 0 }, 0, CMD_LIST_SCROLL_DOWN_LINE, "scroll-down-line",
96 N_("Scroll up one line") },
97 { { 2, 0, 0 }, 0, CMD_LIST_SCROLL_UP_LINE, "scroll-up-line",
98 N_("Scroll down one line") },
99 { { 'N', 0, 0 }, 0, CMD_LIST_SCROLL_DOWN_HALF, "scroll-down-half",
100 N_("Scroll up half a screen") },
101 { { 'B', 0, 0 }, 0, CMD_LIST_SCROLL_UP_HALF, "scroll-up-half",
102 N_("Scroll down half a screen") },
105 /* basic screens */
106 { { '1', F1, 'h' }, 0, CMD_SCREEN_HELP, "screen-help",
107 N_("Help screen") },
108 { { '2', F2, 0 }, 0, CMD_SCREEN_PLAY, "screen-playlist",
109 N_("Playlist screen") },
110 { { '3', F3, 0 }, 0, CMD_SCREEN_FILE, "screen-browse",
111 N_("Browse screen") },
114 /* player commands */
115 { { 13, 0, 0 }, 0, CMD_PLAY, "play",
116 N_("Play/Enter directory") },
117 { { 'P', 0, 0 }, 0, CMD_PAUSE,"pause",
118 N_("Pause") },
119 { { 's', BS, 0 }, 0, CMD_STOP, "stop",
120 N_("Stop") },
121 { { 'o', 0, 0 }, 0, CMD_CROP, "crop",
122 N_("Crop") },
123 { { '>', 0, 0 }, 0, CMD_TRACK_NEXT, "next",
124 N_("Next track") },
125 { { '<', 0, 0 }, 0, CMD_TRACK_PREVIOUS, "prev",
126 N_("Previous track") },
127 { { 'f', 0, 0 }, 0, CMD_SEEK_FORWARD, "seek-forward",
128 N_("Seek forward") },
129 { { 'b', 0, 0 }, 0, CMD_SEEK_BACKWARD, "seek-backward",
130 N_("Seek backward") },
131 { { '+', RGHT, 0 }, 0, CMD_VOLUME_UP, "volume-up",
132 N_("Increase volume") },
133 { { '-', LEFT, 0 }, 0, CMD_VOLUME_DOWN, "volume-down",
134 N_("Decrease volume") },
135 { { ' ', 0, 0 }, 0, CMD_SELECT, "select",
136 N_("Select/deselect song in playlist") },
137 { { 't', 0, 0 }, 0, CMD_SELECT_ALL, "select_all",
138 N_("Select all listed items") },
139 { { DEL, 'd', 0 }, 0, CMD_DELETE, "delete",
140 N_("Delete song from playlist") },
141 { { 'Z', 0, 0 }, 0, CMD_SHUFFLE, "shuffle",
142 N_("Shuffle playlist") },
143 { { 'c', 0, 0 }, 0, CMD_CLEAR, "clear",
144 N_("Clear playlist") },
145 { { 'r', 0, 0 }, 0, CMD_REPEAT, "repeat",
146 N_("Toggle repeat mode") },
147 { { 'z', 0, 0 }, 0, CMD_RANDOM, "random",
148 N_("Toggle random mode") },
149 { { 'y', 0, 0 }, 0, CMD_SINGLE, "single",
150 N_("Toggle single mode") },
151 { { 'C', 0, 0 }, 0, CMD_CONSUME, "consume",
152 N_("Toggle consume mode") },
153 { { 'x', 0, 0 }, 0, CMD_CROSSFADE, "crossfade",
154 N_("Toggle crossfade mode") },
155 { { 21, 0, 0 }, 0, CMD_DB_UPDATE, "db-update",
156 N_("Start a music database update") },
157 { { 'S', 0, 0 }, 0, CMD_SAVE_PLAYLIST, "save",
158 N_("Save playlist") },
159 { { 'a', 0, 0 }, 0, CMD_ADD, "add",
160 N_("Add url/file to playlist") },
162 { { '!', 0, 0 }, 0, CMD_GO_ROOT_DIRECTORY, "go-root-directory",
163 N_("Go to root directory") },
164 { { '"', 0, 0 }, 0, CMD_GO_PARENT_DIRECTORY, "go-parent-directory",
165 N_("Go to parent directory") },
167 { { 'G', 0, 0 }, 0, CMD_LOCATE, "locate",
168 N_("Locate song in browser") },
170 /* lists */
171 { { 11, 0, 0 }, 0, CMD_LIST_MOVE_UP, "move-up",
172 N_("Move item up") },
173 { { 10, 0, 0 }, 0, CMD_LIST_MOVE_DOWN, "move-down",
174 N_("Move item down") },
175 { { 12, 0, 0 }, 0, CMD_SCREEN_UPDATE, "update",
176 N_("Refresh screen") },
179 /* ncmpc options */
180 { { 'w', 0, 0 }, 0, CMD_TOGGLE_FIND_WRAP, "wrap-mode",
181 /* translators: toggle between wrapping and non-wrapping
182 search */
183 N_("Toggle find mode") },
184 { { 'U', 0, 0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
185 /* translators: the auto center mode always centers the song
186 currently being played */
187 N_("Toggle auto center mode") },
190 /* change screen */
191 { { TAB, 0, 0 }, 0, CMD_SCREEN_NEXT, "screen-next",
192 N_("Next screen") },
193 { { STAB, 0, 0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
194 N_("Previous screen") },
195 { { '`', 0, 0 }, 0, CMD_SCREEN_SWAP, "screen-swap",
196 N_("Swap to most recent screen") },
199 /* find */
200 { { '/', 0, 0 }, 0, CMD_LIST_FIND, "find",
201 N_("Forward find") },
202 { { 'n', 0, 0 }, 0, CMD_LIST_FIND_NEXT, "find-next",
203 N_("Forward find next") },
204 { { '?', 0, 0 }, 0, CMD_LIST_RFIND, "rfind",
205 N_("Backward find") },
206 { { 'p', 0, 0 }, 0, CMD_LIST_RFIND_NEXT, "rfind-next",
207 N_("Backward find previous") },
208 { { '.', 0, 0 }, 0, CMD_LIST_JUMP, "jump",
209 /* translators: this queries the user for a string
210 * and jumps directly (while the user is typing)
211 * to the entry which begins with this string */
212 N_("Jump to") },
215 /* extra screens */
216 #ifdef ENABLE_ARTIST_SCREEN
217 { {'4', F4, 0 }, 0, CMD_SCREEN_ARTIST, "screen-artist",
218 N_("Artist screen") },
219 #endif
220 #ifdef ENABLE_SEARCH_SCREEN
221 { {'5', F5, 0 }, 0, CMD_SCREEN_SEARCH, "screen-search",
222 N_("Search screen") },
223 { {'m', 0, 0 }, 0, CMD_SEARCH_MODE, "search-mode",
224 N_("Change search mode") },
225 #endif
226 #ifdef ENABLE_SONG_SCREEN
227 { { 'i', 0, 0 }, 0, CMD_SCREEN_SONG, "view",
228 N_("View the selected and the currently playing song") },
229 #endif
230 #ifdef ENABLE_LYRICS_SCREEN
231 { {'7', F7, 0 }, 0, CMD_SCREEN_LYRICS, "screen-lyrics",
232 N_("Lyrics screen") },
233 { {ESC, 0, 0 }, 0, CMD_INTERRUPT, "lyrics-interrupt",
234 /* translators: interrupt the current background action,
235 e.g. stop loading lyrics from the internet */
236 N_("Interrupt action") },
237 { {'u', 0, 0 }, 0, CMD_LYRICS_UPDATE, "lyrics-update",
238 N_("Update Lyrics") },
239 #endif
241 #ifdef ENABLE_OUTPUTS_SCREEN
242 { {'8', F8, 0 }, 0, CMD_SCREEN_OUTPUTS, "screen-outputs",
243 N_("Outputs screen") },
244 #endif
247 { { -1, -1, -1 }, 0, CMD_NONE, NULL, NULL }
248 };
250 #ifdef ENABLE_KEYDEF_SCREEN
251 command_definition_t *
252 get_command_definitions(void)
253 {
254 return cmds;
255 }
256 #endif
258 const char *
259 key2str(int key)
260 {
261 static char buf[32];
262 int i;
264 buf[0] = 0;
265 switch(key) {
266 case 0:
267 return _("Undefined");
268 case ' ':
269 return _("Space");
270 case 13:
271 return _("Enter");
272 case BS:
273 return _("Backspace");
274 case DEL:
275 return _("Delete");
276 case UP:
277 return _("Up");
278 case DWN:
279 return _("Down");
280 case LEFT:
281 return _("Left");
282 case RGHT:
283 return _("Right");
284 case HOME:
285 return _("Home");
286 case END:
287 return _("End");
288 case PGDN:
289 return _("PageDown");
290 case PGUP:
291 return _("PageUp");
292 case TAB:
293 return _("Tab");
294 case STAB:
295 return _("Shift+Tab");
296 case ESC:
297 return _("Esc");
298 case KEY_IC:
299 return _("Insert");
300 default:
301 for (i = 0; i <= 63; i++)
302 if (key == KEY_F(i)) {
303 g_snprintf(buf, 32, "F%d", i );
304 return buf;
305 }
306 if (!(key & ~037))
307 g_snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
308 else if ((key & ~037) == 224)
309 g_snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
310 else if (key > 32 && key < 256)
311 g_snprintf(buf, 32, "%c", key);
312 else
313 g_snprintf(buf, 32, "0x%03X", key);
314 }
316 return buf;
317 }
319 void
320 command_dump_keys(void)
321 {
322 int i;
324 i = 0;
325 while (cmds[i].description) {
326 if (cmds[i].command != CMD_NONE)
327 printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
328 i++;
329 }
330 }
332 #ifndef NCMPC_MINI
334 static int
335 set_key_flags(command_definition_t *cp, command_t command, int flags)
336 {
337 int i;
339 i = 0;
340 while (cp[i].name) {
341 if (cp[i].command == command) {
342 cp[i].flags |= flags;
343 return 0;
344 }
345 i++;
346 }
348 return 1;
349 }
351 #endif
353 const char *
354 get_key_names(command_t command, int all)
355 {
356 int i;
358 i=0;
359 while (cmds[i].description) {
360 if (cmds[i].command == command) {
361 int j;
362 static char keystr[80];
364 g_strlcpy(keystr, key2str(cmds[i].keys[0]), sizeof(keystr));
365 if (!all)
366 return keystr;
367 j=1;
368 while (j < MAX_COMMAND_KEYS && cmds[i].keys[j] > 0) {
369 g_strlcat(keystr, " ", sizeof(keystr));
370 g_strlcat(keystr, key2str(cmds[i].keys[j]), sizeof(keystr));
371 j++;
372 }
373 return keystr;
374 }
375 i++;
376 }
377 return NULL;
378 }
380 const char *
381 get_key_description(command_t command)
382 {
383 int i;
385 i=0;
386 while (cmds[i].description) {
387 if (cmds[i].command == command)
388 return _(cmds[i].description);
389 i++;
390 }
392 return NULL;
393 }
395 const char *
396 get_key_command_name(command_t command)
397 {
398 int i;
400 i=0;
401 while (cmds[i].name) {
402 if (cmds[i].command == command)
403 return cmds[i].name;
404 i++;
405 }
406 return NULL;
407 }
409 command_t
410 get_key_command_from_name(char *name)
411 {
412 int i;
414 i=0;
415 while (cmds[i].name) {
416 if (strcmp(name, cmds[i].name) == 0)
417 return cmds[i].command;
418 i++;
419 }
421 return CMD_NONE;
422 }
424 command_t
425 find_key_command(int key, command_definition_t *c)
426 {
427 int i;
429 i=0;
430 while (key && c && c[i].name) {
431 if (c[i].keys[0] == key ||
432 c[i].keys[1] == key ||
433 c[i].keys[2] == key)
434 return c[i].command;
435 i++;
436 }
438 return CMD_NONE;
439 }
441 command_t
442 get_key_command(int key)
443 {
444 return find_key_command(key, cmds);
445 }
447 command_t
448 get_keyboard_command(void)
449 {
450 int key;
452 key = wgetch(stdscr);
453 if (key == ERR)
454 return CMD_NONE;
456 #ifdef HAVE_GETMOUSE
457 if (key == KEY_MOUSE)
458 return CMD_MOUSE_EVENT;
459 #endif
461 return get_key_command(key);
462 }
464 int
465 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
466 {
467 int i;
469 i=0;
470 while (cmds[i].name) {
471 if (cmds[i].command == command) {
472 memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
473 #ifndef NCMPC_MINI
474 cmds[i].flags |= COMMAND_KEY_MODIFIED;
475 #endif
476 return 0;
477 }
478 i++;
479 }
480 return -1;
481 }
483 #ifndef NCMPC_MINI
485 int
486 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
487 {
488 int i;
489 int retval = 0;
491 if (cp == NULL)
492 cp = cmds;
494 i=0;
495 while (cp[i].name) {
496 cp[i].flags &= ~COMMAND_KEY_CONFLICT;
497 i++;
498 }
500 i=0;
501 while (cp[i].name) {
502 int j;
503 command_t cmd;
505 for(j=0; j<MAX_COMMAND_KEYS; j++)
506 if (cp[i].keys[j] &&
507 (cmd = find_key_command(cp[i].keys[j],cp)) != cp[i].command) {
508 if (buf) {
509 g_snprintf(buf, bufsize,
510 _("Key %s assigned to %s and %s"),
511 key2str(cp[i].keys[j]),
512 get_key_command_name(cp[i].command),
513 get_key_command_name(cmd));
514 } else {
515 fprintf(stderr,
516 _("Key %s assigned to %s and %s"),
517 key2str(cp[i].keys[j]),
518 get_key_command_name(cp[i].command),
519 get_key_command_name(cmd));
520 fputc('\n', stderr);
521 }
522 cp[i].flags |= COMMAND_KEY_CONFLICT;
523 set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
524 retval = -1;
525 }
526 i++;
527 }
528 return retval;
529 }
531 int
532 write_key_bindings(FILE *f, int flags)
533 {
534 int i,j;
536 if (flags & KEYDEF_WRITE_HEADER)
537 fprintf(f, "## Key bindings for ncmpc (generated by ncmpc)\n\n");
539 i = 0;
540 while (cmds[i].name && !ferror(f)) {
541 if (cmds[i].flags & COMMAND_KEY_MODIFIED ||
542 flags & KEYDEF_WRITE_ALL) {
543 fprintf(f, "## %s\n", cmds[i].description);
544 if (flags & KEYDEF_COMMENT_ALL)
545 fprintf(f, "#");
546 fprintf(f, "key %s = ", cmds[i].name);
547 for (j = 0; j < MAX_COMMAND_KEYS; j++) {
548 if (j && cmds[i].keys[j])
549 fprintf(f, ", ");
550 if (!j || cmds[i].keys[j]) {
551 if (cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
552 isdigit(cmds[i].keys[j])))
553 fprintf(f, "\'%c\'", cmds[i].keys[j]);
554 else
555 fprintf(f, "%d", cmds[i].keys[j]);
556 }
557 }
558 fprintf(f,"\n\n");
559 }
560 i++;
561 }
563 return ferror(f);
564 }
566 #endif