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
|
// 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
//!
//! These dialog boxes can be displayed using various backends:
//! - [`Dialog`][]: uses `dialog` to display ncurses-based dialog boxes (requires the external
//! `dialog` 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
//! [`default_backend`]: fn.default_backend.html
//! [`show`]: trait.DialogBox.html#method.show
//! [`show_with`]: trait.DialogBox.html#method.show_with
/// 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::io::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(&self, backend: &impl backends::Backend) -> Result<Self::Output>;
}
/// 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(&self, backend: &impl backends::Backend) -> Result<Self::Output> {
backend.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(&self, backend: &impl backends::Backend) -> Result<Self::Output> {
backend.show_input(self)
}
}
/// Creates a new instance of the default backend.
///
/// The current implementation always returns a [`Dialog`][] instance.
///
/// [`Dialog`]: backends/struct.Dialog.html
pub fn default_backend() -> impl backends::Backend {
backends::Dialog::new()
}
|
