colorful 0.3.2

//! Colored your terminal.
//! You can use this package to make your string colorful in terminal.
//! Platform support:
//!  - Linux
//!  - macOS
//! <img src="https://github.com/rocketsman/colorful/blob/master/images/1.png?raw=true" width="60%">

/// It is recommended to use `Color` enum item to set foreground color not literal string.
/// Literal string makes program uncontrollable, you can use `Color` `RGB::new(1,1,1)` or `HSL::new(0.5,0.5,0.5)`
/// to create color and pass the variable to method.
/// # Examples
/// ```
/// extern crate colorful;
///
/// use colorful::Colorful;
/// use colorful::Color;
///
/// fn main(){
///     let s = "Hello world";
///     println!("{}",s.color(Color::Red).bg_color(Color::Yellow).bold().to_string());
/// }
/// ```

use std::{thread, time};

use core::color_string::CString;
use core::ColorInterface;
pub use core::colors::Color;
pub use core::hsl::HSL;
pub use core::rgb::RGB;
use core::StrMarker;
pub use core::style::Style;

pub mod core;

/// Support `&str` and `String`, you can use `"text".red()` and `s.red()` for s:String
pub trait Colorful {
    /// Set foreground color. Support Color enum and HSL, RGB mode.
    /// ```Rust
    /// extern crate colorful;
    ///
    /// use colorful::Colorful;
    /// use colorful::Color;
    ///
    /// fn main() {
    ///     let a = "Hello world";
    ///     println!("{}", a.color(Color::Red));
    ///     println!("{}", a.blue());
    ///     let b = String::from("Hello world");
    ///     println!("{}", b.blue());
    /// }
    /// ```
    fn color<C: ColorInterface>(self, color: C) -> CString;
    fn black(self) -> CString;
    fn red(self) -> CString;
    fn green(self) -> CString;
    fn yellow(self) -> CString;
    fn blue(self) -> CString;
    fn magenta(self) -> CString;
    fn cyan(self) -> CString;
    fn light_gray(self) -> CString;
    fn dark_gray(self) -> CString;
    fn light_red(self) -> CString;
    fn light_green(self) -> CString;
    fn light_yellow(self) -> CString;
    fn light_blue(self) -> CString;
    fn light_magenta(self) -> CString;
    fn light_cyan(self) -> CString;
    fn white(self) -> CString;
    /// Set background color. Support Color enum and HSL, RGB mode.
    /// ```Rust
    /// extern crate colorful;
    ///
    /// use colorful::Colorful;
    /// use colorful::Color;
    ///
    /// fn main() {
    ///     let a = "Hello world";
    ///     println!("{}", a.bg_color(Color::Red));
    /// }
    /// ```
    fn bg_color<C: ColorInterface>(self, color: C) -> CString;
    fn bg_black(self) -> CString;
    fn bg_red(self) -> CString;
    fn bg_green(self) -> CString;
    fn bg_yellow(self) -> CString;
    fn bg_blue(self) -> CString;
    fn bg_magenta(self) -> CString;
    fn bg_cyan(self) -> CString;
    fn bg_light_gray(self) -> CString;
    fn bg_dark_gray(self) -> CString;
    fn bg_light_red(self) -> CString;
    fn bg_light_green(self) -> CString;
    fn bg_light_yellow(self) -> CString;
    fn bg_light_blue(self) -> CString;
    fn bg_light_magenta(self) -> CString;
    fn bg_light_cyan(self) -> CString;
    fn bg_white(self) -> CString;
    /// Support RGB color and HSL mode
    /// ```Rust
    /// extern crate colorful;
    ///
    /// use colorful::Colorful;
    ///
    /// fn main() {
    ///     let a = "Hello world";
    ///     println!("{}", a.rgb(100, 100, 100).bg_rgb(100, 100, 100);
    ///     println!("{}", a.hsl(0.5, 0.5, 0.5)).bg_hsl(0.5, 0.5, 0.5));
    /// }
    /// ```
    fn rgb(self, r: u8, g: u8, b: u8) -> CString;
    fn bg_rgb(self, r: u8, g: u8, b: u8) -> CString;
    fn hsl(self, h: f32, s: f32, l: f32) -> CString;
    fn bg_hsl(self, h: f32, s: f32, l: f32) -> CString;
    /// Terminal effect
    /// See [ANSI escape code](https://en.wikipedia.org/wiki/ANSI_escape_code)
    /// For terminals compatibility, check [Terminals compatibility](https://github.com/rocketsman/colorful#terminals-compatibility)
    fn style(self, style: Style) -> CString;
    /// Turn bold mode on.
    fn bold(self) -> CString;
    /// Turn blinking mode on. Blink doesn't work in many terminal emulators ,and it will still work on the console.
    fn blink(self) -> CString;
    /// Turn low intensity mode on.
    fn dim(self) -> CString;
    /// Turn italic mode on.
    fn italic(self) -> CString;
    /// Turn underline mode on.
    fn underlined(self) -> CString;
    /// Turn reverse mode on (invert the foreground and background colors).
    fn reverse(self) -> CString;
    /// Turn invisible text mode on (useful for passwords).
    fn hidden(self) -> CString;
    /// Turn strikethrough mode on.
    fn strikethrough(self) -> CString;
    /// Apply gradient color to sentences, support multiple lines.
    /// You can use `use colorful::Color;` or `use colorful::HSL;` or `use colorful::RGB;`
    /// to import colors and create gradient string.
    /// ```Rust
    /// extern crate colorful;
    ///
    /// use colorful::Color;
    /// use colorful::Colorful;
    ///
    /// fn main() {
    ///     println!("{}", "This code is editable and runnable!".gradient(Color::Red));
    ///     println!("{}", "¡Este código es editable y ejecutable!".gradient(Color::Green));
    ///     println!("{}", "Ce code est modifiable et exécutable !".gradient(Color::Yellow));
    ///     println!("{}", "Questo codice è modificabile ed eseguibile!".gradient(Color::Blue));
    ///     println!("{}", "このコードは編集して実行出来ます！".gradient(Color::Magenta));
    ///     println!("{}", "여기에서 코드를 수정하고 실행할 수 있습니다!".gradient(Color::Cyan));
    ///     println!("{}", "Ten kod można edytować oraz uruchomić!".gradient(Color::LightGray));
    ///     println!("{}", "Este código é editável e executável!".gradient(Color::DarkGray));
    ///     println!("{}", "Этот код можно отредактировать и запустить!".gradient(Color::LightRed));
    ///     println!("{}", "Bạn có thể edit và run code trực tiếp!".gradient(Color::LightGreen));
    ///     println!("{}", "这段代码是可以编辑并且能够运行的！".gradient(Color::LightYellow));
    ///     println!("{}", "Dieser Code kann bearbeitet und ausgeführt werden!".gradient(Color::LightBlue));
    ///     println!("{}", "Den här koden kan redigeras och köras!".gradient(Color::LightMagenta));
    ///     println!("{}", "Tento kód můžete upravit a spustit".gradient(Color::LightCyan));
    ///     println!("{}", "این کد قابلیت ویرایش و اجرا دارد!".gradient(Color::White));
    ///     println!("{}", "โค้ดนี้สามารถแก้ไขได้และรันได้".gradient(Color::Grey0));
    /// }
    /// ```
    /// <img src="https://github.com/rocketsman/colorful/blob/master/images/1.png?raw=true" width="60%">
    fn gradient_with_step<C: ColorInterface>(self, color: C, step: f32) -> CString;
    fn gradient_with_color<C: ColorInterface>(self, start: C, stop: C) -> CString;
    fn gradient<C: ColorInterface>(self, color: C) -> CString;
    fn rainbow_with_speed(self, speed: i32);
    /// Rainbow mode, support multiple lines
    /// <img src="https://github.com/rocketsman/colorful/blob/master/images/11.gif?raw=true" width="60%">
    fn rainbow(self);
    fn neon_with_speed<C: ColorInterface>(self, low: C, high: C, speed: i32);
    /// Neon mode
    fn neon<C: ColorInterface>(self, low: C, high: C);
    /// Show some warning words.
    /// <img src="https://github.com/rocketsman/colorful/blob/master/images/22.gif?raw=true" width="60%">
    fn warn(self);
}

