orgize 0.9.0

A Rust library for parsing orgmode files.
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

use std::borrow::Cow;

use nom::{
    bytes::complete::{tag, take_while1},
    sequence::delimited,
    IResult,
};

use crate::parse::combinators::{blank_lines_count, line};

/// Footnote Definition Element
#[cfg_attr(test, derive(PartialEq))]
#[cfg_attr(feature = "ser", derive(serde::Serialize))]
#[derive(Debug, Default, Clone)]
pub struct FnDef<'a> {
    /// Footnote label, used for reference
    pub label: Cow<'a, str>,
    /// Numbers of blank lines between last footnote definition's line and next
    /// non-blank line or buffer's end
    pub post_blank: usize,
}

impl FnDef<'_> {
    pub(crate) fn parse(input: &str) -> Option<(&str, (FnDef, &str))> {
        parse_internal(input).ok()
    }

    pub fn into_owned(self) -> FnDef<'static> {
        FnDef {
            label: self.label.into_owned().into(),
            post_blank: self.post_blank,
        }
    }
}

fn parse_internal(input: &str) -> IResult<&str, (FnDef, &str), ()> {
    let (input, label) = delimited(
        tag("[fn:"),
        take_while1(|c: char| c.is_ascii_alphanumeric() || c == '-' || c == '_'),
        tag("]"),
    )(input)?;

    let (input, content) = line(input)?;

    let (input, post_blank) = blank_lines_count(input)?;

    Ok((
        input,
        (
            FnDef {
                label: label.into(),
                post_blank,
            },
            content,
        ),
    ))
}

#[test]
fn parse() {
    assert_eq!(
        FnDef::parse("[fn:1] https://orgmode.org"),
        Some((
            "",
            (
                FnDef {
                    label: "1".into(),
                    post_blank: 0
                },
                " https://orgmode.org"
            )
        ))
    );
    assert_eq!(
        FnDef::parse("[fn:word_1] https://orgmode.org"),
        Some((
            "",
            (
                FnDef {
                    label: "word_1".into(),
                    post_blank: 0,
                },
                " https://orgmode.org"
            )
        ))
    );
    assert_eq!(
        FnDef::parse("[fn:WORD-1] https://orgmode.org"),
        Some((
            "",
            (
                FnDef {
                    label: "WORD-1".into(),
                    post_blank: 0,
                },
                " https://orgmode.org"
            )
        ))
    );
    assert_eq!(
        FnDef::parse("[fn:WORD]"),
        Some((
            "",
            (
                FnDef {
                    label: "WORD".into(),
                    post_blank: 0,
                },
                ""
            )
        ))
    );

    assert!(FnDef::parse("[fn:] https://orgmode.org").is_none());
    assert!(FnDef::parse("[fn:wor d] https://orgmode.org").is_none());
    assert!(FnDef::parse("[fn:WORD https://orgmode.org").is_none());
}