/usr/share/doc/enca/html/libenca/libenca-Auxiliary-Functions.html is in libenca-dev 1.13-4.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Auxiliary functions</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Enca Library Reference Manual">
<link rel="up" href="ch01.html" title="Enca Library API">
<link rel="prev" href="libenca-Charsets-and-Surfaces.html" title="Charsets and Surfaces">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Enca Library API">
</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="libenca-Charsets-and-Surfaces.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Enca Library Reference Manual</th>
<td> </td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libenca-Auxiliary-Functions.synopsis" class="shortcut">Top</a>
|
<a href="#libenca-Auxiliary-Functions.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Auxiliary functions">
<a name="libenca-Auxiliary-Functions"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libenca-Auxiliary-Functions.top_of_page"></a>Auxiliary functions</span></h2>
<p>Auxiliary functions — Variouis auxiliary functions and informations about libenca.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libenca-Auxiliary-Functions.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
int <a class="link" href="libenca-Auxiliary-Functions.html#enca-charset-has-ucs2-map" title="enca_charset_has_ucs2_map ()">enca_charset_has_ucs2_map</a> (int charset);
int <a class="link" href="libenca-Auxiliary-Functions.html#enca-charset-ucs2-map" title="enca_charset_ucs2_map ()">enca_charset_ucs2_map</a> (int charset,
unsigned int *buffer);
size_t <a class="link" href="libenca-Auxiliary-Functions.html#enca-number-of-charsets" title="enca_number_of_charsets ()">enca_number_of_charsets</a> (void);
const char* <a class="link" href="libenca-Auxiliary-Functions.html#enca-analyser-language" title="enca_analyser_language ()">enca_analyser_language</a> (EncaAnalyser analyser);
const char** <a class="link" href="libenca-Auxiliary-Functions.html#enca-get-languages" title="enca_get_languages ()">enca_get_languages</a> (size_t *n);
const char* <a class="link" href="libenca-Auxiliary-Functions.html#enca-language-english-name" title="enca_language_english_name ()">enca_language_english_name</a> (const char *lang);
int* <a class="link" href="libenca-Auxiliary-Functions.html#enca-get-language-charsets" title="enca_get_language_charsets ()">enca_get_language_charsets</a> (const char *langname,
size_t *n);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libenca-Auxiliary-Functions.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="libenca-Auxiliary-Functions.details"></a><h2>Details</h2>
<div class="refsect2" title="enca_charset_has_ucs2_map ()">
<a name="enca-charset-has-ucs2-map"></a><h3>enca_charset_has_ucs2_map ()</h3>
<pre class="programlisting">int enca_charset_has_ucs2_map (int charset);</pre>
<p>
Find whether we have charset -> UCS-2 map.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
<td> An 8bit charset.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Nonzero when the map is available, zero otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enca_charset_ucs2_map ()">
<a name="enca-charset-ucs2-map"></a><h3>enca_charset_ucs2_map ()</h3>
<pre class="programlisting">int enca_charset_ucs2_map (int charset,
unsigned int *buffer);</pre>
<p>
Creates map from an 8bit charset to UCS-2.
</p>
<p>
The buffer must be at least 256*sizeof(unsigned int) long to hold the map.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>charset</code></em> :</span></p></td>
<td> An 8bit charset.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td> Buffer to store the map to.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Nonzero when the map was successfully created, zero otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enca_number_of_charsets ()">
<a name="enca-number-of-charsets"></a><h3>enca_number_of_charsets ()</h3>
<pre class="programlisting">size_t enca_number_of_charsets (void);</pre>
<p>
Returns number of known charsets.
</p>
<p>
Charsets idetifiers are assigned successively starting from zero, so last
charset has identifier <a class="link" href="libenca-Auxiliary-Functions.html#enca-number-of-charsets" title="enca_number_of_charsets ()"><code class="function">enca_number_of_charsets()</code></a> - 1.</p>
<p>
</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> The number of charsets.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enca_analyser_language ()">
<a name="enca-analyser-language"></a><h3>enca_analyser_language ()</h3>
<pre class="programlisting">const char* enca_analyser_language (EncaAnalyser analyser);</pre>
<p>
Returns name of language which was <em class="parameter"><code>analyser</code></em> initialized for.
</p>
<p>
The returned string must be considered constant and must NOT be freed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>analyser</code></em> :</span></p></td>
<td> An analyser.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The language name.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enca_get_languages ()">
<a name="enca-get-languages"></a><h3>enca_get_languages ()</h3>
<pre class="programlisting">const char** enca_get_languages (size_t *n);</pre>
<p>
Returns list of known languages.
</p>
<p>
The returned strings are two-letter ISO-639 language codes, the same as
<a class="link" href="libenca-Analyser.html#enca-analyser-alloc" title="enca_analyser_alloc ()"><code class="function">enca_analyser_alloc()</code></a> accepts.
</p>
<p>
The list of languages has to be freed by caller; the strings themselves
must be considered constant and must NOT be freed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td> The number of languages will be stored here.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The list of languages, storing their number into *<em class="parameter"><code>n</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enca_language_english_name ()">
<a name="enca-language-english-name"></a><h3>enca_language_english_name ()</h3>
<pre class="programlisting">const char* enca_language_english_name (const char *lang);</pre>
<p>
Returns an English name of a language given its ISO-639 code.
</p>
<p>
The returned string must be considered constant and must NOT be freed.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>lang</code></em> :</span></p></td>
<td> A two-letter language code, such as obtained from
<a class="link" href="libenca-Auxiliary-Functions.html#enca-analyser-language" title="enca_analyser_language ()"><code class="function">enca_analyser_language()</code></a> or <a class="link" href="libenca-Auxiliary-Functions.html#enca-get-languages" title="enca_get_languages ()"><code class="function">enca_get_languages()</code></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The English language name.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enca_get_language_charsets ()">
<a name="enca-get-language-charsets"></a><h3>enca_get_language_charsets ()</h3>
<pre class="programlisting">int* enca_get_language_charsets (const char *langname,
size_t *n);</pre>
<p>
Returns list of identifiers of charsets supported for language <em class="parameter"><code>language</code></em>.
</p>
<p>
The list of charset identifiers has to be freed by caller.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>langname</code></em> :</span></p></td>
<td> Two-letter ISO-639 language code.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>n</code></em> :</span></p></td>
<td> The number of charsets will be stored here.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The list of charsets, storing their number into *<em class="parameter"><code>n</code></em>. When language
contains no charsets or <em class="parameter"><code>langname</code></em> is invalid, <span class="type">NULL</span> is returned
and zero stored into *<em class="parameter"><code>n</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|