duat-term 0.10.0

A frontend for Duat for the terminal
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
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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
use duat_core::ui::{Axis, SpawnId};
use kasuari::{AddConstraintError, Expression, RemoveConstraintError, Solver, Variable};

use super::VarPoint;
use crate::{DYN_SPAWN_POS_PRIO, Equality, SPAWN_DIMS_PRIO, area::Coord, layout::Frame};

/// A synchronization wrapper around the kasuari constraint
/// [`Solver`]
pub struct SyncSolver {
    solver: Solver,
    eqs_to_add: Vec<Equality>,
    eqs_to_remove: Vec<Equality>,
    spawns: Vec<Spawn>,
}

impl SyncSolver {
    /// Returns a new `SyncSolver`
    ///
    /// The `SyncSolver` is responsible for efficiently adding and
    /// removing equalities from the internal kasuari constraint
    /// [`Solver`], updating only once requested.
    pub fn new(max: VarPoint, width: f64, height: f64) -> Self {
        let mut solver = Solver::new();
        let strength = kasuari::Strength::STRONG;
        solver.add_edit_variable(max.x(), strength).unwrap();
        solver.suggest_value(max.x(), width).unwrap();

        solver.add_edit_variable(max.y(), strength).unwrap();
        solver.suggest_value(max.y(), height).unwrap();

        SyncSolver {
            solver,
            eqs_to_add: Vec::new(),
            eqs_to_remove: Vec::new(),
            spawns: Vec::new(),
        }
    }

    /// Adds and removes remaining equalities and fetches changes
    ///
    /// This function will also internally update the floating widgets
    /// by suggesting new valid values for them, possibly making them
    /// switch sides from their spawned regions.
    pub fn update(
        &mut self,
        change_max: bool,
        max: VarPoint,
        mut assign_floating: bool,
    ) -> Result<Vec<(Variable, f64)>, AddConstraintError> {
        for eq in self.eqs_to_remove.drain(..) {
            match self.solver.remove_constraint(&eq) {
                Ok(_) | Err(RemoveConstraintError::UnknownConstraint) => {}
                Err(err) => panic!("{err:?}"),
            }
        }
        self.solver.add_constraints(self.eqs_to_add.drain(..))?;

        if change_max {
            let (width, height) = crossterm::terminal::size().unwrap();
            let (width, height) = (width as f64, height as f64);

            self.solver.suggest_value(max.x(), width).unwrap();
            self.solver.suggest_value(max.y(), height).unwrap();
        }

        let mut changes = Vec::new();
        let mut new_changes = self.solver.fetch_changes().to_vec();

        // Update the spawned Widgets
        loop {
            let mut to_update = self
                .spawns
                .iter()
                .filter(|spawn| {
                    new_changes.iter().any(|(var, _)| spawn.deps.contains(*var)) || assign_floating
                })
                .peekable();

            if to_update.peek().is_none() {
                changes.extend(new_changes);
                break;
            }

            for spawn in to_update {
                let max = match spawn.axis {
                    Axis::Horizontal => self.solver.get_value(max.x),
                    Axis::Vertical => self.solver.get_value(max.y),
                };
                let [lhs, rhs] = spawn.deps.get_values(&self.solver);
                let [lhs_frame, rhs_frame] = spawn.frame.map(|show| show as usize as f64);

                let [lhs_dist_from_parent, rhs_dist_from_parent] = {
                    let [parent_lhs, parent_rhs] = spawn.parent_frame.map(|show| show as usize);
                    [rhs_frame + parent_lhs as f64, lhs_frame + parent_rhs as f64]
                };

                let lhs_outside_len = lhs_dist_from_parent + lhs_frame;
                let rhs_outside_len = rhs_dist_from_parent + rhs_frame;

                if spawn.is_inside {
                    let inside_len = rhs - lhs - (lhs_frame + rhs_frame);
                    let len = spawn.desired_len.unwrap_or(inside_len).min(inside_len);

                    self.solver.suggest_value(spawn.len_var, len).unwrap();
                    let c = if spawn.prefers_before {
                        lhs_frame + lhs + len / 2.0
                    } else {
                        rhs - (rhs_frame + len / 2.0)
                    };
                    self.solver.suggest_value(spawn.center_var, c).unwrap();
                } else if let Some(len) = spawn.desired_len
                    && (lhs >= len + lhs_outside_len || max - rhs >= len + rhs_outside_len)
                {
                    match (
                        spawn.prefers_before,
                        lhs >= len + lhs_outside_len,
                        max - rhs >= len + rhs_outside_len,
                    ) {
                        (true, true, true | false) | (false, true, false) => {
                            self.solver.suggest_value(spawn.len_var, len).unwrap();
                            self.solver
                                .suggest_value(
                                    spawn.center_var,
                                    lhs - (lhs_dist_from_parent + len / 2.0),
                                )
                                .unwrap();
                        }
                        (true, false, true) | (false, true | false, true) => {
                            self.solver.suggest_value(spawn.len_var, len).unwrap();
                            self.solver
                                .suggest_value(
                                    spawn.center_var,
                                    rhs + (rhs_dist_from_parent + len / 2.0),
                                )
                                .unwrap();
                        }
                        (true | false, false, false) => unreachable!(),
                    };
                } else if lhs <= lhs_outside_len && max - rhs <= rhs_outside_len {
                    self.solver.suggest_value(spawn.len_var, 0.0).unwrap();
                    self.solver.suggest_value(spawn.center_var, 0.0).unwrap();
                } else {
                    let (center, outside_len) = if lhs > max - rhs {
                        (lhs_frame + (lhs - lhs_outside_len) / 2.0, lhs_outside_len)
                    } else {
                        let center =
                            rhs_dist_from_parent + rhs + (max - rhs - rhs_outside_len) / 2.0;
                        (center, rhs_outside_len)
                    };

                    self.solver
                        .suggest_value(spawn.len_var, lhs.max(max - rhs) - outside_len)
                        .unwrap();
                    self.solver.suggest_value(spawn.center_var, center).unwrap();
                }
            }

            assign_floating = false;
            changes.append(&mut new_changes);
            new_changes = self.solver.fetch_changes().to_vec();
        }

        Ok(changes)
    }

