53b349989c6a15870203b58d35abb92c68d9a5bd
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_VISUAL_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_KEYDEF_SCREEN
67 { 0, CMD_SCREEN_KEYDEF, NULL },
68 #endif
70 { 0, CMD_NONE, NULL },
71 { 0, CMD_NONE, NULL },
72 { 1, CMD_NONE, N_("Global") },
73 { 2, CMD_NONE, NULL },
74 { 0, CMD_STOP, NULL },
75 { 0, CMD_PAUSE, NULL },
76 { 0, CMD_CROP, NULL },
77 { 0, CMD_TRACK_NEXT, NULL },
78 { 0, CMD_TRACK_PREVIOUS, NULL },
79 { 0, CMD_SEEK_FORWARD, NULL },
80 { 0, CMD_SEEK_BACKWARD, NULL },
81 { 0, CMD_VOLUME_DOWN, NULL },
82 { 0, CMD_VOLUME_UP, NULL },
83 { 0, CMD_NONE, NULL },
84 { 0, CMD_REPEAT, NULL },
85 { 0, CMD_RANDOM, NULL },
86 { 0, CMD_CROSSFADE, NULL },
87 { 0, CMD_SHUFFLE, NULL },
88 { 0, CMD_DB_UPDATE, NULL },
89 { 0, CMD_NONE, NULL },
90 { 0, CMD_LIST_FIND, NULL },
91 { 0, CMD_LIST_RFIND, NULL },
92 { 0, CMD_LIST_FIND_NEXT, NULL },
93 { 0, CMD_LIST_RFIND_NEXT, NULL },
94 { 0, CMD_LIST_JUMP, NULL },
95 { 0, CMD_TOGGLE_FIND_WRAP, NULL },
96 { 0, CMD_LOCATE, NULL },
97 { 0, CMD_VIEW, NULL },
98 { 0, CMD_NONE, NULL },
99 { 0, CMD_QUIT, NULL },
101 { 0, CMD_NONE, NULL },
102 { 0, CMD_NONE, NULL },
103 { 1, CMD_NONE, N_("Playlist screen") },
104 { 2, CMD_NONE, NULL },
105 { 0, CMD_PLAY, N_("Play") },
106 { 0, CMD_DELETE, NULL },
107 { 0, CMD_CLEAR, NULL },
108 { 0, CMD_LIST_MOVE_UP, N_("Move song up") },
109 { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
110 { 0, CMD_ADD, NULL },
111 { 0, CMD_SAVE_PLAYLIST, NULL },
112 { 0, CMD_SCREEN_UPDATE, N_("Center") },
113 { 0, CMD_TOGGLE_AUTOCENTER, NULL },
115 { 0, CMD_NONE, NULL },
116 { 0, CMD_NONE, NULL },
117 { 1, CMD_NONE, N_("Browse screen") },
118 { 2, CMD_NONE, NULL },
119 { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
120 { 0, CMD_SELECT, NULL },
121 { 0, CMD_ADD, N_("Append song to playlist") },
122 { 0, CMD_SAVE_PLAYLIST, NULL },
123 { 0, CMD_DELETE, N_("Delete playlist") },
124 { 0, CMD_GO_PARENT_DIRECTORY, NULL },
125 { 0, CMD_GO_ROOT_DIRECTORY, NULL },
126 { 0, CMD_SCREEN_UPDATE, NULL },
128 #ifdef ENABLE_SEARCH_SCREEN
129 { 0, CMD_NONE, NULL },
130 { 0, CMD_NONE, NULL },
131 { 1, CMD_NONE, N_("Search screen") },
132 { 2, CMD_NONE, NULL },
133 { 0, CMD_SCREEN_SEARCH, N_("Search") },
134 { 0, CMD_PLAY, N_("Select and play") },
135 { 0, CMD_SELECT, NULL },
136 { 0, CMD_ADD, N_("Append song to playlist") },
137 { 0, CMD_SELECT_ALL, NULL },
138 { 0, CMD_SEARCH_MODE, NULL },
139 #endif
140 #ifdef ENABLE_LYRICS_SCREEN
141 { 0, CMD_NONE, NULL },
142 { 0, CMD_NONE, NULL },
143 { 1, CMD_NONE, N_("Lyrics screen") },
144 { 2, CMD_NONE, NULL },
145 { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
146 { 0, CMD_SELECT, N_("(Re)load lyrics") },
147 { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
148 { 0, CMD_LYRICS_UPDATE, N_("Explicitly download lyrics") },
149 { 0, CMD_ADD, N_("Save lyrics") },
150 #endif
151 #ifdef ENABLE_OUTPUTS_SCREEN
152 { 0, CMD_NONE, NULL },
153 { 0, CMD_NONE, NULL },
154 { 1, CMD_NONE, N_("Outputs screen") },
155 { 2, CMD_NONE, NULL },
156 { 0, CMD_PLAY, N_("Enable/disable output") },
157 #endif
158 };
160 #define help_text_rows (sizeof(help_text) / sizeof(help_text[0]))
162 static list_window_t *lw;
164 static const char *
165 list_callback(unsigned idx, bool *highlight, G_GNUC_UNUSED void *data)
166 {
167 static char buf[512];
169 if (idx >= help_text_rows)
170 return NULL;
172 if (help_text[idx].highlight)
173 *highlight = true;
175 if (help_text[idx].command == CMD_NONE) {
176 if (help_text[idx].text)
177 g_snprintf(buf, sizeof(buf), " %s", _(help_text[idx].text));
178 else if (help_text[idx].highlight == 2) {
179 int i;
181 for (i = 3; i < COLS - 3 && i < (int)sizeof(buf); i++)
182 buf[i] = '-';
183 buf[i] = '\0';
184 } else
185 g_strlcpy(buf, " ", sizeof(buf));
186 return buf;
187 }
189 if (help_text[idx].text)
190 g_snprintf(buf, sizeof(buf),
191 "%20s : %s ",
192 get_key_names(help_text[idx].command, TRUE),
193 _(help_text[idx].text));
194 else
195 g_snprintf(buf, sizeof(buf),
196 "%20s : %s ",
197 get_key_names(help_text[idx].command, TRUE),
198 get_key_description(help_text[idx].command));
199 return buf;
200 }
202 static void
203 help_init(WINDOW *w, int cols, int rows)
204 {
205 lw = list_window_init(w, cols, rows);
206 lw->hide_cursor = true;
207 }
209 static void
210 help_resize(int cols, int rows)
211 {
212 lw->cols = cols;
213 lw->rows = rows;
214 }
216 static void
217 help_exit(void)
218 {
219 list_window_free(lw);
220 }
223 static const char *
224 help_title(G_GNUC_UNUSED char *str, G_GNUC_UNUSED size_t size)
225 {
226 return _("Help");
227 }
229 static void
230 help_paint(void)
231 {
232 list_window_paint(lw, list_callback, NULL);
233 }
235 static bool
236 help_cmd(G_GNUC_UNUSED mpdclient_t *c, command_t cmd)
237 {
238 if (list_window_scroll_cmd(lw, help_text_rows, cmd)) {
239 list_window_paint(lw, list_callback, NULL);
240 wrefresh(lw->w);
241 return true;
242 }
244 lw->selected = lw->start+lw->rows;
245 if (screen_find(lw, help_text_rows,
246 cmd, list_callback, NULL)) {
247 /* center the row */
248 list_window_center(lw, help_text_rows, lw->selected);
249 list_window_paint(lw, list_callback, NULL);
250 wrefresh(lw->w);
251 return true;
252 }
254 return false;
255 }
257 const struct screen_functions screen_help = {
258 .init = help_init,
259 .exit = help_exit,
260 .resize = help_resize,
261 .paint = help_paint,
262 .cmd = help_cmd,
263 .get_title = help_title,
264 };