impl<T> Colorful for T where T: StrMarker {
    fn color<C: ColorInterface>(self, color: C) -> CString { CString::create_by_fg(self, color) }
    fn black(self) -> CString { self.color(Color::Black) }
    fn red(self) -> CString { self.color(Color::Red) }
    fn green(self) -> CString { self.color(Color::Green) }
    fn yellow(self) -> CString { self.color(Color::Yellow) }
    fn blue(self) -> CString { self.color(Color::Blue) }
    fn magenta(self) -> CString { self.color(Color::Magenta) }
    fn cyan(self) -> CString { self.color(Color::Cyan) }
    fn light_gray(self) -> CString { self.color(Color::LightGray) }
    fn dark_gray(self) -> CString { self.color(Color::DarkGray) }
    fn light_red(self) -> CString { self.color(Color::LightRed) }
    fn light_green(self) -> CString { self.color(Color::LightGreen) }
    fn light_yellow(self) -> CString { self.color(Color::LightYellow) }
    fn light_blue(self) -> CString { self.color(Color::LightBlue) }
    fn light_magenta(self) -> CString { self.color(Color::LightMagenta) }
    fn light_cyan(self) -> CString { self.color(Color::LightCyan) }
    fn white(self) -> CString { self.color(Color::White) }
    fn bg_color<C: ColorInterface>(self, color: C) -> CString { CString::create_by_bg(self, color) }
    fn bg_black(self) -> CString { self.bg_color(Color::Black) }
    fn bg_red(self) -> CString { self.bg_color(Color::Red) }
    fn bg_green(self) -> CString { self.bg_color(Color::Green) }
    fn bg_yellow(self) -> CString { self.bg_color(Color::Yellow) }
    fn bg_blue(self) -> CString { self.bg_color(Color::Blue) }
    fn bg_magenta(self) -> CString { self.bg_color(Color::Magenta) }
    fn bg_cyan(self) -> CString { self.bg_color(Color::Cyan) }
    fn bg_light_gray(self) -> CString { self.bg_color(Color::LightGray) }
    fn bg_dark_gray(self) -> CString { self.bg_color(Color::DarkGray) }
    fn bg_light_red(self) -> CString { self.bg_color(Color::LightRed) }
    fn bg_light_green(self) -> CString { self.bg_color(Color::LightGreen) }
    fn bg_light_yellow(self) -> CString { self.bg_color(Color::LightYellow) }
    fn bg_light_blue(self) -> CString { self.bg_color(Color::LightBlue) }
    fn bg_light_magenta(self) -> CString { self.bg_color(Color::LightMagenta) }
    fn bg_light_cyan(self) -> CString { self.bg_color(Color::LightCyan) }
    fn bg_white(self) -> CString { self.bg_color(Color::White) }
    fn rgb(self, r: u8, g: u8, b: u8) -> CString { CString::create_by_fg(self, RGB::new(r, g, b)) }
    fn bg_rgb(self, r: u8, g: u8, b: u8) -> CString { CString::create_by_bg(self, RGB::new(r, g, b)) }
    fn hsl(self, h: f32, s: f32, l: f32) -> CString { CString::create_by_fg(self, HSL::new(h, s, l)) }
    fn bg_hsl(self, h: f32, s: f32, l: f32) -> CString { CString::create_by_bg(self, HSL::new(h, s, l)) }
    fn style(self, style: Style) -> CString { CString::create_by_style(self, style) }
    fn bold(self) -> CString { self.style(Style::Bold) }
    fn blink(self) -> CString { self.style(Style::Blink) }
    fn dim(self) -> CString { self.style(Style::Dim) }
    fn italic(self) -> CString { self.style(Style::Italic) }
    fn underlined(self) -> CString { self.style(Style::Underlined) }
    fn reverse(self) -> CString { self.style(Style::Reverse) }
    fn hidden(self) -> CString { self.style(Style::Hidden) }
    fn strikethrough(self) -> CString { self.style(Style::Strikethrough) }
    fn gradient_with_step<C: ColorInterface>(self, color: C, step: f32) -> CString {
        let mut t = vec![];
        let mut start = color.to_hsl().h;
        let s = self.to_str();
        let c = s.chars();
        let length = c.clone().count() - 1;
        for (index, i) in c.enumerate() {
            let b = i.to_string();
            let tmp = b.hsl(start, 1.0, 0.5).to_string();
            t.push(format!("{}", &tmp[..tmp.len() - if index != length { 4 } else { 0 }]));
            start = (start + step) % 1.0;
        }
        CString::create_by_text(self, t.join(""))
    }
    fn gradient_with_color<C: ColorInterface>(self, start: C, stop: C) -> CString {
        let mut t = vec![];
        let c = self.to_str();
        let s = c.chars();
        let length = s.clone().count() - 1;
        let mut start = start.to_hsl().h;
        let stop = stop.to_hsl().h;
        let step = (stop - start) / length as f32;
        for (index, i) in s.enumerate() {
            let b = i.to_string();
            let tmp = b.hsl(start, 1.0, 0.5).to_string();
            t.push(format!("{}", &tmp[..tmp.len() - if index != length { 4 } else { 0 }]));
            start = (start + step) % 1.0;
        }
        CString::create_by_text(self, t.join(""))
    }
    fn gradient<C: ColorInterface>(self, color: C) -> CString {
        let text = self.to_str();
        let lines: Vec<_> = text.lines().collect();
        let mut tmp = vec![];
        for sub_str in lines.iter() {
            tmp.push(sub_str.gradient_with_step(color.clone(), 1.5 / 360.0).to_string());
        }
        CString::new(tmp.join("\n"))
    }
    fn rainbow_with_speed(self, speed: i32) {
        let respite: u64 = match speed {
            3 => { 10 }
            2 => { 5 }
            1 => { 2 }
            _ => { 0 }
        };
        let text = self.to_str();
        let lines: Vec<_> = text.lines().collect();
        for i in 0..360 {
            let mut tmp = vec![];
            for sub_str in lines.iter() {
                tmp.push(sub_str.gradient_with_step(HSL::new(i as f32 / 360.0, 1.0, 0.5), 0.02).to_string());
            }
            println!("{}\x1B[{}F\x1B[G\x1B[2K", tmp.join("\n"), lines.len());
            let ten_millis = time::Duration::from_millis(respite);
            thread::sleep(ten_millis);
        }
    }
    fn rainbow(self) {
        self.rainbow_with_speed(3);
    }
    fn neon_with_speed<C: ColorInterface>(self, high: C, low: C, speed: i32) {
        let respite: u64 = match speed {
            3 => { 500 }
            2 => { 200 }
            1 => { 100 }
            _ => { 0 }
        };
        let text = self.to_str();
        let lines: Vec<_> = text.lines().collect();
        let mut coin = true;
        let positive = format!("{}\x1B[{}F\x1B[2K", text.clone().color(high), lines.len());
        let negative = format!("{}\x1B[{}F\x1B[2K", text.clone().color(low), lines.len());
        for _ in 0..360 {
            if coin { println!("{}", positive) } else { println!("{}", negative) };
            let ten_millis = time::Duration::from_millis(respite);
            thread::sleep(ten_millis);
            coin = !coin;
        }
    }
    fn neon<C: ColorInterface>(self, high: C, low: C) {
        self.neon_with_speed(high, low, 3);
    }
    fn warn(self) {
        self.neon_with_speed(RGB::new(226, 14, 14), RGB::new(158, 158, 158), 3);
    }
}

pub trait ExtraColorInterface {
    fn grey0(self) -> CString;
}

impl<T> ExtraColorInterface for T where T: Colorful {
    fn grey0(self) -> CString { self.color(Color::Grey0) }
}