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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libsoup-SoupUri">
<refmeta>
<refentrytitle role="top_of_page">soup-uri</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBSOUP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>soup-uri</refname>
<refpurpose>URIs</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="SoupUri">SoupUri</link>;
typedef <link linkend="SoupProtocol">SoupProtocol</link>;
#define <link linkend="SOUP-PROTOCOL-HTTP:CAPS">SOUP_PROTOCOL_HTTP</link>
#define <link linkend="SOUP-PROTOCOL-HTTPS:CAPS">SOUP_PROTOCOL_HTTPS</link>
<link linkend="SoupUri">SoupUri</link>* <link linkend="soup-uri-new-with-base">soup_uri_new_with_base</link> (const <link linkend="SoupUri">SoupUri</link> *base,
const <link linkend="char">char</link> *uri_string);
<link linkend="SoupUri">SoupUri</link>* <link linkend="soup-uri-new">soup_uri_new</link> (const <link linkend="char">char</link> *uri_string);
<link linkend="char">char</link>* <link linkend="soup-uri-to-string">soup_uri_to_string</link> (const <link linkend="SoupUri">SoupUri</link> *uri,
<link linkend="gboolean">gboolean</link> just_path);
<link linkend="SoupUri">SoupUri</link>* <link linkend="soup-uri-copy">soup_uri_copy</link> (const <link linkend="SoupUri">SoupUri</link> *uri);
<link linkend="SoupUri">SoupUri</link>* <link linkend="soup-uri-copy-root">soup_uri_copy_root</link> (const <link linkend="SoupUri">SoupUri</link> *uri);
<link linkend="gboolean">gboolean</link> <link linkend="soup-uri-equal">soup_uri_equal</link> (const <link linkend="SoupUri">SoupUri</link> *uri1,
const <link linkend="SoupUri">SoupUri</link> *uri2);
<link linkend="void">void</link> <link linkend="soup-uri-free">soup_uri_free</link> (<link linkend="SoupUri">SoupUri</link> *uri);
<link linkend="char">char</link>* <link linkend="soup-uri-encode">soup_uri_encode</link> (const <link linkend="char">char</link> *part,
const <link linkend="char">char</link> *escape_extra);
<link linkend="void">void</link> <link linkend="soup-uri-decode">soup_uri_decode</link> (<link linkend="char">char</link> *part);
<link linkend="gboolean">gboolean</link> <link linkend="soup-uri-uses-default-port">soup_uri_uses_default_port</link> (const <link linkend="SoupUri">SoupUri</link> *uri);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SoupUri" role="struct"/>struct SoupUri</title>
<indexterm><primary>SoupUri</primary></indexterm><programlisting>struct SoupUri {
SoupProtocol protocol;
char *user;
char *passwd;
char *host;
guint port;
char *path;
char *query;
char *fragment;
/* Don't use this */
gboolean broken_encoding;
};
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="SoupProtocol" role="typedef"/>SoupProtocol</title>
<indexterm><primary>SoupProtocol</primary></indexterm><programlisting>typedef GQuark SoupProtocol;
</programlisting>
<para>
<link linkend="GQuark"><type>GQuark</type></link> is used for SoupProtocol so that the protocol of a <link linkend="SoupUri"><type>SoupUri</type></link>
can be tested quickly.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="SOUP-PROTOCOL-HTTP:CAPS" role="macro"/>SOUP_PROTOCOL_HTTP</title>
<indexterm><primary>SOUP_PROTOCOL_HTTP</primary></indexterm><programlisting>#define SOUP_PROTOCOL_HTTP (g_quark_from_static_string ("http"))
</programlisting>
<para>
This returns the <link linkend="SoupProtocol"><type>SoupProtocol</type></link> value for "http".</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="SOUP-PROTOCOL-HTTPS:CAPS" role="macro"/>SOUP_PROTOCOL_HTTPS</title>
<indexterm><primary>SOUP_PROTOCOL_HTTPS</primary></indexterm><programlisting>#define SOUP_PROTOCOL_HTTPS (g_quark_from_static_string ("https"))
</programlisting>
<para>
This returns the <link linkend="SoupProtocol"><type>SoupProtocol</type></link> value for "https".</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="soup-uri-new-with-base" role="function"/>soup_uri_new_with_base ()</title>
<indexterm><primary>soup_uri_new_with_base</primary></indexterm><programlisting><link linkend="SoupUri">SoupUri</link>* soup_uri_new_with_base (const <link linkend="SoupUri">SoupUri</link> *base,
const <link linkend="char">char</link> *uri_string);</programlisting>
<para>
Parses <parameter>uri_string</parameter> relative to <parameter>base</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>base</parameter> :</term>
<listitem><simpara> a base URI
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri_string</parameter> :</term>
<listitem><simpara> the URI
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a parsed <link linkend="SoupUri"><type>SoupUri</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-new" role="function"/>soup_uri_new ()</title>
<indexterm><primary>soup_uri_new</primary></indexterm><programlisting><link linkend="SoupUri">SoupUri</link>* soup_uri_new (const <link linkend="char">char</link> *uri_string);</programlisting>
<para>
Parses an absolute URI.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri_string</parameter> :</term>
<listitem><simpara> a URI
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="SoupUri"><type>SoupUri</type></link>, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-to-string" role="function"/>soup_uri_to_string ()</title>
<indexterm><primary>soup_uri_to_string</primary></indexterm><programlisting><link linkend="char">char</link>* soup_uri_to_string (const <link linkend="SoupUri">SoupUri</link> *uri,
<link linkend="gboolean">gboolean</link> just_path);</programlisting>
<para>
Returns a string representing <parameter>uri</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a <link linkend="SoupUri"><type>SoupUri</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>just_path</parameter> :</term>
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, output just the path and query portions
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a string representing <parameter>uri</parameter>, which the caller must free.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-copy" role="function"/>soup_uri_copy ()</title>
<indexterm><primary>soup_uri_copy</primary></indexterm><programlisting><link linkend="SoupUri">SoupUri</link>* soup_uri_copy (const <link linkend="SoupUri">SoupUri</link> *uri);</programlisting>
<para>
Copies <parameter>uri</parameter></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a <link linkend="SoupUri"><type>SoupUri</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a copy of <parameter>uri</parameter>, which must be freed with <link linkend="soup-uri-free"><function>soup_uri_free()</function></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-copy-root" role="function"/>soup_uri_copy_root ()</title>
<indexterm><primary>soup_uri_copy_root</primary></indexterm><programlisting><link linkend="SoupUri">SoupUri</link>* soup_uri_copy_root (const <link linkend="SoupUri">SoupUri</link> *uri);</programlisting>
<para>
Copies the protocol, host, and port of <parameter>uri</parameter> into a new <link linkend="SoupUri"><type>SoupUri</type></link>
(all other fields in the new URI will be empty.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a <link linkend="SoupUri"><type>SoupUri</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a partial copy of <parameter>uri</parameter>, which must be freed with
<link linkend="soup-uri-free"><function>soup_uri_free()</function></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-equal" role="function"/>soup_uri_equal ()</title>
<indexterm><primary>soup_uri_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> soup_uri_equal (const <link linkend="SoupUri">SoupUri</link> *uri1,
const <link linkend="SoupUri">SoupUri</link> *uri2);</programlisting>
<para>
Tests whether or not <parameter>uri1</parameter> and <parameter>uri2</parameter> are equal in all parts</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri1</parameter> :</term>
<listitem><simpara> a <link linkend="SoupUri"><type>SoupUri</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uri2</parameter> :</term>
<listitem><simpara> another <link linkend="SoupUri"><type>SoupUri</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-free" role="function"/>soup_uri_free ()</title>
<indexterm><primary>soup_uri_free</primary></indexterm><programlisting><link linkend="void">void</link> soup_uri_free (<link linkend="SoupUri">SoupUri</link> *uri);</programlisting>
<para>
Frees <parameter>uri</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a <link linkend="SoupUri"><type>SoupUri</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-encode" role="function"/>soup_uri_encode ()</title>
<indexterm><primary>soup_uri_encode</primary></indexterm><programlisting><link linkend="char">char</link>* soup_uri_encode (const <link linkend="char">char</link> *part,
const <link linkend="char">char</link> *escape_extra);</programlisting>
<para>
This <link linkend="encodes"><literal>-encodes</literal></link> the given URI part and returns the escaped version
in allocated memory, which the caller must free when it is done.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>part</parameter> :</term>
<listitem><simpara> a URI part
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>escape_extra</parameter> :</term>
<listitem><simpara> additional characters beyond " \"%#<>{}|\^[]`"
to escape (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the encoded URI part
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-decode" role="function"/>soup_uri_decode ()</title>
<indexterm><primary>soup_uri_decode</primary></indexterm><programlisting><link linkend="void">void</link> soup_uri_decode (<link linkend="char">char</link> *part);</programlisting>
<para>
<link linkend="decodes"><literal>-decodes</literal></link> the passed-in URI *in place*. The decoded version is
never longer than the encoded version, so there does not need to
be any additional space at the end of the string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>part</parameter> :</term>
<listitem><simpara> a URI part
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-uri-uses-default-port" role="function"/>soup_uri_uses_default_port ()</title>
<indexterm><primary>soup_uri_uses_default_port</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> soup_uri_uses_default_port (const <link linkend="SoupUri">SoupUri</link> *uri);</programlisting>
<para>
Tests if <parameter>uri</parameter> uses the default port for its protocol. (Eg, 80 for
http.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter> :</term>
<listitem><simpara> a <link linkend="SoupUri"><type>SoupUri</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
