/usr/share/gtk-doc/html/dee-1.0/dee-1.0-Dee-ICU-Extensions.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 | <!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: Dee ICU Extensions</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="DeeTreeIndex.html" title="DeeTreeIndex">
<link rel="next" href="ch04.html" title="Resources and Serialization">
<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="#dee-1.0-Dee-ICU-Extensions.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#dee-1.0-Dee-ICU-Extensions.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="DeeTreeIndex.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="dee-1.0-Dee-ICU-Extensions.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">GQuark</span>
</td>
<td class="function_name">
<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> <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="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-apply" title="dee_icu_term_filter_apply ()">dee_icu_term_filter_apply</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="dee-1.0-Dee-ICU-Extensions.html#dee-icu-term-filter-destroy" title="dee_icu_term_filter_destroy ()">dee_icu_term_filter_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="returnvalue">DeeICUTermFilter</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter"><span class="returnvalue">DeeICUTermFilter</span></a> *
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dee-1.0-Dee-ICU-Extensions.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DEE-ICU-ERROR:CAPS" title="DEE_ICU_ERROR">DEE_ICU_ERROR</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUError" title="enum DeeICUError">DeeICUError</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="dee-1.0-Dee-ICU-Extensions.html#DeeICUTermFilter" title="DeeICUTermFilter">DeeICUTermFilter</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dee-1.0-Dee-ICU-Extensions.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="dee-1.0-Dee-ICU-Extensions.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <dee-icu.h>
</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.functions_details"></a><h2>Functions</h2>
<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 class="refsect3">
<a name="id-1.4.10.8.2.5"></a><h4>Returns</h4>
<p></p>
</div>
</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="refsect3">
<a name="id-1.4.10.8.3.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>self</p></td>
<td class="parameter_description"><p>The filter to apply</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>The text to apply the filter on</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.10.8.3.6"></a><h4>Returns</h4>
<p> A newly allocated string. Free with <code class="function">g_free()</code>. </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="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="refsect3">
<a name="id-1.4.10.8.4.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>filter</p></td>
<td class="parameter_description"><p>The filter to free</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</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="refsect3">
<a name="id-1.4.10.8.5.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>system_id</p></td>
<td class="parameter_description"><p>A system id for the transliterator to use.
See userguide.icu-project.org/transforms/general</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rules</p></td>
<td class="parameter_description"><p> A set of transliteration rules to use.
See userguide.icu-project.org/transforms/general/rules. </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>error</p></td>
<td class="parameter_description"><p> A place to return a <span class="type">GError</span>, or <code class="literal">NULL</code> to ignore errors. </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>][<acronym title="Typed errors. Similar to throws in Java."><span class="acronym">error-domains</span></acronym> Dee.ICUError]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.10.8.5.6"></a><h4>Returns</h4>
<p> 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>. </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="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="refsect3">
<a name="id-1.4.10.8.6.5"></a><h4>Returns</h4>
<p> 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>. </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>
</div>
<div class="refsect1">
<a name="dee-1.0-Dee-ICU-Extensions.other_details"></a><h2>Types and Values</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>
<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 class="refsect3">
<a name="id-1.4.10.9.3.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="DEE-ICU-ERROR-BAD-RULE:CAPS"></a>DEE_ICU_ERROR_BAD_RULE</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DEE-ICU-ERROR-BAD-ID:CAPS"></a>DEE_ICU_ERROR_BAD_ID</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="DEE-ICU-ERROR-UNKNOWN:CAPS"></a>DEE_ICU_ERROR_UNKNOWN</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DeeICUTermFilter"></a><h3>DeeICUTermFilter</h3>
<pre class="programlisting">typedef struct _DeeICUTermFilter DeeICUTermFilter;</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|