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