on master help sign in
Allow separate styles for markup headings (#1618)
d5ba0b5Alex
book/src/themes.md+2
@@ -166,6 +166,8 @@ We use a similar set of scopes as
166
166
167- `markup`
167- `markup`
168 - `heading`
168 - `heading`
169+ - `marker`
170+ - `1`, `2`, `3`, `4`, `5`, `6` - heading text for h1 through h6
169 - `list`
171 - `list`
170 - `unnumbered`
172 - `unnumbered`
171 - `numbered`
173 - `numbered`
helix-term/src/commands/lsp.rs+1−2
@@ -632,8 +632,7 @@ pub fn hover(cx: &mut Context) {
632
632
633 // skip if contents empty
633 // skip if contents empty
634
634
635− let contents =
636− ui::Markdown::new(contents, editor.syn_loader.clone()).style_group("hover");
635+ let contents = ui::Markdown::new(contents, editor.syn_loader.clone());
637 let popup = Popup::new("hover", contents);
636 let popup = Popup::new("hover", contents);
638 compositor.replace_or_push("hover", Box::new(popup));
637 compositor.replace_or_push("hover", Box::new(popup));
639 }
638 }
helix-term/src/ui/completion.rs+3−5
@@ -305,8 +305,6 @@ impl Component for Completion {
305 let coords = helix_core::visual_coords_at_pos(text, cursor_pos, doc.tab_width());
305 let coords = helix_core::visual_coords_at_pos(text, cursor_pos, doc.tab_width());
306 let cursor_pos = (coords.row - view.offset.row) as u16;
306 let cursor_pos = (coords.row - view.offset.row) as u16;
307
307
308− let markdown_ui =
309− |content, syn_loader| Markdown::new(content, syn_loader).style_group("completion");
310 let mut markdown_doc = match &option.documentation {
308 let mut markdown_doc = match &option.documentation {
311 Some(lsp::Documentation::String(contents))
309 Some(lsp::Documentation::String(contents))
312 | Some(lsp::Documentation::MarkupContent(lsp::MarkupContent {
310 | Some(lsp::Documentation::MarkupContent(lsp::MarkupContent {
@@ -314,7 +312,7 @@ impl Component for Completion {
314 value: contents,
312 value: contents,
315 })) => {
313 })) => {
316 // TODO: convert to wrapped text
314 // TODO: convert to wrapped text
317− markdown_ui(
315+ Markdown::new(
318 format!(
316 format!(
319 "```{}\n{}\n```\n{}",
317 "```{}\n{}\n```\n{}",
320 language,
318 language,
@@ -329,7 +327,7 @@ impl Component for Completion {
329 value: contents,
327 value: contents,
330 })) => {
328 })) => {
331 // TODO: set language based on doc scope
329 // TODO: set language based on doc scope
332− markdown_ui(
330+ Markdown::new(
333 format!(
331 format!(
334 "```{}\n{}\n```\n{}",
332 "```{}\n{}\n```\n{}",
335 language,
333 language,
@@ -343,7 +341,7 @@ impl Component for Completion {
343 // TODO: copied from above
341 // TODO: copied from above
344
342
345 // TODO: set language based on doc scope
343 // TODO: set language based on doc scope
346− markdown_ui(
344+ Markdown::new(
347 format!(
345 format!(
348 "```{}\n{}\n```",
346 "```{}\n{}\n```",
349 language,
347 language,
helix-term/src/ui/markdown.rs+36−26
@@ -6,14 +6,14 @@ use tui::{
6
6
7use std::sync::Arc;
7use std::sync::Arc;
8
8
9−use pulldown_cmark::{CodeBlockKind, CowStr, Event, Options, Parser, Tag};
9+use pulldown_cmark::{CodeBlockKind, CowStr, Event, HeadingLevel, Options, Parser, Tag};
10
10
11use helix_core::{
11use helix_core::{
12 syntax::{self, HighlightEvent, Syntax},
12 syntax::{self, HighlightEvent, Syntax},
13 Rope,
13 Rope,
14};
14};
15use helix_view::{
15use helix_view::{
16− graphics::{Margin, Rect},
16+ graphics::{Margin, Rect, Style},
17 Theme,
17 Theme,
18};
18};
19
19
@@ -21,30 +21,31 @@ pub struct Markdown {
21 contents: String,
21 contents: String,
22
22
23 config_loader: Arc<syntax::Loader>,
23 config_loader: Arc<syntax::Loader>,
24−
25− block_style: String,
26− heading_style: String,
27}
24}
28
25
29// TODO: pre-render and self reference via Pin
26// TODO: pre-render and self reference via Pin
30// better yet, just use Tendril + subtendril for references
27// better yet, just use Tendril + subtendril for references
31
28
32impl Markdown {
29impl Markdown {
30+ // theme keys, including fallbacks
31+ const TEXT_STYLE: [&'static str; 2] = ["ui.text", "ui"];
32+ const BLOCK_STYLE: [&'static str; 3] = ["markup.raw.inline", "markup.raw", "markup"];
33+ const HEADING_STYLES: [[&'static str; 3]; 6] = [
34+ ["markup.heading.1", "markup.heading", "markup"],
35+ ["markup.heading.2", "markup.heading", "markup"],
36+ ["markup.heading.3", "markup.heading", "markup"],
37+ ["markup.heading.4", "markup.heading", "markup"],
38+ ["markup.heading.5", "markup.heading", "markup"],
39+ ["markup.heading.6", "markup.heading", "markup"],
40+ ];
41+
33 pub fn new(contents: String, config_loader: Arc<syntax::Loader>) -> Self {
42 pub fn new(contents: String, config_loader: Arc<syntax::Loader>) -> Self {
34 Self {
43 Self {
35 contents,
44 contents,
36 config_loader,
45 config_loader,
37− block_style: "markup.raw.inline".into(),
38− heading_style: "markup.heading".into(),
39 }
46 }
40 }
47 }
41
48
42− pub fn style_group(mut self, suffix: &str) -> Self {
43− self.block_style = format!("markup.raw.inline.{}", suffix);
44− self.heading_style = format!("markup.heading.{}", suffix);
45− self
46− }
47−
48 fn parse(&self, theme: Option<&Theme>) -> tui::text::Text<'_> {
49 fn parse(&self, theme: Option<&Theme>) -> tui::text::Text<'_> {
49 // // 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}}}
50 // // 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}}}
50 // 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```";
51 // 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```";
@@ -67,17 +68,19 @@ impl Markdown {
67 })
68 })
68 }
69 }
69
70
70− macro_rules! get_theme {
71+ let get_theme = |keys: &[&str]| match theme {
71− ($s1: expr) => {
72+ Some(theme) => keys
72− theme
73+ .iter()
73− .map(|theme| theme.try_get($s1.as_str()))
74+ .find_map(|key| theme.try_get(key))
74− .flatten()
75− .unwrap_or_default()
75+ .unwrap_or_default(),
76− };
76+ None => Default::default(),
77− }
77+ };
78− let text_style = theme.map(|theme| theme.get("ui.text")).unwrap_or_default();
78+ let text_style = get_theme(&Self::TEXT_STYLE);
79− let code_style = get_theme!(self.block_style);
79+ let code_style = get_theme(&Self::BLOCK_STYLE);
80− let heading_style = get_theme!(self.heading_style);
80+ let heading_styles: Vec<Style> = Self::HEADING_STYLES
81+ .iter()
82+ .map(|key| get_theme(key))
83+ .collect();
81
84
82 for event in parser {
85 for event in parser {
83 match event {
86 match event {
@@ -172,9 +175,16 @@ impl Markdown {
172 lines.push(Spans::from(span));
175 lines.push(Spans::from(span));
173 }
176 }
174 }
177 }
175− } else if let Some(Tag::Heading(_, _, _)) = tags.last() {
178+ } else if let Some(Tag::Heading(level, _, _)) = tags.last() {
176 let mut span = to_span(text);
179 let mut span = to_span(text);
177− span.style = heading_style;
180+ span.style = match level {
181+ HeadingLevel::H1 => heading_styles[0],
182+ HeadingLevel::H2 => heading_styles[1],
183+ HeadingLevel::H3 => heading_styles[2],
184+ HeadingLevel::H4 => heading_styles[3],
185+ HeadingLevel::H5 => heading_styles[4],
186+ HeadingLevel::H6 => heading_styles[5],
187+ };
178 spans.push(span);
188 spans.push(span);
179 } else {
189 } else {
180 let mut span = to_span(text);
190 let mut span = to_span(text);
runtime/queries/markdown/highlights.scm+9−4
@@ -1,7 +1,12 @@
1−[
1+(setext_heading (heading_content) @markup.heading.1 (setext_h1_underline) @markup.heading.marker)
2− (atx_heading)
2+(setext_heading (heading_content) @markup.heading.2 (setext_h2_underline) @markup.heading.marker)
3− (setext_heading)
3+
4−] @markup.heading
4+(atx_heading (atx_h1_marker) @markup.heading.marker (heading_content) @markup.heading.1)
5+(atx_heading (atx_h2_marker) @markup.heading.marker (heading_content) @markup.heading.2)
6+(atx_heading (atx_h3_marker) @markup.heading.marker (heading_content) @markup.heading.3)
7+(atx_heading (atx_h4_marker) @markup.heading.marker (heading_content) @markup.heading.4)
8+(atx_heading (atx_h5_marker) @markup.heading.marker (heading_content) @markup.heading.5)
9+(atx_heading (atx_h6_marker) @markup.heading.marker (heading_content) @markup.heading.6)
5
10
6(code_fence_content) @none
11(code_fence_content) @none
7
12