ncurses 6.0 - patch 20170812
[ncurses.git] / doc / html / man / curs_memleaks.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 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   * @Id: curs_memleaks.3x,v 1.5 2017/07/28 00:04:34 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_memleaks 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_memleaks 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>                                            <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>_nc_freeall</STRONG> <STRONG>_nc_free_and_exit</STRONG> <STRONG>_nc_free_tinfo</STRONG> - <STRONG>curses</STRONG> memory-leak
50        checking
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG>
57        <STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int);</STRONG>
58        <STRONG>void</STRONG> <STRONG>_nc_free_tinfo(int);</STRONG>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        These functions are used to simplify analysis of memory  leaks  in  the
63        ncurses library.  They are normally not available; they must be config-
64        ured into the library at build time using the  <STRONG>--disable-leaks</STRONG>  option.
65        That  compiles-in  code  that  frees  memory that normally would not be
66        freed.
67
68        Any implementation of curses must not free the memory associated with a
69        screen, since (even after calling <STRONG>endwin</STRONG>), it must be available for use
70        in the next call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>.  There are also chunks of memory  held
71        for performance reasons.  That makes it hard to analyze curses applica-
72        tions for memory leaks.  When using the specially configured  debugging
73        version  of  the ncurses library, applications can call functions which
74        free those chunks of memory, simplifying  the  process  of  memory-leak
75        checking.
76
77        These functions are named with a "_nc_" prefix because they are not in-
78        tended for use in the non-debugging library:
79
80        <STRONG>_nc_freeall</STRONG>
81             This frees (almost) all of the memory allocated by ncurses.
82
83        <STRONG>_nc_free_and_exit</STRONG>
84             This frees the memory allocated by ncurses (like <STRONG>_nc_freeall</STRONG>), and
85             exits the program.  It is preferred over <STRONG>_nc_freeall</STRONG> since some of
86             that memory may be required to keep the application running.  Sim-
87             ply exiting (with the given exit-code) is safer.
88
89        <STRONG>_nc_free_tinfo</STRONG>
90             Use  this  function  if only the low-level terminfo functions (and
91             corresponding library) are used.  Like <STRONG>_nc_free_and_exit</STRONG>, it exits
92             the program after freeing memory.
93
94
95 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
96        These functions do not return a value.
97
98
99 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
100        These functions are not part of X/Open Curses; nor do other implementa-
101        tions of curses provide a similar feature.
102
103
104 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
105        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
106
107
108
109                                                              <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>
110 </PRE>
111 <div class="nav">
112 <ul>
113 <li><a href="#h2-NAME">NAME</a></li>
114 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
115 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
116 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
117 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
118 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
119 </ul>
120 </div>
121 </BODY>
122 </HTML>