1pub mod agent_registry_store;
2pub mod agent_server_store;
3pub mod buffer_store;
4pub mod color_extractor;
5pub mod connection_manager;
6pub mod context_server_store;
7pub mod debounced_delay;
8pub mod debugger;
9pub mod git_store;
10pub mod image_store;
11pub mod lsp_command;
12pub mod lsp_store;
13pub mod manifest_tree;
14pub mod prettier_store;
15pub mod project_search;
16pub mod project_settings;
17pub mod search;
18pub mod task_inventory;
19pub mod task_store;
20pub mod telemetry_snapshot;
21pub mod terminals;
22pub mod toolchain_store;
23pub mod trusted_worktrees;
24pub mod worktree_store;
25
26mod environment;
27use buffer_diff::BufferDiff;
28use context_server_store::ContextServerStore;
29pub use environment::ProjectEnvironmentEvent;
30use git::repository::get_git_committer;
31use git_store::{Repository, RepositoryId};
32pub mod search_history;
33pub mod yarn;
34
35use dap::inline_value::{InlineValueLocation, VariableLookupKind, VariableScope};
36use itertools::{Either, Itertools};
37
38use crate::{
39 git_store::GitStore,
40 lsp_store::{SymbolLocation, log_store::LogKind},
41 project_search::SearchResultsHandle,
42 trusted_worktrees::{PathTrust, RemoteHostLocation, TrustedWorktrees},
43 worktree_store::WorktreeIdCounter,
44};
45pub use agent_registry_store::{AgentRegistryStore, RegistryAgent};
46pub use agent_server_store::{AgentId, AgentServerStore, AgentServersUpdated, ExternalAgentSource};
47pub use git_store::{
48 ConflictRegion, ConflictSet, ConflictSetSnapshot, ConflictSetUpdate,
49 git_traversal::{ChildEntriesGitIter, GitEntry, GitEntryRef, GitTraversal},
50 linked_worktree_short_name, worktrees_directory_for_repo,
51};
52pub use manifest_tree::ManifestTree;
53pub use project_search::{Search, SearchResults};
54pub use worktree_store::WorktreePaths;
55
56use anyhow::{Context as _, Result, anyhow};
57use buffer_store::{BufferStore, BufferStoreEvent};
58use client::{
59 Client, Collaborator, PendingEntitySubscription, ProjectId, TypedEnvelope, UserStore, proto,
60};
61use clock::ReplicaId;
62
63use dap::client::DebugAdapterClient;
64
65use collections::{BTreeSet, HashMap, HashSet, IndexSet};
66use debounced_delay::DebouncedDelay;
67pub use debugger::breakpoint_store::BreakpointWithPosition;
68use debugger::{
69 breakpoint_store::{ActiveStackFrame, BreakpointStore},
70 dap_store::{DapStore, DapStoreEvent},
71 session::Session,
72};
73
74pub use environment::ProjectEnvironment;
75
76use futures::{
77 StreamExt,
78 channel::mpsc::{self, UnboundedReceiver},
79 future::try_join_all,
80};
81pub use image_store::{ImageItem, ImageStore};
82use image_store::{ImageItemEvent, ImageStoreEvent};
83
84use ::git::{blame::Blame, status::FileStatus};
85use gpui::{
86 App, AppContext, AsyncApp, BorrowAppContext, Context, Entity, EventEmitter, Hsla, SharedString,
87 Task, WeakEntity, Window,
88};
89use language::{
90 Buffer, BufferEvent, Capability, CodeLabel, CursorShape, DiskState, Language, LanguageName,
91 LanguageRegistry, PointUtf16, ToOffset, ToPointUtf16, Toolchain, ToolchainMetadata,
92 ToolchainScope, Transaction, Unclipped, language_settings::InlayHintKind,
93 proto::split_operations,
94};
95use lsp::{
96 CodeActionKind, CompletionContext, CompletionItemKind, DocumentHighlightKind, InsertTextMode,
97 LanguageServerBinary, LanguageServerId, LanguageServerName, LanguageServerSelector,
98 MessageActionItem,
99};
100use lsp_command::*;
101use lsp_store::{CompletionDocumentation, LspFormatTarget, OpenLspBufferHandle};
102pub use manifest_tree::ManifestProvidersStore;
103use node_runtime::NodeRuntime;
104use parking_lot::Mutex;
105pub use prettier_store::PrettierStore;
106use project_settings::{ProjectSettings, SettingsObserver, SettingsObserverEvent};
107#[cfg(target_os = "windows")]
108use remote::wsl_path_to_windows_path;
109use remote::{RemoteClient, RemoteConnectionOptions};
110use rpc::{
111 AnyProtoClient, ErrorCode,
112 proto::{LanguageServerPromptResponse, REMOTE_SERVER_PROJECT_ID},
113};
114use search::{SearchInputKind, SearchQuery, SearchResult};
115use search_history::SearchHistory;
116use settings::{InvalidSettingsError, RegisterSetting, Settings, SettingsLocation, SettingsStore};
117use snippet::Snippet;
118pub use snippet_provider;
119use snippet_provider::SnippetProvider;
120use std::{
121 borrow::Cow,
122 collections::BTreeMap,
123 ffi::OsString,
124 future::Future,
125 ops::{Not as _, Range},
126 path::{Path, PathBuf},
127 pin::pin,
128 str::{self, FromStr},
129 sync::Arc,
130 time::Duration,
131};
132
133use task_store::TaskStore;
134use terminals::Terminals;
135use text::{Anchor, BufferId, OffsetRangeExt, Point, Rope};
136use toolchain_store::EmptyToolchainStore;
137use util::{
138 ResultExt as _, maybe,
139 path_list::PathList,
140 paths::{PathStyle, SanitizedPath, is_absolute},
141 rel_path::RelPath,
142};
143use worktree::{CreatedEntry, Snapshot, Traversal};
144pub use worktree::{
145 Entry, EntryKind, FS_WATCH_LATENCY, File, LocalWorktree, PathChange, ProjectEntryId,
146 UpdatedEntriesSet, UpdatedGitRepositoriesSet, Worktree, WorktreeId, WorktreeSettings,
147 discover_root_repo_common_dir,
148};
149use worktree_store::{WorktreeStore, WorktreeStoreEvent};
150
151pub use fs::*;
152pub use language::Location;
153#[cfg(any(test, feature = "test-support"))]
154pub use prettier::FORMAT_SUFFIX as TEST_PRETTIER_FORMAT_SUFFIX;
155#[cfg(any(test, feature = "test-support"))]
156pub use prettier::RANGE_FORMAT_SUFFIX as TEST_PRETTIER_RANGE_FORMAT_SUFFIX;
157pub use task_inventory::{
158 BasicContextProvider, ContextProviderWithTasks, DebugScenarioContext, Inventory, TaskContexts,
159 TaskSourceKind,
160};
161
162pub use buffer_store::ProjectTransaction;
163pub use lsp_store::{
164 DiagnosticSummary, InvalidationStrategy, LanguageServerLogType, LanguageServerProgress,
165 LanguageServerPromptRequest, LanguageServerStatus, LanguageServerToQuery, LspStore,
166 LspStoreEvent, ProgressToken, SERVER_PROGRESS_THROTTLE_TIMEOUT,
167};
168pub use toolchain_store::{ToolchainStore, Toolchains};
169const MAX_PROJECT_SEARCH_HISTORY_SIZE: usize = 500;
170
171#[derive(Clone, Copy, Debug)]
172pub struct LocalProjectFlags {
173 pub init_worktree_trust: bool,
174 pub watch_global_configs: bool,
175}
176
177impl Default for LocalProjectFlags {
178 fn default() -> Self {
179 Self {
180 init_worktree_trust: true,
181 watch_global_configs: true,
182 }
183 }
184}
185
186pub trait ProjectItem: 'static {
187 fn try_open(
188 project: &Entity<Project>,
189 path: &ProjectPath,
190 cx: &mut App,
191 ) -> Option<Task<Result<Entity<Self>>>>
192 where
193 Self: Sized;
194 fn entry_id(&self, cx: &App) -> Option<ProjectEntryId>;
195 fn project_path(&self, cx: &App) -> Option<ProjectPath>;
196 fn is_dirty(&self) -> bool;
197}
198
199#[derive(Clone)]
200pub enum OpenedBufferEvent {
201 Disconnected,
202 Ok(BufferId),
203 Err(BufferId, Arc<anyhow::Error>),
204}
205
206/// Semantics-aware entity that is relevant to one or more [`Worktree`] with the files.
207/// `Project` is responsible for tasks, LSP and collab queries, synchronizing worktree states accordingly.
208/// Maps [`Worktree`] entries with its own logic using [`ProjectEntryId`] and [`ProjectPath`] structs.
209///
210/// Can be either local (for the project opened on the same host) or remote.(for collab projects, browsed by multiple remote users).
211pub struct Project {
212 active_entry: Option<ProjectEntryId>,
213 buffer_ordered_messages_tx: mpsc::UnboundedSender<BufferOrderedMessage>,
214 languages: Arc<LanguageRegistry>,
215 dap_store: Entity<DapStore>,
216 agent_server_store: Entity<AgentServerStore>,
217
218 breakpoint_store: Entity<BreakpointStore>,
219 collab_client: Arc<client::Client>,
220 join_project_response_message_id: u32,
221 task_store: Entity<TaskStore>,
222 user_store: Entity<UserStore>,
223 fs: Arc<dyn Fs>,
224 remote_client: Option<Entity<RemoteClient>>,
225 // todo lw explain the client_state x remote_client matrix, its super confusing
226 client_state: ProjectClientState,
227 git_store: Entity<GitStore>,
228 collaborators: HashMap<proto::PeerId, Collaborator>,
229 client_subscriptions: Vec<client::Subscription>,
230 worktree_store: Entity<WorktreeStore>,
231 buffer_store: Entity<BufferStore>,
232 context_server_store: Entity<ContextServerStore>,
233 image_store: Entity<ImageStore>,
234 lsp_store: Entity<LspStore>,
235 _subscriptions: Vec<gpui::Subscription>,
236 buffers_needing_diff: HashSet<WeakEntity<Buffer>>,
237 git_diff_debouncer: DebouncedDelay<Self>,
238 remotely_created_models: Arc<Mutex<RemotelyCreatedModels>>,
239 terminals: Terminals,
240 node: Option<NodeRuntime>,
241 search_history: SearchHistory,
242 search_included_history: SearchHistory,
243 search_excluded_history: SearchHistory,
244 snippets: Entity<SnippetProvider>,
245 environment: Entity<ProjectEnvironment>,
246 settings_observer: Entity<SettingsObserver>,
247 toolchain_store: Option<Entity<ToolchainStore>>,
248 agent_location: Option<AgentLocation>,
249 downloading_files: Arc<Mutex<HashMap<(WorktreeId, String), DownloadingFile>>>,
250 last_worktree_paths: WorktreePaths,
251}
252
253struct DownloadingFile {
254 destination_path: PathBuf,
255 chunks: Vec<u8>,
256 total_size: u64,
257 file_id: Option<u64>, // Set when we receive the State message
258}
259
260#[derive(Clone, Debug, PartialEq, Eq)]
261pub struct AgentLocation {
262 pub buffer: WeakEntity<Buffer>,
263 pub position: Anchor,
264}
265
266#[derive(Default)]
267struct RemotelyCreatedModels {
268 worktrees: Vec<Entity<Worktree>>,
269 buffers: Vec<Entity<Buffer>>,
270 retain_count: usize,
271}
272
273struct RemotelyCreatedModelGuard {
274 remote_models: std::sync::Weak<Mutex<RemotelyCreatedModels>>,
275}
276
277impl Drop for RemotelyCreatedModelGuard {
278 fn drop(&mut self) {
279 if let Some(remote_models) = self.remote_models.upgrade() {
280 let mut remote_models = remote_models.lock();
281 assert!(
282 remote_models.retain_count > 0,
283 "RemotelyCreatedModelGuard dropped too many times"
284 );
285 remote_models.retain_count -= 1;
286 if remote_models.retain_count == 0 {
287 remote_models.buffers.clear();
288 remote_models.worktrees.clear();
289 }
290 }
291 }
292}
293/// Message ordered with respect to buffer operations
294#[derive(Debug)]
295enum BufferOrderedMessage {
296 Operation {
297 buffer_id: BufferId,
298 operation: proto::Operation,
299 },
300 LanguageServerUpdate {
301 language_server_id: LanguageServerId,
302 message: proto::update_language_server::Variant,
303 name: Option<LanguageServerName>,
304 },
305 Resync,
306}
307
308#[derive(Debug)]
309enum ProjectClientState {
310 /// Single-player mode.
311 Local,
312 /// Multi-player mode but still a local project.
313 Shared { remote_id: u64 },
314 /// Multi-player mode but working on a remote project.
315 Collab {
316 sharing_has_stopped: bool,
317 capability: Capability,
318 remote_id: u64,
319 replica_id: ReplicaId,
320 },
321}
322
323/// A link to display in a toast notification, useful to point to documentation.
324#[derive(PartialEq, Debug, Clone)]
325pub struct ToastLink {
326 pub label: &'static str,
327 pub url: &'static str,
328}
329
330#[derive(Clone, Debug, PartialEq)]
331pub enum Event {
332 LanguageServerAdded(LanguageServerId, LanguageServerName, Option<WorktreeId>),
333 LanguageServerRemoved(LanguageServerId),
334 LanguageServerLog(LanguageServerId, LanguageServerLogType, String),
335 // [`lsp::notification::DidOpenTextDocument`] was sent to this server using the buffer data.
336 // Zed's buffer-related data is updated accordingly.
337 LanguageServerBufferRegistered {
338 server_id: LanguageServerId,
339 buffer_id: BufferId,
340 buffer_abs_path: PathBuf,
341 name: Option<LanguageServerName>,
342 },
343 ToggleLspLogs {
344 server_id: LanguageServerId,
345 enabled: bool,
346 toggled_log_kind: LogKind,
347 },
348 Toast {
349 notification_id: SharedString,
350 message: String,
351 /// Optional link to display as a button in the toast.
352 link: Option<ToastLink>,
353 },
354 HideToast {
355 notification_id: SharedString,
356 },
357 LanguageServerPrompt(LanguageServerPromptRequest),
358 LanguageNotFound(Entity<Buffer>),
359 ActiveEntryChanged(Option<ProjectEntryId>),
360 ActivateProjectPanel,
361 WorktreeAdded(WorktreeId),
362 WorktreeOrderChanged,
363 WorktreeRemoved(WorktreeId),
364 WorktreeUpdatedEntries(WorktreeId, UpdatedEntriesSet),
365 WorktreeUpdatedRootRepoCommonDir(WorktreeId),
366 WorktreePathsChanged {
367 old_worktree_paths: WorktreePaths,
368 },
369 DiskBasedDiagnosticsStarted {
370 language_server_id: LanguageServerId,
371 },
372 DiskBasedDiagnosticsFinished {
373 language_server_id: LanguageServerId,
374 },
375 DiagnosticsUpdated {
376 paths: Vec<ProjectPath>,
377 language_server_id: LanguageServerId,
378 },
379 RemoteIdChanged(Option<u64>),
380 DisconnectedFromHost,
381 DisconnectedFromRemote {
382 server_not_running: bool,
383 },
384 Closed,
385 DeletedEntry(WorktreeId, ProjectEntryId),
386 CollaboratorUpdated {
387 old_peer_id: proto::PeerId,
388 new_peer_id: proto::PeerId,
389 },
390 CollaboratorJoined(proto::PeerId),
391 CollaboratorLeft(proto::PeerId),
392 HostReshared,
393 Reshared,
394 Rejoined,
395 RefreshInlayHints {
396 server_id: LanguageServerId,
397 request_id: Option<usize>,
398 },
399 RefreshSemanticTokens {
400 server_id: LanguageServerId,
401 request_id: Option<usize>,
402 },
403 RefreshCodeLens,
404 RevealInProjectPanel(ProjectEntryId),
405 SnippetEdit(BufferId, Vec<(lsp::Range, Snippet)>),
406 ExpandedAllForEntry(WorktreeId, ProjectEntryId),
407 EntryRenamed(ProjectTransaction, ProjectPath, PathBuf),
408 WorkspaceEditApplied(ProjectTransaction),
409 AgentLocationChanged,
410 BufferEdited,
411}
412
413pub struct AgentLocationChanged;
414
415pub enum DebugAdapterClientState {
416 Starting(Task<Option<Arc<DebugAdapterClient>>>),
417 Running(Arc<DebugAdapterClient>),
418}
419
420#[derive(Clone, Debug, Eq, PartialEq, Hash, PartialOrd, Ord)]
421pub struct ProjectPath {
422 pub worktree_id: WorktreeId,
423 pub path: Arc<RelPath>,
424}
425
426impl ProjectPath {
427 pub fn from_file(value: &dyn language::File, cx: &App) -> Self {
428 ProjectPath {
429 worktree_id: value.worktree_id(cx),
430 path: value.path().clone(),
431 }
432 }
433
434 pub fn from_proto(p: proto::ProjectPath) -> Option<Self> {
435 Some(Self {
436 worktree_id: WorktreeId::from_proto(p.worktree_id),
437 path: RelPath::from_proto(&p.path).log_err()?,
438 })
439 }
440
441 pub fn to_proto(&self) -> proto::ProjectPath {
442 proto::ProjectPath {
443 worktree_id: self.worktree_id.to_proto(),
444 path: self.path.as_ref().to_proto(),
445 }
446 }
447
448 pub fn root_path(worktree_id: WorktreeId) -> Self {
449 Self {
450 worktree_id,
451 path: RelPath::empty().into(),
452 }
453 }
454
455 pub fn starts_with(&self, other: &ProjectPath) -> bool {
456 self.worktree_id == other.worktree_id && self.path.starts_with(&other.path)
457 }
458}
459
460#[derive(Debug, Default)]
461pub enum PrepareRenameResponse {
462 Success(Range<Anchor>),
463 OnlyUnpreparedRenameSupported,
464 #[default]
465 InvalidPosition,
466}
467
468#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
469pub enum InlayId {
470 EditPrediction(usize),
471 DebuggerValue(usize),
472 // LSP
473 Hint(usize),
474 Color(usize),
475 ReplResult(usize),
476}
477
478impl InlayId {
479 pub fn id(&self) -> usize {
480 match self {
481 Self::EditPrediction(id) => *id,
482 Self::DebuggerValue(id) => *id,
483 Self::Hint(id) => *id,
484 Self::Color(id) => *id,
485 Self::ReplResult(id) => *id,
486 }
487 }
488}
489
490#[derive(Debug, Clone, PartialEq, Eq)]
491pub struct InlayHint {
492 pub position: language::Anchor,
493 pub label: InlayHintLabel,
494 pub kind: Option<InlayHintKind>,
495 pub padding_left: bool,
496 pub padding_right: bool,
497 pub tooltip: Option<InlayHintTooltip>,
498 pub resolve_state: ResolveState,
499}
500
501/// The user's intent behind a given completion confirmation.
502#[derive(PartialEq, Eq, Hash, Debug, Clone, Copy)]
503pub enum CompletionIntent {
504 /// The user intends to 'commit' this result, if possible.
505 /// Completion confirmations should run side effects.
506 ///
507 /// For LSP completions, will respect the setting `completions.lsp_insert_mode`.
508 Complete,
509 /// Similar to [Self::Complete], but behaves like `lsp_insert_mode` is set to `insert`.
510 CompleteWithInsert,
511 /// Similar to [Self::Complete], but behaves like `lsp_insert_mode` is set to `replace`.
512 CompleteWithReplace,
513 /// The user intends to continue 'composing' this completion.
514 /// Completion confirmations should not run side effects and
515 /// let the user continue composing their action.
516 Compose,
517}
518
519impl CompletionIntent {
520 pub fn is_complete(&self) -> bool {
521 self == &Self::Complete
522 }
523
524 pub fn is_compose(&self) -> bool {
525 self == &Self::Compose
526 }
527}
528
529/// Similar to `CoreCompletion`, but with extra metadata attached.
530#[derive(Clone)]
531pub struct Completion {
532 /// The range of text that will be replaced by this completion.
533 pub replace_range: Range<Anchor>,
534 /// The new text that will be inserted.
535 pub new_text: String,
536 /// A label for this completion that is shown in the menu.
537 pub label: CodeLabel,
538 /// The documentation for this completion.
539 pub documentation: Option<CompletionDocumentation>,
540 /// Completion data source which it was constructed from.
541 pub source: CompletionSource,
542 /// A path to an icon for this completion that is shown in the menu.
543 pub icon_path: Option<SharedString>,
544 /// Text starting here and ending at the cursor will be used as the query for filtering this completion.
545 ///
546 /// If None, the start of the surrounding word is used.
547 pub match_start: Option<text::Anchor>,
548 /// Key used for de-duplicating snippets. If None, always considered unique.
549 pub snippet_deduplication_key: Option<(usize, usize)>,
550 /// Whether to adjust indentation (the default) or not.
551 pub insert_text_mode: Option<InsertTextMode>,
552 /// An optional callback to invoke when this completion is confirmed.
553 /// Returns whether new completions should be retriggered after the current one.
554 /// If `true` is returned, the editor will show a new completion menu after this completion is confirmed.
555 /// if no confirmation is provided or `false` is returned, the completion will be committed.
556 pub confirm: Option<Arc<dyn Send + Sync + Fn(CompletionIntent, &mut Window, &mut App) -> bool>>,
557}
558
559#[derive(Debug, Clone)]
560pub enum CompletionSource {
561 Lsp {
562 /// The alternate `insert` range, if provided by the LSP server.
563 insert_range: Option<Range<Anchor>>,
564 /// The id of the language server that produced this completion.
565 server_id: LanguageServerId,
566 /// The raw completion provided by the language server.
567 lsp_completion: Box<lsp::CompletionItem>,
568 /// A set of defaults for this completion item.
569 lsp_defaults: Option<Arc<lsp::CompletionListItemDefaults>>,
570 /// Whether this completion has been resolved, to ensure it happens once per completion.
571 resolved: bool,
572 },
573 Dap {
574 /// The sort text for this completion.
575 sort_text: String,
576 },
577 Custom,
578 BufferWord {
579 word_range: Range<Anchor>,
580 resolved: bool,
581 },
582}
583
584impl CompletionSource {
585 pub fn server_id(&self) -> Option<LanguageServerId> {
586 if let CompletionSource::Lsp { server_id, .. } = self {
587 Some(*server_id)
588 } else {
589 None
590 }
591 }
592
593 pub fn lsp_completion(&self, apply_defaults: bool) -> Option<Cow<'_, lsp::CompletionItem>> {
594 if let Self::Lsp {
595 lsp_completion,
596 lsp_defaults,
597 ..
598 } = self
599 {
600 if apply_defaults && let Some(lsp_defaults) = lsp_defaults {
601 let mut completion_with_defaults = *lsp_completion.clone();
602 let default_commit_characters = lsp_defaults.commit_characters.as_ref();
603 let default_edit_range = lsp_defaults.edit_range.as_ref();
604 let default_insert_text_format = lsp_defaults.insert_text_format.as_ref();
605 let default_insert_text_mode = lsp_defaults.insert_text_mode.as_ref();
606
607 if default_commit_characters.is_some()
608 || default_edit_range.is_some()
609 || default_insert_text_format.is_some()
610 || default_insert_text_mode.is_some()
611 {
612 if completion_with_defaults.commit_characters.is_none()
613 && default_commit_characters.is_some()
614 {
615 completion_with_defaults.commit_characters =
616 default_commit_characters.cloned()
617 }
618 if completion_with_defaults.text_edit.is_none() {
619 match default_edit_range {
620 Some(lsp::CompletionListItemDefaultsEditRange::Range(range)) => {
621 completion_with_defaults.text_edit =
622 Some(lsp::CompletionTextEdit::Edit(lsp::TextEdit {
623 range: *range,
624 new_text: completion_with_defaults.label.clone(),
625 }))
626 }
627 Some(lsp::CompletionListItemDefaultsEditRange::InsertAndReplace {
628 insert,
629 replace,
630 }) => {
631 completion_with_defaults.text_edit =
632 Some(lsp::CompletionTextEdit::InsertAndReplace(
633 lsp::InsertReplaceEdit {
634 new_text: completion_with_defaults.label.clone(),
635 insert: *insert,
636 replace: *replace,
637 },
638 ))
639 }
640 None => {}
641 }
642 }
643 if completion_with_defaults.insert_text_format.is_none()
644 && default_insert_text_format.is_some()
645 {
646 completion_with_defaults.insert_text_format =
647 default_insert_text_format.cloned()
648 }
649 if completion_with_defaults.insert_text_mode.is_none()
650 && default_insert_text_mode.is_some()
651 {
652 completion_with_defaults.insert_text_mode =
653 default_insert_text_mode.cloned()
654 }
655 }
656 return Some(Cow::Owned(completion_with_defaults));
657 }
658 Some(Cow::Borrowed(lsp_completion))
659 } else {
660 None
661 }
662 }
663}
664
665impl std::fmt::Debug for Completion {
666 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
667 f.debug_struct("Completion")
668 .field("replace_range", &self.replace_range)
669 .field("new_text", &self.new_text)
670 .field("label", &self.label)
671 .field("documentation", &self.documentation)
672 .field("source", &self.source)
673 .finish()
674 }
675}
676
677/// Response from a source of completions.
678pub struct CompletionResponse {
679 pub completions: Vec<Completion>,
680 pub display_options: CompletionDisplayOptions,
681 /// When false, indicates that the list is complete and does not need to be re-queried if it
682 /// can be filtered instead.
683 pub is_incomplete: bool,
684}
685
686#[derive(Default)]
687pub struct CompletionDisplayOptions {
688 pub dynamic_width: bool,
689}
690
691impl CompletionDisplayOptions {
692 pub fn merge(&mut self, other: &CompletionDisplayOptions) {
693 self.dynamic_width = self.dynamic_width && other.dynamic_width;
694 }
695}
696
697/// Response from language server completion request.
698#[derive(Clone, Debug, Default)]
699pub(crate) struct CoreCompletionResponse {
700 pub completions: Vec<CoreCompletion>,
701 /// When false, indicates that the list is complete and does not need to be re-queried if it
702 /// can be filtered instead.
703 pub is_incomplete: bool,
704}
705
706/// A generic completion that can come from different sources.
707#[derive(Clone, Debug)]
708pub(crate) struct CoreCompletion {
709 replace_range: Range<Anchor>,
710 new_text: String,
711 source: CompletionSource,
712}
713
714/// A code action provided by a language server.
715#[derive(Clone, Debug, PartialEq)]
716pub struct CodeAction {
717 /// The id of the language server that produced this code action.
718 pub server_id: LanguageServerId,
719 /// The range of the buffer where this code action is applicable.
720 pub range: Range<Anchor>,
721 /// The raw code action provided by the language server.
722 /// Can be either an action or a command.
723 pub lsp_action: LspAction,
724 /// Whether the action needs to be resolved using the language server.
725 pub resolved: bool,
726}
727
728/// An action sent back by a language server.
729#[derive(Clone, Debug, PartialEq)]
730pub enum LspAction {
731 /// An action with the full data, may have a command or may not.
732 /// May require resolving.
733 Action(Box<lsp::CodeAction>),
734 /// A command data to run as an action.
735 Command(lsp::Command),
736 /// A code lens data to run as an action.
737 CodeLens(lsp::CodeLens),
738}
739
740impl LspAction {
741 pub fn title(&self) -> &str {
742 match self {
743 Self::Action(action) => &action.title,
744 Self::Command(command) => &command.title,
745 Self::CodeLens(lens) => lens
746 .command
747 .as_ref()
748 .map(|command| command.title.as_str())
749 .unwrap_or("Unknown command"),
750 }
751 }
752
753 pub fn action_kind(&self) -> Option<lsp::CodeActionKind> {
754 match self {
755 Self::Action(action) => action.kind.clone(),
756 Self::Command(_) => Some(lsp::CodeActionKind::new("command")),
757 Self::CodeLens(_) => Some(lsp::CodeActionKind::new("code lens")),
758 }
759 }
760
761 fn edit(&self) -> Option<&lsp::WorkspaceEdit> {
762 match self {
763 Self::Action(action) => action.edit.as_ref(),
764 Self::Command(_) => None,
765 Self::CodeLens(_) => None,
766 }
767 }
768
769 fn command(&self) -> Option<&lsp::Command> {
770 match self {
771 Self::Action(action) => action.command.as_ref(),
772 Self::Command(command) => Some(command),
773 Self::CodeLens(lens) => lens.command.as_ref(),
774 }
775 }
776}
777
778#[derive(Debug, Clone, PartialEq, Eq)]
779pub enum ResolveState {
780 Resolved,
781 CanResolve(LanguageServerId, Option<lsp::LSPAny>),
782 Resolving,
783}
784impl InlayHint {
785 pub fn text(&self) -> Rope {
786 match &self.label {
787 InlayHintLabel::String(s) => Rope::from(s),
788 InlayHintLabel::LabelParts(parts) => parts.iter().map(|part| &*part.value).collect(),
789 }
790 }
791}
792
793#[derive(Debug, Clone, PartialEq, Eq)]
794pub enum InlayHintLabel {
795 String(String),
796 LabelParts(Vec<InlayHintLabelPart>),
797}
798
799#[derive(Debug, Clone, PartialEq, Eq)]
800pub struct InlayHintLabelPart {
801 pub value: String,
802 pub tooltip: Option<InlayHintLabelPartTooltip>,
803 pub location: Option<(LanguageServerId, lsp::Location)>,
804}
805
806#[derive(Debug, Clone, PartialEq, Eq)]
807pub enum InlayHintTooltip {
808 String(String),
809 MarkupContent(MarkupContent),
810}
811
812#[derive(Debug, Clone, PartialEq, Eq)]
813pub enum InlayHintLabelPartTooltip {
814 String(String),
815 MarkupContent(MarkupContent),
816}
817
818#[derive(Debug, Clone, PartialEq, Eq)]
819pub struct MarkupContent {
820 pub kind: HoverBlockKind,
821 pub value: String,
822}
823
824#[derive(Debug, Clone, PartialEq)]
825pub struct LocationLink {
826 pub origin: Option<Location>,
827 pub target: Location,
828}
829
830#[derive(Debug)]
831pub struct DocumentHighlight {
832 pub range: Range<language::Anchor>,
833 pub kind: DocumentHighlightKind,
834}
835
836#[derive(Clone, Debug)]
837pub struct Symbol {
838 pub language_server_name: LanguageServerName,
839 pub source_worktree_id: WorktreeId,
840 pub source_language_server_id: LanguageServerId,
841 pub path: SymbolLocation,
842 pub label: CodeLabel,
843 pub name: String,
844 pub kind: lsp::SymbolKind,
845 pub range: Range<Unclipped<PointUtf16>>,
846 pub container_name: Option<String>,
847}
848
849#[derive(Clone, Debug)]
850pub struct DocumentSymbol {
851 pub name: String,
852 pub kind: lsp::SymbolKind,
853 pub range: Range<Unclipped<PointUtf16>>,
854 pub selection_range: Range<Unclipped<PointUtf16>>,
855 pub children: Vec<DocumentSymbol>,
856}
857
858#[derive(Clone, Debug, PartialEq)]
859pub struct HoverBlock {
860 pub text: String,
861 pub kind: HoverBlockKind,
862}
863
864#[derive(Clone, Debug, PartialEq, Eq)]
865pub enum HoverBlockKind {
866 PlainText,
867 Markdown,
868 Code { language: String },
869}
870
871#[derive(Debug, Clone)]
872pub struct Hover {
873 pub contents: Vec<HoverBlock>,
874 pub range: Option<Range<language::Anchor>>,
875 pub language: Option<Arc<Language>>,
876}
877
878impl Hover {
879 pub fn is_empty(&self) -> bool {
880 self.contents.iter().all(|block| block.text.is_empty())
881 }
882}
883
884enum EntitySubscription {
885 Project(PendingEntitySubscription<Project>),
886 BufferStore(PendingEntitySubscription<BufferStore>),
887 GitStore(PendingEntitySubscription<GitStore>),
888 WorktreeStore(PendingEntitySubscription<WorktreeStore>),
889 LspStore(PendingEntitySubscription<LspStore>),
890 SettingsObserver(PendingEntitySubscription<SettingsObserver>),
891 DapStore(PendingEntitySubscription<DapStore>),
892 BreakpointStore(PendingEntitySubscription<BreakpointStore>),
893}
894
895#[derive(Debug, Clone)]
896pub struct DirectoryItem {
897 pub path: PathBuf,
898 pub is_dir: bool,
899}
900
901#[derive(Clone, Debug, PartialEq)]
902pub struct DocumentColor {
903 pub lsp_range: lsp::Range,
904 pub color: lsp::Color,
905 pub resolved: bool,
906 pub color_presentations: Vec<ColorPresentation>,
907}
908
909impl Eq for DocumentColor {}
910
911impl std::hash::Hash for DocumentColor {
912 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
913 self.lsp_range.hash(state);
914 self.color.red.to_bits().hash(state);
915 self.color.green.to_bits().hash(state);
916 self.color.blue.to_bits().hash(state);
917 self.color.alpha.to_bits().hash(state);
918 self.resolved.hash(state);
919 self.color_presentations.hash(state);
920 }
921}
922
923#[derive(Clone, Debug, PartialEq, Eq)]
924pub struct ColorPresentation {
925 pub label: SharedString,
926 pub text_edit: Option<lsp::TextEdit>,
927 pub additional_text_edits: Vec<lsp::TextEdit>,
928}
929
930impl std::hash::Hash for ColorPresentation {
931 fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
932 self.label.hash(state);
933 if let Some(ref edit) = self.text_edit {
934 edit.range.hash(state);
935 edit.new_text.hash(state);
936 }
937 self.additional_text_edits.len().hash(state);
938 for edit in &self.additional_text_edits {
939 edit.range.hash(state);
940 edit.new_text.hash(state);
941 }
942 }
943}
944
945#[derive(Clone)]
946pub enum DirectoryLister {
947 Project(Entity<Project>),
948 Local(Entity<Project>, Arc<dyn Fs>),
949}
950
951impl std::fmt::Debug for DirectoryLister {
952 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
953 match self {
954 DirectoryLister::Project(project) => {
955 write!(f, "DirectoryLister::Project({project:?})")
956 }
957 DirectoryLister::Local(project, _) => {
958 write!(f, "DirectoryLister::Local({project:?})")
959 }
960 }
961 }
962}
963
964impl DirectoryLister {
965 pub fn is_local(&self, cx: &App) -> bool {
966 match self {
967 DirectoryLister::Local(..) => true,
968 DirectoryLister::Project(project) => project.read(cx).is_local(),
969 }
970 }
971
972 pub fn resolve_tilde<'a>(&self, path: &'a String, cx: &App) -> Cow<'a, str> {
973 if self.is_local(cx) {
974 shellexpand::tilde(path)
975 } else {
976 Cow::from(path)
977 }
978 }
979
980 pub fn default_query(&self, cx: &mut App) -> String {
981 let project = match self {
982 DirectoryLister::Project(project) => project,
983 DirectoryLister::Local(project, _) => project,
984 }
985 .read(cx);
986 let path_style = project.path_style(cx);
987 project
988 .visible_worktrees(cx)
989 .next()
990 .map(|worktree| worktree.read(cx).abs_path().to_string_lossy().into_owned())
991 .or_else(|| std::env::home_dir().map(|dir| dir.to_string_lossy().into_owned()))
992 .map(|mut s| {
993 s.push_str(path_style.primary_separator());
994 s
995 })
996 .unwrap_or_else(|| {
997 if path_style.is_windows() {
998 "C:\\"
999 } else {
1000 "~/"
1001 }
1002 .to_string()
1003 })
1004 }
1005
1006 pub fn list_directory(&self, path: String, cx: &mut App) -> Task<Result<Vec<DirectoryItem>>> {
1007 match self {
1008 DirectoryLister::Project(project) => {
1009 project.update(cx, |project, cx| project.list_directory(path, cx))
1010 }
1011 DirectoryLister::Local(_, fs) => {
1012 let fs = fs.clone();
1013 cx.background_spawn(async move {
1014 let mut results = vec![];
1015 let expanded = shellexpand::tilde(&path);
1016 let query = Path::new(expanded.as_ref());
1017 let mut response = fs.read_dir(query).await?;
1018 while let Some(path) = response.next().await {
1019 let path = path?;
1020 if let Some(file_name) = path.file_name() {
1021 results.push(DirectoryItem {
1022 path: PathBuf::from(file_name.to_os_string()),
1023 is_dir: fs.is_dir(&path).await,
1024 });
1025 }
1026 }
1027 Ok(results)
1028 })
1029 }
1030 }
1031 }
1032
1033 pub fn path_style(&self, cx: &App) -> PathStyle {
1034 match self {
1035 Self::Local(project, ..) | Self::Project(project, ..) => {
1036 project.read(cx).path_style(cx)
1037 }
1038 }
1039 }
1040}
1041
1042pub const CURRENT_PROJECT_FEATURES: &[&str] = &["new-style-anchors"];
1043
1044#[cfg(feature = "test-support")]
1045pub const DEFAULT_COMPLETION_CONTEXT: CompletionContext = CompletionContext {
1046 trigger_kind: lsp::CompletionTriggerKind::INVOKED,
1047 trigger_character: None,
1048};
1049
1050/// An LSP diagnostics associated with a certain language server.
1051#[derive(Clone, Debug, Default)]
1052pub enum LspPullDiagnostics {
1053 #[default]
1054 Default,
1055 Response {
1056 /// The id of the language server that produced diagnostics.
1057 server_id: LanguageServerId,
1058 /// URI of the resource,
1059 uri: lsp::Uri,
1060 /// The ID provided by the dynamic registration that produced diagnostics.
1061 registration_id: Option<SharedString>,
1062 /// The diagnostics produced by this language server.
1063 diagnostics: PulledDiagnostics,
1064 },
1065}
1066
1067#[derive(Clone, Debug)]
1068pub enum PulledDiagnostics {
1069 Unchanged {
1070 /// An ID the current pulled batch for this file.
1071 /// If given, can be used to query workspace diagnostics partially.
1072 result_id: SharedString,
1073 },
1074 Changed {
1075 result_id: Option<SharedString>,
1076 diagnostics: Vec<lsp::Diagnostic>,
1077 },
1078}
1079
1080/// Whether to disable all AI features in Zed.
1081///
1082/// Default: false
1083#[derive(Copy, Clone, Debug, RegisterSetting)]
1084pub struct DisableAiSettings {
1085 pub disable_ai: bool,
1086}
1087
1088impl settings::Settings for DisableAiSettings {
1089 fn from_settings(content: &settings::SettingsContent) -> Self {
1090 Self {
1091 disable_ai: content.project.disable_ai.unwrap().0,
1092 }
1093 }
1094}
1095
1096impl DisableAiSettings {
1097 /// Returns whether AI is disabled for the given file.
1098 ///
1099 /// This checks the project-level settings for the file's worktree,
1100 /// allowing `disable_ai` to be configured per-project in `.zed/settings.json`.
1101 pub fn is_ai_disabled_for_buffer(buffer: Option<&Entity<Buffer>>, cx: &App) -> bool {
1102 Self::is_ai_disabled_for_file(buffer.and_then(|buffer| buffer.read(cx).file()), cx)
1103 }
1104
1105 pub fn is_ai_disabled_for_file(file: Option<&Arc<dyn language::File>>, cx: &App) -> bool {
1106 let location = file.map(|f| settings::SettingsLocation {
1107 worktree_id: f.worktree_id(cx),
1108 path: f.path().as_ref(),
1109 });
1110 Self::get(location, cx).disable_ai
1111 }
1112}
1113
1114impl Project {
1115 pub fn init(client: &Arc<Client>, cx: &mut App) {
1116 connection_manager::init(client.clone(), cx);
1117
1118 let client: AnyProtoClient = client.clone().into();
1119 client.add_entity_message_handler(Self::handle_add_collaborator);
1120 client.add_entity_message_handler(Self::handle_update_project_collaborator);
1121 client.add_entity_message_handler(Self::handle_remove_collaborator);
1122 client.add_entity_message_handler(Self::handle_update_project);
1123 client.add_entity_message_handler(Self::handle_unshare_project);
1124 client.add_entity_request_handler(Self::handle_update_buffer);
1125 client.add_entity_message_handler(Self::handle_update_worktree);
1126 client.add_entity_request_handler(Self::handle_synchronize_buffers);
1127
1128 client.add_entity_request_handler(Self::handle_search_candidate_buffers);
1129 client.add_entity_request_handler(Self::handle_open_buffer_by_id);
1130 client.add_entity_request_handler(Self::handle_open_buffer_by_path);
1131 client.add_entity_request_handler(Self::handle_open_new_buffer);
1132 client.add_entity_message_handler(Self::handle_create_buffer_for_peer);
1133 client.add_entity_message_handler(Self::handle_toggle_lsp_logs);
1134 client.add_entity_message_handler(Self::handle_create_image_for_peer);
1135 client.add_entity_request_handler(Self::handle_find_search_candidates_chunk);
1136 client.add_entity_message_handler(Self::handle_find_search_candidates_cancel);
1137 client.add_entity_message_handler(Self::handle_create_file_for_peer);
1138
1139 WorktreeStore::init(&client);
1140 BufferStore::init(&client);
1141 LspStore::init(&client);
1142 GitStore::init(&client);
1143 SettingsObserver::init(&client);
1144 TaskStore::init(Some(&client));
1145 ToolchainStore::init(&client);
1146 DapStore::init(&client, cx);
1147 BreakpointStore::init(&client);
1148 context_server_store::init(cx);
1149 }
1150
1151 pub fn local(
1152 client: Arc<Client>,
1153 node: NodeRuntime,
1154 user_store: Entity<UserStore>,
1155 languages: Arc<LanguageRegistry>,
1156 fs: Arc<dyn Fs>,
1157 env: Option<HashMap<String, String>>,
1158 flags: LocalProjectFlags,
1159 cx: &mut App,
1160 ) -> Entity<Self> {
1161 cx.new(|cx: &mut Context<Self>| {
1162 let (tx, rx) = mpsc::unbounded();
1163 cx.spawn(async move |this, cx| Self::send_buffer_ordered_messages(this, rx, cx).await)
1164 .detach();
1165 let snippets = SnippetProvider::new(fs.clone(), BTreeSet::from_iter([]), cx);
1166 let worktree_store =
1167 cx.new(|cx| WorktreeStore::local(false, fs.clone(), WorktreeIdCounter::get(cx)));
1168 if flags.init_worktree_trust {
1169 trusted_worktrees::track_worktree_trust(
1170 worktree_store.clone(),
1171 None,
1172 None,
1173 None,
1174 cx,
1175 );
1176 }
1177 cx.subscribe(&worktree_store, Self::on_worktree_store_event)
1178 .detach();
1179
1180 let weak_self = cx.weak_entity();
1181 let context_server_store = cx.new(|cx| {
1182 ContextServerStore::local(
1183 worktree_store.clone(),
1184 Some(weak_self.clone()),
1185 false,
1186 cx,
1187 )
1188 });
1189
1190 let environment = cx.new(|cx| {
1191 ProjectEnvironment::new(env, worktree_store.downgrade(), None, false, cx)
1192 });
1193 let manifest_tree = ManifestTree::new(worktree_store.clone(), cx);
1194 let toolchain_store = cx.new(|cx| {
1195 ToolchainStore::local(
1196 languages.clone(),
1197 worktree_store.clone(),
1198 environment.clone(),
1199 manifest_tree.clone(),
1200 cx,
1201 )
1202 });
1203
1204 let buffer_store = cx.new(|cx| BufferStore::local(worktree_store.clone(), cx));
1205 cx.subscribe(&buffer_store, Self::on_buffer_store_event)
1206 .detach();
1207
1208 let breakpoint_store =
1209 cx.new(|_| BreakpointStore::local(worktree_store.clone(), buffer_store.clone()));
1210
1211 let dap_store = cx.new(|cx| {
1212 DapStore::new_local(
1213 client.http_client(),
1214 node.clone(),
1215 fs.clone(),
1216 environment.clone(),
1217 toolchain_store.read(cx).as_language_toolchain_store(),
1218 worktree_store.clone(),
1219 breakpoint_store.clone(),
1220 false,
1221 cx,
1222 )
1223 });
1224 cx.subscribe(&dap_store, Self::on_dap_store_event).detach();
1225
1226 let image_store = cx.new(|cx| ImageStore::local(worktree_store.clone(), cx));
1227 cx.subscribe(&image_store, Self::on_image_store_event)
1228 .detach();
1229
1230 let prettier_store = cx.new(|cx| {
1231 PrettierStore::new(
1232 node.clone(),
1233 fs.clone(),
1234 languages.clone(),
1235 worktree_store.clone(),
1236 cx,
1237 )
1238 });
1239
1240 let git_store = cx.new(|cx| {
1241 GitStore::local(
1242 &worktree_store,
1243 buffer_store.clone(),
1244 environment.clone(),
1245 fs.clone(),
1246 cx,
1247 )
1248 });
1249
1250 let task_store = cx.new(|cx| {
1251 TaskStore::local(
1252 buffer_store.downgrade(),
1253 worktree_store.clone(),
1254 toolchain_store.read(cx).as_language_toolchain_store(),
1255 environment.clone(),
1256 git_store.clone(),
1257 cx,
1258 )
1259 });
1260
1261 let settings_observer = cx.new(|cx| {
1262 SettingsObserver::new_local(
1263 fs.clone(),
1264 worktree_store.clone(),
1265 task_store.clone(),
1266 flags.watch_global_configs,
1267 cx,
1268 )
1269 });
1270 cx.subscribe(&settings_observer, Self::on_settings_observer_event)
1271 .detach();
1272
1273 let lsp_store = cx.new(|cx| {
1274 LspStore::new_local(
1275 buffer_store.clone(),
1276 worktree_store.clone(),
1277 prettier_store.clone(),
1278 toolchain_store
1279 .read(cx)
1280 .as_local_store()
1281 .expect("Toolchain store to be local")
1282 .clone(),
1283 environment.clone(),
1284 manifest_tree,
1285 languages.clone(),
1286 client.http_client(),
1287 fs.clone(),
1288 cx,
1289 )
1290 });
1291
1292 let agent_server_store = cx.new(|cx| {
1293 AgentServerStore::local(
1294 node.clone(),
1295 fs.clone(),
1296 environment.clone(),
1297 client.http_client(),
1298 cx,
1299 )
1300 });
1301
1302 cx.subscribe(&lsp_store, Self::on_lsp_store_event).detach();
1303
1304 Self {
1305 buffer_ordered_messages_tx: tx,
1306 collaborators: Default::default(),
1307 worktree_store,
1308 buffer_store,
1309 image_store,
1310 lsp_store,
1311 context_server_store,
1312 join_project_response_message_id: 0,
1313 client_state: ProjectClientState::Local,
1314 git_store,
1315 client_subscriptions: Vec::new(),
1316 _subscriptions: vec![cx.on_release(Self::release)],
1317 active_entry: None,
1318 snippets,
1319 languages,
1320 collab_client: client,
1321 task_store,
1322 user_store,
1323 settings_observer,
1324 fs,
1325 remote_client: None,
1326 breakpoint_store,
1327 dap_store,
1328 agent_server_store,
1329
1330 buffers_needing_diff: Default::default(),
1331 git_diff_debouncer: DebouncedDelay::new(),
1332 terminals: Terminals {
1333 local_handles: Vec::new(),
1334 },
1335 node: Some(node),
1336 search_history: Self::new_search_history(),
1337 environment,
1338 remotely_created_models: Default::default(),
1339
1340 search_included_history: Self::new_search_history(),
1341 search_excluded_history: Self::new_search_history(),
1342
1343 toolchain_store: Some(toolchain_store),
1344
1345 agent_location: None,
1346 downloading_files: Default::default(),
1347 last_worktree_paths: WorktreePaths::default(),
1348 }
1349 })
1350 }
1351
1352 pub fn remote(
1353 remote: Entity<RemoteClient>,
1354 client: Arc<Client>,
1355 node: NodeRuntime,
1356 user_store: Entity<UserStore>,
1357 languages: Arc<LanguageRegistry>,
1358 fs: Arc<dyn Fs>,
1359 init_worktree_trust: bool,
1360 cx: &mut App,
1361 ) -> Entity<Self> {
1362 cx.new(|cx: &mut Context<Self>| {
1363 let (tx, rx) = mpsc::unbounded();
1364 cx.spawn(async move |this, cx| Self::send_buffer_ordered_messages(this, rx, cx).await)
1365 .detach();
1366 let snippets = SnippetProvider::new(fs.clone(), BTreeSet::from_iter([]), cx);
1367
1368 let (remote_proto, path_style, connection_options) =
1369 remote.read_with(cx, |remote, _| {
1370 (
1371 remote.proto_client(),
1372 remote.path_style(),
1373 remote.connection_options(),
1374 )
1375 });
1376 let worktree_store = cx.new(|cx| {
1377 WorktreeStore::remote(
1378 false,
1379 remote_proto.clone(),
1380 REMOTE_SERVER_PROJECT_ID,
1381 path_style,
1382 WorktreeIdCounter::get(cx),
1383 )
1384 });
1385
1386 cx.subscribe(&worktree_store, Self::on_worktree_store_event)
1387 .detach();
1388 if init_worktree_trust {
1389 trusted_worktrees::track_worktree_trust(
1390 worktree_store.clone(),
1391 Some(RemoteHostLocation::from(connection_options)),
1392 None,
1393 Some((remote_proto.clone(), ProjectId(REMOTE_SERVER_PROJECT_ID))),
1394 cx,
1395 );
1396 }
1397
1398 let weak_self = cx.weak_entity();
1399
1400 let buffer_store = cx.new(|cx| {
1401 BufferStore::remote(
1402 worktree_store.clone(),
1403 remote.read(cx).proto_client(),
1404 REMOTE_SERVER_PROJECT_ID,
1405 cx,
1406 )
1407 });
1408 let image_store = cx.new(|cx| {
1409 ImageStore::remote(
1410 worktree_store.clone(),
1411 remote.read(cx).proto_client(),
1412 REMOTE_SERVER_PROJECT_ID,
1413 cx,
1414 )
1415 });
1416 cx.subscribe(&buffer_store, Self::on_buffer_store_event)
1417 .detach();
1418 let toolchain_store = cx.new(|cx| {
1419 ToolchainStore::remote(
1420 REMOTE_SERVER_PROJECT_ID,
1421 worktree_store.clone(),
1422 remote.read(cx).proto_client(),
1423 cx,
1424 )
1425 });
1426
1427 let context_server_store = cx.new(|cx| {
1428 ContextServerStore::remote(
1429 rpc::proto::REMOTE_SERVER_PROJECT_ID,
1430 remote.clone(),
1431 worktree_store.clone(),
1432 Some(weak_self.clone()),
1433 cx,
1434 )
1435 });
1436
1437 let environment = cx.new(|cx| {
1438 ProjectEnvironment::new(
1439 None,
1440 worktree_store.downgrade(),
1441 Some(remote.downgrade()),
1442 false,
1443 cx,
1444 )
1445 });
1446
1447 let lsp_store = cx.new(|cx| {
1448 LspStore::new_remote(
1449 buffer_store.clone(),
1450 worktree_store.clone(),
1451 languages.clone(),
1452 remote_proto.clone(),
1453 REMOTE_SERVER_PROJECT_ID,
1454 cx,
1455 )
1456 });
1457 cx.subscribe(&lsp_store, Self::on_lsp_store_event).detach();
1458
1459 let breakpoint_store = cx.new(|_| {
1460 BreakpointStore::remote(
1461 REMOTE_SERVER_PROJECT_ID,
1462 remote_proto.clone(),
1463 buffer_store.clone(),
1464 worktree_store.clone(),
1465 )
1466 });
1467
1468 let dap_store = cx.new(|cx| {
1469 DapStore::new_remote(
1470 REMOTE_SERVER_PROJECT_ID,
1471 remote.clone(),
1472 breakpoint_store.clone(),
1473 worktree_store.clone(),
1474 node.clone(),
1475 client.http_client(),
1476 fs.clone(),
1477 cx,
1478 )
1479 });
1480
1481 let git_store = cx.new(|cx| {
1482 GitStore::remote(
1483 &worktree_store,
1484 buffer_store.clone(),
1485 remote_proto.clone(),
1486 REMOTE_SERVER_PROJECT_ID,
1487 cx,
1488 )
1489 });
1490
1491 let task_store = cx.new(|cx| {
1492 TaskStore::remote(
1493 buffer_store.downgrade(),
1494 worktree_store.clone(),
1495 toolchain_store.read(cx).as_language_toolchain_store(),
1496 remote.read(cx).proto_client(),
1497 REMOTE_SERVER_PROJECT_ID,
1498 git_store.clone(),
1499 cx,
1500 )
1501 });
1502
1503 let settings_observer = cx.new(|cx| {
1504 SettingsObserver::new_remote(
1505 fs.clone(),
1506 worktree_store.clone(),
1507 task_store.clone(),
1508 Some(remote_proto.clone()),
1509 false,
1510 cx,
1511 )
1512 });
1513 cx.subscribe(&settings_observer, Self::on_settings_observer_event)
1514 .detach();
1515
1516 let agent_server_store = cx.new(|_| {
1517 AgentServerStore::remote(
1518 REMOTE_SERVER_PROJECT_ID,
1519 remote.clone(),
1520 worktree_store.clone(),
1521 )
1522 });
1523
1524 cx.subscribe(&remote, Self::on_remote_client_event).detach();
1525
1526 let this = Self {
1527 buffer_ordered_messages_tx: tx,
1528 collaborators: Default::default(),
1529 worktree_store,
1530 buffer_store,
1531 image_store,
1532 lsp_store,
1533 context_server_store,
1534 breakpoint_store,
1535 dap_store,
1536 join_project_response_message_id: 0,
1537 client_state: ProjectClientState::Local,
1538 git_store,
1539 agent_server_store,
1540 client_subscriptions: Vec::new(),
1541 _subscriptions: vec![
1542 cx.on_release(Self::release),
1543 cx.on_app_quit(|this, cx| {
1544 let shutdown = this.remote_client.take().and_then(|client| {
1545 client.update(cx, |client, cx| {
1546 client.shutdown_processes(
1547 Some(proto::ShutdownRemoteServer {}),
1548 cx.background_executor().clone(),
1549 )
1550 })
1551 });
1552
1553 cx.background_executor().spawn(async move {
1554 if let Some(shutdown) = shutdown {
1555 shutdown.await;
1556 }
1557 })
1558 }),
1559 ],
1560 active_entry: None,
1561 snippets,
1562 languages,
1563 collab_client: client,
1564 task_store,
1565 user_store,
1566 settings_observer,
1567 fs,
1568 remote_client: Some(remote.clone()),
1569 buffers_needing_diff: Default::default(),
1570 git_diff_debouncer: DebouncedDelay::new(),
1571 terminals: Terminals {
1572 local_handles: Vec::new(),
1573 },
1574 node: Some(node),
1575 search_history: Self::new_search_history(),
1576 environment,
1577 remotely_created_models: Default::default(),
1578
1579 search_included_history: Self::new_search_history(),
1580 search_excluded_history: Self::new_search_history(),
1581
1582 toolchain_store: Some(toolchain_store),
1583 agent_location: None,
1584 downloading_files: Default::default(),
1585 last_worktree_paths: WorktreePaths::default(),
1586 };
1587
1588 // remote server -> local machine handlers
1589 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &cx.entity());
1590 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.buffer_store);
1591 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.worktree_store);
1592 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.lsp_store);
1593 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.dap_store);
1594 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.breakpoint_store);
1595 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.settings_observer);
1596 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.git_store);
1597 remote_proto.subscribe_to_entity(REMOTE_SERVER_PROJECT_ID, &this.agent_server_store);
1598
1599 remote_proto.add_entity_message_handler(Self::handle_create_buffer_for_peer);
1600 remote_proto.add_entity_message_handler(Self::handle_create_image_for_peer);
1601 remote_proto.add_entity_message_handler(Self::handle_create_file_for_peer);
1602 remote_proto.add_entity_message_handler(Self::handle_update_worktree);
1603 remote_proto.add_entity_message_handler(Self::handle_update_project);
1604 remote_proto.add_entity_message_handler(Self::handle_toast);
1605 remote_proto.add_entity_request_handler(Self::handle_language_server_prompt_request);
1606 remote_proto.add_entity_message_handler(Self::handle_hide_toast);
1607 remote_proto.add_entity_request_handler(Self::handle_update_buffer_from_remote_server);
1608 remote_proto.add_entity_request_handler(Self::handle_trust_worktrees);
1609 remote_proto.add_entity_request_handler(Self::handle_restrict_worktrees);
1610 remote_proto.add_entity_request_handler(Self::handle_find_search_candidates_chunk);
1611
1612 remote_proto.add_entity_message_handler(Self::handle_find_search_candidates_cancel);
1613 BufferStore::init(&remote_proto);
1614 WorktreeStore::init_remote(&remote_proto);
1615 LspStore::init(&remote_proto);
1616 SettingsObserver::init(&remote_proto);
1617 TaskStore::init(Some(&remote_proto));
1618 ToolchainStore::init(&remote_proto);
1619 DapStore::init(&remote_proto, cx);
1620 BreakpointStore::init(&remote_proto);
1621 GitStore::init(&remote_proto);
1622 AgentServerStore::init_remote(&remote_proto);
1623
1624 this
1625 })
1626 }
1627
1628 pub async fn in_room(
1629 remote_id: u64,
1630 client: Arc<Client>,
1631 user_store: Entity<UserStore>,
1632 languages: Arc<LanguageRegistry>,
1633 fs: Arc<dyn Fs>,
1634 cx: AsyncApp,
1635 ) -> Result<Entity<Self>> {
1636 client.connect(true, &cx).await.into_response()?;
1637
1638 let subscriptions = [
1639 EntitySubscription::Project(client.subscribe_to_entity::<Self>(remote_id)?),
1640 EntitySubscription::BufferStore(client.subscribe_to_entity::<BufferStore>(remote_id)?),
1641 EntitySubscription::GitStore(client.subscribe_to_entity::<GitStore>(remote_id)?),
1642 EntitySubscription::WorktreeStore(
1643 client.subscribe_to_entity::<WorktreeStore>(remote_id)?,
1644 ),
1645 EntitySubscription::LspStore(client.subscribe_to_entity::<LspStore>(remote_id)?),
1646 EntitySubscription::SettingsObserver(
1647 client.subscribe_to_entity::<SettingsObserver>(remote_id)?,
1648 ),
1649 EntitySubscription::DapStore(client.subscribe_to_entity::<DapStore>(remote_id)?),
1650 EntitySubscription::BreakpointStore(
1651 client.subscribe_to_entity::<BreakpointStore>(remote_id)?,
1652 ),
1653 ];
1654 let committer = get_git_committer(&cx).await;
1655 let response = client
1656 .request_envelope(proto::JoinProject {
1657 project_id: remote_id,
1658 committer_email: committer.email,
1659 committer_name: committer.name,
1660 features: CURRENT_PROJECT_FEATURES
1661 .iter()
1662 .map(|s| s.to_string())
1663 .collect(),
1664 })
1665 .await?;
1666 Self::from_join_project_response(
1667 response,
1668 subscriptions,
1669 client,
1670 false,
1671 user_store,
1672 languages,
1673 fs,
1674 cx,
1675 )
1676 .await
1677 }
1678
1679 async fn from_join_project_response(
1680 response: TypedEnvelope<proto::JoinProjectResponse>,
1681 subscriptions: [EntitySubscription; 8],
1682 client: Arc<Client>,
1683 run_tasks: bool,
1684 user_store: Entity<UserStore>,
1685 languages: Arc<LanguageRegistry>,
1686 fs: Arc<dyn Fs>,
1687 mut cx: AsyncApp,
1688 ) -> Result<Entity<Self>> {
1689 let remote_id = response.payload.project_id;
1690 let role = response.payload.role();
1691
1692 let path_style = if response.payload.windows_paths {
1693 PathStyle::Windows
1694 } else {
1695 PathStyle::Posix
1696 };
1697
1698 let worktree_store = cx.new(|cx| {
1699 WorktreeStore::remote(
1700 true,
1701 client.clone().into(),
1702 response.payload.project_id,
1703 path_style,
1704 WorktreeIdCounter::get(cx),
1705 )
1706 });
1707 let buffer_store = cx.new(|cx| {
1708 BufferStore::remote(worktree_store.clone(), client.clone().into(), remote_id, cx)
1709 });
1710 let image_store = cx.new(|cx| {
1711 ImageStore::remote(worktree_store.clone(), client.clone().into(), remote_id, cx)
1712 });
1713
1714 let environment =
1715 cx.new(|cx| ProjectEnvironment::new(None, worktree_store.downgrade(), None, true, cx));
1716 let breakpoint_store = cx.new(|_| {
1717 BreakpointStore::remote(
1718 remote_id,
1719 client.clone().into(),
1720 buffer_store.clone(),
1721 worktree_store.clone(),
1722 )
1723 });
1724 let dap_store = cx.new(|cx| {
1725 DapStore::new_collab(
1726 remote_id,
1727 client.clone().into(),
1728 breakpoint_store.clone(),
1729 worktree_store.clone(),
1730 fs.clone(),
1731 cx,
1732 )
1733 });
1734
1735 let lsp_store = cx.new(|cx| {
1736 LspStore::new_remote(
1737 buffer_store.clone(),
1738 worktree_store.clone(),
1739 languages.clone(),
1740 client.clone().into(),
1741 remote_id,
1742 cx,
1743 )
1744 });
1745
1746 let git_store = cx.new(|cx| {
1747 GitStore::remote(
1748 // In this remote case we pass None for the environment
1749 &worktree_store,
1750 buffer_store.clone(),
1751 client.clone().into(),
1752 remote_id,
1753 cx,
1754 )
1755 });
1756
1757 let task_store = cx.new(|cx| {
1758 if run_tasks {
1759 TaskStore::remote(
1760 buffer_store.downgrade(),
1761 worktree_store.clone(),
1762 Arc::new(EmptyToolchainStore),
1763 client.clone().into(),
1764 remote_id,
1765 git_store.clone(),
1766 cx,
1767 )
1768 } else {
1769 TaskStore::Noop
1770 }
1771 });
1772
1773 let settings_observer = cx.new(|cx| {
1774 SettingsObserver::new_remote(
1775 fs.clone(),
1776 worktree_store.clone(),
1777 task_store.clone(),
1778 None,
1779 true,
1780 cx,
1781 )
1782 });
1783
1784 let agent_server_store = cx.new(|_cx| AgentServerStore::collab());
1785 let replica_id = ReplicaId::new(response.payload.replica_id as u16);
1786
1787 let project = cx.new(|cx| {
1788 let snippets = SnippetProvider::new(fs.clone(), BTreeSet::from_iter([]), cx);
1789
1790 let weak_self = cx.weak_entity();
1791 let context_server_store = cx.new(|cx| {
1792 ContextServerStore::local(worktree_store.clone(), Some(weak_self), false, cx)
1793 });
1794
1795 let mut worktrees = Vec::new();
1796 for worktree in response.payload.worktrees {
1797 let worktree = Worktree::remote(
1798 remote_id,
1799 replica_id,
1800 worktree,
1801 client.clone().into(),
1802 path_style,
1803 cx,
1804 );
1805 worktrees.push(worktree);
1806 }
1807
1808 let (tx, rx) = mpsc::unbounded();
1809 cx.spawn(async move |this, cx| Self::send_buffer_ordered_messages(this, rx, cx).await)
1810 .detach();
1811
1812 cx.subscribe(&worktree_store, Self::on_worktree_store_event)
1813 .detach();
1814
1815 cx.subscribe(&buffer_store, Self::on_buffer_store_event)
1816 .detach();
1817 cx.subscribe(&lsp_store, Self::on_lsp_store_event).detach();
1818 cx.subscribe(&settings_observer, Self::on_settings_observer_event)
1819 .detach();
1820
1821 cx.subscribe(&dap_store, Self::on_dap_store_event).detach();
1822
1823 let mut project = Self {
1824 buffer_ordered_messages_tx: tx,
1825 buffer_store: buffer_store.clone(),
1826 image_store,
1827 worktree_store: worktree_store.clone(),
1828 lsp_store: lsp_store.clone(),
1829 context_server_store,
1830 active_entry: None,
1831 collaborators: Default::default(),
1832 join_project_response_message_id: response.message_id,
1833 languages,
1834 user_store: user_store.clone(),
1835 task_store,
1836 snippets,
1837 fs,
1838 remote_client: None,
1839 settings_observer: settings_observer.clone(),
1840 client_subscriptions: Default::default(),
1841 _subscriptions: vec![cx.on_release(Self::release)],
1842 collab_client: client.clone(),
1843 client_state: ProjectClientState::Collab {
1844 sharing_has_stopped: false,
1845 capability: Capability::ReadWrite,
1846 remote_id,
1847 replica_id,
1848 },
1849 breakpoint_store: breakpoint_store.clone(),
1850 dap_store: dap_store.clone(),
1851 git_store: git_store.clone(),
1852 agent_server_store,
1853 buffers_needing_diff: Default::default(),
1854 git_diff_debouncer: DebouncedDelay::new(),
1855 terminals: Terminals {
1856 local_handles: Vec::new(),
1857 },
1858 node: None,
1859 search_history: Self::new_search_history(),
1860 search_included_history: Self::new_search_history(),
1861 search_excluded_history: Self::new_search_history(),
1862 environment,
1863 remotely_created_models: Arc::new(Mutex::new(RemotelyCreatedModels::default())),
1864 toolchain_store: None,
1865 agent_location: None,
1866 downloading_files: Default::default(),
1867 last_worktree_paths: WorktreePaths::default(),
1868 };
1869 project.set_role(role, cx);
1870 for worktree in worktrees {
1871 project.add_worktree(&worktree, cx);
1872 }
1873 project
1874 });
1875
1876 let weak_project = project.downgrade();
1877 lsp_store.update(&mut cx, |lsp_store, cx| {
1878 lsp_store.set_language_server_statuses_from_proto(
1879 weak_project,
1880 response.payload.language_servers,
1881 response.payload.language_server_capabilities,
1882 cx,
1883 );
1884 });
1885
1886 let subscriptions = subscriptions
1887 .into_iter()
1888 .map(|s| match s {
1889 EntitySubscription::BufferStore(subscription) => {
1890 subscription.set_entity(&buffer_store, &cx)
1891 }
1892 EntitySubscription::WorktreeStore(subscription) => {
1893 subscription.set_entity(&worktree_store, &cx)
1894 }
1895 EntitySubscription::GitStore(subscription) => {
1896 subscription.set_entity(&git_store, &cx)
1897 }
1898 EntitySubscription::SettingsObserver(subscription) => {
1899 subscription.set_entity(&settings_observer, &cx)
1900 }
1901 EntitySubscription::Project(subscription) => subscription.set_entity(&project, &cx),
1902 EntitySubscription::LspStore(subscription) => {
1903 subscription.set_entity(&lsp_store, &cx)
1904 }
1905 EntitySubscription::DapStore(subscription) => {
1906 subscription.set_entity(&dap_store, &cx)
1907 }
1908 EntitySubscription::BreakpointStore(subscription) => {
1909 subscription.set_entity(&breakpoint_store, &cx)
1910 }
1911 })
1912 .collect::<Vec<_>>();
1913
1914 let user_ids = response
1915 .payload
1916 .collaborators
1917 .iter()
1918 .map(|peer| peer.user_id)
1919 .collect();
1920 user_store
1921 .update(&mut cx, |user_store, cx| user_store.get_users(user_ids, cx))
1922 .await?;
1923
1924 project.update(&mut cx, |this, cx| {
1925 this.set_collaborators_from_proto(response.payload.collaborators, cx)?;
1926 this.client_subscriptions.extend(subscriptions);
1927 anyhow::Ok(())
1928 })?;
1929
1930 Ok(project)
1931 }
1932
1933 fn new_search_history() -> SearchHistory {
1934 SearchHistory::new(
1935 Some(MAX_PROJECT_SEARCH_HISTORY_SIZE),
1936 search_history::QueryInsertionBehavior::AlwaysInsert,
1937 )
1938 }
1939
1940 fn release(&mut self, cx: &mut App) {
1941 if let Some(client) = self.remote_client.take() {
1942 let shutdown = client.update(cx, |client, cx| {
1943 client.shutdown_processes(
1944 Some(proto::ShutdownRemoteServer {}),
1945 cx.background_executor().clone(),
1946 )
1947 });
1948
1949 cx.background_spawn(async move {
1950 if let Some(shutdown) = shutdown {
1951 shutdown.await;
1952 }
1953 })
1954 .detach()
1955 }
1956
1957 match &self.client_state {
1958 ProjectClientState::Local => {}
1959 ProjectClientState::Shared { .. } => {
1960 let _ = self.unshare_internal(cx);
1961 }
1962 ProjectClientState::Collab { remote_id, .. } => {
1963 let _ = self.collab_client.send(proto::LeaveProject {
1964 project_id: *remote_id,
1965 });
1966 self.disconnected_from_host_internal(cx);
1967 }
1968 }
1969 }
1970
1971 #[cfg(feature = "test-support")]
1972 pub fn client_subscriptions(&self) -> &Vec<client::Subscription> {
1973 &self.client_subscriptions
1974 }
1975
1976 #[cfg(feature = "test-support")]
1977 pub async fn example(
1978 root_paths: impl IntoIterator<Item = &Path>,
1979 cx: &mut AsyncApp,
1980 ) -> Entity<Project> {
1981 use clock::FakeSystemClock;
1982
1983 let fs = Arc::new(RealFs::new(None, cx.background_executor().clone()));
1984 let languages = LanguageRegistry::test(cx.background_executor().clone());
1985 let clock = Arc::new(FakeSystemClock::new());
1986 let http_client = http_client::FakeHttpClient::with_404_response();
1987 let client = cx.update(|cx| client::Client::new(clock, http_client.clone(), cx));
1988 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
1989 let project = cx.update(|cx| {
1990 Project::local(
1991 client,
1992 node_runtime::NodeRuntime::unavailable(),
1993 user_store,
1994 Arc::new(languages),
1995 fs,
1996 None,
1997 LocalProjectFlags {
1998 init_worktree_trust: false,
1999 ..Default::default()
2000 },
2001 cx,
2002 )
2003 });
2004 for path in root_paths {
2005 let (tree, _): (Entity<Worktree>, _) = project
2006 .update(cx, |project, cx| {
2007 project.find_or_create_worktree(path, true, cx)
2008 })
2009 .await
2010 .unwrap();
2011 tree.read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
2012 .await;
2013 }
2014 project
2015 }
2016
2017 #[cfg(feature = "test-support")]
2018 pub async fn test(
2019 fs: Arc<dyn Fs>,
2020 root_paths: impl IntoIterator<Item = &Path>,
2021 cx: &mut gpui::TestAppContext,
2022 ) -> Entity<Project> {
2023 Self::test_project(fs, root_paths, false, cx).await
2024 }
2025
2026 #[cfg(feature = "test-support")]
2027 pub async fn test_with_worktree_trust(
2028 fs: Arc<dyn Fs>,
2029 root_paths: impl IntoIterator<Item = &Path>,
2030 cx: &mut gpui::TestAppContext,
2031 ) -> Entity<Project> {
2032 Self::test_project(fs, root_paths, true, cx).await
2033 }
2034
2035 #[cfg(feature = "test-support")]
2036 async fn test_project(
2037 fs: Arc<dyn Fs>,
2038 root_paths: impl IntoIterator<Item = &Path>,
2039 init_worktree_trust: bool,
2040 cx: &mut gpui::TestAppContext,
2041 ) -> Entity<Project> {
2042 use clock::FakeSystemClock;
2043
2044 let languages = LanguageRegistry::test(cx.executor());
2045 let clock = Arc::new(FakeSystemClock::new());
2046 let http_client = http_client::FakeHttpClient::with_404_response();
2047 let client = cx.update(|cx| client::Client::new(clock, http_client.clone(), cx));
2048 let user_store = cx.new(|cx| UserStore::new(client.clone(), cx));
2049 let project = cx.update(|cx| {
2050 Project::local(
2051 client,
2052 node_runtime::NodeRuntime::unavailable(),
2053 user_store,
2054 Arc::new(languages),
2055 fs,
2056 None,
2057 LocalProjectFlags {
2058 init_worktree_trust,
2059 ..Default::default()
2060 },
2061 cx,
2062 )
2063 });
2064 for path in root_paths {
2065 let (tree, _) = project
2066 .update(cx, |project, cx| {
2067 project.find_or_create_worktree(path, true, cx)
2068 })
2069 .await
2070 .unwrap();
2071
2072 tree.read_with(cx, |tree, _| tree.as_local().unwrap().scan_complete())
2073 .await;
2074 }
2075 project
2076 }
2077
2078 #[cfg(any(test, feature = "test-support"))]
2079 pub fn add_test_remote_worktree(
2080 &mut self,
2081 abs_path: &str,
2082 cx: &mut Context<Self>,
2083 ) -> Entity<Worktree> {
2084 use rpc::NoopProtoClient;
2085 use util::paths::PathStyle;
2086
2087 let root_name = std::path::Path::new(abs_path)
2088 .file_name()
2089 .map(|n| n.to_string_lossy().to_string())
2090 .unwrap_or_default();
2091
2092 let client = AnyProtoClient::new(NoopProtoClient::new());
2093 let worktree = Worktree::remote(
2094 0,
2095 ReplicaId::new(1),
2096 proto::WorktreeMetadata {
2097 id: 100 + self.visible_worktrees(cx).count() as u64,
2098 root_name,
2099 visible: true,
2100 abs_path: abs_path.to_string(),
2101 root_repo_common_dir: None,
2102 },
2103 client,
2104 PathStyle::Posix,
2105 cx,
2106 );
2107 self.worktree_store
2108 .update(cx, |store, cx| store.add(&worktree, cx));
2109 worktree
2110 }
2111
2112 #[inline]
2113 pub fn dap_store(&self) -> Entity<DapStore> {
2114 self.dap_store.clone()
2115 }
2116
2117 #[inline]
2118 pub fn breakpoint_store(&self) -> Entity<BreakpointStore> {
2119 self.breakpoint_store.clone()
2120 }
2121
2122 pub fn active_debug_session(&self, cx: &App) -> Option<(Entity<Session>, ActiveStackFrame)> {
2123 let active_position = self.breakpoint_store.read(cx).active_position()?;
2124 let session = self
2125 .dap_store
2126 .read(cx)
2127 .session_by_id(active_position.session_id)?;
2128 Some((session, active_position.clone()))
2129 }
2130
2131 #[inline]
2132 pub fn lsp_store(&self) -> Entity<LspStore> {
2133 self.lsp_store.clone()
2134 }
2135
2136 #[inline]
2137 pub fn worktree_store(&self) -> Entity<WorktreeStore> {
2138 self.worktree_store.clone()
2139 }
2140
2141 /// Returns a future that resolves when all visible worktrees have completed
2142 /// their initial scan.
2143 pub fn wait_for_initial_scan(&self, cx: &App) -> impl Future<Output = ()> + use<> {
2144 self.worktree_store.read(cx).wait_for_initial_scan()
2145 }
2146
2147 #[inline]
2148 pub fn context_server_store(&self) -> Entity<ContextServerStore> {
2149 self.context_server_store.clone()
2150 }
2151
2152 #[inline]
2153 pub fn buffer_for_id(&self, remote_id: BufferId, cx: &App) -> Option<Entity<Buffer>> {
2154 self.buffer_store.read(cx).get(remote_id)
2155 }
2156
2157 #[inline]
2158 pub fn languages(&self) -> &Arc<LanguageRegistry> {
2159 &self.languages
2160 }
2161
2162 #[inline]
2163 pub fn client(&self) -> Arc<Client> {
2164 self.collab_client.clone()
2165 }
2166
2167 #[inline]
2168 pub fn remote_client(&self) -> Option<Entity<RemoteClient>> {
2169 self.remote_client.clone()
2170 }
2171
2172 #[inline]
2173 pub fn user_store(&self) -> Entity<UserStore> {
2174 self.user_store.clone()
2175 }
2176
2177 #[inline]
2178 pub fn node_runtime(&self) -> Option<&NodeRuntime> {
2179 self.node.as_ref()
2180 }
2181
2182 #[inline]
2183 pub fn opened_buffers(&self, cx: &App) -> Vec<Entity<Buffer>> {
2184 self.buffer_store.read(cx).buffers().collect()
2185 }
2186
2187 #[inline]
2188 pub fn environment(&self) -> &Entity<ProjectEnvironment> {
2189 &self.environment
2190 }
2191
2192 #[inline]
2193 pub fn cli_environment(&self, cx: &App) -> Option<HashMap<String, String>> {
2194 self.environment.read(cx).get_cli_environment()
2195 }
2196
2197 #[inline]
2198 pub fn peek_environment_error<'a>(&'a self, cx: &'a App) -> Option<&'a String> {
2199 self.environment.read(cx).peek_environment_error()
2200 }
2201
2202 #[inline]
2203 pub fn pop_environment_error(&mut self, cx: &mut Context<Self>) {
2204 self.environment.update(cx, |environment, _| {
2205 environment.pop_environment_error();
2206 });
2207 }
2208
2209 #[cfg(feature = "test-support")]
2210 #[inline]
2211 pub fn has_open_buffer(&self, path: impl Into<ProjectPath>, cx: &App) -> bool {
2212 self.buffer_store
2213 .read(cx)
2214 .get_by_path(&path.into())
2215 .is_some()
2216 }
2217
2218 #[inline]
2219 pub fn fs(&self) -> &Arc<dyn Fs> {
2220 &self.fs
2221 }
2222
2223 #[inline]
2224 pub fn remote_id(&self) -> Option<u64> {
2225 match self.client_state {
2226 ProjectClientState::Local => None,
2227 ProjectClientState::Shared { remote_id, .. }
2228 | ProjectClientState::Collab { remote_id, .. } => Some(remote_id),
2229 }
2230 }
2231
2232 #[inline]
2233 pub fn supports_terminal(&self, _cx: &App) -> bool {
2234 if self.is_local() {
2235 return true;
2236 }
2237 if self.is_via_remote_server() {
2238 return true;
2239 }
2240
2241 false
2242 }
2243
2244 #[inline]
2245 pub fn remote_connection_state(&self, cx: &App) -> Option<remote::ConnectionState> {
2246 self.remote_client
2247 .as_ref()
2248 .map(|remote| remote.read(cx).connection_state())
2249 }
2250
2251 #[inline]
2252 pub fn remote_connection_options(&self, cx: &App) -> Option<RemoteConnectionOptions> {
2253 self.remote_client
2254 .as_ref()
2255 .map(|remote| remote.read(cx).connection_options())
2256 }
2257
2258 /// Reveals the given path in the system file manager.
2259 ///
2260 /// On Windows with a WSL remote connection, this converts the POSIX path
2261 /// to a Windows UNC path before revealing.
2262 pub fn reveal_path(&self, path: &Path, cx: &mut Context<Self>) {
2263 #[cfg(target_os = "windows")]
2264 if let Some(RemoteConnectionOptions::Wsl(wsl_options)) = self.remote_connection_options(cx)
2265 {
2266 let path = path.to_path_buf();
2267 cx.spawn(async move |_, cx| {
2268 wsl_path_to_windows_path(&wsl_options, &path)
2269 .await
2270 .map(|windows_path| cx.update(|cx| cx.reveal_path(&windows_path)))
2271 })
2272 .detach_and_log_err(cx);
2273 return;
2274 }
2275
2276 cx.reveal_path(path);
2277 }
2278
2279 #[inline]
2280 pub fn replica_id(&self) -> ReplicaId {
2281 match self.client_state {
2282 ProjectClientState::Collab { replica_id, .. } => replica_id,
2283 _ => {
2284 if self.remote_client.is_some() {
2285 ReplicaId::REMOTE_SERVER
2286 } else {
2287 ReplicaId::LOCAL
2288 }
2289 }
2290 }
2291 }
2292
2293 #[inline]
2294 pub fn task_store(&self) -> &Entity<TaskStore> {
2295 &self.task_store
2296 }
2297
2298 #[inline]
2299 pub fn snippets(&self) -> &Entity<SnippetProvider> {
2300 &self.snippets
2301 }
2302
2303 #[inline]
2304 pub fn search_history(&self, kind: SearchInputKind) -> &SearchHistory {
2305 match kind {
2306 SearchInputKind::Query => &self.search_history,
2307 SearchInputKind::Include => &self.search_included_history,
2308 SearchInputKind::Exclude => &self.search_excluded_history,
2309 }
2310 }
2311
2312 #[inline]
2313 pub fn search_history_mut(&mut self, kind: SearchInputKind) -> &mut SearchHistory {
2314 match kind {
2315 SearchInputKind::Query => &mut self.search_history,
2316 SearchInputKind::Include => &mut self.search_included_history,
2317 SearchInputKind::Exclude => &mut self.search_excluded_history,
2318 }
2319 }
2320
2321 #[inline]
2322 pub fn collaborators(&self) -> &HashMap<proto::PeerId, Collaborator> {
2323 &self.collaborators
2324 }
2325
2326 #[inline]
2327 pub fn host(&self) -> Option<&Collaborator> {
2328 self.collaborators.values().find(|c| c.is_host)
2329 }
2330
2331 #[inline]
2332 pub fn set_worktrees_reordered(&mut self, worktrees_reordered: bool, cx: &mut App) {
2333 self.worktree_store.update(cx, |store, _| {
2334 store.set_worktrees_reordered(worktrees_reordered);
2335 });
2336 }
2337
2338 /// Collect all worktrees, including ones that don't appear in the project panel
2339 #[inline]
2340 pub fn worktrees<'a>(
2341 &self,
2342 cx: &'a App,
2343 ) -> impl 'a + DoubleEndedIterator<Item = Entity<Worktree>> {
2344 self.worktree_store.read(cx).worktrees()
2345 }
2346
2347 /// Collect all user-visible worktrees, the ones that appear in the project panel.
2348 #[inline]
2349 pub fn visible_worktrees<'a>(
2350 &'a self,
2351 cx: &'a App,
2352 ) -> impl 'a + DoubleEndedIterator<Item = Entity<Worktree>> {
2353 self.worktree_store.read(cx).visible_worktrees(cx)
2354 }
2355
2356 pub(crate) fn default_visible_worktree_paths(
2357 worktree_store: &WorktreeStore,
2358 cx: &App,
2359 ) -> Vec<PathBuf> {
2360 worktree_store
2361 .visible_worktrees(cx)
2362 .sorted_by(|left, right| {
2363 left.read(cx)
2364 .is_single_file()
2365 .cmp(&right.read(cx).is_single_file())
2366 })
2367 .filter_map(|worktree| {
2368 let worktree = worktree.read(cx);
2369 let path = worktree.abs_path();
2370 if worktree.is_single_file() {
2371 Some(path.parent()?.to_path_buf())
2372 } else {
2373 Some(path.to_path_buf())
2374 }
2375 })
2376 .collect()
2377 }
2378
2379 pub fn default_path_list(&self, cx: &App) -> PathList {
2380 let worktree_roots =
2381 Self::default_visible_worktree_paths(&self.worktree_store.read(cx), cx);
2382
2383 if worktree_roots.is_empty() {
2384 PathList::new(&[paths::home_dir().as_path()])
2385 } else {
2386 PathList::new(&worktree_roots)
2387 }
2388 }
2389
2390 #[inline]
2391 pub fn worktree_for_root_name(&self, root_name: &str, cx: &App) -> Option<Entity<Worktree>> {
2392 self.visible_worktrees(cx)
2393 .find(|tree| tree.read(cx).root_name() == root_name)
2394 }
2395
2396 fn emit_group_key_changed_if_needed(&mut self, cx: &mut Context<Self>) {
2397 let new_worktree_paths = self.worktree_paths(cx);
2398 if new_worktree_paths != self.last_worktree_paths {
2399 let old_worktree_paths =
2400 std::mem::replace(&mut self.last_worktree_paths, new_worktree_paths);
2401 cx.emit(Event::WorktreePathsChanged { old_worktree_paths });
2402 }
2403 }
2404
2405 #[inline]
2406 pub fn worktree_root_names<'a>(&'a self, cx: &'a App) -> impl Iterator<Item = &'a str> {
2407 self.visible_worktrees(cx)
2408 .map(|tree| tree.read(cx).root_name().as_unix_str())
2409 }
2410
2411 #[inline]
2412 pub fn worktree_for_id(&self, id: WorktreeId, cx: &App) -> Option<Entity<Worktree>> {
2413 self.worktree_store.read(cx).worktree_for_id(id, cx)
2414 }
2415
2416 pub fn worktree_for_entry(
2417 &self,
2418 entry_id: ProjectEntryId,
2419 cx: &App,
2420 ) -> Option<Entity<Worktree>> {
2421 self.worktree_store
2422 .read(cx)
2423 .worktree_for_entry(entry_id, cx)
2424 }
2425
2426 #[inline]
2427 pub fn worktree_id_for_entry(&self, entry_id: ProjectEntryId, cx: &App) -> Option<WorktreeId> {
2428 self.worktree_for_entry(entry_id, cx)
2429 .map(|worktree| worktree.read(cx).id())
2430 }
2431
2432 /// Checks if the entry is the root of a worktree.
2433 #[inline]
2434 pub fn entry_is_worktree_root(&self, entry_id: ProjectEntryId, cx: &App) -> bool {
2435 self.worktree_for_entry(entry_id, cx)
2436 .map(|worktree| {
2437 worktree
2438 .read(cx)
2439 .root_entry()
2440 .is_some_and(|e| e.id == entry_id)
2441 })
2442 .unwrap_or(false)
2443 }
2444
2445 #[inline]
2446 pub fn project_path_git_status(
2447 &self,
2448 project_path: &ProjectPath,
2449 cx: &App,
2450 ) -> Option<FileStatus> {
2451 self.git_store
2452 .read(cx)
2453 .project_path_git_status(project_path, cx)
2454 }
2455
2456 #[inline]
2457 pub fn visibility_for_paths(
2458 &self,
2459 paths: &[PathBuf],
2460 exclude_sub_dirs: bool,
2461 cx: &App,
2462 ) -> Option<bool> {
2463 paths
2464 .iter()
2465 .map(|path| self.visibility_for_path(path, exclude_sub_dirs, cx))
2466 .max()
2467 .flatten()
2468 }
2469
2470 pub fn visibility_for_path(
2471 &self,
2472 path: &Path,
2473 exclude_sub_dirs: bool,
2474 cx: &App,
2475 ) -> Option<bool> {
2476 let path = SanitizedPath::new(path).as_path();
2477 let path_style = self.path_style(cx);
2478 self.worktrees(cx)
2479 .filter_map(|worktree| {
2480 let worktree = worktree.read(cx);
2481 let abs_path = worktree.abs_path();
2482 let relative_path = path_style.strip_prefix(path, abs_path.as_ref());
2483 let is_dir = relative_path
2484 .as_ref()
2485 .and_then(|p| worktree.entry_for_path(p))
2486 .is_some_and(|e| e.is_dir());
2487 // Don't exclude the worktree root itself, only actual subdirectories
2488 let is_subdir = relative_path
2489 .as_ref()
2490 .is_some_and(|p| !p.as_ref().as_unix_str().is_empty());
2491 let contains =
2492 relative_path.is_some() && (!exclude_sub_dirs || !is_dir || !is_subdir);
2493 contains.then(|| worktree.is_visible())
2494 })
2495 .max()
2496 }
2497
2498 pub fn create_entry(
2499 &mut self,
2500 project_path: impl Into<ProjectPath>,
2501 is_directory: bool,
2502 cx: &mut Context<Self>,
2503 ) -> Task<Result<CreatedEntry>> {
2504 let project_path = project_path.into();
2505 let Some(worktree) = self.worktree_for_id(project_path.worktree_id, cx) else {
2506 return Task::ready(Err(anyhow!(format!(
2507 "No worktree for path {project_path:?}"
2508 ))));
2509 };
2510 worktree.update(cx, |worktree, cx| {
2511 worktree.create_entry(project_path.path, is_directory, None, cx)
2512 })
2513 }
2514
2515 #[inline]
2516 pub fn copy_entry(
2517 &mut self,
2518 entry_id: ProjectEntryId,
2519 new_project_path: ProjectPath,
2520 cx: &mut Context<Self>,
2521 ) -> Task<Result<Option<Entry>>> {
2522 self.worktree_store.update(cx, |worktree_store, cx| {
2523 worktree_store.copy_entry(entry_id, new_project_path, cx)
2524 })
2525 }
2526
2527 /// Renames the project entry with given `entry_id`.
2528 ///
2529 /// `new_path` is a relative path to worktree root.
2530 /// If root entry is renamed then its new root name is used instead.
2531 pub fn rename_entry(
2532 &mut self,
2533 entry_id: ProjectEntryId,
2534 new_path: ProjectPath,
2535 cx: &mut Context<Self>,
2536 ) -> Task<Result<CreatedEntry>> {
2537 let worktree_store = self.worktree_store.clone();
2538 let Some((worktree, old_path, is_dir)) = worktree_store
2539 .read(cx)
2540 .worktree_and_entry_for_id(entry_id, cx)
2541 .map(|(worktree, entry)| (worktree, entry.path.clone(), entry.is_dir()))
2542 else {
2543 return Task::ready(Err(anyhow!(format!("No worktree for entry {entry_id:?}"))));
2544 };
2545
2546 let worktree_id = worktree.read(cx).id();
2547 let is_root_entry = self.entry_is_worktree_root(entry_id, cx);
2548
2549 let lsp_store = self.lsp_store().downgrade();
2550 cx.spawn(async move |project, cx| {
2551 let (old_abs_path, new_abs_path) = {
2552 let root_path = worktree.read_with(cx, |this, _| this.abs_path());
2553 let new_abs_path = if is_root_entry {
2554 root_path
2555 .parent()
2556 .unwrap()
2557 .join(new_path.path.as_std_path())
2558 } else {
2559 root_path.join(&new_path.path.as_std_path())
2560 };
2561 (root_path.join(old_path.as_std_path()), new_abs_path)
2562 };
2563 let transaction = LspStore::will_rename_entry(
2564 lsp_store.clone(),
2565 worktree_id,
2566 &old_abs_path,
2567 &new_abs_path,
2568 is_dir,
2569 cx.clone(),
2570 )
2571 .await;
2572
2573 let entry = worktree_store
2574 .update(cx, |worktree_store, cx| {
2575 worktree_store.rename_entry(entry_id, new_path.clone(), cx)
2576 })
2577 .await?;
2578
2579 project
2580 .update(cx, |_, cx| {
2581 cx.emit(Event::EntryRenamed(
2582 transaction,
2583 new_path.clone(),
2584 new_abs_path.clone(),
2585 ));
2586 })
2587 .ok();
2588
2589 lsp_store
2590 .read_with(cx, |this, _| {
2591 this.did_rename_entry(worktree_id, &old_abs_path, &new_abs_path, is_dir);
2592 })
2593 .ok();
2594 Ok(entry)
2595 })
2596 }
2597
2598 #[inline]
2599 pub fn delete_file(
2600 &mut self,
2601 path: ProjectPath,
2602 trash: bool,
2603 cx: &mut Context<Self>,
2604 ) -> Option<Task<Result<Option<TrashedEntry>>>> {
2605 let entry = self.entry_for_path(&path, cx)?;
2606 self.delete_entry(entry.id, trash, cx)
2607 }
2608
2609 #[inline]
2610 pub fn delete_entry(
2611 &mut self,
2612 entry_id: ProjectEntryId,
2613 trash: bool,
2614 cx: &mut Context<Self>,
2615 ) -> Option<Task<Result<Option<TrashedEntry>>>> {
2616 let worktree = self.worktree_for_entry(entry_id, cx)?;
2617 cx.emit(Event::DeletedEntry(worktree.read(cx).id(), entry_id));
2618 worktree.update(cx, |worktree, cx| {
2619 worktree.delete_entry(entry_id, trash, cx)
2620 })
2621 }
2622
2623 #[inline]
2624 pub fn restore_entry(
2625 &self,
2626 worktree_id: WorktreeId,
2627 trash_entry: TrashedEntry,
2628 cx: &mut Context<'_, Self>,
2629 ) -> Task<Result<ProjectPath>> {
2630 let Some(worktree) = self.worktree_for_id(worktree_id, cx) else {
2631 return Task::ready(Err(anyhow!("No worktree for id {worktree_id:?}")));
2632 };
2633
2634 cx.spawn(async move |_, cx| {
2635 Worktree::restore_entry(trash_entry, worktree, cx)
2636 .await
2637 .map(|rel_path_buf| ProjectPath {
2638 worktree_id: worktree_id,
2639 path: Arc::from(rel_path_buf.as_rel_path()),
2640 })
2641 })
2642 }
2643
2644 #[inline]
2645 pub fn expand_entry(
2646 &mut self,
2647 worktree_id: WorktreeId,
2648 entry_id: ProjectEntryId,
2649 cx: &mut Context<Self>,
2650 ) -> Option<Task<Result<()>>> {
2651 let worktree = self.worktree_for_id(worktree_id, cx)?;
2652 worktree.update(cx, |worktree, cx| worktree.expand_entry(entry_id, cx))
2653 }
2654
2655 pub fn expand_all_for_entry(
2656 &mut self,
2657 worktree_id: WorktreeId,
2658 entry_id: ProjectEntryId,
2659 cx: &mut Context<Self>,
2660 ) -> Option<Task<Result<()>>> {
2661 let worktree = self.worktree_for_id(worktree_id, cx)?;
2662 let task = worktree.update(cx, |worktree, cx| {
2663 worktree.expand_all_for_entry(entry_id, cx)
2664 });
2665 Some(cx.spawn(async move |this, cx| {
2666 task.context("no task")?.await?;
2667 this.update(cx, |_, cx| {
2668 cx.emit(Event::ExpandedAllForEntry(worktree_id, entry_id));
2669 })?;
2670 Ok(())
2671 }))
2672 }
2673
2674 pub fn shared(&mut self, project_id: u64, cx: &mut Context<Self>) -> Result<()> {
2675 anyhow::ensure!(
2676 matches!(self.client_state, ProjectClientState::Local),
2677 "project was already shared"
2678 );
2679
2680 self.client_subscriptions.extend([
2681 self.collab_client
2682 .subscribe_to_entity(project_id)?
2683 .set_entity(&cx.entity(), &cx.to_async()),
2684 self.collab_client
2685 .subscribe_to_entity(project_id)?
2686 .set_entity(&self.worktree_store, &cx.to_async()),
2687 self.collab_client
2688 .subscribe_to_entity(project_id)?
2689 .set_entity(&self.buffer_store, &cx.to_async()),
2690 self.collab_client
2691 .subscribe_to_entity(project_id)?
2692 .set_entity(&self.lsp_store, &cx.to_async()),
2693 self.collab_client
2694 .subscribe_to_entity(project_id)?
2695 .set_entity(&self.settings_observer, &cx.to_async()),
2696 self.collab_client
2697 .subscribe_to_entity(project_id)?
2698 .set_entity(&self.dap_store, &cx.to_async()),
2699 self.collab_client
2700 .subscribe_to_entity(project_id)?
2701 .set_entity(&self.breakpoint_store, &cx.to_async()),
2702 self.collab_client
2703 .subscribe_to_entity(project_id)?
2704 .set_entity(&self.git_store, &cx.to_async()),
2705 ]);
2706
2707 self.buffer_store.update(cx, |buffer_store, cx| {
2708 buffer_store.shared(project_id, self.collab_client.clone().into(), cx)
2709 });
2710 self.worktree_store.update(cx, |worktree_store, cx| {
2711 worktree_store.shared(project_id, self.collab_client.clone().into(), cx);
2712 });
2713 self.lsp_store.update(cx, |lsp_store, cx| {
2714 lsp_store.shared(project_id, self.collab_client.clone().into(), cx)
2715 });
2716 self.breakpoint_store.update(cx, |breakpoint_store, _| {
2717 breakpoint_store.shared(project_id, self.collab_client.clone().into())
2718 });
2719 self.dap_store.update(cx, |dap_store, cx| {
2720 dap_store.shared(project_id, self.collab_client.clone().into(), cx);
2721 });
2722 self.task_store.update(cx, |task_store, cx| {
2723 task_store.shared(project_id, self.collab_client.clone().into(), cx);
2724 });
2725 self.settings_observer.update(cx, |settings_observer, cx| {
2726 settings_observer.shared(project_id, self.collab_client.clone().into(), cx)
2727 });
2728 self.git_store.update(cx, |git_store, cx| {
2729 git_store.shared(project_id, self.collab_client.clone().into(), cx)
2730 });
2731
2732 self.client_state = ProjectClientState::Shared {
2733 remote_id: project_id,
2734 };
2735
2736 cx.emit(Event::RemoteIdChanged(Some(project_id)));
2737 Ok(())
2738 }
2739
2740 pub fn reshared(
2741 &mut self,
2742 message: proto::ResharedProject,
2743 cx: &mut Context<Self>,
2744 ) -> Result<()> {
2745 self.buffer_store
2746 .update(cx, |buffer_store, _| buffer_store.forget_shared_buffers());
2747 self.set_collaborators_from_proto(message.collaborators, cx)?;
2748
2749 self.worktree_store.update(cx, |worktree_store, cx| {
2750 worktree_store.send_project_updates(cx);
2751 });
2752 if let Some(remote_id) = self.remote_id() {
2753 self.git_store.update(cx, |git_store, cx| {
2754 git_store.shared(remote_id, self.collab_client.clone().into(), cx)
2755 });
2756 }
2757 cx.emit(Event::Reshared);
2758 Ok(())
2759 }
2760
2761 pub fn rejoined(
2762 &mut self,
2763 message: proto::RejoinedProject,
2764 message_id: u32,
2765 cx: &mut Context<Self>,
2766 ) -> Result<()> {
2767 cx.update_global::<SettingsStore, _>(|store, cx| {
2768 for worktree_metadata in &message.worktrees {
2769 store
2770 .clear_local_settings(WorktreeId::from_proto(worktree_metadata.id), cx)
2771 .log_err();
2772 }
2773 });
2774
2775 self.join_project_response_message_id = message_id;
2776 self.set_worktrees_from_proto(message.worktrees, cx)?;
2777 self.set_collaborators_from_proto(message.collaborators, cx)?;
2778
2779 let project = cx.weak_entity();
2780 self.lsp_store.update(cx, |lsp_store, cx| {
2781 lsp_store.set_language_server_statuses_from_proto(
2782 project,
2783 message.language_servers,
2784 message.language_server_capabilities,
2785 cx,
2786 )
2787 });
2788 self.enqueue_buffer_ordered_message(BufferOrderedMessage::Resync)
2789 .unwrap();
2790 cx.emit(Event::Rejoined);
2791 Ok(())
2792 }
2793
2794 #[inline]
2795 pub fn unshare(&mut self, cx: &mut Context<Self>) -> Result<()> {
2796 self.unshare_internal(cx)?;
2797 cx.emit(Event::RemoteIdChanged(None));
2798 Ok(())
2799 }
2800
2801 fn unshare_internal(&mut self, cx: &mut App) -> Result<()> {
2802 anyhow::ensure!(
2803 !self.is_via_collab(),
2804 "attempted to unshare a remote project"
2805 );
2806
2807 if let ProjectClientState::Shared { remote_id, .. } = self.client_state {
2808 self.client_state = ProjectClientState::Local;
2809 self.collaborators.clear();
2810 self.client_subscriptions.clear();
2811 self.worktree_store.update(cx, |store, cx| {
2812 store.unshared(cx);
2813 });
2814 self.buffer_store.update(cx, |buffer_store, cx| {
2815 buffer_store.forget_shared_buffers();
2816 buffer_store.unshared(cx)
2817 });
2818 self.task_store.update(cx, |task_store, cx| {
2819 task_store.unshared(cx);
2820 });
2821 self.breakpoint_store.update(cx, |breakpoint_store, cx| {
2822 breakpoint_store.unshared(cx);
2823 });
2824 self.dap_store.update(cx, |dap_store, cx| {
2825 dap_store.unshared(cx);
2826 });
2827 self.settings_observer.update(cx, |settings_observer, cx| {
2828 settings_observer.unshared(cx);
2829 });
2830 self.git_store.update(cx, |git_store, cx| {
2831 git_store.unshared(cx);
2832 });
2833
2834 self.collab_client
2835 .send(proto::UnshareProject {
2836 project_id: remote_id,
2837 })
2838 .ok();
2839 Ok(())
2840 } else {
2841 anyhow::bail!("attempted to unshare an unshared project");
2842 }
2843 }
2844
2845 pub fn disconnected_from_host(&mut self, cx: &mut Context<Self>) {
2846 if self.is_disconnected(cx) {
2847 return;
2848 }
2849 self.disconnected_from_host_internal(cx);
2850 cx.emit(Event::DisconnectedFromHost);
2851 }
2852
2853 pub fn set_role(&mut self, role: proto::ChannelRole, cx: &mut Context<Self>) {
2854 let new_capability =
2855 if role == proto::ChannelRole::Member || role == proto::ChannelRole::Admin {
2856 Capability::ReadWrite
2857 } else {
2858 Capability::ReadOnly
2859 };
2860 if let ProjectClientState::Collab { capability, .. } = &mut self.client_state {
2861 if *capability == new_capability {
2862 return;
2863 }
2864
2865 *capability = new_capability;
2866 for buffer in self.opened_buffers(cx) {
2867 buffer.update(cx, |buffer, cx| buffer.set_capability(new_capability, cx));
2868 }
2869 }
2870 }
2871
2872 fn disconnected_from_host_internal(&mut self, cx: &mut App) {
2873 if let ProjectClientState::Collab {
2874 sharing_has_stopped,
2875 ..
2876 } = &mut self.client_state
2877 {
2878 *sharing_has_stopped = true;
2879 self.client_subscriptions.clear();
2880 self.collaborators.clear();
2881 self.worktree_store.update(cx, |store, cx| {
2882 store.disconnected_from_host(cx);
2883 });
2884 self.buffer_store.update(cx, |buffer_store, cx| {
2885 buffer_store.disconnected_from_host(cx)
2886 });
2887 self.lsp_store
2888 .update(cx, |lsp_store, _cx| lsp_store.disconnected_from_host());
2889 }
2890 }
2891
2892 #[inline]
2893 pub fn close(&mut self, cx: &mut Context<Self>) {
2894 cx.emit(Event::Closed);
2895 }
2896
2897 #[inline]
2898 pub fn is_disconnected(&self, cx: &App) -> bool {
2899 match &self.client_state {
2900 ProjectClientState::Collab {
2901 sharing_has_stopped,
2902 ..
2903 } => *sharing_has_stopped,
2904 ProjectClientState::Local if self.is_via_remote_server() => {
2905 self.remote_client_is_disconnected(cx)
2906 }
2907 _ => false,
2908 }
2909 }
2910
2911 #[inline]
2912 fn remote_client_is_disconnected(&self, cx: &App) -> bool {
2913 self.remote_client
2914 .as_ref()
2915 .map(|remote| remote.read(cx).is_disconnected())
2916 .unwrap_or(false)
2917 }
2918
2919 #[inline]
2920 pub fn capability(&self) -> Capability {
2921 match &self.client_state {
2922 ProjectClientState::Collab { capability, .. } => *capability,
2923 ProjectClientState::Shared { .. } | ProjectClientState::Local => Capability::ReadWrite,
2924 }
2925 }
2926
2927 #[inline]
2928 pub fn is_read_only(&self, cx: &App) -> bool {
2929 self.is_disconnected(cx) || !self.capability().editable()
2930 }
2931
2932 #[inline]
2933 pub fn is_local(&self) -> bool {
2934 match &self.client_state {
2935 ProjectClientState::Local | ProjectClientState::Shared { .. } => {
2936 self.remote_client.is_none()
2937 }
2938 ProjectClientState::Collab { .. } => false,
2939 }
2940 }
2941
2942 /// Whether this project is a remote server (not counting collab).
2943 #[inline]
2944 pub fn is_via_remote_server(&self) -> bool {
2945 match &self.client_state {
2946 ProjectClientState::Local | ProjectClientState::Shared { .. } => {
2947 self.remote_client.is_some()
2948 }
2949 ProjectClientState::Collab { .. } => false,
2950 }
2951 }
2952
2953 /// Whether this project is from collab (not counting remote servers).
2954 #[inline]
2955 pub fn is_via_collab(&self) -> bool {
2956 match &self.client_state {
2957 ProjectClientState::Local | ProjectClientState::Shared { .. } => false,
2958 ProjectClientState::Collab { .. } => true,
2959 }
2960 }
2961
2962 /// `!self.is_local()`
2963 #[inline]
2964 pub fn is_remote(&self) -> bool {
2965 debug_assert_eq!(
2966 !self.is_local(),
2967 self.is_via_collab() || self.is_via_remote_server()
2968 );
2969 !self.is_local()
2970 }
2971
2972 #[inline]
2973 pub fn is_via_wsl_with_host_interop(&self, cx: &App) -> bool {
2974 match &self.client_state {
2975 ProjectClientState::Local | ProjectClientState::Shared { .. } => {
2976 matches!(
2977 &self.remote_client, Some(remote_client)
2978 if remote_client.read(cx).has_wsl_interop()
2979 )
2980 }
2981 _ => false,
2982 }
2983 }
2984
2985 pub fn disable_worktree_scanner(&mut self, cx: &mut Context<Self>) {
2986 self.worktree_store.update(cx, |worktree_store, _cx| {
2987 worktree_store.disable_scanner();
2988 });
2989 }
2990
2991 #[inline]
2992 pub fn create_buffer(
2993 &mut self,
2994 language: Option<Arc<Language>>,
2995 project_searchable: bool,
2996 cx: &mut Context<Self>,
2997 ) -> Task<Result<Entity<Buffer>>> {
2998 self.buffer_store.update(cx, |buffer_store, cx| {
2999 buffer_store.create_buffer(language, project_searchable, cx)
3000 })
3001 }
3002
3003 #[inline]
3004 pub fn create_local_buffer(
3005 &mut self,
3006 text: &str,
3007 language: Option<Arc<Language>>,
3008 project_searchable: bool,
3009 cx: &mut Context<Self>,
3010 ) -> Entity<Buffer> {
3011 if self.is_remote() {
3012 panic!("called create_local_buffer on a remote project")
3013 }
3014 self.buffer_store.update(cx, |buffer_store, cx| {
3015 buffer_store.create_local_buffer(text, language, project_searchable, cx)
3016 })
3017 }
3018
3019 pub fn open_path(
3020 &mut self,
3021 path: ProjectPath,
3022 cx: &mut Context<Self>,
3023 ) -> Task<Result<(Option<ProjectEntryId>, Entity<Buffer>)>> {
3024 let task = self.open_buffer(path, cx);
3025 cx.spawn(async move |_project, cx| {
3026 let buffer = task.await?;
3027 let project_entry_id = buffer.read_with(cx, |buffer, _cx| {
3028 File::from_dyn(buffer.file()).and_then(|file| file.project_entry_id())
3029 });
3030
3031 Ok((project_entry_id, buffer))
3032 })
3033 }
3034
3035 pub fn open_local_buffer(
3036 &mut self,
3037 abs_path: impl AsRef<Path>,
3038 cx: &mut Context<Self>,
3039 ) -> Task<Result<Entity<Buffer>>> {
3040 let worktree_task = self.find_or_create_worktree(abs_path.as_ref(), false, cx);
3041 cx.spawn(async move |this, cx| {
3042 let (worktree, relative_path) = worktree_task.await?;
3043 this.update(cx, |this, cx| {
3044 this.open_buffer((worktree.read(cx).id(), relative_path), cx)
3045 })?
3046 .await
3047 })
3048 }
3049
3050 #[cfg(feature = "test-support")]
3051 pub fn open_local_buffer_with_lsp(
3052 &mut self,
3053 abs_path: impl AsRef<Path>,
3054 cx: &mut Context<Self>,
3055 ) -> Task<Result<(Entity<Buffer>, lsp_store::OpenLspBufferHandle)>> {
3056 if let Some((worktree, relative_path)) = self.find_worktree(abs_path.as_ref(), cx) {
3057 self.open_buffer_with_lsp((worktree.read(cx).id(), relative_path), cx)
3058 } else {
3059 Task::ready(Err(anyhow!("no such path")))
3060 }
3061 }
3062
3063 pub fn download_file(
3064 &mut self,
3065 worktree_id: WorktreeId,
3066 path: Arc<RelPath>,
3067 destination_path: PathBuf,
3068 cx: &mut Context<Self>,
3069 ) -> Task<Result<()>> {
3070 log::debug!(
3071 "download_file called: worktree_id={:?}, path={:?}, destination={:?}",
3072 worktree_id,
3073 path,
3074 destination_path
3075 );
3076
3077 let Some(remote_client) = &self.remote_client else {
3078 log::error!("download_file: not a remote project");
3079 return Task::ready(Err(anyhow!("not a remote project")));
3080 };
3081
3082 let proto_client = remote_client.read(cx).proto_client();
3083 // For SSH remote projects, use REMOTE_SERVER_PROJECT_ID instead of remote_id()
3084 // because SSH projects have client_state: Local but still need to communicate with remote server
3085 let project_id = self.remote_id().unwrap_or(REMOTE_SERVER_PROJECT_ID);
3086 let downloading_files = self.downloading_files.clone();
3087 let path_str = path.to_proto();
3088
3089 static NEXT_FILE_ID: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(1);
3090 let file_id = NEXT_FILE_ID.fetch_add(1, std::sync::atomic::Ordering::SeqCst);
3091
3092 // Register BEFORE sending request to avoid race condition
3093 let key = (worktree_id, path_str.clone());
3094 log::debug!(
3095 "download_file: pre-registering download with key={:?}, file_id={}",
3096 key,
3097 file_id
3098 );
3099 downloading_files.lock().insert(
3100 key,
3101 DownloadingFile {
3102 destination_path: destination_path,
3103 chunks: Vec::new(),
3104 total_size: 0,
3105 file_id: Some(file_id),
3106 },
3107 );
3108 log::debug!(
3109 "download_file: sending DownloadFileByPath request, path_str={}",
3110 path_str
3111 );
3112
3113 cx.spawn(async move |_this, _cx| {
3114 log::debug!("download_file: sending request with file_id={}...", file_id);
3115 let response = proto_client
3116 .request(proto::DownloadFileByPath {
3117 project_id,
3118 worktree_id: worktree_id.to_proto(),
3119 path: path_str.clone(),
3120 file_id,
3121 })
3122 .await?;
3123
3124 log::debug!("download_file: got response, file_id={}", response.file_id);
3125 // The file_id is set from the State message, we just confirm the request succeeded
3126 Ok(())
3127 })
3128 }
3129
3130 #[ztracing::instrument(skip_all)]
3131 pub fn open_buffer(
3132 &mut self,
3133 path: impl Into<ProjectPath>,
3134 cx: &mut App,
3135 ) -> Task<Result<Entity<Buffer>>> {
3136 if self.is_disconnected(cx) {
3137 return Task::ready(Err(anyhow!(ErrorCode::Disconnected)));
3138 }
3139
3140 self.buffer_store.update(cx, |buffer_store, cx| {
3141 buffer_store.open_buffer(path.into(), cx)
3142 })
3143 }
3144
3145 #[cfg(feature = "test-support")]
3146 pub fn open_buffer_with_lsp(
3147 &mut self,
3148 path: impl Into<ProjectPath>,
3149 cx: &mut Context<Self>,
3150 ) -> Task<Result<(Entity<Buffer>, lsp_store::OpenLspBufferHandle)>> {
3151 let buffer = self.open_buffer(path, cx);
3152 cx.spawn(async move |this, cx| {
3153 let buffer = buffer.await?;
3154 let handle = this.update(cx, |project, cx| {
3155 project.register_buffer_with_language_servers(&buffer, cx)
3156 })?;
3157 Ok((buffer, handle))
3158 })
3159 }
3160
3161 pub fn register_buffer_with_language_servers(
3162 &self,
3163 buffer: &Entity<Buffer>,
3164 cx: &mut App,
3165 ) -> OpenLspBufferHandle {
3166 self.lsp_store.update(cx, |lsp_store, cx| {
3167 lsp_store.register_buffer_with_language_servers(buffer, HashSet::default(), false, cx)
3168 })
3169 }
3170
3171 pub fn open_unstaged_diff(
3172 &mut self,
3173 buffer: Entity<Buffer>,
3174 cx: &mut Context<Self>,
3175 ) -> Task<Result<Entity<BufferDiff>>> {
3176 if self.is_disconnected(cx) {
3177 return Task::ready(Err(anyhow!(ErrorCode::Disconnected)));
3178 }
3179 self.git_store
3180 .update(cx, |git_store, cx| git_store.open_unstaged_diff(buffer, cx))
3181 }
3182
3183 #[ztracing::instrument(skip_all)]
3184 pub fn open_uncommitted_diff(
3185 &mut self,
3186 buffer: Entity<Buffer>,
3187 cx: &mut Context<Self>,
3188 ) -> Task<Result<Entity<BufferDiff>>> {
3189 if self.is_disconnected(cx) {
3190 return Task::ready(Err(anyhow!(ErrorCode::Disconnected)));
3191 }
3192 self.git_store.update(cx, |git_store, cx| {
3193 git_store.open_uncommitted_diff(buffer, cx)
3194 })
3195 }
3196
3197 pub fn open_buffer_by_id(
3198 &mut self,
3199 id: BufferId,
3200 cx: &mut Context<Self>,
3201 ) -> Task<Result<Entity<Buffer>>> {
3202 if let Some(buffer) = self.buffer_for_id(id, cx) {
3203 Task::ready(Ok(buffer))
3204 } else if self.is_local() || self.is_via_remote_server() {
3205 Task::ready(Err(anyhow!("buffer {id} does not exist")))
3206 } else if let Some(project_id) = self.remote_id() {
3207 let request = self.collab_client.request(proto::OpenBufferById {
3208 project_id,
3209 id: id.into(),
3210 });
3211 cx.spawn(async move |project, cx| {
3212 let buffer_id = BufferId::new(request.await?.buffer_id)?;
3213 project
3214 .update(cx, |project, cx| {
3215 project.buffer_store.update(cx, |buffer_store, cx| {
3216 buffer_store.wait_for_remote_buffer(buffer_id, cx)
3217 })
3218 })?
3219 .await
3220 })
3221 } else {
3222 Task::ready(Err(anyhow!("cannot open buffer while disconnected")))
3223 }
3224 }
3225
3226 pub fn save_buffers(
3227 &self,
3228 buffers: HashSet<Entity<Buffer>>,
3229 cx: &mut Context<Self>,
3230 ) -> Task<Result<()>> {
3231 cx.spawn(async move |this, cx| {
3232 let save_tasks = buffers.into_iter().filter_map(|buffer| {
3233 this.update(cx, |this, cx| this.save_buffer(buffer, cx))
3234 .ok()
3235 });
3236 try_join_all(save_tasks).await?;
3237 Ok(())
3238 })
3239 }
3240
3241 pub fn save_buffer(&self, buffer: Entity<Buffer>, cx: &mut Context<Self>) -> Task<Result<()>> {
3242 self.buffer_store
3243 .update(cx, |buffer_store, cx| buffer_store.save_buffer(buffer, cx))
3244 }
3245
3246 pub fn save_buffer_as(
3247 &mut self,
3248 buffer: Entity<Buffer>,
3249 path: ProjectPath,
3250 cx: &mut Context<Self>,
3251 ) -> Task<Result<()>> {
3252 self.buffer_store.update(cx, |buffer_store, cx| {
3253 buffer_store.save_buffer_as(buffer.clone(), path, cx)
3254 })
3255 }
3256
3257 pub fn get_open_buffer(&self, path: &ProjectPath, cx: &App) -> Option<Entity<Buffer>> {
3258 self.buffer_store.read(cx).get_by_path(path)
3259 }
3260
3261 fn register_buffer(&mut self, buffer: &Entity<Buffer>, cx: &mut Context<Self>) -> Result<()> {
3262 {
3263 let mut remotely_created_models = self.remotely_created_models.lock();
3264 if remotely_created_models.retain_count > 0 {
3265 remotely_created_models.buffers.push(buffer.clone())
3266 }
3267 }
3268
3269 self.request_buffer_diff_recalculation(buffer, cx);
3270
3271 cx.subscribe(buffer, |this, buffer, event, cx| {
3272 this.on_buffer_event(buffer, event, cx);
3273 })
3274 .detach();
3275
3276 Ok(())
3277 }
3278
3279 pub fn open_image(
3280 &mut self,
3281 path: impl Into<ProjectPath>,
3282 cx: &mut Context<Self>,
3283 ) -> Task<Result<Entity<ImageItem>>> {
3284 if self.is_disconnected(cx) {
3285 return Task::ready(Err(anyhow!(ErrorCode::Disconnected)));
3286 }
3287
3288 let open_image_task = self.image_store.update(cx, |image_store, cx| {
3289 image_store.open_image(path.into(), cx)
3290 });
3291
3292 let weak_project = cx.entity().downgrade();
3293 cx.spawn(async move |_, cx| {
3294 let image_item = open_image_task.await?;
3295
3296 // Check if metadata already exists (e.g., for remote images)
3297 let needs_metadata =
3298 cx.read_entity(&image_item, |item, _| item.image_metadata.is_none());
3299
3300 if needs_metadata {
3301 let project = weak_project.upgrade().context("Project dropped")?;
3302 let metadata =
3303 ImageItem::load_image_metadata(image_item.clone(), project, cx).await?;
3304 image_item.update(cx, |image_item, cx| {
3305 image_item.image_metadata = Some(metadata);
3306 cx.emit(ImageItemEvent::MetadataUpdated);
3307 });
3308 }
3309
3310 Ok(image_item)
3311 })
3312 }
3313
3314 async fn send_buffer_ordered_messages(
3315 project: WeakEntity<Self>,
3316 rx: UnboundedReceiver<BufferOrderedMessage>,
3317 cx: &mut AsyncApp,
3318 ) -> Result<()> {
3319 const MAX_BATCH_SIZE: usize = 128;
3320
3321 let mut operations_by_buffer_id = HashMap::default();
3322 async fn flush_operations(
3323 this: &WeakEntity<Project>,
3324 operations_by_buffer_id: &mut HashMap<BufferId, Vec<proto::Operation>>,
3325 needs_resync_with_host: &mut bool,
3326 is_local: bool,
3327 cx: &mut AsyncApp,
3328 ) -> Result<()> {
3329 for (buffer_id, operations) in operations_by_buffer_id.drain() {
3330 let request = this.read_with(cx, |this, _| {
3331 let project_id = this.remote_id()?;
3332 Some(this.collab_client.request(proto::UpdateBuffer {
3333 buffer_id: buffer_id.into(),
3334 project_id,
3335 operations,
3336 }))
3337 })?;
3338 if let Some(request) = request
3339 && request.await.is_err()
3340 && !is_local
3341 {
3342 *needs_resync_with_host = true;
3343 break;
3344 }
3345 }
3346 Ok(())
3347 }
3348
3349 let mut needs_resync_with_host = false;
3350 let mut changes = rx.ready_chunks(MAX_BATCH_SIZE);
3351
3352 while let Some(changes) = changes.next().await {
3353 let is_local = project.read_with(cx, |this, _| this.is_local())?;
3354
3355 for change in changes {
3356 match change {
3357 BufferOrderedMessage::Operation {
3358 buffer_id,
3359 operation,
3360 } => {
3361 if needs_resync_with_host {
3362 continue;
3363 }
3364
3365 operations_by_buffer_id
3366 .entry(buffer_id)
3367 .or_insert(Vec::new())
3368 .push(operation);
3369 }
3370
3371 BufferOrderedMessage::Resync => {
3372 operations_by_buffer_id.clear();
3373 if project
3374 .update(cx, |this, cx| this.synchronize_remote_buffers(cx))?
3375 .await
3376 .is_ok()
3377 {
3378 needs_resync_with_host = false;
3379 }
3380 }
3381
3382 BufferOrderedMessage::LanguageServerUpdate {
3383 language_server_id,
3384 message,
3385 name,
3386 } => {
3387 flush_operations(
3388 &project,
3389 &mut operations_by_buffer_id,
3390 &mut needs_resync_with_host,
3391 is_local,
3392 cx,
3393 )
3394 .await?;
3395
3396 project.read_with(cx, |project, _| {
3397 if let Some(project_id) = project.remote_id() {
3398 project
3399 .collab_client
3400 .send(proto::UpdateLanguageServer {
3401 project_id,
3402 server_name: name.map(|name| String::from(name.0)),
3403 language_server_id: language_server_id.to_proto(),
3404 variant: Some(message),
3405 })
3406 .log_err();
3407 }
3408 })?;
3409 }
3410 }
3411 }
3412
3413 flush_operations(
3414 &project,
3415 &mut operations_by_buffer_id,
3416 &mut needs_resync_with_host,
3417 is_local,
3418 cx,
3419 )
3420 .await?;
3421 }
3422
3423 Ok(())
3424 }
3425
3426 fn on_buffer_store_event(
3427 &mut self,
3428 _: Entity<BufferStore>,
3429 event: &BufferStoreEvent,
3430 cx: &mut Context<Self>,
3431 ) {
3432 match event {
3433 BufferStoreEvent::BufferAdded(buffer) => {
3434 self.register_buffer(buffer, cx).log_err();
3435 }
3436 BufferStoreEvent::BufferDropped(buffer_id) => {
3437 if let Some(ref remote_client) = self.remote_client {
3438 remote_client
3439 .read(cx)
3440 .proto_client()
3441 .send(proto::CloseBuffer {
3442 project_id: 0,
3443 buffer_id: buffer_id.to_proto(),
3444 })
3445 .log_err();
3446 }
3447 }
3448 _ => {}
3449 }
3450 }
3451
3452 fn on_image_store_event(
3453 &mut self,
3454 _: Entity<ImageStore>,
3455 event: &ImageStoreEvent,
3456 cx: &mut Context<Self>,
3457 ) {
3458 match event {
3459 ImageStoreEvent::ImageAdded(image) => {
3460 cx.subscribe(image, |this, image, event, cx| {
3461 this.on_image_event(image, event, cx);
3462 })
3463 .detach();
3464 }
3465 }
3466 }
3467
3468 fn on_dap_store_event(
3469 &mut self,
3470 _: Entity<DapStore>,
3471 event: &DapStoreEvent,
3472 cx: &mut Context<Self>,
3473 ) {
3474 if let DapStoreEvent::Notification(message) = event {
3475 cx.emit(Event::Toast {
3476 notification_id: "dap".into(),
3477 message: message.clone(),
3478 link: None,
3479 });
3480 }
3481 }
3482
3483 fn on_lsp_store_event(
3484 &mut self,
3485 _: Entity<LspStore>,
3486 event: &LspStoreEvent,
3487 cx: &mut Context<Self>,
3488 ) {
3489 match event {
3490 LspStoreEvent::DiagnosticsUpdated { server_id, paths } => {
3491 cx.emit(Event::DiagnosticsUpdated {
3492 paths: paths.clone(),
3493 language_server_id: *server_id,
3494 })
3495 }
3496 LspStoreEvent::LanguageServerAdded(server_id, name, worktree_id) => cx.emit(
3497 Event::LanguageServerAdded(*server_id, name.clone(), *worktree_id),
3498 ),
3499 LspStoreEvent::LanguageServerRemoved(server_id) => {
3500 cx.emit(Event::LanguageServerRemoved(*server_id))
3501 }
3502 LspStoreEvent::LanguageServerLog(server_id, log_type, string) => cx.emit(
3503 Event::LanguageServerLog(*server_id, log_type.clone(), string.clone()),
3504 ),
3505 LspStoreEvent::LanguageDetected {
3506 buffer,
3507 new_language,
3508 } => {
3509 let Some(_) = new_language else {
3510 cx.emit(Event::LanguageNotFound(buffer.clone()));
3511 return;
3512 };
3513 }
3514 LspStoreEvent::RefreshInlayHints {
3515 server_id,
3516 request_id,
3517 } => cx.emit(Event::RefreshInlayHints {
3518 server_id: *server_id,
3519 request_id: *request_id,
3520 }),
3521 LspStoreEvent::RefreshSemanticTokens {
3522 server_id,
3523 request_id,
3524 } => cx.emit(Event::RefreshSemanticTokens {
3525 server_id: *server_id,
3526 request_id: *request_id,
3527 }),
3528 LspStoreEvent::RefreshCodeLens => cx.emit(Event::RefreshCodeLens),
3529 LspStoreEvent::LanguageServerPrompt(prompt) => {
3530 cx.emit(Event::LanguageServerPrompt(prompt.clone()))
3531 }
3532 LspStoreEvent::DiskBasedDiagnosticsStarted { language_server_id } => {
3533 cx.emit(Event::DiskBasedDiagnosticsStarted {
3534 language_server_id: *language_server_id,
3535 });
3536 }
3537 LspStoreEvent::DiskBasedDiagnosticsFinished { language_server_id } => {
3538 cx.emit(Event::DiskBasedDiagnosticsFinished {
3539 language_server_id: *language_server_id,
3540 });
3541 }
3542 LspStoreEvent::LanguageServerUpdate {
3543 language_server_id,
3544 name,
3545 message,
3546 } => {
3547 if self.is_local() {
3548 self.enqueue_buffer_ordered_message(
3549 BufferOrderedMessage::LanguageServerUpdate {
3550 language_server_id: *language_server_id,
3551 message: message.clone(),
3552 name: name.clone(),
3553 },
3554 )
3555 .ok();
3556 }
3557
3558 match message {
3559 proto::update_language_server::Variant::MetadataUpdated(update) => {
3560 self.lsp_store.update(cx, |lsp_store, _| {
3561 if let Some(capabilities) = update
3562 .capabilities
3563 .as_ref()
3564 .and_then(|capabilities| serde_json::from_str(capabilities).ok())
3565 {
3566 lsp_store
3567 .lsp_server_capabilities
3568 .insert(*language_server_id, capabilities);
3569 }
3570
3571 if let Some(language_server_status) = lsp_store
3572 .language_server_statuses
3573 .get_mut(language_server_id)
3574 {
3575 if let Some(binary) = &update.binary {
3576 language_server_status.binary = Some(LanguageServerBinary {
3577 path: PathBuf::from(&binary.path),
3578 arguments: binary
3579 .arguments
3580 .iter()
3581 .map(OsString::from)
3582 .collect(),
3583 env: None,
3584 });
3585 }
3586
3587 language_server_status.configuration = update
3588 .configuration
3589 .as_ref()
3590 .and_then(|config_str| serde_json::from_str(config_str).ok());
3591
3592 language_server_status.workspace_folders = update
3593 .workspace_folders
3594 .iter()
3595 .filter_map(|uri_str| lsp::Uri::from_str(uri_str).ok())
3596 .collect();
3597 }
3598 });
3599 }
3600 proto::update_language_server::Variant::RegisteredForBuffer(update) => {
3601 if let Some(buffer_id) = BufferId::new(update.buffer_id).ok() {
3602 cx.emit(Event::LanguageServerBufferRegistered {
3603 buffer_id,
3604 server_id: *language_server_id,
3605 buffer_abs_path: PathBuf::from(&update.buffer_abs_path),
3606 name: name.clone(),
3607 });
3608 }
3609 }
3610 _ => (),
3611 }
3612 }
3613 LspStoreEvent::Notification(message) => cx.emit(Event::Toast {
3614 notification_id: "lsp".into(),
3615 message: message.clone(),
3616 link: None,
3617 }),
3618 LspStoreEvent::SnippetEdit {
3619 buffer_id,
3620 edits,
3621 most_recent_edit,
3622 } => {
3623 if most_recent_edit.replica_id == self.replica_id() {
3624 cx.emit(Event::SnippetEdit(*buffer_id, edits.clone()))
3625 }
3626 }
3627 LspStoreEvent::WorkspaceEditApplied(transaction) => {
3628 cx.emit(Event::WorkspaceEditApplied(transaction.clone()))
3629 }
3630 }
3631 }
3632
3633 fn on_remote_client_event(
3634 &mut self,
3635 _: Entity<RemoteClient>,
3636 event: &remote::RemoteClientEvent,
3637 cx: &mut Context<Self>,
3638 ) {
3639 match event {
3640 &remote::RemoteClientEvent::Disconnected { server_not_running } => {
3641 self.worktree_store.update(cx, |store, cx| {
3642 store.disconnected_from_host(cx);
3643 });
3644 self.buffer_store.update(cx, |buffer_store, cx| {
3645 buffer_store.disconnected_from_host(cx)
3646 });
3647 self.lsp_store.update(cx, |lsp_store, _cx| {
3648 lsp_store.disconnected_from_ssh_remote()
3649 });
3650 cx.emit(Event::DisconnectedFromRemote { server_not_running });
3651 }
3652 }
3653 }
3654
3655 fn on_settings_observer_event(
3656 &mut self,
3657 _: Entity<SettingsObserver>,
3658 event: &SettingsObserverEvent,
3659 cx: &mut Context<Self>,
3660 ) {
3661 match event {
3662 SettingsObserverEvent::LocalSettingsUpdated(result) => match result {
3663 Err(InvalidSettingsError::LocalSettings { message, path }) => {
3664 let message = format!("Failed to set local settings in {path:?}:\n{message}");
3665 cx.emit(Event::Toast {
3666 notification_id: format!("local-settings-{path:?}").into(),
3667 link: None,
3668 message,
3669 });
3670 }
3671 Ok(path) => cx.emit(Event::HideToast {
3672 notification_id: format!("local-settings-{path:?}").into(),
3673 }),
3674 Err(_) => {}
3675 },
3676 SettingsObserverEvent::LocalTasksUpdated(result) => match result {
3677 Err(InvalidSettingsError::Tasks { message, path }) => {
3678 let message = format!("Failed to set local tasks in {path:?}:\n{message}");
3679 cx.emit(Event::Toast {
3680 notification_id: format!("local-tasks-{path:?}").into(),
3681 link: Some(ToastLink {
3682 label: "Open Tasks Documentation",
3683 url: "https://zed.dev/docs/tasks",
3684 }),
3685 message,
3686 });
3687 }
3688 Ok(path) => cx.emit(Event::HideToast {
3689 notification_id: format!("local-tasks-{path:?}").into(),
3690 }),
3691 Err(_) => {}
3692 },
3693 SettingsObserverEvent::LocalDebugScenariosUpdated(result) => match result {
3694 Err(InvalidSettingsError::Debug { message, path }) => {
3695 let message =
3696 format!("Failed to set local debug scenarios in {path:?}:\n{message}");
3697 cx.emit(Event::Toast {
3698 notification_id: format!("local-debug-scenarios-{path:?}").into(),
3699 link: None,
3700 message,
3701 });
3702 }
3703 Ok(path) => cx.emit(Event::HideToast {
3704 notification_id: format!("local-debug-scenarios-{path:?}").into(),
3705 }),
3706 Err(_) => {}
3707 },
3708 }
3709 }
3710
3711 fn on_worktree_store_event(
3712 &mut self,
3713 _: Entity<WorktreeStore>,
3714 event: &WorktreeStoreEvent,
3715 cx: &mut Context<Self>,
3716 ) {
3717 match event {
3718 WorktreeStoreEvent::WorktreeAdded(worktree) => {
3719 self.on_worktree_added(worktree, cx);
3720 cx.emit(Event::WorktreeAdded(worktree.read(cx).id()));
3721 self.emit_group_key_changed_if_needed(cx);
3722 }
3723 WorktreeStoreEvent::WorktreeRemoved(_, id) => {
3724 cx.emit(Event::WorktreeRemoved(*id));
3725 self.emit_group_key_changed_if_needed(cx);
3726 }
3727 WorktreeStoreEvent::WorktreeReleased(_, id) => {
3728 self.on_worktree_released(*id, cx);
3729 }
3730 WorktreeStoreEvent::WorktreeOrderChanged => cx.emit(Event::WorktreeOrderChanged),
3731 WorktreeStoreEvent::WorktreeUpdateSent(_) => {}
3732 WorktreeStoreEvent::WorktreeUpdatedEntries(worktree_id, changes) => {
3733 self.client()
3734 .telemetry()
3735 .report_discovered_project_type_events(*worktree_id, changes);
3736 cx.emit(Event::WorktreeUpdatedEntries(*worktree_id, changes.clone()))
3737 }
3738 WorktreeStoreEvent::WorktreeDeletedEntry(worktree_id, id) => {
3739 cx.emit(Event::DeletedEntry(*worktree_id, *id))
3740 }
3741 // Listen to the GitStore instead.
3742 WorktreeStoreEvent::WorktreeUpdatedGitRepositories(_, _) => {}
3743 WorktreeStoreEvent::WorktreeUpdatedRootRepoCommonDir(worktree_id) => {
3744 cx.emit(Event::WorktreeUpdatedRootRepoCommonDir(*worktree_id));
3745 self.emit_group_key_changed_if_needed(cx);
3746 }
3747 }
3748 }
3749
3750 fn on_worktree_added(&mut self, worktree: &Entity<Worktree>, _: &mut Context<Self>) {
3751 let mut remotely_created_models = self.remotely_created_models.lock();
3752 if remotely_created_models.retain_count > 0 {
3753 remotely_created_models.worktrees.push(worktree.clone())
3754 }
3755 }
3756
3757 fn on_worktree_released(&mut self, id_to_remove: WorktreeId, cx: &mut Context<Self>) {
3758 if let Some(remote) = &self.remote_client {
3759 remote
3760 .read(cx)
3761 .proto_client()
3762 .send(proto::RemoveWorktree {
3763 worktree_id: id_to_remove.to_proto(),
3764 })
3765 .log_err();
3766 }
3767 }
3768
3769 fn on_buffer_event(
3770 &mut self,
3771 buffer: Entity<Buffer>,
3772 event: &BufferEvent,
3773 cx: &mut Context<Self>,
3774 ) -> Option<()> {
3775 if matches!(event, BufferEvent::Edited { .. } | BufferEvent::Reloaded) {
3776 self.request_buffer_diff_recalculation(&buffer, cx);
3777 }
3778
3779 if matches!(event, BufferEvent::Edited { .. }) {
3780 cx.emit(Event::BufferEdited);
3781 }
3782
3783 let buffer_id = buffer.read(cx).remote_id();
3784 match event {
3785 BufferEvent::ReloadNeeded => {
3786 if !self.is_via_collab() {
3787 self.reload_buffers([buffer.clone()].into_iter().collect(), true, cx)
3788 .detach_and_log_err(cx);
3789 }
3790 }
3791 BufferEvent::Operation {
3792 operation,
3793 is_local: true,
3794 } => {
3795 let operation = language::proto::serialize_operation(operation);
3796
3797 if let Some(remote) = &self.remote_client {
3798 remote
3799 .read(cx)
3800 .proto_client()
3801 .send(proto::UpdateBuffer {
3802 project_id: 0,
3803 buffer_id: buffer_id.to_proto(),
3804 operations: vec![operation.clone()],
3805 })
3806 .ok();
3807 }
3808
3809 self.enqueue_buffer_ordered_message(BufferOrderedMessage::Operation {
3810 buffer_id,
3811 operation,
3812 })
3813 .ok();
3814 }
3815
3816 _ => {}
3817 }
3818
3819 None
3820 }
3821
3822 fn on_image_event(
3823 &mut self,
3824 image: Entity<ImageItem>,
3825 event: &ImageItemEvent,
3826 cx: &mut Context<Self>,
3827 ) -> Option<()> {
3828 // TODO: handle image events from remote
3829 if let ImageItemEvent::ReloadNeeded = event
3830 && !self.is_via_collab()
3831 {
3832 self.reload_images([image].into_iter().collect(), cx)
3833 .detach_and_log_err(cx);
3834 }
3835
3836 None
3837 }
3838
3839 fn request_buffer_diff_recalculation(
3840 &mut self,
3841 buffer: &Entity<Buffer>,
3842 cx: &mut Context<Self>,
3843 ) {
3844 self.buffers_needing_diff.insert(buffer.downgrade());
3845 let first_insertion = self.buffers_needing_diff.len() == 1;
3846 let settings = ProjectSettings::get_global(cx);
3847 let delay = settings.git.gutter_debounce;
3848
3849 if delay == 0 {
3850 if first_insertion {
3851 let this = cx.weak_entity();
3852 cx.defer(move |cx| {
3853 if let Some(this) = this.upgrade() {
3854 this.update(cx, |this, cx| {
3855 this.recalculate_buffer_diffs(cx).detach();
3856 });
3857 }
3858 });
3859 }
3860 return;
3861 }
3862
3863 const MIN_DELAY: u64 = 50;
3864 let delay = delay.max(MIN_DELAY);
3865 let duration = Duration::from_millis(delay);
3866
3867 self.git_diff_debouncer
3868 .fire_new(duration, cx, move |this, cx| {
3869 this.recalculate_buffer_diffs(cx)
3870 });
3871 }
3872
3873 fn recalculate_buffer_diffs(&mut self, cx: &mut Context<Self>) -> Task<()> {
3874 cx.spawn(async move |this, cx| {
3875 loop {
3876 let task = this
3877 .update(cx, |this, cx| {
3878 let buffers = this
3879 .buffers_needing_diff
3880 .drain()
3881 .filter_map(|buffer| buffer.upgrade())
3882 .collect::<Vec<_>>();
3883 if buffers.is_empty() {
3884 None
3885 } else {
3886 Some(this.git_store.update(cx, |git_store, cx| {
3887 git_store.recalculate_buffer_diffs(buffers, cx)
3888 }))
3889 }
3890 })
3891 .ok()
3892 .flatten();
3893
3894 if let Some(task) = task {
3895 task.await;
3896 } else {
3897 break;
3898 }
3899 }
3900 })
3901 }
3902
3903 pub fn set_language_for_buffer(
3904 &mut self,
3905 buffer: &Entity<Buffer>,
3906 new_language: Arc<Language>,
3907 cx: &mut Context<Self>,
3908 ) {
3909 self.lsp_store.update(cx, |lsp_store, cx| {
3910 lsp_store.set_language_for_buffer(buffer, new_language, cx)
3911 })
3912 }
3913
3914 pub fn restart_language_servers_for_buffers(
3915 &mut self,
3916 buffers: Vec<Entity<Buffer>>,
3917 only_restart_servers: HashSet<LanguageServerSelector>,
3918 cx: &mut Context<Self>,
3919 ) {
3920 self.lsp_store.update(cx, |lsp_store, cx| {
3921 lsp_store.restart_language_servers_for_buffers(buffers, only_restart_servers, cx)
3922 })
3923 }
3924
3925 pub fn stop_language_servers_for_buffers(
3926 &mut self,
3927 buffers: Vec<Entity<Buffer>>,
3928 also_restart_servers: HashSet<LanguageServerSelector>,
3929 cx: &mut Context<Self>,
3930 ) {
3931 self.lsp_store
3932 .update(cx, |lsp_store, cx| {
3933 lsp_store.stop_language_servers_for_buffers(buffers, also_restart_servers, cx)
3934 })
3935 .detach_and_log_err(cx);
3936 }
3937
3938 pub fn cancel_language_server_work_for_buffers(
3939 &mut self,
3940 buffers: impl IntoIterator<Item = Entity<Buffer>>,
3941 cx: &mut Context<Self>,
3942 ) {
3943 self.lsp_store.update(cx, |lsp_store, cx| {
3944 lsp_store.cancel_language_server_work_for_buffers(buffers, cx)
3945 })
3946 }
3947
3948 pub fn cancel_language_server_work(
3949 &mut self,
3950 server_id: LanguageServerId,
3951 token_to_cancel: Option<ProgressToken>,
3952 cx: &mut Context<Self>,
3953 ) {
3954 self.lsp_store.update(cx, |lsp_store, cx| {
3955 lsp_store.cancel_language_server_work(server_id, token_to_cancel, cx)
3956 })
3957 }
3958
3959 fn enqueue_buffer_ordered_message(&mut self, message: BufferOrderedMessage) -> Result<()> {
3960 self.buffer_ordered_messages_tx
3961 .unbounded_send(message)
3962 .map_err(|e| anyhow!(e))
3963 }
3964
3965 pub fn available_toolchains(
3966 &self,
3967 path: ProjectPath,
3968 language_name: LanguageName,
3969 cx: &App,
3970 ) -> Task<Option<Toolchains>> {
3971 if let Some(toolchain_store) = self.toolchain_store.as_ref().map(Entity::downgrade) {
3972 cx.spawn(async move |cx| {
3973 toolchain_store
3974 .update(cx, |this, cx| this.list_toolchains(path, language_name, cx))
3975 .ok()?
3976 .await
3977 })
3978 } else {
3979 Task::ready(None)
3980 }
3981 }
3982
3983 pub async fn toolchain_metadata(
3984 languages: Arc<LanguageRegistry>,
3985 language_name: LanguageName,
3986 ) -> Option<ToolchainMetadata> {
3987 languages
3988 .language_for_name(language_name.as_ref())
3989 .await
3990 .ok()?
3991 .toolchain_lister()
3992 .map(|lister| lister.meta())
3993 }
3994
3995 pub fn add_toolchain(
3996 &self,
3997 toolchain: Toolchain,
3998 scope: ToolchainScope,
3999 cx: &mut Context<Self>,
4000 ) {
4001 maybe!({
4002 self.toolchain_store.as_ref()?.update(cx, |this, cx| {
4003 this.add_toolchain(toolchain, scope, cx);
4004 });
4005 Some(())
4006 });
4007 }
4008
4009 pub fn remove_toolchain(
4010 &self,
4011 toolchain: Toolchain,
4012 scope: ToolchainScope,
4013 cx: &mut Context<Self>,
4014 ) {
4015 maybe!({
4016 self.toolchain_store.as_ref()?.update(cx, |this, cx| {
4017 this.remove_toolchain(toolchain, scope, cx);
4018 });
4019 Some(())
4020 });
4021 }
4022
4023 pub fn user_toolchains(
4024 &self,
4025 cx: &App,
4026 ) -> Option<BTreeMap<ToolchainScope, IndexSet<Toolchain>>> {
4027 Some(self.toolchain_store.as_ref()?.read(cx).user_toolchains())
4028 }
4029
4030 pub fn resolve_toolchain(
4031 &self,
4032 path: PathBuf,
4033 language_name: LanguageName,
4034 cx: &App,
4035 ) -> Task<Result<Toolchain>> {
4036 if let Some(toolchain_store) = self.toolchain_store.as_ref().map(Entity::downgrade) {
4037 cx.spawn(async move |cx| {
4038 toolchain_store
4039 .update(cx, |this, cx| {
4040 this.resolve_toolchain(path, language_name, cx)
4041 })?
4042 .await
4043 })
4044 } else {
4045 Task::ready(Err(anyhow!("This project does not support toolchains")))
4046 }
4047 }
4048
4049 pub fn toolchain_store(&self) -> Option<Entity<ToolchainStore>> {
4050 self.toolchain_store.clone()
4051 }
4052 pub fn activate_toolchain(
4053 &self,
4054 path: ProjectPath,
4055 toolchain: Toolchain,
4056 cx: &mut App,
4057 ) -> Task<Option<()>> {
4058 let Some(toolchain_store) = self.toolchain_store.clone() else {
4059 return Task::ready(None);
4060 };
4061 toolchain_store.update(cx, |this, cx| this.activate_toolchain(path, toolchain, cx))
4062 }
4063 pub fn active_toolchain(
4064 &self,
4065 path: ProjectPath,
4066 language_name: LanguageName,
4067 cx: &App,
4068 ) -> Task<Option<Toolchain>> {
4069 let Some(toolchain_store) = self.toolchain_store.clone() else {
4070 return Task::ready(None);
4071 };
4072 toolchain_store
4073 .read(cx)
4074 .active_toolchain(path, language_name, cx)
4075 }
4076 pub fn language_server_statuses<'a>(
4077 &'a self,
4078 cx: &'a App,
4079 ) -> impl DoubleEndedIterator<Item = (LanguageServerId, &'a LanguageServerStatus)> {
4080 self.lsp_store.read(cx).language_server_statuses()
4081 }
4082
4083 pub fn last_formatting_failure<'a>(&self, cx: &'a App) -> Option<&'a str> {
4084 self.lsp_store.read(cx).last_formatting_failure()
4085 }
4086
4087 pub fn reset_last_formatting_failure(&self, cx: &mut App) {
4088 self.lsp_store
4089 .update(cx, |store, _| store.reset_last_formatting_failure());
4090 }
4091
4092 pub fn reload_buffers(
4093 &self,
4094 buffers: HashSet<Entity<Buffer>>,
4095 push_to_history: bool,
4096 cx: &mut Context<Self>,
4097 ) -> Task<Result<ProjectTransaction>> {
4098 self.buffer_store.update(cx, |buffer_store, cx| {
4099 buffer_store.reload_buffers(buffers, push_to_history, cx)
4100 })
4101 }
4102
4103 pub fn reload_images(
4104 &self,
4105 images: HashSet<Entity<ImageItem>>,
4106 cx: &mut Context<Self>,
4107 ) -> Task<Result<()>> {
4108 self.image_store
4109 .update(cx, |image_store, cx| image_store.reload_images(images, cx))
4110 }
4111
4112 pub fn format(
4113 &mut self,
4114 buffers: HashSet<Entity<Buffer>>,
4115 target: LspFormatTarget,
4116 push_to_history: bool,
4117 trigger: lsp_store::FormatTrigger,
4118 cx: &mut Context<Project>,
4119 ) -> Task<anyhow::Result<ProjectTransaction>> {
4120 self.lsp_store.update(cx, |lsp_store, cx| {
4121 lsp_store.format(buffers, target, push_to_history, trigger, cx)
4122 })
4123 }
4124
4125 pub fn supports_range_formatting(&self, buffer: &Entity<Buffer>, cx: &App) -> bool {
4126 self.lsp_store
4127 .read(cx)
4128 .supports_range_formatting(buffer, cx)
4129 }
4130
4131 pub fn definitions<T: ToPointUtf16>(
4132 &mut self,
4133 buffer: &Entity<Buffer>,
4134 position: T,
4135 cx: &mut Context<Self>,
4136 ) -> Task<Result<Option<Vec<LocationLink>>>> {
4137 let position = position.to_point_utf16(buffer.read(cx));
4138 let guard = self.retain_remotely_created_models(cx);
4139 let task = self.lsp_store.update(cx, |lsp_store, cx| {
4140 lsp_store.definitions(buffer, position, cx)
4141 });
4142 cx.background_spawn(async move {
4143 let result = task.await;
4144 drop(guard);
4145 result
4146 })
4147 }
4148
4149 pub fn declarations<T: ToPointUtf16>(
4150 &mut self,
4151 buffer: &Entity<Buffer>,
4152 position: T,
4153 cx: &mut Context<Self>,
4154 ) -> Task<Result<Option<Vec<LocationLink>>>> {
4155 let position = position.to_point_utf16(buffer.read(cx));
4156 let guard = self.retain_remotely_created_models(cx);
4157 let task = self.lsp_store.update(cx, |lsp_store, cx| {
4158 lsp_store.declarations(buffer, position, cx)
4159 });
4160 cx.background_spawn(async move {
4161 let result = task.await;
4162 drop(guard);
4163 result
4164 })
4165 }
4166
4167 pub fn type_definitions<T: ToPointUtf16>(
4168 &mut self,
4169 buffer: &Entity<Buffer>,
4170 position: T,
4171 cx: &mut Context<Self>,
4172 ) -> Task<Result<Option<Vec<LocationLink>>>> {
4173 let position = position.to_point_utf16(buffer.read(cx));
4174 let guard = self.retain_remotely_created_models(cx);
4175 let task = self.lsp_store.update(cx, |lsp_store, cx| {
4176 lsp_store.type_definitions(buffer, position, cx)
4177 });
4178 cx.background_spawn(async move {
4179 let result = task.await;
4180 drop(guard);
4181 result
4182 })
4183 }
4184
4185 pub fn implementations<T: ToPointUtf16>(
4186 &mut self,
4187 buffer: &Entity<Buffer>,
4188 position: T,
4189 cx: &mut Context<Self>,
4190 ) -> Task<Result<Option<Vec<LocationLink>>>> {
4191 let position = position.to_point_utf16(buffer.read(cx));
4192 let guard = self.retain_remotely_created_models(cx);
4193 let task = self.lsp_store.update(cx, |lsp_store, cx| {
4194 lsp_store.implementations(buffer, position, cx)
4195 });
4196 cx.background_spawn(async move {
4197 let result = task.await;
4198 drop(guard);
4199 result
4200 })
4201 }
4202
4203 pub fn references<T: ToPointUtf16>(
4204 &mut self,
4205 buffer: &Entity<Buffer>,
4206 position: T,
4207 cx: &mut Context<Self>,
4208 ) -> Task<Result<Option<Vec<Location>>>> {
4209 let position = position.to_point_utf16(buffer.read(cx));
4210 let guard = self.retain_remotely_created_models(cx);
4211 let task = self.lsp_store.update(cx, |lsp_store, cx| {
4212 lsp_store.references(buffer, position, cx)
4213 });
4214 cx.background_spawn(async move {
4215 let result = task.await;
4216 drop(guard);
4217 result
4218 })
4219 }
4220
4221 pub fn document_highlights<T: ToPointUtf16>(
4222 &mut self,
4223 buffer: &Entity<Buffer>,
4224 position: T,
4225 cx: &mut Context<Self>,
4226 ) -> Task<Result<Vec<DocumentHighlight>>> {
4227 let position = position.to_point_utf16(buffer.read(cx));
4228 self.request_lsp(
4229 buffer.clone(),
4230 LanguageServerToQuery::FirstCapable,
4231 GetDocumentHighlights { position },
4232 cx,
4233 )
4234 }
4235
4236 pub fn document_symbols(
4237 &mut self,
4238 buffer: &Entity<Buffer>,
4239 cx: &mut Context<Self>,
4240 ) -> Task<Result<Vec<DocumentSymbol>>> {
4241 self.request_lsp(
4242 buffer.clone(),
4243 LanguageServerToQuery::FirstCapable,
4244 GetDocumentSymbols,
4245 cx,
4246 )
4247 }
4248
4249 pub fn symbols(&self, query: &str, cx: &mut Context<Self>) -> Task<Result<Vec<Symbol>>> {
4250 self.lsp_store
4251 .update(cx, |lsp_store, cx| lsp_store.symbols(query, cx))
4252 }
4253
4254 pub fn open_buffer_for_symbol(
4255 &mut self,
4256 symbol: &Symbol,
4257 cx: &mut Context<Self>,
4258 ) -> Task<Result<Entity<Buffer>>> {
4259 self.lsp_store.update(cx, |lsp_store, cx| {
4260 lsp_store.open_buffer_for_symbol(symbol, cx)
4261 })
4262 }
4263
4264 pub fn open_server_settings(&mut self, cx: &mut Context<Self>) -> Task<Result<Entity<Buffer>>> {
4265 let guard = self.retain_remotely_created_models(cx);
4266 let Some(remote) = self.remote_client.as_ref() else {
4267 return Task::ready(Err(anyhow!("not an ssh project")));
4268 };
4269
4270 let proto_client = remote.read(cx).proto_client();
4271
4272 cx.spawn(async move |project, cx| {
4273 let buffer = proto_client
4274 .request(proto::OpenServerSettings {
4275 project_id: REMOTE_SERVER_PROJECT_ID,
4276 })
4277 .await?;
4278
4279 let buffer = project
4280 .update(cx, |project, cx| {
4281 project.buffer_store.update(cx, |buffer_store, cx| {
4282 anyhow::Ok(
4283 buffer_store
4284 .wait_for_remote_buffer(BufferId::new(buffer.buffer_id)?, cx),
4285 )
4286 })
4287 })??
4288 .await;
4289
4290 drop(guard);
4291 buffer
4292 })
4293 }
4294
4295 pub fn open_local_buffer_via_lsp(
4296 &mut self,
4297 abs_path: lsp::Uri,
4298 language_server_id: LanguageServerId,
4299 cx: &mut Context<Self>,
4300 ) -> Task<Result<Entity<Buffer>>> {
4301 self.lsp_store.update(cx, |lsp_store, cx| {
4302 lsp_store.open_local_buffer_via_lsp(abs_path, language_server_id, cx)
4303 })
4304 }
4305
4306 pub fn hover<T: ToPointUtf16>(
4307 &self,
4308 buffer: &Entity<Buffer>,
4309 position: T,
4310 cx: &mut Context<Self>,
4311 ) -> Task<Option<Vec<Hover>>> {
4312 let position = position.to_point_utf16(buffer.read(cx));
4313 self.lsp_store
4314 .update(cx, |lsp_store, cx| lsp_store.hover(buffer, position, cx))
4315 }
4316
4317 pub fn linked_edits(
4318 &self,
4319 buffer: &Entity<Buffer>,
4320 position: Anchor,
4321 cx: &mut Context<Self>,
4322 ) -> Task<Result<Vec<Range<Anchor>>>> {
4323 self.lsp_store.update(cx, |lsp_store, cx| {
4324 lsp_store.linked_edits(buffer, position, cx)
4325 })
4326 }
4327
4328 pub fn completions<T: ToOffset + ToPointUtf16>(
4329 &self,
4330 buffer: &Entity<Buffer>,
4331 position: T,
4332 context: CompletionContext,
4333 cx: &mut Context<Self>,
4334 ) -> Task<Result<Vec<CompletionResponse>>> {
4335 let position = position.to_point_utf16(buffer.read(cx));
4336 self.lsp_store.update(cx, |lsp_store, cx| {
4337 lsp_store.completions(buffer, position, context, cx)
4338 })
4339 }
4340
4341 pub fn code_actions<T: Clone + ToOffset>(
4342 &mut self,
4343 buffer_handle: &Entity<Buffer>,
4344 range: Range<T>,
4345 kinds: Option<Vec<CodeActionKind>>,
4346 cx: &mut Context<Self>,
4347 ) -> Task<Result<Option<Vec<CodeAction>>>> {
4348 let buffer = buffer_handle.read(cx);
4349 let range = buffer.anchor_before(range.start)..buffer.anchor_before(range.end);
4350 self.lsp_store.update(cx, |lsp_store, cx| {
4351 lsp_store.code_actions(buffer_handle, range, kinds, cx)
4352 })
4353 }
4354
4355 pub fn code_lens_actions<T: Clone + ToOffset>(
4356 &mut self,
4357 buffer: &Entity<Buffer>,
4358 range: Range<T>,
4359 cx: &mut Context<Self>,
4360 ) -> Task<Result<Option<Vec<CodeAction>>>> {
4361 let snapshot = buffer.read(cx).snapshot();
4362 let range = range.to_point(&snapshot);
4363 let range_start = snapshot.anchor_before(range.start);
4364 let range_end = if range.start == range.end {
4365 range_start
4366 } else {
4367 snapshot.anchor_after(range.end)
4368 };
4369 let range = range_start..range_end;
4370 let code_lens_actions = self
4371 .lsp_store
4372 .update(cx, |lsp_store, cx| lsp_store.code_lens_actions(buffer, cx));
4373
4374 cx.background_spawn(async move {
4375 let mut code_lens_actions = code_lens_actions
4376 .await
4377 .map_err(|e| anyhow!("code lens fetch failed: {e:#}"))?;
4378 if let Some(code_lens_actions) = &mut code_lens_actions {
4379 code_lens_actions.retain(|code_lens_action| {
4380 range
4381 .start
4382 .cmp(&code_lens_action.range.start, &snapshot)
4383 .is_ge()
4384 && range
4385 .end
4386 .cmp(&code_lens_action.range.end, &snapshot)
4387 .is_le()
4388 });
4389 }
4390 Ok(code_lens_actions)
4391 })
4392 }
4393
4394 pub fn apply_code_action(
4395 &self,
4396 buffer_handle: Entity<Buffer>,
4397 action: CodeAction,
4398 push_to_history: bool,
4399 cx: &mut Context<Self>,
4400 ) -> Task<Result<ProjectTransaction>> {
4401 self.lsp_store.update(cx, |lsp_store, cx| {
4402 lsp_store.apply_code_action(buffer_handle, action, push_to_history, cx)
4403 })
4404 }
4405
4406 pub fn apply_code_action_kind(
4407 &self,
4408 buffers: HashSet<Entity<Buffer>>,
4409 kind: CodeActionKind,
4410 push_to_history: bool,
4411 cx: &mut Context<Self>,
4412 ) -> Task<Result<ProjectTransaction>> {
4413 self.lsp_store.update(cx, |lsp_store, cx| {
4414 lsp_store.apply_code_action_kind(buffers, kind, push_to_history, cx)
4415 })
4416 }
4417
4418 pub fn prepare_rename<T: ToPointUtf16>(
4419 &mut self,
4420 buffer: Entity<Buffer>,
4421 position: T,
4422 cx: &mut Context<Self>,
4423 ) -> Task<Result<PrepareRenameResponse>> {
4424 let position = position.to_point_utf16(buffer.read(cx));
4425 self.request_lsp(
4426 buffer,
4427 LanguageServerToQuery::FirstCapable,
4428 PrepareRename { position },
4429 cx,
4430 )
4431 }
4432
4433 pub fn perform_rename<T: ToPointUtf16>(
4434 &mut self,
4435 buffer: Entity<Buffer>,
4436 position: T,
4437 new_name: String,
4438 cx: &mut Context<Self>,
4439 ) -> Task<Result<ProjectTransaction>> {
4440 let push_to_history = true;
4441 let position = position.to_point_utf16(buffer.read(cx));
4442 self.request_lsp(
4443 buffer,
4444 LanguageServerToQuery::FirstCapable,
4445 PerformRename {
4446 position,
4447 new_name,
4448 push_to_history,
4449 },
4450 cx,
4451 )
4452 }
4453
4454 pub fn on_type_format<T: ToPointUtf16>(
4455 &mut self,
4456 buffer: Entity<Buffer>,
4457 position: T,
4458 trigger: String,
4459 push_to_history: bool,
4460 cx: &mut Context<Self>,
4461 ) -> Task<Result<Option<Transaction>>> {
4462 self.lsp_store.update(cx, |lsp_store, cx| {
4463 lsp_store.on_type_format(buffer, position, trigger, push_to_history, cx)
4464 })
4465 }
4466
4467 pub fn inline_values(
4468 &mut self,
4469 session: Entity<Session>,
4470 active_stack_frame: ActiveStackFrame,
4471 buffer_handle: Entity<Buffer>,
4472 range: Range<text::Anchor>,
4473 cx: &mut Context<Self>,
4474 ) -> Task<anyhow::Result<Vec<InlayHint>>> {
4475 let snapshot = buffer_handle.read(cx).snapshot();
4476
4477 let captures =
4478 snapshot.debug_variables_query(Anchor::min_for_buffer(snapshot.remote_id())..range.end);
4479
4480 let row = snapshot
4481 .summary_for_anchor::<text::PointUtf16>(&range.end)
4482 .row as usize;
4483
4484 let inline_value_locations = provide_inline_values(captures, &snapshot, row);
4485
4486 let stack_frame_id = active_stack_frame.stack_frame_id;
4487 cx.spawn(async move |this, cx| {
4488 this.update(cx, |project, cx| {
4489 project.dap_store().update(cx, |dap_store, cx| {
4490 dap_store.resolve_inline_value_locations(
4491 session,
4492 stack_frame_id,
4493 buffer_handle,
4494 inline_value_locations,
4495 cx,
4496 )
4497 })
4498 })?
4499 .await
4500 })
4501 }
4502
4503 fn search_impl(&mut self, query: SearchQuery, cx: &mut Context<Self>) -> SearchResultsHandle {
4504 let client: Option<(AnyProtoClient, _)> = if let Some(ssh_client) = &self.remote_client {
4505 Some((ssh_client.read(cx).proto_client(), 0))
4506 } else if let Some(remote_id) = self.remote_id() {
4507 self.is_local()
4508 .not()
4509 .then(|| (self.collab_client.clone().into(), remote_id))
4510 } else {
4511 None
4512 };
4513 let searcher = if query.is_opened_only() {
4514 project_search::Search::open_buffers_only(
4515 self.buffer_store.clone(),
4516 self.worktree_store.clone(),
4517 project_search::Search::MAX_SEARCH_RESULT_FILES + 1,
4518 )
4519 } else {
4520 match client {
4521 Some((client, remote_id)) => project_search::Search::remote(
4522 self.buffer_store.clone(),
4523 self.worktree_store.clone(),
4524 project_search::Search::MAX_SEARCH_RESULT_FILES + 1,
4525 (client, remote_id, self.remotely_created_models.clone()),
4526 ),
4527 None => project_search::Search::local(
4528 self.fs.clone(),
4529 self.buffer_store.clone(),
4530 self.worktree_store.clone(),
4531 project_search::Search::MAX_SEARCH_RESULT_FILES + 1,
4532 cx,
4533 ),
4534 }
4535 };
4536 searcher.into_handle(query, cx)
4537 }
4538
4539 pub fn search(
4540 &mut self,
4541 query: SearchQuery,
4542 cx: &mut Context<Self>,
4543 ) -> SearchResults<SearchResult> {
4544 self.search_impl(query, cx).results(cx)
4545 }
4546
4547 pub fn request_lsp<R: LspCommand>(
4548 &mut self,
4549 buffer_handle: Entity<Buffer>,
4550 server: LanguageServerToQuery,
4551 request: R,
4552 cx: &mut Context<Self>,
4553 ) -> Task<Result<R::Response>>
4554 where
4555 <R::LspRequest as lsp::request::Request>::Result: Send,
4556 <R::LspRequest as lsp::request::Request>::Params: Send,
4557 {
4558 let guard = self.retain_remotely_created_models(cx);
4559 let task = self.lsp_store.update(cx, |lsp_store, cx| {
4560 lsp_store.request_lsp(buffer_handle, server, request, cx)
4561 });
4562 cx.background_spawn(async move {
4563 let result = task.await;
4564 drop(guard);
4565 result
4566 })
4567 }
4568
4569 /// Move a worktree to a new position in the worktree order.
4570 ///
4571 /// The worktree will moved to the opposite side of the destination worktree.
4572 ///
4573 /// # Example
4574 ///
4575 /// Given the worktree order `[11, 22, 33]` and a call to move worktree `22` to `33`,
4576 /// worktree_order will be updated to produce the indexes `[11, 33, 22]`.
4577 ///
4578 /// Given the worktree order `[11, 22, 33]` and a call to move worktree `22` to `11`,
4579 /// worktree_order will be updated to produce the indexes `[22, 11, 33]`.
4580 ///
4581 /// # Errors
4582 ///
4583 /// An error will be returned if the worktree or destination worktree are not found.
4584 pub fn move_worktree(
4585 &mut self,
4586 source: WorktreeId,
4587 destination: WorktreeId,
4588 cx: &mut Context<Self>,
4589 ) -> Result<()> {
4590 self.worktree_store.update(cx, |worktree_store, cx| {
4591 worktree_store.move_worktree(source, destination, cx)
4592 })
4593 }
4594
4595 /// Attempts to convert the input path to a WSL path if this is a wsl remote project and the input path is a host windows path.
4596 pub fn try_windows_path_to_wsl(
4597 &self,
4598 abs_path: &Path,
4599 cx: &App,
4600 ) -> impl Future<Output = Result<PathBuf>> + use<> {
4601 let fut = if cfg!(windows)
4602 && let (
4603 ProjectClientState::Local | ProjectClientState::Shared { .. },
4604 Some(remote_client),
4605 ) = (&self.client_state, &self.remote_client)
4606 && let RemoteConnectionOptions::Wsl(wsl) = remote_client.read(cx).connection_options()
4607 {
4608 Either::Left(wsl.abs_windows_path_to_wsl_path(abs_path))
4609 } else {
4610 Either::Right(abs_path.to_owned())
4611 };
4612 async move {
4613 match fut {
4614 Either::Left(fut) => fut.await.map(Into::into),
4615 Either::Right(path) => Ok(path),
4616 }
4617 }
4618 }
4619
4620 pub fn find_or_create_worktree(
4621 &mut self,
4622 abs_path: impl AsRef<Path>,
4623 visible: bool,
4624 cx: &mut Context<Self>,
4625 ) -> Task<Result<(Entity<Worktree>, Arc<RelPath>)>> {
4626 self.worktree_store.update(cx, |worktree_store, cx| {
4627 worktree_store.find_or_create_worktree(abs_path, visible, cx)
4628 })
4629 }
4630
4631 pub fn find_worktree(
4632 &self,
4633 abs_path: &Path,
4634 cx: &App,
4635 ) -> Option<(Entity<Worktree>, Arc<RelPath>)> {
4636 self.worktree_store.read(cx).find_worktree(abs_path, cx)
4637 }
4638
4639 pub fn is_shared(&self) -> bool {
4640 match &self.client_state {
4641 ProjectClientState::Shared { .. } => true,
4642 ProjectClientState::Local => false,
4643 ProjectClientState::Collab { .. } => true,
4644 }
4645 }
4646
4647 /// Returns the resolved version of `path`, that was found in `buffer`, if it exists.
4648 pub fn resolve_path_in_buffer(
4649 &self,
4650 path: &str,
4651 buffer: &Entity<Buffer>,
4652 cx: &mut Context<Self>,
4653 ) -> Task<Option<ResolvedPath>> {
4654 if util::paths::is_absolute(path, self.path_style(cx)) || path.starts_with("~") {
4655 self.resolve_abs_path(path, cx)
4656 } else {
4657 self.resolve_path_in_worktrees(path, buffer, cx)
4658 }
4659 }
4660
4661 pub fn resolve_abs_file_path(
4662 &self,
4663 path: &str,
4664 cx: &mut Context<Self>,
4665 ) -> Task<Option<ResolvedPath>> {
4666 let resolve_task = self.resolve_abs_path(path, cx);
4667 cx.background_spawn(async move {
4668 let resolved_path = resolve_task.await;
4669 resolved_path.filter(|path| path.is_file())
4670 })
4671 }
4672
4673 pub fn resolve_abs_path(&self, path: &str, cx: &App) -> Task<Option<ResolvedPath>> {
4674 if self.is_local() {
4675 let expanded = PathBuf::from(shellexpand::tilde(&path).into_owned());
4676 let fs = self.fs.clone();
4677 cx.background_spawn(async move {
4678 let metadata = fs.metadata(&expanded).await.ok().flatten();
4679
4680 metadata.map(|metadata| ResolvedPath::AbsPath {
4681 path: expanded.to_string_lossy().into_owned(),
4682 is_dir: metadata.is_dir,
4683 })
4684 })
4685 } else if let Some(ssh_client) = self.remote_client.as_ref() {
4686 let request = ssh_client
4687 .read(cx)
4688 .proto_client()
4689 .request(proto::GetPathMetadata {
4690 project_id: REMOTE_SERVER_PROJECT_ID,
4691 path: path.into(),
4692 });
4693 cx.background_spawn(async move {
4694 let response = request.await.log_err()?;
4695 if response.exists {
4696 Some(ResolvedPath::AbsPath {
4697 path: response.path,
4698 is_dir: response.is_dir,
4699 })
4700 } else {
4701 None
4702 }
4703 })
4704 } else {
4705 Task::ready(None)
4706 }
4707 }
4708
4709 fn resolve_path_in_worktrees(
4710 &self,
4711 path: &str,
4712 buffer: &Entity<Buffer>,
4713 cx: &mut Context<Self>,
4714 ) -> Task<Option<ResolvedPath>> {
4715 let mut candidates = vec![];
4716 let path_style = self.path_style(cx);
4717 if let Ok(path) = RelPath::new(path.as_ref(), path_style) {
4718 candidates.push(path.into_arc());
4719 }
4720
4721 if let Some(file) = buffer.read(cx).file()
4722 && let Some(dir) = file.path().parent()
4723 {
4724 if let Some(joined) = path_style.join(&*dir.display(path_style), path)
4725 && let Some(joined) = RelPath::new(joined.as_ref(), path_style).ok()
4726 {
4727 candidates.push(joined.into_arc());
4728 }
4729 }
4730
4731 let buffer_worktree_id = buffer.read(cx).file().map(|file| file.worktree_id(cx));
4732 let worktrees_with_ids: Vec<_> = self
4733 .worktrees(cx)
4734 .map(|worktree| {
4735 let id = worktree.read(cx).id();
4736 (worktree, id)
4737 })
4738 .collect();
4739
4740 cx.spawn(async move |_, cx| {
4741 if let Some(buffer_worktree_id) = buffer_worktree_id
4742 && let Some((worktree, _)) = worktrees_with_ids
4743 .iter()
4744 .find(|(_, id)| *id == buffer_worktree_id)
4745 {
4746 for candidate in candidates.iter() {
4747 if let Some(path) = Self::resolve_path_in_worktree(worktree, candidate, cx) {
4748 return Some(path);
4749 }
4750 }
4751 }
4752 for (worktree, id) in worktrees_with_ids {
4753 if Some(id) == buffer_worktree_id {
4754 continue;
4755 }
4756 for candidate in candidates.iter() {
4757 if let Some(path) = Self::resolve_path_in_worktree(&worktree, candidate, cx) {
4758 return Some(path);
4759 }
4760 }
4761 }
4762 None
4763 })
4764 }
4765
4766 fn resolve_path_in_worktree(
4767 worktree: &Entity<Worktree>,
4768 path: &RelPath,
4769 cx: &mut AsyncApp,
4770 ) -> Option<ResolvedPath> {
4771 worktree.read_with(cx, |worktree, _| {
4772 worktree.entry_for_path(path).map(|entry| {
4773 let project_path = ProjectPath {
4774 worktree_id: worktree.id(),
4775 path: entry.path.clone(),
4776 };
4777 ResolvedPath::ProjectPath {
4778 project_path,
4779 is_dir: entry.is_dir(),
4780 }
4781 })
4782 })
4783 }
4784
4785 pub fn list_directory(
4786 &self,
4787 query: String,
4788 cx: &mut Context<Self>,
4789 ) -> Task<Result<Vec<DirectoryItem>>> {
4790 if self.is_local() {
4791 DirectoryLister::Local(cx.entity(), self.fs.clone()).list_directory(query, cx)
4792 } else if let Some(session) = self.remote_client.as_ref() {
4793 let request = proto::ListRemoteDirectory {
4794 dev_server_id: REMOTE_SERVER_PROJECT_ID,
4795 path: query,
4796 config: Some(proto::ListRemoteDirectoryConfig { is_dir: true }),
4797 };
4798
4799 let response = session.read(cx).proto_client().request(request);
4800 cx.background_spawn(async move {
4801 let proto::ListRemoteDirectoryResponse {
4802 entries,
4803 entry_info,
4804 } = response.await?;
4805 Ok(entries
4806 .into_iter()
4807 .zip(entry_info)
4808 .map(|(entry, info)| DirectoryItem {
4809 path: PathBuf::from(entry),
4810 is_dir: info.is_dir,
4811 })
4812 .collect())
4813 })
4814 } else {
4815 Task::ready(Err(anyhow!("cannot list directory in remote project")))
4816 }
4817 }
4818
4819 pub fn create_worktree(
4820 &mut self,
4821 abs_path: impl AsRef<Path>,
4822 visible: bool,
4823 cx: &mut Context<Self>,
4824 ) -> Task<Result<Entity<Worktree>>> {
4825 self.worktree_store.update(cx, |worktree_store, cx| {
4826 worktree_store.create_worktree(abs_path, visible, cx)
4827 })
4828 }
4829
4830 /// Returns a task that resolves when the given worktree's `Entity` is
4831 /// fully dropped (all strong references released), not merely when
4832 /// `remove_worktree` is called. `remove_worktree` drops the store's
4833 /// reference and emits `WorktreeRemoved`, but other code may still
4834 /// hold a strong handle — the worktree isn't safe to delete from
4835 /// disk until every handle is gone.
4836 ///
4837 /// We use `observe_release` on the specific entity rather than
4838 /// listening for `WorktreeReleased` events because it's simpler at
4839 /// the call site (one awaitable task, no subscription / channel /
4840 /// ID filtering).
4841 pub fn wait_for_worktree_release(
4842 &mut self,
4843 worktree_id: WorktreeId,
4844 cx: &mut Context<Self>,
4845 ) -> Task<Result<()>> {
4846 let Some(worktree) = self.worktree_for_id(worktree_id, cx) else {
4847 return Task::ready(Ok(()));
4848 };
4849
4850 let (released_tx, released_rx) = futures::channel::oneshot::channel();
4851 let released_tx = std::sync::Arc::new(Mutex::new(Some(released_tx)));
4852 let release_subscription =
4853 cx.observe_release(&worktree, move |_project, _released_worktree, _cx| {
4854 if let Some(released_tx) = released_tx.lock().take() {
4855 let _ = released_tx.send(());
4856 }
4857 });
4858
4859 cx.spawn(async move |_project, _cx| {
4860 let _release_subscription = release_subscription;
4861 released_rx
4862 .await
4863 .map_err(|_| anyhow!("worktree release observer dropped before release"))?;
4864 Ok(())
4865 })
4866 }
4867
4868 pub fn remove_worktree(&mut self, id_to_remove: WorktreeId, cx: &mut Context<Self>) {
4869 self.worktree_store.update(cx, |worktree_store, cx| {
4870 worktree_store.remove_worktree(id_to_remove, cx);
4871 });
4872 }
4873
4874 pub fn remove_worktree_for_main_worktree_path(
4875 &mut self,
4876 path: impl AsRef<Path>,
4877 cx: &mut Context<Self>,
4878 ) {
4879 let path = path.as_ref();
4880 self.worktree_store.update(cx, |worktree_store, cx| {
4881 if let Some(worktree) = worktree_store.worktree_for_main_worktree_path(path, cx) {
4882 worktree_store.remove_worktree(worktree.read(cx).id(), cx);
4883 }
4884 });
4885 }
4886
4887 fn add_worktree(&mut self, worktree: &Entity<Worktree>, cx: &mut Context<Self>) {
4888 self.worktree_store.update(cx, |worktree_store, cx| {
4889 worktree_store.add(worktree, cx);
4890 });
4891 }
4892
4893 pub fn set_active_path(&mut self, entry: Option<ProjectPath>, cx: &mut Context<Self>) {
4894 let new_active_entry = entry.and_then(|project_path| {
4895 let worktree = self.worktree_for_id(project_path.worktree_id, cx)?;
4896 let entry = worktree.read(cx).entry_for_path(&project_path.path)?;
4897 Some(entry.id)
4898 });
4899 if new_active_entry != self.active_entry {
4900 self.active_entry = new_active_entry;
4901 self.lsp_store.update(cx, |lsp_store, _| {
4902 lsp_store.set_active_entry(new_active_entry);
4903 });
4904 cx.emit(Event::ActiveEntryChanged(new_active_entry));
4905 }
4906 }
4907
4908 pub fn language_servers_running_disk_based_diagnostics<'a>(
4909 &'a self,
4910 cx: &'a App,
4911 ) -> impl Iterator<Item = LanguageServerId> + 'a {
4912 self.lsp_store
4913 .read(cx)
4914 .language_servers_running_disk_based_diagnostics()
4915 }
4916
4917 pub fn diagnostic_summary(&self, include_ignored: bool, cx: &App) -> DiagnosticSummary {
4918 self.lsp_store
4919 .read(cx)
4920 .diagnostic_summary(include_ignored, cx)
4921 }
4922
4923 /// Returns a summary of the diagnostics for the provided project path only.
4924 pub fn diagnostic_summary_for_path(&self, path: &ProjectPath, cx: &App) -> DiagnosticSummary {
4925 self.lsp_store
4926 .read(cx)
4927 .diagnostic_summary_for_path(path, cx)
4928 }
4929
4930 pub fn diagnostic_summaries<'a>(
4931 &'a self,
4932 include_ignored: bool,
4933 cx: &'a App,
4934 ) -> impl Iterator<Item = (ProjectPath, LanguageServerId, DiagnosticSummary)> + 'a {
4935 self.lsp_store
4936 .read(cx)
4937 .diagnostic_summaries(include_ignored, cx)
4938 }
4939
4940 pub fn active_entry(&self) -> Option<ProjectEntryId> {
4941 self.active_entry
4942 }
4943
4944 pub fn entry_for_path<'a>(&'a self, path: &ProjectPath, cx: &'a App) -> Option<&'a Entry> {
4945 self.worktree_store.read(cx).entry_for_path(path, cx)
4946 }
4947
4948 pub fn path_for_entry(&self, entry_id: ProjectEntryId, cx: &App) -> Option<ProjectPath> {
4949 let worktree = self.worktree_for_entry(entry_id, cx)?;
4950 let worktree = worktree.read(cx);
4951 let worktree_id = worktree.id();
4952 let path = worktree.entry_for_id(entry_id)?.path.clone();
4953 Some(ProjectPath { worktree_id, path })
4954 }
4955
4956 pub fn absolute_path(&self, project_path: &ProjectPath, cx: &App) -> Option<PathBuf> {
4957 Some(
4958 self.worktree_for_id(project_path.worktree_id, cx)?
4959 .read(cx)
4960 .absolutize(&project_path.path),
4961 )
4962 }
4963
4964 /// Attempts to find a `ProjectPath` corresponding to the given path. If the path
4965 /// is a *full path*, meaning it starts with the root name of a worktree, we'll locate
4966 /// it in that worktree. Otherwise, we'll attempt to find it as a relative path in
4967 /// the first visible worktree that has an entry for that relative path.
4968 ///
4969 /// We use this to resolve edit steps, when there's a chance an LLM may omit the workree
4970 /// root name from paths.
4971 ///
4972 /// # Arguments
4973 ///
4974 /// * `path` - An absolute path, or a full path that starts with a worktree root name, or a
4975 /// relative path within a visible worktree.
4976 /// * `cx` - A reference to the `AppContext`.
4977 ///
4978 /// # Returns
4979 ///
4980 /// Returns `Some(ProjectPath)` if a matching worktree is found, otherwise `None`.
4981 pub fn find_project_path(&self, path: impl AsRef<Path>, cx: &App) -> Option<ProjectPath> {
4982 let path_style = self.path_style(cx);
4983 let path = path.as_ref();
4984 let worktree_store = self.worktree_store.read(cx);
4985
4986 if is_absolute(&path.to_string_lossy(), path_style) {
4987 for worktree in worktree_store.visible_worktrees(cx) {
4988 let worktree_abs_path = worktree.read(cx).abs_path();
4989
4990 if let Ok(relative_path) = path.strip_prefix(worktree_abs_path)
4991 && let Ok(path) = RelPath::new(relative_path, path_style)
4992 {
4993 return Some(ProjectPath {
4994 worktree_id: worktree.read(cx).id(),
4995 path: path.into_arc(),
4996 });
4997 }
4998 }
4999 } else {
5000 for worktree in worktree_store.visible_worktrees(cx) {
5001 let worktree = worktree.read(cx);
5002 if let Ok(rel_path) = RelPath::new(path, path_style) {
5003 if let Some(entry) = worktree.entry_for_path(&rel_path) {
5004 return Some(ProjectPath {
5005 worktree_id: worktree.id(),
5006 path: entry.path.clone(),
5007 });
5008 }
5009 }
5010 }
5011
5012 for worktree in worktree_store.visible_worktrees(cx) {
5013 let worktree_root_name = worktree.read(cx).root_name();
5014 if let Ok(relative_path) = path.strip_prefix(worktree_root_name.as_std_path())
5015 && let Ok(path) = RelPath::new(relative_path, path_style)
5016 {
5017 return Some(ProjectPath {
5018 worktree_id: worktree.read(cx).id(),
5019 path: path.into_arc(),
5020 });
5021 }
5022 }
5023 }
5024
5025 None
5026 }
5027
5028 /// If there's only one visible worktree, returns the given worktree-relative path with no prefix.
5029 ///
5030 /// Otherwise, returns the full path for the project path (obtained by prefixing the worktree-relative path with the name of the worktree).
5031 pub fn short_full_path_for_project_path(
5032 &self,
5033 project_path: &ProjectPath,
5034 cx: &App,
5035 ) -> Option<String> {
5036 let path_style = self.path_style(cx);
5037 if self.visible_worktrees(cx).take(2).count() < 2 {
5038 return Some(project_path.path.display(path_style).to_string());
5039 }
5040 self.worktree_for_id(project_path.worktree_id, cx)
5041 .map(|worktree| {
5042 let worktree_name = worktree.read(cx).root_name();
5043 worktree_name
5044 .join(&project_path.path)
5045 .display(path_style)
5046 .to_string()
5047 })
5048 }
5049
5050 pub fn project_path_for_absolute_path(&self, abs_path: &Path, cx: &App) -> Option<ProjectPath> {
5051 self.worktree_store
5052 .read(cx)
5053 .project_path_for_absolute_path(abs_path, cx)
5054 }
5055
5056 pub fn get_workspace_root(&self, project_path: &ProjectPath, cx: &App) -> Option<PathBuf> {
5057 Some(
5058 self.worktree_for_id(project_path.worktree_id, cx)?
5059 .read(cx)
5060 .abs_path()
5061 .to_path_buf(),
5062 )
5063 }
5064
5065 pub fn blame_buffer(
5066 &self,
5067 buffer: &Entity<Buffer>,
5068 version: Option<clock::Global>,
5069 cx: &mut App,
5070 ) -> Task<Result<Option<Blame>>> {
5071 self.git_store.update(cx, |git_store, cx| {
5072 git_store.blame_buffer(buffer, version, cx)
5073 })
5074 }
5075
5076 pub fn get_permalink_to_line(
5077 &self,
5078 buffer: &Entity<Buffer>,
5079 selection: Range<u32>,
5080 cx: &mut App,
5081 ) -> Task<Result<url::Url>> {
5082 self.git_store.update(cx, |git_store, cx| {
5083 git_store.get_permalink_to_line(buffer, selection, cx)
5084 })
5085 }
5086
5087 // RPC message handlers
5088
5089 async fn handle_unshare_project(
5090 this: Entity<Self>,
5091 _: TypedEnvelope<proto::UnshareProject>,
5092 mut cx: AsyncApp,
5093 ) -> Result<()> {
5094 this.update(&mut cx, |this, cx| {
5095 if this.is_local() || this.is_via_remote_server() {
5096 this.unshare(cx)?;
5097 } else {
5098 this.disconnected_from_host(cx);
5099 }
5100 Ok(())
5101 })
5102 }
5103
5104 async fn handle_add_collaborator(
5105 this: Entity<Self>,
5106 mut envelope: TypedEnvelope<proto::AddProjectCollaborator>,
5107 mut cx: AsyncApp,
5108 ) -> Result<()> {
5109 let collaborator = envelope
5110 .payload
5111 .collaborator
5112 .take()
5113 .context("empty collaborator")?;
5114
5115 let collaborator = Collaborator::from_proto(collaborator)?;
5116 this.update(&mut cx, |this, cx| {
5117 this.buffer_store.update(cx, |buffer_store, _| {
5118 buffer_store.forget_shared_buffers_for(&collaborator.peer_id);
5119 });
5120 this.breakpoint_store.read(cx).broadcast();
5121 cx.emit(Event::CollaboratorJoined(collaborator.peer_id));
5122 this.collaborators
5123 .insert(collaborator.peer_id, collaborator);
5124 });
5125
5126 Ok(())
5127 }
5128
5129 async fn handle_update_project_collaborator(
5130 this: Entity<Self>,
5131 envelope: TypedEnvelope<proto::UpdateProjectCollaborator>,
5132 mut cx: AsyncApp,
5133 ) -> Result<()> {
5134 let old_peer_id = envelope
5135 .payload
5136 .old_peer_id
5137 .context("missing old peer id")?;
5138 let new_peer_id = envelope
5139 .payload
5140 .new_peer_id
5141 .context("missing new peer id")?;
5142 this.update(&mut cx, |this, cx| {
5143 let collaborator = this
5144 .collaborators
5145 .remove(&old_peer_id)
5146 .context("received UpdateProjectCollaborator for unknown peer")?;
5147 let is_host = collaborator.is_host;
5148 this.collaborators.insert(new_peer_id, collaborator);
5149
5150 log::info!("peer {} became {}", old_peer_id, new_peer_id,);
5151 this.buffer_store.update(cx, |buffer_store, _| {
5152 buffer_store.update_peer_id(&old_peer_id, new_peer_id)
5153 });
5154
5155 if is_host {
5156 this.buffer_store
5157 .update(cx, |buffer_store, _| buffer_store.discard_incomplete());
5158 this.enqueue_buffer_ordered_message(BufferOrderedMessage::Resync)
5159 .unwrap();
5160 cx.emit(Event::HostReshared);
5161 }
5162
5163 cx.emit(Event::CollaboratorUpdated {
5164 old_peer_id,
5165 new_peer_id,
5166 });
5167 Ok(())
5168 })
5169 }
5170
5171 async fn handle_remove_collaborator(
5172 this: Entity<Self>,
5173 envelope: TypedEnvelope<proto::RemoveProjectCollaborator>,
5174 mut cx: AsyncApp,
5175 ) -> Result<()> {
5176 this.update(&mut cx, |this, cx| {
5177 let peer_id = envelope.payload.peer_id.context("invalid peer id")?;
5178 let replica_id = this
5179 .collaborators
5180 .remove(&peer_id)
5181 .with_context(|| format!("unknown peer {peer_id:?}"))?
5182 .replica_id;
5183 this.buffer_store.update(cx, |buffer_store, cx| {
5184 buffer_store.forget_shared_buffers_for(&peer_id);
5185 for buffer in buffer_store.buffers() {
5186 buffer.update(cx, |buffer, cx| buffer.remove_peer(replica_id, cx));
5187 }
5188 });
5189 this.git_store.update(cx, |git_store, _| {
5190 git_store.forget_shared_diffs_for(&peer_id);
5191 });
5192
5193 cx.emit(Event::CollaboratorLeft(peer_id));
5194 Ok(())
5195 })
5196 }
5197
5198 async fn handle_update_project(
5199 this: Entity<Self>,
5200 envelope: TypedEnvelope<proto::UpdateProject>,
5201 mut cx: AsyncApp,
5202 ) -> Result<()> {
5203 this.update(&mut cx, |this, cx| {
5204 // Don't handle messages that were sent before the response to us joining the project
5205 if envelope.message_id > this.join_project_response_message_id {
5206 cx.update_global::<SettingsStore, _>(|store, cx| {
5207 for worktree_metadata in &envelope.payload.worktrees {
5208 store
5209 .clear_local_settings(WorktreeId::from_proto(worktree_metadata.id), cx)
5210 .log_err();
5211 }
5212 });
5213
5214 this.set_worktrees_from_proto(envelope.payload.worktrees, cx)?;
5215 }
5216 Ok(())
5217 })
5218 }
5219
5220 async fn handle_toast(
5221 this: Entity<Self>,
5222 envelope: TypedEnvelope<proto::Toast>,
5223 mut cx: AsyncApp,
5224 ) -> Result<()> {
5225 this.update(&mut cx, |_, cx| {
5226 cx.emit(Event::Toast {
5227 notification_id: envelope.payload.notification_id.into(),
5228 message: envelope.payload.message,
5229 link: None,
5230 });
5231 Ok(())
5232 })
5233 }
5234
5235 async fn handle_language_server_prompt_request(
5236 this: Entity<Self>,
5237 envelope: TypedEnvelope<proto::LanguageServerPromptRequest>,
5238 mut cx: AsyncApp,
5239 ) -> Result<proto::LanguageServerPromptResponse> {
5240 let (tx, rx) = smol::channel::bounded(1);
5241 let actions: Vec<_> = envelope
5242 .payload
5243 .actions
5244 .into_iter()
5245 .map(|action| MessageActionItem {
5246 title: action,
5247 properties: Default::default(),
5248 })
5249 .collect();
5250 this.update(&mut cx, |_, cx| {
5251 cx.emit(Event::LanguageServerPrompt(
5252 LanguageServerPromptRequest::new(
5253 proto_to_prompt(envelope.payload.level.context("Invalid prompt level")?),
5254 envelope.payload.message,
5255 actions.clone(),
5256 envelope.payload.lsp_name,
5257 tx,
5258 ),
5259 ));
5260
5261 anyhow::Ok(())
5262 })?;
5263
5264 // We drop `this` to avoid holding a reference in this future for too
5265 // long.
5266 // If we keep the reference, we might not drop the `Project` early
5267 // enough when closing a window and it will only get releases on the
5268 // next `flush_effects()` call.
5269 drop(this);
5270
5271 let mut rx = pin!(rx);
5272 let answer = rx.next().await;
5273
5274 Ok(LanguageServerPromptResponse {
5275 action_response: answer.and_then(|answer| {
5276 actions
5277 .iter()
5278 .position(|action| *action == answer)
5279 .map(|index| index as u64)
5280 }),
5281 })
5282 }
5283
5284 async fn handle_hide_toast(
5285 this: Entity<Self>,
5286 envelope: TypedEnvelope<proto::HideToast>,
5287 mut cx: AsyncApp,
5288 ) -> Result<()> {
5289 this.update(&mut cx, |_, cx| {
5290 cx.emit(Event::HideToast {
5291 notification_id: envelope.payload.notification_id.into(),
5292 });
5293 Ok(())
5294 })
5295 }
5296
5297 // Collab sends UpdateWorktree protos as messages
5298 async fn handle_update_worktree(
5299 this: Entity<Self>,
5300 envelope: TypedEnvelope<proto::UpdateWorktree>,
5301 mut cx: AsyncApp,
5302 ) -> Result<()> {
5303 this.update(&mut cx, |project, cx| {
5304 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
5305 if let Some(worktree) = project.worktree_for_id(worktree_id, cx) {
5306 worktree.update(cx, |worktree, _| {
5307 let worktree = worktree.as_remote_mut().unwrap();
5308 worktree.update_from_remote(envelope.payload);
5309 });
5310 }
5311 Ok(())
5312 })
5313 }
5314
5315 async fn handle_update_buffer_from_remote_server(
5316 this: Entity<Self>,
5317 envelope: TypedEnvelope<proto::UpdateBuffer>,
5318 cx: AsyncApp,
5319 ) -> Result<proto::Ack> {
5320 let buffer_store = this.read_with(&cx, |this, cx| {
5321 if let Some(remote_id) = this.remote_id() {
5322 let mut payload = envelope.payload.clone();
5323 payload.project_id = remote_id;
5324 cx.background_spawn(this.collab_client.request(payload))
5325 .detach_and_log_err(cx);
5326 }
5327 this.buffer_store.clone()
5328 });
5329 BufferStore::handle_update_buffer(buffer_store, envelope, cx).await
5330 }
5331
5332 async fn handle_trust_worktrees(
5333 this: Entity<Self>,
5334 envelope: TypedEnvelope<proto::TrustWorktrees>,
5335 mut cx: AsyncApp,
5336 ) -> Result<proto::Ack> {
5337 if this.read_with(&cx, |project, _| project.is_via_collab()) {
5338 return Ok(proto::Ack {});
5339 }
5340
5341 let trusted_worktrees = cx
5342 .update(|cx| TrustedWorktrees::try_get_global(cx))
5343 .context("missing trusted worktrees")?;
5344 trusted_worktrees.update(&mut cx, |trusted_worktrees, cx| {
5345 trusted_worktrees.trust(
5346 &this.read(cx).worktree_store(),
5347 envelope
5348 .payload
5349 .trusted_paths
5350 .into_iter()
5351 .filter_map(|proto_path| PathTrust::from_proto(proto_path))
5352 .collect(),
5353 cx,
5354 );
5355 });
5356 Ok(proto::Ack {})
5357 }
5358
5359 async fn handle_restrict_worktrees(
5360 this: Entity<Self>,
5361 envelope: TypedEnvelope<proto::RestrictWorktrees>,
5362 mut cx: AsyncApp,
5363 ) -> Result<proto::Ack> {
5364 if this.read_with(&cx, |project, _| project.is_via_collab()) {
5365 return Ok(proto::Ack {});
5366 }
5367
5368 let trusted_worktrees = cx
5369 .update(|cx| TrustedWorktrees::try_get_global(cx))
5370 .context("missing trusted worktrees")?;
5371 trusted_worktrees.update(&mut cx, |trusted_worktrees, cx| {
5372 let worktree_store = this.read(cx).worktree_store().downgrade();
5373 let restricted_paths = envelope
5374 .payload
5375 .worktree_ids
5376 .into_iter()
5377 .map(WorktreeId::from_proto)
5378 .map(PathTrust::Worktree)
5379 .collect::<HashSet<_>>();
5380 trusted_worktrees.restrict(worktree_store, restricted_paths, cx);
5381 });
5382 Ok(proto::Ack {})
5383 }
5384
5385 // Goes from host to client.
5386 async fn handle_find_search_candidates_chunk(
5387 this: Entity<Self>,
5388 envelope: TypedEnvelope<proto::FindSearchCandidatesChunk>,
5389 mut cx: AsyncApp,
5390 ) -> Result<proto::Ack> {
5391 let buffer_store = this.read_with(&mut cx, |this, _| this.buffer_store.clone());
5392 BufferStore::handle_find_search_candidates_chunk(buffer_store, envelope, cx).await
5393 }
5394
5395 // Goes from client to host.
5396 async fn handle_find_search_candidates_cancel(
5397 this: Entity<Self>,
5398 envelope: TypedEnvelope<proto::FindSearchCandidatesCancelled>,
5399 mut cx: AsyncApp,
5400 ) -> Result<()> {
5401 let buffer_store = this.read_with(&mut cx, |this, _| this.buffer_store.clone());
5402 BufferStore::handle_find_search_candidates_cancel(buffer_store, envelope, cx).await
5403 }
5404
5405 async fn handle_update_buffer(
5406 this: Entity<Self>,
5407 envelope: TypedEnvelope<proto::UpdateBuffer>,
5408 cx: AsyncApp,
5409 ) -> Result<proto::Ack> {
5410 let buffer_store = this.read_with(&cx, |this, cx| {
5411 if let Some(ssh) = &this.remote_client {
5412 let mut payload = envelope.payload.clone();
5413 payload.project_id = REMOTE_SERVER_PROJECT_ID;
5414 cx.background_spawn(ssh.read(cx).proto_client().request(payload))
5415 .detach_and_log_err(cx);
5416 }
5417 this.buffer_store.clone()
5418 });
5419 BufferStore::handle_update_buffer(buffer_store, envelope, cx).await
5420 }
5421
5422 fn retain_remotely_created_models(
5423 &mut self,
5424 cx: &mut Context<Self>,
5425 ) -> RemotelyCreatedModelGuard {
5426 Self::retain_remotely_created_models_impl(
5427 &self.remotely_created_models,
5428 &self.buffer_store,
5429 &self.worktree_store,
5430 cx,
5431 )
5432 }
5433
5434 fn retain_remotely_created_models_impl(
5435 models: &Arc<Mutex<RemotelyCreatedModels>>,
5436 buffer_store: &Entity<BufferStore>,
5437 worktree_store: &Entity<WorktreeStore>,
5438 cx: &mut App,
5439 ) -> RemotelyCreatedModelGuard {
5440 {
5441 let mut remotely_create_models = models.lock();
5442 if remotely_create_models.retain_count == 0 {
5443 remotely_create_models.buffers = buffer_store.read(cx).buffers().collect();
5444 remotely_create_models.worktrees = worktree_store.read(cx).worktrees().collect();
5445 }
5446 remotely_create_models.retain_count += 1;
5447 }
5448 RemotelyCreatedModelGuard {
5449 remote_models: Arc::downgrade(&models),
5450 }
5451 }
5452
5453 async fn handle_create_buffer_for_peer(
5454 this: Entity<Self>,
5455 envelope: TypedEnvelope<proto::CreateBufferForPeer>,
5456 mut cx: AsyncApp,
5457 ) -> Result<()> {
5458 this.update(&mut cx, |this, cx| {
5459 this.buffer_store.update(cx, |buffer_store, cx| {
5460 buffer_store.handle_create_buffer_for_peer(
5461 envelope,
5462 this.replica_id(),
5463 this.capability(),
5464 cx,
5465 )
5466 })
5467 })
5468 }
5469
5470 async fn handle_toggle_lsp_logs(
5471 project: Entity<Self>,
5472 envelope: TypedEnvelope<proto::ToggleLspLogs>,
5473 mut cx: AsyncApp,
5474 ) -> Result<()> {
5475 let toggled_log_kind =
5476 match proto::toggle_lsp_logs::LogType::from_i32(envelope.payload.log_type)
5477 .context("invalid log type")?
5478 {
5479 proto::toggle_lsp_logs::LogType::Log => LogKind::Logs,
5480 proto::toggle_lsp_logs::LogType::Trace => LogKind::Trace,
5481 proto::toggle_lsp_logs::LogType::Rpc => LogKind::Rpc,
5482 };
5483 project.update(&mut cx, |_, cx| {
5484 cx.emit(Event::ToggleLspLogs {
5485 server_id: LanguageServerId::from_proto(envelope.payload.server_id),
5486 enabled: envelope.payload.enabled,
5487 toggled_log_kind,
5488 })
5489 });
5490 Ok(())
5491 }
5492
5493 async fn handle_synchronize_buffers(
5494 this: Entity<Self>,
5495 envelope: TypedEnvelope<proto::SynchronizeBuffers>,
5496 mut cx: AsyncApp,
5497 ) -> Result<proto::SynchronizeBuffersResponse> {
5498 let response = this.update(&mut cx, |this, cx| {
5499 let client = this.collab_client.clone();
5500 this.buffer_store.update(cx, |this, cx| {
5501 this.handle_synchronize_buffers(envelope, cx, client)
5502 })
5503 })?;
5504
5505 Ok(response)
5506 }
5507
5508 // Goes from client to host.
5509 async fn handle_search_candidate_buffers(
5510 this: Entity<Self>,
5511 envelope: TypedEnvelope<proto::FindSearchCandidates>,
5512 mut cx: AsyncApp,
5513 ) -> Result<proto::Ack> {
5514 let peer_id = envelope.original_sender_id.unwrap_or(envelope.sender_id);
5515 let message = envelope.payload;
5516 let project_id = message.project_id;
5517 let path_style = this.read_with(&cx, |this, cx| this.path_style(cx));
5518 let query =
5519 SearchQuery::from_proto(message.query.context("missing query field")?, path_style)?;
5520
5521 let handle = message.handle;
5522 let buffer_store = this.read_with(&cx, |this, _| this.buffer_store().clone());
5523 let client = this.read_with(&cx, |this, _| this.client());
5524 let task = cx.spawn(async move |cx| {
5525 let results = this.update(cx, |this, cx| {
5526 this.search_impl(query, cx).matching_buffers(cx)
5527 });
5528 let (batcher, batches) = project_search::AdaptiveBatcher::new(cx.background_executor());
5529 let mut new_matches = Box::pin(results.rx);
5530
5531 let sender_task = cx.background_executor().spawn({
5532 let client = client.clone();
5533 async move {
5534 let mut batches = std::pin::pin!(batches);
5535 while let Some(buffer_ids) = batches.next().await {
5536 client
5537 .request(proto::FindSearchCandidatesChunk {
5538 handle,
5539 peer_id: Some(peer_id),
5540 project_id,
5541 variant: Some(
5542 proto::find_search_candidates_chunk::Variant::Matches(
5543 proto::FindSearchCandidatesMatches { buffer_ids },
5544 ),
5545 ),
5546 })
5547 .await?;
5548 }
5549 anyhow::Ok(())
5550 }
5551 });
5552
5553 while let Some(buffer) = new_matches.next().await {
5554 let buffer_id = this.update(cx, |this, cx| {
5555 this.create_buffer_for_peer(&buffer, peer_id, cx).to_proto()
5556 });
5557 batcher.push(buffer_id).await;
5558 }
5559 batcher.flush().await;
5560
5561 sender_task.await?;
5562
5563 let _ = client
5564 .request(proto::FindSearchCandidatesChunk {
5565 handle,
5566 peer_id: Some(peer_id),
5567 project_id,
5568 variant: Some(proto::find_search_candidates_chunk::Variant::Done(
5569 proto::FindSearchCandidatesDone {},
5570 )),
5571 })
5572 .await?;
5573 anyhow::Ok(())
5574 });
5575 buffer_store.update(&mut cx, |this, _| {
5576 this.register_ongoing_project_search((peer_id, handle), task);
5577 });
5578
5579 Ok(proto::Ack {})
5580 }
5581
5582 async fn handle_open_buffer_by_id(
5583 this: Entity<Self>,
5584 envelope: TypedEnvelope<proto::OpenBufferById>,
5585 mut cx: AsyncApp,
5586 ) -> Result<proto::OpenBufferResponse> {
5587 let peer_id = envelope.original_sender_id()?;
5588 let buffer_id = BufferId::new(envelope.payload.id)?;
5589 let buffer = this
5590 .update(&mut cx, |this, cx| this.open_buffer_by_id(buffer_id, cx))
5591 .await?;
5592 Project::respond_to_open_buffer_request(this, buffer, peer_id, &mut cx)
5593 }
5594
5595 async fn handle_open_buffer_by_path(
5596 this: Entity<Self>,
5597 envelope: TypedEnvelope<proto::OpenBufferByPath>,
5598 mut cx: AsyncApp,
5599 ) -> Result<proto::OpenBufferResponse> {
5600 let peer_id = envelope.original_sender_id()?;
5601 let worktree_id = WorktreeId::from_proto(envelope.payload.worktree_id);
5602 let path = RelPath::from_proto(&envelope.payload.path)?;
5603 let open_buffer = this
5604 .update(&mut cx, |this, cx| {
5605 this.open_buffer(ProjectPath { worktree_id, path }, cx)
5606 })
5607 .await?;
5608 Project::respond_to_open_buffer_request(this, open_buffer, peer_id, &mut cx)
5609 }
5610
5611 async fn handle_open_new_buffer(
5612 this: Entity<Self>,
5613 envelope: TypedEnvelope<proto::OpenNewBuffer>,
5614 mut cx: AsyncApp,
5615 ) -> Result<proto::OpenBufferResponse> {
5616 let buffer = this
5617 .update(&mut cx, |this, cx| this.create_buffer(None, true, cx))
5618 .await?;
5619 let peer_id = envelope.original_sender_id()?;
5620
5621 Project::respond_to_open_buffer_request(this, buffer, peer_id, &mut cx)
5622 }
5623
5624 fn respond_to_open_buffer_request(
5625 this: Entity<Self>,
5626 buffer: Entity<Buffer>,
5627 peer_id: proto::PeerId,
5628 cx: &mut AsyncApp,
5629 ) -> Result<proto::OpenBufferResponse> {
5630 this.update(cx, |this, cx| {
5631 let is_private = buffer
5632 .read(cx)
5633 .file()
5634 .map(|f| f.is_private())
5635 .unwrap_or_default();
5636 anyhow::ensure!(!is_private, ErrorCode::UnsharedItem);
5637 Ok(proto::OpenBufferResponse {
5638 buffer_id: this.create_buffer_for_peer(&buffer, peer_id, cx).into(),
5639 })
5640 })
5641 }
5642
5643 fn create_buffer_for_peer(
5644 &mut self,
5645 buffer: &Entity<Buffer>,
5646 peer_id: proto::PeerId,
5647 cx: &mut App,
5648 ) -> BufferId {
5649 self.buffer_store
5650 .update(cx, |buffer_store, cx| {
5651 buffer_store.create_buffer_for_peer(buffer, peer_id, cx)
5652 })
5653 .detach_and_log_err(cx);
5654 buffer.read(cx).remote_id()
5655 }
5656
5657 async fn handle_create_image_for_peer(
5658 this: Entity<Self>,
5659 envelope: TypedEnvelope<proto::CreateImageForPeer>,
5660 mut cx: AsyncApp,
5661 ) -> Result<()> {
5662 this.update(&mut cx, |this, cx| {
5663 this.image_store.update(cx, |image_store, cx| {
5664 image_store.handle_create_image_for_peer(envelope, cx)
5665 })
5666 })
5667 }
5668
5669 async fn handle_create_file_for_peer(
5670 this: Entity<Self>,
5671 envelope: TypedEnvelope<proto::CreateFileForPeer>,
5672 mut cx: AsyncApp,
5673 ) -> Result<()> {
5674 use proto::create_file_for_peer::Variant;
5675 log::debug!("handle_create_file_for_peer: received message");
5676
5677 let downloading_files: Arc<Mutex<HashMap<(WorktreeId, String), DownloadingFile>>> =
5678 this.update(&mut cx, |this, _| this.downloading_files.clone());
5679
5680 match &envelope.payload.variant {
5681 Some(Variant::State(state)) => {
5682 log::debug!(
5683 "handle_create_file_for_peer: got State: id={}, content_size={}",
5684 state.id,
5685 state.content_size
5686 );
5687
5688 // Extract worktree_id and path from the File field
5689 if let Some(ref file) = state.file {
5690 let worktree_id = WorktreeId::from_proto(file.worktree_id);
5691 let path = file.path.clone();
5692 let key = (worktree_id, path);
5693 log::debug!("handle_create_file_for_peer: looking up key={:?}", key);
5694
5695 let empty_file_destination: Option<PathBuf> = {
5696 let mut files = downloading_files.lock();
5697 log::trace!(
5698 "handle_create_file_for_peer: current downloading_files keys: {:?}",
5699 files.keys().collect::<Vec<_>>()
5700 );
5701
5702 if let Some(file_entry) = files.get_mut(&key) {
5703 file_entry.total_size = state.content_size;
5704 file_entry.file_id = Some(state.id);
5705 log::debug!(
5706 "handle_create_file_for_peer: updated file entry: total_size={}, file_id={}",
5707 state.content_size,
5708 state.id
5709 );
5710 } else {
5711 log::warn!(
5712 "handle_create_file_for_peer: key={:?} not found in downloading_files",
5713 key
5714 );
5715 }
5716
5717 if state.content_size == 0 {
5718 // No chunks will arrive for an empty file; write it now.
5719 files.remove(&key).map(|entry| entry.destination_path)
5720 } else {
5721 None
5722 }
5723 };
5724
5725 if let Some(destination) = empty_file_destination {
5726 log::debug!(
5727 "handle_create_file_for_peer: writing empty file to {:?}",
5728 destination
5729 );
5730 match smol::fs::write(&destination, &[] as &[u8]).await {
5731 Ok(_) => log::info!(
5732 "handle_create_file_for_peer: successfully wrote file to {:?}",
5733 destination
5734 ),
5735 Err(e) => log::error!(
5736 "handle_create_file_for_peer: failed to write empty file: {:?}",
5737 e
5738 ),
5739 }
5740 }
5741 } else {
5742 log::warn!("handle_create_file_for_peer: State has no file field");
5743 }
5744 }
5745 Some(Variant::Chunk(chunk)) => {
5746 log::debug!(
5747 "handle_create_file_for_peer: got Chunk: file_id={}, data_len={}",
5748 chunk.file_id,
5749 chunk.data.len()
5750 );
5751
5752 // Extract data while holding the lock, then release it before await
5753 let (key_to_remove, write_info): (
5754 Option<(WorktreeId, String)>,
5755 Option<(PathBuf, Vec<u8>)>,
5756 ) = {
5757 let mut files = downloading_files.lock();
5758 let mut found_key: Option<(WorktreeId, String)> = None;
5759 let mut write_data: Option<(PathBuf, Vec<u8>)> = None;
5760
5761 for (key, file_entry) in files.iter_mut() {
5762 if file_entry.file_id == Some(chunk.file_id) {
5763 file_entry.chunks.extend_from_slice(&chunk.data);
5764 log::debug!(
5765 "handle_create_file_for_peer: accumulated {} bytes, total_size={}",
5766 file_entry.chunks.len(),
5767 file_entry.total_size
5768 );
5769
5770 if file_entry.chunks.len() as u64 >= file_entry.total_size
5771 && file_entry.total_size > 0
5772 {
5773 let destination = file_entry.destination_path.clone();
5774 let content = std::mem::take(&mut file_entry.chunks);
5775 found_key = Some(key.clone());
5776 write_data = Some((destination, content));
5777 }
5778 break;
5779 }
5780 }
5781 (found_key, write_data)
5782 }; // MutexGuard is dropped here
5783
5784 // Perform the async write outside the lock
5785 if let Some((destination, content)) = write_info {
5786 log::debug!(
5787 "handle_create_file_for_peer: writing {} bytes to {:?}",
5788 content.len(),
5789 destination
5790 );
5791 match smol::fs::write(&destination, &content).await {
5792 Ok(_) => log::info!(
5793 "handle_create_file_for_peer: successfully wrote file to {:?}",
5794 destination
5795 ),
5796 Err(e) => log::error!(
5797 "handle_create_file_for_peer: failed to write file: {:?}",
5798 e
5799 ),
5800 }
5801 }
5802
5803 // Remove the completed entry
5804 if let Some(key) = key_to_remove {
5805 downloading_files.lock().remove(&key);
5806 log::debug!("handle_create_file_for_peer: removed completed download entry");
5807 }
5808 }
5809 None => {
5810 log::warn!("handle_create_file_for_peer: got None variant");
5811 }
5812 }
5813
5814 Ok(())
5815 }
5816
5817 fn synchronize_remote_buffers(&mut self, cx: &mut Context<Self>) -> Task<Result<()>> {
5818 let project_id = match self.client_state {
5819 ProjectClientState::Collab {
5820 sharing_has_stopped,
5821 remote_id,
5822 ..
5823 } => {
5824 if sharing_has_stopped {
5825 return Task::ready(Err(anyhow!(
5826 "can't synchronize remote buffers on a readonly project"
5827 )));
5828 } else {
5829 remote_id
5830 }
5831 }
5832 ProjectClientState::Shared { .. } | ProjectClientState::Local => {
5833 return Task::ready(Err(anyhow!(
5834 "can't synchronize remote buffers on a local project"
5835 )));
5836 }
5837 };
5838
5839 let client = self.collab_client.clone();
5840 cx.spawn(async move |this, cx| {
5841 let (buffers, incomplete_buffer_ids) = this.update(cx, |this, cx| {
5842 this.buffer_store.read(cx).buffer_version_info(cx)
5843 })?;
5844 let response = client
5845 .request(proto::SynchronizeBuffers {
5846 project_id,
5847 buffers,
5848 })
5849 .await?;
5850
5851 let send_updates_for_buffers = this.update(cx, |this, cx| {
5852 response
5853 .buffers
5854 .into_iter()
5855 .map(|buffer| {
5856 let client = client.clone();
5857 let buffer_id = match BufferId::new(buffer.id) {
5858 Ok(id) => id,
5859 Err(e) => {
5860 return Task::ready(Err(e));
5861 }
5862 };
5863 let remote_version = language::proto::deserialize_version(&buffer.version);
5864 if let Some(buffer) = this.buffer_for_id(buffer_id, cx) {
5865 let operations =
5866 buffer.read(cx).serialize_ops(Some(remote_version), cx);
5867 cx.background_spawn(async move {
5868 let operations = operations.await;
5869 for chunk in split_operations(operations) {
5870 client
5871 .request(proto::UpdateBuffer {
5872 project_id,
5873 buffer_id: buffer_id.into(),
5874 operations: chunk,
5875 })
5876 .await?;
5877 }
5878 anyhow::Ok(())
5879 })
5880 } else {
5881 Task::ready(Ok(()))
5882 }
5883 })
5884 .collect::<Vec<_>>()
5885 })?;
5886
5887 // Any incomplete buffers have open requests waiting. Request that the host sends
5888 // creates these buffers for us again to unblock any waiting futures.
5889 for id in incomplete_buffer_ids {
5890 cx.background_spawn(client.request(proto::OpenBufferById {
5891 project_id,
5892 id: id.into(),
5893 }))
5894 .detach();
5895 }
5896
5897 futures::future::join_all(send_updates_for_buffers)
5898 .await
5899 .into_iter()
5900 .collect()
5901 })
5902 }
5903
5904 pub fn worktree_metadata_protos(&self, cx: &App) -> Vec<proto::WorktreeMetadata> {
5905 self.worktree_store.read(cx).worktree_metadata_protos(cx)
5906 }
5907
5908 /// Iterator of all open buffers that have unsaved changes
5909 pub fn dirty_buffers<'a>(&'a self, cx: &'a App) -> impl Iterator<Item = ProjectPath> + 'a {
5910 self.buffer_store.read(cx).buffers().filter_map(|buf| {
5911 let buf = buf.read(cx);
5912 if buf.is_dirty() {
5913 buf.project_path(cx)
5914 } else {
5915 None
5916 }
5917 })
5918 }
5919
5920 fn set_worktrees_from_proto(
5921 &mut self,
5922 worktrees: Vec<proto::WorktreeMetadata>,
5923 cx: &mut Context<Project>,
5924 ) -> Result<()> {
5925 self.worktree_store.update(cx, |worktree_store, cx| {
5926 worktree_store.set_worktrees_from_proto(worktrees, self.replica_id(), cx)
5927 })
5928 }
5929
5930 fn set_collaborators_from_proto(
5931 &mut self,
5932 messages: Vec<proto::Collaborator>,
5933 cx: &mut Context<Self>,
5934 ) -> Result<()> {
5935 let mut collaborators = HashMap::default();
5936 for message in messages {
5937 let collaborator = Collaborator::from_proto(message)?;
5938 collaborators.insert(collaborator.peer_id, collaborator);
5939 }
5940 for old_peer_id in self.collaborators.keys() {
5941 if !collaborators.contains_key(old_peer_id) {
5942 cx.emit(Event::CollaboratorLeft(*old_peer_id));
5943 }
5944 }
5945 self.collaborators = collaborators;
5946 Ok(())
5947 }
5948
5949 pub fn supplementary_language_servers<'a>(
5950 &'a self,
5951 cx: &'a App,
5952 ) -> impl 'a + Iterator<Item = (LanguageServerId, LanguageServerName)> {
5953 self.lsp_store.read(cx).supplementary_language_servers()
5954 }
5955
5956 pub fn any_language_server_supports_inlay_hints(&self, buffer: &Buffer, cx: &mut App) -> bool {
5957 let Some(language) = buffer.language().cloned() else {
5958 return false;
5959 };
5960 self.lsp_store.update(cx, |lsp_store, _| {
5961 let relevant_language_servers = lsp_store
5962 .languages
5963 .lsp_adapters(&language.name())
5964 .into_iter()
5965 .map(|lsp_adapter| lsp_adapter.name())
5966 .collect::<HashSet<_>>();
5967 lsp_store
5968 .language_server_statuses()
5969 .filter_map(|(server_id, server_status)| {
5970 relevant_language_servers
5971 .contains(&server_status.name)
5972 .then_some(server_id)
5973 })
5974 .filter_map(|server_id| lsp_store.lsp_server_capabilities.get(&server_id))
5975 .any(InlayHints::check_capabilities)
5976 })
5977 }
5978
5979 pub fn any_language_server_supports_semantic_tokens(
5980 &self,
5981 buffer: &Buffer,
5982 cx: &mut App,
5983 ) -> bool {
5984 let Some(language) = buffer.language().cloned() else {
5985 return false;
5986 };
5987 let lsp_store = self.lsp_store.read(cx);
5988 let relevant_language_servers = lsp_store
5989 .languages
5990 .lsp_adapters(&language.name())
5991 .into_iter()
5992 .map(|lsp_adapter| lsp_adapter.name())
5993 .collect::<HashSet<_>>();
5994 lsp_store
5995 .language_server_statuses()
5996 .filter_map(|(server_id, server_status)| {
5997 relevant_language_servers
5998 .contains(&server_status.name)
5999 .then_some(server_id)
6000 })
6001 .filter_map(|server_id| lsp_store.lsp_server_capabilities.get(&server_id))
6002 .any(|capabilities| capabilities.semantic_tokens_provider.is_some())
6003 }
6004
6005 pub fn language_server_id_for_name(
6006 &self,
6007 buffer: &Buffer,
6008 name: &LanguageServerName,
6009 cx: &App,
6010 ) -> Option<LanguageServerId> {
6011 let language = buffer.language()?;
6012 let relevant_language_servers = self
6013 .languages
6014 .lsp_adapters(&language.name())
6015 .into_iter()
6016 .map(|lsp_adapter| lsp_adapter.name())
6017 .collect::<HashSet<_>>();
6018 if !relevant_language_servers.contains(name) {
6019 return None;
6020 }
6021 self.language_server_statuses(cx)
6022 .filter(|(_, server_status)| relevant_language_servers.contains(&server_status.name))
6023 .find_map(|(server_id, server_status)| {
6024 if &server_status.name == name {
6025 Some(server_id)
6026 } else {
6027 None
6028 }
6029 })
6030 }
6031
6032 #[cfg(feature = "test-support")]
6033 pub fn has_language_servers_for(&self, buffer: &Buffer, cx: &mut App) -> bool {
6034 self.lsp_store.update(cx, |this, cx| {
6035 this.running_language_servers_for_local_buffer(buffer, cx)
6036 .next()
6037 .is_some()
6038 })
6039 }
6040
6041 pub fn git_init(
6042 &self,
6043 path: Arc<Path>,
6044 fallback_branch_name: String,
6045 cx: &App,
6046 ) -> Task<Result<()>> {
6047 self.git_store
6048 .read(cx)
6049 .git_init(path, fallback_branch_name, cx)
6050 }
6051
6052 pub fn buffer_store(&self) -> &Entity<BufferStore> {
6053 &self.buffer_store
6054 }
6055
6056 pub fn git_store(&self) -> &Entity<GitStore> {
6057 &self.git_store
6058 }
6059
6060 pub fn agent_server_store(&self) -> &Entity<AgentServerStore> {
6061 &self.agent_server_store
6062 }
6063
6064 #[cfg(feature = "test-support")]
6065 pub fn git_scans_complete(&self, cx: &Context<Self>) -> Task<()> {
6066 use futures::future::join_all;
6067 cx.spawn(async move |this, cx| {
6068 let scans_complete = this
6069 .read_with(cx, |this, cx| {
6070 this.worktrees(cx)
6071 .filter_map(|worktree| Some(worktree.read(cx).as_local()?.scan_complete()))
6072 .collect::<Vec<_>>()
6073 })
6074 .unwrap();
6075 join_all(scans_complete).await;
6076 let barriers = this
6077 .update(cx, |this, cx| {
6078 let repos = this.repositories(cx).values().cloned().collect::<Vec<_>>();
6079 repos
6080 .into_iter()
6081 .map(|repo| repo.update(cx, |repo, _| repo.barrier()))
6082 .collect::<Vec<_>>()
6083 })
6084 .unwrap();
6085 join_all(barriers).await;
6086 })
6087 }
6088
6089 pub fn active_repository(&self, cx: &App) -> Option<Entity<Repository>> {
6090 self.git_store.read(cx).active_repository()
6091 }
6092
6093 pub fn repositories<'a>(&self, cx: &'a App) -> &'a HashMap<RepositoryId, Entity<Repository>> {
6094 self.git_store.read(cx).repositories()
6095 }
6096
6097 pub fn status_for_buffer_id(&self, buffer_id: BufferId, cx: &App) -> Option<FileStatus> {
6098 self.git_store.read(cx).status_for_buffer_id(buffer_id, cx)
6099 }
6100
6101 pub fn set_agent_location(
6102 &mut self,
6103 new_location: Option<AgentLocation>,
6104 cx: &mut Context<Self>,
6105 ) {
6106 if let Some(old_location) = self.agent_location.as_ref() {
6107 old_location
6108 .buffer
6109 .update(cx, |buffer, cx| buffer.remove_agent_selections(cx))
6110 .ok();
6111 }
6112
6113 if let Some(location) = new_location.as_ref() {
6114 location
6115 .buffer
6116 .update(cx, |buffer, cx| {
6117 buffer.set_agent_selections(
6118 Arc::from([language::Selection {
6119 id: 0,
6120 start: location.position,
6121 end: location.position,
6122 reversed: false,
6123 goal: language::SelectionGoal::None,
6124 }]),
6125 false,
6126 CursorShape::Hollow,
6127 cx,
6128 )
6129 })
6130 .ok();
6131 }
6132
6133 self.agent_location = new_location;
6134 cx.emit(Event::AgentLocationChanged);
6135 }
6136
6137 pub fn agent_location(&self) -> Option<AgentLocation> {
6138 self.agent_location.clone()
6139 }
6140
6141 pub fn path_style(&self, cx: &App) -> PathStyle {
6142 self.worktree_store.read(cx).path_style()
6143 }
6144
6145 pub fn contains_local_settings_file(
6146 &self,
6147 worktree_id: WorktreeId,
6148 rel_path: &RelPath,
6149 cx: &App,
6150 ) -> bool {
6151 self.worktree_for_id(worktree_id, cx)
6152 .map_or(false, |worktree| {
6153 worktree.read(cx).entry_for_path(rel_path).is_some()
6154 })
6155 }
6156
6157 pub fn worktree_paths(&self, cx: &App) -> WorktreePaths {
6158 self.worktree_store.read(cx).paths(cx)
6159 }
6160
6161 pub fn project_group_key(&self, cx: &App) -> ProjectGroupKey {
6162 ProjectGroupKey::from_project(self, cx)
6163 }
6164}
6165
6166/// Identifies a project group by a set of paths the workspaces in this group
6167/// have.
6168///
6169/// Paths are mapped to their main worktree path first so we can group
6170/// workspaces by main repos.
6171#[derive(PartialEq, Eq, Hash, Clone, Debug, Default)]
6172pub struct ProjectGroupKey {
6173 /// The paths of the main worktrees for this project group.
6174 paths: PathList,
6175 host: Option<RemoteConnectionOptions>,
6176}
6177
6178impl ProjectGroupKey {
6179 /// Creates a new `ProjectGroupKey` with the given path list.
6180 ///
6181 /// The path list should point to the git main worktree paths for a project.
6182 pub fn new(host: Option<RemoteConnectionOptions>, paths: PathList) -> Self {
6183 Self { paths, host }
6184 }
6185
6186 pub fn from_project(project: &Project, cx: &App) -> Self {
6187 let paths = project.worktree_paths(cx);
6188 let host = project.remote_connection_options(cx);
6189 Self {
6190 paths: paths.main_worktree_path_list().clone(),
6191 host,
6192 }
6193 }
6194
6195 pub fn from_worktree_paths(
6196 paths: &WorktreePaths,
6197 host: Option<RemoteConnectionOptions>,
6198 ) -> Self {
6199 Self {
6200 paths: paths.main_worktree_path_list().clone(),
6201 host,
6202 }
6203 }
6204
6205 pub fn path_list(&self) -> &PathList {
6206 &self.paths
6207 }
6208
6209 pub fn display_name(
6210 &self,
6211 path_detail_map: &std::collections::HashMap<PathBuf, usize>,
6212 ) -> SharedString {
6213 let mut names = Vec::with_capacity(self.paths.paths().len());
6214 for abs_path in self.paths.ordered_paths() {
6215 let detail = path_detail_map.get(abs_path).copied().unwrap_or(0);
6216 let suffix = path_suffix(abs_path, detail);
6217 if !suffix.is_empty() {
6218 names.push(suffix);
6219 }
6220 }
6221 if names.is_empty() {
6222 "Empty Workspace".into()
6223 } else {
6224 names.join(", ").into()
6225 }
6226 }
6227
6228 pub fn host(&self) -> Option<RemoteConnectionOptions> {
6229 self.host.clone()
6230 }
6231}
6232
6233pub fn path_suffix(path: &Path, detail: usize) -> String {
6234 let mut components: Vec<_> = path
6235 .components()
6236 .rev()
6237 .filter_map(|component| match component {
6238 std::path::Component::Normal(s) => Some(s.to_string_lossy()),
6239 _ => None,
6240 })
6241 .take(detail + 1)
6242 .collect();
6243 components.reverse();
6244 components.join("/")
6245}
6246
6247pub struct PathMatchCandidateSet {
6248 pub snapshot: Snapshot,
6249 pub include_ignored: bool,
6250 pub include_root_name: bool,
6251 pub candidates: Candidates,
6252}
6253
6254pub enum Candidates {
6255 /// Only consider directories.
6256 Directories,
6257 /// Only consider files.
6258 Files,
6259 /// Consider directories and files.
6260 Entries,
6261}
6262
6263impl<'a> fuzzy::PathMatchCandidateSet<'a> for PathMatchCandidateSet {
6264 type Candidates = PathMatchCandidateSetIter<'a>;
6265
6266 fn id(&self) -> usize {
6267 self.snapshot.id().to_usize()
6268 }
6269
6270 fn len(&self) -> usize {
6271 match self.candidates {
6272 Candidates::Files => {
6273 if self.include_ignored {
6274 self.snapshot.file_count()
6275 } else {
6276 self.snapshot.visible_file_count()
6277 }
6278 }
6279
6280 Candidates::Directories => {
6281 if self.include_ignored {
6282 self.snapshot.dir_count()
6283 } else {
6284 self.snapshot.visible_dir_count()
6285 }
6286 }
6287
6288 Candidates::Entries => {
6289 if self.include_ignored {
6290 self.snapshot.entry_count()
6291 } else {
6292 self.snapshot.visible_entry_count()
6293 }
6294 }
6295 }
6296 }
6297
6298 fn prefix(&self) -> Arc<RelPath> {
6299 if self.snapshot.root_entry().is_some_and(|e| e.is_file()) || self.include_root_name {
6300 self.snapshot.root_name().into()
6301 } else {
6302 RelPath::empty().into()
6303 }
6304 }
6305
6306 fn root_is_file(&self) -> bool {
6307 self.snapshot.root_entry().is_some_and(|f| f.is_file())
6308 }
6309
6310 fn path_style(&self) -> PathStyle {
6311 self.snapshot.path_style()
6312 }
6313
6314 fn candidates(&'a self, start: usize) -> Self::Candidates {
6315 PathMatchCandidateSetIter {
6316 traversal: match self.candidates {
6317 Candidates::Directories => self.snapshot.directories(self.include_ignored, start),
6318 Candidates::Files => self.snapshot.files(self.include_ignored, start),
6319 Candidates::Entries => self.snapshot.entries(self.include_ignored, start),
6320 },
6321 }
6322 }
6323}
6324
6325pub struct PathMatchCandidateSetIter<'a> {
6326 traversal: Traversal<'a>,
6327}
6328
6329impl<'a> Iterator for PathMatchCandidateSetIter<'a> {
6330 type Item = fuzzy::PathMatchCandidate<'a>;
6331
6332 fn next(&mut self) -> Option<Self::Item> {
6333 self.traversal
6334 .next()
6335 .map(|entry| fuzzy::PathMatchCandidate {
6336 is_dir: entry.kind.is_dir(),
6337 path: &entry.path,
6338 char_bag: entry.char_bag,
6339 })
6340 }
6341}
6342
6343impl<'a> fuzzy_nucleo::PathMatchCandidateSet<'a> for PathMatchCandidateSet {
6344 type Candidates = PathMatchCandidateSetNucleoIter<'a>;
6345 fn id(&self) -> usize {
6346 self.snapshot.id().to_usize()
6347 }
6348 fn len(&self) -> usize {
6349 match self.candidates {
6350 Candidates::Files => {
6351 if self.include_ignored {
6352 self.snapshot.file_count()
6353 } else {
6354 self.snapshot.visible_file_count()
6355 }
6356 }
6357 Candidates::Directories => {
6358 if self.include_ignored {
6359 self.snapshot.dir_count()
6360 } else {
6361 self.snapshot.visible_dir_count()
6362 }
6363 }
6364 Candidates::Entries => {
6365 if self.include_ignored {
6366 self.snapshot.entry_count()
6367 } else {
6368 self.snapshot.visible_entry_count()
6369 }
6370 }
6371 }
6372 }
6373 fn prefix(&self) -> Arc<RelPath> {
6374 if self.snapshot.root_entry().is_some_and(|e| e.is_file()) || self.include_root_name {
6375 self.snapshot.root_name().into()
6376 } else {
6377 RelPath::empty().into()
6378 }
6379 }
6380 fn root_is_file(&self) -> bool {
6381 self.snapshot.root_entry().is_some_and(|f| f.is_file())
6382 }
6383 fn path_style(&self) -> PathStyle {
6384 self.snapshot.path_style()
6385 }
6386 fn candidates(&'a self, start: usize) -> Self::Candidates {
6387 PathMatchCandidateSetNucleoIter {
6388 traversal: match self.candidates {
6389 Candidates::Directories => self.snapshot.directories(self.include_ignored, start),
6390 Candidates::Files => self.snapshot.files(self.include_ignored, start),
6391 Candidates::Entries => self.snapshot.entries(self.include_ignored, start),
6392 },
6393 }
6394 }
6395}
6396
6397pub struct PathMatchCandidateSetNucleoIter<'a> {
6398 traversal: Traversal<'a>,
6399}
6400
6401impl<'a> Iterator for PathMatchCandidateSetNucleoIter<'a> {
6402 type Item = fuzzy_nucleo::PathMatchCandidate<'a>;
6403 fn next(&mut self) -> Option<Self::Item> {
6404 self.traversal
6405 .next()
6406 .map(|entry| fuzzy_nucleo::PathMatchCandidate {
6407 is_dir: entry.kind.is_dir(),
6408 path: &entry.path,
6409 })
6410 }
6411}
6412
6413impl EventEmitter<Event> for Project {}
6414
6415impl<'a> From<&'a ProjectPath> for SettingsLocation<'a> {
6416 fn from(val: &'a ProjectPath) -> Self {
6417 SettingsLocation {
6418 worktree_id: val.worktree_id,
6419 path: val.path.as_ref(),
6420 }
6421 }
6422}
6423
6424impl<P: Into<Arc<RelPath>>> From<(WorktreeId, P)> for ProjectPath {
6425 fn from((worktree_id, path): (WorktreeId, P)) -> Self {
6426 Self {
6427 worktree_id,
6428 path: path.into(),
6429 }
6430 }
6431}
6432
6433/// ResolvedPath is a path that has been resolved to either a ProjectPath
6434/// or an AbsPath and that *exists*.
6435#[derive(Debug, Clone)]
6436pub enum ResolvedPath {
6437 ProjectPath {
6438 project_path: ProjectPath,
6439 is_dir: bool,
6440 },
6441 AbsPath {
6442 path: String,
6443 is_dir: bool,
6444 },
6445}
6446
6447impl ResolvedPath {
6448 pub fn abs_path(&self) -> Option<&str> {
6449 match self {
6450 Self::AbsPath { path, .. } => Some(path),
6451 _ => None,
6452 }
6453 }
6454
6455 pub fn into_abs_path(self) -> Option<String> {
6456 match self {
6457 Self::AbsPath { path, .. } => Some(path),
6458 _ => None,
6459 }
6460 }
6461
6462 pub fn project_path(&self) -> Option<&ProjectPath> {
6463 match self {
6464 Self::ProjectPath { project_path, .. } => Some(project_path),
6465 _ => None,
6466 }
6467 }
6468
6469 pub fn is_file(&self) -> bool {
6470 !self.is_dir()
6471 }
6472
6473 pub fn is_dir(&self) -> bool {
6474 match self {
6475 Self::ProjectPath { is_dir, .. } => *is_dir,
6476 Self::AbsPath { is_dir, .. } => *is_dir,
6477 }
6478 }
6479}
6480
6481impl ProjectItem for Buffer {
6482 fn try_open(
6483 project: &Entity<Project>,
6484 path: &ProjectPath,
6485 cx: &mut App,
6486 ) -> Option<Task<Result<Entity<Self>>>> {
6487 Some(project.update(cx, |project, cx| project.open_buffer(path.clone(), cx)))
6488 }
6489
6490 fn entry_id(&self, _cx: &App) -> Option<ProjectEntryId> {
6491 File::from_dyn(self.file()).and_then(|file| file.project_entry_id())
6492 }
6493
6494 fn project_path(&self, cx: &App) -> Option<ProjectPath> {
6495 let file = self.file()?;
6496
6497 (!matches!(file.disk_state(), DiskState::Historic { .. })).then(|| ProjectPath {
6498 worktree_id: file.worktree_id(cx),
6499 path: file.path().clone(),
6500 })
6501 }
6502
6503 fn is_dirty(&self) -> bool {
6504 self.is_dirty()
6505 }
6506}
6507
6508impl Completion {
6509 pub fn kind(&self) -> Option<CompletionItemKind> {
6510 self.source
6511 // `lsp::CompletionListItemDefaults` has no `kind` field
6512 .lsp_completion(false)
6513 .and_then(|lsp_completion| lsp_completion.kind)
6514 }
6515
6516 pub fn label(&self) -> Option<String> {
6517 self.source
6518 .lsp_completion(false)
6519 .map(|lsp_completion| lsp_completion.label.clone())
6520 }
6521
6522 /// A key that can be used to sort completions when displaying
6523 /// them to the user.
6524 pub fn sort_key(&self) -> (usize, &str) {
6525 const DEFAULT_KIND_KEY: usize = 4;
6526 let kind_key = self
6527 .kind()
6528 .and_then(|lsp_completion_kind| match lsp_completion_kind {
6529 lsp::CompletionItemKind::KEYWORD => Some(0),
6530 lsp::CompletionItemKind::VARIABLE => Some(1),
6531 lsp::CompletionItemKind::CONSTANT => Some(2),
6532 lsp::CompletionItemKind::PROPERTY => Some(3),
6533 _ => None,
6534 })
6535 .unwrap_or(DEFAULT_KIND_KEY);
6536 (kind_key, self.label.filter_text())
6537 }
6538
6539 /// Whether this completion is a snippet.
6540 pub fn is_snippet_kind(&self) -> bool {
6541 matches!(
6542 &self.source,
6543 CompletionSource::Lsp { lsp_completion, .. }
6544 if lsp_completion.kind == Some(CompletionItemKind::SNIPPET)
6545 )
6546 }
6547
6548 /// Whether this completion is a snippet or snippet-style LSP completion.
6549 pub fn is_snippet(&self) -> bool {
6550 self.source
6551 // `lsp::CompletionListItemDefaults` has `insert_text_format` field
6552 .lsp_completion(true)
6553 .is_some_and(|lsp_completion| {
6554 lsp_completion.insert_text_format == Some(lsp::InsertTextFormat::SNIPPET)
6555 })
6556 }
6557
6558 /// Returns the corresponding color for this completion.
6559 ///
6560 /// Will return `None` if this completion's kind is not [`CompletionItemKind::COLOR`].
6561 pub fn color(&self) -> Option<Hsla> {
6562 // `lsp::CompletionListItemDefaults` has no `kind` field
6563 let lsp_completion = self.source.lsp_completion(false)?;
6564 if lsp_completion.kind? == CompletionItemKind::COLOR {
6565 return color_extractor::extract_color(&lsp_completion);
6566 }
6567 None
6568 }
6569}
6570
6571fn proto_to_prompt(level: proto::language_server_prompt_request::Level) -> gpui::PromptLevel {
6572 match level {
6573 proto::language_server_prompt_request::Level::Info(_) => gpui::PromptLevel::Info,
6574 proto::language_server_prompt_request::Level::Warning(_) => gpui::PromptLevel::Warning,
6575 proto::language_server_prompt_request::Level::Critical(_) => gpui::PromptLevel::Critical,
6576 }
6577}
6578
6579fn provide_inline_values(
6580 captures: impl Iterator<Item = (Range<usize>, language::DebuggerTextObject)>,
6581 snapshot: &language::BufferSnapshot,
6582 max_row: usize,
6583) -> Vec<InlineValueLocation> {
6584 let mut variables = Vec::new();
6585 let mut variable_position = HashSet::default();
6586 let mut scopes = Vec::new();
6587
6588 let active_debug_line_offset = snapshot.point_to_offset(Point::new(max_row as u32, 0));
6589
6590 for (capture_range, capture_kind) in captures {
6591 match capture_kind {
6592 language::DebuggerTextObject::Variable => {
6593 let variable_name = snapshot
6594 .text_for_range(capture_range.clone())
6595 .collect::<String>();
6596 let point = snapshot.offset_to_point(capture_range.end);
6597
6598 while scopes
6599 .last()
6600 .is_some_and(|scope: &Range<_>| !scope.contains(&capture_range.start))
6601 {
6602 scopes.pop();
6603 }
6604
6605 if point.row as usize > max_row {
6606 break;
6607 }
6608
6609 let scope = if scopes
6610 .last()
6611 .is_none_or(|scope| !scope.contains(&active_debug_line_offset))
6612 {
6613 VariableScope::Global
6614 } else {
6615 VariableScope::Local
6616 };
6617
6618 if variable_position.insert(capture_range.end) {
6619 variables.push(InlineValueLocation {
6620 variable_name,
6621 scope,
6622 lookup: VariableLookupKind::Variable,
6623 row: point.row as usize,
6624 column: point.column as usize,
6625 });
6626 }
6627 }
6628 language::DebuggerTextObject::Scope => {
6629 while scopes.last().map_or_else(
6630 || false,
6631 |scope: &Range<usize>| {
6632 !(scope.contains(&capture_range.start)
6633 && scope.contains(&capture_range.end))
6634 },
6635 ) {
6636 scopes.pop();
6637 }
6638 scopes.push(capture_range);
6639 }
6640 }
6641 }
6642
6643 variables
6644}