Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / libxml2 / 8265a18a6afe22ac8863a6c125681b168c331b2b / . / doc / html / libxml-uri.html
blob: 36476466b79d82132939b49afdbfc3804d67d5b1 [file] [log] [blame]
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>uri</title><meta name="generator" content="DocBook XSL Stylesheets V1.58.1"><style xmlns="http://www.w3.org/TR/xhtml1/transitional" type="text/css">
3 .synopsis, .classsynopsis {
4 background: #eeeeee;
5 border: solid 1px #aaaaaa;
6 padding: 0.5em;
7 }
8 .programlisting {
9 background: #eeeeff;
10 border: solid 1px #aaaaff;
11 padding: 0.5em;
12 }
13 .variablelist {
14 padding: 4px;
15 margin-left: 3em;
16 }
17 .navigation {
18 background: #ffeeee;
19 border: solid 1px #ffaaaa;
20 margin-top: 0.5em;
21 margin-bottom: 0.5em;
22 }
23 .navigation a {
24 color: #770000;
25 }
26 .navigation a:visited {
27 color: #550000;
28 }
29 .navigation .title {
30 font-size: 200%;
31 }
32 </style><link rel="home" href="index.html" title="Gnome XML Library Reference Manual"><link rel="up" href="libxml-lib.html" title="Libxml Library Reference"><link rel="previous" href="libxml-relaxng.html" title="relaxng"><link rel="next" href="libxml-xmlerror.html" title="xmlerror"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libxml-relaxng.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td><td><a accesskey="u" href="libxml-lib.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td><th width="100%" align="center">Gnome XML Library Reference Manual</th><td><a accesskey="n" href="libxml-xmlerror.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td></tr></table><div class="refentry" lang="en"><a name="libxml-uri"></a><div class="titlepage"></div><div class="refnamediv"><h2>uri</h2><p>uri &#8212; </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]33
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]34
35
36struct <a href="libxml-uri.html#xmlURI">xmlURI</a>;
37typedef <a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a>;
38<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> <a href="libxml-uri.html#xmlCreateURI">xmlCreateURI</a> (void);
39<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-uri.html#xmlBuildURI">xmlBuildURI</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI,
40 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *base);
41<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> <a href="libxml-uri.html#xmlParseURI">xmlParseURI</a> (const char *str);
42int <a href="libxml-uri.html#xmlParseURIReference">xmlParseURIReference</a> (<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri,
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]43 const char *str);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]44<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-uri.html#xmlSaveUri">xmlSaveUri</a> (<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri);
45void <a href="libxml-uri.html#xmlPrintURI">xmlPrintURI</a> (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *stream,
46 <a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri);
47<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-uri.html#xmlURIEscapeStr">xmlURIEscapeStr</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,
48 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *list);
49char* <a href="libxml-uri.html#xmlURIUnescapeString">xmlURIUnescapeString</a> (const char *str,
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]50 int len,
51 char *target);
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]52int <a href="libxml-uri.html#xmlNormalizeURIPath">xmlNormalizeURIPath</a> (char *path);
53<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-uri.html#xmlURIEscape">xmlURIEscape</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);
54void <a href="libxml-uri.html#xmlFreeURI">xmlFreeURI</a> (<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri);
55<a href="libxml-tree.html#xmlChar">xmlChar</a>* <a href="libxml-uri.html#xmlCanonicPath">xmlCanonicPath</a> (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *path);
56</pre></div><div class="refsect1" lang="en"><h2>Description</h2><p>
57
58</p></div><div class="refsect1" lang="en"><h2>Details</h2><div class="refsect2" lang="en"><h3><a name="xmlURI"></a>struct xmlURI</h3><pre class="programlisting">struct xmlURI {
Daniel Veillardef90ba72001-12-07 14:24:22 +0000[diff] [blame]59 char *scheme; /* the URI scheme */
60 char *opaque; /* opaque part */
61 char *authority; /* the authority part */
62 char *server; /* the server part */
63 char *user; /* the user part */
64 int port; /* the port number */
65 char *path; /* the path string */
66 char *query; /* the query string */
67 char *fragment; /* the fragment identifier */
68 int cleanup; /* parsing potentially unclean URI */
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]69};
70</pre><p>
71A parsed URI reference. This is a struct containing the various fields
72as described in RFC 2396 but separated for further processing.</p><p>
73
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]74</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlURIPtr"></a>xmlURIPtr</h3><p>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]75
76</p></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCreateURI"></a>xmlCreateURI ()</h3><pre class="programlisting"><a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> xmlCreateURI (void);</pre><p>
77Simply creates an empty xmlURI</p><p>
78
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]79</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
80
81
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]82</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlBuildURI"></a>xmlBuildURI ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlBuildURI (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *URI,
83 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *base);</pre><p>
84Computes he final URI of the reference done by checking that
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]85the given URI is valid, and building the final URI using the
86base URI. This is processed according to section 5.2 of the
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]87RFC 2396
88</p><p>
895.2. Resolving Relative References to Absolute Form</p><p>
90
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]91</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>URI</tt></i> :</span></td><td>
92</td></tr><tr><td><span class="term"><i><tt>base</tt></i> :</span></td><td>
93</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
94
95
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]96</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseURI"></a>xmlParseURI ()</h3><pre class="programlisting"><a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> xmlParseURI (const char *str);</pre><p>
97Parse an URI
98</p><p>
99URI-reference = [ absoluteURI | relativeURI ] [ &quot;#&quot; fragment ]</p><p>
100
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]101</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td>
102</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
103
104
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]105</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlParseURIReference"></a>xmlParseURIReference ()</h3><pre class="programlisting">int xmlParseURIReference (<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri,
106 const char *str);</pre><p>
107Parse an URI reference string and fills in the appropriate fields
108of the <i><tt>uri</tt></i> structure
109</p><p>
110URI-reference = [ absoluteURI | relativeURI ] [ &quot;#&quot; fragment ]</p><p>
111
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]112</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>uri</tt></i> :</span></td><td>
113</td></tr><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td>
114</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
115
116
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]117</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlSaveUri"></a>xmlSaveUri ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlSaveUri (<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri);</pre><p>
118Save the URI as an escaped string</p><p>
119
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]120</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>uri</tt></i> :</span></td><td>
121</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
122
123
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]124</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlPrintURI"></a>xmlPrintURI ()</h3><pre class="programlisting">void xmlPrintURI (<GTKDOCLINK xmlns="http://www.w3.org/TR/xhtml1/transitional" HREF="FILE-CAPS">FILE</GTKDOCLINK> *stream,
125 <a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri);</pre><p>
126Prints the URI in the stream <i><tt>steam</tt></i>.</p><p>
127
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]128</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>stream</tt></i> :</span></td><td>
129</td></tr><tr><td><span class="term"><i><tt>uri</tt></i> :</span></td><td>
130
131
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]132</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlURIEscapeStr"></a>xmlURIEscapeStr ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlURIEscapeStr (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str,
133 const <a href="libxml-tree.html#xmlChar">xmlChar</a> *list);</pre><p>
134This routine escapes a string to hex, ignoring reserved characters (a-z)
135and the characters in the exception list.</p><p>
136
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]137</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td>
138</td></tr><tr><td><span class="term"><i><tt>list</tt></i> :</span></td><td>
139</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
140
141
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]142</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlURIUnescapeString"></a>xmlURIUnescapeString ()</h3><pre class="programlisting">char* xmlURIUnescapeString (const char *str,
Daniel Veillardb732a0e2000-10-15 11:27:01 +0000[diff] [blame]143 int len,
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]144 char *target);</pre><p>
145Unescaping routine, does not do validity checks !
146Output is direct unsigned char translation of <tt>XX</tt> values (no encoding)</p><p>
147
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]148</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td>
149</td></tr><tr><td><span class="term"><i><tt>len</tt></i> :</span></td><td>
150</td></tr><tr><td><span class="term"><i><tt>target</tt></i> :</span></td><td>
151</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
152
153
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]154</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlNormalizeURIPath"></a>xmlNormalizeURIPath ()</h3><pre class="programlisting">int xmlNormalizeURIPath (char *path);</pre><p>
155Applies the 5 normalization steps to a path string--that is, RFC 2396
156Section 5.2, steps 6.c through 6.g.
157</p><p>
158Normalization occurs directly on the string, no new allocation is done</p><p>
159
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]160</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>path</tt></i> :</span></td><td>
161</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
162
163
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]164</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlURIEscape"></a>xmlURIEscape ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlURIEscape (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *str);</pre><p>
165Escaping routine, does not do validity checks !
Daniel Veillard28929b22000-11-13 18:22:49 +0000[diff] [blame]166It will try to escape the chars needing this, but this is heuristic
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]167based it's impossible to be sure.</p><p>
168
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]169</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>str</tt></i> :</span></td><td>
170</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]171
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]172
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]173</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlFreeURI"></a>xmlFreeURI ()</h3><pre class="programlisting">void xmlFreeURI (<a href="libxml-uri.html#xmlURIPtr">xmlURIPtr</a> uri);</pre><p>
174Free up the xmlURI struct</p><p>
175
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]176</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>uri</tt></i> :</span></td><td>
177
178
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]179</td></tr></tbody></table></div></div><hr xmlns="http://www.w3.org/TR/xhtml1/transitional"></hr><div class="refsect2" lang="en"><h3><a name="xmlCanonicPath"></a>xmlCanonicPath ()</h3><pre class="programlisting"><a href="libxml-tree.html#xmlChar">xmlChar</a>* xmlCanonicPath (const <a href="libxml-tree.html#xmlChar">xmlChar</a> *path);</pre><p>
180Constructs a canonic path from the specified path.</p><p>
181
Daniel Veillard93d95252003-04-29 20:25:40 +0000[diff] [blame]182</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i><tt>path</tt></i> :</span></td><td>
183</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>
184
185
Daniel Veillardd4330462003-04-29 12:40:16 +0000[diff] [blame]186</td></tr></tbody></table></div></div></div></div><table xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libxml-relaxng.html"><b>&lt;&lt; relaxng</b></a></td><td align="right"><a accesskey="n" href="libxml-xmlerror.html"><b>xmlerror &gt;&gt;</b></a></td></tr></table></body></html>