ncurses 5.9 - patch 20131012
[ncurses.git] / test / test_addwstr.c
1 /****************************************************************************
2  * Copyright (c) 2009-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: test_addwstr.c,v 1.11 2012/12/16 00:11:18 tom Exp $
30  *
31  * Demonstrate the waddwstr() and wadd_wch functions.
32  * Thomas Dickey - 2009/9/12
33  *
34  * Note: to provide inputs for *add_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 *add_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  * *addwstr() 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 #undef MvAddCh
52 #undef MvAddStr
53 #undef MvWAddCh
54 #undef MvWAddStr
55
56 /* definitions to make it simpler to compare with inserts.c */
57 #define AddNStr    addnwstr
58 #define AddStr     addwstr
59 #define MvAddNStr  (void) mvaddnwstr
60 #define MvAddStr   (void) mvaddwstr
61 #define MvWAddNStr (void) mvwaddnwstr
62 #define MvWAddStr  (void) mvwaddwstr
63 #define WAddNStr   waddnwstr
64 #define WAddStr    waddwstr
65
66 #define MY_TABSIZE 8
67
68 typedef enum {
69     oDefault = 0,
70     oMove = 1,
71     oWindow = 2,
72     oMoveWindow = 3
73 } Options;
74
75 static bool m_opt = FALSE;
76 static bool w_opt = FALSE;
77 static int n_opt = -1;
78
79 static void
80 legend(WINDOW *win, int level, Options state, wchar_t *buffer, int length)
81 {
82     const char *showstate;
83
84     switch (state) {
85     default:
86     case oDefault:
87         showstate = "";
88         break;
89     case oMove:
90         showstate = " (mvXXX)";
91         break;
92     case oWindow:
93         showstate = " (winXXX)";
94         break;
95     case oMoveWindow:
96         showstate = " (mvwinXXX)";
97         break;
98     }
99
100     wmove(win, 0, 0);
101     wprintw(win,
102             "The Strings/Chars displays should match.  Enter any characters, except:\n");
103     wprintw(win,
104             "down-arrow or ^N to repeat on next line, ^W for inner window, ESC to exit.\n");
105     wclrtoeol(win);
106     wprintw(win, "Level %d,%s inserted %d characters <", level,
107             showstate, length);
108     waddwstr(win, buffer);
109     waddstr(win, ">");
110 }
111
112 static int
113 ColOf(wchar_t *buffer, int length, int margin)
114 {
115     int n;
116     int result;
117
118     for (n = 0, result = margin + 1; n < length; ++n) {
119         int ch = buffer[n];
120         switch (ch) {
121         case '\n':
122             /* actually newline should clear the remainder of the line
123              * and move to the next line - but that seems a little awkward
124              * in this example.
125              */
126         case '\r':
127             result = 0;
128             break;
129         case '\b':
130             if (result > 0)
131                 --result;
132             break;
133         case '\t':
134             result += (MY_TABSIZE - (result % MY_TABSIZE));
135             break;
136         case '\177':
137             result += 2;
138             break;
139         default:
140             result += wcwidth(ch);
141             if (ch < 32)
142                 ++result;
143             break;
144         }
145     }
146     return result;
147 }
148
149 static int
150 ConvertCh(chtype source, cchar_t *target)
151 {
152     wchar_t tmp_wchar[2];
153
154     tmp_wchar[0] = (wchar_t) source;
155     tmp_wchar[1] = 0;
156     if (setcchar(target, tmp_wchar, A_NORMAL, 0, (void *) 0) == ERR) {
157         beep();
158         return FALSE;
159     }
160     return TRUE;
161 }
162
163 static int
164 MvWAddCh(WINDOW *win, int y, int x, chtype ch)
165 {
166     int code;
167     cchar_t tmp_cchar;
168
169     if (ConvertCh(ch, &tmp_cchar)) {
170         code = mvwadd_wch(win, y, x, &tmp_cchar);
171     } else {
172         code = mvwaddch(win, y, x, ch);
173     }
174     return code;
175 }
176
177 static int
178 MvAddCh(int y, int x, chtype ch)
179 {
180     int code;
181     cchar_t tmp_cchar;
182
183     if (ConvertCh(ch, &tmp_cchar)) {
184         code = mvadd_wch(y, x, &tmp_cchar);
185     } else {
186         code = mvaddch(y, x, ch);
187     }
188     return code;
189 }
190
191 static int
192 WAddCh(WINDOW *win, chtype ch)
193 {
194     int code;
195     cchar_t tmp_cchar;
196
197     if (ConvertCh(ch, &tmp_cchar)) {
198         code = wadd_wch(win, &tmp_cchar);
199     } else {
200         code = waddch(win, ch);
201     }
202     return code;
203 }
204
205 static int
206 AddCh(chtype ch)
207 {
208     int code;
209     cchar_t tmp_cchar;
210
211     if (ConvertCh(ch, &tmp_cchar)) {
212         code = add_wch(&tmp_cchar);
213     } else {
214         code = addch(ch);
215     }
216     return code;
217 }
218
219 #define LEN(n) ((length - (n) > n_opt) ? n_opt : (length - (n)))
220 static void
221 test_inserts(int level)
222 {
223     static bool first = TRUE;
224
225     int ch;
226     int limit;
227     int row = 1;
228     int col;
229     int row2, col2;
230     int length;
231     wchar_t buffer[BUFSIZ];
232     WINDOW *look = 0;
233     WINDOW *work = 0;
234     WINDOW *show = 0;
235     int margin = (2 * MY_TABSIZE) - 1;
236     Options option = (Options) ((int) (m_opt ? oMove : oDefault)
237                                 | (int) ((w_opt || (level > 0))
238                                          ? oWindow : oDefault));
239
240     if (first) {
241         static char cmd[80];
242         setlocale(LC_ALL, "");
243
244         putenv(strcpy(cmd, "TABSIZE=8"));
245
246         initscr();
247         (void) cbreak();        /* take input chars one at a time, no wait for \n */
248         (void) noecho();        /* don't echo input */
249         keypad(stdscr, TRUE);
250
251         /*
252          * Show the characters inserted in color, to distinguish from those that
253          * are shifted.
254          */
255         if (has_colors()) {
256             start_color();
257             init_pair(1, COLOR_WHITE, COLOR_BLUE);
258         }
259     }
260
261     limit = LINES - 5;
262     if (level > 0) {
263         look = newwin(limit, COLS - (2 * (level - 1)), 0, level - 1);
264         work = newwin(limit - 2, COLS - (2 * level), 1, level);
265         show = newwin(4, COLS, limit + 1, 0);
266         box(look, 0, 0);
267         wnoutrefresh(look);
268         limit -= 2;
269     } else {
270         work = stdscr;
271         show = derwin(stdscr, 4, COLS, limit + 1, 0);
272     }
273     keypad(work, TRUE);
274
275     for (col = margin + 1; col < COLS; col += MY_TABSIZE)
276         MvWVLine(work, row, col, '.', limit - 2);
277
278     MvWVLine(work, row, margin, ACS_VLINE, limit - 2);
279     MvWVLine(work, row, margin + 1, ACS_VLINE, limit - 2);
280     limit /= 2;
281
282     (void) mvwaddstr(work, 1, 2, "String");
283     (void) mvwaddstr(work, limit + 1, 2, "Chars");
284     wnoutrefresh(work);
285
286     buffer[length = 0] = '\0';
287     legend(show, level, option, buffer, length);
288     wnoutrefresh(show);
289
290     doupdate();
291
292     if (has_colors()) {
293         wbkgdset(work, (chtype) (COLOR_PAIR(1) | ' '));
294     }
295
296     while ((ch = read_linedata(work)) != ERR && !isQUIT(ch)) {
297         wmove(work, row, margin + 1);
298         switch (ch) {
299         case key_RECUR:
300             test_inserts(level + 1);
301
302             if (look)
303                 touchwin(look);
304             touchwin(work);
305             touchwin(show);
306
307             if (look)
308                 wnoutrefresh(look);
309             wnoutrefresh(work);
310             wnoutrefresh(show);
311
312             doupdate();
313             break;
314         case key_NEWLINE:
315             if (row < limit) {
316                 ++row;
317                 /* put the whole string in, all at once */
318                 col2 = margin + 1;
319                 switch (option) {
320                 case oDefault:
321                     if (n_opt > 1) {
322                         for (col = 0; col < length; col += n_opt) {
323                             col2 = ColOf(buffer, col, margin);
324                             if (move(row, col2) != ERR) {
325                                 AddNStr(buffer + col, LEN(col));
326                             }
327                         }
328                     } else {
329                         if (move(row, col2) != ERR) {
330                             AddStr(buffer);
331                         }
332                     }
333                     break;
334                 case oMove:
335                     if (n_opt > 1) {
336                         for (col = 0; col < length; col += n_opt) {
337                             col2 = ColOf(buffer, col, margin);
338                             MvAddNStr(row, col2, buffer + col, LEN(col));
339                         }
340                     } else {
341                         MvAddStr(row, col2, buffer);
342                     }
343                     break;
344                 case oWindow:
345                     if (n_opt > 1) {
346                         for (col = 0; col < length; col += n_opt) {
347                             col2 = ColOf(buffer, col, margin);
348                             if (wmove(work, row, col2) != ERR) {
349                                 WAddNStr(work, buffer + col, LEN(col));
350                             }
351                         }
352                     } else {
353                         if (wmove(work, row, col2) != ERR) {
354                             WAddStr(work, buffer);
355                         }
356                     }
357                     break;
358                 case oMoveWindow:
359                     if (n_opt > 1) {
360                         for (col = 0; col < length; col += n_opt) {
361                             col2 = ColOf(buffer, col, margin);
362                             MvWAddNStr(work, row, col2, buffer + col, LEN(col));
363                         }
364                     } else {
365                         MvWAddStr(work, row, col2, buffer);
366                     }
367                     break;
368                 }
369
370                 /* do the corresponding single-character insertion */
371                 row2 = limit + row;
372                 for (col = 0; col < length; ++col) {
373                     col2 = ColOf(buffer, col, margin);
374                     switch (option) {
375                     case oDefault:
376                         if (move(row2, col2) != ERR) {
377                             AddCh((chtype) buffer[col]);
378                         }
379                         break;
380                     case oMove:
381                         MvAddCh(row2, col2, (chtype) buffer[col]);
382                         break;
383                     case oWindow:
384                         if (wmove(work, row2, col2) != ERR) {
385                             WAddCh(work, (chtype) buffer[col]);
386                         }
387                         break;
388                     case oMoveWindow:
389                         MvWAddCh(work, row2, col2, (chtype) buffer[col]);
390                         break;
391                     }
392                 }
393             } else {
394                 beep();
395             }
396             break;
397         case KEY_BACKSPACE:
398             ch = '\b';
399             /* FALLTHRU */
400         default:
401             buffer[length++] = ch;
402             buffer[length] = '\0';
403
404             /* put the string in, one character at a time */
405             col = ColOf(buffer, length - 1, margin);
406             switch (option) {
407             case oDefault:
408                 if (move(row, col) != ERR) {
409                     AddStr(buffer + length - 1);
410                 }
411                 break;
412             case oMove:
413                 MvAddStr(row, col, buffer + length - 1);
414                 break;
415             case oWindow:
416                 if (wmove(work, row, col) != ERR) {
417                     WAddStr(work, buffer + length - 1);
418                 }
419                 break;
420             case oMoveWindow:
421                 MvWAddStr(work, row, col, buffer + length - 1);
422                 break;
423             }
424
425             /* do the corresponding single-character insertion */
426             switch (option) {
427             case oDefault:
428                 if (move(limit + row, col) != ERR) {
429                     AddCh((chtype) ch);
430                 }
431                 break;
432             case oMove:
433                 MvAddCh(limit + row, col, (chtype) ch);
434                 break;
435             case oWindow:
436                 if (wmove(work, limit + row, col) != ERR) {
437                     WAddCh(work, (chtype) ch);
438                 }
439                 break;
440             case oMoveWindow:
441                 MvWAddCh(work, limit + row, col, (chtype) ch);
442                 break;
443             }
444
445             wnoutrefresh(work);
446
447             legend(show, level, option, buffer, length);
448             wnoutrefresh(show);
449
450             doupdate();
451             break;
452         }
453     }
454     delwin(show);
455     if (level > 0) {
456         delwin(work);
457         delwin(look);
458     }
459 }
460
461 static void
462 usage(void)
463 {
464     static const char *tbl[] =
465     {
466         "Usage: inserts [options]"
467         ,""
468         ,"Options:"
469         ,"  -f FILE read data from given file"
470         ,"  -n NUM  limit string-inserts to NUM bytes on ^N replay"
471         ,"  -m      perform wmove/move separately from insert-functions"
472         ,"  -w      use window-parameter even when stdscr would be implied"
473     };
474     unsigned n;
475     for (n = 0; n < SIZEOF(tbl); ++n)
476         fprintf(stderr, "%s\n", tbl[n]);
477     ExitProgram(EXIT_FAILURE);
478 }
479
480 int
481 main(int argc GCC_UNUSED, char *argv[]GCC_UNUSED)
482 {
483     int ch;
484
485     setlocale(LC_ALL, "");
486
487     while ((ch = getopt(argc, argv, "f:mn:w")) != -1) {
488         switch (ch) {
489         case 'f':
490             init_linedata(optarg);
491             break;
492         case 'm':
493             m_opt = TRUE;
494             break;
495         case 'n':
496             n_opt = atoi(optarg);
497             if (n_opt == 0)
498                 n_opt = -1;
499             break;
500         case 'w':
501             w_opt = TRUE;
502             break;
503         default:
504             usage();
505             break;
506         }
507     }
508     if (optind < argc)
509         usage();
510
511     test_inserts(0);
512     endwin();
513     ExitProgram(EXIT_SUCCESS);
514 }
515 #else
516 int
517 main(void)
518 {
519     printf("This program requires the wide-ncurses library\n");
520     ExitProgram(EXIT_FAILURE);
521 }
522 #endif