/usr/share/gtk-doc/html/mialm-1.0.8/mialm-XML-manipulation-of-landmarks.html is in libmialm-doc 1.0.8-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 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 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>mialm Reference Manual: XML manipulation of landmarks</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="mialm Reference Manual">
<link rel="up" href="ch01.html" title="MIA Landmarks for 3D Visualization">
<link rel="prev" href="mialm-MiaVector3d.html" title="3D Vector">
<link rel="next" href="api-index-full.html" title="API Index">
<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="#mialm-XML-manipulation-of-landmarks.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#mialm-XML-manipulation-of-landmarks.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="mialm-MiaVector3d.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="mialm-XML-manipulation-of-landmarks"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="mialm-XML-manipulation-of-landmarks.top_of_page"></a>XML manipulation of landmarks</span></h2>
<p>XML manipulation of landmarks — XML in-and output routines for landmark related data</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="mialm-XML-manipulation-of-landmarks.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="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-start-callback" title="tag_start_callback ()">*tag_start_callback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-ch-callback" title="tag_ch_callback ()">*tag_ch_callback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-end-callback" title="tag_end_callback ()">*tag_end_callback</a><span class="c_punctuation">)</span> <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="mialm-XML-manipulation-of-landmarks.html#xmlio-end-string" title="xmlio_end_string ()">xmlio_end_string</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="mialm-XML-manipulation-of-landmarks.html#xmlio-end-float" title="xmlio_end_float ()">xmlio_end_float</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="mialm-XML-manipulation-of-landmarks.html#xmlio-get-string" title="xmlio_get_string ()">xmlio_get_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="mialm-XML-manipulation-of-landmarks.html#xml-write-float" title="xml_write_float ()">xml_write_float</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="mialm-XML-manipulation-of-landmarks.html#xml-sax-parse" title="xml_sax_parse ()">xml_sax_parse</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="mialm-XML-manipulation-of-landmarks.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserTags" title="struct ParserTags">ParserTags</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="mialm-XML-manipulation-of-landmarks.html#END-PARSER-TAGS:CAPS" title="END_PARSER_TAGS">END_PARSER_TAGS</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserState" title="struct ParserState">ParserState</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserStateStack" title="struct ParserStateStack">ParserStateStack</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="mialm-XML-manipulation-of-landmarks.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="mialm-XML-manipulation-of-landmarks.description"></a><h2>Description</h2>
<p>The functions provided in tis section are used to load ans store landmarks and
related information from and to XML trees.</p>
</div>
<div class="refsect1">
<a name="mialm-XML-manipulation-of-landmarks.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="tag-start-callback"></a><h3>tag_start_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tag_start_callback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserState" title="struct ParserState"><span class="type">ParserState</span></a> *user_data</code></em>,
<em class="parameter"><code>const <span class="type">xmlChar</span> **attrs</code></em>);</pre>
<p>This is the prototype of the callback funtion that will be called by the SAX parser at the opening of a new XML tag.</p>
<div class="refsect3">
<a name="id-1.2.8.7.2.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>user_data</p></td>
<td class="parameter_description"><p>data passd in by the user when calling the SAX parser</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attrs</p></td>
<td class="parameter_description"><p>attributes of the XML tag that was just opened. </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tag-ch-callback"></a><h3>tag_ch_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tag_ch_callback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserState" title="struct ParserState"><span class="type">ParserState</span></a> *user_data</code></em>,
<em class="parameter"><code>const <span class="type">xmlChar</span> *ch</code></em>,
<em class="parameter"><code><span class="type">int</span> len</code></em>);</pre>
<p>This is the prototype of the callback funtion that will be called whenever a chunk of characters is read
when handling an XML tag. The contents of a XML tag may come in parts, hence the incoming data should be accumulated.</p>
<div class="refsect3">
<a name="id-1.2.8.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>user_data</p></td>
<td class="parameter_description"><p>data passd in by the user when calling the SAX parser</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ch</p></td>
<td class="parameter_description"><p>character string </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>length of the incomming character string </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="tag-end-callback"></a><h3>tag_end_callback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*tag_end_callback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserState" title="struct ParserState"><span class="type">ParserState</span></a> *user_data</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property</code></em>);</pre>
<p>This is the prototype of the callback funtion that will be called by the SAX parser at the closing of a XML tag.</p>
<div class="refsect3">
<a name="id-1.2.8.7.4.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>user_data</p></td>
<td class="parameter_description"><p>data passd in by the user when calling the SAX parser</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>property identifies this tag corresponds to. </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xmlio-end-string"></a><h3>xmlio_end_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xmlio_end_string (<em class="parameter"><code><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserState" title="struct ParserState"><span class="type">ParserState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property</code></em>);</pre>
<p>Store the read string as property in the currently active entity</p>
<div class="refsect3">
<a name="id-1.2.8.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>state</p></td>
<td class="parameter_description"><p>holds the current state of the parser </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>the property that is currently read from the XML input </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xmlio-end-float"></a><h3>xmlio_end_float ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xmlio_end_float (<em class="parameter"><code><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserState" title="struct ParserState"><span class="type">ParserState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *property</code></em>);</pre>
<p>Store the read floating point value as property in the currently active entity</p>
<div class="refsect3">
<a name="id-1.2.8.7.6.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>state</p></td>
<td class="parameter_description"><p>holds the current state of the parser </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>property</p></td>
<td class="parameter_description"><p>the property that is currently read from the XML input </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xmlio-get-string"></a><h3>xmlio_get_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xmlio_get_string (<em class="parameter"><code><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserState" title="struct ParserState"><span class="type">ParserState</span></a> *state</code></em>,
<em class="parameter"><code>const <span class="type">xmlChar</span> *ch</code></em>,
<em class="parameter"><code><span class="type">int</span> len</code></em>);</pre>
<p>Append the string <em class="parameter"><code>ch</code></em>
to the currently read string in the parser state</p>
<div class="refsect3">
<a name="id-1.2.8.7.7.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>state</p></td>
<td class="parameter_description"><p>current XML parser state </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ch</p></td>
<td class="parameter_description"><p>character string </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>len</p></td>
<td class="parameter_description"><p>length of the input character string </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xml-write-float"></a><h3>xml_write_float ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xml_write_float (<em class="parameter"><code><span class="type">xmlNodePtr</span> root</code></em>,
<em class="parameter"><code><span class="type">xmlNsPtr</span> ns</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tag</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> f</code></em>);</pre>
<p>Store the value <em class="parameter"><code>f</code></em>
as new node of <em class="parameter"><code>root</code></em>
with tag <em class="parameter"><code>tag</code></em>
in namespace <em class="parameter"><code>ns</code></em>
</p>
<div class="refsect3">
<a name="id-1.2.8.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>root</p></td>
<td class="parameter_description"><p>root node to add thenew data to </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ns</p></td>
<td class="parameter_description"><p>XML name space identified </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tag</p></td>
<td class="parameter_description"><p>node tag to be used to store the data </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>f</p></td>
<td class="parameter_description"><p>floating point value to be stored </p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.8.7.8.6"></a><h4>Returns</h4>
<p> TRUE if successful, FALSE otherwise. </p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xml-sax-parse"></a><h3>xml_sax_parse ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
xml_sax_parse (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code>const <a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserTags" title="struct ParserTags"><span class="type">ParserTags</span></a> *tags</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> pdata</code></em>);</pre>
<p>Parse the given XML file by using the given callback table to handle the
tags accordingly by calling xmlSAXUserParseFile from the libxml2 library.</p>
<div class="refsect3">
<a name="id-1.2.8.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>filename</p></td>
<td class="parameter_description"><p>filename of the input XML file</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tags</p></td>
<td class="parameter_description"><p>A table of tags with their corresponding callback map </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pdata</p></td>
<td class="parameter_description"><p> Private data passed to the parser state. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.8.7.9.6"></a><h4>Returns</h4>
<p> 0 in the case of success and the error number returned by xmlSAXUserParseFile</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="mialm-XML-manipulation-of-landmarks.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ParserTags"></a><h3>struct ParserTags</h3>
<pre class="programlisting">struct ParserTags {
const gchar *tag_name;
tag_start_callback start_callback;
tag_ch_callback ch_callback;
tag_end_callback end_callback;
const ParserTags *parser_tags;
};
</pre>
<p>This table entry describes the handling of a certain XML tag. When the tag opens, it will call the
<em class="parameter"><code>start_callback</code></em>
function and push its related the property and ch_callback and end_callback values
on the <em class="parameter"><code>ParserStateStack</code></em>
that is used to parse the XML file at hand.
If a new tag is read, that the sub-table will be used to identify the proper handler, and if none is available,
the unknown tag handler will be used to skip over this tag.</p>
<div class="refsect3">
<a name="id-1.2.8.8.2.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p>const <span class="type">gchar</span> *<em class="structfield"><code><a name="ParserTags.tag-name"></a>tag_name</code></em>;</p></td>
<td class="struct_member_description"><p>name of the XML tag to be handled by this table entry </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-start-callback" title="tag_start_callback ()"><span class="type">tag_start_callback</span></a> <em class="structfield"><code><a name="ParserTags.start-callback"></a>start_callback</code></em>;</p></td>
<td class="struct_member_description"><p>callback to execute when the tag starts </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-ch-callback" title="tag_ch_callback ()"><span class="type">tag_ch_callback</span></a> <em class="structfield"><code><a name="ParserTags.ch-callback"></a>ch_callback</code></em>;</p></td>
<td class="struct_member_description"><p>callback to execute when string data is read</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-end-callback" title="tag_end_callback ()"><span class="type">tag_end_callback</span></a> <em class="structfield"><code><a name="ParserTags.end-callback"></a>end_callback</code></em>;</p></td>
<td class="struct_member_description"><p>callback to execute when the tag ends, should handle storing of the read data </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserTags" title="struct ParserTags"><span class="type">ParserTags</span></a> *<em class="structfield"><code><a name="ParserTags.parser-tags"></a>parser_tags</code></em>;</p></td>
<td class="struct_member_description"><p>sub-table that describes the supported child-tags of this XML tag </p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="END-PARSER-TAGS:CAPS"></a><h3>END_PARSER_TAGS</h3>
<pre class="programlisting">#define END_PARSER_TAGS {0,0,0,0,0}
</pre>
<p>Defines the end of a parset tags table.</p>
</div>
<hr>
<div class="refsect2">
<a name="ParserState"></a><h3>struct ParserState</h3>
<pre class="programlisting">struct ParserState {
ParserStateStack *pss;
gpointer data;
};
</pre>
<p>This structure holds the current state when parsing an XML file.</p>
<div class="refsect3">
<a name="id-1.2.8.8.4.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserStateStack" title="struct ParserStateStack"><span class="type">ParserStateStack</span></a> *<em class="structfield"><code><a name="ParserState.pss"></a>pss</code></em>;</p></td>
<td class="struct_member_description"><p>stack to store the parser states</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="ParserState.data"></a>data</code></em>;</p></td>
<td class="struct_member_description"><p>additional user data that is passed to the parser </p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ParserStateStack"></a><h3>struct ParserStateStack</h3>
<pre class="programlisting">struct ParserStateStack {
gint tag_id;
gint unknown_depth;
GString *property;
tag_ch_callback ch_callback;
tag_end_callback end_callback;
gint n_parser_tags;
const ParserTags *parser_tags;
GString *ch;
gpointer data;
};
</pre>
<p>A structure to hold the state of the parser.</p>
<div class="refsect3">
<a name="id-1.2.8.8.5.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="ParserStateStack.tag-id"></a>tag_id</code></em>;</p></td>
<td class="struct_member_description"><p>unused field??</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="ParserStateStack.unknown-depth"></a>unknown_depth</code></em>;</p></td>
<td class="struct_member_description"><p>xml-tree depth when reading (and discarding an unkown tag) </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GString</span> *<em class="structfield"><code><a name="ParserStateStack.property"></a>property</code></em>;</p></td>
<td class="struct_member_description"><p>the property related to the tag that is currently read </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-ch-callback" title="tag_ch_callback ()"><span class="type">tag_ch_callback</span></a> <em class="structfield"><code><a name="ParserStateStack.ch-callback"></a>ch_callback</code></em>;</p></td>
<td class="struct_member_description"><p>currently active callback function to handle read characters </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="mialm-XML-manipulation-of-landmarks.html#tag-end-callback" title="tag_end_callback ()"><span class="type">tag_end_callback</span></a> <em class="structfield"><code><a name="ParserStateStack.end-callback"></a>end_callback</code></em>;</p></td>
<td class="struct_member_description"><p>currently active callback funtion to call when the currently read tag ends </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="ParserStateStack.n-parser-tags"></a>n_parser_tags</code></em>;</p></td>
<td class="struct_member_description"><p>size of following tag-callback map</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <a class="link" href="mialm-XML-manipulation-of-landmarks.html#ParserTags" title="struct ParserTags"><span class="type">ParserTags</span></a> *<em class="structfield"><code><a name="ParserStateStack.parser-tags"></a>parser_tags</code></em>;</p></td>
<td class="struct_member_description"><p>table of tag-callback mappings </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GString</span> *<em class="structfield"><code><a name="ParserStateStack.ch"></a>ch</code></em>;</p></td>
<td class="struct_member_description"><p>string to accumulate corrently parsed section </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">gpointer</span> <em class="structfield"><code><a name="ParserStateStack.data"></a>data</code></em>;</p></td>
<td class="struct_member_description"><p>private data passed to the parser </p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|