1 /****************************************************************************
2 * Copyright 2019-2021,2023 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.54 2023/05/27 20:13:10 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)
72 } else if (c == '"' || c == '\\') {
75 } else if (is7bits((int) c) && (isgraph((int) c) || c == ' ')) {
77 } else if (c == '\n') {
80 } else if (c == '\r') {
83 } else if (c == '\b') {
86 } else if (c == '\t') {
89 } else if (c == '\033') {
92 } else if (UChar(c) == 0x7f) {
96 } else if (is7bits(c) && iscntrl(UChar(c))) {
99 *tp++ = (char) ('@' + c);
101 _nc_SPRINTF(tp, _nc_SLIMIT(limit)
102 "\\%03lo", (unsigned long) ChCharOf(c));
110 _nc_visbuf2n(int bufnum, const char *buf, int len)
112 const char *vbuf = 0;
118 if (buf == CANCELLED_STRING)
119 return ("(cancelled)");
122 len = (int) strlen(buf);
126 vbuf = tp = _nc_trace_buf(bufnum, NormalLen(len));
129 static char *mybuf[NUM_VISBUFS];
133 for (c = 0; c < NUM_VISBUFS; ++c) {
134 FreeAndNull(mybuf[c]);
138 mybuf[bufnum] = typeRealloc(char, NormalLen(len), mybuf[bufnum]);
139 vbuf = tp = mybuf[bufnum];
147 while ((--count >= 0) && (c = *buf++) != '\0') {
148 tp = VisChar(tp, UChar(c), NormalLen(len));
153 vbuf = ("(_nc_visbuf2n failed)");
158 NCURSES_EXPORT(const char *)
159 _nc_visbuf2(int bufnum, const char *buf)
161 return _nc_visbuf2n(bufnum, buf, -1);
164 NCURSES_EXPORT(const char *)
165 _nc_visbuf(const char *buf)
167 return _nc_visbuf2(0, buf);
170 NCURSES_EXPORT(const char *)
171 _nc_visbufn(const char *buf, int len)
173 return _nc_visbuf2n(0, buf, len);
177 #if USE_WIDEC_SUPPORT
179 #if defined(USE_TERMLIB)
180 #define _nc_wchstrlen _my_wchstrlen
182 _nc_wchstrlen(const cchar_t *s)
185 while (CharOf(s[result]) != L'\0') {
193 _nc_viswbuf2n(int bufnum, const wchar_t *buf, int len)
203 len = (int) wcslen(buf);
207 vbuf = tp = _nc_trace_buf(bufnum, WideLen(len));
210 static char *mybuf[NUM_VISBUFS];
211 mybuf[bufnum] = typeRealloc(char, WideLen(len), mybuf[bufnum]);
212 vbuf = tp = mybuf[bufnum];
219 while ((--count >= 0) && (c = *buf++) != '\0') {
220 char temp[CCHARW_MAX + 80];
221 int j = wctomb(temp, c), k;
223 _nc_SPRINTF(temp, _nc_SLIMIT(sizeof(temp))
224 "\\u%08X", (unsigned) c);
225 j = (int) strlen(temp);
227 for (k = 0; k < j; ++k) {
228 tp = VisChar(tp, UChar(temp[k]), WideLen(len));
234 vbuf = ("(_nc_viswbuf2n failed)");
239 NCURSES_EXPORT(const char *)
240 _nc_viswbuf2(int bufnum, const wchar_t *buf)
242 return _nc_viswbuf2n(bufnum, buf, -1);
245 NCURSES_EXPORT(const char *)
246 _nc_viswbuf(const wchar_t *buf)
248 return _nc_viswbuf2(0, buf);
251 NCURSES_EXPORT(const char *)
252 _nc_viswbufn(const wchar_t *buf, int len)
254 return _nc_viswbuf2n(0, buf, len);
257 /* this special case is used for wget_wstr() */
258 NCURSES_EXPORT(const char *)
259 _nc_viswibuf(const wint_t *buf)
261 static wchar_t *mybuf;
262 static unsigned mylen;
265 for (n = 0; buf[n] != 0; ++n) {
271 mybuf = typeRealloc(wchar_t, mylen, mybuf);
273 mybuf = typeMalloc(wchar_t, mylen);
276 for (n = 0; buf[n] != 0; ++n) {
277 mybuf[n] = (wchar_t) buf[n];
282 return _nc_viswbuf2(0, mybuf);
284 #endif /* USE_WIDEC_SUPPORT */
286 /* use these functions for displaying parts of a line within a window */
287 NCURSES_EXPORT(const char *)
288 _nc_viscbuf2(int bufnum, const NCURSES_CH_T *buf, int len)
290 char *result = _nc_trace_buf(bufnum, (size_t) BUFSIZ);
295 #if USE_WIDEC_SUPPORT
297 len = _nc_wchstrlen(buf);
298 #endif /* USE_WIDEC_SUPPORT */
301 * Display one or more strings followed by attributes.
303 while (first < len) {
304 attr_t attr = AttrOf(buf[first]);
308 for (j = first + 1; j < len; ++j) {
309 if (!SameAttrOf(buf[j], buf[first])) {
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)
321 (void) _nc_trace_bufcat(bufnum, found);
322 attr &= ~A_ALTCHARSET;
324 #if USE_WIDEC_SUPPORT
325 if (!isWidecExt(buf[j])) {
328 for (PUTC_i = 0; PUTC_i < CCHARW_MAX; ++PUTC_i) {
332 PUTC_ch = buf[j].chars[PUTC_i];
333 if (PUTC_ch == L'\0') {
335 (void) _nc_trace_bufcat(bufnum, "\\000");
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))
344 _nc_wacs_width(buf[j].chars[PUTC_i]),
345 (unsigned long) buf[j].chars[PUTC_i]);
346 (void) _nc_trace_bufcat(bufnum, temp);
349 for (k = 0; k < PUTC_n; k++) {
350 VisChar(temp, UChar(PUTC_buf[k]), sizeof(temp));
351 (void) _nc_trace_bufcat(bufnum, temp);
358 VisChar(temp, UChar(buf[j]), sizeof(temp));
359 (void) _nc_trace_bufcat(bufnum, temp);
361 #endif /* USE_WIDEC_SUPPORT */
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));
368 result = _nc_trace_bufcat(bufnum, r_brace);
375 NCURSES_EXPORT(const char *)
376 _nc_viscbuf(const NCURSES_CH_T *buf, int len)
378 return _nc_viscbuf2(0, buf, len);