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