logix-type 0.11.2

use std::{ops::Range, path::Path};

use crate::{
    error::{ParseError, Result, Wanted, Warn},
    loader::{CachedFile, LogixLoader},
    span::SourceSpan,
    token::{parse_token, Brace, Delim, ParseRes, Token},
    type_trait::Value,
    types::ShortStr,
    LogixType,
};
use bstr::ByteSlice;
use logix_vfs::LogixVfs;

mod delimited;
pub use delimited::ParseDelimited;

#[derive(Clone)]
struct ParseState {
    cur_pos: usize,
    cur_col: usize,
    cur_ln: usize,
    last_was_newline: bool,
    eof: bool,
}

/// The parser used by the `LogixType` trait
pub struct LogixParser<'fs, 'f, FS: LogixVfs> {
    loader: &'fs mut LogixLoader<FS>,
    file: &'f CachedFile,
    state: ParseState,
}

impl<'fs, 'f, FS: LogixVfs> LogixParser<'fs, 'f, FS> {
    pub(crate) fn new(loader: &'fs mut LogixLoader<FS>, file: &'f CachedFile) -> Self {
        Self {
            loader,
            file,
            state: ParseState {
                cur_pos: 0,
                cur_col: 0,
                cur_ln: 1,
                last_was_newline: true,
                eof: false,
            },
        }
    }

    pub fn warning(&self, warning: Warn) -> Result<()> {
        // TODO(2023.10): Make it possible to allow warnings
        Err(ParseError::Warning(warning))
    }

    pub fn cur_span(&self) -> SourceSpan {
        self.calc_span(0..0)
    }

    fn calc_span(&self, range: Range<usize>) -> SourceSpan {
        SourceSpan::new(
            self.file,
            self.state.cur_pos + range.start,
            self.state.cur_ln,
            self.state.cur_col + range.start,
            range.len(),
        )
    }

    pub fn peek_token(&mut self) -> Result<(SourceSpan, Token<'f>)> {
        let mut fork = LogixParser {
            loader: self.loader,
            file: self.file,
            state: self.state.clone(),
        };
        fork.next_token()
    }

    pub fn next_token(&mut self) -> Result<(SourceSpan, Token<'f>)> {
        if self.state.eof {
            return Ok((self.calc_span(0..0), Token::Newline(true)));
        }

        'outer: loop {
            let last_was_newline = std::mem::take(&mut self.state.last_was_newline);

            'ignore_token: loop {
                let buf = &self.file.data()[self.state.cur_pos..];
                let (span, token) = {
                    let ParseRes {
                        len,
                        range,
                        lines,
                        token,
                    } = parse_token(buf);
                    let span = self.calc_span(range);

                    self.state.cur_pos += len;
                    if lines > 0 {
                        debug_assert_ne!(len, 0);

                        self.state.cur_ln += lines;
                        if len == 1 {
                            self.state.cur_col = 0;
                        } else {
                            self.state.cur_col = self.file.data()[..self.state.cur_pos]
                                .lines()
                                .next_back()
                                .unwrap()
                                .len();
                        }
                    } else {
                        self.state.cur_col += len;
                    }
                    (span, token)
                };

                return match token {
                    Ok(
                        token @ (Token::Ident(..)
                        | Token::Action(..)
                        | Token::Brace { .. }
                        | Token::Delim(..)
                        | Token::Literal(..)),
                    ) => Ok((span, token)),
                    Ok(Token::Newline(eof)) => {
                        self.state.last_was_newline = true;
                        if !eof && last_was_newline {
                            continue 'outer;
                        }
                        self.state.eof = eof;
                        Ok((span, Token::Newline(eof)))
                    }
                    Ok(Token::Comment(_)) => {
                        continue 'ignore_token;
                    }
                    Err(error) => Err(ParseError::TokenError { span, error }),
                };
            }
        }
    }

    // TODO(2023.10): Switch to using this where possible
    /// Create a new parser that must start with the given brace, and once it returns, must
    /// point to the ending brace
    pub fn req_wrapped<R>(
        &mut self,
        while_parsing: &'static str,
        brace: Brace,
        f: impl FnOnce(&mut LogixParser<FS>) -> Result<R>,
    ) -> Result<Value<R>> {
        let start = self.req_token(while_parsing, Token::Brace { start: true, brace })?;
        let value = f(self)?;
        let end = self.req_token(
            while_parsing,
            Token::Brace {
                start: false,
                brace,
            },
        )?;
        Ok(Value { value, span: start }.join_with_span(end))
    }

    /// Parse a list of items that may be delimited by comma, newline or both
    pub fn parse_delimited<'p, R: LogixType>(
        &'p mut self,
        while_parsing: &'static str,
    ) -> ParseDelimited<'p, 'fs, 'f, FS, R> {
        ParseDelimited::new(self, while_parsing)
    }

    pub fn req_token(
        &mut self,
        while_parsing: &'static str,
        want_token: Token<'static>,
    ) -> Result<SourceSpan> {
        let (span, got_token) = self.next_token()?;

        if want_token == got_token {
            Ok(span)
        } else {
            Err(ParseError::UnexpectedToken {
                span,
                while_parsing,
                wanted: Wanted::Token(want_token),
                got_token: got_token.token_type_name(),
            })
        }
    }

    pub fn read_key_value<T: LogixType>(
        &mut self,
        while_parsing: &'static str,
        end_brace: Brace,
    ) -> Result<Option<(Value<ShortStr>, Value<T>)>> {
        match self.next_token()? {
            (span, Token::Ident(key)) => {
                let key = Value {
                    value: ShortStr::from(key),
                    span,
                };

                self.req_token(while_parsing, Token::Delim(Delim::Colon))?;

                let value = T::logix_parse(self)?;

                self.req_newline(while_parsing)?;

                Ok(Some((key, value)))
            }
            (
                _,
                Token::Brace {
                    start: false,
                    brace,
                },
            ) if brace == end_brace => Ok(None),
            (span, got_token) => Err(ParseError::UnexpectedToken {
                span,
                while_parsing,
                wanted: Wanted::Ident,
                got_token: got_token.token_type_name(),
            }),
        }
    }

    pub fn req_newline(&mut self, while_parsing: &'static str) -> Result<()> {
        match self.next_token()? {
            (_, Token::Newline(..)) => Ok(()),
            (span, got_token) => Err(ParseError::UnexpectedToken {
                span,
                while_parsing,
                wanted: Wanted::Token(Token::Newline(false)),
                got_token: got_token.token_type_name(),
            }),
        }
    }

    pub(crate) fn open_file(
        &mut self,
        path: impl AsRef<Path>,
    ) -> Result<CachedFile, logix_vfs::Error> {
        self.loader.open_file(path)
    }

    /// Forks the parser and calls the specified function, if the return value
    /// is `Some(R)`, the parser is replaced by the fork.
    pub(crate) fn forked<R>(
        &mut self,
        f: impl FnOnce(&mut LogixParser<'_, 'f, FS>) -> Result<Option<R>>,
    ) -> Result<Option<R>> {
        let mut fork = LogixParser {
            loader: self.loader,
            file: self.file,
            state: self.state.clone(),
        };
        if let Some(ret) = f(&mut fork)? {
            let LogixParser {
                loader: _,
                file: _,
                state,
            } = fork;
            self.state = state;
            Ok(Some(ret))
        } else {
            Ok(None)
        }
    }
}

