Use filetreelist crate

No longer safe Status inside of FileTreeItem. For Status storage, now introduced a new Item, which contains Status alongside FileTreeItem. Note that FileTreeItemKind is no longer publicy available - thus we cannot store this enum anywhere anymore.

Author: abergmeier

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * changes in commit message inside external editor [[@bc-universe]](https://github.com/bc-universe) ([#1420](https://github.com/extrawurst/gitui/issues/1420))
 * add no-verify option on commits to not run hooks [[@dam5h]](https://github.com/dam5h) ([#1374](https://github.com/extrawurst/gitui/issues/1374))
 * allow `fetch` on status tab [[@alensiljak]](https://github.com/alensiljak) ([#1471](https://github.com/extrawurst/gitui/issues/1471))
+* Use `filetreelist` crate for the status tree. [[@abergmeier]](https://github.com/abergmeier) ([#1504](https://github.com/extrawurst/gitui/issues/1504))
 
 ### Fixes
 * commit msg history ordered the wrong way ([#1445](https://github.com/extrawurst/gitui/issues/1445))

src/components/changes.rs

@@ -1,7 +1,6 @@
 use super::{
-status_tree::StatusTreeComponent,
-utils::filetree::{FileTreeItem, FileTreeItemKind},
-CommandBlocking, DrawableComponent,
+status_tree::StatusTreeComponent, CommandBlocking,
+DrawableComponent,
 };
 use crate::{
 components::{CommandInfo, Component, EventState},
@@ -17,6 +16,7 @@ use asyncgit::{
 StatusItem, StatusItemType,
 };
 use crossterm::event::Event;
+use filetreelist::FileTreeItem;
 use std::path::Path;
 use tui::{backend::Backend, layout::Rect, Frame};
 
@@ -72,6 +72,10 @@ impl ChangesComponent {
 self.files.selection()
 }
 
+pub fn selection_status(&self) -> Option<StatusItem> {
+self.files.selection_status()
+}
+
 ///
 pub fn focus_select(&mut self, focus: bool) {
 self.files.focus(focus);
@@ -85,16 +89,26 @@ impl ChangesComponent {
 
 ///
 pub fn is_file_seleted(&self) -> bool {
-self.files.is_file_seleted()
+self.files.is_file_selected()
 }
 
 fn index_add_remove(&mut self) -> Result<bool> {
 if let Some(tree_item) = self.selection() {
 if self.is_working_dir {
-if let FileTreeItemKind::File(i) = tree_item.kind {
-let path = Path::new(i.path.as_str());
-match i.status {
-StatusItemType::Deleted => {
+if tree_item.kind().is_path() {
+let config =
+self.options.borrow().status_show_untracked();
+
+//TODO: check if we can handle the one file case with it aswell
+sync::stage_add_all(
+&self.repo.borrow(),
+tree_item.info().full_path_str(),
+config,
+)?;
+} else {
+let path = Path::new(tree_item.info().path_str());
+match self.selection_status().map(|s| s.status) {
+Some(StatusItemType::Deleted) => {
 sync::stage_addremoved(
 &self.repo.borrow(),
 path,
@@ -105,16 +119,6 @@ impl ChangesComponent {
 path,
 )?,
 };
-} else {
-let config =
-self.options.borrow().status_show_untracked();
-
-//TODO: check if we can handle the one file case with it aswell
-sync::stage_add_all(
-&self.repo.borrow(),
-tree_item.info.full_path.as_str(),
-config,
-)?;
 }
 
 //TODO: this might be slow in big repos,
@@ -130,8 +134,8 @@ impl ChangesComponent {
 }
 } else {
 // this is a staged entry, so lets unstage it
-let path = tree_item.info.full_path.as_str();
-sync::reset_stage(&self.repo.borrow(), path)?;
+let path = tree_item.info().full_path_str();
+sync::reset_stage(&self.repo.borrow(), &path)?;
 }
 
 return Ok(true);
@@ -160,11 +164,13 @@ impl ChangesComponent {
 
 fn dispatch_reset_workdir(&mut self) -> bool {
 if let Some(tree_item) = self.selection() {
-let is_folder =
-matches!(tree_item.kind, FileTreeItemKind::Path(_));
+let is_folder = tree_item.kind().is_path();
 self.queue.push(InternalEvent::ConfirmAction(
 Action::Reset(ResetItem {
-path: tree_item.info.full_path,
+path: tree_item
+.info()
+.full_path_str()
+.to_string(),
 is_folder,
 }),
 ));
@@ -178,12 +184,13 @@ impl ChangesComponent {
 if let Some(tree_item) = self.selection() {
 if let Err(e) = sync::add_to_ignore(
 &self.repo.borrow(),
-&tree_item.info.full_path,
+&tree_item.info().full_path_str(),
 ) {
 self.queue.push(InternalEvent::ShowErrorMsg(
 format!(
 "ignore error:\n{}\nfile:\n{:?}",
-e, tree_item.info.full_path
+e,
+tree_item.info().full_path()
 ),
 ));
 } else {

src/components/compare_commits.rs

@@ -256,7 +256,7 @@ impl CompareCommitsComponent {
 if let Some(f) = self.details.files().selection_file()
 {
 let diff_params = DiffParams {
-path: f.path.clone(),
+path: f.full_path_str().to_string(),
 diff_type: DiffType::Commits(ids),
 options: DiffOptions::default(),
 };
@@ -265,7 +265,11 @@ impl CompareCommitsComponent {
 self.git_diff.last()?
 {
 if params == diff_params {
-self.diff.update(f.path, false, last);
+self.diff.update(
+f.full_path_str().to_string(),
+false,
+last,
+);
 return Ok(());
 }
 }

src/components/inspect_commit.rs

@@ -270,7 +270,7 @@ impl InspectCommitComponent {
 if let Some(f) = self.details.files().selection_file()
 {
 let diff_params = DiffParams {
-path: f.path.clone(),
+path: f.full_path_str().to_string(),
 diff_type: DiffType::Commit(
 request.commit_id,
 ),
@@ -281,7 +281,11 @@ impl InspectCommitComponent {
 self.git_diff.last()?
 {
 if params == diff_params {
-self.diff.update(f.path, false, last);
+self.diff.update(
+f.full_path_str().to_string(),
+false,
+last,
+);
 return Ok(());
 }
 }

src/components/mod.rs

@@ -65,7 +65,6 @@ pub use syntax_text::SyntaxTextComponent;
 pub use tag_commit::TagCommitComponent;
 pub use taglist::TagListComponent;
 pub use textinput::{InputType, TextInputComponent};
-pub use utils::filetree::FileTreeItemKind;
 
 use crate::ui::style::Theme;
 use anyhow::Result;

src/components/status_tree.rs

@@ -1,8 +1,5 @@
 use super::{
-utils::{
-filetree::{FileTreeItem, FileTreeItemKind},
-statustree::{MoveSelection, StatusTree},
-},
+utils::statustree::{MoveSelection, StatusTree},
 BlameFileOpen, CommandBlocking, DrawableComponent, FileRevOpen,
 };
 use crate::{
@@ -16,11 +13,10 @@ use crate::{
 use anyhow::Result;
 use asyncgit::{hash, sync::CommitId, StatusItem, StatusItemType};
 use crossterm::event::Event;
+use filetreelist::{FileTreeItem, TreeItemInfo};
 use std::{borrow::Cow, cell::Cell, convert::From, path::Path};
 use tui::{backend::Backend, layout::Rect, text::Span, Frame};
 
-//TODO: use new `filetreelist` crate
-
 ///
 #[allow(clippy::struct_excessive_bools)]
 pub struct StatusTreeComponent {
@@ -82,20 +78,23 @@ impl StatusTreeComponent {
 
 ///
 pub fn selection(&self) -> Option<FileTreeItem> {
-self.tree.selected_item()
+self.tree.selected_tree_item()
 }
 
-///
-pub fn selection_file(&self) -> Option<StatusItem> {
+pub fn selection_file(&self) -> Option<TreeItemInfo> {
 self.tree.selected_item().and_then(|f| {
-if let FileTreeItemKind::File(f) = f.kind {
-Some(f)
-} else {
+if f.is_path() {
 None
+} else {
+Some(f.info().clone())
 }
 })
 }
 
+pub fn selection_status(&self) -> Option<StatusItem> {
+self.tree.selected_item().and_then(|i| i.status())
+}
+
 ///
 pub fn show_selection(&mut self, show: bool) {
 self.show_selection = show;
@@ -124,13 +123,10 @@ impl StatusTreeComponent {
 }
 
 ///
-pub fn is_file_seleted(&self) -> bool {
-self.tree.selected_item().map_or(false, |item| {
-match item.kind {
-FileTreeItemKind::File(_) => true,
-FileTreeItemKind::Path(..) => false,
-}
-})
+pub fn is_file_selected(&self) -> bool {
+self.tree
+.selected_item()
+.map_or(false, |item| !item.is_path())
 }
 
 fn move_selection(&mut self, dir: MoveSelection) -> bool {
@@ -160,7 +156,8 @@ impl StatusTreeComponent {
 string: &str,
 indent: usize,
 visible: bool,
-file_item_kind: &FileTreeItemKind,
+status_item: &Option<StatusItem>,
+path_collapsed: bool,
 width: u16,
 selected: bool,
 theme: &'b SharedTheme,
@@ -175,8 +172,8 @@ impl StatusTreeComponent {
 return None;
 }
 
-match file_item_kind {
-FileTreeItemKind::File(status_item) => {
+match status_item {
+Some(status_item) => {
 let status_char =
 Self::item_status_char(status_item.status);
 let file = Path::new(&status_item.path)
@@ -202,9 +199,9 @@ impl StatusTreeComponent {
 ))
 }
 
-FileTreeItemKind::Path(path_collapsed) => {
+_ => {
 let collapse_char =
-if path_collapsed.0 { '▸' } else { '▾' };
+if path_collapsed { '▸' } else { '▾' };
 
 let txt = if selected {
 format!(
@@ -246,31 +243,30 @@ impl StatusTreeComponent {
 let index_above_select =
 index < self.tree.selection.unwrap_or(0);
 
-if !item.info.visible && index_above_select {
+if !item.is_visible() && index_above_select {
 selection_offset_visible += 1;
 }
 
 vec_draw_text_info.push(TextDrawInfo {
-name: item.info.path.clone(),
-indent: item.info.indent,
-visible: item.info.visible,
-item_kind: &item.kind,
+name: item.info().path_str().to_string(),
+indent: item.info().indent(),
+visible: item.info().is_visible(),
+status_item: item.status(),
+path_collapsed: item.is_path_collapsed(),
 });
 
 let mut idx_temp = index;
 
 while idx_temp < tree_items.len().saturating_sub(2)
-&& tree_items[idx_temp].info.indent
-< tree_items[idx_temp + 1].info.indent
+&& tree_items[idx_temp].info().indent()
+< tree_items[idx_temp + 1].info().indent()
 {
 // fold up the folder/file
 idx_temp += 1;
 should_skip_over += 1;
 
 // don't fold files up
-if let FileTreeItemKind::File(_) =
-&tree_items[idx_temp].kind
-{
+if !tree_items[idx_temp].is_path() {
 should_skip_over -= 1;
 break;
 }
@@ -290,7 +286,7 @@ impl StatusTreeComponent {
 let vec_draw_text_info_len = vec_draw_text_info.len();
 vec_draw_text_info[vec_draw_text_info_len - 1]
 .name += &(String::from("/")
-+ &tree_items[idx_temp].info.path);
++ tree_items[idx_temp].info().path_str());
 if index_above_select {
 selection_offset += 1;
 }
@@ -305,11 +301,12 @@ impl StatusTreeComponent {
 }
 
 /// Used for drawing the `FileTreeComponent`
-struct TextDrawInfo<'a> {
+struct TextDrawInfo {
 name: String,
 indent: u8,
 visible: bool,
-item_kind: &'a FileTreeItemKind,
+status_item: Option<StatusItem>,
+path_collapsed: bool,
 }
 
 impl DrawableComponent for StatusTreeComponent {
@@ -364,7 +361,8 @@ impl DrawableComponent for StatusTreeComponent {
 &draw_text_info.name,
 draw_text_info.indent as usize,
 draw_text_info.visible,
-draw_text_info.item_kind,
+&draw_text_info.status_item,
+draw_text_info.path_collapsed,
 r.width,
 self.show_selection && select == index,
 &self.theme,
@@ -443,7 +441,9 @@ impl Component for StatusTreeComponent {
 queue.push(InternalEvent::OpenPopup(
 StackablePopupOpen::BlameFile(
 BlameFileOpen {
-file_path: status_item.path,
+file_path: status_item
+.full_path_str()
+.to_string(),
 commit_id: self.revision,
 selection: None,
 },
@@ -462,7 +462,9 @@ impl Component for StatusTreeComponent {
 queue.push(InternalEvent::OpenPopup(
 StackablePopupOpen::FileRevlog(
 FileRevOpen::new(
-status_item.path,
+status_item
+.full_path_str()
+.to_string(),
 ),
 ),
 ));
@@ -475,7 +477,11 @@ impl Component for StatusTreeComponent {
 if let Some(queue) = &self.queue {
 queue.push(
 InternalEvent::OpenExternalEditor(
-Some(status_item.path),
+Some(
+status_item
+.full_path_str()
+.to_string(),
+),
 ),
 );
 }