libgwyddion20-doc 2.50-2 / usr / share / gtk-doc / html / libgwyddion / libgwyddion-gwydebugobjects.html

This file is indexed.

/usr/share/gtk-doc/html/libgwyddion/libgwyddion-gwydebugobjects.html is in libgwyddion20-doc 2.50-2.

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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<!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: Gwyddion Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<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">
<link rel="next" href="api-index-all.html" title="Index of all symbols">
<meta name="generator" content="GTK-Doc V1.19 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgwyddion-gwydebugobjects.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwyddion-gwymd5.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-all.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgwyddion-gwydebugobjects.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation" title="gwy_debug_objects_creation()">gwy_debug_objects_creation</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-creation-detailed" title="gwy_debug_objects_creation_detailed ()">gwy_debug_objects_creation_detailed</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-enable" title="gwy_debug_objects_enable ()">gwy_debug_objects_enable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwyddion-gwydebugobjects.html#gwy-debug-objects-clear" title="gwy_debug_objects_clear ()">gwy_debug_objects_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwyddion-gwydebugobjects.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libgwyddion-gwydebugobjects.html#GwyDebugObjectsDumpFlags" title="enum GwyDebugObjectsDumpFlags">GwyDebugObjectsDumpFlags</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwyddion-gwydebugobjects.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgwyddion/gwyddion.h&gt;
</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.functions_details"></a><h2>Functions</h2>
<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="refsect3">
<a name="gwy-debug-objects-creation.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>o</p></td>
<td class="parameter_description"><p>An object to watch.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</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/gtk/gobjectgobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *object</code></em>,
                                     <em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-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="refsect3">
<a name="gwy-debug-objects-creation-detailed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>object</p></td>
<td class="parameter_description"><p>An object to watch.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>details</p></td>
<td class="parameter_description"><p>Detailed information printed in debug output.  No copy is made,
it must exist permanently.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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/gtk/glibglib-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="refsect3">
<a name="gwy-debug-objects-enable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>enable</p></td>
<td class="parameter_description"><p>Whether object creation/destruction debugger should be enabled.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</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="refsect3">
<a name="gwy-debug-objects-dump-to-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>filehandle</p></td>
<td class="parameter_description"><p>A filehandle open for writing.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Dump option flags.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
</div>
<div class="refsect1">
<a name="libgwyddion-gwydebugobjects.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GwyDebugObjectsDumpFlags"></a><h3>enum GwyDebugObjectsDumpFlags</h3>
<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="refsect3">
<a name="GwyDebugObjectsDumpFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="GWY-DEBUG-OBJECTS-DUMP-ONLY-ALIVE:CAPS"></a>GWY_DEBUG_OBJECTS_DUMP_ONLY_ALIVE</p></td>
<td class="enum_member_description">
<p>Dump only objects that are still
                                    alive.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.