FFI-to-LLS - Automatically generate LuaLS declarations from LuaJIT FFI declarations

[Frityet]

repo

Example

Given the a definitions file such as:

struct MyStruct {
  int a;
  int b;
};

struct MyStruct *mylib_MyStruct_create(int a, int b);

void mylib_MyStruct_free(struct MyStruct *s);

We can generate definitions with

luajit ffi-to-lls.lua mylib.h -o mylib.lua --remove-prefix mylib_

A file like this would be generated:

---Automatically generated bindings generated by ffi-to-lls.lua (https://github.com/Frityet/ffi-to-lls/)
---You can edit this file!
---The following prefix was removed: `mylib_`
---Lua language server will autocomplete both with and without the prefix.
---@meta mylib

---You may remove this, or generate this file again with --no-auxiliary-types, to supress redefinition warnings
---@class c.pointer<T> : { [integer] : T }, ffi.cdata*
---@class mylib
local mylib = {}

---@class MyStruct
---@field a integer
---@field b integer

---@param a integer
---@param b integer
---@return c.pointer<MyStruct>
function mylib.mylib_MyStruct_create(a, b) end
mylib.MyStruct_create = mylib.mylib_MyStruct_create

---@param s c.pointer<MyStruct>
---@return nil
function mylib.mylib_MyStruct_free(s) end
mylib.MyStruct_free = mylib.mylib_MyStruct_free

return mylib