xref: /freebsd/contrib/ncurses/ncurses/trace/lib_tracechr.c (revision 21817992b3314c908ab50f0bb88d2ee750b9c4ac)
1 /****************************************************************************
2  * Copyright 2020,2024 Thomas E. Dickey                                     *
3  * Copyright 1998-2009,2012 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  *     and: Thomas E. Dickey                        1996-on                 *
34  ****************************************************************************/
35 
36 /*
37  *	lib_tracechr.c - Tracing/Debugging routines
38  */
39 #include <curses.priv.h>
40 
41 #include <ctype.h>
42 
43 MODULE_ID("$Id: lib_tracechr.c,v 1.24 2024/02/04 00:11:35 tom Exp $")
44 
45 #ifdef TRACE
46 
47 #define MyBufSize sizeof(_nc_globals.tracechr_buf)
48 
NCURSES_EXPORT(char *)49 NCURSES_EXPORT(char *)
50 _nc_tracechar(SCREEN *sp, int ch)
51 {
52     NCURSES_CONST char *name;
53     char *MyBuffer = ((sp != 0)
54 		      ? sp->tracechr_buf
55 		      : _nc_globals.tracechr_buf);
56 
57     if ((ch > KEY_MIN && !_nc_unicode_locale()) || ch < 0) {
58 	name = safe_keyname(SP_PARM, ch);
59 	if (name == 0 || *name == '\0')
60 	    name = "NULL";
61 	_nc_SPRINTF(MyBuffer, _nc_SLIMIT(MyBufSize)
62 		    "'%.30s' = \\x%02x", name, ch);
63     } else if (!is8bits(ch)
64 	       || (_nc_unicode_locale() && !is7bits(ch))
65 	       || !isprint(UChar(ch))) {
66 	/*
67 	 * workaround for glibc bug:
68 	 * sprintf changes the result from unctrl() to an empty string if it
69 	 * does not correspond to a valid multibyte sequence.
70 	 */
71 	_nc_SPRINTF(MyBuffer, _nc_SLIMIT(MyBufSize)
72 		    "\\x%02x", ch);
73     } else {
74 	name = safe_unctrl(SP_PARM, (chtype) ch);
75 	if (name == 0 || *name == 0)
76 	    name = "null";	/* shouldn't happen */
77 	_nc_SPRINTF(MyBuffer, _nc_SLIMIT(MyBufSize)
78 		    "'%.30s' = \\x%02x", name, ch);
79     }
80     return (MyBuffer);
81 }
82 
83 NCURSES_EXPORT(char *)
_tracechar(int ch)84 _tracechar(int ch)
85 {
86     return _nc_tracechar(CURRENT_SCREEN, ch);
87 }
88 #else
89 EMPTY_MODULE(_nc_lib_tracechr)
90 #endif
91