Rust/ssw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Now a REAL lib

Browse Source
This commit is contained in:
Justine
2023-01-09 19:23:20 +01:00
parent ef46613c71
commit fe9e6f04f5
19014 changed files with 715877 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

746
doc/src/is_terminal/lib.rs.html Normal file
View File

@ -0,0 +1,746 @@
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/is-terminal-0.4.2/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../is_terminal/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../is_terminal/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../is_terminal/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><pre class="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>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
</pre><pre class="rust"><code><span class="doccomment">//! is-terminal is a simple utility that answers one question:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! &gt; Is this a terminal?</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! A &quot;terminal&quot;, also known as a &quot;tty&quot;, is an I/O device which may be</span>
<span class="doccomment">//! interactive and may support color and other special features. This crate</span>
<span class="doccomment">//! doesn&#39;t provide any of those features; it just answers this one question.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! On Unix-family platforms, this is effectively the same as the [`isatty`]</span>
<span class="doccomment">//! function for testing whether a given stream is a terminal, though it</span>
<span class="doccomment">//! accepts high-level stream types instead of raw file descriptors.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! On Windows, it uses a variety of techniques to determine whether the</span>
<span class="doccomment">//! given stream is a terminal.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Example</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```rust</span>
<span class="doccomment">//! use is_terminal::IsTerminal;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! if std::io::stdout().is_terminal() {</span>
<span class="doccomment">//! println!(&quot;stdout is a terminal&quot;)</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [`isatty`]: https://man7.org/linux/man-pages/man3/isatty.3.html</span>
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">unix</span>, <span class="ident">no_std</span>)]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>))]</span>
<span class="kw">use</span> <span class="ident">io_lifetimes::AsFilelike</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">use</span> <span class="ident">io_lifetimes::BorrowedHandle</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">use</span> <span class="ident">windows_sys::Win32::Foundation::HANDLE</span>;
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">use</span> <span class="ident">windows_sys::Win32::System::Console::STD_HANDLE</span>;
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">IsTerminal</span> {
<span class="doccomment">/// Returns true if this is a terminal.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Example</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```</span>
<span class="doccomment">/// use is_terminal::IsTerminal;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// if std::io::stdout().is_terminal() {</span>
<span class="doccomment">/// println!(&quot;stdout is a terminal&quot;)</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// ```</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span>;
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>))]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="ident">Stream</span>: <span class="ident">AsFilelike</span><span class="op">&gt;</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">Stream</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;wasi&quot;</span>))]</span>
{
<span class="ident">rustix::termios::isatty</span>(<span class="self">self</span>)
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;hermit&quot;</span>)]</span>
{
<span class="ident">hermit_abi::isatty</span>(<span class="self">self</span>.<span class="ident">as_filelike</span>().<span class="ident">as_fd</span>())
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
{
<span class="ident">_is_terminal</span>(<span class="self">self</span>.<span class="ident">as_filelike</span>())
}
}
}
<span class="comment">// The Windows implementation here is copied from atty, with #51 and #54</span>
<span class="comment">// applied. The only significant modification is to take a `BorrowedHandle`</span>
<span class="comment">// argument instead of using a `Stream` enum.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">fn</span> <span class="ident">_is_terminal</span>(<span class="ident">stream</span>: <span class="ident">BorrowedHandle</span><span class="op">&lt;</span><span class="lifetime">&#39;_</span><span class="op">&gt;</span>) -&gt; <span class="ident">bool</span> {
<span class="kw">use</span> <span class="ident">std::os::windows::io::AsRawHandle</span>;
<span class="kw">use</span> <span class="ident">windows_sys::Win32::System::Console::GetStdHandle</span>;
<span class="kw">use</span> <span class="ident">windows_sys::Win32::System::Console</span>::{
<span class="ident">STD_ERROR_HANDLE</span> <span class="kw">as</span> <span class="ident">STD_ERROR</span>, <span class="ident">STD_INPUT_HANDLE</span> <span class="kw">as</span> <span class="ident">STD_INPUT</span>,
<span class="ident">STD_OUTPUT_HANDLE</span> <span class="kw">as</span> <span class="ident">STD_OUTPUT</span>,
};
<span class="kw">let</span> (<span class="ident">fd</span>, <span class="ident">others</span>) <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="kw">if</span> <span class="ident">stream</span>.<span class="ident">as_raw_handle</span>() <span class="op">==</span> <span class="ident">GetStdHandle</span>(<span class="ident">STD_INPUT</span>) <span class="kw">as</span> <span class="kw">_</span> {
(<span class="ident">STD_INPUT</span>, [<span class="ident">STD_ERROR</span>, <span class="ident">STD_OUTPUT</span>])
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">stream</span>.<span class="ident">as_raw_handle</span>() <span class="op">==</span> <span class="ident">GetStdHandle</span>(<span class="ident">STD_OUTPUT</span>) <span class="kw">as</span> <span class="kw">_</span> {
(<span class="ident">STD_OUTPUT</span>, [<span class="ident">STD_INPUT</span>, <span class="ident">STD_ERROR</span>])
} <span class="kw">else</span> <span class="kw">if</span> <span class="ident">stream</span>.<span class="ident">as_raw_handle</span>() <span class="op">==</span> <span class="ident">GetStdHandle</span>(<span class="ident">STD_ERROR</span>) <span class="kw">as</span> <span class="kw">_</span> {
(<span class="ident">STD_ERROR</span>, [<span class="ident">STD_INPUT</span>, <span class="ident">STD_OUTPUT</span>])
} <span class="kw">else</span> {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
};
<span class="kw">if</span> <span class="kw">unsafe</span> { <span class="ident">console_on_any</span>(<span class="kw-2">&amp;</span>[<span class="ident">fd</span>]) } {
<span class="comment">// False positives aren&#39;t possible. If we got a console then</span>
<span class="comment">// we definitely have a tty on stdin.</span>
<span class="kw">return</span> <span class="bool-val">true</span>;
}
<span class="comment">// At this point, we *could* have a false negative. We can determine that</span>
<span class="comment">// this is true negative if we can detect the presence of a console on</span>
<span class="comment">// any of the other streams. If another stream has a console, then we know</span>
<span class="comment">// we&#39;re in a Windows console and can therefore trust the negative.</span>
<span class="kw">if</span> <span class="kw">unsafe</span> { <span class="ident">console_on_any</span>(<span class="kw-2">&amp;</span><span class="ident">others</span>) } {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="comment">// Otherwise, we fall back to a very strange msys hack to see if we can</span>
<span class="comment">// sneakily detect the presence of a tty.</span>
<span class="comment">// Safety: function has no invariants. an invalid handle id will cause</span>
<span class="comment">// GetFileInformationByHandleEx to return an error.</span>
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">GetStdHandle</span>(<span class="ident">fd</span>) };
<span class="kw">unsafe</span> { <span class="ident">msys_tty_on</span>(<span class="ident">handle</span>) }
}
<span class="doccomment">/// Returns true if any of the given fds are on a console.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">console_on_any</span>(<span class="ident">fds</span>: <span class="kw-2">&amp;</span>[<span class="ident">STD_HANDLE</span>]) -&gt; <span class="ident">bool</span> {
<span class="kw">use</span> <span class="ident">windows_sys::Win32::System::Console</span>::{<span class="ident">GetConsoleMode</span>, <span class="ident">GetStdHandle</span>};
<span class="kw">for</span> <span class="kw-2">&amp;</span><span class="ident">fd</span> <span class="kw">in</span> <span class="ident">fds</span> {
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">out</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">let</span> <span class="ident">handle</span> <span class="op">=</span> <span class="ident">GetStdHandle</span>(<span class="ident">fd</span>);
<span class="kw">if</span> <span class="ident">GetConsoleMode</span>(<span class="ident">handle</span>, <span class="kw-2">&amp;mut</span> <span class="ident">out</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0</span> {
<span class="kw">return</span> <span class="bool-val">true</span>;
}
}
<span class="bool-val">false</span>
}
<span class="doccomment">/// Returns true if there is an MSYS tty on the given handle.</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">msys_tty_on</span>(<span class="ident">handle</span>: <span class="ident">HANDLE</span>) -&gt; <span class="ident">bool</span> {
<span class="kw">use</span> <span class="ident">std::ffi::c_void</span>;
<span class="kw">use</span> <span class="ident">windows_sys::Win32</span>::{
<span class="ident">Foundation::MAX_PATH</span>,
<span class="ident">Storage::FileSystem</span>::{<span class="ident">FileNameInfo</span>, <span class="ident">GetFileInformationByHandleEx</span>},
};
<span class="doccomment">/// Mirrors windows_sys::Win32::Storage::FileSystem::FILE_NAME_INFO, giving</span>
<span class="doccomment">/// it a fixed length that we can stack allocate</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">C</span>)]</span>
<span class="attribute">#[<span class="ident">allow</span>(<span class="ident">non_snake_case</span>)]</span>
<span class="kw">struct</span> <span class="ident">FILE_NAME_INFO</span> {
<span class="ident">FileNameLength</span>: <span class="ident">u32</span>,
<span class="ident">FileName</span>: [<span class="ident">u16</span>; <span class="ident">MAX_PATH</span> <span class="kw">as</span> <span class="ident">usize</span>],
}
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">name_info</span> <span class="op">=</span> <span class="ident">FILE_NAME_INFO</span> {
<span class="ident">FileNameLength</span>: <span class="number">0</span>,
<span class="ident">FileName</span>: [<span class="number">0</span>; <span class="ident">MAX_PATH</span> <span class="kw">as</span> <span class="ident">usize</span>],
};
<span class="comment">// Safety: buffer length is fixed.</span>
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">GetFileInformationByHandleEx</span>(
<span class="ident">handle</span>,
<span class="ident">FileNameInfo</span>,
<span class="kw-2">&amp;mut</span> <span class="ident">name_info</span> <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="kw">_</span> <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">c_void</span>,
<span class="ident">std::mem::size_of</span>::<span class="op">&lt;</span><span class="ident">FILE_NAME_INFO</span><span class="op">&gt;</span>() <span class="kw">as</span> <span class="ident">u32</span>,
);
<span class="kw">if</span> <span class="ident">res</span> <span class="op">==</span> <span class="number">0</span> {
<span class="kw">return</span> <span class="bool-val">false</span>;
}
<span class="kw">let</span> <span class="ident">s</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="ident">name_info</span>.<span class="ident">FileName</span>[..<span class="ident">name_info</span>.<span class="ident">FileNameLength</span> <span class="kw">as</span> <span class="ident">usize</span> <span class="op">/</span> <span class="number">2</span>];
<span class="kw">let</span> <span class="ident">name</span> <span class="op">=</span> <span class="ident">String::from_utf16_lossy</span>(<span class="ident">s</span>);
<span class="comment">// This checks whether &#39;pty&#39; exists in the file name, which indicates that</span>
<span class="comment">// a pseudo-terminal is attached. To mitigate against false positives</span>
<span class="comment">// (e.g., an actual file name that contains &#39;pty&#39;), we also require that</span>
<span class="comment">// either the strings &#39;msys-&#39; or &#39;cygwin-&#39; are in the file name as well.)</span>
<span class="kw">let</span> <span class="ident">is_msys</span> <span class="op">=</span> <span class="ident">name</span>.<span class="ident">contains</span>(<span class="string">&quot;msys-&quot;</span>) <span class="op">|</span><span class="op">|</span> <span class="ident">name</span>.<span class="ident">contains</span>(<span class="string">&quot;cygwin-&quot;</span>);
<span class="kw">let</span> <span class="ident">is_pty</span> <span class="op">=</span> <span class="ident">name</span>.<span class="ident">contains</span>(<span class="string">&quot;-pty&quot;</span>);
<span class="ident">is_msys</span> <span class="op">&amp;&amp;</span> <span class="ident">is_pty</span>
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::io::Stdin</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::io::Stdout</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::io::Stderr</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::io::StdinLock</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::io::StdoutLock</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::io::StderrLock</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::fs::File</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::process::ChildStdin</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::process::ChildStdout</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>)]</span>
<span class="kw">impl</span> <span class="ident">IsTerminal</span> <span class="kw">for</span> <span class="ident">std::process::ChildStderr</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_terminal</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;unknown&quot;</span>))]</span>
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::IsTerminal</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">fn</span> <span class="ident">stdin</span>() {
<span class="macro">assert_eq!</span>(
<span class="ident">atty::is</span>(<span class="ident">atty::Stream::Stdin</span>),
<span class="ident">std::io::stdin</span>().<span class="ident">is_terminal</span>()
)
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">fn</span> <span class="ident">stdout</span>() {
<span class="macro">assert_eq!</span>(
<span class="ident">atty::is</span>(<span class="ident">atty::Stream::Stdout</span>),
<span class="ident">std::io::stdout</span>().<span class="ident">is_terminal</span>()
)
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">fn</span> <span class="ident">stderr</span>() {
<span class="macro">assert_eq!</span>(
<span class="ident">atty::is</span>(<span class="ident">atty::Stream::Stderr</span>),
<span class="ident">std::io::stderr</span>().<span class="ident">is_terminal</span>()
)
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;wasi&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">stdin</span>() {
<span class="kw">unsafe</span> {
<span class="macro">assert_eq!</span>(
<span class="ident">atty::is</span>(<span class="ident">atty::Stream::Stdin</span>),
<span class="ident">rustix::io::stdin</span>().<span class="ident">is_terminal</span>()
)
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;wasi&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">stdout</span>() {
<span class="kw">unsafe</span> {
<span class="macro">assert_eq!</span>(
<span class="ident">atty::is</span>(<span class="ident">atty::Stream::Stdout</span>),
<span class="ident">rustix::io::stdout</span>().<span class="ident">is_terminal</span>()
)
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;wasi&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">stderr</span>() {
<span class="kw">unsafe</span> {
<span class="macro">assert_eq!</span>(
<span class="ident">atty::is</span>(<span class="ident">atty::Stream::Stderr</span>),
<span class="ident">rustix::io::stderr</span>().<span class="ident">is_terminal</span>()
)
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;wasi&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">stdin_vs_libc</span>() {
<span class="kw">unsafe</span> {
<span class="macro">assert_eq!</span>(
<span class="ident">libc::isatty</span>(<span class="ident">libc::STDIN_FILENO</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0</span>,
<span class="ident">rustix::io::stdin</span>().<span class="ident">is_terminal</span>()
)
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;wasi&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">stdout_vs_libc</span>() {
<span class="kw">unsafe</span> {
<span class="macro">assert_eq!</span>(
<span class="ident">libc::isatty</span>(<span class="ident">libc::STDOUT_FILENO</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0</span>,
<span class="ident">rustix::io::stdout</span>().<span class="ident">is_terminal</span>()
)
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">unix</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">&quot;wasi&quot;</span>))]</span>
<span class="kw">fn</span> <span class="ident">stderr_vs_libc</span>() {
<span class="kw">unsafe</span> {
<span class="macro">assert_eq!</span>(
<span class="ident">libc::isatty</span>(<span class="ident">libc::STDERR_FILENO</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0</span>,
<span class="ident">rustix::io::stderr</span>().<span class="ident">is_terminal</span>()
)
}
}
<span class="comment">// Verify that the msys_tty_on function works with long path.</span>
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span>
<span class="kw">fn</span> <span class="ident">msys_tty_on_path_length</span>() {
<span class="kw">use</span> <span class="ident">std</span>::{<span class="ident">fs::File</span>, <span class="ident">os::windows::io::AsRawHandle</span>};
<span class="kw">use</span> <span class="ident">windows_sys::Win32::Foundation::MAX_PATH</span>;
<span class="kw">let</span> <span class="ident">dir</span> <span class="op">=</span> <span class="ident">tempfile::tempdir</span>().<span class="ident">expect</span>(<span class="string">&quot;Unable to create temporary directory&quot;</span>);
<span class="kw">let</span> <span class="ident">file_path</span> <span class="op">=</span> <span class="ident">dir</span>.<span class="ident">path</span>().<span class="ident">join</span>(<span class="string">&quot;ten_chars_&quot;</span>.<span class="ident">repeat</span>(<span class="number">25</span>));
<span class="comment">// Ensure that the path is longer than MAX_PATH.</span>
<span class="macro">assert!</span>(<span class="ident">file_path</span>.<span class="ident">to_string_lossy</span>().<span class="ident">len</span>() <span class="op">&gt;</span> <span class="ident">MAX_PATH</span> <span class="kw">as</span> <span class="ident">usize</span>);
<span class="kw">let</span> <span class="ident">file</span> <span class="op">=</span> <span class="ident">File::create</span>(<span class="ident">file_path</span>).<span class="ident">expect</span>(<span class="string">&quot;Unable to create file&quot;</span>);
<span class="macro">assert!</span>(<span class="op">!</span><span class="kw">unsafe</span> { <span class="ident"><span class="kw">crate</span>::msys_tty_on</span>(<span class="ident">file</span>.<span class="ident">as_raw_handle</span>() <span class="kw">as</span> <span class="ident">isize</span>) });
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="is_terminal" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>