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