Use markup scopes for the Markdown component (#1363)

book/src/themes.md

@@ -190,6 +190,18 @@ We use a similar set of scopes as
 
 These scopes are used for theming the editor interface.
 
+- `markup`
+  - `normal`
+    - `completion` - for completion doc popup ui
+    - `hover` - for hover popup ui
+  - `heading`
+    - `completion` - for completion doc popup ui
+    - `hover` - for hover popup ui
+  - `raw`
+    - `inline`
+      - `completion` - for completion doc popup ui
+      - `hover` - for hover popup ui
+
 
 | Key                      | Notes                               |
 | ---                      | ---                                 |

helix-term/src/commands.rs

@@ -5455,7 +5455,8 @@ fn hover(cx: &mut Context) {
 
                 // skip if contents empty
 
-                let contents = ui::Markdown::new(contents, editor.syn_loader.clone());
+                let contents =
+                    ui::Markdown::new(contents, editor.syn_loader.clone()).style_group("hover");
                 let popup = Popup::new("hover", contents);
                 if let Some(doc_popup) = compositor.find_id("hover") {
                     *doc_popup = popup;

helix-term/src/ui/completion.rs

@@ -304,6 +304,9 @@ impl Component for Completion {
             let cursor_pos = doc.selection(view.id).primary().cursor(text);
             let coords = helix_core::visual_coords_at_pos(text, cursor_pos, doc.tab_width());
             let cursor_pos = (coords.row - view.offset.row) as u16;
+
+            let markdown_ui =
+                |content, syn_loader| Markdown::new(content, syn_loader).style_group("completion");
             let mut markdown_doc = match &option.documentation {
                 Some(lsp::Documentation::String(contents))
                 | Some(lsp::Documentation::MarkupContent(lsp::MarkupContent {
@@ -311,7 +314,7 @@ impl Component for Completion {
                     value: contents,
                 })) => {
                     // TODO: convert to wrapped text
-                    Markdown::new(
+                    markdown_ui(
                         format!(
                             "```{}\n{}\n```\n{}",
                             language,
@@ -326,7 +329,7 @@ impl Component for Completion {
                     value: contents,
                 })) => {
                     // TODO: set language based on doc scope
-                    Markdown::new(
+                    markdown_ui(
                         format!(
                             "```{}\n{}\n```\n{}",
                             language,
@@ -340,7 +343,7 @@ impl Component for Completion {
                     // TODO: copied from above
 
                     // TODO: set language based on doc scope
-                    Markdown::new(
+                    markdown_ui(
                         format!(
                             "```{}\n{}\n```",
                             language,

helix-term/src/ui/markdown.rs

@@ -21,6 +21,10 @@ pub struct Markdown {
     contents: String,
 
     config_loader: Arc<syntax::Loader>,
+
+    text_style: String,
+    block_style: String,
+    heading_style: String,
 }
 
 // TODO: pre-render and self reference via Pin
@@ -31,21 +35,26 @@ impl Markdown {
         Self {
             contents,
             config_loader,
-        }
+            text_style: "markup.normal".into(),
+            block_style: "markup.raw.inline".into(),
+            heading_style: "markup.heading".into(),
         }
     }
 
-fn parse<'a>(
+    pub fn style_group(mut self, suffix: &str) -> Self {
-    contents: &'a str,
+        self.text_style = format!("markup.normal.{}", suffix);
-    theme: Option<&Theme>,
+        self.block_style = format!("markup.raw.inline.{}", suffix);
-    loader: Arc<syntax::Loader>,
+        self.heading_style = format!("markup.heading.{}", suffix);
-) -> tui::text::Text<'a> {
+        self
+    }
+
+    fn parse(&self, theme: Option<&Theme>) -> tui::text::Text<'_> {
         // // also 2021-03-04T16:33:58.553 helix_lsp::transport [INFO] <- {"contents":{"kind":"markdown","value":"\n```rust\ncore::num\n```\n\n```rust\npub const fn saturating_sub(self, rhs:Self) ->Self\n```\n\n---\n\n```rust\n```"},"range":{"end":{"character":61,"line":101},"start":{"character":47,"line":101}}}
         // let text = "\n```rust\ncore::iter::traits::iterator::Iterator\n```\n\n```rust\nfn collect<B: FromIterator<Self::Item>>(self) -> B\nwhere\n        Self: Sized,\n```\n\n---\n\nTransforms an iterator into a collection.\n\n`collect()` can take anything iterable, and turn it into a relevant\ncollection. This is one of the more powerful methods in the standard\nlibrary, used in a variety of contexts.\n\nThe most basic pattern in which `collect()` is used is to turn one\ncollection into another. You take a collection, call [`iter`](https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html) on it,\ndo a bunch of transformations, and then `collect()` at the end.\n\n`collect()` can also create instances of types that are not typical\ncollections. For example, a [`String`](https://doc.rust-lang.org/nightly/core/iter/std/string/struct.String.html) can be built from [`char`](type@char)s,\nand an iterator of [`Result<T, E>`](https://doc.rust-lang.org/nightly/core/result/enum.Result.html) items can be collected\ninto `Result<Collection<T>, E>`. See the examples below for more.\n\nBecause `collect()` is so general, it can cause problems with type\ninference. As such, `collect()` is one of the few times you'll see\nthe syntax affectionately known as the 'turbofish': `::<>`. This\nhelps the inference algorithm understand specifically which collection\nyou're trying to collect into.\n\n# Examples\n\nBasic usage:\n\n```rust\nlet a = [1, 2, 3];\n\nlet doubled: Vec<i32> = a.iter()\n                         .map(|&x| x * 2)\n                         .collect();\n\nassert_eq!(vec![2, 4, 6], doubled);\n```\n\nNote that we needed the `: Vec<i32>` on the left-hand side. This is because\nwe could collect into, for example, a [`VecDeque<T>`](https://doc.rust-lang.org/nightly/core/iter/std/collections/struct.VecDeque.html) instead:\n\n```rust\nuse std::collections::VecDeque;\n\nlet a = [1, 2, 3];\n\nlet doubled: VecDeque<i32> = a.iter().map(|&x| x * 2).collect();\n\nassert_eq!(2, doubled[0]);\nassert_eq!(4, doubled[1]);\nassert_eq!(6, doubled[2]);\n```\n\nUsing the 'turbofish' instead of annotating `doubled`:\n\n```rust\nlet a = [1, 2, 3];\n\nlet doubled = a.iter().map(|x| x * 2).collect::<Vec<i32>>();\n\nassert_eq!(vec![2, 4, 6], doubled);\n```\n\nBecause `collect()` only cares about what you're collecting into, you can\nstill use a partial type hint, `_`, with the turbofish:\n\n```rust\nlet a = [1, 2, 3];\n\nlet doubled = a.iter().map(|x| x * 2).collect::<Vec<_>>();\n\nassert_eq!(vec![2, 4, 6], doubled);\n```\n\nUsing `collect()` to make a [`String`](https://doc.rust-lang.org/nightly/core/iter/std/string/struct.String.html):\n\n```rust\nlet chars = ['g', 'd', 'k', 'k', 'n'];\n\nlet hello: String = chars.iter()\n    .map(|&x| x as u8)\n    .map(|x| (x + 1) as char)\n    .collect();\n\nassert_eq!(\"hello\", hello);\n```\n\nIf you have a list of [`Result<T, E>`](https://doc.rust-lang.org/nightly/core/result/enum.Result.html)s, you can use `collect()` to\nsee if any of them failed:\n\n```rust\nlet results = [Ok(1), Err(\"nope\"), Ok(3), Err(\"bad\")];\n\nlet result: Result<Vec<_>, &str> = results.iter().cloned().collect();\n\n// gives us the first error\nassert_eq!(Err(\"nope\"), result);\n\nlet results = [Ok(1), Ok(3)];\n\nlet result: Result<Vec<_>, &str> = results.iter().cloned().collect();\n\n// gives us the list of answers\nassert_eq!(Ok(vec![1, 3]), result);\n```";
 
         let mut options = Options::empty();
         options.insert(Options::ENABLE_STRIKETHROUGH);
-    let parser = Parser::new_ext(contents, options);
+        let parser = Parser::new_ext(&self.contents, options);
 
         // TODO: if possible, render links as terminal hyperlinks: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
         let mut tags = Vec::new();
@@ -61,15 +70,17 @@ fn parse<'a>(
             })
         }
 
-    let text_style = theme.map(|theme| theme.get("ui.text")).unwrap_or_default();
+        macro_rules! get_theme {
-
+            ($s1: expr) => {
-    // TODO: use better scopes for these, `markup.raw.block`, `markup.heading`
+                theme
-    let code_style = theme
+                    .map(|theme| theme.try_get($s1.as_str()))
-        .map(|theme| theme.get("ui.text.focus"))
+                    .flatten()
-        .unwrap_or_default(); // white
+                    .unwrap_or_default()
-    let heading_style = theme
+            };
-        .map(|theme| theme.get("ui.linenr.selected"))
+        }
-        .unwrap_or_default(); // lilac
+        let text_style = get_theme!(self.text_style);
+        let code_style = get_theme!(self.block_style);
+        let heading_style = get_theme!(self.heading_style);
 
         for event in parser {
             match event {
@@ -95,10 +106,13 @@ fn parse<'a>(
                     if let Some(Tag::CodeBlock(CodeBlockKind::Fenced(language))) = tags.last() {
                         if let Some(theme) = theme {
                             let rope = Rope::from(text.as_ref());
-                        let syntax = loader
+                            let syntax = self
+                                .config_loader
                                 .language_configuration_for_injection_string(language)
                                 .and_then(|config| config.highlight_config(theme.scopes()))
-                            .map(|config| Syntax::new(&rope, config, loader.clone()));
+                                .map(|config| {
+                                    Syntax::new(&rope, config, self.config_loader.clone())
+                                });
 
                             if let Some(syntax) = syntax {
                                 // if we have a syntax available, highlight_iter and generate spans
@@ -140,8 +154,10 @@ fn parse<'a>(
 
                                             // if there's anything left, emit it too
                                             if !slice.is_empty() {
-                                            let span =
+                                                let span = Span::styled(
-                                                Span::styled(slice.replace('\t', "    "), style);
+                                                    slice.replace('\t', "    "),
+                                                    style,
+                                                );
                                                 spans.push(span);
                                             }
                                         }
@@ -206,15 +222,13 @@ fn parse<'a>(
 
         Text::from(lines)
     }
+}
+
 impl Component for Markdown {
     fn render(&mut self, area: Rect, surface: &mut Surface, cx: &mut Context) {
         use tui::widgets::{Paragraph, Widget, Wrap};
 
-        let text = parse(
+        let text = self.parse(Some(&cx.editor.theme));
-            &self.contents,
-            Some(&cx.editor.theme),
-            self.config_loader.clone(),
-        );
 
         let par = Paragraph::new(text)
             .wrap(Wrap { trim: false })
@@ -232,7 +246,8 @@ impl Component for Markdown {
         if padding >= viewport.1 || padding >= viewport.0 {
             return None;
         }
-        let contents = parse(&self.contents, None, self.config_loader.clone());
+        let contents = self.parse(None);
+
         // TODO: account for tab width
         let max_text_width = (viewport.0 - padding).min(120);
         let mut text_width = 0;