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
// Copyright 2019 The xi-editor 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. //! Custom commands. use std::any::{self, Any}; use std::{ marker::PhantomData, sync::{Arc, Mutex}, }; use crate::{WidgetId, WindowId}; /// The identity of a [`Selector`]. /// /// [`Selector`]: struct.Selector.html pub(crate) type SelectorSymbol = &'static str; /// An identifier for a particular command. /// /// This should be a unique string identifier. /// Having multiple selectors with the same identifier but different payload /// types is not allowed and can cause [`Command::get`] and [`get_unchecked`] to panic. /// /// The type parameter `T` specifies the command's payload type. /// See [`Command`] for more information. /// /// Certain `Selector`s are defined by druid, and have special meaning /// to the framework; these are listed in the [`druid::commands`] module. /// /// [`Command`]: struct.Command.html /// [`Command::get`]: struct.Command.html#method.get /// [`get_unchecked`]: struct.Command.html#method.get_unchecked /// [`druid::commands`]: commands/index.html #[derive(Debug, PartialEq, Eq)] pub struct Selector<T = ()>(SelectorSymbol, PhantomData<*const T>); /// An arbitrary command. /// /// A `Command` consists of a [`Selector`], that indicates what the command is /// and what type of payload it carries, as well as the actual payload. /// /// If the payload can't or shouldn't be cloned, /// wrapping it with [`SingleUse`] allows you to `take` the payload. /// The [`SingleUse`] docs give an example on how to do this. /// /// Generic payloads can be achieved with `Selector<Box<dyn Any>>`. /// In this case it could make sense to use utility functions to construct /// such commands in order to maintain as much static typing as possible. /// The [`EventCtx::new_window`] method is an example of this. /// /// # Examples /// ``` /// use druid::{Command, Selector}; /// /// let selector = Selector::new("process_rows"); /// let rows = vec![1, 3, 10, 12]; /// let command = Command::new(selector, rows); /// /// assert_eq!(command.get(selector), Some(&vec![1, 3, 10, 12])); /// ``` /// /// [`EventCtx::new_window`]: struct.EventCtx.html#method.new_window /// [`SingleUse`]: struct.SingleUse.html /// [`Selector`]: struct.Selector.html #[derive(Debug, Clone)] pub struct Command { symbol: SelectorSymbol, payload: Arc<dyn Any>, } /// A wrapper type for [`Command`] payloads that should only be used once. /// /// This is useful if you have some resource that cannot be /// cloned, and you wish to send it to another widget. /// /// # Examples /// ``` /// use druid::{Command, Selector, SingleUse}; /// /// struct CantClone(u8); /// /// let selector = Selector::new("use-once"); /// let num = CantClone(42); /// let command = Command::new(selector, SingleUse::new(num)); /// /// let payload: &SingleUse<CantClone> = command.get_unchecked(selector); /// if let Some(num) = payload.take() { /// // now you own the data /// assert_eq!(num.0, 42); /// } /// /// // subsequent calls will return `None` /// assert!(payload.take().is_none()); /// ``` /// /// [`Command`]: struct.Command.html pub struct SingleUse<T>(Mutex<Option<T>>); /// The target of a command. #[derive(Clone, Copy, Debug, PartialEq)] pub enum Target { /// The target is the top-level application. Global, /// The target is a window; the event will be delivered to all /// widgets in that window. Window(WindowId), /// The target is a specific widget. Widget(WidgetId), } /// Commands with special meaning, defined by druid. /// /// See [`Command`] for more info. /// /// [`Command`]: ../struct.Command.html pub mod sys { use std::any::Any; use super::Selector; use crate::{FileDialogOptions, FileInfo, SingleUse}; /// Quit the running application. This command is handled by the druid library. pub const QUIT_APP: Selector = Selector::new("druid-builtin.quit-app"); /// Hide the application. (mac only?) pub const HIDE_APPLICATION: Selector = Selector::new("druid-builtin.menu-hide-application"); /// Hide all other applications. (mac only?) pub const HIDE_OTHERS: Selector = Selector::new("druid-builtin.menu-hide-others"); /// The selector for a command to create a new window. pub(crate) const NEW_WINDOW: Selector<SingleUse<Box<dyn Any>>> = Selector::new("druid-builtin.new-window"); /// The selector for a command to close a window. /// /// The command must target a specific window. /// When calling `submit_command` on a `Widget`s context, passing `None` as target /// will automatically target the window containing the widget. pub const CLOSE_WINDOW: Selector = Selector::new("druid-builtin.close-window"); /// Close all windows. pub const CLOSE_ALL_WINDOWS: Selector = Selector::new("druid-builtin.close-all-windows"); /// The selector for a command to bring a window to the front, and give it focus. /// /// The command must target a specific window. /// When calling `submit_command` on a `Widget`s context, passing `None` as target /// will automatically target the window containing the widget. pub const SHOW_WINDOW: Selector = Selector::new("druid-builtin.show-window"); /// Display a context (right-click) menu. The payload must be the [`ContextMenu`] /// object to be displayed. /// /// [`ContextMenu`]: ../struct.ContextMenu.html pub(crate) const SHOW_CONTEXT_MENU: Selector<Box<dyn Any>> = Selector::new("druid-builtin.show-context-menu"); /// The selector for a command to set the window's menu. The payload should /// be a [`MenuDesc`] object. /// /// [`MenuDesc`]: ../struct.MenuDesc.html pub(crate) const SET_MENU: Selector<Box<dyn Any>> = Selector::new("druid-builtin.set-menu"); /// Show the application preferences. pub const SHOW_PREFERENCES: Selector = Selector::new("druid-builtin.menu-show-preferences"); /// Show the application about window. pub const SHOW_ABOUT: Selector = Selector::new("druid-builtin.menu-show-about"); /// Show all applications. pub const SHOW_ALL: Selector = Selector::new("druid-builtin.menu-show-all"); /// Show the new file dialog. pub const NEW_FILE: Selector = Selector::new("druid-builtin.menu-file-new"); /// When submitted by the application, a file picker dialog will be shown to the user, /// and an [`OPEN_FILE`] command will be sent if a file is chosen. /// /// [`OPEN_FILE`]: constant.OPEN_FILE.html pub const SHOW_OPEN_PANEL: Selector<FileDialogOptions> = Selector::new("druid-builtin.menu-file-open"); /// Open a file, must be handled by the application. /// /// [`FileInfo`]: ../struct.FileInfo.html pub const OPEN_FILE: Selector<FileInfo> = Selector::new("druid-builtin.open-file-path"); /// When submitted by the application, the system will show the 'save as' panel, /// and if a path is selected the system will issue a [`SAVE_FILE`] command /// with the selected path as the payload. /// /// [`SAVE_FILE`]: constant.SAVE_FILE.html pub const SHOW_SAVE_PANEL: Selector<FileDialogOptions> = Selector::new("druid-builtin.menu-file-save-as"); /// Save the current file, must be handled by the application. /// /// How this should be handled depends on the payload: /// `Some(handle)`: the app should save to that file and store the `handle` for future use. /// `None`: the app should have received `Some` before and use the stored `FileInfo`. pub const SAVE_FILE: Selector<Option<FileInfo>> = Selector::new("druid-builtin.menu-file-save"); /// Show the print-setup window. pub const PRINT_SETUP: Selector = Selector::new("druid-builtin.menu-file-print-setup"); /// Show the print dialog. pub const PRINT: Selector = Selector::new("druid-builtin.menu-file-print"); /// Show the print preview. pub const PRINT_PREVIEW: Selector = Selector::new("druid-builtin.menu-file-print"); /// Cut the current selection. pub const CUT: Selector = Selector::new("druid-builtin.menu-cut"); /// Copy the current selection. pub const COPY: Selector = Selector::new("druid-builtin.menu-copy"); /// Paste. pub const PASTE: Selector = Selector::new("druid-builtin.menu-paste"); /// Undo. pub const UNDO: Selector = Selector::new("druid-builtin.menu-undo"); /// Redo. pub const REDO: Selector = Selector::new("druid-builtin.menu-redo"); } impl Selector<()> { /// A selector that does nothing. pub const NOOP: Selector = Selector::new(""); } impl<T> Selector<T> { /// Create a new `Selector` with the given string. pub const fn new(s: &'static str) -> Selector<T> { Selector(s, PhantomData) } /// Returns the `SelectorSymbol` identifying this `Selector`. pub(crate) const fn symbol(self) -> SelectorSymbol { self.0 } } impl<T: Any> Selector<T> { /// Convenience method for [`Command::new`] with this selector. /// /// If the payload is `()` there is no need to call this, /// as `Selector<()>` implements `Into<Command>`. /// /// [`Command::new`]: struct.Command.html#method.new pub fn with(self, payload: T) -> Command { Command::new(self, payload) } } impl Command { /// Create a new `Command` with a payload. /// /// [`Selector::with`] can be used to create `Command`s more conveniently. /// /// If you do not need a payload, [`Selector`] implements `Into<Command>`. /// /// [`Selector`]: struct.Selector.html /// [`Selector::with`]: struct.Selector.html#method.with pub fn new<T: Any>(selector: Selector<T>, payload: T) -> Self { Command { symbol: selector.symbol(), payload: Arc::new(payload), } } /// Used to create a command from the types sent via an `ExtEventSink`. pub(crate) fn from_ext(symbol: SelectorSymbol, payload: Box<dyn Any>) -> Self { Command { symbol, payload: payload.into(), } } /// Returns `true` if `self` matches this `selector`. pub fn is<T>(&self, selector: Selector<T>) -> bool { self.symbol == selector.symbol() } /// Returns `Some(&T)` (this `Command`'s payload) if the selector matches. /// /// Returns `None` when `self.is(selector) == false`. /// /// Alternatively you can check the selector with [`is`] and then use [`get_unchecked`]. /// /// # Panics /// /// Panics when the payload has a different type, than what the selector is supposed to carry. /// This can happen when two selectors with different types but the same key are used. /// /// [`get_unchecked`]: #method.get_unchecked pub fn get<T: Any>(&self, selector: Selector<T>) -> Option<&T> { if self.symbol == selector.symbol() { Some(self.payload.downcast_ref().unwrap_or_else(|| { panic!( "The selector \"{}\" exists twice with different types. See druid::Command::get for more information", selector.symbol() ) })) } else { None } } /// Returns a reference to this `Command`'s payload. /// /// If the selector has already been checked with [`is`], then `get_unchecked` can be used safely. /// Otherwise you should use [`get`] instead. /// /// # Panics /// /// Panics when `self.is(selector) == false`. /// /// Panics when the payload has a different type, than what the selector is supposed to carry. /// This can happen when two selectors with different types but the same key are used. /// /// [`is`]: #method.is /// [`get`]: #method.get pub fn get_unchecked<T: Any>(&self, selector: Selector<T>) -> &T { self.get(selector).unwrap_or_else(|| { panic!( "Expected selector \"{}\" but the command was \"{}\".", selector.symbol(), self.symbol ) }) } } impl<T: Any> SingleUse<T> { pub fn new(data: T) -> Self { SingleUse(Mutex::new(Some(data))) } /// Takes the value, leaving a None in its place. pub fn take(&self) -> Option<T> { self.0.lock().unwrap().take() } } impl From<Selector> for Command { fn from(selector: Selector) -> Command { Command { symbol: selector.symbol(), payload: Arc::new(()), } } } impl<T> std::fmt::Display for Selector<T> { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!(f, "Selector(\"{}\", {})", self.0, any::type_name::<T>()) } } // This has do be done explicitly, to avoid the Copy bound on `T`. // See https://doc.rust-lang.org/std/marker/trait.Copy.html#how-can-i-implement-copy . impl<T> Copy for Selector<T> {} impl<T> Clone for Selector<T> { fn clone(&self) -> Self { *self } } impl From<WindowId> for Target { fn from(id: WindowId) -> Target { Target::Window(id) } } impl From<WidgetId> for Target { fn from(id: WidgetId) -> Target { Target::Widget(id) } } impl Into<Option<Target>> for WindowId { fn into(self) -> Option<Target> { Some(Target::Window(self)) } } impl Into<Option<Target>> for WidgetId { fn into(self) -> Option<Target> { Some(Target::Widget(self)) } } #[cfg(test)] mod tests { use super::*; #[test] fn get_payload() { let sel = Selector::new("my-selector"); let payload = vec![0, 1, 2]; let command = Command::new(sel, payload); assert_eq!(command.get(sel), Some(&vec![0, 1, 2])); } }