banjo/api_8h_source.html

#ifndef BJ_API_H

#define BJ_API_H


#include <stddef.h>

#include <stdint.h>


#define BJ_VERSION_MAJOR(version) (((version) >> 22U) & 0x3FFU)


#define BJ_VERSION_MINOR(version) (((version) >> 12U) & 0x3FFU)


#define BJ_VERSION_PATCH(version) ((version) & 0xFFFU)


#define BJ_MAKE_VERSION(major, minor, patch) \

    ((((uint32_t)(major)) << 22U) | (((uint32_t)(minor)) << 12U) | ((uint32_t)(patch)))


#define BJ_VERSION_MAJOR_NUMBER 0

#define BJ_VERSION_MINOR_NUMBER 1

#define BJ_VERSION_PATCH_NUMBER 0


#define BJ_VERSION BJ_MAKE_VERSION(BJ_VERSION_MAJOR_NUMBER, BJ_VERSION_MINOR_NUMBER, BJ_VERSION_PATCH_NUMBER)


#define BJ_NAME "Banjo"


#if defined(__EMSCRIPTEN__)

#   define BJ_OS_EMSCRIPTEN

#elif defined(WIN32) || defined(_WIN32) || defined(__WIN32__)

#   define BJ_OS_WINDOWS

#elif defined(__linux__) || defined(__gnu_linux__)

#   define BJ_OS_LINUX

#elif __APPLE__

#   define BJ_OS_APPLE

#   include <TargetConditionals.h>

#   if TARGET_OS_IPHONE

#       define BJ_OS_IOS

#   elif TARGET_IPHONE_SIMULATOR

#       define BJ_OS_IOS

#       define BJ_OS_IOS_SIMULATOR

#   elif TARGET_OS_MAC

#       define BJ_OS_MACOS

#       define BJ_OS_UNIX

#   else

#       define BJ_OS_APPLE_UNKNOWN

#   endif

#else

#   define BJ_OS_UNKNOWN

#endif


#if defined(__unix__)

#   define BJ_OS_UNIX

#endif


#if defined(BJ_COMPILER_DOXYGEN)

#    define BJ_COMPILER_NAME "Doxygen"

#    define BJ_COMPILER_VERSION 0

#elif defined(__EMSCRIPTEN__)

#    include <emscripten/version.h>

#    define BJ_COMPILER_EMSCRIPTEN

#    define BJ_COMPILER_NAME "Emscripten"

#    define BJ_COMPILER_VERSION __EMSCRIPTEN_major__

#elif defined(__GNUC__) && !defined(__clang__)

#    define BJ_COMPILER_GCC

#    define BJ_COMPILER_NAME "GCC"

#    define BJ_COMPILER_VERSION __GNUC__

#elif defined(__clang__)

#    define BJ_COMPILER_CLANG

#    define BJ_COMPILER_NAME "Clang"

#    define BJ_COMPILER_VERSION __clang_major__

#elif defined(_MSC_VER)

#    define BJ_COMPILER_MSVC

#    define BJ_COMPILER_NAME "MSVC"

#    define BJ_COMPILER_VERSION _MSC_VER

#elif defined(__MINGW32__)

#    define BJ_COMPILER_MINGW

#    define BJ_COMPILER_NAME "MinGW"

#    define BJ_COMPILER_VERSION 0

#else

#    define BJ_COMPILER_UNKNOWN

#    define BJ_COMPILER_NAME "Unknown"

#    define BJ_COMPILER_VERSION 0

#endif


#if defined(NDEBUG) || defined(BJ_COMPILER_DOXYGEN)

#   define BJ_BUILD_RELEASE

#endif

#if !defined(NDEBUG) || defined(BJ_COMPILER_DOXYGEN)

#   define BJ_BUILD_DEBUG

#endif


#if defined(BANJO_STATIC) || defined(BJ_COMPILER_DOXYGEN)

#  define BANJO_EXPORT