    /// Adds equalities to the `SyncSolver`
    pub fn add_eqs(&mut self, eqs: impl IntoIterator<Item = Equality>) {
        self.eqs_to_add.extend(eqs);
    }

    /// Removes equalities from the `SyncSolver`
    pub fn remove_eqs(&mut self, eqs: impl IntoIterator<Item = Equality>) {
        let eqs: Vec<Equality> = eqs.into_iter().collect();
        if self.eqs_to_add.extract_if(.., |e| eqs.contains(e)).count() == 0 {
            self.eqs_to_remove.extend(eqs);
        }
    }

    /// Sets the [`Frame`] for a [`SpawnId`]
    pub fn set_frame(&mut self, id: SpawnId, frame: &Frame, parent_frame: Option<&Frame>) {
        let Some(spawn) = self.spawns.iter_mut().find(|spawn| spawn.id == id) else {
            return;
        };

        match spawn.axis {
            Axis::Horizontal => spawn.frame = [frame.left, frame.right],
            Axis::Vertical => spawn.frame = [frame.above, frame.below],
        }

        if let Some(parent_frame) = parent_frame {
            match spawn.axis {
                Axis::Horizontal => spawn.parent_frame = [parent_frame.left, parent_frame.right],
                Axis::Vertical => spawn.parent_frame = [parent_frame.above, parent_frame.below],
            }
        }
    }

