i18n: add gettext() fake macro
[ncmpc-debian.git] / src / HelpPage.cxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2018 The Music Player Daemon Project
3  * Project homepage: http://musicpd.org
4  *
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.
9  *
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.
14  *
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  */
19
20 #include "HelpPage.hxx"
21 #include "PageMeta.hxx"
22 #include "ListPage.hxx"
23 #include "ListRenderer.hxx"
24 #include "ListText.hxx"
25 #include "screen_find.hxx"
26 #include "paint.hxx"
27 #include "Bindings.hxx"
28 #include "GlobalBindings.hxx"
29 #include "config.h"
30 #include "i18n.h"
31 #include "util/Macros.hxx"
32 #include "util/StringUTF8.hxx"
33
34 #include <assert.h>
35
36 struct help_text_row {
37         signed char highlight;
38         Command command;
39         const char *text;
40 };
41
42 static const struct help_text_row help_text[] = {
43         { 1, Command::NONE, N_("Movement") },
44         { 2, Command::NONE, nullptr },
45         { 0, Command::LIST_PREVIOUS, nullptr },
46         { 0, Command::LIST_NEXT, nullptr },
47         { 0, Command::LIST_TOP, nullptr },
48         { 0, Command::LIST_MIDDLE, nullptr },
49         { 0, Command::LIST_BOTTOM, nullptr },
50         { 0, Command::LIST_PREVIOUS_PAGE, nullptr },
51         { 0, Command::LIST_NEXT_PAGE, nullptr },
52         { 0, Command::LIST_FIRST, nullptr },
53         { 0, Command::LIST_LAST, nullptr },
54         { 0, Command::LIST_RANGE_SELECT, nullptr },
55         { 0, Command::LIST_SCROLL_UP_LINE, nullptr},
56         { 0, Command::LIST_SCROLL_DOWN_LINE, nullptr},
57         { 0, Command::LIST_SCROLL_UP_HALF, nullptr},
58         { 0, Command::LIST_SCROLL_DOWN_HALF, nullptr},
59         { 0, Command::NONE, nullptr },
60
61         { 0, Command::SCREEN_PREVIOUS,nullptr },
62         { 0, Command::SCREEN_NEXT, nullptr },
63         { 0, Command::SCREEN_SWAP, nullptr },
64         { 0, Command::SCREEN_HELP, nullptr },
65         { 0, Command::SCREEN_PLAY, nullptr },
66         { 0, Command::SCREEN_FILE, nullptr },
67 #ifdef ENABLE_ARTIST_SCREEN
68         { 0, Command::SCREEN_ARTIST, nullptr },
69 #endif
70 #ifdef ENABLE_SEARCH_SCREEN
71         { 0, Command::SCREEN_SEARCH, nullptr },
72 #endif
73 #ifdef ENABLE_LYRICS_SCREEN
74         { 0, Command::SCREEN_LYRICS, nullptr },
75 #endif
76 #ifdef ENABLE_OUTPUTS_SCREEN
77         { 0, Command::SCREEN_OUTPUTS, nullptr },
78 #endif
79 #ifdef ENABLE_CHAT_SCREEN
80         { 0, Command::SCREEN_CHAT, nullptr },
81 #endif
82 #ifdef ENABLE_KEYDEF_SCREEN
83         { 0, Command::SCREEN_KEYDEF, nullptr },
84 #endif
85
86         { 0, Command::NONE, nullptr },
87         { 0, Command::NONE, nullptr },
88         { 1, Command::NONE, N_("Global") },
89         { 2, Command::NONE, nullptr },
90         { 0, Command::STOP, nullptr },
91         { 0, Command::PAUSE, nullptr },
92         { 0, Command::CROP, nullptr },
93         { 0, Command::TRACK_NEXT, nullptr },
94         { 0, Command::TRACK_PREVIOUS, nullptr },
95         { 0, Command::SEEK_FORWARD, nullptr },
96         { 0, Command::SEEK_BACKWARD, nullptr },
97         { 0, Command::VOLUME_DOWN, nullptr },
98         { 0, Command::VOLUME_UP, nullptr },
99         { 0, Command::NONE, nullptr },
100         { 0, Command::REPEAT, nullptr },
101         { 0, Command::RANDOM, nullptr },
102         { 0, Command::SINGLE, nullptr },
103         { 0, Command::CONSUME, nullptr },
104         { 0, Command::CROSSFADE, nullptr },
105         { 0, Command::SHUFFLE, nullptr },
106         { 0, Command::DB_UPDATE, nullptr },
107         { 0, Command::NONE, nullptr },
108         { 0, Command::LIST_FIND, nullptr },
109         { 0, Command::LIST_RFIND, nullptr },
110         { 0, Command::LIST_FIND_NEXT, nullptr },
111         { 0, Command::LIST_RFIND_NEXT, nullptr },
112         { 0, Command::LIST_JUMP, nullptr },
113         { 0, Command::TOGGLE_FIND_WRAP, nullptr },
114         { 0, Command::LOCATE, nullptr },
115 #ifdef ENABLE_SONG_SCREEN
116         { 0, Command::SCREEN_SONG, nullptr },
117 #endif
118         { 0, Command::NONE, nullptr },
119         { 0, Command::QUIT, nullptr },
120
121         { 0, Command::NONE, nullptr },
122         { 0, Command::NONE, nullptr },
123         { 1, Command::NONE, N_("Queue screen") },
124         { 2, Command::NONE, nullptr },
125         { 0, Command::PLAY, N_("Play") },
126         { 0, Command::DELETE, nullptr },
127         { 0, Command::CLEAR, nullptr },
128         { 0, Command::LIST_MOVE_UP, N_("Move song up") },
129         { 0, Command::LIST_MOVE_DOWN, N_("Move song down") },
130         { 0, Command::ADD, nullptr },
131         { 0, Command::SAVE_PLAYLIST, nullptr },
132         { 0, Command::SCREEN_UPDATE, N_("Center") },
133         { 0, Command::SELECT_PLAYING, nullptr },
134         { 0, Command::TOGGLE_AUTOCENTER, nullptr },
135
136         { 0, Command::NONE, nullptr },
137         { 0, Command::NONE, nullptr },
138         { 1, Command::NONE, N_("Browse screen") },
139         { 2, Command::NONE, nullptr },
140         { 0, Command::PLAY, N_("Enter directory/Select and play song") },
141         { 0, Command::SELECT, nullptr },
142         { 0, Command::ADD, N_("Append song to queue") },
143         { 0, Command::SAVE_PLAYLIST, nullptr },
144         { 0, Command::DELETE, N_("Delete playlist") },
145         { 0, Command::GO_PARENT_DIRECTORY, nullptr },
146         { 0, Command::GO_ROOT_DIRECTORY, nullptr },
147         { 0, Command::SCREEN_UPDATE, nullptr },
148
149 #ifdef ENABLE_SEARCH_SCREEN
150         { 0, Command::NONE, nullptr },
151         { 0, Command::NONE, nullptr },
152         { 1, Command::NONE, N_("Search screen") },
153         { 2, Command::NONE, nullptr },
154         { 0, Command::SCREEN_SEARCH, N_("Search") },
155         { 0, Command::PLAY, N_("Select and play") },
156         { 0, Command::SELECT, nullptr },
157         { 0, Command::ADD, N_("Append song to queue") },
158         { 0, Command::SELECT_ALL,        nullptr },
159         { 0, Command::SEARCH_MODE, nullptr },
160 #endif
161 #ifdef ENABLE_LYRICS_SCREEN
162         { 0, Command::NONE, nullptr },
163         { 0, Command::NONE, nullptr },
164         { 1, Command::NONE, N_("Lyrics screen") },
165         { 2, Command::NONE, nullptr },
166         { 0, Command::SCREEN_LYRICS, N_("View Lyrics") },
167         { 0, Command::SELECT, N_("(Re)load lyrics") },
168         /* to translators: this hotkey aborts the retrieval of lyrics
169            from the server */
170         { 0, Command::INTERRUPT, N_("Interrupt retrieval") },
171         { 0, Command::LYRICS_UPDATE, N_("Download lyrics for currently playing song") },
172         { 0, Command::EDIT, N_("Add or edit lyrics") },
173         { 0, Command::SAVE_PLAYLIST, N_("Save lyrics") },
174         { 0, Command::DELETE, N_("Delete saved lyrics") },
175 #endif
176 #ifdef ENABLE_OUTPUTS_SCREEN
177         { 0, Command::NONE, nullptr },
178         { 0, Command::NONE, nullptr },
179         { 1, Command::NONE, N_("Outputs screen") },
180         { 2, Command::NONE, nullptr },
181         { 0, Command::PLAY, N_("Enable/disable output") },
182 #endif
183 #ifdef ENABLE_CHAT_SCREEN
184         { 0, Command::NONE, nullptr },
185         { 0, Command::NONE, nullptr },
186         { 1, Command::NONE, N_("Chat screen") },
187         { 2, Command::NONE, nullptr },
188         { 0, Command::PLAY, N_("Write a message") },
189 #endif
190 #ifdef ENABLE_KEYDEF_SCREEN
191         { 0, Command::NONE, nullptr },
192         { 0, Command::NONE, nullptr },
193         { 1, Command::NONE, N_("Keydef screen") },
194         { 2, Command::NONE, nullptr },
195         { 0, Command::PLAY, N_("Edit keydefs for selected command") },
196         { 0, Command::DELETE, N_("Remove selected keydef") },
197         { 0, Command::ADD, N_("Add a keydef") },
198         { 0, Command::GO_PARENT_DIRECTORY, N_("Go up a level") },
199         { 0, Command::SAVE_PLAYLIST, N_("Apply and save changes") },
200 #endif
201 };
202
203 class HelpPage final : public ListPage, ListRenderer, ListText {
204         ScreenManager &screen;
205
206 public:
207         HelpPage(ScreenManager &_screen, WINDOW *w, Size size)
208                 :ListPage(w, size), screen(_screen) {
209                 lw.hide_cursor = true;
210                 lw.SetLength(ARRAY_SIZE(help_text));
211         }
212
213 public:
214         /* virtual methods from class ListRenderer */
215         void PaintListItem(WINDOW *w, unsigned i,
216                            unsigned y, unsigned width,
217                            bool selected) const override;
218
219         /* virtual methods from class ListText */
220         const char *GetListItemText(char *buffer, size_t size,
221                                     unsigned i) const override;
222
223         /* virtual methods from class Page */
224         void Paint() const override;
225         bool OnCommand(struct mpdclient &c, Command cmd) override;
226
227         const char *GetTitle(char *, size_t) const override {
228                 return _("Help");
229         }
230 };
231
232 const char *
233 HelpPage::GetListItemText(char *, size_t, unsigned i) const
234 {
235         const struct help_text_row *row = &help_text[i];
236
237         assert(i < ARRAY_SIZE(help_text));
238
239         if (row->text != nullptr)
240                 return gettext(row->text);
241
242         if (row->command != Command::NONE)
243                 return get_key_description(row->command);
244
245         return "";
246 }
247
248 static Page *
249 help_init(ScreenManager &screen, WINDOW *w, Size size)
250 {
251         return new HelpPage(screen, w, size);
252 }
253
254 void
255 HelpPage::PaintListItem(WINDOW *w, unsigned i,
256                         unsigned y, unsigned width,
257                         gcc_unused bool selected) const
258 {
259         const struct help_text_row *row = &help_text[i];
260
261         assert(i < ARRAY_SIZE(help_text));
262
263         row_color(w, row->highlight ? COLOR_LIST_BOLD : COLOR_LIST, false);
264
265         wclrtoeol(w);
266
267         if (row->command == Command::NONE) {
268                 if (row->text != nullptr)
269                         mvwaddstr(w, y, 6, gettext(row->text));
270                 else if (row->highlight == 2)
271                         mvwhline(w, y, 3, '-', width - 6);
272         } else {
273                 const char *key =
274                         GetGlobalKeyBindings().GetKeyNames(row->command, true);
275
276                 if (utf8_width(key) < 20)
277                         wmove(w, y, 20 - utf8_width(key));
278                 waddstr(w, key);
279                 mvwaddch(w, y, 21, ':');
280                 mvwaddstr(w, y, 23,
281                           row->text != nullptr
282                           ? gettext(row->text)
283                           : get_key_description(row->command));
284         }
285 }
286
287 void
288 HelpPage::Paint() const
289 {
290         lw.Paint(*this);
291 }
292
293 bool
294 HelpPage::OnCommand(struct mpdclient &c, Command cmd)
295 {
296         if (ListPage::OnCommand(c, cmd))
297                 return true;
298
299         lw.SetCursor(lw.start);
300         if (screen_find(screen, &lw, cmd, *this)) {
301                 /* center the row */
302                 lw.Center(lw.selected);
303                 SetDirty();
304                 return true;
305         }
306
307         return false;
308 }
309
310 const PageMeta screen_help = {
311         "help",
312         Command::SCREEN_HELP,
313         help_init,
314 };