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