File: screen_keydef.c

package info (click to toggle)
ncmpc 0.25-0.1%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 2,616 kB
  • sloc: ansic: 12,229; sh: 4,157; makefile: 282; ruby: 28
file content (514 lines) | stat: -rw-r--r-- 11,378 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
/* ncmpc (Ncurses MPD Client)
 * (c) 2004-2010 The Music Player Daemon Project
 * Project homepage: http://musicpd.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#include "screen_keydef.h"
#include "screen_interface.h"
#include "screen_status.h"
#include "screen_find.h"
#include "i18n.h"
#include "conf.h"
#include "screen.h"
#include "screen_utils.h"
#include "options.h"
#include "Compiler.h"

#include <assert.h>
#include <errno.h>
#include <string.h>
#include <glib.h>

static struct list_window *lw;

static command_definition_t *cmds = NULL;

/** the number of commands */
static unsigned command_n_commands = 0;

/**
 * the position of the "apply" item. It's the same as command_n_commands,
 * because array subscripts start at 0, while numbers of items start at 1.
 */
gcc_pure
static inline unsigned
command_item_apply(void)
{
	return command_n_commands;
}

/** the position of the "apply and save" item */
gcc_pure
static inline unsigned
command_item_save(void)
{
	return command_item_apply() + 1;
}

/** the number of items in the "command" view */
gcc_pure
static inline unsigned
command_length(void)
{
	return command_item_save() + 1;
}


/**
 * The command being edited, represented by a array subscript to @cmds, or -1,
 * if no command is being edited
 */
static int subcmd = -1;

/** The number of keys assigned to the current command */
static unsigned subcmd_n_keys = 0;

/** The position of the up ("[..]") item */
gcc_const
static inline unsigned
subcmd_item_up(void)
{
	return 0;
}

/** The position of the "add a key" item */
gcc_pure
static inline unsigned
subcmd_item_add(void)
{
	return subcmd_n_keys + 1;
}

/** The number of items in the list_window, if there's a command being edited */
gcc_pure
static inline unsigned
subcmd_length(void)
{
	return subcmd_item_add() + 1;
}

/** Check whether a given item is a key */
gcc_pure
static inline bool
subcmd_item_is_key(unsigned i)
{
	return (i > subcmd_item_up() && i < subcmd_item_add());
}

/**
 * Convert an item id (as in lw->selected) into a "key id", which is an array
 * subscript to cmds[subcmd].keys.
 */
gcc_const
static inline unsigned
subcmd_item_to_key_id(unsigned i)
{
	return i - 1;
}


static int
keybindings_changed(void)
{
	command_definition_t *orginal_cmds = get_command_definitions();
	size_t size = command_n_commands * sizeof(command_definition_t);

	return memcmp(orginal_cmds, cmds, size);
}

static void
apply_keys(void)
{
	if (keybindings_changed()) {
		command_definition_t *orginal_cmds = get_command_definitions();
		size_t size = command_n_commands * sizeof(command_definition_t);

		memcpy(orginal_cmds, cmds, size);
		screen_status_printf(_("You have new key bindings"));
	} else
		screen_status_printf(_("Keybindings unchanged."));
}

static int
save_keys(void)
{
	char *allocated = NULL;
	const char *filename = options.key_file;
	if (filename == NULL) {
		if (!check_user_conf_dir()) {
			screen_status_printf(_("Error: Unable to create directory ~/.ncmpc - %s"),
					     strerror(errno));
			screen_bell();
			return -1;
		}

		filename = allocated = build_user_key_binding_filename();
	}

	FILE *f = fopen(filename, "w");
	if (f == NULL) {
		screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));
		screen_bell();
		g_free(allocated);
		return -1;
	}

	if (write_key_bindings(f, KEYDEF_WRITE_HEADER))
		screen_status_printf(_("Wrote %s"), filename);
	else
		screen_status_printf(_("Error: %s - %s"), filename, strerror(errno));

	g_free(allocated);
	return fclose(f);
}

/* TODO: rename to check_n_keys / subcmd_count_keys? */
static void
check_subcmd_length(void)
{
	unsigned i;

	/* this loops counts the continous valid keys at the start of the the keys
	   array, so make sure you don't have gaps */
	for (i = 0; i < MAX_COMMAND_KEYS; i++)
		if (cmds[subcmd].keys[i] == 0)
			break;
	subcmd_n_keys = i;

	list_window_set_length(lw, subcmd_length());
}

