tachyonfx 0.25.0

A ratatui library for creating shader-like effects in TUIs.
Documentation 
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

use alloc::boxed::Box;

use ratatui_core::{buffer::Buffer, layout::Rect};

use crate::{CellFilter, ColorSpace, Duration, Effect, EffectTimer, Interpolation::Linear, Shader};

/// Specifies the position where the additional duration should be applied in a `Prolong`
/// effect.
#[derive(Clone, Copy, Debug, PartialEq)]
pub(crate) enum ProlongPosition {
    Start,
    End,
}

#[derive(Clone, Debug)]
pub(super) struct Prolong {
    inner: Effect,
    timer: EffectTimer,
    position: ProlongPosition,
}

impl Prolong {
    pub fn new(position: ProlongPosition, additional_duration: EffectTimer, inner: Effect) -> Self {
        Self { inner, timer: additional_duration, position }
    }
}

/// A shader that wraps an inner effect and prolongs its duration either at the start or
/// end.
impl Shader for Prolong {
    fn name(&self) -> &'static str {
        match self.position {
            ProlongPosition::Start => "prolong_start",
            ProlongPosition::End => "prolong_end",
        }
    }

    fn process(&mut self, duration: Duration, buf: &mut Buffer, area: Rect) -> Option<Duration> {
        match self.position {
            ProlongPosition::Start => {
                let overflow = self.timer.process(duration);
                self.inner
                    .process(overflow.unwrap_or_default(), buf, area)
            },
            ProlongPosition::End => {
                let overflow = self.inner.process(duration, buf, area);
                self.timer.process(overflow?)
            },
        }
    }

    /// Checks if the prolonged effect is done.
    ///
    /// # Returns
    ///
    /// `true` if both the additional duration and inner effect are done, `false`
    /// otherwise.
    fn done(&self) -> bool {
        self.timer.done() && self.inner.done()
    }

    fn clone_box(&self) -> Box<dyn Shader> {
        Box::new(self.clone())
    }

    fn area(&self) -> Option<Rect> {
        self.inner.area()
    }

    fn set_area(&mut self, area: Rect) {
        self.inner.set_area(area);
    }

    fn filter(&mut self, strategy: CellFilter) {
        self.inner.filter(strategy);
    }

    fn set_color_space(&mut self, color_space: ColorSpace) {
        self.inner.set_color_space(color_space);
    }

    fn color_space(&self) -> ColorSpace {
        self.inner.color_space()
    }

    /// Returns the total duration of the prolonged effect.
    ///
    /// # Returns
    ///
    /// An `EffectTimer` representing the sum of the additional duration and the inner
    /// effect's duration.
    fn timer(&self) -> Option<EffectTimer> {
        let self_duration = self.timer.duration();
        let inner_duration = self.inner.timer().unwrap_or_default().duration();

        Some(EffectTimer::new(self_duration + inner_duration, Linear))
    }

    fn cell_filter(&self) -> Option<&CellFilter> {
        self.inner.cell_filter()
    }

    fn reset(&mut self) {
        self.timer.reset();
        self.inner.reset();
    }

    #[cfg(feature = "dsl")]
    fn to_dsl(&self) -> Result<crate::dsl::EffectExpression, crate::dsl::DslError> {
        use crate::dsl::{DslFormat, EffectExpression};

        EffectExpression::parse(&format!(
            "fx::{}({}, {})",
            self.name(),
            self.timer.dsl_format(),
            self.inner.to_dsl()?
        ))
    }
}

#[cfg(test)]
#[cfg(feature = "dsl")]
mod tests {
    use indoc::indoc;

    use crate::{fx, fx::consume_tick};

    #[test]
    fn to_dsl_prolong_start() {
        let dsl = fx::prolong_start(100, consume_tick())
            .to_dsl()
            .unwrap()
            .to_string();

        assert_eq!(dsl, indoc! {
            "fx::prolong_start(EffectTimer::from_ms(100, Interpolation::Linear), fx::consume_tick())"
        });
    }

    #[test]
    fn to_dsl_prolong_end() {
        let dsl = fx::prolong_end(100, consume_tick())
            .to_dsl()
            .unwrap()
            .to_string();

        assert_eq!(dsl, indoc! {
            "fx::prolong_end(EffectTimer::from_ms(100, Interpolation::Linear), fx::consume_tick())"
        });
    }
}