| <!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/ansi_term-0.12.1/src/windows.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>windows.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="../../ansi_term/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="../../ansi_term/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> |
| </pre><pre class="rust"><code><span class="doccomment">/// Enables ANSI code support on Windows 10. |
| /// |
| /// This uses Windows API calls to alter the properties of the console that |
| /// the program is running in. |
| /// |
| /// https://msdn.microsoft.com/en-us/library/windows/desktop/mt638032(v=vs.85).aspx |
| /// |
| /// Returns a `Result` with the Windows error code if unsuccessful. |
| </span><span class="attribute">#[cfg(windows)] |
| </span><span class="kw">pub fn </span>enable_ansi_support() -> <span class="prelude-ty">Result</span><(), u32> { |
| <span class="comment">// ref: https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences#EXAMPLE_OF_ENABLING_VIRTUAL_TERMINAL_PROCESSING @@ https://archive.is/L7wRJ#76% |
| |
| </span><span class="kw">use </span>std::ffi::OsStr; |
| <span class="kw">use </span>std::iter::once; |
| <span class="kw">use </span>std::os::windows::ffi::OsStrExt; |
| <span class="kw">use </span>std::ptr::null_mut; |
| <span class="kw">use </span>winapi::um::consoleapi::{GetConsoleMode, SetConsoleMode}; |
| <span class="kw">use </span>winapi::um::errhandlingapi::GetLastError; |
| <span class="kw">use </span>winapi::um::fileapi::{CreateFileW, OPEN_EXISTING}; |
| <span class="kw">use </span>winapi::um::handleapi::INVALID_HANDLE_VALUE; |
| <span class="kw">use </span>winapi::um::winnt::{FILE_SHARE_WRITE, GENERIC_READ, GENERIC_WRITE}; |
| |
| <span class="kw">const </span>ENABLE_VIRTUAL_TERMINAL_PROCESSING: u32 = <span class="number">0x0004</span>; |
| |
| <span class="kw">unsafe </span>{ |
| <span class="comment">// ref: https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-createfilew |
| // Using `CreateFileW("CONOUT$", ...)` to retrieve the console handle works correctly even if STDOUT and/or STDERR are redirected |
| </span><span class="kw">let </span>console_out_name: Vec<u16> = OsStr::new(<span class="string">"CONOUT$"</span>).encode_wide().chain(once(<span class="number">0</span>)).collect(); |
| <span class="kw">let </span>console_handle = CreateFileW( |
| console_out_name.as_ptr(), |
| GENERIC_READ | GENERIC_WRITE, |
| FILE_SHARE_WRITE, |
| null_mut(), |
| OPEN_EXISTING, |
| <span class="number">0</span>, |
| null_mut(), |
| ); |
| <span class="kw">if </span>console_handle == INVALID_HANDLE_VALUE |
| { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(GetLastError()); |
| } |
| |
| <span class="comment">// ref: https://docs.microsoft.com/en-us/windows/console/getconsolemode |
| </span><span class="kw">let </span><span class="kw-2">mut </span>console_mode: u32 = <span class="number">0</span>; |
| <span class="kw">if </span><span class="number">0 </span>== GetConsoleMode(console_handle, <span class="kw-2">&mut </span>console_mode) |
| { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(GetLastError()); |
| } |
| |
| <span class="comment">// VT processing not already enabled? |
| </span><span class="kw">if </span>console_mode & ENABLE_VIRTUAL_TERMINAL_PROCESSING == <span class="number">0 </span>{ |
| <span class="comment">// https://docs.microsoft.com/en-us/windows/console/setconsolemode |
| </span><span class="kw">if </span><span class="number">0 </span>== SetConsoleMode(console_handle, console_mode | ENABLE_VIRTUAL_TERMINAL_PROCESSING) |
| { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(GetLastError()); |
| } |
| } |
| } |
| |
| <span class="kw">return </span><span class="prelude-val">Ok</span>(()); |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ansi_term" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |