yamd 0.19.0

Yet Another Markdown Document (flavour)
Documentation
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
428
429
430
431
432
433
434
435
436
437
438
use crate::{
    lexer::{Token, TokenKind},
    op::{
        Content, Node, Op,
        paragraph::paragraph,
        parser::{ListKind, Parser, StopCondition, eat_seq, is_list_marker},
    },
};

fn is_space(t: &Token) -> bool {
    t.kind == TokenKind::Space && t.range.len() == 1
}

fn list_item(p: &mut Parser, level: usize, kind: Option<ListKind>) -> Option<ListKind> {
    if !p.at(|t: &Token| t.position.column == 0) {
        return None;
    }

    let marker_idx = p.pos + if level == 0 { 0 } else { 1 };
    let marker_kind = ListKind::try_from(p.get(marker_idx)?).ok()?;

    let start_range = if level == 0 {
        eat_seq!(p, |t: &Token| is_list_marker(t, kind), is_space)?
    } else {
        eat_seq!(
            p,
            |t: &Token| t.kind == TokenKind::Space && t.range.len() == level,
            |t: &Token| is_list_marker(t, kind),
            is_space
        )?
    };

    let start_content = p.span(start_range);
    p.ops.push(Op::new_start(Node::ListItem, start_content));

    p.with_eof(
        StopCondition::ListBoundary {
            level,
            kind: marker_kind,
        },
        |p| {
            paragraph(p);
        },
    );

    if !p.at_eof() {
        list_inner(p, level + 1);
    }

    p.ops.push(Op::new_end(Node::ListItem, Content::Span(0..0)));
    Some(marker_kind)
}

fn list_inner(p: &mut Parser, level: usize) -> Option<ListKind> {
    let snap = p.ops.len();
    let list_kind = list_item(p, level, None)?;

    let list_start_idx = snap;
    p.ops.insert(
        list_start_idx,
        Op::new_start(list_kind.node(), Content::Span(0..0)),
    );

    while list_item(p, level, Some(list_kind)).is_some() {}

    p.ops
        .push(Op::new_end(list_kind.node(), Content::Span(0..0)));
    Some(list_kind)
}

pub fn list(p: &mut Parser, level: usize) -> bool {
    list_inner(p, level).is_some()
}

#[cfg(test)]
mod tests {
    use crate::op::{Content, Node, Op, list::list, parser::Parser};

    #[test]
    fn parse_unordered() {
        let mut p: Parser = "- level 0\n- level 0".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..6)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(6..7)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn parse_ordered() {
        let mut p: Parser = "+ level 0\n+ same level".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..6)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(6..7)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn parse_mixed() {
        let mut p: Parser = "+ level 0\n - level 0".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..7)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(7..8)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn parse_nested() {
        let mut p: Parser = "- one\n - two".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..7)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(7..8)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn eol() {
        let mut p: Parser = "- one\n - two\n something".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..7)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(7..11)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn mixed_same_level_ordered() {
        let mut p: Parser = "+ level 0\n- same level".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..7)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn mixed_same_level_unordered() {
        let mut p: Parser = "- level 0\n+ same level".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..7)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn multiple_levels_unordered() {
        let mut p: Parser =
            "- Level 0\n - Level 1\n  - Level 2\n - Level 1\n- Level 0\n - Level 1\n  - Level 2\n- Level 0".into()
        ;

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..7)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(7..9)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(9..12)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(12..14)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(14..17)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(17..19)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(19..21)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(21..23)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(23..26)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(26..28)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(28..31)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(31..33)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(33..35)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(35..36)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn multiple_levels_ordered() {
        let mut p: Parser =
            "+ Level 0\n + Level 1\n  + Level 2\n + Level 1\n+ Level 0\n + Level 1\n  + Level 2\n+ Level 0".into()
        ;

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..7)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(7..9)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(9..12)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(12..14)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(14..17)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(17..19)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(19..21)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(21..23)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(23..26)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(26..28)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(28..31)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(31..33)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(33..35)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(35..36)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn empty_body() {
        let mut p: Parser = "- ".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn no_nested_ordered_list() {
        let mut p: Parser = "+ level 0\n + ".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..7)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
            ]
        );
    }

    #[test]
    fn no_nested_unordered_list() {
        let mut p: Parser = "+ level 0\n - ".into();

        assert!(list(&mut p, 0));
        assert_eq!(
            p.ops,
            vec![
                Op::new_start(Node::OrderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(0..2)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_value(p.span(2..4)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_start(Node::UnorderedList, Content::Span(0..0)),
                Op::new_start(Node::ListItem, p.span(4..7)),
                Op::new_start(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::Paragraph, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::UnorderedList, Content::Span(0..0)),
                Op::new_end(Node::ListItem, Content::Span(0..0)),
                Op::new_end(Node::OrderedList, Content::Span(0..0)),
            ]
        );
    }
}