Struct broot::command::PanelInput
source · pub struct PanelInput {
pub input_field: InputField,
/* private fields */
}Expand description
Wrap the input of a panel, receive events and make commands
Fields§
§input_field: InputFieldImplementations§
source§impl PanelInput
impl PanelInput
sourcepub fn new(area: Area) -> Self
pub fn new(area: Area) -> Self
Examples found in repository?
src/app/panel.rs (line 44)
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
pub fn new(
id: PanelId,
state: Box<dyn PanelState>,
areas: Areas,
con: &AppContext,
) -> Self {
let mut input = PanelInput::new(areas.input.clone());
input.set_content(&state.get_starting_input());
let status = state.no_verb_status(false, con);
Self {
id,
states: vec![state],
areas,
status,
purpose: PanelPurpose::None,
input,
}
}sourcepub fn set_content(&mut self, content: &str)
pub fn set_content(&mut self, content: &str)
Examples found in repository?
src/app/panel.rs (line 45)
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
pub fn new(
id: PanelId,
state: Box<dyn PanelState>,
areas: Areas,
con: &AppContext,
) -> Self {
let mut input = PanelInput::new(areas.input.clone());
input.set_content(&state.get_starting_input());
let status = state.no_verb_status(false, con);
Self {
id,
states: vec![state],
areas,
status,
purpose: PanelPurpose::None,
input,
}
}
pub fn set_error(&mut self, text: String) {
self.status = Status::from_error(text);
}
pub fn set_message<S: Into<String>>(&mut self, md: S) {
self.status = Status::from_message(md.into());
}
/// apply a command on the current state, with no
/// effect on screen
#[allow(clippy::too_many_arguments)] // a refactory could still be useful
pub fn apply_command<'c>(
&mut self,
w: &'c mut W,
cmd: &'c Command,
app_state: &mut AppState,
app_cmd_context: &'c AppCmdContext<'c>,
) -> Result<CmdResult, ProgramError> {
let state_idx = self.states.len() - 1;
let cc = CmdContext {
cmd,
app: app_cmd_context,
panel: PanelCmdContext {
areas: &self.areas,
purpose: self.purpose,
},
};
let result = self.states[state_idx].on_command(w, app_state, &cc);
let has_previous_state = self.states.len() > 1;
self.status = self.state().get_status(app_state, &cc, has_previous_state);
result
}
/// called on focusing the panel and before the display,
/// this updates the status from the command read in the input
pub fn refresh_input_status<'c>(
&mut self,
app_state: &AppState,
app_cmd_context: &'c AppCmdContext<'c>,
) {
let cmd = Command::from_raw(self.input.get_content(), false);
let cc = CmdContext {
cmd: &cmd,
app: app_cmd_context,
panel: PanelCmdContext {
areas: &self.areas,
purpose: self.purpose,
},
};
let has_previous_state = self.states.len() > 1;
self.status = self.state().get_status(app_state, &cc, has_previous_state);
}
/// do the next pending task stopping as soon as there's an event
/// in the dam
pub fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam,
) -> Result<(), ProgramError> {
self.mut_state().do_pending_task(app_state, screen, con, dam)
}
pub fn has_pending_task(&self) -> bool {
self.state().get_pending_task().is_some()
}
/// return a new command
/// Update the input field
pub fn add_event(
&mut self,
w: &mut W,
event: TimedEvent,
app_state: &AppState,
con: &AppContext,
) -> Result<Command, ProgramError> {
let sel_info = self.states[self.states.len() - 1].sel_info(app_state);
let mode = self.state().get_mode();
let panel_state_type = self.state().get_type();
self.input.on_event(w, event, con, sel_info, app_state, mode, panel_state_type)
}
pub fn push_state(&mut self, new_state: Box<dyn PanelState>) {
self.input.set_content(&new_state.get_starting_input());
self.states.push(new_state);
}
pub fn mut_state(&mut self) -> &mut dyn PanelState {
self.states.last_mut().unwrap().as_mut()
}
pub fn state(&self) -> &dyn PanelState {
self.states.last().unwrap().as_ref()
}
pub fn clear_input(&mut self) {
self.input.set_content("");
}
/// remove the verb invocation from the input but keep
/// the filter if there's one
pub fn clear_input_invocation(&mut self, con: &AppContext) {
let mut command_parts = CommandParts::from(self.input.get_content());
if command_parts.verb_invocation.is_some() {
command_parts.verb_invocation = None;
let new_input = format!("{}", command_parts);
self.input.set_content(&new_input);
}
self.mut_state().set_mode(initial_mode(con));
}
pub fn set_input_content(&mut self, content: &str) {
self.input.set_content(content);
}
pub fn get_input_content(&self) -> String {
self.input.get_content()
}
/// change the argument of the verb in the input, if there's one
pub fn set_input_arg(&mut self, arg: String) {
let mut command_parts = CommandParts::from(self.input.get_content());
if let Some(invocation) = &mut command_parts.verb_invocation {
invocation.args = Some(arg);
let new_input = format!("{}", command_parts);
self.input.set_content(&new_input);
}
}
/// return true when the element has been removed
pub fn remove_state(&mut self) -> bool {
if self.states.len() > 1 {
self.states.pop();
self.input.set_content(&self.state().get_starting_input());
true
} else {
false
}
}More examples
src/command/panel_input.rs (line 359)
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
fn get_command(
&mut self,
timed_event: TimedEvent,
con: &AppContext,
sel_info: SelInfo<'_>,
app_state: &AppState,
mode: Mode,
panel_state_type: PanelStateType,
) -> Command {
match timed_event.event {
Event::Mouse(MouseEvent { kind, column, row, modifiers: KeyModifiers::NONE }) => {
if self.input_field.apply_timed_event(timed_event) {
Command::empty()
} else {
match kind {
MouseEventKind::Up(MouseButton::Left) => {
if timed_event.double_click {
Command::DoubleClick(column, row)
} else {
Command::Click(column, row)
}
}
MouseEventKind::ScrollDown => {
Command::Internal {
internal: Internal::line_down,
input_invocation: None,
}
}
MouseEventKind::ScrollUp => {
Command::Internal {
internal: Internal::line_up,
input_invocation: None,
}
}
_ => Command::None,
}
}
}
Event::Key(key) => {
// value of raw and parts before any key related change
let raw = self.input_field.get_content();
let mut parts = CommandParts::from(raw.clone());
// we first handle the cases that MUST absolutely
// not be overridden by configuration
if key == key!(esc) {
// tab cycling
self.tab_cycle_count = 0;
if let Some(raw) = self.input_before_cycle.take() {
// we cancel the tab cycling
self.input_field.set_str(&raw);
self.input_before_cycle = None;
return Command::from_raw(raw, false);
} else if con.modal && mode == Mode::Input {
// leave insertion mode
return Command::Internal {
internal: Internal::mode_command,
input_invocation: None,
};
} else {
// general back command
self.input_field.clear();
let internal = Internal::back;
return Command::Internal {
internal,
input_invocation: parts.verb_invocation,
};
}
}
// tab completion
if key == key!(tab) {
if parts.verb_invocation.is_some() {
let parts_before_cycle;
let completable_parts = if let Some(s) = &self.input_before_cycle {
parts_before_cycle = CommandParts::from(s.clone());
&parts_before_cycle
} else {
&parts
};
let completions = Completions::for_input(completable_parts, con, sel_info);
info!(" -> completions: {:?}", &completions);
let added = match completions {
Completions::None => {
debug!("nothing to complete!");
self.tab_cycle_count = 0;
self.input_before_cycle = None;
None
}
Completions::Common(completion) => {
self.tab_cycle_count = 0;
Some(completion)
}
Completions::List(mut completions) => {
let idx = self.tab_cycle_count % completions.len();
if self.tab_cycle_count == 0 {
self.input_before_cycle = Some(raw.to_string());
}
self.tab_cycle_count += 1;
Some(completions.swap_remove(idx))
}
};
if let Some(added) = added {
let mut raw = self
.input_before_cycle
.as_ref()
.map_or(raw, |s| s.to_string());
raw.push_str(&added);
self.input_field.set_str(&raw);
return Command::from_raw(raw, false);
} else {
return Command::None;
}
}
} else {
self.tab_cycle_count = 0;
self.input_before_cycle = None;
}
if key == key!(enter) && parts.has_not_empty_verb_invocation() {
return Command::from_parts(parts, true);
}
if (key == key!('?') || key == key!(shift-'?'))
&& (raw.is_empty() || parts.verb_invocation.is_some()) {
// a '?' opens the help when it's the first char
// or when it's part of the verb invocation
return Command::Internal {
internal: Internal::help,
input_invocation: parts.verb_invocation,
};
}
// we now check if the key is the trigger key of one of the verbs
if keys::is_key_allowed_for_verb(key, mode, raw.is_empty()) {
for (index, verb) in con.verb_store.verbs.iter().enumerate() {
for verb_key in &verb.keys {
if *verb_key != key {
continue;
}
if self.handle_input_related_verb(verb, con) {
return Command::from_raw(self.input_field.get_content(), false);
}
if !verb.selection_condition.is_respected_by(sel_info.common_stype()) {
continue;
}
if !verb.can_be_called_in_panel(panel_state_type) {
continue;
}
if mode != Mode::Input && verb.is_internal(Internal::mode_input) {
self.enter_input_mode_with_key(key, &parts);
}
if !verb.file_extensions.is_empty() {
let extension = sel_info.extension();
if !extension.map_or(false, |ext| verb.file_extensions.iter().any(|ve| ve == ext)) {
continue;
}
}
if verb.auto_exec {
return Command::VerbTrigger {
index,
input_invocation: parts.verb_invocation,
};
}
if let Some(invocation_parser) = &verb.invocation_parser {
let exec_builder = ExecutionStringBuilder::without_invocation(
sel_info,
app_state,
);
let verb_invocation = exec_builder.invocation_with_default(
&invocation_parser.invocation_pattern
);
parts.verb_invocation = Some(verb_invocation);
self.set_content(&parts.to_string());
return Command::VerbEdit(parts.verb_invocation.unwrap());
}
}
}
}
// input field management
if mode == Mode::Input {
if self.input_field.apply_timed_event(timed_event) {
return Command::from_raw(self.input_field.get_content(), false);
}
}
Command::None
}
_ => Command::None,
}
}sourcepub fn get_content(&self) -> String
pub fn get_content(&self) -> String
Examples found in repository?
src/app/panel.rs (line 96)
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
pub fn refresh_input_status<'c>(
&mut self,
app_state: &AppState,
app_cmd_context: &'c AppCmdContext<'c>,
) {
let cmd = Command::from_raw(self.input.get_content(), false);
let cc = CmdContext {
cmd: &cmd,
app: app_cmd_context,
panel: PanelCmdContext {
areas: &self.areas,
purpose: self.purpose,
},
};
let has_previous_state = self.states.len() > 1;
self.status = self.state().get_status(app_state, &cc, has_previous_state);
}
/// do the next pending task stopping as soon as there's an event
/// in the dam
pub fn do_pending_task(
&mut self,
app_state: &mut AppState,
screen: Screen,
con: &AppContext,
dam: &mut Dam,
) -> Result<(), ProgramError> {
self.mut_state().do_pending_task(app_state, screen, con, dam)
}
pub fn has_pending_task(&self) -> bool {
self.state().get_pending_task().is_some()
}
/// return a new command
/// Update the input field
pub fn add_event(
&mut self,
w: &mut W,
event: TimedEvent,
app_state: &AppState,
con: &AppContext,
) -> Result<Command, ProgramError> {
let sel_info = self.states[self.states.len() - 1].sel_info(app_state);
let mode = self.state().get_mode();
let panel_state_type = self.state().get_type();
self.input.on_event(w, event, con, sel_info, app_state, mode, panel_state_type)
}
pub fn push_state(&mut self, new_state: Box<dyn PanelState>) {
self.input.set_content(&new_state.get_starting_input());
self.states.push(new_state);
}
pub fn mut_state(&mut self) -> &mut dyn PanelState {
self.states.last_mut().unwrap().as_mut()
}
pub fn state(&self) -> &dyn PanelState {
self.states.last().unwrap().as_ref()
}
pub fn clear_input(&mut self) {
self.input.set_content("");
}
/// remove the verb invocation from the input but keep
/// the filter if there's one
pub fn clear_input_invocation(&mut self, con: &AppContext) {
let mut command_parts = CommandParts::from(self.input.get_content());
if command_parts.verb_invocation.is_some() {
command_parts.verb_invocation = None;
let new_input = format!("{}", command_parts);
self.input.set_content(&new_input);
}
self.mut_state().set_mode(initial_mode(con));
}
pub fn set_input_content(&mut self, content: &str) {
self.input.set_content(content);
}
pub fn get_input_content(&self) -> String {
self.input.get_content()
}
/// change the argument of the verb in the input, if there's one
pub fn set_input_arg(&mut self, arg: String) {
let mut command_parts = CommandParts::from(self.input.get_content());
if let Some(invocation) = &mut command_parts.verb_invocation {
invocation.args = Some(arg);
let new_input = format!("{}", command_parts);
self.input.set_content(&new_input);
}
}
/// return true when the element has been removed
pub fn remove_state(&mut self) -> bool {
if self.states.len() > 1 {
self.states.pop();
self.input.set_content(&self.state().get_starting_input());
true
} else {
false
}
}
/// render the whole panel (state, status, purpose, input, flags)
pub fn display(
&mut self,
w: &mut W,
disc: &DisplayContext,
) -> Result<(), ProgramError> {
self.mut_state().display(w, disc)?;
if disc.active || !WIDE_STATUS {
self.write_status(w, disc.panel_skin, disc.screen)?;
}
let mut input_area = self.areas.input.clone();
if disc.active {
self.write_purpose(w, disc.panel_skin, disc.screen, disc.con)?;
let flags = self.state().get_flags();
let input_content_len = self.input.get_content().len() as u16;
let flags_len = flags_display::visible_width(&flags);
if input_area.width > input_content_len + 1 + flags_len {
input_area.width -= flags_len + 1;
disc.screen.goto(w, input_area.left + input_area.width, input_area.top)?;
flags_display::write(w, &flags, disc.panel_skin)?;
}
}
self.input.display(w, disc.active, self.state().get_mode(), input_area, disc.panel_skin)?;
Ok(())
}sourcepub fn display(
&mut self,
w: &mut W,
active: bool,
mode: Mode,
area: Area,
panel_skin: &PanelSkin
) -> Result<(), ProgramError>
pub fn display(
&mut self,
w: &mut W,
active: bool,
mode: Mode,
area: Area,
panel_skin: &PanelSkin
) -> Result<(), ProgramError>
Examples found in repository?
src/app/panel.rs (line 218)
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
pub fn display(
&mut self,
w: &mut W,
disc: &DisplayContext,
) -> Result<(), ProgramError> {
self.mut_state().display(w, disc)?;
if disc.active || !WIDE_STATUS {
self.write_status(w, disc.panel_skin, disc.screen)?;
}
let mut input_area = self.areas.input.clone();
if disc.active {
self.write_purpose(w, disc.panel_skin, disc.screen, disc.con)?;
let flags = self.state().get_flags();
let input_content_len = self.input.get_content().len() as u16;
let flags_len = flags_display::visible_width(&flags);
if input_area.width > input_content_len + 1 + flags_len {
input_area.width -= flags_len + 1;
disc.screen.goto(w, input_area.left + input_area.width, input_area.top)?;
flags_display::write(w, &flags, disc.panel_skin)?;
}
}
self.input.display(w, disc.active, self.state().get_mode(), input_area, disc.panel_skin)?;
Ok(())
}sourcepub fn on_event(
&mut self,
w: &mut W,
event: TimedEvent,
con: &AppContext,
sel_info: SelInfo<'_>,
app_state: &AppState,
mode: Mode,
panel_state_type: PanelStateType
) -> Result<Command, ProgramError>
pub fn on_event(
&mut self,
w: &mut W,
event: TimedEvent,
con: &AppContext,
sel_info: SelInfo<'_>,
app_state: &AppState,
mode: Mode,
panel_state_type: PanelStateType
) -> Result<Command, ProgramError>
consume the event to
- maybe change the input
- build a command then redraw the input field
Examples found in repository?
src/app/panel.rs (line 138)
128 129 130 131 132 133 134 135 136 137 138 139
pub fn add_event(
&mut self,
w: &mut W,
event: TimedEvent,
app_state: &AppState,
con: &AppContext,
) -> Result<Command, ProgramError> {
let sel_info = self.states[self.states.len() - 1].sel_info(app_state);
let mode = self.state().get_mode();
let panel_state_type = self.state().get_type();
self.input.on_event(w, event, con, sel_info, app_state, mode, panel_state_type)
}