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