1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
use std::ops::{Deref, DerefMut};
use pulldown_cmark::{CodeBlockKind, Event, Options, Tag, TagEnd};
use crate::note_editor::{
ast::{self, Node, SourceRange, TaskKind},
rich_text::{RichText, Style, TextSegment},
};
pub struct Parser<'a>(pulldown_cmark::TextMergeWithOffset<'a, pulldown_cmark::OffsetIter<'a>>);
impl<'a> Deref for Parser<'a> {
type Target = pulldown_cmark::TextMergeWithOffset<'a, pulldown_cmark::OffsetIter<'a>>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for Parser<'_> {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
impl<'a> Iterator for Parser<'a> {
type Item = (Event<'a>, SourceRange<usize>);
fn next(&mut self) -> Option<Self::Item> {
self.deref_mut().next()
}
}
#[derive(Clone, Debug, PartialEq, Default)]
pub struct ParserState {
task_kind: Option<ast::TaskKind>,
item_kind: Vec<ast::ItemKind>,
}
impl<'a> Parser<'a> {
/// Creates a new [`Parser`] from a Markdown input string.
///
/// The parser uses [`pulldown_cmark::Parser::new_ext`] with [`Options::all()`] and
/// [`pulldown_cmark::TextMergeWithOffset`] internally.
///
/// The offset is required to know where the node appears in the provided source text.
pub fn new(text: &'a str) -> Self {
let parser = pulldown_cmark::TextMergeWithOffset::new(
pulldown_cmark::Parser::new_ext(text, Options::all()).into_offset_iter(),
);
Self(parser)
}
pub fn parse(mut self) -> Vec<Node> {
let mut result = Vec::new();
let mut state = ParserState::default();
while let Some((event, _)) = self.next() {
match event {
Event::Start(tag) if Self::is_container_tag(&tag) => {
if let Some(node) = self.parse_container(tag, &mut state) {
result.push(node);
}
}
_ => {}
}
}
result
}
pub fn parse_container(&mut self, tag: Tag, state: &mut ParserState) -> Option<Node> {
let mut nodes = Vec::new();
let mut text_segments = Vec::new();
let mut inline_styles = Vec::new();
match tag {
Tag::List(Some(start)) => {
state.item_kind.push(ast::ItemKind::Ordered(start));
}
Tag::List(..) => {
state.item_kind.push(ast::ItemKind::Unordered);
}
_ => {}
};
while let Some((event, source_range)) = self.next() {
match event {
Event::Start(inner_tag) if Self::is_container_tag(&inner_tag) => {
if let Some(node) = self.parse_container(inner_tag, state) {
nodes.push(node);
}
}
Event::Start(inner_tag) if Self::is_inline_tag(&inner_tag) => {
if let Some(style) = Self::tag_to_style(&inner_tag) {
inline_styles.push(style);
}
}
Event::TaskListMarker(checked) => {
state.task_kind = Some(if checked {
TaskKind::Checked
} else {
TaskKind::Unchecked
});
}
Event::Code(text) => {
let text_segment = TextSegment::styled(&text, Style::Code);
text_segments.push(text_segment);
}
Event::Text(text) => {
let mut text_segment = TextSegment::plain(&text);
inline_styles.iter().for_each(|style| {
text_segment.add_style(style);
});
text_segments.push(text_segment);
}
Event::SoftBreak => {
let text_segment = TextSegment::empty_line();
text_segments.push(text_segment);
}
Event::End(tag_end) if Self::tags_match(&tag, &tag_end) => {
let text = if !text_segments.is_empty() {
RichText::from(text_segments)
} else {
RichText::empty()
};
return match tag {
Tag::Heading { level, .. } => Some(Node::Heading {
level: level.into(),
text,
source_range,
}),
Tag::Item => {
// This is required since in block quotes list items are considered
// "tight", thus the text is not stored in a paragraph directly.
// TODO: Think if wrapping this into a paragraph is a good idea or not.
// Potentially storing a RichText here is better.
if !text.is_empty() {
nodes.insert(
0,
Node::Paragraph {
text,
source_range: source_range.clone(),
},
);
}
let item = if let Some(kind) = state.task_kind.take() {
Some(Node::Task {
kind,
nodes,
source_range,
})
} else {
Some(Node::Item {
kind: state
.item_kind
.last()
.cloned()
.unwrap_or(ast::ItemKind::Unordered),
nodes,
source_range,
})
};
if let Some(ast::ItemKind::Ordered(start)) = state.item_kind.last_mut()
{
*start += 1;
};
item
}
Tag::List(..) => {
state.item_kind.pop();
Some(Node::List {
nodes,
source_range,
})
}
Tag::CodeBlock(kind) => Some(Node::CodeBlock {
lang: match kind {
CodeBlockKind::Fenced(lang) => Some(lang.to_string()),
_ => None,
},
text,
source_range,
}),
Tag::BlockQuote(kind) => Some(Node::BlockQuote {
kind: kind.map(|kind| kind.into()),
nodes,
source_range,
}),
Tag::Paragraph => Some(Node::Paragraph { text, source_range }),
_ => None,
};
}
_ => {}
}
}
None
}
fn is_container_tag(tag: &Tag) -> bool {
matches!(
tag,
Tag::Paragraph
| Tag::Item
| Tag::List(..)
| Tag::BlockQuote(..)
| Tag::CodeBlock(..)
| Tag::Heading { .. }
)
}
fn is_inline_tag(tag: &Tag) -> bool {
matches!(tag, Tag::Emphasis | Tag::Strong | Tag::Strikethrough)
}
fn tags_match(start: &Tag, end: &TagEnd) -> bool {
fn tag_to_end(tag: &Tag) -> Option<TagEnd> {
match tag {
Tag::Heading { level, .. } => Some(TagEnd::Heading(*level)),
Tag::List(ordered) => Some(TagEnd::List(ordered.is_some())),
Tag::Item => Some(TagEnd::Item),
Tag::BlockQuote(kind) => Some(TagEnd::BlockQuote(*kind)),
Tag::CodeBlock(..) => Some(TagEnd::CodeBlock),
Tag::Paragraph => Some(TagEnd::Paragraph),
_ => None,
}
}
if let Some(start) = tag_to_end(start) {
std::mem::discriminant(&start) == std::mem::discriminant(end)
} else {
false
}
}
fn tag_to_style(tag: &Tag) -> Option<Style> {
match tag {
Tag::Emphasis => Some(Style::Emphasis),
Tag::Strong => Some(Style::Strong),
Tag::Strikethrough => Some(Style::Strikethrough),
_ => None,
}
}
}
pub fn from_str(text: &str) -> Vec<Node> {
Parser::new(text).parse()
}
#[cfg(test)]
mod tests {
use indoc::indoc;
use insta::assert_snapshot;
use super::*;
#[test]
fn test_parser() {
let tests = [
(
"paragraphs",
indoc! { r#"## Paragraphs
To create paragraphs in Markdown, use a **blank line** to separate blocks of text. Each block of text separated by a blank line is treated as a distinct paragraph.
This is a paragraph.
This is another paragraph.
A blank line between lines of text creates separate paragraphs. This is the default behavior in Markdown.
"#},
),
(
"headings",
indoc! { r#"## Headings
To create a heading, add up to six `#` symbols before your heading text. The number of `#` symbols determines the size of the heading.
# This is a heading 1
## This is a heading 2
### This is a heading 3
#### This is a heading 4
##### This is a heading 5
###### This is a heading 6
"#},
),
(
"lists",
indoc! { r#"## Lists
You can create an unordered list by adding a `-`, `*`, or `+` before the text.
- First list item
- Second list item
- Third list item
To create an ordered list, start each line with a number followed by a `.` or `)` symbol.
1. First list item
2. Second list item
3. Third list item
1) First list item
2) Second list item
3) Third list item
"#},
),
(
"lists_line_breaks",
indoc! { r#"## Lists with line breaks
You can use line breaks within an ordered list without altering the numbering.
1. First list item
2. Second list item
3. Third list item
4. Fourth list item
5. Fifth list item
6. Sixth list item
"#},
),
(
"task_lists",
indoc! { r#"## Task lists
To create a task list, start each list item with a hyphen and space followed by `[ ]`.
- [x] This is a completed task.
- [ ] This is an incomplete task.
You can toggle a task in Reading view by selecting the checkbox.
> [!tip]
> You can use any character inside the brackets to mark it as complete.
>
> - [x] Milk
> - [?] Eggs
> - [-] Eggs
"#},
),
(
"nesting_lists",
indoc! { r#"## Nesting lists
You can nest any type of list—ordered, unordered, or task lists—under any other type of list.
To create a nested list, indent one or more list items. You can mix list types within a nested structure:
1. First list item
1. Ordered nested list item
2. Second list item
- Unordered nested list item
"#},
),
(
"nesting_task_lists",
indoc! { r#"## Nesting task lists
Similarly, you can create a nested task list by indenting one or more list items:
- [ ] Task item 1
- [ ] Subtask 1
- [ ] Task item 2
- [ ] Subtask 1
"#},
),
// TODO: Implement horizontal rule
// (
// "horizontal_rule",
// indoc! { r#"## Horizontal rule
// You can use three or more stars `***`, hyphens `---`, or underscore `___` on its own line to add a horizontal bar. You can also separate symbols using spaces.
//
// ***
// ****
// * * *
// ---
// ----
// - - -
// ___
// ____
// _ _ _
// "#},
// ),
(
"code_blocks",
indoc! { r#"## Code blocks
To format code as a block, enclose it with three backticks or three tildes.
```md
cd ~/Desktop
```
You can also create a code block by indenting the text using `Tab` or 4 blank spaces.
cd ~/Desktop
"#},
),
(
"code_syntax_highlighting_in_blocks",
indoc! { r#"## Code syntax highlighting in blocks
You can add syntax highlighting to a code block, by adding a language code after the first set of backticks.
```js
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
```
"#},
),
];
tests.into_iter().for_each(|(name, text)| {
assert_snapshot!(
name,
format!("{}\n ---\n\n{}", text, ast::nodes_to_sexp(&from_str(text)))
);
});
}
}