detlef_sdk.h

/*
 * Shared C package authoring API. MIT licensed.
 * Define a package with DETLEF_SDK_PACKAGE() in exactly one translation unit.
 * Setup and package builds: ../../../docs/c/index.md
 */
#ifndef DETLEF_SDK_A95992C2_ACAE_4E89_926F_6F692CFF5892
#define DETLEF_SDK_A95992C2_ACAE_4E89_926F_6F692CFF5892
 
#include <stddef.h>
#include <stdint.h>
 
/* Fixed-width storage; documentation links these names to their enum values. */
#ifndef DETLEF_DOXYGEN
typedef int32_t DetlefSdkStatus;
typedef uint32_t DetlefSdkBool;
typedef uint32_t DetlefSdkTypeKind;
typedef uint32_t DetlefSdkCallableKind;
#endif
 
typedef uint64_t DetlefSdkValue;
typedef struct DetlefSdkCall DetlefSdkCall;
 
#ifdef DETLEF_DOXYGEN
enum DetlefSdkStatus {
#else
enum DetlefSdkStatusCode {
#endif
    DETLEF_SDK_OK = 0,
 
    DETLEF_SDK_ERROR = 1,
};
 
#ifdef DETLEF_DOXYGEN
enum DetlefSdkTypeKind {
#else
enum DetlefSdkTypeKindCode {
#endif
    DETLEF_SDK_NAMED,
 
    DETLEF_SDK_ARRAY,
 
    DETLEF_SDK_OPTIONAL,
};
 
#ifdef DETLEF_DOXYGEN
enum DetlefSdkCallableKind {
#else
enum DetlefSdkCallableKindCode {
#endif
    DETLEF_SDK_FUNCTION,
 
    DETLEF_SDK_CONTROL,
};
 
#ifdef DETLEF_DOXYGEN
enum DetlefSdkBool {
#else
enum DetlefSdkBoolCode {
#endif
    DETLEF_SDK_FALSE = 0,
 
    DETLEF_SDK_TRUE = 1,
};
 
typedef struct DetlefSdkType DetlefSdkType;
 
struct DetlefSdkType {
    DetlefSdkTypeKind kind;
 
    const char *name;
 
    const DetlefSdkType *inner;
};
 
#define DETLEF_SDK_TYPE(name) { DETLEF_SDK_NAMED, name, NULL }
 
#define DETLEF_SDK_ARRAY_TYPE(inner) { DETLEF_SDK_ARRAY, NULL, inner }
 
#define DETLEF_SDK_OPTIONAL_TYPE(inner) { DETLEF_SDK_OPTIONAL, NULL, inner }
 
#define DETLEF_SDK_COUNT(items) (sizeof(items) / sizeof((items)[0]))
 
#define DETLEF_SDK_TRY(operation)                          \
    do {                                                 \
        DetlefSdkStatus sdk_status_ = (operation);        \
        if (sdk_status_ != DETLEF_SDK_OK)                 \
            return sdk_status_;                          \
    } while (0)
 
typedef struct DetlefSdkField {
    const char *name;
 
    const DetlefSdkType *type;
} DetlefSdkField;
 
typedef DetlefSdkStatus (*DetlefSdkCallback)(DetlefSdkCall *call,
                                            DetlefSdkValue *result);
 
typedef struct DetlefSdkCallable {
    const char *name;
 
    DetlefSdkCallableKind kind;
 
    DetlefSdkCallback callback;
 
    const DetlefSdkField *parameters;
 
    size_t parameter_count;
 
    const DetlefSdkType *variadic;
 
    void *data;
} DetlefSdkCallable;
 
typedef struct DetlefSdkRecord {
    const char *name;
 
    const DetlefSdkField *fields;
 
    size_t field_count;
} DetlefSdkRecord;
 
typedef struct DetlefSdkPackage {
    const DetlefSdkCallable *callables;
 
    size_t callable_count;
 
    const DetlefSdkRecord *records;
 
    size_t record_count;
} DetlefSdkPackage;
 
static inline DetlefSdkStatus detlef_sdk_argument_count(DetlefSdkCall *call, size_t *count);
 
static inline DetlefSdkStatus detlef_sdk_argument(DetlefSdkCall *call, size_t index, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_integer(DetlefSdkCall *call, int64_t value, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_float(DetlefSdkCall *call, double value, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_boolean(DetlefSdkCall *call, DetlefSdkBool value, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_string(DetlefSdkCall *call, const char *text, size_t length, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_none(DetlefSdkCall *call, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_get_integer(DetlefSdkCall *call, DetlefSdkValue value, int64_t *out);
 
static inline DetlefSdkStatus detlef_sdk_get_float(DetlefSdkCall *call, DetlefSdkValue value, double *out);
 
static inline DetlefSdkStatus detlef_sdk_get_boolean(DetlefSdkCall *call, DetlefSdkValue value, DetlefSdkBool *out);
 
static inline DetlefSdkStatus detlef_sdk_format(DetlefSdkCall *call, DetlefSdkValue value, char *output, size_t capacity, size_t *length);
 
static inline DetlefSdkStatus detlef_sdk_array(DetlefSdkCall *call, const DetlefSdkType *type, const DetlefSdkValue *items, size_t count, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_record(DetlefSdkCall *call, const char *name, const DetlefSdkValue *fields, size_t count, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_array_length(DetlefSdkCall *call, DetlefSdkValue value, size_t *out);
 
static inline DetlefSdkStatus detlef_sdk_array_get(DetlefSdkCall *call, DetlefSdkValue value, size_t index, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_array_set(DetlefSdkCall *call, DetlefSdkValue value, size_t index, DetlefSdkValue item);
 
static inline DetlefSdkStatus detlef_sdk_record_get(DetlefSdkCall *call, DetlefSdkValue value, const char *field, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_record_set(DetlefSdkCall *call, DetlefSdkValue value, const char *field, DetlefSdkValue item);
 
static inline DetlefSdkStatus detlef_sdk_execute(DetlefSdkCall *call, const char *source, size_t length, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_retain(DetlefSdkCall *call, DetlefSdkValue value, DetlefSdkValue *out);
 
static inline DetlefSdkStatus detlef_sdk_release(DetlefSdkCall *call, DetlefSdkValue value);
 
static inline DetlefSdkStatus detlef_sdk_error(DetlefSdkCall *call, const char *message);
 
static inline void *detlef_sdk_data(DetlefSdkCall *call);
 
#define DETLEF_SDK_PACKAGE(definition) DETLEF_SDK_IMPLEMENT_PACKAGE(definition)
 
#include "internal/sdk_common.h"
 
#if defined(__wasm32__)
#include "internal/sdk_wasm.h"
#else
#include "internal/sdk_native.h"
#endif
 
#endif /* DETLEF_SDK_A95992C2_ACAE_4E89_926F_6F692CFF5892 */