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
|
use {
super::help_content,
crate::{
app::*,
command::{Command, TriggerType},
conf::Conf,
display::{Screen, W},
errors::ProgramError,
launchable::Launchable,
pattern::*,
tree::TreeOptions,
verb::*,
},
std::path::{Path, PathBuf},
termimad::{Area, FmtText, TextView},
};
/// an application state dedicated to help
pub struct HelpState {
pub scroll: i32, // scroll position
pub text_area: Area,
dirty: bool, // background must be cleared
pattern: Pattern,
tree_options: TreeOptions,
config_path: PathBuf, // the last config path when several were used
mode: Mode,
}
impl HelpState {
pub fn new(
tree_options: TreeOptions,
_screen: Screen,
con: &AppContext,
) -> HelpState {
let text_area = Area::uninitialized(); // will be fixed at drawing time
let config_path = con.config_paths
.last()
.cloned()
.unwrap_or_else(Conf::default_location);
HelpState {
text_area,
scroll: 0,
dirty: true,
pattern: Pattern::None,
tree_options,
config_path,
mode: initial_mode(con),
}
}
}
impl PanelState for HelpState {
fn get_type(&self) -> PanelStateType {
PanelStateType::Help
}
fn set_mode(&mut self, mode: Mode) {
self.mode = mode;
}
fn get_mode(&self) -> Mode {
self.mode
}
fn selected_path(&self) -> Option<&Path> {
Some(&self.config_path)
}
fn tree_options(&self) -> TreeOptions {
self.tree_options.clone()
}
fn with_new_options(
&mut self,
_screen: Screen,
change_options: &dyn Fn(&mut TreeOptions),
_in_new_panel: bool, // TODO open a tree if true
_con: &AppContext,
) -> CmdResult {
change_options(&mut self.tree_options);
CmdResult::Keep
}
fn selection(&self) -> Option<Selection<'_>> {
Some(Selection {
path: &self.config_path,
stype: SelectionType::File,
is_exe: false,
line: 0,
})
}
fn refresh(&mut self, _screen: Screen, _con: &AppContext) -> Command {
self.dirty = true;
Command::empty()
}
fn on_pattern(
&mut self,
pat: InputPattern,
_app_state: &AppState,
_con: &AppContext,
) -> Result<CmdResult, ProgramError> {
self.pattern = pat.pattern;
Ok(CmdResult::Keep)
}
fn display(
&mut self,
w: &mut W,
disc: &DisplayContext,
) -> Result<(), ProgramError> {
let con = &disc.con;
let mut text_area = disc.state_area.clone();
text_area.pad_for_max_width(120);
if text_area != self.text_area {
self.dirty = true;
self.text_area = text_area;
}
if self.dirty {
disc.panel_skin.styles.default.queue_bg(w)?;
disc.screen.clear_area_to_right(w, &disc.state_area)?;
self.dirty = false;
}
let mut expander = help_content::expander();
expander.set("version", env!("CARGO_PKG_VERSION"));
let config_paths: Vec<String> = con.config_paths.iter()
.map(|p| p.to_string_lossy().to_string())
.collect();
for path in &config_paths {
expander.sub("config-files")
.set("path", path);
}
let verb_rows = super::help_verbs::matching_verb_rows(&self.pattern, con);
for row in &verb_rows {
let sub = expander
.sub("verb-rows")
.set_md("name", row.name())
.set_md("shortcut", row.shortcut())
.set("key", &row.verb.keys_desc);
if row.verb.description.code {
sub.set("description", "");
sub.set("execution", &row.verb.description.content);
} else {
sub.set_md("description", &row.verb.description.content);
sub.set("execution", "");
}
}
let search_rows = super::help_search_modes::search_mode_rows(con);
for row in &search_rows {
expander
.sub("search-mode-rows")
.set("search-prefix", &row.prefix)
.set("search-type", &row.description);
}
let features = super::help_features::list();
expander.set(
"features-text",
if features.is_empty() {
"This release was compiled with no optional feature enabled."
} else {
"This release was compiled with those optional features enabled:"
},
);
for feature in &features {
expander
.sub("features")
.set("feature-name", feature.0)
.set("feature-description", feature.1);
}
let text = expander.expand();
let fmt_text = FmtText::from_text(
&disc.panel_skin.help_skin,
text,
Some((self.text_area.width - 1) as usize),
);
let mut text_view = TextView::from(&self.text_area, &fmt_text);
self.scroll = text_view.set_scroll(self.scroll);
Ok(text_view.write_on(w)?)
}
fn on_internal(
&mut self,
w: &mut W,
internal_exec: &InternalExecution,
input_invocation: Option<&VerbInvocation>,
trigger_type: TriggerType,
app_state: &mut AppState,
cc: &CmdContext,
) -> Result<CmdResult, ProgramError> {
use Internal::*;
Ok(match internal_exec.internal {
Internal::back => {
if self.pattern.is_some() {
self.pattern = Pattern::None;
CmdResult::Keep
} else {
CmdResult::PopState
}
}
help => CmdResult::Keep,
line_down | line_down_no_cycle => {
self.scroll += get_arg(input_invocation, internal_exec, 1);
CmdResult::Keep
}
line_up | line_up_no_cycle => {
self.scroll -= get_arg(input_invocation, internal_exec, 1);
CmdResult::Keep
}
open_stay => match open::that(&Conf::default_location()) {
Ok(exit_status) => {
info!("open returned with exit_status {:?}", exit_status);
CmdResult::Keep
}
Err(e) => CmdResult::DisplayError(format!("{:?}", e)),
},
// FIXME check we can't use the generic one
open_leave => {
CmdResult::from(Launchable::opener(
Conf::default_location()
))
}
page_down => {
self.scroll += self.text_area.height as i32;
CmdResult::Keep
}
page_up => {
self.scroll -= self.text_area.height as i32;
CmdResult::Keep
}
_ => self.on_internal_generic(
w,
internal_exec,
input_invocation,
trigger_type,
app_state,
cc,
)?,
})
}
}
|