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 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
// Copyright 2019 The Druid Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Window building and app lifecycle.
use crate::ext_event::{ExtEventHost, ExtEventSink};
use crate::kurbo::{Point, Size};
use crate::menu::MenuManager;
use crate::shell::{Application, Error as PlatformError, WindowBuilder, WindowHandle, WindowLevel};
use crate::widget::LabelText;
use crate::win_handler::{AppHandler, AppState};
use crate::window::WindowId;
use crate::{AppDelegate, Data, Env, LocalizedString, Menu, Widget};
use tracing::warn;
use druid_shell::WindowState;
/// A function that modifies the initial environment.
type EnvSetupFn<T> = dyn FnOnce(&mut Env, &T);
/// Handles initial setup of an application, and starts the runloop.
pub struct AppLauncher<T> {
windows: Vec<WindowDesc<T>>,
env_setup: Option<Box<EnvSetupFn<T>>>,
l10n_resources: Option<(Vec<String>, String)>,
delegate: Option<Box<dyn AppDelegate<T>>>,
ext_event_host: ExtEventHost,
}
/// Defines how a windows size should be determined
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum WindowSizePolicy {
/// Use the content of the window to determine the size.
///
/// If you use this option, your root widget will be passed infinite constraints;
/// you are responsible for ensuring that your content picks an appropriate size.
Content,
/// Use the provided window size
User,
}
/// Window configuration that can be applied to a WindowBuilder, or to an existing WindowHandle.
/// It does not include anything related to app data.
#[derive(PartialEq)]
pub struct WindowConfig {
pub(crate) size_policy: WindowSizePolicy,
pub(crate) size: Option<Size>,
pub(crate) min_size: Option<Size>,
pub(crate) position: Option<Point>,
pub(crate) resizable: Option<bool>,
pub(crate) transparent: Option<bool>,
pub(crate) show_titlebar: Option<bool>,
pub(crate) level: Option<WindowLevel>,
pub(crate) always_on_top: Option<bool>,
pub(crate) state: Option<WindowState>,
}
/// A description of a window to be instantiated.
///
/// This struct has builder methods to specify some window properties. Each of
/// these methods usually corresponds to a platform API call when constructing the
/// function. Except for `title()`, they have no default values and the APIS
/// won't be called if the method is not used.
pub struct WindowDesc<T> {
pub(crate) pending: PendingWindow<T>,
pub(crate) config: WindowConfig,
/// The `WindowId` that will be assigned to this window.
///
/// This can be used to track a window from when it is launched and when
/// it actually connects.
pub id: WindowId,
}
/// The parts of a window, pending construction, that are dependent on top level app state
/// or are not part of the `druid-shell`'s windowing abstraction.
/// This includes the boxed root widget, as well as other window properties such as the title.
pub struct PendingWindow<T> {
pub(crate) root: Box<dyn Widget<T>>,
pub(crate) title: LabelText<T>,
pub(crate) transparent: bool,
pub(crate) menu: Option<MenuManager<T>>,
pub(crate) size_policy: WindowSizePolicy, // This is copied over from the WindowConfig
// when the native window is constructed.
}
impl<T: Data> PendingWindow<T> {
/// Create a pending window from any widget.
pub fn new<W>(root: W) -> PendingWindow<T>
where
W: Widget<T> + 'static,
{
// This just makes our API slightly cleaner; callers don't need to explicitly box.
PendingWindow {
root: Box::new(root),
title: LocalizedString::new("app-name").into(),
menu: MenuManager::platform_default(),
transparent: false,
size_policy: WindowSizePolicy::User,
}
}
/// Set the title for this window. This is a [`LabelText`]; it can be either
/// a `String`, a [`LocalizedString`], or a closure that computes a string;
/// it will be kept up to date as the application's state changes.
pub fn title(mut self, title: impl Into<LabelText<T>>) -> Self {
self.title = title.into();
self
}
/// Set whether the background should be transparent
pub fn transparent(mut self, transparent: bool) -> Self {
self.transparent = transparent;
self
}
/// Set the menu for this window.
///
/// `menu` is a callback for creating the menu. Its first argument is the id of the window that
/// will have the menu, or `None` if it's creating the root application menu for an app with no
/// menus (which can happen, for example, on macOS).
pub fn menu(
mut self,
menu: impl FnMut(Option<WindowId>, &T, &Env) -> Menu<T> + 'static,
) -> Self {
self.menu = Some(MenuManager::new(menu));
self
}
}
impl<T: Data> AppLauncher<T> {
/// Create a new `AppLauncher` with the provided window.
pub fn with_window(window: WindowDesc<T>) -> Self {
AppLauncher {
windows: vec![window],
env_setup: None,
l10n_resources: None,
delegate: None,
ext_event_host: ExtEventHost::new(),
}
}
/// Provide an optional closure that will be given mutable access to
/// the environment and immutable access to the app state before launch.
///
/// This can be used to set or override theme values.
pub fn configure_env(mut self, f: impl Fn(&mut Env, &T) + 'static) -> Self {
self.env_setup = Some(Box::new(f));
self
}
/// Set the [`AppDelegate`].
pub fn delegate(mut self, delegate: impl AppDelegate<T> + 'static) -> Self {
self.delegate = Some(Box::new(delegate));
self
}
/// Initialize a minimal logger with DEBUG max level for printing logs out to stderr.
///
/// This is meant for use during development only.
///
/// # Panics
///
/// Panics if the logger fails to initialize.
#[doc(hidden)]
#[deprecated(since = "0.8.0", note = "Use log_to_console instead")]
pub fn use_simple_logger(self) -> Self {
self.log_to_console()
}
/// Initialize a minimal tracing subscriber with DEBUG max level for printing logs out to
/// stderr.
///
/// This is meant for quick-and-dirty debugging. If you want more serious trace handling,
/// it's probably better to implement it yourself.
///
/// # Panics
///
/// Panics if `enable` is `true` and the subscriber fails to initialize,
/// for example if a `tracing`/`tracing_wasm` global logger was already set.
///
/// Never panics when `enable` is `false`, or have any other side effect.
///
/// Passing in false is useful if you want to enable a global logger as feature
/// but log to console otherwise.
pub fn start_console_logging(self, enable: bool) -> Self {
if !enable {
return self;
}
#[cfg(not(target_arch = "wasm32"))]
{
use tracing_subscriber::prelude::*;
let filter_layer = tracing_subscriber::filter::LevelFilter::DEBUG;
let fmt_layer = tracing_subscriber::fmt::layer()
// Display target (eg "my_crate::some_mod::submod") with logs
.with_target(true);
tracing_subscriber::registry()
.with(filter_layer)
.with(fmt_layer)
.init();
}
// Note - tracing-wasm might not work in headless Node.js. Probably doesn't matter anyway,
// because this is a GUI framework, so wasm targets will virtually always be browsers.
#[cfg(target_arch = "wasm32")]
{
console_error_panic_hook::set_once();
let config = tracing_wasm::WASMLayerConfigBuilder::new()
.set_max_level(tracing::Level::DEBUG)
.build();
tracing_wasm::set_as_global_default_with_config(config)
}
self
}
/// Calls `start_console_logging` with `true`.
pub fn log_to_console(self) -> Self {
self.start_console_logging(true)
}
/// Use custom localization resource
///
/// `resources` is a list of file names that contain strings. `base_dir`
/// is a path to a directory that includes per-locale subdirectories.
///
/// This directory should be of the structure `base_dir/{locale}/{resource}`,
/// where '{locale}' is a valid BCP47 language tag, and {resource} is a `.ftl`
/// included in `resources`.
pub fn localization_resources(mut self, resources: Vec<String>, base_dir: String) -> Self {
self.l10n_resources = Some((resources, base_dir));
self
}
/// Returns an [`ExtEventSink`] that can be moved between threads,
/// and can be used to submit commands back to the application.
pub fn get_external_handle(&self) -> ExtEventSink {
self.ext_event_host.make_sink()
}
/// Build the windows and start the runloop.
///
/// Returns an error if a window cannot be instantiated. This is usually
/// a fatal error.
pub fn launch(mut self, data: T) -> Result<(), PlatformError> {
let app = Application::new()?;
let mut env = self
.l10n_resources
.map(|it| Env::with_i10n(it.0, &it.1))
.unwrap_or_else(Env::with_default_i10n);
if let Some(f) = self.env_setup.take() {
f(&mut env, &data);
}
let mut state = AppState::new(
app.clone(),
data,
env,
self.delegate.take(),
self.ext_event_host,
);
for desc in self.windows {
let window = desc.build_native(&mut state)?;
window.show();
}
let handler = AppHandler::new(state);
app.run(Some(Box::new(handler)));
Ok(())
}
}
impl Default for WindowConfig {
fn default() -> Self {
WindowConfig {
size_policy: WindowSizePolicy::User,
size: None,
min_size: None,
position: None,
resizable: None,
show_titlebar: None,
transparent: None,
level: None,
always_on_top: None,
state: None,
}
}
}
impl WindowConfig {
/// Set the window size policy.
pub fn window_size_policy(mut self, size_policy: WindowSizePolicy) -> Self {
#[cfg(windows)]
{
// On Windows content_insets doesn't work on window with no initial size
// so the window size can't be adapted to the content, to fix this a
// non null initial size is set here.
if size_policy == WindowSizePolicy::Content {
self.size = Some(Size::new(1., 1.))
}
}
self.size_policy = size_policy;
self
}
/// Set the window's initial drawing area size in [display points].
///
/// You can pass in a tuple `(width, height)` or a [`Size`],
/// e.g. to create a window with a drawing area 1000dp wide and 500dp high:
///
/// ```ignore
/// window.window_size((1000.0, 500.0));
/// ```
///
/// The actual window size in pixels will depend on the platform DPI settings.
///
/// This should be considered a request to the platform to set the size of the window.
/// The platform might increase the size a tiny bit due to DPI.
///
/// [`Size`]: Size
/// [display points]: crate::Scale
pub fn window_size(mut self, size: impl Into<Size>) -> Self {
self.size = Some(size.into());
self
}
/// Set the window's minimum drawing area size in [display points].
///
/// The actual minimum window size in pixels will depend on the platform DPI settings.
///
/// This should be considered a request to the platform to set the minimum size of the window.
/// The platform might increase the size a tiny bit due to DPI.
///
/// To set the window's initial drawing area size use [`window_size`].
///
/// [`window_size`]: #method.window_size
/// [display points]: crate::Scale
pub fn with_min_size(mut self, size: impl Into<Size>) -> Self {
self.min_size = Some(size.into());
self
}
/// Set whether the window should be resizable.
pub fn resizable(mut self, resizable: bool) -> Self {
self.resizable = Some(resizable);
self
}
/// Set whether the window should have a titlebar and decorations.
pub fn show_titlebar(mut self, show_titlebar: bool) -> Self {
self.show_titlebar = Some(show_titlebar);
self
}
/// Sets the window position in virtual screen coordinates.
/// [`position`] Position in pixels.
///
/// [`position`]: Point
pub fn set_position(mut self, position: Point) -> Self {
self.position = Some(position);
self
}
/// Sets the [`WindowLevel`] of the window
pub fn set_level(mut self, level: WindowLevel) -> Self {
self.level = Some(level);
self
}
/// Sets whether the window is always on top.
///
/// An always on top window stays on top, even after clicking off of it.
pub fn set_always_on_top(mut self, always_on_top: bool) -> Self {
self.always_on_top = Some(always_on_top);
self
}
/// Sets the [`WindowState`] of the window.
pub fn set_window_state(mut self, state: WindowState) -> Self {
self.state = Some(state);
self
}
/// Set whether the window background should be transparent
pub fn transparent(mut self, transparent: bool) -> Self {
self.transparent = Some(transparent);
self
}
/// Apply this window configuration to the passed in WindowBuilder
pub fn apply_to_builder(&self, builder: &mut WindowBuilder) {
if let Some(resizable) = self.resizable {
builder.resizable(resizable);
}
if let Some(show_titlebar) = self.show_titlebar {
builder.show_titlebar(show_titlebar);
}
if let Some(size) = self.size {
builder.set_size(size);
} else if let WindowSizePolicy::Content = self.size_policy {
builder.set_size(Size::new(0., 0.));
}
if let Some(position) = self.position {
builder.set_position(position);
}
if let Some(transparent) = self.transparent {
builder.set_transparent(transparent);
}
if let Some(level) = self.level.clone() {
builder.set_level(level)
}
if let Some(always_on_top) = self.always_on_top {
builder.set_always_on_top(always_on_top)
}
if let Some(state) = self.state {
builder.set_window_state(state);
}
if let Some(min_size) = self.min_size {
builder.set_min_size(min_size);
}
}
/// Apply this window configuration to the passed in WindowHandle
pub fn apply_to_handle(&self, win_handle: &mut WindowHandle) {
if let Some(resizable) = self.resizable {
win_handle.resizable(resizable);
}
if let Some(show_titlebar) = self.show_titlebar {
win_handle.show_titlebar(show_titlebar);
}
if let Some(size) = self.size {
win_handle.set_size(size);
}
// Can't apply min size currently as window handle
// does not support it.
if let Some(position) = self.position {
win_handle.set_position(position);
}
if self.level.is_some() {
warn!("Applying a level can only be done on window builders");
}
if let Some(state) = self.state {
win_handle.set_window_state(state);
}
}
}
impl<T: Data> WindowDesc<T> {
/// Create a new `WindowDesc`, taking the root [`Widget`] for this window.
pub fn new<W>(root: W) -> WindowDesc<T>
where
W: Widget<T> + 'static,
{
WindowDesc {
pending: PendingWindow::new(root),
config: WindowConfig::default(),
id: WindowId::next(),
}
}
/// Set the title for this window. This is a [`LabelText`]; it can be either
/// a `String`, a [`LocalizedString`], or a closure that computes a string;
/// it will be kept up to date as the application's state changes.
///
/// If this method isn't called, the default title will be `LocalizedString::new("app-name")`.
pub fn title(mut self, title: impl Into<LabelText<T>>) -> Self {
self.pending = self.pending.title(title);
self
}
/// Set the menu for this window.
///
/// `menu` is a callback for creating the menu. Its first argument is the id of the window that
/// will have the menu, or `None` if it's creating the root application menu for an app with no
/// menus (which can happen, for example, on macOS).
pub fn menu(
mut self,
menu: impl FnMut(Option<WindowId>, &T, &Env) -> Menu<T> + 'static,
) -> Self {
self.pending = self.pending.menu(menu);
self
}
/// Set the window size policy
pub fn window_size_policy(mut self, size_policy: WindowSizePolicy) -> Self {
#[cfg(windows)]
{
// On Windows content_insets doesn't work on window with no initial size
// so the window size can't be adapted to the content, to fix this a
// non null initial size is set here.
if size_policy == WindowSizePolicy::Content {
self.config.size = Some(Size::new(1., 1.))
}
}
self.config.size_policy = size_policy;
self
}
/// Set the window's initial drawing area size in [display points].
///
/// You can pass in a tuple `(width, height)` or a [`Size`],
/// e.g. to create a window with a drawing area 1000dp wide and 500dp high:
///
/// ```ignore
/// window.window_size((1000.0, 500.0));
/// ```
///
/// The actual window size in pixels will depend on the platform DPI settings.
///
/// This should be considered a request to the platform to set the size of the window.
/// The platform might increase the size a tiny bit due to DPI.
///
/// [display points]: crate::Scale
pub fn window_size(mut self, size: impl Into<Size>) -> Self {
self.config.size = Some(size.into());
self
}
/// Set the window's minimum drawing area size in [display points].
///
/// The actual minimum window size in pixels will depend on the platform DPI settings.
///
/// This should be considered a request to the platform to set the minimum size of the window.
/// The platform might increase the size a tiny bit due to DPI.
///
/// To set the window's initial drawing area size use [`window_size`].
///
/// [`window_size`]: #method.window_size
/// [display points]: crate::Scale
pub fn with_min_size(mut self, size: impl Into<Size>) -> Self {
self.config = self.config.with_min_size(size);
self
}
/// Builder-style method to set whether this window can be resized.
pub fn resizable(mut self, resizable: bool) -> Self {
self.config = self.config.resizable(resizable);
self
}
/// Builder-style method to set whether this window's titlebar is visible.
pub fn show_titlebar(mut self, show_titlebar: bool) -> Self {
self.config = self.config.show_titlebar(show_titlebar);
self
}
/// Builder-style method to set whether this window's background should be
/// transparent.
pub fn transparent(mut self, transparent: bool) -> Self {
self.config = self.config.transparent(transparent);
self.pending = self.pending.transparent(transparent);
self
}
/// Sets the initial window position in [display points], relative to the origin
/// of the [virtual screen].
///
/// [display points]: crate::Scale
/// [virtual screen]: crate::Screen
pub fn set_position(mut self, position: impl Into<Point>) -> Self {
self.config = self.config.set_position(position.into());
self
}
/// Sets the [`WindowLevel`] of the window
///
/// [`WindowLevel`]: WindowLevel
pub fn set_level(mut self, level: WindowLevel) -> Self {
self.config = self.config.set_level(level);
self
}
/// Sets whether the window is always on top.
///
/// An always on top window stays on top, even after clicking off of it.
pub fn set_always_on_top(mut self, always_on_top: bool) -> Self {
self.config = self.config.set_always_on_top(always_on_top);
self
}
/// Set initial state for the window.
pub fn set_window_state(mut self, state: WindowState) -> Self {
self.config = self.config.set_window_state(state);
self
}
/// Set the [`WindowConfig`] of window.
pub fn with_config(mut self, config: WindowConfig) -> Self {
self.config = config;
self
}
/// Attempt to create a platform window from this `WindowDesc`.
pub(crate) fn build_native(
self,
state: &mut AppState<T>,
) -> Result<WindowHandle, PlatformError> {
state.build_native_window(self.id, self.pending, self.config)
}
}