1<!-- 2 **************************************************************************** 3 * Copyright 2019-2023,2024 Thomas E. Dickey * 4 * Copyright 2008-2010,2017 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 **************************************************************************** 30 * @Id: curs_memleaks.3x,v 1.35 2024/03/16 15:35:01 tom Exp @ 31--> 32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 33<HTML> 34<HEAD> 35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>curs_memleaks 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">curs_memleaks 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>exit_curses</STRONG>, <STRONG>exit_terminfo</STRONG> - check for memory leaks in <EM>curses</EM> 51 52 53</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 54 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> 55 <STRONG>void</STRONG> <STRONG>exit_curses(int</STRONG> <EM>code</EM><STRONG>);</STRONG> 56 57 <STRONG>#include</STRONG> <STRONG><term.h></STRONG> 58 <STRONG>void</STRONG> <STRONG>exit_terminfo(int</STRONG> <EM>code</EM><STRONG>);</STRONG> 59 60 <EM>/*</EM> <EM>deprecated</EM> <EM>(intentionally</EM> <EM>not</EM> <EM>declared</EM> <EM>in</EM> <EM>curses.h</EM> <EM>or</EM> <EM>term.h)</EM> <EM>*/</EM> 61 <STRONG>void</STRONG> <STRONG>_nc_freeall(void);</STRONG> 62 <STRONG>void</STRONG> <STRONG>_nc_free_and_exit(int</STRONG> <EM>code</EM><STRONG>);</STRONG> 63 <STRONG>void</STRONG> <STRONG>_nc_free_tinfo(int</STRONG> <EM>code</EM><STRONG>);</STRONG> 64 65 66</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 67 These functions are used to simplify analysis of memory leaks in the 68 <EM>ncurses</EM> library. 69 70 Any implementation of curses must not free the memory associated with a 71 screen, since (even after calling <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG>), it must be available for 72 use in the next call to <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG>. There are also chunks of memory 73 held for performance reasons. That makes it hard to analyze curses 74 applications for memory leaks. When using the specially configured 75 debugging version of the <EM>ncurses</EM> library, applications can call 76 functions which free those chunks of memory, simplifying the process of 77 memory-leak checking. 78 79 Some of the functions are named with a "_nc_" prefix because they are 80 not intended for use in the non-debugging library: 81 82 <STRONG>_nc_freeall</STRONG> 83 This frees (almost) all of the memory allocated by <EM>ncurses</EM>. 84 85 <STRONG>_nc_free_and_exit</STRONG> 86 This frees the memory allocated by <EM>ncurses</EM> (like <STRONG>_nc_freeall</STRONG>), and 87 exits the program. It is preferred over <STRONG>_nc_freeall</STRONG> since some of 88 that memory may be required to keep the application running. 89 Simply exiting (with the given exit-code) is safer. 90 91 <STRONG>_nc_free_tinfo</STRONG> 92 Use this function if only the low-level terminfo functions (and 93 corresponding library) are used. Like <STRONG>_nc_free_and_exit</STRONG>, it exits 94 the program after freeing memory. 95 96 The functions prefixed "_nc" are normally not available; they must be 97 configured into the library at build time using the <STRONG>--disable-leaks</STRONG> 98 option. That compiles-in code that frees memory that normally would 99 not be freed. 100 101 The <STRONG>exit_curses</STRONG> and <STRONG>exit_terminfo</STRONG> functions call <STRONG>_nc_free_and_exit</STRONG> and 102 <STRONG>_nc_free_tinfo</STRONG> if the library is configured to support memory-leak 103 checking. If the library is not configured to support memory-leak 104 checking, they simply call <STRONG>exit</STRONG>. 105 106 107</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 108 These functions do not return a value. 109 110 111</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 112 These functions are not part of X/Open Curses; nor do other 113 implementations of curses provide a similar feature. 114 115 In any implementation of X/Open Curses, an application can free part of 116 the memory allocated by curses: 117 118 <STRONG>o</STRONG> The portable part of <STRONG>exit_curses</STRONG> can be freed using <STRONG>delscreen</STRONG>, 119 passing the <EM>SCREEN</EM> pointer returned by <STRONG>newterm</STRONG>. 120 121 In some implementations, there is a global variable <STRONG>sp</STRONG> which could 122 be used, e.g., if the screen were only initialized using <STRONG>initscr</STRONG>. 123 124 <STRONG>o</STRONG> The portable part of <STRONG>exit_terminfo</STRONG> can be freed using <STRONG>del_curterm</STRONG>. 125 126 In this case, there is a global variable <STRONG>cur_term</STRONG> which can be used 127 as parameter. 128 129 130</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 131 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> 132 133 134 135ncurses 6.5 2024-03-16 <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG> 136</PRE> 137<div class="nav"> 138<ul> 139<li><a href="#h2-NAME">NAME</a></li> 140<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 141<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 142<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 143<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 144<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 145</ul> 146</div> 147</BODY> 148</HTML> 149