appcui 0.4.8

A feature-rich and cross-platform TUI/CUI framework for Rust, enabling modern terminal-based applications on Windows, Linux, and macOS. Includes built-in UI components like buttons, menus, list views, tree views, checkboxes, and more. Perfect for building fast and interactive CLI tools and text-based interfaces.
Documentation
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
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
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
use std::path::{Path, PathBuf};
use std::sync::{Mutex, OnceLock};

use dialogs::extension_selection_dialog::ExtensionSelectionDialog;
use dialogs::file_mask::FileMask;
use dialogs::root_select_dialog::RootSelectDialog;
use fs::EntryType;

use super::Location;
use crate::prelude::*;
use crate::ui::pathfinder::GenericPathFinder;
use crate::utils::fs::{Entry, Root};
use crate::utils::Navigator;
use EnumBitFlags::EnumBitFlags;

pub(super) enum OpenSaveDialogResult {
    Path(PathBuf),
    //MultiplePaths(Vec<PathBuf>),
    Cancel,
}

#[EnumBitFlags(bits = 8)]
pub(super) enum InnerFlags {
    Save = 1,
    Icons = 2,
    MultipleOpen = 4,
    ValidateOverwrite = 8,
    CheckIfFileExists = 16,
}

pub(super) static LAST_PATH: OnceLock<Mutex<Option<PathBuf>>> = OnceLock::new();

#[ModalWindow(events = ButtonEvents+WindowEvents+ListViewEvents<Entry>+ComboBoxEvents+PathFinderEvents, response: OpenSaveDialogResult, internal: true)]
pub(super) struct FileExplorer<T>
where
    T: Navigator<Entry, Root, PathBuf> + 'static,
{
    list: Handle<ListView<Entry>>,
    path_viewer: Handle<GenericPathFinder<T>>,
    details: Handle<ToggleButton>,
    columns: Handle<ToggleButton>,
    name: Handle<TextField>,
    b_ok: Handle<Button>,
    b_cancel: Handle<Button>,
    b_drive: Handle<Button>,
    mask: Handle<ComboBox>,
    extension_mask: Vec<FileMask>,
    nav: T,
    g_updir: listview::Group,
    g_files: listview::Group,
    g_folders: listview::Group,
    path: PathBuf,
    flags: InnerFlags,
}