#  define BANJO_NO_EXPORT

#else

#    ifdef _MSC_VER

#      ifndef BANJO_EXPORT

#        ifdef BANJO_EXPORTS

#          define BANJO_EXPORT __declspec(dllexport)

#        else

#          define BANJO_EXPORT  __declspec( dllexport )

#        endif

#      endif

#      ifndef BANJO_NO_EXPORT

#        define BANJO_NO_EXPORT

#      endif

#    else

#      ifndef BANJO_EXPORT

#        ifdef BANJO_EXPORTS

#          define BANJO_EXPORT __attribute__((visibility("default")))

#        else

#          define BANJO_EXPORT __attribute__((visibility("default")))

#        endif

#      endif

#      ifndef BANJO_NO_EXPORT

#        define BANJO_NO_EXPORT __attribute__((visibility("hidden")))

#      endif

#    endif

#endif


#if defined(__cplusplus)

    #if defined(__GNUC__) || defined(__clang__)

        #define BJ_RESTRICT __restrict__

    #elif defined(_MSC_VER)

        #define BJ_RESTRICT __restrict

    #else

        #define BJ_RESTRICT /* nothing */

    #endif

#else

    /* pure C (C99 or newer) */

    #if defined(BJ_COMPILER_DOXYGEN) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)

        #define BJ_RESTRICT restrict

    #elif defined(__GNUC__) || defined(__clang__)

        #define BJ_RESTRICT __restrict__

    #elif defined(_MSC_VER)

        #define BJ_RESTRICT __restrict

    #else

        #define BJ_RESTRICT /* nothing */

    #endif

#endif


#if defined(_MSC_VER)

    #if defined(__has_include)

        #if __has_include(<sal.h>)

            #include <sal.h>

            #define BJ_CONST_ARRAY(T,n,name)      _In_reads_(n)             const T* BJ_RESTRICT name

            #define BJ_ARRAY(T,n,name)            _Out_writes_(n)                  T* BJ_RESTRICT name

            #define BJ_CONST_ARRAY_2D(T,n,m,name) _In_reads_((n)*(m)) const T (* BJ_RESTRICT name)[m]

            #define BJ_ARRAY_2D(T,n,m,name)       _Out_writes_((n)*(m))        T (* BJ_RESTRICT name)[m]

        #else

            #define BJ_CONST_ARRAY(T,n,name)      const T* BJ_RESTRICT name

            #define BJ_ARRAY(T,n,name)                  T* BJ_RESTRICT name

            #define BJ_CONST_ARRAY_2D(T,n,m,name) const T (* BJ_RESTRICT name)[m]

            #define BJ_ARRAY_2D(T,n,m,name)            T (* BJ_RESTRICT name)[m]

        #endif

    #else

        #include <sal.h>

        #define BJ_CONST_ARRAY(T,n,name)      _In_reads_(n)             const T* BJ_RESTRICT name

        #define BJ_ARRAY(T,n,name)            _Out_writes_(n)                  T* BJ_RESTRICT name

        #define BJ_CONST_ARRAY_2D(T,n,m,name) _In_reads_((n)*(m)) const T (* BJ_RESTRICT name)[m]

        #define BJ_ARRAY_2D(T,n,m,name)       _Out_writes_((n)*(m))        T (* BJ_RESTRICT name)[m]

    #endif

#elif defined(BJ_COMPILER_DOXYGEN) || (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L))

    #define BJ_CONST_ARRAY(T,n,name)      const T name[BJ_RESTRICT static (n)]

    #define BJ_ARRAY(T,n,name)                  T name[BJ_RESTRICT static (n)]

    #define BJ_CONST_ARRAY_2D(T,n,m,name) const T name[BJ_RESTRICT static (n)][m]

    #define BJ_ARRAY_2D(T,n,m,name)             T name[BJ_RESTRICT static (n)][m]

