doc/libunistring_14.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: 14. Case mappings &lt;unicase.h&gt;</title>
  15
  16 <meta name="description" content="GNU libunistring: 14. Case mappings &lt;unicase.h&gt;">
  17 <meta name="keywords" content="GNU libunistring: 14. Case mappings &lt;unicase.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_13.html#SEC48" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
  46 <td valign="middle" align="left">[<a href="libunistring_15.html#SEC60" 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="unicase_002eh"></a>
  60 <a name="SEC54"></a>
  61 <h1 class="chapter"> <a href="libunistring.html#TOC54">14. Case mappings <code>&lt;unicase.h&gt;</code></a> </h1>
  62
  63 <p>This include file defines functions for case mapping for Unicode strings and
  64 case insensitive comparison of Unicode strings and C strings.
  65 </p>
  66 <p>These string functions fix the problems that were mentioned in
  67 <a href="libunistring_1.html#SEC6">&lsquo;<samp>char *</samp>&rsquo; strings</a>, namely, they handle the Croatian
  68 <small>LETTER DZ WITH CARON</small>, the German <small>LATIN SMALL LETTER SHARP S</small>, the
  69 Greek sigma and the Lithuanian i correctly.
  70 </p>
  71
  72 <hr size="6">
  73 <a name="Case-mappings-of-characters"></a>
  74 <a name="SEC55"></a>
  75 <h2 class="section"> <a href="libunistring.html#TOC55">14.1 Case mappings of characters</a> </h2>
  76
  77 <p>The following functions implement case mappings on Unicode characters &mdash;
  78 for those cases only where the result of the mapping is a again a single
  79 Unicode character.
  80 </p>
  81 <p>These mappings are locale and context independent.
  82 </p>
  83 <table class="cartouche" border="1"><tr><td>
  84 <p><strong>WARNING!</strong> These functions are not sufficient for languages such as
  85 German, Greek and Lithuanian.  Better use the functions below that treat an
  86 entire string at once and are language aware.
  87 </p></td></tr></table>
  88
  89 <dl>
  90 <dt><u>Function:</u> ucs4_t <b>uc_toupper</b><i> (ucs4_t <var>uc</var>)</i>
  91 <a name="IDX815"></a>
  92 </dt>
  93 <dd><p>Returns the uppercase mapping of the Unicode character <var>uc</var>.
  94 </p></dd></dl>
  95
  96 <dl>
  97 <dt><u>Function:</u> ucs4_t <b>uc_tolower</b><i> (ucs4_t <var>uc</var>)</i>
  98 <a name="IDX816"></a>
  99 </dt>
 100 <dd><p>Returns the lowercase mapping of the Unicode character <var>uc</var>.
 101 </p></dd></dl>
 102
 103 <dl>
 104 <dt><u>Function:</u> ucs4_t <b>uc_totitle</b><i> (ucs4_t <var>uc</var>)</i>
 105 <a name="IDX817"></a>
 106 </dt>
 107 <dd><p>Returns the titlecase mapping of the Unicode character <var>uc</var>.
 108 </p>
 109 <p>The titlecase mapping of a character is to be used when the character should
 110 look like upper case and the following characters are lower cased.
 111 </p>
 112 <p>For most characters, this is the same as the uppercase mapping.  There are
 113 only few characters where the title case variant and the uuper case variant
 114 are different.  These characters occur in the Latin writing of the Croatian,
 115 Bosnian, and Serbian languages.
 116 </p>
 117 <table>
 118 <thead><tr><th><p> Lower case </p></th><th><p> Title case </p></th><th><p> Upper case
 119 </p></th></tr></thead>
 120 <tr><td><p> LATIN SMALL LETTER LJ
 121  </p></td><td><p> LATIN CAPITAL LETTER L WITH SMALL LETTER J
 122  </p></td><td><p> LATIN CAPITAL LETTER LJ
 123 </p></td></tr>
 124 <tr><td><p> LATIN SMALL LETTER NJ
 125  </p></td><td><p> LATIN CAPITAL LETTER N WITH SMALL LETTER J
 126  </p></td><td><p> LATIN CAPITAL LETTER NJ
 127 </p></td></tr>
 128 <tr><td><p> LATIN SMALL LETTER DZ
 129  </p></td><td><p> LATIN CAPITAL LETTER D WITH SMALL LETTER Z
 130  </p></td><td><p> LATIN CAPITAL LETTER DZ
 131 </p></td></tr>
 132 <tr><td><p> LATIN SMALL LETTER DZ WITH CARON
 133  </p></td><td><p> LATIN CAPITAL LETTER D WITH SMALL LETTER Z WITH CARON
 134  </p></td><td><p> LATIN CAPITAL LETTER DZ WITH CARON
 135 </p></td></tr>
 136 </table>
 137 </dd></dl>
 138
 139 <hr size="6">
 140 <a name="Case-mappings-of-strings"></a>
 141 <a name="SEC56"></a>
 142 <h2 class="section"> <a href="libunistring.html#TOC56">14.2 Case mappings of strings</a> </h2>
 143
 144 <p>Case mapping should always be performed on entire strings, not on individual
 145 characters.  The functions in this sections do so.
 146 </p>
 147 <p>These functions allow to apply a normalization after the case mapping.  The
 148 reason is that if you want to treat &lsquo;<samp>&auml;</samp>&rsquo; and &lsquo;<samp>&Auml;</samp>&rsquo; the same,
 149 you most often also want to treat the composed and decomposed forms of such
 150 a character, U+00C4 <small>LATIN CAPITAL LETTER A WITH DIAERESIS</small> and
 151 U+0041 <small>LATIN CAPITAL LETTER A</small> U+0308 <small>COMBINING DIAERESIS</small> the same.
 152 The <var>nf</var> argument designates the normalization.
 153 </p>
 154 <a name="IDX818"></a>
 155 <p>These functions are locale dependent.  The <var>iso639_language</var> argument
 156 identifies the language (e.g. <code>&quot;tr&quot;</code> for Turkish).  NULL means to use
 157 locale independent case mappings.
 158 </p>
 159 <dl>
 160 <dt><u>Function:</u> const char * <b>uc_locale_language</b><i> ()</i>
 161 <a name="IDX819"></a>
 162 </dt>
 163 <dd><p>Returns the ISO 639 language code of the current locale.
 164 Returns <code>&quot;&quot;</code> if it is unknown, or in the &quot;C&quot; locale.
 165 </p></dd></dl>
 166
 167 <dl>
 168 <dt><u>Function:</u> uint8_t * <b>u8_toupper</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 169 <a name="IDX820"></a>
 170 </dt>
 171 <dt><u>Function:</u> uint16_t * <b>u16_toupper</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 172 <a name="IDX821"></a>
 173 </dt>
 174 <dt><u>Function:</u> uint32_t * <b>u32_toupper</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 175 <a name="IDX822"></a>
 176 </dt>
 177 <dd><p>Returns the uppercase mapping of a string.
 178 </p>
 179 <p>The <var>nf</var> argument identifies the normalization form to apply after the
 180 case-mapping.  It can also be NULL, for no normalization.
 181 </p></dd></dl>
 182
 183 <dl>
 184 <dt><u>Function:</u> uint8_t * <b>u8_tolower</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 185 <a name="IDX823"></a>
 186 </dt>
 187 <dt><u>Function:</u> uint16_t * <b>u16_tolower</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 188 <a name="IDX824"></a>
 189 </dt>
 190 <dt><u>Function:</u> uint32_t * <b>u32_tolower</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 191 <a name="IDX825"></a>
 192 </dt>
 193 <dd><p>Returns the lowercase mapping of a string.
 194 </p>
 195 <p>The <var>nf</var> argument identifies the normalization form to apply after the
 196 case-mapping.  It can also be NULL, for no normalization.
 197 </p></dd></dl>
 198
 199 <dl>
 200 <dt><u>Function:</u> uint8_t * <b>u8_totitle</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 201 <a name="IDX826"></a>
 202 </dt>
 203 <dt><u>Function:</u> uint16_t * <b>u16_totitle</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 204 <a name="IDX827"></a>
 205 </dt>
 206 <dt><u>Function:</u> uint32_t * <b>u32_totitle</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 207 <a name="IDX828"></a>
 208 </dt>
 209 <dd><p>Returns the titlecase mapping of a string.
 210 </p>
 211 <p>Mapping to title case means that, in each word, the first cased character
 212 is being mapped to title case and the remaining characters of the word
 213 are being mapped to lower case.
 214 </p>
 215 <p>The <var>nf</var> argument identifies the normalization form to apply after the
 216 case-mapping.  It can also be NULL, for no normalization.
 217 </p></dd></dl>
 218
 219 <hr size="6">
 220 <a name="Case-mappings-of-substrings"></a>
 221 <a name="SEC57"></a>
 222 <h2 class="section"> <a href="libunistring.html#TOC57">14.3 Case mappings of substrings</a> </h2>
 223
 224 <p>Case mapping of a substring cannot simply be performed by extracting the
 225 substring and then applying the case mapping function to it.  This does not
 226 work because case mapping requires some information about the surrounding
 227 characters.  The following functions allow to apply case mappings to
 228 substrings of a given string, while taking into account the characters that
 229 precede it (the &ldquo;prefix&rdquo;) and the characters that follow it (the &ldquo;suffix&rdquo;).
 230 </p>
 231 <dl>
 232 <dt><u>Type:</u> <b>casing_prefix_context_t</b>
 233 <a name="IDX829"></a>
 234 </dt>
 235 <dd><p>This data type denotes the case-mapping context that is given by a prefix
 236 string.  It is an immediate type that can be copied by simple assignment,
 237 without involving memory allocation.  It is not an array type.
 238 </p></dd></dl>
 239
 240 <dl>
 241 <dt><u>Constant:</u> casing_prefix_context_t <b>unicase_empty_prefix_context</b>
 242 <a name="IDX830"></a>
 243 </dt>
 244 <dd><p>This constant is the case-mapping context that corresponds to an empty prefix
 245 string.
 246 </p></dd></dl>
 247
 248 <p>The following functions return <code>casing_prefix_context_t</code> objects:
 249 </p>
 250 <dl>
 251 <dt><u>Function:</u> casing_prefix_context_t <b>u8_casing_prefix_context</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>)</i>
 252 <a name="IDX831"></a>
 253 </dt>
 254 <dt><u>Function:</u> casing_prefix_context_t <b>u16_casing_prefix_context</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>)</i>
 255 <a name="IDX832"></a>
 256 </dt>
 257 <dt><u>Function:</u> casing_prefix_context_t <b>u32_casing_prefix_context</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>)</i>
 258 <a name="IDX833"></a>
 259 </dt>
 260 <dd><p>Returns the case-mapping context of a given prefix string.
 261 </p></dd></dl>
 262
 263 <dl>
 264 <dt><u>Function:</u> casing_prefix_context_t <b>u8_casing_prefixes_context</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>a_context</var>)</i>
 265 <a name="IDX834"></a>
 266 </dt>
 267 <dt><u>Function:</u> casing_prefix_context_t <b>u16_casing_prefixes_context</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>a_context</var>)</i>
 268 <a name="IDX835"></a>
 269 </dt>
 270 <dt><u>Function:</u> casing_prefix_context_t <b>u32_casing_prefixes_context</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>a_context</var>)</i>
 271 <a name="IDX836"></a>
 272 </dt>
 273 <dd><p>Returns the case-mapping context of the prefix concat(<var>a</var>, <var>s</var>),
 274 given the case-mapping context of the prefix <var>a</var>.
 275 </p></dd></dl>
 276
 277 <dl>
 278 <dt><u>Type:</u> <b>casing_suffix_context_t</b>
 279 <a name="IDX837"></a>
 280 </dt>
 281 <dd><p>This data type denotes the case-mapping context that is given by a suffix
 282 string.  It is an immediate type that can be copied by simple assignment,
 283 without involving memory allocation.  It is not an array type.
 284 </p></dd></dl>
 285
 286 <dl>
 287 <dt><u>Constant:</u> casing_suffix_context_t <b>unicase_empty_suffix_context</b>
 288 <a name="IDX838"></a>
 289 </dt>
 290 <dd><p>This constant is the case-mapping context that corresponds to an empty suffix
 291 string.
 292 </p></dd></dl>
 293
 294 <p>The following functions return <code>casing_suffix_context_t</code> objects:
 295 </p>
 296 <dl>
 297 <dt><u>Function:</u> casing_suffix_context_t <b>u8_casing_suffix_context</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>)</i>
 298 <a name="IDX839"></a>
 299 </dt>
 300 <dt><u>Function:</u> casing_suffix_context_t <b>u16_casing_suffix_context</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>)</i>
 301 <a name="IDX840"></a>
 302 </dt>
 303 <dt><u>Function:</u> casing_suffix_context_t <b>u32_casing_suffix_context</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>)</i>
 304 <a name="IDX841"></a>
 305 </dt>
 306 <dd><p>Returns the case-mapping context of a given suffix string.
 307 </p></dd></dl>
 308
 309 <dl>
 310 <dt><u>Function:</u> casing_suffix_context_t <b>u8_casing_suffixes_context</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, casing_suffix_context_t <var>a_context</var>)</i>
 311 <a name="IDX842"></a>
 312 </dt>
 313 <dt><u>Function:</u> casing_suffix_context_t <b>u16_casing_suffixes_context</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, casing_suffix_context_t <var>a_context</var>)</i>
 314 <a name="IDX843"></a>
 315 </dt>
 316 <dt><u>Function:</u> casing_suffix_context_t <b>u32_casing_suffixes_context</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, casing_suffix_context_t <var>a_context</var>)</i>
 317 <a name="IDX844"></a>
 318 </dt>
 319 <dd><p>Returns the case-mapping context of the suffix concat(<var>s</var>, <var>a</var>),
 320 given the case-mapping context of the suffix <var>a</var>.
 321 </p></dd></dl>
 322
 323 <p>The following functions perform a case mapping, considering the
 324 prefix context and the suffix context.
 325 </p>
 326 <dl>
 327 <dt><u>Function:</u> uint8_t * <b>u8_ct_toupper</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 328 <a name="IDX845"></a>
 329 </dt>
 330 <dt><u>Function:</u> uint16_t * <b>u16_ct_toupper</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 331 <a name="IDX846"></a>
 332 </dt>
 333 <dt><u>Function:</u> uint32_t * <b>u32_ct_toupper</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 334 <a name="IDX847"></a>
 335 </dt>
 336 <dd><p>Returns the uppercase mapping of a string that is surrounded by a prefix
 337 and a suffix.
 338 </p></dd></dl>
 339
 340 <dl>
 341 <dt><u>Function:</u> uint8_t * <b>u8_ct_tolower</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 342 <a name="IDX848"></a>
 343 </dt>
 344 <dt><u>Function:</u> uint16_t * <b>u16_ct_tolower</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 345 <a name="IDX849"></a>
 346 </dt>
 347 <dt><u>Function:</u> uint32_t * <b>u32_ct_tolower</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 348 <a name="IDX850"></a>
 349 </dt>
 350 <dd><p>Returns the lowercase mapping of a string that is surrounded by a prefix
 351 and a suffix.
 352 </p></dd></dl>
 353
 354 <dl>
 355 <dt><u>Function:</u> uint8_t * <b>u8_ct_totitle</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 356 <a name="IDX851"></a>
 357 </dt>
 358 <dt><u>Function:</u> uint16_t * <b>u16_ct_totitle</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 359 <a name="IDX852"></a>
 360 </dt>
 361 <dt><u>Function:</u> uint32_t * <b>u32_ct_totitle</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 362 <a name="IDX853"></a>
 363 </dt>
 364 <dd><p>Returns the titlecase mapping of a string that is surrounded by a prefix
 365 and a suffix.
 366 </p></dd></dl>
 367
 368 <p>For example, to uppercase the UTF-8 substring between <code>s + start_index</code>
 369 and <code>s + end_index</code> of a string that extends from <code>s</code> to
 370 <code>s + u8_strlen (s)</code>, you can use the statements
 371 </p>
 372 <table><tr><td>&nbsp;</td><td><pre class="smallexample">size_t result_length;
 373 uint8_t result =
 374   u8_ct_toupper (s + start_index, end_index - start_index,
 375                  u8_casing_prefix_context (s, start_index),
 376                  u8_casing_suffix_context (s + end_index,
 377                                            u8_strlen (s) - end_index),
 378                  iso639_language, NULL, NULL, &amp;result_length);
 379 </pre></td></tr></table>
 380
 381 <hr size="6">
 382 <a name="Case-insensitive-comparison"></a>
 383 <a name="SEC58"></a>
 384 <h2 class="section"> <a href="libunistring.html#TOC58">14.4 Case insensitive comparison</a> </h2>
 385
 386 <p>The following functions implement comparison that ignores differences in case
 387 and normalization.
 388 </p>
 389 <dl>
 390 <dt><u>Function:</u> uint8_t * <b>u8_casefold</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 391 <a name="IDX854"></a>
 392 </dt>
 393 <dt><u>Function:</u> uint16_t * <b>u16_casefold</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 394 <a name="IDX855"></a>
 395 </dt>
 396 <dt><u>Function:</u> uint32_t * <b>u32_casefold</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 397 <a name="IDX856"></a>
 398 </dt>
 399 <dd><p>Returns the case folded string.
 400 </p>
 401 <p>Comparing <code>u8_casefold (<var>s1</var>)</code> and <code>u8_casefold (<var>s2</var>)</code>
 402 with the <code>u8_cmp2</code> function is equivalent to comparing <var>s1</var> and
 403 <var>s2</var> with <code>u8_casecmp</code>.
 404 </p>
 405 <p>The <var>nf</var> argument identifies the normalization form to apply after the
 406 case-mapping.  It can also be NULL, for no normalization.
 407 </p></dd></dl>
 408
 409 <dl>
 410 <dt><u>Function:</u> uint8_t * <b>u8_ct_casefold</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint8_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 411 <a name="IDX857"></a>
 412 </dt>
 413 <dt><u>Function:</u> uint16_t * <b>u16_ct_casefold</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint16_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 414 <a name="IDX858"></a>
 415 </dt>
 416 <dt><u>Function:</u> uint32_t * <b>u32_ct_casefold</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, casing_prefix_context_t <var>prefix_context</var>, casing_suffix_context_t <var>suffix_context</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, uint32_t *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 417 <a name="IDX859"></a>
 418 </dt>
 419 <dd><p>Returns the case folded string.  The case folding takes into account the
 420 case mapping contexts of the prefix and suffix strings.
 421 </p></dd></dl>
 422
 423 <dl>
 424 <dt><u>Function:</u> int <b>u8_casecmp</b><i> (const uint8_t *<var>s1</var>, size_t <var>n1</var>, const uint8_t *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 425 <a name="IDX860"></a>
 426 </dt>
 427 <dt><u>Function:</u> int <b>u16_casecmp</b><i> (const uint16_t *<var>s1</var>, size_t <var>n1</var>, const uint16_t *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 428 <a name="IDX861"></a>
 429 </dt>
 430 <dt><u>Function:</u> int <b>u32_casecmp</b><i> (const uint32_t *<var>s1</var>, size_t <var>n1</var>, const uint32_t *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 431 <a name="IDX862"></a>
 432 </dt>
 433 <dt><u>Function:</u> int <b>ulc_casecmp</b><i> (const char *<var>s1</var>, size_t <var>n1</var>, const char *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 434 <a name="IDX863"></a>
 435 </dt>
 436 <dd><p>Compares <var>s1</var> and <var>s2</var>, ignoring differences in case and normalization.
 437 </p>
 438 <p>The <var>nf</var> argument identifies the normalization form to apply after the
 439 case-mapping.  It can also be NULL, for no normalization.
 440 </p>
 441 <p>If successful, sets <code>*<var>resultp</var></code> to -1 if <var>s1</var> &lt; <var>s2</var>,
 442 0 if <var>s1</var> = <var>s2</var>, 1 if <var>s1</var> &gt; <var>s2</var>, and returns 0.
 443 Upon failure, returns -1 with <code>errno</code> set.
 444 </p></dd></dl>
 445
 446 <a name="IDX864"></a>
 447 <a name="IDX865"></a>
 448 <a name="IDX866"></a>
 449 <a name="IDX867"></a>
 450 <p>The following functions additionally take into account the sorting rules of the
 451 current locale.
 452 </p>
 453 <dl>
 454 <dt><u>Function:</u> char * <b>u8_casexfrm</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, char *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 455 <a name="IDX868"></a>
 456 </dt>
 457 <dt><u>Function:</u> char * <b>u16_casexfrm</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, char *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 458 <a name="IDX869"></a>
 459 </dt>
 460 <dt><u>Function:</u> char * <b>u32_casexfrm</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, char *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 461 <a name="IDX870"></a>
 462 </dt>
 463 <dt><u>Function:</u> char * <b>ulc_casexfrm</b><i> (const char *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, char *<var>resultbuf</var>, size_t *<var>lengthp</var>)</i>
 464 <a name="IDX871"></a>
 465 </dt>
 466 <dd><p>Converts the string <var>s</var> of length <var>n</var> to a NUL-terminated byte
 467 sequence, in such a way that comparing <code>u8_casexfrm (<var>s1</var>)</code> and
 468 <code>u8_casexfrm (<var>s2</var>)</code> with the gnulib function <code>memcmp2</code> is
 469 equivalent to comparing <var>s1</var> and <var>s2</var> with <code>u8_casecoll</code>.
 470 </p>
 471 <p><var>nf</var> must be either <code>UNINORM_NFC</code>, <code>UNINORM_NFKC</code>, or NULL for
 472 no normalization.
 473 </p></dd></dl>
 474
 475 <dl>
 476 <dt><u>Function:</u> int <b>u8_casecoll</b><i> (const uint8_t *<var>s1</var>, size_t <var>n1</var>, const uint8_t *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 477 <a name="IDX872"></a>
 478 </dt>
 479 <dt><u>Function:</u> int <b>u16_casecoll</b><i> (const uint16_t *<var>s1</var>, size_t <var>n1</var>, const uint16_t *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 480 <a name="IDX873"></a>
 481 </dt>
 482 <dt><u>Function:</u> int <b>u32_casecoll</b><i> (const uint32_t *<var>s1</var>, size_t <var>n1</var>, const uint32_t *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 483 <a name="IDX874"></a>
 484 </dt>
 485 <dt><u>Function:</u> int <b>ulc_casecoll</b><i> (const char *<var>s1</var>, size_t <var>n1</var>, const char *<var>s2</var>, size_t <var>n2</var>, const char *<var>iso639_language</var>, uninorm_t <var>nf</var>, int *<var>resultp</var>)</i>
 486 <a name="IDX875"></a>
 487 </dt>
 488 <dd><p>Compares <var>s1</var> and <var>s2</var>, ignoring differences in case and normalization,
 489 using the collation rules of the current locale.
 490 </p>
 491 <p>The <var>nf</var> argument identifies the normalization form to apply after the
 492 case-mapping.  It must be either <code>UNINORM_NFC</code> or <code>UNINORM_NFKC</code>.
 493 It can also be NULL, for no normalization.
 494 </p>
 495 <p>If successful, sets <code>*<var>resultp</var></code> to -1 if <var>s1</var> &lt; <var>s2</var>,
 496 0 if <var>s1</var> = <var>s2</var>, 1 if <var>s1</var> &gt; <var>s2</var>, and returns 0.
 497 Upon failure, returns -1 with <code>errno</code> set.
 498 </p></dd></dl>
 499
 500 <hr size="6">
 501 <a name="Case-detection"></a>
 502 <a name="SEC59"></a>
 503 <h2 class="section"> <a href="libunistring.html#TOC59">14.5 Case detection</a> </h2>
 504
 505 <p>The following functions determine whether a Unicode string is entirely in
 506 upper case. or entirely in lower case, or entirely in title case, or already
 507 case-folded.
 508 </p>
 509 <dl>
 510 <dt><u>Function:</u> int <b>u8_is_uppercase</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 511 <a name="IDX876"></a>
 512 </dt>
 513 <dt><u>Function:</u> int <b>u16_is_uppercase</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 514 <a name="IDX877"></a>
 515 </dt>
 516 <dt><u>Function:</u> int <b>u32_is_uppercase</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 517 <a name="IDX878"></a>
 518 </dt>
 519 <dd><p>Sets <code>*<var>resultp</var></code> to true if mapping NFD(<var>s</var>) to upper case is
 520 a no-op, or to false otherwise, and returns 0.  Upon failure, returns -1 with
 521 <code>errno</code> set.
 522 </p></dd></dl>
 523
 524 <dl>
 525 <dt><u>Function:</u> int <b>u8_is_lowercase</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 526 <a name="IDX879"></a>
 527 </dt>
 528 <dt><u>Function:</u> int <b>u16_is_lowercase</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 529 <a name="IDX880"></a>
 530 </dt>
 531 <dt><u>Function:</u> int <b>u32_is_lowercase</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 532 <a name="IDX881"></a>
 533 </dt>
 534 <dd><p>Sets <code>*<var>resultp</var></code> to true if mapping NFD(<var>s</var>) to lower case is
 535 a no-op, or to false otherwise, and returns 0.  Upon failure, returns -1 with
 536 <code>errno</code> set.
 537 </p></dd></dl>
 538
 539 <dl>
 540 <dt><u>Function:</u> int <b>u8_is_titlecase</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 541 <a name="IDX882"></a>
 542 </dt>
 543 <dt><u>Function:</u> int <b>u16_is_titlecase</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 544 <a name="IDX883"></a>
 545 </dt>
 546 <dt><u>Function:</u> int <b>u32_is_titlecase</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 547 <a name="IDX884"></a>
 548 </dt>
 549 <dd><p>Sets <code>*<var>resultp</var></code> to true if mapping NFD(<var>s</var>) to title case is
 550 a no-op, or to false otherwise, and returns 0.  Upon failure, returns -1 with
 551 <code>errno</code> set.
 552 </p></dd></dl>
 553
 554 <dl>
 555 <dt><u>Function:</u> int <b>u8_is_casefolded</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 556 <a name="IDX885"></a>
 557 </dt>
 558 <dt><u>Function:</u> int <b>u16_is_casefolded</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 559 <a name="IDX886"></a>
 560 </dt>
 561 <dt><u>Function:</u> int <b>u32_is_casefolded</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 562 <a name="IDX887"></a>
 563 </dt>
 564 <dd><p>Sets <code>*<var>resultp</var></code> to true if applying case folding to NFD(<var>S</var>) is
 565 a no-op, or to false otherwise, and returns 0.  Upon failure, returns -1 with
 566 <code>errno</code> set.
 567 </p></dd></dl>
 568
 569 <p>The following functions determine whether case mappings have any effect on a
 570 Unicode string.
 571 </p>
 572 <dl>
 573 <dt><u>Function:</u> int <b>u8_is_cased</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 574 <a name="IDX888"></a>
 575 </dt>
 576 <dt><u>Function:</u> int <b>u16_is_cased</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 577 <a name="IDX889"></a>
 578 </dt>
 579 <dt><u>Function:</u> int <b>u32_is_cased</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, const char *<var>iso639_language</var>, bool *<var>resultp</var>)</i>
 580 <a name="IDX890"></a>
 581 </dt>
 582 <dd><p>Sets <code>*<var>resultp</var></code> to true if case matters for <var>s</var>, that is, if
 583 mapping NFD(<var>s</var>) to either upper case or lower case or title case is not
 584 a no-op.  Set <code>*<var>resultp</var></code> to false if NFD(<var>s</var>) maps to itself
 585 under the upper case mapping, under the lower case mapping, and under the title
 586 case mapping; in other words, when NFD(<var>s</var>) consists entirely of caseless
 587 characters. Upon failure, returns -1 with <code>errno</code> set.
 588 </p></dd></dl>
 589 <hr size="6">
 590 <table cellpadding="1" cellspacing="1" border="0">
 591 <tr><td valign="middle" align="left">[<a href="#SEC54" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
 592 <td valign="middle" align="left">[<a href="libunistring_15.html#SEC60" title="Next chapter"> &gt;&gt; </a>]</td>
 593 <td valign="middle" align="left"> &nbsp; </td>
 594 <td valign="middle" align="left"> &nbsp; </td>
 595 <td valign="middle" align="left"> &nbsp; </td>
 596 <td valign="middle" align="left"> &nbsp; </td>
 597 <td valign="middle" align="left"> &nbsp; </td>
 598 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Top" title="Cover (top) of document">Top</a>]</td>
 599 <td valign="middle" align="left">[<a href="libunistring.html#SEC_Contents" title="Table of contents">Contents</a>]</td>
 600 <td valign="middle" align="left">[<a href="libunistring_19.html#SEC77" title="Index">Index</a>]</td>
 601 <td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td>
 602 </tr></table>
 603 <p>
 604  <font size="-1">
 605   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>.
 606  </font>
 607  <br>
 608
 609 </p>
 610 </body>
 611 </html>