Merge pull request 'Widget Focus' (#3) from 11-widget-focus into master

Reviewed-on: #3

.cargo/config.toml

@@ -1,2 +0,0 @@
-[profile.dev.package."*"]
-opt-level = 2

.gitignore

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

Cargo.toml

@@ -6,11 +6,16 @@ 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.soaos.dev/soaos/bevy_terminal_display"
 
+[profile.dev]
+opt-level = 1
+
+[profile.dev.package."*"]
+opt-level = 2
+
 [dependencies]
 crossbeam-channel = "0.5"
 downcast-rs = "2.0"
 once_cell = "1.19"
-bevy_headless_render = "0.2"
 ratatui = "0.29"
 color-eyre = "0.6"
 leafwing-input-manager = "0.16"
@@ -26,5 +31,10 @@ features = ["bevy_render"]
 version = "0.28"
 features = ["serde"]
 
+# SOAOS DEPS
+
 [dependencies.bevy_dither_post_process]
-git = "https://git.soaos.dev/soaos/bevy_dither_post_process"
+version = "0.3"
+
+[dependencies.bevy_headless_render]
+version = "0.2"

src/lib.rs

@@ -3,7 +3,7 @@
 //! 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::{
@@ -18,7 +18,6 @@ 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;
 pub use ratatui;
 
 /// Functions and types related to capture and display of world to terminal
@@ -30,8 +29,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,19 +45,12 @@ 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)
@@ -100,6 +90,7 @@ impl Plugin for TerminalDisplayPlugin {
         )
         .insert_resource(display::resources::Terminal::default())
         .insert_resource(input::resources::EventQueue::default())
+        .init_resource::<widgets::resources::FocusedWidget>()
         .add_event::<input::events::TerminalInputEvent>();
     }
 }

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<'w, 's> TerminalWidgetCommands for Commands<'w,'s> {
+    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 == true {
+                for event in event_reader.read() {
+                    widget.widget.handle_events(event, &mut commands);
+                }
+            }
         }
     }
 }