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
//! Offers functionality for reading input from the user.
use std::collections::HashSet;
use crate::{
core::{
crossterm::{
self,
event::Event,
style::{Attribute, Attributes, Color, ContentStyle},
},
render::{Renderer, SharedRenderer},
Widget,
},
preset::Evaluator,
suggest::Suggest,
validate::{ErrorMessageGenerator, Validator, ValidatorManager},
widgets::{
listbox::{self, Listbox},
text::{self, Text},
text_editor::{self, History},
},
Signal,
};
pub mod evaluate;
/// Represents the indices of various components in the readline preset.
#[derive(PartialEq, Eq, PartialOrd, Ord)]
pub enum Index {
Title = 0,
Readline = 1,
Suggestion = 2,
ErrorMessage = 3,
}
/// Represents the focus state of the readline,
/// determining which component is currently active for input handling.
pub enum Focus {
Readline,
Suggestion,
}
/// `Readline` struct provides functionality
/// for reading a single line of input from the user.
/// It supports various configurations
/// such as input masking, history, suggestions, and custom styles.
pub struct Readline {
/// Shared renderer for the prompt, allowing for rendering of UI components.
pub renderer: Option<SharedRenderer<Index>>,
/// Function to evaluate the input events and update the state of the prompt.
pub evaluator: Evaluator<Self>,
/// Holds the focus state for event handling, determining which component is currently focused.
pub focus: Focus,
/// Holds a title's renderer state, used for rendering the title section.
pub title: text::State,
/// Holds a text editor's renderer state, used for rendering the text input area.
pub readline: text_editor::State,
/// Optional suggest component for autocomplete functionality.
pub suggest: Option<Suggest>,
/// Holds a suggest box's renderer state, used when rendering suggestions for autocomplete.
pub suggestions: listbox::State,
/// Optional validator manager for input validation.
pub validator: Option<ValidatorManager<str>>,
/// Holds an error message's renderer state, used for rendering error messages.
pub error_message: text::State,
}
impl Default for Readline {
fn default() -> Self {
Self {
renderer: None,
evaluator: |event, ctx| Box::pin(evaluate::default(event, ctx)),
focus: Focus::Readline,
title: text::State {
config: text::config::Config {
style: Some(ContentStyle {
attributes: Attributes::from(Attribute::Bold),
..Default::default()
}),
..Default::default()
},
..Default::default()
},
readline: text_editor::State {
texteditor: Default::default(),
history: Default::default(),
config: text_editor::config::Config {
prefix: String::from("❯❯ "),
mask: Default::default(),
prefix_style: ContentStyle {
foreground_color: Some(Color::DarkGreen),
..Default::default()
},
active_char_style: ContentStyle {
background_color: Some(Color::DarkCyan),
..Default::default()
},
inactive_char_style: ContentStyle::default(),
edit_mode: Default::default(),
word_break_chars: HashSet::from([' ']),
lines: Default::default(),
},
},
suggest: Default::default(),
suggestions: listbox::State {
listbox: Listbox::from(Vec::<String>::new()),
config: listbox::config::Config {
cursor: String::from("❯ "),
active_item_style: Some(ContentStyle {
foreground_color: Some(Color::DarkGrey),
background_color: Some(Color::DarkYellow),
..Default::default()
}),
inactive_item_style: Some(ContentStyle {
foreground_color: Some(Color::DarkGrey),
..Default::default()
}),
lines: Some(3),
},
},
validator: Default::default(),
error_message: text::State {
text: Default::default(),
config: text::config::Config {
style: Some(ContentStyle {
foreground_color: Some(Color::DarkRed),
attributes: Attributes::from(Attribute::Bold),
..Default::default()
}),
lines: None,
},
},
}
}
}
#[async_trait::async_trait]
impl crate::Prompt for Readline {
async fn initialize(&mut self) -> anyhow::Result<()> {
let size = crossterm::terminal::size()?;
self.renderer = Some(SharedRenderer::new(
Renderer::try_new_with_graphemes(
[
(Index::Title, self.title.create_graphemes(size.0, size.1)),
(
Index::Readline,
self.readline.create_graphemes(size.0, size.1),
),
(
Index::Suggestion,
self.suggestions.create_graphemes(size.0, size.1),
),
(
Index::ErrorMessage,
self.error_message.create_graphemes(size.0, size.1),
),
],
true,
)
.await?,
));
Ok(())
}
async fn evaluate(&mut self, event: &Event) -> anyhow::Result<Signal> {
let ret = (self.evaluator)(event, self).await;
let size = crossterm::terminal::size()?;
self.render(size.0, size.1).await?;
ret
}
type Return = String;
fn finalize(&mut self) -> anyhow::Result<Self::Return> {
let ret = self.readline.texteditor.text_without_cursor().to_string();
// Reset the text editor state for the next prompt.
self.readline.texteditor.erase_all();
Ok(ret)
}
}
impl Readline {
/// Sets the title text displayed above the input field.
pub fn title<T: AsRef<str>>(mut self, text: T) -> Self {
self.title.text = Text::from(text);
self
}
/// Sets the style for the title text.
pub fn title_style(mut self, style: ContentStyle) -> Self {
self.title.config.style = Some(style);
self
}
/// Enables suggestion functionality with the provided `Suggest` instance.
pub fn enable_suggest(mut self, suggest: Suggest) -> Self {
self.suggest = Some(suggest);
self
}
/// Enables history functionality allowing navigation through previous inputs.
pub fn enable_history(mut self) -> Self {
self.readline.history = Some(History::default());
self
}
/// Sets the prefix string displayed before the input text.
pub fn prefix<T: AsRef<str>>(mut self, prefix: T) -> Self {
self.readline.config.prefix = prefix.as_ref().to_string();
self
}
/// Sets the character used for masking input text, typically used for password fields.
pub fn mask(mut self, mask: char) -> Self {
self.readline.config.mask = Some(mask);
self
}
/// Sets the style for the prefix string.
pub fn prefix_style(mut self, style: ContentStyle) -> Self {
self.readline.config.prefix_style = style;
self
}
/// Sets the style for the currently active character in the input field.
pub fn active_char_style(mut self, style: ContentStyle) -> Self {
self.readline.config.active_char_style = style;
self
}
/// Sets the style for characters that are not currently active in the input field.
pub fn inactive_char_style(mut self, style: ContentStyle) -> Self {
self.readline.config.inactive_char_style = style;
self
}
/// Sets the edit mode for the text editor, either insert or overwrite.
pub fn edit_mode(mut self, mode: text_editor::Mode) -> Self {
self.readline.config.edit_mode = mode;
self
}
/// Sets the characters to be for word break.
pub fn word_break_chars(mut self, characters: HashSet<char>) -> Self {
self.readline.config.word_break_chars = characters;
self
}
/// Sets the number of lines available for rendering the text editor.
pub fn text_editor_lines(mut self, lines: usize) -> Self {
self.readline.config.lines = Some(lines);
self
}
/// Sets the function to evaluate the input, allowing for custom evaluation logic.
pub fn evaluator(mut self, evaluator: Evaluator<Self>) -> Self {
self.evaluator = evaluator;
self
}
/// Configures a validator for the input with a function to validate the input and another to configure the error message.
pub fn validator(
mut self,
validator: Validator<str>,
error_message_generator: ErrorMessageGenerator<str>,
) -> Self {
self.validator = Some(ValidatorManager::new(validator, error_message_generator));
self
}
/// Render the prompt with the specified width and height.
async fn render(&mut self, width: u16, height: u16) -> anyhow::Result<()> {
match self.renderer.as_ref() {
Some(renderer) => {
renderer
.update([
(Index::Title, self.title.create_graphemes(width, height)),
(
Index::Readline,
self.readline.create_graphemes(width, height),
),
(
Index::Suggestion,
self.suggestions.create_graphemes(width, height),
),
(
Index::ErrorMessage,
self.error_message.create_graphemes(width, height),
),
])
.render()
.await
}
None => Err(anyhow::anyhow!("Renderer not initialized")),
}
}
}