This is the mainstay of all of Burgerlib. You include the file burger.h in your project which will determine the compiler, target, CPU, and system specific features so you can write platform neutral code.

Debug defines, one is required MUST be present and is supplied by the build project. This is not created by default by Burgerlib. If both exist or both are missing, burger.h will force a compile error.

_DEBUG Debugging asserts are enabled.
NDEBUG Debugging asserts are disabled.

Compiler level

Compiler C++ level, all are defined up to the feature level present.

BURGER_CPP89 Compiler is at least C++89 level of features
BURGER_CPP98 Compiler is at least C++98 level of features
BURGER_CPP11 Compiler is at least C++11 level of features
BURGER_CPP14 Compiler is at least C++14 level of features
BURGER_CPP17 Compiler is at least C++17 level of features
BURGER_CPP20 Compiler is at least C++20 level of features
BURGER_STDCPP_NAME String of maximum C++ level

Compiler name

Compiler defines, to determine any compiler specific features are available. Only one macro is defined. All are defined as the compiler version number.

BURGER_WATCOM Open Watcom
BURGER_MRC Apple's PowerPC MPW compiler
BURGER_APPLE_SC Apple's 68000 MPW compiler
BURGER_DJGPP DJ's GNU compiler
BURGER_SNSYSTEMS SN System's compiler
BURGER_GHS Green Hills compiler
BURGER_INTEL_COMPILER Intel compiler
BURGER_MINGW MinGW compiler
BURGER_CLANG clang compiler
BURGER_GNUC GNU C, found on Linux and other platforms
BURGER_METROWERKS Metrowerks Codewarrior (PowerPC, Intel, 68000)
BURGER_ARM_COMPILER Advanced RISC Machines ARM compiler
BURGER_MSVC Microsoft Visual Studio
BURGER_COMPILER_NAME String of the compiler's name
BURGER_COMPILER_VERSION Integer of the version of the compiler

Feature Detectors

__has_builtin Macro for non-clang compilers
__has_feature Macro for non-clang compilers
__has_extension Macro for non-clang compilers
__has_cpp_attribute Macro for non-clang compilers
__has_declspec_attribute Macro for non-clang compilers

CPU defines

CPU defines, only one is enabled on each compiler.

BURGER_X86 compiled for 32 bit Intel CPUs.
BURGER_AMD64 compiled for 64 bit AMD64/Intel CPUs.
BURGER_ITANIUM compiled for 64 bit Intel Itanium.
BURGER_ARM32 compiled for 32 bit ARM CPUs.
BURGER_ARM64 compiled for 64 bit ARM CPUs.
BURGER_MIPS32 compiled for 32 bit MIPS CPUs.
BURGER_MIPS64 compiled for 64 bit MIPS CPUs.
BURGER_POWERPC compiled for 32 bit PowerPC CPUs.
BURGER_POWERPC64 compiled for 64 bit PowerPC CPUs.
BURGER_68K compiled for 32 bit 68000 CPUs.
BURGER_RISCV compiled for 32 bit RISC-V CPUs.
BURGER_AVR compiled for 32 bit Atmel AVR CPUS.
BURGER_MSP430 compiled for 32 bit Texas Instruments MSP430 CPUs.
BURGER_SPARC32 compiled for 32 bit SPARC CPUs.
BURGER_SPARC64 compiled for 64 bit SPARC CPUs.
BURGER_CPU_NAME String of the CPU's name.

"Type of CPU" defines, they are defined to help determine the type of CPU is running.

BURGER_INTEL The CPU is either AMD64 or X86.
BURGER_PPC CPU is part of the PowerPC family.
BURGER_ARM CPU is part of the Advanced RISC Machines family.
BURGER_MIPS CPU is part of the MIPS family.
BURGER_SPARC CPU is part of the SPARC family.
BURGER_64BITCPU The CPU has native 64 bit registers (AMD64, PPC64, ARM64, ITANIUM, SPARC64).

CPU special feature macros.

BURGER_NEON ARM NEON features are enabled.
BURGER_68881 68000 math co-processor features are enabled.
BURGER_ALTIVEC PowerPC Altivec features are enabled.
BURGER_3DNOW AMD 3DNow! features are enabled.
BURGER_SSE Intel SSE features are enabled.
BURGER_SSE2 Intel SSE features are enabled.
BURGER_AVX Intel SSE features are enabled.
BURGER_AVX2 Intel SSE features are enabled.

Endian defines

Endian defines, only one is enabled on each compile. Do not use the CPU to determine the endian, because it may change on some platforms.

BURGER_BIGENDIAN Defined on big endian machines
BURGER_LITTLEENDIAN Defined on little endian machine
BURGER_ENDIANINDEX_LOW Index for low byte for 16 bit value (0 or 1)
BURGER_ENDIANINDEX_HIGH Index for high byte for 16 bit value (0 or 1)

