/usr/share/gtk-doc/html/libbonobo/libbonobo-bonobo-exception.html is in libbonobo2-dev 2.32.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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>bonobo-exception</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="general.html" title="General">
<link rel="prev" href="libbonobo-bonobo-context.html" title="bonobo-context">
<link rel="next" href="libbonobo-bonobo-application.html" title="bonobo-application">
<meta name="generator" content="GTK-Doc V1.16 (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="libbonobo-bonobo-context.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="general.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">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-application.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-exception.synopsis" class="shortcut">Top</a>
|
<a href="#libbonobo-bonobo-exception.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-exception"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-exception.top_of_page"></a>bonobo-exception</span></h2>
<p>bonobo-exception — maps CORBA exceptions to user readable text, + helper macros</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-exception.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="libbonobo-bonobo-exception.html#bonobo-exception-set" title="bonobo_exception_set()">bonobo_exception_set</a> (opt_ev,
repo_id)
#define <a class="link" href="libbonobo-bonobo-exception.html#bonobo-return-if-fail" title="bonobo_return_if_fail()">bonobo_return_if_fail</a> (expr,
opt_ev)
#define <a class="link" href="libbonobo-bonobo-exception.html#bonobo-return-val-if-fail" title="bonobo_return_val_if_fail()">bonobo_return_val_if_fail</a> (expr,
val,
opt_ev)
#define <a class="link" href="libbonobo-bonobo-exception.html#BONOBO-EX:CAPS" title="BONOBO_EX()">BONOBO_EX</a> (ev)
#define <a class="link" href="libbonobo-bonobo-exception.html#BONOBO-USER-EX:CAPS" title="BONOBO_USER_EX()">BONOBO_USER_EX</a> (ev,
id)
#define <a class="link" href="libbonobo-bonobo-exception.html#BONOBO-EX-REPOID:CAPS" title="BONOBO_EX_REPOID()">BONOBO_EX_REPOID</a> (ev)
#define <a class="link" href="libbonobo-bonobo-exception.html#BONOBO-RET-EX:CAPS" title="BONOBO_RET_EX()">BONOBO_RET_EX</a> (ev)
#define <a class="link" href="libbonobo-bonobo-exception.html#BONOBO-RET-VAL-EX:CAPS" title="BONOBO_RET_VAL_EX()">BONOBO_RET_VAL_EX</a> (ev,
v)
<span class="returnvalue">char</span> * (<a class="link" href="libbonobo-bonobo-exception.html#BonoboExceptionFn" title="BonoboExceptionFn ()">*BonoboExceptionFn</a>) (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="libbonobo-bonobo-exception.html#bonobo-exception-get-text" title="bonobo_exception_get_text ()">bonobo_exception_get_text</a> (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="libbonobo-bonobo-exception.html#bonobo-exception-repoid-to-text" title="bonobo_exception_repoid_to_text ()">bonobo_exception_repoid_to_text</a> (<em class="parameter"><code>const <span class="type">char</span> *repo_id</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbonobo-bonobo-exception.html#bonobo-exception-add-handler-str" title="bonobo_exception_add_handler_str ()">bonobo_exception_add_handler_str</a> (<em class="parameter"><code>const <span class="type">char</span> *repo_id</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbonobo-bonobo-exception.html#bonobo-exception-add-handler-fn" title="bonobo_exception_add_handler_fn ()">bonobo_exception_add_handler_fn</a> (<em class="parameter"><code>const <span class="type">char</span> *repo_id</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-exception.html#BonoboExceptionFn" title="BonoboExceptionFn ()"><span class="type">BonoboExceptionFn</span></a> fn</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_fn</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libbonobo-bonobo-exception.html#bonobo-exception-general-error-set" title="bonobo_exception_general_error_set ()">bonobo_exception_general_error_set</a> (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>,
<em class="parameter"><code><span class="type">CORBA_TypeCode</span> opt_deriv</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="libbonobo-bonobo-exception.html#bonobo-exception-general-error-get" title="bonobo_exception_general_error_get ()">bonobo_exception_general_error_get</a> (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-exception.description"></a><h2>Description</h2>
<p>
This module contains some useful helper functions
that can be used to set various exceptions inside your
CORBA methods. It also contains code to map between
complex CORBA_Environment exceptions and helpful
strings suitable for display to the user.
</p>
<p>
Typically to test for exceptions the BONOBO_EX macro
is used thus:
</p>
<div class="example">
<a name="id336587"></a><p class="title"><b>Example 4. Bonobo exception trapping and reporting</b></p>
<div class="example-contents"><pre class="programlisting">
int
do_something (CORBA_Environment *ev)
{
...
retval = Foo_Baa_method (object, ev);
if (BONOBO_EX (ev)) {
if (BONOBO_USER_EX (ev, ex_CosNaming_NamingContext_NotFound)) {
g_warning ("Not found");
} else {
char *str;
g_warning ("Exception '%s' occured",
(str = bonobo_exception_get_text (ev)));
g_free (str);
}
return -1;
}
...
}
</pre></div>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-exception.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="bonobo-exception-set"></a><h3>bonobo_exception_set()</h3>
<pre class="programlisting">#define bonobo_exception_set(opt_ev,repo_id)</pre>
<p>
This macro sets the stateless user exception with <em class="parameter"><code>repo_id</code></em> on
<em class="parameter"><code>opt_ev</code></em> or warns if <em class="parameter"><code>opt_ev</code></em> == NULL
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
<td>an optional corba exception environment.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>repo_id</code></em> :</span></p></td>
<td>repoid of the exception to set.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-return-if-fail"></a><h3>bonobo_return_if_fail()</h3>
<pre class="programlisting">#define bonobo_return_if_fail(expr,opt_ev)</pre>
<p>
this macro is used for bonobo preconditons on argument types,
usualy inside skels if <em class="parameter"><code>expr</code></em> is FALSE a warning is printed and
<em class="parameter"><code>opt_ev</code></em> is set to ex_Bonobo_BadArg.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>expr</code></em> :</span></p></td>
<td>an expression that should be true</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
<td>an optional corba exception environment.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-return-val-if-fail"></a><h3>bonobo_return_val_if_fail()</h3>
<pre class="programlisting">#define bonobo_return_val_if_fail(expr,val,opt_ev)</pre>
<p>
this macro is used for bonobo preconditons on argument types,
usualy inside skels if <em class="parameter"><code>expr</code></em> is FALSE a warning is printed and
<em class="parameter"><code>opt_ev</code></em> is set to ex_Bonobo_BadArg.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>expr</code></em> :</span></p></td>
<td>an expression that should be true</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
<td>a value to return on failure.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>opt_ev</code></em> :</span></p></td>
<td>an optional corba exception environment.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-EX:CAPS"></a><h3>BONOBO_EX()</h3>
<pre class="programlisting">#define BONOBO_EX(ev) ((ev) != NULL && (ev)->_major != CORBA_NO_EXCEPTION)
</pre>
<p>
This macro returns TRUE if <em class="parameter"><code>ev</code></em> flags an exception.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>the exception environment</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-USER-EX:CAPS"></a><h3>BONOBO_USER_EX()</h3>
<pre class="programlisting">#define BONOBO_USER_EX(ev,id)</pre>
<p>
This macro returns TRUE if <em class="parameter"><code>ev</code></em> contains a user exception
of type <em class="parameter"><code>id</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>ev</code></em> :</span></p></td>
<td>the exception environment</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>the repo_id of the exception</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-EX-REPOID:CAPS"></a><h3>BONOBO_EX_REPOID()</h3>
<pre class="programlisting">#define BONOBO_EX_REPOID(ev) (ev)->_id
</pre>
<p>
Returns the repoid string of exception <em class="parameter"><code>ev</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>ev</code></em> :</span></p></td>
<td>a CORBA exception</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-RET-EX:CAPS"></a><h3>BONOBO_RET_EX()</h3>
<pre class="programlisting">#define BONOBO_RET_EX(ev)</pre>
<p>
returns if there is an exception flagged in <em class="parameter"><code>ev</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>ev</code></em> :</span></p></td>
<td>the exception environment</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BONOBO-RET-VAL-EX:CAPS"></a><h3>BONOBO_RET_VAL_EX()</h3>
<pre class="programlisting">#define BONOBO_RET_VAL_EX(ev,v)</pre>
<p>
returns <em class="parameter"><code>v</code></em> if there is an exception flagged in <em class="parameter"><code>ev</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>ev</code></em> :</span></p></td>
<td>the exception environment</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>v</code></em> :</span></p></td>
<td>the value to return</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="BonoboExceptionFn"></a><h3>BonoboExceptionFn ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * (*BonoboExceptionFn) (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
The prototype for user registerable exception decoders.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>the exception environment</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data to be passed to the function</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a g_malloc'd copy of a translated user readable error string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-exception-get-text"></a><h3>bonobo_exception_get_text ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * bonobo_exception_get_text (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>
<p>
Returns a user readable description of the exception. First
checks <em class="parameter"><code>ev</code></em> against builtin Bonobo exceptions, then falls back to
exception names added through bonobo_exception_add_handler_str
or bonobo_exception_add_handler_fn.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ev</code></em> :</span></p></td>
<td>the corba environment.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A g_malloc'd description, which the caller must free.
NULL is never returned.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-exception-repoid-to-text"></a><h3>bonobo_exception_repoid_to_text ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * bonobo_exception_repoid_to_text (<em class="parameter"><code>const <span class="type">char</span> *repo_id</code></em>);</pre>
<p>
This maps builtin bonobo exceptions that the system
knows about to user readable strings.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>repo_id</code></em> :</span></p></td>
<td>exception repository id</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a user string or NULL for an unknown repo_id</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-exception-add-handler-str"></a><h3>bonobo_exception_add_handler_str ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_exception_add_handler_str (<em class="parameter"><code>const <span class="type">char</span> *repo_id</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *str</code></em>);</pre>
<p>
This routine adds a simple string mapping for an exception
with repository id <em class="parameter"><code>repo_id</code></em>, such that when we call
bonobo_exception_get_text on an exception of id <em class="parameter"><code>repo_id</code></em> we
get <em class="parameter"><code>str</code></em> back.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>repo_id</code></em> :</span></p></td>
<td>exception repository id</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
<td>the user readable, translated exception text.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-exception-add-handler-fn"></a><h3>bonobo_exception_add_handler_fn ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_exception_add_handler_fn (<em class="parameter"><code>const <span class="type">char</span> *repo_id</code></em>,
<em class="parameter"><code><a class="link" href="libbonobo-bonobo-exception.html#BonoboExceptionFn" title="BonoboExceptionFn ()"><span class="type">BonoboExceptionFn</span></a> fn</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_fn</code></em>);</pre>
<p>
This routine adds a method mapping for an exception
with repository id <em class="parameter"><code>repo_id</code></em>, such that when we call
bonobo_exception_get_text on an exception of id <em class="parameter"><code>repo_id</code></em>
the <em class="parameter"><code>fn</code></em> is called and passed <em class="parameter"><code>user_data</code></em>.
When the handler is removed the <em class="parameter"><code>destroy_fn</code></em> is called
on its <em class="parameter"><code>user_data</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>repo_id</code></em> :</span></p></td>
<td>exception repository id</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fn</code></em> :</span></p></td>
<td>function to make exception human readable</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>the user data</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy_fn</code></em> :</span></p></td>
<td>user data destroy function or NULL.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-exception-general-error-set"></a><h3>bonobo_exception_general_error_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> bonobo_exception_general_error_set (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>,
<em class="parameter"><code><span class="type">CORBA_TypeCode</span> opt_deriv</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-exception-general-error-get"></a><h3>bonobo_exception_general_error_get ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * bonobo_exception_general_error_get (<em class="parameter"><code><span class="type">CORBA_Environment</span> *ev</code></em>);</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.16</div>
</body>
</html>
|