static void
keydef_paint(void);

static void
keydef_repaint(void)
{
	keydef_paint();
	wrefresh(lw->w);
}

/** lw->start the last time switch_to_subcmd_mode() was called */
static unsigned saved_start = 0;

static void
switch_to_subcmd_mode(int cmd)
{
	assert(subcmd == -1);

	saved_start = lw->start;

	subcmd = cmd;
	list_window_reset(lw);
	check_subcmd_length();

	keydef_repaint();
}

static void
switch_to_command_mode(void)
{
	assert(subcmd != -1);

	list_window_set_length(lw, command_length());
	list_window_set_cursor(lw, subcmd);
	subcmd = -1;

	lw->start = saved_start;

	keydef_repaint();
}

/**
 * Delete a key from a given command's definition
 * @param cmd_index the command
 * @param key_index the key (see below)
 */
static void
delete_key(int cmd_index, int key_index)
{
	/* shift the keys to close the gap that appeared */
	int i = key_index+1;
	while (i < MAX_COMMAND_KEYS && cmds[cmd_index].keys[i])
		cmds[cmd_index].keys[key_index++] = cmds[cmd_index].keys[i++];

	/* As key_index now holds the index of the last key slot that contained
	   a key, we use it to empty this slot, because this key has been copied
	   to the previous slot in the loop above */
	cmds[cmd_index].keys[key_index] = 0;

	cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;
	check_subcmd_length();

	screen_status_printf(_("Deleted"));

	/* repaint */
	keydef_repaint();

	/* update key conflict flags */
	check_key_bindings(cmds, NULL, 0);
}

/* assigns a new key to a key slot */
static void
overwrite_key(int cmd_index, int key_index)
{
	assert(key_index < MAX_COMMAND_KEYS);

	char *buf = g_strdup_printf(_("Enter new key for %s: "),
				    cmds[cmd_index].name);
	const int key = screen_getch(buf);
	g_free(buf);

	if (key == ERR) {
		screen_status_printf(_("Aborted"));
		return;
	}

	if (key == '\0') {
		screen_status_printf(_("Ctrl-Space can't be used"));
		return;
	}

	const command_t cmd = find_key_command(key, cmds);
	if (cmd != CMD_NONE) {
		screen_status_printf(_("Error: key %s is already used for %s"),
				     key2str(key), get_key_command_name(cmd));
		screen_bell();
		return;
	}

	cmds[cmd_index].keys[key_index] = key;
	cmds[cmd_index].flags |= COMMAND_KEY_MODIFIED;

	screen_status_printf(_("Assigned %s to %s"),
			     key2str(key),cmds[cmd_index].name);
	check_subcmd_length();

	/* repaint */
	keydef_repaint();

	/* update key conflict flags */
	check_key_bindings(cmds, NULL, 0);
}

/* assign a new key to a new slot */
static void
add_key(int cmd_index)
{
	if (subcmd_n_keys < MAX_COMMAND_KEYS)
		overwrite_key(cmd_index, subcmd_n_keys);
}

static const char *
list_callback(unsigned idx, gcc_unused void *data)
{
	static char buf[256];

	if (subcmd == -1) {
		if (idx == command_item_apply())
			return _("===> Apply key bindings ");
		if (idx == command_item_save())
			return _("===> Apply & Save key bindings  ");

		assert(idx < (unsigned) command_n_commands);

		/*
		 * Format the lines in two aligned columnes for the key name and
		 * the description, like this:
		 *
		 *	this-command - do this
		 *	that-one     - do that
		 */
		size_t len = strlen(cmds[idx].name);
		strncpy(buf, cmds[idx].name, sizeof(buf));

		if (len < get_cmds_max_name_width(cmds))
			memset(buf + len, ' ', get_cmds_max_name_width(cmds) - len);

		g_snprintf(buf + get_cmds_max_name_width(cmds),
			   sizeof(buf) - get_cmds_max_name_width(cmds),
			   " - %s", _(cmds[idx].description));

		return buf;
	} else {
		if (idx == subcmd_item_up())
			return "[..]";

		if (idx == subcmd_item_add()) {
			g_snprintf(buf, sizeof(buf), "%d. %s",
				   idx, _("Add new key"));
			return buf;
		}

		assert(subcmd_item_is_key(idx));

		g_snprintf(buf, sizeof(buf),
			   "%d. %-20s   (%d) ", idx,
			   key2str(cmds[subcmd].keys[subcmd_item_to_key_id(idx)]),
			   cmds[subcmd].keys[subcmd_item_to_key_id(idx)]);
		return buf;
	}
}

