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
// Copyright (C) 2019 Robin Krahl <robin.krahl@ireas.org> // SPDX-License-Identifier: MIT #![warn(missing_docs, rust_2018_compatibility, rust_2018_idioms, unused)] //! Displays dialog boxes using various backends. //! //! The `dialog` crate can be used to display different types of dialog boxes. The supported types //! are: //! - [`Input`][]: a text input dialog //! - [`Message`][]: a simple message box //! - [`Password`][]: a password input dialog //! - [`Question`][]: a question dialog box //! //! These dialog boxes can be displayed using various backends: //! - [`Dialog`][]: uses `dialog` to display ncurses-based dialog boxes (requires the external //! `dialog` tool) //! - [`Stdio`][]: prints messages to the standard output and reads user input form standard input //! (intended as a fallback backend) //! - [`Zenity`][]: uses `zenity` to display GTK-based dialog boxes (requires the external `zenity` //! tool) //! //! You can let `dialog` choose the backend by calling the [`show`][] method on a dialog box. If //! you want to choose the backend yourself, create a backend instance and pass it to //! [`show_with`][]. You can also use the [`default_backend`][] function to create a backend. //! //! # Examples //! //! Show a message box using the default backend: //! //! ```no_run //! use dialog::DialogBox; //! //! dialog::Message::new("Did you know that I am using the dialog crate?") //! .title("Public Service Announcement") //! .show() //! .expect("Could not display dialog box"); //! ``` //! //! Show a message box using the [`Dialog`][] backend with customized settings: //! //! ```no_run //! use dialog::DialogBox; //! //! let mut backend = dialog::backends::Dialog::new(); //! backend.set_backtitle("dialog demo"); //! backend.set_width(100); //! backend.set_height(10); //! dialog::Message::new("Did you know that I am using the dialog crate?") //! .title("Public Service Announcement") //! .show_with(&backend) //! .expect("Could not display dialog box"); //! ``` //! //! Query a string from the user: //! //! ```no_run //! use dialog::DialogBox; //! //! let name = dialog::Input::new("Please enter your name") //! .title("Name") //! .show() //! .expect("Could not display dialog box"); //! match name { //! Some(name) => println!("Hello {}!", name), //! None => println!("Hello stranger!"), //! }; //! ``` //! //! [`Dialog`]: backends/struct.Dialog.html //! [`Input`]: struct.Input.html //! [`Message`]: struct.Message.html //! [`Password`]: struct.Password.html //! [`Question`]: struct.Question.html //! [`Stdio`]: backends/struct.Stdio.html //! [`Zenity`]: backends/struct.Zenity.html //! [`default_backend`]: fn.default_backend.html //! [`show`]: trait.DialogBox.html#method.show //! [`show_with`]: trait.DialogBox.html#method.show_with mod error; /// Backends that display dialog boxes. /// /// All backends implement the [`Backend`][] trait. Some backends might provide additional /// settings. For a list of supported backends, see the [top-level crate documentation](./..) or /// the [list of structs in this module](#structs). /// /// [`Backend`]: trait.Backend.html pub mod backends; use std::env; pub use crate::error::{Error, Result}; /// A dialog box that can be shown using a backend. /// /// Some dialog boxes might return data of the type `Output`. pub trait DialogBox { /// The type of the data returned by the dialog box. type Output; /// Shows this dialog box using the default backend and returns the output. /// /// `box.show()` is a shorthand for `box.show_with(default_backend())`. fn show(&self) -> Result<Self::Output> { self.show_with(default_backend()) } /// Shows this dialog box using the given backend and returns the output. fn show_with<B>(&self, backend: impl AsRef<B>) -> Result<Self::Output> where B: backends::Backend + ?Sized; } /// A message box. /// /// This dialog box displays a text and an optional title and has a single OK button. It does not /// produce any output. /// /// # Example /// /// ```no_run /// use dialog::DialogBox; /// /// dialog::Message::new("The operation was successful.") /// .title("Success") /// .show() /// .expect("Could not display dialog box"); /// ``` pub struct Message { text: String, title: Option<String>, } impl Message { /// Creates a new message box with the given text. pub fn new(text: impl Into<String>) -> Message { Message { text: text.into(), title: None, } } /// Sets the title of this message box. /// /// This method returns a reference to `self` to enable chaining. pub fn title(&mut self, title: impl Into<String>) -> &mut Message { self.title = Some(title.into()); self } } impl DialogBox for Message { type Output = (); fn show_with<B>(&self, backend: impl AsRef<B>) -> Result<Self::Output> where B: backends::Backend + ?Sized, { backend.as_ref().show_message(self) } } /// A dialog box with a text input field. /// /// This dialog box displays a text and an input field. It returns the text entered by the user or /// `None` if the user cancelled the dialog. /// /// # Example /// /// ```no_run /// use dialog::DialogBox; /// /// let name = dialog::Input::new("Please enter your name") /// .title("Name") /// .show() /// .expect("Could not display dialog box"); /// match name { /// Some(name) => println!("Hello {}!", name), /// None => println!("Hello stranger!"), /// }; /// ``` pub struct Input { text: String, title: Option<String>, default: Option<String>, } impl Input { /// Creates a new input dialog box with the given text. pub fn new(text: impl Into<String>) -> Input { Input { text: text.into(), title: None, default: None, } } /// Sets the title of this input box. /// /// This method returns a reference to `self` to enable chaining. pub fn title(&mut self, title: impl Into<String>) -> &mut Input { self.title = Some(title.into()); self } /// Sets the default value of this input box. /// /// This method returns a reference to `self` to enable chaining. pub fn default(&mut self, default: impl Into<String>) -> &mut Input { self.default = Some(default.into()); self } } impl DialogBox for Input { type Output = Option<String>; fn show_with<B>(&self, backend: impl AsRef<B>) -> Result<Self::Output> where B: backends::Backend + ?Sized, { backend.as_ref().show_input(self) } } /// A dialog box with a password input field. /// /// This dialog box displays a text and a password input field. It returns the password entered by /// the user or `None` if the user cancelled the dialog. /// /// # Example /// /// ```no_run /// use dialog::DialogBox; /// /// let password = dialog::Password::new("Please enter a new password") /// .title("Password") /// .show() /// .expect("Could not display dialog box"); /// match password { /// Some(password) => println!("Your new password is: {}", password), /// None => println!("You do not want to have a password."), /// }; /// ``` pub struct Password { text: String, title: Option<String>, } impl Password { /// Creates a new password dialog box with the given text. pub fn new(text: impl Into<String>) -> Password { Password { text: text.into(), title: None, } } /// Sets the title of this password dialog box. /// /// This method returns a reference to `self` to enable chaining. pub fn title(&mut self, title: impl Into<String>) -> &mut Password { self.title = Some(title.into()); self } } impl DialogBox for Password { type Output = Option<String>; fn show_with<B>(&self, backend: impl AsRef<B>) -> Result<Self::Output> where B: backends::Backend + ?Sized, { backend.as_ref().show_password(self) } } /// A user choise in a dialog box. #[derive(Clone, Copy, Debug, PartialEq)] pub enum Choice { /// The yes button. Yes, /// The no button. No, /// The cancel button or a cancelled dialog. Cancel, } /// A question dialog box. /// /// This dialog box displays a text and an optional title and has a yes and a no button. The /// output is the button presed by the user, or Cancel if the dialog has been cancelled. /// /// # Example /// /// ```no_run /// use dialog::DialogBox; /// /// let choice = dialog::Question::new("Do you want to continue?") /// .title("Question") /// .show() /// .expect("Could not display dialog box"); /// println!("The user chose: {:?}", choice); /// ``` pub struct Question { text: String, title: Option<String>, } impl Question { /// Creates a new question dialog with the given text. pub fn new(text: impl Into<String>) -> Question { Question { text: text.into(), title: None, } } /// Sets the title of this question dialog box. /// /// This method returns a reference to `self` to enable chaining. pub fn title(&mut self, title: impl Into<String>) -> &mut Question { self.title = Some(title.into()); self } } impl DialogBox for Question { type Output = Choice; fn show_with<B>(&self, backend: impl AsRef<B>) -> Result<Self::Output> where B: backends::Backend + ?Sized, { backend.as_ref().show_question(self) } } /// Creates a new instance of the default backend. /// /// The following steps are performed to determine the default backend: /// - If the `DIALOG` environment variable is set to a valid backend name, this backend is used. /// A valid backend name is the name of a struct in the `backends` module implementing the /// `Backend` trait in any case. /// - If the `DISPLAY` environment variable is set, the first available backend from this list is /// used: /// - [`Zenity`][] /// - If the [`Dialog`][] backend is available, it is used. /// - Otherwise, a [`Stdio`][] instance is returned. /// /// [`Dialog`]: backends/struct.Dialog.html /// [`Stdio`]: backends/struct.Stdio.html /// [`Zenity`]: backends/struct.Zenity.html pub fn default_backend() -> Box<dyn backends::Backend> { if let Ok(backend) = env::var("DIALOG") { if let Some(backend) = backends::from_str(&backend) { return backend; } } if let Ok(display) = env::var("DISPLAY") { if !display.is_empty() { if backends::Zenity::is_available() { return Box::new(backends::Zenity::new()); } } } if backends::Dialog::is_available() { Box::new(backends::Dialog::new()) } else { Box::new(backends::Stdio::new()) } }