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