koffi 0.9.16 → 0.9.17

package/README.md

@@ -63,6 +63,8 @@ npm install koffi
 
 This section assumes you know how to build C shared libraries.
 
+## Raylib example
+
 This examples illustrates how to use Koffi with a Raylib shared library:
 
 ```js
@@ -123,17 +125,17 @@ const Font = koffi.struct('Font', {
 // Fix the path to Raylib DLL if needed
 let lib = koffi.load('build/raylib' + (process.platform == 'win32' ? '.dll' : '.so'));
 
-const InitWindow = lib.func('InitWindow', 'void', ['int', 'int', 'string']);
-const SetTargetFPS = lib.func('SetTargetFPS', 'void', ['int']);
-const GetScreenWidth = lib.func('GetScreenWidth', 'int', []);
-const GetScreenHeight = lib.func('GetScreenHeight', 'int', []);
-const ClearBackground = lib.func('ClearBackground', 'void', [Color]);
-const BeginDrawing = lib.func('BeginDrawing', 'void', []);
-const EndDrawing = lib.func('EndDrawing', 'void', []);
-const WindowShouldClose = lib.func('WindowShouldClose', 'bool', []);
-const GetFontDefault = lib.func('GetFontDefault', Font, []);
-const MeasureTextEx = lib.func('MeasureTextEx', Vector2, [Font, 'string', 'float', 'float']);
-const DrawTextEx = lib.func('DrawTextEx', 'void', [Font, 'string', Vector2, 'float', 'float', Color]);
+const InitWindow = lib.cdecl('InitWindow', 'void', ['int', 'int', 'string']);
+const SetTargetFPS = lib.cdecl('SetTargetFPS', 'void', ['int']);
+const GetScreenWidth = lib.cdecl('GetScreenWidth', 'int', []);
+const GetScreenHeight = lib.cdecl('GetScreenHeight', 'int', []);
+const ClearBackground = lib.cdecl('ClearBackground', 'void', [Color]);
+const BeginDrawing = lib.cdecl('BeginDrawing', 'void', []);
+const EndDrawing = lib.cdecl('EndDrawing', 'void', []);
+const WindowShouldClose = lib.cdecl('WindowShouldClose', 'bool', []);
+const GetFontDefault = lib.cdecl('GetFontDefault', Font, []);
+const MeasureTextEx = lib.cdecl('MeasureTextEx', Vector2, [Font, 'string', 'float', 'float']);
+const DrawTextEx = lib.cdecl('DrawTextEx', 'void', [Font, 'string', Vector2, 'float', 'float', Color]);
 
 InitWindow(800, 600, 'Test Raylib');
 SetTargetFPS(60);
@@ -170,6 +172,18 @@ while (!WindowShouldClose()) {
 
 ```
 
+## Win32 (\__stdcall) example
+
+```js
+const koffi = require('koffi');
+
+let lib = koffi.load('user32.dll');
+
+const MessageBoxA = lib.stdcall('MessageBoxA', 'int', ['void *', 'string', 'string', 'uint']);
+
+MessageBoxA(null, 'Hello', 'Foobar', 0x40); // MB_ICONINFORMATION
+```
+
 # Tests
 
 Koffi is tested on multiple architectures using emulated (accelerated when possible) QEMU machines. First, you need to install qemu packages, such as `qemu-system` (or even `qemu-system-gui`) on Ubuntu.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koffi",
-  "version": "0.9.16",
+  "version": "0.9.17",
   "description": "Fast and simple FFI (foreign function interface) for Node.js",
   "keywords": [
     "foreign",

package/src/call_x86.cc

@@ -39,17 +39,10 @@ bool AnalyseFunction(InstanceData *instance, FunctionInfo *func)
 #endif
     }
 
-    Size params_size = 0;
     for (const ParameterInfo &param: func->parameters) {
-        params_size += std::max((int16_t)4, param.type->size);
+        func->args_size += std::max((int16_t)4, param.type->size);
     }
