Merge pull request 'widget-focus' (#4) from widget-focus into master

Reviewed-on: #4

.gitea/workflows/build.yaml

@@ -0,0 +1,25 @@
+name: Build
+on: [push]
+
+jobs:
+  Build:
+    env:
+      RUNNER_TOOL_CACHE: /toolcache
+    container: rust:alpine
+    steps:
+      - name: Install node
+        run: apk add nodejs gcc libc-dev pkgconf libx11-dev alsa-lib-dev eudev-dev tar
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Restore cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Build
+        run: cargo build --release

.gitignore

@@ -1 +1,3 @@
 /target
+Cargo.lock
+.cargo

Cargo.toml

@@ -1,17 +1,21 @@
 [package]
 name = "bevy_terminal_display"
-version = "0.6.0"
+version = "0.7.0"
 edition = "2021"
 license = "0BSD OR MIT OR Apache-2.0"
 description = "A plugin for the Bevy game engine which enables rendering to a terminal using unicode braille characters."
-repository = "https://git.exvacuum.dev/bevy_terminal_display"
+repository = "https://git.soaos.dev/soaos/bevy_terminal_display"
+
+[profile.dev]
+opt-level = 1
+
+[profile.dev.package."*"]
+opt-level = 2
 
 [dependencies]
 crossbeam-channel = "0.5"
-downcast-rs = "1.2"
+downcast-rs = "2.0"
 once_cell = "1.19"
-bevy_headless_render = "0.2"
-bevy_dither_post_process = "0.3"
 ratatui = "0.29"
 color-eyre = "0.6"
 leafwing-input-manager = "0.16"
@@ -26,3 +30,11 @@ features = ["bevy_render"]
 [dependencies.crossterm]
 version = "0.28"
 features = ["serde"]
+
+# SOAOS DEPS
+
+[dependencies.bevy_dither_post_process]
+version = "0.3"
+
+[dependencies.bevy_headless_render]
+version = "0.2"

README.md

@@ -2,8 +2,6 @@
 
 [![Crates](https://img.shields.io/crates/v/bevy_terminal_display)](https://crates.io/crates/bevy_terminal_display)
 ![License](https://img.shields.io/badge/license-0BSD%2FMIT%2FApache-blue.svg)
-![Tag](https://img.shields.io/github/v/tag/exvacuum/bevy_terminal_display)
-[![Docs](https://img.shields.io/website?url=https%3A%2F%2Fexvacuum.github.io%2Fbevy_terminal_display%2F&label=docs)](https://exvacuum.github.io/bevy_terminal_display)
 
 A (very experimental) plugin for the [Bevy](https://bevyengine.org) engine which allows for rendering to a terminal window.
 
@@ -19,12 +17,12 @@ Features Include:
 - Log redirection
 
 ## Screenshots
-![](https://git.exvacuum.dev/bevy_terminal_display/plain/doc/screenshot.png)
+![](doc/screenshot.png)
 ## Compatibility
 
 | Crate Version | Bevy Version |
 | ------------- | ------------ |
-| 0.6           | 0.15         |
+| 0.6-0.7       | 0.15         |
 | 0.4           | 0.14         |
 | 0.2           | 0.13         |
 
@@ -33,13 +31,13 @@ Features Include:
 ### crates.io
 ```toml
 [dependencies]
-bevy_terminal_display = "0.5"
+bevy_terminal_display = "0.7"
 ```
 
 ### Using git URL in Cargo.toml
 ```toml
 [dependencies.bevy_terminal_display]
-git = "https://git.exvacuum.dev/bevy_terminal_display"
+git = "https://git.soaos.dev/soaos/bevy_terminal_display"
 ```
 
 ## Example Usage

src/display/components.rs

@@ -1,8 +1,5 @@
 use bevy::{
-    ecs::{
-        component::ComponentId,
-        world::DeferredWorld,
-    },
+    ecs::{component::ComponentId, world::DeferredWorld},
     prelude::*,
     render::render_resource::{
         Extent3d, TextureDescriptor, TextureDimension, TextureFormat, TextureUsages,
@@ -10,15 +7,40 @@ use bevy::{
 };
 use bevy_dither_post_process::components::DitherPostProcessSettings;
 use bevy_headless_render::components::HeadlessRenderSource;
+use ratatui::style::Style;
+
+// TODO: MULTIPLE WINDOWS (probably behind feature flag)
+// INFO: need abstraction for launching terminal emulators
+//
+// /// Structure to refer to a terminal window entity
+// #[derive(Clone, Debug)]
+// pub enum TerminalWindowRef {
+//     /// Refers to the primary window created by default in the terminal the command is run in
+//     Primary,
+//     /// Direct reference to an terminal window entity
+//     Entity(Entity),
+// }
+//
+// #[derive(Component, Debug)]
+// pub struct TerminalWindow;
 
 /// Marker component for terminal display
 #[derive(Component, Debug)]
 #[component(on_add = on_add_terminal_display)]
-pub struct TerminalDisplay(pub u32);
+pub struct TerminalDisplay {
+    /// Level of dithering performed on image
+    pub dither_level: u32,
+    /// Style applied to rendered text
+    pub style: Style,
+}
 
 fn on_add_terminal_display(mut world: DeferredWorld, entity: Entity, _id: ComponentId) {
     let asset_server = world.get_resource::<AssetServer>().unwrap();
-    let dither_level = world.entity(entity).get::<TerminalDisplay>().unwrap().0;
+    let dither_level = world
+        .entity(entity)
+        .get::<TerminalDisplay>()
+        .unwrap()
+        .dither_level;
 
     let terminal_size = crossterm::terminal::size().unwrap();
     let size = Extent3d {
@@ -46,17 +68,19 @@ fn on_add_terminal_display(mut world: DeferredWorld, entity: Entity, _id: Compon
     image.resize(size);
     let image_handle = asset_server.add(image);
 
-    let headless_render_source = HeadlessRenderSource::new(&asset_server, image_handle.clone());
-    let post_process_settings = DitherPostProcessSettings::new(dither_level, &asset_server);
+    let headless_render_source = HeadlessRenderSource::new(asset_server, image_handle.clone());
+    let post_process_settings = DitherPostProcessSettings::new(dither_level, asset_server);
     world
         .commands()
         .entity(entity)
         .insert((headless_render_source, post_process_settings));
-    if let Some(mut camera) =  world.entity_mut(entity).get_mut::<Camera>() {
+    if let Some(mut camera) = world.entity_mut(entity).get_mut::<Camera>() {
         camera.target = image_handle.into();
     } else {
         world.commands().entity(entity).insert(Camera {
             target: image_handle.into(),
+            hdr: true,
+            clear_color: ClearColorConfig::Custom(Color::LinearRgba(LinearRgba::BLACK)),
             ..Default::default()
         });
     }

src/display/resources.rs

@@ -20,9 +20,7 @@ impl Default for Terminal {
         stdout().execute(EnterAlternateScreen).unwrap();
         stdout().execute(EnableMouseCapture).unwrap();
         stdout()
-            .execute(PushKeyboardEnhancementFlags(
-                KeyboardEnhancementFlags::REPORT_EVENT_TYPES,
-            ))
+            .execute(PushKeyboardEnhancementFlags(KeyboardEnhancementFlags::all()))
             .unwrap();
         enable_raw_mode().unwrap();
         let mut terminal = ratatui::Terminal::new(CrosstermBackend::new(stdout()))

src/display/systems.rs

@@ -2,16 +2,15 @@ use bevy::{
     prelude::*,
     render::render_resource::{Extent3d, TextureFormat},
 };
-use bevy_headless_render::{components::HeadlessRenderDestination, render_assets::HeadlessRenderSource};
-use crossterm::event::Event;
-use ratatui::{
-    style::Stylize,
-    widgets::{Paragraph, Wrap},
+use bevy_headless_render::{
+    components::HeadlessRenderDestination, render_assets::HeadlessRenderSource,
 };
+use crossterm::event::Event;
+use ratatui::widgets::{Paragraph, Wrap};
 
 use crate::{input::events::TerminalInputEvent, widgets::components::Widget};
 
-use super::resources::Terminal;
+use super::{components::TerminalDisplay, resources::Terminal};
 
 const BRAILLE_CODE_MIN: u16 = 0x2800;
 const BRAILLE_CODE_MAX: u16 = 0x28FF;
@@ -25,11 +24,13 @@ const BRAILLE_DOT_BIT_POSITIONS: [u8; 8] = [0, 1, 2, 6, 3, 4, 5, 7];
 /// Prints out the contents of a render image to the terminal as braille characters
 pub fn print_to_terminal(
     mut terminal: ResMut<Terminal>,
-    image_exports: Query<&HeadlessRenderDestination>,
+    image_exports: Query<(&TerminalDisplay, &HeadlessRenderDestination)>,
     mut widgets: Query<&mut Widget>,
 ) {
-    for image_export in image_exports.iter() {
-        let mut image = image_export
+    let display = image_exports.get_single();
+    let mut output_buffer = Vec::<char>::new();
+    if let Ok((_, image)) = display {
+        let mut image = image
             .0
             .lock()
             .expect("Failed to get lock on output texture");
@@ -44,7 +45,6 @@ pub fn print_to_terminal(
             };
         }
 
-        let mut output_buffer = Vec::<char>::new();
         let width = image.width();
         let height = image.height();
         let data = &image.data;
@@ -64,29 +64,31 @@ pub fn print_to_terminal(
                 output_buffer.push(braille_char(mask));
             }
         }
+    }
 
-        let string = output_buffer.into_iter().collect::<String>();
-        terminal
-            .0
-            .draw(|frame| {
+    let string = output_buffer.into_iter().collect::<String>();
+    terminal
+        .0
+        .draw(|frame| {
+            if !string.is_empty() {
                 frame.render_widget(
                     Paragraph::new(string)
-                        .white()
+                        .style(display.unwrap().0.style)
                         .wrap(Wrap { trim: true }),
                     frame.area(),
                 );
+            }
 
-                let mut active_widgets = widgets
-                    .iter_mut()
-                    .filter(|widget| widget.enabled)
-                    .collect::<Vec<_>>();
-                active_widgets.sort_by(|a, b| a.depth.cmp(&b.depth));
-                for mut widget in active_widgets {
-                    widget.widget.render(frame, frame.area());
-                }
-            })
-            .expect("Failed to draw terminal frame");
-    }
+            let mut active_widgets = widgets
+                .iter_mut()
+                .filter(|widget| widget.enabled)
+                .collect::<Vec<_>>();
+            active_widgets.sort_by(|a, b| a.depth.cmp(&b.depth));
+            for mut widget in active_widgets {
+                widget.widget.render(frame, frame.area());
+            }
+        })
+        .expect("Failed to draw terminal frame");
 }
 
 /// Utility function to convert a u8 into the corresponding braille character

src/input/systems.rs

@@ -7,11 +7,7 @@ use bevy::{
 use crossterm::event::{read, Event, KeyEvent, KeyEventKind, MediaKeyCode, ModifierKeyCode};
 use smol_str::SmolStr;
 
-use super::{
-    components::DummyWindow,
-    events::TerminalInputEvent,
-    resources::EventQueue,
-};
+use super::{components::DummyWindow, events::TerminalInputEvent, resources::EventQueue};
 
 /// Initializes event queue and thread
 pub fn setup_input(mut commands: Commands, event_queue: Res<EventQueue>) {
@@ -294,7 +290,7 @@ fn crossterm_keycode_to_bevy_key(
             35 => Some(BKey::F35),
             _ => None,
         },
-        CKey::Char(c) => Some(BKey::Character(SmolStr::from(c.encode_utf8(&mut [0;4])))),
+        CKey::Char(c) => Some(BKey::Character(SmolStr::from(c.encode_utf8(&mut [0; 4])))),
         CKey::Null => None,
         CKey::Esc => Some(BKey::Escape),
         CKey::CapsLock => Some(BKey::CapsLock),

src/lib.rs

@@ -3,22 +3,29 @@
 //! Bevy plugin which allows a camera to render to a terminal window.
 
 use std::{
-    fs::OpenOptions, io::{stdout, Write}, path::PathBuf, sync::{Arc, Mutex}
+    fs::OpenOptions,
+    io::{stdout, Write},
+    path::PathBuf,
 };
 
 use bevy::{
     log::{
         tracing_subscriber::{self, layer::SubscriberExt, EnvFilter, Layer, Registry},
         Level,
-    }, prelude::*, utils::tracing::subscriber,
+    },
+    prelude::*,
+    utils::tracing::subscriber,
 };
 use bevy_dither_post_process::DitherPostProcessPlugin;
 
 use bevy_headless_render::HeadlessRenderPlugin;
 use color_eyre::config::HookBuilder;
 pub use crossterm;
-use crossterm::{event::{DisableMouseCapture, PopKeyboardEnhancementFlags}, terminal::{disable_raw_mode, LeaveAlternateScreen}, ExecutableCommand};
-use once_cell::sync::Lazy;
+use crossterm::{
+    event::{DisableMouseCapture, PopKeyboardEnhancementFlags},
+    terminal::{disable_raw_mode, LeaveAlternateScreen},
+    ExecutableCommand,
+};
 pub use ratatui;
 
 /// Functions and types related to capture and display of world to terminal
@@ -30,8 +37,6 @@ pub mod input;
 /// Functions and types related to constructing and rendering TUI widgets
 pub mod widgets;
 
-static LOG_PATH: Lazy<Arc<Mutex<PathBuf>>> = Lazy::new(|| Arc::new(Mutex::new(PathBuf::default())));
-
 /// Plugin providing terminal display functionality
 pub struct TerminalDisplayPlugin {
     /// Path to redirect tracing logs to. Defaults to "debug.log"
@@ -48,23 +53,20 @@ impl Default for TerminalDisplayPlugin {
 
 impl Plugin for TerminalDisplayPlugin {
     fn build(&self, app: &mut App) {
-        *LOG_PATH
-            .lock()
-            .expect("Failed to get lock on log path mutex") = self.log_path.clone();
+        let log_path = self.log_path.clone();
         let log_file = OpenOptions::new()
             .write(true)
             .create(true)
             .truncate(true)
-            .open(
-                LOG_PATH
-                    .lock()
-                    .expect("Failed to get lock on log path mutex")
-                    .clone(),
-            )
+            .open(log_path)
             .unwrap();
         let file_layer = tracing_subscriber::fmt::Layer::new()
             .with_writer(log_file)
-            .with_filter(EnvFilter::builder().parse_lossy(format!("{},{}", Level::INFO, "wgpu=error,naga=warn")));
+            .with_filter(EnvFilter::builder().parse_lossy(format!(
+                "{},{}",
+                Level::INFO,
+                "wgpu=error,naga=warn"
+            )));
         let subscriber = Registry::default().with(file_layer);
         subscriber::set_global_default(subscriber).unwrap();
 
@@ -73,43 +75,45 @@ impl Plugin for TerminalDisplayPlugin {
         let error = error.into_eyre_hook();
 
         color_eyre::eyre::set_hook(Box::new(move |e| {
-            let _ = restore_terminal();
+            restore_terminal();
             error(e)
-        })).unwrap();
+        }))
+        .unwrap();
 
         std::panic::set_hook(Box::new(move |info| {
-            let _ = restore_terminal();
+            restore_terminal();
             error!("{info}");
             panic(info);
         }));
 
-        app.add_plugins((
-            DitherPostProcessPlugin,
-            HeadlessRenderPlugin,
-        ))
-        .add_systems(Startup, input::systems::setup_input)
-        .add_systems(
-            Update,
-            (
-                input::systems::input_handling,
-                display::systems::resize_handling,
-                display::systems::print_to_terminal,
-                widgets::systems::widget_input_handling,
-                widgets::systems::update_widgets,
-            ),
-        )
-        .insert_resource(display::resources::Terminal::default())
-        .insert_resource(input::resources::EventQueue::default())
-        .add_event::<input::events::TerminalInputEvent>();
+        app.add_plugins((DitherPostProcessPlugin, HeadlessRenderPlugin))
+            .add_systems(Startup, input::systems::setup_input)
+            .add_systems(
+                Update,
+                (
+                    input::systems::input_handling,
+                    display::systems::resize_handling,
+                    display::systems::print_to_terminal,
+                    widgets::systems::widget_input_handling,
+                    widgets::systems::update_widgets,
+                ),
+            )
+            .insert_resource(display::resources::Terminal::default())
+            .insert_resource(input::resources::EventQueue::default())
+            .init_resource::<widgets::resources::FocusedWidget>()
+            .add_event::<input::events::TerminalInputEvent>();
     }
 }
 
-fn restore_terminal() -> Result<(), Box<dyn std::error::Error>>{
-    disable_raw_mode()?;
+fn restore_terminal() {
+    let _ = disable_raw_mode();
     let mut stdout = stdout();
-    stdout.execute(PopKeyboardEnhancementFlags)?
-        .execute(DisableMouseCapture)?
-        .execute(LeaveAlternateScreen)?
-        .flush()?;
-    Ok(())
+    let _ = stdout
+        .execute(PopKeyboardEnhancementFlags)
+        .unwrap()
+        .execute(DisableMouseCapture)
+        .unwrap()
+        .execute(LeaveAlternateScreen)
+        .unwrap()
+        .flush();
 }

src/widgets/commands.rs

@@ -0,0 +1,23 @@
+use bevy::prelude::*;
+
+use super::resources::FocusedWidget;
+
+struct FocusWidgetCommand(Entity);
+
+impl Command for FocusWidgetCommand {
+    fn apply(self, world: &mut World) {
+        **world.resource_mut::<FocusedWidget>() = Some(self.0);
+    }
+}
+
+/// Command interface for manipulating terminal widget resources
+pub trait TerminalWidgetCommands {
+    /// Gives focus to the terminal widget on the provided entity.
+    fn focus_widget(&mut self, widget: Entity);
+}
+
+impl TerminalWidgetCommands for Commands<'_, '_> {
+    fn focus_widget(&mut self, widget: Entity) {
+        self.queue(FocusWidgetCommand(widget));
+    }
+}

src/widgets/mod.rs

@@ -7,9 +7,15 @@ use crate::input::events::TerminalInputEvent;
 /// Components for this module
 pub mod components;
 
+/// Resources for this module
+pub mod resources;
+
 /// Systems for this module
 pub(crate) mod systems;
 
+/// Commands for this module
+pub mod commands;
+
 /// Trait which defines an interface for terminal widgets
 pub trait TerminalWidget: DowncastSync {
     /// Called every frame to render the widget

src/widgets/resources.rs

@@ -0,0 +1,7 @@
+use bevy::prelude::*;
+
+/// Terminal widget entity currently focused and handling input
+/// Can be manipulated directly or you can request an entity be focused through
+/// the `focus_widget` command.
+#[derive(Resource, Default, Deref, DerefMut, Debug)]
+pub struct FocusedWidget(pub Option<Entity>);

src/widgets/systems.rs

@@ -2,17 +2,22 @@ use bevy::prelude::*;
 
 use crate::input::events::TerminalInputEvent;
 
-use super::components::Widget;
+use super::{components::Widget, resources::FocusedWidget};
 
-/// Invokes every enabled widget's `handle_events` methods for each incoming input event
+/// Invokes focused widget's `handle_events` methods for each incoming input event
 pub fn widget_input_handling(
     mut widgets: Query<&mut Widget>,
     mut event_reader: EventReader<TerminalInputEvent>,
     mut commands: Commands,
+    focused_widget: Res<FocusedWidget>,
 ) {
-    for event in event_reader.read() {
-        for mut widget in widgets.iter_mut().filter(|widget| widget.enabled) {
-            widget.widget.handle_events(event, &mut commands);
+    if let Some(entity) = **focused_widget {
+        if let Ok(mut widget) = widgets.get_mut(entity) {
+            if widget.enabled {
+                for event in event_reader.read() {
+                    widget.widget.handle_events(event, &mut commands);
+                }
+            }
         }
     }
 }