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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
//! The [`Chunk`] builder returned by [`Lua::load`]. Mirrors `mlua::Chunk`.
//!
//! Compilation reuses the same machinery as the umbrella `luaur` crate's
//! `compile`/`eval` helpers: source -> `luaur_compiler::compile` -> bytecode ->
//! `luau_load` -> a Lua function on the stack -> `lua_pcall`.
use crate::error::{Error, Result};
use crate::function::Function;
use crate::state::Lua;
use crate::sys::*;
use crate::traits::FromLuaMulti;
use luaur_ast::records::parse_options::ParseOptions;
use luaur_bytecode::records::bytecode_encoder::BytecodeEncoder;
use luaur_compiler::functions::compile::compile as compiler_compile;
use luaur_compiler::records::compile_options::CompileOptions;
/// No-op bytecode encoder (same as the umbrella crate's `NoopEncoder`).
struct NoopEncoder;
impl BytecodeEncoder for NoopEncoder {
fn encode(&mut self, _data: &mut [u32]) {}
}
/// A not-yet-executed piece of Lua source.
///
/// Mirrors `mlua::Chunk`. Produced by [`Lua::load`]; finalized with
/// [`Chunk::exec`], [`Chunk::eval`], or [`Chunk::into_function`].
pub struct Chunk {
pub(crate) lua: Lua,
pub(crate) source: String,
pub(crate) name: String,
/// Optional environment table applied to the loaded function. Mirrors the
/// per-chunk environment set by `mlua::Chunk::set_environment`.
pub(crate) environment: Option<crate::table::Table>,
/// Optional per-chunk compiler. Mirrors `mlua::Chunk::set_compiler`. When
/// `None`, the VM-default compiler (`Lua::set_compiler`) is used, falling
/// back to luaur's default options.
pub(crate) compiler: Option<crate::compiler::Compiler>,
}
impl Chunk {
/// Override the chunk name shown in error messages / tracebacks.
///
/// Mirrors `mlua::Chunk::set_name`.
pub fn set_name(mut self, name: impl Into<String>) -> Self {
self.name = name.into();
self
}
/// Set the environment (globals table) the loaded chunk runs in.
///
/// Mirrors `mlua::Chunk::set_environment`. Applied to the function produced
/// by [`Chunk::into_function`] / [`Chunk::exec`] / [`Chunk::eval`].
pub fn set_environment(mut self, env: crate::table::Table) -> Self {
self.environment = Some(env);
self
}
/// Set the [`Compiler`](crate::Compiler) used to compile this chunk.
/// Mirrors `mlua::Chunk::set_compiler`.
pub fn set_compiler(mut self, compiler: crate::compiler::Compiler) -> Self {
self.compiler = Some(compiler);
self
}
/// Compile the chunk and call it with `args`, converting the result to `R`.
/// Mirrors `mlua::Chunk::call`.
pub fn call<R: FromLuaMulti>(self, args: impl crate::traits::IntoLuaMulti) -> Result<R> {
self.into_function()?.call::<R>(args)
}
/// The current chunk mode is always text here (luaur-rt loads source).
/// Mirrors `mlua::Chunk::set_mode` as a no-op accepting `mlua::ChunkMode`'s
/// role: luaur-rt auto-detects, so this is provided only for signature
/// parity and returns `self` unchanged.
pub fn set_mode(self, _mode: ChunkMode) -> Self {
self
}
/// The chunk name used for error messages / tracebacks.
///
/// Mirrors `mlua::Chunk::name`.
pub fn name(&self) -> &str {
&self.name
}
/// Compile the source to bytecode (or return a [`Error::SyntaxError`]).
fn compile(&self) -> Result<Vec<u8>> {
// Pick the effective compiler: a per-chunk one wins over the VM-default
// one (`Lua::set_compiler`); otherwise use luaur's default options.
let effective = self.compiler.clone().or_else(|| self.lua.vm_compiler());
let mut scratch: Vec<*const core::ffi::c_char> = Vec::new();
let options = match &effective {
Some(c) => c.to_options(&mut scratch),
None => CompileOptions::default(),
};
let parse_options = ParseOptions::default();
let mut encoder = NoopEncoder;
let owned = self.source.clone();
let blob = compiler_compile(
&owned,
&options,
&parse_options,
&mut encoder as *mut dyn BytecodeEncoder,
);
let bytes = blob.into_bytes();
// A leading 0 byte is the compiler's error marker.
if bytes.first() == Some(&0u8) {
let message = String::from_utf8_lossy(&bytes[1..]).into_owned();
// Luau reports a syntax error caused by hitting end-of-input (an
// unterminated block/expression) with a "got <eof>" suffix; mlua
// surfaces that as `incomplete_input: true` so a REPL can keep
// reading. Detect it the same way.
let incomplete_input = message.contains("<eof>");
return Err(Error::SyntaxError {
message,
incomplete_input,
});
}
Ok(bytes)
}
/// Load the compiled chunk and leave the resulting function on top of the
/// stack, returning a [`Function`] handle.
///
/// Mirrors `mlua::Chunk::into_function`.
pub fn into_function(self) -> Result<Function> {
let bytecode = self.compile()?;
let state = self.lua.state();
unsafe {
let chunkname = std::ffi::CString::new(format!("={}", self.name))
.unwrap_or_else(|_| std::ffi::CString::new("=chunk").unwrap());
let rc = luau_load(
state,
chunkname.as_ptr(),
bytecode.as_ptr() as *const c_char,
bytecode.len(),
0,
);
if rc != 0 {
// luau_load failure leaves an error message on the stack.
return Err(self.lua.pop_error(rc));
}
let func = Function::from_ref(self.lua.pop_ref());
if let Some(env) = &self.environment {
func.set_environment(env.clone())?;
}
Ok(func)
}
}
/// Statically type-check this chunk's source against the owning [`Lua`]'s
/// accumulated host definitions (the `typecheck` feature).
///
/// Returns `Ok(())` when the source type-checks clean, or
/// [`Error::TypeError`](crate::Error::TypeError) carrying the structured
/// diagnostics otherwise. Because Luau is dynamically typed, the check is
/// advisory — it composes with `?` ahead of [`Chunk::exec`] / [`Chunk::eval`]
/// without changing what running the chunk does:
///
/// ```
/// # #[cfg(feature = "typecheck")] {
/// # use luaur_rt::Lua;
/// let lua = Lua::new();
/// let c = lua.load("local x: number = 1\nreturn x");
/// c.check().unwrap();
/// # }
/// ```
#[cfg(feature = "typecheck")]
#[cfg_attr(docsrs, doc(cfg(feature = "typecheck")))]
pub fn check(&self) -> Result<()> {
self.lua.check(&self.source)
}
/// Run the chunk for its side effects, discarding return values.
///
/// Mirrors `mlua::Chunk::exec`.
pub fn exec(self) -> Result<()> {
let f = self.into_function()?;
f.call::<()>(())
}
/// Run the chunk and convert its return value(s) to `R`.
///
/// Mirrors `mlua::Chunk::eval`. Like the Lua REPL (and mlua), the source is
/// first tried as an *expression* (by prepending `return `); if that
/// compiles it is used, otherwise the chunk is run as a statement block.
/// This is what lets `lua.load("coroutine.create(f)").eval::<Thread>()` and
/// `lua.load("function() ... end").eval::<Function>()` work.
pub fn eval<R: FromLuaMulti>(self) -> Result<R> {
// Try the expression form first.
let expr = Chunk {
lua: self.lua.clone(),
source: format!("return {}", self.source),
name: self.name.clone(),
environment: self.environment.clone(),
compiler: self.compiler.clone(),
};
if let Ok(f) = expr.into_function() {
return f.call::<R>(());
}
// Fall back to statement-block mode.
let f = self.into_function()?;
f.call::<R>(())
}
/// Asynchronously load the chunk and call it with `args` (the `async`
/// feature). Mirrors `mlua::Chunk::call_async`.
#[cfg(feature = "async")]
#[cfg_attr(docsrs, doc(cfg(feature = "async")))]
pub async fn call_async<R>(self, args: impl crate::traits::IntoLuaMulti) -> Result<R>
where
R: FromLuaMulti,
{
self.into_function()?.call_async(args).await
}
/// Asynchronously run the chunk for its side effects (the `async` feature).
/// Mirrors `mlua::Chunk::exec_async`.
#[cfg(feature = "async")]
#[cfg_attr(docsrs, doc(cfg(feature = "async")))]
pub async fn exec_async(self) -> Result<()> {
self.call_async(()).await
}
/// Asynchronously evaluate the chunk as an expression (or block) and convert
/// the result to `R` (the `async` feature). Mirrors `mlua::Chunk::eval_async`.
///
/// Like [`Chunk::eval`], the source is first tried as an expression (by
/// prepending `return `); if that compiles it is driven, otherwise the chunk
/// runs as a statement block.
#[cfg(feature = "async")]
#[cfg_attr(docsrs, doc(cfg(feature = "async")))]
pub async fn eval_async<R>(self) -> Result<R>
where
R: FromLuaMulti,
{
// Try the expression form first (mirrors `eval`).
let expr = Chunk {
lua: self.lua.clone(),
source: format!("return {}", self.source),
name: self.name.clone(),
environment: self.environment.clone(),
compiler: self.compiler.clone(),
};
if let Ok(f) = expr.into_function() {
return f.call_async::<R>(()).await;
}
let f = self.into_function()?;
f.call_async::<R>(()).await
}
}
/// How a chunk's bytes are interpreted. Mirrors `mlua::ChunkMode`. luaur-rt
/// always loads text source, so this exists for signature parity with
/// [`Chunk::set_mode`].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ChunkMode {
/// Text source (the default and only supported mode here).
Text,
/// Precompiled bytecode (not supported by luaur-rt's high-level loader).
Binary,
}