964a5a3fdc1da7623ccea5a1116e33625b221eb1
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 "config.h"
21 #include "i18n.h"
22 #include "mpdclient.h"
23 #include "command.h"
24 #include "screen.h"
25 #include "screen_utils.h"
27 #include <stdlib.h>
28 #include <string.h>
29 #include <glib.h>
31 typedef struct {
32 signed char highlight;
33 command_t command;
34 const char *text;
35 } help_text_row_t;
37 static help_text_row_t help_text[] = {
38 { 1, CMD_NONE, N_("Movement") },
39 { 2, CMD_NONE, NULL },
40 { 0, CMD_LIST_PREVIOUS, NULL },
41 { 0, CMD_LIST_NEXT, NULL },
42 { 0, CMD_LIST_TOP, NULL },
43 { 0, CMD_LIST_MIDDLE, NULL },
44 { 0, CMD_LIST_BOTTOM, NULL },
45 { 0, CMD_LIST_PREVIOUS_PAGE, NULL },
46 { 0, CMD_LIST_NEXT_PAGE, NULL },
47 { 0, CMD_LIST_FIRST, NULL },
48 { 0, CMD_LIST_LAST, NULL },
49 { 0, CMD_LIST_RANGE_SELECT, NULL },
50 { 0, CMD_LIST_SCROLL_UP_LINE, NULL},
51 { 0, CMD_LIST_SCROLL_DOWN_LINE, NULL},
52 { 0, CMD_LIST_SCROLL_UP_HALF, NULL},
53 { 0, CMD_LIST_SCROLL_DOWN_HALF, NULL},
54 { 0, CMD_NONE, NULL },
55 { 0, CMD_SCREEN_PREVIOUS,NULL },
56 { 0, CMD_SCREEN_NEXT, NULL },
57 { 0, CMD_SCREEN_HELP, NULL },
58 { 0, CMD_SCREEN_PLAY, NULL },
59 { 0, CMD_SCREEN_FILE, NULL },
60 #ifdef ENABLE_ARTIST_SCREEN
61 { 0, CMD_SCREEN_ARTIST, NULL },
62 #endif
63 #ifdef ENABLE_SEARCH_SCREEN
64 { 0, CMD_SCREEN_SEARCH, NULL },
65 #endif
66 #ifdef ENABLE_LYRICS_SCREEN
67 { 0, CMD_SCREEN_LYRICS, NULL },
68 #endif
69 #ifdef ENABLE_OUTPUTS_SCREEN
70 { 0, CMD_SCREEN_OUTPUTS, NULL },
71 #endif
72 #ifdef ENABLE_KEYDEF_SCREEN
73 { 0, CMD_SCREEN_KEYDEF, NULL },
74 #endif
76 { 0, CMD_NONE, NULL },
77 { 0, CMD_NONE, NULL },
78 { 1, CMD_NONE, N_("Global") },
79 { 2, CMD_NONE, NULL },
80 { 0, CMD_STOP, NULL },
81 { 0, CMD_PAUSE, NULL },
82 { 0, CMD_CROP, NULL },
83 { 0, CMD_TRACK_NEXT, NULL },
84 { 0, CMD_TRACK_PREVIOUS, NULL },
85 { 0, CMD_SEEK_FORWARD, NULL },
86 { 0, CMD_SEEK_BACKWARD, NULL },
87 { 0, CMD_VOLUME_DOWN, NULL },
88 { 0, CMD_VOLUME_UP, NULL },
89 { 0, CMD_NONE, NULL },
90 { 0, CMD_REPEAT, NULL },
91 { 0, CMD_RANDOM, NULL },
92 { 0, CMD_CROSSFADE, NULL },
93 { 0, CMD_SHUFFLE, NULL },
94 { 0, CMD_DB_UPDATE, NULL },
95 { 0, CMD_NONE, NULL },
96 { 0, CMD_LIST_FIND, NULL },
97 { 0, CMD_LIST_RFIND, NULL },
98 { 0, CMD_LIST_FIND_NEXT, NULL },
99 { 0, CMD_LIST_RFIND_NEXT, NULL },
100 { 0, CMD_LIST_JUMP, NULL },
101 { 0, CMD_TOGGLE_FIND_WRAP, NULL },
102 { 0, CMD_LOCATE, NULL },
103 { 0, CMD_SCREEN_SONG, NULL },
104 { 0, CMD_NONE, NULL },
105 { 0, CMD_QUIT, NULL },
107 { 0, CMD_NONE, NULL },
108 { 0, CMD_NONE, NULL },
109 { 1, CMD_NONE, N_("Playlist screen") },
110 { 2, CMD_NONE, NULL },
111 { 0, CMD_PLAY, N_("Play") },
112 { 0, CMD_DELETE, NULL },
113 { 0, CMD_CLEAR, NULL },
114 { 0, CMD_LIST_MOVE_UP, N_("Move song up") },
115 { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
116 { 0, CMD_ADD, NULL },
117 { 0, CMD_SAVE_PLAYLIST, NULL },
118 { 0, CMD_SCREEN_UPDATE, N_("Center") },
119 { 0, CMD_TOGGLE_AUTOCENTER, NULL },
121 { 0, CMD_NONE, NULL },
122 { 0, CMD_NONE, NULL },
123 { 1, CMD_NONE, N_("Browse screen") },
124 { 2, CMD_NONE, NULL },
125 { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
126 { 0, CMD_SELECT, NULL },
127 { 0, CMD_ADD, N_("Append song to playlist") },
128 { 0, CMD_SAVE_PLAYLIST, NULL },
129 { 0, CMD_DELETE, N_("Delete playlist") },
130 { 0, CMD_GO_PARENT_DIRECTORY, NULL },
131 { 0, CMD_GO_ROOT_DIRECTORY, NULL },
132 { 0, CMD_SCREEN_UPDATE, NULL },
134 #ifdef ENABLE_SEARCH_SCREEN
135 { 0, CMD_NONE, NULL },
136 { 0, CMD_NONE, NULL },
137 { 1, CMD_NONE, N_("Search screen") },
138 { 2, CMD_NONE, NULL },
139 { 0, CMD_SCREEN_SEARCH, N_("Search") },
140 { 0, CMD_PLAY, N_("Select and play") },
141 { 0, CMD_SELECT, NULL },
142 { 0, CMD_ADD, N_("Append song to playlist") },
143 { 0, CMD_SELECT_ALL, NULL },
144 { 0, CMD_SEARCH_MODE, NULL },
145 #endif
146 #ifdef ENABLE_LYRICS_SCREEN
147 { 0, CMD_NONE, NULL },
148 { 0, CMD_NONE, NULL },
149 { 1, CMD_NONE, N_("Lyrics screen") },
150 { 2, CMD_NONE, NULL },
151 { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
152 { 0, CMD_SELECT, N_("(Re)load lyrics") },
153 { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
154 { 0, CMD_LYRICS_UPDATE, N_("Download lyrics for currently playing song") },
155 { 0, CMD_SAVE_PLAYLIST, N_("Save lyrics") },
156 #endif
157 #ifdef ENABLE_OUTPUTS_SCREEN
158 { 0, CMD_NONE, NULL },
159 { 0, CMD_NONE, NULL },
160 { 1, CMD_NONE, N_("Outputs screen") },
161 { 2, CMD_NONE, NULL },
162 { 0, CMD_PLAY, N_("Enable/disable output") },
163 #endif
164 #ifdef ENABLE_KEYDEF_SCREEN
165 { 0, CMD_NONE, NULL },
166 { 0, CMD_NONE, NULL },
167 { 1, CMD_NONE, N_("Keydef screen") },
168 { 2, CMD_NONE, NULL },
169 { 0, CMD_PLAY, N_("Edit keydefs for selected command") },
170 { 0, CMD_DELETE, N_("Remove selected keydef") },
171 { 0, CMD_GO_PARENT_DIRECTORY, N_("Go up a level") },
172 { 0, CMD_SAVE_PLAYLIST, N_("Apply and save changes") },
173 #endif
174 };
176 #define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
178 static list_window_t *lw;
180 static const char *
181 list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED void *data)
182 {
183 static char buf[512];
185 if (idx >= help_text_rows)
186 return NULL;
188 if (help_text[idx].highlight)
189 *highlight = true;
191 if (help_text[idx].command == CMD_NONE) {
192 if (help_text[idx].text)
193 g_snprintf(buf, sizeof(buf), " %s", _(help_text[idx].text));
194 else if (help_text[idx].highlight == 2) {
195 int i;
197 for (i = 3; i < COLS - 3 && i < (int)sizeof(buf); i++)
198 buf[i] = '-';
199 buf[i] = '\0';
200 } else
201 g_strlcpy(buf, " ", sizeof(buf));
202 return buf;
203 }
205 if (help_text[idx].text)
206 g_snprintf(buf, sizeof(buf),
207 "%20s : %s ",
208 get_key_names(help_text[idx].command, TRUE),
209 _(help_text[idx].text));
210 else
211 g_snprintf(buf, sizeof(buf),
212 "%20s : %s ",
213 get_key_names(help_text[idx].command, TRUE),
214 get_key_description(help_text[idx].command));
215 return buf;
216 }
218 static void
219 help_init(WINDOW *w, int cols, int rows)
220 {
221 lw = list_window_init(w, cols, rows);
222 lw->hide_cursor = true;
223 }
225 static void
226 help_resize(int cols, int rows)
227 {
228 lw->cols = cols;
229 lw->rows = rows;
230 }
232 static void
233 help_exit(void)
234 {
235 list_window_free(lw);
236 }
239 static const char *
240 help_title(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
241 {
242 return _("Help");
243 }
245 static void
246 help_paint(void)
247 {
248 list_window_paint(lw, list_callback, NULL);
249 }
251 static bool
252 help_cmd(G_GNUC_UNUSED mpdclient_t *c, command_t cmd)
253 {
254 if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
255 list_window_paint(lw, list_callback, NULL);
256 wrefresh(lw->w);
257 return true;
258 }
260 lw->selected = lw->start+lw->rows;
261 if (screen_find(lw, help_text_rows,
262 cmd, list_callback, NULL)) {
263 /* center the row */
264 list_window_center(lw, help_text_rows, lw->selected);
265 list_window_paint(lw, list_callback, NULL);
266 wrefresh(lw->w);
267 return true;
268 }
270 return false;
271 }
273 const struct screen_functions screen_help = {
274 .init = help_init,
275 .exit = help_exit,
276 .resize = help_resize,
277 .paint = help_paint,
278 .cmd = help_cmd,
279 .get_title = help_title,
280 };