* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_memleaks.3x,v 1.4 2017/01/07 19:25:15 tom Exp @
+ * @Id: curs_memleaks.3x,v 1.6 2017/08/22 08:35:37 Sven.Joachim Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
-<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>curs_memleaks 3x</TITLE>
<link rev=made href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>_nc_freeall</STRONG> <STRONG>_nc_free_and_exit</STRONG> - <STRONG>curses</STRONG> memory-leak checking
+ <STRONG>_nc_freeall</STRONG>, <STRONG>_nc_free_and_exit</STRONG>, <STRONG>_nc_free_tinfo</STRONG> - <STRONG>curses</STRONG> memory-leak
+ checking
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG>
<STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int);</STRONG>
+ <STRONG>void</STRONG> <STRONG>_nc_free_tinfo(int);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- These functions are used to simplify analysis of memory leaks in the
+ These functions are used to simplify analysis of memory leaks in the
ncurses library. They are normally not available; they must be config-
- ured into the library at build time using the <STRONG>--disable-leaks</STRONG> option.
- That compiles-in code that frees memory that normally would not be
+ ured into the library at build time using the <STRONG>--disable-leaks</STRONG> option.
+ That compiles-in code that frees memory that normally would not be
freed.
Any implementation of curses must not free the memory associated with a
screen, since (even after calling <STRONG>endwin</STRONG>), it must be available for use
- in the next call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>. There are also chunks of memory held
+ in the next call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>. There are also chunks of memory held
for performance reasons. That makes it hard to analyze curses applica-
- tions for memory leaks. To work around this, one can build a debugging
- version of the ncurses library which frees those chunks which it can,
- and provides these functions to free all of the memory allocated by the
- ncurses library.
+ tions for memory leaks. When using the specially configured debugging
+ version of the ncurses library, applications can call functions which
+ free those chunks of memory, simplifying the process of memory-leak
+ checking.
- The _nc_free_and_exit function is the preferred one since some of the
- memory which is freed may be required for the application to continue
- running. Its parameter is the code to pass to the exit routine.
+ These functions are named with a "_nc_" prefix because they are not in-
+ tended for use in the non-debugging library:
+
+ <STRONG>_nc_freeall</STRONG>
+ This frees (almost) all of the memory allocated by ncurses.
+
+ <STRONG>_nc_free_and_exit</STRONG>
+ This frees the memory allocated by ncurses (like <STRONG>_nc_freeall</STRONG>), and
+ exits the program. It is preferred over <STRONG>_nc_freeall</STRONG> since some of
+ that memory may be required to keep the application running. Sim-
+ ply exiting (with the given exit-code) is safer.
+
+ <STRONG>_nc_free_tinfo</STRONG>
+ Use this function if only the low-level terminfo functions (and
+ corresponding library) are used. Like <STRONG>_nc_free_and_exit</STRONG>, it exits
+ the program after freeing memory.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These functions are not part of the XSI interface.
+ These functions are not part of X/Open Curses; nor do other implementa-
+ tions of curses provide a similar feature.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
projects / ncurses.git / blobdiff