1use anyhow::{Context as _, Result, bail};
2use async_trait::async_trait;
3use futures::StreamExt;
4use gpui::{App, AsyncApp};
5use http_client::github::{AssetKind, GitHubLspBinaryVersion, latest_github_release};
6use http_client::github_download::{GithubBinaryMetadata, download_server_binary};
7pub use language::*;
8use lsp::{InitializeParams, LanguageServerBinary, LanguageServerName};
9use project::lsp_store::clangd_ext;
10use serde_json::json;
11use smol::fs;
12use std::{env::consts, path::PathBuf, sync::Arc};
13use util::{ResultExt, fs::remove_matching, maybe, merge_json_value_into};
14
15pub struct CLspAdapter;
16
17impl CLspAdapter {
18 const SERVER_NAME: LanguageServerName = LanguageServerName::new_static("clangd");
19}
20
21impl LspInstaller for CLspAdapter {
22 type BinaryVersion = GitHubLspBinaryVersion;
23
24 async fn fetch_latest_server_version(
25 &self,
26 delegate: &dyn LspAdapterDelegate,
27 pre_release: bool,
28 _: &mut AsyncApp,
29 ) -> Result<GitHubLspBinaryVersion> {
30 let release =
31 latest_github_release("clangd/clangd", true, pre_release, delegate.http_client())
32 .await?;
33 let os_suffix = match consts::OS {
34 "macos" => "mac",
35 "linux" => "linux",
36 "windows" => "windows",
37 other => bail!("Running on unsupported os: {other}"),
38 };
39 let asset_name = format!("clangd-{}-{}.zip", os_suffix, release.tag_name);
40 let asset = release
41 .assets
42 .iter()
43 .find(|asset| asset.name == asset_name)
44 .with_context(|| format!("no asset found matching {asset_name:?}"))?;
45 let version = GitHubLspBinaryVersion {
46 name: release.tag_name,
47 url: asset.browser_download_url.clone(),
48 digest: asset.digest.clone(),
49 };
50 Ok(version)
51 }
52
53 async fn check_if_user_installed(
54 &self,
55 delegate: &dyn LspAdapterDelegate,
56 _: Option<Toolchain>,
57 _: &AsyncApp,
58 ) -> Option<LanguageServerBinary> {
59 let path = delegate.which(Self::SERVER_NAME.as_ref()).await?;
60 Some(LanguageServerBinary {
61 path,
62 arguments: Vec::new(),
63 env: None,
64 })
65 }
66
67 async fn fetch_server_binary(
68 &self,
69 version: GitHubLspBinaryVersion,
70 container_dir: PathBuf,
71 delegate: &dyn LspAdapterDelegate,
72 ) -> Result<LanguageServerBinary> {
73 let GitHubLspBinaryVersion {
74 name,
75 url,
76 digest: expected_digest,
77 } = version;
78 let version_dir = container_dir.join(format!("clangd_{name}"));
79 let binary_path = version_dir.join("bin/clangd");
80
81 let binary = LanguageServerBinary {
82 path: binary_path.clone(),
83 env: None,
84 arguments: Default::default(),
85 };
86
87 let metadata_path = version_dir.join("metadata");
88 let metadata = GithubBinaryMetadata::read_from_file(&metadata_path)
89 .await
90 .ok();
91 if let Some(metadata) = metadata {
92 let validity_check = async || {
93 delegate
94 .try_exec(LanguageServerBinary {
95 path: binary_path.clone(),
96 arguments: vec!["--version".into()],
97 env: None,
98 })
99 .await
100 .inspect_err(|err| {
101 log::warn!("Unable to run {binary_path:?} asset, redownloading: {err}",)
102 })
103 };
104 if let (Some(actual_digest), Some(expected_digest)) =
105 (&metadata.digest, &expected_digest)
106 {
107 if actual_digest == expected_digest {
108 if validity_check().await.is_ok() {
109 return Ok(binary);
110 }
111 } else {
112 log::info!(
113 "SHA-256 mismatch for {binary_path:?} asset, downloading new asset. Expected: {expected_digest}, Got: {actual_digest}"
114 );
115 }
116 } else if validity_check().await.is_ok() {
117 return Ok(binary);
118 }
119 }
120 download_server_binary(
121 &*delegate.http_client(),
122 &url,
123 expected_digest.as_deref(),
124 &container_dir,
125 AssetKind::Zip,
126 )
127 .await?;
128 remove_matching(&container_dir, |entry| entry != version_dir).await;
129 GithubBinaryMetadata::write_to_file(
130 &GithubBinaryMetadata {
131 metadata_version: 1,
132 digest: expected_digest,
133 },
134 &metadata_path,
135 )
136 .await?;
137
138 Ok(binary)
139 }
140
141 async fn cached_server_binary(
142 &self,
143 container_dir: PathBuf,
144 _: &dyn LspAdapterDelegate,
145 ) -> Option<LanguageServerBinary> {
146 get_cached_server_binary(container_dir).await
147 }
148}
149
150#[async_trait(?Send)]
151impl super::LspAdapter for CLspAdapter {
152 fn name(&self) -> LanguageServerName {
153 Self::SERVER_NAME
154 }
155
156 async fn label_for_completion(
157 &self,
158 completion: &lsp::CompletionItem,
159 language: &Arc<Language>,
160 ) -> Option<CodeLabel> {
161 let label_detail = match &completion.label_details {
162 Some(label_detail) => match &label_detail.detail {
163 Some(detail) => detail.trim(),
164 None => "",
165 },
166 None => "",
167 };
168
169 let mut label = completion
170 .label
171 .strip_prefix('•')
172 .unwrap_or(&completion.label)
173 .trim()
174 .to_owned();
175
176 if !label_detail.is_empty() {
177 let should_add_space = match completion.kind {
178 Some(lsp::CompletionItemKind::FUNCTION | lsp::CompletionItemKind::METHOD) => false,
179 _ => true,
180 };
181
182 if should_add_space && !label.ends_with(' ') && !label_detail.starts_with(' ') {
183 label.push(' ');
184 }
185 label.push_str(label_detail);
186 }
187
188 match completion.kind {
189 Some(lsp::CompletionItemKind::FIELD) if completion.detail.is_some() => {
190 let detail = completion.detail.as_ref().unwrap();
191 let text = format!("{} {}", detail, label);
192 let source = Rope::from_str_small(format!("struct S {{ {} }}", text).as_str());
193 let runs = language.highlight_text(&source, 11..11 + text.len());
194 let filter_range = completion
195 .filter_text
196 .as_deref()
197 .and_then(|filter_text| {
198 text.find(filter_text)
199 .map(|start| start..start + filter_text.len())
200 })
201 .unwrap_or(detail.len() + 1..text.len());
202 return Some(CodeLabel::new(text, filter_range, runs));
203 }
204 Some(lsp::CompletionItemKind::CONSTANT | lsp::CompletionItemKind::VARIABLE)
205 if completion.detail.is_some() =>
206 {
207 let detail = completion.detail.as_ref().unwrap();
208 let text = format!("{} {}", detail, label);
209 let runs =
210 language.highlight_text(&Rope::from_str_small(text.as_str()), 0..text.len());
211 let filter_range = completion
212 .filter_text
213 .as_deref()
214 .and_then(|filter_text| {
215 text.find(filter_text)
216 .map(|start| start..start + filter_text.len())
217 })
218 .unwrap_or(detail.len() + 1..text.len());
219 return Some(CodeLabel::new(text, filter_range, runs));
220 }
221 Some(lsp::CompletionItemKind::FUNCTION | lsp::CompletionItemKind::METHOD)
222 if completion.detail.is_some() =>
223 {
224 let detail = completion.detail.as_ref().unwrap();
225 let text = format!("{} {}", detail, label);
226 let runs =
227 language.highlight_text(&Rope::from_str_small(text.as_str()), 0..text.len());
228 let filter_range = completion
229 .filter_text
230 .as_deref()
231 .and_then(|filter_text| {
232 text.find(filter_text)
233 .map(|start| start..start + filter_text.len())
234 })
235 .unwrap_or_else(|| {
236 let filter_start = detail.len() + 1;
237 let filter_end = text
238 .rfind('(')
239 .filter(|end| *end > filter_start)
240 .unwrap_or(text.len());
241 filter_start..filter_end
242 });
243
244 return Some(CodeLabel::new(text, filter_range, runs));
245 }
246 Some(kind) => {
247 let highlight_name = match kind {
248 lsp::CompletionItemKind::STRUCT
249 | lsp::CompletionItemKind::INTERFACE
250 | lsp::CompletionItemKind::CLASS
251 | lsp::CompletionItemKind::ENUM => Some("type"),
252 lsp::CompletionItemKind::ENUM_MEMBER => Some("variant"),
253 lsp::CompletionItemKind::KEYWORD => Some("keyword"),
254 lsp::CompletionItemKind::VALUE | lsp::CompletionItemKind::CONSTANT => {
255 Some("constant")
256 }
257 _ => None,
258 };
259 if let Some(highlight_id) = language
260 .grammar()
261 .and_then(|g| g.highlight_id_for_name(highlight_name?))
262 {
263 let mut label = CodeLabel::plain(label, completion.filter_text.as_deref());
264 label.runs.push((
265 0..label.text.rfind('(').unwrap_or(label.text.len()),
266 highlight_id,
267 ));
268 return Some(label);
269 }
270 }
271 _ => {}
272 }
273 Some(CodeLabel::plain(label, completion.filter_text.as_deref()))
274 }
275
276 async fn label_for_symbol(
277 &self,
278 name: &str,
279 kind: lsp::SymbolKind,
280 language: &Arc<Language>,
281 ) -> Option<CodeLabel> {
282 let (text, filter_range, display_range) = match kind {
283 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
284 let text = format!("void {} () {{}}", name);
285 let filter_range = 0..name.len();
286 let display_range = 5..5 + name.len();
287 (text, filter_range, display_range)
288 }
289 lsp::SymbolKind::STRUCT => {
290 let text = format!("struct {} {{}}", name);
291 let filter_range = 7..7 + name.len();
292 let display_range = 0..filter_range.end;
293 (text, filter_range, display_range)
294 }
295 lsp::SymbolKind::ENUM => {
296 let text = format!("enum {} {{}}", name);
297 let filter_range = 5..5 + name.len();
298 let display_range = 0..filter_range.end;
299 (text, filter_range, display_range)
300 }
301 lsp::SymbolKind::INTERFACE | lsp::SymbolKind::CLASS => {
302 let text = format!("class {} {{}}", name);
303 let filter_range = 6..6 + name.len();
304 let display_range = 0..filter_range.end;
305 (text, filter_range, display_range)
306 }
307 lsp::SymbolKind::CONSTANT => {
308 let text = format!("const int {} = 0;", name);
309 let filter_range = 10..10 + name.len();
310 let display_range = 0..filter_range.end;
311 (text, filter_range, display_range)
312 }
313 lsp::SymbolKind::MODULE => {
314 let text = format!("namespace {} {{}}", name);
315 let filter_range = 10..10 + name.len();
316 let display_range = 0..filter_range.end;
317 (text, filter_range, display_range)
318 }
319 lsp::SymbolKind::TYPE_PARAMETER => {
320 let text = format!("typename {} {{}};", name);
321 let filter_range = 9..9 + name.len();
322 let display_range = 0..filter_range.end;
323 (text, filter_range, display_range)
324 }
325 _ => return None,
326 };
327
328 Some(CodeLabel::new(
329 text[display_range.clone()].to_string(),
330 filter_range,
331 language.highlight_text(&Rope::from_str_small(text.as_str()), display_range),
332 ))
333 }
334
335 fn prepare_initialize_params(
336 &self,
337 mut original: InitializeParams,
338 _: &App,
339 ) -> Result<InitializeParams> {
340 let experimental = json!({
341 "textDocument": {
342 "completion" : {
343 // enable clangd's dot-to-arrow feature.
344 "editsNearCursor": true
345 },
346 "inactiveRegionsCapabilities": {
347 "inactiveRegions": true,
348 }
349 }
350 });
351 if let Some(ref mut original_experimental) = original.capabilities.experimental {
352 merge_json_value_into(experimental, original_experimental);
353 } else {
354 original.capabilities.experimental = Some(experimental);
355 }
356 Ok(original)
357 }
358
359 fn retain_old_diagnostic(&self, previous_diagnostic: &Diagnostic, _: &App) -> bool {
360 clangd_ext::is_inactive_region(previous_diagnostic)
361 }
362
363 fn underline_diagnostic(&self, diagnostic: &lsp::Diagnostic) -> bool {
364 !clangd_ext::is_lsp_inactive_region(diagnostic)
365 }
366}
367
368async fn get_cached_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
369 maybe!(async {
370 let mut last_clangd_dir = None;
371 let mut entries = fs::read_dir(&container_dir).await?;
372 while let Some(entry) = entries.next().await {
373 let entry = entry?;
374 if entry.file_type().await?.is_dir() {
375 last_clangd_dir = Some(entry.path());
376 }
377 }
378 let clangd_dir = last_clangd_dir.context("no cached binary")?;
379 let clangd_bin = clangd_dir.join("bin/clangd");
380 anyhow::ensure!(
381 clangd_bin.exists(),
382 "missing clangd binary in directory {clangd_dir:?}"
383 );
384 Ok(LanguageServerBinary {
385 path: clangd_bin,
386 env: None,
387 arguments: Vec::new(),
388 })
389 })
390 .await
391 .log_err()
392}
393
394#[cfg(test)]
395mod tests {
396 use gpui::{AppContext as _, BorrowAppContext, TestAppContext};
397 use language::{AutoindentMode, Buffer};
398 use settings::SettingsStore;
399 use std::num::NonZeroU32;
400
401 #[gpui::test]
402 async fn test_c_autoindent(cx: &mut TestAppContext) {
403 // cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
404 cx.update(|cx| {
405 let test_settings = SettingsStore::test(cx);
406 cx.set_global(test_settings);
407 language::init(cx);
408 cx.update_global::<SettingsStore, _>(|store, cx| {
409 store.update_user_settings(cx, |s| {
410 s.project.all_languages.defaults.tab_size = NonZeroU32::new(2);
411 });
412 });
413 });
414 let language = crate::language("c", tree_sitter_c::LANGUAGE.into());
415
416 cx.new(|cx| {
417 let mut buffer = Buffer::local("", cx).with_language(language, cx);
418
419 // empty function
420 buffer.edit([(0..0, "int main() {}")], None, cx);
421
422 // indent inside braces
423 let ix = buffer.len() - 1;
424 buffer.edit([(ix..ix, "\n\n")], Some(AutoindentMode::EachLine), cx);
425 assert_eq!(buffer.text(), "int main() {\n \n}");
426
427 // indent body of single-statement if statement
428 let ix = buffer.len() - 2;
429 buffer.edit([(ix..ix, "if (a)\nb;")], Some(AutoindentMode::EachLine), cx);
430 assert_eq!(buffer.text(), "int main() {\n if (a)\n b;\n}");
431
432 // indent inside field expression
433 let ix = buffer.len() - 3;
434 buffer.edit([(ix..ix, "\n.c")], Some(AutoindentMode::EachLine), cx);
435 assert_eq!(buffer.text(), "int main() {\n if (a)\n b\n .c;\n}");
436
437 buffer
438 });
439 }
440}