doc/libunistring_13.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
   2 <html>
   3 <!-- Created on September, 1 2014 by texi2html 1.78a -->
   4 <!--
   5 Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
   6             Karl Berry  <karl@freefriends.org>
   7             Olaf Bachmann <obachman@mathematik.uni-kl.de>
   8             and many others.
   9 Maintained by: Many creative people.
  10 Send bugs and suggestions to <texi2html-bug@nongnu.org>
  11
  12 -->
  13 <head>
  14 <title>GNU libunistring: 13. Normalization forms (composition and decomposition) &lt;uninorm.h&gt;</title>
  15
  16 <meta name="description" content="GNU libunistring: 13. Normalization forms (composition and decomposition) &lt;uninorm.h&gt;">
  17 <meta name="keywords" content="GNU libunistring: 13. Normalization forms (composition and decomposition) &lt;uninorm.h&gt;">
  18 <meta name="resource-type" content="document">
  19 <meta name="distribution" content="global">
  20 <meta name="Generator" content="texi2html 1.78a">
  21 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  22 <style type="text/css">
  23 <!--
  24 a.summary-letter {text-decoration: none}
  25 pre.display {font-family: serif}
  26 pre.format {font-family: serif}
  27 pre.menu-comment {font-family: serif}
  28 pre.menu-preformatted {font-family: serif}
  29 pre.smalldisplay {font-family: serif; font-size: smaller}
  30 pre.smallexample {font-size: smaller}
  31 pre.smallformat {font-family: serif; font-size: smaller}
  32 pre.smalllisp {font-size: smaller}
  33 span.roman {font-family:serif; font-weight:normal;}
  34 span.sansserif {font-family:sans-serif; font-weight:normal;}
  35 ul.toc {list-style: none}
  36 -->
  37 </style>
  38
  39
  40 </head>
  41
  42 <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  43
  44 <table cellpadding="1" cellspacing="1" border="0">
  45 <tr><td valign="middle" align="left">[<a href="libunistring_12.html#SEC47" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  46 <td valign="middle" align="left">[<a href="libunistring_14.html#SEC54" title="Next chapter"> &gt;&gt; </a>]</td>
  47 <td valign="middle" align="left"> &nbsp; </td>
  48 <td valign="middle" align="left"> &nbsp; </td>
  49 <td valign="middle" align="left"> &nbsp; </td>
  50 <td valign="middle" align="left"> &nbsp; </td>
  51 <td valign="middle" align="left"> &nbsp; </td>
  52 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
  53 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
  54 <td valign="middle" align="left">[<a href="libunistring_19.html#SEC77" title="Index">Index</a>]</td>
  55 <td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
  56 </tr></table>
  57
  58 <hr size="2">
  59 <a name="uninorm_002eh"></a>
  60 <a name="SEC48"></a>
  61 <h1 class="chapter"> <a href="libunistring.html#TOC48">13. Normalization forms (composition and decomposition) <code>&lt;uninorm.h&gt;</code></a> </h1>
  62
  63 <p>This include file defines functions for transforming Unicode strings to one
  64 of the four normal forms, known as NFC, NFD, NKFC, NFKD.  These
  65 transformations involve decomposition and &mdash; for NFC and NFKC &mdash; composition
  66 of Unicode characters.
  67 </p>
  68
  69 <hr size="6">
  70 <a name="Decomposition-of-characters"></a>
  71 <a name="SEC49"></a>
  72 <h2 class="section"> <a href="libunistring.html#TOC49">13.1 Decomposition of Unicode characters</a> </h2>
  73
  74 <p>The following enumerated values are the possible types of decomposition of a
  75 Unicode character.
  76 </p>
  77 <dl>
  78 <dt><u>Constant:</u> int <b>UC_DECOMP_CANONICAL</b>
  79 <a name="IDX767"></a>
  80 </dt>
  81 <dd><p>Denotes canonical decomposition.
  82 </p></dd></dl>
  83
  84 <dl>
  85 <dt><u>Constant:</u> int <b>UC_DECOMP_FONT</b>
  86 <a name="IDX768"></a>
  87 </dt>
  88 <dd><p>UCD marker: <code>&lt;font&gt;</code>.  Denotes a font variant (e.g. a blackletter form).
  89 </p></dd></dl>
  90
  91 <dl>
  92 <dt><u>Constant:</u> int <b>UC_DECOMP_NOBREAK</b>
  93 <a name="IDX769"></a>
  94 </dt>
  95 <dd><p>UCD marker: <code>&lt;noBreak&gt;</code>.
  96 Denotes a no-break version of a space or hyphen.
  97 </p></dd></dl>
  98
  99 <dl>
 100 <dt><u>Constant:</u> int <b>UC_DECOMP_INITIAL</b>
 101 <a name="IDX770"></a>
 102 </dt>
 103 <dd><p>UCD marker: <code>&lt;initial&gt;</code>.
 104 Denotes an initial presentation form (Arabic).
 105 </p></dd></dl>
 106
 107 <dl>
 108 <dt><u>Constant:</u> int <b>UC_DECOMP_MEDIAL</b>
 109 <a name="IDX771"></a>
 110 </dt>
 111 <dd><p>UCD marker: <code>&lt;medial&gt;</code>.
 112 Denotes a medial presentation form (Arabic).
 113 </p></dd></dl>
 114
 115 <dl>
 116 <dt><u>Constant:</u> int <b>UC_DECOMP_FINAL</b>
 117 <a name="IDX772"></a>
 118 </dt>
 119 <dd><p>UCD marker: <code>&lt;final&gt;</code>.
 120 Denotes a final presentation form (Arabic).
 121 </p></dd></dl>
 122
 123 <dl>
 124 <dt><u>Constant:</u> int <b>UC_DECOMP_ISOLATED</b>
 125 <a name="IDX773"></a>
 126 </dt>
 127 <dd><p>UCD marker: <code>&lt;isolated&gt;</code>.
 128 Denotes an isolated presentation form (Arabic).
 129 </p></dd></dl>
 130
 131 <dl>
 132 <dt><u>Constant:</u> int <b>UC_DECOMP_CIRCLE</b>
 133 <a name="IDX774"></a>
 134 </dt>
 135 <dd><p>UCD marker: <code>&lt;circle&gt;</code>.
 136 Denotes an encircled form.
 137 </p></dd></dl>
 138
 139 <dl>
 140 <dt><u>Constant:</u> int <b>UC_DECOMP_SUPER</b>
 141 <a name="IDX775"></a>
 142 </dt>
 143 <dd><p>UCD marker: <code>&lt;super&gt;</code>.
 144 Denotes a superscript form.
 145 </p></dd></dl>
 146
 147 <dl>
 148 <dt><u>Constant:</u> int <b>UC_DECOMP_SUB</b>
 149 <a name="IDX776"></a>
 150 </dt>
 151 <dd><p>UCD marker: <code>&lt;sub&gt;</code>.
 152 Denotes a subscript form.
 153 </p></dd></dl>
 154
 155 <dl>
 156 <dt><u>Constant:</u> int <b>UC_DECOMP_VERTICAL</b>
 157 <a name="IDX777"></a>
 158 </dt>
 159 <dd><p>UCD marker: <code>&lt;vertical&gt;</code>.
 160 Denotes a vertical layout presentation form.
 161 </p></dd></dl>
 162
 163 <dl>
 164 <dt><u>Constant:</u> int <b>UC_DECOMP_WIDE</b>
 165 <a name="IDX778"></a>
 166 </dt>
 167 <dd><p>UCD marker: <code>&lt;wide&gt;</code>.
 168 Denotes a wide (or zenkaku) compatibility character.
 169 </p></dd></dl>
 170
 171 <dl>
 172 <dt><u>Constant:</u> int <b>UC_DECOMP_NARROW</b>
 173 <a name="IDX779"></a>
 174 </dt>
 175 <dd><p>UCD marker: <code>&lt;narrow&gt;</code>.
 176 Denotes a narrow (or hankaku) compatibility character.
 177 </p></dd></dl>
 178
 179 <dl>
 180 <dt><u>Constant:</u> int <b>UC_DECOMP_SMALL</b>
 181 <a name="IDX780"></a>
 182 </dt>
 183 <dd><p>UCD marker: <code>&lt;small&gt;</code>.
 184 Denotes a small variant form (CNS compatibility).
 185 </p></dd></dl>
 186
 187 <dl>
 188 <dt><u>Constant:</u> int <b>UC_DECOMP_SQUARE</b>
 189 <a name="IDX781"></a>
 190 </dt>
 191 <dd><p>UCD marker: <code>&lt;square&gt;</code>.
 192 Denotes a CJK squared font variant.
 193 </p></dd></dl>
 194
 195 <dl>
 196 <dt><u>Constant:</u> int <b>UC_DECOMP_FRACTION</b>
 197 <a name="IDX782"></a>
 198 </dt>
 199 <dd><p>UCD marker: <code>&lt;fraction&gt;</code>.
 200 Denotes a vulgar fraction form.
 201 </p></dd></dl>
 202
 203 <dl>
 204 <dt><u>Constant:</u> int <b>UC_DECOMP_COMPAT</b>
 205 <a name="IDX783"></a>
 206 </dt>
 207 <dd><p>UCD marker: <code>&lt;compat&gt;</code>.
 208 Denotes an otherwise unspecified compatibility character.
 209 </p></dd></dl>
 210
 211 <p>The following constant denotes the maximum size of decomposition of a single
 212 Unicode character.
 213 </p>
 214 <dl>
 215 <dt><u>Macro:</u> unsigned int <b>UC_DECOMPOSITION_MAX_LENGTH</b>
 216 <a name="IDX784"></a>
 217 </dt>
 218 <dd><p>This macro expands to a constant that is the required size of buffer passed to
 219 the <code>uc_decomposition</code> and <code>uc_canonical_decomposition</code> functions.
 220 </p></dd></dl>
 221
 222 <p>The following functions decompose a Unicode character.
 223 </p>
 224 <dl>
 225 <dt><u>Function:</u> int <b>uc_decomposition</b><i> (ucs4_t <var>uc</var>, int *<var>decomp_tag</var>, ucs4_t *<var>decomposition</var>)</i>
 226 <a name="IDX785"></a>
 227 </dt>
 228 <dd><p>Returns the character decomposition mapping of the Unicode character <var>uc</var>.
 229 <var>decomposition</var> must point to an array of at least
 230 <code>UC_DECOMPOSITION_MAX_LENGTH</code> <code>ucs_t</code> elements.
 231 </p>
 232 <p>When a decomposition exists, <code><var>decomposition</var>[0..<var>n</var>-1]</code> and
 233 <code>*<var>decomp_tag</var></code> are filled and <var>n</var> is returned.  Otherwise -1 is
 234 returned.
 235 </p></dd></dl>
 236
 237 <dl>
 238 <dt><u>Function:</u> int <b>uc_canonical_decomposition</b><i> (ucs4_t <var>uc</var>, ucs4_t *<var>decomposition</var>)</i>
 239 <a name="IDX786"></a>
 240 </dt>
 241 <dd><p>Returns the canonical character decomposition mapping of the Unicode character
 242 <var>uc</var>.  <var>decomposition</var> must point to an array of at least
 243 <code>UC_DECOMPOSITION_MAX_LENGTH</code> <code>ucs_t</code> elements.
 244 </p>
 245 <p>When a decomposition exists, <code><var>decomposition</var>[0..<var>n</var>-1]</code> is filled
 246 and <var>n</var> is returned.  Otherwise -1 is returned.
 247 </p></dd></dl>
 248
 249 <hr size="6">
 250 <a name="Composition-of-characters"></a>
 251 <a name="SEC50"></a>
 252 <h2 class="section"> <a href="libunistring.html#TOC50">13.2 Composition of Unicode characters</a> </h2>
 253
 254 <p>The following function composes a Unicode character from two Unicode
 255 characters.
 256 </p>
 257 <dl>
 258 <dt><u>Function:</u> ucs4_t <b>uc_composition</b><i> (ucs4_t <var>uc1</var>, ucs4_t <var>uc2</var>)</i>
 259 <a name="IDX787"></a>
 260 </dt>
 261 <dd><p>Attempts to combine the Unicode characters <var>uc1</var>, <var>uc2</var>.
 262 <var>uc1</var> is known to have canonical combining class 0.
 263 </p>
 264 <p>Returns the combination of <var>uc1</var> and <var>uc2</var>, if it exists.
 265 Returns 0 otherwise.
 266 </p>
 267 <p>Not all decompositions can be recombined using this function.  See the Unicode
 268 file &lsquo;<tt>CompositionExclusions.txt</tt>&rsquo; for details.
 269 </p></dd></dl>
 270
 271 <hr size="6">
 272 <a name="Normalization-of-strings"></a>
 273 <a name="SEC51"></a>
 274 <h2 class="section"> <a href="libunistring.html#TOC51">13.3 Normalization of strings</a> </h2>
 275
 276 <p>The Unicode standard defines four normalization forms for Unicode strings.
 277 The following type is used to denote a normalization form.
 278 </p>
 279 <dl>
 280 <dt><u>Type:</u> <b>uninorm_t</b>
 281 <a name="IDX788"></a>
 282 </dt>
 283 <dd><p>An object of type <code>uninorm_t</code> denotes a Unicode normalization form.
 284 This is a scalar type; its values can be compared with <code>==</code>.
 285 </p></dd></dl>
 286
 287 <p>The following constants denote the four normalization forms.
 288 </p>
 289 <dl>
 290 <dt><u>Macro:</u> uninorm_t <b>UNINORM_NFD</b>
 291 <a name="IDX789"></a>
 292 </dt>
 293 <dd><p>Denotes Normalization form D: canonical decomposition.
 294 </p></dd></dl>
 295
 296 <dl>
 297 <dt><u>Macro:</u> uninorm_t <b>UNINORM_NFC</b>
 298 <a name="IDX790"></a>
 299 </dt>
 300 <dd><p>Normalization form C: canonical decomposition, then canonical composition.
 301 </p></dd></dl>
 302
 303 <dl>
 304 <dt><u>Macro:</u> uninorm_t <b>UNINORM_NFKD</b>
 305 <a name="IDX791"></a>
 306 </dt>
 307 <dd><p>Normalization form KD: compatibility decomposition.
 308 </p></dd></dl>
 309
 310 <dl>
 311 <dt><u>Macro:</u> uninorm_t <b>UNINORM_NFKC</b>
 312 <a name="IDX792"></a>
 313 </dt>
 314 <dd><p>Normalization form KC: compatibility decomposition, then canonical composition.
 315 </p></dd></dl>
 316
 317 <p>The following functions operate on <code>uninorm_t</code> objects.
 318 </p>
 319 <dl>
 320 <dt><u>Function:</u> bool <b>uninorm_is_compat_decomposing</b><i> (uninorm_t <var>nf</var>)</i>
 321 <a name="IDX793"></a>
 322 </dt>
 323 <dd><p>Tests whether the normalization form <var>nf</var> does compatibility decomposition.
 324 </p></dd></dl>
 325
 326 <dl>
 327 <dt><u>Function:</u> bool <b>uninorm_is_composing</b><i> (uninorm_t <var>nf</var>)</i>
 328 <a name="IDX794"></a>
 329 </dt>
 330 <dd><p>Tests whether the normalization form <var>nf</var> includes canonical composition.
 331 </p></dd></dl>
 332
 333 <dl>
 334 <dt><u>Function:</u> uninorm_t <b>uninorm_decomposing_form</b><i> (uninorm_t <var>nf</var>)</i>
 335 <a name="IDX795"></a>
 336 </dt>
 337 <dd><p>Returns the decomposing variant of the normalization form <var>nf</var>.
 338 This maps NFC,NFD → NFD and NFKC,NFKD → NFKD.
 339 </p></dd></dl>
 340
 341 <p>The following functions apply a Unicode normalization form to a Unicode string.
 342 </p>
 343 <dl>
 344 <dt><u>Function:</u> uint8_t * <b>u8_normalize</b><i> (uninorm_t <var>nf</var>, const uint8_t *<var>s</var>, size_t <var>n</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 345 <a name="IDX796"></a>
 346 </dt>
 347 <dt><u>Function:</u> uint16_t * <b>u16_normalize</b><i> (uninorm_t <var>nf</var>, const uint16_t *<var>s</var>, size_t <var>n</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 348 <a name="IDX797"></a>
 349 </dt>
 350 <dt><u>Function:</u> uint32_t * <b>u32_normalize</b><i> (uninorm_t <var>nf</var>, const uint32_t *<var>s</var>, size_t <var>n</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 351 <a name="IDX798"></a>
 352 </dt>
 353 <dd><p>Returns the specified normalization form of a string.
 354 </p></dd></dl>
 355
 356 <hr size="6">
 357 <a name="Normalizing-comparisons"></a>
 358 <a name="SEC52"></a>
 359 <h2 class="section"> <a href="libunistring.html#TOC52">13.4 Normalizing comparisons</a> </h2>
 360
 361 <p>The following functions compare Unicode string, ignoring differences in
 362 normalization.
 363 </p>
 364 <dl>
 365 <dt><u>Function:</u> int <b>u8_normcmp</b><i> (const uint8_t *<var>s1</var>, size_t <var>n1</var>, const uint8_t *<var>s2</var>, size_t <var>n2</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 366 <a name="IDX799"></a>
 367 </dt>
 368 <dt><u>Function:</u> int <b>u16_normcmp</b><i> (const uint16_t *<var>s1</var>, size_t <var>n1</var>, const uint16_t *<var>s2</var>, size_t <var>n2</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 369 <a name="IDX800"></a>
 370 </dt>
 371 <dt><u>Function:</u> int <b>u32_normcmp</b><i> (const uint32_t *<var>s1</var>, size_t <var>n1</var>, const uint32_t *<var>s2</var>, size_t <var>n2</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 372 <a name="IDX801"></a>
 373 </dt>
 374 <dd><p>Compares <var>s1</var> and <var>s2</var>, ignoring differences in normalization.
 375 </p>
 376 <p><var>nf</var> must be either <code>UNINORM_NFD</code> or <code>UNINORM_NFKD</code>.
 377 </p>
 378 <p>If successful, sets <code>*<var>resultp</var></code> to -1 if <var>s1</var> &lt; <var>s2</var>,
 379 0 if <var>s1</var> = <var>s2</var>, 1 if <var>s1</var> &gt; <var>s2</var>, and returns 0.
 380 Upon failure, returns -1 with <code>errno</code> set.
 381 </p></dd></dl>
 382
 383 <a name="IDX802"></a>
 384 <a name="IDX803"></a>
 385 <dl>
 386 <dt><u>Function:</u> char * <b>u8_normxfrm</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, uninorm_t <var>nf</var>, char *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 387 <a name="IDX804"></a>
 388 </dt>
 389 <dt><u>Function:</u> char * <b>u16_normxfrm</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, uninorm_t <var>nf</var>, char *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 390 <a name="IDX805"></a>
 391 </dt>
 392 <dt><u>Function:</u> char * <b>u32_normxfrm</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, uninorm_t <var>nf</var>, char *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 393 <a name="IDX806"></a>
 394 </dt>
 395 <dd><p>Converts the string <var>s</var> of length <var>n</var> to a NUL-terminated byte
 396 sequence, in such a way that comparing <code>u8_normxfrm (<var>s1</var>)</code> and
 397 <code>u8_normxfrm (<var>s2</var>)</code> with the <code>u8_cmp2</code> function is equivalent to
 398 comparing <var>s1</var> and <var>s2</var> with the <code>u8_normcoll</code> function.
 399 </p>
 400 <p><var>nf</var> must be either <code>UNINORM_NFC</code> or <code>UNINORM_NFKC</code>.
 401 </p></dd></dl>
 402
 403 <dl>
 404 <dt><u>Function:</u> int <b>u8_normcoll</b><i> (const uint8_t *<var>s1</var>, size_t <var>n1</var>, const uint8_t *<var>s2</var>, size_t <var>n2</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 405 <a name="IDX807"></a>
 406 </dt>
 407 <dt><u>Function:</u> int <b>u16_normcoll</b><i> (const uint16_t *<var>s1</var>, size_t <var>n1</var>, const uint16_t *<var>s2</var>, size_t <var>n2</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 408 <a name="IDX808"></a>
 409 </dt>
 410 <dt><u>Function:</u> int <b>u32_normcoll</b><i> (const uint32_t *<var>s1</var>, size_t <var>n1</var>, const uint32_t *<var>s2</var>, size_t <var>n2</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 411 <a name="IDX809"></a>
 412 </dt>
 413 <dd><p>Compares <var>s1</var> and <var>s2</var>, ignoring differences in normalization, using
 414 the collation rules of the current locale.
 415 </p>
 416 <p><var>nf</var> must be either <code>UNINORM_NFC</code> or <code>UNINORM_NFKC</code>.
 417 </p>
 418 <p>If successful, sets <code>*<var>resultp</var></code> to -1 if <var>s1</var> &lt; <var>s2</var>,
 419 0 if <var>s1</var> = <var>s2</var>, 1 if <var>s1</var> &gt; <var>s2</var>, and returns 0.
 420 Upon failure, returns -1 with <code>errno</code> set.
 421 </p></dd></dl>
 422
 423 <hr size="6">
 424 <a name="Normalization-of-streams"></a>
 425 <a name="SEC53"></a>
 426 <h2 class="section"> <a href="libunistring.html#TOC53">13.5 Normalization of streams of Unicode characters</a> </h2>
 427
 428 <p>A &ldquo;stream of Unicode characters&rdquo; is essentially a function that accepts an
 429 <code>ucs4_t</code> argument repeatedly, optionally combined with a function that
 430 &ldquo;flushes&rdquo; the stream.
 431 </p>
 432 <dl>
 433 <dt><u>Type:</u> <b>struct uninorm_filter</b>
 434 <a name="IDX810"></a>
 435 </dt>
 436 <dd><p>This is the data type of a stream of Unicode characters that normalizes its
 437 input according to a given normalization form and passes the normalized
 438 character sequence to the encapsulated stream of Unicode characters.
 439 </p></dd></dl>
 440
 441 <dl>
 442 <dt><u>Function:</u> struct uninorm_filter * <b>uninorm_filter_create</b><i> (uninorm_t <var>nf</var>, int (*<var>stream_func</var>) (void *<var>stream_data</var>, ucs4_t <var>uc</var>), void *<var>stream_data</var>)</i>
 443 <a name="IDX811"></a>
 444 </dt>
 445 <dd><p>Creates and returns a normalization filter for Unicode characters.
 446 </p>
 447 <p>The pair (<var>stream_func</var>, <var>stream_data</var>) is the encapsulated stream.
 448 <code><var>stream_func</var> (<var>stream_data</var>, <var>uc</var>)</code> receives the Unicode
 449 character <var>uc</var> and returns 0 if successful, or -1 with <code>errno</code> set
 450 upon failure.
 451 </p>
 452 <p>Returns the new filter, or NULL with <code>errno</code> set upon failure.
 453 </p></dd></dl>
 454
 455 <dl>
 456 <dt><u>Function:</u> int <b>uninorm_filter_write</b><i> (struct uninorm_filter *<var>filter</var>, ucs4_t <var>uc</var>)</i>
 457 <a name="IDX812"></a>
 458 </dt>
 459 <dd><p>Stuffs a Unicode character into a normalizing filter.
 460 Returns 0 if successful, or -1 with <code>errno</code> set upon failure.
 461 </p></dd></dl>
 462
 463 <dl>
 464 <dt><u>Function:</u> int <b>uninorm_filter_flush</b><i> (struct uninorm_filter *<var>filter</var>)</i>
 465 <a name="IDX813"></a>
 466 </dt>
 467 <dd><p>Brings data buffered in the filter to its destination, the encapsulated stream.
 468 </p>
 469 <p>Returns 0 if successful, or -1 with <code>errno</code> set upon failure.
 470 </p>
 471 <p>Note! If after calling this function, additional characters are written
 472 into the filter, the resulting character sequence in the encapsulated stream
 473 will not necessarily be normalized.
 474 </p></dd></dl>
 475
 476 <dl>
 477 <dt><u>Function:</u> int <b>uninorm_filter_free</b><i> (struct uninorm_filter *<var>filter</var>)</i>
 478 <a name="IDX814"></a>
 479 </dt>
 480 <dd><p>Brings data buffered in the filter to its destination, the encapsulated stream,
 481 then closes and frees the filter.
 482 </p>
 483 <p>Returns 0 if successful, or -1 with <code>errno</code> set upon failure.
 484 </p></dd></dl>
 485 <hr size="6">
 486 <table cellpadding="1" cellspacing="1" border="0">
 487 <tr><td valign="middle" align="left">[<a href="#SEC48" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
 488 <td valign="middle" align="left">[<a href="libunistring_14.html#SEC54" title="Next chapter"> &gt;&gt; </a>]</td>
 489 <td valign="middle" align="left"> &nbsp; </td>
 490 <td valign="middle" align="left"> &nbsp; </td>
 491 <td valign="middle" align="left"> &nbsp; </td>
 492 <td valign="middle" align="left"> &nbsp; </td>
 493 <td valign="middle" align="left"> &nbsp; </td>
 494 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
 495 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
 496 <td valign="middle" align="left">[<a href="libunistring_19.html#SEC77" title="Index">Index</a>]</td>
 497 <td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
 498 </tr></table>
 499 <p>
 500  <font size="-1">
 501   This document was generated by <em>Daiki Ueno</em> on <em>September, 1 2014</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.78a</em></a>.
 502  </font>
 503  <br>
 504
 505 </p>
 506 </body>
 507 </html>