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