Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix and simplify library opening #68

Merged
merged 2 commits into from
Mar 19, 2024
Merged

Fix and simplify library opening #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8eff23a
breaking: remove lua.open() function
natecraddock Mar 19, 2024
3075ba8
fix(#64): segfault when loading standard libraries
natecraddock Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion examples/zig-fn.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ pub fn main() anyerror!void {
lua.setGlobal("add");

// We need to open the base library so the global print() is available
lua.open(.{ .base = true });
lua.openBase();

// Our "program" is an inline string
lua.doString(
Expand Down
53 changes: 11 additions & 42 deletions src/lib.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,13 +435,6 @@ pub const Libs53 = packed struct {
debug: bool = false,
};

/// Bitflag for the Lua standard libraries
pub const Libs = switch (lang) {
.lua51, .luajit => Libs51,
.lua52 => Libs52,
.lua53, .lua54, .luau => Libs53,
};

/// The type of the opaque structure that points to a thread and the state of a Lua interpreter
pub const LuaState = c.lua_State;

Expand Down Expand Up @@ -2956,30 +2949,6 @@ pub const Lua = struct {

// Standard library loading functions

/// Opens the specified standard library functions
/// Behaves like openLibs, but allows specifying which libraries
/// to expose to the global table rather than all of them
/// See https://www.lua.org/manual/5.4/manual.html#luaL_openlibs
pub fn open(lua: *Lua, libs: Libs) void {
if (libs.base) lua.requireF("_G", c.luaopen_base, true);
if (libs.string) lua.requireF(c.LUA_STRLIBNAME, c.luaopen_string, true);
if (libs.table) lua.requireF(c.LUA_TABLIBNAME, c.luaopen_table, true);
if (libs.math) lua.requireF(c.LUA_MATHLIBNAME, c.luaopen_math, true);
if (libs.os) lua.requireF(c.LUA_OSLIBNAME, c.luaopen_os, true);
if (libs.debug) lua.requireF(c.LUA_DBLIBNAME, c.luaopen_debug, true);

if (lang != .luau) {
if (libs.io) lua.requireF(c.LUA_IOLIBNAME, c.luaopen_io, true);
if (libs.package) lua.requireF(c.LUA_LOADLIBNAME, c.luaopen_package, true);
}

if (lang != .lua51 and lang != .luajit and libs.coroutine) lua.requireF(c.LUA_COLIBNAME, c.luaopen_coroutine, true);

if ((lang == .lua53 or lang == .lua54) and libs.utf8) lua.requireF(c.LUA_UTF8LIBNAME, c.luaopen_utf8, true);

if (lang == .lua52 and libs.bit) lua.requireF(c.LUA_BITLIBNAME, c.luaopen_bit32, true);
}

/// Open all standard libraries
/// See https://www.lua.org/manual/5.4/manual.html#luaL_openlibs
pub fn openLibs(lua: *Lua) void {
Expand All @@ -2988,57 +2957,57 @@ pub const Lua = struct {

/// Open the basic standard library
pub fn openBase(lua: *Lua) void {
_ = c.luaopen_base(lua.state);
lua.requireF("_G", c.luaopen_base, true);
}

/// Open the coroutine standard library
pub fn openCoroutine(lua: *Lua) void {
_ = c.luaopen_coroutine(lua.state);
lua.requireF(c.LUA_COLIBNAME, c.luaopen_coroutine, true);
}

/// Open the package standard library
pub fn openPackage(lua: *Lua) void {
_ = c.luaopen_package(lua.state);
lua.requireF(c.LUA_LOADLIBNAME, c.luaopen_package, true);
}

/// Open the string standard library
pub fn openString(lua: *Lua) void {
_ = c.luaopen_string(lua.state);
lua.requireF(c.LUA_STRLIBNAME, c.luaopen_string, true);
}

/// Open the UTF-8 standard library
pub fn openUtf8(lua: *Lua) void {
_ = c.luaopen_utf8(lua.state);
lua.requireF(c.LUA_UTF8LIBNAME, c.luaopen_utf8, true);
}

/// Open the table standard library
pub fn openTable(lua: *Lua) void {
_ = c.luaopen_table(lua.state);
lua.requireF(c.LUA_TABLIBNAME, c.luaopen_table, true);
}

/// Open the math standard library
pub fn openMath(lua: *Lua) void {
_ = c.luaopen_math(lua.state);
lua.requireF(c.LUA_MATHLIBNAME, c.luaopen_math, true);
}

/// Open the io standard library
pub fn openIO(lua: *Lua) void {
_ = c.luaopen_io(lua.state);
lua.requireF(c.LUA_IOLIBNAME, c.luaopen_io, true);
}

/// Open the os standard library
pub fn openOS(lua: *Lua) void {
_ = c.luaopen_os(lua.state);
lua.requireF(c.LUA_OSLIBNAME, c.luaopen_os, true);
}

/// Open the debug standard library
pub fn openDebug(lua: *Lua) void {
_ = c.luaopen_debug(lua.state);
lua.requireF(c.LUA_DBLIBNAME, c.luaopen_debug, true);
}

/// Open the bit32 standard library
pub fn openBit32(lua: *Lua) void {
_ = c.luaopen_bit32(lua.state);
lua.requireF(c.LUA_BITLIBNAME, c.luaopen_bit32, true);
}

/// Returns if given typeinfo is a string type
Expand Down
24 changes: 4 additions & 20 deletions src/tests.zig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,22 +154,6 @@ test "standard library loading" {
lua.openLibs();
}

// open a subset of standard libraries with Zig wrapper
{
var lua = try Lua.init(&testing.allocator);
defer lua.deinit();

switch (ziglua.lang) {
.lua51 => lua.open(.{ .base = true, .package = true, .string = true, .table = true, .math = true, .io = true, .os = true, .debug = true }),
.lua52 => lua.open(.{ .base = true, .coroutine = true, .package = true, .string = true, .table = true, .math = true, .io = true, .os = true, .debug = true, .bit = true }),
.lua53, .lua54 => lua.open(.{ .base = true, .coroutine = true, .package = true, .string = true, .utf8 = true, .table = true, .math = true, .io = true, .os = true, .debug = true }),
.luau => lua.open(.{ .base = true, .coroutine = true, .string = true, .utf8 = true, .table = true, .math = true, .io = true, .os = true, .debug = true }),
.luajit => {
// TODO: why do tests crash?
},
}
}

// open all standard libraries with individual functions
// these functions are only useful if you want to load the standard
// packages into a non-standard table
Expand All @@ -184,8 +168,7 @@ test "standard library loading" {
lua.openOS();
lua.openDebug();

// TODO: why do these fail in lua51? Debugger shows it is on line with LUA_ENVIRONINDEX
if (ziglua.lang != .luau and ziglua.lang != .lua51 and ziglua.lang != .luajit) {
if (ziglua.lang != .luau) {
lua.openPackage();
lua.openIO();
}
Expand Down Expand Up @@ -631,7 +614,8 @@ test "global table" {
defer lua.deinit();

// open some libs so we can inspect them
lua.open(.{ .math = true, .base = true });
lua.openBase();
lua.openMath();
lua.pushGlobalTable();

// find the print function
Expand Down Expand Up @@ -1143,7 +1127,7 @@ test "closing vars" {
var lua = try Lua.init(&testing.allocator);
defer lua.deinit();

lua.open(.{ .base = true });
lua.openBase();

// do setup in Lua for ease
try lua.doString(
Expand Down
Loading