    /// Creates a new center for a widget spawned widget
    ///
    /// Returns the center variable for this new widget and the lenght
    /// for said widget in the given axis, respectively
    pub fn new_widget_spawn(
        &mut self,
        spawn_id: SpawnId,
        variables: &mut super::variables::Variables,
        [tl, br]: [VarPoint; 2],
        (len, axis): (Option<f32>, Axis),
        (prefers_before, is_inside): (bool, bool),
        parent_frame: Option<&Frame>,
    ) -> [Variable; 2] {
        let center_var = variables.new_var();
        let len_var = variables.new_var();

        self.solver
            .add_edit_variable(center_var, SPAWN_DIMS_PRIO)
            .unwrap();
        self.solver
            .add_edit_variable(len_var, SPAWN_DIMS_PRIO)
            .unwrap();

        self.spawns.push(Spawn {
            id: spawn_id,
            center_var,
            len_var,
            desired_len: len.map(|len| len as f64),
            deps: CenterDeps::Widget(tl, br, axis),
            axis,
            prefers_before,
            is_inside,
            frame: [false; 2],
            parent_frame: parent_frame
                .map(|frame| match axis {
                    Axis::Horizontal => [frame.left, frame.right],
                    Axis::Vertical => [frame.above, frame.below],
                })
                .unwrap_or_default(),
        });

        [center_var, len_var]
    }

    /// Creates a new center for a text spawned widget
    ///
    /// Returns the center variable for this new widget and the lenght
    /// for said widget in the given axis, respectively. Also returns
    /// the [`VarPoint`] representing the top left corner of a
    /// terminal cell.
    pub fn new_text_spawn(
        &mut self,
        spawn_id: SpawnId,
        variables: &mut super::variables::Variables,
        len: Option<f32>,
        axis: Axis,
        prefers_before: bool,
    ) -> ([Variable; 2], VarPoint) {
        let center_var = variables.new_var();
        let len_var = variables.new_var();

        self.solver
            .add_edit_variable(center_var, SPAWN_DIMS_PRIO)
            .unwrap();
        self.solver
            .add_edit_variable(len_var, SPAWN_DIMS_PRIO)
            .unwrap();

        let tl = VarPoint::new(variables.new_var(), variables.new_var());
        self.solver
            .add_edit_variable(tl.x, DYN_SPAWN_POS_PRIO)
            .unwrap();
        self.solver
            .add_edit_variable(tl.y, DYN_SPAWN_POS_PRIO)
            .unwrap();

        self.spawns.push(Spawn {
            id: spawn_id,
            center_var,
            len_var,
            desired_len: len.map(|len| len as f64),
            deps: match axis {
                Axis::Horizontal => CenterDeps::TextHorizontal(tl, None),
                Axis::Vertical => CenterDeps::TextVertical(tl),
            },
            axis,
            prefers_before,
            is_inside: false,
            frame: [false; 2],
            parent_frame: [false; 2],
        });

        ([center_var, len_var], tl)
    }

    /// Moves the spawn point of a [`SpawnId`]
    ///
    /// The `char_width` argument is used to determine where the right
    /// edge lies. It's ignored for vertically spawned widgets
    pub fn move_spawn_to(&mut self, id: SpawnId, coord: Coord, char_width: u32) {
        let Some(center) = self.spawns.iter_mut().find(|spawn| spawn.id == id) else {
            unreachable!("Whoopsie Daisy, that's not supposed to happen.");
        };

        match center.deps {
            CenterDeps::Widget(..) => unreachable!(),
            CenterDeps::TextHorizontal(tl, ref mut len) => {
                self.solver.suggest_value(tl.x, coord.x as f64).unwrap();
                self.solver.suggest_value(tl.y, coord.y as f64).unwrap();
                *len = Some(char_width)
            }
            CenterDeps::TextVertical(tl) => {
                self.solver.suggest_value(tl.x, coord.x as f64).unwrap();
                self.solver.suggest_value(tl.y, coord.y as f64).unwrap();
            }
        }
    }

