fml 0.6.5

Friendly Markup Language
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

// #[macro_use]
// pub mod macros;
// TODO: uncomment once migration to winnow finishes
#[cfg(test)]
mod tests;

// <Modules and reexports>
pub mod functions;
pub use functions::parse;
// Deprecating so that end users dont have to manually include chumsky traits if they dont need to
#[deprecated(note = "deprecated export in favor of fml::parse abstraction")]
pub use functions::parser;
// </Modules and reexports>

// <use>
use std::fmt::Debug;
use winnow::Stateful;
// </use>

// <Attributes>
const ESCAPABLE_TOKENS: &[char] = &[
    '\\', '*', '%', '_', '~', '|', '$', '[', ']', '(', ')', '<', '>', '{', '}', '`', '-', '#', '^',
];

/// Global state shared between parsing functions
#[derive(Debug, Clone, Copy)]
struct State {
    /// States whether the cursor should interpret is position as the Start-of-Line or not.
    is_sol: bool,
    /// States whether the cursor is already inside of a heading.
    /// This gets temporarily overridden by Quotes.
    is_in_heading: bool,
    /// For prevention of hyperlink nesting.
    is_in_hyperlink: bool,
    /// Prevents nesting (sup&sub)scripts
    is_in_script: bool,
}
impl Default for State {
    fn default() -> Self {
        Self {
            is_sol: true,
            is_in_heading: false,
            is_in_hyperlink: false,
            is_in_script: false,
        }
    }
}

/// Input for parsers. Bool symbolises newline
type Stream<'i> = Stateful<&'i str, State>;