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