Platform defines

Platform defines, only one is enabled on each compile.

BURGER_PLATFORM_NAME String of the operating system's name.
BURGER_WIN32 The underlying OS is 32 bit Windows (XP/NT/7/8 Etc)
BURGER_WIN64 The underlying OS is 64 bit Windows
BURGER_WINDOWS The underlying OS is any flavor of Microsoft Windows
BURGER_MSDOS The underlying OS is MSDOS
BURGER_MAC The underlying OS is MacOS (Pre-X)
BURGER_MACOSX The underlying OS is a version of MacOSX
BURGER_MACCLASSIC macOS 7-9 using class API
BURGER_MACCARBON macOS7-9 using CarbonLib
BURGER_MACOS The underlying OS is ANY version of MacOS
BURGER_IOS Build for iOS
BURGER_NGAGE Build for Nokia NGage
BURGER_SYMBIAN Build for Symbian OS
BURGER_PS1 Build for Playstation classic
BURGER_PS2 Build for Playstation 2
BURGER_PS3 Build for Playstation 3
BURGER_PS4 Build for Playstation 4
BURGER_PSP Build for Playstation Portable
BURGER_VITA Build for Playstation Portable 2
BURGER_GAMECUBE Build for Nintendo Gamecube
BURGER_WII Build for Nintendo Wii
BURGER_WIIU Build for Nintendo WiiU
BURGER_SWITCH Build for Nintendo Switch
BURGER_GBA Gameboy Advanced Build for Nintendo Gameboy Advance
BURGER_DS Build for Nintendo DS and DSi
BURGER_3DS Build for Nintendo 3DS
BURGER_XBOX Build for the original XBox
BURGER_XBOX360 Build for the Xbox 360
BURGER_XBOXONE Build for the Xbox ONE
BURGER_ANDROID Build for Android
BURGER_SHIELD Build for nVidia Shield
BURGER_OUYA Build for Ouya
BURGER_BEOS Build for BeOS and Haiku.
BURGER_AMIGA Build for Commodore Amiga.
BURGER_APPLEIIGS has been removed.
BURGER_3DO has been removed.

Global defines

Standard defines present on all build targets

TRUE 1
FALSE 0
NULL 0
BURGER_MAXINT
BURGER_MININT
BURGER_MAXUINT
BURGER_INLINE Force inlining this function.
BURGER_NO_INLINE Disable inlining this function.
BURGER_API Burgerlib function call API type (Usually fastcall)
BURGER_ANSIAPI API native to the compiler.
BURGER_ASM Define a function as pure assembly.
BURGER_CFM macOS 7-9 Code Fragment Manager
BURGER_FASTCALLENABLED Used for Intel assembly functions to use the __fastcall ABI
BURGER_DECLSPECNAKED Used to create a function without a prologue or epilogue
BURGER_ALIGN
BURGER_PREALIGN
BURGER_POSTALIGN
BURGER_STRUCT_ALIGN
BURGER_STRUCT_PACK
BURGER_STRUCT_PACKPUSH

API detection

Defines to denote if features, compilation switches or high level APIs are present

BURGER_OPENGL OpenGL is available
BURGER_OPENGLES OpenGL ES is available
BURGER_VULKAN Vulkan is available
BURGER_TCPIP Is TCP/IP available on this platform
BURGER_APPLETALK Is AppleTalk supported on this platform
BURGER_IPX Is IPX/SPX available on this platform
BURGER_STEAM Is Steam is available on this platform
BURGER_XBOXLIVE Is Xbox Live available on this platform

Handy macros

BURGER_STRINGIZE Convert a macro's definition into a string
BURGER_JOIN Join two macros together.
BURGER_LEFT_PARENTHESIS (
BURGER_RIGHT_PARENTHESIS )
BURGER_OFFSETOF Get offset of a structure member
BURGER_GET_BASE_PTR
BURGER_CONST_GET_BASE_PTR
BURGER_ARRAYSIZE Get number of members in an array
BURGER_UNUSED Mark variables as unused
BURGER_EQUALS_DELETE Insert '= delete' on compilers that support it
BURGER_EQUALS_DEFAULT Insert '= default' on compilers that support it
BURGER_DISABLE_COPY Disable the ability to copy the class
BURGER_STATIC_ASSERT static_assert
BURGER_CONSTEXPR constexpr
BURGER_OVERRIDE override
BURGER_FINAL final
nullptr 0 on compilers that don't support this keyword.
__underlying_type int on compilers that don't support this keyword.
BURGER_RVALUE_REFERENCES Test for && operations.
BURGER_HAS_SFINAE Compiler supports SFINAE