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