1 /****************************************************************************
2 * Copyright 2019-2020,2021 Thomas E. Dickey *
3 * Copyright 2001-2016,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************/
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 ****************************************************************************/
37 * visbuf.c - Tracing/Debugging support routines
40 #define NEED_NCURSES_CH_T
41 #include <curses.priv.h>
46 MODULE_ID("$Id: visbuf.c,v 1.53 2021/02/27 20:07:57 tom Exp $")
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)
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);
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
63 #define VisChar(tp, chr, limit) _nc_vischar(tp, chr)
64 #define LIMIT_ARG /* nothing */
68 _nc_vischar(char *tp, unsigned c LIMIT_ARG)
70 if (c == '"' || c == '\\') {
73 } else if (is7bits((int) c) && (isgraph((int) c) || c == ' ')) {
75 } else if (c == '\n') {
78 } else if (c == '\r') {
81 } else if (c == '\b') {
84 } else if (c == '\t') {
87 } else if (c == '\033') {
90 } else if (UChar(c) == 0x7f) {
94 } else if (is7bits(c) && iscntrl(UChar(c))) {
97 *tp++ = (char) ('@' + c);
99 _nc_SPRINTF(tp, _nc_SLIMIT(limit)
100 "\\%03lo", (unsigned long) ChCharOf(c));
108 _nc_visbuf2n(int bufnum, const char *buf, int len)
110 const char *vbuf = 0;
116 if (buf == CANCELLED_STRING)
117 return ("(cancelled)");
120 len = (int) strlen(buf);
124 vbuf = tp = _nc_trace_buf(bufnum, NormalLen(len));
127 static char *mybuf[NUM_VISBUFS];
131 for (c = 0; c < NUM_VISBUFS; ++c) {
132 FreeAndNull(mybuf[c]);
136 mybuf[bufnum] = typeRealloc(char, NormalLen(len), mybuf[bufnum]);
137 vbuf = tp = mybuf[bufnum];
145 while ((--count >= 0) && (c = *buf++) != '\0') {
146 tp = VisChar(tp, UChar(c), NormalLen(len));
151 vbuf = ("(_nc_visbuf2n failed)");
156 NCURSES_EXPORT(const char *)
157 _nc_visbuf2(int bufnum, const char *buf)
159 return _nc_visbuf2n(bufnum, buf, -1);
162 NCURSES_EXPORT(const char *)
163 _nc_visbuf(const char *buf)
165 return _nc_visbuf2(0, buf);
168 NCURSES_EXPORT(const char *)
169 _nc_visbufn(const char *buf, int len)
171 return _nc_visbuf2n(0, buf, len);
175 #if USE_WIDEC_SUPPORT
177 #if defined(USE_TERMLIB)
178 #define _nc_wchstrlen _my_wchstrlen
180 _nc_wchstrlen(const cchar_t *s)
183 while (CharOf(s[result]) != L'\0') {
191 _nc_viswbuf2n(int bufnum, const wchar_t *buf, int len)
201 len = (int) wcslen(buf);
205 vbuf = tp = _nc_trace_buf(bufnum, WideLen(len));
208 static char *mybuf[NUM_VISBUFS];
209 mybuf[bufnum] = typeRealloc(char, WideLen(len), mybuf[bufnum]);
210 vbuf = tp = mybuf[bufnum];
217 while ((--count >= 0) && (c = *buf++) != '\0') {
218 char temp[CCHARW_MAX + 80];
219 int j = wctomb(temp, c), k;
221 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
222 "\\u%08X", (unsigned) c);
223 j = (int) strlen(temp);
225 for (k = 0; k < j; ++k) {
226 tp = VisChar(tp, UChar(temp[k]), WideLen(len));
232 vbuf = ("(_nc_viswbuf2n failed)");
237 NCURSES_EXPORT(const char *)
238 _nc_viswbuf2(int bufnum, const wchar_t *buf)
240 return _nc_viswbuf2n(bufnum, buf, -1);
243 NCURSES_EXPORT(const char *)
244 _nc_viswbuf(const wchar_t *buf)
246 return _nc_viswbuf2(0, buf);
249 NCURSES_EXPORT(const char *)
250 _nc_viswbufn(const wchar_t *buf, int len)
252 return _nc_viswbuf2n(0, buf, len);
255 /* this special case is used for wget_wstr() */
256 NCURSES_EXPORT(const char *)
257 _nc_viswibuf(const wint_t *buf)
259 static wchar_t *mybuf;
260 static unsigned mylen;
263 for (n = 0; buf[n] != 0; ++n) {
269 mybuf = typeRealloc(wchar_t, mylen, mybuf);
271 mybuf = typeMalloc(wchar_t, mylen);
274 for (n = 0; buf[n] != 0; ++n) {
275 mybuf[n] = (wchar_t) buf[n];
280 return _nc_viswbuf2(0, mybuf);
282 #endif /* USE_WIDEC_SUPPORT */
284 /* use these functions for displaying parts of a line within a window */
285 NCURSES_EXPORT(const char *)
286 _nc_viscbuf2(int bufnum, const NCURSES_CH_T *buf, int len)
288 char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
293 #if USE_WIDEC_SUPPORT
295 len = _nc_wchstrlen(buf);
296 #endif /* USE_WIDEC_SUPPORT */
299 * Display one or more strings followed by attributes.
301 while (first < len) {
302 attr_t attr = AttrOf(buf[first]);
306 for (j = first + 1; j < len; ++j) {
307 if (!SameAttrOf(buf[j], buf[first])) {
313 (void) _nc_trace_bufcat(bufnum, l_brace);
314 (void) _nc_trace_bufcat(bufnum, d_quote);
315 for (j = first; j <= last; ++j) {
316 const char *found = _nc_altcharset_name(attr, (chtype)
319 (void) _nc_trace_bufcat(bufnum, found);
320 attr &= ~A_ALTCHARSET;
322 #if USE_WIDEC_SUPPORT
323 if (!isWidecExt(buf[j])) {
326 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {
330 PUTC_ch = buf[j].chars[PUTC_i];
331 if (PUTC_ch == L'\0') {
333 (void) _nc_trace_bufcat(bufnum, "\\000");
337 PUTC_n = (int) wcrtomb(PUTC_buf,
338 buf[j].chars[PUTC_i], &PUT_st);
339 if (PUTC_n <= 0 || buf[j].chars[PUTC_i] > 255) {
340 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
342 _nc_wacs_width(buf[j].chars[PUTC_i]),
343 (unsigned long) buf[j].chars[PUTC_i]);
344 (void) _nc_trace_bufcat(bufnum, temp);
347 for (k = 0; k < PUTC_n; k++) {
348 VisChar(temp, UChar(PUTC_buf[k]), sizeof(temp));
349 (void) _nc_trace_bufcat(bufnum, temp);
356 VisChar(temp, UChar(buf[j]), sizeof(temp));
357 (void) _nc_trace_bufcat(bufnum, temp);
359 #endif /* USE_WIDEC_SUPPORT */
361 (void) _nc_trace_bufcat(bufnum, d_quote);
362 if (attr != A_NORMAL) {
363 (void) _nc_trace_bufcat(bufnum, " | ");
364 (void) _nc_trace_bufcat(bufnum, _traceattr2(bufnum + 20, attr));
366 result = _nc_trace_bufcat(bufnum, r_brace);
373 NCURSES_EXPORT(const char *)
374 _nc_viscbuf(const NCURSES_CH_T *buf, int len)
376 return _nc_viscbuf2(0, buf, len);