wartank/vendor/modernc.org/tk9.0/tk_purego.go

// Copyright 2024 The tk9.0-go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

//go:build (linux && (amd64 || arm64)) || (darwin && (amd64 || arm64)) || (freebsd && (amd64 || arm64))

package tk9_0 // import "modernc.org/tk9.0"

import (
	"errors"
	"fmt"
	"os"
	"path/filepath"
	"runtime"
	"strings"
	"testing"
	"unsafe"

	"github.com/ebitengine/purego"
	"github.com/evilsocket/islazy/zip"
	"modernc.org/memory"
)

var (
	// No mutex, the package must be used by a single goroutine only.
	allocator memory.Allocator

	createCommandProc uintptr
	deleteCommandProc uintptr
	evalExProc        uintptr
	getObjResultProc  uintptr
	getStringProc     uintptr
	interp            uintptr
	newStringObjProc  uintptr
	runCmdProxy       = purego.NewCallback(eventDispatcher)
	setObjResultProc  uintptr
	splitListProc     uintptr
	tclBinHandle      uintptr
	tkBinHandle       uintptr
)

func init() {
	if runtime.GOOS == "darwin" && !testing.Testing() {
		runtime.LockOSThread()
	}
}

func lazyInit() {
	if initialized {
		return
	}

	runtime.LockOSThread()
	initialized = true

	defer func() {
		// make sure we do not clobber global Error value.
		if Error != nil {
			return
		}
		commonLazyInit()
	}()

	var cacheDir string
	if cacheDir, Error = getCacheDir(); Error != nil {
		return
	}

	if bindLibs(cacheDir); Error != nil {
		return
	}

	switch goos {
	case "freebsd":
		a := []string{cacheDir, os.Getenv("LD_LIBRARY_PATH")}
		os.Setenv("LD_LIBRARY_PATH", strings.Join(a, string(os.PathSeparator)))
	}

	var nm uintptr
	if nm, Error = cString("eventDispatcher"); Error != nil {
		return
	}

	cmd, _, _ := purego.SyscallN(createCommandProc, interp, nm, runCmdProxy, 0, 0)
	if cmd == 0 {
		Error = fmt.Errorf("registering event dispatcher proxy failed: %v", getObjResultProc)
		return
	}

	setDefaults()
}

func bindLibs(cacheDir string) {
	var wd string
	if wd, Error = os.Getwd(); Error != nil {
		return
	}

	defer func() {
		Error = errors.Join(Error, os.Chdir(wd))
	}()

	if Error = os.Chdir(cacheDir); Error != nil {
		return
	}

	if tclBinHandle, Error = purego.Dlopen(filepath.Join(cacheDir, tclBin), purego.RTLD_LAZY|purego.RTLD_GLOBAL); Error != nil {
		return
	}

	if tkBinHandle, Error = purego.Dlopen(filepath.Join(cacheDir, tkBin), purego.RTLD_LAZY|purego.RTLD_GLOBAL); Error != nil {
		return
	}

	var tclCreateInterpProc, tclInitProc, tkInitProc uintptr
	if tclCreateInterpProc, Error = purego.Dlsym(tclBinHandle, "Tcl_CreateInterp"); Error != nil {
		return
	}

	if tclInitProc, Error = purego.Dlsym(tclBinHandle, "Tcl_Init"); Error != nil {
		return
	}

	if createCommandProc, Error = purego.Dlsym(tclBinHandle, "Tcl_CreateCommand"); Error != nil {
		return
	}

	if deleteCommandProc, Error = purego.Dlsym(tclBinHandle, "Tcl_DeleteCommand"); Error != nil {
		return
	}

	if evalExProc, Error = purego.Dlsym(tclBinHandle, "Tcl_EvalEx"); Error != nil {
		return
	}

	if setObjResultProc, Error = purego.Dlsym(tclBinHandle, "Tcl_SetObjResult"); Error != nil {
		return
	}

	if splitListProc, Error = purego.Dlsym(tclBinHandle, "Tcl_SplitList"); Error != nil {
		return
	}

	if getObjResultProc, Error = purego.Dlsym(tclBinHandle, "Tcl_GetObjResult"); Error != nil {
		return
	}

	if getStringProc, Error = purego.Dlsym(tclBinHandle, "Tcl_GetString"); Error != nil {
		return
	}

	if newStringObjProc, Error = purego.Dlsym(tclBinHandle, "Tcl_NewStringObj"); Error != nil {
		return
	}

	if tkInitProc, Error = purego.Dlsym(tkBinHandle, "Tk_Init"); Error != nil {
		return
	}

	if interp, _, _ = purego.SyscallN(tclCreateInterpProc); interp == 0 {
		Error = fmt.Errorf("failed to create a Tcl interpreter")
		return
	}

	if r, _, _ := purego.SyscallN(tclInitProc, interp); r != tcl_ok {
		Error = fmt.Errorf("failed to initialize the Tcl interpreter")
		return
	}

	if goos == "darwin" {
		if _, Error := eval("set tcl_interactive 0"); Error != nil {
			return
		}
	}

	fn := filepath.Join(cacheDir, fmt.Sprintf("lib%s.zip", libVersion))
	if _, Error := eval(fmt.Sprintf("zipfs mount %s /app", fn)); Error != nil {
		return
	}

	if r, _, _ := purego.SyscallN(tkInitProc, interp); r != tcl_ok {
		Error = fmt.Errorf("failed to initialize Tk: %s", tclResult())
		return
	}

	for _, dll := range moreDLLs {
		var handle, initProc uintptr
		if handle, Error = purego.Dlopen(filepath.Join(cacheDir, dll.dll), purego.RTLD_LAZY|purego.RTLD_GLOBAL); Error != nil {
			return
		}

		if initProc, Error = purego.Dlsym(handle, dll.initProc); Error != nil {
			return
		}

		r, _, _ := purego.SyscallN(initProc, interp)
		if r != tcl_ok {
			Error = fmt.Errorf("failed to initialize %s: %s", dll.dll, tclResult())
			return
		}
	}
}