    /// Removes the spawn info associated with a [`SpawnId`]
    ///
    /// Returns all edit variables.
    pub fn remove_spawn_info(&mut self, id: SpawnId) -> Option<ReturnedEditVars> {
        self.spawns
            .extract_if(.., |spawn| spawn.id == id)
            .next()
            .map(|c| {
                self.solver.remove_edit_variable(c.center_var).unwrap();
                self.solver.remove_edit_variable(c.len_var).unwrap();
                if let CenterDeps::TextHorizontal(tl, _) | CenterDeps::TextVertical(tl) = c.deps {
                    self.solver.remove_edit_variable(tl.x).unwrap();
                    self.solver.remove_edit_variable(tl.y).unwrap();
                    ReturnedEditVars::TextSpawned([c.center_var, c.len_var, tl.x, tl.y])
                } else {
                    ReturnedEditVars::WidgetSpawned([c.center_var, c.len_var])
                }
            })
    }

    /// Returns the spawn info associated with a [`SpawnId`]
    ///
    /// This info consists of the following:
    ///
    /// - The `center` and `len` variables
    /// - The top left corner of the spawn target
    /// - The bottom right corner of the spawn target
    pub fn get_spawn_info(
        &self,
        id: SpawnId,
    ) -> Option<([Variable; 2], [Expression; 2], [Expression; 2])> {
        self.spawns
            .iter()
            .find(|spawn| spawn.id == id)
            .map(|center| {
                let (tl, br) = match center.deps {
                    CenterDeps::Widget(tl, br, _) => (tl, [br.x().into(), br.y().into()]),
                    CenterDeps::TextHorizontal(tl, char_width) => {
                        let width = char_width.unwrap_or(1);
                        (tl, [tl.x() + width as f32, tl.y() + 1.0])
                    }
                    CenterDeps::TextVertical(tl) => (tl, [tl.x() + 1.0, tl.y() + 1.0]),
                };

                (
                    [center.center_var, center.len_var],
                    [tl.x().into(), tl.y().into()],
                    br,
                )
            })
    }

    /// Sets the new desired length for a [`SpawnId`]
    pub fn set_spawn_len(&mut self, id: SpawnId, desired_len: Option<f64>) {
        let Some(center) = self.spawns.iter_mut().find(|spawn| spawn.id == id) else {
            unreachable!(
                "This should only be called when it is known that the Spawn still exists."
            );
        };

        center.desired_len = desired_len;
    }
}

/// Represents the "center" of a floaging [`Rect`]
///
/// This makes use of an edit [`Variable`], allowing for
/// dinamically positioned floating [`Rect`]s.
///
/// [`Rect`]: super::Rect
struct Spawn {
    id: SpawnId,
    center_var: Variable,
    len_var: Variable,
    desired_len: Option<f64>,
    deps: CenterDeps,
    axis: Axis,
    prefers_before: bool,
    is_inside: bool,
    frame: [bool; 2],
    parent_frame: [bool; 2],
}

/// What kind of dependency a [`SpawnedCenter`] has
enum CenterDeps {
    Widget(VarPoint, VarPoint, Axis),
    TextHorizontal(VarPoint, Option<u32>),
    TextVertical(VarPoint),
}

impl CenterDeps {
    /// The current value of the edges that define a [`SpawnedCenter`]
    fn get_values(&self, solver: &Solver) -> [f64; 2] {
        match *self {
            CenterDeps::Widget(tl, br, axis) => [tl, br].map(|v| solver.get_value(v.on(axis))),
            CenterDeps::TextHorizontal(tl, len) => {
                let left = solver.get_value(tl.x);
                [left, left + len.unwrap_or(1) as f64]
            }
            CenterDeps::TextVertical(tl) => {
                let top = solver.get_value(tl.y);
                [top, top + 1.0]
            }
        }
    }

    /// Wether the dependencies contain a certain [`Variable`]
    fn contains(&self, var: Variable) -> bool {
        match *self {
            CenterDeps::Widget(tl, br, axis) => tl.on(axis) == var || br.on(axis) == var,
            CenterDeps::TextHorizontal(tl, _) => tl.x == var,
            CenterDeps::TextVertical(tl) => tl.y == var,
        }
    }
}

pub enum ReturnedEditVars {
    WidgetSpawned([Variable; 2]),
    TextSpawned([Variable; 4]),
}