/usr/share/doc/enca/html/libenca/libenca-Typedefs-and-Constants.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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Typedefs and Constants</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-Analyser.html" title="Analyser">
<link rel="next" 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-Analyser.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><a accesskey="n" href="libenca-Charsets-and-Surfaces.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libenca-Typedefs-and-Constants.synopsis" class="shortcut">Top</a>
|
<a href="#libenca-Typedefs-and-Constants.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Typedefs and Constants">
<a name="libenca-Typedefs-and-Constants"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libenca-Typedefs-and-Constants.top_of_page"></a>Typedefs and Constants</span></h2>
<p>Typedefs and Constants — Enca library typedefs, enums and constants.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libenca-Typedefs-and-Constants.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="libenca-Typedefs-and-Constants.html#EncaEncoding" title="EncaEncoding">EncaEncoding</a>;
#define <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CS-UNKNOWN--CAPS" title="ENCA_CS_UNKNOWN">ENCA_CS_UNKNOWN</a>
enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a>;
enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaCharsetFlags" title="enum EncaCharsetFlags">EncaCharsetFlags</a>;
enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaNameStyle" title="enum EncaNameStyle">EncaNameStyle</a>;
enum <a class="link" href="libenca-Typedefs-and-Constants.html#EncaErrno" title="enum EncaErrno">EncaErrno</a>;
#define <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-NOT-A-CHAR--CAPS" title="ENCA_NOT_A_CHAR">ENCA_NOT_A_CHAR</a>
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libenca-Typedefs-and-Constants.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="libenca-Typedefs-and-Constants.details"></a><h2>Details</h2>
<div class="refsect2" title="EncaEncoding">
<a name="EncaEncoding"></a><h3>EncaEncoding</h3>
<pre class="programlisting">typedef struct {
int charset; EncaSurface surface;
} EncaEncoding;
</pre>
<p>
Encoding, i.e. charset and surface.
</p>
<p>
This is what <a class="link" href="libenca-Analyser.html#enca-analyse" title="enca_analyse ()"><code class="function">enca_analyse()</code></a> and <a class="link" href="libenca-Analyser.html#enca-analyse-const" title="enca_analyse_const ()"><code class="function">enca_analyse_const()</code></a> return.
</p>
<p>
The <em class="parameter"><code>charset</code></em> field is an opaque numerical charset identifier, which has no
meaning outside Enca library.
You will probably want to use it only as <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-name" title="enca_charset_name ()"><code class="function">enca_charset_name()</code></a> argument.
It is only guaranteed not to change meaning
during program execution time; change of its interpretation (e.g. due to
addition of new charsets) is not considered API change.
</p>
<p>
The <em class="parameter"><code>surface</code></em> field is a combination of <a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface"><span class="type">EncaSurface</span></a> flags. You may want
to ignore it completely; you should use <a class="link" href="libenca-Analyser.html#enca-set-interpreted-surfaces" title="enca_set_interpreted_surfaces ()"><code class="function">enca_set_interpreted_surfaces()</code></a>
to disable weird surfaces then.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term">int <em class="structfield"><code>charset</code></em>;</span></p></td>
<td> Numeric charset identifier.
</td>
</tr>
<tr>
<td><p><span class="term"><a class="link" href="libenca-Typedefs-and-Constants.html#EncaSurface" title="enum EncaSurface">EncaSurface</a> <em class="structfield"><code>surface</code></em>;</span></p></td>
<td> Surface flags.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ENCA_CS_UNKNOWN">
<a name="ENCA-CS-UNKNOWN--CAPS"></a><h3>ENCA_CS_UNKNOWN</h3>
<pre class="programlisting">#define ENCA_CS_UNKNOWN (-1)
</pre>
<p>
Unknown character set id.
</p>
<p>
Use <a class="link" href="libenca-Charsets-and-Surfaces.html#enca-charset-is-known" title="enca_charset_is_known()"><code class="function">enca_charset_is_known()</code></a> to check for unknown charset instead of direct
comparsion.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="enum EncaSurface">
<a name="EncaSurface"></a><h3>enum EncaSurface</h3>
<pre class="programlisting">typedef enum { /*< flags >*/
ENCA_SURFACE_EOL_CR = 1 << 0,
ENCA_SURFACE_EOL_LF = 1 << 1,
ENCA_SURFACE_EOL_CRLF = 1 << 2,
ENCA_SURFACE_EOL_MIX = 1 << 3,
ENCA_SURFACE_EOL_BIN = 1 << 4,
ENCA_SURFACE_MASK_EOL = (ENCA_SURFACE_EOL_CR
| ENCA_SURFACE_EOL_LF
| ENCA_SURFACE_EOL_CRLF
| ENCA_SURFACE_EOL_MIX
| ENCA_SURFACE_EOL_BIN),
ENCA_SURFACE_PERM_21 = 1 << 5,
ENCA_SURFACE_PERM_4321 = 1 << 6,
ENCA_SURFACE_PERM_MIX = 1 << 7,
ENCA_SURFACE_MASK_PERM = (ENCA_SURFACE_PERM_21
| ENCA_SURFACE_PERM_4321
| ENCA_SURFACE_PERM_MIX),
ENCA_SURFACE_QP = 1 << 8,
ENCA_SURFACE_REMOVE = 1 << 13,
ENCA_SURFACE_UNKNOWN = 1 << 14,
ENCA_SURFACE_MASK_ALL = (ENCA_SURFACE_MASK_EOL
| ENCA_SURFACE_MASK_PERM
| ENCA_SURFACE_QP
| ENCA_SURFACE_REMOVE)
} EncaSurface;
</pre>
<p>
Surface flags.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="ENCA-SURFACE-EOL-CR--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_CR</code></span></p></td>
<td> End-of-lines are represented with CR's.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-EOL-LF--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_LF</code></span></p></td>
<td> End-of-lines are represented with LF's.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-EOL-CRLF--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_CRLF</code></span></p></td>
<td> End-of-lines are represented with CRLF's.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-EOL-MIX--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_MIX</code></span></p></td>
<td> Several end-of-line types, mixed.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-EOL-BIN--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_EOL_BIN</code></span></p></td>
<td> End-of-line concept not applicable (binary data).
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-MASK-EOL--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_MASK_EOL</code></span></p></td>
<td> Mask for end-of-line surfaces.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-PERM-21--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_PERM_21</code></span></p></td>
<td> Odd and even bytes swapped.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-PERM-4321--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_PERM_4321</code></span></p></td>
<td> Reversed byte sequence in 4byte words.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-PERM-MIX--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_PERM_MIX</code></span></p></td>
<td> Chunks with both endianess, concatenated.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-MASK-PERM--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_MASK_PERM</code></span></p></td>
<td> Mask for permutation surfaces.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-QP--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_QP</code></span></p></td>
<td> Quoted printables.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-REMOVE--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_REMOVE</code></span></p></td>
<td> Recode `remove' surface.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-UNKNOWN--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_UNKNOWN</code></span></p></td>
<td> Unknown surface.
</td>
</tr>
<tr>
<td><p><a name="ENCA-SURFACE-MASK-ALL--CAPS"></a><span class="term"><code class="literal">ENCA_SURFACE_MASK_ALL</code></span></p></td>
<td> Mask for all bits, withnout <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-SURFACE-UNKNOWN--CAPS"><span class="type">ENCA_SURFACE_UNKNOWN</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum EncaCharsetFlags">
<a name="EncaCharsetFlags"></a><h3>enum EncaCharsetFlags</h3>
<pre class="programlisting">typedef enum { /*< flags >*/
ENCA_CHARSET_7BIT = 1 << 0,
ENCA_CHARSET_8BIT = 1 << 1,
ENCA_CHARSET_16BIT = 1 << 2,
ENCA_CHARSET_32BIT = 1 << 3,
ENCA_CHARSET_FIXED = 1 << 4,
ENCA_CHARSET_VARIABLE = 1 << 5,
ENCA_CHARSET_BINARY = 1 << 6,
ENCA_CHARSET_REGULAR = 1 << 7,
ENCA_CHARSET_MULTIBYTE = 1 << 8
} EncaCharsetFlags;
</pre>
<p>
Charset properties.
</p>
<p>
Flags <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-7BIT--CAPS"><code class="literal">ENCA_CHARSET_7BIT</code></a>, <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-8BIT--CAPS"><code class="literal">ENCA_CHARSET_8BIT</code></a>, <a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-16BIT--CAPS"><code class="literal">ENCA_CHARSET_16BIT</code></a>,
<a class="link" href="libenca-Typedefs-and-Constants.html#ENCA-CHARSET-32BIT--CAPS"><code class="literal">ENCA_CHARSET_32BIT</code></a> tell how many bits a `fundamental piece' consists of.
This is different from bits per character; r.g. UTF-8 consists of 8bit
pieces (bytes), but character can be composed from 1 to 6 of them.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="ENCA-CHARSET-7BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_7BIT</code></span></p></td>
<td> Characters are represented with 7bit characters.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-8BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_8BIT</code></span></p></td>
<td> Characters are represented with bytes.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-16BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_16BIT</code></span></p></td>
<td> Characters are represented with 2byte words.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-32BIT--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_32BIT</code></span></p></td>
<td> Characters are represented with 4byte words.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-FIXED--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_FIXED</code></span></p></td>
<td> One characters consists of one fundamental piece.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-VARIABLE--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_VARIABLE</code></span></p></td>
<td> One character consists of variable number of
fundamental pieces.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-BINARY--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_BINARY</code></span></p></td>
<td> Charset is binary from ASCII viewpoint.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-REGULAR--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_REGULAR</code></span></p></td>
<td> Language dependent (8bit) charset.
</td>
</tr>
<tr>
<td><p><a name="ENCA-CHARSET-MULTIBYTE--CAPS"></a><span class="term"><code class="literal">ENCA_CHARSET_MULTIBYTE</code></span></p></td>
<td> Multibyte charset.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum EncaNameStyle">
<a name="EncaNameStyle"></a><h3>enum EncaNameStyle</h3>
<pre class="programlisting">typedef enum {
ENCA_NAME_STYLE_ENCA,
ENCA_NAME_STYLE_RFC1345,
ENCA_NAME_STYLE_CSTOCS,
ENCA_NAME_STYLE_ICONV,
ENCA_NAME_STYLE_HUMAN,
ENCA_NAME_STYLE_MIME
} EncaNameStyle;
</pre>
<p>
Charset naming styles and conventions.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="ENCA-NAME-STYLE-ENCA--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_ENCA</code></span></p></td>
<td> Default, implicit charset name in Enca.
</td>
</tr>
<tr>
<td><p><a name="ENCA-NAME-STYLE-RFC1345--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_RFC1345</code></span></p></td>
<td> RFC 1345 or otherwise canonical charset name.
</td>
</tr>
<tr>
<td><p><a name="ENCA-NAME-STYLE-CSTOCS--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_CSTOCS</code></span></p></td>
<td> Cstocs charset name (may not exist).
</td>
</tr>
<tr>
<td><p><a name="ENCA-NAME-STYLE-ICONV--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_ICONV</code></span></p></td>
<td> Iconv charset name (may not exist).
</td>
</tr>
<tr>
<td><p><a name="ENCA-NAME-STYLE-HUMAN--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_HUMAN</code></span></p></td>
<td> Human comprehensible description.
</td>
</tr>
<tr>
<td><p><a name="ENCA-NAME-STYLE-MIME--CAPS"></a><span class="term"><code class="literal">ENCA_NAME_STYLE_MIME</code></span></p></td>
<td> Preferred MIME name (may not exist).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum EncaErrno">
<a name="EncaErrno"></a><h3>enum EncaErrno</h3>
<pre class="programlisting">typedef enum {
ENCA_EOK = 0,
ENCA_EINVALUE,
ENCA_EEMPTY,
ENCA_EFILTERED,
ENCA_ENOCS8,
ENCA_ESIGNIF,
ENCA_EWINNER,
ENCA_EGARBAGE
} EncaErrno;
</pre>
<p>
Error codes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="ENCA-EOK--CAPS"></a><span class="term"><code class="literal">ENCA_EOK</code></span></p></td>
<td> OK.
</td>
</tr>
<tr>
<td><p><a name="ENCA-EINVALUE--CAPS"></a><span class="term"><code class="literal">ENCA_EINVALUE</code></span></p></td>
<td> Invalid value (usually of an option).
</td>
</tr>
<tr>
<td><p><a name="ENCA-EEMPTY--CAPS"></a><span class="term"><code class="literal">ENCA_EEMPTY</code></span></p></td>
<td> Sample is empty.
</td>
</tr>
<tr>
<td><p><a name="ENCA-EFILTERED--CAPS"></a><span class="term"><code class="literal">ENCA_EFILTERED</code></span></p></td>
<td> After filtering, (almost) nothing remained.
</td>
</tr>
<tr>
<td><p><a name="ENCA-ENOCS8--CAPS"></a><span class="term"><code class="literal">ENCA_ENOCS8</code></span></p></td>
<td> Mulitibyte tests failed and language contains no 8bit charsets.
</td>
</tr>
<tr>
<td><p><a name="ENCA-ESIGNIF--CAPS"></a><span class="term"><code class="literal">ENCA_ESIGNIF</code></span></p></td>
<td> Too few significant characters.
</td>
</tr>
<tr>
<td><p><a name="ENCA-EWINNER--CAPS"></a><span class="term"><code class="literal">ENCA_EWINNER</code></span></p></td>
<td> No clear winner.
</td>
</tr>
<tr>
<td><p><a name="ENCA-EGARBAGE--CAPS"></a><span class="term"><code class="literal">ENCA_EGARBAGE</code></span></p></td>
<td> Sample is garbage.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ENCA_NOT_A_CHAR">
<a name="ENCA-NOT-A-CHAR--CAPS"></a><h3>ENCA_NOT_A_CHAR</h3>
<pre class="programlisting">#define ENCA_NOT_A_CHAR 0xffff
</pre>
<p>
Not-a-character in unicode tables.</p>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|