#[cfg(test)]
mod tests {
    use logix_vfs::RelFs;

    use crate::token::{Brace, Literal, StrLit, StrTag};

    use super::*;

    pub(super) struct Tester<'f> {
        f: &'f CachedFile,
    }

    impl<'f> Tester<'f> {
        fn span(&self, pos: usize, ln: usize, start: usize, len: usize) -> SourceSpan {
            SourceSpan::new(self.f, pos, ln, start, len)
        }
    }

    pub(super) fn run_test<R>(
        src: &str,
        test_clb: impl FnOnce(&mut LogixParser<RelFs>, &Tester) -> R,
    ) -> R {
        let root = tempfile::tempdir().unwrap();
        std::fs::write(root.path().join("test.logix"), src).unwrap();

        let mut loader = LogixLoader::new(RelFs::new(root.path()));
        let f = loader.open_file("test.logix").unwrap();

        test_clb(&mut LogixParser::new(&mut loader, &f), &Tester { f: &f })
    }

    #[test]
    fn basics() -> Result<()> {
        run_test("Hello { world: \"!!!\" }", |p, t| -> Result<()> {
            assert_eq!(p.next_token()?, (t.span(0, 1, 0, 5), Token::Ident("Hello")));
            assert_eq!(
                p.next_token()?,
                (
                    t.span(6, 1, 6, 1),
                    Token::Brace {
                        start: true,
                        brace: Brace::Curly
                    }
                )
            );
            assert_eq!(p.next_token()?, (t.span(8, 1, 8, 5), Token::Ident("world")));
            assert_eq!(
                p.next_token()?,
                (t.span(13, 1, 13, 1), Token::Delim(Delim::Colon))
            );
            assert_eq!(
                p.next_token()?,
                (
                    t.span(15, 1, 15, 5),
                    Token::Literal(Literal::Str(StrLit::new(StrTag::Raw, "!!!")))
                )
            );
            assert_eq!(
                p.next_token()?,
                (
                    t.span(21, 1, 21, 1),
                    Token::Brace {
                        start: false,
                        brace: Brace::Curly
                    }
                )
            );

            assert_eq!(
                p.next_token()?,
                (t.span(22, 1, 22, 0), Token::Newline(true))
            );

            assert_eq!(
                p.next_token()?,
                (t.span(22, 1, 22, 0), Token::Newline(true))
            );
            // A second time to trigger additional code
            Ok(())
        })
    }
}