Implement high-level Lua APIs

.gitignore

@@ -20,5 +20,8 @@
 # Build script compiled data
 .lei/
 
+# Cgo generated files
+_obj/
+
 # Dependency directories (remove the comment below to include it)
 # vendor/

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "internal/luau"]
-	path = internal/luau
-	url = https://github.com/luau-lang/luau
 [submodule "ffi/luau"]
 	path = ffi/luau
 	url = https://github.com/luau-lang/luau.git

build/build.go

@@ -1,152 +1,49 @@
 package main
 
 import (
-	"fmt"
+	"log"
 	"os"
-	"path"
 	"strings"
-
-	"github.com/gookit/color"
-	"golang.org/x/term"
 )
 
-const LUAU_VERSION = "0.634"
-const ARTIFACT_NAME = "libLuau.VM.a"
-
-func bail(err error) {
-	if err != nil {
-		panic(err)
-	}
-}
-
-func cloneSrc() string {
-	color.Blue.Println("> Cloning luau-lang/luau")
-
-	dir, tempDirErr := os.MkdirTemp("", "lei-build")
-	bail(tempDirErr)
-
-	// Clone down the Luau repo and checkout the required tag
-	Exec("git", "", "clone", "https://github.com/luau-lang/luau.git", dir)
-	Exec("git", dir, "checkout", LUAU_VERSION)
-
-	color.Green.Printf("> Cloned repo to%s\n\n", dir)
-	return dir
-}
-
-func buildVm(srcPath string, artifactPath string, includesDir string, cmakeFlags ...string) {
-	color.Blue.Println("> Compile libLuau.VM.a")
-
-	// Build the Luau VM using CMake
-	buildDir := path.Join(srcPath, "cmake")
-	buildDirErr := os.Mkdir(buildDir, os.ModePerm)
-	if !os.IsExist(buildDirErr) {
-		bail(buildDirErr)
-	}
-
-	defaultCmakeFlags := []string{"..", "-DCMAKE_BUILD_TYPE=RelWithDebInfo", "-DLUAU_EXTERN_C=ON", "-DCMAKE_POLICY_VERSION_MINIMUM=3.5"}
-	Exec("cmake", buildDir, append(defaultCmakeFlags, cmakeFlags...)...)
-	Exec("cmake", buildDir, "--build", ".", "--target Luau.VM", "--config", "RelWithDebInfo")
-
-	color.Green.Println("> Successfully compiled!\n")
-
-	// Copy the artifact to the artifact directory
-	artifactFile, artifactErr := os.ReadFile(path.Join(buildDir, ARTIFACT_NAME))
-	bail(artifactErr)
-	bail(os.WriteFile(artifactPath, artifactFile, os.ModePerm))
-
-	// Copy the header files into the includes directory
-	headerDir := path.Join(srcPath, "VM", "include")
-	headerFiles, headerErr := os.ReadDir(headerDir)
-	bail(headerErr)
-	for _, file := range headerFiles {
-		src := path.Join(headerDir, file.Name())
-		dest := path.Join(includesDir, file.Name())
-
-		headerContents, headerReadErr := os.ReadFile(src)
-		bail(headerReadErr)
-
-		os.WriteFile(dest, headerContents, os.ModePerm)
-	}
-}
-
 func main() {
-	workDir, workDirErr := os.Getwd()
-	bail(workDirErr)
-
-	artifactDir := path.Join(workDir, ".lei")
-	artifactPath := path.Join(artifactDir, ARTIFACT_NAME)
-	lockfilePath := path.Join(artifactDir, ".lock")
-	includesDir := path.Join(artifactDir, "includes")
-
-	bail(os.MkdirAll(includesDir, os.ModePerm)) // includesDir is the deepest dir, creates all
-
-	gitignore, gitignoreErr := os.ReadFile(".gitignore")
-	if gitignoreErr == nil && !strings.Contains(string(gitignore), ".lei") {
-		color.Yellow.Println("> WARN: The gitignore in the CWD does not include `.lei`, consider adding it")
+	usage := func() { log.Fatal("Usage: buildProject <projects...>") }
+	if len(os.Args) < 2 {
+		usage()
 	}
 
-	// TODO: Args for clean build
-	args := os.Args[1:]
-
-	goArgs := []string{}
-	cmakeFlags := []string{}
-	features := []string{}
+	switch os.Args[1] {
+	case "buildProject":
+		for _, project := range os.Args[2:] {
+			if !strings.HasPrefix(project, "Luau.") {
+				log.Fatalf("Invalid project name: %s", project)
+			}
 
-	// TODO: maybe use env vars for this config instead
-	for _, arg := range args {
-		if arg == "--enable-vector4" {
-			features = append(features, "LUAU_VECTOR4")
-			// FIXME: This flag apparently isn't recognized by cmake for some reason
-			cmakeFlags = append(cmakeFlags, "-DLUAU_VECTOR_SIZE=4")
-
-		} else {
-			goArgs = append(goArgs, arg)
+			compileLuauProject(project)
 		}
-	}
 
-	lockfileContents, err := os.ReadFile(lockfilePath)
-	if !os.IsNotExist(err) {
-		bail(err)
+	// Display usage menu
+	case "-h", "--help":
+		fallthrough
+	default:
+		usage()
 	}
+}
 
-	serFeatures := fmt.Sprintf("%v", features)
-	toCleanBuild := (string(lockfileContents) != serFeatures) || os.Getenv("LEI_CLEAN_BUILD") == "true"
-	if _, err := os.Stat(artifactPath); err == nil && !toCleanBuild {
-		fmt.Printf("[build] Using existing artifact at %s\n", artifactPath)
-	} else {
-		srcPath, notUnset := os.LookupEnv("LEI_LUAU_SRC")
-		if !notUnset {
-			srcPath = cloneSrc()
-			defer os.RemoveAll(srcPath)
-		}
-
-		buildVm(srcPath, artifactPath, includesDir, cmakeFlags...)
-		bail(os.WriteFile(lockfilePath, []byte(serFeatures), os.ModePerm))
-	}
+func compileLuauProject(project string) {
+	if err := os.Mkdir("_obj", os.ModePerm); err == nil || !os.IsExist(err) {
+		// Directory already exists, i.e., config files generated
+		Exec(
+			"cmake",
+			"-S", "luau",
+			"-B", "_obj",
+			"-G", "Ninja",
 
-	buildTags := []string{}
-	if len(features) > 0 {
-		buildTags = append(buildTags, []string{"-tags", strings.Join(features, ",")}...)
+			// Flags
+			"-DCMAKE_BUILD_TYPE=RelWithDebInfo",
+			"-DLUAU_EXTERN_C=ON",
+		)
 	}
 
-	w, _, termErr := term.GetSize(int(os.Stdout.Fd()))
-	bail(termErr)
-	fmt.Println(strings.Repeat("=", w))
-
-	subcommand := goArgs[0]
-	goArgs = goArgs[1:]
-	combinedArgs := append(buildTags, goArgs...)
-	cmd, _, _, _ := Command("go").
-		WithArgs(append([]string{subcommand}, combinedArgs...)...).
-		WithVar(
-			"CGO_LDFLAGS",
-			fmt.Sprintf("-L %s -lLuau.VM -lm -lstdc++", artifactDir),
-		).
-		WithVar("CGO_CFLAGS", fmt.Sprintf("-I%s", includesDir)).
-		WithVar("CGO_ENABLED", "1").
-		PipeAll(Forward).
-		ToCommand()
-
-	bail(cmd.Start())
-	bail(cmd.Wait())
+	Exec("cmake", "--build", "_obj", "-t", project, "--config", "RelWithDebInfo")
 }

build/cmd.go

@@ -3,8 +3,10 @@ package main
 import (
 	"bytes"
 	"io"
+	"log"
 	"os"
 	"os/exec"
+	"strings"
 )
 
 type CommandPipeMode int
@@ -127,17 +129,23 @@ func pipeModeToWriter(mode CommandPipeMode, def io.Writer) io.Writer {
 	}
 }
 
-func Exec(name string, dir string, args ...string) {
-	cmd, _, _, _ := Command(name).WithArgs(args...).Dir(dir).PipeAll(Forward).ToCommand()
-	startErr := cmd.Start()
-	if startErr != nil {
-		panic(startErr)
+func Exec(exe string, args ...string) {
+	cmd, _, _, _ := Command(exe).
+		WithArgs(args...).
+		WithVar("CLICOLOR_FORCE", "1").
+		PipeAll(Forward).
+		ToCommand()
+
+	if err := cmd.Start(); err != nil {
+		log.Fatalf("Failed to start command %s: %v", exe, err)
 	}
 
-	cmdErr := cmd.Wait()
-	if cmdErr != nil {
-		panic(cmdErr)
-		// err := cmdErr.(*exec.ExitError)
-		// os.Exit(err.ExitCode())
+	if err := cmd.Wait(); err != nil {
+		if exitErr, ok := err.(*exec.ExitError); ok {
+			commandStr := strings.Join(append([]string{exe}, args...), " ")
+			log.Fatalf("'%s' exited with %d", commandStr, exitErr.ExitCode())
+		}
+
+		log.Fatalf("%s command failed: %v", exe, err)
 	}
 }

doc.go

@@ -0,0 +1,3 @@
+// Root package. Use `ffi` or `lua` modules for low-level bindings
+// or high-level APIs respectively.
+package main

ffi/bytecode.go

@@ -0,0 +1,23 @@
+package ffi
+
+/*
+#cgo CFLAGS: -Iluau/Common/include
+#include "Luau/Bytecode.h"
+
+enum LuauBytecodeTag LuauBytecodeTag;
+*/
+import "C"
+
+//
+// Version Constants
+//
+
+const (
+	LBC_VERSION_MIN    = C.LBC_VERSION_MIN
+	LBC_VERSION_MAX    = C.LBC_VERSION_MAX
+	LBC_VERSION_TARGET = C.LBC_VERSION_TARGET
+
+	LBC_TYPE_VERSION_MIN    = C.LBC_TYPE_VERSION_MIN
+	LBC_TYPE_VERSION_MAX    = C.LBC_TYPE_VERSION_MAX
+	LBC_TYPE_VERSION_TARGET = C.LBC_TYPE_VERSION_TARGET
+)

ffi/clua.c

@@ -1,6 +1,5 @@
 #include <stdio.h>
-#include <lua.h>
-#include <_cgo_export.h>
+#include "luau/VM/include/lua.h" 
 
 // void* clua_alloc(void* ud, void *ptr, size_t osize, size_t nsize)
 // {

ffi/clua.h

@@ -1,5 +1,5 @@
 #include <stdlib.h>
-#include <lua.h>
+#include "luau/VM/include/lua.h" 
 
 lua_State* clua_newstate(void* f, void* ud);
 l_noret cluaL_errorL(lua_State* L, char* msg);

ffi/lauxlib.go

@@ -1,8 +1,10 @@
 package ffi
 
+//go:generate go run ../build buildProject Luau.VM
+
 /*
-#cgo CFLAGS: -Iluau/VM/include -I/usr/lib/gcc/x86_64-pc-linux-gnu/14.1.1/include
-#cgo LDFLAGS: -Lluau/cmake -lLuau.VM -lm -lstdc++
+#cgo CFLAGS: -Iluau/VM/include
+#cgo LDFLAGS: -L_obj -lLuau.VM -lm -lstdc++
 #include <lua.h>
 #include <lualib.h>
 #include <stdlib.h>
@@ -66,8 +68,6 @@ func LArgError(L *LuaState, narg int32, extramsg string) {
 
 func LCheckLString(L *LuaState, narg int32, l *uint64) string {
 	p := C.luaL_checklstring(L, C.int(narg), (*C.size_t)(l))
-	defer C.free(unsafe.Pointer(p))
-
 	return C.GoString(p)
 }
 
@@ -76,8 +76,6 @@ func LOptLString(L *LuaState, narg int32, def string, l *uint64) string {
 	defer C.free(unsafe.Pointer(cdef))
 
 	p := C.luaL_optlstring(L, C.int(narg), cdef, (*C.ulong)(l))
-	defer C.free(unsafe.Pointer(p))
-
 	return C.GoString(p)
 }
 
@@ -238,31 +236,29 @@ func LOptString(L *LuaState, n int32, d string) string {
 }
 
 const (
-	LUA_COLIBNAME     = "coroutine"
-	LUA_TABLIBNAME    = "table"
-	LUA_OSLIBNAME     = "os"
-	LUA_STRLIBNAME    = "string"
-	LUA_BITLIBNAME    = "bit32"
-	LUA_BUFFERLIBNAME = "buffer"
-	LUA_UTF8LIBNAME   = "utf8"
-	LUA_MATHLIBNAME   = "math"
-	LUA_DBLIBNAME     = "debug"
+	LUA_COLIBNAME     = C.LUA_COLIBNAME
+	LUA_TABLIBNAME    = C.LUA_TABLIBNAME
+	LUA_OSLIBNAME     = C.LUA_OSLIBNAME
+	LUA_STRLIBNAME    = C.LUA_STRLIBNAME
+	LUA_BITLIBNAME    = C.LUA_BITLIBNAME
+	LUA_BUFFERLIBNAME = C.LUA_BUFFERLIBNAME
+	LUA_UTF8LIBNAME   = C.LUA_UTF8LIBNAME
+	LUA_MATHLIBNAME   = C.LUA_MATHLIBNAME
+	LUA_DBLIBNAME     = C.LUA_DBLIBNAME
+	LUA_VECLIBNAME    = C.LUA_VECLIBNAME
 )
 
-// DIVERGENCE: We cannot export wrapper functions around C functions if we want to
-// pass them to API functions, we preserve the real C pointer by having 'opener'
-// functions
-
-func CoroutineOpener() C.lua_CFunction { return C.lua_CFunction(C.luaopen_base) }
-func BaseOpener() C.lua_CFunction      { return C.lua_CFunction(C.luaopen_base) }
-func TableOpener() C.lua_CFunction     { return C.lua_CFunction(C.luaopen_table) }
-func OsOpener() C.lua_CFunction        { return C.lua_CFunction(C.luaopen_os) }
-func StringOpener() C.lua_CFunction    { return C.lua_CFunction(C.luaopen_string) }
-func Bit32Opener() C.lua_CFunction     { return C.lua_CFunction(C.luaopen_bit32) }
-func BufferOpener() C.lua_CFunction    { return C.lua_CFunction(C.luaopen_buffer) }
-func Utf8Opener() C.lua_CFunction      { return C.lua_CFunction(C.luaopen_utf8) }
-func MathOpener() C.lua_CFunction      { return C.lua_CFunction(C.luaopen_math) }
-func DebugOpener() C.lua_CFunction     { return C.lua_CFunction(C.luaopen_debug) }
-func LibsOpener() C.lua_CFunction      { return C.lua_CFunction(C.luaL_openlibs) }
+func OpenBase(L *LuaState)      { C.luaopen_base(L) }
+func OpenCoroutine(L *LuaState) { C.luaopen_coroutine(L) }
+func OpenTable(L *LuaState)     { C.luaopen_table(L) }
+func OpenOs(L *LuaState)        { C.luaopen_os(L) }
+func OpenString(L *LuaState)    { C.luaopen_string(L) }
+func OpenBit32(L *LuaState)     { C.luaopen_bit32(L) }
+func OpenBuffer(L *LuaState)    { C.luaopen_buffer(L) }
+func OpenUtf8(L *LuaState)      { C.luaopen_utf8(L) }
+func OpenMath(L *LuaState)      { C.luaopen_math(L) }
+func OpenDebug(L *LuaState)     { C.luaopen_debug(L) }
+func OpenVector(L *LuaState)    { C.luaopen_vector(L) }
+func LOpenLibs(L *LuaState)     { C.luaL_openlibs(L) }
 
 // TODO: More utility functions, buffer bindings