fwdansi-1.0.1/.gitignore010064400007650000120000000000361332756140600133560ustar0000000000000000/target **/*.rs.bk Cargo.lock fwdansi-1.0.1/.travis.yml010064400007650000120000000002201333011600300134510ustar0000000000000000sudo: false language: rust rust: - 1.27.2 - stable - beta - nightly script: - cargo build - cargo test - cargo run --example run-rustc fwdansi-1.0.1/appveyor.yml010064400007650000120000000006561333011577700137660ustar0000000000000000environment: matrix: - TOOLCHAIN: 1.27.2 - TOOLCHAIN: stable - TOOLCHAIN: beta - TOOLCHAIN: nightly install: - appveyor DownloadFile https://win.rustup.rs/x86_64 -FileName rustup-init.exe - rustup-init -y --default-toolchain %TOOLCHAIN% - SET PATH=%PATH%;C:\Users\appveyor\.cargo\bin - rustc -vV - cargo -vV test_script: - cargo build - cargo test - cargo run --example run-rustc build: false fwdansi-1.0.1/Cargo.toml.orig010064400007650000120000000011001333011722500142340ustar0000000000000000[package] name = "fwdansi" version = "1.0.1" authors = ["kennytm "] description = "Forwards a byte string with ANSI escape code to a termcolor terminal" repository = "https://github.com/kennytm/fwdansi" keywords = ["ansi", "windows", "console", "terminal", "color"] categories = ["command-line-interface"] license = "MIT" [badges] travis-ci = { repository = "kennytm/fwdansi" } appveyor = { repository = "kennytm/fwdansi" } maintenance = { status = "passively-maintained" } [dependencies] termcolor = "1" memchr = "2" [dev-dependencies] proptest = "0.8" fwdansi-1.0.1/Cargo.toml0000644000000021630000000000000105250ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g. crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] name = "fwdansi" version = "1.0.1" authors = ["kennytm "] description = "Forwards a byte string with ANSI escape code to a termcolor terminal" keywords = ["ansi", "windows", "console", "terminal", "color"] categories = ["command-line-interface"] license = "MIT" repository = "https://github.com/kennytm/fwdansi" [dependencies.memchr] version = "2" [dependencies.termcolor] version = "1" [dev-dependencies.proptest] version = "0.8" [badges.appveyor] repository = "kennytm/fwdansi" [badges.maintenance] status = "passively-maintained" [badges.travis-ci] repository = "kennytm/fwdansi" fwdansi-1.0.1/examples/run-rustc.rs010064400007650000120000000007101333011573700155070ustar0000000000000000extern crate termcolor; extern crate fwdansi; use termcolor::*; use std::io; use std::process::Command; use fwdansi::write_ansi; fn main() -> io::Result<()> { let output = Command::new("rustc").args(&["--color", "always"]).output()?; let mut stderr = StandardStream::stderr(ColorChoice::Always); write_ansi(&mut stderr, &output.stderr)?; //^ should print "error: no input filename given" with appropriate color everywhere. Ok(()) } fwdansi-1.0.1/src/lib.rs010064400007650000120000000161651333010671700132750ustar0000000000000000//! Write colored strings with ANSI escape code into a `termcolor` terminal. //! //! This package provides a single function, [`write_ansi`], which parses ANSI //! escape codes in the provided byte string and transforms them into the //! corresponding `termcolor` commands. The colors will be supported even on a //! Windows console. //! //! The main purpose of this package is to forward colored output from a child //! process. //! //! ```rust // #![doc(include = "../examples/rustc.rs")] // still unstable, see issue 44732 //! extern crate termcolor; //! extern crate fwdansi; //! //! use termcolor::*; //! use std::io; //! use std::process::Command; //! use fwdansi::write_ansi; //! //! fn main() -> io::Result<()> { //! let output = Command::new("rustc").args(&["--color", "always"]).output()?; //! //! let mut stderr = StandardStream::stderr(ColorChoice::Always); //! write_ansi(&mut stderr, &output.stderr)?; //! //^ should print "error: no input filename given" with appropriate color everywhere. //! //! Ok(()) //! } //! ``` extern crate termcolor; extern crate memchr; use memchr::memchr; use termcolor::{Color, ColorSpec, WriteColor}; use std::io; use std::mem; /// Writes a string with ANSI escape code into the colored output stream. /// /// Only SGR (`\x1b[…m`) is supported. Other input will be printed as-is. pub fn write_ansi(mut writer: W, mut ansi: &[u8]) -> io::Result<()> { while let Some(index) = memchr(0x1b, ansi) { let (left, right) = ansi.split_at(index); writer.write_all(left)?; if right.is_empty() { return Ok(()); } let mut parser = ColorSpecParser::new(right); parser.parse(); if parser.ansi.as_ptr() == right.as_ptr() { writer.write_all(&right[..1])?; ansi = &right[1..]; } else { writer.set_color(&parser.spec)?; ansi = parser.ansi; } } writer.write_all(ansi) } #[derive(Copy, Clone, PartialEq, Eq, Debug)] enum State { Normal, PrepareCustomColor, Ansi256, Rgb, } struct ColorSpecParser<'a> { spec: ColorSpec, ansi: &'a [u8], reset: bool, state: State, is_bg: bool, red: Option, green: Option, } impl<'a> ColorSpecParser<'a> { fn new(ansi: &'a [u8]) -> Self { Self { spec: ColorSpec::new(), ansi, reset: false, state: State::Normal, is_bg: false, red: None, green: None, } } fn parse(&mut self) { #[derive(PartialEq, Eq)] enum Expected { Escape, OpenBracket, Number(u8), } while !self.ansi.is_empty() { let mut expected = Expected::Escape; let mut it = self.ansi.iter(); for b in &mut it { match (*b, expected) { (0x1b, Expected::Escape) => { expected = Expected::OpenBracket; continue; } (b'[', Expected::OpenBracket) => { expected = Expected::Number(0); continue; } (b'0'..=b'9', Expected::Number(number)) => { if let Some(n) = number.checked_mul(10).and_then(|n| n.checked_add(b - b'0')) { expected = Expected::Number(n); continue; } } (b':', Expected::Number(number)) | (b';', Expected::Number(number)) | (b'm', Expected::Number(number)) => { if self.apply_number(number) { if *b == b'm' { expected = Expected::Escape; break; } else { expected = Expected::Number(0); continue; } } } _ => {} } return; } if let Expected::Escape = expected { self.ansi = it.as_slice(); } else { break; } } } fn set_color(&mut self, color: Color) { if self.is_bg { self.spec.set_bg(Some(color)); } else { self.spec.set_fg(Some(color)); } } fn apply_number(&mut self, number: u8) -> bool { match (number, self.state) { (0, State::Normal) => { if mem::replace(&mut self.reset, true) { return false; } } (1, State::Normal) => { self.spec.set_bold(true); } (4, State::Normal) => { self.spec.set_underline(true); } (21, State::Normal) => { self.spec.set_bold(false); } (24, State::Normal) => { self.spec.set_underline(false); } (38, State::Normal) | (48, State::Normal) => { self.is_bg = number == 48; self.state = State::PrepareCustomColor; } (30..=39, State::Normal) => { self.spec.set_fg(parse_color(number - 30)); } (40..=49, State::Normal) => { self.spec.set_bg(parse_color(number - 40)); } (90..=97, State::Normal) => { self.spec.set_intense(true).set_fg(parse_color(number - 90)); } (100..=107, State::Normal) => { self.spec.set_intense(true).set_bg(parse_color(number - 100)); } (5, State::PrepareCustomColor) => { self.state = State::Ansi256; } (2, State::PrepareCustomColor) => { self.state = State::Rgb; self.red = None; self.green = None; } (n, State::Ansi256) => { self.set_color(Color::Ansi256(n)); self.state = State::Normal; } (b, State::Rgb) => { match (self.red, self.green) { (None, _) => { self.red = Some(b); } (Some(_), None) => { self.green = Some(b); } (Some(r), Some(g)) => { self.set_color(Color::Rgb(r, g, b)); self.state = State::Normal; } } } _ => { self.state = State::Normal; } } true } } fn parse_color(digit: u8) -> Option { match digit { 0 => Some(Color::Black), 1 => Some(Color::Red), 2 => Some(Color::Green), 3 => Some(Color::Yellow), 4 => Some(Color::Blue), 5 => Some(Color::Magenta), 6 => Some(Color::Cyan), 7 => Some(Color::White), _ => None, } } fwdansi-1.0.1/tests/tests.proptest-regressions010064400007650000120000000013341333000265000200200ustar0000000000000000# Seeds for failure cases proptest has generated in the past. It is # automatically read and these particular cases re-run before any # novel cases are generated. # # It is recommended to check this file in to source control so that # everyone who runs the test benefits from these saved cases. xs 3335351554 386647235 3584534272 266266105 # shrinks to ref elements = [Reset] xs 1928044643 2253320966 2424427606 448028530 # shrinks to ref ansi_string = [27] xs 1984785545 2043478319 191885995 1442765875 # shrinks to ref elements = [Text([27])] xs 4274884889 8924921 2258884976 859679705 # shrinks to ref elements = [Text([27, 91, 109])] xs 428132133 722552347 3851126282 1913029940 # shrinks to ref elements = [Text([27, 91, 58])] fwdansi-1.0.1/tests/tests.rs010064400007650000120000000054651333000262100142320ustar0000000000000000#[macro_use] extern crate proptest; extern crate fwdansi; extern crate termcolor; use fwdansi::write_ansi; use proptest::prelude::*; use std::io; use termcolor::{Ansi, Color, ColorSpec, WriteColor}; proptest! { #[test] fn check_no_crash(ref ansi_string in any::>()) { let mut ansi = Ansi::new(Vec::with_capacity(ansi_string.len())); prop_assert!(write_ansi(&mut ansi, &ansi_string).is_ok()); } #[test] fn ansi_idempotent(ref elements in prop::collection::vec(Element::any(), 0..100)) { // first, write the test string into an ANSI buffer. let mut original = Ansi::new(Vec::new()); for e in elements { e.write(&mut original).unwrap(); } // recover the original string, and forward it using `write_ansi`. let original = original.into_inner(); let mut forwarded = Ansi::new(Vec::with_capacity(original.len())); prop_assert!(write_ansi(&mut forwarded, &original).is_ok()); prop_assert_eq!(original, forwarded.into_inner()); } } #[derive(Debug, Clone)] enum Element { ColorSpec(ColorSpec), Reset, Text(Vec), } fn any_opt_color() -> impl Strategy> { let color = prop_oneof![ Just(Color::Black), Just(Color::Red), Just(Color::Green), Just(Color::Yellow), Just(Color::Blue), Just(Color::Magenta), Just(Color::Cyan), Just(Color::White), any::().prop_map(Color::Ansi256), any::<[u8; 3]>().prop_map(|[r, g, b]| Color::Rgb(r, g, b)), ]; prop::option::weighted(0.9, color) } prop_compose! { fn any_color_spec()( bold in any::(), underline in any::(), intense in any::(), fg_color in any_opt_color(), bg_color in any_opt_color(), ) -> ColorSpec { let mut spec = ColorSpec::new(); spec.set_bold(bold) .set_underline(underline) .set_intense(intense) .set_fg(fg_color) .set_bg(bg_color); spec } } impl Element { fn any() -> impl Strategy { prop_oneof![ Just(Element::Reset), any_color_spec().prop_map(Element::ColorSpec), any::>() .prop_filter_map( "ignored empty SGR", |v| if v.windows(3).find(|w| w == b"\x1b[m").is_some() { None } else { Some(Element::Text(v)) } ), ] } fn write(&self, mut w: W) -> io::Result<()> { match self { Element::ColorSpec(cs) => w.set_color(cs), Element::Reset => w.reset(), Element::Text(text) => w.write_all(text), } } }