ncurses 6.2 - patch 20201219
[ncurses.git] / man / curs_memleaks.3x
1 .\"***************************************************************************
2 .\" Copyright 2019,2020 Thomas E. Dickey                                     *
3 .\" Copyright 2008-2010,2017 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 .\" $Id: curs_memleaks.3x,v 1.9 2020/06/13 23:35:34 tom Exp $
31 .TH curs_memleaks 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .na
37 .hy 0
38 .SH NAME
39 \fB_nc_freeall\fP,
40 \fB_nc_free_and_exit\fP,
41 \fB_nc_free_tinfo\fP \- \fBcurses\fR memory-leak checking
42 .ad
43 .hy
44 .SH SYNOPSIS
45 \fB#include <curses.h>\fR
46 .sp
47 \fBvoid exit_curses(int);\fR
48 .br
49 \fBvoid exit_terminfo(int);\fR
50 .sp
51 /* deprecated */
52 .br
53 \fBvoid _nc_freeall(void);\fR
54 .br
55 \fBvoid _nc_free_and_exit(int);\fR
56 .br
57 \fBvoid _nc_free_tinfo(int);\fR
58 .SH DESCRIPTION
59 These functions are used to simplify analysis of memory leaks in the ncurses
60 library.
61 .PP
62 Any implementation of curses must not free the memory associated with
63 a screen, since (even after calling \fBendwin\fP(3X)), it must be available
64 for use in the next call to \fBrefresh\fP(3X).
65 There are also chunks of memory held for performance reasons.
66 That makes it hard to analyze curses applications for memory leaks.
67 When using the specially configured debugging version of the ncurses library,
68 applications can call functions which free those chunks of memory,
69 simplifying the process of memory-leak checking.
70 .PP
71 Some of the functions are named with a \*(``_nc_\*('' prefix
72 because they are not intended for use in the non-debugging library:
73 .TP 5
74 \fB_nc_freeall\fP
75 This frees (almost) all of the memory allocated by ncurses.
76 .TP 5
77 \fB_nc_free_and_exit\fP
78 This frees the memory allocated by ncurses (like \fB_nc_freeall\fP),
79 and exits the program.
80 It is preferred over \fB_nc_freeall\fP since some of that memory
81 may be required to keep the application running.
82 Simply exiting (with the given exit-code) is safer.
83 .TP 5
84 \fB_nc_free_tinfo\fP
85 Use this function if only the low-level terminfo functions (and
86 corresponding library) are used.
87 Like \fB_nc_free_and_exit\fP, it exits the program after freeing memory.
88 .PP
89 The functions prefixed \*(``_nc\*('' are normally not available;
90 they must be configured into the library
91 at build time using the \fB\-\-disable-leaks\fP option.
92 That compiles-in code that frees memory that normally would not be freed.
93 .PP
94 The \fBexit_curses\fP and \fBexit_terminfo\fP functions
95 call \fB_nc_free_and_exit\fP and \fB_nc_free_tinfo\fP if
96 the library is configured to support memory-leak checking.
97 If the library is not configured to support memory-leak checking,
98 they simply call \fBexit\fP.
99 .SH RETURN VALUE
100 These functions do not return a value.
101 .SH PORTABILITY
102 These functions are not part of X/Open Curses;
103 nor do other implementations of curses provide a similar feature.
104 .SH SEE ALSO
105 \fBcurses\fR(3X).