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
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="raptor-section-xml-namespace">
<refmeta>
<refentrytitle role="top_of_page">XML Namespaces</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>RAPTOR Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>XML Namespaces</refname>
<refpurpose>Namespaces in XML include stacks of Namespaces</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
typedef <link linkend="raptor-namespace">raptor_namespace</link>;
<link linkend="raptor-namespace">raptor_namespace</link>* <link linkend="raptor-new-namespace-from-uri">raptor_new_namespace_from_uri</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
<link linkend="raptor-uri">raptor_uri</link> *ns_uri,
<link linkend="int">int</link> depth);
<link linkend="raptor-namespace-stack">raptor_namespace_stack</link>* <link linkend="raptor-new-namespaces">raptor_new_namespaces</link>
(<link linkend="raptor-uri-handler">raptor_uri_handler</link> *uri_handler,
<link linkend="void">void</link> *uri_context,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data,
<link linkend="int">int</link> defaults);
<link linkend="void">void</link> <link linkend="raptor-namespaces-init">raptor_namespaces_init</link> (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-uri-handler">raptor_uri_handler</link> *uri_handler,
<link linkend="void">void</link> *uri_context,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data,
<link linkend="int">int</link> defaults);
<link linkend="void">void</link> <link linkend="raptor-namespaces-clear">raptor_namespaces_clear</link> (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack);
<link linkend="void">void</link> <link linkend="raptor-free-namespaces">raptor_free_namespaces</link> (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack);
<link linkend="void">void</link> <link linkend="raptor-namespaces-start-namespace">raptor_namespaces_start_namespace</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-namespace">raptor_namespace</link> *nspace);
<link linkend="int">int</link> <link linkend="raptor-namespaces-start-namespace-full">raptor_namespaces_start_namespace_full</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
unsigned <link linkend="char">char</link> *ns_uri_string,
<link linkend="int">int</link> depth);
<link linkend="void">void</link> <link linkend="raptor-namespaces-end-for-depth">raptor_namespaces_end_for_depth</link> (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="int">int</link> depth);
<link linkend="raptor-namespace">raptor_namespace</link>* <link linkend="raptor-namespaces-get-default-namespace">raptor_namespaces_get_default_namespace</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack);
<link linkend="raptor-namespace">raptor_namespace</link>* <link linkend="raptor-namespaces-find-namespace">raptor_namespaces_find_namespace</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
<link linkend="int">int</link> prefix_length);
<link linkend="raptor-namespace">raptor_namespace</link>* <link linkend="raptor-namespaces-find-namespace-by-uri">raptor_namespaces_find_namespace_by_uri</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-uri">raptor_uri</link> *ns_uri);
<link linkend="int">int</link> <link linkend="raptor-namespaces-namespace-in-scope">raptor_namespaces_namespace_in_scope</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
const <link linkend="raptor-namespace">raptor_namespace</link> *nspace);
<link linkend="raptor-namespace">raptor_namespace</link>* <link linkend="raptor-new-namespace">raptor_new_namespace</link> (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
unsigned <link linkend="char">char</link> *ns_uri_string,
<link linkend="int">int</link> depth);
<link linkend="void">void</link> <link linkend="raptor-free-namespace">raptor_free_namespace</link> (<link linkend="raptor-namespace">raptor_namespace</link> *ns);
<link linkend="int">int</link> <link linkend="raptor-namespace-copy">raptor_namespace_copy</link> (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-namespace">raptor_namespace</link> *ns,
<link linkend="int">int</link> new_depth);
<link linkend="raptor-uri">raptor_uri</link>* <link linkend="raptor-namespace-get-uri">raptor_namespace_get_uri</link> (const <link linkend="raptor-namespace">raptor_namespace</link> *ns);
const unsigned <link linkend="char">char</link>* <link linkend="raptor-namespace-get-prefix">raptor_namespace_get_prefix</link>
(const <link linkend="raptor-namespace">raptor_namespace</link> *ns);
const unsigned <link linkend="char">char</link>* <link linkend="raptor-namespace-get-counted-prefix">raptor_namespace_get_counted_prefix</link>
(const <link linkend="raptor-namespace">raptor_namespace</link> *ns,
<link linkend="size-t">size_t</link> *length_p);
unsigned <link linkend="char">char</link>* <link linkend="raptor-namespaces-format">raptor_namespaces_format</link> (const <link linkend="raptor-namespace">raptor_namespace</link> *ns,
<link linkend="size-t">size_t</link> *length_p);
<link linkend="int">int</link> <link linkend="raptor-iostream-write-namespace">raptor_iostream_write_namespace</link> (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
<link linkend="raptor-namespace">raptor_namespace</link> *ns);
<link linkend="int">int</link> <link linkend="raptor-new-namespace-parts-from-string">raptor_new_namespace_parts_from_string</link>
(unsigned <link linkend="char">char</link> *string,
unsigned <link linkend="char">char</link> **prefix,
unsigned <link linkend="char">char</link> **uri_string);
typedef <link linkend="raptor-namespace-stack">raptor_namespace_stack</link>;
<link linkend="raptor-qname">raptor_qname</link>* <link linkend="raptor-namespaces-qname-from-uri">raptor_namespaces_qname_from_uri</link>
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="int">int</link> xml_version);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Two classes that provide an XML namespace - short prefix (or none) and
absolute URI (or none) to match the form <literal>xmlns...="..."</literal>
seen in XML. A stack of namespaces <link linkend="raptor-namespace-stack"><type>raptor_namespace_stack</type></link> is also
provided to handle in-scope namespace calculations that happen inside
XML documents where inner namespaces can override outer ones.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="raptor-namespace" role="typedef"/>raptor_namespace</title>
<indexterm><primary>raptor_namespace</primary></indexterm><programlisting>raptor_namespace* raptor_namespace;
</programlisting>
<para>
Raptor XML Namespace class</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="raptor-new-namespace-from-uri" role="function"/>raptor_new_namespace_from_uri ()</title>
<indexterm><primary>raptor_new_namespace_from_uri</primary></indexterm><programlisting><link linkend="raptor-namespace">raptor_namespace</link>* raptor_new_namespace_from_uri
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
<link linkend="raptor-uri">raptor_uri</link> *ns_uri,
<link linkend="int">int</link> depth);</programlisting>
<para>
Constructor - create a new namespace from a prefix and URI object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix</parameter> :</term>
<listitem><simpara> namespace prefix string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns_uri</parameter> :</term>
<listitem><simpara> namespace URI
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter> :</term>
<listitem><simpara> depth of namespace in the stack
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="raptor-namespace"><type>raptor_namespace</type></link> or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-new-namespaces" role="function"/>raptor_new_namespaces ()</title>
<indexterm><primary>raptor_new_namespaces</primary></indexterm><programlisting><link linkend="raptor-namespace-stack">raptor_namespace_stack</link>* raptor_new_namespaces
(<link linkend="raptor-uri-handler">raptor_uri_handler</link> *uri_handler,
<link linkend="void">void</link> *uri_context,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data,
<link linkend="int">int</link> defaults);</programlisting>
<para>
Constructor - create a new <link linkend="raptor-namespace-stack"><type>raptor_namespace_stack</type></link>.
</para>
<para>
See <link linkend="raptor-namespaces-init"><function>raptor_namespaces_init()</function></link> fo the values of <parameter>defaults</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri_handler</parameter> :</term>
<listitem><simpara> URI handler function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri_context</parameter> :</term>
<listitem><simpara> URI handler context data
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error_handler</parameter> :</term>
<listitem><simpara> error handler function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error_data</parameter> :</term>
<listitem><simpara> erorr handler data
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>defaults</parameter> :</term>
<listitem><simpara> namespaces to initialise
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new namespace stack or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-init" role="function"/>raptor_namespaces_init ()</title>
<indexterm><primary>raptor_namespaces_init</primary></indexterm><programlisting><link linkend="void">void</link> raptor_namespaces_init (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-uri-handler">raptor_uri_handler</link> *uri_handler,
<link linkend="void">void</link> *uri_context,
<link linkend="raptor-simple-message-handler">raptor_simple_message_handler</link> error_handler,
<link linkend="void">void</link> *error_data,
<link linkend="int">int</link> defaults);</programlisting>
<para>
Initialise a namespaces stack some optional common namespaces.
</para>
<para>
<parameter>defaults</parameter> can be 0 for none, 1 for just XML, 2 for RDF, RDFS, OWL
and XSD (RDQL uses this) or 3+ undefined.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> <link linkend="raptor-namespace-stack"><type>raptor_namespace_stack</type></link> to initialise
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri_handler</parameter> :</term>
<listitem><simpara> URI handler function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri_context</parameter> :</term>
<listitem><simpara> context for URI handler
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error_handler</parameter> :</term>
<listitem><simpara> error handler function
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error_data</parameter> :</term>
<listitem><simpara> context for error handler
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>defaults</parameter> :</term>
<listitem><simpara> namespaces to initialise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-clear" role="function"/>raptor_namespaces_clear ()</title>
<indexterm><primary>raptor_namespaces_clear</primary></indexterm><programlisting><link linkend="void">void</link> raptor_namespaces_clear (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack);</programlisting>
<para>
Empty a namespace stack of namespaces and any other resources.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-free-namespaces" role="function"/>raptor_free_namespaces ()</title>
<indexterm><primary>raptor_free_namespaces</primary></indexterm><programlisting><link linkend="void">void</link> raptor_free_namespaces (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack);</programlisting>
<para>
Destructor - destroy a namespace stack</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-start-namespace" role="function"/>raptor_namespaces_start_namespace ()</title>
<indexterm><primary>raptor_namespaces_start_namespace</primary></indexterm><programlisting><link linkend="void">void</link> raptor_namespaces_start_namespace
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-namespace">raptor_namespace</link> *nspace);</programlisting>
<para>
Start a namespace on a stack of namespaces.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nspace</parameter> :</term>
<listitem><simpara> namespace to start
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-start-namespace-full" role="function"/>raptor_namespaces_start_namespace_full ()</title>
<indexterm><primary>raptor_namespaces_start_namespace_full</primary></indexterm><programlisting><link linkend="int">int</link> raptor_namespaces_start_namespace_full
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
unsigned <link linkend="char">char</link> *ns_uri_string,
<link linkend="int">int</link> depth);</programlisting>
<para>
Create a new namespace and start it on a stack of namespaces.
</para>
<para>
See <link linkend="raptor-new-namespace"><function>raptor_new_namespace()</function></link> for the meanings of <parameter>prefix</parameter>,
<parameter>ns_uri_string</parameter> and <parameter>depth</parameter> for namespaces.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix</parameter> :</term>
<listitem><simpara> new namespace prefix (or NULL)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns_uri_string</parameter> :</term>
<listitem><simpara> new namespace URI (or NULL)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter> :</term>
<listitem><simpara> new namespace depth
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-end-for-depth" role="function"/>raptor_namespaces_end_for_depth ()</title>
<indexterm><primary>raptor_namespaces_end_for_depth</primary></indexterm><programlisting><link linkend="void">void</link> raptor_namespaces_end_for_depth (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="int">int</link> depth);</programlisting>
<para>
End all namespaces at the given depth in the namespace stack.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter> :</term>
<listitem><simpara> depth
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-get-default-namespace" role="function"/>raptor_namespaces_get_default_namespace ()</title>
<indexterm><primary>raptor_namespaces_get_default_namespace</primary></indexterm><programlisting><link linkend="raptor-namespace">raptor_namespace</link>* raptor_namespaces_get_default_namespace
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack);</programlisting>
<para>
Get the current default namespace in-scope in a stack.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="raptor-namespace"><type>raptor_namespace</type></link> or NULL if no default namespace is in scope
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-find-namespace" role="function"/>raptor_namespaces_find_namespace ()</title>
<indexterm><primary>raptor_namespaces_find_namespace</primary></indexterm><programlisting><link linkend="raptor-namespace">raptor_namespace</link>* raptor_namespaces_find_namespace
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
<link linkend="int">int</link> prefix_length);</programlisting>
<para>
Find a namespace in a namespace stack by prefix.
</para>
<para>
Note that this uses the <parameter>length</parameter> so that the prefix may be a prefix (sic)
of a longer string. If <parameter>prefix</parameter> is NULL, the default namespace will
be returned if present, <parameter>prefix_length</parameter> length is ignored in this case.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix</parameter> :</term>
<listitem><simpara> namespace prefix to find
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix_length</parameter> :</term>
<listitem><simpara> length of prefix.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="raptor-namespace"><type>raptor_namespace</type></link> for the prefix or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-find-namespace-by-uri" role="function"/>raptor_namespaces_find_namespace_by_uri ()</title>
<indexterm><primary>raptor_namespaces_find_namespace_by_uri</primary></indexterm><programlisting><link linkend="raptor-namespace">raptor_namespace</link>* raptor_namespaces_find_namespace_by_uri
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-uri">raptor_uri</link> *ns_uri);</programlisting>
<para>
Find a namespace in a namespace stack by namespace URI.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns_uri</parameter> :</term>
<listitem><simpara> namespace URI to find
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="raptor-namespace"><type>raptor_namespace</type></link> for the URI or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-namespace-in-scope" role="function"/>raptor_namespaces_namespace_in_scope ()</title>
<indexterm><primary>raptor_namespaces_namespace_in_scope</primary></indexterm><programlisting><link linkend="int">int</link> raptor_namespaces_namespace_in_scope
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
const <link linkend="raptor-namespace">raptor_namespace</link> *nspace);</programlisting>
<para>
Test if a given namespace is in-scope in the namespace stack.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>nspace</parameter> :</term>
<listitem><simpara> namespace
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 if the namespace is in scope.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-new-namespace" role="function"/>raptor_new_namespace ()</title>
<indexterm><primary>raptor_new_namespace</primary></indexterm><programlisting><link linkend="raptor-namespace">raptor_namespace</link>* raptor_new_namespace (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
unsigned <link linkend="char">char</link> *prefix,
unsigned <link linkend="char">char</link> *ns_uri_string,
<link linkend="int">int</link> depth);</programlisting>
<para>
Constructor - create a new namespace from a prefix and URI string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix</parameter> :</term>
<listitem><simpara> namespace prefix string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns_uri_string</parameter> :</term>
<listitem><simpara> namespace URI string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>depth</parameter> :</term>
<listitem><simpara> depth of namespace in the stack
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="raptor-namespace"><type>raptor_namespace</type></link> or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-free-namespace" role="function"/>raptor_free_namespace ()</title>
<indexterm><primary>raptor_free_namespace</primary></indexterm><programlisting><link linkend="void">void</link> raptor_free_namespace (<link linkend="raptor-namespace">raptor_namespace</link> *ns);</programlisting>
<para>
Destructor - destroy a namespace.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ns</parameter> :</term>
<listitem><simpara> namespace object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespace-copy" role="function"/>raptor_namespace_copy ()</title>
<indexterm><primary>raptor_namespace_copy</primary></indexterm><programlisting><link linkend="int">int</link> raptor_namespace_copy (<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-namespace">raptor_namespace</link> *ns,
<link linkend="int">int</link> new_depth);</programlisting>
<para>
Copy a namespace to a new namespace stack with a new depth.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns</parameter> :</term>
<listitem><simpara> namespace
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_depth</parameter> :</term>
<listitem><simpara> new depth
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespace-get-uri" role="function"/>raptor_namespace_get_uri ()</title>
<indexterm><primary>raptor_namespace_get_uri</primary></indexterm><programlisting><link linkend="raptor-uri">raptor_uri</link>* raptor_namespace_get_uri (const <link linkend="raptor-namespace">raptor_namespace</link> *ns);</programlisting>
<para>
Get the namespace URI.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ns</parameter> :</term>
<listitem><simpara> namespace object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> namespace URI or NULL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespace-get-prefix" role="function"/>raptor_namespace_get_prefix ()</title>
<indexterm><primary>raptor_namespace_get_prefix</primary></indexterm><programlisting>const unsigned <link linkend="char">char</link>* raptor_namespace_get_prefix
(const <link linkend="raptor-namespace">raptor_namespace</link> *ns);</programlisting>
<para>
Get the namespace prefix.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ns</parameter> :</term>
<listitem><simpara> namespace object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> prefix string or NULL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespace-get-counted-prefix" role="function"/>raptor_namespace_get_counted_prefix ()</title>
<indexterm><primary>raptor_namespace_get_counted_prefix</primary></indexterm><programlisting>const unsigned <link linkend="char">char</link>* raptor_namespace_get_counted_prefix
(const <link linkend="raptor-namespace">raptor_namespace</link> *ns,
<link linkend="size-t">size_t</link> *length_p);</programlisting>
<para>
Get the namespace prefix and length.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ns</parameter> :</term>
<listitem><simpara> namespace object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length_p</parameter> :</term>
<listitem><simpara> pointer to store length or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> prefix string or NULL
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-format" role="function"/>raptor_namespaces_format ()</title>
<indexterm><primary>raptor_namespaces_format</primary></indexterm><programlisting>unsigned <link linkend="char">char</link>* raptor_namespaces_format (const <link linkend="raptor-namespace">raptor_namespace</link> *ns,
<link linkend="size-t">size_t</link> *length_p);</programlisting>
<para>
Format a namespace in an XML style into a newly allocated string.
</para>
<para>
Generates a string of the form xmlns:prefix="uri",
xmlns="uri", xmlns:prefix="" or xmlns="" depending on the
namespace's prefix or URI. Double quotes are always used.
</para>
<para>
If <parameter>length_p</parameter> is not NULL, the length of the string is
stored in the address it points to.
</para>
<para>
See also <link linkend="raptor-new-namespace-parts-from-string"><function>raptor_new_namespace_parts_from_string()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ns</parameter> :</term>
<listitem><simpara> namespace object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length_p</parameter> :</term>
<listitem><simpara> pointer to length (or NULL)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> namespace formatted as newly allocated string or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-iostream-write-namespace" role="function"/>raptor_iostream_write_namespace ()</title>
<indexterm><primary>raptor_iostream_write_namespace</primary></indexterm><programlisting><link linkend="int">int</link> raptor_iostream_write_namespace (<link linkend="raptor-iostream">raptor_iostream</link> *iostr,
<link linkend="raptor-namespace">raptor_namespace</link> *ns);</programlisting>
<para>
Write a formatted namespace to an iostream</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>iostr</parameter> :</term>
<listitem><simpara> raptor iosteram
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ns</parameter> :</term>
<listitem><simpara> namespace to write
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-new-namespace-parts-from-string" role="function"/>raptor_new_namespace_parts_from_string ()</title>
<indexterm><primary>raptor_new_namespace_parts_from_string</primary></indexterm><programlisting><link linkend="int">int</link> raptor_new_namespace_parts_from_string
(unsigned <link linkend="char">char</link> *string,
unsigned <link linkend="char">char</link> **prefix,
unsigned <link linkend="char">char</link> **uri_string);</programlisting>
<para>
Parse a string containin an XML style namespace declaration
into a namespace prefix and URI.
</para>
<para>
The string is of the form xmlns:prefix="uri",
xmlns="uri", xmlns:prefix="" or xmlns="".
The quotes can be single or double quotes.
</para>
<para>
Two values are returned from this function into *<parameter>prefix</parameter> and
*<parameter>uri_string</parameter> neither of which may be NULL.
</para>
<para>
See also <link linkend="raptor-namespaces-format"><function>raptor_namespaces_format()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string</parameter> :</term>
<listitem><simpara> string to parse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>prefix</parameter> :</term>
<listitem><simpara> pointer to location to store namespace prefix
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri_string</parameter> :</term>
<listitem><simpara> pointer to location to store namespace URI
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> non-0 on failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="raptor-namespace-stack" role="typedef"/>raptor_namespace_stack</title>
<indexterm><primary>raptor_namespace_stack</primary></indexterm><programlisting>raptor_namespace_stack* raptor_namespace_stack;
</programlisting>
<para>
Raptor XML Namespace Stack class</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="raptor-namespaces-qname-from-uri" role="function"/>raptor_namespaces_qname_from_uri ()</title>
<indexterm><primary>raptor_namespaces_qname_from_uri</primary></indexterm><programlisting><link linkend="raptor-qname">raptor_qname</link>* raptor_namespaces_qname_from_uri
(<link linkend="raptor-namespace-stack">raptor_namespace_stack</link> *nstack,
<link linkend="raptor-uri">raptor_uri</link> *uri,
<link linkend="int">int</link> xml_version);</programlisting>
<para>
Make an appropriate XML Qname from the namespaces on a namespace stack
</para>
<para>
Makes a qname from the in-scope namespaces in a stack if the URI matches
the prefix and the rest is a legal XML name.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>nstack</parameter> :</term>
<listitem><simpara> namespace stack
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> URI to use to make qname
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xml_version</parameter> :</term>
<listitem><simpara> XML Version
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="raptor-qname"><type>raptor_qname</type></link> for the URI or NULL on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
