oak-bat 0.0.11

High-performance incremental Windows Batch (BAT) 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
120
121
122
123
124
125
126
127
128
129

#![doc = include_str!("readme.md")]
/// Element type definitions for Windows Batch (BAT) syntax tree nodes.
///
/// This module provides [`BatElementType`] which defines all element types
/// used in the BAT parse tree, including statements, labels, and commands.
pub mod element_type;

pub use element_type::BatElementType;

use crate::{
    language::BatLanguage,
    lexer::{BatLexer, BatTokenType},
};
use oak_core::{
    OakError, TextEdit,
    parser::{ParseCache, Parser, ParserState},
    source::Source,
};

pub(crate) type State<'a, S> = ParserState<'a, BatLanguage, S>;

/// Parser for Windows Batch (BAT) files.
///
/// This parser transforms tokens from the lexer into a structured
/// parse tree (green tree) representing the BAT source code.
pub struct BatParser<'config> {
    pub(crate) config: &'config BatLanguage,
}

impl<'config> BatParser<'config> {
    /// Creates a new `BatParser` instance with the specified language configuration.
    ///
    /// # Arguments
    ///
    /// * `config` - A reference to the `BatLanguage` configuration that defines
    ///   the language-specific settings for parsing.
    pub fn new(config: &'config BatLanguage) -> Self {
        Self { config }
    }

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

        match state.peek_kind() {
            Some(BatTokenType::Label) => self.parse_label(state),
            Some(BatTokenType::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(BatTokenType::Whitespace) || state.at(BatTokenType::Newline) || state.at(BatTokenType::Comment) {
            state.bump();
        }
    }

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

    fn parse_if<'a, S: Source + ?Sized>(&self, state: &mut State<'a, S>) -> Result<(), OakError> {
        let cp = state.checkpoint();
        state.bump(); // IF
        // Basic IF parsing: consume until newline or block
        while state.not_at_end() && !state.at(BatTokenType::Newline) {
            state.bump();
        }
        state.finish_at(cp, BatElementType::IfStatement);
        Ok(())
    }

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

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

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

impl<'config> Parser<BatLanguage> for BatParser<'config> {
    fn parse<'a, S: Source + ?Sized>(&self, text: &'a S, edits: &[TextEdit], cache: &'a mut impl ParseCache<BatLanguage>) -> oak_core::ParseOutput<'a, BatLanguage> {
        let lexer = BatLexer::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, BatElementType::Root))
        })
    }
}