impl<T> FileExplorer<T>
where
    T: Navigator<Entry, Root, PathBuf> + 'static,
{
    pub(super) fn new(file_name: &str, title: &str, location: Location, extension_mask: Vec<FileMask>, nav: T, flags: InnerFlags) -> Self {
        let mut w = Self {
            base: ModalWindow::new(title, layout!("a:c,w:70,h:20"), window::Flags::Sizeable),
            list: Handle::None,
            details: Handle::None,
            columns: Handle::None,
            name: Handle::None,
            b_ok: Handle::None,
            b_cancel: Handle::None,
            b_drive: Handle::None,
            mask: Handle::None,
            path_viewer: Handle::None,
            extension_mask,
            nav: nav.clone(),
            g_updir: listview::Group::None,
            g_files: listview::Group::None,
            g_folders: listview::Group::None,
            path: PathBuf::new(),
            flags,
        };
        w.path = match location {
            Location::Current => nav.current_dir(),
            Location::Last => {
                let m = LAST_PATH.get_or_init(|| Mutex::new(None));
                if let Ok(m) = m.lock() {
                    if let Some(p) = m.as_ref() {
                        p.clone()
                    } else {
                        nav.current_dir()
                    }
                } else {
                    nav.current_dir()
                }
            }
            Location::Path(p) => p.to_path_buf(),
        };
        w.b_drive = w.add(button!("&Drive,x:1,y:1,w:7,type:Flat"));
        let pf = GenericPathFinder::with_navigator(
            w.path.as_path().as_os_str().to_str().unwrap_or(""),
            layout!("l:9,t:1,r:1"),
            pathfinder::Flags::None,
            nav,
        );
        w.path_viewer = w.add(pf);
        let mut p = panel!("l:1,t:3,r:1,b:5");
        let mut lv: ListView<Entry> = ListView::new(
            layout!("d:f"),
            listview::Flags::SearchBar
                | listview::Flags::ScrollBars
                | if flags.contains(InnerFlags::Icons) {
                    listview::Flags::LargeIcons
                } else {
                    listview::Flags::None
                }
                | if !flags.contains(InnerFlags::MultipleOpen) {
                    listview::Flags::NoSelection
                } else {
                    listview::Flags::None
                },
        );
        lv.set_components_toolbar_margins(2, 0);
        w.g_updir = lv.add_group("UpDir");
        w.g_folders = lv.add_group("Folders");
        w.g_files = lv.add_group("Files");
        w.list = p.add(lv);
        w.add(p);
        w.add(label!("&Name,l:1,b:3,w:4"));
        let mut fname = TextField::new(file_name, layout!("l:6,b:3,r:11"), textfield::Flags::None);
        fname.set_hotkey(key!("Alt+N"));
        w.name = w.add(fname);
        w.b_ok = w.add(button!("&OK,r:1,b:2,w:9"));
        w.add(label!("&Type,l:1,b:1,w:4"));
        let mut mask = ComboBox::new(layout!("l:6,b:1,r:11"), combobox::Flags::None);
        for m in &w.extension_mask {
            mask.add(m.name());
        }
        mask.add("All files");
        mask.set_index(0);
        mask.set_hotkey(key!("Alt+T"));
        w.mask = w.add(mask);
        w.b_cancel = w.add(button!("&Cancel,r:1,b:0,w:9"));
        w.set_size_bounds(40, 17, u16::MAX, u16::MAX);
        let h = w.name;
        w.request_focus_for_control(h);
        w
    }
    fn update_last_path(&self, last_path: &Path) {
        if let Some(dir) = last_path.parent() {
            let mut new_path = dir.to_path_buf();
            new_path.push(""); // make sure we have a trailing slash
            if let Ok(mut guard) = LAST_PATH.get_or_init(|| Mutex::new(None)).lock() {
                *guard = Some(new_path);
            }
        }
    }
    fn populate(&mut self) {
        let is_root = self.path.is_absolute() && self.path.parent().is_none();
        let mut entries = self.nav.entries(&self.path);
        let filter_idx = if let Some(mask) = self.control(self.mask) {
            mask.index().unwrap_or_default() as usize
        } else {
            0
        };
        if filter_idx < self.extension_mask.len() {
            // we need to filter the files
            let filter = &self.extension_mask[filter_idx];
            entries.retain(|e| (e.entry_type != EntryType::File) || filter.matches(&e.name));
        }

        let h = self.list;
        let g_folders = self.g_folders;
        let g_files = self.g_files;
        let g_updir = self.g_updir;
        let theme = self.theme();
        let c_files = theme.text.normal;
        let c_folders = theme.text.focused;
        if let Some(lv) = self.control_mut(h) {
            lv.add_batch(|lv| {
                lv.clear();
                if !is_root {
                    lv.add_item(listview::Item::new(
                        Entry::new("..", 0, chrono::NaiveDateTime::default(), crate::utils::fs::EntryType::UpDir),
                        false,
                        Some(c_folders),
                        ['🔙', ' '],
                        g_updir,
                    ));
                }
                for e in entries {
                    let is_folder = e.is_container();
                    lv.add_item(listview::Item::new(
                        e,
                        false,
                        if is_folder { Some(c_folders) } else { Some(c_files) },
                        [if is_folder { '📁' } else { '📄' }, ' '],
                        if is_folder { g_folders } else { g_files },
                    ));
                }
            });
        }
    }
    fn populate_after_path_update(&mut self) {
        self.path.push("");
        let h = self.path_viewer;
        let ts = TempString::<128>::new(self.path.to_str().unwrap_or_default());
        if let Some(pv) = self.control_mut(h) {
            pv.set_path(Path::new(ts.as_str()));
        }
        let h = self.list;
        if let Some(lst) = self.control_mut(h) {
            lst.clear_search();
        }
        self.populate();
    }
    fn return_result_from_save(&mut self) {
        // get the file name
        let mut entry = Entry::default();
        if let Some(tf) = self.control(self.name) {
            if tf.text().trim().is_empty() {
                return;
            }
            entry.name.push_str(tf.text());
        } else {
            return;
        };
        let ext_idx = self.control(self.mask).unwrap().index().unwrap() as usize;
        let check_extension = self.extension_mask.len() > ext_idx;
        if let Some(mut result) = self.nav.join(&self.path, &entry) {
            if self.flags.contains(InnerFlags::ValidateOverwrite) {
                match self.nav.exists(&result) {
                    Some(true) => {
                        if !crate::dialogs::validate("Overwrite", format!("Do you want to overwrite the file: '{}'", result.display()).as_str()) {
                            return;
                        }
                    }
                    Some(false) => {
                        // do nothing - the file does not exist
                    }
                    None => {
                        crate::dialogs::error("Error", format!("Fail to check if file exists: '{}'", result.display()).as_str());
                        return;
                    }
                }
            }
            self.update_last_path(&result);
            let fname = result.file_name();
            if check_extension && fname.is_some() {
                if let Some(fname) = fname.unwrap().to_os_string().to_str() {
                    if !self.extension_mask[ext_idx].matches(fname) {
                        // need to add the proper extension
                        if self.extension_mask[ext_idx].extensions_count() == 1 {
                            // one extension - we need to add it
                            result.set_extension(self.extension_mask[ext_idx].extension(0));
                        } else {
                            // multiple extensions - we need to select what we add
                            if let Some(selected_extension) = ExtensionSelectionDialog::new(&self.extension_mask[ext_idx]).show() {
                                result.set_extension(&selected_extension);
                            }
                        }
                    }
                }
            }
            self.exit_with(OpenSaveDialogResult::Path(result));
        } else {
            crate::dialogs::error(
                "Error",
                format!(
                    "Fail to join current path: '{}' with file name: '{}'",
                    self.path.display(),
                    entry.name.as_str()
                )
                .as_str(),
            );
        }
    }

    fn return_result_from_open(&mut self) {
        // get the file name
        let mut entry = Entry::default();
        if let Some(tf) = self.control(self.name) {
            if tf.text().trim().is_empty() {
                return;
            }
            entry.name.push_str(tf.text());
        } else {
            return;
        };
        if let Some(result) = self.nav.join(&self.path, &entry) {
            if self.flags.contains(InnerFlags::CheckIfFileExists) {
                match self.nav.exists(&result) {
                    Some(true) => {
                        // do nothing --> all is good
                    }
                    Some(false) => {
                        crate::dialogs::error("Error", format!("File '{}' does not exists !", result.display()).as_str());
                        return;
                    }
                    None => {
                        crate::dialogs::error("Error", format!("Fail to check if file exists: '{}'", result.display()).as_str());
                        return;
                    }
                }
            }
            self.update_last_path(&result);
            self.exit_with(OpenSaveDialogResult::Path(result));
        } else {
            crate::dialogs::error(
                "Error",
                format!(
                    "Fail to join current path: '{}' with file name: '{}'",
                    self.path.display(),
                    entry.name.as_str()
                )
                .as_str(),
            );
        }
    }
    fn return_result(&mut self) {
        if self.flags.contains(InnerFlags::Save) {
            self.return_result_from_save()
        } else {
            self.return_result_from_open()
        }
    }
}
impl<T> ButtonEvents for FileExplorer<T>
where
    T: Navigator<Entry, Root, PathBuf> + 'static,
{
    fn on_pressed(&mut self, handle: Handle<Button>) -> EventProcessStatus {
        match () {
            _ if handle == self.b_ok => {
                self.return_result();
                EventProcessStatus::Processed
            }
            _ if handle == self.b_cancel => {
                self.exit_with(OpenSaveDialogResult::Cancel);
                EventProcessStatus::Processed
            }
            _ if handle == self.b_drive => {
                if let Some(path) = RootSelectDialog::new(self.nav.roots(), self.flags.contains(InnerFlags::Icons)).show() {
                    self.path = path;
                    self.populate_after_path_update();
                }
                EventProcessStatus::Processed
            }
            _ => EventProcessStatus::Ignored,
        }
    }
}
impl<T> WindowEvents for FileExplorer<T>
where
    T: Navigator<Entry, Root, PathBuf> + 'static,
{
    fn on_activate(&mut self) {
        self.populate();
    }
    fn on_accept(&mut self) {
        self.return_result();
    }
    fn on_cancel(&mut self) -> ActionRequest {
        ActionRequest::Allow
    }
}
impl<T> ComboBoxEvents for FileExplorer<T>
where
    T: Navigator<Entry, Root, PathBuf> + 'static,
{
    fn on_selection_changed(&mut self, handle: Handle<ComboBox>) -> EventProcessStatus {
        if handle == self.mask {
            self.populate();
        }
        EventProcessStatus::Processed
    }
}
impl<T> ListViewEvents<Entry> for FileExplorer<T>
where
    T: Navigator<Entry, Root, PathBuf> + 'static,
{
    fn on_item_action(&mut self, handle: Handle<ListView<Entry>>, item_index: usize) -> EventProcessStatus {
        let (data, etype): (Option<TempString<128>>, Option<EntryType>) = if let Some(lv) = self.control(handle) {
            if let Some(e) = lv.item(item_index) {
                if e.is_container() {
                    (Some(TempString::new(e.name())), Some(e.entry_type))
                } else {
                    (None, Some(e.entry_type))
                }
            } else {
                (None, None)
            }
        } else {
            (None, None)
        };

        match etype {
            Some(EntryType::UpDir) => {
                self.path.pop();
                self.populate_after_path_update();
            }
            Some(EntryType::Folder) => {
                if let Some(name) = data {
                    self.path.push(name.as_str());
                    self.populate_after_path_update();
                }
            }
            Some(EntryType::File) => {
                self.return_result();
            }
            None => {}
        }
        EventProcessStatus::Processed
    }

    fn on_current_item_changed(&mut self, handle: Handle<ListView<Entry>>) -> EventProcessStatus {
        let current_item = if let Some(lv) = self.control(handle) {
            if let Some(e) = lv.current_item() {
                if e.entry_type == EntryType::File {
                    e.name()
                } else {
                    ""
                }
            } else {
                ""
            }
        } else {
            ""
        };
        let temp_string: TempString<128> = TempString::new(current_item);
        if !temp_string.is_empty() {
            let h = self.name;
            if let Some(tf) = self.control_mut(h) {
                tf.set_text(temp_string.as_str());
            }
        }
        EventProcessStatus::Processed
    }
}

impl<T> PathFinderEvents for FileExplorer<T>
where
    T: Navigator<Entry, Root, PathBuf> + 'static,
{
    fn on_path_updated(&mut self, handle: Handle<PathFinder>) -> EventProcessStatus {
        if handle == self.path_viewer {
            if let Some(pv) = self.control(self.path_viewer) {
                self.path = pv.path().to_path_buf();
                self.populate_after_path_update();
            }
        }
        EventProcessStatus::Processed
    }
}