6e4e7275cdf6723f75db63e865f32a86640c19a8
[ncurses.git] / test / ins_wide.c
1 /****************************************************************************
2  * Copyright (c) 2002-2010,2012 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.19 2012/12/09 01:13:56 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(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         putenv(strcpy(cmd, "TABSIZE=8"));
240
241         initscr();
242         (void) cbreak();        /* take input chars one at a time, no wait for \n */
243         (void) noecho();        /* don't echo input */
244         keypad(stdscr, TRUE);
245
246         /*
247          * Show the characters inserted in color, to distinguish from those
248          * that are shifted.
249          */
250         if (has_colors()) {
251             start_color();
252             init_pair(1, COLOR_WHITE, COLOR_BLUE);
253         }
254     }
255
256     limit = LINES - 5;
257     if (level > 0) {
258         look = newwin(limit, COLS - (2 * (level - 1)), 0, level - 1);
259         work = newwin(limit - 2, COLS - (2 * level), 1, level);
260         show = newwin(4, COLS, limit + 1, 0);
261         box(look, 0, 0);
262         wnoutrefresh(look);
263         limit -= 2;
264     } else {
265         work = stdscr;
266         show = derwin(stdscr, 4, COLS, limit + 1, 0);
267     }
268     keypad(work, TRUE);
269
270     for (col = margin + 1; col < COLS; col += MY_TABSIZE)
271         MvWVLine(work, row, col, '.', limit - 2);
272
273     MvWVLine(work, row, margin, ACS_VLINE, limit - 2);
274     MvWVLine(work, row, margin + 1, ACS_VLINE, limit - 2);
275     limit /= 2;
276
277     MvWAddStr(work, 1, 2, "String");
278     MvWAddStr(work, limit + 1, 2, "Chars");
279     wnoutrefresh(work);
280
281     buffer[length = 0] = '\0';
282     legend(show, level, option, buffer, length);
283     wnoutrefresh(show);
284
285     doupdate();
286
287     if (has_colors()) {
288         wbkgdset(work, (chtype) (COLOR_PAIR(1) | ' '));
289     }
290
291     while ((ch = read_linedata(work)) != ERR && !isQUIT(ch)) {
292         wmove(work, row, margin + 1);
293         switch (ch) {
294         case key_RECUR:
295             test_inserts(level + 1);
296
297             touchwin(look);
298             touchwin(work);
299             touchwin(show);
300
301             wnoutrefresh(look);
302             wnoutrefresh(work);
303             wnoutrefresh(show);
304
305             doupdate();
306             break;
307         case key_NEWLINE:
308             if (row < limit) {
309                 ++row;
310                 /* put the whole string in, all at once */
311                 col2 = margin + 1;
312                 switch (option) {
313                 case oDefault:
314                     if (n_opt > 1) {
315                         for (col = 0; col < length; col += n_opt) {
316                             col2 = ColOf(buffer, col, margin);
317                             if (move(row, col2) != ERR) {
318                                 InsNStr(buffer + col, LEN(col));
319                             }
320                         }
321                     } else {
322                         if (move(row, col2) != ERR) {
323                             InsStr(buffer);
324                         }
325                     }
326                     break;
327                 case oMove:
328                     if (n_opt > 1) {
329                         for (col = 0; col < length; col += n_opt) {
330                             col2 = ColOf(buffer, col, margin);
331                             MvInsNStr(row, col2, buffer + col, LEN(col));
332                         }
333                     } else {
334                         MvInsStr(row, col2, buffer);
335                     }
336                     break;
337                 case oWindow:
338                     if (n_opt > 1) {
339                         for (col = 0; col < length; col += n_opt) {
340                             col2 = ColOf(buffer, col, margin);
341                             if (wmove(work, row, col2) != ERR) {
342                                 WInsNStr(work, buffer + col, LEN(col));
343                             }
344                         }
345                     } else {
346                         if (wmove(work, row, col2) != ERR) {
347                             WInsStr(work, buffer);
348                         }
349                     }
350                     break;
351                 case oMoveWindow:
352                     if (n_opt > 1) {
353                         for (col = 0; col < length; col += n_opt) {
354                             col2 = ColOf(buffer, col, margin);
355                             MvWInsNStr(work, row, col2, buffer + col, LEN(col));
356                         }
357                     } else {
358                         MvWInsStr(work, row, col2, buffer);
359                     }
360                     break;
361                 }
362
363                 /* do the corresponding single-character insertion */
364                 row2 = limit + row;
365                 for (col = 0; col < length; ++col) {
366                     col2 = ColOf(buffer, col, margin);
367                     switch (option) {
368                     case oDefault:
369                         if (move(row2, col2) != ERR) {
370                             InsCh((chtype) buffer[col]);
371                         }
372                         break;
373                     case oMove:
374                         MvInsCh(row2, col2, (chtype) buffer[col]);
375                         break;
376                     case oWindow:
377                         if (wmove(work, row2, col2) != ERR) {
378                             WInsCh(work, (chtype) buffer[col]);
379                         }
380                         break;
381                     case oMoveWindow:
382                         MvWInsCh(work, row2, col2, (chtype) buffer[col]);
383                         break;
384                     }
385                 }
386             } else {
387                 beep();
388             }
389             break;
390         default:
391             buffer[length++] = ch;
392             buffer[length] = '\0';
393
394             /* put the string in, one character at a time */
395             col = ColOf(buffer, length - 1, margin);
396             switch (option) {
397             case oDefault:
398                 if (move(row, col) != ERR) {
399                     InsStr(buffer + length - 1);
400                 }
401                 break;
402             case oMove:
403                 MvInsStr(row, col, buffer + length - 1);
404                 break;
405             case oWindow:
406                 if (wmove(work, row, col) != ERR) {
407                     WInsStr(work, buffer + length - 1);
408                 }
409                 break;
410             case oMoveWindow:
411                 MvWInsStr(work, row, col, buffer + length - 1);
412                 break;
413             }
414
415             /* do the corresponding single-character insertion */
416             switch (option) {
417             case oDefault:
418                 if (move(limit + row, col) != ERR) {
419                     InsCh((chtype) ch);
420                 }
421                 break;
422             case oMove:
423                 MvInsCh(limit + row, col, (chtype) ch);
424                 break;
425             case oWindow:
426                 if (wmove(work, limit + row, col) != ERR) {
427                     WInsCh(work, (chtype) ch);
428                 }
429                 break;
430             case oMoveWindow:
431                 MvWInsCh(work, limit + row, col, (chtype) ch);
432                 break;
433             }
434
435             wnoutrefresh(work);
436
437             legend(show, level, option, buffer, length);
438             wnoutrefresh(show);
439
440             doupdate();
441             break;
442         }
443     }
444     if (level > 0) {
445         delwin(work);
446         delwin(look);
447     }
448     delwin(show);
449 }
450
451 static void
452 usage(void)
453 {
454     static const char *tbl[] =
455     {
456         "Usage: inserts [options]"
457         ,""
458         ,"Options:"
459         ,"  -f FILE read data from given file"
460         ,"  -n NUM  limit string-inserts to NUM bytes on ^N replay"
461         ,"  -m      perform wmove/move separately from insert-functions"
462         ,"  -w      use window-parameter even when stdscr would be implied"
463     };
464     unsigned n;
465     for (n = 0; n < SIZEOF(tbl); ++n)
466         fprintf(stderr, "%s\n", tbl[n]);
467     ExitProgram(EXIT_FAILURE);
468 }
469
470 int
471 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
472 {
473     int ch;
474
475     setlocale(LC_ALL, "");
476
477     while ((ch = getopt(argc, argv, "f:mn:w")) != -1) {
478         switch (ch) {
479         case 'f':
480             init_linedata(optarg);
481             break;
482         case 'm':
483             m_opt = TRUE;
484             break;
485         case 'n':
486             n_opt = atoi(optarg);
487             if (n_opt == 0)
488                 n_opt = -1;
489             break;
490         case 'w':
491             w_opt = TRUE;
492             break;
493         default:
494             usage();
495             break;
496         }
497     }
498     if (optind < argc)
499         usage();
500
501     test_inserts(0);
502     endwin();
503     ExitProgram(EXIT_SUCCESS);
504 }
505 #else
506 int
507 main(void)
508 {
509     printf("This program requires the wide-ncurses library\n");
510     ExitProgram(EXIT_FAILURE);
511 }
512 #endif