1
<refentry id="camel-camel-url-scanner">
3
<refentrytitle role="top_of_page" id="camel-camel-url-scanner.top_of_page">camel-url-scanner</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>CAMEL Library</refmiscinfo>
9
<refname>camel-url-scanner</refname>
10
<refpurpose></refpurpose>
13
<refsynopsisdiv id="camel-camel-url-scanner.synopsis" role="synopsis">
14
<title role="synopsis.title">Synopsis</title>
17
<link linkend="urlmatch-t">urlmatch_t</link>;
18
<link linkend="gboolean">gboolean</link> (<link linkend="CamelUrlScanFunc">*CamelUrlScanFunc</link>) (const <link linkend="gchar">gchar</link> *in,
19
const <link linkend="gchar">gchar</link> *pos,
20
const <link linkend="gchar">gchar</link> *inend,
21
<link linkend="urlmatch-t">urlmatch_t</link> *match);
22
<link linkend="gboolean">gboolean</link> <link linkend="camel-url-file-start">camel_url_file_start</link> (const <link linkend="gchar">gchar</link> *in,
23
const <link linkend="gchar">gchar</link> *pos,
24
const <link linkend="gchar">gchar</link> *inend,
25
<link linkend="urlmatch-t">urlmatch_t</link> *match);
26
<link linkend="gboolean">gboolean</link> <link linkend="camel-url-file-end">camel_url_file_end</link> (const <link linkend="gchar">gchar</link> *in,
27
const <link linkend="gchar">gchar</link> *pos,
28
const <link linkend="gchar">gchar</link> *inend,
29
<link linkend="urlmatch-t">urlmatch_t</link> *match);
30
<link linkend="gboolean">gboolean</link> <link linkend="camel-url-web-start">camel_url_web_start</link> (const <link linkend="gchar">gchar</link> *in,
31
const <link linkend="gchar">gchar</link> *pos,
32
const <link linkend="gchar">gchar</link> *inend,
33
<link linkend="urlmatch-t">urlmatch_t</link> *match);
34
<link linkend="gboolean">gboolean</link> <link linkend="camel-url-web-end">camel_url_web_end</link> (const <link linkend="gchar">gchar</link> *in,
35
const <link linkend="gchar">gchar</link> *pos,
36
const <link linkend="gchar">gchar</link> *inend,
37
<link linkend="urlmatch-t">urlmatch_t</link> *match);
38
<link linkend="gboolean">gboolean</link> <link linkend="camel-url-addrspec-start">camel_url_addrspec_start</link> (const <link linkend="gchar">gchar</link> *in,
39
const <link linkend="gchar">gchar</link> *pos,
40
const <link linkend="gchar">gchar</link> *inend,
41
<link linkend="urlmatch-t">urlmatch_t</link> *match);
42
<link linkend="gboolean">gboolean</link> <link linkend="camel-url-addrspec-end">camel_url_addrspec_end</link> (const <link linkend="gchar">gchar</link> *in,
43
const <link linkend="gchar">gchar</link> *pos,
44
const <link linkend="gchar">gchar</link> *inend,
45
<link linkend="urlmatch-t">urlmatch_t</link> *match);
46
<link linkend="urlpattern-t">urlpattern_t</link>;
47
<link linkend="CamelUrlScanner">CamelUrlScanner</link>;
48
<link linkend="CamelUrlScanner">CamelUrlScanner</link> * <link linkend="camel-url-scanner-new">camel_url_scanner_new</link> (void);
49
<link linkend="void">void</link> <link linkend="camel-url-scanner-free">camel_url_scanner_free</link> (<link linkend="CamelUrlScanner">CamelUrlScanner</link> *scanner);
50
<link linkend="void">void</link> <link linkend="camel-url-scanner-add">camel_url_scanner_add</link> (<link linkend="CamelUrlScanner">CamelUrlScanner</link> *scanner,
51
<link linkend="urlpattern-t">urlpattern_t</link> *pattern);
52
<link linkend="gboolean">gboolean</link> <link linkend="camel-url-scanner-scan">camel_url_scanner_scan</link> (<link linkend="CamelUrlScanner">CamelUrlScanner</link> *scanner,
53
const <link linkend="gchar">gchar</link> *in,
54
<link linkend="gsize">gsize</link> inlen,
55
<link linkend="urlmatch-t">urlmatch_t</link> *match);
67
<refsect1 id="camel-camel-url-scanner.description" role="desc">
68
<title role="desc.title">Description</title>
73
<refsect1 id="camel-camel-url-scanner.details" role="details">
74
<title role="details.title">Details</title>
75
<refsect2 id="urlmatch-t" role="struct">
76
<title>urlmatch_t</title>
77
<indexterm zone="urlmatch-t"><primary sortas="urlmatch_t">urlmatch_t</primary></indexterm><programlisting>typedef struct {
86
<refsect2 id="CamelUrlScanFunc" role="function">
87
<title>CamelUrlScanFunc ()</title>
88
<indexterm zone="CamelUrlScanFunc"><primary sortas="CamelUrlScanFunc">CamelUrlScanFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*CamelUrlScanFunc) (const <link linkend="gchar">gchar</link> *in,
89
const <link linkend="gchar">gchar</link> *pos,
90
const <link linkend="gchar">gchar</link> *inend,
91
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
93
</para><variablelist role="params">
94
<varlistentry><term><parameter>in</parameter> :</term>
96
</simpara></listitem></varlistentry>
97
<varlistentry><term><parameter>pos</parameter> :</term>
99
</simpara></listitem></varlistentry>
100
<varlistentry><term><parameter>inend</parameter> :</term>
102
</simpara></listitem></varlistentry>
103
<varlistentry><term><parameter>match</parameter> :</term>
105
</simpara></listitem></varlistentry>
106
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
107
</simpara></listitem></varlistentry>
108
</variablelist></refsect2>
109
<refsect2 id="camel-url-file-start" role="function">
110
<title>camel_url_file_start ()</title>
111
<indexterm zone="camel-url-file-start"><primary sortas="camel_url_file_start">camel_url_file_start</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_url_file_start (const <link linkend="gchar">gchar</link> *in,
112
const <link linkend="gchar">gchar</link> *pos,
113
const <link linkend="gchar">gchar</link> *inend,
114
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
116
</para><variablelist role="params">
117
<varlistentry><term><parameter>in</parameter> :</term>
119
</simpara></listitem></varlistentry>
120
<varlistentry><term><parameter>pos</parameter> :</term>
122
</simpara></listitem></varlistentry>
123
<varlistentry><term><parameter>inend</parameter> :</term>
125
</simpara></listitem></varlistentry>
126
<varlistentry><term><parameter>match</parameter> :</term>
128
</simpara></listitem></varlistentry>
129
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
130
</simpara></listitem></varlistentry>
131
</variablelist></refsect2>
132
<refsect2 id="camel-url-file-end" role="function">
133
<title>camel_url_file_end ()</title>
134
<indexterm zone="camel-url-file-end"><primary sortas="camel_url_file_end">camel_url_file_end</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_url_file_end (const <link linkend="gchar">gchar</link> *in,
135
const <link linkend="gchar">gchar</link> *pos,
136
const <link linkend="gchar">gchar</link> *inend,
137
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
139
</para><variablelist role="params">
140
<varlistentry><term><parameter>in</parameter> :</term>
142
</simpara></listitem></varlistentry>
143
<varlistentry><term><parameter>pos</parameter> :</term>
145
</simpara></listitem></varlistentry>
146
<varlistentry><term><parameter>inend</parameter> :</term>
148
</simpara></listitem></varlistentry>
149
<varlistentry><term><parameter>match</parameter> :</term>
151
</simpara></listitem></varlistentry>
152
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
153
</simpara></listitem></varlistentry>
154
</variablelist></refsect2>
155
<refsect2 id="camel-url-web-start" role="function">
156
<title>camel_url_web_start ()</title>
157
<indexterm zone="camel-url-web-start"><primary sortas="camel_url_web_start">camel_url_web_start</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_url_web_start (const <link linkend="gchar">gchar</link> *in,
158
const <link linkend="gchar">gchar</link> *pos,
159
const <link linkend="gchar">gchar</link> *inend,
160
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
162
</para><variablelist role="params">
163
<varlistentry><term><parameter>in</parameter> :</term>
165
</simpara></listitem></varlistentry>
166
<varlistentry><term><parameter>pos</parameter> :</term>
168
</simpara></listitem></varlistentry>
169
<varlistentry><term><parameter>inend</parameter> :</term>
171
</simpara></listitem></varlistentry>
172
<varlistentry><term><parameter>match</parameter> :</term>
174
</simpara></listitem></varlistentry>
175
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
176
</simpara></listitem></varlistentry>
177
</variablelist></refsect2>
178
<refsect2 id="camel-url-web-end" role="function">
179
<title>camel_url_web_end ()</title>
180
<indexterm zone="camel-url-web-end"><primary sortas="camel_url_web_end">camel_url_web_end</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_url_web_end (const <link linkend="gchar">gchar</link> *in,
181
const <link linkend="gchar">gchar</link> *pos,
182
const <link linkend="gchar">gchar</link> *inend,
183
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
185
</para><variablelist role="params">
186
<varlistentry><term><parameter>in</parameter> :</term>
188
</simpara></listitem></varlistentry>
189
<varlistentry><term><parameter>pos</parameter> :</term>
191
</simpara></listitem></varlistentry>
192
<varlistentry><term><parameter>inend</parameter> :</term>
194
</simpara></listitem></varlistentry>
195
<varlistentry><term><parameter>match</parameter> :</term>
197
</simpara></listitem></varlistentry>
198
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
199
</simpara></listitem></varlistentry>
200
</variablelist></refsect2>
201
<refsect2 id="camel-url-addrspec-start" role="function">
202
<title>camel_url_addrspec_start ()</title>
203
<indexterm zone="camel-url-addrspec-start"><primary sortas="camel_url_addrspec_start">camel_url_addrspec_start</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_url_addrspec_start (const <link linkend="gchar">gchar</link> *in,
204
const <link linkend="gchar">gchar</link> *pos,
205
const <link linkend="gchar">gchar</link> *inend,
206
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
208
</para><variablelist role="params">
209
<varlistentry><term><parameter>in</parameter> :</term>
211
</simpara></listitem></varlistentry>
212
<varlistentry><term><parameter>pos</parameter> :</term>
214
</simpara></listitem></varlistentry>
215
<varlistentry><term><parameter>inend</parameter> :</term>
217
</simpara></listitem></varlistentry>
218
<varlistentry><term><parameter>match</parameter> :</term>
220
</simpara></listitem></varlistentry>
221
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
222
</simpara></listitem></varlistentry>
223
</variablelist></refsect2>
224
<refsect2 id="camel-url-addrspec-end" role="function">
225
<title>camel_url_addrspec_end ()</title>
226
<indexterm zone="camel-url-addrspec-end"><primary sortas="camel_url_addrspec_end">camel_url_addrspec_end</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_url_addrspec_end (const <link linkend="gchar">gchar</link> *in,
227
const <link linkend="gchar">gchar</link> *pos,
228
const <link linkend="gchar">gchar</link> *inend,
229
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
231
</para><variablelist role="params">
232
<varlistentry><term><parameter>in</parameter> :</term>
234
</simpara></listitem></varlistentry>
235
<varlistentry><term><parameter>pos</parameter> :</term>
237
</simpara></listitem></varlistentry>
238
<varlistentry><term><parameter>inend</parameter> :</term>
240
</simpara></listitem></varlistentry>
241
<varlistentry><term><parameter>match</parameter> :</term>
243
</simpara></listitem></varlistentry>
244
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
245
</simpara></listitem></varlistentry>
246
</variablelist></refsect2>
247
<refsect2 id="urlpattern-t" role="struct">
248
<title>urlpattern_t</title>
249
<indexterm zone="urlpattern-t"><primary sortas="urlpattern_t">urlpattern_t</primary></indexterm><programlisting>typedef struct {
250
const gchar *pattern;
252
CamelUrlScanFunc start;
253
CamelUrlScanFunc end;
258
<refsect2 id="CamelUrlScanner" role="struct">
259
<title>CamelUrlScanner</title>
260
<indexterm zone="CamelUrlScanner"><primary sortas="CamelUrlScanner">CamelUrlScanner</primary></indexterm><programlisting>typedef struct _CamelUrlScanner CamelUrlScanner;</programlisting>
263
<refsect2 id="camel-url-scanner-new" role="function">
264
<title>camel_url_scanner_new ()</title>
265
<indexterm zone="camel-url-scanner-new"><primary sortas="camel_url_scanner_new">camel_url_scanner_new</primary></indexterm><programlisting><link linkend="CamelUrlScanner">CamelUrlScanner</link> * camel_url_scanner_new (void);</programlisting>
267
</para><variablelist role="params">
268
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
269
</simpara></listitem></varlistentry>
270
</variablelist></refsect2>
271
<refsect2 id="camel-url-scanner-free" role="function">
272
<title>camel_url_scanner_free ()</title>
273
<indexterm zone="camel-url-scanner-free"><primary sortas="camel_url_scanner_free">camel_url_scanner_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_url_scanner_free (<link linkend="CamelUrlScanner">CamelUrlScanner</link> *scanner);</programlisting>
275
</para><variablelist role="params">
276
<varlistentry><term><parameter>scanner</parameter> :</term>
278
</simpara></listitem></varlistentry>
279
</variablelist></refsect2>
280
<refsect2 id="camel-url-scanner-add" role="function">
281
<title>camel_url_scanner_add ()</title>
282
<indexterm zone="camel-url-scanner-add"><primary sortas="camel_url_scanner_add">camel_url_scanner_add</primary></indexterm><programlisting><link linkend="void">void</link> camel_url_scanner_add (<link linkend="CamelUrlScanner">CamelUrlScanner</link> *scanner,
283
<link linkend="urlpattern-t">urlpattern_t</link> *pattern);</programlisting>
285
</para><variablelist role="params">
286
<varlistentry><term><parameter>scanner</parameter> :</term>
288
</simpara></listitem></varlistentry>
289
<varlistentry><term><parameter>pattern</parameter> :</term>
291
</simpara></listitem></varlistentry>
292
</variablelist></refsect2>
293
<refsect2 id="camel-url-scanner-scan" role="function">
294
<title>camel_url_scanner_scan ()</title>
295
<indexterm zone="camel-url-scanner-scan"><primary sortas="camel_url_scanner_scan">camel_url_scanner_scan</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> camel_url_scanner_scan (<link linkend="CamelUrlScanner">CamelUrlScanner</link> *scanner,
296
const <link linkend="gchar">gchar</link> *in,
297
<link linkend="gsize">gsize</link> inlen,
298
<link linkend="urlmatch-t">urlmatch_t</link> *match);</programlisting>
300
</para><variablelist role="params">
301
<varlistentry><term><parameter>scanner</parameter> :</term>
303
</simpara></listitem></varlistentry>
304
<varlistentry><term><parameter>in</parameter> :</term>
306
</simpara></listitem></varlistentry>
307
<varlistentry><term><parameter>inlen</parameter> :</term>
309
</simpara></listitem></varlistentry>
310
<varlistentry><term><parameter>match</parameter> :</term>
312
</simpara></listitem></varlistentry>
313
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
314
</simpara></listitem></varlistentry>
315
</variablelist></refsect2>