1use std::ops::Range;
2use std::path::PathBuf;
3use std::sync::Arc;
4
5use anyhow::{Context as _, Result};
6use async_trait::async_trait;
7use collections::{HashMap, HashSet};
8use extension::{Extension, ExtensionLanguageServerProxy, WorktreeDelegate};
9use futures::{FutureExt, future::join_all, lock::OwnedMutexGuard};
10use gpui::{App, AppContext, AsyncApp, Task};
11use language::{
12 BinaryStatus, CodeLabel, DynLspInstaller, HighlightId, Language, LanguageName,
13 LanguageServerBinaryLocations, LspAdapter, LspAdapterDelegate, Toolchain,
14};
15use lsp::{
16 CodeActionKind, LanguageServerBinary, LanguageServerBinaryOptions, LanguageServerName,
17 LanguageServerSelector,
18};
19use serde::Serialize;
20use serde_json::Value;
21use util::{ResultExt, fs::make_file_executable, maybe, rel_path::RelPath};
22
23use crate::{LanguageServerRegistryProxy, LspAccess};
24
25/// An adapter that allows an [`LspAdapterDelegate`] to be used as a [`WorktreeDelegate`].
26struct WorktreeDelegateAdapter(pub Arc<dyn LspAdapterDelegate>);
27
28#[async_trait]
29impl WorktreeDelegate for WorktreeDelegateAdapter {
30 fn id(&self) -> u64 {
31 self.0.worktree_id().to_proto()
32 }
33
34 fn root_path(&self) -> String {
35 self.0.worktree_root_path().to_string_lossy().into_owned()
36 }
37
38 async fn read_text_file(&self, path: &RelPath) -> Result<String> {
39 self.0.read_text_file(path).await
40 }
41
42 async fn which(&self, binary_name: String) -> Option<String> {
43 self.0
44 .which(binary_name.as_ref())
45 .await
46 .map(|path| path.to_string_lossy().into_owned())
47 }
48
49 async fn shell_env(&self) -> Vec<(String, String)> {
50 self.0.shell_env().await.into_iter().collect()
51 }
52}
53
54impl ExtensionLanguageServerProxy for LanguageServerRegistryProxy {
55 fn register_language_server(
56 &self,
57 extension: Arc<dyn Extension>,
58 language_server_id: LanguageServerName,
59 language: LanguageName,
60 ) {
61 self.language_registry.register_lsp_adapter(
62 language.clone(),
63 Arc::new(ExtensionLspAdapter::new(
64 extension,
65 language_server_id,
66 language,
67 )),
68 );
69 }
70
71 fn remove_language_server(
72 &self,
73 language: &LanguageName,
74 language_server_name: &LanguageServerName,
75 cx: &mut App,
76 ) -> Task<Result<()>> {
77 self.language_registry
78 .remove_lsp_adapter(language, language_server_name);
79
80 let mut tasks = Vec::new();
81 match &self.lsp_access {
82 LspAccess::ViaLspStore(lsp_store) => lsp_store.update(cx, |lsp_store, cx| {
83 let stop_task = lsp_store.stop_language_servers_for_buffers(
84 Vec::new(),
85 HashSet::from_iter([LanguageServerSelector::Name(
86 language_server_name.clone(),
87 )]),
88 cx,
89 );
90 tasks.push(stop_task);
91 }),
92 LspAccess::ViaWorkspaces(lsp_store_provider) => {
93 if let Ok(lsp_stores) = lsp_store_provider(cx) {
94 for lsp_store in lsp_stores {
95 lsp_store.update(cx, |lsp_store, cx| {
96 let stop_task = lsp_store.stop_language_servers_for_buffers(
97 Vec::new(),
98 HashSet::from_iter([LanguageServerSelector::Name(
99 language_server_name.clone(),
100 )]),
101 cx,
102 );
103 tasks.push(stop_task);
104 });
105 }
106 }
107 }
108 LspAccess::Noop => {}
109 }
110
111 cx.background_spawn(async move {
112 let results = join_all(tasks).await;
113 for result in results {
114 result?;
115 }
116 Ok(())
117 })
118 }
119
120 fn update_language_server_status(
121 &self,
122 language_server_id: LanguageServerName,
123 status: BinaryStatus,
124 ) {
125 log::debug!(
126 "updating binary status for {} to {:?}",
127 language_server_id,
128 status
129 );
130 self.language_registry
131 .update_lsp_binary_status(language_server_id, status);
132 }
133}
134
135struct ExtensionLspAdapter {
136 extension: Arc<dyn Extension>,
137 language_server_id: LanguageServerName,
138 language_name: LanguageName,
139}
140
141impl ExtensionLspAdapter {
142 fn new(
143 extension: Arc<dyn Extension>,
144 language_server_id: LanguageServerName,
145 language_name: LanguageName,
146 ) -> Self {
147 Self {
148 extension,
149 language_server_id,
150 language_name,
151 }
152 }
153}
154
155#[async_trait(?Send)]
156impl DynLspInstaller for ExtensionLspAdapter {
157 fn get_language_server_command(
158 self: Arc<Self>,
159 delegate: Arc<dyn LspAdapterDelegate>,
160 _: Option<Toolchain>,
161 _: LanguageServerBinaryOptions,
162 _: OwnedMutexGuard<Option<(bool, LanguageServerBinary)>>,
163 _: AsyncApp,
164 ) -> LanguageServerBinaryLocations {
165 async move {
166 let ret = maybe!(async move {
167 let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
168 let command = self
169 .extension
170 .language_server_command(
171 self.language_server_id.clone(),
172 self.language_name.clone(),
173 delegate,
174 )
175 .await?;
176
177 let path = self.extension.path_from_extension(command.command.as_ref());
178
179 // TODO: This should now be done via the `zed::make_file_executable` function in
180 // Zed extension API, but we're leaving these existing usages in place temporarily
181 // to avoid any compatibility issues between Zed and the extension versions.
182 //
183 // We can remove once the following extension versions no longer see any use:
184 // - toml@0.0.2
185 // - zig@0.0.1
186 if ["toml", "zig"].contains(&self.extension.manifest().id.as_ref())
187 && path.starts_with(&self.extension.work_dir())
188 {
189 make_file_executable(&path)
190 .await
191 .context("failed to set file permissions")?;
192 }
193
194 Ok(LanguageServerBinary {
195 path,
196 arguments: command.args.into_iter().map(|arg| arg.into()).collect(),
197 env: Some(command.env.into_iter().collect()),
198 })
199 })
200 .await;
201 (ret, None)
202 }
203 .boxed_local()
204 }
205
206 async fn try_fetch_server_binary(
207 &self,
208 _: &Arc<dyn LspAdapterDelegate>,
209 _: PathBuf,
210 _: bool,
211 _: &mut AsyncApp,
212 ) -> Result<LanguageServerBinary> {
213 unreachable!("get_language_server_command is overridden")
214 }
215}
216
217#[async_trait(?Send)]
218impl LspAdapter for ExtensionLspAdapter {
219 fn name(&self) -> LanguageServerName {
220 self.language_server_id.clone()
221 }
222
223 fn code_action_kinds(&self) -> Option<Vec<CodeActionKind>> {
224 let code_action_kinds = self
225 .extension
226 .manifest()
227 .language_servers
228 .get(&self.language_server_id)
229 .and_then(|server| server.code_action_kinds.clone());
230
231 code_action_kinds.or(Some(vec![
232 CodeActionKind::EMPTY,
233 CodeActionKind::QUICKFIX,
234 CodeActionKind::REFACTOR,
235 CodeActionKind::REFACTOR_EXTRACT,
236 CodeActionKind::SOURCE,
237 ]))
238 }
239
240 fn language_ids(&self) -> HashMap<LanguageName, String> {
241 // TODO: The language IDs can be provided via the language server options
242 // in `extension.toml now but we're leaving these existing usages in place temporarily
243 // to avoid any compatibility issues between Zed and the extension versions.
244 //
245 // We can remove once the following extension versions no longer see any use:
246 // - php@0.0.1
247 if self.extension.manifest().id.as_ref() == "php" {
248 return HashMap::from_iter([(LanguageName::new("PHP"), "php".into())]);
249 }
250
251 self.extension
252 .manifest()
253 .language_servers
254 .get(&self.language_server_id)
255 .map(|server| server.language_ids.clone())
256 .unwrap_or_default()
257 }
258
259 async fn initialization_options(
260 self: Arc<Self>,
261 delegate: &Arc<dyn LspAdapterDelegate>,
262 ) -> Result<Option<serde_json::Value>> {
263 let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
264 let json_options = self
265 .extension
266 .language_server_initialization_options(
267 self.language_server_id.clone(),
268 self.language_name.clone(),
269 delegate,
270 )
271 .await?;
272 Ok(if let Some(json_options) = json_options {
273 serde_json::from_str(&json_options).with_context(|| {
274 format!("failed to parse initialization_options from extension: {json_options}")
275 })?
276 } else {
277 None
278 })
279 }
280
281 async fn workspace_configuration(
282 self: Arc<Self>,
283 delegate: &Arc<dyn LspAdapterDelegate>,
284 _: Option<Toolchain>,
285 _cx: &mut AsyncApp,
286 ) -> Result<Value> {
287 let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
288 let json_options: Option<String> = self
289 .extension
290 .language_server_workspace_configuration(self.language_server_id.clone(), delegate)
291 .await?;
292 Ok(if let Some(json_options) = json_options {
293 serde_json::from_str(&json_options).with_context(|| {
294 format!("failed to parse workspace_configuration from extension: {json_options}")
295 })?
296 } else {
297 serde_json::json!({})
298 })
299 }
300
301 async fn additional_initialization_options(
302 self: Arc<Self>,
303 target_language_server_id: LanguageServerName,
304 delegate: &Arc<dyn LspAdapterDelegate>,
305 ) -> Result<Option<serde_json::Value>> {
306 let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
307 let json_options: Option<String> = self
308 .extension
309 .language_server_additional_initialization_options(
310 self.language_server_id.clone(),
311 target_language_server_id.clone(),
312 delegate,
313 )
314 .await?;
315 Ok(if let Some(json_options) = json_options {
316 serde_json::from_str(&json_options).with_context(|| {
317 format!(
318 "failed to parse additional_initialization_options from extension: {json_options}"
319 )
320 })?
321 } else {
322 None
323 })
324 }
325
326 async fn additional_workspace_configuration(
327 self: Arc<Self>,
328 target_language_server_id: LanguageServerName,
329
330 delegate: &Arc<dyn LspAdapterDelegate>,
331
332 _cx: &mut AsyncApp,
333 ) -> Result<Option<serde_json::Value>> {
334 let delegate = Arc::new(WorktreeDelegateAdapter(delegate.clone())) as _;
335 let json_options: Option<String> = self
336 .extension
337 .language_server_additional_workspace_configuration(
338 self.language_server_id.clone(),
339 target_language_server_id.clone(),
340 delegate,
341 )
342 .await?;
343 Ok(if let Some(json_options) = json_options {
344 serde_json::from_str(&json_options).with_context(|| {
345 format!("failed to parse additional_workspace_configuration from extension: {json_options}")
346 })?
347 } else {
348 None
349 })
350 }
351
352 async fn labels_for_completions(
353 self: Arc<Self>,
354 completions: &[lsp::CompletionItem],
355 language: &Arc<Language>,
356 ) -> Result<Vec<Option<CodeLabel>>> {
357 let completions = completions
358 .iter()
359 .cloned()
360 .map(lsp_completion_to_extension)
361 .collect::<Vec<_>>();
362
363 let labels = self
364 .extension
365 .labels_for_completions(self.language_server_id.clone(), completions)
366 .await?;
367
368 Ok(labels_from_extension(labels, language))
369 }
370
371 async fn labels_for_symbols(
372 self: Arc<Self>,
373 symbols: &[(String, lsp::SymbolKind)],
374 language: &Arc<Language>,
375 ) -> Result<Vec<Option<CodeLabel>>> {
376 let symbols = symbols
377 .iter()
378 .cloned()
379 .map(|(name, kind)| extension::Symbol {
380 name,
381 kind: lsp_symbol_kind_to_extension(kind),
382 })
383 .collect::<Vec<_>>();
384
385 let labels = self
386 .extension
387 .labels_for_symbols(self.language_server_id.clone(), symbols)
388 .await?;
389
390 Ok(labels_from_extension(labels, language))
391 }
392
393 fn is_extension(&self) -> bool {
394 true
395 }
396}
397
398fn labels_from_extension(
399 labels: Vec<Option<extension::CodeLabel>>,
400 language: &Arc<Language>,
401) -> Vec<Option<CodeLabel>> {
402 labels
403 .into_iter()
404 .map(|label| {
405 let label = label?;
406 let runs = if label.code.is_empty() {
407 Vec::new()
408 } else {
409 language.highlight_text(&label.code.as_str().into(), 0..label.code.len())
410 };
411 build_code_label(&label, &runs, language)
412 })
413 .collect()
414}
415
416fn build_code_label(
417 label: &extension::CodeLabel,
418 parsed_runs: &[(Range<usize>, HighlightId)],
419 language: &Arc<Language>,
420) -> Option<CodeLabel> {
421 let mut text = String::new();
422 let mut runs = vec![];
423
424 for span in &label.spans {
425 match span {
426 extension::CodeLabelSpan::CodeRange(range) => {
427 let code_span = &label.code.get(range.clone())?;
428 let mut input_ix = range.start;
429 let mut output_ix = text.len();
430 for (run_range, id) in parsed_runs {
431 if run_range.start >= range.end {
432 break;
433 }
434 if run_range.end <= input_ix {
435 continue;
436 }
437
438 if run_range.start > input_ix {
439 let len = run_range.start - input_ix;
440 output_ix += len;
441 input_ix += len;
442 }
443
444 let len = range.end.min(run_range.end) - input_ix;
445 runs.push((output_ix..output_ix + len, *id));
446 output_ix += len;
447 input_ix += len;
448 }
449
450 text.push_str(code_span);
451 }
452 extension::CodeLabelSpan::Literal(span) => {
453 let highlight_id = language
454 .grammar()
455 .zip(span.highlight_name.as_ref())
456 .and_then(|(grammar, highlight_name)| {
457 grammar.highlight_id_for_name(highlight_name)
458 })
459 .unwrap_or_default();
460 let ix = text.len();
461 runs.push((ix..ix + span.text.len(), highlight_id));
462 text.push_str(&span.text);
463 }
464 }
465 }
466
467 let filter_range = label.filter_range.clone();
468 text.get(filter_range.clone())?;
469 Some(CodeLabel::new(text, filter_range, runs))
470}
471
472fn lsp_completion_to_extension(value: lsp::CompletionItem) -> extension::Completion {
473 extension::Completion {
474 label: value.label,
475 label_details: value
476 .label_details
477 .map(lsp_completion_item_label_details_to_extension),
478 detail: value.detail,
479 kind: value.kind.map(lsp_completion_item_kind_to_extension),
480 insert_text_format: value
481 .insert_text_format
482 .map(lsp_insert_text_format_to_extension),
483 }
484}
485
486fn lsp_completion_item_label_details_to_extension(
487 value: lsp::CompletionItemLabelDetails,
488) -> extension::CompletionLabelDetails {
489 extension::CompletionLabelDetails {
490 detail: value.detail,
491 description: value.description,
492 }
493}
494
495fn lsp_completion_item_kind_to_extension(
496 value: lsp::CompletionItemKind,
497) -> extension::CompletionKind {
498 match value {
499 lsp::CompletionItemKind::TEXT => extension::CompletionKind::Text,
500 lsp::CompletionItemKind::METHOD => extension::CompletionKind::Method,
501 lsp::CompletionItemKind::FUNCTION => extension::CompletionKind::Function,
502 lsp::CompletionItemKind::CONSTRUCTOR => extension::CompletionKind::Constructor,
503 lsp::CompletionItemKind::FIELD => extension::CompletionKind::Field,
504 lsp::CompletionItemKind::VARIABLE => extension::CompletionKind::Variable,
505 lsp::CompletionItemKind::CLASS => extension::CompletionKind::Class,
506 lsp::CompletionItemKind::INTERFACE => extension::CompletionKind::Interface,
507 lsp::CompletionItemKind::MODULE => extension::CompletionKind::Module,
508 lsp::CompletionItemKind::PROPERTY => extension::CompletionKind::Property,
509 lsp::CompletionItemKind::UNIT => extension::CompletionKind::Unit,
510 lsp::CompletionItemKind::VALUE => extension::CompletionKind::Value,
511 lsp::CompletionItemKind::ENUM => extension::CompletionKind::Enum,
512 lsp::CompletionItemKind::KEYWORD => extension::CompletionKind::Keyword,
513 lsp::CompletionItemKind::SNIPPET => extension::CompletionKind::Snippet,
514 lsp::CompletionItemKind::COLOR => extension::CompletionKind::Color,
515 lsp::CompletionItemKind::FILE => extension::CompletionKind::File,
516 lsp::CompletionItemKind::REFERENCE => extension::CompletionKind::Reference,
517 lsp::CompletionItemKind::FOLDER => extension::CompletionKind::Folder,
518 lsp::CompletionItemKind::ENUM_MEMBER => extension::CompletionKind::EnumMember,
519 lsp::CompletionItemKind::CONSTANT => extension::CompletionKind::Constant,
520 lsp::CompletionItemKind::STRUCT => extension::CompletionKind::Struct,
521 lsp::CompletionItemKind::EVENT => extension::CompletionKind::Event,
522 lsp::CompletionItemKind::OPERATOR => extension::CompletionKind::Operator,
523 lsp::CompletionItemKind::TYPE_PARAMETER => extension::CompletionKind::TypeParameter,
524 _ => extension::CompletionKind::Other(extract_int(value)),
525 }
526}
527
528fn lsp_insert_text_format_to_extension(
529 value: lsp::InsertTextFormat,
530) -> extension::InsertTextFormat {
531 match value {
532 lsp::InsertTextFormat::PLAIN_TEXT => extension::InsertTextFormat::PlainText,
533 lsp::InsertTextFormat::SNIPPET => extension::InsertTextFormat::Snippet,
534 _ => extension::InsertTextFormat::Other(extract_int(value)),
535 }
536}
537
538fn lsp_symbol_kind_to_extension(value: lsp::SymbolKind) -> extension::SymbolKind {
539 match value {
540 lsp::SymbolKind::FILE => extension::SymbolKind::File,
541 lsp::SymbolKind::MODULE => extension::SymbolKind::Module,
542 lsp::SymbolKind::NAMESPACE => extension::SymbolKind::Namespace,
543 lsp::SymbolKind::PACKAGE => extension::SymbolKind::Package,
544 lsp::SymbolKind::CLASS => extension::SymbolKind::Class,
545 lsp::SymbolKind::METHOD => extension::SymbolKind::Method,
546 lsp::SymbolKind::PROPERTY => extension::SymbolKind::Property,
547 lsp::SymbolKind::FIELD => extension::SymbolKind::Field,
548 lsp::SymbolKind::CONSTRUCTOR => extension::SymbolKind::Constructor,
549 lsp::SymbolKind::ENUM => extension::SymbolKind::Enum,
550 lsp::SymbolKind::INTERFACE => extension::SymbolKind::Interface,
551 lsp::SymbolKind::FUNCTION => extension::SymbolKind::Function,
552 lsp::SymbolKind::VARIABLE => extension::SymbolKind::Variable,
553 lsp::SymbolKind::CONSTANT => extension::SymbolKind::Constant,
554 lsp::SymbolKind::STRING => extension::SymbolKind::String,
555 lsp::SymbolKind::NUMBER => extension::SymbolKind::Number,
556 lsp::SymbolKind::BOOLEAN => extension::SymbolKind::Boolean,
557 lsp::SymbolKind::ARRAY => extension::SymbolKind::Array,
558 lsp::SymbolKind::OBJECT => extension::SymbolKind::Object,
559 lsp::SymbolKind::KEY => extension::SymbolKind::Key,
560 lsp::SymbolKind::NULL => extension::SymbolKind::Null,
561 lsp::SymbolKind::ENUM_MEMBER => extension::SymbolKind::EnumMember,
562 lsp::SymbolKind::STRUCT => extension::SymbolKind::Struct,
563 lsp::SymbolKind::EVENT => extension::SymbolKind::Event,
564 lsp::SymbolKind::OPERATOR => extension::SymbolKind::Operator,
565 lsp::SymbolKind::TYPE_PARAMETER => extension::SymbolKind::TypeParameter,
566 _ => extension::SymbolKind::Other(extract_int(value)),
567 }
568}
569
570fn extract_int<T: Serialize>(value: T) -> i32 {
571 maybe!({
572 let kind = serde_json::to_value(&value)?;
573 serde_json::from_value(kind)
574 })
575 .log_err()
576 .unwrap_or(-1)
577}
578
579#[test]
580fn test_build_code_label() {
581 use util::test::marked_text_ranges;
582
583 let (code, code_ranges) = marked_text_ranges(
584 "«const» «a»: «fn»(«Bcd»(«Efgh»)) -> «Ijklm» = pqrs.tuv",
585 false,
586 );
587 let code_runs = code_ranges
588 .into_iter()
589 .map(|range| (range, HighlightId(0)))
590 .collect::<Vec<_>>();
591
592 let label = build_code_label(
593 &extension::CodeLabel {
594 spans: vec![
595 extension::CodeLabelSpan::CodeRange(code.find("pqrs").unwrap()..code.len()),
596 extension::CodeLabelSpan::CodeRange(
597 code.find(": fn").unwrap()..code.find(" = ").unwrap(),
598 ),
599 ],
600 filter_range: 0.."pqrs.tuv".len(),
601 code,
602 },
603 &code_runs,
604 &language::PLAIN_TEXT,
605 )
606 .unwrap();
607
608 let (label_text, label_ranges) =
609 marked_text_ranges("pqrs.tuv: «fn»(«Bcd»(«Efgh»)) -> «Ijklm»", false);
610 let label_runs = label_ranges
611 .into_iter()
612 .map(|range| (range, HighlightId(0)))
613 .collect::<Vec<_>>();
614
615 assert_eq!(
616 label,
617 CodeLabel::new(label_text, label.filter_range.clone(), label_runs)
618 )
619}
620
621#[test]
622fn test_build_code_label_with_invalid_ranges() {
623 use util::test::marked_text_ranges;
624
625 let (code, code_ranges) = marked_text_ranges("const «a»: «B» = '🏀'", false);
626 let code_runs = code_ranges
627 .into_iter()
628 .map(|range| (range, HighlightId(0)))
629 .collect::<Vec<_>>();
630
631 // A span uses a code range that is invalid because it starts inside of
632 // a multi-byte character.
633 let label = build_code_label(
634 &extension::CodeLabel {
635 spans: vec![
636 extension::CodeLabelSpan::CodeRange(
637 code.find('B').unwrap()..code.find(" = ").unwrap(),
638 ),
639 extension::CodeLabelSpan::CodeRange((code.find('🏀').unwrap() + 1)..code.len()),
640 ],
641 filter_range: 0.."B".len(),
642 code,
643 },
644 &code_runs,
645 &language::PLAIN_TEXT,
646 );
647 assert!(label.is_none());
648
649 // Filter range extends beyond actual text
650 let label = build_code_label(
651 &extension::CodeLabel {
652 spans: vec![extension::CodeLabelSpan::Literal(
653 extension::CodeLabelSpanLiteral {
654 text: "abc".into(),
655 highlight_name: Some("type".into()),
656 },
657 )],
658 filter_range: 0..5,
659 code: String::new(),
660 },
661 &code_runs,
662 &language::PLAIN_TEXT,
663 );
664 assert!(label.is_none());
665}