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::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 let filter_start = detail.len() + 1;
201 let filter_end =
202 if let Some(end) = text.rfind('(').filter(|end| *end > filter_start) {
203 end
204 } else {
205 text.len()
206 };
207
208 return Some(CodeLabel {
209 filter_range: filter_start..filter_end,
210 text,
211 runs,
212 });
213 }
214 Some(kind) => {
215 let highlight_name = match kind {
216 lsp::CompletionItemKind::STRUCT
217 | lsp::CompletionItemKind::INTERFACE
218 | lsp::CompletionItemKind::CLASS
219 | lsp::CompletionItemKind::ENUM => Some("type"),
220 lsp::CompletionItemKind::ENUM_MEMBER => Some("variant"),
221 lsp::CompletionItemKind::KEYWORD => Some("keyword"),
222 lsp::CompletionItemKind::VALUE | lsp::CompletionItemKind::CONSTANT => {
223 Some("constant")
224 }
225 _ => None,
226 };
227 if let Some(highlight_id) = language
228 .grammar()
229 .and_then(|g| g.highlight_id_for_name(highlight_name?))
230 {
231 let mut label = CodeLabel::plain(label.to_string(), None);
232 label.runs.push((
233 0..label.text.rfind('(').unwrap_or(label.text.len()),
234 highlight_id,
235 ));
236 return Some(label);
237 }
238 }
239 _ => {}
240 }
241 Some(CodeLabel::plain(label.to_string(), None))
242 }
243
244 async fn label_for_symbol(
245 &self,
246 name: &str,
247 kind: lsp::SymbolKind,
248 language: &Arc<Language>,
249 ) -> Option<CodeLabel> {
250 let (text, filter_range, display_range) = match kind {
251 lsp::SymbolKind::METHOD | lsp::SymbolKind::FUNCTION => {
252 let text = format!("void {} () {{}}", name);
253 let filter_range = 0..name.len();
254 let display_range = 5..5 + name.len();
255 (text, filter_range, display_range)
256 }
257 lsp::SymbolKind::STRUCT => {
258 let text = format!("struct {} {{}}", name);
259 let filter_range = 7..7 + name.len();
260 let display_range = 0..filter_range.end;
261 (text, filter_range, display_range)
262 }
263 lsp::SymbolKind::ENUM => {
264 let text = format!("enum {} {{}}", name);
265 let filter_range = 5..5 + name.len();
266 let display_range = 0..filter_range.end;
267 (text, filter_range, display_range)
268 }
269 lsp::SymbolKind::INTERFACE | lsp::SymbolKind::CLASS => {
270 let text = format!("class {} {{}}", name);
271 let filter_range = 6..6 + name.len();
272 let display_range = 0..filter_range.end;
273 (text, filter_range, display_range)
274 }
275 lsp::SymbolKind::CONSTANT => {
276 let text = format!("const int {} = 0;", name);
277 let filter_range = 10..10 + name.len();
278 let display_range = 0..filter_range.end;
279 (text, filter_range, display_range)
280 }
281 lsp::SymbolKind::MODULE => {
282 let text = format!("namespace {} {{}}", name);
283 let filter_range = 10..10 + name.len();
284 let display_range = 0..filter_range.end;
285 (text, filter_range, display_range)
286 }
287 lsp::SymbolKind::TYPE_PARAMETER => {
288 let text = format!("typename {} {{}};", name);
289 let filter_range = 9..9 + name.len();
290 let display_range = 0..filter_range.end;
291 (text, filter_range, display_range)
292 }
293 _ => return None,
294 };
295
296 Some(CodeLabel {
297 runs: language.highlight_text(&text.as_str().into(), display_range.clone()),
298 text: text[display_range].to_string(),
299 filter_range,
300 })
301 }
302}
303
304async fn get_cached_server_binary(container_dir: PathBuf) -> Option<LanguageServerBinary> {
305 maybe!(async {
306 let mut last_clangd_dir = None;
307 let mut entries = fs::read_dir(&container_dir).await?;
308 while let Some(entry) = entries.next().await {
309 let entry = entry?;
310 if entry.file_type().await?.is_dir() {
311 last_clangd_dir = Some(entry.path());
312 }
313 }
314 let clangd_dir = last_clangd_dir.ok_or_else(|| anyhow!("no cached binary"))?;
315 let clangd_bin = clangd_dir.join("bin/clangd");
316 if clangd_bin.exists() {
317 Ok(LanguageServerBinary {
318 path: clangd_bin,
319 env: None,
320 arguments: vec![],
321 })
322 } else {
323 Err(anyhow!(
324 "missing clangd binary in directory {:?}",
325 clangd_dir
326 ))
327 }
328 })
329 .await
330 .log_err()
331}
332
333#[cfg(test)]
334mod tests {
335 use gpui::{BorrowAppContext, Context, TestAppContext};
336 use language::{language_settings::AllLanguageSettings, AutoindentMode, Buffer};
337 use settings::SettingsStore;
338 use std::num::NonZeroU32;
339
340 #[gpui::test]
341 async fn test_c_autoindent(cx: &mut TestAppContext) {
342 // cx.executor().set_block_on_ticks(usize::MAX..=usize::MAX);
343 cx.update(|cx| {
344 let test_settings = SettingsStore::test(cx);
345 cx.set_global(test_settings);
346 language::init(cx);
347 cx.update_global::<SettingsStore, _>(|store, cx| {
348 store.update_user_settings::<AllLanguageSettings>(cx, |s| {
349 s.defaults.tab_size = NonZeroU32::new(2);
350 });
351 });
352 });
353 let language = crate::language("c", tree_sitter_c::language());
354
355 cx.new_model(|cx| {
356 let mut buffer = Buffer::local("", cx).with_language(language, cx);
357
358 // empty function
359 buffer.edit([(0..0, "int main() {}")], None, cx);
360
361 // indent inside braces
362 let ix = buffer.len() - 1;
363 buffer.edit([(ix..ix, "\n\n")], Some(AutoindentMode::EachLine), cx);
364 assert_eq!(buffer.text(), "int main() {\n \n}");
365
366 // indent body of single-statement if statement
367 let ix = buffer.len() - 2;
368 buffer.edit([(ix..ix, "if (a)\nb;")], Some(AutoindentMode::EachLine), cx);
369 assert_eq!(buffer.text(), "int main() {\n if (a)\n b;\n}");
370
371 // indent inside field expression
372 let ix = buffer.len() - 3;
373 buffer.edit([(ix..ix, "\n.c")], Some(AutoindentMode::EachLine), cx);
374 assert_eq!(buffer.text(), "int main() {\n if (a)\n b\n .c;\n}");
375
376 buffer
377 });
378 }
379}