boxdd-sys 0.6.0

Low-level FFI bindings for Box2D built from upstream via submodule
Documentation
// SPDX-FileCopyrightText: 2023 Erin Catto
// SPDX-License-Identifier: MIT

#pragma once

#include "box2d/base.h"

// clang-format off

// for performance comparisons
#define B2_RESTRICT restrict

#ifdef NDEBUG
	#define B2_DEBUG 0
#else
	#define B2_DEBUG 1
#endif

// Define platform
#if defined(_WIN32) || defined(_WIN64)
	#define B2_PLATFORM_WINDOWS
#elif defined( __ANDROID__ )
	#define B2_PLATFORM_ANDROID
#elif defined( __linux__ )
	#define B2_PLATFORM_LINUX
#elif defined( __APPLE__ )
	#include <TargetConditionals.h>
	#if defined( TARGET_OS_IPHONE ) && !TARGET_OS_IPHONE
		#define B2_PLATFORM_MACOS
	#else
		#define B2_PLATFORM_IOS
	#endif
#elif defined( __EMSCRIPTEN__ )
	#define B2_PLATFORM_WASM
#else
	#define B2_PLATFORM_UNKNOWN
#endif

// Define CPU
#if defined( __x86_64__ ) || defined( _M_X64 ) || defined( __i386__ ) || defined( _M_IX86 )
	#define B2_CPU_X86_X64
#elif defined( __aarch64__ ) || defined( _M_ARM64 ) || defined( __arm__ ) || defined( _M_ARM )
	#define B2_CPU_ARM
#elif defined( __EMSCRIPTEN__ )
	#define B2_CPU_WASM
#else
	#define B2_CPU_UNKNOWN
#endif

// Define SIMD
#if defined( BOX2D_DISABLE_SIMD )
	#define B2_SIMD_NONE
	// note: I tried width of 1 and got no performance change
	#define B2_SIMD_WIDTH 4
#else
	#if defined( B2_CPU_X86_X64 )
		#if defined( BOX2D_AVX2 )
			#define B2_SIMD_AVX2
			#define B2_SIMD_WIDTH 8
		#else
			#define B2_SIMD_SSE2
			#define B2_SIMD_WIDTH 4
		#endif
	#elif defined( B2_CPU_ARM )
		#define B2_SIMD_NEON
		#define B2_SIMD_WIDTH 4
	#elif defined( B2_CPU_WASM )
		#define B2_CPU_WASM
		#define B2_SIMD_SSE2
		#define B2_SIMD_WIDTH 4
	#else
		#define B2_SIMD_NONE
		#define B2_SIMD_WIDTH 4
	#endif
#endif

// Define compiler
#if defined( __clang__ )
	#define B2_COMPILER_CLANG
#elif defined( __GNUC__ )
	#define B2_COMPILER_GCC
#elif defined( _MSC_VER )
	#define B2_COMPILER_MSVC
#endif

/// Tracy profiler instrumentation
/// https://github.com/wolfpld/tracy
#ifdef BOX2D_PROFILE
	#include <tracy/TracyC.h>
	#define b2TracyCZoneC( ctx, color, active ) TracyCZoneC( ctx, color, active )
	#define b2TracyCZoneNC( ctx, name, color, active ) TracyCZoneNC( ctx, name, color, active )
	#define b2TracyCZoneEnd( ctx ) TracyCZoneEnd( ctx )
	#define b2TracyCFrame TracyCFrameMark
	#define b2TracyCSetThreadName( name ) TracyCSetThreadName( name )
#else
	#define b2TracyCZoneC( ctx, color, active )
	#define b2TracyCZoneNC( ctx, name, color, active )
	#define b2TracyCZoneEnd( ctx )
	#define b2TracyCFrame
	#define b2TracyCSetThreadName( name )
#endif

// clang-format on

// Returns the number of elements of an array
#define B2_ARRAY_COUNT( A ) ( (int)( sizeof( A ) / sizeof( *A ) ) )

// Used to prevent the compiler from warning about unused variables
#define B2_UNUSED( ... ) (void)sizeof(( __VA_ARGS__, 0 ))

// Use to validate definitions. Do not take my cookie.
#define B2_SECRET_COOKIE 1152023

// Snoop counters. These should be disabled in optimized builds because they are expensive.
#if defined( box2d_EXPORTS )
#define B2_SNOOP_TABLE_COUNTERS B2_DEBUG
#define B2_SNOOP_PAIR_COUNTERS B2_DEBUG
#define B2_SNOOP_TOI_COUNTERS B2_DEBUG
#else
#define B2_SNOOP_TABLE_COUNTERS 0
#define B2_SNOOP_PAIR_COUNTERS 0
#define B2_SNOOP_TOI_COUNTERS 0
#endif

#ifdef __cplusplus
#define B2_TYPE_OF( A ) decltype( A )
#else
#define B2_TYPE_OF( A ) __typeof__( A )
#endif

#define B2_SWAP( x, y )                                                                                                          \
	do                                                                                                                           \
	{                                                                                                                            \
		B2_TYPE_OF( x ) B2_SWAP_TEMP = x;                                                                                        \
		x = y;                                                                                                                   \
		y = B2_SWAP_TEMP;                                                                                                        \
	}                                                                                                                            \
	while ( 0 )

#define B2_CHECK_DEF( DEF ) B2_ASSERT( DEF->internalValue == B2_SECRET_COOKIE )

typedef struct b2AtomicInt
{
	int value;
} b2AtomicInt;

typedef struct b2AtomicU32
{
	uint32_t value;
} b2AtomicU32;

typedef struct b2AtomicI64
{
	// 64-bit atomic wants 8-byte alignment
	_Alignas( 8 ) int64_t value;
} b2AtomicI64;

void* b2Alloc( size_t size );
void* b2AllocZeroInit( size_t size );
#define B2_ALLOC_STRUCT( type ) b2Alloc( sizeof( type ) )
#define B2_ALLOC_ARRAY( count, type ) b2Alloc( count * sizeof( type ) )

void b2Free( void* mem, size_t size );
#define B2_FREE_STRUCT( mem, type ) b2Free( mem, sizeof( type ) );
#define B2_FREE_ARRAY( mem, count, type ) b2Free( mem, count * sizeof( type ) )

void* b2GrowAlloc( void* oldMem, size_t oldSize, size_t newSize );
void* b2GrowAllocZeroInit( void* oldMem, size_t oldSize, size_t newSize );

void b2Log( const char* format, ... );

typedef struct b2Mutex b2Mutex;
b2Mutex* b2CreateMutex( void );
void b2DestroyMutex( b2Mutex* m );
void b2LockMutex( b2Mutex* m );
void b2UnlockMutex( b2Mutex* m );

typedef struct b2Semaphore b2Semaphore;
b2Semaphore* b2CreateSemaphore( int initCount );
void b2DestroySemaphore( b2Semaphore* s );
void b2WaitSemaphore( b2Semaphore* s );
void b2SignalSemaphore( b2Semaphore* s );

typedef void b2ThreadFunction( void* context );
typedef struct b2Thread b2Thread;
// Name may be NULL, otherwise it is copied.
b2Thread* b2CreateThread( b2ThreadFunction* function, void* context, const char* name );
void b2JoinThread( b2Thread* t );