notedown_ast 0.16.3

Notedown Abstract Syntax Tree
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

use super::*;
use crate::ASTNodes;

/// Marks position of [`XMLCommand`]
#[derive(Clone, Eq, PartialEq)]
pub enum XMLCommandMarks {
    /// This is a open-close xml
    OpenClose {
        /// `|` `<cmd`
        start: usize,
        /// `|` `>`
        middle: usize,
        /// `|` `</cmd>`
        end: usize,
    },
    /// This is a self-close xml
    SelfClose {
        /// <cmd
        start: usize,
        /// </cmd>
        end: usize,
    },
}

/// ## XMLCommand
/// a command on XML Syntax
/// ### OpenClose
/// ```md
/// <cmd[][] arg=1>body text</cmd>
/// ```
/// ### SelfClose
/// ```md
/// <cmd[][] arg=1/>
/// ```
#[derive(Clone, Eq, PartialEq)]
pub struct XMLCommand {
    /// Command name
    pub cmd: String,
    /// Command marks position
    pub kind: XMLCommandMarks,
    /// Command options
    pub options: CommandArguments,
    /// Command body
    pub body: ASTNodes,
}

impl XMLCommandMarks {
    /// Start range of Command
    pub fn start_range(&self, name: &str) -> Range<usize> {
        match self {
            | Self::OpenClose { start, middle: _, end: _ } // \n
            | Self::SelfClose { start, end: _ } => {
                Range { start: *start, end: start + 1 + name.len() }
            }
        }
    }
    /// End range of Command
    pub fn end_range(&self, name: &str) -> Range<usize> {
        match self {
            | Self::OpenClose { start: _, middle: _, end } // \n
            | Self::SelfClose { start: _, end } => {
                Range { start: *end, end: end + 1 + name.len() }
            }
        }
    }
}

impl XMLCommand {
    /// Constructor of [`XMLCommand`]
    pub fn open_close(cmd: String, body: ASTNodes, options: CommandArguments) -> Self {
        let kind = XMLCommandMarks::OpenClose { start: 0, middle: 0, end: 0 };
        Self { cmd, kind, options, body }
    }
    /// Constructor of [`XMLCommand`]
    pub fn self_close(cmd: String, options: CommandArguments) -> Self {
        let kind = XMLCommandMarks::SelfClose { start: 0, end: 0 };
        Self { cmd, kind, options, body: vec![] }
    }
}

impl XMLCommand {
    /// Edit event of command name
    pub fn modify_name(&mut self, new: String) -> (Range<usize>, Range<usize>) {
        let out = (self.kind.start_range(&self.cmd), self.kind.end_range(&self.cmd));
        self.cmd = new;
        return out;
    }
}