use collections::HashMap; use std::{ cell::OnceCell, collections::HashSet, ffi::OsStr, ops::Range, path::{Path, PathBuf}, sync::Arc, time::Duration, }; use git::repository::GitFileStatus; use util::{ResultExt, TryFutureExt}; use db::kvp::KEY_VALUE_STORE; use gpui::*; use project::{Entry, EntryKind, Fs, Project, ProjectEntryId, WorktreeId}; use serde::{Deserialize, Serialize}; use settings::Settings as _; use ui::{ prelude::*, Checkbox, Divider, DividerColor, ElevationIndex, Scrollbar, ScrollbarState, Tooltip, }; use workspace::dock::{DockPosition, Panel, PanelEvent}; use workspace::Workspace; use crate::{git_status_icon, settings::GitPanelSettings}; use crate::{CommitAllChanges, CommitStagedChanges, DiscardAll, StageAll, UnstageAll}; actions!(git_panel, [ToggleFocus]); const GIT_PANEL_KEY: &str = "GitPanel"; pub fn init(cx: &mut AppContext) { cx.observe_new_views( |workspace: &mut Workspace, _cx: &mut ViewContext| { workspace.register_action(|workspace, _: &ToggleFocus, cx| { workspace.toggle_panel_focus::(cx); }); }, ) .detach(); } #[derive(Debug)] pub enum Event { Focus, } pub struct GitStatusEntry {} #[derive(Debug, PartialEq, Eq, Clone)] struct EntryDetails { filename: String, display_name: String, path: Arc, kind: EntryKind, depth: usize, is_expanded: bool, status: Option, } impl EntryDetails { pub fn is_dir(&self) -> bool { self.kind.is_dir() } } #[derive(Serialize, Deserialize)] struct SerializedGitPanel { width: Option, } pub struct GitPanel { _workspace: WeakView, current_modifiers: Modifiers, focus_handle: FocusHandle, fs: Arc, hide_scrollbar_task: Option>, pending_serialization: Task>, project: Model, scroll_handle: UniformListScrollHandle, scrollbar_state: ScrollbarState, selected_item: Option, show_scrollbar: bool, expanded_dir_ids: HashMap>, // The entries that are currently shown in the panel, aka // not hidden by folding or such visible_entries: Vec<(WorktreeId, Vec, OnceCell>>)>, width: Option, } impl GitPanel { pub fn load( workspace: WeakView, cx: AsyncWindowContext, ) -> Task>> { cx.spawn(|mut cx| async move { // Clippy incorrectly classifies this as a redundant closure #[allow(clippy::redundant_closure)] workspace.update(&mut cx, |workspace, cx| Self::new(workspace, cx)) }) } pub fn new(workspace: &mut Workspace, cx: &mut ViewContext) -> View { let fs = workspace.app_state().fs.clone(); let weak_workspace = workspace.weak_handle(); let project = workspace.project().clone(); let git_panel = cx.new_view(|cx: &mut ViewContext| { let focus_handle = cx.focus_handle(); cx.on_focus(&focus_handle, Self::focus_in).detach(); cx.on_focus_out(&focus_handle, |this, _, cx| { this.hide_scrollbar(cx); }) .detach(); cx.subscribe(&project, |this, _project, event, cx| match event { project::Event::WorktreeRemoved(id) => { this.expanded_dir_ids.remove(id); this.update_visible_entries(None, cx); cx.notify(); } project::Event::WorktreeUpdatedEntries(_, _) | project::Event::WorktreeAdded(_) | project::Event::WorktreeOrderChanged => { this.update_visible_entries(None, cx); cx.notify(); } _ => {} }) .detach(); let scroll_handle = UniformListScrollHandle::new(); let mut this = Self { _workspace: weak_workspace, focus_handle: cx.focus_handle(), fs, pending_serialization: Task::ready(None), project, visible_entries: Vec::new(), current_modifiers: cx.modifiers(), expanded_dir_ids: Default::default(), width: Some(px(360.)), scrollbar_state: ScrollbarState::new(scroll_handle.clone()).parent_view(cx.view()), scroll_handle, selected_item: None, show_scrollbar: !Self::should_autohide_scrollbar(cx), hide_scrollbar_task: None, }; this.update_visible_entries(None, cx); this }); git_panel } fn serialize(&mut self, cx: &mut ViewContext) { let width = self.width; self.pending_serialization = cx.background_executor().spawn( async move { KEY_VALUE_STORE .write_kvp( GIT_PANEL_KEY.into(), serde_json::to_string(&SerializedGitPanel { width })?, ) .await?; anyhow::Ok(()) } .log_err(), ); } fn dispatch_context(&self) -> KeyContext { let mut dispatch_context = KeyContext::new_with_defaults(); dispatch_context.add("GitPanel"); dispatch_context.add("menu"); dispatch_context } fn focus_in(&mut self, cx: &mut ViewContext) { if !self.focus_handle.contains_focused(cx) { cx.emit(Event::Focus); } } fn should_show_scrollbar(_cx: &AppContext) -> bool { // TODO: plug into settings true } fn should_autohide_scrollbar(_cx: &AppContext) -> bool { // TODO: plug into settings true } fn hide_scrollbar(&mut self, cx: &mut ViewContext) { const SCROLLBAR_SHOW_INTERVAL: Duration = Duration::from_secs(1); if !Self::should_autohide_scrollbar(cx) { return; } self.hide_scrollbar_task = Some(cx.spawn(|panel, mut cx| async move { cx.background_executor() .timer(SCROLLBAR_SHOW_INTERVAL) .await; panel .update(&mut cx, |panel, cx| { panel.show_scrollbar = false; cx.notify(); }) .log_err(); })) } fn handle_modifiers_changed( &mut self, event: &ModifiersChangedEvent, cx: &mut ViewContext, ) { self.current_modifiers = event.modifiers; cx.notify(); } fn calculate_depth_and_difference( entry: &Entry, visible_worktree_entries: &HashSet>, ) -> (usize, usize) { let (depth, difference) = entry .path .ancestors() .skip(1) // Skip the entry itself .find_map(|ancestor| { if let Some(parent_entry) = visible_worktree_entries.get(ancestor) { let entry_path_components_count = entry.path.components().count(); let parent_path_components_count = parent_entry.components().count(); let difference = entry_path_components_count - parent_path_components_count; let depth = parent_entry .ancestors() .skip(1) .filter(|ancestor| visible_worktree_entries.contains(*ancestor)) .count(); Some((depth + 1, difference)) } else { None } }) .unwrap_or((0, 0)); (depth, difference) } } impl GitPanel { fn stage_all(&mut self, _: &StageAll, _cx: &mut ViewContext) { // TODO: Implement stage all println!("Stage all triggered"); } fn unstage_all(&mut self, _: &UnstageAll, _cx: &mut ViewContext) { // TODO: Implement unstage all println!("Unstage all triggered"); } fn discard_all(&mut self, _: &DiscardAll, _cx: &mut ViewContext) { // TODO: Implement discard all println!("Discard all triggered"); } /// Commit all staged changes fn commit_staged_changes(&mut self, _: &CommitStagedChanges, _cx: &mut ViewContext) { // TODO: Implement commit all staged println!("Commit staged changes triggered"); } /// Commit all changes, regardless of whether they are staged or not fn commit_all_changes(&mut self, _: &CommitAllChanges, _cx: &mut ViewContext) { // TODO: Implement commit all changes println!("Commit all changes triggered"); } fn all_staged(&self) -> bool { // TODO: Implement all_staged true } fn no_entries(&self) -> bool { self.visible_entries.is_empty() } fn entry_count(&self) -> usize { self.visible_entries .iter() .map(|(_, entries, _)| { entries .iter() .filter(|entry| entry.git_status.is_some()) .count() }) .sum() } fn for_each_visible_entry( &self, range: Range, cx: &mut ViewContext, mut callback: impl FnMut(ProjectEntryId, EntryDetails, &mut ViewContext), ) { let mut ix = 0; for (worktree_id, visible_worktree_entries, entries_paths) in &self.visible_entries { if ix >= range.end { return; } if ix + visible_worktree_entries.len() <= range.start { ix += visible_worktree_entries.len(); continue; } let end_ix = range.end.min(ix + visible_worktree_entries.len()); // let entry_range = range.start.saturating_sub(ix)..end_ix - ix; if let Some(worktree) = self.project.read(cx).worktree_for_id(*worktree_id, cx) { let snapshot = worktree.read(cx).snapshot(); let root_name = OsStr::new(snapshot.root_name()); let expanded_entry_ids = self .expanded_dir_ids .get(&snapshot.id()) .map(Vec::as_slice) .unwrap_or(&[]); let entry_range = range.start.saturating_sub(ix)..end_ix - ix; let entries = entries_paths.get_or_init(|| { visible_worktree_entries .iter() .map(|e| (e.path.clone())) .collect() }); for entry in visible_worktree_entries[entry_range].iter() { let status = entry.git_status; let is_expanded = expanded_entry_ids.binary_search(&entry.id).is_ok(); let (depth, difference) = Self::calculate_depth_and_difference(entry, entries); let filename = match difference { diff if diff > 1 => entry .path .iter() .skip(entry.path.components().count() - diff) .collect::() .to_str() .unwrap_or_default() .to_string(), _ => entry .path .file_name() .map(|name| name.to_string_lossy().into_owned()) .unwrap_or_else(|| root_name.to_string_lossy().to_string()), }; let display_name = entry.path.to_string_lossy().into_owned(); let details = EntryDetails { filename, display_name, kind: entry.kind, is_expanded, path: entry.path.clone(), status, depth, }; callback(entry.id, details, cx); } } ix = end_ix; } } // TODO: Update expanded directory state fn update_visible_entries( &mut self, new_selected_entry: Option<(WorktreeId, ProjectEntryId)>, cx: &mut ViewContext, ) { let project = self.project.read(cx); self.visible_entries.clear(); for worktree in project.visible_worktrees(cx) { let snapshot = worktree.read(cx).snapshot(); let worktree_id = snapshot.id(); let mut visible_worktree_entries = Vec::new(); let mut entry_iter = snapshot.entries(true, 0); while let Some(entry) = entry_iter.entry() { // Only include entries with a git status if entry.git_status.is_some() { visible_worktree_entries.push(entry.clone()); } entry_iter.advance(); } snapshot.propagate_git_statuses(&mut visible_worktree_entries); project::sort_worktree_entries(&mut visible_worktree_entries); if !visible_worktree_entries.is_empty() { self.visible_entries .push((worktree_id, visible_worktree_entries, OnceCell::new())); } } if let Some((worktree_id, entry_id)) = new_selected_entry { self.selected_item = self.visible_entries.iter().enumerate().find_map( |(worktree_index, (id, entries, _))| { if *id == worktree_id { entries .iter() .position(|entry| entry.id == entry_id) .map(|entry_index| worktree_index * entries.len() + entry_index) } else { None } }, ); } cx.notify(); } } impl GitPanel { pub fn panel_button( &self, id: impl Into, label: impl Into, ) -> Button { let id = id.into().clone(); let label = label.into().clone(); Button::new(id, label) .label_size(LabelSize::Small) .layer(ElevationIndex::ElevatedSurface) .size(ButtonSize::Compact) .style(ButtonStyle::Filled) } pub fn render_divider(&self, _cx: &mut ViewContext) -> impl IntoElement { h_flex() .items_center() .h(px(8.)) .child(Divider::horizontal_dashed().color(DividerColor::Border)) } pub fn render_panel_header(&self, cx: &mut ViewContext) -> impl IntoElement { let focus_handle = self.focus_handle(cx).clone(); let changes_string = format!("{} changes", self.entry_count()); h_flex() .h(px(32.)) .items_center() .px_3() .bg(ElevationIndex::Surface.bg(cx)) .child( h_flex() .gap_2() .child(Checkbox::new("all-changes", true.into()).disabled(true)) .child(div().text_buffer(cx).text_ui_sm(cx).child(changes_string)), ) .child(div().flex_grow()) .child( h_flex() .gap_2() .child( IconButton::new("discard-changes", IconName::Undo) .tooltip(move |cx| { let focus_handle = focus_handle.clone(); Tooltip::for_action_in( "Discard all changes", &DiscardAll, &focus_handle, cx, ) }) .icon_size(IconSize::Small) .disabled(true), ) .child(if self.all_staged() { self.panel_button("unstage-all", "Unstage All").on_click( cx.listener(move |_, _, cx| cx.dispatch_action(Box::new(DiscardAll))), ) } else { self.panel_button("stage-all", "Stage All").on_click( cx.listener(move |_, _, cx| cx.dispatch_action(Box::new(StageAll))), ) }), ) } pub fn render_commit_editor(&self, cx: &ViewContext) -> impl IntoElement { let focus_handle_1 = self.focus_handle(cx).clone(); let focus_handle_2 = self.focus_handle(cx).clone(); let commit_staged_button = self .panel_button("commit-staged-changes", "Commit") .tooltip(move |cx| { let focus_handle = focus_handle_1.clone(); Tooltip::for_action_in( "Commit all staged changes", &CommitStagedChanges, &focus_handle, cx, ) }) .on_click(cx.listener(|this, _: &ClickEvent, cx| { this.commit_staged_changes(&CommitStagedChanges, cx) })); let commit_all_button = self .panel_button("commit-all-changes", "Commit All") .tooltip(move |cx| { let focus_handle = focus_handle_2.clone(); Tooltip::for_action_in( "Commit all changes, including unstaged changes", &CommitAllChanges, &focus_handle, cx, ) }) .on_click(cx.listener(|this, _: &ClickEvent, cx| { this.commit_all_changes(&CommitAllChanges, cx) })); div().w_full().h(px(140.)).px_2().pt_1().pb_2().child( v_flex() .h_full() .py_2p5() .px_3() .bg(cx.theme().colors().editor_background) .font_buffer(cx) .text_ui_sm(cx) .text_color(cx.theme().colors().text_muted) .child("Add a message") .gap_1() .child(div().flex_grow()) .child(h_flex().child(div().gap_1().flex_grow()).child( if self.current_modifiers.alt { commit_all_button } else { commit_staged_button }, )) .cursor(CursorStyle::OperationNotAllowed) .opacity(0.5), ) } fn render_empty_state(&self, cx: &ViewContext) -> impl IntoElement { h_flex() .h_full() .flex_1() .justify_center() .items_center() .child( v_flex() .gap_3() .child("No changes to commit") .text_ui_sm(cx) .mx_auto() .text_color(Color::Placeholder.color(cx)), ) } fn render_scrollbar(&self, cx: &mut ViewContext) -> Option> { if !Self::should_show_scrollbar(cx) || !(self.show_scrollbar || self.scrollbar_state.is_dragging()) { return None; } Some( div() .occlude() .id("project-panel-vertical-scroll") .on_mouse_move(cx.listener(|_, _, cx| { cx.notify(); cx.stop_propagation() })) .on_hover(|_, cx| { cx.stop_propagation(); }) .on_any_mouse_down(|_, cx| { cx.stop_propagation(); }) .on_mouse_up( MouseButton::Left, cx.listener(|this, _, cx| { if !this.scrollbar_state.is_dragging() && !this.focus_handle.contains_focused(cx) { this.hide_scrollbar(cx); cx.notify(); } cx.stop_propagation(); }), ) .on_scroll_wheel(cx.listener(|_, _, cx| { cx.notify(); })) .h_full() .absolute() .right_1() .top_1() .bottom_1() .w(px(12.)) .cursor_default() .children(Scrollbar::vertical( // percentage as f32..end_offset as f32, self.scrollbar_state.clone(), )), ) } fn render_entries(&self, cx: &mut ViewContext) -> impl IntoElement { let item_count = self .visible_entries .iter() .map(|(_, worktree_entries, _)| worktree_entries.len()) .sum(); h_flex() .size_full() .overflow_hidden() .child( uniform_list(cx.view().clone(), "entries", item_count, { |this, range, cx| { let mut items = Vec::with_capacity(range.end - range.start); this.for_each_visible_entry(range, cx, |id, details, cx| { items.push(this.render_entry(id, details, cx)); }); items } }) .size_full() .with_sizing_behavior(ListSizingBehavior::Infer) .with_horizontal_sizing_behavior(ListHorizontalSizingBehavior::Unconstrained) // .with_width_from_item(self.max_width_item_index) .track_scroll(self.scroll_handle.clone()), ) .children(self.render_scrollbar(cx)) } fn render_entry( &self, id: ProjectEntryId, details: EntryDetails, cx: &ViewContext, ) -> impl IntoElement { let id = id.to_proto() as usize; let checkbox_id = ElementId::Name(format!("checkbox_{}", id).into()); let is_staged = ToggleState::Selected; h_flex() .id(id) .h(px(28.)) .w_full() .pl(px(12. + 12. * details.depth as f32)) .pr(px(4.)) .items_center() .gap_2() .font_buffer(cx) .text_ui_sm(cx) .when(!details.is_dir(), |this| { this.child(Checkbox::new(checkbox_id, is_staged)) }) .when_some(details.status, |this, status| { this.child(git_status_icon(status)) }) .child(h_flex().gap_1p5().child(details.display_name.clone())) } } impl Render for GitPanel { fn render(&mut self, cx: &mut ViewContext) -> impl IntoElement { let project = self.project.read(cx); v_flex() .id("git_panel") .key_context(self.dispatch_context()) .track_focus(&self.focus_handle) .on_modifiers_changed(cx.listener(Self::handle_modifiers_changed)) .when(!project.is_read_only(cx), |this| { this.on_action(cx.listener(|this, &StageAll, cx| this.stage_all(&StageAll, cx))) .on_action( cx.listener(|this, &UnstageAll, cx| this.unstage_all(&UnstageAll, cx)), ) .on_action( cx.listener(|this, &DiscardAll, cx| this.discard_all(&DiscardAll, cx)), ) .on_action(cx.listener(|this, &CommitStagedChanges, cx| { this.commit_staged_changes(&CommitStagedChanges, cx) })) .on_action(cx.listener(|this, &CommitAllChanges, cx| { this.commit_all_changes(&CommitAllChanges, cx) })) }) .on_hover(cx.listener(|this, hovered, cx| { if *hovered { this.show_scrollbar = true; this.hide_scrollbar_task.take(); cx.notify(); } else if !this.focus_handle.contains_focused(cx) { this.hide_scrollbar(cx); } })) .size_full() .overflow_hidden() .font_buffer(cx) .py_1() .bg(ElevationIndex::Surface.bg(cx)) .child(self.render_panel_header(cx)) .child(self.render_divider(cx)) .child(if !self.no_entries() { self.render_entries(cx).into_any_element() } else { self.render_empty_state(cx).into_any_element() }) .child(self.render_divider(cx)) .child(self.render_commit_editor(cx)) } } impl FocusableView for GitPanel { fn focus_handle(&self, _: &AppContext) -> gpui::FocusHandle { self.focus_handle.clone() } } impl EventEmitter for GitPanel {} impl EventEmitter for GitPanel {} impl Panel for GitPanel { fn persistent_name() -> &'static str { "GitPanel" } fn position(&self, cx: &gpui::WindowContext) -> DockPosition { GitPanelSettings::get_global(cx).dock } fn position_is_valid(&self, position: DockPosition) -> bool { matches!(position, DockPosition::Left | DockPosition::Right) } fn set_position(&mut self, position: DockPosition, cx: &mut ViewContext) { settings::update_settings_file::( self.fs.clone(), cx, move |settings, _| settings.dock = Some(position), ); } fn size(&self, cx: &gpui::WindowContext) -> Pixels { self.width .unwrap_or_else(|| GitPanelSettings::get_global(cx).default_width) } fn set_size(&mut self, size: Option, cx: &mut ViewContext) { self.width = size; self.serialize(cx); cx.notify(); } fn icon(&self, cx: &WindowContext) -> Option { Some(ui::IconName::GitBranch).filter(|_| GitPanelSettings::get_global(cx).button) } fn icon_tooltip(&self, _cx: &WindowContext) -> Option<&'static str> { Some("Git Panel") } fn toggle_action(&self) -> Box { Box::new(ToggleFocus) } }