/usr/share/gtk-doc/html/exo-1/exo-Miscellaneous-Utility-Functions.html is in libexo-1-dev 0.6.2-4.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Miscellaneous Utility Functions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Exo Reference Manual">
<link rel="up" href="exo-miscelleanous.html" title="Part VII. Miscelleanous">
<link rel="prev" href="exo-String-Utility-Functions.html" title="String Utility Functions">
<link rel="next" href="ExoXsessionClient.html" title="ExoXsessionClient">
<meta name="generator" content="GTK-Doc V1.17 (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="exo-String-Utility-Functions.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="exo-miscelleanous.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">Exo Reference Manual</th>
<td><a accesskey="n" href="ExoXsessionClient.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#exo-Miscellaneous-Utility-Functions.synopsis" class="shortcut">Top</a>
|
<a href="#exo-Miscellaneous-Utility-Functions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="exo-Miscellaneous-Utility-Functions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="exo-Miscellaneous-Utility-Functions.top_of_page"></a>Miscellaneous Utility Functions</span></h2>
<p>Miscellaneous Utility Functions — Various utility functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="exo-Miscellaneous-Utility-Functions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <exo/exo.h>
<span class="returnvalue">void</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-noop" title="exo_noop ()">exo_noop</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gint</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-noop-one" title="exo_noop_one ()">exo_noop_one</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gint</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-noop-zero" title="exo_noop_zero ()">exo_noop_zero</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-noop-null" title="exo_noop_null ()">exo_noop_null</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-noop-true" title="exo_noop_true ()">exo_noop_true</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-noop-false" title="exo_noop_false ()">exo_noop_false</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-atomic-inc" title="exo_atomic_inc ()">exo_atomic_inc</a> (<em class="parameter"><code><span class="type">gint</span> *value</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="exo-Miscellaneous-Utility-Functions.html#exo-atomic-dec" title="exo_atomic_dec ()">exo_atomic_dec</a> (<em class="parameter"><code><span class="type">gint</span> *value</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="exo-Miscellaneous-Utility-Functions.description"></a><h2>Description</h2>
<p>
This module contains various utility functions that extend the basic
utility functions provided by the <a class="ulink" href="http://library.gnome.org/devel/glib/stable/" target="_top">GLib</a> library.
</p>
</div>
<div class="refsect1">
<a name="exo-Miscellaneous-Utility-Functions.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="exo-noop"></a><h3>exo_noop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_noop (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function has no effect. It does nothing but
returning instantly. It is mostly useful in
situations that require a function to be called,
but that function does not need to do anything
useful.
</p>
<p class="since">Since 0.3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-noop-one"></a><h3>exo_noop_one ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> exo_noop_one (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function has no effect but simply returns
the integer value <code class="literal">1</code>. It is mostly useful in
situations where you just need a function that
returns <code class="literal">1</code>, but don't want to perform any other
actions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the integer value <code class="literal">1</code>.</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-noop-zero"></a><h3>exo_noop_zero ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> exo_noop_zero (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function has no effect but simply returns
the integer value <code class="literal">0</code>. It is mostly useful in
situations where you just need a function that
returns <code class="literal">0</code>, but don't want to perform any other
actions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the integer value <code class="literal">0</code>.</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-noop-null"></a><h3>exo_noop_null ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> exo_noop_null (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function has no effect but simply returns
a <code class="literal">NULL</code> pointer. It is mostly useful in
situations where you just need a function that
returns <code class="literal">NULL</code>, but don't want to perform any
other actions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a <code class="literal">NULL</code> pointer.</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-noop-true"></a><h3>exo_noop_true ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> exo_noop_true (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function has no effect, but simply returns
the boolean value <code class="literal">TRUE</code>. It is mostly useful in
situations where you just need a function that
returns <code class="literal">TRUE</code>, but don't want to perform any
other actions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the boolean value <code class="literal">TRUE</code>.</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-noop-false"></a><h3>exo_noop_false ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> exo_noop_false (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
This function has no effect, but simply returns
the boolean value <code class="literal">FALSE</code>. It is mostly useful in
situations where you just need a function that
returns <code class="literal">FALSE</code>, but don't want to perform any
other actions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the boolean value <code class="literal">FALSE</code>.</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.3.1</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-atomic-inc"></a><h3>exo_atomic_inc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_atomic_inc (<em class="parameter"><code><span class="type">gint</span> *value</code></em>);</pre>
<p>
Increments the integer at <em class="parameter"><code>value</code></em> by one in an
atomic fashion. The advantage over using
<code class="function">g_atomic_int_inc()</code> is that calls to this
function can be inlined.
</p>
<p>
Since : 0.3.1
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a pointer to the integer value to increment.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-atomic-dec"></a><h3>exo_atomic_dec ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> exo_atomic_dec (<em class="parameter"><code><span class="type">gint</span> *value</code></em>);</pre>
<p>
Decrements the integer at <em class="parameter"><code>value</code></em> by one in an atomic
fashion and returns <code class="literal">TRUE</code> if the <em class="parameter"><code>value</code></em> dropped to
zero by this operation, else <code class="literal">FALSE</code>. The advantage
over using <code class="function">g_atomic_int_dec()</code> is that calls to this
function can be inlined.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a pointer to the integer value to decrement.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>value</code></em> dropped to zero, else <code class="literal">FALSE</code>.
Since : 0.3.1</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="exo-Miscellaneous-Utility-Functions.see-also"></a><h2>See Also</h2>
<a class="ulink" href="http://library.gnome.org/devel/glib/stable/glib-Atomic-Operations.html" target="_top">
GLib Atomic Operations</a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|