Note: This page is about macros generated in build-time (i.e., platform specifics). For macros defined in C++ code, see Useful macros.

Writing platform dependent code#

AUI provides a set of AUI_PLATFORM_* and AUI_COMPILER_* definitions for platform and compiler checking to use in both CMake and C++.

Platform checks#

Platform	C++	CMake	Platform specific dir(s)
Windows (operating system)	#if AUI_PLATFORM_WIN // ... #endif	if(AUI_PLATFORM_WIN) # ... endif()	`src/Platform/win32` `src/platform/win32`
Linux (-based desktop OSes)	#if AUI_PLATFORM_LINUX // ... #endif	if(AUI_PLATFORM_LINUX) # ... endif()	`src/Platform/linux` `src/platform/linux`
macOS (operating system)	#if AUI_PLATFORM_MACOS // ... #endif	if(AUI_PLATFORM_MACOS) # ... endif()	`src/Platform/macos` `src/platform/macos`
Android (operating system)	#if AUI_PLATFORM_ANDROID // ... #endif	if(AUI_PLATFORM_ANDROID) # ... endif()	`src/Platform/android` `src/platform/android`
iOS (operating system) (both iPhone and iPad)	#if AUI_PLATFORM_IOS // ... #endif	if(AUI_PLATFORM_IOS) # ... endif()	`src/Platform/ios` `src/platform/ios`
Apple (macOS, iOS)	#if AUI_PLATFORM_APPLE // ... #endif	if(AUI_PLATFORM_APPLE) # ... endif()	`src/Platform/apple` `src/platform/apple`
Unix (Linux, Android, macOS, iOS)	#if AUI_PLATFORM_UNIX // ... #endif	if(AUI_PLATFORM_UNIX) # ... endif()	`src/Platform/unix` `src/platform/unix`
Emscripten (WebAssembly)	#if AUI_PLATFORM_EMSCRIPTEN // ... #endif	if(AUI_PLATFORM_EMSCRIPTEN) # ... endif()	`src/Platform/emscripten` `src/platform/emscripten`

Platform specific sources#

With AUI, the platform dependent code can be placed in src/Platform/<PLATFORM_NAME> or src/platform/<PLATFORM_NAME> dirs, where <PLATFORM_NAME> is one of the supported platforms (see the table above).

Note: Both cases (Platform and platform) were added to honor projects with various directory naming agreements.

Compiler checks#

Compiler	C++	CMake
MSVC	#if AUI_COMPILER_MSVC // ... #endif	if(AUI_COMPILER_MSVC) # ... endif()
GCC (including MinGW)	#if AUI_COMPILER_GCC // ... #endif	if(AUI_COMPILER_GCC) # ... endif()
CLANG	#if AUI_COMPILER_CLANG // ... #endif	if(AUI_COMPILER_CLANG) # ... endif()

Other#

AUI_MODULE_NAME#

Target name exposed by aui_module and aui_executable.

AUI_CMAKE_PROJECT_VERSION#

${CMAKE_PROJECT_VERSION} exposed by aui_module and aui_executable.

CMAKE_PROJECT_VERSION is typically defined by project CMake command:

project(test_project VERSION 2.2.8)

API_<module name>#

dllexport (on Windows) or visibility (on other platforms) policy for the symbol.

class API_AUI_VIEWS AView ... { // defined in aui.views module
  ...
};