blob: b631b0fd58395f3ee844d39b0d3fe4271fc72d1c [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-normalization-0.1.22/src/quick_check.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>quick_check.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="icon" href="https://unicode-rs.github.io/unicode-rs_sm.png"></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_normalization/index.html"><div class="logo-container">
<img src="https://unicode-rs.github.io/unicode-rs_sm.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../unicode_normalization/index.html">
<img src="https://unicode-rs.github.io/unicode-rs_sm.png" 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>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::lookups::canonical_combining_class;
<span class="kw">use </span><span class="kw">crate</span>::stream_safe;
<span class="kw">use </span><span class="kw">crate</span>::tables;
<span class="kw">use </span><span class="kw">crate</span>::UnicodeNormalization;
<span class="doccomment">/// The QuickCheck algorithm can quickly determine if a text is or isn&#39;t
/// normalized without any allocations in many cases, but it has to be able to
/// return `Maybe` when a full decomposition and recomposition is necessary.
</span><span class="attribute">#[derive(Debug, Eq, PartialEq)]
</span><span class="kw">pub enum </span>IsNormalized {
<span class="doccomment">/// The text is definitely normalized.
</span>Yes,
<span class="doccomment">/// The text is definitely not normalized.
</span>No,
<span class="doccomment">/// The text may be normalized.
</span>Maybe,
}
<span class="comment">// https://unicode.org/reports/tr15/#Detecting_Normalization_Forms
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>quick_check&lt;F, I&gt;(s: I, is_allowed: F, stream_safe: bool) -&gt; IsNormalized
<span class="kw">where
</span>I: Iterator&lt;Item = char&gt;,
F: Fn(char) -&gt; IsNormalized,
{
<span class="kw">let </span><span class="kw-2">mut </span>last_cc = <span class="number">0u8</span>;
<span class="kw">let </span><span class="kw-2">mut </span>nonstarter_count = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>result = IsNormalized::Yes;
<span class="kw">for </span>ch <span class="kw">in </span>s {
<span class="comment">// For ASCII we know it&#39;s always allowed and a starter
</span><span class="kw">if </span>ch &lt;= <span class="string">&#39;\x7f&#39; </span>{
last_cc = <span class="number">0</span>;
nonstarter_count = <span class="number">0</span>;
<span class="kw">continue</span>;
}
<span class="comment">// Otherwise, lookup the combining class and QC property
</span><span class="kw">let </span>cc = canonical_combining_class(ch);
<span class="kw">if </span>last_cc &gt; cc &amp;&amp; cc != <span class="number">0 </span>{
<span class="kw">return </span>IsNormalized::No;
}
<span class="kw">match </span>is_allowed(ch) {
IsNormalized::Yes =&gt; (),
IsNormalized::No =&gt; <span class="kw">return </span>IsNormalized::No,
IsNormalized::Maybe =&gt; {
result = IsNormalized::Maybe;
}
}
<span class="kw">if </span>stream_safe {
<span class="kw">let </span>decomp = stream_safe::classify_nonstarters(ch);
<span class="comment">// If we&#39;re above `MAX_NONSTARTERS`, we&#39;re definitely *not*
// stream-safe normalized.
</span><span class="kw">if </span>nonstarter_count + decomp.leading_nonstarters &gt; stream_safe::MAX_NONSTARTERS {
<span class="kw">return </span>IsNormalized::No;
}
<span class="kw">if </span>decomp.leading_nonstarters == decomp.decomposition_len {
nonstarter_count += decomp.decomposition_len;
} <span class="kw">else </span>{
nonstarter_count = decomp.trailing_nonstarters;
}
}
last_cc = cc;
}
result
}
<span class="doccomment">/// Quickly check if a string is in NFC, potentially returning
/// `IsNormalized::Maybe` if further checks are necessary. In this case a check
/// like `s.chars().nfc().eq(s.chars())` should suffice.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfc_quick&lt;I: Iterator&lt;Item = char&gt;&gt;(s: I) -&gt; IsNormalized {
quick_check(s, tables::qc_nfc, <span class="bool-val">false</span>)
}
<span class="doccomment">/// Quickly check if a string is in NFKC.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfkc_quick&lt;I: Iterator&lt;Item = char&gt;&gt;(s: I) -&gt; IsNormalized {
quick_check(s, tables::qc_nfkc, <span class="bool-val">false</span>)
}
<span class="doccomment">/// Quickly check if a string is in NFD.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfd_quick&lt;I: Iterator&lt;Item = char&gt;&gt;(s: I) -&gt; IsNormalized {
quick_check(s, tables::qc_nfd, <span class="bool-val">false</span>)
}
<span class="doccomment">/// Quickly check if a string is in NFKD.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfkd_quick&lt;I: Iterator&lt;Item = char&gt;&gt;(s: I) -&gt; IsNormalized {
quick_check(s, tables::qc_nfkd, <span class="bool-val">false</span>)
}
<span class="doccomment">/// Quickly check if a string is Stream-Safe NFC.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfc_stream_safe_quick&lt;I: Iterator&lt;Item = char&gt;&gt;(s: I) -&gt; IsNormalized {
quick_check(s, tables::qc_nfc, <span class="bool-val">true</span>)
}
<span class="doccomment">/// Quickly check if a string is Stream-Safe NFD.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfd_stream_safe_quick&lt;I: Iterator&lt;Item = char&gt;&gt;(s: I) -&gt; IsNormalized {
quick_check(s, tables::qc_nfd, <span class="bool-val">true</span>)
}
<span class="doccomment">/// Authoritatively check if a string is in NFC.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfc(s: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="kw">match </span>is_nfc_quick(s.chars()) {
IsNormalized::Yes =&gt; <span class="bool-val">true</span>,
IsNormalized::No =&gt; <span class="bool-val">false</span>,
IsNormalized::Maybe =&gt; s.chars().eq(s.chars().nfc()),
}
}
<span class="doccomment">/// Authoritatively check if a string is in NFKC.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfkc(s: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="kw">match </span>is_nfkc_quick(s.chars()) {
IsNormalized::Yes =&gt; <span class="bool-val">true</span>,
IsNormalized::No =&gt; <span class="bool-val">false</span>,
IsNormalized::Maybe =&gt; s.chars().eq(s.chars().nfkc()),
}
}
<span class="doccomment">/// Authoritatively check if a string is in NFD.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfd(s: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="kw">match </span>is_nfd_quick(s.chars()) {
IsNormalized::Yes =&gt; <span class="bool-val">true</span>,
IsNormalized::No =&gt; <span class="bool-val">false</span>,
IsNormalized::Maybe =&gt; s.chars().eq(s.chars().nfd()),
}
}
<span class="doccomment">/// Authoritatively check if a string is in NFKD.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfkd(s: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="kw">match </span>is_nfkd_quick(s.chars()) {
IsNormalized::Yes =&gt; <span class="bool-val">true</span>,
IsNormalized::No =&gt; <span class="bool-val">false</span>,
IsNormalized::Maybe =&gt; s.chars().eq(s.chars().nfkd()),
}
}
<span class="doccomment">/// Authoritatively check if a string is Stream-Safe NFC.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfc_stream_safe(s: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="kw">match </span>is_nfc_stream_safe_quick(s.chars()) {
IsNormalized::Yes =&gt; <span class="bool-val">true</span>,
IsNormalized::No =&gt; <span class="bool-val">false</span>,
IsNormalized::Maybe =&gt; s.chars().eq(s.chars().stream_safe().nfc()),
}
}
<span class="doccomment">/// Authoritatively check if a string is Stream-Safe NFD.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>is_nfd_stream_safe(s: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="kw">match </span>is_nfd_stream_safe_quick(s.chars()) {
IsNormalized::Yes =&gt; <span class="bool-val">true</span>,
IsNormalized::No =&gt; <span class="bool-val">false</span>,
IsNormalized::Maybe =&gt; s.chars().eq(s.chars().stream_safe().nfd()),
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::{is_nfc_stream_safe_quick, is_nfd_stream_safe_quick, IsNormalized};
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_stream_safe_nfd() {
<span class="kw">let </span>okay = <span class="string">&quot;Da\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}ngerzone&quot;</span>;
<span class="macro">assert_eq!</span>(is_nfd_stream_safe_quick(okay.chars()), IsNormalized::Yes);
<span class="kw">let </span>too_much = <span class="string">&quot;Da\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{031e}\u{0300}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}ngerzone&quot;</span>;
<span class="macro">assert_eq!</span>(is_nfd_stream_safe_quick(too_much.chars()), IsNormalized::No);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_stream_safe_nfc() {
<span class="kw">let </span>okay = <span class="string">&quot;ok\u{e0}\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}y&quot;</span>;
<span class="macro">assert_eq!</span>(is_nfc_stream_safe_quick(okay.chars()), IsNormalized::Maybe);
<span class="kw">let </span>too_much = <span class="string">&quot;not ok\u{e0}\u{031b}\u{0316}\u{0317}\u{0318}\u{0319}\u{031c}\u{031d}\u{031e}\u{0301}\u{0302}\u{0303}\u{0304}\u{0305}\u{0306}\u{0307}\u{0308}\u{0309}\u{030a}\u{030b}\u{030c}\u{030d}\u{030e}\u{030f}\u{0310}\u{0311}\u{0312}\u{0313}\u{0314}\u{0315}\u{031a}y&quot;</span>;
<span class="macro">assert_eq!</span>(is_nfc_stream_safe_quick(too_much.chars()), IsNormalized::No);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="unicode_normalization" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>