ncurses 6.0 - patch 20170304
[ncurses.git] / ncurses / widechar / lib_cchar.c
1 /****************************************************************************
2  * Copyright (c) 2001-2016,2017 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_cchar.c
31 **
32 **      The routines setcchar() and getcchar().
33 **
34 */
35
36 #include <curses.priv.h>
37
38 MODULE_ID("$Id: lib_cchar.c,v 1.29 2017/03/04 19:56:00 tom Exp $")
39
40 /* 
41  * The SuSv2 description leaves some room for interpretation.  We'll assume wch
42  * points to a string which is L'\0' terminated, contains at least one
43  * character with strictly positive width, which must be the first, and
44  * contains no characters of negative width.
45  */
46 NCURSES_EXPORT(int)
47 setcchar(cchar_t *wcval,
48          const wchar_t *wch,
49          const attr_t attrs,
50          NCURSES_PAIRS_T color_pair,
51          const void *opts)
52 {
53     unsigned len;
54     int code = OK;
55
56     TR(TRACE_CCALLS, (T_CALLED("setcchar(%p,%s,%lu,%d,%p)"),
57                       (void *) wcval, _nc_viswbuf(wch),
58                       (unsigned long) attrs, (int) color_pair, opts));
59
60     if (opts != NULL
61         || wch == NULL
62         || ((len = (unsigned) wcslen(wch)) > 1 && wcwidth(wch[0]) < 0)
63         || color_pair < 0) {
64         code = ERR;
65     } else {
66         unsigned i;
67
68         if (len > CCHARW_MAX)
69             len = CCHARW_MAX;
70
71         /*
72          * If we have a following spacing-character, stop at that point.  We
73          * are only interested in adding non-spacing characters.
74          */
75         for (i = 1; i < len; ++i) {
76             if (wcwidth(wch[i]) != 0) {
77                 len = i;
78                 break;
79             }
80         }
81
82         memset(wcval, 0, sizeof(*wcval));
83
84         if (len != 0) {
85             SetAttr(*wcval, attrs);
86             SetPair(CHDEREF(wcval), color_pair);
87             memcpy(&wcval->chars, wch, len * sizeof(wchar_t));
88             TR(TRACE_CCALLS, ("copy %d wchars, first is %s", len,
89                               _tracecchar_t(wcval)));
90         }
91     }
92
93     TR(TRACE_CCALLS, (T_RETURN("%d"), code));
94     return (code);
95 }
96
97 NCURSES_EXPORT(int)
98 getcchar(const cchar_t *wcval,
99          wchar_t *wch,
100          attr_t *attrs,
101          NCURSES_PAIRS_T *color_pair,
102          void *opts)
103 {
104     int code = ERR;
105
106     TR(TRACE_CCALLS, (T_CALLED("getcchar(%p,%p,%p,%p,%p)"),
107                       (const void *) wcval,
108                       (void *) wch,
109                       (void *) attrs,
110                       (void *) color_pair,
111                       opts));
112
113     if (opts == NULL && wcval != NULL) {
114         wchar_t *wp;
115         int len;
116
117         len = ((wp = wmemchr(wcval->chars, L'\0', (size_t) CCHARW_MAX))
118                ? (int) (wp - wcval->chars)
119                : CCHARW_MAX);
120
121         if (wch == NULL) {
122             /*
123              * If the value is a null, set the length to 1.
124              * If the value is not a null, return the length plus 1 for null.
125              */
126             code = (len < CCHARW_MAX) ? (len + 1) : CCHARW_MAX;
127         } else if (attrs == 0 || color_pair == 0) {
128             code = ERR;
129         } else if (len >= 0) {
130             *attrs = AttrOf(*wcval) & A_ATTRIBUTES;
131             *color_pair = (NCURSES_PAIRS_T) GetPair(*wcval);
132             wmemcpy(wch, wcval->chars, (size_t) len);
133             wch[len] = L'\0';
134             if (*color_pair >= 0)
135                 code = OK;
136         }
137     }
138
139     TR(TRACE_CCALLS, (T_RETURN("%d"), code));
140     return (code);
141 }