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 label = completion
170 .label
171 .strip_prefix('•')
172 .unwrap_or(&completion.label)
173 .trim()
174 .to_owned()
175 + label_detail;
176
177 match completion.kind {
178 Some(lsp::CompletionItemKind::FIELD) if completion.detail.is_some() => {
179 let detail = completion.detail.as_ref().unwrap();
180 let text = format!("{} {}", detail, label);
181 let source = Rope::from(format!("struct S {{ {} }}", text).as_str());
182 let runs = language.highlight_text(&source, 11..11 + text.len());
183 let filter_range = completion
184 .filter_text
185 .as_deref()
186 .and_then(|filter_text| {
187 text.find(filter_text)
188 .map(|start| start..start + filter_text.len())
189 })
190 .unwrap_or(detail.len() + 1..text.len());
191 return Some(CodeLabel::new(text, filter_range, runs));
192 }
193 Some(lsp::CompletionItemKind::CONSTANT | lsp::CompletionItemKind::VARIABLE)
194 if completion.detail.is_some() =>
195 {
196 let detail = completion.detail.as_ref().unwrap();
197 let text = format!("{} {}", detail, label);
198 let runs = language.highlight_text(&Rope::from(text.as_str()), 0..text.len());
199 let filter_range = completion
200 .filter_text
201 .as_deref()
202 .and_then(|filter_text| {
203 text.find(filter_text)
204 .map(|start| start..start + filter_text.len())
205 })
206 .unwrap_or(detail.len() + 1..text.len());
207 return Some(CodeLabel::new(text, filter_range, runs));
208 }
209 Some(lsp::CompletionItemKind::FUNCTION | lsp::CompletionItemKind::METHOD)
210 if completion.detail.is_some() =>
211 {
212 let detail = completion.detail.as_ref().unwrap();
213 let text = format!("{} {}", detail, label);
214 let runs = language.highlight_text(&Rope::from(text.as_str()), 0..text.len());
215 let filter_range = completion
216 .filter_text
217 .as_deref()
218 .and_then(|filter_text| {
219 text.find(filter_text)
220 .map(|start| start..start + filter_text.len())
221 })
222 .unwrap_or_else(|| {
223 let filter_start = detail.len() + 1;
224 let filter_end = text
225 .rfind('(')
226 .filter(|end| *end > filter_start)
227 .unwrap_or(text.len());
228 filter_start..filter_end
229 });
230
231 return Some(CodeLabel::new(text, filter_range, runs));
232 }
233 Some(kind) => {
234 let highlight_name = match kind {
235 lsp::CompletionItemKind::STRUCT
236 | lsp::CompletionItemKind::INTERFACE
237 | lsp::CompletionItemKind::CLASS
238 | lsp::CompletionItemKind::ENUM => Some("type"),
239 lsp::CompletionItemKind::ENUM_MEMBER => Some("variant"),
240 lsp::CompletionItemKind::KEYWORD => Some("keyword"),
241 lsp::CompletionItemKind::VALUE | lsp::CompletionItemKind::CONSTANT => {
242 Some("constant")
243 }
244 _ => None,
245 };
246 if let Some(highlight_id) = language
247 .grammar()
248 .and_then(|g| g.highlight_id_for_name(highlight_name?))
249 {
250 let mut label = CodeLabel::plain(label, completion.filter_text.as_deref());
251 label.runs.push((
252 0..label.text.rfind('(').unwrap_or(label.text.len()),
253 highlight_id,
254 ));
255 return Some(label);
256 }
257 }
258 _ => {}
259 }
260 Some(CodeLabel::plain(label, completion.filter_text.as_deref()))
261 }
262
263 async fn label_for_symbol(
264 &self,
265 name: &str,
266 kind: lsp::SymbolKind,
267 language: &Arc<Language>,
268 ) -> Option<CodeLabel> {
269 let (text, filter_range, display_range) = match kind {
270 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
271 let text = format!("void {} () {{}}", name);
272 let filter_range = 0..name.len();
273 let display_range = 5..5 + name.len();
274 (text, filter_range, display_range)
275 }
276 lsp::SymbolKind::STRUCT => {
277 let text = format!("struct {} {{}}", name);
278 let filter_range = 7..7 + name.len();
279 let display_range = 0..filter_range.end;
280 (text, filter_range, display_range)
281 }
282 lsp::SymbolKind::ENUM => {
283 let text = format!("enum {} {{}}", name);
284 let filter_range = 5..5 + name.len();
285 let display_range = 0..filter_range.end;
286 (text, filter_range, display_range)
287 }
288 lsp::SymbolKind::INTERFACE | lsp::SymbolKind::CLASS => {
289 let text = format!("class {} {{}}", name);
290 let filter_range = 6..6 + name.len();
291 let display_range = 0..filter_range.end;
292 (text, filter_range, display_range)
293 }
294 lsp::SymbolKind::CONSTANT => {
295 let text = format!("const int {} = 0;", name);
296 let filter_range = 10..10 + name.len();
297 let display_range = 0..filter_range.end;
298 (text, filter_range, display_range)
299 }
300 lsp::SymbolKind::MODULE => {
301 let text = format!("namespace {} {{}}", name);
302 let filter_range = 10..10 + name.len();
303 let display_range = 0..filter_range.end;
304 (text, filter_range, display_range)
305 }
306 lsp::SymbolKind::TYPE_PARAMETER => {
307 let text = format!("typename {} {{}};", name);
308 let filter_range = 9..9 + name.len();
309 let display_range = 0..filter_range.end;
310 (text, filter_range, display_range)
311 }
312 _ => return None,
313 };
314
315 Some(CodeLabel::new(
316 text[display_range.clone()].to_string(),
317 filter_range,
318 language.highlight_text(&text.as_str().into(), display_range),
319 ))
320 }
321
322 fn prepare_initialize_params(
323 &self,
324 mut original: InitializeParams,
325 _: &App,
326 ) -> Result<InitializeParams> {
327 let experimental = json!({
328 "textDocument": {
329 "completion" : {
330 // enable clangd's dot-to-arrow feature.
331 "editsNearCursor": true
332 },
333 "inactiveRegionsCapabilities": {
334 "inactiveRegions": true,
335 }
336 }
337 });
338 if let Some(ref mut original_experimental) = original.capabilities.experimental {
339 merge_json_value_into(experimental, original_experimental);
340 } else {
341 original.capabilities.experimental = Some(experimental);
342 }
343 Ok(original)
344 }
345
346 fn retain_old_diagnostic(&self, previous_diagnostic: &Diagnostic, _: &App) -> bool {
347 clangd_ext::is_inactive_region(previous_diagnostic)
348 }
349
350 fn underline_diagnostic(&self, diagnostic: &lsp::Diagnostic) -> bool {
351 !clangd_ext::is_lsp_inactive_region(diagnostic)
352 }
353}
354
355async fn get_cached_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
356 maybe!(async {
357 let mut last_clangd_dir = None;
358 let mut entries = fs::read_dir(&container_dir).await?;
359 while let Some(entry) = entries.next().await {
360 let entry = entry?;
361 if entry.file_type().await?.is_dir() {
362 last_clangd_dir = Some(entry.path());
363 }
364 }
365 let clangd_dir = last_clangd_dir.context("no cached binary")?;
366 let clangd_bin = clangd_dir.join("bin/clangd");
367 anyhow::ensure!(
368 clangd_bin.exists(),
369 "missing clangd binary in directory {clangd_dir:?}"
370 );
371 Ok(LanguageServerBinary {
372 path: clangd_bin,
373 env: None,
374 arguments: Vec::new(),
375 })
376 })
377 .await
378 .log_err()
379}
380
381#[cfg(test)]
382mod tests {
383 use gpui::{AppContext as _, BorrowAppContext, TestAppContext};
384 use language::{AutoindentMode, Buffer};
385 use settings::SettingsStore;
386 use std::num::NonZeroU32;
387
388 #[gpui::test]
389 async fn test_c_autoindent(cx: &mut TestAppContext) {
390 // cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
391 cx.update(|cx| {
392 let test_settings = SettingsStore::test(cx);
393 cx.set_global(test_settings);
394 language::init(cx);
395 cx.update_global::<SettingsStore, _>(|store, cx| {
396 store.update_user_settings(cx, |s| {
397 s.project.all_languages.defaults.tab_size = NonZeroU32::new(2);
398 });
399 });
400 });
401 let language = crate::language("c", tree_sitter_c::LANGUAGE.into());
402
403 cx.new(|cx| {
404 let mut buffer = Buffer::local("", cx).with_language(language, cx);
405
406 // empty function
407 buffer.edit([(0..0, "int main() {}")], None, cx);
408
409 // indent inside braces
410 let ix = buffer.len() - 1;
411 buffer.edit([(ix..ix, "\n\n")], Some(AutoindentMode::EachLine), cx);
412 assert_eq!(buffer.text(), "int main() {\n \n}");
413
414 // indent body of single-statement if statement
415 let ix = buffer.len() - 2;
416 buffer.edit([(ix..ix, "if (a)\nb;")], Some(AutoindentMode::EachLine), cx);
417 assert_eq!(buffer.text(), "int main() {\n if (a)\n b;\n}");
418
419 // indent inside field expression
420 let ix = buffer.len() - 3;
421 buffer.edit([(ix..ix, "\n.c")], Some(AutoindentMode::EachLine), cx);
422 assert_eq!(buffer.text(), "int main() {\n if (a)\n b\n .c;\n}");
423
424 buffer
425 });
426 }
427}