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 */
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 <ncurses.h>
29 #include "config.h"
30 #include "ncmpc.h"
31 #include "command.h"
33 #undef DEBUG_KEYS
35 #ifdef DEBUG_KEYS
36 #define DK(x) x
37 #else
38 #define DK(x)
39 #endif
41 extern void screen_resize(void);
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)
64 static command_definition_t cmds[] =
65 {
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") },
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") },
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") },
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 { { '>', 0, 0 }, 0, CMD_TRACK_NEXT, "next",
105 N_("Next track") },
106 { { '<', 0, 0 }, 0, CMD_TRACK_PREVIOUS, "prev",
107 N_("Previous track") },
108 { { 'f', 0, 0 }, 0, CMD_SEEK_FORWARD, "seek-forward",
109 N_("Seek forward") },
110 { { 'b', 0, 0 }, 0, CMD_SEEK_BACKWARD, "seek-backward",
111 N_("Seek backward") },
112 { { '+', RGHT, 0 }, 0, CMD_VOLUME_UP, "volume-up",
113 N_("Increase volume") },
114 { { '-', LEFT, 0 }, 0, CMD_VOLUME_DOWN, "volume-down",
115 N_("Decrease volume") },
116 { { ' ', 0, 0 }, 0, CMD_SELECT, "select",
117 N_("Select/deselect song in playlist") },
118 { { DEL, 'd', 0 }, 0, CMD_DELETE, "delete",
119 N_("Delete song from playlist") },
120 { { 'Z', 0, 0 }, 0, CMD_SHUFFLE, "shuffle",
121 N_("Shuffle playlist") },
122 { { 'c', 0, 0 }, 0, CMD_CLEAR, "clear",
123 N_("Clear playlist") },
124 { { 'r', 0, 0 }, 0, CMD_REPEAT, "repeat",
125 N_("Toggle repeat mode") },
126 { { 'z', 0, 0 }, 0, CMD_RANDOM, "random",
127 N_("Toggle random mode") },
128 { { 'x', 0, 0 }, 0, CMD_CROSSFADE, "crossfade",
129 N_("Toggle crossfade mode") },
130 { { 21, 0, 0 }, 0, CMD_DB_UPDATE, "db-update",
131 N_("Start a music database update") },
132 { { 'S', 0, 0 }, 0, CMD_SAVE_PLAYLIST, "save",
133 N_("Save playlist") },
134 { { 'a', 0, 0 }, 0, CMD_ADD, "add",
135 N_("Add url/file to playlist") },
138 /* lists */
139 { { 11, 0, 0 }, 0, CMD_LIST_MOVE_UP, "move-up",
140 N_("Move item up") },
141 { { 10, 0, 0 }, 0, CMD_LIST_MOVE_DOWN, "move-down",
142 N_("Move item down") },
143 { { 12, 0, 0 }, 0, CMD_SCREEN_UPDATE, "update",
144 N_("Update screen") },
147 /* ncmpc options */
148 { { 'w', 0, 0 }, 0, CMD_TOGGLE_FIND_WRAP, "wrap-mode",
149 N_("Toggle find mode") },
150 { { 'U', 0, 0 }, 0, CMD_TOGGLE_AUTOCENTER, "autocenter-mode",
151 N_("Toggle auto center mode") },
154 /* change screen */
155 { { TAB, 0, 0 }, 0, CMD_SCREEN_NEXT, "screen-next",
156 N_("Next screen") },
157 { { STAB, 0, 0 }, 0, CMD_SCREEN_PREVIOUS, "screen-prev",
158 N_("Previous screen") },
161 /* find */
162 { { '/', 0, 0 }, 0, CMD_LIST_FIND, "find",
163 N_("Forward find") },
164 { { 'n', 0, 0 }, 0, CMD_LIST_FIND_NEXT, "find-next",
165 N_("Forward find next") },
166 { { '?', 0, 0 }, 0, CMD_LIST_RFIND, "rfind",
167 N_("Backward find") },
168 { { 'p', 0, 0 }, 0, CMD_LIST_RFIND_NEXT, "rfind-next",
169 N_("Backward find previous") },
172 /* extra screens */
173 #ifdef ENABLE_CLOCK_SCREEN
174 { {'4', F4, 0 }, 0, CMD_SCREEN_CLOCK, "screen-clock",
175 N_("Clock screen") },
176 #endif
178 { { -1, -1, -1 }, 0, CMD_NONE, NULL, NULL }
179 };
181 command_definition_t *
182 get_command_definitions(void)
183 {
184 return cmds;
185 }
187 char *
188 key2str(int key)
189 {
190 static char buf[32];
191 int i;
193 buf[0] = 0;
194 switch(key)
195 {
196 case 0:
197 return _("Undefined");
198 case ' ':
199 return _("Space");
200 case 13:
201 return _("Enter");
202 case BS:
203 return _("Backspace");
204 case DEL:
205 return _("Delete");
206 case UP:
207 return _("Up");
208 case DWN:
209 return _("Down");
210 case LEFT:
211 return _("Left");
212 case RGHT:
213 return _("Right");
214 case HOME:
215 return _("Home");
216 case END:
217 return _("End");
218 case PGDN:
219 return _("PageDown");
220 case PGUP:
221 return _("PageUp");
222 case TAB:
223 return _("Tab");
224 case STAB:
225 return _("Shift+Tab");
226 case ESC:
227 return _("Esc");
228 case KEY_IC:
229 return _("Insert");
230 default:
231 for(i=0; i<=63; i++)
232 if( key==KEY_F(i) )
233 {
234 snprintf(buf, 32, "F%d", i );
235 return buf;
236 }
237 if( !(key & ~037) )
238 snprintf(buf, 32, "Ctrl-%c", 'A'+(key & 037)-1 );
239 else if( (key & ~037) == 224 )
240 snprintf(buf, 32, "Alt-%c", 'A'+(key & 037)-1 );
241 else if( key>32 && key<256 )
242 snprintf(buf, 32, "%c", key);
243 else
244 snprintf(buf, 32, "0x%03X", key);
245 }
246 return buf;
247 }
249 void
250 command_dump_keys(void)
251 {
252 int i;
254 i=0;
255 while( cmds[i].description )
256 {
257 if( cmds[i].command != CMD_NONE )
258 printf(" %20s : %s\n", get_key_names(cmds[i].command,1),cmds[i].name);
259 i++;
260 }
261 }
263 int
264 set_key_flags(command_definition_t *cp, command_t command, int flags)
265 {
266 int i;
268 i=0;
269 while( cp[i].name )
270 {
271 if( cp[i].command == command )
272 {
273 cp[i].flags |= flags;
274 return 0;
275 }
276 i++;
277 }
278 return 1;
279 }
281 char *
282 get_key_names(command_t command, int all)
283 {
284 int i;
286 i=0;
287 while( cmds[i].description )
288 {
289 if( cmds[i].command == command )
290 {
291 int j;
292 static char keystr[80];
294 strncpy(keystr, key2str(cmds[i].keys[0]), 80);
295 if( !all )
296 return keystr;
297 j=1;
298 while( j<MAX_COMMAND_KEYS && cmds[i].keys[j]>0 )
299 {
300 strcat(keystr, " ");
301 strcat(keystr, key2str(cmds[i].keys[j]));
302 j++;
303 }
304 return keystr;
305 }
306 i++;
307 }
308 return NULL;
309 }
311 char *
312 get_key_description(command_t command)
313 {
314 int i;
316 i=0;
317 while( cmds[i].description )
318 {
319 if( cmds[i].command == command )
320 return _(cmds[i].description);
321 i++;
322 }
323 return NULL;
324 }
326 char *
327 get_key_command_name(command_t command)
328 {
329 int i;
331 i=0;
332 while( cmds[i].name )
333 {
334 if( cmds[i].command == command )
335 return cmds[i].name;
336 i++;
337 }
338 return NULL;
339 }
341 command_t
342 get_key_command_from_name(char *name)
343 {
344 int i;
346 i=0;
347 while( cmds[i].name )
348 {
349 if( strcmp(name, cmds[i].name) == 0 )
350 return cmds[i].command;
351 i++;
352 }
353 return CMD_NONE;
354 }
357 command_t
358 find_key_command(int key, command_definition_t *cmds)
359 {
360 int i;
362 i=0;
363 while( cmds && cmds[i].name )
364 {
365 if( cmds[i].keys[0] == key ||
366 cmds[i].keys[1] == key ||
367 cmds[i].keys[2] == key )
368 return cmds[i].command;
369 i++;
370 }
371 return CMD_NONE;
372 }
374 command_t
375 get_key_command(int key)
376 {
377 return find_key_command(key, cmds);
378 }
380 command_t
381 get_keyboard_command_with_timeout(int ms)
382 {
383 int key;
385 if( ms != SCREEN_TIMEOUT)
386 timeout(ms);
387 key = wgetch(stdscr);
388 if( ms != SCREEN_TIMEOUT)
389 timeout(SCREEN_TIMEOUT);
391 if( key==KEY_RESIZE )
392 screen_resize();
394 if( key==ERR )
395 return CMD_NONE;
397 #ifdef HAVE_GETMOUSE
398 if( key==KEY_MOUSE )
399 return CMD_MOUSE_EVENT;
400 #endif
402 return get_key_command(key);
403 }
405 command_t
406 get_keyboard_command(void)
407 {
408 return get_keyboard_command_with_timeout(SCREEN_TIMEOUT);
409 }
411 int
412 assign_keys(command_t command, int keys[MAX_COMMAND_KEYS])
413 {
414 int i;
416 i=0;
417 while( cmds[i].name )
418 {
419 if( cmds[i].command == command )
420 {
421 memcpy(cmds[i].keys, keys, sizeof(int)*MAX_COMMAND_KEYS);
422 cmds[i].flags |= COMMAND_KEY_MODIFIED;
423 return 0;
424 }
425 i++;
426 }
427 return -1;
428 }
430 int
431 check_key_bindings(command_definition_t *cp, char *buf, size_t bufsize)
432 {
433 int i;
434 int retval = 0;
436 if( cp==NULL )
437 cp = cmds;
439 i=0;
440 while( cp[i].name )
441 {
442 cp[i].flags &= ~COMMAND_KEY_CONFLICT;
443 i++;
444 }
446 i=0;
447 while( cp[i].name )
448 {
449 int j;
450 command_t cmd;
452 for(j=0; j<MAX_COMMAND_KEYS; j++)
453 if( cp[i].keys[j] &&
454 (cmd=find_key_command(cp[i].keys[j],cp)) != cp[i].command )
455 {
456 if( buf )
457 #ifdef ENABLE_KEYDEF_SCREEN
458 snprintf(buf, bufsize,
459 _("Key %s assigned to %s and %s (press %s for the key editor)"),
460 key2str(cp[i].keys[j]),
461 get_key_command_name(cp[i].command),
462 get_key_command_name(cmd),
463 get_key_names(CMD_SCREEN_KEYDEF,0));
464 #else
465 snprintf(buf, bufsize,
466 _("Error: Key %s assigned to %s and %s !!!\n"),
467 key2str(cp[i].keys[j]),
468 get_key_command_name(cp[i].command),
469 get_key_command_name(cmd));
470 #endif
471 else
472 fprintf(stderr,
473 _("Error: Key %s assigned to %s and %s !!!\n"),
474 key2str(cp[i].keys[j]),
475 get_key_command_name(cp[i].command),
476 get_key_command_name(cmd));
477 cp[i].flags |= COMMAND_KEY_CONFLICT;
478 set_key_flags(cp, cmd, COMMAND_KEY_CONFLICT);
479 retval = -1;
480 }
481 i++;
482 }
483 return retval;
484 }
486 int
487 write_key_bindings(FILE *f)
488 {
489 int i,j;
491 fprintf(f, "# Key bindings for ncmpc (generated by ncmpc)\n\n");
493 i=0;
494 while( cmds[i].name && !ferror(f) )
495 {
496 if( cmds[i].flags & COMMAND_KEY_MODIFIED )
497 {
498 fprintf(f, "# %s\n", cmds[i].description);
499 fprintf(f, "key %s = ", cmds[i].name);
500 for(j=0; j<MAX_COMMAND_KEYS; j++)
501 {
502 if( j && cmds[i].keys[j] )
503 fprintf(f, ", ");
504 if( !j || cmds[i].keys[j] )
505 {
506 if( cmds[i].keys[j]<256 && (isalpha(cmds[i].keys[j]) ||
507 isdigit(cmds[i].keys[j])) )
508 fprintf(f, "\'%c\'", cmds[i].keys[j]);
509 else
510 fprintf(f, "%d", cmds[i].keys[j]);
511 }
512 }
513 fprintf(f,"\n\n");
514 }
515 i++;
516 }
517 return ferror(f);
518 }