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