From 76698ff2b5753e637b14533650c0d28e681be3c5 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Wed, 1 Sep 2021 19:21:49 +0700 Subject: Make `Command` implementations platform-specific This allows us to introduce a platform-specific `Action` to both `iced_native` and `iced_web` and remove the `Clipboard` from `Application::update` to maintain purity. Additionally, this should let us implement further actions to let users query and modify the shell environment (e.g. window, clipboard, and more!) --- web/src/clipboard.rs | 21 ------------- web/src/command.rs | 77 +++++++++++++++++++++++++++++++++++++++++++++++ web/src/command/action.rs | 18 +++++++++++ web/src/lib.rs | 49 ++++++++++++++++++------------ 4 files changed, 125 insertions(+), 40 deletions(-) delete mode 100644 web/src/clipboard.rs create mode 100644 web/src/command.rs create mode 100644 web/src/command/action.rs (limited to 'web') diff --git a/web/src/clipboard.rs b/web/src/clipboard.rs deleted file mode 100644 index 167a1e53..00000000 --- a/web/src/clipboard.rs +++ /dev/null @@ -1,21 +0,0 @@ -/// A buffer for short-term storage and transfer within and between -/// applications. -#[derive(Debug, Clone, Copy)] -pub struct Clipboard; - -impl Clipboard { - /// Creates a new [`Clipboard`]. - pub fn new() -> Self { - Self - } - - /// Reads the current content of the [`Clipboard`] as text. - pub fn read(&self) -> Option { - unimplemented! {} - } - - /// Writes the given text contents to the [`Clipboard`]. - pub fn write(&mut self, _contents: String) { - unimplemented! {} - } -} diff --git a/web/src/command.rs b/web/src/command.rs new file mode 100644 index 00000000..606097de --- /dev/null +++ b/web/src/command.rs @@ -0,0 +1,77 @@ +mod action; + +pub use action::Action; + +#[cfg(target_arch = "wasm32")] +use std::future::Future; + +/// A set of asynchronous actions to be performed by some runtime. +pub enum Command { + None, + Single(Action), + Batch(Vec>), +} + +impl Command { + /// Creates an empty [`Command`]. + /// + /// In other words, a [`Command`] that does nothing. + pub fn none() -> Self { + Self::None + } + + /// Creates a [`Command`] that performs the action of the given future. + #[cfg(target_arch = "wasm32")] + pub fn perform( + future: impl Future + 'static, + f: impl Fn(T) -> A + 'static + Send, + ) -> Command { + use iced_futures::futures::FutureExt; + + Command::Single(Action::Future(Box::pin(future.map(f)))) + } + + /// Applies a transformation to the result of a [`Command`]. + #[cfg(target_arch = "wasm32")] + pub fn map(mut self, f: impl Fn(T) -> A + 'static + Clone) -> Command + where + T: 'static, + { + match self { + Self::None => Command::None, + Self::Single(action) => Command::Single(action.map(f)), + Self::Batch(batch) => Command::Batch( + batch + .into_iter() + .map(|action| action.map(f.clone())) + .collect(), + ), + } + } + + /// Creates a [`Command`] that performs the actions of all the given + /// commands. + /// + /// Once this command is run, all the commands will be executed at once. + pub fn batch(commands: impl IntoIterator>) -> Self { + let mut batch = Vec::new(); + + for command in commands { + match command { + Self::None => {} + Self::Single(command) => batch.push(command), + Self::Batch(commands) => batch.extend(commands), + } + } + + Self::Batch(batch) + } + + pub fn actions(self) -> Vec> { + match self { + Self::None => Vec::new(), + Self::Single(action) => vec![action], + Self::Batch(batch) => batch, + } + } +} diff --git a/web/src/command/action.rs b/web/src/command/action.rs new file mode 100644 index 00000000..cf384f07 --- /dev/null +++ b/web/src/command/action.rs @@ -0,0 +1,18 @@ +pub enum Action { + Future(iced_futures::BoxFuture), +} + +impl Action { + /// Applies a transformation to the result of a [`Command`]. + #[cfg(target_arch = "wasm32")] + pub fn map(self, f: impl Fn(T) -> A + 'static) -> Action + where + T: 'static, + { + use iced_futures::futures::FutureExt; + + match self { + Self::Future(future) => Action::Future(Box::pin(future.map(f))), + } + } +} diff --git a/web/src/lib.rs b/web/src/lib.rs index bb09bb0d..ec2bd178 100644 --- a/web/src/lib.rs +++ b/web/src/lib.rs @@ -50,8 +50,8 @@ //! [`wasm-pack`]: https://github.com/rustwasm/wasm-pack //! [`wasm-bindgen`]: https://github.com/rustwasm/wasm-bindgen //! [`tour` example]: https://github.com/hecrj/iced/tree/0.3/examples/tour -#![deny(missing_docs)] -#![deny(missing_debug_implementations)] +//#![deny(missing_docs)] +//#![deny(missing_debug_implementations)] #![deny(unused_results)] #![forbid(unsafe_code)] #![forbid(rust_2018_idioms)] @@ -59,7 +59,7 @@ use dodrio::bumpalo; use std::{cell::RefCell, rc::Rc}; mod bus; -mod clipboard; +mod command; mod element; mod hasher; @@ -68,7 +68,7 @@ pub mod subscription; pub mod widget; pub use bus::Bus; -pub use clipboard::Clipboard; +pub use command::Command; pub use css::Css; pub use dodrio; pub use element::Element; @@ -77,7 +77,7 @@ pub use iced_core::{ keyboard, menu, mouse, Align, Background, Color, Font, HorizontalAlignment, Length, Menu, Padding, Point, Rectangle, Size, Vector, VerticalAlignment, }; -pub use iced_futures::{executor, futures, Command}; +pub use iced_futures::{executor, futures}; pub use subscription::Subscription; #[doc(no_inline)] @@ -128,11 +128,7 @@ pub trait Application { /// this method. /// /// Any [`Command`] returned will be executed immediately in the background. - fn update( - &mut self, - message: Self::Message, - clipboard: &mut Clipboard, - ) -> Command; + fn update(&mut self, message: Self::Message) -> Command; /// Returns the widgets to display in the [`Application`]. /// @@ -162,8 +158,6 @@ pub trait Application { let document = window.document().unwrap(); let body = document.body().unwrap(); - let mut clipboard = Clipboard::new(); - let (sender, receiver) = iced_futures::futures::channel::mpsc::unbounded(); @@ -177,7 +171,7 @@ pub trait Application { let mut title = app.title(); document.set_title(&title); - runtime.spawn(command); + run_command(command, &mut runtime); let application = Rc::new(RefCell::new(app)); @@ -190,8 +184,7 @@ pub trait Application { let event_loop = receiver.for_each(move |message| { let (command, subscription) = runtime.enter(|| { - let command = - application.borrow_mut().update(message, &mut clipboard); + let command = application.borrow_mut().update(message); let subscription = application.borrow().subscription(); (command, subscription) @@ -199,7 +192,7 @@ pub trait Application { let new_title = application.borrow().title(); - runtime.spawn(command); + run_command(command, &mut runtime); runtime.track(subscription); if title != new_title { @@ -350,8 +343,7 @@ pub trait Embedded { ); let (app, command) = runtime.enter(|| Self::new(flags)); - - runtime.spawn(command); + run_command(command, &mut runtime); let application = Rc::new(RefCell::new(app)); @@ -370,7 +362,7 @@ pub trait Embedded { (command, subscription) }); - runtime.spawn(command); + run_command(command, &mut runtime); runtime.track(subscription); vdom.weak().schedule_render(); @@ -382,6 +374,25 @@ pub trait Embedded { } } +fn run_command( + command: Command, + runtime: &mut iced_futures::Runtime< + Hasher, + (), + E, + iced_futures::futures::channel::mpsc::UnboundedSender, + Message, + >, +) { + for action in command.actions() { + match action { + command::Action::Future(future) => { + runtime.spawn(future); + } + } + } +} + struct EmbeddedInstance { application: Rc>, bus: Bus, -- cgit From 6887afdb2c71429fa032d68f2ee3a4a075ecca1d Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Thu, 2 Sep 2021 13:47:34 +0700 Subject: Remove unnecessary `mut self` in `Command::map` --- web/src/command.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'web') diff --git a/web/src/command.rs b/web/src/command.rs index 606097de..ff6965c1 100644 --- a/web/src/command.rs +++ b/web/src/command.rs @@ -33,7 +33,7 @@ impl Command { /// Applies a transformation to the result of a [`Command`]. #[cfg(target_arch = "wasm32")] - pub fn map(mut self, f: impl Fn(T) -> A + 'static + Clone) -> Command + pub fn map(self, f: impl Fn(T) -> A + 'static + Clone) -> Command where T: 'static, { -- cgit From 6fce35393fb2dc3dcbc5f423fa8472f5ce1f7027 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Thu, 2 Sep 2021 15:50:00 +0700 Subject: Hide implementation details of `Command` in `iced_futures` --- web/src/command.rs | 65 +++++++++++++++++++++--------------------------------- 1 file changed, 25 insertions(+), 40 deletions(-) (limited to 'web') diff --git a/web/src/command.rs b/web/src/command.rs index ff6965c1..f222795d 100644 --- a/web/src/command.rs +++ b/web/src/command.rs @@ -6,18 +6,19 @@ pub use action::Action; use std::future::Future; /// A set of asynchronous actions to be performed by some runtime. -pub enum Command { - None, - Single(Action), - Batch(Vec>), -} +pub struct Command(iced_futures::Command>); impl Command { /// Creates an empty [`Command`]. /// /// In other words, a [`Command`] that does nothing. - pub fn none() -> Self { - Self::None + pub const fn none() -> Self { + Self(iced_futures::Command::none()) + } + + /// Creates a [`Command`] that performs a single [`Action`]. + pub const fn single(action: Action) -> Self { + Self(iced_futures::Command::single(action)) } /// Creates a [`Command`] that performs the action of the given future. @@ -28,25 +29,7 @@ impl Command { ) -> Command { use iced_futures::futures::FutureExt; - Command::Single(Action::Future(Box::pin(future.map(f)))) - } - - /// Applies a transformation to the result of a [`Command`]. - #[cfg(target_arch = "wasm32")] - pub fn map(self, f: impl Fn(T) -> A + 'static + Clone) -> Command - where - T: 'static, - { - match self { - Self::None => Command::None, - Self::Single(action) => Command::Single(action.map(f)), - Self::Batch(batch) => Command::Batch( - batch - .into_iter() - .map(|action| action.map(f.clone())) - .collect(), - ), - } + Command::single(Action::Future(Box::pin(future.map(f)))) } /// Creates a [`Command`] that performs the actions of all the given @@ -54,24 +37,26 @@ impl Command { /// /// Once this command is run, all the commands will be executed at once. pub fn batch(commands: impl IntoIterator>) -> Self { - let mut batch = Vec::new(); + Self(iced_futures::Command::batch( + commands.into_iter().map(|Command(command)| command), + )) + } - for command in commands { - match command { - Self::None => {} - Self::Single(command) => batch.push(command), - Self::Batch(commands) => batch.extend(commands), - } - } + /// Applies a transformation to the result of a [`Command`]. + #[cfg(target_arch = "wasm32")] + pub fn map(self, f: impl Fn(T) -> A + 'static + Clone) -> Command + where + T: 'static, + { + let Command(command) = self; - Self::Batch(batch) + Command(command.map(move |action| action.map(f.clone()))) } + /// Returns all of the actions of the [`Command`]. pub fn actions(self) -> Vec> { - match self { - Self::None => Vec::new(), - Self::Single(action) => vec![action], - Self::Batch(batch) => batch, - } + let Command(command) = self; + + command.actions() } } -- cgit From 01b945b9814b9dc546e783a6dab66e4f7fe49786 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Mon, 13 Sep 2021 11:22:53 +0700 Subject: Write missing docs and `Debug` implementations for `web` --- web/src/command.rs | 10 ++++++++++ web/src/command/action.rs | 10 ++++++++++ web/src/lib.rs | 4 ++-- 3 files changed, 22 insertions(+), 2 deletions(-) (limited to 'web') diff --git a/web/src/command.rs b/web/src/command.rs index f222795d..33e49e70 100644 --- a/web/src/command.rs +++ b/web/src/command.rs @@ -2,6 +2,8 @@ mod action; pub use action::Action; +use std::fmt; + #[cfg(target_arch = "wasm32")] use std::future::Future; @@ -60,3 +62,11 @@ impl Command { command.actions() } } + +impl fmt::Debug for Command { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + let Command(command) = self; + + command.fmt(f) + } +} diff --git a/web/src/command/action.rs b/web/src/command/action.rs index cf384f07..c0223e50 100644 --- a/web/src/command/action.rs +++ b/web/src/command/action.rs @@ -2,6 +2,8 @@ pub enum Action { Future(iced_futures::BoxFuture), } +use std::fmt; + impl Action { /// Applies a transformation to the result of a [`Command`]. #[cfg(target_arch = "wasm32")] @@ -16,3 +18,11 @@ impl Action { } } } + +impl fmt::Debug for Action { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + match self { + Self::Future(_) => write!(f, "Action::Future"), + } + } +} diff --git a/web/src/lib.rs b/web/src/lib.rs index ec2bd178..5bbd2ee6 100644 --- a/web/src/lib.rs +++ b/web/src/lib.rs @@ -50,8 +50,8 @@ //! [`wasm-pack`]: https://github.com/rustwasm/wasm-pack //! [`wasm-bindgen`]: https://github.com/rustwasm/wasm-bindgen //! [`tour` example]: https://github.com/hecrj/iced/tree/0.3/examples/tour -//#![deny(missing_docs)] -//#![deny(missing_debug_implementations)] +#![deny(missing_docs)] +#![deny(missing_debug_implementations)] #![deny(unused_results)] #![forbid(unsafe_code)] #![forbid(rust_2018_idioms)] -- cgit