marco-core 1.1.0

nom-based Markdown parser, HTML renderer, and intelligence features (highlights, diagnostics, completions) for the Marco editor.
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

//! GFM-style footnote references (inline extension).
//!
//! Syntax: `[^label]`

use super::shared::{opt_span, GrammarSpan};
use crate::parser::ast::{Node, NodeKind};
use nom::IResult;
use nom::Input;

/// Parse an inline footnote reference of the form `[^label]`.
pub fn parse_footnote_reference(input: GrammarSpan) -> IResult<GrammarSpan, Node> {
    let frag = input.fragment();
    if !frag.starts_with("[^") {
        return Err(nom::Err::Error(nom::error::Error::new(
            input,
            nom::error::ErrorKind::Tag,
        )));
    }

    // Find the closing bracket on the same line.
    let close = match frag.find(']') {
        Some(idx) => idx,
        None => {
            return Err(nom::Err::Error(nom::error::Error::new(
                input,
                nom::error::ErrorKind::Tag,
            )))
        }
    };

    if let Some(nl) = frag.find('\n') {
        if nl < close {
            return Err(nom::Err::Error(nom::error::Error::new(
                input,
                nom::error::ErrorKind::Tag,
            )));
        }
    }

    if close < 3 {
        return Err(nom::Err::Error(nom::error::Error::new(
            input,
            nom::error::ErrorKind::Tag,
        )));
    }

    let label = &frag[2..close];
    if label.is_empty() {
        return Err(nom::Err::Error(nom::error::Error::new(
            input,
            nom::error::ErrorKind::Tag,
        )));
    }

    let consumed_len = close + 1;
    let (rest, taken) = input.take_split(consumed_len);

    Ok((
        rest,
        Node {
            kind: NodeKind::FootnoteReference {
                label: label.to_string(),
            },
            span: opt_span(taken),
            children: Vec::new(),
        },
    ))
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn smoke_test_parse_footnote_reference_basic() {
        let input = GrammarSpan::new("[^a] test");
        let (rest, node) = parse_footnote_reference(input).expect("should parse");
        assert_eq!(*rest.fragment(), " test");
        match node.kind {
            NodeKind::FootnoteReference { label } => assert_eq!(label, "a"),
            other => panic!("expected FootnoteReference, got {other:?}"),
        }
    }

    #[test]
    fn smoke_test_parse_footnote_reference_unicode_label() {
        let input = GrammarSpan::new("[^参考]。");
        let (rest, node) = parse_footnote_reference(input).expect("should parse");
        assert_eq!(*rest.fragment(), "。");
        match node.kind {
            NodeKind::FootnoteReference { label } => assert_eq!(label, "参考"),
            other => panic!("expected FootnoteReference, got {other:?}"),
        }
    }
}