conan.tools.microsoft.visual¶
check_min_vs¶
- check_min_vs(conanfile, version, raise_invalid=True)¶
This is a helper method to allow the migration of 1.X -> 2.0 and VisualStudio -> msvc settings without breaking recipes. The legacy “Visual Studio” with different toolset is not managed, not worth the complexity.
- Parameters:
raise_invalid –
bool
Whether to raise or return False if the version check failsconanfile –
< ConanFile object >
The current recipe object. Always useself
.version –
str
Visual Studio or msvc version number.
Example:
def validate(self):
check_min_vs(self, "192")
msvc_runtime_flag¶
- msvc_runtime_flag(conanfile)¶
Gets the MSVC runtime flag given the
compiler.runtime
value from the settings.- Parameters:
conanfile –
< ConanFile object >
The current recipe object. Always useself
.- Returns:
str
runtime flag.
is_msvc¶
- is_msvc(conanfile, build_context=False)¶
Validates if the current compiler is
msvc
.- Parameters:
conanfile –
< ConanFile object >
The current recipe object. Always useself
.build_context – If True, will use the settings from the build context, not host ones
- Returns:
bool
True, if the host compiler ismsvc
, otherwise, False.
is_msvc_static_runtime¶
- is_msvc_static_runtime(conanfile)¶
Validates when building with Visual Studio or msvc and MT on runtime.
- Parameters:
conanfile –
< ConanFile object >
The current recipe object. Always useself
.- Returns:
bool
True, ifmsvc + runtime MT
. Otherwise, False.
msvs_toolset¶
- msvs_toolset(conanfile)¶
Returns the corresponding platform toolset based on the compiler of the given conanfile. In case no toolset is configured in the profile, it will return a toolset based on the compiler version, otherwise, it will return the toolset from the profile. When there is no compiler version neither toolset configured, it will return None It supports Visual Studio, msvc and Intel.
- Parameters:
conanfile – Conanfile instance to access settings.compiler
- Returns:
A toolset when compiler.version is valid or compiler.toolset is configured. Otherwise, None.
conan.tools.microsoft.subsystems¶
unix_path¶
- unix_path(conanfile, path, scope='build')¶