/usr/share/gtk-doc/html/gedit/gedit-gedit-debug.html is in gedit-dev 3.4.1-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gedit-debug</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="gedit Reference Manual">
<link rel="up" href="ch01.html" title="gedit">
<link rel="prev" href="GeditWindowActivatable.html" title="GeditWindowActivatable">
<link rel="next" href="gedit-gedit-encodings.html" title="gedit-encodings">
<meta name="generator" content="GTK-Doc V1.18 (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="GeditWindowActivatable.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></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">gedit Reference Manual</th>
<td><a accesskey="n" href="gedit-gedit-encodings.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gedit-gedit-debug.synopsis" class="shortcut">Top</a>
|
<a href="#gedit-gedit-debug.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gedit-gedit-debug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gedit-gedit-debug.top_of_page"></a>gedit-debug</span></h2>
<p>gedit-debug</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gedit-gedit-debug.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum <a class="link" href="gedit-gedit-debug.html#GeditDebugSection" title="enum GeditDebugSection">GeditDebugSection</a>;
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-VIEW:CAPS" title="DEBUG_VIEW">DEBUG_VIEW</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-SEARCH:CAPS" title="DEBUG_SEARCH">DEBUG_SEARCH</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-PRINT:CAPS" title="DEBUG_PRINT">DEBUG_PRINT</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-PREFS:CAPS" title="DEBUG_PREFS">DEBUG_PREFS</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-PLUGINS:CAPS" title="DEBUG_PLUGINS">DEBUG_PLUGINS</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-TAB:CAPS" title="DEBUG_TAB">DEBUG_TAB</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-DOCUMENT:CAPS" title="DEBUG_DOCUMENT">DEBUG_DOCUMENT</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-COMMANDS:CAPS" title="DEBUG_COMMANDS">DEBUG_COMMANDS</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-APP:CAPS" title="DEBUG_APP">DEBUG_APP</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-SESSION:CAPS" title="DEBUG_SESSION">DEBUG_SESSION</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-UTILS:CAPS" title="DEBUG_UTILS">DEBUG_UTILS</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-METADATA:CAPS" title="DEBUG_METADATA">DEBUG_METADATA</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-WINDOW:CAPS" title="DEBUG_WINDOW">DEBUG_WINDOW</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-LOADER:CAPS" title="DEBUG_LOADER">DEBUG_LOADER</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-SAVER:CAPS" title="DEBUG_SAVER">DEBUG_SAVER</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-PANEL:CAPS" title="DEBUG_PANEL">DEBUG_PANEL</a>
#define <a class="link" href="gedit-gedit-debug.html#DEBUG-DBUS:CAPS" title="DEBUG_DBUS">DEBUG_DBUS</a>
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-debug.html#gedit-debug-init" title="gedit_debug_init ()">gedit_debug_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-debug.html#gedit-debug" title="gedit_debug ()">gedit_debug</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-debug.html#GeditDebugSection" title="enum GeditDebugSection"><span class="type">GeditDebugSection</span></a> section</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *function</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-debug.html#gedit-debug-message" title="gedit_debug_message ()">gedit_debug_message</a> (<em class="parameter"><code><a class="link" href="gedit-gedit-debug.html#GeditDebugSection" title="enum GeditDebugSection"><span class="type">GeditDebugSection</span></a> section</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *function</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gedit-gedit-debug.html#gedit-debug-plugin-message" title="gedit_debug_plugin_message ()">gedit_debug_plugin_message</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *function</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gedit-gedit-debug.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="gedit-gedit-debug.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GeditDebugSection"></a><h3>enum GeditDebugSection</h3>
<pre class="programlisting">typedef enum {
GEDIT_NO_DEBUG = 0,
GEDIT_DEBUG_VIEW = 1 << 0,
GEDIT_DEBUG_SEARCH = 1 << 1,
GEDIT_DEBUG_PRINT = 1 << 2,
GEDIT_DEBUG_PREFS = 1 << 3,
GEDIT_DEBUG_PLUGINS = 1 << 4,
GEDIT_DEBUG_TAB = 1 << 5,
GEDIT_DEBUG_DOCUMENT = 1 << 6,
GEDIT_DEBUG_COMMANDS = 1 << 7,
GEDIT_DEBUG_APP = 1 << 8,
GEDIT_DEBUG_SESSION = 1 << 9,
GEDIT_DEBUG_UTILS = 1 << 10,
GEDIT_DEBUG_METADATA = 1 << 11,
GEDIT_DEBUG_WINDOW = 1 << 12,
GEDIT_DEBUG_LOADER = 1 << 13,
GEDIT_DEBUG_SAVER = 1 << 14,
GEDIT_DEBUG_PANEL = 1 << 15,
GEDIT_DEBUG_DBUS = 1 << 16
} GeditDebugSection;
</pre>
<p>
Enumeration of debug sections.
</p>
<p>
Debugging output for a section is enabled by setting an environment variable
of the same name. For example, setting the <code class="code">GEDIT_DEBUG_PLUGINS</code>
environment variable enables all debugging output for the <code class="literal">GEDIT_DEBUG_PLUGINS</code>
section. Setting the special environment variable <code class="code">GEDIT_DEBUG</code>
enables output for all sections.
</p>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-VIEW:CAPS"></a><h3>DEBUG_VIEW</h3>
<pre class="programlisting">#define DEBUG_VIEW GEDIT_DEBUG_VIEW, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-SEARCH:CAPS"></a><h3>DEBUG_SEARCH</h3>
<pre class="programlisting">#define DEBUG_SEARCH GEDIT_DEBUG_SEARCH, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-PRINT:CAPS"></a><h3>DEBUG_PRINT</h3>
<pre class="programlisting">#define DEBUG_PRINT GEDIT_DEBUG_PRINT, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-PREFS:CAPS"></a><h3>DEBUG_PREFS</h3>
<pre class="programlisting">#define DEBUG_PREFS GEDIT_DEBUG_PREFS, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-PLUGINS:CAPS"></a><h3>DEBUG_PLUGINS</h3>
<pre class="programlisting">#define DEBUG_PLUGINS GEDIT_DEBUG_PLUGINS, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-TAB:CAPS"></a><h3>DEBUG_TAB</h3>
<pre class="programlisting">#define DEBUG_TAB GEDIT_DEBUG_TAB, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-DOCUMENT:CAPS"></a><h3>DEBUG_DOCUMENT</h3>
<pre class="programlisting">#define DEBUG_DOCUMENT GEDIT_DEBUG_DOCUMENT,__FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-COMMANDS:CAPS"></a><h3>DEBUG_COMMANDS</h3>
<pre class="programlisting">#define DEBUG_COMMANDS GEDIT_DEBUG_COMMANDS,__FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-APP:CAPS"></a><h3>DEBUG_APP</h3>
<pre class="programlisting">#define DEBUG_APP GEDIT_DEBUG_APP, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-SESSION:CAPS"></a><h3>DEBUG_SESSION</h3>
<pre class="programlisting">#define DEBUG_SESSION GEDIT_DEBUG_SESSION, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-UTILS:CAPS"></a><h3>DEBUG_UTILS</h3>
<pre class="programlisting">#define DEBUG_UTILS GEDIT_DEBUG_UTILS, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-METADATA:CAPS"></a><h3>DEBUG_METADATA</h3>
<pre class="programlisting">#define DEBUG_METADATA GEDIT_DEBUG_METADATA,__FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-WINDOW:CAPS"></a><h3>DEBUG_WINDOW</h3>
<pre class="programlisting">#define DEBUG_WINDOW GEDIT_DEBUG_WINDOW, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-LOADER:CAPS"></a><h3>DEBUG_LOADER</h3>
<pre class="programlisting">#define DEBUG_LOADER GEDIT_DEBUG_LOADER, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-SAVER:CAPS"></a><h3>DEBUG_SAVER</h3>
<pre class="programlisting">#define DEBUG_SAVER GEDIT_DEBUG_SAVER, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-PANEL:CAPS"></a><h3>DEBUG_PANEL</h3>
<pre class="programlisting">#define DEBUG_PANEL GEDIT_DEBUG_PANEL, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DEBUG-DBUS:CAPS"></a><h3>DEBUG_DBUS</h3>
<pre class="programlisting">#define DEBUG_DBUS GEDIT_DEBUG_DBUS, __FILE__, __LINE__, G_STRFUNC
</pre>
</div>
<hr>
<div class="refsect2">
<a name="gedit-debug-init"></a><h3>gedit_debug_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_debug_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initializes the debugging subsystem of Gedit.
</p>
<p>
The function checks for the existence of certain environment variables to
determine whether to enable output for a debug section. To enable output
for a specific debug section, set an environment variable of the same name;
e.g. to enable output for the <code class="literal">GEDIT_DEBUG_PLUGINS</code> section, set a
<code class="code">GEDIT_DEBUG_PLUGINS</code> environment variable. To enable output
for all debug sections, set the <code class="code">GEDIT_DEBUG</code> environment
variable.
</p>
<p>
This function must be called before any of the other debug functions are
called. It must only be called once.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gedit-debug"></a><h3>gedit_debug ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_debug (<em class="parameter"><code><a class="link" href="gedit-gedit-debug.html#GeditDebugSection" title="enum GeditDebugSection"><span class="type">GeditDebugSection</span></a> section</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *function</code></em>);</pre>
<p>
If output for debug section <em class="parameter"><code>section</code></em> is enabled, then logs the trace
information <em class="parameter"><code>file</code></em>, <em class="parameter"><code>line</code></em>, and <em class="parameter"><code>function</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>section</code></em> :</span></p></td>
<td>Debug section.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>Name of the source file containing the call to <a class="link" href="gedit-gedit-debug.html#gedit-debug" title="gedit_debug ()"><code class="function">gedit_debug()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
<td>Line number within the file named by <em class="parameter"><code>file</code></em> of the call to <a class="link" href="gedit-gedit-debug.html#gedit-debug" title="gedit_debug ()"><code class="function">gedit_debug()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
<td>Name of the function that is calling <a class="link" href="gedit-gedit-debug.html#gedit-debug" title="gedit_debug ()"><code class="function">gedit_debug()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-debug-message"></a><h3>gedit_debug_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_debug_message (<em class="parameter"><code><a class="link" href="gedit-gedit-debug.html#GeditDebugSection" title="enum GeditDebugSection"><span class="type">GeditDebugSection</span></a> section</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *function</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
If output for debug section <em class="parameter"><code>section</code></em> is enabled, then logs the trace
information <em class="parameter"><code>file</code></em>, <em class="parameter"><code>line</code></em>, and <em class="parameter"><code>function</code></em> along with the message obtained by
formatting <em class="parameter"><code>format</code></em> with the given format string arguments.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>section</code></em> :</span></p></td>
<td>Debug section.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>Name of the source file containing the call to <a class="link" href="gedit-gedit-debug.html#gedit-debug-message" title="gedit_debug_message ()"><code class="function">gedit_debug_message()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
<td>Line number within the file named by <em class="parameter"><code>file</code></em> of the call to <a class="link" href="gedit-gedit-debug.html#gedit-debug-message" title="gedit_debug_message ()"><code class="function">gedit_debug_message()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
<td>Name of the function that is calling <a class="link" href="gedit-gedit-debug.html#gedit-debug-message" title="gedit_debug_message ()"><code class="function">gedit_debug_message()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>A <a href="/usr/share/gtk-doc/html/glib/glib-String-Utility-Functions.html#g-vprintf"><code class="function">g_vprintf()</code></a> format string.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>The format string arguments.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gedit-debug-plugin-message"></a><h3>gedit_debug_plugin_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gedit_debug_plugin_message (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> line</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *function</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre>
<p>
If output for debug section <code class="literal">GEDIT_DEBUG_PLUGINS</code> is enabled, then logs the trace
information <em class="parameter"><code>file</code></em>, <em class="parameter"><code>line</code></em>, and <em class="parameter"><code>function</code></em> along with the informational message
<em class="parameter"><code>message</code></em>.
</p>
<p>
This function may be overridden by GObject Introspection language bindings
to be more language-specific.
</p>
<p>
<span class="emphasis"><em>Python</em></span>
</p>
<p>
A PyGObject override is provided that has the following signature:
</p>
<div class="informalexample"><pre class="programlisting">
def debug_plugin_message(format_str, *format_args):
#...
</pre></div>
<p>
</p>
<p>
It automatically supplies parameters <em class="parameter"><code>file</code></em>, <em class="parameter"><code>line</code></em>, and <em class="parameter"><code>function</code></em>, and it
formats <code class="code">format_str</code> with the given format arguments. The syntax
of the format string is the usual Python string formatting syntax described
by <a class="ulink" href="http://docs.python.org/library/stdtypes.html#string-formatting" target="_top">5.6.2. String Formatting Operations</a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td>Name of the source file containing the call to <a class="link" href="gedit-gedit-debug.html#gedit-debug-plugin-message" title="gedit_debug_plugin_message ()"><code class="function">gedit_debug_plugin_message()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
<td>Line number within the file named by <em class="parameter"><code>file</code></em> of the call to <a class="link" href="gedit-gedit-debug.html#gedit-debug-plugin-message" title="gedit_debug_plugin_message ()"><code class="function">gedit_debug_plugin_message()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
<td>Name of the function that is calling <a class="link" href="gedit-gedit-debug.html#gedit-debug-plugin-message" title="gedit_debug_plugin_message ()"><code class="function">gedit_debug_plugin_message()</code></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>An informational message.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|