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
//! Facilitates querying and selecting from a set of options in a structured format.
use std::fmt::Display;
use crate::{
core::{
crossterm::{
self,
event::Event,
style::{Attribute, Attributes, Color, ContentStyle},
},
render::{Renderer, SharedRenderer},
Widget,
},
preset::Evaluator,
widgets::{
listbox::{self, Listbox},
text::{self, Text},
text_editor::{self, Mode},
},
Signal,
};
pub mod evaluate;
/// Represents the indices of various components in the query selector preset.
#[derive(PartialEq, Eq, PartialOrd, Ord)]
pub enum Index {
Title = 0,
Readline = 1,
List = 2,
}
/// Used to process and filter a list of options
/// based on the input text in the `QuerySelector` component.
pub type Filter = fn(&str, &Vec<String>) -> Vec<String>;
/// Represents a query selection component that combines a text editor
/// for input and a list box
/// for displaying filtered options based on the input.
pub struct QuerySelector {
/// 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>,
/// State for the title displayed above the query selection.
pub title: text::State,
/// State for the text editor component.
pub readline: text_editor::State,
/// Initial state for the list box component.
pub init_list: Listbox,
/// State for the list box component.
pub list: listbox::State,
/// A filter function to apply to the list box items
/// based on the text editor input.
pub filter: Filter,
}
#[async_trait::async_trait]
impl crate::Prompt for QuerySelector {
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::List, self.list.create_graphemes(size.0, size.1)),
],
true,
)
.await?,
));
Ok(())
}
async fn evaluate(&mut self, event: &Event) -> anyhow::Result<Signal> {
// Store the previous text in the readline before evaluating the event.
let prev = self.readline.texteditor.text_without_cursor().to_string();
// Evaluate the event using the provided evaluator function.
let ret = (self.evaluator)(event, self).await;
// If the text in the readline has changed, we need to filter the list.
if prev != self.readline.texteditor.text_without_cursor().to_string() {
let query = self.readline.texteditor.text_without_cursor().to_string();
let list = (self.filter)(
&query,
&self
.init_list
.items()
.iter()
.map(|s| s.to_string())
.collect(),
);
self.list.listbox = Listbox::from(list);
}
// Update the renderer with the new state of the components.
let size = crossterm::terminal::size()?;
self.render(size.0, size.1).await?;
ret
}
type Return = String;
fn finalize(&mut self) -> anyhow::Result<Self::Return> {
Ok(self.list.listbox.get().to_string())
}
}
impl QuerySelector {
/// Constructs a new `QuerySelector` instance
/// with a list of items and a filter function.
///
/// # Arguments
///
/// * `items` - An iterator over items that implement the `Display` trait,
/// to be used as options in the list box.
/// * `filter` - A function that takes the current input
/// from the text editor and the list of items,
/// returning a filtered list of items to display.
pub fn new<T, I>(items: I, filter: Filter) -> Self
where
T: Display,
I: IntoIterator<Item = T>,
{
let listbox = Listbox::from(items);
Self {
renderer: None,
evaluator: |event, ctx| Box::pin(evaluate::default(event, ctx)),
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: None,
config: text_editor::config::Config {
prefix: String::from("❯❯ "),
mask: None,
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: Default::default(),
lines: Default::default(),
},
},
init_list: listbox.clone(),
list: listbox::State {
listbox,
config: listbox::config::Config {
cursor: String::from("❯ "),
active_item_style: Some(ContentStyle {
foreground_color: Some(Color::DarkCyan),
..Default::default()
}),
inactive_item_style: Some(ContentStyle::default()),
lines: Default::default(),
},
},
filter,
}
}
/// Sets the title text displayed above the query selection.
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
}
/// Sets the prefix string displayed before the input text in the text editor component.
pub fn prefix<T: AsRef<str>>(mut self, prefix: T) -> Self {
self.readline.config.prefix = prefix.as_ref().to_string();
self
}
/// Sets the style for the prefix string in the text editor component.
pub fn prefix_style(mut self, style: ContentStyle) -> Self {
self.readline.config.prefix_style = style;
self
}
/// Sets the style for the active character (the character at the cursor position) in the text editor component.
pub fn active_char_style(mut self, style: ContentStyle) -> Self {
self.readline.config.active_char_style = style;
self
}
/// Sets the style for inactive characters (characters not at the cursor position) in the text editor component.
pub fn inactive_char_style(mut self, style: ContentStyle) -> Self {
self.readline.config.inactive_char_style = style;
self
}
/// Sets the editing mode for the text editor component.
pub fn edit_mode(mut self, mode: Mode) -> Self {
self.readline.config.edit_mode = mode;
self
}
/// Sets the number of lines available for the text editor component.
pub fn text_editor_lines(mut self, lines: usize) -> Self {
self.readline.config.lines = Some(lines);
self
}
/// Sets the cursor symbol used in the list box component.
pub fn cursor<T: AsRef<str>>(mut self, cursor: T) -> Self {
self.list.config.cursor = cursor.as_ref().to_string();
self
}
/// Sets the style for active (currently selected) items in the list box component.
pub fn active_item_style(mut self, style: ContentStyle) -> Self {
self.list.config.active_item_style = Some(style);
self
}
/// Sets the style for inactive (not currently selected) items in the list box component.
pub fn inactive_item_style(mut self, style: ContentStyle) -> Self {
self.list.config.inactive_item_style = Some(style);
self
}
/// Sets the number of lines available for the list box component.
pub fn listbox_lines(mut self, lines: usize) -> Self {
self.list.config.lines = Some(lines);
self
}
/// Sets the evaluator function for the text prompt.
pub fn evaluator(mut self, evaluator: Evaluator<Self>) -> Self {
self.evaluator = evaluator;
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::List, self.list.create_graphemes(width, height)),
])
.render()
.await
}
None => Err(anyhow::anyhow!("Renderer not initialized")),
}
}
}