/usr/share/gtk-doc/html/libgwyddion/libgwyddion-gwydebugobjects.html is in libgwyddion20-doc 2.26-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gwydebugobjects</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="prev" href="libgwyddion-gwymd5.html" title="gwymd5">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgwyddion-gwymd5.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Library Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwyddion-gwydebugobjects.synopsis" class="shortcut">Top</a>
|
<a href="#libgwyddion-gwydebugobjects.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwyddion-gwydebugobjects"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyddion-gwydebugobjects.top_of_page"></a>gwydebugobjects</span></h2>
<p>gwydebugobjects — Helps chasing leaking objects (debug)</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyddion-gwydebugobjects.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwyddion/gwyddion.h>
enum <a class="link" href="libgwyddion-gwydebugobjects.html#GwyDebugObjectsDumpFlags" title="enum GwyDebugObjectsDumpFlags">GwyDebugObjectsDumpFlags</a>;
<span class="returnvalue">void</span> <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-clear" title="gwy_debug_objects_clear ()">gwy_debug_objects_clear</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
#define <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation" title="gwy_debug_objects_creation()">gwy_debug_objects_creation</a> (o)
<span class="returnvalue">void</span> <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation-detailed" title="gwy_debug_objects_creation_detailed ()">gwy_debug_objects_creation_detailed</a> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *details</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-dump-to-file" title="gwy_debug_objects_dump_to_file ()">gwy_debug_objects_dump_to_file</a> (<em class="parameter"><code><span class="type">FILE</span> *filehandle</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-gwydebugobjects.html#GwyDebugObjectsDumpFlags" title="enum GwyDebugObjectsDumpFlags"><span class="type">GwyDebugObjectsDumpFlags</span></a> flags</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-enable" title="gwy_debug_objects_enable ()">gwy_debug_objects_enable</a> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyddion-gwydebugobjects.description"></a><h2>Description</h2>
<p>
If you wonder about some object lifetime rules, these functions can help
you: <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation" title="gwy_debug_objects_creation()"><code class="function">gwy_debug_objects_creation()</code></a> hooks object finalization so it is
possible to tell later whether and when the object was destroyed -- use
<a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-dump-to-file" title="gwy_debug_objects_dump_to_file ()"><code class="function">gwy_debug_objects_dump_to_file()</code></a> to dump this information to a file.
</p>
<p>
If debugging is not enabled with <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-enable" title="gwy_debug_objects_enable ()"><code class="function">gwy_debug_objects_enable()</code></a> these functions
do nothing. Note all Gwyddion data-like objects (i.e., not widgets) already
call <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation" title="gwy_debug_objects_creation()"><code class="function">gwy_debug_objects_creation()</code></a> so to debug their lifetime rules, just
enable it.
</p>
<p>
Future changes: This functionality will be removed in 3.0. Use RefDbg.
</p>
</div>
<div class="refsect1">
<a name="libgwyddion-gwydebugobjects.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyDebugObjectsDumpFlags"></a><h3>enum GwyDebugObjectsDumpFlags</h3>
<pre class="programlisting">typedef enum {
GWY_DEBUG_OBJECTS_DUMP_ONLY_ALIVE = 1 << 0
} GwyDebugObjectsDumpFlags;
</pre>
<p>
Option flags for <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-dump-to-file" title="gwy_debug_objects_dump_to_file ()"><code class="function">gwy_debug_objects_dump_to_file()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><a name="GWY-DEBUG-OBJECTS-DUMP-ONLY-ALIVE:CAPS"></a><span class="term"><code class="literal">GWY_DEBUG_OBJECTS_DUMP_ONLY_ALIVE</code></span></p></td>
<td>Dump only objects that are still
alive.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-debug-objects-clear"></a><h3>gwy_debug_objects_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_debug_objects_clear (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Frees all memory taken by debugger, removes all watches.
</p>
<p>
Eventual following call to <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation" title="gwy_debug_objects_creation()"><code class="function">gwy_debug_objects_creation()</code></a> will behave like
the very first one, including time counting reset.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-debug-objects-creation"></a><h3>gwy_debug_objects_creation()</h3>
<pre class="programlisting">#define gwy_debug_objects_creation(o)</pre>
<p>
Convenience wrapper for <a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation-detailed" title="gwy_debug_objects_creation_detailed ()"><code class="function">gwy_debug_objects_creation_detailed()</code></a>.
</p>
<p>
It uses file name and line number as the detail.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>o</code></em> :</span></p></td>
<td>An object to watch.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-debug-objects-creation-detailed"></a><h3>gwy_debug_objects_creation_detailed ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_debug_objects_creation_detailed (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a> *object</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *details</code></em>);</pre>
<p>
Notes down <em class="parameter"><code>object</code></em> and sets up watch for its destruction.
</p>
<p>
This function should be called on object creation to get accurate creation
time, but can be in fact called anytime in object existence.
</p>
<p>
There are two possible uses: In class implementation, where it should be
put into instance init function. Constructors are less suited for that,
as there can be more than one, there can be deserializators, duplicators,
etc., and you usually want to catch all possible means of object creation.
</p>
<p>
Or it can be used on the side of object user who is concerned with lifetime
rules of a particular object, he then calls it just after object creation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>An object to watch.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>details</code></em> :</span></p></td>
<td>Detailed information printed in debug output. No copy is made,
it must exist permanently.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-debug-objects-dump-to-file"></a><h3>gwy_debug_objects_dump_to_file ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_debug_objects_dump_to_file (<em class="parameter"><code><span class="type">FILE</span> *filehandle</code></em>,
<em class="parameter"><code><a class="link" href="libgwyddion-gwydebugobjects.html#GwyDebugObjectsDumpFlags" title="enum GwyDebugObjectsDumpFlags"><span class="type">GwyDebugObjectsDumpFlags</span></a> flags</code></em>);</pre>
<p>
Dumps all recorded objects to a file.
</p>
<p>
The format of each line is: object type name, object address, creation time,
destruction time (or ALIVE! message with reference count).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filehandle</code></em> :</span></p></td>
<td>A filehandle open for writing.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>Dump option flags.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-debug-objects-enable"></a><h3>gwy_debug_objects_enable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_debug_objects_enable (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> enable</code></em>);</pre>
<p>
Enables or disables the object creation/destruction debugger.
</p>
<p>
When debugger is disabled, no new objects are noted, but destruction of
already watched ones is still noted.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>enable</code></em> :</span></p></td>
<td>Whether object creation/destruction debugger should be enabled.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|