shrub-core 0.0.3

Reusable core of a POSIX/bash shell (used by shrub-shell)
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

//! Parsing for shell instances.

use std::io::Read;

use crate::{Shell, extensions, trace_categories};

impl<SE: extensions::ShellExtensions> Shell<SE> {
    /// Parses the given reader as a shell program, returning the resulting
    /// Abstract Syntax Tree for the program.
    ///
    /// # Errors
    ///
    /// - [`shrub_parser::ParseError::Tokenizing`] if the input cannot be
    ///   tokenized.
    /// - [`shrub_parser::ParseError::ParsingNear`] or
    ///   [`shrub_parser::ParseError::ParsingAtEndOfInput`] if the input is not
    ///   a valid program.
    pub fn parse<R: Read>(
        &self,
        reader: R,
    ) -> Result<shrub_parser::ast::Program, shrub_parser::ParseError> {
        let mut parser = create_parser(reader, &self.parser_options());

        tracing::debug!(target: trace_categories::PARSE, "Parsing reader as program...");
        parser.parse_program()
    }

    /// Parses the given string as a shell program, returning the resulting
    /// Abstract Syntax Tree for the program.
    ///
    /// # Arguments
    ///
    /// * `s` - The string to parse as a program.
    ///
    /// # Errors
    ///
    /// - [`shrub_parser::ParseError::Tokenizing`] if the input cannot be
    ///   tokenized.
    /// - [`shrub_parser::ParseError::ParsingNear`] or
    ///   [`shrub_parser::ParseError::ParsingAtEndOfInput`] if the input is not
    ///   a valid program.
    pub fn parse_string<S: Into<String>>(
        &self,
        s: S,
    ) -> Result<shrub_parser::ast::Program, shrub_parser::ParseError> {
        let s: String = s.into();
        parse_string_impl(&s, &self.parser_options())
    }

    /// Returns the options that should be used for parsing shell programs;
    /// reflects the current configuration state of the shell and may change
    /// over time.
    pub const fn parser_options(&self) -> shrub_parser::ParserOptions {
        shrub_parser::ParserOptions {
            enable_extended_globbing: self.options.extended_globbing,
            posix_mode: self.options.posix_mode,
            sh_mode: self.options.sh_mode,
            tilde_expansion_at_word_start: true,
            tilde_expansion_after_colon: false,
            parser_impl: self.parser_impl,
        }
    }
}

#[cached::macros::cached(
    max_size = 64,
    key = "(String, shrub_parser::ParserOptions)",
    convert = r#"{ (s.to_owned(), parser_options.to_owned()) }"#
)]
fn parse_string_impl(
    s: &str,
    parser_options: &shrub_parser::ParserOptions,
) -> Result<shrub_parser::ast::Program, shrub_parser::ParseError> {
    let mut parser = create_parser(s.as_bytes(), parser_options);

    tracing::debug!(target: trace_categories::PARSE, "Parsing string as program...");
    parser.parse_program()
}

pub(super) fn create_parser<R: Read>(
    r: R,
    parser_options: &shrub_parser::ParserOptions,
) -> shrub_parser::Parser<std::io::BufReader<R>> {
    let reader = std::io::BufReader::new(r);
    shrub_parser::Parser::new(reader, parser_options)
}