syntect/highlighting/
style.rs

Help
1// Code based on [https://github.com/defuz/sublimate/blob/master/src/core/syntax/scope.rs](https://github.com/defuz/sublimate/blob/master/src/core/syntax/scope.rs)
2// released under the MIT license by @defuz
3use bitflags::bitflags;
4use serde_derive::{Deserialize, Serialize};
5
6/// Foreground and background colors, with font style
7#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
8pub struct Style {
9    /// Foreground color
10    pub foreground: Color,
11    /// Background color
12    pub background: Color,
13    /// Style of the font
14    pub font_style: FontStyle,
15}
16
17/// A change to a [`Style`] applied incrementally by a theme rule
18///
19/// Fields left empty (as `None`) will not modify the corresponding field on a `Style`
20///
21/// [`Style`]: struct.Style.html
22#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
23pub struct StyleModifier {
24    /// Foreground color
25    pub foreground: Option<Color>,
26    /// Background color
27    pub background: Option<Color>,
28    /// Style of the font
29    pub font_style: Option<FontStyle>,
30}
31
32/// RGBA color, directly from the theme
33///
34/// Because these numbers come directly from the theme, you might have to do your own color space
35/// conversion if you're outputting a different color space from the theme. This can be a problem
36/// because some Sublime themes use sRGB and some don't. This is specified in an attribute syntect
37/// doesn't parse yet.
38#[derive(Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
39pub struct Color {
40    /// Red component
41    pub r: u8,
42    /// Green component
43    pub g: u8,
44    /// Blue component
45    pub b: u8,
46    /// Alpha (transparency) component
47    pub a: u8,
48}
49
50// More compact alternate debug representation by not using a separate line for each color field,
51// also adapts the default debug representation to match.
52impl std::fmt::Debug for Color {
53    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
54        let Color { r, g, b, a } = self;
55        if f.alternate() {
56            // when formatted with "{:#?}"
57            write!(
58                f,
59                "Color {{ r/g/b/a: {: >3}/{: >3}/{: >3}/{: >3} }}",
60                r, g, b, a
61            )
62        } else {
63            // when formatted with "{:?}"
64            write!(f, "Color {{ r/g/b/a: {}/{}/{}/{} }}", r, g, b, a)
65        }
66    }
67}
68
69bitflags! {
70    /// The color-independent styling of a font - i.e. bold, italicized, and/or underlined
71    #[derive(Serialize, Deserialize)]
72    pub struct FontStyle: u8 {
73        /// Bold font style
74        const BOLD = 1;
75        /// Underline font style
76        const UNDERLINE = 2;
77        /// Italic font style
78        const ITALIC = 4;
79    }
80}
81
82impl Color {
83    /// The color black (`#000000`)
84    pub const BLACK: Color = Color {
85        r: 0x00,
86        g: 0x00,
87        b: 0x00,
88        a: 0xFF,
89    };
90
91    /// The color white (`#FFFFFF`)
92    pub const WHITE: Color = Color {
93        r: 0xFF,
94        g: 0xFF,
95        b: 0xFF,
96        a: 0xFF,
97    };
98}
99
100impl Style {
101    /// Applies a change to this style, yielding a new changed style
102    pub fn apply(&self, modifier: StyleModifier) -> Style {
103        Style {
104            foreground: modifier.foreground.unwrap_or(self.foreground),
105            background: modifier.background.unwrap_or(self.background),
106            font_style: modifier.font_style.unwrap_or(self.font_style),
107        }
108    }
109}
110
111impl Default for Style {
112    fn default() -> Style {
113        Style {
114            foreground: Color::BLACK,
115            background: Color::WHITE,
116            font_style: FontStyle::empty(),
117        }
118    }
119}
120
121impl StyleModifier {
122    /// Applies the other modifier to this one, creating a new modifier.
123    ///
124    /// Values in `other` are preferred.
125    pub fn apply(&self, other: StyleModifier) -> StyleModifier {
126        StyleModifier {
127            foreground: other.foreground.or(self.foreground),
128            background: other.background.or(self.background),
129            font_style: other.font_style.or(self.font_style),
130        }
131    }
132}
133
134impl Default for FontStyle {
135    fn default() -> FontStyle {
136        FontStyle::empty()
137    }
138}
syntect/highlighting/style.rs

syntect/highlighting/
style.rs
