ncurses 5.6 - patch 20070407
[ncurses.git] / ncurses / base / lib_addch.c
1 /****************************************************************************
2  * Copyright (c) 1998-2005,2006 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 /*
30 **      lib_addch.c
31 **
32 **      The routine waddch().
33 **
34 */
35
36 #include <curses.priv.h>
37 #include <ctype.h>
38
39 MODULE_ID("$Id: lib_addch.c,v 1.104 2006/10/14 20:31:19 tom Exp $")
40
41 static const NCURSES_CH_T blankchar = NewChar(BLANK_TEXT);
42
43 /*
44  * Ugly microtweaking alert.  Everything from here to end of module is
45  * likely to be speed-critical -- profiling data sure says it is!
46  * Most of the important screen-painting functions are shells around
47  * waddch().  So we make every effort to reduce function-call overhead
48  * by inlining stuff, even at the cost of making wrapped copies for
49  * export.  Also we supply some internal versions that don't call the
50  * window sync hook, for use by string-put functions.
51  */
52
53 /* Return bit mask for clearing color pair number if given ch has color */
54 #define COLOR_MASK(ch) (~(attr_t)((ch) & A_COLOR ? A_COLOR : 0))
55
56 static NCURSES_INLINE NCURSES_CH_T
57 render_char(WINDOW *win, NCURSES_CH_T ch)
58 /* compute a rendition of the given char correct for the current context */
59 {
60     attr_t a = WINDOW_ATTRS(win);
61     int pair = GetPair(ch);
62
63     if (ISBLANK(ch)
64         && AttrOf(ch) == A_NORMAL
65         && pair == 0) {
66         /* color/pair in attrs has precedence over bkgrnd */
67         ch = win->_nc_bkgd;
68         SetAttr(ch, a | AttrOf(win->_nc_bkgd));
69         if ((pair = GET_WINDOW_PAIR(win)) == 0)
70             pair = GetPair(win->_nc_bkgd);
71         SetPair(ch, pair);
72     } else {
73         /* color in attrs has precedence over bkgrnd */
74         a |= AttrOf(win->_nc_bkgd) & COLOR_MASK(a);
75         /* color in ch has precedence */
76         if (pair == 0) {
77             if ((pair = GET_WINDOW_PAIR(win)) == 0)
78                 pair = GetPair(win->_nc_bkgd);
79         }
80 #if 0
81         if (pair > 255) {
82             NCURSES_CH_T fixme = ch;
83             SetPair(fixme, pair);
84         }
85 #endif
86         AddAttr(ch, (a & COLOR_MASK(AttrOf(ch))));
87         SetPair(ch, pair);
88     }
89
90     TR(TRACE_VIRTPUT,
91        ("render_char bkg %s (%d), attrs %s (%d) -> ch %s (%d)",
92         _tracech_t2(1, CHREF(win->_nc_bkgd)),
93         GetPair(win->_nc_bkgd),
94         _traceattr(WINDOW_ATTRS(win)),
95         GET_WINDOW_PAIR(win),
96         _tracech_t2(3, CHREF(ch)),
97         GetPair(ch)));
98
99     return (ch);
100 }
101
102 NCURSES_EXPORT(NCURSES_CH_T)
103 _nc_render(WINDOW *win, NCURSES_CH_T ch)
104 /* make render_char() visible while still allowing us to inline it below */
105 {
106     return render_char(win, ch);
107 }
108
109 /* check if position is legal; if not, return error */
110 #ifndef NDEBUG                  /* treat this like an assertion */
111 #define CHECK_POSITION(win, x, y) \
112         if (y > win->_maxy \
113          || x > win->_maxx \
114          || y < 0 \
115          || x < 0) { \
116                 TR(TRACE_VIRTPUT, ("Alert! Win=%p _curx = %d, _cury = %d " \
117                                    "(_maxx = %d, _maxy = %d)", win, x, y, \
118                                    win->_maxx, win->_maxy)); \
119                 return(ERR); \
120         }
121 #else
122 #define CHECK_POSITION(win, x, y)       /* nothing */
123 #endif
124
125 static bool
126 newline_forces_scroll(WINDOW *win, NCURSES_SIZE_T * ypos)
127 {
128     bool result = FALSE;
129
130     if (*ypos >= win->_regtop && *ypos == win->_regbottom) {
131         *ypos = win->_regbottom;
132         result = TRUE;
133     } else {
134         *ypos += 1;
135     }
136     return result;
137 }
138
139 /*
140  * The _WRAPPED flag is useful only for telling an application that we've just
141  * wrapped the cursor.  We don't do anything with this flag except set it when
142  * wrapping, and clear it whenever we move the cursor.  If we try to wrap at
143  * the lower-right corner of a window, we cannot move the cursor (since that
144  * wouldn't be legal).  So we return an error (which is what SVr4 does). 
145  * Unlike SVr4, we can successfully add a character to the lower-right corner
146  * (Solaris 2.6 does this also, however).
147  */
148 static int
149 wrap_to_next_line(WINDOW *win)
150 {
151     win->_flags |= _WRAPPED;
152     if (newline_forces_scroll(win, &(win->_cury))) {
153         win->_curx = win->_maxx;
154         if (!win->_scroll)
155             return (ERR);
156         scroll(win);
157     }
158     win->_curx = 0;
159     return (OK);
160 }
161
162 #if USE_WIDEC_SUPPORT
163 static int waddch_literal(WINDOW *, NCURSES_CH_T);
164 /*
165  * Fill the given number of cells with blanks using the current background
166  * rendition.  This saves/restores the current x-position.
167  */
168 static void
169 fill_cells(WINDOW *win, int count)
170 {
171     NCURSES_CH_T blank = blankchar;
172     int save_x = win->_curx;
173     int save_y = win->_cury;
174
175     while (count-- > 0) {
176         if (waddch_literal(win, blank) == ERR)
177             break;
178     }
179     win->_curx = save_x;
180     win->_cury = save_y;
181 }
182 #endif
183
184 /*
185  * Build up the bytes for a multibyte character, returning the length when
186  * complete (a positive number), -1 for error and -2 for incomplete.
187  */
188 #if USE_WIDEC_SUPPORT
189 NCURSES_EXPORT(int)
190 _nc_build_wch(WINDOW *win, ARG_CH_T ch)
191 {
192     char *buffer = WINDOW_EXT(win, addch_work);
193     int len;
194     int x = win->_curx;
195     int y = win->_cury;
196     mbstate_t state;
197     wchar_t result;
198
199     if ((WINDOW_EXT(win, addch_used) != 0) &&
200         (WINDOW_EXT(win, addch_x) != x ||
201          WINDOW_EXT(win, addch_y) != y)) {
202         /* discard the incomplete multibyte character */
203         WINDOW_EXT(win, addch_used) = 0;
204         TR(TRACE_VIRTPUT,
205            ("Alert discarded multibyte on move (%d,%d) -> (%d,%d)",
206             WINDOW_EXT(win, addch_y), WINDOW_EXT(win, addch_x),
207             y, x));
208     }
209     WINDOW_EXT(win, addch_x) = x;
210     WINDOW_EXT(win, addch_y) = y;
211
212     init_mb(state);
213     buffer[WINDOW_EXT(win, addch_used)] = CharOf(CHDEREF(ch));
214     WINDOW_EXT(win, addch_used) += 1;
215     buffer[WINDOW_EXT(win, addch_used)] = '\0';
216     if ((len = mbrtowc(&result,
217                        buffer,
218                        WINDOW_EXT(win, addch_used), &state)) > 0) {
219         attr_t attrs = AttrOf(CHDEREF(ch));
220         SetChar(CHDEREF(ch), result, attrs);
221         WINDOW_EXT(win, addch_used) = 0;
222     } else {
223         if (len == -1) {
224             /*
225              * An error occurred.  We could either discard everything,
226              * or assume that the error was in the previous input.
227              * Try the latter.
228              */
229             TR(TRACE_VIRTPUT, ("Alert! mbrtowc returns error"));
230             buffer[0] = CharOf(CHDEREF(ch));
231             WINDOW_EXT(win, addch_used) = 1;
232         }
233     }
234     return len;
235 }
236 #endif /* USE_WIDEC_SUPPORT */
237
238 static
239 #if !USE_WIDEC_SUPPORT          /* cannot be inline if it is recursive */
240 NCURSES_INLINE
241 #endif
242 int
243 waddch_literal(WINDOW *win, NCURSES_CH_T ch)
244 {
245     int x;
246     int y;
247     struct ldat *line;
248
249     x = win->_curx;
250     y = win->_cury;
251
252     CHECK_POSITION(win, x, y);
253
254     ch = render_char(win, ch);
255
256     line = win->_line + y;
257
258     CHANGED_CELL(line, x);
259
260     /*
261      * Build up multibyte characters until we have a wide-character.
262      */
263     if_WIDEC({
264         if (WINDOW_EXT(win, addch_used) != 0 || !Charable(ch)) {
265             int len = _nc_build_wch(win, CHREF(ch));
266
267             if (len > 0) {
268                 if (is8bits(CharOf(ch))) {
269                     const char *s = unctrl((chtype) CharOf(ch));
270                     if (s[1] != 0) {
271                         return waddstr(win, s);
272                     }
273                 }
274             } else {
275                 return OK;
276             }
277         }
278     });
279
280     /*
281      * Non-spacing characters are added to the current cell.
282      *
283      * Spacing characters that are wider than one column require some display
284      * adjustments.
285      */
286     if_WIDEC({
287         int len = wcwidth(CharOf(ch));
288         int i;
289         int j;
290
291         if (len == 0) {         /* non-spacing */
292             if ((x > 0 && y >= 0)
293                 || ((y = win->_cury - 1) >= 0 &&
294                     (x = win->_maxx) > 0)) {
295                 wchar_t *chars = (win->_line[y].text[x - 1].chars);
296                 for (i = 0; i < CCHARW_MAX; ++i) {
297                     if (chars[i] == 0) {
298                         TR(TRACE_VIRTPUT,
299                            ("added non-spacing %d: %x",
300                             x, (int) CharOf(ch)));
301                         chars[i] = CharOf(ch);
302                         break;
303                     }
304                 }
305             }
306             goto testwrapping;
307         } else if (len > 1) {   /* multi-column characters */
308             /*
309              * Check if the character will fit on the current line.  If it does
310              * not fit, fill in the remainder of the line with blanks.  and
311              * move to the next line.
312              */
313             if (len > win->_maxx + 1) {
314                 TR(TRACE_VIRTPUT, ("character will not fit"));
315                 return ERR;
316             } else if (x + len > win->_maxx + 1) {
317                 int count = win->_maxx + 1 - x;
318                 TR(TRACE_VIRTPUT, ("fill %d remaining cells", count));
319                 fill_cells(win, count);
320                 if (wrap_to_next_line(win) == ERR)
321                     return ERR;
322                 x = win->_curx;
323                 y = win->_cury;
324             }
325             /*
326              * Check for cells which are orphaned by adding this character, set
327              * those to blanks.
328              *
329              * FIXME: this actually could fill j-i cells, more complicated to
330              * setup though.
331              */
332             for (i = 0; i < len; ++i) {
333                 if (isWidecBase(win->_line[y].text[x + i])) {
334                     break;
335                 } else if (isWidecExt(win->_line[y].text[x + i])) {
336                     for (j = i; x + j <= win->_maxx; ++j) {
337                         if (!isWidecExt(win->_line[y].text[x + j])) {
338                             TR(TRACE_VIRTPUT, ("fill %d orphan cells", j));
339                             fill_cells(win, j);
340                             break;
341                         }
342                     }
343                     break;
344                 }
345             }
346             /*
347              * Finally, add the cells for this character.
348              */
349             for (i = 0; i < len; ++i) {
350                 NCURSES_CH_T value = ch;
351                 SetWidecExt(value, i);
352                 TR(TRACE_VIRTPUT, ("multicolumn %d:%d (%d,%d)",
353                                    i + 1, len,
354                                    win->_begy + y, win->_begx + x));
355                 line->text[x] = value;
356                 CHANGED_CELL(line, x);
357                 ++x;
358             }
359             goto testwrapping;
360         }
361     });
362
363     /*
364      * Single-column characters.
365      */
366     line->text[x++] = ch;
367     /*
368      * This label is used only for wide-characters.
369      */
370     if_WIDEC(
371   testwrapping:
372     );
373
374     TR(TRACE_VIRTPUT, ("cell (%ld, %ld..%d) = %s",
375                        (long) win->_cury, (long) win->_curx, x - 1,
376                        _tracech_t(CHREF(ch))));
377
378     if (x > win->_maxx) {
379         return wrap_to_next_line(win);
380     }
381     win->_curx = x;
382     return OK;
383 }
384
385 static NCURSES_INLINE int
386 waddch_nosync(WINDOW *win, const NCURSES_CH_T ch)
387 /* the workhorse function -- add a character to the given window */
388 {
389     NCURSES_SIZE_T x, y;
390     chtype t = CharOf(ch);
391     const char *s = unctrl(t);
392
393     /*
394      * If we are using the alternate character set, forget about locale.
395      * Otherwise, if unctrl() returns a single-character or the locale
396      * claims the code is printable, treat it that way.
397      */
398     if ((AttrOf(ch) & A_ALTCHARSET)
399         || (
400 #if USE_WIDEC_SUPPORT
401                (SP != 0 && SP->_legacy_coding) &&
402 #endif
403                s[1] == 0
404         )
405         || (
406                isprint(t)
407 #if USE_WIDEC_SUPPORT
408                || ((SP == 0 || !SP->_legacy_coding) &&
409                    (WINDOW_EXT(win, addch_used)
410                     || !_nc_is_charable(CharOf(ch))))
411 #endif
412         ))
413         return waddch_literal(win, ch);
414
415     /*
416      * Handle carriage control and other codes that are not printable, or are
417      * known to expand to more than one character according to unctrl().
418      */
419     x = win->_curx;
420     y = win->_cury;
421
422     switch (t) {
423     case '\t':
424         x += (TABSIZE - (x % TABSIZE));
425
426         /*
427          * Space-fill the tab on the bottom line so that we'll get the
428          * "correct" cursor position.
429          */
430         if ((!win->_scroll && (y == win->_regbottom))
431             || (x <= win->_maxx)) {
432             NCURSES_CH_T blank = blankchar;
433             AddAttr(blank, AttrOf(ch));
434             while (win->_curx < x) {
435                 if (waddch_literal(win, blank) == ERR)
436                     return (ERR);
437             }
438             break;
439         } else {
440             wclrtoeol(win);
441             win->_flags |= _WRAPPED;
442             if (newline_forces_scroll(win, &y)) {
443                 x = win->_maxx;
444                 if (win->_scroll) {
445                     scroll(win);
446                     x = 0;
447                 }
448             } else {
449                 x = 0;
450             }
451         }
452         break;
453     case '\n':
454         wclrtoeol(win);
455         if (newline_forces_scroll(win, &y)) {
456             if (win->_scroll)
457                 scroll(win);
458             else
459                 return (ERR);
460         }
461         /* FALLTHRU */
462     case '\r':
463         x = 0;
464         win->_flags &= ~_WRAPPED;
465         break;
466     case '\b':
467         if (x == 0)
468             return (OK);
469         x--;
470         win->_flags &= ~_WRAPPED;
471         break;
472     default:
473         while (*s) {
474             NCURSES_CH_T sch;
475             SetChar(sch, *s++, AttrOf(ch));
476             if (waddch_literal(win, sch) == ERR)
477                 return ERR;
478         }
479         return (OK);
480     }
481
482     win->_curx = x;
483     win->_cury = y;
484
485     return (OK);
486 }
487
488 NCURSES_EXPORT(int)
489 _nc_waddch_nosync(WINDOW *win, const NCURSES_CH_T c)
490 /* export copy of waddch_nosync() so the string-put functions can use it */
491 {
492     return (waddch_nosync(win, c));
493 }
494
495 /*
496  * The versions below call _nc_synchook().  We wanted to avoid this in the
497  * version exported for string puts; they'll call _nc_synchook once at end
498  * of run.
499  */
500
501 /* These are actual entry points */
502
503 NCURSES_EXPORT(int)
504 waddch(WINDOW *win, const chtype ch)
505 {
506     int code = ERR;
507     NCURSES_CH_T wch;
508     SetChar2(wch, ch);
509
510     TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_CALLED("waddch(%p, %s)"), win,
511                                       _tracechtype(ch)));
512
513     if (win && (waddch_nosync(win, wch) != ERR)) {
514         _nc_synchook(win);
515         code = OK;
516     }
517
518     TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_RETURN("%d"), code));
519     return (code);
520 }
521
522 NCURSES_EXPORT(int)
523 wechochar(WINDOW *win, const chtype ch)
524 {
525     int code = ERR;
526     NCURSES_CH_T wch;
527     SetChar2(wch, ch);
528
529     TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_CALLED("wechochar(%p, %s)"), win,
530                                       _tracechtype(ch)));
531
532     if (win && (waddch_nosync(win, wch) != ERR)) {
533         bool save_immed = win->_immed;
534         win->_immed = TRUE;
535         _nc_synchook(win);
536         win->_immed = save_immed;
537         code = OK;
538     }
539     TR(TRACE_VIRTPUT | TRACE_CCALLS, (T_RETURN("%d"), code));
540     return (code);
541 }