1 /****************************************************************************
2 * Copyright 2019-2021,2023 Thomas E. Dickey *
3 * Copyright 2001-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: Thomas E. Dickey 1996-on *
32 * and: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995 *
33 * and: Eric S. Raymond <esr@snark.thyrsus.com> *
34 ****************************************************************************/
35
36 /*
37 * visbuf.c - Tracing/Debugging support routines
38 */
39
40 #define NEED_NCURSES_CH_T
41 #include <curses.priv.h>
42
43 #include <tic.h>
44 #include <ctype.h>
45
46 MODULE_ID("$Id: visbuf.c,v 1.54 2023/05/27 20:13:10 tom Exp $")
47
48 #define NUM_VISBUFS 4
49
50 #define NormalLen(len) (size_t) (((size_t)(len) + 1) * 4)
51 #define WideLen(len) (size_t) (((size_t)(len) + 1) * 4 * (size_t) MB_CUR_MAX)
52
53 #ifdef TRACE
54 static const char d_quote[] = StringOf(D_QUOTE);
55 static const char l_brace[] = StringOf(L_BRACE);
56 static const char r_brace[] = StringOf(R_BRACE);
57 #endif
58
59 #if USE_STRING_HACKS && HAVE_SNPRINTF
60 #define VisChar(tp, chr, limit) _nc_vischar(tp, chr, limit)
61 #define LIMIT_ARG ,size_t limit
62 #else
63 #define VisChar(tp, chr, limit) _nc_vischar(tp, chr)
64 #define LIMIT_ARG /* nothing */
65 #endif
66
67 static char *
_nc_vischar(char * tp,unsigned c LIMIT_ARG)68 _nc_vischar(char *tp, unsigned c LIMIT_ARG)
69 {
70 if (tp == NULL) {
71 return NULL;
72 } else if (c == '"' || c == '\\') {
73 *tp++ = '\\';
74 *tp++ = (char) c;
75 } else if (is7bits((int) c) && (isgraph((int) c) || c == ' ')) {
76 *tp++ = (char) c;
77 } else if (c == '\n') {
78 *tp++ = '\\';
79 *tp++ = 'n';
80 } else if (c == '\r') {
81 *tp++ = '\\';
82 *tp++ = 'r';
83 } else if (c == '\b') {
84 *tp++ = '\\';
85 *tp++ = 'b';
86 } else if (c == '\t') {
87 *tp++ = '\\';
88 *tp++ = 't';
89 } else if (c == '\033') {
90 *tp++ = '\\';
91 *tp++ = 'e';
92 } else if (UChar(c) == 0x7f) {
93 *tp++ = '\\';
94 *tp++ = '^';
95 *tp++ = '?';
96 } else if (is7bits(c) && iscntrl(UChar(c))) {
97 *tp++ = '\\';
98 *tp++ = '^';
99 *tp++ = (char) ('@' + c);
100 } else {
101 _nc_SPRINTF(tp, _nc_SLIMIT(limit)
102 "\\%03lo", (unsigned long) ChCharOf(c));
103 tp += strlen(tp);
104 }
105 *tp = 0;
106 return tp;
107 }
108
109 static const char *
_nc_visbuf2n(int bufnum,const char * buf,int len)110 _nc_visbuf2n(int bufnum, const char *buf, int len)
111 {
112 const char *vbuf = 0;
113 char *tp;
114 int count;
115
116 if (buf == 0)
117 return ("(null)");
118 if (buf == CANCELLED_STRING)
119 return ("(cancelled)");
120
121 if (len < 0)
122 len = (int) strlen(buf);
123
124 count = len;
125 #ifdef TRACE
126 vbuf = tp = _nc_trace_buf(bufnum, NormalLen(len));
127 #else
128 {
129 static char *mybuf[NUM_VISBUFS];
130 int c;
131
132 if (bufnum < 0) {
133 for (c = 0; c < NUM_VISBUFS; ++c) {
134 FreeAndNull(mybuf[c]);
135 }
136 tp = 0;
137 } else {
138 mybuf[bufnum] = typeRealloc(char, NormalLen(len), mybuf[bufnum]);
139 vbuf = tp = mybuf[bufnum];
140 }
141 }
142 #endif
143 if (tp != 0) {
144 int c;
145
146 *tp++ = D_QUOTE;
147 while ((--count >= 0) && (c = *buf++) != '\0') {
148 tp = VisChar(tp, UChar(c), NormalLen(len));
149 }
150 *tp++ = D_QUOTE;
151 *tp = '\0';
152 } else {
153 vbuf = ("(_nc_visbuf2n failed)");
154 }
155 return (vbuf);
156 }
157
158 NCURSES_EXPORT(const char *)
_nc_visbuf2(int bufnum,const char * buf)159 _nc_visbuf2(int bufnum, const char *buf)
160 {
161 return _nc_visbuf2n(bufnum, buf, -1);
162 }
163
164 NCURSES_EXPORT(const char *)
_nc_visbuf(const char * buf)165 _nc_visbuf(const char *buf)
166 {
167 return _nc_visbuf2(0, buf);
168 }
169
170 NCURSES_EXPORT(const char *)
_nc_visbufn(const char * buf,int len)171 _nc_visbufn(const char *buf, int len)
172 {
173 return _nc_visbuf2n(0, buf, len);
174 }
175
176 #ifdef TRACE
177 #if USE_WIDEC_SUPPORT
178
179 #if defined(USE_TERMLIB)
180 #define _nc_wchstrlen _my_wchstrlen
181 static int
_nc_wchstrlen(const cchar_t * s)182 _nc_wchstrlen(const cchar_t *s)
183 {
184 int result = 0;
185 while (CharOf(s[result]) != L'\0') {
186 result++;
187 }
188 return result;
189 }
190 #endif
191
192 static const char *
_nc_viswbuf2n(int bufnum,const wchar_t * buf,int len)193 _nc_viswbuf2n(int bufnum, const wchar_t *buf, int len)
194 {
195 const char *vbuf;
196 char *tp;
197 int count;
198
199 if (buf == 0)
200 return ("(null)");
201
202 if (len < 0)
203 len = (int) wcslen(buf);
204
205 count = len;
206 #ifdef TRACE
207 vbuf = tp = _nc_trace_buf(bufnum, WideLen(len));
208 #else
209 {
210 static char *mybuf[NUM_VISBUFS];
211 mybuf[bufnum] = typeRealloc(char, WideLen(len), mybuf[bufnum]);
212 vbuf = tp = mybuf[bufnum];
213 }
214 #endif
215 if (tp != 0) {
216 wchar_t c;
217
218 *tp++ = D_QUOTE;
219 while ((--count >= 0) && (c = *buf++) != '\0') {
220 char temp[CCHARW_MAX + 80];
221 int j = wctomb(temp, c), k;
222 if (j <= 0) {
223 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
224 "\\u%08X", (unsigned) c);
225 j = (int) strlen(temp);
226 }
227 for (k = 0; k < j; ++k) {
228 tp = VisChar(tp, UChar(temp[k]), WideLen(len));
229 }
230 }
231 *tp++ = D_QUOTE;
232 *tp = '\0';
233 } else {
234 vbuf = ("(_nc_viswbuf2n failed)");
235 }
236 return (vbuf);
237 }
238
239 NCURSES_EXPORT(const char *)
_nc_viswbuf2(int bufnum,const wchar_t * buf)240 _nc_viswbuf2(int bufnum, const wchar_t *buf)
241 {
242 return _nc_viswbuf2n(bufnum, buf, -1);
243 }
244
245 NCURSES_EXPORT(const char *)
_nc_viswbuf(const wchar_t * buf)246 _nc_viswbuf(const wchar_t *buf)
247 {
248 return _nc_viswbuf2(0, buf);
249 }
250
251 NCURSES_EXPORT(const char *)
_nc_viswbufn(const wchar_t * buf,int len)252 _nc_viswbufn(const wchar_t *buf, int len)
253 {
254 return _nc_viswbuf2n(0, buf, len);
255 }
256
257 /* this special case is used for wget_wstr() */
258 NCURSES_EXPORT(const char *)
_nc_viswibuf(const wint_t * buf)259 _nc_viswibuf(const wint_t *buf)
260 {
261 static wchar_t *mybuf;
262 static unsigned mylen;
263 unsigned n;
264
265 for (n = 0; buf[n] != 0; ++n) {
266 ; /* empty */
267 }
268 if (mylen < ++n) {
269 mylen = n + 80;
270 if (mybuf != 0)
271 mybuf = typeRealloc(wchar_t, mylen, mybuf);
272 else
273 mybuf = typeMalloc(wchar_t, mylen);
274 }
275 if (mybuf != 0) {
276 for (n = 0; buf[n] != 0; ++n) {
277 mybuf[n] = (wchar_t) buf[n];
278 }
279 mybuf[n] = L'\0';
280 }
281
282 return _nc_viswbuf2(0, mybuf);
283 }
284 #endif /* USE_WIDEC_SUPPORT */
285
286 /* use these functions for displaying parts of a line within a window */
287 NCURSES_EXPORT(const char *)
_nc_viscbuf2(int bufnum,const NCURSES_CH_T * buf,int len)288 _nc_viscbuf2(int bufnum, const NCURSES_CH_T *buf, int len)
289 {
290 char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
291
292 if (result != 0) {
293 int first = 0;
294
295 #if USE_WIDEC_SUPPORT
296 if (len < 0)
297 len = _nc_wchstrlen(buf);
298 #endif /* USE_WIDEC_SUPPORT */
299
300 /*
301 * Display one or more strings followed by attributes.
302 */
303 while (first < len) {
304 attr_t attr = AttrOf(buf[first]);
305 int last = len - 1;
306 int j;
307
308 for (j = first + 1; j < len; ++j) {
309 if (!SameAttrOf(buf[j], buf[first])) {
310 last = j - 1;
311 break;
312 }
313 }
314
315 (void) _nc_trace_bufcat(bufnum, l_brace);
316 (void) _nc_trace_bufcat(bufnum, d_quote);
317 for (j = first; j <= last; ++j) {
318 const char *found = _nc_altcharset_name(attr, (chtype)
319 CharOf(buf[j]));
320 if (found != 0) {
321 (void) _nc_trace_bufcat(bufnum, found);
322 attr &= ~A_ALTCHARSET;
323 } else
324 #if USE_WIDEC_SUPPORT
325 if (!isWidecExt(buf[j])) {
326 PUTC_DATA;
327
328 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {
329 int k;
330 char temp[80];
331
332 PUTC_ch = buf[j].chars[PUTC_i];
333 if (PUTC_ch == L'\0') {
334 if (PUTC_i == 0)
335 (void) _nc_trace_bufcat(bufnum, "\\000");
336 break;
337 }
338 PUTC_INIT;
339 PUTC_n = (int) wcrtomb(PUTC_buf,
340 buf[j].chars[PUTC_i], &PUT_st);
341 if (PUTC_n <= 0 || buf[j].chars[PUTC_i] > 255) {
342 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
343 "{%d:\\u%lx}",
344 _nc_wacs_width(buf[j].chars[PUTC_i]),
345 (unsigned long) buf[j].chars[PUTC_i]);
346 (void) _nc_trace_bufcat(bufnum, temp);
347 break;
348 }
349 for (k = 0; k < PUTC_n; k++) {
350 VisChar(temp, UChar(PUTC_buf[k]), sizeof(temp));
351 (void) _nc_trace_bufcat(bufnum, temp);
352 }
353 }
354 }
355 #else
356 {
357 char temp[80];
358 VisChar(temp, UChar(buf[j]), sizeof(temp));
359 (void) _nc_trace_bufcat(bufnum, temp);
360 }
361 #endif /* USE_WIDEC_SUPPORT */
362 }
363 (void) _nc_trace_bufcat(bufnum, d_quote);
364 if (attr != A_NORMAL) {
365 (void) _nc_trace_bufcat(bufnum, " | ");
366 (void) _nc_trace_bufcat(bufnum, _traceattr2(bufnum + 20, attr));
367 }
368 result = _nc_trace_bufcat(bufnum, r_brace);
369 first = last + 1;
370 }
371 }
372 return result;
373 }
374
375 NCURSES_EXPORT(const char *)
_nc_viscbuf(const NCURSES_CH_T * buf,int len)376 _nc_viscbuf(const NCURSES_CH_T *buf, int len)
377 {
378 return _nc_viscbuf2(0, buf, len);
379 }
380 #endif /* TRACE */
381