31a125a7f709811d1cda2113a8c82667cda21820
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 <stdlib.h>
22 #include <string.h>
23 #include <glib.h>
24 #include <ncurses.h>
26 #include "config.h"
27 #include "ncmpc.h"
28 #include "mpdclient.h"
29 #include "command.h"
30 #include "screen.h"
31 #include "screen_utils.h"
34 typedef struct
35 {
36 signed char highlight;
37 command_t command;
38 char *text;
39 } help_text_row_t;
41 static help_text_row_t help_text[] =
42 {
43 { 1, CMD_NONE, N_("Keys - Movement") },
44 { 2, CMD_NONE, NULL },
45 { 0, CMD_LIST_PREVIOUS, NULL },
46 { 0, CMD_LIST_NEXT, NULL },
47 { 0, CMD_LIST_PREVIOUS_PAGE, NULL },
48 { 0, CMD_LIST_NEXT_PAGE, NULL },
49 { 0, CMD_LIST_FIRST, NULL },
50 { 0, CMD_LIST_LAST, NULL },
51 { 0, CMD_NONE, NULL },
52 { 0, CMD_SCREEN_PREVIOUS,NULL },
53 { 0, CMD_SCREEN_NEXT, NULL },
54 { 0, CMD_SCREEN_HELP, NULL },
55 { 0, CMD_SCREEN_PLAY, NULL },
56 { 0, CMD_SCREEN_FILE, NULL },
57 #ifdef ENABLE_SEARCH_SCREEN
58 { 0, CMD_SCREEN_SEARCH, NULL },
59 #endif
60 #ifdef ENABLE_CLOCK_SCREEN
61 { 0, CMD_SCREEN_CLOCK, NULL },
62 #endif
63 #ifdef ENABLE_KEYDEF_SCREEN
64 { 0, CMD_SCREEN_KEYDEF, NULL },
65 #endif
67 { 0, CMD_NONE, NULL },
68 { 0, CMD_NONE, NULL },
69 { 1, CMD_NONE, N_("Keys - Global") },
70 { 2, CMD_NONE, NULL },
71 { 0, CMD_STOP, NULL },
72 { 0, CMD_PAUSE, NULL },
73 { 0, CMD_TRACK_NEXT, NULL },
74 { 0, CMD_TRACK_PREVIOUS, NULL },
75 { 0, CMD_SEEK_FORWARD, NULL },
76 { 0, CMD_SEEK_BACKWARD, NULL },
77 { 0, CMD_VOLUME_DOWN, NULL },
78 { 0, CMD_VOLUME_UP, NULL },
79 { 0, CMD_NONE, NULL },
80 { 0, CMD_REPEAT, NULL },
81 { 0, CMD_RANDOM, NULL },
82 { 0, CMD_CROSSFADE, NULL },
83 { 0, CMD_SHUFFLE, NULL },
84 { 0, CMD_DB_UPDATE, NULL },
85 { 0, CMD_NONE, NULL },
86 { 0, CMD_LIST_FIND, NULL },
87 { 0, CMD_LIST_RFIND, NULL },
88 { 0, CMD_LIST_FIND_NEXT, NULL },
89 { 0, CMD_LIST_RFIND_NEXT, NULL },
90 { 0, CMD_TOGGLE_FIND_WRAP, NULL },
91 { 0, CMD_NONE, NULL },
92 { 0, CMD_QUIT, NULL },
94 { 0, CMD_NONE, NULL },
95 { 0, CMD_NONE, NULL },
96 { 1, CMD_NONE, N_("Keys - Playlist screen") },
97 { 2, CMD_NONE, NULL },
98 { 0, CMD_PLAY, N_("Play") },
99 { 0, CMD_DELETE, NULL },
100 { 0, CMD_CLEAR, NULL },
101 { 0, CMD_LIST_MOVE_UP, N_("Move song up") },
102 { 0, CMD_LIST_MOVE_DOWN, N_("Move song down") },
103 { 0, CMD_ADD, NULL },
104 { 0, CMD_SAVE_PLAYLIST, NULL },
105 { 0, CMD_SCREEN_UPDATE, N_("Center") },
106 { 0, CMD_TOGGLE_AUTOCENTER, NULL },
108 { 0, CMD_NONE, NULL },
109 { 0, CMD_NONE, NULL },
110 { 1, CMD_NONE, N_("Keys - Browse screen") },
111 { 2, CMD_NONE, NULL },
112 { 0, CMD_PLAY, N_("Enter directory/Select and play song") },
113 { 0, CMD_SELECT, NULL },
114 { 0, CMD_SAVE_PLAYLIST, NULL },
115 { 0, CMD_DELETE, N_("Delete playlist") },
116 { 0, CMD_SCREEN_UPDATE, NULL },
118 #ifdef ENABLE_SEARCH_SCREEN
119 { 0, CMD_NONE, NULL },
120 { 0, CMD_NONE, NULL },
121 { 1, CMD_NONE, N_("Keys - Search screen") },
122 { 2, CMD_NONE, NULL },
123 { 0, CMD_SCREEN_SEARCH, N_("Search") },
124 { 0, CMD_PLAY, N_("Select and play") },
125 { 0, CMD_SELECT, NULL },
126 { 0, CMD_SEARCH_MODE, NULL },
127 #endif
128 #ifdef ENABLE_LYRICS_SCREEN
129 { 0, CMD_NONE, NULL },
130 { 0, CMD_NONE, NULL },
131 { 1, CMD_NONE, N_("Keys - Lyrics screen") },
132 { 2, CMD_NONE, NULL },
133 { 0, CMD_SCREEN_LYRICS, N_("View Lyrics") },
134 { 0, CMD_SELECT, N_("(Re)load lyrics") },
135 { 0, CMD_INTERRUPT, N_("Interrupt retrieval") },
136 { 0, CMD_LYRICS_UPDATE, N_("Explicitly download lyrics") },
137 { 0, CMD_ADD, N_("Save lyrics") },
138 #endif
139 { 0, CMD_NONE, NULL },
140 {-1, CMD_NONE, NULL }
141 };
143 static int help_text_rows = -1;
144 static list_window_t *lw = NULL;
147 static char *
148 list_callback(int index, int *highlight, void *data)
149 {
150 static char buf[512];
152 if( help_text_rows<0 )
153 {
154 help_text_rows = 0;
155 while( help_text[help_text_rows].highlight != -1 )
156 help_text_rows++;
157 }
159 *highlight = 0;
160 if( index<help_text_rows )
161 {
162 *highlight = help_text[index].highlight > 0;
163 if( help_text[index].command == CMD_NONE )
164 {
165 if( help_text[index].text )
166 g_snprintf(buf, sizeof(buf), " %s", _(help_text[index].text));
167 else
168 if( help_text[index].highlight == 2 )
169 {
170 int i;
172 for(i=3; i<COLS-3 && i<sizeof(buf); i++)
173 buf[i]='-';
174 buf[i] = '\0';
175 }
176 else
177 g_strlcpy(buf, " ", sizeof(buf));
178 return buf;
179 }
180 if( help_text[index].text )
181 g_snprintf(buf, sizeof(buf),
182 "%20s : %s ",
183 get_key_names(help_text[index].command, TRUE),
184 _(help_text[index].text));
185 else
186 g_snprintf(buf, sizeof(buf),
187 "%20s : %s ",
188 get_key_names(help_text[index].command, TRUE),
189 get_key_description(help_text[index].command));
190 return buf;
191 }
193 return NULL;
194 }
196 static void
197 help_init(WINDOW *w, int cols, int rows)
198 {
199 lw = list_window_init(w, cols, rows);
200 lw->flags = LW_HIDE_CURSOR;
201 }
203 static void
204 help_resize(int cols, int rows)
205 {
206 lw->cols = cols;
207 lw->rows = rows;
208 }
210 static void
211 help_exit(void)
212 {
213 list_window_free(lw);
214 }
217 static char *
218 help_title(char *str, size_t size)
219 {
220 return _("Help");
221 }
223 static void
224 help_paint(screen_t *screen, mpdclient_t *c)
225 {
226 lw->clear = 1;
227 list_window_paint(lw, list_callback, NULL);
228 wrefresh(lw->w);
229 }
231 static void
232 help_update(screen_t *screen, mpdclient_t *c)
233 {
234 if( lw->repaint )
235 {
236 list_window_paint(lw, list_callback, NULL);
237 wrefresh(lw->w);
238 lw->repaint = 0;
239 }
240 }
243 static int
244 help_cmd(screen_t *screen, mpdclient_t *c, command_t cmd)
245 {
246 lw->repaint=1;
247 switch(cmd)
248 {
249 case CMD_LIST_NEXT:
250 if( lw->start+lw->rows < help_text_rows )
251 lw->start++;
252 return 1;
253 case CMD_LIST_PREVIOUS:
254 if( lw->start >0 )
255 lw->start--;
256 return 1;
257 case CMD_LIST_FIRST:
258 lw->start = 0;
259 return 1;
260 case CMD_LIST_LAST:
261 lw->start = help_text_rows-lw->rows;
262 if( lw->start<0 )
263 lw->start = 0;
264 return 1;
265 case CMD_LIST_NEXT_PAGE:
266 lw->start = lw->start + lw->rows;
267 if( lw->start+lw->rows >= help_text_rows )
268 lw->start = help_text_rows-lw->rows;
269 if( lw->start<0 )
270 lw->start = 0;
271 return 1;
272 case CMD_LIST_PREVIOUS_PAGE:
273 lw->start = lw->start - lw->rows;
274 if( lw->start<0 )
275 lw->start = 0;
276 return 1;
277 default:
278 break;
279 }
281 lw->selected = lw->start+lw->rows;
282 if( screen_find(screen, c,
283 lw, help_text_rows,
284 cmd, list_callback, NULL) )
285 {
286 /* center the row */
287 lw->start = lw->selected-(lw->rows/2);
288 if( lw->start+lw->rows > help_text_rows )
289 lw->start = help_text_rows-lw->rows;
290 if( lw->start<0 )
291 lw->start=0;
292 return 1;
293 }
295 return 0;
296 }
298 static list_window_t *
299 help_lw(void)
300 {
301 return lw;
302 }
304 screen_functions_t *
305 get_screen_help(void)
306 {
307 static screen_functions_t functions;
309 memset(&functions, 0, sizeof(screen_functions_t));
310 functions.init = help_init;
311 functions.exit = help_exit;
312 functions.open = NULL;
313 functions.close = NULL;
314 functions.resize = help_resize;
315 functions.paint = help_paint;
316 functions.update = help_update;
317 functions.cmd = help_cmd;
318 functions.get_lw = help_lw;
319 functions.get_title = help_title;
321 return &functions;
322 }