| Linux in-mum-web1499.main-hosting.eu 5.14.0-503.40.1.el9_5.x86_64 #1 SMP PREEMPT_DYNAMIC Mon May 5 06:06:04 EDT 2025 x86_64 Path : /opt/alt/alt-nodejs24/root/usr/share/doc/alt-nodejs24-libicu-doc/ |
| Current File : //opt/alt/alt-nodejs24/root/usr/share/doc/alt-nodejs24-libicu-doc/classExternalBreakEngine.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ICU 77.1: icu::ExternalBreakEngine Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ICU 77.1
 <span id="projectnumber">77.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceicu.html">icu</a></li><li class="navelem"><a class="el" href="classicu_1_1ExternalBreakEngine.html">ExternalBreakEngine</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">icu::ExternalBreakEngine Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classicu_1_1ExternalBreakEngine.html" title="The ExternalBreakEngine class define an abstract interface for the host environment to provide a low ...">ExternalBreakEngine</a> class define an abstract interface for the host environment to provide a low level facility to break text for unicode text in script that the text boundary cannot be handled by upper level rule based logic, for example, for Chinese and Japanese word breaking, Thai, Khmer, Burmese, Lao and other Southeast Asian scripts.
<a href="classicu_1_1ExternalBreakEngine.html#details">More...</a></p>
<p><code>#include <<a class="el" href="rbbi_8h_source.html">rbbi.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for icu::ExternalBreakEngine:</div>
<div class="dyncontent">
<div class="center">
<img src="classicu_1_1ExternalBreakEngine.png" usemap="#icu::ExternalBreakEngine_map" alt=""/>
<map id="icu::ExternalBreakEngine_map" name="icu::ExternalBreakEngine_map">
<area href="classicu_1_1UObject.html" title="UObject is the common ICU "boilerplate" class." alt="icu::UObject" shape="rect" coords="0,56,153,80"/>
<area href="classicu_1_1UMemory.html" title="UMemory is the common ICU base class." alt="icu::UMemory" shape="rect" coords="0,0,153,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afbe2d84b15f76cff3368e7d0a594235c"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ExternalBreakEngine.html#afbe2d84b15f76cff3368e7d0a594235c">~ExternalBreakEngine</a> ()</td></tr>
<tr class="memdesc:afbe2d84b15f76cff3368e7d0a594235c"><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="classicu_1_1ExternalBreakEngine.html#afbe2d84b15f76cff3368e7d0a594235c">More...</a><br /></td></tr>
<tr class="separator:afbe2d84b15f76cff3368e7d0a594235c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a289dc5c2c1ab2d559b5708c00b96a63f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ExternalBreakEngine.html#a289dc5c2c1ab2d559b5708c00b96a63f">isFor</a> (<a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c, const char *locale) const =0</td></tr>
<tr class="separator:a289dc5c2c1ab2d559b5708c00b96a63f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a2a35e7cbf5c0b2d6cbd59cab0e07fc"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ExternalBreakEngine.html#a8a2a35e7cbf5c0b2d6cbd59cab0e07fc">handles</a> (<a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> c) const =0</td></tr>
<tr class="separator:a8a2a35e7cbf5c0b2d6cbd59cab0e07fc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d578ef0687b395b32dc5aeafa2a38e2"><td class="memItemLeft" align="right" valign="top">virtual int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1ExternalBreakEngine.html#a4d578ef0687b395b32dc5aeafa2a38e2">fillBreaks</a> (<a class="el" href="structUText.html">UText</a> *text, int32_t start, int32_t end, int32_t *foundBreaks, int32_t foundBreaksCapacity, <a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> &status) const =0</td></tr>
<tr class="separator:a4d578ef0687b395b32dc5aeafa2a38e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classicu_1_1UObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classicu_1_1UObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classicu_1_1UObject.html">icu::UObject</a></td></tr>
<tr class="memitem:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">~UObject</a> ()</td></tr>
<tr class="memdesc:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classicu_1_1UObject.html#af10026497704f510d3d1f2eff50acb18">More...</a><br /></td></tr>
<tr class="separator:af10026497704f510d3d1f2eff50acb18 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca1169c4978c52ce2b76eda104e9a214 inherit pub_methods_classicu_1_1UObject"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="uobject_8h.html#a22af10545208a455a6e884008df48e9f">UClassID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classicu_1_1UObject.html#aca1169c4978c52ce2b76eda104e9a214">getDynamicClassID</a> () const</td></tr>
<tr class="memdesc:aca1169c4978c52ce2b76eda104e9a214 inherit pub_methods_classicu_1_1UObject"><td class="mdescLeft"> </td><td class="mdescRight">ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class. <a href="classicu_1_1UObject.html#aca1169c4978c52ce2b76eda104e9a214">More...</a><br /></td></tr>
<tr class="separator:aca1169c4978c52ce2b76eda104e9a214 inherit pub_methods_classicu_1_1UObject"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classicu_1_1ExternalBreakEngine.html" title="The ExternalBreakEngine class define an abstract interface for the host environment to provide a low ...">ExternalBreakEngine</a> class define an abstract interface for the host environment to provide a low level facility to break text for unicode text in script that the text boundary cannot be handled by upper level rule based logic, for example, for Chinese and Japanese word breaking, Thai, Khmer, Burmese, Lao and other Southeast Asian scripts. </p>
<p>The host environment implement one or more subclass of <a class="el" href="classicu_1_1ExternalBreakEngine.html" title="The ExternalBreakEngine class define an abstract interface for the host environment to provide a low ...">ExternalBreakEngine</a> and register them in the initialization time by calling <a class="el" href="classicu_1_1RuleBasedBreakIterator.html#a8d8651c91dea3032e7e0c8ccaab5c888" title="Register a new external break engine.">RuleBasedBreakIterator::registerExternalBreakEngine()</a>. ICU adopt and own the engine and will delete the registered external engine in proper time during the clean up event. </p><dl class="internal"><dt><b><a class="el" href="internal.html#_internal000102">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 74 technology preview </dd></dl>
<p class="definition">Definition at line <a class="el" href="rbbi_8h_source.html#l00060">60</a> of file <a class="el" href="rbbi_8h_source.html">rbbi.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="afbe2d84b15f76cff3368e7d0a594235c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbe2d84b15f76cff3368e7d0a594235c">◆ </a></span>~ExternalBreakEngine()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual icu::ExternalBreakEngine::~ExternalBreakEngine </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>destructor </p>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000103">Internal:</a></b></dt><dd>Do not use.</dd></dl>
<p>This API is for internal use only. ICU 74 technology preview </p>
<p class="definition">Definition at line <a class="el" href="rbbi_8h_source.html#l00066">66</a> of file <a class="el" href="rbbi_8h_source.html">rbbi.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4d578ef0687b395b32dc5aeafa2a38e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d578ef0687b395b32dc5aeafa2a38e2">◆ </a></span>fillBreaks()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int32_t icu::ExternalBreakEngine::fillBreaks </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structUText.html">UText</a> * </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>start</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t * </td>
<td class="paramname"><em>foundBreaks</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"><em>foundBreaksCapacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="utypes_8h.html#a3343c1c8a8377277046774691c98d78c">UErrorCode</a> & </td>
<td class="paramname"><em>status</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Divide up a range of text handled by this break engine.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>A <a class="el" href="structUText.html" title="UText struct.">UText</a> representing the text </td></tr>
<tr><td class="paramname">start</td><td>The start of the range of known characters </td></tr>
<tr><td class="paramname">end</td><td>The end of the range of known characters </td></tr>
<tr><td class="paramname">foundBreaks</td><td>Output of C array of int32_t break positions, or nullptr </td></tr>
<tr><td class="paramname">foundBreaksCapacity</td><td>The capacity of foundBreaks </td></tr>
<tr><td class="paramname">status</td><td>Information on any errors encountered. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of breaks found </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000106">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 74 technology preview </dd></dl>
</div>
</div>
<a id="a8a2a35e7cbf5c0b2d6cbd59cab0e07fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a2a35e7cbf5c0b2d6cbd59cab0e07fc">◆ </a></span>handles()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool icu::ExternalBreakEngine::handles </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td>
<td class="paramname"><em>c</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate whether this engine handles a particular character.This method is used by the <a class="el" href="classicu_1_1RuleBasedBreakIterator.html" title="A subclass of BreakIterator whose behavior is specified using a list of rules.">RuleBasedBreakIterator</a> after it already find a break engine to see which characters after the first one can be handled by this break engine.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>A character that the engine might handle. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this engine handles the particular character. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000105">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 74 technology preview </dd></dl>
</div>
</div>
<a id="a289dc5c2c1ab2d559b5708c00b96a63f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a289dc5c2c1ab2d559b5708c00b96a63f">◆ </a></span>isFor()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool icu::ExternalBreakEngine::isFor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="umachine_8h.html#a09fff5c3b5a5b015324dc3ec3cf92809">UChar32</a> </td>
<td class="paramname"><em>c</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>locale</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Indicate whether this engine handles a particular character when the <a class="el" href="classicu_1_1RuleBasedBreakIterator.html" title="A subclass of BreakIterator whose behavior is specified using a list of rules.">RuleBasedBreakIterator</a> is used for a particular locale. This method is used by the <a class="el" href="classicu_1_1RuleBasedBreakIterator.html" title="A subclass of BreakIterator whose behavior is specified using a list of rules.">RuleBasedBreakIterator</a> to find a break engine.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">c</td><td>A character which begins a run that the engine might handle. </td></tr>
<tr><td class="paramname">locale</td><td>The locale. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this engine handles the particular character for that locale. </dd></dl>
<dl class="internal"><dt><b><a class="el" href="internal.html#_internal000104">Internal:</a></b></dt><dd>Do not use. This API is for internal use only. ICU 74 technology preview </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>common/unicode/<a class="el" href="rbbi_8h_source.html">rbbi.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>