luaparse-rs 0.1.1

Multi-version Lua parser supporting Lua 5.1-5.4 and Luau
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

#![doc = include_str!("../README.md")]
#![cfg_attr(not(feature = "std"), no_std)]

extern crate alloc;
use alloc::{string::String, vec::Vec};
use thiserror::Error;

/// The syntax tree types: statements, expressions, types, and the visitor.
pub mod ast;
/// The parser that turns source code into an [`Ast`].
pub mod parser;
/// The tokenizer that breaks source text into tokens.
pub mod lexer;
/// Lua version markers ([`Luau`], [`Lua51`], [`Lua52`], [`Lua53`], [`Lua54`]).
pub mod marker;

pub use ast::{Ast, AstWithTypes};
pub use lexer::InterpolationPart;

pub use marker::{Lua51, Lua52, Lua53, Lua54, LuaVersion, Luau};
pub use parser::Parser;

/// A byte range in the source code (`start..end`).
///
/// Every node in the syntax tree carries a span so you can trace it back to
/// a position in the original source string.
pub type Span = core::ops::Range<usize>;

/// Something went wrong while parsing.
///
/// Each variant includes a [`Span`] pointing to where the problem is in the source.
#[derive(Debug, Error, Clone)]
pub enum ParseError {
    /// Found a token the parser wasn't expecting.
    #[error("unexpected token: expected {expected:?}, found {found}")]
    UnexpectedToken {
        /// What the parser was looking for.
        expected: Vec<String>,
        /// What it actually found.
        found: String,
        /// Where in the source.
        span: Span,
    },
    /// The source ended before the parser finished.
    #[error("unexpected end of file: expected {expected:?}")]
    UnexpectedEof {
        /// What the parser still needed.
        expected: Vec<String>,
        /// Points to the end of the source.
        span: Span,
    },
    /// The code is structurally wrong.
    #[error("{message}")]
    InvalidSyntax {
        /// What went wrong.
        message: String,
        /// Where in the source.
        span: Span,
        /// An optional suggestion for how to fix it.
        help: Option<String>,
    },
    /// A feature was used that doesn't exist in the chosen Lua version.
    ///
    /// For example, using `continue` when parsing as Lua 5.1.
    #[error("feature '{feature}' not supported in {version}")]
    UnsupportedFeature {
        /// Name of the unsupported feature.
        feature: String,
        /// Which Lua version was selected.
        version: String,
        /// Where in the source.
        span: Span,
    },
}

/// Something went wrong during lexing (tokenization).
///
/// These errors happen before parsing even starts. The source text couldn't
/// be broken into valid tokens.
#[derive(Debug, Error, Clone)]
pub enum LexError {
    /// A string literal was opened but never closed.
    #[error("unterminated string literal")]
    UnterminatedString { span: Span },
    /// A number literal couldn't be understood.
    #[error("invalid number literal")]
    InvalidNumber { span: Span },
    /// A block comment (`--[[ ... ]]`) was opened but never closed.
    #[error("unterminated comment")]
    UnterminatedComment { span: Span },
    /// A string contains a backslash sequence that isn't valid.
    #[error("invalid escape sequence: \\{escape}")]
    InvalidEscape { escape: char, span: Span },
}

#[cfg(feature = "wasm")]
pub mod wasm;