@ -315,6 +315,44 @@ impl From<Color> for crossterm::style::Color {
} }
} }
#[ derive(Debug, Clone, Copy, PartialEq) ]
pub enum UnderlineStyle {
Reset ,
Line ,
Curl ,
Dotted ,
Dashed ,
DoubleLine ,
}
impl FromStr for UnderlineStyle {
type Err = & ' static str ;
fn from_str ( modifier : & str ) -> Result < Self , Self ::Err > {
match modifier {
"line" = > Ok ( Self ::Line ) ,
"curl" = > Ok ( Self ::Curl ) ,
"dotted" = > Ok ( Self ::Dotted ) ,
"dashed" = > Ok ( Self ::Dashed ) ,
"double_line" = > Ok ( Self ::DoubleLine ) ,
_ = > Err ( "Invalid underline style" ) ,
}
}
}
impl From < UnderlineStyle > for crossterm ::style ::Attribute {
fn from ( style : UnderlineStyle ) -> Self {
match style {
UnderlineStyle ::Line = > crossterm ::style ::Attribute ::Underlined ,
UnderlineStyle ::Curl = > crossterm ::style ::Attribute ::Undercurled ,
UnderlineStyle ::Dotted = > crossterm ::style ::Attribute ::Underdotted ,
UnderlineStyle ::Dashed = > crossterm ::style ::Attribute ::Underdashed ,
UnderlineStyle ::DoubleLine = > crossterm ::style ::Attribute ::DoubleUnderlined ,
UnderlineStyle ::Reset = > crossterm ::style ::Attribute ::NoUnderline ,
}
}
}
bitflags ! { bitflags ! {
/// Modifier changes the way a piece of text is displayed.
/// Modifier changes the way a piece of text is displayed.
///
///
@ -332,7 +370,6 @@ bitflags! {
const BOLD = 0b0000_0000_0001 ; const BOLD = 0b0000_0000_0001 ;
const DIM = 0b0000_0000_0010 ; const DIM = 0b0000_0000_0010 ;
const ITALIC = 0b0000_0000_0100 ; const ITALIC = 0b0000_0000_0100 ;
const UNDERLINED = 0b0000_0000_1000 ;
const SLOW_BLINK = 0b0000_0001_0000 ; const SLOW_BLINK = 0b0000_0001_0000 ;
const RAPID_BLINK = 0b0000_0010_0000 ; const RAPID_BLINK = 0b0000_0010_0000 ;
const REVERSED = 0b0000_0100_0000 ; const REVERSED = 0b0000_0100_0000 ;
@ -349,7 +386,6 @@ impl FromStr for Modifier {
"bold" = > Ok ( Self ::BOLD ) , "bold" = > Ok ( Self ::BOLD ) ,
"dim" = > Ok ( Self ::DIM ) , "dim" = > Ok ( Self ::DIM ) ,
"italic" = > Ok ( Self ::ITALIC ) , "italic" = > Ok ( Self ::ITALIC ) ,
"underlined" = > Ok ( Self ::UNDERLINED ) ,
"slow_blink" = > Ok ( Self ::SLOW_BLINK ) , "slow_blink" = > Ok ( Self ::SLOW_BLINK ) ,
"rapid_blink" = > Ok ( Self ::RAPID_BLINK ) , "rapid_blink" = > Ok ( Self ::RAPID_BLINK ) ,
"reversed" = > Ok ( Self ::REVERSED ) , "reversed" = > Ok ( Self ::REVERSED ) ,
@ -375,7 +411,7 @@ impl FromStr for Modifier {
/// just S3.
/// just S3.
///
///
/// ```rust
/// ```rust
/// # use helix_view::graphics::{Rect, Color, Modifier, Style};
/// # use helix_view::graphics::{Rect, Color, UnderlineStyle, Modifier, Style};
/// # use helix_tui::buffer::Buffer;
/// # use helix_tui::buffer::Buffer;
/// let styles = [
/// let styles = [
/// Style::default().fg(Color::Blue).add_modifier(Modifier::BOLD | Modifier::ITALIC),
/// Style::default().fg(Color::Blue).add_modifier(Modifier::BOLD | Modifier::ITALIC),
@ -391,6 +427,8 @@ impl FromStr for Modifier {
/// fg: Some(Color::Yellow),
/// fg: Some(Color::Yellow),
/// bg: Some(Color::Red),
/// bg: Some(Color::Red),
/// add_modifier: Modifier::BOLD,
/// add_modifier: Modifier::BOLD,
/// underline_color: Some(Color::Reset),
/// underline_style: Some(UnderlineStyle::Reset),
/// sub_modifier: Modifier::empty(),
/// sub_modifier: Modifier::empty(),
/// },
/// },
/// buffer[(0, 0)].style(),
/// buffer[(0, 0)].style(),
@ -401,7 +439,7 @@ impl FromStr for Modifier {
/// reset all properties until that point use [`Style::reset`].
/// reset all properties until that point use [`Style::reset`].
///
///
/// ```
/// ```
/// # use helix_view::graphics::{Rect, Color, Modifier, Style};
/// # use helix_view::graphics::{Rect, Color, UnderlineStyle, Modifier, Style};
/// # use helix_tui::buffer::Buffer;
/// # use helix_tui::buffer::Buffer;
/// let styles = [
/// let styles = [
/// Style::default().fg(Color::Blue).add_modifier(Modifier::BOLD | Modifier::ITALIC),
/// Style::default().fg(Color::Blue).add_modifier(Modifier::BOLD | Modifier::ITALIC),
@ -415,6 +453,8 @@ impl FromStr for Modifier {
/// Style {
/// Style {
/// fg: Some(Color::Yellow),
/// fg: Some(Color::Yellow),
/// bg: Some(Color::Reset),
/// bg: Some(Color::Reset),
/// underline_color: Some(Color::Reset),
/// underline_style: Some(UnderlineStyle::Reset),
/// add_modifier: Modifier::empty(),
/// add_modifier: Modifier::empty(),
/// sub_modifier: Modifier::empty(),
/// sub_modifier: Modifier::empty(),
/// },
/// },
@ -426,6 +466,8 @@ impl FromStr for Modifier {
pub struct Style { pub struct Style {
pub fg : Option < Color > , pub fg : Option < Color > ,
pub bg : Option < Color > , pub bg : Option < Color > ,
pub underline_color : Option < Color > ,
pub underline_style : Option < UnderlineStyle > ,
pub add_modifier : Modifier , pub add_modifier : Modifier ,
pub sub_modifier : Modifier , pub sub_modifier : Modifier ,
} }
@ -435,6 +477,8 @@ impl Default for Style {
Style { Style {
fg : None , fg : None ,
bg : None , bg : None ,
underline_color : None ,
underline_style : None ,
add_modifier : Modifier ::empty ( ) , add_modifier : Modifier ::empty ( ) ,
sub_modifier : Modifier ::empty ( ) , sub_modifier : Modifier ::empty ( ) ,
} }
@ -447,6 +491,8 @@ impl Style {
Style { Style {
fg : Some ( Color ::Reset ) , fg : Some ( Color ::Reset ) ,
bg : Some ( Color ::Reset ) , bg : Some ( Color ::Reset ) ,
underline_color : None ,
underline_style : None ,
add_modifier : Modifier ::empty ( ) , add_modifier : Modifier ::empty ( ) ,
sub_modifier : Modifier ::all ( ) , sub_modifier : Modifier ::all ( ) ,
} }
@ -482,6 +528,36 @@ impl Style {
self self
} }
/// Changes the underline color.
///
/// ## Examples
///
/// ```rust
/// # use helix_view::graphics::{Color, Style};
/// let style = Style::default().underline_color(Color::Blue);
/// let diff = Style::default().underline_color(Color::Red);
/// assert_eq!(style.patch(diff), Style::default().underline_color(Color::Red));
/// ```
pub fn underline_color ( mut self , color : Color ) -> Style {
self . underline_color = Some ( color ) ;
self
}
/// Changes the underline style.
///
/// ## Examples
///
/// ```rust
/// # use helix_view::graphics::{UnderlineStyle, Style};
/// let style = Style::default().underline_style(UnderlineStyle::Line);
/// let diff = Style::default().underline_style(UnderlineStyle::Curl);
/// assert_eq!(style.patch(diff), Style::default().underline_style(UnderlineStyle::Curl));
/// ```
pub fn underline_style ( mut self , style : UnderlineStyle ) -> Style {
self . underline_style = Some ( style ) ;
self
}
/// Changes the text emphasis.
/// Changes the text emphasis.
///
///
/// When applied, it adds the given modifier to the `Style` modifiers.
/// When applied, it adds the given modifier to the `Style` modifiers.
@ -538,6 +614,8 @@ impl Style {
pub fn patch ( mut self , other : Style ) -> Style { pub fn patch ( mut self , other : Style ) -> Style {
self . fg = other . fg . or ( self . fg ) ; self . fg = other . fg . or ( self . fg ) ;
self . bg = other . bg . or ( self . bg ) ; self . bg = other . bg . or ( self . bg ) ;
self . underline_color = other . underline_color . or ( self . underline_color ) ;
self . underline_style = other . underline_style . or ( self . underline_style ) ;
self . add_modifier . remove ( other . sub_modifier ) ; self . add_modifier . remove ( other . sub_modifier ) ;
self . add_modifier . insert ( other . add_modifier ) ; self . add_modifier . insert ( other . add_modifier ) ;
Blaž Hrastnik
2 years ago
committed by
GitHub