/usr/share/gtk-doc/html/rhythmbox/rhythmbox-rb-debug.html is in rhythmbox-doc 3.0.2-0ubuntu1.
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 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Rhythmbox Development Reference Manual: rb-debug</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
<link rel="up" href="ch02.html" title="Lib">
<link rel="prev" href="rhythmbox-rb-async-queue-watch.html" title="rb-async-queue-watch">
<link rel="next" href="rhythmbox-rb-file-helpers.html" title="rb-file-helpers">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#rhythmbox-rb-debug.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#rhythmbox-rb-debug.object-hierarchy" class="shortcut">Object Hierarchy</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><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="rhythmbox-rb-async-queue-watch.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="rhythmbox-rb-file-helpers.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="rhythmbox-rb-debug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="rhythmbox-rb-debug.top_of_page"></a>rb-debug</span></h2>
<p>rb-debug — debugging support functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="rhythmbox-rb-debug.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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="rhythmbox-rb-debug.html#rb-debug" title="rb_debug()">rb_debug</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="rhythmbox-rb-debug.html#rb-debug-init" title="rb_debug_init ()">rb_debug_init</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="rhythmbox-rb-debug.html#rb-debug-init-match" title="rb_debug_init_match ()">rb_debug_init_match</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-debug.html#rb-debug-matches" title="rb_debug_matches ()">rb_debug_matches</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> **
</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-debug.html#rb-debug-get-args" title="rb_debug_get_args ()">rb_debug_get_args</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="rhythmbox-rb-debug.html#rb-debug-stop-in-debugger" title="rb_debug_stop_in_debugger ()">rb_debug_stop_in_debugger</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="rhythmbox-rb-debug.html#RBProfiler" title="RBProfiler"><span class="returnvalue">RBProfiler</span></a> *
</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-debug.html#rb-profiler-new" title="rb_profiler_new ()">rb_profiler_new</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="rhythmbox-rb-debug.html#rb-profiler-dump" title="rb_profiler_dump ()">rb_profiler_dump</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="rhythmbox-rb-debug.html#rb-profiler-reset" title="rb_profiler_reset ()">rb_profiler_reset</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="rhythmbox-rb-debug.html#rb-profiler-free" title="rb_profiler_free ()">rb_profiler_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-debug.html#rb-profile-start" title="rb_profile_start()">rb_profile_start</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="rhythmbox-rb-debug.html#rb-profile-end" title="rb_profile_end()">rb_profile_end</a><span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-debug.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><a class="link" href="rhythmbox-rb-debug.html#RBProfiler" title="RBProfiler">RBProfiler</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-debug.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-debug.description"></a><h2>Description</h2>
<p>In addition to a simple debug output system, we have two distinct
profiling mechanisms for timing sections of code.</p>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-debug.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="rb-debug"></a><h3>rb_debug()</h3>
<pre class="programlisting">#define rb_debug(...) rb_debug_realf (__func__, __FILE__, __LINE__, TRUE, __VA_ARGS__)
</pre>
<p>If the call site function or file name matches the current debug output
settings, the message will be formatted and printed to standard error,
including a timestamp, the thread ID, the file and function names, and
the line number. A newline will be appended, so the format string shouldn't
include one.</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-debug-init"></a><h3>rb_debug_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_debug_init (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> debug</code></em>);</pre>
<p>Sets up debug output, with either all debug enabled
or none.</p>
<div class="refsect3">
<a name="id-1.3.3.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>debug</p></td>
<td class="parameter_description"><p>if TRUE, enable all debug output</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-debug-init-match"></a><h3>rb_debug_init_match ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_debug_init_match (<em class="parameter"><code>const <span class="type">char</span> *match</code></em>);</pre>
<p>Sets up debug output, enabling debug output from file and function
names that contain the specified match string.</p>
<p>Also sets up a GLib log handler that will trigger a debugger
break for critical or warning level output if any debug output
at all is enabled.</p>
<div class="refsect3">
<a name="id-1.3.3.7.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>match</p></td>
<td class="parameter_description"><p>string to match functions and filenames against</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-debug-matches"></a><h3>rb_debug_matches ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
rb_debug_matches (<em class="parameter"><code>const <span class="type">char</span> *func</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *file</code></em>);</pre>
<p>Checks if <em class="parameter"><code>file</code></em>
or <em class="parameter"><code>func</code></em>
matches the current debug output settings.</p>
<div class="refsect3">
<a name="id-1.3.3.7.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>func</p></td>
<td class="parameter_description"><p>function to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>filename to check</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.5.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if matched</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-debug-get-args"></a><h3>rb_debug_get_args ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> **
rb_debug_get_args (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Constructs arguments to pass to another process using
this debug output code that will produce the same debug output
settings.</p>
<div class="refsect3">
<a name="id-1.3.3.7.6.5"></a><h4>Returns</h4>
<p> debug output arguments, must be freed with <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-strfreev"><code class="function"><GTKDOCLINK HREF="g-strfreev"><code class="function">g_strfreev()</code></a></code></GTKDOCLINK>. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-debug-stop-in-debugger"></a><h3>rb_debug_stop_in_debugger ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_debug_stop_in_debugger (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Raises a SIGINT signal to get the attention of the debugger.
When not running under the debugger, we don't want to stop,
so we ignore the signal for just the moment that we raise it.</p>
</div>
<hr>
<div class="refsect2">
<a name="rb-profiler-new"></a><h3>rb_profiler_new ()</h3>
<pre class="programlisting"><a class="link" href="rhythmbox-rb-debug.html#RBProfiler" title="RBProfiler"><span class="returnvalue">RBProfiler</span></a> *
rb_profiler_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>Creates a new profiler instance. This can be used to
time certain sections of code.</p>
<div class="refsect3">
<a name="id-1.3.3.7.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>name</p></td>
<td class="parameter_description"><p>profiler name</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.3.7.8.6"></a><h4>Returns</h4>
<p> profiler instance</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-profiler-dump"></a><h3>rb_profiler_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_profiler_dump (<em class="parameter"><code><a class="link" href="rhythmbox-rb-debug.html#RBProfiler" title="RBProfiler"><span class="type">RBProfiler</span></a> *profiler</code></em>);</pre>
<p>Produces debug output for the profiler instance,
showing the elapsed time.</p>
<div class="refsect3">
<a name="id-1.3.3.7.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>profiler</p></td>
<td class="parameter_description"><p>profiler instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-profiler-reset"></a><h3>rb_profiler_reset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_profiler_reset (<em class="parameter"><code><a class="link" href="rhythmbox-rb-debug.html#RBProfiler" title="RBProfiler"><span class="type">RBProfiler</span></a> *profiler</code></em>);</pre>
<p>Resets the elapsed time for the profiler</p>
<div class="refsect3">
<a name="id-1.3.3.7.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>profiler</p></td>
<td class="parameter_description"><p>profiler instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-profiler-free"></a><h3>rb_profiler_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
rb_profiler_free (<em class="parameter"><code><a class="link" href="rhythmbox-rb-debug.html#RBProfiler" title="RBProfiler"><span class="type">RBProfiler</span></a> *profiler</code></em>);</pre>
<p>Frees the memory associated with a profiler instance.</p>
<div class="refsect3">
<a name="id-1.3.3.7.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>profiler</p></td>
<td class="parameter_description"><p>profiler instance to destroy</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-profile-start"></a><h3>rb_profile_start()</h3>
<pre class="programlisting">#define rb_profile_start(msg) _rb_profile_log (__func__, __FILE__, __LINE__, RB_PROFILE_INDENTATION, "START", msg)
</pre>
<p>Records a start point for profiling.
This profile mechanism operates by issuing file access
requests with filenames indicating the profile points.
Use 'strace -e access' to gather this information.</p>
<div class="refsect3">
<a name="id-1.3.3.7.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>msg</p></td>
<td class="parameter_description"><p>profile point message</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="rb-profile-end"></a><h3>rb_profile_end()</h3>
<pre class="programlisting">#define rb_profile_end(msg) _rb_profile_log (__func__, __FILE__, __LINE__, -RB_PROFILE_INDENTATION, "END", msg)
</pre>
<p>Records an end point for profiling. See <em class="parameter"><code>rb_profile_start</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.3.7.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>msg</p></td>
<td class="parameter_description"><p>profile point message</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="rhythmbox-rb-debug.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="RBProfiler"></a><h3>RBProfiler</h3>
<pre class="programlisting">typedef struct RBProfiler RBProfiler;
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|