oak-cmd 0.0.11

High-performance incremental Windows Command (CMD) parser for the oak ecosystem with flexible configuration, supporting shell scripting and automation workflows.
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
118
119

#![doc = include_str!("readme.md")]

/// Element types for command-line arguments.
pub mod element_type;

pub use element_type::CmdElementType;

use crate::{
    language::CmdLanguage,
    lexer::{CmdLexer, CmdTokenType},
};
use oak_core::{
    TextEdit,
    parser::{ParseCache, Parser, ParserState},
    source::Source,
};

#[allow(dead_code)]
pub(crate) type State<'a, S> = ParserState<'a, CmdLanguage, S>;

/// Parser for the CMD language.
pub struct CmdParser<'config> {
    pub(crate) config: &'config CmdLanguage,
}

impl<'config> CmdParser<'config> {
    /// Creates a new `CmdParser` with the given configuration.
    pub fn new(config: &'config CmdLanguage) -> Self {
        Self { config }
    }

    fn parse_statement<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), oak_core::OakError> {
        self.skip_trivia(state);
        if !state.not_at_end() {
            return Ok(());
        }

        match state.peek_kind() {
            Some(CmdTokenType::Label) => self.parse_label(state),
            Some(CmdTokenType::Keyword) => {
                let text = state.peek_text().map(|s| s.to_uppercase());
                match text.as_deref() {
                    Some("IF") => self.parse_if(state),
                    Some("FOR") => self.parse_for(state),
                    Some("SET") => self.parse_set(state),
                    _ => self.parse_command(state),
                }
            }
            _ => self.parse_command(state),
        }
    }

    fn skip_trivia<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) {
        while state.at(CmdTokenType::Whitespace) || state.at(CmdTokenType::Newline) || state.at(CmdTokenType::Comment) {
            state.bump();
        }
    }

    fn parse_label<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), oak_core::OakError> {
        let cp = state.checkpoint();
        state.expect(CmdTokenType::Label)?;
        state.finish_at(cp, CmdElementType::LabelDefinition);
        Ok(())
    }

    fn parse_if<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), oak_core::OakError> {
        let cp = state.checkpoint();
        state.bump(); // IF
        while state.not_at_end() && !state.at(CmdTokenType::Newline) {
            state.bump();
        }
        state.finish_at(cp, CmdElementType::IfStatement);
        Ok(())
    }

    fn parse_for<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), oak_core::OakError> {
        let cp = state.checkpoint();
        state.bump(); // FOR
        while state.not_at_end() && !state.at(CmdTokenType::Newline) {
            state.bump();
        }
        state.finish_at(cp, CmdElementType::ForStatement);
        Ok(())
    }

    fn parse_set<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), oak_core::OakError> {
        let cp = state.checkpoint();
        state.bump(); // SET
        while state.not_at_end() && !state.at(CmdTokenType::Newline) {
            state.bump();
        }
        state.finish_at(cp, CmdElementType::SetStatement);
        Ok(())
    }

    fn parse_command<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), oak_core::OakError> {
        let cp = state.checkpoint();
        while state.not_at_end() && !state.at(CmdTokenType::Newline) {
            state.bump();
        }
        state.finish_at(cp, CmdElementType::CommandStatement);
        Ok(())
    }
}

impl<'config> Parser<CmdLanguage> for CmdParser<'config> {
    fn parse<'a, S: Source + ?Sized>(&self, text: &'a S, edits: &[TextEdit], cache: &'a mut impl ParseCache<CmdLanguage>) -> oak_core::ParseOutput<'a, CmdLanguage> {
        let lexer = CmdLexer::new(self.config);
        oak_core::parser::parse_with_lexer(&lexer, text, edits, cache, |state| {
            let checkpoint = state.checkpoint();
            while state.not_at_end() {
                if self.parse_statement(state).is_err() {
                    break;
                }
            }
            Ok(state.finish_at(checkpoint, CmdElementType::Root))
        })
    }
}