osui 0.2.0

A TUI library for advanced uis
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

//! # Console Engine Implementation
//!
//! Provides a Console implementation of the Engine trait for rendering
//! to the terminal using crossterm.

use std::{
    io::{stdout, Write},
    sync::{Arc, Mutex},
};

use crossterm::{cursor::MoveTo, execute, terminal::Clear};

use crate::component::{context::Context, ComponentImpl};
use crate::{
    engine::{commands, CommandExecutor},
    render::Area,
    DrawContext, View,
};

use super::Engine;

/// Executes commands for the console engine
pub struct ConsoleExecutor {
    /// Flag indicating whether the application is running
    running: Mutex<bool>,
}

/// Console-based rendering engine
/// 
/// Renders components to the terminal using crossterm for cross-platform support.
pub struct Console {
    /// Thread functions to execute
    threads: Mutex<Vec<Arc<dyn Fn(Arc<Context>) + Send + Sync>>>,
    /// The executor for this console
    executor: Arc<ConsoleExecutor>,
}

impl Console {
    /// Creates a new console engine
    pub fn new() -> Self {
        Self {
            threads: Mutex::new(Vec::new()),
            executor: Arc::new(ConsoleExecutor {
                running: Mutex::new(true),
            }),
        }
    }

    /// Registers a thread function to run alongside the engine
    pub fn thread<F: Fn(Arc<Context>) + Send + Sync + 'static>(&self, run: F) {
        self.threads.lock().unwrap().push(Arc::new(run));
    }
}

impl Engine for Console {
    fn render_view(&self, area: &Area, view: &View) -> DrawContext {
        let mut context = DrawContext::new(area.clone());
        view(&mut context);
        context
    }

    fn draw_context(&self, ctx: &DrawContext) {
        for inst in &ctx.drawing {
            match inst {
                crate::render::DrawInstruction::Text(point, text) => {
                    let (x, y) = (ctx.area.x + point.x, ctx.area.y + point.y);
                    execute!(stdout(), MoveTo(x, y),).unwrap();
                    print!("{text}");
                    stdout().flush().unwrap();
                }
                crate::render::DrawInstruction::Child(_point, child) => self.draw_context(child),
                crate::render::DrawInstruction::View(area, view) => {
                    self.draw_context(&self.render_view(area, view))
                }
            }
        }
    }

    fn render(&self, cx: &Arc<Context>) {
        let (width, height) = crossterm::terminal::size().unwrap();

        execute!(stdout(), Clear(crossterm::terminal::ClearType::Purge)).unwrap();
        execute!(stdout(), Clear(crossterm::terminal::ClearType::All)).unwrap();

        self.draw_context(&self.render_view(
            &Area {
                x: 0,
                y: 0,
                width,
                height,
            },
            &cx.get_view(),
        ));
    }

    fn init<C: ComponentImpl + 'static>(&self, component: C) -> Arc<Context> {
        crossterm::execute!(std::io::stdout(), crossterm::cursor::Hide).unwrap();

        let cx = Context::new(component, self.executor.clone());
        cx.refresh();

        for thread in self.threads.lock().unwrap().iter() {
            let thread = thread.clone();

            std::thread::spawn({
                let cx = cx.clone();
                move || thread(cx)
            });
        }

        cx
    }

    fn executor(&self) -> Arc<dyn super::CommandExecutor> {
        self.executor.clone()
    }

    fn run<F: ComponentImpl + 'static>(&self, component: F) -> crate::Result<()> {
        let cx = self.init(component);

        while self.executor.is_running() {
            self.render(&cx);
            self.render_delay();
        }

        Ok(())
    }
}

impl ConsoleExecutor {
    /// Checks if the engine is still running
    pub fn is_running(self: &Arc<ConsoleExecutor>) -> bool {
        *self.running.lock().unwrap()
    }

    /// Stops the engine
    pub fn stop(&self) -> crate::Result<()> {
        *self.running.lock()? = false;
        Ok(())
    }
}

impl CommandExecutor for ConsoleExecutor {
    fn execute_command(&self, command: &Arc<dyn super::Command>) -> crate::Result<()> {
        let command = command.as_any();

        if let Some(commands::Stop) = command.downcast_ref() {
            self.stop()?;
        }

        Ok(())
    }
}