1mod buffer;
2mod diagnostic_set;
3mod highlight_map;
4mod outline;
5pub mod proto;
6#[cfg(test)]
7mod tests;
8
9use anyhow::{anyhow, Context, Result};
10use client::http::{self, HttpClient};
11use collections::HashSet;
12use futures::{
13 future::{BoxFuture, Shared},
14 FutureExt, TryFutureExt,
15};
16use gpui::{MutableAppContext, Task};
17use highlight_map::HighlightMap;
18use lazy_static::lazy_static;
19use parking_lot::{Mutex, RwLock};
20use serde::Deserialize;
21use serde_json::Value;
22use std::{
23 cell::RefCell,
24 ops::Range,
25 path::{Path, PathBuf},
26 str,
27 sync::Arc,
28};
29use theme::SyntaxTheme;
30use tree_sitter::{self, Query};
31use util::ResultExt;
32
33#[cfg(any(test, feature = "test-support"))]
34use futures::channel::mpsc;
35
36pub use buffer::Operation;
37pub use buffer::*;
38pub use diagnostic_set::DiagnosticEntry;
39pub use outline::{Outline, OutlineItem};
40pub use tree_sitter::{Parser, Tree};
41
42thread_local! {
43 static PARSER: RefCell<Parser> = RefCell::new(Parser::new());
44}
45
46lazy_static! {
47 pub static ref PLAIN_TEXT: Arc<Language> = Arc::new(Language::new(
48 LanguageConfig {
49 name: "Plain Text".into(),
50 path_suffixes: Default::default(),
51 brackets: Default::default(),
52 autoclose_before: Default::default(),
53 line_comment: None,
54 language_server: Default::default(),
55 },
56 None,
57 ));
58}
59
60pub trait ToLspPosition {
61 fn to_lsp_position(self) -> lsp::Position;
62}
63
64pub struct LspBinaryVersion {
65 pub name: String,
66 pub url: Option<http::Url>,
67}
68
69pub trait LspAdapter: 'static + Send + Sync {
70 fn name(&self) -> &'static str;
71 fn fetch_latest_server_version(
72 &self,
73 http: Arc<dyn HttpClient>,
74 ) -> BoxFuture<'static, Result<LspBinaryVersion>>;
75 fn fetch_server_binary(
76 &self,
77 version: LspBinaryVersion,
78 http: Arc<dyn HttpClient>,
79 container_dir: PathBuf,
80 ) -> BoxFuture<'static, Result<PathBuf>>;
81 fn cached_server_binary(&self, container_dir: PathBuf) -> BoxFuture<'static, Option<PathBuf>>;
82 fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams);
83
84 fn label_for_completion(&self, _: &lsp::CompletionItem, _: &Language) -> Option<CodeLabel> {
85 None
86 }
87
88 fn label_for_symbol(&self, _: &str, _: lsp::SymbolKind, _: &Language) -> Option<CodeLabel> {
89 None
90 }
91
92 fn server_args(&self) -> &[&str] {
93 &[]
94 }
95
96 fn initialization_options(&self) -> Option<Value> {
97 None
98 }
99}
100
101#[derive(Clone, Debug, PartialEq, Eq)]
102pub struct CodeLabel {
103 pub text: String,
104 pub runs: Vec<(Range<usize>, HighlightId)>,
105 pub filter_range: Range<usize>,
106}
107
108#[derive(Deserialize)]
109pub struct LanguageConfig {
110 pub name: Arc<str>,
111 pub path_suffixes: Vec<String>,
112 pub brackets: Vec<BracketPair>,
113 #[serde(default)]
114 pub autoclose_before: String,
115 pub line_comment: Option<String>,
116 #[serde(default)]
117 pub language_server: LanguageServerConfig,
118}
119
120impl Default for LanguageConfig {
121 fn default() -> Self {
122 Self {
123 name: "".into(),
124 path_suffixes: Default::default(),
125 brackets: Default::default(),
126 autoclose_before: Default::default(),
127 line_comment: Default::default(),
128 language_server: Default::default(),
129 }
130 }
131}
132
133#[derive(Default, Deserialize)]
134pub struct LanguageServerConfig {
135 pub disk_based_diagnostic_sources: HashSet<String>,
136 pub disk_based_diagnostics_progress_token: Option<String>,
137 #[cfg(any(test, feature = "test-support"))]
138 #[serde(skip)]
139 fake_config: Option<FakeLanguageServerConfig>,
140}
141
142#[cfg(any(test, feature = "test-support"))]
143struct FakeLanguageServerConfig {
144 servers_tx: mpsc::UnboundedSender<lsp::FakeLanguageServer>,
145 capabilities: lsp::ServerCapabilities,
146 initializer: Option<Box<dyn 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer)>>,
147}
148
149#[derive(Clone, Debug, Deserialize)]
150pub struct BracketPair {
151 pub start: String,
152 pub end: String,
153 pub close: bool,
154 pub newline: bool,
155}
156
157pub struct Language {
158 pub(crate) config: LanguageConfig,
159 pub(crate) grammar: Option<Arc<Grammar>>,
160 pub(crate) adapter: Option<Arc<dyn LspAdapter>>,
161 lsp_binary_path: Mutex<Option<Shared<BoxFuture<'static, Result<PathBuf, Arc<anyhow::Error>>>>>>,
162}
163
164pub struct Grammar {
165 pub(crate) ts_language: tree_sitter::Language,
166 pub(crate) highlights_query: Query,
167 pub(crate) brackets_query: Query,
168 pub(crate) indents_query: Query,
169 pub(crate) outline_query: Query,
170 pub(crate) highlight_map: Mutex<HighlightMap>,
171}
172
173#[derive(Clone)]
174pub enum LanguageServerBinaryStatus {
175 CheckingForUpdate,
176 Downloading,
177 Downloaded,
178 Cached,
179 Failed,
180}
181
182pub struct LanguageRegistry {
183 languages: RwLock<Vec<Arc<Language>>>,
184 language_server_download_dir: Option<Arc<Path>>,
185 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
186 lsp_binary_statuses_rx: async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)>,
187 login_shell_env_loaded: Shared<Task<()>>,
188}
189
190impl LanguageRegistry {
191 pub fn new(login_shell_env_loaded: Task<()>) -> Self {
192 let (lsp_binary_statuses_tx, lsp_binary_statuses_rx) = async_broadcast::broadcast(16);
193 Self {
194 language_server_download_dir: None,
195 languages: Default::default(),
196 lsp_binary_statuses_tx,
197 lsp_binary_statuses_rx,
198 login_shell_env_loaded: login_shell_env_loaded.shared(),
199 }
200 }
201
202 #[cfg(any(test, feature = "test-support"))]
203 pub fn test() -> Self {
204 Self::new(Task::ready(()))
205 }
206
207 pub fn add(&self, language: Arc<Language>) {
208 self.languages.write().push(language.clone());
209 }
210
211 pub fn set_theme(&self, theme: &SyntaxTheme) {
212 for language in self.languages.read().iter() {
213 language.set_theme(theme);
214 }
215 }
216
217 pub fn set_language_server_download_dir(&mut self, path: impl Into<Arc<Path>>) {
218 self.language_server_download_dir = Some(path.into());
219 }
220
221 pub fn get_language(&self, name: &str) -> Option<Arc<Language>> {
222 self.languages
223 .read()
224 .iter()
225 .find(|language| language.name().as_ref() == name)
226 .cloned()
227 }
228
229 pub fn select_language(&self, path: impl AsRef<Path>) -> Option<Arc<Language>> {
230 let path = path.as_ref();
231 let filename = path.file_name().and_then(|name| name.to_str());
232 let extension = path.extension().and_then(|name| name.to_str());
233 let path_suffixes = [extension, filename];
234 self.languages
235 .read()
236 .iter()
237 .find(|language| {
238 language
239 .config
240 .path_suffixes
241 .iter()
242 .any(|suffix| path_suffixes.contains(&Some(suffix.as_str())))
243 })
244 .cloned()
245 }
246
247 pub fn start_language_server(
248 &self,
249 language: Arc<Language>,
250 root_path: Arc<Path>,
251 http_client: Arc<dyn HttpClient>,
252 cx: &mut MutableAppContext,
253 ) -> Option<Task<Result<lsp::LanguageServer>>> {
254 #[cfg(any(test, feature = "test-support"))]
255 if language.config.language_server.fake_config.is_some() {
256 let language = language.clone();
257 return Some(cx.spawn(|mut cx| async move {
258 let fake_config = language
259 .config
260 .language_server
261 .fake_config
262 .as_ref()
263 .unwrap();
264 let (server, mut fake_server) = cx.update(|cx| {
265 lsp::LanguageServer::fake_with_capabilities(
266 fake_config.capabilities.clone(),
267 cx,
268 )
269 });
270 if let Some(initializer) = &fake_config.initializer {
271 initializer(&mut fake_server);
272 }
273
274 let servers_tx = fake_config.servers_tx.clone();
275 cx.background()
276 .spawn(async move {
277 fake_server
278 .receive_notification::<lsp::notification::Initialized>()
279 .await;
280 servers_tx.unbounded_send(fake_server).ok();
281 })
282 .detach();
283 Ok(server)
284 }));
285 }
286
287 let download_dir = self
288 .language_server_download_dir
289 .clone()
290 .ok_or_else(|| anyhow!("language server download directory has not been assigned"))
291 .log_err()?;
292
293 let adapter = language.adapter.clone()?;
294 let background = cx.background().clone();
295 let lsp_binary_statuses = self.lsp_binary_statuses_tx.clone();
296 let login_shell_env_loaded = self.login_shell_env_loaded.clone();
297 Some(cx.background().spawn(async move {
298 login_shell_env_loaded.await;
299 let server_binary_path = language
300 .lsp_binary_path
301 .lock()
302 .get_or_insert_with(|| {
303 get_server_binary_path(
304 adapter.clone(),
305 language.clone(),
306 http_client,
307 download_dir,
308 lsp_binary_statuses,
309 )
310 .map_err(Arc::new)
311 .boxed()
312 .shared()
313 })
314 .clone()
315 .map_err(|e| anyhow!(e));
316
317 let server_binary_path = server_binary_path.await?;
318 let server_args = adapter.server_args();
319 let server = lsp::LanguageServer::new(
320 &server_binary_path,
321 server_args,
322 &root_path,
323 adapter.initialization_options(),
324 background,
325 )?;
326 Ok(server)
327 }))
328 }
329
330 pub fn language_server_binary_statuses(
331 &self,
332 ) -> async_broadcast::Receiver<(Arc<Language>, LanguageServerBinaryStatus)> {
333 self.lsp_binary_statuses_rx.clone()
334 }
335}
336
337async fn get_server_binary_path(
338 adapter: Arc<dyn LspAdapter>,
339 language: Arc<Language>,
340 http_client: Arc<dyn HttpClient>,
341 download_dir: Arc<Path>,
342 statuses: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
343) -> Result<PathBuf> {
344 let container_dir = download_dir.join(adapter.name());
345 if !container_dir.exists() {
346 smol::fs::create_dir_all(&container_dir)
347 .await
348 .context("failed to create container directory")?;
349 }
350
351 let path = fetch_latest_server_binary_path(
352 adapter.clone(),
353 language.clone(),
354 http_client,
355 &container_dir,
356 statuses.clone(),
357 )
358 .await;
359 if path.is_err() {
360 if let Some(cached_path) = adapter.cached_server_binary(container_dir).await {
361 statuses
362 .broadcast((language.clone(), LanguageServerBinaryStatus::Cached))
363 .await?;
364 return Ok(cached_path);
365 } else {
366 statuses
367 .broadcast((language.clone(), LanguageServerBinaryStatus::Failed))
368 .await?;
369 }
370 }
371 path
372}
373
374async fn fetch_latest_server_binary_path(
375 adapter: Arc<dyn LspAdapter>,
376 language: Arc<Language>,
377 http_client: Arc<dyn HttpClient>,
378 container_dir: &Path,
379 lsp_binary_statuses_tx: async_broadcast::Sender<(Arc<Language>, LanguageServerBinaryStatus)>,
380) -> Result<PathBuf> {
381 lsp_binary_statuses_tx
382 .broadcast((
383 language.clone(),
384 LanguageServerBinaryStatus::CheckingForUpdate,
385 ))
386 .await?;
387 let version_info = adapter
388 .fetch_latest_server_version(http_client.clone())
389 .await?;
390 lsp_binary_statuses_tx
391 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloading))
392 .await?;
393 let path = adapter
394 .fetch_server_binary(version_info, http_client, container_dir.to_path_buf())
395 .await?;
396 lsp_binary_statuses_tx
397 .broadcast((language.clone(), LanguageServerBinaryStatus::Downloaded))
398 .await?;
399 Ok(path)
400}
401
402impl Language {
403 pub fn new(config: LanguageConfig, ts_language: Option<tree_sitter::Language>) -> Self {
404 Self {
405 config,
406 grammar: ts_language.map(|ts_language| {
407 Arc::new(Grammar {
408 brackets_query: Query::new(ts_language, "").unwrap(),
409 highlights_query: Query::new(ts_language, "").unwrap(),
410 indents_query: Query::new(ts_language, "").unwrap(),
411 outline_query: Query::new(ts_language, "").unwrap(),
412 ts_language,
413 highlight_map: Default::default(),
414 })
415 }),
416 adapter: None,
417 lsp_binary_path: Default::default(),
418 }
419 }
420
421 pub fn with_highlights_query(mut self, source: &str) -> Result<Self> {
422 let grammar = self
423 .grammar
424 .as_mut()
425 .and_then(Arc::get_mut)
426 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
427 grammar.highlights_query = Query::new(grammar.ts_language, source)?;
428 Ok(self)
429 }
430
431 pub fn with_brackets_query(mut self, source: &str) -> Result<Self> {
432 let grammar = self
433 .grammar
434 .as_mut()
435 .and_then(Arc::get_mut)
436 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
437 grammar.brackets_query = Query::new(grammar.ts_language, source)?;
438 Ok(self)
439 }
440
441 pub fn with_indents_query(mut self, source: &str) -> Result<Self> {
442 let grammar = self
443 .grammar
444 .as_mut()
445 .and_then(Arc::get_mut)
446 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
447 grammar.indents_query = Query::new(grammar.ts_language, source)?;
448 Ok(self)
449 }
450
451 pub fn with_outline_query(mut self, source: &str) -> Result<Self> {
452 let grammar = self
453 .grammar
454 .as_mut()
455 .and_then(Arc::get_mut)
456 .ok_or_else(|| anyhow!("grammar does not exist or is already being used"))?;
457 grammar.outline_query = Query::new(grammar.ts_language, source)?;
458 Ok(self)
459 }
460
461 pub fn with_lsp_adapter(mut self, lsp_adapter: Arc<dyn LspAdapter>) -> Self {
462 self.adapter = Some(lsp_adapter);
463 self
464 }
465
466 pub fn name(&self) -> Arc<str> {
467 self.config.name.clone()
468 }
469
470 pub fn line_comment_prefix(&self) -> Option<&str> {
471 self.config.line_comment.as_deref()
472 }
473
474 pub fn disk_based_diagnostic_sources(&self) -> &HashSet<String> {
475 &self.config.language_server.disk_based_diagnostic_sources
476 }
477
478 pub fn disk_based_diagnostics_progress_token(&self) -> Option<&String> {
479 self.config
480 .language_server
481 .disk_based_diagnostics_progress_token
482 .as_ref()
483 }
484
485 pub fn process_diagnostics(&self, diagnostics: &mut lsp::PublishDiagnosticsParams) {
486 if let Some(processor) = self.adapter.as_ref() {
487 processor.process_diagnostics(diagnostics);
488 }
489 }
490
491 pub fn label_for_completion(&self, completion: &lsp::CompletionItem) -> Option<CodeLabel> {
492 self.adapter
493 .as_ref()?
494 .label_for_completion(completion, self)
495 }
496
497 pub fn label_for_symbol(&self, name: &str, kind: lsp::SymbolKind) -> Option<CodeLabel> {
498 self.adapter.as_ref()?.label_for_symbol(name, kind, self)
499 }
500
501 pub fn highlight_text<'a>(
502 &'a self,
503 text: &'a Rope,
504 range: Range<usize>,
505 ) -> Vec<(Range<usize>, HighlightId)> {
506 let mut result = Vec::new();
507 if let Some(grammar) = &self.grammar {
508 let tree = grammar.parse_text(text, None);
509 let mut offset = 0;
510 for chunk in BufferChunks::new(text, range, Some(&tree), self.grammar.as_ref(), vec![])
511 {
512 let end_offset = offset + chunk.text.len();
513 if let Some(highlight_id) = chunk.syntax_highlight_id {
514 result.push((offset..end_offset, highlight_id));
515 }
516 offset = end_offset;
517 }
518 }
519 result
520 }
521
522 pub fn brackets(&self) -> &[BracketPair] {
523 &self.config.brackets
524 }
525
526 pub fn should_autoclose_before(&self, c: char) -> bool {
527 c.is_whitespace() || self.config.autoclose_before.contains(c)
528 }
529
530 pub fn set_theme(&self, theme: &SyntaxTheme) {
531 if let Some(grammar) = self.grammar.as_ref() {
532 *grammar.highlight_map.lock() =
533 HighlightMap::new(grammar.highlights_query.capture_names(), theme);
534 }
535 }
536
537 pub fn grammar(&self) -> Option<&Arc<Grammar>> {
538 self.grammar.as_ref()
539 }
540}
541
542impl Grammar {
543 fn parse_text(&self, text: &Rope, old_tree: Option<Tree>) -> Tree {
544 PARSER.with(|parser| {
545 let mut parser = parser.borrow_mut();
546 parser
547 .set_language(self.ts_language)
548 .expect("incompatible grammar");
549 let mut chunks = text.chunks_in_range(0..text.len());
550 parser
551 .parse_with(
552 &mut move |offset, _| {
553 chunks.seek(offset);
554 chunks.next().unwrap_or("").as_bytes()
555 },
556 old_tree.as_ref(),
557 )
558 .unwrap()
559 })
560 }
561
562 pub fn highlight_map(&self) -> HighlightMap {
563 self.highlight_map.lock().clone()
564 }
565
566 pub fn highlight_id_for_name(&self, name: &str) -> Option<HighlightId> {
567 let capture_id = self.highlights_query.capture_index_for_name(name)?;
568 Some(self.highlight_map.lock().get(capture_id))
569 }
570}
571
572impl CodeLabel {
573 pub fn plain(text: String, filter_text: Option<&str>) -> Self {
574 let mut result = Self {
575 runs: Vec::new(),
576 filter_range: 0..text.len(),
577 text,
578 };
579 if let Some(filter_text) = filter_text {
580 if let Some(ix) = result.text.find(filter_text) {
581 result.filter_range = ix..ix + filter_text.len();
582 }
583 }
584 result
585 }
586}
587
588#[cfg(any(test, feature = "test-support"))]
589impl LanguageServerConfig {
590 pub fn fake() -> (Self, mpsc::UnboundedReceiver<lsp::FakeLanguageServer>) {
591 let (servers_tx, servers_rx) = mpsc::unbounded();
592 (
593 Self {
594 fake_config: Some(FakeLanguageServerConfig {
595 servers_tx,
596 capabilities: lsp::LanguageServer::full_capabilities(),
597 initializer: None,
598 }),
599 disk_based_diagnostics_progress_token: Some("fakeServer/check".to_string()),
600 ..Default::default()
601 },
602 servers_rx,
603 )
604 }
605
606 pub fn set_fake_capabilities(&mut self, capabilities: lsp::ServerCapabilities) {
607 self.fake_config.as_mut().unwrap().capabilities = capabilities;
608 }
609
610 pub fn set_fake_initializer(
611 &mut self,
612 initializer: impl 'static + Send + Sync + Fn(&mut lsp::FakeLanguageServer),
613 ) {
614 self.fake_config.as_mut().unwrap().initializer = Some(Box::new(initializer));
615 }
616}
617
618impl ToLspPosition for PointUtf16 {
619 fn to_lsp_position(self) -> lsp::Position {
620 lsp::Position::new(self.row, self.column)
621 }
622}
623
624pub fn point_from_lsp(point: lsp::Position) -> PointUtf16 {
625 PointUtf16::new(point.line, point.character)
626}
627
628pub fn range_from_lsp(range: lsp::Range) -> Range<PointUtf16> {
629 let start = PointUtf16::new(range.start.line, range.start.character);
630 let end = PointUtf16::new(range.end.line, range.end.character);
631 start..end
632}