func getCacheDir() (r string, err error) {
	if r, err = os.UserCacheDir(); err != nil {
		return "", err
	}

	r0 := filepath.Join(r, "modernc.org", libVersion, goos)
	r = filepath.Join(r0, goarch)
	fi, err := os.Stat(r)
	if err == nil && fi.IsDir() {
		if checkSig(r, shasig) {
			return r, nil
		}

		os.RemoveAll(r) // Tampered or corrupted.
	}

	os.MkdirAll(r0, 0700)
	tmp, err := os.MkdirTemp(r0, "")
	if err != nil {
		return "", err
	}

	zf := filepath.Join(tmp, "lib.zip")
	if err = os.WriteFile(zf, libZip, 0660); err != nil {
		return "", err
	}

	if _, err = zip.Unzip(zf, tmp); err != nil {
		os.Remove(zf)
		return "", err
	}

	os.Remove(zf)
	if err = os.Rename(tmp, r); err == nil {
		return r, nil
	}

	cleanupDirs = append(cleanupDirs, tmp)
	return tmp, nil
}

// Finalize releases all resources held, if any. This may include temporary
// files. Finalize is intended to be called on process shutdown only.
func Finalize() (err error) {
	if finished.Swap(1) != 0 {
		return
	}

	defer runtime.UnlockOSThread()

	for _, v := range cleanupDirs {
		err = errors.Join(err, os.RemoveAll(v))
	}
	return err
}

func eval(code string) (r string, err error) {
	if dmesgs {
		defer func() {
			dmesg("code=%s -> r=%v err=%v", code, r, err)
		}()
	}

	if !initialized {
		lazyInit()
		if Error != nil {
			return "", Error
		}
	}

	cs, err := cString(code)
	if err != nil {
		return "", err
	}

	defer allocator.UintptrFree(cs)

	switch r0, _, _ := purego.SyscallN(evalExProc, interp, cs, uintptr(len(code)), tcl_eval_direct); r0 {
	case tcl_ok, tcl_return:
		return tclResult(), nil
	default:
		return "", fmt.Errorf("%s", tclResult())
	}

}

func tclResult() string {
	r, _, _ := purego.SyscallN(getObjResultProc, interp)
	if r == 0 {
		return ""
	}

	if r, _, _ = purego.SyscallN(getStringProc, r); r != 0 {
		return goString(r)
	}

	return ""
}

func cString(s string) (r uintptr, err error) {
	if s == "" {
		return 0, nil
	}

	if r, err = allocator.UintptrMalloc(len(s) + 1); err != nil {
		return 0, err
	}

	copy(unsafe.Slice((*byte)(unsafe.Pointer(r)), len(s)), s)
	*(*byte)(unsafe.Add(unsafe.Pointer(r), len(s))) = 0
	return r, nil
}

func eventDispatcher(clientData, in uintptr, argc int32, argv uintptr) uintptr {
	if argc < 2 {
		setResult(fmt.Sprintf("eventDispatcher internal error: argc=%v", argc))
		return tcl_error
	}

	arg1 := goTransientString(*(*uintptr)(unsafe.Pointer(argv + unsafe.Sizeof(uintptr(0)))))
	id, e, err := newEvent(arg1)
	if err != nil {
		setResult(fmt.Sprintf("eventDispatcher internal error: argv[1]=%q, err=%v", arg1, err))
		return tcl_error
	}

	h := handlers[int32(id)]
	e.W = h.w
	for i := int32(2); i < argc; i++ {
		e.args = append(e.args, goString(*(*uintptr)(unsafe.Pointer(argv + uintptr(i)*unsafe.Sizeof(uintptr(0))))))
	}
	switch h.callback(e); {
	case e.Err != nil:
		setResult(tclSafeString(e.Err.Error()))
		return tcl_error
	default:
		if setResult(e.Result) != nil {
			return tcl_error
		}

		return uintptr(e.returnCode)
	}
}

func goTransientString(p uintptr) (r string) { // Result cannot be retained.
	if p == 0 {
		return ""
	}

	var n uintptr
	for p := p; *(*byte)(unsafe.Pointer(p + n)) != 0; n++ {
	}
	return string(unsafe.Slice((*byte)(unsafe.Pointer(p)), n))
}

func setResult(s string) (err error) {
	cs, err := cString(s)
	if err != nil {
		return err
	}

	defer allocator.UintptrFree(cs)

	obj, _, _ := purego.SyscallN(newStringObjProc, cs, uintptr(len(s)))
	if obj == 0 {
		return fmt.Errorf("OOM")
	}

	purego.SyscallN(setObjResultProc, interp, obj)
	return nil
}

func callSplitList(cList uintptr, argcPtr uintptr, argvPtr uintptr) (r1 uintptr, r2 uintptr, err uintptr) {
	return purego.SyscallN(splitListProc, interp, cList, argcPtr, argvPtr)
}

// Internal malloc enabling parseList() in tk.go to not care about the target
// specific implemetations.
func malloc(sz int) (r uintptr, err error) {
	return allocator.UintptrMalloc(sz)
}

// Internal free enabling parseList() in tk.go to not care about the target
// specific implemetations.
func free(p uintptr) (err error) {
	return allocator.UintptrFree(p)
}