Merge pull request #246 from hecrj/feature/application-flags

Application flags

examples/clock/src/main.rs

@@ -23,8 +23,9 @@ enum Message {
 impl Application for Clock {
     type Executor = executor::Default;
     type Message = Message;
+    type Flags = ();
 
-    fn new() -> (Self, Command<Message>) {
+    fn new(_flags: ()) -> (Self, Command<Message>) {
         (
             Clock {
                 now: chrono::Local::now().into(),

examples/download_progress/src/main.rs

@@ -26,8 +26,9 @@ pub enum Message {
 impl Application for Example {
     type Executor = executor::Default;
     type Message = Message;
+    type Flags = ();
 
-    fn new() -> (Example, Command<Message>) {
+    fn new(_flags: ()) -> (Example, Command<Message>) {
         (
             Example::Idle {
                 button: button::State::new(),

examples/events/src/main.rs

@@ -22,8 +22,9 @@ enum Message {
 impl Application for Events {
     type Executor = executor::Default;
     type Message = Message;
+    type Flags = ();
 
-    fn new() -> (Events, Command<Message>) {
+    fn new(_flags: ()) -> (Events, Command<Message>) {
         (Events::default(), Command::none())
     }
 

examples/pokedex/src/main.rs

@@ -29,8 +29,9 @@ enum Message {
 impl Application for Pokedex {
     type Executor = iced::executor::Default;
     type Message = Message;
+    type Flags = ();
 
-    fn new() -> (Pokedex, Command<Message>) {
+    fn new(_flags: ()) -> (Pokedex, Command<Message>) {
         (
             Pokedex::Loading,
             Command::perform(Pokemon::search(), Message::PokemonFound),

examples/solar_system/src/main.rs

@@ -7,8 +7,8 @@
 //!
 //! [1]: https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API/Tutorial/Basic_animations#An_animated_solar_system
 use iced::{
-    canvas, executor, Application, Canvas, Color, Command, Container, Element,
-    Length, Point, Settings, Size, Subscription, Vector,
+    canvas, executor, window, Application, Canvas, Color, Command, Container,
+    Element, Length, Point, Settings, Size, Subscription, Vector,
 };
 
 use std::time::Instant;
@@ -33,8 +33,9 @@ enum Message {
 impl Application for SolarSystem {
     type Executor = executor::Default;
     type Message = Message;
+    type Flags = ();
 
-    fn new() -> (Self, Command<Message>) {
+    fn new(_flags: ()) -> (Self, Command<Message>) {
         (
             SolarSystem {
                 state: State::new(),
@@ -95,7 +96,7 @@ impl State {
 
     pub fn new() -> State {
         let now = Instant::now();
-        let (width, height) = Settings::default().window.size;
+        let (width, height) = window::Settings::default().size;
 
         State {
             start: now,

examples/stopwatch/src/main.rs

@@ -30,8 +30,9 @@ enum Message {
 impl Application for Stopwatch {
     type Executor = iced_futures::executor::AsyncStd;
     type Message = Message;
+    type Flags = ();
 
-    fn new() -> (Stopwatch, Command<Message>) {
+    fn new(_flags: ()) -> (Stopwatch, Command<Message>) {
         (
             Stopwatch {
                 duration: Duration::default(),

examples/todos/src/main.rs

@@ -40,8 +40,9 @@ enum Message {
 impl Application for Todos {
     type Executor = iced::executor::Default;
     type Message = Message;
+    type Flags = ();
 
-    fn new() -> (Todos, Command<Message>) {
+    fn new(_flags: ()) -> (Todos, Command<Message>) {
         (
             Todos::Loading,
             Command::perform(SavedState::load(), Message::Loaded),

src/application.rs

@@ -41,8 +41,9 @@ use crate::{window, Command, Element, Executor, Settings, Subscription};
 /// impl Application for Counter {
 ///     type Executor = executor::Null;
 ///     type Message = Message;
+///     type Flags = ();
 ///
-///     fn new() -> (Self, Command<Message>) {
+///     fn new(_flags: ()) -> (Self, Command<Message>) {
 ///         (Self::default(), Command::none())
 ///     }
 ///
@@ -94,7 +95,13 @@ pub trait Application: Sized {
     /// [`Application`]: trait.Application.html
     type Message: std::fmt::Debug + Send;
 
-    /// Initializes the [`Application`].
+    /// The data needed to initialize your [`Application`].
+    ///
+    /// [`Application`]: trait.Application.html
+    type Flags;
+
+    /// Initializes the [`Application`] with the flags provided to
+    /// [`run`] as part of the [`Settings`]:
     ///
     /// Here is where you should return the initial state of your app.
     ///
@@ -104,7 +111,9 @@ pub trait Application: Sized {
     /// request, etc.
     ///
     /// [`Application`]: trait.Application.html
-    fn new() -> (Self, Command<Self::Message>);
+    /// [`run`]: #method.run.html
+    /// [`Settings`]: struct.Settings.html
+    fn new(flags: Self::Flags) -> (Self, Command<Self::Message>);
 
     /// Returns the current title of the [`Application`].
     ///
@@ -169,26 +178,30 @@ pub trait Application: Sized {
     /// It should probably be that last thing you call in your `main` function.
     ///
     /// [`Application`]: trait.Application.html
-    fn run(_settings: Settings)
+    fn run(settings: Settings<Self::Flags>)
     where
         Self: 'static,
     {
         #[cfg(not(target_arch = "wasm32"))]
-        <Instance<Self> as iced_winit::Application>::run(
-            _settings.into(),
-            iced_wgpu::Settings {
-                default_font: _settings.default_font,
-                antialiasing: if _settings.antialiasing {
+        {
+            let wgpu_settings = iced_wgpu::Settings {
+                default_font: settings.default_font,
+                antialiasing: if settings.antialiasing {
                     Some(iced_wgpu::settings::Antialiasing::MSAAx4)
                 } else {
                     None
                 },
                 ..iced_wgpu::Settings::default()
-            },
-        );
+            };
+
+            <Instance<Self> as iced_winit::Application>::run(
+                settings.into(),
+                wgpu_settings,
+            );
+        }
 
         #[cfg(target_arch = "wasm32")]
-        <Instance<Self> as iced_web::Application>::run();
+        <Instance<Self> as iced_web::Application>::run(settings.flags);
     }
 }
 
@@ -201,10 +214,11 @@ where
 {
     type Backend = iced_wgpu::window::Backend;
     type Executor = A::Executor;
+    type Flags = A::Flags;
     type Message = A::Message;
 
-    fn new() -> (Self, Command<A::Message>) {
-        let (app, command) = A::new();
+    fn new(flags: Self::Flags) -> (Self, Command<A::Message>) {
+        let (app, command) = A::new(flags);
 
         (Instance(app), command)
     }
@@ -238,11 +252,12 @@ impl<A> iced_web::Application for Instance<A>
 where
     A: Application,
 {
-    type Message = A::Message;
     type Executor = A::Executor;
+    type Message = A::Message;
+    type Flags = A::Flags;
 
-    fn new() -> (Self, Command<A::Message>) {
-        let (app, command) = A::new();
+    fn new(flags: Self::Flags) -> (Self, Command<A::Message>) {
+        let (app, command) = A::new(flags);
 
         (Instance(app), command)
     }

src/executor.rs

@@ -51,7 +51,11 @@ mod platform {
 
     /// A default cross-platform executor.
     ///
-    /// - On native platforms, it will use `iced_futures::executor::ThreadPool`.
+    /// - On native platforms, it will use:
+    ///   - `iced_futures::executor::Tokio` when the `tokio` feature is enabled.
+    ///   - `iced_futures::executor::AsyncStd` when the `async-std` feature is
+    ///     enabled.
+    ///   - `iced_futures::executor::ThreadPool` otherwise.
     /// - On the Web, it will use `iced_futures::executor::WasmBindgen`.
     #[derive(Debug)]
     pub struct Default(WasmBindgen);
@@ -64,5 +68,9 @@ mod platform {
         fn spawn(&self, future: impl futures::Future<Output = ()> + 'static) {
             self.0.spawn(future);
         }
+
+        fn enter<R>(&self, f: impl FnOnce() -> R) -> R {
+            self.0.enter(f)
+        }
     }
 }

src/sandbox.rs

@@ -121,7 +121,7 @@ pub trait Sandbox {
     /// It should probably be that last thing you call in your `main` function.
     ///
     /// [`Sandbox`]: trait.Sandbox.html
-    fn run(settings: Settings)
+    fn run(settings: Settings<()>)
     where
         Self: 'static + Sized,
     {
@@ -134,9 +134,10 @@ where
     T: Sandbox,
 {
     type Executor = executor::Null;
+    type Flags = ();
     type Message = T::Message;
 
-    fn new() -> (Self, Command<T::Message>) {
+    fn new(_flags: ()) -> (Self, Command<T::Message>) {
         (T::new(), Command::none())
     }
 

src/settings.rs

@@ -3,7 +3,7 @@ use crate::window;
 
 /// The settings of an application.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
-pub struct Settings {
+pub struct Settings<Flags> {
     /// The window settings.
     ///
     /// They will be ignored on the Web.
@@ -11,6 +11,11 @@ pub struct Settings {
     /// [`Window`]: struct.Window.html
     pub window: window::Settings,
 
+    /// The data needed to initialize an [`Application`].
+    ///
+    /// [`Application`]: trait.Application.html
+    pub flags: Flags,
+
     /// The bytes of the font that will be used by default.
     ///
     /// If `None` is provided, a default system font will be chosen.
@@ -28,8 +33,8 @@ pub struct Settings {
 }
 
 #[cfg(not(target_arch = "wasm32"))]
-impl From<Settings> for iced_winit::Settings {
-    fn from(settings: Settings) -> iced_winit::Settings {
+impl<Flags> From<Settings<Flags>> for iced_winit::Settings<Flags> {
+    fn from(settings: Settings<Flags>) -> iced_winit::Settings<Flags> {
         iced_winit::Settings {
             window: iced_winit::settings::Window {
                 size: settings.window.size,
@@ -37,6 +42,7 @@ impl From<Settings> for iced_winit::Settings {
                 decorations: settings.window.decorations,
                 platform_specific: Default::default(),
             },
+            flags: settings.flags,
         }
     }
 }

web/src/lib.rs

@@ -94,11 +94,6 @@ pub use executor::Executor;
 /// An [`Application`](trait.Application.html) can execute asynchronous actions
 /// by returning a [`Command`](struct.Command.html) in some of its methods.
 pub trait Application {
-    /// The type of __messages__ your [`Application`] will produce.
-    ///
-    /// [`Application`]: trait.Application.html
-    type Message: Send;
-
     /// The [`Executor`] that will run commands and subscriptions.
     ///
     /// The [`executor::WasmBindgen`] can be a good choice for the Web.
@@ -107,6 +102,16 @@ pub trait Application {
     /// [`executor::Default`]: executor/struct.Default.html
     type Executor: Executor;
 
+    /// The type of __messages__ your [`Application`] will produce.
+    ///
+    /// [`Application`]: trait.Application.html
+    type Message: Send;
+
+    /// The data needed to initialize your [`Application`].
+    ///
+    /// [`Application`]: trait.Application.html
+    type Flags;
+
     /// Initializes the [`Application`].
     ///
     /// Here is where you should return the initial state of your app.
@@ -117,7 +122,7 @@ pub trait Application {
     /// request, etc.
     ///
     /// [`Application`]: trait.Application.html
-    fn new() -> (Self, Command<Self::Message>)
+    fn new(flags: Self::Flags) -> (Self, Command<Self::Message>)
     where
         Self: Sized;
 
@@ -165,21 +170,16 @@ pub trait Application {
     /// Runs the [`Application`].
     ///
     /// [`Application`]: trait.Application.html
-    fn run()
+    fn run(flags: Self::Flags)
     where
         Self: 'static + Sized,
     {
         use futures::stream::StreamExt;
 
-        let (app, command) = Self::new();
-
         let window = web_sys::window().unwrap();
         let document = window.document().unwrap();
         let body = document.body().unwrap();
 
-        let mut title = app.title();
-        document.set_title(&title);
-
         let (sender, receiver) =
             iced_futures::futures::channel::mpsc::unbounded();
 
@@ -187,6 +187,12 @@ pub trait Application {
             Self::Executor::new().expect("Create executor"),
             sender.clone(),
         );
+
+        let (app, command) = runtime.enter(|| Self::new(flags));
+
+        let mut title = app.title();
+        document.set_title(&title);
+
         runtime.spawn(command);
 
         let application = Rc::new(RefCell::new(app));
@@ -199,8 +205,13 @@ pub trait Application {
         let vdom = dodrio::Vdom::new(&body, instance);
 
         let event_loop = receiver.for_each(move |message| {
-            let command = application.borrow_mut().update(message);
-            let subscription = application.borrow().subscription();
+            let (command, subscription) = runtime.enter(|| {
+                let command = application.borrow_mut().update(message);
+                let subscription = application.borrow().subscription();
+
+                (command, subscription)
+            });
+
             let new_title = application.borrow().title();
 
             runtime.spawn(command);

winit/src/application.rs

@@ -28,7 +28,13 @@ pub trait Application: Sized {
     /// [`Application`]: trait.Application.html
     type Message: std::fmt::Debug + Send;
 
-    /// Initializes the [`Application`].
+    /// The data needed to initialize your [`Application`].
+    ///
+    /// [`Application`]: trait.Application.html
+    type Flags;
+
+    /// Initializes the [`Application`] with the flags provided to
+    /// [`run`] as part of the [`Settings`]:
     ///
     /// Here is where you should return the initial state of your app.
     ///
@@ -38,7 +44,9 @@ pub trait Application: Sized {
     /// request, etc.
     ///
     /// [`Application`]: trait.Application.html
-    fn new() -> (Self, Command<Self::Message>);
+    /// [`run`]: #method.run.html
+    /// [`Settings`]: struct.Settings.html
+    fn new(flags: Self::Flags) -> (Self, Command<Self::Message>);
 
     /// Returns the current title of the [`Application`].
     ///
@@ -90,7 +98,7 @@ pub trait Application: Sized {
         Mode::Windowed
     }
 
-    /// Runs the [`Application`].
+    /// Runs the [`Application`] with the provided [`Settings`].
     ///
     /// This method will take control of the current thread and __will NOT
     /// return__.
@@ -98,8 +106,9 @@ pub trait Application: Sized {
     /// It should probably be that last thing you call in your `main` function.
     ///
     /// [`Application`]: trait.Application.html
+    /// [`Settings`]: struct.Settings.html
     fn run(
-        settings: Settings,
+        settings: Settings<Self::Flags>,
         backend_settings: <Self::Backend as window::Backend>::Settings,
     ) where
         Self: 'static,
@@ -123,7 +132,9 @@ pub trait Application: Sized {
             Runtime::new(executor, Proxy::new(event_loop.create_proxy()))
         };
 
-        let (mut application, init_command) = runtime.enter(Self::new);
+        let flags = settings.flags;
+        let (mut application, init_command) =
+            runtime.enter(|| Self::new(flags));
         runtime.spawn(init_command);
 
         let subscription = application.subscription();

winit/src/settings.rs

@@ -1,28 +1,25 @@
 //! Configure your application.
 #[cfg(target_os = "windows")]
-#[path = "windows.rs"]
+#[path = "settings/windows.rs"]
 mod platform;
 #[cfg(not(target_os = "windows"))]
-#[path = "not_windows.rs"]
+#[path = "settings/not_windows.rs"]
 mod platform;
 
 pub use platform::PlatformSpecific;
 
 /// The settings of an application.
-#[derive(Debug, Clone, Copy, PartialEq)]
-pub struct Settings {
+#[derive(Debug, Clone, Copy, PartialEq, Default)]
+pub struct Settings<Flags> {
     /// The [`Window`] settings
     ///
     /// [`Window`]: struct.Window.html
     pub window: Window,
-}
 
-impl Default for Settings {
-    fn default() -> Settings {
-        Settings {
-            window: Window::default(),
-        }
-    }
+    /// The data needed to initialize an [`Application`].
+    ///
+    /// [`Application`]: trait.Application.html
+    pub flags: Flags,
 }
 
 /// The window settings of an application.