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
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
// Copyright 2018 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.

//! Platform independent window types.

use std::any::Any;
use std::time::Duration;

use crate::application::Application;
use crate::backend::window as backend;
use crate::common_util::Counter;
use crate::dialog::{FileDialogOptions, FileInfo};
use crate::error::Error;
use crate::keyboard::KeyEvent;
use crate::kurbo::{Insets, Point, Rect, Size};
use crate::menu::Menu;
use crate::mouse::{Cursor, CursorDesc, MouseEvent};
use crate::region::Region;
use crate::scale::Scale;
use crate::text::{Event, InputHandler};
use piet_common::PietText;
#[cfg(feature = "raw-win-handle")]
use raw_window_handle::{HasRawWindowHandle, RawWindowHandle};

/// A token that uniquely identifies a running timer.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Hash)]
pub struct TimerToken(u64);

impl TimerToken {
    /// A token that does not correspond to any timer.
    pub const INVALID: TimerToken = TimerToken(0);

    /// Create a new token.
    pub fn next() -> TimerToken {
        static TIMER_COUNTER: Counter = Counter::new();
        TimerToken(TIMER_COUNTER.next())
    }

    /// Create a new token from a raw value.
    pub const fn from_raw(id: u64) -> TimerToken {
        TimerToken(id)
    }

    /// Get the raw value for a token.
    pub const fn into_raw(self) -> u64 {
        self.0
    }
}

/// Uniquely identifies a text input field inside a window.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Hash)]
pub struct TextFieldToken(u64);

impl TextFieldToken {
    /// A token that does not correspond to any text input.
    pub const INVALID: TextFieldToken = TextFieldToken(0);

    /// Create a new token; this should for the most part be called only by platform code.
    pub fn next() -> TextFieldToken {
        static TEXT_FIELD_COUNTER: Counter = Counter::new();
        TextFieldToken(TEXT_FIELD_COUNTER.next())
    }

    /// Create a new token from a raw value.
    pub const fn from_raw(id: u64) -> TextFieldToken {
        TextFieldToken(id)
    }

    /// Get the raw value for a token.
    pub const fn into_raw(self) -> u64 {
        self.0
    }
}

//NOTE: this has a From<backend::Handle> impl for construction
/// A handle that can enqueue tasks on the window loop.
#[derive(Clone)]
pub struct IdleHandle(backend::IdleHandle);

impl IdleHandle {
    /// Add an idle handler, which is called (once) when the message loop
    /// is empty. The idle handler will be run from the main UI thread, and
    /// won't be scheduled if the associated view has been dropped.
    ///
    /// Note: the name "idle" suggests that it will be scheduled with a lower
    /// priority than other UI events, but that's not necessarily the case.
    pub fn add_idle<F>(&self, callback: F)
    where
        F: FnOnce(&mut dyn WinHandler) + Send + 'static,
    {
        self.0.add_idle_callback(callback)
    }

    /// Request a callback from the runloop. Your `WinHander::idle` method will
    /// be called with the `token` that was passed in.
    pub fn schedule_idle(&mut self, token: IdleToken) {
        self.0.add_idle_token(token)
    }
}

/// A token that uniquely identifies a idle schedule.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Hash)]
pub struct IdleToken(usize);

impl IdleToken {
    /// Create a new `IdleToken` with the given raw `usize` id.
    pub const fn new(raw: usize) -> IdleToken {
        IdleToken(raw)
    }
}

/// A token that uniquely identifies a file dialog request.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Hash)]
pub struct FileDialogToken(u64);

impl FileDialogToken {
    /// A token that does not correspond to any file dialog.
    pub const INVALID: FileDialogToken = FileDialogToken(0);

    /// Create a new token.
    pub fn next() -> FileDialogToken {
        static COUNTER: Counter = Counter::new();
        FileDialogToken(COUNTER.next())
    }

    /// Create a new token from a raw value.
    pub const fn from_raw(id: u64) -> FileDialogToken {
        FileDialogToken(id)
    }

    /// Get the raw value for a token.
    pub const fn into_raw(self) -> u64 {
        self.0
    }
}

