This file is indexed.

/usr/share/gtk-doc/html/dee-1.0/DeeAnalyzer.html is in libdee-doc 1.0.10-3.1.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dee Reference Manual: DeeAnalyzer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch03.html" title="Indexes">
<link rel="prev" href="ch03.html" title="Indexes">
<link rel="next" href="DeeHashIndex.html" title="DeeHashIndex">
<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="#DeeAnalyzer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#DeeAnalyzer.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="DeeHashIndex.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DeeAnalyzer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DeeAnalyzer.top_of_page"></a>DeeAnalyzer</span></h2>
<p>DeeAnalyzer — Primary gateway for data indexing</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DeeAnalyzer.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">gchar</span> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="DeeAnalyzer.html#DeeCollatorFunc" title="DeeCollatorFunc ()">*DeeCollatorFunc</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="DeeAnalyzer.html#DeeTermFilterFunc" title="DeeTermFilterFunc ()">*DeeTermFilterFunc</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="DeeAnalyzer.html#dee-analyzer-add-term-filter" title="dee_analyzer_add_term_filter ()">dee_analyzer_add_term_filter</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="DeeAnalyzer.html#dee-analyzer-analyze" title="dee_analyzer_analyze ()">dee_analyzer_analyze</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-cmp" title="dee_analyzer_collate_cmp ()">dee_analyzer_collate_cmp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-cmp-func" title="dee_analyzer_collate_cmp_func ()">dee_analyzer_collate_cmp_func</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-key" title="dee_analyzer_collate_key ()">dee_analyzer_collate_key</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="returnvalue">DeeAnalyzer</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeAnalyzer.html#dee-analyzer-new" title="dee_analyzer_new ()">dee_analyzer_new</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="DeeAnalyzer.html#dee-analyzer-tokenize" title="dee_analyzer_tokenize ()">dee_analyzer_tokenize</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeAnalyzer.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="DeeAnalyzer.html#DeeAnalyzer-struct" title="struct DeeAnalyzer">DeeAnalyzer</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="DeeAnalyzer.html#DeeAnalyzerClass" title="struct DeeAnalyzerClass">DeeAnalyzerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeAnalyzer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> DeeAnalyzer
        <span class="lineart">╰──</span> <a class="link" href="DeeTextAnalyzer.html" title="DeeTextAnalyzer">DeeTextAnalyzer</a>
</pre>
</div>
<div class="refsect1">
<a name="DeeAnalyzer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;dee.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="DeeAnalyzer.description"></a><h2>Description</h2>
<p>A <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> takes a text stream, splits it into tokens, and runs the
tokens through a series of filtering steps. Optionally outputs collation
keys for the terms.</p>
<p>One of the important use cases of analyzers in Dee is as vessel for the
indexing logic for creating a <a class="link" href="DeeIndex.html" title="DeeIndex"><span class="type">DeeIndex</span></a> from a <span class="type">DeeModel</span>.</p>
<p>The recommended way to implement your own custom analyzers are by either
adding term filters to a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> or <a class="link" href="DeeTextAnalyzer.html" title="DeeTextAnalyzer"><span class="type">DeeTextAnalyzer</span></a> instance with
<a class="link" href="DeeAnalyzer.html#dee-analyzer-add-term-filter" title="dee_analyzer_add_term_filter ()"><code class="function">dee_analyzer_add_term_filter()</code></a> and/or
derive your own subclass that overrides the <a class="link" href="DeeAnalyzer.html#dee-analyzer-tokenize" title="dee_analyzer_tokenize ()"><code class="function">dee_analyzer_tokenize()</code></a> method.
Should you have very special requirements it is possible to reimplement
all aspects of the analyzer class though.</p>
</div>
<div class="refsect1">
<a name="DeeAnalyzer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="DeeCollatorFunc"></a><h3>DeeCollatorFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
<span class="c_punctuation">(</span>*DeeCollatorFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">gchar</span> *input</code></em>,
                    <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>A collator takes an input string, most often a term produced from a
<a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a>, and outputs a collation key.</p>
<div class="refsect3">
<a name="id-1.4.2.8.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>input</p></td>
<td class="parameter_description"><p>The string to produce a collation key for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p> User data set when registering the collator. </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.4.2.8.2.6"></a><h4>Returns</h4>
<p> The collation key. Free with <code class="function">g_free()</code> when done
using it. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DeeTermFilterFunc"></a><h3>DeeTermFilterFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*DeeTermFilterFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *terms_in</code></em>,
                      <em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *terms_out</code></em>,
                      <em class="parameter"><code><span class="type">gpointer</span> filter_data</code></em>);</pre>
