api.h File Reference

#include <stddef.h>
#include <stdint.h>

Include dependency graph for api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	bj_build_info

Macros
#define	BJ_VERSION_MAJOR(version)
#define	BJ_VERSION_MINOR(version)
#define	BJ_VERSION_PATCH(version)
#define	BJ_MAKE_VERSION(major, minor, 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"
#define	BJ_FALSE   ((bj_bool)0)
#define	BJ_TRUE   ((bj_bool)1)
Platform detection
One of these will be defined to indicate the target OS.
#define	BJ_OS_UNKNOWN
Compiler detection
One of these will be defined to indicate the compiler in use. Additionally BJ_COMPILER_NAME and BJ_COMPILER_VERSION are provided.
#define	BJ_COMPILER_NAME   "Doxygen"
#define	BJ_COMPILER_VERSION   0
Build configuration
Exactly one of BJ_BUILD_DEBUG or BJ_BUILD_RELEASE is defined.
#define	BJ_BUILD_RELEASE
#define	BJ_BUILD_DEBUG
Export/visibility helpers
BANJO_EXPORT marks public symbols. BANJO_NO_EXPORT hides symbols.
#define	BANJO_EXPORT
#define	BANJO_NO_EXPORT
Restrict qualifier macro
#define	BJ_RESTRICT   restrict
Array parameter helper macros
#define	BJ_CONST_ARRAY(T, n, name)
#define	BJ_ARRAY(T, n, name)
#define	BJ_CONST_ARRAY_2D(T, n, m, name)
#define	BJ_ARRAY_2D(T, n, m, name)
Inline helper macro
#define	BJ_INLINE   inline

Typedefs
typedef uint32_t	bj_bool

Functions
const bj_build_info *	bj_build_information (void)

Detailed Description

General-purpose definitions for Banjo API.