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 if let Ok(Some(BinarySettings {
39 path: Some(path),
40 arguments,
41 })) = configured_binary
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 } else {
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 async fn fetch_latest_server_version(
64 &self,
65 delegate: &dyn LspAdapterDelegate,
66 ) -> Result<Box<dyn 'static + Send + Any>> {
67 let release =
68 latest_github_release("clangd/clangd", true, false, delegate.http_client()).await?;
69 let os_suffix = match consts::OS {
70 "macos" => "mac",
71 "linux" => "linux",
72 "windows" => "windows",
73 other => bail!("Running on unsupported os: {other}"),
74 };
75 let asset_name = format!("clangd-{}-{}.zip", os_suffix, release.tag_name);
76 let asset = release
77 .assets
78 .iter()
79 .find(|asset| asset.name == asset_name)
80 .ok_or_else(|| anyhow!("no asset found matching {:?}", asset_name))?;
81 let version = GitHubLspBinaryVersion {
82 name: release.tag_name,
83 url: asset.browser_download_url.clone(),
84 };
85 Ok(Box::new(version) as Box<_>)
86 }
87
88 async fn fetch_server_binary(
89 &self,
90 version: Box<dyn 'static + Send + Any>,
91 container_dir: PathBuf,
92 delegate: &dyn LspAdapterDelegate,
93 ) -> Result<LanguageServerBinary> {
94 let version = version.downcast::<GitHubLspBinaryVersion>().unwrap();
95 let zip_path = container_dir.join(format!("clangd_{}.zip", version.name));
96 let version_dir = container_dir.join(format!("clangd_{}", version.name));
97 let binary_path = version_dir.join("bin/clangd");
98
99 if fs::metadata(&binary_path).await.is_err() {
100 let mut response = delegate
101 .http_client()
102 .get(&version.url, Default::default(), true)
103 .await
104 .context("error downloading release")?;
105 let mut file = File::create(&zip_path).await?;
106 if !response.status().is_success() {
107 Err(anyhow!(
108 "download failed with status {}",
109 response.status().to_string()
110 ))?;
111 }
112 futures::io::copy(response.body_mut(), &mut file).await?;
113
114 let unzip_status = smol::process::Command::new("unzip")
115 .current_dir(&container_dir)
116 .arg(&zip_path)
117 .output()
118 .await?
119 .status;
120 if !unzip_status.success() {
121 Err(anyhow!("failed to unzip clangd archive"))?;
122 }
123
124 remove_matching(&container_dir, |entry| entry != version_dir).await;
125 }
126
127 Ok(LanguageServerBinary {
128 path: binary_path,
129 env: None,
130 arguments: vec![],
131 })
132 }
133
134 async fn cached_server_binary(
135 &self,
136 container_dir: PathBuf,
137 _: &dyn LspAdapterDelegate,
138 ) -> Option<LanguageServerBinary> {
139 get_cached_server_binary(container_dir).await
140 }
141
142 async fn installation_test_binary(
143 &self,
144 container_dir: PathBuf,
145 ) -> Option<LanguageServerBinary> {
146 get_cached_server_binary(container_dir)
147 .await
148 .map(|mut binary| {
149 binary.arguments = vec!["--help".into()];
150 binary
151 })
152 }
153
154 async fn label_for_completion(
155 &self,
156 completion: &lsp::CompletionItem,
157 language: &Arc<Language>,
158 ) -> Option<CodeLabel> {
159 let label = completion
160 .label
161 .strip_prefix('•')
162 .unwrap_or(&completion.label)
163 .trim();
164
165 match completion.kind {
166 Some(lsp::CompletionItemKind::FIELD) if completion.detail.is_some() => {
167 let detail = completion.detail.as_ref().unwrap();
168 let text = format!("{} {}", detail, label);
169 let source = Rope::from(format!("struct S {{ {} }}", text).as_str());
170 let runs = language.highlight_text(&source, 11..11 + text.len());
171 return Some(CodeLabel {
172 filter_range: detail.len() + 1..text.len(),
173 text,
174 runs,
175 });
176 }
177 Some(lsp::CompletionItemKind::CONSTANT | lsp::CompletionItemKind::VARIABLE)
178 if completion.detail.is_some() =>
179 {
180 let detail = completion.detail.as_ref().unwrap();
181 let text = format!("{} {}", detail, label);
182 let runs = language.highlight_text(&Rope::from(text.as_str()), 0..text.len());
183 return Some(CodeLabel {
184 filter_range: detail.len() + 1..text.len(),
185 text,
186 runs,
187 });
188 }
189 Some(lsp::CompletionItemKind::FUNCTION | lsp::CompletionItemKind::METHOD)
190 if completion.detail.is_some() =>
191 {
192 let detail = completion.detail.as_ref().unwrap();
193 let text = format!("{} {}", detail, label);
194 let runs = language.highlight_text(&Rope::from(text.as_str()), 0..text.len());
195 return Some(CodeLabel {
196 filter_range: detail.len() + 1..text.rfind('(').unwrap_or(text.len()),
197 text,
198 runs,
199 });
200 }
201 Some(kind) => {
202 let highlight_name = match kind {
203 lsp::CompletionItemKind::STRUCT
204 | lsp::CompletionItemKind::INTERFACE
205 | lsp::CompletionItemKind::CLASS
206 | lsp::CompletionItemKind::ENUM => Some("type"),
207 lsp::CompletionItemKind::ENUM_MEMBER => Some("variant"),
208 lsp::CompletionItemKind::KEYWORD => Some("keyword"),
209 lsp::CompletionItemKind::VALUE | lsp::CompletionItemKind::CONSTANT => {
210 Some("constant")
211 }
212 _ => None,
213 };
214 if let Some(highlight_id) = language
215 .grammar()
216 .and_then(|g| g.highlight_id_for_name(highlight_name?))
217 {
218 let mut label = CodeLabel::plain(label.to_string(), None);
219 label.runs.push((
220 0..label.text.rfind('(').unwrap_or(label.text.len()),
221 highlight_id,
222 ));
223 return Some(label);
224 }
225 }
226 _ => {}
227 }
228 Some(CodeLabel::plain(label.to_string(), None))
229 }
230
231 async fn label_for_symbol(
232 &self,
233 name: &str,
234 kind: lsp::SymbolKind,
235 language: &Arc<Language>,
236 ) -> Option<CodeLabel> {
237 let (text, filter_range, display_range) = match kind {
238 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
239 let text = format!("void {} () {{}}", name);
240 let filter_range = 0..name.len();
241 let display_range = 5..5 + name.len();
242 (text, filter_range, display_range)
243 }
244 lsp::SymbolKind::STRUCT => {
245 let text = format!("struct {} {{}}", name);
246 let filter_range = 7..7 + name.len();
247 let display_range = 0..filter_range.end;
248 (text, filter_range, display_range)
249 }
250 lsp::SymbolKind::ENUM => {
251 let text = format!("enum {} {{}}", name);
252 let filter_range = 5..5 + name.len();
253 let display_range = 0..filter_range.end;
254 (text, filter_range, display_range)
255 }
256 lsp::SymbolKind::INTERFACE | lsp::SymbolKind::CLASS => {
257 let text = format!("class {} {{}}", name);
258 let filter_range = 6..6 + name.len();
259 let display_range = 0..filter_range.end;
260 (text, filter_range, display_range)
261 }
262 lsp::SymbolKind::CONSTANT => {
263 let text = format!("const int {} = 0;", name);
264 let filter_range = 10..10 + name.len();
265 let display_range = 0..filter_range.end;
266 (text, filter_range, display_range)
267 }
268 lsp::SymbolKind::MODULE => {
269 let text = format!("namespace {} {{}}", name);
270 let filter_range = 10..10 + name.len();
271 let display_range = 0..filter_range.end;
272 (text, filter_range, display_range)
273 }
274 lsp::SymbolKind::TYPE_PARAMETER => {
275 let text = format!("typename {} {{}};", name);
276 let filter_range = 9..9 + name.len();
277 let display_range = 0..filter_range.end;
278 (text, filter_range, display_range)
279 }
280 _ => return None,
281 };
282
283 Some(CodeLabel {
284 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
285 text: text[display_range].to_string(),
286 filter_range,
287 })
288 }
289}
290
291async fn get_cached_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
292 maybe!(async {
293 let mut last_clangd_dir = None;
294 let mut entries = fs::read_dir(&container_dir).await?;
295 while let Some(entry) = entries.next().await {
296 let entry = entry?;
297 if entry.file_type().await?.is_dir() {
298 last_clangd_dir = Some(entry.path());
299 }
300 }
301 let clangd_dir = last_clangd_dir.ok_or_else(|| anyhow!("no cached binary"))?;
302 let clangd_bin = clangd_dir.join("bin/clangd");
303 if clangd_bin.exists() {
304 Ok(LanguageServerBinary {
305 path: clangd_bin,
306 env: None,
307 arguments: vec![],
308 })
309 } else {
310 Err(anyhow!(
311 "missing clangd binary in directory {:?}",
312 clangd_dir
313 ))
314 }
315 })
316 .await
317 .log_err()
318}
319
320#[cfg(test)]
321mod tests {
322 use gpui::{BorrowAppContext, Context, TestAppContext};
323 use language::{language_settings::AllLanguageSettings, AutoindentMode, Buffer};
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());
341
342 cx.new_model(|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}