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