ncurses 6.2 - patch 20200212
[ncurses.git] / ncurses / trace / lib_tracechr.c
1 /****************************************************************************
2  * Copyright 2020 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.23 2020/02/02 23:34:34 tom Exp $")
44
45 #ifdef TRACE
46
47 #define MyBufSize sizeof(_nc_globals.tracechr_buf)
48
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 || 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' = %#03o", name, ch);
63     } else if (!is8bits(ch) || !isprint(UChar(ch))) {
64         /*
65          * workaround for glibc bug:
66          * sprintf changes the result from unctrl() to an empty string if it
67          * does not correspond to a valid multibyte sequence.
68          */
69         _nc_SPRINTF(MyBuffer, _nc_SLIMIT(MyBufSize)
70                     "%#03o", ch);
71     } else {
72         name = safe_unctrl(SP_PARM, (chtype) ch);
73         if (name == 0 || *name == 0)
74             name = "null";      /* shouldn't happen */
75         _nc_SPRINTF(MyBuffer, _nc_SLIMIT(MyBufSize)
76                     "'%.30s' = %#03o", name, ch);
77     }
78     return (MyBuffer);
79 }
80
81 NCURSES_EXPORT(char *)
82 _tracechar(int ch)
83 {
84     return _nc_tracechar(CURRENT_SCREEN, ch);
85 }
86 #else
87 EMPTY_MODULE(_nc_lib_tracechr)
88 #endif