1 .\"***************************************************************************
2 .\" Copyright (c) 2000-2009,2010 Free Software Foundation, Inc. *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a *
5 .\" copy of this software and associated documentation files (the *
6 .\" "Software"), to deal in the Software without restriction, including *
7 .\" without limitation the rights to use, copy, modify, merge, publish, *
8 .\" distribute, distribute with modifications, sublicense, and/or sell *
9 .\" copies of the Software, and to permit persons to whom the Software is *
10 .\" furnished to do so, subject to the following conditions: *
12 .\" The above copyright notice and this permission notice shall be included *
13 .\" in all copies or substantial portions of the Software. *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
23 .\" Except as contained in this notice, the name(s) of the above copyright *
24 .\" holders shall not be used in advertising or otherwise to promote the *
25 .\" sale, use or other dealings in this Software without prior written *
27 .\"***************************************************************************
29 .\" $Id: curs_trace.3x,v 1.12 2010/12/04 18:40:45 tom Exp $
45 \fBtrace\fR \- \fBcurses\fR debugging routines
49 \fB#include <curses.h>\fR
51 \fBvoid _tracef(const char *format, ...);\fR
53 \fBvoid _tracedump(const char *label, WINDOW *win);\fR
55 \fBchar *_traceattr(attr_t attr);\fR
57 \fBchar *_traceattr2(int buffer, chtype ch);\fR
59 \fBchar *_nc_tracebits(void);\fR
61 \fBchar * _tracecchar_t(const cchar_t *string);\fR
63 \fBchar * _tracecchar_t2(int buffer, const cchar_t *string);\fR
65 \fBchar *_tracechar(int ch);\fR
67 \fBchar *_tracechtype(chtype ch);\fR
69 \fBchar *_tracechtype2(int buffer, chtype ch);\fR
71 \fBchar *_tracemouse(const MEVENT *event);\fR
73 \fBvoid trace(const unsigned int param);\fR
75 The \fBtrace\fR routines are used for debugging the ncurses libraries,
76 as well as applications which use the ncurses libraries.
77 These functions are normally available only with the debugging library
78 \fIlibncurses_g.a\fR, but may be compiled into any model (shared, static,
79 profile) by defining the symbol \fBTRACE\fR.
80 Additionally, some functions are only available with the wide-character
81 configuration of the libraries.
83 The principal parts of this interface are the \fBtrace\fR routine which
84 selectively enables different tracing features, and the \fB_tracef\fR
85 routine which writes formatted data to the \fItrace\fR file.
87 Calling \fBtrace\fR with a nonzero parameter opens the file \fBtrace\fR
88 in the current directory for output. The parameter is formed by OR'ing
89 values from the list of \fBTRACE_\fP\fIxxx\fR definitions in \fB<curses.h>\fR.
96 trace user and system times of updates.
102 trace update actions, old & new screens.
105 trace cursor movement and scrolling.
108 trace all character outputs.
111 trace all update actions.
112 The old and new screen contents are written to the trace file
116 trace all curses calls.
117 The parameters for each call are traced, as well as return values.
120 trace virtual character puts, i.e., calls to \fBaddch\fR.
123 trace low-level input processing, including timeouts.
126 trace state of TTY control bits.
129 trace internal/nested calls.
132 trace per-character calls.
135 trace read/write of terminfo/termcap data.
138 trace changes to video attributes and colors.
141 maximum trace level, enables all of the separate trace features.
143 Some tracing features are enabled whenever the \fBtrace\fR parameter
144 is nonzero. Some features overlap.
145 The specific names are used as a guideline.
147 These functions check the \fBNCURSES_TRACE\fP environment variable,
148 to set the tracing feature as if \fBtrace\fP was called:
162 Routines which return a value are designed to be used as parameters
163 to the \fB_tracef\fR routine.
165 These functions are not part of the XSI interface.
166 Some other curses implementations are known to
167 have similar, undocumented features,
168 but they are not compatible with ncurses.