/// Levels in the window system - Z order for display purposes.
/// Describes the purpose of a window and should be mapped appropriately to match platform
/// conventions.
#[derive(Clone, PartialEq, Eq)]
pub enum WindowLevel {
    /// A top level app window.
    AppWindow,
    /// A window that should stay above app windows - like a tooltip
    Tooltip(WindowHandle),
    /// A user interface element such as a dropdown menu or combo box
    DropDown(WindowHandle),
    /// A modal dialog
    Modal(WindowHandle),
}

/// Contains the different states a Window can be in.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum WindowState {
    Maximized,
    Minimized,
    Restored,
}

/// A handle to a platform window object.
#[derive(Clone, Default, PartialEq, Eq)]
pub struct WindowHandle(pub(crate) backend::WindowHandle);

impl WindowHandle {
    /// Make this window visible.
    pub fn show(&self) {
        self.0.show()
    }

    /// Close the window.
    pub fn close(&self) {
        self.0.close()
    }

    /// Hide the window
    pub fn hide(&self) {
        self.0.hide()
    }

    /// Set whether the window should be resizable
    pub fn resizable(&self, resizable: bool) {
        self.0.resizable(resizable)
    }

    /// Sets the state of the window.
    pub fn set_window_state(&mut self, state: WindowState) {
        self.0.set_window_state(state);
    }

    /// Gets the state of the window.
    pub fn get_window_state(&self) -> WindowState {
        self.0.get_window_state()
    }

    /// Informs the system that the current location of the mouse should be treated as part of the
    /// window's titlebar. This can be used to implement a custom titlebar widget. Note that
    /// because this refers to the current location of the mouse, you should probably call this
    /// function in response to every relevant [`WinHandler::mouse_move`].
    ///
    /// This is currently only implemented on Windows and GTK.
    pub fn handle_titlebar(&self, val: bool) {
        self.0.handle_titlebar(val);
    }

    /// Set whether the window should show titlebar.
    pub fn show_titlebar(&self, show_titlebar: bool) {
        self.0.show_titlebar(show_titlebar)
    }

    /// Sets the position of the window.
    ///
    /// The position is given in [display points], measured relative to the parent window if there
    /// is one, or the origin of the virtual screen if there is no parent.
    ///
    /// [display points]: crate::Scale
    pub fn set_position(&self, position: impl Into<Point>) {
        self.0.set_position(position.into())
    }

    /// Sets whether the window is always on top of other windows.
    ///
    /// How and if this works is system dependent, by either setting a flag, or setting the level.
    /// On Wayland systems, the user needs to manually set this in the titlebar.
    pub fn set_always_on_top(&self, always_on_top: bool) {
        self.0.set_always_on_top(always_on_top);
    }

    /// Sets where in the window the user can interact with the program.
    ///
    /// This enables irregularly shaped windows. For example, you can make it simply
    /// not rectangular or you can make a sub-window which can be moved even on Wayland.
    ///
    /// The contents of `region` are added together, and are specified in [display points], so
    /// you do not need to deal with scale yourself.
    ///
    /// On GTK and Wayland, this is specified as where the user can interact with the program.
    /// On Windows, this is specified as both where you can interact, and where the window is
    /// visible. So on Windows it will hide all regions not specified.
    /// On macOS, this does nothing, but you can make the window transparent for the same effect.
    /// On Web, this does nothing.
    ///
    /// [display points]: crate::Scale
    pub fn set_input_region(&self, region: Option<Region>) {
        self.0.set_input_region(region)
    }

    /// Returns the position of the top left corner of the window.
    ///
    /// The position is returned in [display points], measured relative to the parent window if
    /// there is one, of the origin of the virtual screen if there is no parent.
    ///
    /// [display points]: crate::Scale
    pub fn get_position(&self) -> Point {
        self.0.get_position()
    }

    /// Returns the insets of the window content from its position and size in [display points].
    ///
    /// This is to account for any window system provided chrome, e.g. title bars. For example, if
    /// you want your window to have room for contents of size `contents`, then you should call
    /// [`WindowHandle::get_size`] with an argument of `(contents.to_rect() + insets).size()`,
    /// where `insets` is the return value of this function.
    ///
    /// The details of this function are somewhat platform-dependent. For example, on Windows both
    /// the insets and the window size include the space taken up by the title bar and window
    /// decorations; on GTK neither the insets nor the window size include the title bar or window
    /// decorations.
    ///
    /// [display points]: crate::Scale
    pub fn content_insets(&self) -> Insets {
        self.0.content_insets()
    }

