xref: /freebsd/contrib/ncurses/ncurses/base/lib_addstr.c (revision 21817992b3314c908ab50f0bb88d2ee750b9c4ac)
1 /****************************************************************************
2  * Copyright 2019-2022,2023 Thomas E. Dickey                                *
3  * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29 
30 /****************************************************************************
31  *  Author: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *                                                                          *
34  *  Rewritten 2001-2004 to support wide-characters by                       *
35  *	Sven Verdoolaege                                                    *
36  *	Thomas Dickey                                                       *
37  ****************************************************************************/
38 
39 /*
40 **	lib_addstr.c
41 *
42 **	The routines waddnstr(), waddchnstr().
43 **
44 */
45 
46 #include <curses.priv.h>
47 
48 MODULE_ID("$Id: lib_addstr.c,v 1.62 2023/11/21 21:47:23 tom Exp $")
49 
NCURSES_EXPORT(int)50 NCURSES_EXPORT(int)
51 waddnstr(WINDOW *win, const char *astr, int n)
52 {
53     const char *str = astr;
54     int code = ERR;
55 
56     T((T_CALLED("waddnstr(%p,%s,%d)"), (void *) win, _nc_visbufn(astr, n), n));
57 
58     if (win && (str != 0) && (n != 0)) {
59 	bool explicit = (n > 0);
60 
61 	TR(TRACE_VIRTPUT | TRACE_ATTRS,
62 	   ("... current %s", _traceattr(WINDOW_ATTRS(win))));
63 	code = OK;
64 
65 	TR(TRACE_VIRTPUT, ("str is not null, length = %d",
66 			   (explicit ? n : (int) strlen(str))));
67 	if (!explicit)
68 	    n = INT_MAX;
69 	while ((n-- > 0) && (*str != '\0')) {
70 	    NCURSES_CH_T ch;
71 	    TR(TRACE_VIRTPUT, ("*str = %#o", UChar(*str)));
72 	    SetChar(ch, UChar(*str++), A_NORMAL);
73 	    if (_nc_waddch_nosync(win, ch) == ERR) {
74 		code = ERR;
75 		break;
76 	    }
77 	}
78 	_nc_synchook(win);
79     }
80     TR(TRACE_VIRTPUT, ("waddnstr returns %d", code));
81     returnCode(code);
82 }
83 
84 NCURSES_EXPORT(int)
waddchnstr(WINDOW * win,const chtype * astr,int n)85 waddchnstr(WINDOW *win, const chtype *astr, int n)
86 {
87     NCURSES_SIZE_T y, x;
88     int code = OK;
89     int i;
90     struct ldat *line;
91 
92     T((T_CALLED("waddchnstr(%p,%p,%d)"), (void *) win, (const void *) astr, n));
93 
94     if (!win || !astr)
95 	returnCode(ERR);
96 
97     y = win->_cury;
98     x = win->_curx;
99     if (n < 0) {
100 	const chtype *str;
101 	n = 0;
102 	for (str = (const chtype *) astr; *str != 0; str++)
103 	    n++;
104     }
105     if (n > win->_maxx - x + 1)
106 	n = win->_maxx - x + 1;
107     if (n == 0)
108 	returnCode(code);
109 
110     line = &(win->_line[y]);
111     for (i = 0; i < n && ChCharOf(astr[i]) != '\0'; ++i) {
112 	SetChar2(line->text[i + x], astr[i]);
113     }
114     CHANGED_RANGE(line, x, (NCURSES_SIZE_T) (x + n - 1));
115 
116     _nc_synchook(win);
117     returnCode(code);
118 }
119 
120 #if USE_WIDEC_SUPPORT
121 
122 NCURSES_EXPORT(int)
_nc_wchstrlen(const cchar_t * s)123 _nc_wchstrlen(const cchar_t *s)
124 {
125     int result = 0;
126     if (s != 0) {
127 	while (CharOf(s[result]) != L'\0') {
128 	    result++;
129 	}
130     }
131     return result;
132 }
133 
134 NCURSES_EXPORT(int)
wadd_wchnstr(WINDOW * win,const cchar_t * astr,int n)135 wadd_wchnstr(WINDOW *win, const cchar_t *astr, int n)
136 {
137     static const NCURSES_CH_T blank = NewChar(BLANK_TEXT);
138     NCURSES_SIZE_T y;
139     NCURSES_SIZE_T x;
140     int code = OK;
141     struct ldat *line;
142     int i, j, start, len, end;
143 
144     T((T_CALLED("wadd_wchnstr(%p,%s,%d)"),
145        (void *) win,
146        _nc_viscbuf(astr, n),
147        n));
148 
149     if (!win || !astr)
150 	returnCode(ERR);
151 
152     y = win->_cury;
153     x = win->_curx;
154     if (n < 0) {
155 	n = _nc_wchstrlen(astr);
156     }
157     if (n > win->_maxx - x + 1)
158 	n = win->_maxx - x + 1;
159     if (n == 0)
160 	returnCode(code);
161 
162     line = &(win->_line[y]);
163     start = x;
164     end = x + n - 1;
165 
166     /*
167      * Reset orphaned cells of multi-column characters that extend up to the
168      * new string's location to blanks.
169      */
170     if (x > 0 && isWidecExt(line->text[x])) {
171 	for (i = 0; i <= x; ++i) {
172 	    if (!isWidecExt(line->text[x - i])) {
173 		/* must be isWidecBase() */
174 		start -= i;
175 		while (i > 0) {
176 		    line->text[x - i--] = _nc_render(win, blank);
177 		}
178 		break;
179 	    }
180 	}
181     }
182 
183     /*
184      * Copy the new string to the window.
185      */
186     for (i = 0; i < n && CharOf(astr[i]) != L'\0' && x <= win->_maxx; ++i) {
187 	if (isWidecExt(astr[i]))
188 	    continue;
189 
190 	len = _nc_wacs_width(CharOf(astr[i]));
191 
192 	if (x + len - 1 <= win->_maxx) {
193 	    line->text[x] = _nc_render(win, astr[i]);
194 	    if (len > 1) {
195 		for (j = 0; j < len; ++j) {
196 		    if (j != 0) {
197 			line->text[x + j] = line->text[x];
198 		    }
199 		    SetWidecExt(line->text[x + j], j);
200 		}
201 	    } else {
202 		len = 1;
203 	    }
204 	    x = (NCURSES_SIZE_T) (x + len);
205 	    end += len - 1;
206 	} else {
207 	    break;
208 	}
209     }
210 
211     /*
212      * Set orphaned cells of multi-column characters which lie after the new
213      * string to blanks.
214      */
215     while (x <= win->_maxx && isWidecExt(line->text[x])) {
216 	line->text[x] = _nc_render(win, blank);
217 	++end;
218 	++x;
219     }
220     CHANGED_RANGE(line, start, end);
221 
222     _nc_synchook(win);
223     returnCode(code);
224 }
225 
226 NCURSES_EXPORT(int)
waddnwstr(WINDOW * win,const wchar_t * str,int n)227 waddnwstr(WINDOW *win, const wchar_t *str, int n)
228 {
229     int code = ERR;
230 
231     T((T_CALLED("waddnwstr(%p,%s,%d)"), (void *) win, _nc_viswbufn(str, n), n));
232 
233     if (win && (str != 0) && (n != 0)) {
234 	bool explicit = (n > 0);
235 
236 	TR(TRACE_VIRTPUT | TRACE_ATTRS,
237 	   ("... current %s", _traceattr(WINDOW_ATTRS(win))));
238 	code = OK;
239 
240 	TR(TRACE_VIRTPUT, ("str is not null, length = %d",
241 			   (explicit ? n : (int) wcslen(str))));
242 	if (!explicit)
243 	    n = INT_MAX;
244 	while ((n-- > 0) && (*str != L('\0'))) {
245 	    NCURSES_CH_T ch;
246 	    TR(TRACE_VIRTPUT, ("*str[0] = %#lx", (unsigned long) *str));
247 	    SetChar(ch, *str++, A_NORMAL);
248 	    if (wadd_wch(win, &ch) == ERR) {
249 		code = ERR;
250 		break;
251 	    }
252 	}
253 	_nc_synchook(win);
254     }
255     TR(TRACE_VIRTPUT, ("waddnwstr returns %d", code));
256     returnCode(code);
257 }
258 
259 #endif
260