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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
//! Generator implementations tui crate.
mod tag;
#[cfg(test)]
mod test;
use tui::{
style::Style,
text::{Span, Spans, Text},
};
use super::{
helper::{unescape, CustomTagParser, GeneratorInfallible, NoopCustomTagParser},
Generator,
};
use crate::generator::{Tag, TagG};
use crate::parser::{Item, ItemG};
use tag::TuiTagParser;
/// Generator for [tui crate][tui]'s [Text] type.
///
/// See [tui-tags.ebnf] for supported tags.
///
/// ## Example
///
/// ```
/// # use tui::{style::{Style, Color, Modifier}, text::{Text, Spans, Span}};
/// use tui_markup::{compile, generator::TuiTextGenerator};
///
/// assert_eq!(
/// compile::<TuiTextGenerator>("I have a <green green text>"),
/// Ok(Text { lines: vec![Spans(vec![
/// Span::raw("I have a "),
/// Span::styled("green text", Style::default().fg(Color::Green)),
/// ])] }),
/// );
///
/// assert_eq!(
/// compile::<TuiTextGenerator>("I can set <bg:blue background>"),
/// Ok(Text { lines: vec![Spans(vec![
/// Span::raw("I can set "),
/// Span::styled("background", Style::default().bg(Color::Blue)),
/// ])] }),
/// );
///
/// assert_eq!(
/// compile::<TuiTextGenerator>("I can add <b bold>, <d dim>, <i italic> modifiers"),
/// Ok(Text { lines: vec![Spans(vec![
/// Span::raw("I can add "),
/// Span::styled("bold", Style::default().add_modifier(Modifier::BOLD)),
/// Span::raw(", "),
/// Span::styled("dim", Style::default().add_modifier(Modifier::DIM)),
/// Span::raw(", "),
/// Span::styled("italic", Style::default().add_modifier(Modifier::ITALIC)),
/// Span::raw(" modifiers"),
/// ])] }),
/// );
///
///
/// assert_eq!(
/// compile::<TuiTextGenerator>("I can <bg:blue combine <green them <b <i all>>>>"),
/// Ok(Text { lines: vec![Spans(vec![
/// Span::raw("I can "),
/// Span::styled("combine ", Style::default().bg(Color::Blue)),
/// Span::styled("them ", Style::default().bg(Color::Blue).fg(Color::Green)),
/// Span::styled("all", Style::default()
/// .bg(Color::Blue).fg(Color::Green).add_modifier(Modifier::BOLD | Modifier::ITALIC)),
/// ])] }),
/// );
///
/// assert_eq!(
/// compile::<TuiTextGenerator>("I can use <bg:66ccff custom color>"),
/// Ok(Text { lines: vec![Spans(vec![
/// Span::raw("I can use "),
/// Span::styled("custom color", Style::default().bg(Color::Rgb(0x66, 0xcc, 0xff))),
/// ])] }),
/// );
///
/// assert_eq!(
/// compile::<TuiTextGenerator>("I can set <bg:blue,green,b,i many style> in one tag"),
/// Ok(Text { lines: vec![Spans(vec![
/// Span::raw("I can set "),
/// Span::styled("many style", Style::default()
/// .bg(Color::Blue).fg(Color::Green).add_modifier(Modifier::BOLD | Modifier::ITALIC)),
/// Span::raw(" in one tag"),
/// ])] }),
/// );
/// ```
///
/// ### With custom tags
///
/// ```
/// # use tui::{style::{Style, Color, Modifier}, text::{Text, Spans, Span}};
/// use tui_markup::{compile_with, generator::TuiTextGenerator};
///
/// let gen = TuiTextGenerator::new(|tag: &str| match tag {
/// "keyboard" => Some(Style::default().bg(Color::White).fg(Color::Green).add_modifier(Modifier::BOLD)),
/// _ => None,
/// });
///
/// assert_eq!(
/// compile_with("Press <keyboard W> to move up", gen),
/// Ok(Text { lines: vec![Spans(vec![
/// Span::raw("Press "),
/// Span::styled("W", Style::default().bg(Color::White).fg(Color::Green).add_modifier(Modifier::BOLD)),
/// Span::raw(" to move up"),
/// ])] }),
/// );
/// ```
///
/// ### Show output
///
/// Use any widget of [tui] crate that supports it's Text type, for example: [`tui::widgets::Paragraph`].
///
/// [tui-tags.ebnf]: https://github.com/7sDream/master/blob/docs/tui-tag.ebnf
#[cfg_attr(docsrs, doc(cfg(feature = "tui")))]
#[derive(Debug)]
pub struct TuiTextGenerator<P = NoopCustomTagParser<Style>> {
tag_parser: TuiTagParser<P>,
}
impl<P> Default for TuiTextGenerator<P> {
fn default() -> Self {
Self {
tag_parser: Default::default(),
}
}
}
impl<P> TuiTextGenerator<P> {
/// Create a new generator, with custom tag parser.
pub fn new(p: P) -> Self {
TuiTextGenerator {
tag_parser: TuiTagParser::new(p),
}
}
}
impl<'a, P> TuiTextGenerator<P>
where
P: CustomTagParser<Output = Style>,
{
fn tag_to_style(tag: TagG<'a, Self>) -> Style {
match tag {
Tag::Fg(color) => Style::default().fg(color),
Tag::Bg(color) => Style::default().bg(color),
Tag::Modifier(m) => Style::default().add_modifier(m),
Tag::Custom(style) => style,
}
}
fn patch_style(style: Option<Style>, tag: Vec<TagG<'a, Self>>) -> Style {
tag.into_iter()
.map(Self::tag_to_style)
.fold(style.unwrap_or_default(), Style::patch)
}
fn plain_text(&self, escaped: &'a str, style: Option<Style>) -> Vec<Span<'a>> {
unescape(escaped)
.map(|s| match style {
Some(style) => Span::styled(s, style),
None => Span::raw(s),
})
.collect()
}
fn element(
&mut self, tags: Vec<TagG<'a, Self>>, children: Vec<ItemG<'a, Self>>, style: Option<Style>,
) -> Vec<Span<'a>> {
self.items(children, Some(Self::patch_style(style, tags)))
}
fn item(&mut self, item: Item<'a, TagG<'a, Self>>, style: Option<Style>) -> Vec<Span<'a>> {
match item {
Item::PlainText(t) => self.plain_text(t.fragment(), style),
Item::Element(tags, children) => self.element(tags, children, style),
}
}
fn items(&mut self, items: Vec<ItemG<'a, Self>>, style: Option<Style>) -> Vec<Span<'a>> {
items
.into_iter()
.flat_map(|item| self.item(item, style).into_iter())
.collect()
}
}
impl<'a, P> Generator<'a> for TuiTextGenerator<P>
where
P: CustomTagParser<Output = Style>,
{
type Convertor = TuiTagParser<P>;
type Output = Text<'a>;
type Err = GeneratorInfallible;
fn convertor(&mut self) -> &mut Self::Convertor {
&mut self.tag_parser
}
fn generate(&mut self, items: Vec<Vec<Item<'a, TagG<'a, Self>>>>) -> Result<Self::Output, Self::Err> {
Ok(Text::from(
items
.into_iter()
.map(|line| Spans::from(self.items(line, None)))
.collect::<Vec<_>>(),
))
}
}