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