libshimmer 0.2.2

Animated status lines for terminal UIs, paced by the host's work
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

//! The preview script: a canned bout and the rest after it, playing in a loop, with which a picker
//! previews a recipe.
//!
//! The bout is the design swatches' cycle. The host works under three captions, then waits on a
//! background terminal, whose output arrives as the wait ends and drains as a [`Reservoir`]
//! drains it. Then it rests, so that the preview shows the recipe between bouts too.
//!
//! [`Reservoir`]: crate::Reservoir

use std::time::Duration;

use crate::reservoir::DRAIN;
use crate::shimmer::QUANTA;
use crate::{Intensity, Spell};

/// What the host does during a segment, in units that count as quanta up to brisk work.
#[derive(Clone, Copy)]
enum Work {
    /// It produces `rate` units a second.
    Busy { rate: f64 },
    /// It waits on a terminal, whose output of `lump` units arrives as the wait ends.
    Wait { lump: f64 },
    /// It rests between bouts.
    Idle,
}

struct Segment {
    caption: &'static str,
    /// Seconds.
    length: f64,
    work: Work,
}

static CYCLE: [Segment; 5] = [
    Segment {
        caption: "Working",
        length: 2.5,
        work: Work::Busy { rate: 60.0 },
    },
    Segment {
        caption: "Tracing shimmer cadence",
        length: 3.5,
        work: Work::Busy { rate: 80.0 },
    },
    Segment {
        caption: "Drafting the fix",
        length: 4.0,
        work: Work::Busy { rate: 50.0 },
    },
    Segment {
        caption: "Waiting for background terminal",
        length: 7.0,
        work: Work::Wait { lump: 600.0 },
    },
    Segment {
        caption: "Finished",
        length: 3.0,
        work: Work::Idle,
    },
];

/// Seconds in one cycle.
fn length() -> f64 {
    CYCLE.iter().map(|segment| segment.length).sum()
}

/// The segment under way `t` seconds into a cycle.
fn segment(t: f64) -> &'static Segment {
    let mut end = 0.0;
    for segment in &CYCLE[..CYCLE.len() - 1] {
        end += segment.length;
        if t < end {
            return segment;
        }
    }
    &CYCLE[CYCLE.len() - 1]
}

/// Units a second arriving `t` seconds into a cycle: the host's own output while it works, and
/// every lump draining.
fn inflow(t: f64) -> f64 {
    let length = length();
    // A lump drains on through later cycles, so each cycle meets every earlier one's remainder.
    let echoes = 1.0 / -(-length / DRAIN).exp_m1();
    let mut end = 0.0;
    let mut drained = 0.0;
    for segment in &CYCLE {
        end += segment.length;
        if let Work::Wait { lump } = segment.work {
            drained += lump / DRAIN * (-(t - end).rem_euclid(length) / DRAIN).exp() * echoes;
        }
    }
    match segment(t).work {
        Work::Busy { rate } => rate + drained,
        Work::Wait { .. } | Work::Idle => drained,
    }
}

/// What the script commands at one moment.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Cue {
    /// The spell to cast.
    pub spell: Spell,
    /// The caption to show.
    pub caption: &'static str,
    /// The intensity to set.
    pub intensity: Intensity,
}

/// The cue `at` into the looping script.
pub fn cue(at: Duration) -> Cue {
    let t = at.as_secs_f64() % length();
    let segment = segment(t);
    Cue {
        spell: match segment.work {
            Work::Busy { .. } => Spell::Busy,
            Work::Wait { .. } => Spell::Wait,
            Work::Idle => Spell::Idle,
        },
        caption: segment.caption,
        intensity: Intensity::new(inflow(t) / QUANTA),
    }
}