static void
keydef_init(WINDOW *w, int cols, int rows)
{
	lw = list_window_init(w, cols, rows);
}

static void
keydef_resize(int cols, int rows)
{
	list_window_resize(lw, cols, rows);
}

static void
keydef_exit(void)
{
	list_window_free(lw);
	if (cmds)
		g_free(cmds);
	cmds = NULL;
	lw = NULL;
}

static void
keydef_open(gcc_unused struct mpdclient *c)
{
	if (cmds == NULL) {
		command_definition_t *current_cmds = get_command_definitions();
		command_n_commands = 0;
		while (current_cmds[command_n_commands].name)
			command_n_commands++;

		/* +1 for the terminator element */
		size_t cmds_size = (command_n_commands + 1)
			* sizeof(command_definition_t);
		cmds = g_malloc0(cmds_size);
		memcpy(cmds, current_cmds, cmds_size);
	}

	subcmd = -1;
	list_window_set_length(lw, command_length());
}

static void
keydef_close(void)
{
	if (cmds && !keybindings_changed()) {
		g_free(cmds);
		cmds = NULL;
	} else
		screen_status_printf(_("Note: Did you forget to \'Apply\' your changes?"));
}

static const char *
keydef_title(char *str, size_t size)
{
	if (subcmd == -1)
		return _("Edit key bindings");

	g_snprintf(str, size, _("Edit keys for %s"), cmds[subcmd].name);
	return str;
}

static void
keydef_paint(void)
{
	list_window_paint(lw, list_callback, NULL);
}

static bool
keydef_cmd(gcc_unused struct mpdclient *c, command_t cmd)
{
	if (cmd == CMD_LIST_RANGE_SELECT)
		return false;

	if (list_window_cmd(lw, cmd)) {
		keydef_repaint();
		return true;
	}

	switch(cmd) {
	case CMD_PLAY:
		if (subcmd == -1) {
			if (lw->selected == command_item_apply()) {
				apply_keys();
			} else if (lw->selected == command_item_save()) {
				apply_keys();
				save_keys();
			} else {
				switch_to_subcmd_mode(lw->selected);
			}
		} else {
			if (lw->selected == subcmd_item_up()) {
				switch_to_command_mode();
			} else if (lw->selected == subcmd_item_add()) {
				add_key(subcmd);
			} else {
				/* just to be sure ;-) */
				assert(subcmd_item_is_key(lw->selected));
				overwrite_key(subcmd, subcmd_item_to_key_id(lw->selected));
			}
		}
		return true;
	case CMD_GO_PARENT_DIRECTORY:
	case CMD_GO_ROOT_DIRECTORY:
		if (subcmd != -1)
			switch_to_command_mode();
		return true;
	case CMD_DELETE:
		if (subcmd != -1 && subcmd_item_is_key(lw->selected))
			delete_key(subcmd, subcmd_item_to_key_id(lw->selected));

		return true;
	case CMD_ADD:
		if (subcmd != -1)
			add_key(subcmd);
		return true;
	case CMD_SAVE_PLAYLIST:
		apply_keys();
		save_keys();
		return true;
	case CMD_LIST_FIND:
	case CMD_LIST_RFIND:
	case CMD_LIST_FIND_NEXT:
	case CMD_LIST_RFIND_NEXT:
		screen_find(lw, cmd, list_callback, NULL);
		keydef_repaint();
		return true;

	default:
		return false;
	}

	/* unreachable */
	assert(0);
	return false;
}

const struct screen_functions screen_keydef = {
	.init = keydef_init,
	.exit = keydef_exit,
	.open = keydef_open,
	.close = keydef_close,
	.resize = keydef_resize,
	.paint = keydef_paint,
	.cmd = keydef_cmd,
	.get_title = keydef_title,
};