blasthavers/minicrossterm
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Simplify ansi_support (#522)

Browse Source
This commit is contained in:
Koxiaet 2020-12-26 18:31:34 +00:00 committed by GitHub
parent 8f6ba34349
commit 52bed07ce8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
src/ansi_support.rs
View File

@ -5,29 +5,23 @@ use lazy_static::lazy_static;
use crate::Result; use crate::Result;
/// Toggle virtual terminal processing. /// Enable virtual terminal processing.
/// ///
/// This method attempts to toggle virtual terminal processing for this /// This method attempts to enable virtual terminal processing for this
/// console. If there was a problem toggling it, then an error returned. /// console. If there was a problem enabling it, then an error returned.
/// On success, the caller may assume that toggling it was successful. /// On success, the caller may assume that enabling it was successful.
/// ///
/// When virtual terminal processing is enabled, characters emitted to the /// When virtual terminal processing is enabled, characters emitted to the
/// console are parsed for VT100 and similar control character sequences /// console are parsed for VT100 and similar control character sequences
/// that control color and other similar operations. /// that control color and other similar operations.
pub(crate) fn set_virtual_terminal_processing(yes: bool) -> Result<()> { fn enable_vt_processing() -> Result<()> {
let mask = ENABLE_VIRTUAL_TERMINAL_PROCESSING; let mask = ENABLE_VIRTUAL_TERMINAL_PROCESSING;
let console_mode = ConsoleMode::from(Handle::current_out_handle()?); let console_mode = ConsoleMode::from(Handle::current_out_handle()?);
let old_mode = console_mode.mode()?; let old_mode = console_mode.mode()?;
let new_mode = if yes { if old_mode & mask == 0 {
old_mode | mask console_mode.set_mode(old_mode | mask)?;
} else {
old_mode & !mask
};
if old_mode != new_mode {
console_mode.set_mode(new_mode)?;
} }
Ok(()) Ok(())
@ -35,18 +29,11 @@ pub(crate) fn set_virtual_terminal_processing(yes: bool) -> Result<()> {
lazy_static! { lazy_static! {
static ref SUPPORTS_ANSI_ESCAPE_CODES: bool = { static ref SUPPORTS_ANSI_ESCAPE_CODES: bool = {
// Some terminals on windows like GitBash can't use WinaApi calls directly // Some terminals on Windows like GitBash can't use WinAPI calls directly
// so when we try to enable the ANSI-flag for windows this won't work. // so when we try to enable the ANSI-flag for Windows this won't work.
// Because of that we should check first if the TERM-variable is set // Because of that we should check first if the TERM-variable is set
// and see if the current terminal is a terminal who does support ANSI. // and see if the current terminal is a terminal who does support ANSI.
if is_specific_term() { std::env::var("TERM").map_or(false, |term| term != "dumb") || enable_vt_processing().is_ok()
true
} else {
// if it is not listed we should try with WinApi to check if we do support ANSI-codes.
set_virtual_terminal_processing(true)
.map(|_| true)
.unwrap_or(false)
}
}; };
} }
@ -54,27 +41,3 @@ lazy_static! {
pub fn supports_ansi() -> bool { pub fn supports_ansi() -> bool {
*SUPPORTS_ANSI_ESCAPE_CODES *SUPPORTS_ANSI_ESCAPE_CODES
} }
// Checks if the 'TERM' environment variable is set to check if the terminal supports ANSI-codes.
// I got the list of terminals from here: https://github.com/keqingrong/supports-ansi/blob/master/index.js
fn is_specific_term() -> bool {
const TERMS: [&str; 15] = [
"xterm", // xterm, PuTTY, Mintty
"rxvt", // RXVT
"eterm", // Eterm
"screen", // GNU screen, tmux
"tmux", // tmux
"vt100", "vt102", "vt220", "vt320", // DEC VT series
"ansi", // ANSI
"scoansi", // SCO ANSI
"cygwin", // Cygwin, MinGW
"linux", // Linux console
"konsole", // Konsole
"bvterm", // Bitvise SSH Client
];
match std::env::var("TERM") {
Ok(val) => val != "dumb" || TERMS.contains(&val.as_str()),
Err(_) => false,
}
}

19
src/terminal.rs
View File

@ -387,8 +387,6 @@ mod tests {
#[test] #[test]
#[ignore] #[ignore]
fn test_resize_ansi() { fn test_resize_ansi() {
try_enable_ansi();
let (width, height) = size().unwrap(); let (width, height) = size().unwrap();
execute!(stdout(), SetSize(35, 35)).unwrap(); execute!(stdout(), SetSize(35, 35)).unwrap();
@ -406,21 +404,4 @@ mod tests {
assert_eq!((width, height), size().unwrap()); assert_eq!((width, height), size().unwrap());
} }
fn try_enable_ansi() -> bool {
#[cfg(windows)]
{
if cfg!(target_os = "windows") {
use crate::ansi_support::set_virtual_terminal_processing;
// if it is not listed we should try with WinApi to check if we do support ANSI-codes.
match set_virtual_terminal_processing(true) {
Ok(_) => return true,
Err(_) => return false,
}
}
}
true
}
} }