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

use std::borrow::Cow;

use nom::{
    bytes::complete::tag_no_case,
    character::complete::{alpha1, space0, space1},
    IResult,
};

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

/// Dynamic Block Element
#[derive(Debug, Default, Clone)]
#[cfg_attr(test, derive(PartialEq))]
#[cfg_attr(feature = "ser", derive(serde::Serialize))]
pub struct DynBlock<'a> {
    /// Block name
    pub block_name: Cow<'a, str>,
    /// Block argument
    #[cfg_attr(feature = "ser", serde(skip_serializing_if = "Option::is_none"))]
    pub arguments: Option<Cow<'a, str>>,
    /// Numbers of blank lines between first block's line and next non-blank
    /// line
    pub pre_blank: usize,
    /// Numbers of blank lines between last drawer's line and next non-blank
    /// line or buffer's end
    pub post_blank: usize,
}

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

    pub fn into_owned(self) -> DynBlock<'static> {
        DynBlock {
            block_name: self.block_name.into_owned().into(),
            arguments: self.arguments.map(Into::into).map(Cow::Owned),
            pre_blank: self.pre_blank,
            post_blank: self.post_blank,
        }
    }
}

#[inline]
fn parse_internal(input: &str) -> IResult<&str, (DynBlock, &str), ()> {
    let (input, _) = space0(input)?;
    let (input, _) = tag_no_case("#+BEGIN:")(input)?;
    let (input, _) = space1(input)?;
    let (input, name) = alpha1(input)?;
    let (input, args) = line(input)?;
    let (input, contents) = lines_till(|line| line.trim().eq_ignore_ascii_case("#+END:"))(input)?;
    let (contents, pre_blank) = blank_lines_count(contents)?;
    let (input, post_blank) = blank_lines_count(input)?;

    Ok((
        input,
        (
            DynBlock {
                block_name: name.into(),
                arguments: if args.trim().is_empty() {
                    None
                } else {
                    Some(args.trim().into())
                },
                pre_blank,
                post_blank,
            },
            contents,
        ),
    ))
}

#[test]
fn parse() {
    // TODO: testing
    assert_eq!(
        DynBlock::parse(
            r#"#+BEGIN: clocktable :scope file


CONTENTS
#+END:

"#
        ),
        Some((
            "",
            (
                DynBlock {
                    block_name: "clocktable".into(),
                    arguments: Some(":scope file".into()),
                    pre_blank: 2,
                    post_blank: 1,
                },
                "CONTENTS\n"
            )
        ))
    );
}