SamandClaude Fable 5
b5bc569156
- benilla loads real 1.12 addons from Interface/AddOns — TOC, XML and Lua through one loader, with per-addon saved variables, Bindings.xml and the lifecycle events addons expect - both AddOns screens are in: the character-select list with per-addon enable state, and the ESC menu's in-game list - the API surface is measured, not guessed — a corpus harness runs hundreds of real 1.12 addons and ranks exactly which globals, templates and verbs they demand - the Lua dialect is the client's own, read off the binary — 5.0 semantics with the 1.12 additions, and UI source files are bytes, not UTF-8 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
71 lines
3.2 KiB
Rust
71 lines
3.2 KiB
Rust
//! `dump_globals` — print benilla's Lua global namespace, asked of a real VM.
|
|
//!
|
|
//! ```text
|
|
//! cargo run -q -p benilla-ui --example dump_globals # name<TAB>type, one per line
|
|
//! cargo run -q -p benilla-ui --example dump_globals --members # ...the stdlib TABLES' members too
|
|
//! ```
|
|
//!
|
|
//! **The point is that it is a run, not a grep** (decisions 1188, 1189). Every wrong number in the
|
|
//! addon arc came from measuring our API surface by pattern-matching Rust source: a regex over
|
|
//! `.set("Name", …)` misses the Lua prelude, miscounts a `format!`-registered family, and cannot
|
|
//! see what the sandbox removed. When the question is what a running system exposes, ask the
|
|
//! running system — this is the four-minute answer 1188 §4 describes, made permanent.
|
|
//!
|
|
//! This is [`UiScript::new`]'s namespace: the Rust bindings plus the Lua stdlib prelude, i.e. what
|
|
//! an addon sees *before* any FrameXML loads. That is deliberately the engine half — it is
|
|
//! deterministic, needs no install, and is exactly what `scripts/api-coverage.sh` compares against
|
|
//! `reference/1.12-globals.tsv`'s `engine` and `lua` rows.
|
|
//!
|
|
//! ## `--members`, and the blind spot it closes (decision 1194)
|
|
//!
|
|
//! `_G` is not the whole surface an addon can tell apart. `table.setn` is not a global — it is a
|
|
//! member of the `table` table — and it stopped **61 of 218** real addons dead, because mlua's Lua
|
|
//! 5.1 raises `'setn' is obsolete` where the 1.12 client's Lua 5.0 does the thing. A `_G`-only
|
|
//! instrument cannot see that, and did not: the arc measured coverage for two sessions with this
|
|
//! gap wide open. `--members` prints `table.setn`-style rows for the stdlib tables, so the dialect
|
|
//! is measurable the same way the API surface is.
|
|
use benilla_ui::script::UiScript;
|
|
|
|
/// The tables whose membership an addon can observe and depend on.
|
|
///
|
|
/// Deliberately a fixed list, not "every table-valued global": `_G` would recurse, and a *frame*
|
|
/// table's members are the widget API, which is a different question with a different reference.
|
|
const STDLIB: &[&str] = &["string", "table", "math", "coroutine", "os", "io", "debug"];
|
|
|
|
fn main() -> mlua::Result<()> {
|
|
let script = UiScript::new()?;
|
|
// Joined Lua-side into one `name<TAB>type` string per entry: a `Vec<String>` crosses the mlua
|
|
// boundary directly, where a `Vec<(String, String)>` does not.
|
|
let mut rows: Vec<String> = script.eval(
|
|
"local out = {} \
|
|
for k, v in pairs(_G) do \
|
|
if type(k) == 'string' then table.insert(out, k .. '\\t' .. type(v)) end \
|
|
end \
|
|
return out",
|
|
)?;
|
|
|
|
if std::env::args().any(|a| a == "--members") {
|
|
for lib in STDLIB {
|
|
let members: Vec<String> = script.eval(&format!(
|
|
"local t = {lib} \
|
|
local out = {{}} \
|
|
if type(t) == 'table' then \
|
|
for k, v in pairs(t) do \
|
|
if type(k) == 'string' then \
|
|
table.insert(out, '{lib}.' .. k .. '\\t' .. type(v)) \
|
|
end \
|
|
end \
|
|
end \
|
|
return out"
|
|
))?;
|
|
rows.extend(members);
|
|
}
|
|
}
|
|
|
|
rows.sort();
|
|
for row in rows {
|
|
println!("{row}");
|
|
}
|
|
Ok(())
|
|
}
|