#else

    #define BJ_CONST_ARRAY(T,n,name)      const T* BJ_RESTRICT name

    #define BJ_ARRAY(T,n,name)                  T* BJ_RESTRICT name

    #define BJ_CONST_ARRAY_2D(T,n,m,name) const T (* BJ_RESTRICT name)[m]

    #define BJ_ARRAY_2D(T,n,m,name)            T (* BJ_RESTRICT name)[m]

#endif


#if defined(_MSC_VER)

    #if defined(BJ_API_FORCE_INLINE)

        #define BJ_INLINE __forceinline

    #else

        #if !defined(__cplusplus) && !defined(inline)

            #define BJ_INLINE __inline

        #else

            #define BJ_INLINE inline

        #endif

    #endif

#elif defined(__GNUC__) || defined(__clang__)

    #if defined(BJ_API_FORCE_INLINE)

        #define BJ_INLINE inline __attribute__((always_inline))

    #else

        #define BJ_INLINE inline

    #endif

#else

    #if defined(BJ_COMPILER_DOXYGEN) || (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L)

        #define BJ_INLINE inline

    #else

        #define BJ_INLINE /* no inline available */

    #endif

#endif


typedef uint32_t bj_bool;


#define BJ_FALSE ((bj_bool)0)


#define BJ_TRUE ((bj_bool)1)


typedef struct {

    const char* p_name;

    uint32_t    version;

    const char* compiler_name;

    int         compiler_version;

    bj_bool     debug;

    bj_bool     feature_win32;

    bj_bool     feature_emscripten;

    bj_bool     feature_x11;

    bj_bool     feature_mme;

    bj_bool     feature_alsa;

    bj_bool     config_checks_abort;

    bj_bool     config_checks_log;

    bj_bool     config_log_color;

    bj_bool     config_pedantic;

    bj_bool     config_fastmath;

} bj_build_info;


BANJO_EXPORT const bj_build_info* bj_build_information(void);


#endif /* BJ_API_H */

bj_build_info::feature_emscripten
bj_bool feature_emscripten
Built with Emscripten support.
Definition api.h:304

bj_build_info::config_fastmath
bj_bool config_fastmath
Built with fast-math optimizations.
Definition api.h:312

bj_build_info::version
uint32_t version
Packed API version (see BJ_VERSION).
Definition api.h:299

bj_build_info::feature_win32
bj_bool feature_win32
Built with Win32 window support.
Definition api.h:303

bj_build_info::feature_x11
bj_bool feature_x11
Built with X11 window support.
Definition api.h:305

bj_build_info::compiler_name
const char * compiler_name
Compiler name string.
Definition api.h:300

bj_build_info::p_name
const char * p_name
API name (see BJ_NAME).
Definition api.h:298

bj_build_info::debug
bj_bool debug
Non-zero if built with debug info.
Definition api.h:302

bj_build_info::config_checks_abort
bj_bool config_checks_abort
Checks abort execution on failure.
Definition api.h:308

bj_build_info::config_pedantic
bj_bool config_pedantic
Extra runtime checks enabled.
Definition api.h:311

bj_build_info::feature_mme
bj_bool feature_mme
Built with Windows MME audio.
Definition api.h:306

bj_build_info::compiler_version
int compiler_version
Compiler version number.
Definition api.h:301

bj_build_info::feature_alsa
bj_bool feature_alsa
Built with ALSA audio.
Definition api.h:307

bj_build_info::config_checks_log
bj_bool config_checks_log
Checks log failures.
Definition api.h:309

bj_build_info::config_log_color
bj_bool config_log_color
Colored log output enabled.
Definition api.h:310

BANJO_EXPORT
#define BANJO_EXPORT
Definition api.h:139

bj_bool
uint32_t bj_bool
Boolean type used throughout the Banjo API.
Definition api.h:276

bj_build_information
const bj_build_info * bj_build_information(void)
Get runtime build information for the loaded Banjo binaries.

bj_build_info
Structure holding build information of the binary.
Definition api.h:297