<p>A term filter takes a list of terms and runs it through a filtering and/or
set of transformations and stores the output in a <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a>.</p>
<p>You can register term filters on a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> with
<a class="link" href="DeeAnalyzer.html#dee-analyzer-add-term-filter" title="dee_analyzer_add_term_filter ()"><code class="function">dee_analyzer_add_term_filter()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.3.6"></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>terms_in</p></td>
<td class="parameter_description"><p>A <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> with the terms to filter</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>terms_out</p></td>
<td class="parameter_description"><p>A <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> to write the filtered terms to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filter_data</p></td>
<td class="parameter_description"><p> User data set when registering the filter. </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>
<hr>
<div class="refsect2">
<a name="dee-analyzer-add-term-filter"></a><h3>dee_analyzer_add_term_filter ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_analyzer_add_term_filter (<em class="parameter"><code><a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> *self</code></em>,
                              <em class="parameter"><code><a class="link" href="DeeAnalyzer.html#DeeTermFilterFunc" title="DeeTermFilterFunc ()"><span class="type">DeeTermFilterFunc</span></a> filter_func</code></em>,
                              <em class="parameter"><code><span class="type">gpointer</span> filter_data</code></em>,
                              <em class="parameter"><code><span class="type">GDestroyNotify</span> filter_destroy</code></em>);</pre>
<p>Register a <a class="link" href="DeeAnalyzer.html#DeeTermFilterFunc" title="DeeTermFilterFunc ()"><span class="type">DeeTermFilterFunc</span></a> to be called whenever <a class="link" href="DeeAnalyzer.html#dee-analyzer-analyze" title="dee_analyzer_analyze ()"><code class="function">dee_analyzer_analyze()</code></a>
is called.</p>
<p>Term filters can be used to normalize, add, or remove terms from an input
data stream.</p>
<div class="refsect3">
<a name="id-1.4.2.8.4.6"></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>self</p></td>
<td class="parameter_description"><p>The analyzer to add a term filter to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filter_func</p></td>
<td class="parameter_description"><p> Function to call. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>filter_data</p></td>
<td class="parameter_description"><p> Data to pass to <em class="parameter"><code>filter_func</code></em>
when it is invoked. </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>
<tr>
<td class="parameter_name"><p>filter_destroy</p></td>
<td class="parameter_description"><p> Called on <em class="parameter"><code>filter_data</code></em>
when the <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a>
owning the filter is destroyed. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-analyzer-analyze"></a><h3>dee_analyzer_analyze ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_analyzer_analyze (<em class="parameter"><code><a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> *self</code></em>,
                      <em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
                      <em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *terms_out</code></em>,
                      <em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *colkeys_out</code></em>);</pre>
<p>Extract terms and or collation keys from some input data (which is normally,
but not necessarily, a UTF-8 string).</p>
<p>The terms and corresponding collation keys will be written in order to the
provided <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a>s.</p>
<p>Implementation notes for subclasses:
The analysis process must call <a class="link" href="DeeAnalyzer.html#dee-analyzer-tokenize" title="dee_analyzer_tokenize ()"><code class="function">dee_analyzer_tokenize()</code></a> and run the tokens
through all term filters added with <a class="link" href="DeeAnalyzer.html#dee-analyzer-add-term-filter" title="dee_analyzer_add_term_filter ()"><code class="function">dee_analyzer_add_term_filter()</code></a>.
Collation keys must be generated with <a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-key" title="dee_analyzer_collate_key ()"><code class="function">dee_analyzer_collate_key()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.5.7"></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>self</p></td>
<td class="parameter_description"><p>The analyzer to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>The input data to analyze</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>terms_out</p></td>
<td class="parameter_description"><p> A <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> to place the generated terms in.
If <code class="literal">NULL</code> to terms are generated. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>colkeys_out</p></td>
<td class="parameter_description"><p> A <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> to place generated collation keys in.
If <code class="literal">NULL</code> no collation keys are generated. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-analyzer-collate-cmp"></a><h3>dee_analyzer_collate_cmp ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
dee_analyzer_collate_cmp (<em class="parameter"><code><a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> *self</code></em>,
                          <em class="parameter"><code>const <span class="type">gchar</span> *key1</code></em>,
                          <em class="parameter"><code>const <span class="type">gchar</span> *key2</code></em>);</pre>
