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