function_types.fbs

namespace Hyperlight.Generated;

// the following tables are used to hold the values of the parameters and return values of functions
// they are named with hl prefix to avoid reserved word clashes in generated code

// hlint is a 32 bit signed integer

table hlint {
    value:int;
}

// hluint is a 32 bit unsigned integer

table hluint {
    value:uint;
}

// hllong is a 64 bit signed integer

table hllong {
    value:long;
}

// hlulong is a 64 bit unsigned integer

table hlulong {
    value:ulong;
}

// hlfloat is 32-bit float

table hlfloat {
    value:float;
}

// hldouble is 64-bit float

table hldouble {
    value:double;
}

// hlstring is a UTF8 encoded string 

table hlstring{
    value:string;
}

// hlbool is a C99 boolean

table hlbool {
    value:bool;
}

// hlexternalbytes declares a logical byte value stored outside the FlatBuffer.
// chunked requests the ByteChunks representation rather than VecBytes.

table hlexternalbytes {
    length:ulong;
    chunked:bool;
}

// hlvoid is a void (used for functions that return nothing)

table hlvoid {
}

// This represents a parameter value in a function call

union ParameterValue {
    hlint = 1,
    hluint = 2,
    hllong = 3,
    hlulong = 4,
    hlfloat = 5,
    hldouble = 6,
    hlstring = 7,
    hlbool = 8,
    // Tag 9 is reserved for embedded byte vectors.
    hlexternalbytes = 10,
}

// This represents a parameter type in a function definition

enum ParameterType : ubyte {
    hlint,
    hluint,
    hllong,
    hlulong,
    hlfloat,
    hldouble,
    hlstring,
    hlbool,
    hlvecbytes,
    hlbytechunks,
}

enum ReturnType : ubyte {
    hlint,
    hluint,
    hllong,
    hlulong,
    hlfloat,
    hldouble,
    hlstring,
    hlbool,
    hlvoid,
    hlsizeprefixedbuffer,
    hlbytechunks,
}

union ReturnValue {
    hlint = 1,
    hluint = 2,
    hllong = 3,
    hlulong = 4,
    hlfloat = 5,
    hldouble = 6,
    hlstring = 7,
    hlbool = 8,
    hlvoid = 9,
    // Tag 10 is reserved for embedded size-prefixed buffers.
    hlexternalbytes = 11,
}