***************************************************************************
Copyright (c) 2000-2009,2010 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_trace.3x,v 1.12 2010/12/04 18:40:45 tom Exp $
_tracef, _tracedump, _traceattr, _traceattr2, _nc_tracebits, _tracecchar_t, _tracecchar_t2, _tracechar, _tracechtype, _tracechtype2, _tracemouse, trace - curses debugging routines #include <curses.h> void _tracef(const char *format, ...);

void _tracedump(const char *label, WINDOW *win);

char *_traceattr(attr_t attr);

char *_traceattr2(int buffer, chtype ch);

char *_nc_tracebits(void);

char * _tracecchar_t(const cchar_t *string);

char * _tracecchar_t2(int buffer, const cchar_t *string);

char *_tracechar(int ch);

char *_tracechtype(chtype ch);

char *_tracechtype2(int buffer, chtype ch);

char *_tracemouse(const MEVENT *event);

void trace(const unsigned int param);

The trace routines are used for debugging the ncurses libraries, as well as applications which use the ncurses libraries. These functions are normally available only with the debugging library libncurses_g.a, but may be compiled into any model (shared, static, profile) by defining the symbol TRACE. Additionally, some functions are only available with the wide-character configuration of the libraries.

The principal parts of this interface are the trace routine which selectively enables different tracing features, and the _tracef routine which writes formatted data to the trace file.

Calling trace with a nonzero parameter opens the file trace in the current directory for output. The parameter is formed by OR'ing values from the list of TRACE_xxx definitions in <curses.h>. These include:

5 TRACE_DISABLE turn off tracing.

5 TRACE_TIMES trace user and system times of updates.

5 TRACE_TPUTS trace tputs calls.

5 TRACE_UPDATE trace update actions, old & new screens.

5 TRACE_MOVE trace cursor movement and scrolling.

5 TRACE_CHARPUT trace all character outputs.

5 TRACE_ORDINARY trace all update actions. The old and new screen contents are written to the trace file for each refresh.

5 TRACE_CALLS trace all curses calls. The parameters for each call are traced, as well as return values.

5 TRACE_VIRTPUT trace virtual character puts, i.e., calls to addch.

5 TRACE_IEVENT trace low-level input processing, including timeouts.

5 TRACE_BITS trace state of TTY control bits.

5 TRACE_ICALLS trace internal/nested calls.

5 TRACE_CCALLS trace per-character calls.

5 TRACE_DATABASE trace read/write of terminfo/termcap data.

5 TRACE_ATTRS trace changes to video attributes and colors.

5 TRACE_MAXIMUM maximum trace level, enables all of the separate trace features.

Some tracing features are enabled whenever the trace parameter is nonzero. Some features overlap. The specific names are used as a guideline.

These functions check the NCURSES_TRACE environment variable, to set the tracing feature as if trace was called:

Routines which return a value are designed to be used as parameters to the _tracef routine. These functions are not part of the XSI interface. Some other curses implementations are known to have similar, undocumented features, but they are not compatible with ncurses. curses(3X).