<p>Compare collation keys generated by <a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-key" title="dee_analyzer_collate_key ()"><code class="function">dee_analyzer_collate_key()</code></a> with similar
semantics as <code class="function">strcmp()</code>. See also <a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-cmp-func" title="dee_analyzer_collate_cmp_func ()"><code class="function">dee_analyzer_collate_cmp_func()</code></a> if you
need a version of this function that works as a <span class="type">GCompareDataFunc</span>.</p>
<p>The default implementation in <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> just uses <code class="function">strcmp()</code>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.6.6"></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>self</p></td>
<td class="parameter_description"><p>The analyzer to use when comparing collation keys</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key1</p></td>
<td class="parameter_description"><p>The first collation key to compare</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key2</p></td>
<td class="parameter_description"><p>The second collation key to compare</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.6.7"></a><h4>Returns</h4>
<p> -1, 0 or 1, if <em class="parameter"><code>key1</code></em>
is &lt;, == or &gt; than <em class="parameter"><code>key2</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-analyzer-collate-cmp-func"></a><h3>dee_analyzer_collate_cmp_func ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
dee_analyzer_collate_cmp_func (<em class="parameter"><code>const <span class="type">gchar</span> *key1</code></em>,
                               <em class="parameter"><code>const <span class="type">gchar</span> *key2</code></em>,
                               <em class="parameter"><code><span class="type">gpointer</span> analyzer</code></em>);</pre>
<p>A <span class="type">GCompareDataFunc</span> using a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> to compare the keys. This is just
a convenience wrapper around <a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-cmp" title="dee_analyzer_collate_cmp ()"><code class="function">dee_analyzer_collate_cmp()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.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>key1</p></td>
<td class="parameter_description"><p>The first key to compare</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key2</p></td>
<td class="parameter_description"><p>The second key to compare</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>analyzer</p></td>
<td class="parameter_description"><p>The <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> to use for the comparison</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.7.6"></a><h4>Returns</h4>
<p> -1, 0 or 1, if <em class="parameter"><code>key1</code></em>
is &lt;, == or &gt; than <em class="parameter"><code>key2</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-analyzer-collate-key"></a><h3>dee_analyzer_collate_key ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
dee_analyzer_collate_key (<em class="parameter"><code><a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> *self</code></em>,
                          <em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>);</pre>
<p>Generate a collation key for a set of input data (usually a UTF-8 string
passed through tokenization and term filters of the analyzer).</p>
<p>The default implementation just calls <code class="function">g_strdup()</code>.</p>
<div class="refsect3">
<a name="id-1.4.2.8.8.6"></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>self</p></td>
<td class="parameter_description"><p>The analyzer to generate a collation key with</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>The input data to generate a collation key for</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.2.8.8.7"></a><h4>Returns</h4>
<p> A newly allocated collation key. Use <a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-cmp" title="dee_analyzer_collate_cmp ()"><code class="function">dee_analyzer_collate_cmp()</code></a> or
<a class="link" href="DeeAnalyzer.html#dee-analyzer-collate-cmp-func" title="dee_analyzer_collate_cmp_func ()"><code class="function">dee_analyzer_collate_cmp_func()</code></a> to compare collation keys. Free
with <code class="function">g_free()</code>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-analyzer-new"></a><h3>dee_analyzer_new ()</h3>
<pre class="programlisting"><a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="returnvalue">DeeAnalyzer</span></a> *
dee_analyzer_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
<div class="refsect3">
<a name="id-1.4.2.8.9.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-analyzer-tokenize"></a><h3>dee_analyzer_tokenize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dee_analyzer_tokenize (<em class="parameter"><code><a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> *self</code></em>,
                       <em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>,
                       <em class="parameter"><code><a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> *terms_out</code></em>);</pre>
<p>Tokenize some input data (which is normally, but not necessarily,
a UTF-8 string).</p>
<p>Tokenization splits the input data into constituents (in most cases words),
but does not run it through any of the term filters set for the analyzer.
It is undefined if the tokenization process itself does any normalization.</p>
<div class="refsect3">
<a name="id-1.4.2.8.10.6"></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>self</p></td>
<td class="parameter_description"><p>The analyzer to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>The input data to analyze</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>terms_out</p></td>
<td class="parameter_description"><p>A <a class="link" href="DeeTermList.html" title="DeeTermList"><span class="type">DeeTermList</span></a> to place the generated tokens in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeAnalyzer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DeeAnalyzer-struct"></a><h3>struct DeeAnalyzer</h3>
<pre class="programlisting">struct DeeAnalyzer;</pre>
<p>All fields in the DeeAnalyzer structure are private and should never be
accessed directly</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeAnalyzerClass"></a><h3>struct DeeAnalyzerClass</h3>
<pre class="programlisting">struct DeeAnalyzerClass {
};
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>