diff options
Diffstat (limited to 'doc/libunistring_10.html')
| -rw-r--r-- | doc/libunistring_10.html | 114 |
1 files changed, 58 insertions, 56 deletions
diff --git a/doc/libunistring_10.html b/doc/libunistring_10.html index 68448fb..4c0ac07 100644 --- a/doc/libunistring_10.html +++ b/doc/libunistring_10.html @@ -1,6 +1,6 @@ <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd"> <html> -<!-- Created on May, 25 2018 by texi2html 1.78a --> +<!-- Created on January, 2 2022 by texi2html 1.78a --> <!-- Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author) Karl Berry <karl@freefriends.org> @@ -49,16 +49,16 @@ ul.toc {list-style: none} <td valign="middle" align="left"> </td> <td valign="middle" align="left"> </td> <td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="libunistring.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> -<td valign="middle" align="left">[<a href="libunistring.html#SEC_Contents" title="Table of contents">Contents</a>]</td> -<td valign="middle" align="left">[<a href="libunistring_20.html#SEC91" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="libunistring_21.html#SEC92" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> <hr size="2"> <a name="unigbrk_002eh"></a> <a name="SEC54"></a> -<h1 class="chapter"> <a href="libunistring.html#TOC54">10. Grapheme cluster breaks in strings <code><unigbrk.h></code></a> </h1> +<h1 class="chapter"> <a href="libunistring_toc.html#TOC54">10. Grapheme cluster breaks in strings <code><unigbrk.h></code></a> </h1> <p>This include file declares functions for determining where in a string “grapheme clusters” start and end. A “grapheme cluster” is an @@ -86,20 +86,20 @@ clusters. <hr size="6"> <a name="Grapheme-cluster-breaks-in-a-string"></a> <a name="SEC55"></a> -<h2 class="section"> <a href="libunistring.html#TOC55">10.1 Grapheme cluster breaks in a string</a> </h2> +<h2 class="section"> <a href="libunistring_toc.html#TOC55">10.1 Grapheme cluster breaks in a string</a> </h2> <p>The following functions find a single boundary between grapheme clusters in a string. </p> <dl> -<dt><u>Function:</u> void <b>u8_grapheme_next</b><i> (const uint8_t *<var>s</var>, const uint8_t *<var>end</var>)</i> -<a name="IDX703"></a> +<dt><u>Function:</u> void <b>u8_grapheme_next</b><i> (const uint8_t *<var>s</var>, const uint8_t *<var>end</var>)</i> +<a name="IDX768"></a> </dt> -<dt><u>Function:</u> void <b>u16_grapheme_next</b><i> (const uint16_t *<var>s</var>, const uint16_t *<var>end</var>)</i> -<a name="IDX704"></a> +<dt><u>Function:</u> void <b>u16_grapheme_next</b><i> (const uint16_t *<var>s</var>, const uint16_t *<var>end</var>)</i> +<a name="IDX769"></a> </dt> -<dt><u>Function:</u> void <b>u32_grapheme_next</b><i> (const uint32_t *<var>s</var>, const uint32_t *<var>end</var>)</i> -<a name="IDX705"></a> +<dt><u>Function:</u> void <b>u32_grapheme_next</b><i> (const uint32_t *<var>s</var>, const uint32_t *<var>end</var>)</i> +<a name="IDX770"></a> </dt> <dd><p>Returns the start of the next grapheme cluster following <var>s</var>, or <var>end</var> if no grapheme cluster break is encountered before it. @@ -112,14 +112,14 @@ cases. </p></dd></dl> <dl> -<dt><u>Function:</u> void <b>u8_grapheme_prev</b><i> (const uint8_t *<var>s</var>, const uint8_t *<var>start</var>)</i> -<a name="IDX706"></a> +<dt><u>Function:</u> void <b>u8_grapheme_prev</b><i> (const uint8_t *<var>s</var>, const uint8_t *<var>start</var>)</i> +<a name="IDX771"></a> </dt> -<dt><u>Function:</u> void <b>u16_grapheme_prev</b><i> (const uint16_t *<var>s</var>, const uint16_t *<var>start</var>)</i> -<a name="IDX707"></a> +<dt><u>Function:</u> void <b>u16_grapheme_prev</b><i> (const uint16_t *<var>s</var>, const uint16_t *<var>start</var>)</i> +<a name="IDX772"></a> </dt> -<dt><u>Function:</u> void <b>u32_grapheme_prev</b><i> (const uint32_t *<var>s</var>, const uint32_t *<var>start</var>)</i> -<a name="IDX708"></a> +<dt><u>Function:</u> void <b>u32_grapheme_prev</b><i> (const uint32_t *<var>s</var>, const uint32_t *<var>start</var>)</i> +<a name="IDX773"></a> </dt> <dd><p>Returns the start of the grapheme cluster preceding <var>s</var>, or <var>start</var> if no grapheme cluster break is encountered before it. @@ -129,26 +129,28 @@ Returns NULL if and only if <code><var>s</var> == <var>start</var></code>. outside of the range between <var>start</var> and <var>s</var> is needed to determine the boundary. Use <code>_grapheme_breaks</code> functions for such cases. +</p> +<p>Note also that these functions work only on well-formed Unicode strings. </p></dd></dl> <p>The following functions determine all of the grapheme cluster boundaries in a string. </p> <dl> -<dt><u>Function:</u> void <b>u8_grapheme_breaks</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> -<a name="IDX709"></a> +<dt><u>Function:</u> void <b>u8_grapheme_breaks</b><i> (const uint8_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> +<a name="IDX774"></a> </dt> -<dt><u>Function:</u> void <b>u16_grapheme_breaks</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> -<a name="IDX710"></a> +<dt><u>Function:</u> void <b>u16_grapheme_breaks</b><i> (const uint16_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> +<a name="IDX775"></a> </dt> -<dt><u>Function:</u> void <b>u32_grapheme_breaks</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> -<a name="IDX711"></a> +<dt><u>Function:</u> void <b>u32_grapheme_breaks</b><i> (const uint32_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> +<a name="IDX776"></a> </dt> -<dt><u>Function:</u> void <b>ulc_grapheme_breaks</b><i> (const char *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> -<a name="IDX712"></a> +<dt><u>Function:</u> void <b>ulc_grapheme_breaks</b><i> (const char *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> +<a name="IDX777"></a> </dt> -<dt><u>Function:</u> void <b>uc_grapheme_breaks</b><i> (const ucs_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> -<a name="IDX713"></a> +<dt><u>Function:</u> void <b>uc_grapheme_breaks</b><i> (const ucs_t *<var>s</var>, size_t <var>n</var>, char *<var>p</var>)</i> +<a name="IDX778"></a> </dt> <dd><p>Determines the grapheme cluster break points in <var>s</var>, an array of <var>n</var> units, and stores the result at <code><var>p</var>[0..<var>nx</var>-1]</code>. @@ -176,12 +178,12 @@ characters. <hr size="6"> <a name="Grapheme-cluster-break-property"></a> <a name="SEC56"></a> -<h2 class="section"> <a href="libunistring.html#TOC56">10.2 Grapheme cluster break property</a> </h2> +<h2 class="section"> <a href="libunistring_toc.html#TOC56">10.2 Grapheme cluster break property</a> </h2> <p>This is a more low-level API. The grapheme cluster break property is a property defined in Unicode Standard Annex #29, section “Grapheme Cluster Boundaries”, see -<a href="http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries">http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries</a>. +<a href="https://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries">https://www.unicode.org/reports/tr29/#Grapheme_Cluster_Boundaries</a>. It is used for determining the grapheme cluster breaks in a string. </p> <p>The following are the possible values of the grapheme cluster break @@ -189,58 +191,58 @@ property. More values may be added in the future. </p> <dl> <dt><u>Constant:</u> int <b>GBP_OTHER</b> -<a name="IDX714"></a> +<a name="IDX779"></a> </dt> <dt><u>Constant:</u> int <b>GBP_CR</b> -<a name="IDX715"></a> +<a name="IDX780"></a> </dt> <dt><u>Constant:</u> int <b>GBP_LF</b> -<a name="IDX716"></a> +<a name="IDX781"></a> </dt> <dt><u>Constant:</u> int <b>GBP_CONTROL</b> -<a name="IDX717"></a> +<a name="IDX782"></a> </dt> <dt><u>Constant:</u> int <b>GBP_EXTEND</b> -<a name="IDX718"></a> +<a name="IDX783"></a> </dt> <dt><u>Constant:</u> int <b>GBP_PREPEND</b> -<a name="IDX719"></a> +<a name="IDX784"></a> </dt> <dt><u>Constant:</u> int <b>GBP_SPACINGMARK</b> -<a name="IDX720"></a> +<a name="IDX785"></a> </dt> <dt><u>Constant:</u> int <b>GBP_L</b> -<a name="IDX721"></a> +<a name="IDX786"></a> </dt> <dt><u>Constant:</u> int <b>GBP_V</b> -<a name="IDX722"></a> +<a name="IDX787"></a> </dt> <dt><u>Constant:</u> int <b>GBP_T</b> -<a name="IDX723"></a> +<a name="IDX788"></a> </dt> <dt><u>Constant:</u> int <b>GBP_LV</b> -<a name="IDX724"></a> +<a name="IDX789"></a> </dt> <dt><u>Constant:</u> int <b>GBP_LVT</b> -<a name="IDX725"></a> +<a name="IDX790"></a> </dt> <dt><u>Constant:</u> int <b>GBP_RI</b> -<a name="IDX726"></a> +<a name="IDX791"></a> </dt> <dt><u>Constant:</u> int <b>GBP_ZWJ</b> -<a name="IDX727"></a> +<a name="IDX792"></a> </dt> <dt><u>Constant:</u> int <b>GBP_EB</b> -<a name="IDX728"></a> +<a name="IDX793"></a> </dt> <dt><u>Constant:</u> int <b>GBP_EM</b> -<a name="IDX729"></a> +<a name="IDX794"></a> </dt> <dt><u>Constant:</u> int <b>GBP_GAZ</b> -<a name="IDX730"></a> +<a name="IDX795"></a> </dt> <dt><u>Constant:</u> int <b>GBP_EBG</b> -<a name="IDX731"></a> +<a name="IDX796"></a> </dt> </dl> @@ -248,8 +250,8 @@ property. More values may be added in the future. character. </p> <dl> -<dt><u>Function:</u> int <b>uc_graphemeclusterbreak_property</b><i> (ucs4_t <var>uc</var>)</i> -<a name="IDX732"></a> +<dt><u>Function:</u> int <b>uc_graphemeclusterbreak_property</b><i> (ucs4_t <var>uc</var>)</i> +<a name="IDX797"></a> </dt> <dd><p>Returns the Grapheme_Cluster_Break property of a Unicode character. </p></dd></dl> @@ -259,8 +261,8 @@ break between two Unicode characters. It is the primitive upon which the higher-level functions in the previous section are directly based. </p> <dl> -<dt><u>Function:</u> bool <b>uc_is_grapheme_break</b><i> (ucs4_t <var>a</var>, ucs4_t <var>b</var>)</i> -<a name="IDX733"></a> +<dt><u>Function:</u> bool <b>uc_is_grapheme_break</b><i> (ucs4_t <var>a</var>, ucs4_t <var>b</var>)</i> +<a name="IDX798"></a> </dt> <dd><p>Returns true if there is an grapheme cluster boundary between Unicode characters <var>a</var> and <var>b</var>. @@ -286,14 +288,14 @@ consecutive characters are needed to determine the boundary. Use <td valign="middle" align="left"> </td> <td valign="middle" align="left"> </td> <td valign="middle" align="left"> </td> -<td valign="middle" align="left">[<a href="libunistring.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> -<td valign="middle" align="left">[<a href="libunistring.html#SEC_Contents" title="Table of contents">Contents</a>]</td> -<td valign="middle" align="left">[<a href="libunistring_20.html#SEC91" title="Index">Index</a>]</td> +<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Top" title="Cover (top) of document">Top</a>]</td> +<td valign="middle" align="left">[<a href="libunistring_toc.html#SEC_Contents" title="Table of contents">Contents</a>]</td> +<td valign="middle" align="left">[<a href="libunistring_21.html#SEC92" title="Index">Index</a>]</td> <td valign="middle" align="left">[<a href="libunistring_abt.html#SEC_About" title="About (help)"> ? </a>]</td> </tr></table> <p> <font size="-1"> - This document was generated by <em>Daiki Ueno</em> on <em>May, 25 2018</em> using <a href="http://www.nongnu.org/texi2html/"><em>texi2html 1.78a</em></a>. + This document was generated by <em>Bruno Haible</em> on <em>January, 2 2022</em> using <a href="https://www.nongnu.org/texi2html/"><em>texi2html 1.78a</em></a>. </font> <br> |