ProxSpace/msys2/usr/share/doc/libunistring/libunistring_11.html
2023-09-22 00:10:50 +02:00

220 lines
8.4 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html401/loose.dtd">
<html>
<!-- Created on October, 16 2022 by texi2html 1.78a -->
<!--
Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
Karl Berry <karl@freefriends.org>
Olaf Bachmann <obachman@mathematik.uni-kl.de>
and many others.
Maintained by: Many creative people.
Send bugs and suggestions to <texi2html-bug@nongnu.org>
-->
<head>
<title>GNU libunistring: 11. Word breaks in strings &lt;uniwbrk.h&gt;</title>
<meta name="description" content="GNU libunistring: 11. Word breaks in strings &lt;uniwbrk.h&gt;">
<meta name="keywords" content="GNU libunistring: 11. Word breaks in strings &lt;uniwbrk.h&gt;">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2html 1.78a">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
pre.display {font-family: serif}
pre.format {font-family: serif}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: serif; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: serif; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.roman {font-family:serif; font-weight:normal;}
span.sansserif {font-family:sans-serif; font-weight:normal;}
ul.toc {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="libunistring_10.html#SEC54" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="libunistring_12.html#SEC60" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </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="uniwbrk_002eh"></a>
<a name="SEC57"></a>
<h1 class="chapter"> <a href="libunistring_toc.html#TOC57">11. Word breaks in strings <code>&lt;uniwbrk.h&gt;</code></a> </h1>
<p>This include file declares functions for determining where in a string
&ldquo;words&rdquo; start and end. Here &ldquo;words&rdquo; are not necessarily the same as
entities that can be looked up in dictionaries, but rather groups of
consecutive characters that should not be split by text processing
operations.
</p>
<hr size="6">
<a name="Word-breaks-in-a-string"></a>
<a name="SEC58"></a>
<h2 class="section"> <a href="libunistring_toc.html#TOC58">11.1 Word breaks in a string</a> </h2>
<p>The following functions determine the word breaks in a string.
</p>
<dl>
<dt><u>Function:</u> void <b>u8_wordbreaks</b><i> (const&nbsp;uint8_t&nbsp;*<var>s</var>, size_t&nbsp;<var>n</var>, char&nbsp;*<var>p</var>)</i>
<a name="IDX800"></a>
</dt>
<dt><u>Function:</u> void <b>u16_wordbreaks</b><i> (const&nbsp;uint16_t&nbsp;*<var>s</var>, size_t&nbsp;<var>n</var>, char&nbsp;*<var>p</var>)</i>
<a name="IDX801"></a>
</dt>
<dt><u>Function:</u> void <b>u32_wordbreaks</b><i> (const&nbsp;uint32_t&nbsp;*<var>s</var>, size_t&nbsp;<var>n</var>, char&nbsp;*<var>p</var>)</i>
<a name="IDX802"></a>
</dt>
<dt><u>Function:</u> void <b>ulc_wordbreaks</b><i> (const&nbsp;char&nbsp;*<var>s</var>, size_t&nbsp;<var>n</var>, char&nbsp;*<var>p</var>)</i>
<a name="IDX803"></a>
</dt>
<dd><p>Determines the word break points in <var>s</var>, an array of <var>n</var> units, and
stores the result at <code><var>p</var>[0..<var>n</var>-1]</code>.
</p><dl compact="compact">
<dt> <code><var>p</var>[i] = 1</code></dt>
<dd><p>means that there is a word boundary between <code><var>s</var>[i-1]</code> and
<code><var>s</var>[i]</code>.
</p></dd>
<dt> <code><var>p</var>[i] = 0</code></dt>
<dd><p>means that <code><var>s</var>[i-1]</code> and <code><var>s</var>[i]</code> must not be separated.
</p></dd>
</dl>
<p><code><var>p</var>[0]</code> is always set to 0. If an application wants to consider a
word break to be present at the beginning of the string (before
<code><var>s</var>[0]</code>) or at the end of the string (after
<code><var>s</var>[0..<var>n</var>-1]</code>), it has to treat these cases explicitly.
</p></dd></dl>
<hr size="6">
<a name="Word-break-property"></a>
<a name="SEC59"></a>
<h2 class="section"> <a href="libunistring_toc.html#TOC59">11.2 Word break property</a> </h2>
<p>This is a more low-level API. The word break property is a property defined
in Unicode Standard Annex #29, section &ldquo;Word Boundaries&rdquo;, see
<a href="https://www.unicode.org/reports/tr29/#Word_Boundaries">https://www.unicode.org/reports/tr29/#Word_Boundaries</a>. It is
used for determining the word breaks in a string.
</p>
<p>The following are the possible values of the word break property. More values
may be added in the future.
</p>
<dl>
<dt><u>Constant:</u> int <b>WBP_OTHER</b>
<a name="IDX804"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_CR</b>
<a name="IDX805"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_LF</b>
<a name="IDX806"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_NEWLINE</b>
<a name="IDX807"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_EXTEND</b>
<a name="IDX808"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_FORMAT</b>
<a name="IDX809"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_KATAKANA</b>
<a name="IDX810"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_ALETTER</b>
<a name="IDX811"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_MIDNUMLET</b>
<a name="IDX812"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_MIDLETTER</b>
<a name="IDX813"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_MIDNUM</b>
<a name="IDX814"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_NUMERIC</b>
<a name="IDX815"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_EXTENDNUMLET</b>
<a name="IDX816"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_RI</b>
<a name="IDX817"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_DQ</b>
<a name="IDX818"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_SQ</b>
<a name="IDX819"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_HL</b>
<a name="IDX820"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_ZWJ</b>
<a name="IDX821"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_EB</b>
<a name="IDX822"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_EM</b>
<a name="IDX823"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_GAZ</b>
<a name="IDX824"></a>
</dt>
<dt><u>Constant:</u> int <b>WBP_EBG</b>
<a name="IDX825"></a>
</dt>
</dl>
<p>The following function looks up the word break property of a character.
</p>
<dl>
<dt><u>Function:</u> int <b>uc_wordbreak_property</b><i> (ucs4_t&nbsp;<var>uc</var>)</i>
<a name="IDX826"></a>
</dt>
<dd><p>Returns the Word_Break property of a Unicode character.
</p></dd></dl>
<hr size="6">
<table cellpadding="1" cellspacing="1" border="0">
<tr><td valign="middle" align="left">[<a href="#SEC57" title="Beginning of this chapter or previous chapter"> &lt;&lt; </a>]</td>
<td valign="middle" align="left">[<a href="libunistring_12.html#SEC60" title="Next chapter"> &gt;&gt; </a>]</td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </td>
<td valign="middle" align="left"> &nbsp; </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>Bruno Haible</em> on <em>October, 16 2022</em> using <a href="https://www.nongnu.org/texi2html/"><em>texi2html 1.78a</em></a>.
</font>
<br>
</p>
</body>
</html>