Loading...
Searching...
No Matches
Classes | Public Types | List of all members
by::buildFeature Class Reference
Indep

Provides build-time information and feature detection. More...

#include <buildFeature.hpp>

Classes

struct  config
 Build configuration information. More...
 
struct  date
 Build date information. More...
 
struct  platform
 Platform information. More...
 
struct  time
 Build time information. More...
 
struct  version
 Version information. More...
 

Public Types

enum  platformType {
  PLATFORM_TYPE_START = -1 , WINDOW , LINUX , MACOS ,
  OTHERS , PLATFORM_TYPE_END
}
 
enum  buildType { BUILD_TYPE_START = -1 , DEBUG , RELEASE , BUILD_TYPE_END }
 

Detailed Description

Provides build-time information and feature detection.

Returns information defined in buildInformation.hpp, which is automatically generated by CMake. Contains build date/time, version, build OS, and binary type information.

The original values are defined as #define macros in buildInformation.hpp, so they can be used directly if needed. They are also frequently used in #ifdef conditionals.

Usage

if(buildFeature::config::isDbg())
platformAPI::unlimitCoreDump();
// Or directly use macros:
#ifdef BY_BUILD_PLATFORM_IS_WINDOWS
...
#endif
by::platformAPI::unlimitCoreDump
nbool unlimitCoreDump()
Enables unlimited core dump size for debugging.
Definition platformAPI.cpp:302
by::buildFeature::config::isDbg
static constexpr nbool isDbg()
Checks if this is a debug build.
Definition buildFeature.hpp:141
by::noWrap
Rich logging support with polymorphic type conversion.
Definition richLog.hpp:34
Remarks
Never manually modify values All values are automatically generated by CMake during build process.
Platform-specific code should stay in indep module According to byeol's architecture, platform-specific code must reside only in the indep module. It is not recommended to use conditional compilation with OS #ifdef or buildFeature::platform::getName() in modules above indep.
The documentation for this class was generated from the following file: