tb_configuration.hpp

 
#ifndef TurtleBrains_Configuration_hpp
#define TurtleBrains_Configuration_hpp
 
//TODO: TurtleBrains: Remove the settings in the build script and set them up here, hopefully automatically.
//  2022-05-28: Perhaps this should not be setup here as it would make it near impossible to build for platform X while
//  using a tool that would typically build for platform Y (consider building Web from Linux or similar).
 
//#define tb_windows
//#define tb_macos
//#define tb_linux
//#define tb_web
//#define tb_ios
 
#if defined(tb_macosx)
  #warning The tb_macosx define is deprecated, use tb_macos
  #if !defined(tb_macos)
    #define tb_macos
  #endif /* only define if needed, always give warning. */
#endif /* use newer tb_macos define */
 
#if !defined(tb_windows) && !defined(tb_macos) && !defined(tb_linux) && !defined(tb_web) && !defined(tb_ios)
  #error Unsupported or unknown platform configuration, make sure either: tb_windows, tb_macos, tb_linux, or tb_web is defined.
#endif /* tb_platform */
 
//#define tb_without_threading       ///< When deefined, TurtleBrains will stay on a single thread, otherwise Audio and other things may run on threads.
//#define tb_without_audio           ///< When defined, TurtleBrains will NOT include the Audio API, which would require linking with OpenAL.
//#define tb_without_networking      ///< When defined, TurtleBrains will NOT include the Networking API, which may require additional linked dependencies.
//#define tb_without_input_devices   ///< When defined, TurtleBrains will NOT include the system input devices API, which could require additional linking.
//#define tb_without_development     ///< When defined, TurtleBrains will NOT include the Development API, which is useful tools for development stuff.
//#define tb_without_math_operators  ///< When defined, Vector/Matrix math objects will contain FEWER operators, does NOT disable ALL operators!
//#define tb_without_splash_screen   ///< When defined, TurtleBrains will jump directly to set scene instead of displaying TurtleBrains splash screen.
//#define tb_without_legacy_gl       ///< When defined, if TurtleBrains cannot create a 3.2 Core context, it will fail to create application window.
//#define tb_with_legacy_gl_context  ///< When defined a legacy OpenGL context will be used instead of 3.2 Core, if possible. Not recommended.
//#define tb_without_internal_tests  ///< When defined TurtleBrains will not build and include internal tests into the UnitTest RunAllTests().
//#define tb_righthanded_math        ///< When defined, TurtleBrains math will use negative-Z as forward.
 
//#define tb_with_debug_set          ///< Can be used to keep the debug tools/logging active even in a release build.
//#define tb_without_debug_set       ///< Takes precedence over anything else, if defined will shutoff debug_set completely.
//#define tb_without_diagnostics     ///< Turn off TurtleBrains internal logging, automatically implied if tb_without_debug_set is defined.
 
//Wide String support has been untested for so long that it probably does not work, and may be removed? 2022-05-28
//#define tb_with_wide_string        ///< Allows an Opt-In for using std::wstring vs std::string implementation throughout framework.
 
//If unspecified, setup the debug/release state based on DEBUG or _DEBUG being defined.
//Note: 2023-08-31: Before today tb_public_build was being since at least 2021, and didn't appear below. Which meant that
//  tb_release_build was ALSO defined while tb_public_build was defined. Going forward only one _build config is defined
//  in a given build. It seemed code (at least in TurtleBrains, ICE and TrackBuilder) was generally checking against
//  tb_debug_build for special debug code and tb_public_build for special ship conditions, while release just remained
//  in the middle. This should mean this change is acceptable and desired, but may find some projects with oddities.
#if !defined(tb_public_build) && !defined(tb_release_build) && !defined(tb_development_build) && !defined(tb_debug_build)
  #if !defined(DEBUG) && !defined(_DEBUG)
    #define tb_release_build
  #else
    #define tb_debug_build
  #endif
#endif /* tb_debug_build or tb_development_build or tb_release_build or tb_public_build*/
 
//Defines for the compiler being used, mainly to use specific 'features' of a compiler or, more likely, to avoid issues when building.
#if !defined(tb_visual_cpp) && !defined(tb_mingw)
  #if defined(_MSC_VER)
    #define tb_visual_cpp
  #elif defined(__MINGW32__)
    #define tb_mingw
  #endif
#endif /* compiler checks */
 
#if !defined(tb_with_debug_set) && !defined(tb_without_debug_set)
  #if defined(tb_debug_build)
    #define tb_with_debug_set
  #else
    #define tb_without_debug_set
  #endif
#endif
 
//Using the with/without options, enable the actual define used deeper in the framework.
#if !defined(tb_without_diagnostics) && !defined(tb_with_diagnostics)
#if !defined(tb_release_build) || defined(tb_with_debug_set)
  #define tb_with_diagnostics
#else
  #define tb_without_diagnostics
#endif
#endif
 
#if defined(tb_with_diagnostics)
#if !defined(tb_diagnose_opengl)
  #define tb_diagnose_opengl false
