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, cx);
 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), 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), 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 = matches!(reveal_strategy, RevealStrategy::Always);
 794                    pane.add_item(terminal_view, true, focus, None, window, cx);
 795                });
 796
 797                Ok(terminal.downgrade())
 798            })?;
 799            terminal_panel.update(cx, |terminal_panel, cx| {
 800                terminal_panel.pending_terminals_to_add =
 801                    terminal_panel.pending_terminals_to_add.saturating_sub(1);
 802                terminal_panel.serialize(cx)
 803            })?;
 804            result
 805        })
 806    }
 807
 808    fn add_terminal_shell(
 809        &mut self,
 810        cwd: Option<PathBuf>,
 811        reveal_strategy: RevealStrategy,
 812        window: &mut Window,
 813        cx: &mut Context<Self>,
 814    ) -> Task<Result<WeakEntity<Terminal>>> {
 815        let workspace = self.workspace.clone();
 816
 817        cx.spawn_in(window, async move |terminal_panel, cx| {
 818            if workspace.update(cx, |workspace, cx| !is_enabled_in_workspace(workspace, cx))? {
 819                anyhow::bail!("terminal not yet supported for collaborative projects");
 820            }
 821            let pane = terminal_panel.update(cx, |terminal_panel, _| {
 822                terminal_panel.pending_terminals_to_add += 1;
 823                terminal_panel.active_pane.clone()
 824            })?;
 825            let project = workspace.read_with(cx, |workspace, _| workspace.project().clone())?;
 826            let terminal = project
 827                .update(cx, |project, cx| project.create_terminal_shell(cwd, cx))?
 828                .await;
 829
 830            match terminal {
 831                Ok(terminal) => {
 832                    let result = workspace.update_in(cx, |workspace, window, cx| {
 833                        let terminal_view = Box::new(cx.new(|cx| {
 834                            TerminalView::new(
 835                                terminal.clone(),
 836                                workspace.weak_handle(),
 837                                workspace.database_id(),
 838                                workspace.project().downgrade(),
 839                                window,
 840                                cx,
 841                            )
 842                        }));
 843
 844                        match reveal_strategy {
 845                            RevealStrategy::Always => {
 846                                workspace.focus_panel::<Self>(window, cx);
 847                            }
 848                            RevealStrategy::NoFocus => {
 849                                workspace.open_panel::<Self>(window, cx);
 850                            }
 851                            RevealStrategy::Never => {}
 852                        }
 853
 854                        pane.update(cx, |pane, cx| {
 855                            let focus = matches!(reveal_strategy, RevealStrategy::Always);
 856                            pane.add_item(terminal_view, true, focus, None, window, cx);
 857                        });
 858
 859                        Ok(terminal.downgrade())
 860                    })?;
 861                    terminal_panel.update(cx, |terminal_panel, cx| {
 862                        terminal_panel.pending_terminals_to_add =
 863                            terminal_panel.pending_terminals_to_add.saturating_sub(1);
 864                        terminal_panel.serialize(cx)
 865                    })?;
 866                    result
 867                }
 868                Err(error) => {
 869                    pane.update_in(cx, |pane, window, cx| {
 870                        let focus = pane.has_focus(window, cx);
 871                        let failed_to_spawn = cx.new(|cx| FailedToSpawnTerminal {
 872                            error: error.to_string(),
 873                            focus_handle: cx.focus_handle(),
 874                        });
 875                        pane.add_item(Box::new(failed_to_spawn), true, focus, None, window, cx);
 876                    })?;
 877                    Err(error)
 878                }
 879            }
 880        })
 881    }
 882
 883    fn serialize(&mut self, cx: &mut Context<Self>) {
 884        let height = self.height;
 885        let width = self.width;
 886        let Some(serialization_key) = self
 887            .workspace
 888            .read_with(cx, |workspace, _| {
 889                TerminalPanel::serialization_key(workspace)
 890            })
 891            .ok()
 892            .flatten()
 893        else {
 894            return;
 895        };
 896        self.pending_serialization = cx.spawn(async move |terminal_panel, cx| {
 897            cx.background_executor()
 898                .timer(Duration::from_millis(50))
 899                .await;
 900            let terminal_panel = terminal_panel.upgrade()?;
 901            let items = terminal_panel
 902                .update(cx, |terminal_panel, cx| {
 903                    SerializedItems::WithSplits(serialize_pane_group(
 904                        &terminal_panel.center,
 905                        &terminal_panel.active_pane,
 906                        cx,
 907                    ))
 908                })
 909                .ok()?;
 910            cx.background_spawn(
 911                async move {
 912                    KEY_VALUE_STORE
 913                        .write_kvp(
 914                            serialization_key,
 915                            serde_json::to_string(&SerializedTerminalPanel {
 916                                items,
 917                                active_item_id: None,
 918                                height,
 919                                width,
 920                            })?,
 921                        )
 922                        .await?;
 923                    anyhow::Ok(())
 924                }
 925                .log_err(),
 926            )
 927            .await;
 928            Some(())
 929        });
 930    }
 931
 932    fn replace_terminal(
 933        &self,
 934        spawn_task: SpawnInTerminal,
 935        task_pane: Entity<Pane>,
 936        terminal_item_index: usize,
 937        terminal_to_replace: Entity<TerminalView>,
 938        window: &mut Window,
 939        cx: &mut Context<Self>,
 940    ) -> Task<Result<WeakEntity<Terminal>>> {
 941        let reveal = spawn_task.reveal;
 942        let reveal_target = spawn_task.reveal_target;
 943        let task_workspace = self.workspace.clone();
 944        cx.spawn_in(window, async move |terminal_panel, cx| {
 945            let project = terminal_panel.update(cx, |this, cx| {
 946                this.workspace
 947                    .update(cx, |workspace, _| workspace.project().clone())
 948            })??;
 949            let new_terminal = project
 950                .update(cx, |project, cx| {
 951                    project.create_terminal_task(spawn_task, cx)
 952                })?
 953                .await?;
 954            terminal_to_replace.update_in(cx, |terminal_to_replace, window, cx| {
 955                terminal_to_replace.set_terminal(new_terminal.clone(), window, cx);
 956            })?;
 957
 958            match reveal {
 959                RevealStrategy::Always => match reveal_target {
 960                    RevealTarget::Center => {
 961                        task_workspace.update_in(cx, |workspace, window, cx| {
 962                            let did_activate = workspace.activate_item(
 963                                &terminal_to_replace,
 964                                true,
 965                                true,
 966                                window,
 967                                cx,
 968                            );
 969
 970                            anyhow::ensure!(did_activate, "Failed to retrieve terminal pane");
 971
 972                            anyhow::Ok(())
 973                        })??;
 974                    }
 975                    RevealTarget::Dock => {
 976                        terminal_panel.update_in(cx, |terminal_panel, window, cx| {
 977                            terminal_panel.activate_terminal_view(
 978                                &task_pane,
 979                                terminal_item_index,
 980                                true,
 981                                window,
 982                                cx,
 983                            )
 984                        })?;
 985
 986                        cx.spawn(async move |cx| {
 987                            task_workspace
 988                                .update_in(cx, |workspace, window, cx| {
 989                                    workspace.focus_panel::<Self>(window, cx)
 990                                })
 991                                .ok()
 992                        })
 993                        .detach();
 994                    }
 995                },
 996                RevealStrategy::NoFocus => match reveal_target {
 997                    RevealTarget::Center => {
 998                        task_workspace.update_in(cx, |workspace, window, cx| {
 999                            workspace.active_pane().focus_handle(cx).focus(window, cx);
1000                        })?;
1001                    }
1002                    RevealTarget::Dock => {
1003                        terminal_panel.update_in(cx, |terminal_panel, window, cx| {
1004                            terminal_panel.activate_terminal_view(
1005                                &task_pane,
1006                                terminal_item_index,
1007                                false,
1008                                window,
1009                                cx,
1010                            )
1011                        })?;
1012
1013                        cx.spawn(async move |cx| {
1014                            task_workspace
1015                                .update_in(cx, |workspace, window, cx| {
1016                                    workspace.open_panel::<Self>(window, cx)
1017                                })
1018                                .ok()
1019                        })
1020                        .detach();
1021                    }
1022                },
1023                RevealStrategy::Never => {}
1024            }
1025
1026            Ok(new_terminal.downgrade())
1027        })
1028    }
1029
1030    fn has_no_terminals(&self, cx: &App) -> bool {
1031        self.active_pane.read(cx).items_len() == 0 && self.pending_terminals_to_add == 0
1032    }
1033
1034    pub fn assistant_enabled(&self) -> bool {
1035        self.assistant_enabled
1036    }
1037
1038    fn is_enabled(&self, cx: &App) -> bool {
1039        self.workspace
1040            .upgrade()
1041            .is_some_and(|workspace| is_enabled_in_workspace(workspace.read(cx), cx))
1042    }
1043
1044    fn activate_pane_in_direction(
1045        &mut self,
1046        direction: SplitDirection,
1047        window: &mut Window,
1048        cx: &mut Context<Self>,
1049    ) {
1050        if let Some(pane) = self
1051            .center
1052            .find_pane_in_direction(&self.active_pane, direction, cx)
1053        {
1054            window.focus(&pane.focus_handle(cx), cx);
1055        } else {
1056            self.workspace
1057                .update(cx, |workspace, cx| {
1058                    workspace.activate_pane_in_direction(direction, window, cx)
1059                })
1060                .ok();
1061        }
1062    }
1063
1064    fn swap_pane_in_direction(&mut self, direction: SplitDirection, cx: &mut Context<Self>) {
1065        if let Some(to) = self
1066            .center
1067            .find_pane_in_direction(&self.active_pane, direction, cx)
1068            .cloned()
1069        {
1070            self.center.swap(&self.active_pane, &to, cx);
1071            cx.notify();
1072        }
1073    }
1074
1075    fn move_pane_to_border(&mut self, direction: SplitDirection, cx: &mut Context<Self>) {
1076        if self
1077            .center
1078            .move_to_border(&self.active_pane, direction, cx)
1079            .unwrap()
1080        {
1081            cx.notify();
1082        }
1083    }
1084}
1085
1086fn is_enabled_in_workspace(workspace: &Workspace, cx: &App) -> bool {
1087    workspace.project().read(cx).supports_terminal(cx)
1088}
1089
1090pub fn new_terminal_pane(
1091    workspace: WeakEntity<Workspace>,
1092    project: Entity<Project>,
1093    zoomed: bool,
1094    window: &mut Window,
1095    cx: &mut Context<TerminalPanel>,
1096) -> Entity<Pane> {
1097    let is_local = project.read(cx).is_local();
1098    let terminal_panel = cx.entity();
1099    let pane = cx.new(|cx| {
1100        let mut pane = Pane::new(
1101            workspace.clone(),
1102            project.clone(),
1103            Default::default(),
1104            None,
1105            NewTerminal.boxed_clone(),
1106            false,
1107            window,
1108            cx,
1109        );
1110        pane.set_zoomed(zoomed, cx);
1111        pane.set_can_navigate(false, cx);
1112        pane.display_nav_history_buttons(None);
1113        pane.set_should_display_tab_bar(|_, _| true);
1114        pane.set_zoom_out_on_close(false);
1115
1116        let split_closure_terminal_panel = terminal_panel.downgrade();
1117        pane.set_can_split(Some(Arc::new(move |pane, dragged_item, _window, cx| {
1118            if let Some(tab) = dragged_item.downcast_ref::<DraggedTab>() {
1119                let is_current_pane = tab.pane == cx.entity();
1120                let Some(can_drag_away) = split_closure_terminal_panel
1121                    .read_with(cx, |terminal_panel, _| {
1122                        let current_panes = terminal_panel.center.panes();
1123                        !current_panes.contains(&&tab.pane)
1124                            || current_panes.len() > 1
1125                            || (!is_current_pane || pane.items_len() > 1)
1126                    })
1127                    .ok()
1128                else {
1129                    return false;
1130                };
1131                if can_drag_away {
1132                    let item = if is_current_pane {
1133                        pane.item_for_index(tab.ix)
1134                    } else {
1135                        tab.pane.read(cx).item_for_index(tab.ix)
1136                    };
1137                    if let Some(item) = item {
1138                        return item.downcast::<TerminalView>().is_some();
1139                    }
1140                }
1141            }
1142            false
1143        })));
1144
1145        let buffer_search_bar = cx.new(|cx| {
1146            search::BufferSearchBar::new(Some(project.read(cx).languages().clone()), window, cx)
1147        });
1148        let breadcrumbs = cx.new(|_| Breadcrumbs::new());
1149        pane.toolbar().update(cx, |toolbar, cx| {
1150            toolbar.add_item(buffer_search_bar, window, cx);
1151            toolbar.add_item(breadcrumbs, window, cx);
1152        });
1153
1154        let drop_closure_project = project.downgrade();
1155        let drop_closure_terminal_panel = terminal_panel.downgrade();
1156        pane.set_custom_drop_handle(cx, move |pane, dropped_item, window, cx| {
1157            let Some(project) = drop_closure_project.upgrade() else {
1158                return ControlFlow::Break(());
1159            };
1160            if let Some(tab) = dropped_item.downcast_ref::<DraggedTab>() {
1161                let this_pane = cx.entity();
1162                let item = if tab.pane == this_pane {
1163                    pane.item_for_index(tab.ix)
1164                } else {
1165                    tab.pane.read(cx).item_for_index(tab.ix)
1166                };
1167                if let Some(item) = item {
1168                    if item.downcast::<TerminalView>().is_some() {
1169                        let source = tab.pane.clone();
1170                        let item_id_to_move = item.item_id();
1171
1172                        let Ok(new_split_pane) = pane
1173                            .drag_split_direction()
1174                            .map(|split_direction| {
1175                                drop_closure_terminal_panel.update(cx, |terminal_panel, cx| {
1176                                    let is_zoomed = if terminal_panel.active_pane == this_pane {
1177                                        pane.is_zoomed()
1178                                    } else {
1179                                        terminal_panel.active_pane.read(cx).is_zoomed()
1180                                    };
1181                                    let new_pane = new_terminal_pane(
1182                                        workspace.clone(),
1183                                        project.clone(),
1184                                        is_zoomed,
1185                                        window,
1186                                        cx,
1187                                    );
1188                                    terminal_panel.apply_tab_bar_buttons(&new_pane, cx);
1189                                    terminal_panel.center.split(
1190                                        &this_pane,
1191                                        &new_pane,
1192                                        split_direction,
1193                                        cx,
1194                                    )?;
1195                                    anyhow::Ok(new_pane)
1196                                })
1197                            })
1198                            .transpose()
1199                        else {
1200                            return ControlFlow::Break(());
1201                        };
1202
1203                        match new_split_pane.transpose() {
1204                            // Source pane may be the one currently updated, so defer the move.
1205                            Ok(Some(new_pane)) => cx
1206                                .spawn_in(window, async move |_, cx| {
1207                                    cx.update(|window, cx| {
1208                                        move_item(
1209                                            &source,
1210                                            &new_pane,
1211                                            item_id_to_move,
1212                                            new_pane.read(cx).active_item_index(),
1213                                            true,
1214                                            window,
1215                                            cx,
1216                                        );
1217                                    })
1218                                    .ok();
1219                                })
1220                                .detach(),
1221                            // If we drop into existing pane or current pane,
1222                            // regular pane drop handler will take care of it,
1223                            // using the right tab index for the operation.
1224                            Ok(None) => return ControlFlow::Continue(()),
1225                            err @ Err(_) => {
1226                                err.log_err();
1227                                return ControlFlow::Break(());
1228                            }
1229                        };
1230                    } else if let Some(project_path) = item.project_path(cx)
1231                        && let Some(entry_path) = project.read(cx).absolute_path(&project_path, cx)
1232                    {
1233                        add_paths_to_terminal(pane, &[entry_path], window, cx);
1234                    }
1235                }
1236            } else if let Some(selection) = dropped_item.downcast_ref::<DraggedSelection>() {
1237                let project = project.read(cx);
1238                let paths_to_add = selection
1239                    .items()
1240                    .map(|selected_entry| selected_entry.entry_id)
1241                    .filter_map(|entry_id| project.path_for_entry(entry_id, cx))
1242                    .filter_map(|project_path| project.absolute_path(&project_path, cx))
1243                    .collect::<Vec<_>>();
1244                if !paths_to_add.is_empty() {
1245                    add_paths_to_terminal(pane, &paths_to_add, window, cx);
1246                }
1247            } else if let Some(&entry_id) = dropped_item.downcast_ref::<ProjectEntryId>() {
1248                if let Some(entry_path) = project
1249                    .read(cx)
1250                    .path_for_entry(entry_id, cx)
1251                    .and_then(|project_path| project.read(cx).absolute_path(&project_path, cx))
1252                {
1253                    add_paths_to_terminal(pane, &[entry_path], window, cx);
1254                }
1255            } else if is_local && let Some(paths) = dropped_item.downcast_ref::<ExternalPaths>() {
1256                add_paths_to_terminal(pane, paths.paths(), window, cx);
1257            }
1258
1259            ControlFlow::Break(())
1260        });
1261
1262        pane
1263    });
1264
1265    cx.subscribe_in(&pane, window, TerminalPanel::handle_pane_event)
1266        .detach();
1267    cx.observe(&pane, |_, _, cx| cx.notify()).detach();
1268
1269    pane
1270}
1271
1272async fn wait_for_terminals_tasks(
1273    terminals_for_task: Vec<(usize, Entity<Pane>, Entity<TerminalView>)>,
1274    cx: &mut AsyncApp,
1275) {
1276    let pending_tasks = terminals_for_task.iter().filter_map(|(_, _, terminal)| {
1277        terminal
1278            .update(cx, |terminal_view, cx| {
1279                terminal_view
1280                    .terminal()
1281                    .update(cx, |terminal, cx| terminal.wait_for_completed_task(cx))
1282            })
1283            .ok()
1284    });
1285    join_all(pending_tasks).await;
1286}
1287
1288fn add_paths_to_terminal(
1289    pane: &mut Pane,
1290    paths: &[PathBuf],
1291    window: &mut Window,
1292    cx: &mut Context<Pane>,
1293) {
1294    if let Some(terminal_view) = pane
1295        .active_item()
1296        .and_then(|item| item.downcast::<TerminalView>())
1297    {
1298        window.focus(&terminal_view.focus_handle(cx), cx);
1299        let mut new_text = paths.iter().map(|path| format!(" {path:?}")).join("");
1300        new_text.push(' ');
1301        terminal_view.update(cx, |terminal_view, cx| {
1302            terminal_view.terminal().update(cx, |terminal, _| {
1303                terminal.paste(&new_text);
1304            });
1305        });
1306    }
1307}
1308
1309struct FailedToSpawnTerminal {
1310    error: String,
1311    focus_handle: FocusHandle,
1312}
1313
1314impl Focusable for FailedToSpawnTerminal {
1315    fn focus_handle(&self, _: &App) -> FocusHandle {
1316        self.focus_handle.clone()
1317    }
1318}
1319
1320impl Render for FailedToSpawnTerminal {
1321    fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1322        let popover_menu = PopoverMenu::new("settings-popover")
1323            .trigger(
1324                IconButton::new("icon-button-popover", IconName::ChevronDown)
1325                    .icon_size(IconSize::XSmall),
1326            )
1327            .menu(move |window, cx| {
1328                Some(ContextMenu::build(window, cx, |context_menu, _, _| {
1329                    context_menu
1330                        .action("Open Settings", zed_actions::OpenSettings.boxed_clone())
1331                        .action(
1332                            "Edit settings.json",
1333                            zed_actions::OpenSettingsFile.boxed_clone(),
1334                        )
1335                }))
1336            })
1337            .anchor(Corner::TopRight)
1338            .offset(gpui::Point {
1339                x: px(0.0),
1340                y: px(2.0),
1341            });
1342
1343        v_flex()
1344            .track_focus(&self.focus_handle)
1345            .size_full()
1346            .p_4()
1347            .items_center()
1348            .justify_center()
1349            .bg(cx.theme().colors().editor_background)
1350            .child(
1351                v_flex()
1352                    .max_w_112()
1353                    .items_center()
1354                    .justify_center()
1355                    .text_center()
1356                    .child(Label::new("Failed to spawn terminal"))
1357                    .child(
1358                        Label::new(self.error.to_string())
1359                            .size(LabelSize::Small)
1360                            .color(Color::Muted)
1361                            .mb_4(),
1362                    )
1363                    .child(SplitButton::new(
1364                        ButtonLike::new("open-settings-ui")
1365                            .child(Label::new("Edit Settings").size(LabelSize::Small))
1366                            .on_click(|_, window, cx| {
1367                                window.dispatch_action(zed_actions::OpenSettings.boxed_clone(), cx);
1368                            }),
1369                        popover_menu.into_any_element(),
1370                    )),
1371            )
1372    }
1373}
1374
1375impl EventEmitter<()> for FailedToSpawnTerminal {}
1376
1377impl workspace::Item for FailedToSpawnTerminal {
1378    type Event = ();
1379
1380    fn tab_content_text(&self, _detail: usize, _cx: &App) -> SharedString {
1381        SharedString::new_static("Failed to spawn terminal")
1382    }
1383}
1384
1385impl EventEmitter<PanelEvent> for TerminalPanel {}
1386
1387impl Render for TerminalPanel {
1388    fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1389        let mut registrar = DivRegistrar::new(
1390            |panel, _, cx| {
1391                panel
1392                    .active_pane
1393                    .read(cx)
1394                    .toolbar()
1395                    .read(cx)
1396                    .item_of_type::<BufferSearchBar>()
1397            },
1398            cx,
1399        );
1400        BufferSearchBar::register(&mut registrar);
1401        let registrar = registrar.into_div();
1402        self.workspace
1403            .update(cx, |workspace, cx| {
1404                registrar.size_full().child(self.center.render(
1405                    workspace.zoomed_item(),
1406                    &workspace::PaneRenderContext {
1407                        follower_states: &HashMap::default(),
1408                        active_call: workspace.active_call(),
1409                        active_pane: &self.active_pane,
1410                        app_state: workspace.app_state(),
1411                        project: workspace.project(),
1412                        workspace: &workspace.weak_handle(),
1413                    },
1414                    window,
1415                    cx,
1416                ))
1417            })
1418            .ok()
1419            .map(|div| {
1420                div.on_action({
1421                    cx.listener(|terminal_panel, _: &ActivatePaneLeft, window, cx| {
1422                        terminal_panel.activate_pane_in_direction(SplitDirection::Left, window, cx);
1423                    })
1424                })
1425                .on_action({
1426                    cx.listener(|terminal_panel, _: &ActivatePaneRight, window, cx| {
1427                        terminal_panel.activate_pane_in_direction(
1428                            SplitDirection::Right,
1429                            window,
1430                            cx,
1431                        );
1432                    })
1433                })
1434                .on_action({
1435                    cx.listener(|terminal_panel, _: &ActivatePaneUp, window, cx| {
1436                        terminal_panel.activate_pane_in_direction(SplitDirection::Up, window, cx);
1437                    })
1438                })
1439                .on_action({
1440                    cx.listener(|terminal_panel, _: &ActivatePaneDown, window, cx| {
1441                        terminal_panel.activate_pane_in_direction(SplitDirection::Down, window, cx);
1442                    })
1443                })
1444                .on_action(
1445                    cx.listener(|terminal_panel, _action: &ActivateNextPane, window, cx| {
1446                        let panes = terminal_panel.center.panes();
1447                        if let Some(ix) = panes
1448                            .iter()
1449                            .position(|pane| **pane == terminal_panel.active_pane)
1450                        {
1451                            let next_ix = (ix + 1) % panes.len();
1452                            window.focus(&panes[next_ix].focus_handle(cx), cx);
1453                        }
1454                    }),
1455                )
1456                .on_action(cx.listener(
1457                    |terminal_panel, _action: &ActivatePreviousPane, window, cx| {
1458                        let panes = terminal_panel.center.panes();
1459                        if let Some(ix) = panes
1460                            .iter()
1461                            .position(|pane| **pane == terminal_panel.active_pane)
1462                        {
1463                            let prev_ix = cmp::min(ix.wrapping_sub(1), panes.len() - 1);
1464                            window.focus(&panes[prev_ix].focus_handle(cx), cx);
1465                        }
1466                    },
1467                ))
1468                .on_action(
1469                    cx.listener(|terminal_panel, action: &ActivatePane, window, cx| {
1470                        let panes = terminal_panel.center.panes();
1471                        if let Some(&pane) = panes.get(action.0) {
1472                            window.focus(&pane.read(cx).focus_handle(cx), cx);
1473                        } else {
1474                            let future =
1475                                terminal_panel.new_pane_with_cloned_active_terminal(window, cx);
1476                            cx.spawn_in(window, async move |terminal_panel, cx| {
1477                                if let Some(new_pane) = future.await {
1478                                    _ = terminal_panel.update_in(
1479                                        cx,
1480                                        |terminal_panel, window, cx| {
1481                                            terminal_panel
1482                                                .center
1483                                                .split(
1484                                                    &terminal_panel.active_pane,
1485                                                    &new_pane,
1486                                                    SplitDirection::Right,
1487                                                    cx,
1488                                                )
1489                                                .log_err();
1490                                            let new_pane = new_pane.read(cx);
1491                                            window.focus(&new_pane.focus_handle(cx), cx);
1492                                        },
1493                                    );
1494                                }
1495                            })
1496                            .detach();
1497                        }
1498                    }),
1499                )
1500                .on_action(cx.listener(|terminal_panel, _: &SwapPaneLeft, _, cx| {
1501                    terminal_panel.swap_pane_in_direction(SplitDirection::Left, cx);
1502                }))
1503                .on_action(cx.listener(|terminal_panel, _: &SwapPaneRight, _, cx| {
1504                    terminal_panel.swap_pane_in_direction(SplitDirection::Right, cx);
1505                }))
1506                .on_action(cx.listener(|terminal_panel, _: &SwapPaneUp, _, cx| {
1507                    terminal_panel.swap_pane_in_direction(SplitDirection::Up, cx);
1508                }))
1509                .on_action(cx.listener(|terminal_panel, _: &SwapPaneDown, _, cx| {
1510                    terminal_panel.swap_pane_in_direction(SplitDirection::Down, cx);
1511                }))
1512                .on_action(cx.listener(|terminal_panel, _: &MovePaneLeft, _, cx| {
1513                    terminal_panel.move_pane_to_border(SplitDirection::Left, cx);
1514                }))
1515                .on_action(cx.listener(|terminal_panel, _: &MovePaneRight, _, cx| {
1516                    terminal_panel.move_pane_to_border(SplitDirection::Right, cx);
1517                }))
1518                .on_action(cx.listener(|terminal_panel, _: &MovePaneUp, _, cx| {
1519                    terminal_panel.move_pane_to_border(SplitDirection::Up, cx);
1520                }))
1521                .on_action(cx.listener(|terminal_panel, _: &MovePaneDown, _, cx| {
1522                    terminal_panel.move_pane_to_border(SplitDirection::Down, cx);
1523                }))
1524                .on_action(
1525                    cx.listener(|terminal_panel, action: &MoveItemToPane, window, cx| {
1526                        let Some(&target_pane) =
1527                            terminal_panel.center.panes().get(action.destination)
1528                        else {
1529                            return;
1530                        };
1531                        move_active_item(
1532                            &terminal_panel.active_pane,
1533                            target_pane,
1534                            action.focus,
1535                            true,
1536                            window,
1537                            cx,
1538                        );
1539                    }),
1540                )
1541                .on_action(cx.listener(
1542                    |terminal_panel, action: &MoveItemToPaneInDirection, window, cx| {
1543                        let source_pane = &terminal_panel.active_pane;
1544                        if let Some(destination_pane) = terminal_panel
1545                            .center
1546                            .find_pane_in_direction(source_pane, action.direction, cx)
1547                        {
1548                            move_active_item(
1549                                source_pane,
1550                                destination_pane,
1551                                action.focus,
1552                                true,
1553                                window,
1554                                cx,
1555                            );
1556                        };
1557                    },
1558                ))
1559            })
1560            .unwrap_or_else(|| div())
1561    }
1562}
1563
1564impl Focusable for TerminalPanel {
1565    fn focus_handle(&self, cx: &App) -> FocusHandle {
1566        self.active_pane.focus_handle(cx)
1567    }
1568}
1569
1570impl Panel for TerminalPanel {
1571    fn position(&self, _window: &Window, cx: &App) -> DockPosition {
1572        match TerminalSettings::get_global(cx).dock {
1573            TerminalDockPosition::Left => DockPosition::Left,
1574            TerminalDockPosition::Bottom => DockPosition::Bottom,
1575            TerminalDockPosition::Right => DockPosition::Right,
1576        }
1577    }
1578
1579    fn position_is_valid(&self, _: DockPosition) -> bool {
1580        true
1581    }
1582
1583    fn set_position(
1584        &mut self,
1585        position: DockPosition,
1586        _window: &mut Window,
1587        cx: &mut Context<Self>,
1588    ) {
1589        settings::update_settings_file(self.fs.clone(), cx, move |settings, _| {
1590            let dock = match position {
1591                DockPosition::Left => TerminalDockPosition::Left,
1592                DockPosition::Bottom => TerminalDockPosition::Bottom,
1593                DockPosition::Right => TerminalDockPosition::Right,
1594            };
1595            settings.terminal.get_or_insert_default().dock = Some(dock);
1596        });
1597    }
1598
1599    fn size(&self, window: &Window, cx: &App) -> Pixels {
1600        let settings = TerminalSettings::get_global(cx);
1601        match self.position(window, cx) {
1602            DockPosition::Left | DockPosition::Right => {
1603                self.width.unwrap_or(settings.default_width)
1604            }
1605            DockPosition::Bottom => self.height.unwrap_or(settings.default_height),
1606        }
1607    }
1608
1609    fn set_size(&mut self, size: Option<Pixels>, window: &mut Window, cx: &mut Context<Self>) {
1610        match self.position(window, cx) {
1611            DockPosition::Left | DockPosition::Right => self.width = size,
1612            DockPosition::Bottom => self.height = size,
1613        }
1614        cx.notify();
1615        cx.defer_in(window, |this, _, cx| {
1616            this.serialize(cx);
1617        })
1618    }
1619
1620    fn is_zoomed(&self, _window: &Window, cx: &App) -> bool {
1621        self.active_pane.read(cx).is_zoomed()
1622    }
1623
1624    fn set_zoomed(&mut self, zoomed: bool, _: &mut Window, cx: &mut Context<Self>) {
1625        for pane in self.center.panes() {
1626            pane.update(cx, |pane, cx| {
1627                pane.set_zoomed(zoomed, cx);
1628            })
1629        }
1630        cx.notify();
1631    }
1632
1633    fn set_active(&mut self, active: bool, window: &mut Window, cx: &mut Context<Self>) {
1634        let old_active = self.active;
1635        self.active = active;
1636        if !active || old_active == active || !self.has_no_terminals(cx) {
1637            return;
1638        }
1639        cx.defer_in(window, |this, window, cx| {
1640            let Ok(kind) = this
1641                .workspace
1642                .update(cx, |workspace, cx| default_working_directory(workspace, cx))
1643            else {
1644                return;
1645            };
1646
1647            this.add_terminal_shell(kind, RevealStrategy::Always, window, cx)
1648                .detach_and_log_err(cx)
1649        })
1650    }
1651
1652    fn icon_label(&self, _window: &Window, cx: &App) -> Option<String> {
1653        let count = self
1654            .center
1655            .panes()
1656            .into_iter()
1657            .map(|pane| pane.read(cx).items_len())
1658            .sum::<usize>();
1659        if count == 0 {
1660            None
1661        } else {
1662            Some(count.to_string())
1663        }
1664    }
1665
1666    fn persistent_name() -> &'static str {
1667        "TerminalPanel"
1668    }
1669
1670    fn panel_key() -> &'static str {
1671        TERMINAL_PANEL_KEY
1672    }
1673
1674    fn icon(&self, _window: &Window, cx: &App) -> Option<IconName> {
1675        if (self.is_enabled(cx) || !self.has_no_terminals(cx))
1676            && TerminalSettings::get_global(cx).button
1677        {
1678            Some(IconName::TerminalAlt)
1679        } else {
1680            None
1681        }
1682    }
1683
1684    fn icon_tooltip(&self, _window: &Window, _cx: &App) -> Option<&'static str> {
1685        Some("Terminal Panel")
1686    }
1687
1688    fn toggle_action(&self) -> Box<dyn gpui::Action> {
1689        Box::new(ToggleFocus)
1690    }
1691
1692    fn pane(&self) -> Option<Entity<Pane>> {
1693        Some(self.active_pane.clone())
1694    }
1695
1696    fn activation_priority(&self) -> u32 {
1697        1
1698    }
1699}
1700
1701struct TerminalProvider(Entity<TerminalPanel>);
1702
1703impl workspace::TerminalProvider for TerminalProvider {
1704    fn spawn(
1705        &self,
1706        task: SpawnInTerminal,
1707        window: &mut Window,
1708        cx: &mut App,
1709    ) -> Task<Option<Result<ExitStatus>>> {
1710        let terminal_panel = self.0.clone();
1711        window.spawn(cx, async move |cx| {
1712            let terminal = terminal_panel
1713                .update_in(cx, |terminal_panel, window, cx| {
1714                    terminal_panel.spawn_task(&task, window, cx)
1715                })
1716                .ok()?
1717                .await;
1718            match terminal {
1719                Ok(terminal) => {
1720                    let exit_status = terminal
1721                        .read_with(cx, |terminal, cx| terminal.wait_for_completed_task(cx))
1722                        .ok()?
1723                        .await?;
1724                    Some(Ok(exit_status))
1725                }
1726                Err(e) => Some(Err(e)),
1727            }
1728        })
1729    }
1730}
1731
1732struct InlineAssistTabBarButton {
1733    focus_handle: FocusHandle,
1734}
1735
1736impl Render for InlineAssistTabBarButton {
1737    fn render(&mut self, _window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
1738        let focus_handle = self.focus_handle.clone();
1739        IconButton::new("terminal_inline_assistant", IconName::ZedAssistant)
1740            .icon_size(IconSize::Small)
1741            .on_click(cx.listener(|_, _, window, cx| {
1742                window.dispatch_action(InlineAssist::default().boxed_clone(), cx);
1743            }))
1744            .tooltip(move |_window, cx| {
1745                Tooltip::for_action_in("Inline Assist", &InlineAssist::default(), &focus_handle, cx)
1746            })
1747    }
1748}
1749
1750#[cfg(test)]
1751mod tests {
1752    use std::num::NonZero;
1753
1754    use super::*;
1755    use gpui::{TestAppContext, UpdateGlobal as _};
1756    use pretty_assertions::assert_eq;
1757    use project::FakeFs;
1758    use settings::SettingsStore;
1759
1760    #[gpui::test]
1761    async fn test_spawn_an_empty_task(cx: &mut TestAppContext) {
1762        init_test(cx);
1763
1764        let fs = FakeFs::new(cx.executor());
1765        let project = Project::test(fs, [], cx).await;
1766        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1767
1768        let (window_handle, terminal_panel) = workspace
1769            .update(cx, |workspace, window, cx| {
1770                let window_handle = window.window_handle();
1771                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1772                (window_handle, terminal_panel)
1773            })
1774            .unwrap();
1775
1776        let task = window_handle
1777            .update(cx, |_, window, cx| {
1778                terminal_panel.update(cx, |terminal_panel, cx| {
1779                    terminal_panel.spawn_task(&SpawnInTerminal::default(), window, cx)
1780                })
1781            })
1782            .unwrap();
1783
1784        let terminal = task.await.unwrap();
1785        let expected_shell = util::get_system_shell();
1786        terminal
1787            .update(cx, |terminal, _| {
1788                let task_metadata = terminal
1789                    .task()
1790                    .expect("When spawning a task, should have the task metadata")
1791                    .spawned_task
1792                    .clone();
1793                assert_eq!(task_metadata.env, HashMap::default());
1794                assert_eq!(task_metadata.cwd, None);
1795                assert_eq!(task_metadata.shell, task::Shell::System);
1796                assert_eq!(
1797                    task_metadata.command,
1798                    Some(expected_shell.clone()),
1799                    "Empty tasks should spawn a -i shell"
1800                );
1801                assert_eq!(task_metadata.args, Vec::<String>::new());
1802                assert_eq!(
1803                    task_metadata.command_label, expected_shell,
1804                    "We show the shell launch for empty commands"
1805                );
1806            })
1807            .unwrap();
1808    }
1809
1810    #[gpui::test]
1811    async fn test_bypass_max_tabs_limit(cx: &mut TestAppContext) {
1812        init_test(cx);
1813
1814        let fs = FakeFs::new(cx.executor());
1815        let project = Project::test(fs, [], cx).await;
1816        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1817
1818        let (window_handle, terminal_panel) = workspace
1819            .update(cx, |workspace, window, cx| {
1820                let window_handle = window.window_handle();
1821                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1822                (window_handle, terminal_panel)
1823            })
1824            .unwrap();
1825
1826        set_max_tabs(cx, Some(3));
1827
1828        for _ in 0..5 {
1829            let task = window_handle
1830                .update(cx, |_, window, cx| {
1831                    terminal_panel.update(cx, |panel, cx| {
1832                        panel.add_terminal_shell(None, RevealStrategy::Always, window, cx)
1833                    })
1834                })
1835                .unwrap();
1836            task.await.unwrap();
1837        }
1838
1839        cx.run_until_parked();
1840
1841        let item_count =
1842            terminal_panel.read_with(cx, |panel, cx| panel.active_pane.read(cx).items_len());
1843
1844        assert_eq!(
1845            item_count, 5,
1846            "Terminal panel should bypass max_tabs limit and have all 5 terminals"
1847        );
1848    }
1849
1850    // A complex Unix command won't be properly parsed by the Windows terminal hence omit the test there.
1851    #[cfg(unix)]
1852    #[gpui::test]
1853    async fn test_spawn_script_like_task(cx: &mut TestAppContext) {
1854        init_test(cx);
1855
1856        let fs = FakeFs::new(cx.executor());
1857        let project = Project::test(fs, [], cx).await;
1858        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1859
1860        let (window_handle, terminal_panel) = workspace
1861            .update(cx, |workspace, window, cx| {
1862                let window_handle = window.window_handle();
1863                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1864                (window_handle, terminal_panel)
1865            })
1866            .unwrap();
1867
1868        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();
1869
1870        let expected_cwd = PathBuf::from("/some/work");
1871        let task = window_handle
1872            .update(cx, |_, window, cx| {
1873                terminal_panel.update(cx, |terminal_panel, cx| {
1874                    terminal_panel.spawn_task(
1875                        &SpawnInTerminal {
1876                            command: Some(user_command.clone()),
1877                            cwd: Some(expected_cwd.clone()),
1878                            ..SpawnInTerminal::default()
1879                        },
1880                        window,
1881                        cx,
1882                    )
1883                })
1884            })
1885            .unwrap();
1886
1887        let terminal = task.await.unwrap();
1888        let shell = util::get_system_shell();
1889        terminal
1890            .update(cx, |terminal, _| {
1891                let task_metadata = terminal
1892                    .task()
1893                    .expect("When spawning a task, should have the task metadata")
1894                    .spawned_task
1895                    .clone();
1896                assert_eq!(task_metadata.env, HashMap::default());
1897                assert_eq!(task_metadata.cwd, Some(expected_cwd));
1898                assert_eq!(task_metadata.shell, task::Shell::System);
1899                assert_eq!(task_metadata.command, Some(shell.clone()));
1900                assert_eq!(
1901                    task_metadata.args,
1902                    vec!["-i".to_string(), "-c".to_string(), user_command.clone(),],
1903                    "Use command should have been moved into the arguments, as we're spawning a new -i shell",
1904                );
1905                assert_eq!(
1906                    task_metadata.command_label,
1907                    format!("{shell} {interactive}-c '{user_command}'", interactive = if cfg!(windows) {""} else {"-i "}),
1908                    "We want to show to the user the entire command spawned");
1909            })
1910            .unwrap();
1911    }
1912
1913    #[gpui::test]
1914    async fn renders_error_if_default_shell_fails(cx: &mut TestAppContext) {
1915        init_test(cx);
1916
1917        cx.update(|cx| {
1918            SettingsStore::update_global(cx, |store, cx| {
1919                store.update_user_settings(cx, |settings| {
1920                    settings.terminal.get_or_insert_default().project.shell =
1921                        Some(settings::Shell::Program("asdf".to_owned()));
1922                });
1923            });
1924        });
1925
1926        let fs = FakeFs::new(cx.executor());
1927        let project = Project::test(fs, [], cx).await;
1928        let workspace = cx.add_window(|window, cx| Workspace::test_new(project, window, cx));
1929
1930        let (window_handle, terminal_panel) = workspace
1931            .update(cx, |workspace, window, cx| {
1932                let window_handle = window.window_handle();
1933                let terminal_panel = cx.new(|cx| TerminalPanel::new(workspace, window, cx));
1934                (window_handle, terminal_panel)
1935            })
1936            .unwrap();
1937
1938        window_handle
1939            .update(cx, |_, window, cx| {
1940                terminal_panel.update(cx, |terminal_panel, cx| {
1941                    terminal_panel.add_terminal_shell(None, RevealStrategy::Always, window, cx)
1942                })
1943            })
1944            .unwrap()
1945            .await
1946            .unwrap_err();
1947
1948        window_handle
1949            .update(cx, |_, _, cx| {
1950                terminal_panel.update(cx, |terminal_panel, cx| {
1951                    assert!(
1952                        terminal_panel
1953                            .active_pane
1954                            .read(cx)
1955                            .items()
1956                            .any(|item| item.downcast::<FailedToSpawnTerminal>().is_some()),
1957                        "should spawn `FailedToSpawnTerminal` pane"
1958                    );
1959                })
1960            })
1961            .unwrap();
1962    }
1963
1964    fn set_max_tabs(cx: &mut TestAppContext, value: Option<usize>) {
1965        cx.update_global(|store: &mut SettingsStore, cx| {
1966            store.update_user_settings(cx, |settings| {
1967                settings.workspace.max_tabs = value.map(|v| NonZero::new(v).unwrap())
1968            });
1969        });
1970    }
1971
1972    pub fn init_test(cx: &mut TestAppContext) {
1973        cx.update(|cx| {
1974            let store = SettingsStore::test(cx);
1975            cx.set_global(store);
1976            theme::init(theme::LoadThemes::JustBase, cx);
1977            editor::init(cx);
1978            crate::init(cx);
1979        });
1980    }
1981}