1use std::{cmp, ops::ControlFlow, path::PathBuf, process::ExitStatus, sync::Arc, time::Duration};
   2
   3use crate::{
   4    TerminalView, default_working_directory,
   5    persistence::{
   6        SerializedItems, SerializedTerminalPanel, deserialize_terminal_panel, serialize_pane_group,
   7    },
   8};
   9use breadcrumbs::Breadcrumbs;
  10use collections::HashMap;
  11use db::kvp::KEY_VALUE_STORE;
  12use futures::{channel::oneshot, future::join_all};
  13use gpui::{
  14    Action, AnyView, App, AsyncApp, AsyncWindowContext, Context, Corner, Entity, EventEmitter,
  15    ExternalPaths, FocusHandle, Focusable, IntoElement, ParentElement, Pixels, Render, Styled,
  16    Task, WeakEntity, Window, actions,
  17};
  18use itertools::Itertools;
  19use project::{Fs, Project, ProjectEntryId};
  20use search::{BufferSearchBar, buffer_search::DivRegistrar};
  21use settings::{Settings, TerminalDockPosition};
  22use task::{RevealStrategy, RevealTarget, Shell, ShellBuilder, SpawnInTerminal, TaskId};
  23use terminal::{Terminal, terminal_settings::TerminalSettings};
  24use ui::{
  25    ButtonLike, Clickable, ContextMenu, FluentBuilder, PopoverMenu, SplitButton, Toggleable,
  26    Tooltip, prelude::*,
  27};
  28use util::{ResultExt, TryFutureExt};
  29use workspace::{
  30    ActivateNextPane, ActivatePane, ActivatePaneDown, ActivatePaneLeft, ActivatePaneRight,
  31    ActivatePaneUp, ActivatePreviousPane, DraggedSelection, DraggedTab, ItemId, MoveItemToPane,
  32    MoveItemToPaneInDirection, MovePaneDown, MovePaneLeft, MovePaneRight, MovePaneUp, NewTerminal,
  33    Pane, PaneGroup, SplitDirection, SplitDown, SplitLeft, SplitRight, SplitUp, SwapPaneDown,
  34    SwapPaneLeft, SwapPaneRight, SwapPaneUp, ToggleZoom, Workspace,
  35    dock::{DockPosition, Panel, PanelEvent, PanelHandle},
  36    item::SerializableItem,
  37    move_active_item, move_item, pane,
  38};
  39
  40use anyhow::{Result, anyhow};
  41use zed_actions::assistant::InlineAssist;
  42
  43const TERMINAL_PANEL_KEY: &str = "TerminalPanel";
  44
  45actions!(
  46    terminal_panel,
  47    [
  48        /// Toggles the terminal panel.
  49        Toggle,
  50        /// Toggles focus on the terminal panel.
  51        ToggleFocus
  52    ]
  53);
  54
  55pub fn init(cx: &mut App) {
  56    cx.observe_new(
  57        |workspace: &mut Workspace, _window, _: &mut Context<Workspace>| {
  58            workspace.register_action(TerminalPanel::new_terminal);
  59            workspace.register_action(TerminalPanel::open_terminal);
  60            workspace.register_action(|workspace, _: &ToggleFocus, window, cx| {
  61                if is_enabled_in_workspace(workspace, cx) {
  62                    workspace.toggle_panel_focus::<TerminalPanel>(window, cx);
  63                }
  64            });
  65            workspace.register_action(|workspace, _: &Toggle, window, cx| {
  66                if is_enabled_in_workspace(workspace, cx) {
  67                    if !workspace.toggle_panel_focus::<TerminalPanel>(window, cx) {
  68                        workspace.close_panel::<TerminalPanel>(window, cx);
  69                    }
  70                }
  71            });
  72        },
  73    )
  74    .detach();
  75}
  76
  77pub struct TerminalPanel {
  78    pub(crate) active_pane: Entity<Pane>,
  79    pub(crate) center: PaneGroup,
  80    fs: Arc<dyn Fs>,
  81    workspace: WeakEntity<Workspace>,
  82    pub(crate) width: Option<Pixels>,
  83    pub(crate) height: Option<Pixels>,
  84    pending_serialization: Task<Option<()>>,
  85    pending_terminals_to_add: usize,
  86    deferred_tasks: HashMap<TaskId, Task<()>>,
  87    assistant_enabled: bool,
  88    assistant_tab_bar_button: Option<AnyView>,
  89    active: bool,
  90}
  91
  92impl TerminalPanel {
  93    pub fn new(workspace: &Workspace, window: &mut Window, cx: &mut Context<Self>) -> Self {
  94        let project = workspace.project();
  95        let pane = new_terminal_pane(workspace.weak_handle(), project.clone(), false, window, cx);
  96        let center = PaneGroup::new(pane.clone());
  97        let terminal_panel = Self {
  98            center,
  99            active_pane: pane,
 100            fs: workspace.app_state().fs.clone(),
 101            workspace: workspace.weak_handle(),
 102            pending_serialization: Task::ready(None),
 103            width: None,
 104            height: None,
 105            pending_terminals_to_add: 0,
 106            deferred_tasks: HashMap::default(),
 107            assistant_enabled: false,
 108            assistant_tab_bar_button: None,
 109            active: false,
 110        };
 111        terminal_panel.apply_tab_bar_buttons(&terminal_panel.active_pane, cx);
 112        terminal_panel
 113    }
 114
 115    pub fn set_assistant_enabled(&mut self, enabled: bool, cx: &mut Context<Self>) {
 116        self.assistant_enabled = enabled;
 117        if enabled {
 118            let focus_handle = self
 119                .active_pane
 120                .read(cx)
 121                .active_item()
 122                .map(|item| item.item_focus_handle(cx))
 123                .unwrap_or(self.focus_handle(cx));
 124            self.assistant_tab_bar_button = Some(
 125                cx.new(move |_| InlineAssistTabBarButton { focus_handle })
 126                    .into(),
 127            );
 128        } else {
 129            self.assistant_tab_bar_button = None;
 130        }
 131        for pane in self.center.panes() {
 132            self.apply_tab_bar_buttons(pane, cx);
 133        }
 134    }
 135
 136    fn apply_tab_bar_buttons(&self, terminal_pane: &Entity<Pane>, cx: &mut Context<Self>) {
 137        let assistant_tab_bar_button = self.assistant_tab_bar_button.clone();
 138        terminal_pane.update(cx, |pane, cx| {
 139            pane.set_render_tab_bar_buttons(cx, move |pane, window, cx| {
 140                let split_context = pane
 141                    .active_item()
 142                    .and_then(|item| item.downcast::<TerminalView>())
 143                    .map(|terminal_view| terminal_view.read(cx).focus_handle.clone());
 144                if !pane.has_focus(window, cx) && !pane.context_menu_focused(window, cx) {
 145                    return (None, None);
 146                }
 147                let focus_handle = pane.focus_handle(cx);
 148                let right_children = h_flex()
 149                    .gap(DynamicSpacing::Base02.rems(cx))
 150                    .child(
 151                        PopoverMenu::new("terminal-tab-bar-popover-menu")
 152                            .trigger_with_tooltip(
 153                                IconButton::new("plus", IconName::Plus).icon_size(IconSize::Small),
 154                                Tooltip::text("New…"),
 155                            )
 156                            .anchor(Corner::TopRight)
 157                            .with_handle(pane.new_item_context_menu_handle.clone())
 158                            .menu(move |window, cx| {
 159                                let focus_handle = focus_handle.clone();
 160                                let menu = ContextMenu::build(window, cx, |menu, _, _| {
 161                                    menu.context(focus_handle.clone())
 162                                        .action(
 163                                            "New Terminal",
 164                                            workspace::NewTerminal.boxed_clone(),
 165                                        )
 166                                        // We want the focus to go back to terminal panel once task modal is dismissed,
 167                                        // hence we focus that first. Otherwise, we'd end up without a focused element, as
 168                                        // context menu will be gone the moment we spawn the modal.
 169                                        .action(
 170                                            "Spawn Task",
 171                                            zed_actions::Spawn::modal().boxed_clone(),
 172                                        )
 173                                });
 174
 175                                Some(menu)
 176                            }),
 177                    )
 178                    .children(assistant_tab_bar_button.clone())
 179                    .child(
 180                        PopoverMenu::new("terminal-pane-tab-bar-split")
 181                            .trigger_with_tooltip(
 182                                IconButton::new("terminal-pane-split", IconName::Split)
 183                                    .icon_size(IconSize::Small),
 184                                Tooltip::text("Split Pane"),
 185                            )
 186                            .anchor(Corner::TopRight)
 187                            .with_handle(pane.split_item_context_menu_handle.clone())
 188                            .menu({
 189                                move |window, cx| {
 190                                    ContextMenu::build(window, cx, |menu, _, _| {
 191                                        menu.when_some(
 192                                            split_context.clone(),
 193                                            |menu, split_context| menu.context(split_context),
 194                                        )
 195                                        .action("Split Right", SplitRight.boxed_clone())
 196                                        .action("Split Left", SplitLeft.boxed_clone())
 197                                        .action("Split Up", SplitUp.boxed_clone())
 198                                        .action("Split Down", SplitDown.boxed_clone())
 199                                    })
 200                                    .into()
 201                                }
 202                            }),
 203                    )
 204                    .child({
 205                        let zoomed = pane.is_zoomed();
 206                        IconButton::new("toggle_zoom", IconName::Maximize)
 207                            .icon_size(IconSize::Small)
 208                            .toggle_state(zoomed)
 209                            .selected_icon(IconName::Minimize)
 210                            .on_click(cx.listener(|pane, _, window, cx| {
 211                                pane.toggle_zoom(&workspace::ToggleZoom, window, cx);
 212                            }))
 213                            .tooltip(move |_window, cx| {
 214                                Tooltip::for_action(
 215                                    if zoomed { "Zoom Out" } else { "Zoom In" },
 216                                    &ToggleZoom,
 217                                    cx,
 218                                )
 219                            })
 220                    })
 221                    .into_any_element()
 222                    .into();
 223                (None, right_children)
 224            });
 225        });
 226    }
 227
 228    fn serialization_key(workspace: &Workspace) -> Option<String> {
 229        workspace
 230            .database_id()
 231            .map(|id| i64::from(id).to_string())
 232            .or(workspace.session_id())
 233            .map(|id| format!("{:?}-{:?}", TERMINAL_PANEL_KEY, id))
 234    }
 235
 236    pub async fn load(
 237        workspace: WeakEntity<Workspace>,
 238        mut cx: AsyncWindowContext,
 239    ) -> Result<Entity<Self>> {
 240        let mut terminal_panel = None;
 241
 242        if let Some((database_id, serialization_key)) = workspace
 243            .read_with(&cx, |workspace, _| {
 244                workspace
 245                    .database_id()
 246                    .zip(TerminalPanel::serialization_key(workspace))
 247            })
 248            .ok()
 249            .flatten()
 250            && let Some(serialized_panel) = cx
 251                .background_spawn(async move { KEY_VALUE_STORE.read_kvp(&serialization_key) })
 252                .await
 253                .log_err()
 254                .flatten()
 255                .map(|panel| serde_json::from_str::<SerializedTerminalPanel>(&panel))
 256                .transpose()
 257                .log_err()
 258                .flatten()
 259            && let Ok(serialized) = workspace
 260                .update_in(&mut cx, |workspace, window, cx| {
 261                    deserialize_terminal_panel(
 262                        workspace.weak_handle(),
 263                        workspace.project().clone(),
 264                        database_id,
 265                        serialized_panel,
 266                        window,
 267                        cx,
 268                    )
 269                })?
 270                .await
 271        {
 272            terminal_panel = Some(serialized);
 273        }
 274
 275        let terminal_panel = if let Some(panel) = terminal_panel {
 276            panel
 277        } else {
 278            workspace.update_in(&mut cx, |workspace, window, cx| {
 279                cx.new(|cx| TerminalPanel::new(workspace, window, cx))
 280            })?
 281        };
 282
 283        if let Some(workspace) = workspace.upgrade() {
 284            workspace
 285                .update(&mut cx, |workspace, _| {
 286                    workspace.set_terminal_provider(TerminalProvider(terminal_panel.clone()))
 287                })
 288                .ok();
 289        }
 290
 291        // Since panels/docks are loaded outside from the workspace, we cleanup here, instead of through the workspace.
 292        if let Some(workspace) = workspace.upgrade() {
 293            let cleanup_task = workspace.update_in(&mut cx, |workspace, window, cx| {
 294                let alive_item_ids = terminal_panel
 295                    .read(cx)
 296                    .center
 297                    .panes()
 298                    .into_iter()
 299                    .flat_map(|pane| pane.read(cx).items())
 300                    .map(|item| item.item_id().as_u64() as ItemId)
 301                    .collect();
 302                workspace.database_id().map(|workspace_id| {
 303                    TerminalView::cleanup(workspace_id, alive_item_ids, window, cx)
 304                })
 305            })?;
 306            if let Some(task) = cleanup_task {
 307                task.await.log_err();
 308            }
 309        }
 310
 311        if let Some(workspace) = workspace.upgrade() {
 312            let should_focus = workspace
 313                .update_in(&mut cx, |workspace, window, cx| {
 314                    workspace.active_item(cx).is_none()
 315                        && workspace
 316                            .is_dock_at_position_open(terminal_panel.position(window, cx), cx)
 317                })
 318                .unwrap_or(false);
 319
 320            if should_focus {
 321                terminal_panel
 322                    .update_in(&mut cx, |panel, window, cx| {
 323                        panel.active_pane.update(cx, |pane, cx| {
 324                            pane.focus_active_item(window, cx);
 325                        });
 326                    })
 327                    .ok();
 328            }
 329        }
 330        Ok(terminal_panel)
 331    }
 332
 333    fn handle_pane_event(
 334        &mut self,
 335        pane: &Entity<Pane>,
 336        event: &pane::Event,
 337        window: &mut Window,
 338        cx: &mut Context<Self>,
 339    ) {
 340        match event {
 341            pane::Event::ActivateItem { .. } => self.serialize(cx),
 342            pane::Event::RemovedItem { .. } => self.serialize(cx),
 343            pane::Event::Remove { focus_on_pane } => {
 344                let pane_count_before_removal = self.center.panes().len();
 345                let _removal_result = self.center.remove(pane, cx);
 346                if pane_count_before_removal == 1 {
 347                    self.center.first_pane().update(cx, |pane, cx| {
 348                        pane.set_zoomed(false, cx);
 349                    });
 350                    cx.emit(PanelEvent::Close);
 351                } else if let Some(focus_on_pane) =
 352                    focus_on_pane.as_ref().or_else(|| self.center.panes().pop())
 353                {
 354                    focus_on_pane.focus_handle(cx).focus(window);
 355                }
 356            }
 357            pane::Event::ZoomIn => {
 358                for pane in self.center.panes() {
 359                    pane.update(cx, |pane, cx| {
 360                        pane.set_zoomed(true, cx);
 361                    })
 362                }
 363                cx.emit(PanelEvent::ZoomIn);
 364                cx.notify();
 365            }
 366            pane::Event::ZoomOut => {
 367                for pane in self.center.panes() {
 368                    pane.update(cx, |pane, cx| {
 369                        pane.set_zoomed(false, cx);
 370                    })
 371                }
 372                cx.emit(PanelEvent::ZoomOut);
 373                cx.notify();
 374            }
 375            pane::Event::AddItem { item } => {
 376                if let Some(workspace) = self.workspace.upgrade() {
 377                    workspace.update(cx, |workspace, cx| {
 378                        item.added_to_pane(workspace, pane.clone(), window, cx)
 379                    })
 380                }
 381                self.serialize(cx);
 382            }
 383            &pane::Event::Split {
 384                direction,
 385                clone_active_item,
 386            } => {
 387                if clone_active_item {
 388                    let fut = self.new_pane_with_cloned_active_terminal(window, cx);
 389                    let pane = pane.clone();
 390                    cx.spawn_in(window, async move |panel, cx| {
 391                        let Some(new_pane) = fut.await else {
 392                            return;
 393                        };
 394                        panel
 395                            .update_in(cx, |panel, window, cx| {
 396                                panel
 397                                    .center
 398                                    .split(&pane, &new_pane, direction, cx)
 399                                    .log_err();
 400                                window.focus(&new_pane.focus_handle(cx));
 401                            })
 402                            .ok();
 403                    })
 404                    .detach();
 405                } else {
 406                    let Some(item) = pane.update(cx, |pane, cx| pane.take_active_item(window, cx))
 407                    else {
 408                        return;
 409                    };
 410                    let Ok(project) = self
 411                        .workspace
 412                        .update(cx, |workspace, _| workspace.project().clone())
 413                    else {
 414                        return;
 415                    };
 416                    let new_pane =
 417                        new_terminal_pane(self.workspace.clone(), project, false, window, cx);
 418                    new_pane.update(cx, |pane, cx| {
 419                        pane.add_item(item, true, true, None, window, cx);
 420                    });
 421                    self.center.split(&pane, &new_pane, direction, cx).log_err();
 422                    window.focus(&new_pane.focus_handle(cx));
 423                }
 424            }
 425            pane::Event::Focus => {
 426                self.active_pane = pane.clone();
 427            }
 428            pane::Event::ItemPinned | pane::Event::ItemUnpinned => {
 429                self.serialize(cx);
 430            }
 431
 432            _ => {}
 433        }
 434    }
 435
 436    fn new_pane_with_cloned_active_terminal(
 437        &mut self,
 438        window: &mut Window,
 439        cx: &mut Context<Self>,
 440    ) -> Task<Option<Entity<Pane>>> {
 441        let Some(workspace) = self.workspace.upgrade() else {
 442            return Task::ready(None);
 443        };
 444        let workspace = workspace.read(cx);
 445        let database_id = workspace.database_id();
 446        let weak_workspace = self.workspace.clone();
 447        let project = workspace.project().clone();
 448        let active_pane = &self.active_pane;
 449        let terminal_view = active_pane
 450            .read(cx)
 451            .active_item()
 452            .and_then(|item| item.downcast::<TerminalView>());
 453        let working_directory = terminal_view
 454            .as_ref()
 455            .and_then(|terminal_view| {
 456                terminal_view
 457                    .read(cx)
 458                    .terminal()
 459                    .read(cx)
 460                    .working_directory()
 461            })
 462            .or_else(|| default_working_directory(workspace, cx));
 463        let is_zoomed = active_pane.read(cx).is_zoomed();
 464        cx.spawn_in(window, async move |panel, cx| {
 465            let terminal = project
 466                .update(cx, |project, cx| match terminal_view {
 467                    Some(view) => project.clone_terminal(
 468                        &view.read(cx).terminal.clone(),
 469                        cx,
 470                        working_directory,
 471                    ),
 472                    None => project.create_terminal_shell(working_directory, cx),
 473                })
 474                .ok()?
 475                .await
 476                .log_err()?;
 477
 478            panel
 479                .update_in(cx, move |terminal_panel, window, cx| {
 480                    let terminal_view = Box::new(cx.new(|cx| {
 481                        TerminalView::new(
 482                            terminal.clone(),
 483                            weak_workspace.clone(),
 484                            database_id,
 485                            project.downgrade(),
 486                            window,
 487                            cx,
 488                        )
 489                    }));
 490                    let pane = new_terminal_pane(weak_workspace, project, is_zoomed, window, cx);
 491                    terminal_panel.apply_tab_bar_buttons(&pane, cx);
 492                    pane.update(cx, |pane, cx| {
 493                        pane.add_item(terminal_view, true, true, None, window, cx);
 494                    });
 495                    Some(pane)
 496                })
 497                .ok()
 498                .flatten()
 499        })
 500    }
 501
 502    pub fn open_terminal(
 503        workspace: &mut Workspace,
 504        action: &workspace::OpenTerminal,
 505        window: &mut Window,
 506        cx: &mut Context<Workspace>,
 507    ) {
 508        let Some(terminal_panel) = workspace.panel::<Self>(cx) else {
 509            return;
 510        };
 511
 512        terminal_panel
 513            .update(cx, |panel, cx| {
 514                panel.add_terminal_shell(
 515                    Some(action.working_directory.clone()),
 516                    RevealStrategy::Always,
 517                    window,
 518                    cx,
 519                )
 520            })
 521            .detach_and_log_err(cx);
 522    }
 523
 524    pub fn spawn_task(
 525        &mut self,
 526        task: &SpawnInTerminal,
 527        window: &mut Window,
 528        cx: &mut Context<Self>,
 529    ) -> Task<Result<WeakEntity<Terminal>>> {
 530        let Some(workspace) = self.workspace.upgrade() else {
 531            return Task::ready(Err(anyhow!("failed to read workspace")));
 532        };
 533
 534        let project = workspace.read(cx).project().read(cx);
 535
 536        if project.is_via_collab() {
 537            return Task::ready(Err(anyhow!("cannot spawn tasks as a guest")));
 538        }
 539
 540        let remote_client = project.remote_client();
 541        let is_windows = project.path_style(cx).is_windows();
 542        let remote_shell = remote_client
 543            .as_ref()
 544            .and_then(|remote_client| remote_client.read(cx).shell());
 545
 546        let shell = if let Some(remote_shell) = remote_shell
 547            && task.shell == Shell::System
 548        {
 549            Shell::Program(remote_shell)
 550        } else {
 551            task.shell.clone()
 552        };
 553
 554        let builder = ShellBuilder::new(&shell, is_windows);
 555        let command_label = builder.command_label(task.command.as_deref().unwrap_or(""));
 556        let (command, args) = builder.build_no_quote(task.command.clone(), &task.args);
 557
 558        let task = SpawnInTerminal {
 559            command_label,
 560            command: Some(command),
 561            args,
 562            ..task.clone()
 563        };
 564
 565        if task.allow_concurrent_runs && task.use_new_terminal {
 566            return self.spawn_in_new_terminal(task, window, cx);
 567        }
 568
 569        let mut terminals_for_task = self.terminals_for_task(&task.full_label, cx);
 570        let Some(existing) = terminals_for_task.pop() else {
 571            return self.spawn_in_new_terminal(task, window, cx);
 572        };
 573
 574        let (existing_item_index, task_pane, existing_terminal) = existing;
 575        if task.allow_concurrent_runs {
 576            return self.replace_terminal(
 577                task,
 578                task_pane,
 579                existing_item_index,
 580                existing_terminal,
 581                window,
 582                cx,
 583            );
 584        }
 585
 586        let (tx, rx) = oneshot::channel();
 587
 588        self.deferred_tasks.insert(
 589            task.id.clone(),
 590            cx.spawn_in(window, async move |terminal_panel, cx| {
 591                wait_for_terminals_tasks(terminals_for_task, cx).await;
 592                let task = terminal_panel.update_in(cx, |terminal_panel, window, cx| {
 593                    if task.use_new_terminal {
 594                        terminal_panel.spawn_in_new_terminal(task, window, cx)
 595                    } else {
 596                        terminal_panel.replace_terminal(
 597                            task,
 598                            task_pane,
 599                            existing_item_index,
 600                            existing_terminal,
 601                            window,
 602                            cx,
 603                        )
 604                    }
 605                });
 606                if let Ok(task) = task {
 607                    tx.send(task.await).ok();
 608                }
 609            }),
 610        );
 611
 612        cx.spawn(async move |_, _| rx.await?)
 613    }
 614
 615    fn spawn_in_new_terminal(
 616        &mut self,
 617        spawn_task: SpawnInTerminal,
 618        window: &mut Window,
 619        cx: &mut Context<Self>,
 620    ) -> Task<Result<WeakEntity<Terminal>>> {
 621        let reveal = spawn_task.reveal;
 622        let reveal_target = spawn_task.reveal_target;
 623        match reveal_target {
 624            RevealTarget::Center => self
 625                .workspace
 626                .update(cx, |workspace, cx| {
 627                    Self::add_center_terminal(workspace, window, cx, |project, cx| {
 628                        project.create_terminal_task(spawn_task, cx)
 629                    })
 630                })
 631                .unwrap_or_else(|e| Task::ready(Err(e))),
 632            RevealTarget::Dock => self.add_terminal_task(spawn_task, reveal, window, cx),
 633        }
 634    }
 635
 636    /// Create a new Terminal in the current working directory or the user's home directory
 637    fn new_terminal(
 638        workspace: &mut Workspace,
 639        _: &workspace::NewTerminal,
 640        window: &mut Window,
 641        cx: &mut Context<Workspace>,
 642    ) {
 643        let Some(terminal_panel) = workspace.panel::<Self>(cx) else {
 644            return;
 645        };
 646
 647        terminal_panel
 648            .update(cx, |this, cx| {
 649                this.add_terminal_shell(
 650                    default_working_directory(workspace, cx),
 651                    RevealStrategy::Always,
 652                    window,
 653                    cx,
 654                )
 655            })
 656            .detach_and_log_err(cx);
 657    }
 658
 659    fn terminals_for_task(
 660        &self,
 661        label: &str,
 662        cx: &mut App,
 663    ) -> Vec<(usize, Entity<Pane>, Entity<TerminalView>)> {
 664        let Some(workspace) = self.workspace.upgrade() else {
 665            return Vec::new();
 666        };
 667
 668        let pane_terminal_views = |pane: Entity<Pane>| {
 669            pane.read(cx)
 670                .items()
 671                .enumerate()
 672                .filter_map(|(index, item)| Some((index, item.act_as::<TerminalView>(cx)?)))
 673                .filter_map(|(index, terminal_view)| {
 674                    let task_state = terminal_view.read(cx).terminal().read(cx).task()?;
 675                    if &task_state.spawned_task.full_label == label {
 676                        Some((index, terminal_view))
 677                    } else {
 678                        None
 679                    }
 680                })
 681                .map(move |(index, terminal_view)| (index, pane.clone(), terminal_view))
 682        };
 683
 684        self.center
 685            .panes()
 686            .into_iter()
 687            .cloned()
 688            .flat_map(pane_terminal_views)
 689            .chain(
 690                workspace
 691                    .read(cx)
 692                    .panes()
 693                    .iter()
 694                    .cloned()
 695                    .flat_map(pane_terminal_views),
 696            )
 697            .sorted_by_key(|(_, _, terminal_view)| terminal_view.entity_id())
 698            .collect()
 699    }
 700
 701    fn activate_terminal_view(
 702        &self,
 703        pane: &Entity<Pane>,
 704        item_index: usize,
 705        focus: bool,
 706        window: &mut Window,
 707        cx: &mut App,
 708    ) {
 709        pane.update(cx, |pane, cx| {
 710            pane.activate_item(item_index, true, focus, window, cx)
 711        })
 712    }
 713
 714    pub fn add_center_terminal(
 715        workspace: &mut Workspace,
 716        window: &mut Window,
 717        cx: &mut Context<Workspace>,
 718        create_terminal: impl FnOnce(
 719            &mut Project,
 720            &mut Context<Project>,
 721        ) -> Task<Result<Entity<Terminal>>>
 722        + 'static,
 723    ) -> Task<Result<WeakEntity<Terminal>>> {
 724        if !is_enabled_in_workspace(workspace, cx) {
 725            return Task::ready(Err(anyhow!(
 726                "terminal not yet supported for remote projects"
 727            )));
 728        }
 729        let project = workspace.project().downgrade();
 730        cx.spawn_in(window, async move |workspace, cx| {
 731            let terminal = project.update(cx, create_terminal)?.await?;
 732
 733            workspace.update_in(cx, |workspace, window, cx| {
 734                let terminal_view = cx.new(|cx| {
 735                    TerminalView::new(
 736                        terminal.clone(),
 737                        workspace.weak_handle(),
 738                        workspace.database_id(),
 739                        workspace.project().downgrade(),
 740                        window,
 741                        cx,
 742                    )
 743                });
 744                workspace.add_item_to_active_pane(Box::new(terminal_view), None, true, window, cx);
 745            })?;
 746            Ok(terminal.downgrade())
 747        })
 748    }
 749
 750    pub fn add_terminal_task(
 751        &mut self,
 752        task: SpawnInTerminal,
 753        reveal_strategy: RevealStrategy,
 754        window: &mut Window,
 755        cx: &mut Context<Self>,
 756    ) -> Task<Result<WeakEntity<Terminal>>> {
 757        let workspace = self.workspace.clone();
 758        cx.spawn_in(window, async move |terminal_panel, cx| {
 759            if workspace.update(cx, |workspace, cx| !is_enabled_in_workspace(workspace, cx))? {
 760                anyhow::bail!("terminal not yet supported for remote projects");
 761            }
 762            let pane = terminal_panel.update(cx, |terminal_panel, _| {
 763                terminal_panel.pending_terminals_to_add += 1;
 764                terminal_panel.active_pane.clone()
 765            })?;
 766            let project = workspace.read_with(cx, |workspace, _| workspace.project().clone())?;
 767            let terminal = project
 768                .update(cx, |project, cx| project.create_terminal_task(task, cx))?
 769                .await?;
 770            let result = workspace.update_in(cx, |workspace, window, cx| {
 771                let terminal_view = Box::new(cx.new(|cx| {
 772                    TerminalView::new(
 773                        terminal.clone(),
 774                        workspace.weak_handle(),
 775                        workspace.database_id(),
 776                        workspace.project().downgrade(),
 777                        window,
 778                        cx,
 779                    )
 780                }));
 781
 782                match reveal_strategy {
 783                    RevealStrategy::Always => {
 784                        workspace.focus_panel::<Self>(window, cx);
 785                    }
 786                    RevealStrategy::NoFocus => {
 787                        workspace.open_panel::<Self>(window, cx);
 788                    }
 789                    RevealStrategy::Never => {}
 790                }
 791
 792                pane.update(cx, |pane, cx| {
 793                    let focus = pane.has_focus(window, cx)
 794                        || matches!(reveal_strategy, RevealStrategy::Always);
 795                    pane.add_item(terminal_view, true, focus, None, window, cx);
 796                });
 797
 798                Ok(terminal.downgrade())
 799            })?;
 800            terminal_panel.update(cx, |terminal_panel, cx| {
 801                terminal_panel.pending_terminals_to_add =
 802                    terminal_panel.pending_terminals_to_add.saturating_sub(1);
 803                terminal_panel.serialize(cx)
 804            })?;
 805            result
 806        })
 807    }
 808
 809    fn add_terminal_shell(
 810        &mut self,
 811        cwd: Option<PathBuf>,
 812        reveal_strategy: RevealStrategy,
 813        window: &mut Window,
 814        cx: &mut Context<Self>,
 815    ) -> Task<Result<WeakEntity<Terminal>>> {
 816        let workspace = self.workspace.clone();
 817
 818        cx.spawn_in(window, async move |terminal_panel, cx| {
 819            if workspace.update(cx, |workspace, cx| !is_enabled_in_workspace(workspace, cx))? {
 820                anyhow::bail!("terminal not yet supported for collaborative projects");
 821            }
 822            let pane = terminal_panel.update(cx, |terminal_panel, _| {
 823                terminal_panel.pending_terminals_to_add += 1;
 824                terminal_panel.active_pane.clone()
 825            })?;
 826            let project = workspace.read_with(cx, |workspace, _| workspace.project().clone())?;
 827            let terminal = project
 828                .update(cx, |project, cx| project.create_terminal_shell(cwd, cx))?
 829                .await;
 830
 831            match terminal {
 832                Ok(terminal) => {
 833                    let result = workspace.update_in(cx, |workspace, window, cx| {
 834                        let terminal_view = Box::new(cx.new(|cx| {
 835                            TerminalView::new(
 836                                terminal.clone(),
 837                                workspace.weak_handle(),
 838                                workspace.database_id(),
 839                                workspace.project().downgrade(),
 840                                window,
 841                                cx,
 842                            )
 843                        }));
 844
 845                        match reveal_strategy {
 846                            RevealStrategy::Always => {
 847                                workspace.focus_panel::<Self>(window, cx);
 848                            }
 849                            RevealStrategy::NoFocus => {
 850                                workspace.open_panel::<Self>(window, cx);
 851                            }
 852                            RevealStrategy::Never => {}
 853                        }
 854
 855                        pane.update(cx, |pane, cx| {
 856                            let focus = pane.has_focus(window, cx)
 857                                || matches!(reveal_strategy, RevealStrategy::Always);
 858                            pane.add_item(terminal_view, true, focus, None, window, cx);
 859                        });
 860
 861                        Ok(terminal.downgrade())
 862                    })?;
 863                    terminal_panel.update(cx, |terminal_panel, cx| {
 864                        terminal_panel.pending_terminals_to_add =
 865                            terminal_panel.pending_terminals_to_add.saturating_sub(1);
 866                        terminal_panel.serialize(cx)
 867                    })?;
 868                    result
 869                }
 870                Err(error) => {
 871                    pane.update_in(cx, |pane, window, cx| {
 872                        let focus = pane.has_focus(window, cx);
 873                        let failed_to_spawn = cx.new(|cx| FailedToSpawnTerminal {
 874                            error: error.to_string(),
 875                            focus_handle: cx.focus_handle(),
 876                        });
 877                        pane.add_item(Box::new(failed_to_spawn), true, focus, None, window, cx);
 878                    })?;
 879                    Err(error)
 880                }
 881            }
 882        })
 883    }
 884
 885    fn serialize(&mut self, cx: &mut Context<Self>) {
 886        let height = self.height;
 887        let width = self.width;
 888        let Some(serialization_key) = self
 889            .workspace
 890            .read_with(cx, |workspace, _| {
 891                TerminalPanel::serialization_key(workspace)
 892            })
 893            .ok()
 894            .flatten()
 895        else {
 896            return;
 897        };
 898        self.pending_serialization = cx.spawn(async move |terminal_panel, cx| {
 899            cx.background_executor()
 900                .timer(Duration::from_millis(50))
 901                .await;
 902            let terminal_panel = terminal_panel.upgrade()?;
 903            let items = terminal_panel
 904                .update(cx, |terminal_panel, cx| {
 905                    SerializedItems::WithSplits(serialize_pane_group(
 906                        &terminal_panel.center,
 907                        &terminal_panel.active_pane,
 908                        cx,
 909                    ))
 910                })
 911                .ok()?;
 912            cx.background_spawn(
 913                async move {
 914                    KEY_VALUE_STORE
 915                        .write_kvp(
 916                            serialization_key,
 917                            serde_json::to_string(&SerializedTerminalPanel {
 918                                items,
 919                                active_item_id: None,
 920                                height,
 921                                width,
 922                            })?,
 923                        )
 924                        .await?;
 925                    anyhow::Ok(())
 926                }
 927                .log_err(),
 928            )
 929            .await;
 930            Some(())
 931        });
 932    }
 933
 934    fn replace_terminal(
 935        &self,
 936        spawn_task: SpawnInTerminal,
 937        task_pane: Entity<Pane>,
 938        terminal_item_index: usize,
 939        terminal_to_replace: Entity<TerminalView>,
 940        window: &mut Window,
 941        cx: &mut Context<Self>,
 942    ) -> Task<Result<WeakEntity<Terminal>>> {
 943        let reveal = spawn_task.reveal;
 944        let reveal_target = spawn_task.reveal_target;
 945        let task_workspace = self.workspace.clone();
 946        cx.spawn_in(window, async move |terminal_panel, cx| {
 947            let project = terminal_panel.update(cx, |this, cx| {
 948                this.workspace
 949                    .update(cx, |workspace, _| workspace.project().clone())
 950            })??;
 951            let new_terminal = project
 952                .update(cx, |project, cx| {
 953                    project.create_terminal_task(spawn_task, cx)
 954                })?
 955                .await?;
 956            terminal_to_replace.update_in(cx, |terminal_to_replace, window, cx| {
 957                terminal_to_replace.set_terminal(new_terminal.clone(), window, cx);
 958            })?;
 959
 960            match reveal {
 961                RevealStrategy::Always => match reveal_target {
 962                    RevealTarget::Center => {
 963                        task_workspace.update_in(cx, |workspace, window, cx| {
 964                            let did_activate = workspace.activate_item(
 965                                &terminal_to_replace,
 966                                true,
 967                                true,
 968                                window,
 969                                cx,
 970                            );
 971
 972                            anyhow::ensure!(did_activate, "Failed to retrieve terminal pane");
 973
 974                            anyhow::Ok(())
 975                        })??;
 976                    }
 977                    RevealTarget::Dock => {
 978                        terminal_panel.update_in(cx, |terminal_panel, window, cx| {
 979                            terminal_panel.activate_terminal_view(
 980                                &task_pane,
 981                                terminal_item_index,
 982                                true,
 983                                window,
 984                                cx,
 985                            )
 986                        })?;
 987
 988                        cx.spawn(async move |cx| {
 989                            task_workspace
 990                                .update_in(cx, |workspace, window, cx| {
 991                                    workspace.focus_panel::<Self>(window, cx)
 992                                })
 993                                .ok()
 994                        })
 995                        .detach();
 996                    }
 997                },
 998                RevealStrategy::NoFocus => match reveal_target {
 999                    RevealTarget::Center => {
1000                        task_workspace.update_in(cx, |workspace, window, cx| {
1001                            workspace.active_pane().focus_handle(cx).focus(window);
1002                        })?;
1003                    }
1004                    RevealTarget::Dock => {
1005                        terminal_panel.update_in(cx, |terminal_panel, window, cx| {
1006                            terminal_panel.activate_terminal_view(
1007                                &task_pane,
1008                                terminal_item_index,
1009                                false,
1010                                window,
1011                                cx,
1012                            )
1013                        })?;
1014
1015                        cx.spawn(async move |cx| {
1016                            task_workspace
1017                                .update_in(cx, |workspace, window, cx| {
1018                                    workspace.open_panel::<Self>(window, cx)
1019                                })
1020                                .ok()
1021                        })
1022                        .detach();
1023                    }
1024                },
1025                RevealStrategy::Never => {}
1026            }
1027
1028            Ok(new_terminal.downgrade())
1029        })
1030    }
1031
1032    fn has_no_terminals(&self, cx: &App) -> bool {
1033        self.active_pane.read(cx).items_len() == 0 && self.pending_terminals_to_add == 0
1034    }
1035
1036    pub fn assistant_enabled(&self) -> bool {
1037        self.assistant_enabled
1038    }
1039
1040    fn is_enabled(&self, cx: &App) -> bool {
1041        self.workspace
1042            .upgrade()
1043            .is_some_and(|workspace| is_enabled_in_workspace(workspace.read(cx), cx))
1044    }
1045
1046    fn activate_pane_in_direction(
1047        &mut self,
1048        direction: SplitDirection,
1049        window: &mut Window,
1050        cx: &mut Context<Self>,
1051    ) {
1052        if let Some(pane) = self
1053            .center
1054            .find_pane_in_direction(&self.active_pane, direction, cx)
1055        {
1056            window.focus(&pane.focus_handle(cx));
1057        } else {
1058            self.workspace
1059                .update(cx, |workspace, cx| {
1060                    workspace.activate_pane_in_direction(direction, window, cx)
1061                })
1062                .ok();
1063        }
1064    }
1065
1066    fn swap_pane_in_direction(&mut self, direction: SplitDirection, cx: &mut Context<Self>) {
1067        if let Some(to) = self
1068            .center
1069            .find_pane_in_direction(&self.active_pane, direction, cx)
1070            .cloned()
1071        {
1072            self.center.swap(&self.active_pane, &to, cx);
1073            cx.notify();
1074        }
1075    }
1076
1077    fn move_pane_to_border(&mut self, direction: SplitDirection, cx: &mut Context<Self>) {
1078        if self
1079            .center
1080            .move_to_border(&self.active_pane, direction, cx)
1081            .unwrap()
1082        {
1083            cx.notify();
1084        }
1085    }
1086}
1087
1088fn is_enabled_in_workspace(workspace: &Workspace, cx: &App) -> bool {
1089    workspace.project().read(cx).supports_terminal(cx)
1090}
1091
1092pub fn new_terminal_pane(
1093    workspace: WeakEntity<Workspace>,
1094    project: Entity<Project>,
1095    zoomed: bool,
1096    window: &mut Window,
1097    cx: &mut Context<TerminalPanel>,
1098) -> Entity<Pane> {
1099    let is_local = project.read(cx).is_local();
1100    let terminal_panel = cx.entity();
1101    let pane = cx.new(|cx| {
1102        let mut pane = Pane::new(
1103            workspace.clone(),
1104            project.clone(),
1105            Default::default(),
1106            None,
1107            NewTerminal.boxed_clone(),
1108            false,
1109            window,
1110            cx,
1111        );
1112        pane.set_zoomed(zoomed, cx);
1113        pane.set_can_navigate(false, cx);
1114        pane.display_nav_history_buttons(None);
1115        pane.set_should_display_tab_bar(|_, _| true);
1116        pane.set_zoom_out_on_close(false);
1117
1118        let split_closure_terminal_panel = terminal_panel.downgrade();
1119        pane.set_can_split(Some(Arc::new(move |pane, dragged_item, _window, cx| {
1120            if let Some(tab) = dragged_item.downcast_ref::<DraggedTab>() {
1121                let is_current_pane = tab.pane == cx.entity();
1122                let Some(can_drag_away) = split_closure_terminal_panel
1123                    .read_with(cx, |terminal_panel, _| {
1124                        let current_panes = terminal_panel.center.panes();
1125                        !current_panes.contains(&&tab.pane)
1126                            || current_panes.len() > 1
1127                            || (!is_current_pane || pane.items_len() > 1)
1128                    })
1129                    .ok()
1130                else {
1131                    return false;
1132                };
1133                if can_drag_away {
1134                    let item = if is_current_pane {
1135                        pane.item_for_index(tab.ix)
1136                    } else {
1137                        tab.pane.read(cx).item_for_index(tab.ix)
1138                    };
1139                    if let Some(item) = item {
1140                        return item.downcast::<TerminalView>().is_some();
1141                    }
1142                }
1143            }
1144            false
1145        })));
1146
1147        let buffer_search_bar = cx.new(|cx| {
1148            search::BufferSearchBar::new(Some(project.read(cx).languages().clone()), window, cx)
1149        });
1150        let breadcrumbs = cx.new(|_| Breadcrumbs::new());
1151        pane.toolbar().update(cx, |toolbar, cx| {
1152            toolbar.add_item(buffer_search_bar, window, cx);
1153            toolbar.add_item(breadcrumbs, window, cx);
1154        });
1155
1156        let drop_closure_project = project.downgrade();
1157        let drop_closure_terminal_panel = terminal_panel.downgrade();
1158        pane.set_custom_drop_handle(cx, move |pane, dropped_item, window, cx| {
1159            let Some(project) = drop_closure_project.upgrade() else {
1160                return ControlFlow::Break(());
1161            };
1162            if let Some(tab) = dropped_item.downcast_ref::<DraggedTab>() {
1163                let this_pane = cx.entity();
1164                let item = if tab.pane == this_pane {
1165                    pane.item_for_index(tab.ix)
1166                } else {
1167                    tab.pane.read(cx).item_for_index(tab.ix)
1168                };
1169                if let Some(item) = item {
1170                    if item.downcast::<TerminalView>().is_some() {
1171                        let source = tab.pane.clone();
1172                        let item_id_to_move = item.item_id();
1173
1174                        // If no split direction, let the regular pane drop handler take care of it
1175                        let Some(split_direction) = pane.drag_split_direction() else {
1176                            return ControlFlow::Continue(());
1177                        };
1178
1179                        // Gather data synchronously before deferring
1180                        let is_zoomed = drop_closure_terminal_panel
1181                            .upgrade()
1182                            .map(|terminal_panel| {
1183                                let terminal_panel = terminal_panel.read(cx);
1184                                if terminal_panel.active_pane == this_pane {
1185                                    pane.is_zoomed()
1186                                } else {
1187                                    terminal_panel.active_pane.read(cx).is_zoomed()
1188                                }
1189                            })
1190                            .unwrap_or(false);
1191
1192                        let workspace = workspace.clone();
1193                        let terminal_panel = drop_closure_terminal_panel.clone();
1194
1195                        // Defer the split operation to avoid re-entrancy panic.
1196                        // The pane may be the one currently being updated, so we cannot
1197                        // call mark_positions (via split) synchronously.
1198                        cx.spawn_in(window, async move |_, cx| {
1199                            cx.update(|window, cx| {
1200                                let Ok(new_pane) =
1201                                    terminal_panel.update(cx, |terminal_panel, cx| {
1202                                        let new_pane = new_terminal_pane(
1203                                            workspace, project, is_zoomed, window, cx,
1204                                        );
1205                                        terminal_panel.apply_tab_bar_buttons(&new_pane, cx);
1206                                        terminal_panel.center.split(
1207                                            &this_pane,
1208                                            &new_pane,
1209                                            split_direction,
1210                                            cx,
1211                                        )?;
1212                                        anyhow::Ok(new_pane)
1213                                    })
1214                                else {
1215                                    return;
1216                                };
1217
1218                                let Some(new_pane) = new_pane.log_err() else {
1219                                    return;
1220                                };
1221
1222                                move_item(
1223                                    &source,
1224                                    &new_pane,
1225                                    item_id_to_move,
1226                                    new_pane.read(cx).active_item_index(),
1227                                    true,
1228                                    window,
1229                                    cx,
1230                                );
1231                            })
1232                            .ok();
1233                        })
1234                        .detach();
1235                    } else if let Some(project_path) = item.project_path(cx)
1236                        && let Some(entry_path) = project.read(cx).absolute_path(&project_path, cx)
1237                    {
1238                        add_paths_to_terminal(pane, &[entry_path], window, cx);
1239                    }
1240                }
1241            } else if let Some(selection) = dropped_item.downcast_ref::<DraggedSelection>() {
1242                let project = project.read(cx);
1243                let paths_to_add = selection
1244                    .items()
1245                    .map(|selected_entry| selected_entry.entry_id)
1246                    .filter_map(|entry_id| project.path_for_entry(entry_id, cx))
1247                    .filter_map(|project_path| project.absolute_path(&project_path, cx))
1248                    .collect::<Vec<_>>();
1249                if !paths_to_add.is_empty() {
1250                    add_paths_to_terminal(pane, &paths_to_add, window, cx);
1251                }
1252            } else if let Some(&entry_id) = dropped_item.downcast_ref::<ProjectEntryId>() {
1253                if let Some(entry_path) = project
1254                    .read(cx)
1255                    .path_for_entry(entry_id, cx)
1256                    .and_then(|project_path| project.read(cx).absolute_path(&project_path, cx))
1257                {
1258                    add_paths_to_terminal(pane, &[entry_path], window, cx);
1259                }
1260            } else if is_local && let Some(paths) = dropped_item.downcast_ref::<ExternalPaths>() {
1261                add_paths_to_terminal(pane, paths.paths(), window, cx);
1262            }
1263
1264            ControlFlow::Break(())
1265        });
1266
1267        pane
1268    });
1269
1270    cx.subscribe_in(&pane, window, TerminalPanel::handle_pane_event)
1271        .detach();
1272    cx.observe(&pane, |_, _, cx| cx.notify()).detach();
1273
1274    pane
1275}
1276
1277async fn wait_for_terminals_tasks(
1278    terminals_for_task: Vec<(usize, Entity<Pane>, Entity<TerminalView>)>,
1279    cx: &mut AsyncApp,
1280) {
1281    let pending_tasks = terminals_for_task.iter().filter_map(|(_, _, terminal)| {
1282        terminal
1283            .update(cx, |terminal_view, cx| {
1284                terminal_view
1285                    .terminal()
1286                    .update(cx, |terminal, cx| terminal.wait_for_completed_task(cx))
1287            })
1288            .ok()
1289    });
1290    join_all(pending_tasks).await;
1291}
1292
1293fn add_paths_to_terminal(
1294    pane: &mut Pane,
1295    paths: &[PathBuf],
1296    window: &mut Window,
1297    cx: &mut Context<Pane>,
1298) {
1299    if let Some(terminal_view) = pane
1300        .active_item()
1301        .and_then(|item| item.downcast::<TerminalView>())
1302    {
1303        window.focus(&terminal_view.focus_handle(cx));
1304        let mut new_text = paths.iter().map(|path| format!(" {path:?}")).join("");
1305        new_text.push(' ');
1306        terminal_view.update(cx, |terminal_view, cx| {
1307            terminal_view.terminal().update(cx, |terminal, _| {
1308                terminal.paste(&new_text);
1309            });
1310        });
1311    }
1312}
1313
1314struct FailedToSpawnTerminal {
1315    error: String,
1316    focus_handle: FocusHandle,
1317}
1318
1319impl Focusable for FailedToSpawnTerminal {
1320    fn focus_handle(&self, _: &App) -> FocusHandle {
1321        self.focus_handle.clone()
1322    }
1323}
1324
1325impl Render for FailedToSpawnTerminal {
1326    fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1327        let popover_menu = PopoverMenu::new("settings-popover")
1328            .trigger(
1329                IconButton::new("icon-button-popover", IconName::ChevronDown)
1330                    .icon_size(IconSize::XSmall),
1331            )
1332            .menu(move |window, cx| {
1333                Some(ContextMenu::build(window, cx, |context_menu, _, _| {
1334                    context_menu
1335                        .action("Open Settings", zed_actions::OpenSettings.boxed_clone())
1336                        .action(
1337                            "Edit settings.json",
1338                            zed_actions::OpenSettingsFile.boxed_clone(),
1339                        )
1340                }))
1341            })
1342            .anchor(Corner::TopRight)
1343            .offset(gpui::Point {
1344                x: px(0.0),
1345                y: px(2.0),
1346            });
1347
1348        v_flex()
1349            .track_focus(&self.focus_handle)
1350            .size_full()
1351            .p_4()
1352            .items_center()
1353            .justify_center()
1354            .bg(cx.theme().colors().editor_background)
1355            .child(
1356                v_flex()
1357                    .max_w_112()
1358                    .items_center()
1359                    .justify_center()
1360                    .text_center()
1361                    .child(Label::new("Failed to spawn terminal"))
1362                    .child(
1363                        Label::new(self.error.to_string())
1364                            .size(LabelSize::Small)
1365                            .color(Color::Muted)
1366                            .mb_4(),
1367                    )
1368                    .child(SplitButton::new(
1369                        ButtonLike::new("open-settings-ui")
1370                            .child(Label::new("Edit Settings").size(LabelSize::Small))
1371                            .on_click(|_, window, cx| {
1372                                window.dispatch_action(zed_actions::OpenSettings.boxed_clone(), cx);
1373                            }),
1374                        popover_menu.into_any_element(),
1375                    )),
1376            )
1377    }
1378}
1379
1380impl EventEmitter<()> for FailedToSpawnTerminal {}
1381
1382impl workspace::Item for FailedToSpawnTerminal {
1383    type Event = ();
1384
1385    fn tab_content_text(&self, _detail: usize, _cx: &App) -> SharedString {
1386        SharedString::new_static("Failed to spawn terminal")
1387    }
1388}
1389
1390impl EventEmitter<PanelEvent> for TerminalPanel {}
1391
1392impl Render for TerminalPanel {
1393    fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1394        let mut registrar = DivRegistrar::new(
1395            |panel, _, cx| {
1396                panel
1397                    .active_pane
1398                    .read(cx)
1399                    .toolbar()
1400                    .read(cx)
1401                    .item_of_type::<BufferSearchBar>()
1402            },
1403            cx,
1404        );
1405        BufferSearchBar::register(&mut registrar);
1406        let registrar = registrar.into_div();
1407        self.workspace
1408            .update(cx, |workspace, cx| {
1409                registrar.size_full().child(self.center.render(
1410                    workspace.zoomed_item(),
1411                    &workspace::PaneRenderContext {
1412                        follower_states: &HashMap::default(),
1413                        active_call: workspace.active_call(),
1414                        active_pane: &self.active_pane,
1415                        app_state: workspace.app_state(),
1416                        project: workspace.project(),
1417                        workspace: &workspace.weak_handle(),
1418                    },
1419                    window,
1420                    cx,
1421                ))
1422            })
1423            .ok()
1424            .map(|div| {
1425                div.on_action({
1426                    cx.listener(|terminal_panel, _: &ActivatePaneLeft, window, cx| {
1427                        terminal_panel.activate_pane_in_direction(SplitDirection::Left, window, cx);
1428                    })
1429                })
1430                .on_action({
1431                    cx.listener(|terminal_panel, _: &ActivatePaneRight, window, cx| {
1432                        terminal_panel.activate_pane_in_direction(
1433                            SplitDirection::Right,
1434                            window,
1435                            cx,
1436                        );
1437                    })
1438                })
1439                .on_action({
1440                    cx.listener(|terminal_panel, _: &ActivatePaneUp, window, cx| {
1441                        terminal_panel.activate_pane_in_direction(SplitDirection::Up, window, cx);
1442                    })
1443                })
1444                .on_action({
1445                    cx.listener(|terminal_panel, _: &ActivatePaneDown, window, cx| {
1446                        terminal_panel.activate_pane_in_direction(SplitDirection::Down, window, cx);
1447                    })
1448                })
1449                .on_action(
1450                    cx.listener(|terminal_panel, _action: &ActivateNextPane, window, cx| {
1451                        let panes = terminal_panel.center.panes();
1452                        if let Some(ix) = panes
1453                            .iter()
1454                            .position(|pane| **pane == terminal_panel.active_pane)
1455                        {
1456                            let next_ix = (ix + 1) % panes.len();
1457                            window.focus(&panes[next_ix].focus_handle(cx));
1458                        }
1459                    }),
1460                )
1461                .on_action(cx.listener(
1462                    |terminal_panel, _action: &ActivatePreviousPane, window, cx| {
1463                        let panes = terminal_panel.center.panes();
1464                        if let Some(ix) = panes
1465                            .iter()
1466                            .position(|pane| **pane == terminal_panel.active_pane)
1467                        {
1468                            let prev_ix = cmp::min(ix.wrapping_sub(1), panes.len() - 1);
1469                            window.focus(&panes[prev_ix].focus_handle(cx));
1470                        }
1471                    },
1472                ))
1473                .on_action(
1474                    cx.listener(|terminal_panel, action: &ActivatePane, window, cx| {
1475                        let panes = terminal_panel.center.panes();
1476                        if let Some(&pane) = panes.get(action.0) {
1477                            window.focus(&pane.read(cx).focus_handle(cx));
1478                        } else {
1479                            let future =
1480                                terminal_panel.new_pane_with_cloned_active_terminal(window, cx);
1481                            cx.spawn_in(window, async move |terminal_panel, cx| {
1482                                if let Some(new_pane) = future.await {
1483                                    _ = terminal_panel.update_in(
1484                                        cx,
1485                                        |terminal_panel, window, cx| {
1486                                            terminal_panel
1487                                                .center
1488                                                .split(
1489                                                    &terminal_panel.active_pane,
1490                                                    &new_pane,
1491                                                    SplitDirection::Right,
1492                                                    cx,
1493                                                )
1494                                                .log_err();
1495                                            let new_pane = new_pane.read(cx);
1496                                            window.focus(&new_pane.focus_handle(cx));
1497                                        },
1498                                    );
1499                                }
1500                            })
1501                            .detach();
1502                        }
1503                    }),
1504                )
1505                .on_action(cx.listener(|terminal_panel, _: &SwapPaneLeft, _, cx| {
1506                    terminal_panel.swap_pane_in_direction(SplitDirection::Left, cx);
1507                }))
1508                .on_action(cx.listener(|terminal_panel, _: &SwapPaneRight, _, cx| {
1509                    terminal_panel.swap_pane_in_direction(SplitDirection::Right, cx);
1510                }))
1511                .on_action(cx.listener(|terminal_panel, _: &SwapPaneUp, _, cx| {
1512                    terminal_panel.swap_pane_in_direction(SplitDirection::Up, cx);
1513                }))
1514                .on_action(cx.listener(|terminal_panel, _: &SwapPaneDown, _, cx| {
1515                    terminal_panel.swap_pane_in_direction(SplitDirection::Down, cx);
1516                }))
1517                .on_action(cx.listener(|terminal_panel, _: &MovePaneLeft, _, cx| {
1518                    terminal_panel.move_pane_to_border(SplitDirection::Left, cx);
1519                }))
1520                .on_action(cx.listener(|terminal_panel, _: &MovePaneRight, _, cx| {
1521                    terminal_panel.move_pane_to_border(SplitDirection::Right, cx);
1522                }))
1523                .on_action(cx.listener(|terminal_panel, _: &MovePaneUp, _, cx| {
1524                    terminal_panel.move_pane_to_border(SplitDirection::Up, cx);
1525                }))
1526                .on_action(cx.listener(|terminal_panel, _: &MovePaneDown, _, cx| {
1527                    terminal_panel.move_pane_to_border(SplitDirection::Down, cx);
1528                }))
1529                .on_action(
1530                    cx.listener(|terminal_panel, action: &MoveItemToPane, window, cx| {
1531                        let Some(&target_pane) =
1532                            terminal_panel.center.panes().get(action.destination)
1533                        else {
1534                            return;
1535                        };
1536                        move_active_item(
1537                            &terminal_panel.active_pane,
1538                            target_pane,
1539                            action.focus,
1540                            true,
1541                            window,
1542                            cx,
1543                        );
1544                    }),
1545                )
1546                .on_action(cx.listener(
1547                    |terminal_panel, action: &MoveItemToPaneInDirection, window, cx| {
1548                        let source_pane = &terminal_panel.active_pane;
1549                        if let Some(destination_pane) = terminal_panel
1550                            .center
1551                            .find_pane_in_direction(source_pane, action.direction, cx)
1552                        {
1553                            move_active_item(
1554                                source_pane,
1555                                destination_pane,
1556                                action.focus,
1557                                true,
1558                                window,
1559                                cx,
1560                            );
1561                        };
1562                    },
1563                ))
1564            })
1565            .unwrap_or_else(|| div())
1566    }
1567}
1568
1569impl Focusable for TerminalPanel {
1570    fn focus_handle(&self, cx: &App) -> FocusHandle {
1571        self.active_pane.focus_handle(cx)
1572    }
1573}
1574
1575impl Panel for TerminalPanel {
1576    fn position(&self, _window: &Window, cx: &App) -> DockPosition {
1577        match TerminalSettings::get_global(cx).dock {
1578            TerminalDockPosition::Left => DockPosition::Left,
1579            TerminalDockPosition::Bottom => DockPosition::Bottom,
1580            TerminalDockPosition::Right => DockPosition::Right,
1581        }
1582    }
1583
1584    fn position_is_valid(&self, _: DockPosition) -> bool {
1585        true
1586    }
1587
1588    fn set_position(
1589        &mut self,
1590        position: DockPosition,
1591        _window: &mut Window,
1592        cx: &mut Context<Self>,
1593    ) {
1594        settings::update_settings_file(self.fs.clone(), cx, move |settings, _| {
1595            let dock = match position {
1596                DockPosition::Left => TerminalDockPosition::Left,
1597                DockPosition::Bottom => TerminalDockPosition::Bottom,
1598                DockPosition::Right => TerminalDockPosition::Right,
1599            };
1600            settings.terminal.get_or_insert_default().dock = Some(dock);
1601        });
1602    }
1603
1604    fn size(&self, window: &Window, cx: &App) -> Pixels {
1605        let settings = TerminalSettings::get_global(cx);
1606        match self.position(window, cx) {
1607            DockPosition::Left | DockPosition::Right => {
1608                self.width.unwrap_or(settings.default_width)
1609            }
1610            DockPosition::Bottom => self.height.unwrap_or(settings.default_height),
1611        }
1612    }
1613
1614    fn set_size(&mut self, size: Option<Pixels>, window: &mut Window, cx: &mut Context<Self>) {
1615        match self.position(window, cx) {
1616            DockPosition::Left | DockPosition::Right => self.width = size,
1617            DockPosition::Bottom => self.height = size,
1618        }
1619        cx.notify();
1620        cx.defer_in(window, |this, _, cx| {
1621            this.serialize(cx);
1622        })
1623    }
1624
1625    fn is_zoomed(&self, _window: &Window, cx: &App) -> bool {
1626        self.active_pane.read(cx).is_zoomed()
1627    }
1628
1629    fn set_zoomed(&mut self, zoomed: bool, _: &mut Window, cx: &mut Context<Self>) {
1630        for pane in self.center.panes() {
1631            pane.update(cx, |pane, cx| {
1632                pane.set_zoomed(zoomed, cx);
1633            })
1634        }
1635        cx.notify();
1636    }
1637
1638    fn set_active(&mut self, active: bool, window: &mut Window, cx: &mut Context<Self>) {
1639        let old_active = self.active;
1640        self.active = active;
1641        if !active || old_active == active || !self.has_no_terminals(cx) {
1642            return;
1643        }
1644        cx.defer_in(window, |this, window, cx| {
1645            let Ok(kind) = this
1646                .workspace
1647                .update(cx, |workspace, cx| default_working_directory(workspace, cx))
1648            else {
1649                return;
1650            };
1651
1652            this.add_terminal_shell(kind, RevealStrategy::Always, window, cx)
1653                .detach_and_log_err(cx)
1654        })
1655    }
1656
1657    fn icon_label(&self, _window: &Window, cx: &App) -> Option<String> {
1658        let count = self
1659            .center
1660            .panes()
1661            .into_iter()
1662            .map(|pane| pane.read(cx).items_len())
1663            .sum::<usize>();
1664        if count == 0 {
1665            None
1666        } else {
1667            Some(count.to_string())
1668        }
1669    }
1670
1671    fn persistent_name() -> &'static str {
1672        "TerminalPanel"
1673    }
1674
1675    fn panel_key() -> &'static str {
1676        TERMINAL_PANEL_KEY
1677    }
1678
1679    fn icon(&self, _window: &Window, cx: &App) -> Option<IconName> {
1680        if (self.is_enabled(cx) || !self.has_no_terminals(cx))
1681            && TerminalSettings::get_global(cx).button
1682        {
1683            Some(IconName::TerminalAlt)
1684        } else {
1685            None
1686        }
1687    }
1688
1689    fn icon_tooltip(&self, _window: &Window, _cx: &App) -> Option<&'static str> {
1690        Some("Terminal Panel")
1691    }
1692
1693    fn toggle_action(&self) -> Box<dyn gpui::Action> {
1694        Box::new(ToggleFocus)
1695    }
1696
1697    fn pane(&self) -> Option<Entity<Pane>> {
1698        Some(self.active_pane.clone())
1699    }
1700
1701    fn activation_priority(&self) -> u32 {
1702        1
1703    }
1704}
1705
1706struct TerminalProvider(Entity<TerminalPanel>);
1707
1708impl workspace::TerminalProvider for TerminalProvider {
1709    fn spawn(
1710        &self,
1711        task: SpawnInTerminal,
1712        window: &mut Window,
1713        cx: &mut App,
1714    ) -> Task<Option<Result<ExitStatus>>> {
1715        let terminal_panel = self.0.clone();
1716        window.spawn(cx, async move |cx| {
1717            let terminal = terminal_panel
1718                .update_in(cx, |terminal_panel, window, cx| {
1719                    terminal_panel.spawn_task(&task, window, cx)
1720                })
1721                .ok()?
1722                .await;
1723            match terminal {
1724                Ok(terminal) => {
1725                    let exit_status = terminal
1726                        .read_with(cx, |terminal, cx| terminal.wait_for_completed_task(cx))
1727                        .ok()?
1728                        .await?;
1729                    Some(Ok(exit_status))
1730                }
1731                Err(e) => Some(Err(e)),
1732            }
1733        })
1734    }
1735}
1736
1737struct InlineAssistTabBarButton {
1738    focus_handle: FocusHandle,
1739}
1740
1741impl Render for InlineAssistTabBarButton {
1742    fn render(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1743        let focus_handle = self.focus_handle.clone();
1744        IconButton::new("terminal_inline_assistant", IconName::ZedAssistant)
1745            .icon_size(IconSize::Small)
1746            .on_click(cx.listener(|_, _, window, cx| {
1747                window.dispatch_action(InlineAssist::default().boxed_clone(), cx);
1748            }))
1749            .tooltip(move |_window, cx| {
1750                Tooltip::for_action_in("Inline Assist", &InlineAssist::default(), &focus_handle, cx)
1751            })
1752    }
1753}
1754
1755#[cfg(test)]
1756mod tests {
1757    use std::num::NonZero;
1758
1759    use super::*;
1760    use gpui::{TestAppContext, UpdateGlobal as _};
1761    use pretty_assertions::assert_eq;
1762    use project::FakeFs;
1763    use settings::SettingsStore;
1764
1765    #[gpui::test]
1766    async fn test_spawn_an_empty_task(cx: &mut TestAppContext) {
1767        init_test(cx);
1768
1769        let fs = FakeFs::new(cx.executor());
1770        let project = Project::test(fs, [], cx).await;
1771        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1772
1773        let (window_handle, terminal_panel) = workspace
1774            .update(cx, |workspace, window, cx| {
1775                let window_handle = window.window_handle();
1776                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1777                (window_handle, terminal_panel)
1778            })
1779            .unwrap();
1780
1781        let task = window_handle
1782            .update(cx, |_, window, cx| {
1783                terminal_panel.update(cx, |terminal_panel, cx| {
1784                    terminal_panel.spawn_task(&SpawnInTerminal::default(), window, cx)
1785                })
1786            })
1787            .unwrap();
1788
1789        let terminal = task.await.unwrap();
1790        let expected_shell = util::get_system_shell();
1791        terminal
1792            .update(cx, |terminal, _| {
1793                let task_metadata = terminal
1794                    .task()
1795                    .expect("When spawning a task, should have the task metadata")
1796                    .spawned_task
1797                    .clone();
1798                assert_eq!(task_metadata.env, HashMap::default());
1799                assert_eq!(task_metadata.cwd, None);
1800                assert_eq!(task_metadata.shell, task::Shell::System);
1801                assert_eq!(
1802                    task_metadata.command,
1803                    Some(expected_shell.clone()),
1804                    "Empty tasks should spawn a -i shell"
1805                );
1806                assert_eq!(task_metadata.args, Vec::<String>::new());
1807                assert_eq!(
1808                    task_metadata.command_label, expected_shell,
1809                    "We show the shell launch for empty commands"
1810                );
1811            })
1812            .unwrap();
1813    }
1814
1815    #[gpui::test]
1816    async fn test_bypass_max_tabs_limit(cx: &mut TestAppContext) {
1817        init_test(cx);
1818
1819        let fs = FakeFs::new(cx.executor());
1820        let project = Project::test(fs, [], cx).await;
1821        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1822
1823        let (window_handle, terminal_panel) = workspace
1824            .update(cx, |workspace, window, cx| {
1825                let window_handle = window.window_handle();
1826                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1827                (window_handle, terminal_panel)
1828            })
1829            .unwrap();
1830
1831        set_max_tabs(cx, Some(3));
1832
1833        for _ in 0..5 {
1834            let task = window_handle
1835                .update(cx, |_, window, cx| {
1836                    terminal_panel.update(cx, |panel, cx| {
1837                        panel.add_terminal_shell(None, RevealStrategy::Always, window, cx)
1838                    })
1839                })
1840                .unwrap();
1841            task.await.unwrap();
1842        }
1843
1844        cx.run_until_parked();
1845
1846        let item_count =
1847            terminal_panel.read_with(cx, |panel, cx| panel.active_pane.read(cx).items_len());
1848
1849        assert_eq!(
1850            item_count, 5,
1851            "Terminal panel should bypass max_tabs limit and have all 5 terminals"
1852        );
1853    }
1854
1855    // A complex Unix command won't be properly parsed by the Windows terminal hence omit the test there.
1856    #[cfg(unix)]
1857    #[gpui::test]
1858    async fn test_spawn_script_like_task(cx: &mut TestAppContext) {
1859        init_test(cx);
1860
1861        let fs = FakeFs::new(cx.executor());
1862        let project = Project::test(fs, [], cx).await;
1863        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1864
1865        let (window_handle, terminal_panel) = workspace
1866            .update(cx, |workspace, window, cx| {
1867                let window_handle = window.window_handle();
1868                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1869                (window_handle, terminal_panel)
1870            })
1871            .unwrap();
1872
1873        let user_command = r#"REPO_URL=$(git remote get-url origin | sed -e \"s/^git@\\(.*\\):\\(.*\\)\\.git$/https:\\/\\/\\1\\/\\2/\"); COMMIT_SHA=$(git log -1 --format=\"%H\" -- \"${ZED_RELATIVE_FILE}\"); echo \"${REPO_URL}/blob/${COMMIT_SHA}/${ZED_RELATIVE_FILE}#L${ZED_ROW}-$(echo $(($(wc -l <<< \"$ZED_SELECTED_TEXT\") + $ZED_ROW - 1)))\" | xclip -selection clipboard"#.to_string();
1874
1875        let expected_cwd = PathBuf::from("/some/work");
1876        let task = window_handle
1877            .update(cx, |_, window, cx| {
1878                terminal_panel.update(cx, |terminal_panel, cx| {
1879                    terminal_panel.spawn_task(
1880                        &SpawnInTerminal {
1881                            command: Some(user_command.clone()),
1882                            cwd: Some(expected_cwd.clone()),
1883                            ..SpawnInTerminal::default()
1884                        },
1885                        window,
1886                        cx,
1887                    )
1888                })
1889            })
1890            .unwrap();
1891
1892        let terminal = task.await.unwrap();
1893        let shell = util::get_system_shell();
1894        terminal
1895            .update(cx, |terminal, _| {
1896                let task_metadata = terminal
1897                    .task()
1898                    .expect("When spawning a task, should have the task metadata")
1899                    .spawned_task
1900                    .clone();
1901                assert_eq!(task_metadata.env, HashMap::default());
1902                assert_eq!(task_metadata.cwd, Some(expected_cwd));
1903                assert_eq!(task_metadata.shell, task::Shell::System);
1904                assert_eq!(task_metadata.command, Some(shell.clone()));
1905                assert_eq!(
1906                    task_metadata.args,
1907                    vec!["-i".to_string(), "-c".to_string(), user_command.clone(),],
1908                    "Use command should have been moved into the arguments, as we're spawning a new -i shell",
1909                );
1910                assert_eq!(
1911                    task_metadata.command_label,
1912                    format!("{shell} {interactive}-c '{user_command}'", interactive = if cfg!(windows) {""} else {"-i "}),
1913                    "We want to show to the user the entire command spawned");
1914            })
1915            .unwrap();
1916    }
1917
1918    #[gpui::test]
1919    async fn renders_error_if_default_shell_fails(cx: &mut TestAppContext) {
1920        init_test(cx);
1921
1922        cx.update(|cx| {
1923            SettingsStore::update_global(cx, |store, cx| {
1924                store.update_user_settings(cx, |settings| {
1925                    settings.terminal.get_or_insert_default().project.shell =
1926                        Some(settings::Shell::Program("asdf".to_owned()));
1927                });
1928            });
1929        });
1930
1931        let fs = FakeFs::new(cx.executor());
1932        let project = Project::test(fs, [], cx).await;
1933        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1934
1935        let (window_handle, terminal_panel) = workspace
1936            .update(cx, |workspace, window, cx| {
1937                let window_handle = window.window_handle();
1938                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1939                (window_handle, terminal_panel)
1940            })
1941            .unwrap();
1942
1943        window_handle
1944            .update(cx, |_, window, cx| {
1945                terminal_panel.update(cx, |terminal_panel, cx| {
1946                    terminal_panel.add_terminal_shell(None, RevealStrategy::Always, window, cx)
1947                })
1948            })
1949            .unwrap()
1950            .await
1951            .unwrap_err();
1952
1953        window_handle
1954            .update(cx, |_, _, cx| {
1955                terminal_panel.update(cx, |terminal_panel, cx| {
1956                    assert!(
1957                        terminal_panel
1958                            .active_pane
1959                            .read(cx)
1960                            .items()
1961                            .any(|item| item.downcast::<FailedToSpawnTerminal>().is_some()),
1962                        "should spawn `FailedToSpawnTerminal` pane"
1963                    );
1964                })
1965            })
1966            .unwrap();
1967    }
1968
1969    fn set_max_tabs(cx: &mut TestAppContext, value: Option<usize>) {
1970        cx.update_global(|store: &mut SettingsStore, cx| {
1971            store.update_user_settings(cx, |settings| {
1972                settings.workspace.max_tabs = value.map(|v| NonZero::new(v).unwrap())
1973            });
1974        });
1975    }
1976
1977    pub fn init_test(cx: &mut TestAppContext) {
1978        cx.update(|cx| {
1979            let store = SettingsStore::test(cx);
1980            cx.set_global(store);
1981            theme::init(theme::LoadThemes::JustBase, cx);
1982            editor::init(cx);
1983            crate::init(cx);
1984        });
1985    }
1986}