blob: 3cb99e62e9f6f1a166833386053ff33767fa0ca0 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/unicode-bidi-0.3.13/src/explicit.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>explicit.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../unicode_bidi/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../unicode_bidi/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2015 The Servo Project Developers. See the
// COPYRIGHT file at the top-level directory of this distribution.
//
// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license
// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
</span><span class="doccomment">//! 3.3.2 Explicit Levels and Directions
//!
//! &lt;http://www.unicode.org/reports/tr9/#Explicit_Levels_and_Directions&gt;
</span><span class="kw">use </span>alloc::vec::Vec;
<span class="kw">use </span><span class="kw">super</span>::char_data::{
is_rtl,
BidiClass::{<span class="self">self</span>, <span class="kw-2">*</span>},
};
<span class="kw">use </span><span class="kw">super</span>::level::Level;
<span class="doccomment">/// Compute explicit embedding levels for one paragraph of text (X1-X8).
///
/// `processing_classes[i]` must contain the `BidiClass` of the char at byte index `i`,
/// for each char in `text`.
</span><span class="attribute">#[cfg_attr(feature = <span class="string">&quot;flame_it&quot;</span>, flamer::flame)]
</span><span class="kw">pub fn </span>compute(
text: <span class="kw-2">&amp;</span>str,
para_level: Level,
original_classes: <span class="kw-2">&amp;</span>[BidiClass],
levels: <span class="kw-2">&amp;mut </span>[Level],
processing_classes: <span class="kw-2">&amp;mut </span>[BidiClass],
) {
<span class="macro">assert_eq!</span>(text.len(), original_classes.len());
<span class="comment">// &lt;http://www.unicode.org/reports/tr9/#X1&gt;
</span><span class="kw">let </span><span class="kw-2">mut </span>stack = DirectionalStatusStack::new();
stack.push(para_level, OverrideStatus::Neutral);
<span class="kw">let </span><span class="kw-2">mut </span>overflow_isolate_count = <span class="number">0u32</span>;
<span class="kw">let </span><span class="kw-2">mut </span>overflow_embedding_count = <span class="number">0u32</span>;
<span class="kw">let </span><span class="kw-2">mut </span>valid_isolate_count = <span class="number">0u32</span>;
<span class="kw">for </span>(i, c) <span class="kw">in </span>text.char_indices() {
<span class="kw">match </span>original_classes[i] {
<span class="comment">// Rules X2-X5c
</span>RLE | LRE | RLO | LRO | RLI | LRI | FSI =&gt; {
<span class="kw">let </span>last_level = stack.last().level;
<span class="comment">// &lt;https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters&gt;
</span>levels[i] = last_level;
<span class="comment">// X5a-X5c: Isolate initiators get the level of the last entry on the stack.
</span><span class="kw">let </span>is_isolate = <span class="kw">match </span>original_classes[i] {
RLI | LRI | FSI =&gt; <span class="bool-val">true</span>,
<span class="kw">_ </span>=&gt; <span class="bool-val">false</span>,
};
<span class="kw">if </span>is_isolate {
<span class="comment">// Redundant due to &quot;Retaining explicit formatting characters&quot; step.
// levels[i] = last_level;
</span><span class="kw">match </span>stack.last().status {
OverrideStatus::RTL =&gt; processing_classes[i] = R,
OverrideStatus::LTR =&gt; processing_classes[i] = L,
<span class="kw">_ </span>=&gt; {}
}
}
<span class="kw">let </span>new_level = <span class="kw">if </span>is_rtl(original_classes[i]) {
last_level.new_explicit_next_rtl()
} <span class="kw">else </span>{
last_level.new_explicit_next_ltr()
};
<span class="kw">if </span>new_level.is_ok() &amp;&amp; overflow_isolate_count == <span class="number">0 </span>&amp;&amp; overflow_embedding_count == <span class="number">0
</span>{
<span class="kw">let </span>new_level = new_level.unwrap();
stack.push(
new_level,
<span class="kw">match </span>original_classes[i] {
RLO =&gt; OverrideStatus::RTL,
LRO =&gt; OverrideStatus::LTR,
RLI | LRI | FSI =&gt; OverrideStatus::Isolate,
<span class="kw">_ </span>=&gt; OverrideStatus::Neutral,
},
);
<span class="kw">if </span>is_isolate {
valid_isolate_count += <span class="number">1</span>;
} <span class="kw">else </span>{
<span class="comment">// The spec doesn&#39;t explicitly mention this step, but it is necessary.
// See the reference implementations for comparison.
</span>levels[i] = new_level;
}
} <span class="kw">else if </span>is_isolate {
overflow_isolate_count += <span class="number">1</span>;
} <span class="kw">else if </span>overflow_isolate_count == <span class="number">0 </span>{
overflow_embedding_count += <span class="number">1</span>;
}
<span class="kw">if </span>!is_isolate {
<span class="comment">// X9 +
// &lt;https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters&gt;
// (PDF handled below)
</span>processing_classes[i] = BN;
}
}
<span class="comment">// &lt;http://www.unicode.org/reports/tr9/#X6a&gt;
</span>PDI =&gt; {
<span class="kw">if </span>overflow_isolate_count &gt; <span class="number">0 </span>{
overflow_isolate_count -= <span class="number">1</span>;
} <span class="kw">else if </span>valid_isolate_count &gt; <span class="number">0 </span>{
overflow_embedding_count = <span class="number">0</span>;
<span class="kw">loop </span>{
<span class="comment">// Pop everything up to and including the last Isolate status.
</span><span class="kw">match </span>stack.vec.pop() {
<span class="prelude-val">None
</span>| <span class="prelude-val">Some</span>(Status {
status: OverrideStatus::Isolate,
..
}) =&gt; <span class="kw">break</span>,
<span class="kw">_ </span>=&gt; <span class="kw">continue</span>,
}
}
valid_isolate_count -= <span class="number">1</span>;
}
<span class="kw">let </span>last = stack.last();
levels[i] = last.level;
<span class="kw">match </span>last.status {
OverrideStatus::RTL =&gt; processing_classes[i] = R,
OverrideStatus::LTR =&gt; processing_classes[i] = L,
<span class="kw">_ </span>=&gt; {}
}
}
<span class="comment">// &lt;http://www.unicode.org/reports/tr9/#X7&gt;
</span>PDF =&gt; {
<span class="kw">if </span>overflow_isolate_count &gt; <span class="number">0 </span>{
<span class="comment">// do nothing
</span>} <span class="kw">else if </span>overflow_embedding_count &gt; <span class="number">0 </span>{
overflow_embedding_count -= <span class="number">1</span>;
} <span class="kw">else if </span>stack.last().status != OverrideStatus::Isolate &amp;&amp; stack.vec.len() &gt;= <span class="number">2 </span>{
stack.vec.pop();
}
<span class="comment">// &lt;https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters&gt;
</span>levels[i] = stack.last().level;
<span class="comment">// X9 part of retaining explicit formatting characters.
</span>processing_classes[i] = BN;
}
<span class="comment">// Nothing.
// BN case moved down to X6, see &lt;https://www.unicode.org/reports/tr9/#Retaining_Explicit_Formatting_Characters&gt;
</span>B =&gt; {}
<span class="comment">// &lt;http://www.unicode.org/reports/tr9/#X6&gt;
</span><span class="kw">_ </span>=&gt; {
<span class="kw">let </span>last = stack.last();
levels[i] = last.level;
<span class="comment">// This condition is not in the spec, but I am pretty sure that is a spec bug.
// https://www.unicode.org/L2/L2023/23014-amd-to-uax9.pdf
</span><span class="kw">if </span>original_classes[i] != BN {
<span class="kw">match </span>last.status {
OverrideStatus::RTL =&gt; processing_classes[i] = R,
OverrideStatus::LTR =&gt; processing_classes[i] = L,
<span class="kw">_ </span>=&gt; {}
}
}
}
}
<span class="comment">// Handle multi-byte characters.
</span><span class="kw">for </span>j <span class="kw">in </span><span class="number">1</span>..c.len_utf8() {
levels[i + j] = levels[i];
processing_classes[i + j] = processing_classes[i];
}
}
}
<span class="doccomment">/// Entries in the directional status stack:
</span><span class="kw">struct </span>Status {
level: Level,
status: OverrideStatus,
}
<span class="attribute">#[derive(PartialEq)]
</span><span class="kw">enum </span>OverrideStatus {
Neutral,
RTL,
LTR,
Isolate,
}
<span class="kw">struct </span>DirectionalStatusStack {
vec: Vec&lt;Status&gt;,
}
<span class="kw">impl </span>DirectionalStatusStack {
<span class="kw">fn </span>new() -&gt; <span class="self">Self </span>{
DirectionalStatusStack {
vec: Vec::with_capacity(Level::max_explicit_depth() <span class="kw">as </span>usize + <span class="number">2</span>),
}
}
<span class="kw">fn </span>push(<span class="kw-2">&amp;mut </span><span class="self">self</span>, level: Level, status: OverrideStatus) {
<span class="self">self</span>.vec.push(Status { level, status });
}
<span class="kw">fn </span>last(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Status {
<span class="self">self</span>.vec.last().unwrap()
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="unicode_bidi" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>