-    func->args_size = params_size + 4 * !func->ret.trivial;
-
-#ifdef _WIN32
-    if (func->convention == CallConvention::Stdcall) {
-        func->decorated_name = Fmt(&instance->str_alloc, "_%1@%2", func->name, params_size).ptr;
-    }
-#endif
+    func->args_size += 4 * !func->ret.trivial;
 
     return true;
 }

package/src/ffi.cc

@@ -273,7 +273,7 @@ static Napi::Value MarkInOut(const Napi::CallbackInfo &info)
     return EncodePointerDirection(info, 3);
 }
 
-static Napi::Value FindLibraryFunction(const Napi::CallbackInfo &info)
+static Napi::Value FindLibraryFunction(const Napi::CallbackInfo &info, CallConvention convention)
 {
     Napi::Env env = info.Env();
     InstanceData *instance = env.GetInstanceData<InstanceData>();
@@ -293,42 +293,17 @@ static Napi::Value FindLibraryFunction(const Napi::CallbackInfo &info)
 
     std::string name = ((Napi::Value)info[0u]).As<Napi::String>();
     func->name = DuplicateString(name.c_str(), &instance->str_alloc).ptr;
-    func->decorated_name = func->name;
     func->lib = lib->Ref();
 
-    Napi::Array parameters;
-
-    if (info.Length() >= 4 && info[3u].IsArray()) {
-        std::string conv = ((Napi::Value)info[1u]).As<Napi::String>();
-
-        if (conv == "cdecl" || conv == "__cdecl") {
-            func->convention = CallConvention::Default;
-        } else if (conv == "stdcall" || conv == "__stdcall") {
-            func->convention = CallConvention::Stdcall;
-        } else {
-            ThrowError<Napi::Error>(env, "Unknown calling convention '%1'", conv.c_str());
-            return env.Null();
-        }
-
-        func->ret.type = ResolveType(instance, info[2u]);
-        if (!func->ret.type)
-            return env.Null();
-        if (!((Napi::Value)info[3u]).IsArray()) {
-            ThrowError<Napi::TypeError>(env, "Unexpected %1 value for parameters of '%2', expected an array", GetValueType(instance, (Napi::Value)info[1u]), func->name);
-            return env.Null();
-        }
-        parameters = ((Napi::Value)info[3u]).As<Napi::Array>();
-    } else {
-        func->ret.type = ResolveType(instance, info[1u]);
-        if (!func->ret.type)
-            return env.Null();
-        if (!((Napi::Value)info[2u]).IsArray()) {
-            ThrowError<Napi::TypeError>(env, "Unexpected %1 value for parameters of '%2', expected an array", GetValueType(instance, (Napi::Value)info[1u]), func->name);
-            return env.Null();
-        }
-        parameters = ((Napi::Value)info[2u]).As<Napi::Array>();
+    func->ret.type = ResolveType(instance, info[1u]);
+    if (!func->ret.type)
+        return env.Null();
+    if (!((Napi::Value)info[2u]).IsArray()) {
+        ThrowError<Napi::TypeError>(env, "Unexpected %1 value for parameters of '%2', expected an array", GetValueType(instance, (Napi::Value)info[1u]), func->name);
+        return env.Null();
     }
 
+    Napi::Array parameters = ((Napi::Value)info[2u]).As<Napi::Array>();
     Size out_counter = 0;
 
     for (uint32_t j = 0; j < parameters.Length(); j++) {
@@ -358,15 +333,15 @@ static Napi::Value FindLibraryFunction(const Napi::CallbackInfo &info)
         return env.Null();
 
 #ifdef _WIN32
-    func->func = (void *)GetProcAddress((HMODULE)lib->module, func->decorated_name);
+    func->func = (void *)GetProcAddress((HMODULE)lib->module, func->name);
 #else
-    func->func = dlsym(lib->module, func->decorated_name);
+    func->func = dlsym(lib->module, func->name);
 #endif
     if (!func->func) {
-        RG_DEBUG_BREAK();
-        ThrowError<Napi::Error>(env, "Cannot find function '%1' in shared library", name.c_str());
+        ThrowError<Napi::Error>(env, "Cannot find function '%1' in shared library", func->name);
         return env.Null();
     }
+    func->convention = convention;
 
     Napi::Function wrapper = Napi::Function::New(env, TranslateCall, name.c_str(), (void *)func);
     wrapper.AddFinalizer([](Napi::Env, FunctionInfo *func) { delete func; }, func);
@@ -432,9 +407,18 @@ static Napi::Value LoadSharedLibrary(const Napi::CallbackInfo &info)
 
     Napi::Object obj = Napi::Object::New(env);
 
-    Napi::Function func = Napi::Function::New(env, FindLibraryFunction, "func", (void *)lib->Ref());
-    func.AddFinalizer([](Napi::Env, LibraryHolder *lib) { lib->Unref(); }, lib);
-    obj.Set("func", func);
+#define ADD_CONVENTION(Name, Value) \
+        do { \
+            const auto wrapper = [](const Napi::CallbackInfo &info) { return FindLibraryFunction(info, (Value)); }; \
+            Napi::Function func = Napi::Function::New(env, wrapper, (Name), (void *)lib->Ref()); \
+            func.AddFinalizer([](Napi::Env, LibraryHolder *lib) { lib->Unref(); }, lib); \
+            obj.Set((Name), func); \
+        } while (false)
+
+    ADD_CONVENTION("cdecl", CallConvention::Default);
+    ADD_CONVENTION("stdcall", CallConvention::Stdcall);
+
+#undef ADD_CONVENTION
 
     return obj;
 }

package/src/ffi.hh

@@ -133,7 +133,6 @@ struct FunctionInfo {
     ~FunctionInfo();
 
     const char *name;
-    const char *decorated_name;
     LibraryHolder *lib = nullptr;
 
     void *func;

package/test/tests/misc.js

@@ -40,8 +40,8 @@ async function test() {
                        (process.platform == 'win32' ? '.dll' : '.so');
     let lib = koffi.load(lib_filename);
 
-    const FillPack3 = lib.func('FillPack3', 'void', ['int', 'int', 'int', koffi.out(koffi.pointer(Pack3))]);
-    const AddPack3 = lib.func('AddPack3', 'void', ['int', 'int', 'int', koffi.inout(koffi.pointer(Pack3))]);
+    const FillPack3 = lib.cdecl('FillPack3', 'void', ['int', 'int', 'int', koffi.out(koffi.pointer(Pack3))]);
+    const AddPack3 = lib.cdecl('AddPack3', 'void', ['int', 'int', 'int', koffi.inout(koffi.pointer(Pack3))]);
 
     let p = {};
 

package/test/tests/raylib.js

@@ -87,14 +87,14 @@ async function test() {
                        (process.platform == 'win32' ? '.dll' : '.so');
     let lib = koffi.load(lib_filename);
 
-    const InitWindow = lib.func('InitWindow', 'void', ['int', 'int', 'string']);
-    const SetTraceLogLevel = lib.func('SetTraceLogLevel', 'void', ['int']);
-    const SetWindowState = lib.func('SetWindowState', 'void', ['uint']);
-    const GenImageColor = lib.func('GenImageColor', Image, ['int', 'int', Color]);
-    const GetFontDefault = lib.func('GetFontDefault', Font, []);
-    const MeasureTextEx = lib.func('MeasureTextEx', Vector2, [Font, 'string', 'float', 'float']);
-    const ImageDrawTextEx = lib.func('ImageDrawTextEx', 'void', [koffi.pointer(Image), Font, 'string', Vector2, 'float', 'float', Color]);
-    const ExportImage = lib.func('ExportImage', 'bool', [Image, 'string']);
+    const InitWindow = lib.cdecl('InitWindow', 'void', ['int', 'int', 'string']);
+    const SetTraceLogLevel = lib.cdecl('SetTraceLogLevel', 'void', ['int']);
+    const SetWindowState = lib.cdecl('SetWindowState', 'void', ['uint']);
+    const GenImageColor = lib.cdecl('GenImageColor', Image, ['int', 'int', Color]);
+    const GetFontDefault = lib.cdecl('GetFontDefault', Font, []);
+    const MeasureTextEx = lib.cdecl('MeasureTextEx', Vector2, [Font, 'string', 'float', 'float']);
+    const ImageDrawTextEx = lib.cdecl('ImageDrawTextEx', 'void', [koffi.pointer(Image), Font, 'string', Vector2, 'float', 'float', Color]);
+    const ExportImage = lib.cdecl('ExportImage', 'bool', [Image, 'string']);
 
     // We need to call InitWindow before using anything else (such as fonts)
     SetTraceLogLevel(4); // Warnings

package/test/tests/sqlite.js

@@ -40,15 +40,15 @@ async function test() {
                        (process.platform == 'win32' ? '.dll' : '.so');
     let lib = koffi.load(lib_filename);
 
-    const sqlite3_open_v2 = lib.func('sqlite3_open_v2', 'int', ['string', koffi.out(koffi.pointer(sqlite3_db)), 'int', 'string']);
-    const sqlite3_exec = lib.func('sqlite3_exec', 'int', [sqlite3_db, 'string', 'void *', 'void *', 'void *']);
-    const sqlite3_prepare_v2 = lib.func('sqlite3_prepare_v2', 'int', [sqlite3_db, 'string', 'int', koffi.out(koffi.pointer(sqlite3_stmt)), 'string']);
-    const sqlite3_reset = lib.func('sqlite3_reset', 'int', [sqlite3_stmt]);
-    const sqlite3_bind_text = lib.func('sqlite3_bind_text', 'int', [sqlite3_stmt, 'int', 'string', 'int', 'void *']);
-    const sqlite3_bind_int = lib.func('sqlite3_bind_int', 'int', [sqlite3_stmt, 'int', 'int']);
-    const sqlite3_step = lib.func('sqlite3_step', 'int', [sqlite3_stmt]);
-    const sqlite3_finalize = lib.func('sqlite3_finalize', 'int', [sqlite3_stmt]);
-    const sqlite3_close_v2 = lib.func('sqlite3_close_v2', 'int', [sqlite3_db]);
+    const sqlite3_open_v2 = lib.cdecl('sqlite3_open_v2', 'int', ['string', koffi.out(koffi.pointer(sqlite3_db)), 'int', 'string']);
+    const sqlite3_exec = lib.cdecl('sqlite3_exec', 'int', [sqlite3_db, 'string', 'void *', 'void *', 'void *']);
+    const sqlite3_prepare_v2 = lib.cdecl('sqlite3_prepare_v2', 'int', [sqlite3_db, 'string', 'int', koffi.out(koffi.pointer(sqlite3_stmt)), 'string']);
+    const sqlite3_reset = lib.cdecl('sqlite3_reset', 'int', [sqlite3_stmt]);
+    const sqlite3_bind_text = lib.cdecl('sqlite3_bind_text', 'int', [sqlite3_stmt, 'int', 'string', 'int', 'void *']);
+    const sqlite3_bind_int = lib.cdecl('sqlite3_bind_int', 'int', [sqlite3_stmt, 'int', 'int']);
+    const sqlite3_step = lib.cdecl('sqlite3_step', 'int', [sqlite3_stmt]);
+    const sqlite3_finalize = lib.cdecl('sqlite3_finalize', 'int', [sqlite3_stmt]);
+    const sqlite3_close_v2 = lib.cdecl('sqlite3_close_v2', 'int', [sqlite3_db]);
 
     let filename = create_temporary_file(path.join(os.tmpdir(), 'test_sqlite'));
     let db = {};