conan.tools.buildļƒ

conan.tools.build.cross_buildingļƒ

Available since: 1.46.0

def cross_building(conanfile=None, skip_x64_x86=False):

Check it we are cross building comparing the build and host settings. Returns True in the case that we are cross-building.

Parameters:

  • conanfile: Conanfile object, use always self.

  • skip_x64_x86: Will not consider the as cross-building the case of building in 64 bit architecture for 32 bit architecture, like build_arch=x86_64 and host_arch=x86 for example.

conan.tools.build.can_runļƒ

Available since: 1.49.0

def can_run(conanfile):

Validates whether is possible to run a non-native app on the same architecture. It returns the configuration value for tools.build.cross_building:can_run if exists, otherwise, it returns False if we are cross-building, else, True.

Itā€™s an useful feature for the case your architecture can run more than one target. For instance, Mac M1 machines can run both armv8 and x86_64.

Parameters:

  • conanfile: Conanfile object, use always self.

conan.tools.build.check_min_cppstdļƒ

Available since: 1.50.0

def check_min_cppstd(conanfile, cppstd, gnu_extensions=False)

Check if provided conanfile.settings.compiler.cppstd fits the minimal version required (specified in the argument cppstd). In case it doesnā€™t, a ConanInvalidConfiguration exception will be raised.

Parameters:

  • conanfile: The current recipe object. Always use self.

  • cppstd: Minimal cppstd version required.

  • gnu_extensions: GNU extension is required (e.g gnu17).

conan.tools.build.default_cppstdļƒ

Available since: 1.50.0

def default_cppstd(conanfile, compiler=None, compiler_version=None):

Get the default compiler.cppstd for the ā€œconanfile.settings.compilerā€ and ā€œconanfile settings.compiler_versionā€ or for the parameters ā€œcompilerā€ and ā€œcompiler_versionā€ if specified. Returns the default compiler.cppstd for the specified compiler.

Parameters:

  • conanfile: The current recipe object. Always use self.

  • compiler: Name of the compiler e.g. gcc

  • compiler_version: Version of the compiler e.g. 12

conan.tools.build.supported_cppstdļƒ

Available since: 1.50.0

def supported_cppstd(conanfile, compiler=None, compiler_version=None):

Get the a list of supported compiler.cppstd for the ā€œconanfile.settings.compilerā€ and ā€œconanfile.settings.compiler_versionā€ or for the parameters ā€œcompilerā€ and ā€œcompiler_versionā€ if specified. Returns a list of supported cppstd values.

Parameters:

  • conanfile: The current recipe object. Always use self.

  • compiler: Name of the compiler e.g: gcc

  • compiler_version: Version of the compiler e.g: 12

conan.tools.build.stdcpp_libraryļƒ

Available since: 1.54.0

def stdcpp_library(conanfile):

Get the valid name of the C++ standard library for the linker based on the current settings and its compiler.libcxx value. Returns None if compiler.libcxx value is unknown.

Parameters:

  • conanfile: The current recipe object. Always use self.

conan.tools.build.build_jobsļƒ

Available since: 1.43.0

def build_jobs(conanfile):

Returns the number of CPUs available for parallel builds. It returns the configuration value for tools.build:jobs if exists, otherwise, it defaults to the helper function _cpu_count(). _cpu_count() reads cgroup to detect the configured number of CPUs. Currently, there are two versions of cgroup available.

In the case of cgroup v1, if the data in cgroup is invalid, processor detection comes into play. Whenever processor detection is not enabled, build_jobs() will safely return 1.

In the case of cgroup v2, if no limit is set, processor detection is used. When the limit is set, the behavior is as described in cgroup v1.

Parameters:

  • conanfile: The current recipe object. Always use self.

conan.tools.build.cppstd_flagļƒ

Available since: 1.64.0

def cppstd_flag(conanfile):

Returns flags specific to the C++ standard based on the conanfile.settings.compiler, conanfile.settings.compiler.version and conanfile.settings.compiler.cppstd.

It also considers when using GNU extension in settings.compiler.cppstd, reflecting it in the compiler flag. Currently, it supports GCC, Clang, AppleClang, MSVC, Intel, MCST-LCC.

In case there is no settings.compiler or settings.cppstd in the profile, the result will be an empty string.

Parameters:

  • conanfile: The current recipe object. Always use self.