base.h

// SPDX-FileCopyrightText: 2025 Erin Catto
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
// Compile-time options. Edit box3d/config.h, or define BOX3D_USER_CONFIG to
// point at your own copy.
#ifdef BOX3D_USER_CONFIG
#include BOX3D_USER_CONFIG
#endif
#include "config.h"
 
// clang-format off
// 
// Shared library macros
// Predefine BOX3D_EXPORT to reuse an existing export/import scheme, for example
// when compiling Box3D into another shared library.
#ifndef BOX3D_EXPORT
#if defined(_WIN32) && defined(box3d_EXPORTS)
    // build the Windows DLL
    #define BOX3D_EXPORT __declspec(dllexport)
#elif defined(_WIN32) && defined(BOX3D_DLL)
    // using the Windows DLL
    #define BOX3D_EXPORT __declspec(dllimport)
#elif defined(box3d_EXPORTS)
    // building or using the shared library
    #define BOX3D_EXPORT __attribute__((visibility("default")))
#else
    // static library
    #define BOX3D_EXPORT
#endif
#endif
 
// C++ macros
#ifdef __cplusplus
    #define B3_API extern "C" BOX3D_EXPORT
    #define B3_INLINE inline
 
#if defined( _MSC_VER )
    #define B3_FORCE_INLINE __forceinline
#elif defined( __GNUC__ ) || defined( __clang__ )
    #define B3_FORCE_INLINE inline __attribute__((always_inline))
#else
    #define B3_FORCE_INLINE inline
#endif
 
    #define B3_LITERAL(T) T
    #define B3_ZERO_INIT {}
#else
    #define B3_API BOX3D_EXPORT
    #define B3_INLINE static inline
 
#if defined( _MSC_VER )
    #define B3_FORCE_INLINE static __forceinline
#elif defined( __GNUC__ ) || defined( __clang__ )
    #define B3_FORCE_INLINE static inline __attribute__((always_inline))
#else
    #define B3_FORCE_INLINE static inline
#endif

    #define B3_LITERAL(T) (T)
    #define B3_ZERO_INIT {0}
#endif
// clang-format on
 
#if defined( BOX3D_VALIDATE ) && !defined( NDEBUG )
#define B3_ENABLE_VALIDATION 1
#else
#define B3_ENABLE_VALIDATION 0
#endif


#define B3_NULL_INDEX -1

typedef void* b3AllocFcn( int32_t size, int32_t alignment );

typedef void b3FreeFcn( void* mem );

typedef int b3AssertFcn( const char* condition, const char* fileName, int lineNumber );

typedef void b3LogFcn( const char* message );

B3_API void b3SetAllocator( b3AllocFcn* allocFcn, b3FreeFcn* freeFcn );

B3_API int32_t b3GetByteCount( void );

B3_API void b3SetAssertFcn( b3AssertFcn* assertFcn );

#if defined( _MSC_VER )
#define B3_BREAKPOINT __debugbreak()
#elif defined( __GNUC__ ) || defined( __clang__ )
#define B3_BREAKPOINT __builtin_trap()
#else
#include <assert.h>
#define B3_BREAKPOINT assert( 0 )
#endif
 
#if !defined( NDEBUG ) || defined( B3_ENABLE_ASSERT )
B3_API int b3InternalAssert( const char* condition, const char* fileName, int lineNumber );
#define B3_ASSERT( condition )                                                                                                  \
    ( (void)( ( !!( condition ) ) || ( b3InternalAssert( #condition, __FILE__, (int)( __LINE__ ) ), 0 ) ) )
#else
#define B3_ASSERT( ... ) ( (void)0 )
#endif
 
#if B3_ENABLE_VALIDATION
#define B3_VALIDATE( condition ) B3_ASSERT( condition )
#else
#define B3_VALIDATE( ... ) ( (void)0 )
#endif

B3_API void b3SetLogFcn( b3LogFcn* logFcn );

typedef struct b3Version
{
    int major;

    int minor;

    int revision;
} b3Version;

B3_API b3Version b3GetVersion( void );

B3_API bool b3IsDoublePrecision( void );



B3_API uint64_t b3GetTicks( void );

B3_API float b3GetMilliseconds( uint64_t ticks );

B3_API float b3GetMillisecondsAndReset( uint64_t* ticks );

B3_API void b3Yield( void );

B3_API void b3Sleep( int milliseconds );
 
// Simple djb2 hash function for determinism testing
#define B3_HASH_INIT 5381
B3_API uint32_t b3Hash( uint32_t hash, const uint8_t* data, int count );
 
// Dump file support functions
B3_API void b3WriteBinaryFile( void* data, int size, const char* fileName );
B3_API void* b3ReadBinaryFile( const char* prefix, const char* fileName, int* memSize );