luau_parser/impl/block/

impl.rs

//! All `impl` blocks for [`Block`].

use lsp_types::Range;
use luau_lexer::prelude::{Error, Lexer, Symbol, Token, TokenType};

use crate::{
    types::{
        Block, GetRange, GetRangeError, Parse, ParseWithArgs, Pointer, Print, Statement,
        TerminationStatement,
    },
    utils::get_token_type_display_extended,
};

/// A private helper trait for [`Block::parse_with`].
trait MatchesToken {
    /// Whether or not the current item matches the passed [`token`](Token).
    fn matches(&self, token: &Token) -> bool;
}

impl<T: MatchesToken> MatchesToken for Option<T> {
    #[inline]
    fn matches(&self, token: &Token) -> bool {
        self.as_ref().is_some_and(|value| value.matches(token))
    }
}

impl MatchesToken for TokenType {
    #[inline]
    fn matches(&self, token: &Token) -> bool {
        token == self
    }
}
impl MatchesToken for Token {
    #[inline]
    fn matches(&self, token: &Token) -> bool {
        token == self
    }
}

impl MatchesToken for Vec<TokenType> {
    #[inline]
    fn matches(&self, token: &Token) -> bool {
        self.contains(&token.token_type)
    }
}
impl MatchesToken for Vec<Token> {
    #[inline]
    fn matches(&self, token: &Token) -> bool {
        self.contains(token)
    }
}

impl<const T: usize> MatchesToken for [Token; T] {
    #[inline]
    fn matches(&self, token: &Token) -> bool {
        self.contains(token)
    }
}
impl<const T: usize> MatchesToken for [TokenType; T] {
    #[inline]
    fn matches(&self, token: &Token) -> bool {
        self.contains(&token.token_type)
    }
}

impl<T: MatchesToken> ParseWithArgs<T> for Block {
    fn parse_with(
        mut token: Token,
        lexer: &mut Lexer,
        errors: &mut Vec<Error>,
        stop_at: T,
    ) -> Option<Self> {
        let mut statements = Vec::new();
        let mut last_statement = None;
        let mut is_done = false;

        if stop_at.matches(&token) {
            return (!statements.is_empty() || last_statement.is_some()).then_some(Self {
                statements,
                last_statement,
            });
        }

        loop {
            if token.token_type == TokenType::EndOfFile {
                is_done = true;
            }
            let mut failed_parsing = false;

            if let Some(statement) = Statement::parse(token.clone(), lexer, errors) {
                if last_statement.is_some() {
                    // We will still continue parsing so LSPs, formatters, etc.
                    // can still produce "correct" outputs.

                    if let Ok(range) = statement.get_range() {
                        errors.push(Error::new(
                            range.start,
                            "Statements after a termination statement are not allowed.".to_string(),
                            Some(range.end),
                        ));
                    }
                }

                maybe_next_token!(lexer, maybe_semicolon, TokenType::Symbol(Symbol::Semicolon));
                statements.push((Pointer::new(statement), maybe_semicolon))
            } else if let Some(statement) =
                TerminationStatement::parse(token.clone(), lexer, errors)
            {
                maybe_next_token!(lexer, maybe_semicolon, TokenType::Symbol(Symbol::Semicolon));
                last_statement = Some((Pointer::new(statement), maybe_semicolon));
            } else {
                failed_parsing = true;
            }

            if is_done {
                break;
            }

            let state = lexer.save_state();
            let next_token = lexer.next_token();

            if stop_at.matches(&next_token) {
                lexer.set_state(state);

                break;
            } else if failed_parsing {
                errors.push(Error::new(
                    state.lexer_position(),
                    format!(
                        "Unexpected {}",
                        get_token_type_display_extended(&token.token_type)
                    ),
                    Some(state.lexer_position()),
                ));
            }

            token = next_token;
        }

        (!statements.is_empty() || last_statement.is_some()).then_some(Self {
            statements,
            last_statement,
        })
    }
}

impl Block {
    /// Whether or not this block is empty.
    pub const fn is_empty(&self) -> bool {
        self.statements.is_empty() && self.last_statement.is_none()
    }
}

/// A helper function to get the range of a [`Statement`] or [`TerminationStatement`]
/// which accounts for the optional [`;`](Symbol::Semicolon) at the end.
fn get_range<T: GetRange>(
    statement: &T,
    semi_colon: &Option<Token>,
) -> Result<Range, GetRangeError> {
    let statement_range = statement.get_range();

    if let Some(semicolon) = semi_colon {
        Ok(Range::new(
            statement_range?.start,
            semicolon.get_range()?.end,
        ))
    } else {
        statement_range
    }
}

impl GetRange for Block {
    fn get_range(&self) -> Result<Range, GetRangeError> {
        if self.is_empty() {
            return Err(GetRangeError::EmptyBlock);
        }
        if let Some((first_statement, semi_colon)) = self.statements.first() {
            let last_statement_range = match &self.last_statement {
                Some((statement, semi_colon)) => get_range(statement, semi_colon),
                None => get_range(first_statement, semi_colon),
            };

            return Ok(Range::new(
                get_range(first_statement, semi_colon)?.start,
                last_statement_range?.end,
            ));
        }

        match &self.last_statement {
            Some((statement, semi_colon)) => get_range(statement, semi_colon),
            None => Err(GetRangeError::EmptyBlock),
            // `None` should be `unreachable!()`.
        }
    }
}

impl Print for Block {
    fn print_final_trivia(&self) -> String {
        if self.is_empty() {
            String::new()
        } else if let Some(last_statement) = self.last_statement.as_ref() {
            last_statement.print_final_trivia()
        } else {
            self.statements.print_final_trivia()
        }
    }

    fn print_without_final_trivia(&self) -> String {
        if self.is_empty() {
            String::new()
        } else if self.statements.is_empty() {
            // SAFETY: Since `is_empty` is false and no statements exist, a
            //         last_statement must exit.
            #[allow(clippy::unwrap_used)]
            self.last_statement
                .as_ref()
                .unwrap()
                .print_without_final_trivia()
        } else if self.last_statement.is_none() {
            self.statements.print_without_final_trivia()
        } else {
            // SAFETY: Checked in the previous `else if` arm.
            #[allow(clippy::unwrap_used)]
            {
                self.statements.print_without_final_trivia()
                    + &self
                        .last_statement
                        .as_ref()
                        .unwrap()
                        .print_without_final_trivia()
            }
        }
    }
}