1use crate::{
2 DocumentHighlight, Hover, HoverBlock, HoverBlockKind, InlayHint, InlayHintLabel,
3 InlayHintLabelPart, InlayHintLabelPartTooltip, InlayHintTooltip, Location, LocationLink,
4 MarkupContent, Project, ProjectTransaction, ResolveState,
5};
6use anyhow::{anyhow, Context, Result};
7use async_trait::async_trait;
8use client::proto::{self, PeerId};
9use futures::future;
10use gpui::{AppContext, AsyncAppContext, Model};
11use language::{
12 language_settings::{language_settings, InlayHintKind},
13 point_from_lsp, point_to_lsp, prepare_completion_documentation,
14 proto::{deserialize_anchor, deserialize_version, serialize_anchor, serialize_version},
15 range_from_lsp, range_to_lsp, Anchor, Bias, Buffer, BufferSnapshot, CachedLspAdapter, CharKind,
16 CodeAction, Completion, OffsetRangeExt, PointUtf16, ToOffset, ToPointUtf16, Transaction,
17 Unclipped,
18};
19use lsp::{
20 CompletionListItemDefaultsEditRange, DocumentHighlightKind, LanguageServer, LanguageServerId,
21 OneOf, ServerCapabilities,
22};
23use std::{cmp::Reverse, ops::Range, path::Path, sync::Arc};
24use text::LineEnding;
25
26pub fn lsp_formatting_options(tab_size: u32) -> lsp::FormattingOptions {
27 lsp::FormattingOptions {
28 tab_size,
29 insert_spaces: true,
30 insert_final_newline: Some(true),
31 ..lsp::FormattingOptions::default()
32 }
33}
34
35#[async_trait(?Send)]
36pub(crate) trait LspCommand: 'static + Sized + Send {
37 type Response: 'static + Default + Send;
38 type LspRequest: 'static + Send + lsp::request::Request;
39 type ProtoRequest: 'static + Send + proto::RequestMessage;
40
41 fn check_capabilities(&self, _: &lsp::ServerCapabilities) -> bool {
42 true
43 }
44
45 fn to_lsp(
46 &self,
47 path: &Path,
48 buffer: &Buffer,
49 language_server: &Arc<LanguageServer>,
50 cx: &AppContext,
51 ) -> <Self::LspRequest as lsp::request::Request>::Params;
52
53 async fn response_from_lsp(
54 self,
55 message: <Self::LspRequest as lsp::request::Request>::Result,
56 project: Model<Project>,
57 buffer: Model<Buffer>,
58 server_id: LanguageServerId,
59 cx: AsyncAppContext,
60 ) -> Result<Self::Response>;
61
62 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> Self::ProtoRequest;
63
64 async fn from_proto(
65 message: Self::ProtoRequest,
66 project: Model<Project>,
67 buffer: Model<Buffer>,
68 cx: AsyncAppContext,
69 ) -> Result<Self>;
70
71 fn response_to_proto(
72 response: Self::Response,
73 project: &mut Project,
74 peer_id: PeerId,
75 buffer_version: &clock::Global,
76 cx: &mut AppContext,
77 ) -> <Self::ProtoRequest as proto::RequestMessage>::Response;
78
79 async fn response_from_proto(
80 self,
81 message: <Self::ProtoRequest as proto::RequestMessage>::Response,
82 project: Model<Project>,
83 buffer: Model<Buffer>,
84 cx: AsyncAppContext,
85 ) -> Result<Self::Response>;
86
87 fn buffer_id_from_proto(message: &Self::ProtoRequest) -> u64;
88}
89
90pub(crate) struct PrepareRename {
91 pub position: PointUtf16,
92}
93
94pub(crate) struct PerformRename {
95 pub position: PointUtf16,
96 pub new_name: String,
97 pub push_to_history: bool,
98}
99
100pub(crate) struct GetDefinition {
101 pub position: PointUtf16,
102}
103
104pub(crate) struct GetTypeDefinition {
105 pub position: PointUtf16,
106}
107
108pub(crate) struct GetReferences {
109 pub position: PointUtf16,
110}
111
112pub(crate) struct GetDocumentHighlights {
113 pub position: PointUtf16,
114}
115
116pub(crate) struct GetHover {
117 pub position: PointUtf16,
118}
119
120pub(crate) struct GetCompletions {
121 pub position: PointUtf16,
122}
123
124pub(crate) struct GetCodeActions {
125 pub range: Range<Anchor>,
126}
127
128pub(crate) struct OnTypeFormatting {
129 pub position: PointUtf16,
130 pub trigger: String,
131 pub options: FormattingOptions,
132 pub push_to_history: bool,
133}
134
135pub(crate) struct InlayHints {
136 pub range: Range<Anchor>,
137}
138
139pub(crate) struct FormattingOptions {
140 tab_size: u32,
141}
142
143impl From<lsp::FormattingOptions> for FormattingOptions {
144 fn from(value: lsp::FormattingOptions) -> Self {
145 Self {
146 tab_size: value.tab_size,
147 }
148 }
149}
150
151#[async_trait(?Send)]
152impl LspCommand for PrepareRename {
153 type Response = Option<Range<Anchor>>;
154 type LspRequest = lsp::request::PrepareRenameRequest;
155 type ProtoRequest = proto::PrepareRename;
156
157 fn check_capabilities(&self, capabilities: &ServerCapabilities) -> bool {
158 if let Some(lsp::OneOf::Right(rename)) = &capabilities.rename_provider {
159 rename.prepare_provider == Some(true)
160 } else {
161 false
162 }
163 }
164
165 fn to_lsp(
166 &self,
167 path: &Path,
168 _: &Buffer,
169 _: &Arc<LanguageServer>,
170 _: &AppContext,
171 ) -> lsp::TextDocumentPositionParams {
172 lsp::TextDocumentPositionParams {
173 text_document: lsp::TextDocumentIdentifier {
174 uri: lsp::Url::from_file_path(path).unwrap(),
175 },
176 position: point_to_lsp(self.position),
177 }
178 }
179
180 async fn response_from_lsp(
181 self,
182 message: Option<lsp::PrepareRenameResponse>,
183 _: Model<Project>,
184 buffer: Model<Buffer>,
185 _: LanguageServerId,
186 mut cx: AsyncAppContext,
187 ) -> Result<Option<Range<Anchor>>> {
188 buffer.update(&mut cx, |buffer, _| {
189 if let Some(
190 lsp::PrepareRenameResponse::Range(range)
191 | lsp::PrepareRenameResponse::RangeWithPlaceholder { range, .. },
192 ) = message
193 {
194 let Range { start, end } = range_from_lsp(range);
195 if buffer.clip_point_utf16(start, Bias::Left) == start.0
196 && buffer.clip_point_utf16(end, Bias::Left) == end.0
197 {
198 return Ok(Some(buffer.anchor_after(start)..buffer.anchor_before(end)));
199 }
200 }
201 Ok(None)
202 })?
203 }
204
205 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::PrepareRename {
206 proto::PrepareRename {
207 project_id,
208 buffer_id: buffer.remote_id(),
209 position: Some(language::proto::serialize_anchor(
210 &buffer.anchor_before(self.position),
211 )),
212 version: serialize_version(&buffer.version()),
213 }
214 }
215
216 async fn from_proto(
217 message: proto::PrepareRename,
218 _: Model<Project>,
219 buffer: Model<Buffer>,
220 mut cx: AsyncAppContext,
221 ) -> Result<Self> {
222 let position = message
223 .position
224 .and_then(deserialize_anchor)
225 .ok_or_else(|| anyhow!("invalid position"))?;
226 buffer
227 .update(&mut cx, |buffer, _| {
228 buffer.wait_for_version(deserialize_version(&message.version))
229 })?
230 .await?;
231
232 Ok(Self {
233 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
234 })
235 }
236
237 fn response_to_proto(
238 range: Option<Range<Anchor>>,
239 _: &mut Project,
240 _: PeerId,
241 buffer_version: &clock::Global,
242 _: &mut AppContext,
243 ) -> proto::PrepareRenameResponse {
244 proto::PrepareRenameResponse {
245 can_rename: range.is_some(),
246 start: range
247 .as_ref()
248 .map(|range| language::proto::serialize_anchor(&range.start)),
249 end: range
250 .as_ref()
251 .map(|range| language::proto::serialize_anchor(&range.end)),
252 version: serialize_version(buffer_version),
253 }
254 }
255
256 async fn response_from_proto(
257 self,
258 message: proto::PrepareRenameResponse,
259 _: Model<Project>,
260 buffer: Model<Buffer>,
261 mut cx: AsyncAppContext,
262 ) -> Result<Option<Range<Anchor>>> {
263 if message.can_rename {
264 buffer
265 .update(&mut cx, |buffer, _| {
266 buffer.wait_for_version(deserialize_version(&message.version))
267 })?
268 .await?;
269 let start = message.start.and_then(deserialize_anchor);
270 let end = message.end.and_then(deserialize_anchor);
271 Ok(start.zip(end).map(|(start, end)| start..end))
272 } else {
273 Ok(None)
274 }
275 }
276
277 fn buffer_id_from_proto(message: &proto::PrepareRename) -> u64 {
278 message.buffer_id
279 }
280}
281
282#[async_trait(?Send)]
283impl LspCommand for PerformRename {
284 type Response = ProjectTransaction;
285 type LspRequest = lsp::request::Rename;
286 type ProtoRequest = proto::PerformRename;
287
288 fn to_lsp(
289 &self,
290 path: &Path,
291 _: &Buffer,
292 _: &Arc<LanguageServer>,
293 _: &AppContext,
294 ) -> lsp::RenameParams {
295 lsp::RenameParams {
296 text_document_position: lsp::TextDocumentPositionParams {
297 text_document: lsp::TextDocumentIdentifier {
298 uri: lsp::Url::from_file_path(path).unwrap(),
299 },
300 position: point_to_lsp(self.position),
301 },
302 new_name: self.new_name.clone(),
303 work_done_progress_params: Default::default(),
304 }
305 }
306
307 async fn response_from_lsp(
308 self,
309 message: Option<lsp::WorkspaceEdit>,
310 project: Model<Project>,
311 buffer: Model<Buffer>,
312 server_id: LanguageServerId,
313 mut cx: AsyncAppContext,
314 ) -> Result<ProjectTransaction> {
315 if let Some(edit) = message {
316 let (lsp_adapter, lsp_server) =
317 language_server_for_buffer(&project, &buffer, server_id, &mut cx)?;
318 Project::deserialize_workspace_edit(
319 project,
320 edit,
321 self.push_to_history,
322 lsp_adapter,
323 lsp_server,
324 &mut cx,
325 )
326 .await
327 } else {
328 Ok(ProjectTransaction::default())
329 }
330 }
331
332 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::PerformRename {
333 proto::PerformRename {
334 project_id,
335 buffer_id: buffer.remote_id(),
336 position: Some(language::proto::serialize_anchor(
337 &buffer.anchor_before(self.position),
338 )),
339 new_name: self.new_name.clone(),
340 version: serialize_version(&buffer.version()),
341 }
342 }
343
344 async fn from_proto(
345 message: proto::PerformRename,
346 _: Model<Project>,
347 buffer: Model<Buffer>,
348 mut cx: AsyncAppContext,
349 ) -> Result<Self> {
350 let position = message
351 .position
352 .and_then(deserialize_anchor)
353 .ok_or_else(|| anyhow!("invalid position"))?;
354 buffer
355 .update(&mut cx, |buffer, _| {
356 buffer.wait_for_version(deserialize_version(&message.version))
357 })?
358 .await?;
359 Ok(Self {
360 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
361 new_name: message.new_name,
362 push_to_history: false,
363 })
364 }
365
366 fn response_to_proto(
367 response: ProjectTransaction,
368 project: &mut Project,
369 peer_id: PeerId,
370 _: &clock::Global,
371 cx: &mut AppContext,
372 ) -> proto::PerformRenameResponse {
373 let transaction = project.serialize_project_transaction_for_peer(response, peer_id, cx);
374 proto::PerformRenameResponse {
375 transaction: Some(transaction),
376 }
377 }
378
379 async fn response_from_proto(
380 self,
381 message: proto::PerformRenameResponse,
382 project: Model<Project>,
383 _: Model<Buffer>,
384 mut cx: AsyncAppContext,
385 ) -> Result<ProjectTransaction> {
386 let message = message
387 .transaction
388 .ok_or_else(|| anyhow!("missing transaction"))?;
389 project
390 .update(&mut cx, |project, cx| {
391 project.deserialize_project_transaction(message, self.push_to_history, cx)
392 })?
393 .await
394 }
395
396 fn buffer_id_from_proto(message: &proto::PerformRename) -> u64 {
397 message.buffer_id
398 }
399}
400
401#[async_trait(?Send)]
402impl LspCommand for GetDefinition {
403 type Response = Vec<LocationLink>;
404 type LspRequest = lsp::request::GotoDefinition;
405 type ProtoRequest = proto::GetDefinition;
406
407 fn to_lsp(
408 &self,
409 path: &Path,
410 _: &Buffer,
411 _: &Arc<LanguageServer>,
412 _: &AppContext,
413 ) -> lsp::GotoDefinitionParams {
414 lsp::GotoDefinitionParams {
415 text_document_position_params: lsp::TextDocumentPositionParams {
416 text_document: lsp::TextDocumentIdentifier {
417 uri: lsp::Url::from_file_path(path).unwrap(),
418 },
419 position: point_to_lsp(self.position),
420 },
421 work_done_progress_params: Default::default(),
422 partial_result_params: Default::default(),
423 }
424 }
425
426 async fn response_from_lsp(
427 self,
428 message: Option<lsp::GotoDefinitionResponse>,
429 project: Model<Project>,
430 buffer: Model<Buffer>,
431 server_id: LanguageServerId,
432 cx: AsyncAppContext,
433 ) -> Result<Vec<LocationLink>> {
434 location_links_from_lsp(message, project, buffer, server_id, cx).await
435 }
436
437 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::GetDefinition {
438 proto::GetDefinition {
439 project_id,
440 buffer_id: buffer.remote_id(),
441 position: Some(language::proto::serialize_anchor(
442 &buffer.anchor_before(self.position),
443 )),
444 version: serialize_version(&buffer.version()),
445 }
446 }
447
448 async fn from_proto(
449 message: proto::GetDefinition,
450 _: Model<Project>,
451 buffer: Model<Buffer>,
452 mut cx: AsyncAppContext,
453 ) -> Result<Self> {
454 let position = message
455 .position
456 .and_then(deserialize_anchor)
457 .ok_or_else(|| anyhow!("invalid position"))?;
458 buffer
459 .update(&mut cx, |buffer, _| {
460 buffer.wait_for_version(deserialize_version(&message.version))
461 })?
462 .await?;
463 Ok(Self {
464 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
465 })
466 }
467
468 fn response_to_proto(
469 response: Vec<LocationLink>,
470 project: &mut Project,
471 peer_id: PeerId,
472 _: &clock::Global,
473 cx: &mut AppContext,
474 ) -> proto::GetDefinitionResponse {
475 let links = location_links_to_proto(response, project, peer_id, cx);
476 proto::GetDefinitionResponse { links }
477 }
478
479 async fn response_from_proto(
480 self,
481 message: proto::GetDefinitionResponse,
482 project: Model<Project>,
483 _: Model<Buffer>,
484 cx: AsyncAppContext,
485 ) -> Result<Vec<LocationLink>> {
486 location_links_from_proto(message.links, project, cx).await
487 }
488
489 fn buffer_id_from_proto(message: &proto::GetDefinition) -> u64 {
490 message.buffer_id
491 }
492}
493
494#[async_trait(?Send)]
495impl LspCommand for GetTypeDefinition {
496 type Response = Vec<LocationLink>;
497 type LspRequest = lsp::request::GotoTypeDefinition;
498 type ProtoRequest = proto::GetTypeDefinition;
499
500 fn check_capabilities(&self, capabilities: &ServerCapabilities) -> bool {
501 match &capabilities.type_definition_provider {
502 None => false,
503 Some(lsp::TypeDefinitionProviderCapability::Simple(false)) => false,
504 _ => true,
505 }
506 }
507
508 fn to_lsp(
509 &self,
510 path: &Path,
511 _: &Buffer,
512 _: &Arc<LanguageServer>,
513 _: &AppContext,
514 ) -> lsp::GotoTypeDefinitionParams {
515 lsp::GotoTypeDefinitionParams {
516 text_document_position_params: lsp::TextDocumentPositionParams {
517 text_document: lsp::TextDocumentIdentifier {
518 uri: lsp::Url::from_file_path(path).unwrap(),
519 },
520 position: point_to_lsp(self.position),
521 },
522 work_done_progress_params: Default::default(),
523 partial_result_params: Default::default(),
524 }
525 }
526
527 async fn response_from_lsp(
528 self,
529 message: Option<lsp::GotoTypeDefinitionResponse>,
530 project: Model<Project>,
531 buffer: Model<Buffer>,
532 server_id: LanguageServerId,
533 cx: AsyncAppContext,
534 ) -> Result<Vec<LocationLink>> {
535 location_links_from_lsp(message, project, buffer, server_id, cx).await
536 }
537
538 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::GetTypeDefinition {
539 proto::GetTypeDefinition {
540 project_id,
541 buffer_id: buffer.remote_id(),
542 position: Some(language::proto::serialize_anchor(
543 &buffer.anchor_before(self.position),
544 )),
545 version: serialize_version(&buffer.version()),
546 }
547 }
548
549 async fn from_proto(
550 message: proto::GetTypeDefinition,
551 _: Model<Project>,
552 buffer: Model<Buffer>,
553 mut cx: AsyncAppContext,
554 ) -> Result<Self> {
555 let position = message
556 .position
557 .and_then(deserialize_anchor)
558 .ok_or_else(|| anyhow!("invalid position"))?;
559 buffer
560 .update(&mut cx, |buffer, _| {
561 buffer.wait_for_version(deserialize_version(&message.version))
562 })?
563 .await?;
564 Ok(Self {
565 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
566 })
567 }
568
569 fn response_to_proto(
570 response: Vec<LocationLink>,
571 project: &mut Project,
572 peer_id: PeerId,
573 _: &clock::Global,
574 cx: &mut AppContext,
575 ) -> proto::GetTypeDefinitionResponse {
576 let links = location_links_to_proto(response, project, peer_id, cx);
577 proto::GetTypeDefinitionResponse { links }
578 }
579
580 async fn response_from_proto(
581 self,
582 message: proto::GetTypeDefinitionResponse,
583 project: Model<Project>,
584 _: Model<Buffer>,
585 cx: AsyncAppContext,
586 ) -> Result<Vec<LocationLink>> {
587 location_links_from_proto(message.links, project, cx).await
588 }
589
590 fn buffer_id_from_proto(message: &proto::GetTypeDefinition) -> u64 {
591 message.buffer_id
592 }
593}
594
595fn language_server_for_buffer(
596 project: &Model<Project>,
597 buffer: &Model<Buffer>,
598 server_id: LanguageServerId,
599 cx: &mut AsyncAppContext,
600) -> Result<(Arc<CachedLspAdapter>, Arc<LanguageServer>)> {
601 project
602 .update(cx, |project, cx| {
603 project
604 .language_server_for_buffer(buffer.read(cx), server_id, cx)
605 .map(|(adapter, server)| (adapter.clone(), server.clone()))
606 })?
607 .ok_or_else(|| anyhow!("no language server found for buffer"))
608}
609
610async fn location_links_from_proto(
611 proto_links: Vec<proto::LocationLink>,
612 project: Model<Project>,
613 mut cx: AsyncAppContext,
614) -> Result<Vec<LocationLink>> {
615 let mut links = Vec::new();
616
617 for link in proto_links {
618 let origin = match link.origin {
619 Some(origin) => {
620 let buffer = project
621 .update(&mut cx, |this, cx| {
622 this.wait_for_remote_buffer(origin.buffer_id, cx)
623 })?
624 .await?;
625 let start = origin
626 .start
627 .and_then(deserialize_anchor)
628 .ok_or_else(|| anyhow!("missing origin start"))?;
629 let end = origin
630 .end
631 .and_then(deserialize_anchor)
632 .ok_or_else(|| anyhow!("missing origin end"))?;
633 buffer
634 .update(&mut cx, |buffer, _| buffer.wait_for_anchors([start, end]))?
635 .await?;
636 Some(Location {
637 buffer,
638 range: start..end,
639 })
640 }
641 None => None,
642 };
643
644 let target = link.target.ok_or_else(|| anyhow!("missing target"))?;
645 let buffer = project
646 .update(&mut cx, |this, cx| {
647 this.wait_for_remote_buffer(target.buffer_id, cx)
648 })?
649 .await?;
650 let start = target
651 .start
652 .and_then(deserialize_anchor)
653 .ok_or_else(|| anyhow!("missing target start"))?;
654 let end = target
655 .end
656 .and_then(deserialize_anchor)
657 .ok_or_else(|| anyhow!("missing target end"))?;
658 buffer
659 .update(&mut cx, |buffer, _| buffer.wait_for_anchors([start, end]))?
660 .await?;
661 let target = Location {
662 buffer,
663 range: start..end,
664 };
665
666 links.push(LocationLink { origin, target })
667 }
668
669 Ok(links)
670}
671
672async fn location_links_from_lsp(
673 message: Option<lsp::GotoDefinitionResponse>,
674 project: Model<Project>,
675 buffer: Model<Buffer>,
676 server_id: LanguageServerId,
677 mut cx: AsyncAppContext,
678) -> Result<Vec<LocationLink>> {
679 let message = match message {
680 Some(message) => message,
681 None => return Ok(Vec::new()),
682 };
683
684 let mut unresolved_links = Vec::new();
685 match message {
686 lsp::GotoDefinitionResponse::Scalar(loc) => {
687 unresolved_links.push((None, loc.uri, loc.range));
688 }
689
690 lsp::GotoDefinitionResponse::Array(locs) => {
691 unresolved_links.extend(locs.into_iter().map(|l| (None, l.uri, l.range)));
692 }
693
694 lsp::GotoDefinitionResponse::Link(links) => {
695 unresolved_links.extend(links.into_iter().map(|l| {
696 (
697 l.origin_selection_range,
698 l.target_uri,
699 l.target_selection_range,
700 )
701 }));
702 }
703 }
704
705 let (lsp_adapter, language_server) =
706 language_server_for_buffer(&project, &buffer, server_id, &mut cx)?;
707 let mut definitions = Vec::new();
708 for (origin_range, target_uri, target_range) in unresolved_links {
709 let target_buffer_handle = project
710 .update(&mut cx, |this, cx| {
711 this.open_local_buffer_via_lsp(
712 target_uri,
713 language_server.server_id(),
714 lsp_adapter.name.clone(),
715 cx,
716 )
717 })?
718 .await?;
719
720 buffer.update(&mut cx, |origin_buffer, cx| {
721 let origin_location = origin_range.map(|origin_range| {
722 let origin_start =
723 origin_buffer.clip_point_utf16(point_from_lsp(origin_range.start), Bias::Left);
724 let origin_end =
725 origin_buffer.clip_point_utf16(point_from_lsp(origin_range.end), Bias::Left);
726 Location {
727 buffer: buffer.clone(),
728 range: origin_buffer.anchor_after(origin_start)
729 ..origin_buffer.anchor_before(origin_end),
730 }
731 });
732
733 let target_buffer = target_buffer_handle.read(cx);
734 let target_start =
735 target_buffer.clip_point_utf16(point_from_lsp(target_range.start), Bias::Left);
736 let target_end =
737 target_buffer.clip_point_utf16(point_from_lsp(target_range.end), Bias::Left);
738 let target_location = Location {
739 buffer: target_buffer_handle,
740 range: target_buffer.anchor_after(target_start)
741 ..target_buffer.anchor_before(target_end),
742 };
743
744 definitions.push(LocationLink {
745 origin: origin_location,
746 target: target_location,
747 })
748 })?;
749 }
750 Ok(definitions)
751}
752
753fn location_links_to_proto(
754 links: Vec<LocationLink>,
755 project: &mut Project,
756 peer_id: PeerId,
757 cx: &mut AppContext,
758) -> Vec<proto::LocationLink> {
759 links
760 .into_iter()
761 .map(|definition| {
762 let origin = definition.origin.map(|origin| {
763 let buffer_id = project.create_buffer_for_peer(&origin.buffer, peer_id, cx);
764 proto::Location {
765 start: Some(serialize_anchor(&origin.range.start)),
766 end: Some(serialize_anchor(&origin.range.end)),
767 buffer_id,
768 }
769 });
770
771 let buffer_id = project.create_buffer_for_peer(&definition.target.buffer, peer_id, cx);
772 let target = proto::Location {
773 start: Some(serialize_anchor(&definition.target.range.start)),
774 end: Some(serialize_anchor(&definition.target.range.end)),
775 buffer_id,
776 };
777
778 proto::LocationLink {
779 origin,
780 target: Some(target),
781 }
782 })
783 .collect()
784}
785
786#[async_trait(?Send)]
787impl LspCommand for GetReferences {
788 type Response = Vec<Location>;
789 type LspRequest = lsp::request::References;
790 type ProtoRequest = proto::GetReferences;
791
792 fn to_lsp(
793 &self,
794 path: &Path,
795 _: &Buffer,
796 _: &Arc<LanguageServer>,
797 _: &AppContext,
798 ) -> lsp::ReferenceParams {
799 lsp::ReferenceParams {
800 text_document_position: lsp::TextDocumentPositionParams {
801 text_document: lsp::TextDocumentIdentifier {
802 uri: lsp::Url::from_file_path(path).unwrap(),
803 },
804 position: point_to_lsp(self.position),
805 },
806 work_done_progress_params: Default::default(),
807 partial_result_params: Default::default(),
808 context: lsp::ReferenceContext {
809 include_declaration: true,
810 },
811 }
812 }
813
814 async fn response_from_lsp(
815 self,
816 locations: Option<Vec<lsp::Location>>,
817 project: Model<Project>,
818 buffer: Model<Buffer>,
819 server_id: LanguageServerId,
820 mut cx: AsyncAppContext,
821 ) -> Result<Vec<Location>> {
822 let mut references = Vec::new();
823 let (lsp_adapter, language_server) =
824 language_server_for_buffer(&project, &buffer, server_id, &mut cx)?;
825
826 if let Some(locations) = locations {
827 for lsp_location in locations {
828 let target_buffer_handle = project
829 .update(&mut cx, |this, cx| {
830 this.open_local_buffer_via_lsp(
831 lsp_location.uri,
832 language_server.server_id(),
833 lsp_adapter.name.clone(),
834 cx,
835 )
836 })?
837 .await?;
838
839 target_buffer_handle
840 .clone()
841 .update(&mut cx, |target_buffer, _| {
842 let target_start = target_buffer
843 .clip_point_utf16(point_from_lsp(lsp_location.range.start), Bias::Left);
844 let target_end = target_buffer
845 .clip_point_utf16(point_from_lsp(lsp_location.range.end), Bias::Left);
846 references.push(Location {
847 buffer: target_buffer_handle,
848 range: target_buffer.anchor_after(target_start)
849 ..target_buffer.anchor_before(target_end),
850 });
851 })?;
852 }
853 }
854
855 Ok(references)
856 }
857
858 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::GetReferences {
859 proto::GetReferences {
860 project_id,
861 buffer_id: buffer.remote_id(),
862 position: Some(language::proto::serialize_anchor(
863 &buffer.anchor_before(self.position),
864 )),
865 version: serialize_version(&buffer.version()),
866 }
867 }
868
869 async fn from_proto(
870 message: proto::GetReferences,
871 _: Model<Project>,
872 buffer: Model<Buffer>,
873 mut cx: AsyncAppContext,
874 ) -> Result<Self> {
875 let position = message
876 .position
877 .and_then(deserialize_anchor)
878 .ok_or_else(|| anyhow!("invalid position"))?;
879 buffer
880 .update(&mut cx, |buffer, _| {
881 buffer.wait_for_version(deserialize_version(&message.version))
882 })?
883 .await?;
884 Ok(Self {
885 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
886 })
887 }
888
889 fn response_to_proto(
890 response: Vec<Location>,
891 project: &mut Project,
892 peer_id: PeerId,
893 _: &clock::Global,
894 cx: &mut AppContext,
895 ) -> proto::GetReferencesResponse {
896 let locations = response
897 .into_iter()
898 .map(|definition| {
899 let buffer_id = project.create_buffer_for_peer(&definition.buffer, peer_id, cx);
900 proto::Location {
901 start: Some(serialize_anchor(&definition.range.start)),
902 end: Some(serialize_anchor(&definition.range.end)),
903 buffer_id,
904 }
905 })
906 .collect();
907 proto::GetReferencesResponse { locations }
908 }
909
910 async fn response_from_proto(
911 self,
912 message: proto::GetReferencesResponse,
913 project: Model<Project>,
914 _: Model<Buffer>,
915 mut cx: AsyncAppContext,
916 ) -> Result<Vec<Location>> {
917 let mut locations = Vec::new();
918 for location in message.locations {
919 let target_buffer = project
920 .update(&mut cx, |this, cx| {
921 this.wait_for_remote_buffer(location.buffer_id, cx)
922 })?
923 .await?;
924 let start = location
925 .start
926 .and_then(deserialize_anchor)
927 .ok_or_else(|| anyhow!("missing target start"))?;
928 let end = location
929 .end
930 .and_then(deserialize_anchor)
931 .ok_or_else(|| anyhow!("missing target end"))?;
932 target_buffer
933 .update(&mut cx, |buffer, _| buffer.wait_for_anchors([start, end]))?
934 .await?;
935 locations.push(Location {
936 buffer: target_buffer,
937 range: start..end,
938 })
939 }
940 Ok(locations)
941 }
942
943 fn buffer_id_from_proto(message: &proto::GetReferences) -> u64 {
944 message.buffer_id
945 }
946}
947
948#[async_trait(?Send)]
949impl LspCommand for GetDocumentHighlights {
950 type Response = Vec<DocumentHighlight>;
951 type LspRequest = lsp::request::DocumentHighlightRequest;
952 type ProtoRequest = proto::GetDocumentHighlights;
953
954 fn check_capabilities(&self, capabilities: &ServerCapabilities) -> bool {
955 capabilities.document_highlight_provider.is_some()
956 }
957
958 fn to_lsp(
959 &self,
960 path: &Path,
961 _: &Buffer,
962 _: &Arc<LanguageServer>,
963 _: &AppContext,
964 ) -> lsp::DocumentHighlightParams {
965 lsp::DocumentHighlightParams {
966 text_document_position_params: lsp::TextDocumentPositionParams {
967 text_document: lsp::TextDocumentIdentifier {
968 uri: lsp::Url::from_file_path(path).unwrap(),
969 },
970 position: point_to_lsp(self.position),
971 },
972 work_done_progress_params: Default::default(),
973 partial_result_params: Default::default(),
974 }
975 }
976
977 async fn response_from_lsp(
978 self,
979 lsp_highlights: Option<Vec<lsp::DocumentHighlight>>,
980 _: Model<Project>,
981 buffer: Model<Buffer>,
982 _: LanguageServerId,
983 mut cx: AsyncAppContext,
984 ) -> Result<Vec<DocumentHighlight>> {
985 buffer.update(&mut cx, |buffer, _| {
986 let mut lsp_highlights = lsp_highlights.unwrap_or_default();
987 lsp_highlights.sort_unstable_by_key(|h| (h.range.start, Reverse(h.range.end)));
988 lsp_highlights
989 .into_iter()
990 .map(|lsp_highlight| {
991 let start = buffer
992 .clip_point_utf16(point_from_lsp(lsp_highlight.range.start), Bias::Left);
993 let end = buffer
994 .clip_point_utf16(point_from_lsp(lsp_highlight.range.end), Bias::Left);
995 DocumentHighlight {
996 range: buffer.anchor_after(start)..buffer.anchor_before(end),
997 kind: lsp_highlight
998 .kind
999 .unwrap_or(lsp::DocumentHighlightKind::READ),
1000 }
1001 })
1002 .collect()
1003 })
1004 }
1005
1006 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::GetDocumentHighlights {
1007 proto::GetDocumentHighlights {
1008 project_id,
1009 buffer_id: buffer.remote_id(),
1010 position: Some(language::proto::serialize_anchor(
1011 &buffer.anchor_before(self.position),
1012 )),
1013 version: serialize_version(&buffer.version()),
1014 }
1015 }
1016
1017 async fn from_proto(
1018 message: proto::GetDocumentHighlights,
1019 _: Model<Project>,
1020 buffer: Model<Buffer>,
1021 mut cx: AsyncAppContext,
1022 ) -> Result<Self> {
1023 let position = message
1024 .position
1025 .and_then(deserialize_anchor)
1026 .ok_or_else(|| anyhow!("invalid position"))?;
1027 buffer
1028 .update(&mut cx, |buffer, _| {
1029 buffer.wait_for_version(deserialize_version(&message.version))
1030 })?
1031 .await?;
1032 Ok(Self {
1033 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
1034 })
1035 }
1036
1037 fn response_to_proto(
1038 response: Vec<DocumentHighlight>,
1039 _: &mut Project,
1040 _: PeerId,
1041 _: &clock::Global,
1042 _: &mut AppContext,
1043 ) -> proto::GetDocumentHighlightsResponse {
1044 let highlights = response
1045 .into_iter()
1046 .map(|highlight| proto::DocumentHighlight {
1047 start: Some(serialize_anchor(&highlight.range.start)),
1048 end: Some(serialize_anchor(&highlight.range.end)),
1049 kind: match highlight.kind {
1050 DocumentHighlightKind::TEXT => proto::document_highlight::Kind::Text.into(),
1051 DocumentHighlightKind::WRITE => proto::document_highlight::Kind::Write.into(),
1052 DocumentHighlightKind::READ => proto::document_highlight::Kind::Read.into(),
1053 _ => proto::document_highlight::Kind::Text.into(),
1054 },
1055 })
1056 .collect();
1057 proto::GetDocumentHighlightsResponse { highlights }
1058 }
1059
1060 async fn response_from_proto(
1061 self,
1062 message: proto::GetDocumentHighlightsResponse,
1063 _: Model<Project>,
1064 buffer: Model<Buffer>,
1065 mut cx: AsyncAppContext,
1066 ) -> Result<Vec<DocumentHighlight>> {
1067 let mut highlights = Vec::new();
1068 for highlight in message.highlights {
1069 let start = highlight
1070 .start
1071 .and_then(deserialize_anchor)
1072 .ok_or_else(|| anyhow!("missing target start"))?;
1073 let end = highlight
1074 .end
1075 .and_then(deserialize_anchor)
1076 .ok_or_else(|| anyhow!("missing target end"))?;
1077 buffer
1078 .update(&mut cx, |buffer, _| buffer.wait_for_anchors([start, end]))?
1079 .await?;
1080 let kind = match proto::document_highlight::Kind::from_i32(highlight.kind) {
1081 Some(proto::document_highlight::Kind::Text) => DocumentHighlightKind::TEXT,
1082 Some(proto::document_highlight::Kind::Read) => DocumentHighlightKind::READ,
1083 Some(proto::document_highlight::Kind::Write) => DocumentHighlightKind::WRITE,
1084 None => DocumentHighlightKind::TEXT,
1085 };
1086 highlights.push(DocumentHighlight {
1087 range: start..end,
1088 kind,
1089 });
1090 }
1091 Ok(highlights)
1092 }
1093
1094 fn buffer_id_from_proto(message: &proto::GetDocumentHighlights) -> u64 {
1095 message.buffer_id
1096 }
1097}
1098
1099#[async_trait(?Send)]
1100impl LspCommand for GetHover {
1101 type Response = Option<Hover>;
1102 type LspRequest = lsp::request::HoverRequest;
1103 type ProtoRequest = proto::GetHover;
1104
1105 fn to_lsp(
1106 &self,
1107 path: &Path,
1108 _: &Buffer,
1109 _: &Arc<LanguageServer>,
1110 _: &AppContext,
1111 ) -> lsp::HoverParams {
1112 lsp::HoverParams {
1113 text_document_position_params: lsp::TextDocumentPositionParams {
1114 text_document: lsp::TextDocumentIdentifier {
1115 uri: lsp::Url::from_file_path(path).unwrap(),
1116 },
1117 position: point_to_lsp(self.position),
1118 },
1119 work_done_progress_params: Default::default(),
1120 }
1121 }
1122
1123 async fn response_from_lsp(
1124 self,
1125 message: Option<lsp::Hover>,
1126 _: Model<Project>,
1127 buffer: Model<Buffer>,
1128 _: LanguageServerId,
1129 mut cx: AsyncAppContext,
1130 ) -> Result<Self::Response> {
1131 let Some(hover) = message else {
1132 return Ok(None);
1133 };
1134
1135 let (language, range) = buffer.update(&mut cx, |buffer, _| {
1136 (
1137 buffer.language().cloned(),
1138 hover.range.map(|range| {
1139 let token_start =
1140 buffer.clip_point_utf16(point_from_lsp(range.start), Bias::Left);
1141 let token_end = buffer.clip_point_utf16(point_from_lsp(range.end), Bias::Left);
1142 buffer.anchor_after(token_start)..buffer.anchor_before(token_end)
1143 }),
1144 )
1145 })?;
1146
1147 fn hover_blocks_from_marked_string(marked_string: lsp::MarkedString) -> Option<HoverBlock> {
1148 let block = match marked_string {
1149 lsp::MarkedString::String(content) => HoverBlock {
1150 text: content,
1151 kind: HoverBlockKind::Markdown,
1152 },
1153 lsp::MarkedString::LanguageString(lsp::LanguageString { language, value }) => {
1154 HoverBlock {
1155 text: value,
1156 kind: HoverBlockKind::Code { language },
1157 }
1158 }
1159 };
1160 if block.text.is_empty() {
1161 None
1162 } else {
1163 Some(block)
1164 }
1165 }
1166
1167 let contents = match hover.contents {
1168 lsp::HoverContents::Scalar(marked_string) => {
1169 hover_blocks_from_marked_string(marked_string)
1170 .into_iter()
1171 .collect()
1172 }
1173 lsp::HoverContents::Array(marked_strings) => marked_strings
1174 .into_iter()
1175 .filter_map(hover_blocks_from_marked_string)
1176 .collect(),
1177 lsp::HoverContents::Markup(markup_content) => vec![HoverBlock {
1178 text: markup_content.value,
1179 kind: if markup_content.kind == lsp::MarkupKind::Markdown {
1180 HoverBlockKind::Markdown
1181 } else {
1182 HoverBlockKind::PlainText
1183 },
1184 }],
1185 };
1186
1187 Ok(Some(Hover {
1188 contents,
1189 range,
1190 language,
1191 }))
1192 }
1193
1194 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> Self::ProtoRequest {
1195 proto::GetHover {
1196 project_id,
1197 buffer_id: buffer.remote_id(),
1198 position: Some(language::proto::serialize_anchor(
1199 &buffer.anchor_before(self.position),
1200 )),
1201 version: serialize_version(&buffer.version),
1202 }
1203 }
1204
1205 async fn from_proto(
1206 message: Self::ProtoRequest,
1207 _: Model<Project>,
1208 buffer: Model<Buffer>,
1209 mut cx: AsyncAppContext,
1210 ) -> Result<Self> {
1211 let position = message
1212 .position
1213 .and_then(deserialize_anchor)
1214 .ok_or_else(|| anyhow!("invalid position"))?;
1215 buffer
1216 .update(&mut cx, |buffer, _| {
1217 buffer.wait_for_version(deserialize_version(&message.version))
1218 })?
1219 .await?;
1220 Ok(Self {
1221 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
1222 })
1223 }
1224
1225 fn response_to_proto(
1226 response: Self::Response,
1227 _: &mut Project,
1228 _: PeerId,
1229 _: &clock::Global,
1230 _: &mut AppContext,
1231 ) -> proto::GetHoverResponse {
1232 if let Some(response) = response {
1233 let (start, end) = if let Some(range) = response.range {
1234 (
1235 Some(language::proto::serialize_anchor(&range.start)),
1236 Some(language::proto::serialize_anchor(&range.end)),
1237 )
1238 } else {
1239 (None, None)
1240 };
1241
1242 let contents = response
1243 .contents
1244 .into_iter()
1245 .map(|block| proto::HoverBlock {
1246 text: block.text,
1247 is_markdown: block.kind == HoverBlockKind::Markdown,
1248 language: if let HoverBlockKind::Code { language } = block.kind {
1249 Some(language)
1250 } else {
1251 None
1252 },
1253 })
1254 .collect();
1255
1256 proto::GetHoverResponse {
1257 start,
1258 end,
1259 contents,
1260 }
1261 } else {
1262 proto::GetHoverResponse {
1263 start: None,
1264 end: None,
1265 contents: Vec::new(),
1266 }
1267 }
1268 }
1269
1270 async fn response_from_proto(
1271 self,
1272 message: proto::GetHoverResponse,
1273 _: Model<Project>,
1274 buffer: Model<Buffer>,
1275 mut cx: AsyncAppContext,
1276 ) -> Result<Self::Response> {
1277 let contents: Vec<_> = message
1278 .contents
1279 .into_iter()
1280 .map(|block| HoverBlock {
1281 text: block.text,
1282 kind: if let Some(language) = block.language {
1283 HoverBlockKind::Code { language }
1284 } else if block.is_markdown {
1285 HoverBlockKind::Markdown
1286 } else {
1287 HoverBlockKind::PlainText
1288 },
1289 })
1290 .collect();
1291 if contents.is_empty() {
1292 return Ok(None);
1293 }
1294
1295 let language = buffer.update(&mut cx, |buffer, _| buffer.language().cloned())?;
1296 let range = if let (Some(start), Some(end)) = (message.start, message.end) {
1297 language::proto::deserialize_anchor(start)
1298 .and_then(|start| language::proto::deserialize_anchor(end).map(|end| start..end))
1299 } else {
1300 None
1301 };
1302
1303 Ok(Some(Hover {
1304 contents,
1305 range,
1306 language,
1307 }))
1308 }
1309
1310 fn buffer_id_from_proto(message: &Self::ProtoRequest) -> u64 {
1311 message.buffer_id
1312 }
1313}
1314
1315#[async_trait(?Send)]
1316impl LspCommand for GetCompletions {
1317 type Response = Vec<Completion>;
1318 type LspRequest = lsp::request::Completion;
1319 type ProtoRequest = proto::GetCompletions;
1320
1321 fn to_lsp(
1322 &self,
1323 path: &Path,
1324 _: &Buffer,
1325 _: &Arc<LanguageServer>,
1326 _: &AppContext,
1327 ) -> lsp::CompletionParams {
1328 lsp::CompletionParams {
1329 text_document_position: lsp::TextDocumentPositionParams::new(
1330 lsp::TextDocumentIdentifier::new(lsp::Url::from_file_path(path).unwrap()),
1331 point_to_lsp(self.position),
1332 ),
1333 context: Default::default(),
1334 work_done_progress_params: Default::default(),
1335 partial_result_params: Default::default(),
1336 }
1337 }
1338
1339 async fn response_from_lsp(
1340 self,
1341 completions: Option<lsp::CompletionResponse>,
1342 project: Model<Project>,
1343 buffer: Model<Buffer>,
1344 server_id: LanguageServerId,
1345 mut cx: AsyncAppContext,
1346 ) -> Result<Vec<Completion>> {
1347 let mut response_list = None;
1348 let completions = if let Some(completions) = completions {
1349 match completions {
1350 lsp::CompletionResponse::Array(completions) => completions,
1351
1352 lsp::CompletionResponse::List(mut list) => {
1353 let items = std::mem::take(&mut list.items);
1354 response_list = Some(list);
1355 items
1356 }
1357 }
1358 } else {
1359 Default::default()
1360 };
1361
1362 let completions = buffer.update(&mut cx, |buffer, cx| {
1363 let language_registry = project.read(cx).languages().clone();
1364 let language = buffer.language().cloned();
1365 let snapshot = buffer.snapshot();
1366 let clipped_position = buffer.clip_point_utf16(Unclipped(self.position), Bias::Left);
1367
1368 let mut range_for_token = None;
1369 completions
1370 .into_iter()
1371 .filter_map(move |mut lsp_completion| {
1372 let (old_range, mut new_text) = match lsp_completion.text_edit.as_ref() {
1373 // If the language server provides a range to overwrite, then
1374 // check that the range is valid.
1375 Some(lsp::CompletionTextEdit::Edit(edit)) => {
1376 let range = range_from_lsp(edit.range);
1377 let start = snapshot.clip_point_utf16(range.start, Bias::Left);
1378 let end = snapshot.clip_point_utf16(range.end, Bias::Left);
1379 if start != range.start.0 || end != range.end.0 {
1380 log::info!("completion out of expected range");
1381 return None;
1382 }
1383 (
1384 snapshot.anchor_before(start)..snapshot.anchor_after(end),
1385 edit.new_text.clone(),
1386 )
1387 }
1388
1389 // If the language server does not provide a range, then infer
1390 // the range based on the syntax tree.
1391 None => {
1392 if self.position != clipped_position {
1393 log::info!("completion out of expected range");
1394 return None;
1395 }
1396
1397 let default_edit_range = response_list
1398 .as_ref()
1399 .and_then(|list| list.item_defaults.as_ref())
1400 .and_then(|defaults| defaults.edit_range.as_ref())
1401 .and_then(|range| match range {
1402 CompletionListItemDefaultsEditRange::Range(r) => Some(r),
1403 _ => None,
1404 });
1405
1406 let range = if let Some(range) = default_edit_range {
1407 let range = range_from_lsp(range.clone());
1408 let start = snapshot.clip_point_utf16(range.start, Bias::Left);
1409 let end = snapshot.clip_point_utf16(range.end, Bias::Left);
1410 if start != range.start.0 || end != range.end.0 {
1411 log::info!("completion out of expected range");
1412 return None;
1413 }
1414
1415 snapshot.anchor_before(start)..snapshot.anchor_after(end)
1416 } else {
1417 range_for_token
1418 .get_or_insert_with(|| {
1419 let offset = self.position.to_offset(&snapshot);
1420 let (range, kind) = snapshot.surrounding_word(offset);
1421 let range = if kind == Some(CharKind::Word) {
1422 range
1423 } else {
1424 offset..offset
1425 };
1426
1427 snapshot.anchor_before(range.start)
1428 ..snapshot.anchor_after(range.end)
1429 })
1430 .clone()
1431 };
1432
1433 let text = lsp_completion
1434 .insert_text
1435 .as_ref()
1436 .unwrap_or(&lsp_completion.label)
1437 .clone();
1438 (range, text)
1439 }
1440
1441 Some(lsp::CompletionTextEdit::InsertAndReplace(_)) => {
1442 log::info!("unsupported insert/replace completion");
1443 return None;
1444 }
1445 };
1446
1447 let language_registry = language_registry.clone();
1448 let language = language.clone();
1449 LineEnding::normalize(&mut new_text);
1450 Some(async move {
1451 let mut label = None;
1452 if let Some(language) = language.as_ref() {
1453 language.process_completion(&mut lsp_completion).await;
1454 label = language.label_for_completion(&lsp_completion).await;
1455 }
1456
1457 let documentation = if let Some(lsp_docs) = &lsp_completion.documentation {
1458 Some(
1459 prepare_completion_documentation(
1460 lsp_docs,
1461 &language_registry,
1462 language.clone(),
1463 )
1464 .await,
1465 )
1466 } else {
1467 None
1468 };
1469
1470 Completion {
1471 old_range,
1472 new_text,
1473 label: label.unwrap_or_else(|| {
1474 language::CodeLabel::plain(
1475 lsp_completion.label.clone(),
1476 lsp_completion.filter_text.as_deref(),
1477 )
1478 }),
1479 documentation,
1480 server_id,
1481 lsp_completion,
1482 }
1483 })
1484 })
1485 })?;
1486
1487 Ok(future::join_all(completions).await)
1488 }
1489
1490 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::GetCompletions {
1491 let anchor = buffer.anchor_after(self.position);
1492 proto::GetCompletions {
1493 project_id,
1494 buffer_id: buffer.remote_id(),
1495 position: Some(language::proto::serialize_anchor(&anchor)),
1496 version: serialize_version(&buffer.version()),
1497 }
1498 }
1499
1500 async fn from_proto(
1501 message: proto::GetCompletions,
1502 _: Model<Project>,
1503 buffer: Model<Buffer>,
1504 mut cx: AsyncAppContext,
1505 ) -> Result<Self> {
1506 let version = deserialize_version(&message.version);
1507 buffer
1508 .update(&mut cx, |buffer, _| buffer.wait_for_version(version))?
1509 .await?;
1510 let position = message
1511 .position
1512 .and_then(language::proto::deserialize_anchor)
1513 .map(|p| {
1514 buffer.update(&mut cx, |buffer, _| {
1515 buffer.clip_point_utf16(Unclipped(p.to_point_utf16(buffer)), Bias::Left)
1516 })
1517 })
1518 .ok_or_else(|| anyhow!("invalid position"))??;
1519 Ok(Self { position })
1520 }
1521
1522 fn response_to_proto(
1523 completions: Vec<Completion>,
1524 _: &mut Project,
1525 _: PeerId,
1526 buffer_version: &clock::Global,
1527 _: &mut AppContext,
1528 ) -> proto::GetCompletionsResponse {
1529 proto::GetCompletionsResponse {
1530 completions: completions
1531 .iter()
1532 .map(language::proto::serialize_completion)
1533 .collect(),
1534 version: serialize_version(&buffer_version),
1535 }
1536 }
1537
1538 async fn response_from_proto(
1539 self,
1540 message: proto::GetCompletionsResponse,
1541 _: Model<Project>,
1542 buffer: Model<Buffer>,
1543 mut cx: AsyncAppContext,
1544 ) -> Result<Vec<Completion>> {
1545 buffer
1546 .update(&mut cx, |buffer, _| {
1547 buffer.wait_for_version(deserialize_version(&message.version))
1548 })?
1549 .await?;
1550
1551 let language = buffer.update(&mut cx, |buffer, _| buffer.language().cloned())?;
1552 let completions = message.completions.into_iter().map(|completion| {
1553 language::proto::deserialize_completion(completion, language.clone())
1554 });
1555 future::try_join_all(completions).await
1556 }
1557
1558 fn buffer_id_from_proto(message: &proto::GetCompletions) -> u64 {
1559 message.buffer_id
1560 }
1561}
1562
1563#[async_trait(?Send)]
1564impl LspCommand for GetCodeActions {
1565 type Response = Vec<CodeAction>;
1566 type LspRequest = lsp::request::CodeActionRequest;
1567 type ProtoRequest = proto::GetCodeActions;
1568
1569 fn check_capabilities(&self, capabilities: &ServerCapabilities) -> bool {
1570 match &capabilities.code_action_provider {
1571 None => false,
1572 Some(lsp::CodeActionProviderCapability::Simple(false)) => false,
1573 _ => true,
1574 }
1575 }
1576
1577 fn to_lsp(
1578 &self,
1579 path: &Path,
1580 buffer: &Buffer,
1581 language_server: &Arc<LanguageServer>,
1582 _: &AppContext,
1583 ) -> lsp::CodeActionParams {
1584 let relevant_diagnostics = buffer
1585 .snapshot()
1586 .diagnostics_in_range::<_, usize>(self.range.clone(), false)
1587 .map(|entry| entry.to_lsp_diagnostic_stub())
1588 .collect();
1589 lsp::CodeActionParams {
1590 text_document: lsp::TextDocumentIdentifier::new(
1591 lsp::Url::from_file_path(path).unwrap(),
1592 ),
1593 range: range_to_lsp(self.range.to_point_utf16(buffer)),
1594 work_done_progress_params: Default::default(),
1595 partial_result_params: Default::default(),
1596 context: lsp::CodeActionContext {
1597 diagnostics: relevant_diagnostics,
1598 only: language_server.code_action_kinds(),
1599 ..lsp::CodeActionContext::default()
1600 },
1601 }
1602 }
1603
1604 async fn response_from_lsp(
1605 self,
1606 actions: Option<lsp::CodeActionResponse>,
1607 _: Model<Project>,
1608 _: Model<Buffer>,
1609 server_id: LanguageServerId,
1610 _: AsyncAppContext,
1611 ) -> Result<Vec<CodeAction>> {
1612 Ok(actions
1613 .unwrap_or_default()
1614 .into_iter()
1615 .filter_map(|entry| {
1616 if let lsp::CodeActionOrCommand::CodeAction(lsp_action) = entry {
1617 Some(CodeAction {
1618 server_id,
1619 range: self.range.clone(),
1620 lsp_action,
1621 })
1622 } else {
1623 None
1624 }
1625 })
1626 .collect())
1627 }
1628
1629 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::GetCodeActions {
1630 proto::GetCodeActions {
1631 project_id,
1632 buffer_id: buffer.remote_id(),
1633 start: Some(language::proto::serialize_anchor(&self.range.start)),
1634 end: Some(language::proto::serialize_anchor(&self.range.end)),
1635 version: serialize_version(&buffer.version()),
1636 }
1637 }
1638
1639 async fn from_proto(
1640 message: proto::GetCodeActions,
1641 _: Model<Project>,
1642 buffer: Model<Buffer>,
1643 mut cx: AsyncAppContext,
1644 ) -> Result<Self> {
1645 let start = message
1646 .start
1647 .and_then(language::proto::deserialize_anchor)
1648 .ok_or_else(|| anyhow!("invalid start"))?;
1649 let end = message
1650 .end
1651 .and_then(language::proto::deserialize_anchor)
1652 .ok_or_else(|| anyhow!("invalid end"))?;
1653 buffer
1654 .update(&mut cx, |buffer, _| {
1655 buffer.wait_for_version(deserialize_version(&message.version))
1656 })?
1657 .await?;
1658
1659 Ok(Self { range: start..end })
1660 }
1661
1662 fn response_to_proto(
1663 code_actions: Vec<CodeAction>,
1664 _: &mut Project,
1665 _: PeerId,
1666 buffer_version: &clock::Global,
1667 _: &mut AppContext,
1668 ) -> proto::GetCodeActionsResponse {
1669 proto::GetCodeActionsResponse {
1670 actions: code_actions
1671 .iter()
1672 .map(language::proto::serialize_code_action)
1673 .collect(),
1674 version: serialize_version(&buffer_version),
1675 }
1676 }
1677
1678 async fn response_from_proto(
1679 self,
1680 message: proto::GetCodeActionsResponse,
1681 _: Model<Project>,
1682 buffer: Model<Buffer>,
1683 mut cx: AsyncAppContext,
1684 ) -> Result<Vec<CodeAction>> {
1685 buffer
1686 .update(&mut cx, |buffer, _| {
1687 buffer.wait_for_version(deserialize_version(&message.version))
1688 })?
1689 .await?;
1690 message
1691 .actions
1692 .into_iter()
1693 .map(language::proto::deserialize_code_action)
1694 .collect()
1695 }
1696
1697 fn buffer_id_from_proto(message: &proto::GetCodeActions) -> u64 {
1698 message.buffer_id
1699 }
1700}
1701
1702#[async_trait(?Send)]
1703impl LspCommand for OnTypeFormatting {
1704 type Response = Option<Transaction>;
1705 type LspRequest = lsp::request::OnTypeFormatting;
1706 type ProtoRequest = proto::OnTypeFormatting;
1707
1708 fn check_capabilities(&self, server_capabilities: &lsp::ServerCapabilities) -> bool {
1709 let Some(on_type_formatting_options) =
1710 &server_capabilities.document_on_type_formatting_provider
1711 else {
1712 return false;
1713 };
1714 on_type_formatting_options
1715 .first_trigger_character
1716 .contains(&self.trigger)
1717 || on_type_formatting_options
1718 .more_trigger_character
1719 .iter()
1720 .flatten()
1721 .any(|chars| chars.contains(&self.trigger))
1722 }
1723
1724 fn to_lsp(
1725 &self,
1726 path: &Path,
1727 _: &Buffer,
1728 _: &Arc<LanguageServer>,
1729 _: &AppContext,
1730 ) -> lsp::DocumentOnTypeFormattingParams {
1731 lsp::DocumentOnTypeFormattingParams {
1732 text_document_position: lsp::TextDocumentPositionParams::new(
1733 lsp::TextDocumentIdentifier::new(lsp::Url::from_file_path(path).unwrap()),
1734 point_to_lsp(self.position),
1735 ),
1736 ch: self.trigger.clone(),
1737 options: lsp_formatting_options(self.options.tab_size),
1738 }
1739 }
1740
1741 async fn response_from_lsp(
1742 self,
1743 message: Option<Vec<lsp::TextEdit>>,
1744 project: Model<Project>,
1745 buffer: Model<Buffer>,
1746 server_id: LanguageServerId,
1747 mut cx: AsyncAppContext,
1748 ) -> Result<Option<Transaction>> {
1749 if let Some(edits) = message {
1750 let (lsp_adapter, lsp_server) =
1751 language_server_for_buffer(&project, &buffer, server_id, &mut cx)?;
1752 Project::deserialize_edits(
1753 project,
1754 buffer,
1755 edits,
1756 self.push_to_history,
1757 lsp_adapter,
1758 lsp_server,
1759 &mut cx,
1760 )
1761 .await
1762 } else {
1763 Ok(None)
1764 }
1765 }
1766
1767 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::OnTypeFormatting {
1768 proto::OnTypeFormatting {
1769 project_id,
1770 buffer_id: buffer.remote_id(),
1771 position: Some(language::proto::serialize_anchor(
1772 &buffer.anchor_before(self.position),
1773 )),
1774 trigger: self.trigger.clone(),
1775 version: serialize_version(&buffer.version()),
1776 }
1777 }
1778
1779 async fn from_proto(
1780 message: proto::OnTypeFormatting,
1781 _: Model<Project>,
1782 buffer: Model<Buffer>,
1783 mut cx: AsyncAppContext,
1784 ) -> Result<Self> {
1785 let position = message
1786 .position
1787 .and_then(deserialize_anchor)
1788 .ok_or_else(|| anyhow!("invalid position"))?;
1789 buffer
1790 .update(&mut cx, |buffer, _| {
1791 buffer.wait_for_version(deserialize_version(&message.version))
1792 })?
1793 .await?;
1794
1795 let tab_size = buffer.update(&mut cx, |buffer, cx| {
1796 language_settings(buffer.language(), buffer.file(), cx).tab_size
1797 })?;
1798
1799 Ok(Self {
1800 position: buffer.update(&mut cx, |buffer, _| position.to_point_utf16(buffer))?,
1801 trigger: message.trigger.clone(),
1802 options: lsp_formatting_options(tab_size.get()).into(),
1803 push_to_history: false,
1804 })
1805 }
1806
1807 fn response_to_proto(
1808 response: Option<Transaction>,
1809 _: &mut Project,
1810 _: PeerId,
1811 _: &clock::Global,
1812 _: &mut AppContext,
1813 ) -> proto::OnTypeFormattingResponse {
1814 proto::OnTypeFormattingResponse {
1815 transaction: response
1816 .map(|transaction| language::proto::serialize_transaction(&transaction)),
1817 }
1818 }
1819
1820 async fn response_from_proto(
1821 self,
1822 message: proto::OnTypeFormattingResponse,
1823 _: Model<Project>,
1824 _: Model<Buffer>,
1825 _: AsyncAppContext,
1826 ) -> Result<Option<Transaction>> {
1827 let Some(transaction) = message.transaction else {
1828 return Ok(None);
1829 };
1830 Ok(Some(language::proto::deserialize_transaction(transaction)?))
1831 }
1832
1833 fn buffer_id_from_proto(message: &proto::OnTypeFormatting) -> u64 {
1834 message.buffer_id
1835 }
1836}
1837
1838impl InlayHints {
1839 pub async fn lsp_to_project_hint(
1840 lsp_hint: lsp::InlayHint,
1841 buffer_handle: &Model<Buffer>,
1842 server_id: LanguageServerId,
1843 resolve_state: ResolveState,
1844 force_no_type_left_padding: bool,
1845 cx: &mut AsyncAppContext,
1846 ) -> anyhow::Result<InlayHint> {
1847 let kind = lsp_hint.kind.and_then(|kind| match kind {
1848 lsp::InlayHintKind::TYPE => Some(InlayHintKind::Type),
1849 lsp::InlayHintKind::PARAMETER => Some(InlayHintKind::Parameter),
1850 _ => None,
1851 });
1852
1853 let position = buffer_handle.update(cx, |buffer, _| {
1854 let position = buffer.clip_point_utf16(point_from_lsp(lsp_hint.position), Bias::Left);
1855 if kind == Some(InlayHintKind::Parameter) {
1856 buffer.anchor_before(position)
1857 } else {
1858 buffer.anchor_after(position)
1859 }
1860 })?;
1861 let label = Self::lsp_inlay_label_to_project(lsp_hint.label, server_id)
1862 .await
1863 .context("lsp to project inlay hint conversion")?;
1864 let padding_left = if force_no_type_left_padding && kind == Some(InlayHintKind::Type) {
1865 false
1866 } else {
1867 lsp_hint.padding_left.unwrap_or(false)
1868 };
1869
1870 Ok(InlayHint {
1871 position,
1872 padding_left,
1873 padding_right: lsp_hint.padding_right.unwrap_or(false),
1874 label,
1875 kind,
1876 tooltip: lsp_hint.tooltip.map(|tooltip| match tooltip {
1877 lsp::InlayHintTooltip::String(s) => InlayHintTooltip::String(s),
1878 lsp::InlayHintTooltip::MarkupContent(markup_content) => {
1879 InlayHintTooltip::MarkupContent(MarkupContent {
1880 kind: match markup_content.kind {
1881 lsp::MarkupKind::PlainText => HoverBlockKind::PlainText,
1882 lsp::MarkupKind::Markdown => HoverBlockKind::Markdown,
1883 },
1884 value: markup_content.value,
1885 })
1886 }
1887 }),
1888 resolve_state,
1889 })
1890 }
1891
1892 async fn lsp_inlay_label_to_project(
1893 lsp_label: lsp::InlayHintLabel,
1894 server_id: LanguageServerId,
1895 ) -> anyhow::Result<InlayHintLabel> {
1896 let label = match lsp_label {
1897 lsp::InlayHintLabel::String(s) => InlayHintLabel::String(s),
1898 lsp::InlayHintLabel::LabelParts(lsp_parts) => {
1899 let mut parts = Vec::with_capacity(lsp_parts.len());
1900 for lsp_part in lsp_parts {
1901 parts.push(InlayHintLabelPart {
1902 value: lsp_part.value,
1903 tooltip: lsp_part.tooltip.map(|tooltip| match tooltip {
1904 lsp::InlayHintLabelPartTooltip::String(s) => {
1905 InlayHintLabelPartTooltip::String(s)
1906 }
1907 lsp::InlayHintLabelPartTooltip::MarkupContent(markup_content) => {
1908 InlayHintLabelPartTooltip::MarkupContent(MarkupContent {
1909 kind: match markup_content.kind {
1910 lsp::MarkupKind::PlainText => HoverBlockKind::PlainText,
1911 lsp::MarkupKind::Markdown => HoverBlockKind::Markdown,
1912 },
1913 value: markup_content.value,
1914 })
1915 }
1916 }),
1917 location: Some(server_id).zip(lsp_part.location),
1918 });
1919 }
1920 InlayHintLabel::LabelParts(parts)
1921 }
1922 };
1923
1924 Ok(label)
1925 }
1926
1927 pub fn project_to_proto_hint(response_hint: InlayHint) -> proto::InlayHint {
1928 let (state, lsp_resolve_state) = match response_hint.resolve_state {
1929 ResolveState::Resolved => (0, None),
1930 ResolveState::CanResolve(server_id, resolve_data) => (
1931 1,
1932 resolve_data
1933 .map(|json_data| {
1934 serde_json::to_string(&json_data)
1935 .expect("failed to serialize resolve json data")
1936 })
1937 .map(|value| proto::resolve_state::LspResolveState {
1938 server_id: server_id.0 as u64,
1939 value,
1940 }),
1941 ),
1942 ResolveState::Resolving => (2, None),
1943 };
1944 let resolve_state = Some(proto::ResolveState {
1945 state,
1946 lsp_resolve_state,
1947 });
1948 proto::InlayHint {
1949 position: Some(language::proto::serialize_anchor(&response_hint.position)),
1950 padding_left: response_hint.padding_left,
1951 padding_right: response_hint.padding_right,
1952 label: Some(proto::InlayHintLabel {
1953 label: Some(match response_hint.label {
1954 InlayHintLabel::String(s) => proto::inlay_hint_label::Label::Value(s),
1955 InlayHintLabel::LabelParts(label_parts) => {
1956 proto::inlay_hint_label::Label::LabelParts(proto::InlayHintLabelParts {
1957 parts: label_parts.into_iter().map(|label_part| {
1958 let location_url = label_part.location.as_ref().map(|(_, location)| location.uri.to_string());
1959 let location_range_start = label_part.location.as_ref().map(|(_, location)| point_from_lsp(location.range.start).0).map(|point| proto::PointUtf16 { row: point.row, column: point.column });
1960 let location_range_end = label_part.location.as_ref().map(|(_, location)| point_from_lsp(location.range.end).0).map(|point| proto::PointUtf16 { row: point.row, column: point.column });
1961 proto::InlayHintLabelPart {
1962 value: label_part.value,
1963 tooltip: label_part.tooltip.map(|tooltip| {
1964 let proto_tooltip = match tooltip {
1965 InlayHintLabelPartTooltip::String(s) => proto::inlay_hint_label_part_tooltip::Content::Value(s),
1966 InlayHintLabelPartTooltip::MarkupContent(markup_content) => proto::inlay_hint_label_part_tooltip::Content::MarkupContent(proto::MarkupContent {
1967 is_markdown: markup_content.kind == HoverBlockKind::Markdown,
1968 value: markup_content.value,
1969 }),
1970 };
1971 proto::InlayHintLabelPartTooltip {content: Some(proto_tooltip)}
1972 }),
1973 location_url,
1974 location_range_start,
1975 location_range_end,
1976 language_server_id: label_part.location.as_ref().map(|(server_id, _)| server_id.0 as u64),
1977 }}).collect()
1978 })
1979 }
1980 }),
1981 }),
1982 kind: response_hint.kind.map(|kind| kind.name().to_string()),
1983 tooltip: response_hint.tooltip.map(|response_tooltip| {
1984 let proto_tooltip = match response_tooltip {
1985 InlayHintTooltip::String(s) => proto::inlay_hint_tooltip::Content::Value(s),
1986 InlayHintTooltip::MarkupContent(markup_content) => {
1987 proto::inlay_hint_tooltip::Content::MarkupContent(proto::MarkupContent {
1988 is_markdown: markup_content.kind == HoverBlockKind::Markdown,
1989 value: markup_content.value,
1990 })
1991 }
1992 };
1993 proto::InlayHintTooltip {
1994 content: Some(proto_tooltip),
1995 }
1996 }),
1997 resolve_state,
1998 }
1999 }
2000
2001 pub fn proto_to_project_hint(message_hint: proto::InlayHint) -> anyhow::Result<InlayHint> {
2002 let resolve_state = message_hint.resolve_state.as_ref().unwrap_or_else(|| {
2003 panic!("incorrect proto inlay hint message: no resolve state in hint {message_hint:?}",)
2004 });
2005 let resolve_state_data = resolve_state
2006 .lsp_resolve_state.as_ref()
2007 .map(|lsp_resolve_state| {
2008 serde_json::from_str::<Option<lsp::LSPAny>>(&lsp_resolve_state.value)
2009 .with_context(|| format!("incorrect proto inlay hint message: non-json resolve state {lsp_resolve_state:?}"))
2010 .map(|state| (LanguageServerId(lsp_resolve_state.server_id as usize), state))
2011 })
2012 .transpose()?;
2013 let resolve_state = match resolve_state.state {
2014 0 => ResolveState::Resolved,
2015 1 => {
2016 let (server_id, lsp_resolve_state) = resolve_state_data.with_context(|| {
2017 format!(
2018 "No lsp resolve data for the hint that can be resolved: {message_hint:?}"
2019 )
2020 })?;
2021 ResolveState::CanResolve(server_id, lsp_resolve_state)
2022 }
2023 2 => ResolveState::Resolving,
2024 invalid => {
2025 anyhow::bail!("Unexpected resolve state {invalid} for hint {message_hint:?}")
2026 }
2027 };
2028 Ok(InlayHint {
2029 position: message_hint
2030 .position
2031 .and_then(language::proto::deserialize_anchor)
2032 .context("invalid position")?,
2033 label: match message_hint
2034 .label
2035 .and_then(|label| label.label)
2036 .context("missing label")?
2037 {
2038 proto::inlay_hint_label::Label::Value(s) => InlayHintLabel::String(s),
2039 proto::inlay_hint_label::Label::LabelParts(parts) => {
2040 let mut label_parts = Vec::new();
2041 for part in parts.parts {
2042 label_parts.push(InlayHintLabelPart {
2043 value: part.value,
2044 tooltip: part.tooltip.map(|tooltip| match tooltip.content {
2045 Some(proto::inlay_hint_label_part_tooltip::Content::Value(s)) => {
2046 InlayHintLabelPartTooltip::String(s)
2047 }
2048 Some(
2049 proto::inlay_hint_label_part_tooltip::Content::MarkupContent(
2050 markup_content,
2051 ),
2052 ) => InlayHintLabelPartTooltip::MarkupContent(MarkupContent {
2053 kind: if markup_content.is_markdown {
2054 HoverBlockKind::Markdown
2055 } else {
2056 HoverBlockKind::PlainText
2057 },
2058 value: markup_content.value,
2059 }),
2060 None => InlayHintLabelPartTooltip::String(String::new()),
2061 }),
2062 location: {
2063 match part
2064 .location_url
2065 .zip(
2066 part.location_range_start.and_then(|start| {
2067 Some(start..part.location_range_end?)
2068 }),
2069 )
2070 .zip(part.language_server_id)
2071 {
2072 Some(((uri, range), server_id)) => Some((
2073 LanguageServerId(server_id as usize),
2074 lsp::Location {
2075 uri: lsp::Url::parse(&uri)
2076 .context("invalid uri in hint part {part:?}")?,
2077 range: lsp::Range::new(
2078 point_to_lsp(PointUtf16::new(
2079 range.start.row,
2080 range.start.column,
2081 )),
2082 point_to_lsp(PointUtf16::new(
2083 range.end.row,
2084 range.end.column,
2085 )),
2086 ),
2087 },
2088 )),
2089 None => None,
2090 }
2091 },
2092 });
2093 }
2094
2095 InlayHintLabel::LabelParts(label_parts)
2096 }
2097 },
2098 padding_left: message_hint.padding_left,
2099 padding_right: message_hint.padding_right,
2100 kind: message_hint
2101 .kind
2102 .as_deref()
2103 .and_then(InlayHintKind::from_name),
2104 tooltip: message_hint.tooltip.and_then(|tooltip| {
2105 Some(match tooltip.content? {
2106 proto::inlay_hint_tooltip::Content::Value(s) => InlayHintTooltip::String(s),
2107 proto::inlay_hint_tooltip::Content::MarkupContent(markup_content) => {
2108 InlayHintTooltip::MarkupContent(MarkupContent {
2109 kind: if markup_content.is_markdown {
2110 HoverBlockKind::Markdown
2111 } else {
2112 HoverBlockKind::PlainText
2113 },
2114 value: markup_content.value,
2115 })
2116 }
2117 })
2118 }),
2119 resolve_state,
2120 })
2121 }
2122
2123 pub fn project_to_lsp_hint(hint: InlayHint, snapshot: &BufferSnapshot) -> lsp::InlayHint {
2124 lsp::InlayHint {
2125 position: point_to_lsp(hint.position.to_point_utf16(snapshot)),
2126 kind: hint.kind.map(|kind| match kind {
2127 InlayHintKind::Type => lsp::InlayHintKind::TYPE,
2128 InlayHintKind::Parameter => lsp::InlayHintKind::PARAMETER,
2129 }),
2130 text_edits: None,
2131 tooltip: hint.tooltip.and_then(|tooltip| {
2132 Some(match tooltip {
2133 InlayHintTooltip::String(s) => lsp::InlayHintTooltip::String(s),
2134 InlayHintTooltip::MarkupContent(markup_content) => {
2135 lsp::InlayHintTooltip::MarkupContent(lsp::MarkupContent {
2136 kind: match markup_content.kind {
2137 HoverBlockKind::PlainText => lsp::MarkupKind::PlainText,
2138 HoverBlockKind::Markdown => lsp::MarkupKind::Markdown,
2139 HoverBlockKind::Code { .. } => return None,
2140 },
2141 value: markup_content.value,
2142 })
2143 }
2144 })
2145 }),
2146 label: match hint.label {
2147 InlayHintLabel::String(s) => lsp::InlayHintLabel::String(s),
2148 InlayHintLabel::LabelParts(label_parts) => lsp::InlayHintLabel::LabelParts(
2149 label_parts
2150 .into_iter()
2151 .map(|part| lsp::InlayHintLabelPart {
2152 value: part.value,
2153 tooltip: part.tooltip.and_then(|tooltip| {
2154 Some(match tooltip {
2155 InlayHintLabelPartTooltip::String(s) => {
2156 lsp::InlayHintLabelPartTooltip::String(s)
2157 }
2158 InlayHintLabelPartTooltip::MarkupContent(markup_content) => {
2159 lsp::InlayHintLabelPartTooltip::MarkupContent(
2160 lsp::MarkupContent {
2161 kind: match markup_content.kind {
2162 HoverBlockKind::PlainText => {
2163 lsp::MarkupKind::PlainText
2164 }
2165 HoverBlockKind::Markdown => {
2166 lsp::MarkupKind::Markdown
2167 }
2168 HoverBlockKind::Code { .. } => return None,
2169 },
2170 value: markup_content.value,
2171 },
2172 )
2173 }
2174 })
2175 }),
2176 location: part.location.map(|(_, location)| location),
2177 command: None,
2178 })
2179 .collect(),
2180 ),
2181 },
2182 padding_left: Some(hint.padding_left),
2183 padding_right: Some(hint.padding_right),
2184 data: match hint.resolve_state {
2185 ResolveState::CanResolve(_, data) => data,
2186 ResolveState::Resolving | ResolveState::Resolved => None,
2187 },
2188 }
2189 }
2190
2191 pub fn can_resolve_inlays(capabilities: &ServerCapabilities) -> bool {
2192 capabilities
2193 .inlay_hint_provider
2194 .as_ref()
2195 .and_then(|options| match options {
2196 OneOf::Left(_is_supported) => None,
2197 OneOf::Right(capabilities) => match capabilities {
2198 lsp::InlayHintServerCapabilities::Options(o) => o.resolve_provider,
2199 lsp::InlayHintServerCapabilities::RegistrationOptions(o) => {
2200 o.inlay_hint_options.resolve_provider
2201 }
2202 },
2203 })
2204 .unwrap_or(false)
2205 }
2206}
2207
2208#[async_trait(?Send)]
2209impl LspCommand for InlayHints {
2210 type Response = Vec<InlayHint>;
2211 type LspRequest = lsp::InlayHintRequest;
2212 type ProtoRequest = proto::InlayHints;
2213
2214 fn check_capabilities(&self, server_capabilities: &lsp::ServerCapabilities) -> bool {
2215 let Some(inlay_hint_provider) = &server_capabilities.inlay_hint_provider else {
2216 return false;
2217 };
2218 match inlay_hint_provider {
2219 lsp::OneOf::Left(enabled) => *enabled,
2220 lsp::OneOf::Right(inlay_hint_capabilities) => match inlay_hint_capabilities {
2221 lsp::InlayHintServerCapabilities::Options(_) => true,
2222 lsp::InlayHintServerCapabilities::RegistrationOptions(_) => false,
2223 },
2224 }
2225 }
2226
2227 fn to_lsp(
2228 &self,
2229 path: &Path,
2230 buffer: &Buffer,
2231 _: &Arc<LanguageServer>,
2232 _: &AppContext,
2233 ) -> lsp::InlayHintParams {
2234 lsp::InlayHintParams {
2235 text_document: lsp::TextDocumentIdentifier {
2236 uri: lsp::Url::from_file_path(path).unwrap(),
2237 },
2238 range: range_to_lsp(self.range.to_point_utf16(buffer)),
2239 work_done_progress_params: Default::default(),
2240 }
2241 }
2242
2243 async fn response_from_lsp(
2244 self,
2245 message: Option<Vec<lsp::InlayHint>>,
2246 project: Model<Project>,
2247 buffer: Model<Buffer>,
2248 server_id: LanguageServerId,
2249 mut cx: AsyncAppContext,
2250 ) -> anyhow::Result<Vec<InlayHint>> {
2251 let (lsp_adapter, lsp_server) =
2252 language_server_for_buffer(&project, &buffer, server_id, &mut cx)?;
2253 // `typescript-language-server` adds padding to the left for type hints, turning
2254 // `const foo: boolean` into `const foo : boolean` which looks odd.
2255 // `rust-analyzer` does not have the padding for this case, and we have to accomodate both.
2256 //
2257 // We could trim the whole string, but being pessimistic on par with the situation above,
2258 // there might be a hint with multiple whitespaces at the end(s) which we need to display properly.
2259 // Hence let's use a heuristic first to handle the most awkward case and look for more.
2260 let force_no_type_left_padding =
2261 lsp_adapter.name.0.as_ref() == "typescript-language-server";
2262
2263 let hints = message.unwrap_or_default().into_iter().map(|lsp_hint| {
2264 let resolve_state = if InlayHints::can_resolve_inlays(lsp_server.capabilities()) {
2265 ResolveState::CanResolve(lsp_server.server_id(), lsp_hint.data.clone())
2266 } else {
2267 ResolveState::Resolved
2268 };
2269
2270 let buffer = buffer.clone();
2271 cx.spawn(move |mut cx| async move {
2272 InlayHints::lsp_to_project_hint(
2273 lsp_hint,
2274 &buffer,
2275 server_id,
2276 resolve_state,
2277 force_no_type_left_padding,
2278 &mut cx,
2279 )
2280 .await
2281 })
2282 });
2283 future::join_all(hints)
2284 .await
2285 .into_iter()
2286 .collect::<anyhow::Result<_>>()
2287 .context("lsp to project inlay hints conversion")
2288 }
2289
2290 fn to_proto(&self, project_id: u64, buffer: &Buffer) -> proto::InlayHints {
2291 proto::InlayHints {
2292 project_id,
2293 buffer_id: buffer.remote_id(),
2294 start: Some(language::proto::serialize_anchor(&self.range.start)),
2295 end: Some(language::proto::serialize_anchor(&self.range.end)),
2296 version: serialize_version(&buffer.version()),
2297 }
2298 }
2299
2300 async fn from_proto(
2301 message: proto::InlayHints,
2302 _: Model<Project>,
2303 buffer: Model<Buffer>,
2304 mut cx: AsyncAppContext,
2305 ) -> Result<Self> {
2306 let start = message
2307 .start
2308 .and_then(language::proto::deserialize_anchor)
2309 .context("invalid start")?;
2310 let end = message
2311 .end
2312 .and_then(language::proto::deserialize_anchor)
2313 .context("invalid end")?;
2314 buffer
2315 .update(&mut cx, |buffer, _| {
2316 buffer.wait_for_version(deserialize_version(&message.version))
2317 })?
2318 .await?;
2319
2320 Ok(Self { range: start..end })
2321 }
2322
2323 fn response_to_proto(
2324 response: Vec<InlayHint>,
2325 _: &mut Project,
2326 _: PeerId,
2327 buffer_version: &clock::Global,
2328 _: &mut AppContext,
2329 ) -> proto::InlayHintsResponse {
2330 proto::InlayHintsResponse {
2331 hints: response
2332 .into_iter()
2333 .map(|response_hint| InlayHints::project_to_proto_hint(response_hint))
2334 .collect(),
2335 version: serialize_version(buffer_version),
2336 }
2337 }
2338
2339 async fn response_from_proto(
2340 self,
2341 message: proto::InlayHintsResponse,
2342 _: Model<Project>,
2343 buffer: Model<Buffer>,
2344 mut cx: AsyncAppContext,
2345 ) -> anyhow::Result<Vec<InlayHint>> {
2346 buffer
2347 .update(&mut cx, |buffer, _| {
2348 buffer.wait_for_version(deserialize_version(&message.version))
2349 })?
2350 .await?;
2351
2352 let mut hints = Vec::new();
2353 for message_hint in message.hints {
2354 hints.push(InlayHints::proto_to_project_hint(message_hint)?);
2355 }
2356
2357 Ok(hints)
2358 }
2359
2360 fn buffer_id_from_proto(message: &proto::InlayHints) -> u64 {
2361 message.buffer_id
2362 }
2363}