853adfd7d8a8c811ee7f9b56d271dd4b296b9b63
[ncmpc-debian.git] / src / wreadln.cxx
1 /* ncmpc (Ncurses MPD Client)
2  * (c) 2004-2019 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 "wreadln.hxx"
21 #include "Completion.hxx"
22 #include "charset.hxx"
23 #include "screen_utils.hxx"
24 #include "Point.hxx"
25 #include "config.h"
26 #include "util/LocaleString.hxx"
27
28 #include <string>
29
30 #include <assert.h>
31 #include <stdlib.h>
32 #include <string.h>
33
34 #ifndef _WIN32
35 #include "WaitUserInput.hxx"
36 #endif
37
38 #define KEY_CTRL_A   1
39 #define KEY_CTRL_B   2
40 #define KEY_CTRL_C   3
41 #define KEY_CTRL_D   4
42 #define KEY_CTRL_E   5
43 #define KEY_CTRL_F   6
44 #define KEY_CTRL_G   7
45 #define KEY_CTRL_K   11
46 #define KEY_CTRL_N   14
47 #define KEY_CTRL_P   16
48 #define KEY_CTRL_U   21
49 #define KEY_CTRL_W   23
50 #define KEY_CTRL_Z   26
51 #define KEY_BCKSPC   8
52 #define TAB          9
53
54 struct wreadln {
55         /** the ncurses window where this field is displayed */
56         WINDOW *const w;
57
58         /** the origin coordinates in the window */
59         Point point;
60
61         /** the screen width of the input field */
62         unsigned width;
63
64         /** is the input masked, i.e. characters displayed as '*'? */
65         const bool masked;
66
67         /** the byte position of the cursor */
68         size_t cursor = 0;
69
70         /** the byte position displayed at the origin (for horizontal
71             scrolling) */
72         size_t start = 0;
73
74         /** the current value */
75         std::string value;
76
77         wreadln(WINDOW *_w, bool _masked) noexcept
78                 :w(_w), masked(_masked) {}
79
80         /** draw line buffer and update cursor position */
81         void Paint() const noexcept;
82
83         /** returns the screen column where the cursor is located */
84         gcc_pure
85         unsigned GetCursorColumn() const noexcept;
86
87         /** move the cursor one step to the right */
88         void MoveCursorRight() noexcept;
89
90         /** move the cursor one step to the left */
91         void MoveCursorLeft() noexcept;
92
93         /** move the cursor to the end of the line */
94         void MoveCursorToEnd() noexcept;
95
96         void InsertByte(int key) noexcept;
97         void DeleteChar(size_t x) noexcept;
98         void DeleteChar() noexcept {
99                 DeleteChar(cursor);
100         }
101 };
102
103 /** max items stored in the history list */
104 static constexpr std::size_t wrln_max_history_length = 32;
105
106 /** converts a byte position to a screen column */
107 gcc_pure
108 static unsigned
109 byte_to_screen(const char *data, size_t x) noexcept
110 {
111 #if defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)
112         assert(x <= strlen(data));
113
114         return StringWidthMB(data, x);
115 #else
116         (void)data;
117
118         return (unsigned)x;
119 #endif
120 }
121
122 /** finds the first character which doesn't fit on the screen */
123 gcc_pure
124 static size_t
125 screen_to_bytes(const char *data, unsigned width) noexcept
126 {
127 #if defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)
128         size_t length = strlen(data);
129
130         while (true) {
131                 unsigned p_width = StringWidthMB(data, length);
132                 if (p_width <= width)
133                         return length;
134
135                 --length;
136         }
137 #else
138         (void)data;
139
140         return (size_t)width;
141 #endif
142 }
143
144 unsigned
145 wreadln::GetCursorColumn() const noexcept
146 {
147         return byte_to_screen(value.data() + start, cursor - start);
148 }
149
150 /** returns the offset in the string to align it at the right border
151     of the screen */
152 gcc_pure
153 static inline size_t
154 right_align_bytes(const char *data, size_t right, unsigned width) noexcept
155 {
156 #if defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)
157         size_t start = 0;
158
159         assert(right <= strlen(data));
160
161         while (start < right) {
162                 if (StringWidthMB(data + start, right - start) < width)
163                         break;
164
165                 start += CharSizeMB(data + start, right - start);
166         }
167
168         return start;
169 #else
170         (void)data;
171
172         return right >= width ? right + 1 - width : 0;
173 #endif
174 }
175
176 void
177 wreadln::MoveCursorRight() noexcept
178 {
179         if (cursor == value.length())
180                 return;
181
182         size_t size = CharSizeMB(value.data() + cursor,
183                                  value.length() - cursor);
184         cursor += size;
185         if (GetCursorColumn() >= width)
186                 start = right_align_bytes(value.c_str(), cursor, width);
187 }
188
189 void
190 wreadln::MoveCursorLeft() noexcept
191 {
192         const char *v = value.c_str();
193         const char *new_cursor = PrevCharMB(v, v + cursor);
194         cursor = new_cursor - v;
195         if (cursor < start)
196                 start = cursor;
197 }
198
199 void
200 wreadln::MoveCursorToEnd() noexcept
201 {
202         cursor = value.length();
203         if (GetCursorColumn() >= width)
204                 start = right_align_bytes(value.c_str(),
205                                               cursor, width);
206 }
207
208 void
209 wreadln::Paint() const noexcept
210 {
211         wmove(w, point.y, point.x);
212         /* clear input area */
213         whline(w, ' ', width);
214         /* print visible part of the line buffer */
215         if (masked)
216                 whline(w, '*', StringWidthMB(value.c_str() + start));
217         else
218                 waddnstr(w, value.c_str() + start,
219                          screen_to_bytes(value.c_str(), width));
220         /* move the cursor to the correct position */
221         wmove(w, point.y, point.x + GetCursorColumn());
222         /* tell ncurses to redraw the screen */
223         doupdate();
224 }
225
226 void
227 wreadln::InsertByte(int key) noexcept
228 {
229         size_t length = 1;
230 #if (defined(HAVE_CURSES_ENHANCED) || defined(ENABLE_MULTIBYTE)) && !defined(_WIN32)
231         char buffer[32] = { (char)key };
232         WaitUserInput wui;
233
234         /* wide version: try to complete the multibyte sequence */
235
236         while (length < sizeof(buffer)) {
237                 if (!IsIncompleteCharMB(buffer, length))
238                         /* sequence is complete */
239                         break;
240
241                 /* poll for more bytes on stdin, without timeout */
242
243                 if (!wui.IsReady())
244                         /* no more input from keyboard */
245                         break;
246
247                 buffer[length++] = wgetch(w);
248         }
249
250         value.insert(cursor, buffer, length);
251
252 #else
253         value.insert(cursor, key);
254 #endif
255
256         cursor += length;
257         if (GetCursorColumn() >= width)
258                 start = right_align_bytes(value.c_str(), cursor, width);
259 }
260
261 void
262 wreadln::DeleteChar(size_t x) noexcept
263 {
264         assert(x < value.length());
265
266         size_t length = CharSizeMB(value.data() + x, value.length() - x);
267         value.erase(x, length);
268 }
269
270 /* libcurses version */
271
272 static std::string
273 _wreadln(WINDOW *w,
274          const char *initial_value,
275          unsigned x1,
276          History *history,
277          Completion *completion,
278          bool masked) noexcept
279 {
280         struct wreadln wr(w, masked);
281         History::iterator hlist, hcurrent;
282
283 #ifdef NCMPC_MINI
284         (void)completion;
285 #endif
286
287         /* make sure the cursor is visible */
288         curs_set(1);
289         /* retrieve y and x0 position */
290         getyx(w, wr.point.y, wr.point.x);
291         /* check the x1 value */
292         if (x1 <= (unsigned)wr.point.x || x1 > (unsigned)COLS)
293                 x1 = COLS;
294         wr.width = x1 - wr.point.x;
295         /* clear input area */
296         mvwhline(w, wr.point.y, wr.point.x, ' ', wr.width);
297
298         if (history) {
299                 /* append the a new line to our history list */
300                 history->emplace_back();
301                 /* hlist points to the current item in the history list */
302                 hcurrent = hlist = std::prev(history->end());
303         }
304
305         if (initial_value == (char *)-1) {
306                 /* get previous history entry */
307                 if (history && hlist != history->begin()) {
308                         /* get previous line */
309                         --hlist;
310                         wr.value = *hlist;
311                 }
312                 wr.MoveCursorToEnd();
313                 wr.Paint();
314         } else if (initial_value) {
315                 /* copy the initial value to the line buffer */
316                 wr.value = initial_value;
317                 wr.MoveCursorToEnd();
318                 wr.Paint();
319         }
320
321 #ifndef _WIN32
322         WaitUserInput wui;
323 #endif
324
325         int key = 0;
326         while (key != 13 && key != '\n') {
327                 key = wgetch(w);
328
329 #ifndef _WIN32
330                 if (key == ERR && errno == EAGAIN) {
331                         if (wui.Wait())
332                                 continue;
333                         else
334                                 break;
335                 }
336 #endif
337
338                 /* check if key is a function key */
339                 for (size_t i = 0; i < 63; i++)
340                         if (key == (int)KEY_F(i)) {
341                                 key = KEY_F(1);
342                                 i = 64;
343                         }
344
345                 switch (key) {
346 #ifdef HAVE_GETMOUSE
347                 case KEY_MOUSE: /* ignore mouse events */
348 #endif
349                 case ERR: /* ignore errors */
350                         break;
351
352                 case TAB:
353 #ifndef NCMPC_MINI
354                         if (completion != nullptr) {
355                                 completion->Pre(wr.value.c_str());
356                                 auto r = completion->Complete(wr.value.c_str());
357                                 if (!r.new_prefix.empty()) {
358                                         wr.value = std::move(r.new_prefix);
359                                         wr.MoveCursorToEnd();
360                                 } else
361                                         screen_bell();
362
363                                 completion->Post(wr.value.c_str(), r.range);
364                         }
365 #endif
366                         break;
367
368                 case KEY_CTRL_G:
369                         screen_bell();
370                         if (history) {
371                                 history->pop_back();
372                         }
373                         return {};
374
375                 case KEY_LEFT:
376                 case KEY_CTRL_B:
377                         wr.MoveCursorLeft();
378                         break;
379                 case KEY_RIGHT:
380                 case KEY_CTRL_F:
381                         wr.MoveCursorRight();
382                         break;
383                 case KEY_HOME:
384                 case KEY_CTRL_A:
385                         wr.cursor = 0;
386                         wr.start = 0;
387                         break;
388                 case KEY_END:
389                 case KEY_CTRL_E:
390                         wr.MoveCursorToEnd();
391                         break;
392                 case KEY_CTRL_K:
393                         wr.value.erase(wr.cursor);
394                         break;
395                 case KEY_CTRL_U:
396                         wr.value.erase(0, wr.cursor);
397                         wr.cursor = 0;
398                         break;
399                 case KEY_CTRL_W:
400                         /* Firstly remove trailing spaces. */
401                         for (; wr.cursor > 0 && wr.value[wr.cursor - 1] == ' ';)
402                         {
403                                 wr.MoveCursorLeft();
404                                 wr.DeleteChar();
405                         }
406                         /* Then remove word until next space. */
407                         for (; wr.cursor > 0 && wr.value[wr.cursor - 1] != ' ';)
408                         {
409                                 wr.MoveCursorLeft();
410                                 wr.DeleteChar();
411                         }
412                         break;
413                 case 127:
414                 case KEY_BCKSPC:        /* handle backspace: copy all */
415                 case KEY_BACKSPACE:     /* chars starting from curpos */
416                         if (wr.cursor > 0) { /* - 1 from buf[n+1] to buf   */
417                                 wr.MoveCursorLeft();
418                                 wr.DeleteChar();
419                         }
420                         break;
421                 case KEY_DC:            /* handle delete key. As above */
422                 case KEY_CTRL_D:
423                         if (wr.cursor < wr.value.length())
424                                 wr.DeleteChar();
425                         break;
426                 case KEY_UP:
427                 case KEY_CTRL_P:
428                         /* get previous history entry */
429                         if (history && hlist != history->begin()) {
430                                 if (hlist == hcurrent)
431                                         /* save the current line */
432                                         *hlist = wr.value;
433
434                                 /* get previous line */
435                                 --hlist;
436                                 wr.value = *hlist;
437                         }
438                         wr.MoveCursorToEnd();
439                         break;
440                 case KEY_DOWN:
441                 case KEY_CTRL_N:
442                         /* get next history entry */
443                         if (history && std::next(hlist) != history->end()) {
444                                 /* get next line */
445                                 ++hlist;
446                                 wr.value = *hlist;
447                         }
448                         wr.MoveCursorToEnd();
449                         break;
450
451                 case '\n':
452                 case 13:
453                 case KEY_IC:
454                 case KEY_PPAGE:
455                 case KEY_NPAGE:
456                 case KEY_F(1):
457                         /* ignore char */
458                         break;
459                 default:
460                         if (key >= 32)
461                                 wr.InsertByte(key);
462                 }
463
464                 wr.Paint();
465         }
466
467         /* update history */
468         if (history) {
469                 if (!wr.value.empty()) {
470                         /* update the current history entry */
471                         *hcurrent = wr.value;
472                 } else {
473                         /* the line was empty - remove the current history entry */
474                         history->erase(hcurrent);
475                 }
476
477                 auto history_length = history->size();
478                 while (history_length > wrln_max_history_length) {
479                         history->pop_front();
480                         --history_length;
481                 }
482         }
483
484         return std::move(wr.value);
485 }
486
487 std::string
488 wreadln(WINDOW *w,
489         const char *initial_value,
490         unsigned x1,
491         History *history,
492         Completion *completion) noexcept
493 {
494         return  _wreadln(w, initial_value, x1,
495                          history, completion, false);
496 }
497
498 std::string
499 wreadln_masked(WINDOW *w,
500                const char *initial_value,
501                unsigned x1) noexcept
502 {
503         return  _wreadln(w, initial_value, x1, nullptr, nullptr, true);
504 }