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
57
58
59
60
61
62
63
64

/*
    This file is a part of term-string.

    Copyright (C) 2018 Mohammad AlSaleh <CE.Mohammad.AlSaleh at gmail.com>
    https://github.com/rust-alt/term-string

    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    file, You can obtain one at <http://mozilla.org/MPL/2.0/>.
*/

//! Provide a string and a style type for terminal formatted output.
//! 
//! This crate wraps around the `term` crate. And thus, supports both
//! Terminfo terminals, and the Windows console.
//!
//! # Examples
//!
//! ``` rust
//! // color is a re-exported module from term
//! use term_string::color::{GREEN, RED};
//!
//! use term_string::{TermString, TermStyle};
//!
//! // Create term styles
//! let style1 = TermStyle::bold() + TermStyle::fg(GREEN) + TermStyle::bg(RED);
//! let style2 = TermStyle::underline(true);
//!
//! // Create term string from a style and a string value
//! let mut ts = TermString::new(style1, "style");
//!
//! // "1" inherits style1
//! ts+= "1";
//!
//! // " : " is un-styled
//! ts += TermString::from(" : ");
//!
//! ts += TermString::new(style2, "This is text with style 2");
//!
//! ts.println();
//! ```
//!
//! Check [`TermStyle`] and [`TermString`] for detailed documentation of each type.

#![recursion_limit = "1024"]

#[macro_use]
extern crate mashup;

pub extern crate isatty;
pub extern crate term;

#[macro_use]
mod common_macros;

mod error;
mod string;
mod style;

#[doc(inline)]
pub use style::{color, Attr, TermStyle};

#[doc(inline)]
pub use string::{TermString, TermWrite};