libmedium/src/libmedium/render_html.rs.html

338 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `src/render_html.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>render_html.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-1f7d512b176f0f72.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-124a1ca42af929b6.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-6827029ac823cab7.css" id="mainThemeStyle"><link rel="stylesheet" id="themeStyle" href="../../static.files/light-ebce58d0a40c3431.css"><link rel="stylesheet" disabled href="../../static.files/dark-f23faae4a2daf9a6.css"><link rel="stylesheet" disabled href="../../static.files/ayu-8af5e100b21cd173.css"><script id="default-settings" ></script><script src="../../static.files/storage-d43fa987303ecbbb.js"></script><script defer src="../../static.files/source-script-5cf2e01a42cc9858.js"></script><script defer src="../../source-files.js"></script><script defer src="../../static.files/main-c55e1eb52e1886b4.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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"></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../libmedium/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" 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="../../static.files/wheel-5ec35bf9ca753509.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
</pre><pre class="rust"><code><span class="comment">/*
* Copyright (C) 2022 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
*/
</span><span class="kw">use </span>std::path::Path;
<span class="kw">use </span>syntect::highlighting::{Color, ThemeSet};
<span class="kw">use </span>syntect::html::highlighted_html_for_string;
<span class="kw">use </span>syntect::parsing::{SyntaxReference, SyntaxSet};
<span class="kw">pub trait </span>GenerateHTML {
<span class="kw">fn </span>generate(<span class="kw-2">&amp;mut </span><span class="self">self</span>);
}
<span class="attr">#[allow(dead_code)]
</span><span class="kw">pub const </span>STYLE: <span class="kw-2">&amp;</span>str = <span class="string">&quot;
&quot;</span>;
<span class="macro">thread_local! </span>{
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>SYNTAX_SET: SyntaxSet = SyntaxSet::load_defaults_newlines();
}
<span class="kw">pub struct </span>SourcegraphQuery&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub </span>filepath: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="kw">pub </span>code: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; SourcegraphQuery&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub fn </span>syntax_highlight(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; String {
<span class="comment">// let ss = SYNTAX_SET;
</span><span class="kw">let </span>ts = ThemeSet::load_defaults();
<span class="kw">let </span>theme = <span class="kw-2">&amp;</span>ts.themes[<span class="string">&quot;InspiredGitHub&quot;</span>];
<span class="kw">let </span>c = theme.settings.background.unwrap_or(Color::WHITE);
<span class="kw">let </span><span class="kw-2">mut </span>num = <span class="number">1</span>;
<span class="kw">let </span><span class="kw-2">mut </span>output = <span class="macro">format!</span>(
<span class="string">&quot;&lt;style&gt;
.gist_file {{
background-color:#{:02x}{:02x}{:02x};
}}&lt;/style&gt;&quot;</span>,
c.r, c.g, c.b
);
<span class="comment">// highlighted_html_for_string(&amp;q.code, syntax_set, syntax_def, theme),
</span><span class="kw">let </span>html = SYNTAX_SET.with(|ss| {
<span class="kw">let </span>language = <span class="self">self</span>.determine_language(ss);
highlighted_html_for_string(<span class="self">self</span>.code, ss, language, theme)
});
<span class="kw">let </span>total_lines = html.lines().count();
<span class="kw">for </span>(line_num, line) <span class="kw">in </span>html.lines().enumerate() {
<span class="kw">if </span>!line.trim().is_empty() {
<span class="kw">if </span>line_num == <span class="number">0 </span>|| line_num == total_lines - <span class="number">1 </span>{
output.push_str(line);
} <span class="kw">else </span>{
output.push_str(<span class="kw-2">&amp;</span><span class="macro">format!</span>(<span class="string">&quot;&lt;div title=&#39;click for more options&#39; id=\&quot;line-{num}\&quot;class=\&quot;line\&quot;&gt;&lt;details class=&#39;line_links&#39;&gt;&lt;summary class=&#39;line_top-link&#39;&gt;&lt;a href=\&quot;#line-{num}\&quot;&lt;span class=\&quot;line-number\&quot;&gt;{num}&lt;/span&gt;&lt;/a&gt;{line}&lt;/summary&gt;&lt;a href=\&quot;#line-{num}\&quot;&lt;span class=\&quot;line-link\&quot;&gt;Permanant link&lt;/span&gt;&lt;/a&gt;&lt;a href=\&quot;#line-{num}\&quot;&lt;span class=\&quot;line-link\&quot;&gt;Highlight&lt;/span&gt;&lt;/a&gt;&lt;/details&gt;&lt;/div&gt;&quot;
</span>));
num += <span class="number">1</span>;
}
}
}
output
}
<span class="comment">// adopted from
// https://github.com/sourcegraph/sourcegraph/blob/9fe138ae75fd64dce06b621572b252a9c9c8da70/docker-images/syntax-highlighter/crates/sg-syntax/src/lib.rs#L81
// with minimum modifications. Crate was MIT licensed at the time(2022-03-12 11:11)
</span><span class="kw">fn </span>determine_language&lt;<span class="lifetime">&#39;b</span>&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, syntax_set: <span class="kw-2">&amp;</span><span class="lifetime">&#39;b </span>SyntaxSet) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;b </span>SyntaxReference {
<span class="kw">if </span><span class="self">self</span>.filepath.is_empty() {
<span class="comment">// Legacy codepath, kept for backwards-compatability with old clients.
</span><span class="kw">match </span>syntax_set.find_syntax_by_first_line(<span class="self">self</span>.code) {
<span class="prelude-val">Some</span>(v) =&gt; {
<span class="kw">return </span>v;
}
<span class="prelude-val">None </span>=&gt; <span class="macro">unimplemented!</span>(), <span class="comment">//Err(json!({&quot;error&quot;: &quot;invalid extension&quot;})),
</span>};
}
<span class="comment">// Split the input path (&quot;foo/myfile.go&quot;) into file name
// (&quot;myfile.go&quot;) and extension (&quot;go&quot;).
</span><span class="kw">let </span>path = Path::new(<span class="kw-2">&amp;</span><span class="self">self</span>.filepath);
<span class="kw">let </span>file_name = path.file_name().and_then(|n| n.to_str()).unwrap_or(<span class="string">&quot;&quot;</span>);
<span class="kw">let </span>extension = path.extension().and_then(|x| x.to_str()).unwrap_or(<span class="string">&quot;&quot;</span>);
<span class="comment">// Override syntect&#39;s language detection for conflicting file extensions because
// it&#39;s impossible to express this logic in a syntax definition.
</span><span class="kw">struct </span>Override {
extension: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str,
prefix_langs: Vec&lt;(<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str, <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str)&gt;,
default: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str,
}
<span class="kw">let </span>overrides = <span class="macro">vec!</span>[Override {
extension: <span class="string">&quot;cls&quot;</span>,
prefix_langs: <span class="macro">vec!</span>[(<span class="string">&quot;%&quot;</span>, <span class="string">&quot;TeX&quot;</span>), (<span class="string">&quot;\\&quot;</span>, <span class="string">&quot;TeX&quot;</span>)],
default: <span class="string">&quot;Apex&quot;</span>,
}];
<span class="kw">if let </span><span class="prelude-val">Some</span>(Override {
prefix_langs,
default,
..
}) = overrides.iter().find(|o| o.extension == extension)
{
<span class="kw">let </span>name = <span class="kw">match </span>prefix_langs
.iter()
.find(|(prefix, <span class="kw">_</span>)| <span class="self">self</span>.code.starts_with(prefix))
{
<span class="prelude-val">Some</span>((<span class="kw">_</span>, lang)) =&gt; lang,
<span class="prelude-val">None </span>=&gt; default,
};
<span class="kw">return </span>syntax_set
.find_syntax_by_name(name)
.unwrap_or_else(|| syntax_set.find_syntax_plain_text());
}
syntax_set
<span class="comment">// First try to find a syntax whose &quot;extension&quot; matches our file
// name. This is done due to some syntaxes matching an &quot;extension&quot;
// that is actually a whole file name (e.g. &quot;Dockerfile&quot; or &quot;CMakeLists.txt&quot;)
// see https://github.com/trishume/syntect/pull/170
</span>.find_syntax_by_extension(file_name)
.or_else(|| syntax_set.find_syntax_by_extension(extension))
.or_else(|| syntax_set.find_syntax_by_first_line(<span class="self">self</span>.code))
.unwrap_or_else(|| syntax_set.find_syntax_plain_text())
}
}
<span class="attr">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use </span><span class="kw">super</span>::SourcegraphQuery;
<span class="kw">use </span>syntect::parsing::SyntaxSet;
<span class="attr">#[test]
</span><span class="kw">fn </span>cls_tex() {
<span class="kw">let </span>syntax_set = SyntaxSet::load_defaults_newlines();
<span class="kw">let </span>query = SourcegraphQuery {
filepath: <span class="string">&quot;foo.cls&quot;</span>,
code: <span class="string">&quot;%&quot;</span>,
};
<span class="kw">let </span>result = query.determine_language(<span class="kw-2">&amp;</span>syntax_set);
<span class="macro">assert_eq!</span>(result.name, <span class="string">&quot;TeX&quot;</span>);
<span class="kw">let </span>_result = query.syntax_highlight();
}
<span class="comment">//#[test]
//fn cls_apex() {
// let syntax_set = SyntaxSet::load_defaults_newlines();
// let query = SourcegraphQuery {
// filepath: &quot;foo.cls&quot;.to_string(),
// code: &quot;/**&quot;.to_string(),
// extension: String::new(),
// };
// let result = determine_language(&amp;query, &amp;syntax_set);
// assert_eq!(result.unwrap().name, &quot;Apex&quot;);
//}
</span>}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="libmedium" data-themes="" data-resource-suffix="" data-rustdoc-version="1.67.1 (d5a82bbd2 2023-02-07)" data-search-js="search-444266647c4dba98.js" data-settings-js="settings-bebeae96e00e4617.js" data-settings-css="settings-af96d9e2fc13e081.css" ></div></body></html>