all_term 0.1.0

Cross-platform terminal abstraction library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use winapi::{
    um::{
        consoleapi::{GetConsoleMode, SetConsoleMode},
        wincon::{ENABLE_VIRTUAL_TERMINAL_PROCESSING, ENABLE_VIRTUAL_TERMINAL_INPUT},
    },
    shared::minwindef::DWORD,
};

use crate::os::windows::{get_stdout_handle, get_stdin_handle, check_win32_error};

const ANSI_INPUT_FLAGS: DWORD = ENABLE_VIRTUAL_TERMINAL_INPUT;
const ANSI_OUTPUT_FLAGS: DWORD = ENABLE_VIRTUAL_TERMINAL_PROCESSING;

/// Enables ANSI terminal mode on Windows if supported.
///
/// Based on ansi_term's implementation of this operation:
/// https://github.com/ogham/rust-ansi-term/blob/bb2cdf9fcab0362c8620f202ac5db21ac39338b1/src/windows.rs
///
/// https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences
///
/// Return value indicates success.
pub fn enable_ansi_mode() -> Result<(), String> {
    unsafe {
        {
            let stdout_handle = get_stdout_handle()?;

            let mut console_mode = 0;
            if GetConsoleMode(stdout_handle, &mut console_mode) == 0 {
                check_win32_error()?;
            }

            let new_mode = console_mode | ANSI_OUTPUT_FLAGS;

            if SetConsoleMode(stdout_handle, new_mode) == 0 {
                check_win32_error()?;
            }
        }

        {
            let stdin_handle = get_stdin_handle()?;

            let mut console_mode = 0;
            if GetConsoleMode(stdin_handle, &mut console_mode) == 0 {
                check_win32_error()?;
            }

            let new_mode = console_mode | ANSI_INPUT_FLAGS;

            if SetConsoleMode(stdin_handle, new_mode) == 0 {
                check_win32_error()?;
            }
        }
    }

    Ok(())
}