    /// Set the window's size in [display points].
    ///
    /// 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 choose a different size depending on its DPI or other platform-dependent
    /// configuration.  To know the actual size of the window you should handle the
    /// [`WinHandler::size`] method.
    ///
    /// [display points]: crate::Scale
    pub fn set_size(&self, size: impl Into<Size>) {
        self.0.set_size(size.into())
    }

    /// Gets the window size, in [display points].
    ///
    /// [display points]: crate::Scale
    pub fn get_size(&self) -> Size {
        self.0.get_size()
    }

    /// Bring this window to the front of the window stack and give it focus.
    pub fn bring_to_front_and_focus(&self) {
        self.0.bring_to_front_and_focus()
    }

    /// Request that [`prepare_paint`] and [`paint`] be called next time there's the opportunity to
    /// render another frame. This differs from [`invalidate`] and [`invalidate_rect`] in that it
    /// doesn't invalidate any part of the window.
    ///
    /// [`invalidate`]: WindowHandle::invalidate
    /// [`invalidate_rect`]: WindowHandle::invalidate_rect
    /// [`paint`]: WinHandler::paint
    /// [`prepare_paint`]: WinHandler::prepare_paint
    pub fn request_anim_frame(&self) {
        self.0.request_anim_frame();
    }

    /// Request invalidation of the entire window contents.
    pub fn invalidate(&self) {
        self.0.invalidate();
    }

    /// Request invalidation of a region of the window.
    pub fn invalidate_rect(&self, rect: Rect) {
        self.0.invalidate_rect(rect);
    }

    /// Set the title for this menu.
    pub fn set_title(&self, title: &str) {
        self.0.set_title(title)
    }

    /// Set the top-level menu for this window.
    pub fn set_menu(&self, menu: Menu) {
        self.0.set_menu(menu.into_inner())
    }

    /// Get access to a type that can perform text layout.
    pub fn text(&self) -> PietText {
        self.0.text()
    }

    /// Register a new text input receiver for this window.
    ///
    /// This method should be called any time a new editable text field is
    /// created inside a window.  Any text field with a `TextFieldToken` that
    /// has not yet been destroyed with `remove_text_field` *must* be ready to
    /// accept input from the platform via `WinHandler::text_input` at any time,
    /// even if it is not currently focused.
    ///
    /// Returns the `TextFieldToken` associated with this new text input.
    pub fn add_text_field(&self) -> TextFieldToken {
        self.0.add_text_field()
    }

    /// Unregister a previously registered text input receiver.
    ///
    /// If `token` is the text field currently focused, the platform automatically
    /// sets the focused field to `None`.
    pub fn remove_text_field(&self, token: TextFieldToken) {
        self.0.remove_text_field(token)
    }

    /// Notify the platform that the focused text input receiver has changed.
    ///
    /// This must be called any time focus changes to a different text input, or
    /// when focus switches away from a text input.
    pub fn set_focused_text_field(&self, active_field: Option<TextFieldToken>) {
        self.0.set_focused_text_field(active_field)
    }

    /// Notify the platform that some text input state has changed, such as the
    /// selection, contents, etc.
    ///
    /// This method should *never* be called in response to edits from a
    /// `InputHandler`; only in response to changes from the application:
    /// scrolling, remote edits, etc.
    pub fn update_text_field(&self, token: TextFieldToken, update: Event) {
        self.0.update_text_field(token, update)
    }

    /// Schedule a timer.
    ///
    /// This causes a [`WinHandler::timer`] call at the deadline. The
    /// return value is a token that can be used to associate the request
    /// with the handler call.
    ///
    /// Note that this is not a precise timer. On Windows, the typical
    /// resolution is around 10ms. Therefore, it's best used for things
    /// like blinking a cursor or triggering tooltips, not for anything
    /// requiring precision.
    pub fn request_timer(&self, deadline: Duration) -> TimerToken {
        self.0.request_timer(instant::Instant::now() + deadline)
    }

