FixNative Documentation

• Version: 0.4
• Homepage
• ChangeLog

This library allows you to use native APIs.

Features:

• native memory access (including structs)
• calling native functions
• providing native callbacks
• supported systems: Windows, Linux, Mac OS X, Haiku, Raspberry Pi, WebAssembly (browser and WASI)
• supported CPU architectures: x86, x86_64, arm, wasm
• support for declaration of structs and functions in C syntax
• ability to embed JavaScript functions (in WebAssembly target)
• licensed under ZLIB license (no attribution required in binary builds)

Declaration in C syntax

You can declare native functions directly in the C syntax. Currently it supports typedefs, structs, common predefined types and functions. The token processor requires using of classes.

An example:

use "native/extern";
use "classes";

import "native/native";

extern "C" {
    typedef struct {
        int some;
        float value;
    } Test;

    bind("lib");
    void some_func(Test *test);
    void other_func();

    bind("c");
    int printf(char *fmt, ...);
}

function test()
{
    Library::bind("c");
    Library::bind("lib", Library::open("./libcustom.so"));

    var test = Test::create();
    test.set_some(5);
    test.set_value(123.0);
    some_func(test);

    printf("Hello, world! value=%f\n", 123.0);
}

JavaScript functions

When using WebAssembly in the browser you can directly embed code of JavaScript functions. Here is an example:

use "native/extern";
use "classes";

import "native/native";

extern "JS" {
    function js_func(arg1: int, arg2: float, arg3: string): float {
        return 123.456;
    }
}

The function declaration must include types for the parameters and the return value (unless there is none). The available types are:

• boolean - boolean
• int - 32bit integer
• float - 32bit float
• double - 64bit float
• pointer - pointer (32bit integer)
• string - string (internally converted using UTF-8 encoding)

The functions can use these variables:

• global - global object for the WebAssembly module
• memory - WebAssembly memory
• mem8 - memory view as Uint8Array
• mem16 - memory view as Uint16Array
• mem32 - memory view as Int32Array
• memF32 - memory view as Float32Array

And these functions:

• malloc(size) - allocate uninitialized memory
• calloc(nmemb, size) - allocate zeroed memory
• realloc(ptr, size) - reallocates the memory
• free(ptr) - frees the memory
• suspend() - suspends the execution and returns a continuation function that takes a return value

Classes

• System - information about the system
• Pointer - pointer to arbitrary memory location
  • Memory - pointer to memory with bounds
• StructLayout - computes native layout of a struct
  • UnionLayout - computes native layout of an union
• Library - native library
• Destructor - allows you to add destructors to your objects
• Callback - creation of native callbacks
• JSFunction - dynamic creation of JavaScript functions

Global functions
C API