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 },
56 { 0, CMD_SCREEN_PREVIOUS,NULL },
57 { 0, CMD_SCREEN_NEXT, NULL },
58 { 0, CMD_SCREEN_SWAP, NULL },
59 { 0, CMD_SCREEN_HELP, NULL },
60 { 0, CMD_SCREEN_PLAY, NULL },
61 { 0, CMD_SCREEN_FILE, NULL },
62 #ifdef ENABLE_ARTIST_SCREEN
63 { 0, CMD_SCREEN_ARTIST, NULL },
64 #endif
65 #ifdef ENABLE_SEARCH_SCREEN
66 { 0, CMD_SCREEN_SEARCH, NULL },
67 #endif
68 #ifdef ENABLE_LYRICS_SCREEN
69 { 0, CMD_SCREEN_LYRICS, NULL },
70 #endif
71 #ifdef ENABLE_OUTPUTS_SCREEN
72 { 0, CMD_SCREEN_OUTPUTS, NULL },
73 #endif
74 #ifdef ENABLE_KEYDEF_SCREEN
75 { 0, CMD_SCREEN_KEYDEF, NULL },
76 #endif
78 { 0, CMD_NONE, NULL },
79 { 0, CMD_NONE, NULL },
80 { 1, CMD_NONE, N_("Global") },
81 { 2, CMD_NONE, NULL },
82 { 0, CMD_STOP, NULL },
83 { 0, CMD_PAUSE, NULL },
84 { 0, CMD_CROP, NULL },
85 { 0, CMD_TRACK_NEXT, NULL },
86 { 0, CMD_TRACK_PREVIOUS, NULL },
87 { 0, CMD_SEEK_FORWARD, NULL },
88 { 0, CMD_SEEK_BACKWARD, NULL },
89 { 0, CMD_VOLUME_DOWN, NULL },
90 { 0, CMD_VOLUME_UP, NULL },
91 { 0, CMD_NONE, NULL },
92 { 0, CMD_REPEAT, NULL },
93 { 0, CMD_RANDOM, NULL },
94 { 0, CMD_SINGLE, NULL },
95 { 0, CMD_CONSUME, NULL },
96 { 0, CMD_CROSSFADE, NULL },
97 { 0, CMD_SHUFFLE, NULL },
98 { 0, CMD_DB_UPDATE, NULL },
99 { 0, CMD_NONE, NULL },
100 { 0, CMD_LIST_FIND, NULL },
101 { 0, CMD_LIST_RFIND, NULL },
102 { 0, CMD_LIST_FIND_NEXT, NULL },
103 { 0, CMD_LIST_RFIND_NEXT, NULL },
104 { 0, CMD_LIST_JUMP, NULL },
105 { 0, CMD_TOGGLE_FIND_WRAP, NULL },
106 { 0, CMD_LOCATE, NULL },
107 { 0, CMD_SCREEN_SONG, NULL },
108 { 0, CMD_NONE, NULL },
109 { 0, CMD_QUIT, NULL },
111 { 0, CMD_NONE, NULL },
112 { 0, CMD_NONE, NULL },
113 { 1, CMD_NONE, N_("Playlist screen") },
114 { 2, CMD_NONE, NULL },
115 { 0, CMD_PLAY, N_("Play") },
116 { 0, CMD_DELETE, NULL },
117 { 0, CMD_CLEAR, NULL },
118 { 0, CMD_LIST_MOVE_UP, N_("Move song up") },
119 { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
120 { 0, CMD_ADD, NULL },
121 { 0, CMD_SAVE_PLAYLIST, NULL },
122 { 0, CMD_SCREEN_UPDATE, N_("Center") },
123 { 0, CMD_SELECT_PLAYING, NULL },
124 { 0, CMD_TOGGLE_AUTOCENTER, NULL },
126 { 0, CMD_NONE, NULL },
127 { 0, CMD_NONE, NULL },
128 { 1, CMD_NONE, N_("Browse screen") },
129 { 2, CMD_NONE, NULL },
130 { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
131 { 0, CMD_SELECT, NULL },
132 { 0, CMD_ADD, N_("Append song to playlist") },
133 { 0, CMD_SAVE_PLAYLIST, NULL },
134 { 0, CMD_DELETE, N_("Delete playlist") },
135 { 0, CMD_GO_PARENT_DIRECTORY, NULL },
136 { 0, CMD_GO_ROOT_DIRECTORY, NULL },
137 { 0, CMD_SCREEN_UPDATE, NULL },
139 #ifdef ENABLE_SEARCH_SCREEN
140 { 0, CMD_NONE, NULL },
141 { 0, CMD_NONE, NULL },
142 { 1, CMD_NONE, N_("Search screen") },
143 { 2, CMD_NONE, NULL },
144 { 0, CMD_SCREEN_SEARCH, N_("Search") },
145 { 0, CMD_PLAY, N_("Select and play") },
146 { 0, CMD_SELECT, NULL },
147 { 0, CMD_ADD, N_("Append song to playlist") },
148 { 0, CMD_SELECT_ALL, NULL },
149 { 0, CMD_SEARCH_MODE, NULL },
150 #endif
151 #ifdef ENABLE_LYRICS_SCREEN
152 { 0, CMD_NONE, NULL },
153 { 0, CMD_NONE, NULL },
154 { 1, CMD_NONE, N_("Lyrics screen") },
155 { 2, CMD_NONE, NULL },
156 { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
157 { 0, CMD_SELECT, N_("(Re)load lyrics") },
158 /* to translators: this hotkey aborts the retrieval of lyrics
159 from the server */
160 { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
161 { 0, CMD_LYRICS_UPDATE, N_("Download lyrics for currently playing song") },
162 { 0, CMD_SAVE_PLAYLIST, N_("Save lyrics") },
163 #endif
164 #ifdef ENABLE_OUTPUTS_SCREEN
165 { 0, CMD_NONE, NULL },
166 { 0, CMD_NONE, NULL },
167 { 1, CMD_NONE, N_("Outputs screen") },
168 { 2, CMD_NONE, NULL },
169 { 0, CMD_PLAY, N_("Enable/disable output") },
170 #endif
171 #ifdef ENABLE_KEYDEF_SCREEN
172 { 0, CMD_NONE, NULL },
173 { 0, CMD_NONE, NULL },
174 { 1, CMD_NONE, N_("Keydef screen") },
175 { 2, CMD_NONE, NULL },
176 { 0, CMD_PLAY, N_("Edit keydefs for selected command") },
177 { 0, CMD_DELETE, N_("Remove selected keydef") },
178 { 0, CMD_GO_PARENT_DIRECTORY, N_("Go up a level") },
179 { 0, CMD_SAVE_PLAYLIST, N_("Apply and save changes") },
180 #endif
181 };
183 #define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
185 static list_window_t *lw;
187 static const char *
188 list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED char** second_column, G_GNUC_UNUSED void *data)
189 {
190 static char buf[512];
192 if (idx >= help_text_rows)
193 return NULL;
195 if (help_text[idx].highlight)
196 *highlight = true;
198 if (help_text[idx].command == CMD_NONE) {
199 if (help_text[idx].text)
200 g_snprintf(buf, sizeof(buf), " %s", _(help_text[idx].text));
201 else if (help_text[idx].highlight == 2) {
202 int i;
204 for (i = 3; i < COLS - 3 && i < (int)sizeof(buf); i++)
205 buf[i] = '-';
206 buf[i] = '\0';
207 } else
208 g_strlcpy(buf, " ", sizeof(buf));
209 return buf;
210 }
212 if (help_text[idx].text)
213 g_snprintf(buf, sizeof(buf),
214 "%20s : %s ",
215 get_key_names(help_text[idx].command, TRUE),
216 _(help_text[idx].text));
217 else
218 g_snprintf(buf, sizeof(buf),
219 "%20s : %s ",
220 get_key_names(help_text[idx].command, TRUE),
221 get_key_description(help_text[idx].command));
222 return buf;
223 }
225 static void
226 help_init(WINDOW *w, int cols, int rows)
227 {
228 lw = list_window_init(w, cols, rows);
229 lw->hide_cursor = true;
230 }
232 static void
233 help_resize(int cols, int rows)
234 {
235 lw->cols = cols;
236 lw->rows = rows;
237 }
239 static void
240 help_exit(void)
241 {
242 list_window_free(lw);
243 }
246 static const char *
247 help_title(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
248 {
249 return _("Help");
250 }
252 static void
253 help_paint(void)
254 {
255 list_window_paint(lw, list_callback, NULL);
256 }
258 static bool
259 help_cmd(G_GNUC_UNUSED struct mpdclient *c, command_t cmd)
260 {
261 if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
262 list_window_paint(lw, list_callback, NULL);
263 wrefresh(lw->w);
264 return true;
265 }
267 lw->selected = lw->start;
268 if (screen_find(lw, help_text_rows,
269 cmd, list_callback, NULL)) {
270 /* center the row */
271 list_window_center(lw, help_text_rows, lw->selected);
272 list_window_paint(lw, list_callback, NULL);
273 wrefresh(lw->w);
274 return true;
275 }
277 return false;
278 }
280 const struct screen_functions screen_help = {
281 .init = help_init,
282 .exit = help_exit,
283 .resize = help_resize,
284 .paint = help_paint,
285 .cmd = help_cmd,
286 .get_title = help_title,
287 };