/usr/share/gtk-doc/html/dee-1.0/dee-1.0-Dee-ICU-Extensions.html is in libdee-doc 1.0.10-3.
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 | <!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 ICU Extensions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch03.html" title="Indexes">
<link rel="prev" href="DeeTreeIndex.html" title="DeeTreeIndex">
<link rel="next" href="ch04.html" title="Resources and Serialization">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="DeeTreeIndex.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Dee Reference Manual</th>
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#dee-1.0-Dee-ICU-Extensions.synopsis" class="shortcut">Top</a>
|
<a href="#dee-1.0-Dee-ICU-Extensions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="dee-1.0-Dee-ICU-Extensions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="dee-1.0-Dee-ICU-Extensions.top_of_page"></a>Dee ICU Extensions</span></h2>
<p>Dee ICU Extensions — A suite of <span class="type">DeeTermFilter</span>s based on ICU</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="dee-1.0-Dee-ICU-Extensions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <dee-icu.h>
#define <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DEE-ICU-ERROR:CAPS" title="DEE_ICU_ERROR">DEE_ICU_ERROR</a>
enum <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUError" title="enum DeeICUError">DeeICUError</a>;
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter">DeeICUTermFilter</a>;
<span class="returnvalue">GQuark</span> <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-error-quark" title="dee_icu_error_quark ()">dee_icu_error_quark</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-apply" title="dee_icu_term_filter_apply ()">dee_icu_term_filter_apply</a> (<em class="parameter"><code><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
<span class="returnvalue">void</span> <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-destroy" title="dee_icu_term_filter_destroy ()">dee_icu_term_filter_destroy</a> (<em class="parameter"><code><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a> *filter</code></em>);
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="returnvalue">DeeICUTermFilter</span></a> * <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-new" title="dee_icu_term_filter_new ()">dee_icu_term_filter_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *system_id</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *rules</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="returnvalue">DeeICUTermFilter</span></a> * <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-new-ascii-folder" title="dee_icu_term_filter_new_ascii_folder ()">dee_icu_term_filter_new_ascii_folder</a>
();
</pre>
</div>
<div class="refsect1">
<a name="dee-1.0-Dee-ICU-Extensions.description"></a><h2>Description</h2>
<p>
This module allows developers to easily construct powerful
<span class="type">DeeTermFilter</span>s with ease. The filters leverage the ICU
framework to provide world class transliteration features.
</p>
<p>
The filters can be employed manually by calling <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-apply" title="dee_icu_term_filter_apply ()"><code class="function">dee_icu_term_filter_apply()</code></a>
or installed in a <a class="link" href="DeeAnalyzer.html" title="DeeAnalyzer"><span class="type">DeeAnalyzer</span></a> by calling <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>
passing the term filter instance as the user data and
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-destroy" title="dee_icu_term_filter_destroy ()"><code class="function">dee_icu_term_filter_destroy()</code></a> as the <span class="type">GDestroyNotify</span>.
</p>
</div>
<div class="refsect1">
<a name="dee-1.0-Dee-ICU-Extensions.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="DEE-ICU-ERROR:CAPS"></a><h3>DEE_ICU_ERROR</h3>
<pre class="programlisting">#define DEE_ICU_ERROR dee_icu_error_quark()
</pre>
<p>
Error domain for the ICU extension to Dee. Error codes will be from the
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUError" title="enum DeeICUError"><span class="type">DeeICUError</span></a> enumeration
</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeICUError"></a><h3>enum DeeICUError</h3>
<pre class="programlisting">typedef enum {
DEE_ICU_ERROR_BAD_RULE,
DEE_ICU_ERROR_BAD_ID,
DEE_ICU_ERROR_UNKNOWN
} DeeICUError;
</pre>
<p>
Error codes for the ICU extension to Dee. These codes will be set when the
error domain is <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DEE-ICU-ERROR:CAPS" title="DEE_ICU_ERROR"><span class="type">DEE_ICU_ERROR</span></a>.
</p>
<p>
<em class="parameter"><code>DEE_ICU_ERROR_BAD_RULE</code></em>: Error parsing a transliteration rule
<em class="parameter"><code>DEE_ICU_ERROR_BAD_ID</code></em>: Error parsing a transliterator system id
<em class="parameter"><code>DEE_ICU_ERROR_UNKNOWN</code></em>: The ICU subsystem returned an error that is not
handled in Dee
</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeICUTermFilter"></a><h3>DeeICUTermFilter</h3>
<pre class="programlisting">typedef struct _DeeICUTermFilter DeeICUTermFilter;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="dee-icu-error-quark"></a><h3>dee_icu_error_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span> dee_icu_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="dee-icu-term-filter-apply"></a><h3>dee_icu_term_filter_apply ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * dee_icu_term_filter_apply (<em class="parameter"><code><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>
Apply a <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a> on a piece of UTF-8 text.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The filter to apply</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>The text to apply the filter on</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated string. Free with <code class="function">g_free()</code>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-icu-term-filter-destroy"></a><h3>dee_icu_term_filter_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> dee_icu_term_filter_destroy (<em class="parameter"><code><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a> *filter</code></em>);</pre>
<p>
Free all resources allocated by a <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>filter</code></em> :</span></p></td>
<td>The filter to free</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-icu-term-filter-new"></a><h3>dee_icu_term_filter_new ()</h3>
<pre class="programlisting"><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="returnvalue">DeeICUTermFilter</span></a> * dee_icu_term_filter_new (<em class="parameter"><code>const <span class="type">gchar</span> *system_id</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *rules</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Create a new <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a> for a given ICU transliterator system id
and/or set of transliteration rules.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>system_id</code></em> :</span></p></td>
<td>A system id for the transliterator to use.
See userguide.icu-project.org/transforms/general
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rules</code></em> :</span></p></td>
<td>A set of transliteration rules to use.
See userguide.icu-project.org/transforms/general/rules. <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><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>A place to return a <span class="type">GError</span>, or <code class="literal">NULL</code> to ignore errors. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Typed errors. Similar to throws in Java."><span class="acronym">error-domains</span></acronym> Dee.ICUError]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a>.
Free with <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-destroy" title="dee_icu_term_filter_destroy ()"><code class="function">dee_icu_term_filter_destroy()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-icu-term-filter-new-ascii-folder"></a><h3>dee_icu_term_filter_new_ascii_folder ()</h3>
<pre class="programlisting"><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="returnvalue">DeeICUTermFilter</span></a> * dee_icu_term_filter_new_ascii_folder
();</pre>
<p>
Construct a term filter that folds any UTF-8 string into ASCII.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated <a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="type">DeeICUTermFilter</span></a>. Free with
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-destroy" title="dee_icu_term_filter_destroy ()"><code class="function">dee_icu_term_filter_destroy()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|