#endif
#else
#if !defined(tb_diagnose_opengl)
  #define tb_diagnose_opengl false
#endif
#endif
 
//--------------------------------------------------------------------------------------------------------------------//
//--------------------------------------------------------------------------------------------------------------------//
//--------------------------------------------------------------------------------------------------------------------//
 
#if !defined(tb_without_threading) && !defined(tb_with_threading)
  #define tb_with_threading
#elif defined(tb_without_threading) && defined(tb_with_threading)
  #warning Both tb_with_threading and tb_without_threading are defined, No threading used.
  #undef(tb_with_threading);
#endif
 
#if !defined(tb_without_audio) && !defined(tb_with_audio)
  #define tb_with_audio
#elif defined(tb_without_audio) && defined(tb_with_audio)
  #warning Both tb_with_audio and tb_without_audio are defined, No audio used.
  #undef(tb_with_audio)
#endif
 
#if !defined(tb_without_networking) && !defined(tb_with_networking)
  #define tb_with_networking
#elif defined(tb_without_networking) && defined(tb_with_networking)
  #warning Both tb_with_networking and tb_without_networking are defined, No networking used.
  #undef(tb_with_networking)
#endif
 
#if !defined(tb_without_input_devices) && !defined(tb_with_input_devices)
  #define tb_with_input_devices
#elif defined(tb_without_input_devices) && defined(tb_with_input_devices)
  #warning Both tb_with_input_devices and tb_without_input_devices are defined, No input devices used.
  #undef tb_with_input_devices
#endif
 
//  Uncaught emscripten_get_num_gamepads() can only be called after having first called
//  emscripten_sample_gamepad_data() and that function has returned EMSCRIPTEN_RESULT_SUCCESS!
//
//  2022-08-15: I believe the above has been mostly or completely dealt with in r1752 which has an accidental bad
//    commit message, so ignore that; I believe that code was running, and I know it was with this commented out,
//    however I am not aware if there were any other side effects, or if it actually worked as intended. Since
//    Rally of Rockets was cancelled the reason to support this vanished for now.
#if defined(tb_web) && defined(tb_with_input_devices)
  #undef tb_with_input_devices
  #if !defined(tb_without_input_devices)
    #define tb_without_input_devices
  #endif
#endif
 
#if !defined(tb_righthanded_math) && !defined(tb_lefthanded_math)
  // @note 2023-11-09: LeftHanded math isn't exactly supported but this begins to allow future support.
  #define tb_righthanded_math
#endif
 
//As of 2023-08-31 development_kit was deprecated and renamed to development_tools for consistency with other defines.
//  Once this makes its way into the SVN repo and the nightly builds are still building, this comment and the following
//  checks/warning can be removed. I don't believe any project has used any of these defines.
#if defined(tb_with_development_kit) || defined(tb_without_development_kit) || defined(tb_with_development) || defined(tb_without_development)
  #warning Development Kit defines have changed (2023-08-31) and should be tb_with_development_tools or tb_without_development_tools
#endif
 
#if !defined(tb_without_development_tools) && !defined(tb_with_development_tools)
  #if defined(tb_debug_build) || defined(tb_development_build)
    #define tb_with_development_tools
  #else
    #define tb_without_development_tools
  #endif
#elif defined(tb_without_development_tools) && defined(tb_with_development_tools)
  #warning Both tb_with_development_kit and tb_without_development_kit are defined, No development kit used.
  #undef tb_with_development_tools
#endif
 
#if !defined(tb_without_math_operators) && !defined(tb_with_math_operators)
  #define tb_with_math_operators
#elif defined(tb_without_math_operators) && defined(tb_with_math_operators)
  #warning Both tb_with_math_operators and tb_without_math_operators are defined, No math operators used.
  #undef tb_with_math_operators
#endif
 
#if !defined(tb_without_splash_screen) && !defined(tb_with_splash_screen)
  #define tb_with_splash_screen
#elif defined(tb_without_splash_screen) && defined(tb_with_splash_screen)
  #warning Both tb_with_splash_screen and tb_without_splash_screen are defined, No splash screen used.
  #undef tb_with_splash_screen
#endif
 
#if !defined(tb_without_legacy_gl) && !defined(tb_with_legacy_gl)
  #define tb_with_legacy_gl
#elif defined(tb_without_legacy_gl) && defined(tb_with_legacy_gl)
  #warning Both tb_with_legacy_gl and tb_without_legacy_gl are defined, No legacy OpenGL used.
  #undef tb_with_legacy_gl
#endif
 
#if !defined(tb_without_internal_tests) && !defined(tb_with_internal_tests)
  #define tb_with_internal_tests
#elif defined(tb_without_internal_tests) && defined(tb_with_internal_tests)
  #warning Both tb_with_internal_tests and tb_without_internal_tests are defined, No internal tests used.
  #undef tb_with_internal_tests
#endif
 
#endif /* TurtleBrains_Configuration_hpp */