    /// Set the cursor icon.
    pub fn set_cursor(&mut self, cursor: &Cursor) {
        self.0.set_cursor(cursor)
    }

    pub fn make_cursor(&self, desc: &CursorDesc) -> Option<Cursor> {
        self.0.make_cursor(desc)
    }

    /// Prompt the user to choose a file to open.
    ///
    /// This won't block immediately; the file dialog will be shown whenever control returns to
    /// `druid-shell`, and the [`WinHandler::open_file`] method will be called when the dialog is
    /// closed.
    pub fn open_file(&mut self, options: FileDialogOptions) -> Option<FileDialogToken> {
        self.0.open_file(options)
    }

    /// Prompt the user to choose a path for saving.
    ///
    /// This won't block immediately; the file dialog will be shown whenever control returns to
    /// `druid-shell`, and the [`WinHandler::save_as`] method will be called when the dialog is
    /// closed.
    pub fn save_as(&mut self, options: FileDialogOptions) -> Option<FileDialogToken> {
        self.0.save_as(options)
    }

    /// Display a pop-up menu at the given position.
    ///
    /// `pos` is in the coordinate space of the window.
    pub fn show_context_menu(&self, menu: Menu, pos: Point) {
        self.0.show_context_menu(menu.into_inner(), pos)
    }

    /// Get a handle that can be used to schedule an idle task.
    pub fn get_idle_handle(&self) -> Option<IdleHandle> {
        self.0.get_idle_handle().map(IdleHandle)
    }

    /// Get the DPI scale of the window.
    ///
    /// The returned [`Scale`](crate::Scale) is a copy and thus its information will be stale after
    /// the platform DPI changes. This means you should not stash it and rely on it later; it is
    /// only guaranteed to be valid for the current pass of the runloop.
    // TODO: Can we get rid of the Result/Error for ergonomics?
    pub fn get_scale(&self) -> Result<Scale, Error> {
        self.0.get_scale().map_err(Into::into)
    }
}

#[cfg(feature = "raw-win-handle")]
unsafe impl HasRawWindowHandle for WindowHandle {
    fn raw_window_handle(&self) -> RawWindowHandle {
        self.0.raw_window_handle()
    }
}

/// A builder type for creating new windows.
pub struct WindowBuilder(backend::WindowBuilder);

impl WindowBuilder {
    /// Create a new `WindowBuilder`.
    ///
    /// Takes the [`Application`](crate::Application) that this window is for.
    pub fn new(app: Application) -> WindowBuilder {
        WindowBuilder(backend::WindowBuilder::new(app.backend_app))
    }

    /// Set the [`WinHandler`] for this window.
    ///
    /// This is the object that will receive callbacks from this window.
    pub fn set_handler(&mut self, handler: Box<dyn WinHandler>) {
        self.0.set_handler(handler)
    }

    /// Set the window's initial drawing area size in [display points].
    ///
    /// 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 choose a different size depending on its DPI or other platform-dependent
    /// configuration.  To know the actual size of the window you should handle the
    /// [`WinHandler::size`] method.
    ///
    /// [display points]: crate::Scale
    pub fn set_size(&mut self, size: Size) {
        self.0.set_size(size)
    }

    /// 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.
    ///
    /// [display points]: crate::Scale
    pub fn set_min_size(&mut self, size: Size) {
        self.0.set_min_size(size)
    }

    /// Set whether the window should be resizable.
    pub fn resizable(&mut self, resizable: bool) {
        self.0.resizable(resizable)
    }

    /// Set whether the window should have a titlebar and decorations.
    pub fn show_titlebar(&mut self, show_titlebar: bool) {
        self.0.show_titlebar(show_titlebar)
    }

    /// Set whether the window should be always positioned above all other windows.
    pub fn set_always_on_top(&mut self, always_on_top: bool) {
        self.0.set_always_on_top(always_on_top);
    }

    /// Set whether the window background should be transparent
    pub fn set_transparent(&mut self, transparent: bool) {
        self.0.set_transparent(transparent)
    }

    /// Sets the initial window position in display points.
    /// For windows with a parent, the position is relative to the parent.
    /// For windows without a parent, it is relative to the origin of the virtual screen.
    /// See also [set_level]
    ///
    /// [set_level]: crate::WindowBuilder::set_level
    pub fn set_position(&mut self, position: Point) {
        self.0.set_position(position);
    }

