ncurses 6.1 - patch 20191123
[ncurses.git] / test / ins_wide.c
1 /****************************************************************************
2  * Copyright (c) 2002-2016,2017 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28 /*
29  * $Id: ins_wide.c,v 1.24 2017/10/18 23:03:57 tom Exp $
30  *
31  * Demonstrate the wins_wstr() and wins_wch functions.
32  * Thomas Dickey - 2002/11/23
33  *
34  * Note: to provide inputs for *ins_wch(), we use setcchar().  A quirk of the
35  * X/Open definition for that function is that the string contains no
36  * characters with negative width.  Any control character (such as tab) falls
37  * into that category.  So it follows that *ins_wch() cannot render a tab
38  * character because there is no legal way to construct a cchar_t containing
39  * one.  X/Open does not document this, and it would be logical to assume that
40  * *ins_wstr() has the same limitation, but it uses a wchar_t string directly,
41  * and does not document how tabs are handled.
42  */
43
44 #include <test.priv.h>
45
46 #if USE_WIDEC_SUPPORT
47
48 #define WIDE_LINEDATA
49 #include <linedata.h>
50
51 /* definitions to make it simpler to compare with inserts.c */
52 #define InsNStr    ins_nwstr
53 #define InsStr     ins_wstr
54 #define MvInsNStr  (void) mvins_nwstr
55 #define MvInsStr   (void) mvins_wstr
56 #define MvWInsNStr (void) mvwins_nwstr
57 #define MvWInsStr  (void) mvwins_wstr
58 #define WInsNStr   wins_nwstr
59 #define WInsStr    wins_wstr
60
61 #define MY_TABSIZE 8
62
63 typedef enum {
64     oDefault = 0,
65     oMove = 1,
66     oWindow = 2,
67     oMoveWindow = 3
68 } Options;
69
70 static bool m_opt = FALSE;
71 static bool w_opt = FALSE;
72 static int n_opt = -1;
73
74 static void
75 legend(WINDOW *win, int level, Options state, wchar_t *buffer, int length)
76 {
77     const char *showstate;
78
79     switch (state) {
80     default:
81     case oDefault:
82         showstate = "";
83         break;
84     case oMove:
85         showstate = " (mvXXX)";
86         break;
87     case oWindow:
88         showstate = " (winXXX)";
89         break;
90     case oMoveWindow:
91         showstate = " (mvwinXXX)";
92         break;
93     }
94
95     wmove(win, 0, 0);
96     wprintw(win,
97             "The Strings/Chars displays should match.  Enter any characters, except:\n");
98     wprintw(win,
99             "down-arrow or ^N to repeat on next line, ^W for inner window, ESC to exit.\n");
100     wclrtoeol(win);
101     wprintw(win, "Level %d,%s inserted %d characters <", level,
102             showstate, length);
103     waddwstr(win, buffer);
104     waddstr(win, ">");
105 }
106
107 static int
108 ColOf(wchar_t *buffer, int length, int margin)
109 {
110     int n;
111     int result;
112
113     for (n = 0, result = margin + 1; n < length; ++n) {
114         int ch = buffer[n];
115         switch (ch) {
116         case '\n':
117             /* actually newline should clear the remainder of the line
118              * and move to the next line - but that seems a little awkward
119              * in this example.
120              */
121         case '\r':
122             result = 0;
123             break;
124         case '\b':
125             if (result > 0)
126                 --result;
127             break;
128         case '\t':
129             result += (MY_TABSIZE - (result % MY_TABSIZE));
130             break;
131         case '\177':
132             result += 2;
133             break;
134         default:
135             result += wcwidth((wchar_t) ch);
136             if (ch < 32)
137                 ++result;
138             break;
139         }
140     }
141     return result;
142 }
143
144 static int
145 ConvertCh(chtype source, cchar_t *target)
146 {
147     wchar_t tmp_wchar[2];
148
149     tmp_wchar[0] = (wchar_t) source;
150     tmp_wchar[1] = 0;
151     if (setcchar(target, tmp_wchar, A_NORMAL, 0, (void *) 0) == ERR) {
152         beep();
153         return FALSE;
154     }
155     return TRUE;
156 }
157
158 static int
159 MvWInsCh(WINDOW *win, int y, int x, chtype ch)
160 {
161     int code;
162     cchar_t tmp_cchar;
163
164     if (ConvertCh(ch, &tmp_cchar)) {
165         code = mvwins_wch(win, y, x, &tmp_cchar);
166     } else {
167         code = mvwinsch(win, y, x, ch);
168     }
169     return code;
170 }
171
172 static int
173 MvInsCh(int y, int x, chtype ch)
174 {
175     int code;
176     cchar_t tmp_cchar;
177
178     if (ConvertCh(ch, &tmp_cchar)) {
179         code = mvins_wch(y, x, &tmp_cchar);
180     } else {
181         code = mvinsch(y, x, ch);
182     }
183     return code;
184 }
185
186 static int
187 WInsCh(WINDOW *win, chtype ch)
188 {
189     int code;
190     cchar_t tmp_cchar;
191
192     if (ConvertCh(ch, &tmp_cchar)) {
193         code = wins_wch(win, &tmp_cchar);
194     } else {
195         code = winsch(win, ch);
196     }
197     return code;
198 }
199
200 static int
201 InsCh(chtype ch)
202 {
203     int code;
204     cchar_t tmp_cchar;
205
206     if (ConvertCh(ch, &tmp_cchar)) {
207         code = ins_wch(&tmp_cchar);
208     } else {
209         code = insch(ch);
210     }
211     return code;
212 }
213
214 #define LEN(n) ((length - (n) > n_opt) ? n_opt : (length - (n)))
215 static void
216 test_inserts(int level)
217 {
218     static bool first = TRUE;
219
220     int ch;
221     int limit;
222     int row = 1;
223     int col;
224     int row2, col2;
225     int length;
226     wchar_t buffer[BUFSIZ];
227     WINDOW *look = 0;
228     WINDOW *work = 0;
229     WINDOW *show = 0;
230     int margin = (2 * MY_TABSIZE) - 1;
231     Options option = (Options) ((int) (m_opt ? oMove : oDefault)
232                                 | (int) ((w_opt || (level > 0))
233                                          ? oWindow : oDefault));
234
235     if (first) {
236         static char cmd[80];
237         setlocale(LC_ALL, "");
238
239         _nc_STRCPY(cmd, "TABSIZE=8", sizeof(cmd));
240         putenv(cmd);
241
242         initscr();
243         (void) cbreak();        /* take input chars one at a time, no wait for \n */
244         (void) noecho();        /* don't echo input */
245         keypad(stdscr, TRUE);
246
247         /*
248          * Show the characters inserted in color, to distinguish from those
249          * that are shifted.
250          */
251         if (has_colors()) {
252             start_color();
253             init_pair(1, COLOR_WHITE, COLOR_BLUE);
254         }
255     }
256
257     limit = LINES - 5;
258     if (level > 0) {
259         look = newwin(limit, COLS - (2 * (level - 1)), 0, level - 1);
260         work = newwin(limit - 2, COLS - (2 * level), 1, level);
261         show = newwin(4, COLS, limit + 1, 0);
262         box(look, 0, 0);
263         wnoutrefresh(look);
264         limit -= 2;
265     } else {
266         work = stdscr;
267         show = derwin(stdscr, 4, COLS, limit + 1, 0);
268     }
269     keypad(work, TRUE);
270
271     for (col = margin + 1; col < COLS; col += MY_TABSIZE)
272         MvWVLine(work, row, col, '.', limit - 2);
273
274     MvWVLine(work, row, margin, ACS_VLINE, limit - 2);
275     MvWVLine(work, row, margin + 1, ACS_VLINE, limit - 2);
276     limit /= 2;
277
278     MvWAddStr(work, 1, 2, "String");
279     MvWAddStr(work, limit + 1, 2, "Chars");
280     wnoutrefresh(work);
281
282     buffer[length = 0] = '\0';
283     legend(show, level, option, buffer, length);
284     wnoutrefresh(show);
285
286     doupdate();
287
288     if (has_colors()) {
289         wbkgdset(work, (chtype) (COLOR_PAIR(1) | ' '));
290     }
291
292     while ((ch = read_linedata(work)) != ERR && !isQUIT(ch)) {
293         wmove(work, row, margin + 1);
294         switch (ch) {
295         case key_RECUR:
296             test_inserts(level + 1);
297
298             if (look)
299                 touchwin(look);
300             touchwin(work);
301             touchwin(show);
302
303             if (look)
304                 wnoutrefresh(look);
305             wnoutrefresh(work);
306             wnoutrefresh(show);
307
308             doupdate();
309             break;
310         case key_NEWLINE:
311             if (row < limit) {
312                 ++row;
313                 /* put the whole string in, all at once */
314                 col2 = margin + 1;
315                 switch (option) {
316                 case oDefault:
317                     if (n_opt > 1) {
318                         for (col = 0; col < length; col += n_opt) {
319                             col2 = ColOf(buffer, col, margin);
320                             if (move(row, col2) != ERR) {
321                                 InsNStr(buffer + col, LEN(col));
322                             }
323                         }
324                     } else {
325                         if (move(row, col2) != ERR) {
326                             InsStr(buffer);
327                         }
328                     }
329                     break;
330                 case oMove:
331                     if (n_opt > 1) {
332                         for (col = 0; col < length; col += n_opt) {
333                             col2 = ColOf(buffer, col, margin);
334                             MvInsNStr(row, col2, buffer + col, LEN(col));
335                         }
336                     } else {
337                         MvInsStr(row, col2, buffer);
338                     }
339                     break;
340                 case oWindow:
341                     if (n_opt > 1) {
342                         for (col = 0; col < length; col += n_opt) {
343                             col2 = ColOf(buffer, col, margin);
344                             if (wmove(work, row, col2) != ERR) {
345                                 WInsNStr(work, buffer + col, LEN(col));
346                             }
347                         }
348                     } else {
349                         if (wmove(work, row, col2) != ERR) {
350                             WInsStr(work, buffer);
351                         }
352                     }
353                     break;
354                 case oMoveWindow:
355                     if (n_opt > 1) {
356                         for (col = 0; col < length; col += n_opt) {
357                             col2 = ColOf(buffer, col, margin);
358                             MvWInsNStr(work, row, col2, buffer + col, LEN(col));
359                         }
360                     } else {
361                         MvWInsStr(work, row, col2, buffer);
362                     }
363                     break;
364                 }
365
366                 /* do the corresponding single-character insertion */
367                 row2 = limit + row;
368                 for (col = 0; col < length; ++col) {
369                     col2 = ColOf(buffer, col, margin);
370                     switch (option) {
371                     case oDefault:
372                         if (move(row2, col2) != ERR) {
373                             InsCh((chtype) buffer[col]);
374                         }
375                         break;
376                     case oMove:
377                         MvInsCh(row2, col2, (chtype) buffer[col]);
378                         break;
379                     case oWindow:
380                         if (wmove(work, row2, col2) != ERR) {
381                             WInsCh(work, (chtype) buffer[col]);
382                         }
383                         break;
384                     case oMoveWindow:
385                         MvWInsCh(work, row2, col2, (chtype) buffer[col]);
386                         break;
387                     }
388                 }
389             } else {
390                 beep();
391             }
392             break;
393         default:
394             if (length >= BUFSIZ - 2)
395                 break;
396             buffer[length++] = (wchar_t) ch;
397             buffer[length] = '\0';
398
399             /* put the string in, one character at a time */
400             col = ColOf(buffer, length - 1, margin);
401             switch (option) {
402             case oDefault:
403                 if (move(row, col) != ERR) {
404                     InsStr(buffer + length - 1);
405                 }
406                 break;
407             case oMove:
408                 MvInsStr(row, col, buffer + length - 1);
409                 break;
410             case oWindow:
411                 if (wmove(work, row, col) != ERR) {
412                     WInsStr(work, buffer + length - 1);
413                 }
414                 break;
415             case oMoveWindow:
416                 MvWInsStr(work, row, col, buffer + length - 1);
417                 break;
418             }
419
420             /* do the corresponding single-character insertion */
421             switch (option) {
422             case oDefault:
423                 if (move(limit + row, col) != ERR) {
424                     InsCh((chtype) ch);
425                 }
426                 break;
427             case oMove:
428                 MvInsCh(limit + row, col, (chtype) ch);
429                 break;
430             case oWindow:
431                 if (wmove(work, limit + row, col) != ERR) {
432                     WInsCh(work, (chtype) ch);
433                 }
434                 break;
435             case oMoveWindow:
436                 MvWInsCh(work, limit + row, col, (chtype) ch);
437                 break;
438             }
439
440             wnoutrefresh(work);
441
442             legend(show, level, option, buffer, length);
443             wnoutrefresh(show);
444
445             doupdate();
446             break;
447         }
448     }
449     if (level > 0) {
450         delwin(work);
451         delwin(look);
452     }
453     delwin(show);
454 }
455
456 static void
457 usage(void)
458 {
459     static const char *tbl[] =
460     {
461         "Usage: ins_wide [options]"
462         ,""
463         ,"Options:"
464         ,"  -f FILE read data from given file"
465         ,"  -n NUM  limit string-inserts to NUM bytes on ^N replay"
466         ,"  -m      perform wmove/move separately from insert-functions"
467         ,"  -w      use window-parameter even when stdscr would be implied"
468     };
469     unsigned n;
470     for (n = 0; n < SIZEOF(tbl); ++n)
471         fprintf(stderr, "%s\n", tbl[n]);
472     ExitProgram(EXIT_FAILURE);
473 }
474
475 int
476 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
477 {
478     int ch;
479
480     setlocale(LC_ALL, "");
481
482     while ((ch = getopt(argc, argv, "f:mn:w")) != -1) {
483         switch (ch) {
484         case 'f':
485             init_linedata(optarg);
486             break;
487         case 'm':
488             m_opt = TRUE;
489             break;
490         case 'n':
491             n_opt = atoi(optarg);
492             if (n_opt == 0)
493                 n_opt = -1;
494             break;
495         case 'w':
496             w_opt = TRUE;
497             break;
498         default:
499             usage();
500             break;
501         }
502     }
503     if (optind < argc)
504         usage();
505
506     test_inserts(0);
507     endwin();
508     ExitProgram(EXIT_SUCCESS);
509 }
510 #else
511 int
512 main(void)
513 {
514     printf("This program requires the wide-ncurses library\n");
515     ExitProgram(EXIT_FAILURE);
516 }
517 #endif