feat: restructure and add Lua 5.3, 5.2, and 5.1

Restructures the source layout and adds three new versions of Lua.
Documentation is still incomplete at this point, but all four supported
versions are well tested.

Author: natecraddock

build.zig

@@ -3,12 +3,36 @@ const std = @import("std");
 const Builder = std.build.Builder;
 const LibExeObjStep = std.build.LibExeObjStep;
 
+const LuaVersion = enum {
+    lua_51,
+    lua_52,
+    lua_53,
+    lua_54,
+    lua_jit,
+};
+
+fn libPath(version: LuaVersion) []const u8 {
+    return switch (version) {
+        .lua_51 => "src/ziglua-5.1/lib.zig",
+        .lua_52 => "src/ziglua-5.2/lib.zig",
+        .lua_53 => "src/ziglua-5.3/lib.zig",
+        .lua_54 => "src/ziglua-5.4/lib.zig",
+        else => unreachable,
+        // .lua_jit => "src/ziglua-jit/lib.zig",
+    };
+}
+
 pub fn build(b: *Builder) void {
-    const mode = b.standardReleaseOptions();
+    const version = b.option(LuaVersion, "version", "lua version to test") orelse .lua_54;
 
-    const tests = b.addTest("src/tests.zig");
-    link(b, tests, .{ .use_apicheck = true });
-    tests.setBuildMode(mode);
+    const tests = b.addTest(switch (version) {
+        .lua_51 => "src/ziglua-5.1/tests.zig",
+        .lua_52 => "src/ziglua-5.2/tests.zig",
+        .lua_53 => "src/ziglua-5.3/tests.zig",
+        .lua_54 => "src/ziglua-5.4/tests.zig",
+        else => unreachable,
+    });
+    link(b, tests, libPath(version), .{ .use_apicheck = true, .version = version });
 
     const test_step = b.step("test", "Run ziglua library tests");
     test_step.dependOn(&tests.step);
@@ -21,19 +45,41 @@ fn dir() []const u8 {
 const Options = struct {
     /// Defines the macro LUA_USE_APICHECK in debug builds
     use_apicheck: bool = false,
+    /// Defines the Lua version to build and link
+    version: LuaVersion = .lua_54,
 };
 
-pub fn link(b: *Builder, step: *LibExeObjStep, options: Options) void {
-    const lib = buildLua(b, step, options);
+pub fn linkAndPackage(b: *Builder, step: *LibExeObjStep, options: Options) std.build.Pkg {
+    const lib_path = libPath(options.version);
+    link(b, step, lib_path, options);
+
+    return .{
+        .name = "ziglua",
+        .path = .{ .path = std.fs.path.join(b.allocator, &.{ dir(), lib_path }) catch unreachable },
+    };
+}
+
+// TODO: expose the link and package steps separately for advanced use cases?
+fn link(b: *Builder, step: *LibExeObjStep, lib_path: []const u8, options: Options) void {
+    const lib = buildLua(b, step, lib_path, options);
     step.linkLibrary(lib);
     step.linkLibC();
 }
 
-const lib_dir = "lib/lua-5.4.4/src/";
+// TODO: how to test all versions? May need a make/help script to test all
+// versions separately because there might be name collisions
+fn buildLua(b: *Builder, step: *LibExeObjStep, lib_path: []const u8, options: Options) *LibExeObjStep {
+    const lib_dir = switch (options.version) {
+        .lua_51 => "lib/lua-5.1.5/src/",
+        .lua_52 => "lib/lua-5.2.4/src/",
+        .lua_53 => "lib/lua-5.3.6/src/",
+        .lua_54 => "lib/lua-5.4.4/src/",
+        else => unreachable,
+        // .lua_jit => "lib/lua-5.4.4/src/",
+    };
 
-fn buildLua(b: *Builder, step: *LibExeObjStep, options: Options) *LibExeObjStep {
-    const lib_path = std.fs.path.join(b.allocator, &.{ dir(), "src/ziglua.zig" }) catch unreachable;
-    const lib = b.addStaticLibrary("lua", lib_path);
+    const absolute_lib_path = std.fs.path.join(b.allocator, &.{ dir(), lib_path }) catch unreachable;
+    const lib = b.addStaticLibrary("lua", absolute_lib_path);
     lib.setBuildMode(step.build_mode);
     lib.setTarget(step.target);
 
@@ -59,15 +105,127 @@ fn buildLua(b: *Builder, step: *LibExeObjStep, options: Options) *LibExeObjStep
         if (apicheck) "-DLUA_USE_APICHECK" else "",
     };
 
-    inline for (lua_source_files) |file| {
-        const path = std.fs.path.join(b.allocator, &.{ dir(), lib_dir ++ file }) catch unreachable;
+    const lua_source_files = switch (options.version) {
+        .lua_51 => &lua_51_source_files,
+        .lua_52 => &lua_52_source_files,
+        .lua_53 => &lua_53_source_files,
+        .lua_54 => &lua_54_source_files,
+        else => unreachable,
+        // .lua_jit => &lua_jit_source_files,
+    };
+
+    for (lua_source_files) |file| {
+        const path = std.fs.path.join(b.allocator, &.{ dir(), lib_dir, file }) catch unreachable;
         step.addCSourceFile(path, &flags);
     }
 
     return lib;
 }
 
-const lua_source_files = [_][]const u8{
+const lua_51_source_files = [_][]const u8 {
+    "lapi.c",
+    "lcode.c",
+    "ldebug.c",
+    "ldo.c",
+    "ldump.c",
+    "lfunc.c",
+    "lgc.c",
+    "llex.c",
+    "lmem.c",
+    "lobject.c",
+    "lopcodes.c",
+    "lparser.c",
+    "lstate.c",
+    "lstring.c",
+    "ltable.c",
+    "ltm.c",
+    "lundump.c",
+    "lvm.c",
+    "lzio.c",
+    "lauxlib.c",
+    "lbaselib.c",
+    "ldblib.c",
+    "liolib.c",
+    "lmathlib.c",
+    "loslib.c",
+    "ltablib.c",
+    "lstrlib.c",
+    "loadlib.c",
+    "linit.c",
+};
+
+const lua_52_source_files = [_][]const u8 {
+    "lapi.c",
+    "lcode.c",
+    "lctype.c",
+    "ldebug.c",
+    "ldo.c",
+    "ldump.c",
+    "lfunc.c",
+    "lgc.c",
+    "llex.c",
+    "lmem.c",
+    "lobject.c",
+    "lopcodes.c",
+    "lparser.c",
+    "lstate.c",
+    "lstring.c",
+    "ltable.c",
+    "ltm.c",
+    "lundump.c",
+    "lvm.c",
+    "lzio.c",
+    "lauxlib.c",
+    "lbaselib.c",
+    "lbitlib.c",
+    "lcorolib.c",
+    "ldblib.c",
+    "liolib.c",
+    "lmathlib.c",
+    "loslib.c",
+    "lstrlib.c",
+    "ltablib.c",
+    "loadlib.c",
+    "linit.c",
+};
+
+const lua_53_source_files = [_][]const u8{
+    "lapi.c",
+    "lcode.c",
+    "lctype.c",
+    "ldebug.c",
+    "ldo.c",
+    "ldump.c",
+    "lfunc.c",
+    "lgc.c",
+    "llex.c",
+    "lmem.c",
+    "lobject.c",
+    "lopcodes.c",
+    "lparser.c",
+    "lstate.c",
+    "lstring.c",
+    "ltable.c",
+    "ltm.c",
+    "lundump.c",
+    "lvm.c",
+    "lzio.c",
+    "lauxlib.c",
+    "lbaselib.c",
+    "lbitlib.c",
+    "lcorolib.c",
+    "ldblib.c",
+    "liolib.c",
+    "lmathlib.c",
+    "loslib.c",
+    "lstrlib.c",
+    "ltablib.c",
+    "lutf8lib.c",
+    "loadlib.c",
+    "linit.c",
+};
+
+const lua_54_source_files = [_][]const u8{
     "lapi.c",
     "lcode.c",
     "lctype.c",

docs.md

@@ -108,11 +108,10 @@ Both `lua_pcall` and `lua_pcallk` are expanded to `protectedCall` and `protected
 
 ## Build Documentation
 
-When integrating ziglua into your projects, the following three statements are required:
+When integrating ziglua into your projects, the following two statements are required:
 
 1. `@import()` the `build.zig` file
-2. `addPackagePath` the ziglua api
-3. `ziglua.link()` the library with your executable
+2. `addPackage()` the ziglua api
 
 Note that this _must_ be done after setting the target and build mode, otherwise ziglua will not know that information.
 
@@ -121,15 +120,24 @@ const ziglua = @import("lib/ziglua/build.zig");
 
 pub fn build(b: *Builder) void {
     ...
-    exe.addPackagePath("ziglua", "lib/ziglua/src/ziglua.zig");
-    ziglua.link(b, exe, .{});
+    exe.addPackage(ziglua.linkAndPackage(b, exe, .{}));
 }
 ```
 
-There is currently one option that can be passed in the third argument to `ziglua.link()`:
+This makes the `ziglua` package available in your project. Access with `@import("ziglua")`.
+
+There are currently two options that can be passed in the third argument to `ziglua.link()`:
 
 * `.use_apicheck`: defaults to **false**. When **true** defines the macro `LUA_USE_APICHECK` in debug builds. See [The C API docs](https://www.lua.org/manual/5.4/manual.html#4) for more information on this macro.
 
+* `.version`: Set the Lua version to build and embed. Defaults to `.lua_54`. Possible values are `.lua_51`, `.lua_52`, `.lua_53`, and `.lua_54`.
+
+For example, here is a `ziglua.linkAndPackage()` call that enables api check and embeds Lua 5.2:
+
+```
+exe.addPackage(ziglua.linkAndPackage(b, exe, .{ .use_apicheck = true, .version = .lua_52 }));
+```
+
 ## Examples
 
 Here are more thorough examples that show off the ziglua bindings in context. All examples use previously documented [`build.zig`](#build-documentation) setup.

lib/lua-5.1.5/COPYRIGHT

@@ -0,0 +1,34 @@
+Lua License
+-----------
+
+Lua is licensed under the terms of the MIT license reproduced below.
+This means that Lua is free software and can be used for both academic
+and commercial purposes at absolutely no cost.
+
+For details and rationale, see http://www.lua.org/license.html .
+
+===============================================================================
+
+Copyright (C) 1994-2012 Lua.org, PUC-Rio.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+===============================================================================
+
+(end of COPYRIGHT)