    /// Sets the initial [`WindowLevel`].
    pub fn set_level(&mut self, level: WindowLevel) {
        self.0.set_level(level);
    }

    /// Set the window's initial title.
    pub fn set_title(&mut self, title: impl Into<String>) {
        self.0.set_title(title)
    }

    /// Set the window's menu.
    pub fn set_menu(&mut self, menu: Menu) {
        self.0.set_menu(menu.into_inner())
    }

    /// Sets the initial state of the window.
    pub fn set_window_state(&mut self, state: WindowState) {
        self.0.set_window_state(state);
    }

    /// Attempt to construct the platform window.
    ///
    /// If this fails, your application should exit.
    pub fn build(self) -> Result<WindowHandle, Error> {
        self.0.build().map(WindowHandle).map_err(Into::into)
    }
}

/// App behavior, supplied by the app.
///
/// Many of the "window procedure" messages map to calls to this trait.
/// The methods are non-mut because the window procedure can be called
/// recursively; implementers are expected to use `RefCell` or the like,
/// but should be careful to keep the lifetime of the borrow short.
pub trait WinHandler {
    /// Provide the handler with a handle to the window so that it can
    /// invalidate or make other requests.
    ///
    /// This method passes the `WindowHandle` directly, because the handler may
    /// wish to stash it.
    fn connect(&mut self, handle: &WindowHandle);

    /// Called when the size of the window has changed.
    ///
    /// The `size` parameter is the new size in [display points](crate::Scale).
    #[allow(unused_variables)]
    fn size(&mut self, size: Size) {}

    /// Called when the [scale](crate::Scale) of the window has changed.
    ///
    /// This is always called before the accompanying [`size`](WinHandler::size).
    #[allow(unused_variables)]
    fn scale(&mut self, scale: Scale) {}

    /// Request the handler to prepare to paint the window contents.  In particular, if there are
    /// any regions that need to be repainted on the next call to `paint`, the handler should
    /// invalidate those regions by calling [`WindowHandle::invalidate_rect`] or
    /// [`WindowHandle::invalidate`].
    fn prepare_paint(&mut self);

    /// Request the handler to paint the window contents.  `invalid` is the region in [display
    /// points](crate::Scale) that needs to be repainted; painting outside the invalid region will
    /// have no effect.
    fn paint(&mut self, piet: &mut piet_common::Piet, invalid: &Region);

    /// Called when the resources need to be rebuilt.
    ///
    /// Discussion: this function is mostly motivated by using
    /// `GenericRenderTarget` on Direct2D. If we move to `DeviceContext`
    /// instead, then it's possible we don't need this.
    #[allow(unused_variables)]
    fn rebuild_resources(&mut self) {}

    /// Called when a menu item is selected.
    #[allow(unused_variables)]
    fn command(&mut self, id: u32) {}

    /// Called when a "Save As" dialog is closed.
    ///
    /// `token` is the value returned by [`WindowHandle::save_as`]. `file` contains the information
    /// of the chosen path, or `None` if the save dialog was cancelled.
    #[allow(unused_variables)]
    fn save_as(&mut self, token: FileDialogToken, file: Option<FileInfo>) {}

    /// Called when an "Open" dialog is closed.
    ///
    /// `token` is the value returned by [`WindowHandle::open_file`]. `file` contains the information
    /// of the chosen path, or `None` if the save dialog was cancelled.
    #[allow(unused_variables)]
    fn open_file(&mut self, token: FileDialogToken, file: Option<FileInfo>) {}

    /// Called when an "Open" dialog with multiple selection is closed.
    ///
    /// `token` is the value returned by [`WindowHandle::open_file`]. `files` contains the information
    /// of the chosen paths, or `None` if the save dialog was cancelled.
    #[allow(unused_variables)]
    fn open_files(&mut self, token: FileDialogToken, files: Vec<FileInfo>) {}

    /// Called on a key down event.
    ///
    /// Return `true` if the event is handled.
    #[allow(unused_variables)]
    fn key_down(&mut self, event: KeyEvent) -> bool {
        false
    }

