File explorer and tree helper #2377
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -432,7 +432,10 @@ impl MappableCommand { | |
| decrement, "Decrement item under cursor", | ||
| record_macro, "Record macro", | ||
| replay_macro, "Replay macro", | ||
| command_palette, "Open command pallete", | ||
| toggle_or_focus_explorer, "toggle or focus explorer", | ||
| open_explorer_recursion, "open explorer recursion", | ||
| close_explorer, "close explorer", | ||
| ); | ||
| } | ||
|
|
||
|
|
@@ -2213,6 +2216,43 @@ fn file_picker_in_current_directory(cx: &mut Context) { | |
| cx.push_layer(Box::new(overlayed(picker))); | ||
| } | ||
|
|
||
| fn toggle_or_focus_explorer(cx: &mut Context) { | ||
| cx.callback = Some(Box::new( | ||
| |compositor: &mut Compositor, cx: &mut compositor::Context| { | ||
| if let Some(editor) = compositor.find::<ui::EditorView>() { | ||
| match editor.explorer.as_mut() { | ||
| Some(explore) => explore.content.focus(), | ||
| None => match ui::Explorer::new(cx) { | ||
| Ok(explore) => editor.explorer = Some(overlayed(explore)), | ||
| Err(err) => cx.editor.set_error(format!("{}", err)), | ||
| }, | ||
| } | ||
| } | ||
| }, | ||
| )); | ||
| } | ||
|
|
||
| fn open_explorer_recursion(cx: &mut Context) { | ||
| cx.callback = Some(Box::new( | ||
| |compositor: &mut Compositor, cx: &mut compositor::Context| { | ||
| if let Some(editor) = compositor.find::<ui::EditorView>() { | ||
| match ui::Explorer::new_explorer_recursion() { | ||
| Ok(explore) => editor.explorer = Some(overlayed(explore)), | ||
| Err(err) => cx.editor.set_error(format!("{}", err)), | ||
| } | ||
| } | ||
| }, | ||
| )); | ||
| } | ||
|
|
||
| fn close_explorer(cx: &mut Context) { | ||
| cx.callback = Some(Box::new(|compositor: &mut Compositor, _| { | ||
| if let Some(editor) = compositor.find::<ui::EditorView>() { | ||
| editor.explorer.take(); | ||
| } | ||
| })); | ||
| } | ||
|
|
||
| fn buffer_picker(cx: &mut Context) { | ||
| let current = view!(cx.editor).doc; | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -264,6 +264,8 @@ pub fn default() -> HashMap<Mode, Keymap> { | |
| "r" => rename_symbol, | ||
| "h" => select_references_to_symbol_under_cursor, | ||
| "?" => command_palette, | ||
| "e" => toggle_or_focus_explorer, | ||
| "E" => open_explorer_recursion, | ||
| }, | ||
| "z" => { "View" | ||
| "z" | "c" => align_view_center, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ use crate::{ | |
| compositor::{Component, Context, Event, EventResult}, | ||
| job, key, | ||
| keymap::{KeymapResult, Keymaps}, | ||
| ui::{overlay::Overlay, Completion, Explorer, ProgressSpinners}, | ||
| }; | ||
|
|
||
| use helix_core::{ | ||
|
|
@@ -36,6 +36,7 @@ pub struct EditorView { | |
| last_insert: (commands::MappableCommand, Vec<InsertEvent>), | ||
| pub(crate) completion: Option<Completion>, | ||
| spinners: ProgressSpinners, | ||
| pub(crate) explorer: Option<Overlay<Explorer>>, | ||
| } | ||
|
|
||
| #[derive(Debug, Clone)] | ||
|
|
@@ -59,6 +60,7 @@ impl EditorView { | |
| last_insert: (commands::MappableCommand::normal_mode, Vec::new()), | ||
| completion: None, | ||
| spinners: ProgressSpinners::default(), | ||
| explorer: None, | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -1118,6 +1120,11 @@ impl Component for EditorView { | |
| event: Event, | ||
| context: &mut crate::compositor::Context, | ||
| ) -> EventResult { | ||
| if let Some(explore) = self.explorer.as_mut() { | ||
| if let EventResult::Consumed(callback) = explore.handle_event(event, context) { | ||
| return EventResult::Consumed(callback); | ||
| } | ||
| } | ||
| let mut cx = commands::Context { | ||
| editor: context.editor, | ||
| count: None, | ||
|
|
@@ -1260,7 +1267,17 @@ impl Component for EditorView { | |
| surface.set_style(area, cx.editor.theme.get("ui.background")); | ||
| let config = cx.editor.config(); | ||
| // if the terminal size suddenly changed, we need to trigger a resize | ||
| let mut editor_area = area.clip_bottom(1); | ||
| if self.explorer.is_some() && (config.explorer.is_embed()) { | ||
| editor_area = editor_area.clip_left(config.explorer.column_width as u16 + 2); | ||
| } | ||
| cx.editor.resize(editor_area); // -1 from bottom for commandline | ||
|
|
||
| if let Some(explore) = self.explorer.as_mut() { | ||
| if !explore.content.is_focus() && config.explorer.is_embed() { | ||
| explore.content.render(area, surface, cx); | ||
| } | ||
| } | ||
|
|
||
| for (view, is_focused) in cx.editor.tree.views() { | ||
| let doc = cx.editor.document(view.doc).unwrap(); | ||
|
|
@@ -1336,9 +1353,30 @@ impl Component for EditorView { | |
| if let Some(completion) = self.completion.as_mut() { | ||
| completion.render(area, surface, cx); | ||
| } | ||
|
|
||
| if let Some(explore) = self.explorer.as_mut() { | ||
| if explore.content.is_focus() { | ||
| if config.explorer.is_embed() { | ||
| explore.content.render(area, surface, cx); | ||
| } else { | ||
| explore.render(area, surface, cx); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn cursor(&self, _area: Rect, editor: &Editor) -> (Option<Position>, CursorKind) { | ||
| if let Some(explore) = &self.explorer { | ||
| if explore.content.is_focus() { | ||
| if editor.config().explorer.is_overlay() { | ||
| return explore.cursor(_area, editor); | ||
| } | ||
| let cursor = explore.content.cursor(_area, editor); | ||
| if cursor.0.is_some() { | ||
| return cursor; | ||
| } | ||
| } | ||
| } | ||
| match editor.cursor() { | ||
| // All block cursors are drawn manually | ||
| (pos, CursorKind::Block) => (pos, CursorKind::Hidden), | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be called tree explorer rather than file explorer? Given that later tree explorer functionality may be reused for something else.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just my two cents, but I have my doubts...
"tree explorer" sounds like a name which could be used in the code because - as you correctly point out - it could share its code base for different purposes. However, IMHO that name should not be presented to the user:
The user explores... files. Not trees. 🌳
Add to that the fact that "file explorer" is a pretty common term, e.g. in desktop environments, but also in other editors/IDEs.
If we really want to use the word "tree", I could imagine the name "file tree", but I still find "file explorer" more intuitive. :)