    /// Called when a key is released. This corresponds to the WM_KEYUP message
    /// on Windows, or keyUp(withEvent:) on macOS.
    #[allow(unused_variables)]
    fn key_up(&mut self, event: KeyEvent) {}

    /// Take a lock for the text document specified by `token`.
    ///
    /// All calls to this method must be balanced with a call to
    /// [`release_input_lock`].
    ///
    /// If `mutable` is true, the lock should be a write lock, and allow calling
    /// mutating methods on InputHandler.  This method is called from the top
    /// level of the event loop and expects to acquire a lock successfully.
    ///
    /// For more information, see [the text input documentation](crate::text).
    ///
    /// [`release_input_lock`]: WinHandler::release_input_lock
    #[allow(unused_variables)]
    fn acquire_input_lock(
        &mut self,
        token: TextFieldToken,
        mutable: bool,
    ) -> Box<dyn InputHandler> {
        panic!("acquire_input_lock was called on a WinHandler that did not expect text input.")
    }

    /// Release a lock previously acquired by [`acquire_input_lock`].
    ///
    /// [`acquire_input_lock`]: WinHandler::acquire_input_lock
    #[allow(unused_variables)]
    fn release_input_lock(&mut self, token: TextFieldToken) {
        panic!("release_input_lock was called on a WinHandler that did not expect text input.")
    }

    /// Called on a mouse wheel event.
    ///
    /// The polarity is the amount to be added to the scroll position,
    /// in other words the opposite of the direction the content should
    /// move on scrolling. This polarity is consistent with the
    /// deltaX and deltaY values in a web [WheelEvent].
    ///
    /// [WheelEvent]: https://w3c.github.io/uievents/#event-type-wheel
    #[allow(unused_variables)]
    fn wheel(&mut self, event: &MouseEvent) {}

    /// Called when a platform-defined zoom gesture occurs (such as pinching
    /// on the trackpad).
    #[allow(unused_variables)]
    fn zoom(&mut self, delta: f64) {}

    /// Called when the mouse moves.
    #[allow(unused_variables)]
    fn mouse_move(&mut self, event: &MouseEvent) {}

    /// Called on mouse button down.
    #[allow(unused_variables)]
    fn mouse_down(&mut self, event: &MouseEvent) {}

    /// Called on mouse button up.
    #[allow(unused_variables)]
    fn mouse_up(&mut self, event: &MouseEvent) {}

    /// Called when the mouse cursor has left the application window
    fn mouse_leave(&mut self) {}

    /// Called on timer event.
    ///
    /// This is called at (approximately) the requested deadline by a
    /// [`WindowHandle::request_timer()`] call. The token argument here is the same
    /// as the return value of that call.
    #[allow(unused_variables)]
    fn timer(&mut self, token: TimerToken) {}

    /// Called when this window becomes the focused window.
    #[allow(unused_variables)]
    fn got_focus(&mut self) {}

    /// Called when this window stops being the focused window.
    #[allow(unused_variables)]
    fn lost_focus(&mut self) {}

    /// Called when the shell requests to close the window, for example because the user clicked
    /// the little "X" in the titlebar.
    ///
    /// If you want to actually close the window in response to this request, call
    /// [`WindowHandle::close`]. If you don't implement this method, clicking the titlebar "X" will
    /// have no effect.
    fn request_close(&mut self) {}

    /// Called when the window is being destroyed. Note that this happens
    /// earlier in the sequence than drop (at WM_DESTROY, while the latter is
    /// WM_NCDESTROY).
    #[allow(unused_variables)]
    fn destroy(&mut self) {}

    /// Called when a idle token is requested by [`IdleHandle::schedule_idle()`] call.
    #[allow(unused_variables)]
    fn idle(&mut self, token: IdleToken) {}

    /// Get a reference to the handler state. Used mostly by idle handlers.
    fn as_any(&mut self) -> &mut dyn Any;
}

impl From<backend::WindowHandle> for WindowHandle {
    fn from(src: backend::WindowHandle) -> WindowHandle {
        WindowHandle(src)
    }
}

#[cfg(test)]
mod test {
    use super::*;

    use static_assertions as sa;

    sa::assert_not_impl_any!(WindowHandle: Send, Sync);
    sa::assert_impl_all!(IdleHandle: Send, Sync);
}