xz_utils: conan v2 support #13038
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,16 @@ | ||
| from conan import ConanFile | ||
| from conan.errors import ConanException | ||
| from conan.tools.apple import fix_apple_shared_install_name | ||
| from conan.tools.env import VirtualBuildEnv | ||
| from conan.tools.files import collect_libs, copy, get, rename, replace_in_file, rm, rmdir, save | ||
| from conan.tools.gnu import Autotools, AutotoolsToolchain | ||
| from conan.tools.layout import basic_layout | ||
| from conan.tools.microsoft import is_msvc, is_msvc_static_runtime, MSBuild, MSBuildToolchain, unix_path | ||
| from conan.tools.scm import Version | ||
| import os | ||
| import textwrap | ||
|
|
||
| required_conan_version = ">=1.52.0" | ||
|
|
||
|
|
||
| class XZUtils(ConanFile): | ||
|
|
@@ -28,24 +35,18 @@ class XZUtils(ConanFile): | |
| "fPIC": True, | ||
| } | ||
|
|
||
| @property | ||
| def _settings_build(self): | ||
| return getattr(self, "settings_build", self.settings) | ||
|
|
||
| @property | ||
| def _effective_msbuild_type(self): | ||
| # treat "RelWithDebInfo" and "MinSizeRel" as "Release" | ||
| # there is no DebugMT configuration in upstream vcxproj, we patch Debug configuration afterwards | ||
| return "{}{}".format( | ||
| "Debug" if self.settings.build_type == "Debug" else "Release", | ||
| "MT" if is_msvc_static_runtime(self) and self.settings.build_type != "Debug" else "", | ||
| ) | ||
|
|
||
| def config_options(self): | ||
| if self.settings.os == "Windows": | ||
|
|
@@ -54,133 +55,179 @@ def config_options(self): | |
| def configure(self): | ||
| if self.options.shared: | ||
| del self.options.fPIC | ||
| try: | ||
| del self.settings.compiler.libcxx | ||
| except Exception: | ||
| pass | ||
| try: | ||
| del self.settings.compiler.cppstd | ||
| except Exception: | ||
| pass | ||
|
|
||
| def layout(self): | ||
| basic_layout(self, src_folder="src") | ||
|
|
||
| def build_requirements(self): | ||
| if self._settings_build.os == "Windows" and not is_msvc(self) and \ | ||
| not self.conf.get("tools.microsoft.bash:path", default=False, check_type=bool): | ||
| self.tool_requires("msys2/cci.latest") | ||
|
|
||
| def source(self): | ||
| get(self, **self.conan_data["sources"][self.version], | ||
| destination=self.source_folder, strip_root=True) | ||
|
|
||
| def generate(self): | ||
| if is_msvc(self): | ||
| tc = MSBuildToolchain(self) | ||
| tc.generate() | ||
| else: | ||
| tc = AutotoolsToolchain(self) | ||
| tc.configure_args.append("--disable-doc") | ||
| if self.settings.build_type == "Debug": | ||
| tc.configure_args.append("--enable-debug") | ||
| tc.generate() | ||
| env = VirtualBuildEnv(self) | ||
| env.generate() | ||
|
|
||
| def _fix_msvc_platform_toolset(self, vcxproj_file, old_toolset): | ||
| platform_toolset = { | ||
| "Visual Studio": { | ||
| "8": "v80", | ||
| "9": "v90", | ||
| "10": "v100", | ||
| "11": "v110", | ||
| "12": "v120", | ||
| "14": "v140", | ||
| "15": "v141", | ||
| "16": "v142", | ||
| "17": "v143", | ||
| }, | ||
| "msvc": { | ||
| "170": "v110", | ||
| "180": "v120", | ||
| "190": "v140", | ||
| "191": "v141", | ||
| "192": "v142", | ||
| "193": "v143", | ||
| } | ||
| }.get(str(self.settings.compiler), {}).get(str(self.settings.compiler.version)) | ||
| if not platform_toolset: | ||
| raise ConanException( | ||
| f"Unkown platform toolset for {self.settings.compiler} {self.settings.compiler.version}", | ||
| ) | ||
| replace_in_file( | ||
| self, | ||
| vcxproj_file, | ||
| f"<PlatformToolset>{old_toolset}</PlatformToolset>", | ||
| f"<PlatformToolset>{platform_toolset}</PlatformToolset>", | ||
| ) | ||
|
|
||
| def _build_msvc(self): | ||
| if Version(self.version) == "5.2.4": | ||
| # Relax Windows SDK restriction | ||
| # Workaround is required only for 5.2.4 because since 5.2.5 WindowsTargetPlatformVersion is dropped from vcproj file | ||
| # https://developercommunity.visualstudio.com/content/problem/140294/windowstargetplatformversion-makes-it-impossible-t.html | ||
| windows_target_platform_version_old = "<WindowsTargetPlatformVersion>10.0.15063.0</WindowsTargetPlatformVersion>" | ||
| replace_in_file(self, os.path.join(self.source_folder, "windows", "vs2017", "liblzma.vcxproj"), | ||
| windows_target_platform_version_old, "") | ||
| replace_in_file(self, os.path.join(self.source_folder, "windows", "vs2017", "liblzma_dll.vcxproj"), | ||
| windows_target_platform_version_old, "") | ||
|
|
||
| # TODO: Find a way to inject conantoolchain.props content from MSBuildToolchain | ||
| # For the moment all the logic below is a big trick & doesn't honor custom cflags, cxxflags & ldflags from profile | ||
| # and arch different than x86 & x86_64 | ||
|
|
||
| # windows\INSTALL-MSVC.txt | ||
| if (self.settings.compiler == "Visual Studio" and Version(self.settings.compiler) >= "15") or \ | ||
| (self.settings.compiler == "msvc" and Version(self.settings.compiler) >= "191"): | ||
| msvc_version = "vs2017" | ||
| old_toolset = "v141" | ||
| else: | ||
| msvc_version = "vs2013" | ||
| old_toolset = "v120" | ||
| build_script_folder = os.path.join(self.source_folder, "windows", msvc_version) | ||
|
|
||
| # TODO: replace by some conan helper function (https://github.com/conan-io/conan/issues/12155)? | ||
| liblzma_vcxproj = os.path.join(build_script_folder, "liblzma.vcxproj") | ||
| liblzma_dll_vcxproj = os.path.join(build_script_folder, "liblzma_dll.vcxproj") | ||
| self._fix_msvc_platform_toolset(liblzma_vcxproj, old_toolset) | ||
| self._fix_msvc_platform_toolset(liblzma_dll_vcxproj, old_toolset) | ||
|
|
||
| # Patch Debug configuration if runtime is MT since there is no DebugMT configuration in upstream vcxproj | ||
| if self.settings.build_type == "Debug" and is_msvc_static_runtime(self): | ||
| replace_in_file(self, liblzma_vcxproj, "MultiThreadedDebugDLL", "MultiThreadedDebug") | ||
| replace_in_file(self, liblzma_dll_vcxproj, "MultiThreadedDebugDLL", "MultiThreadedDebug") | ||
|
|
||
| target = "liblzma_dll" if self.options.shared else "liblzma" | ||
| msbuild = MSBuild(self) | ||
| msbuild.build_type = self._effective_msbuild_type | ||
| msbuild.platform = "Win32" if self.settings.arch == "x86" else msbuild.platform | ||
| msbuild.build(os.path.join(build_script_folder, "xz_win.sln"), targets=[target]) | ||
|
|
||
| def build(self): | ||
| if is_msvc(self): | ||
| self._build_msvc() | ||
| else: | ||
| autotools = Autotools(self) | ||
| self.win_bash = True | ||
| autotools.configure() | ||
| autotools.make() | ||
| self.win_bash = None | ||
|
There was a problem hiding this comment. @memsharded could you confirm this is the canonical way to conditionally enable win_bash in conan v2 methods (for this case it's for MinGW, and we ensure that a bash is available on windows build machine by adding There was a problem hiding this comment. I've tested locally on windows with MinGW. It works... almost: It fails during installation because install path is not converted to unix path: There was a problem hiding this comment. There was a problem hiding this comment. That's it. If I replace There was a problem hiding this comment. Here we go: conan-io/conan#12153 & conan-io/conan#12154 There was a problem hiding this comment. @SpaceIm Thank you very much for checking it. The new MSBuild is still limited in terms of features, compared to the legacy. |
||
|
|
||
| def package(self): | ||
| copy(self, "COPYING", src=self.source_folder, dst=os.path.join(self.package_folder, "licenses")) | ||
| if is_msvc(self): | ||
| inc_dir = os.path.join(self.source_folder, "src", "liblzma", "api") | ||
| copy(self, "*.h", src=inc_dir, dst=os.path.join(self.package_folder, "include"), keep_path=True) | ||
| arch = {"x86": "Win32", "x86_64": "x64"}.get(str(self.settings.arch)) | ||
| target = "liblzma_dll" if self.options.shared else "liblzma" | ||
| if (self.settings.compiler == "Visual Studio" and Version(self.settings.compiler) >= "15") or \ | ||
| (self.settings.compiler == "msvc" and Version(self.settings.compiler) >= "191"): | ||
| msvc_version = "vs2017" | ||
| else: | ||
| msvc_version = "vs2013" | ||
| bin_dir = os.path.join(self.source_folder, "windows", msvc_version, | ||
| self._effective_msbuild_type, arch, target) | ||
| copy(self, "*.lib", src=bin_dir, dst=os.path.join(self.package_folder, "lib"), keep_path=False) | ||
| if self.options.shared: | ||
| copy(self, "*.dll", src=bin_dir, dst=os.path.join(self.package_folder, "bin"), keep_path=False) | ||
| rename(self, os.path.join(self.package_folder, "lib", "liblzma.lib"), | ||
| os.path.join(self.package_folder, "lib", "lzma.lib")) | ||
| else: | ||
| autotools = Autotools(self) | ||
| self.win_bash = True | ||
| # TODO: replace by autotools.install() once https://github.com/conan-io/conan/issues/12153 fixed | ||
| autotools.install(args=[f"DESTDIR={unix_path(self, self.package_folder)}"]) | ||
| self.win_bash = None | ||
| rmdir(self, os.path.join(self.package_folder, "lib", "pkgconfig")) | ||
| rmdir(self, os.path.join(self.package_folder, "share")) | ||
| rm(self, "*.la", os.path.join(self.package_folder, "lib")) | ||
| fix_apple_shared_install_name(self) | ||
|
|
||
| self._create_cmake_module_variables( | ||
| os.path.join(self.package_folder, self._module_file_rel_path), | ||
| ) | ||
|
|
||
| def _create_cmake_module_variables(self, module_file): | ||
| # TODO: also add LIBLZMA_HAS_AUTO_DECODER, LIBLZMA_HAS_EASY_ENCODER & LIBLZMA_HAS_LZMA_PRESET | ||
| content = textwrap.dedent(f"""\ | ||
| set(LIBLZMA_FOUND TRUE) | ||
| if(DEFINED LibLZMA_INCLUDE_DIRS) | ||
| set(LIBLZMA_INCLUDE_DIRS ${{LibLZMA_INCLUDE_DIRS}}) | ||
| endif() | ||
| if(DEFINED LibLZMA_LIBRARIES) | ||
| set(LIBLZMA_LIBRARIES ${{LibLZMA_LIBRARIES}}) | ||
| endif() | ||
| set(LIBLZMA_VERSION_MAJOR {Version(self.version).major}) | ||
| set(LIBLZMA_VERSION_MINOR {Version(self.version).minor}) | ||
| set(LIBLZMA_VERSION_PATCH {Version(self.version).patch}) | ||
| set(LIBLZMA_VERSION_STRING "{self.version}") | ||
| """) | ||
| save(self, module_file, content) | ||
|
|
||
| @property | ||
| def _module_file_rel_path(self): | ||
| return os.path.join("lib", "cmake", f"conan-official-{self.name}-variables.cmake") | ||
|
|
||
| def package_info(self): | ||
| self.cpp_info.set_property("cmake_find_mode", "both") | ||
|
|
@@ -192,7 +239,7 @@ def package_info(self): | |
| self.cpp_info.defines.append("LZMA_API_STATIC") | ||
| if self.settings.os in ["Linux", "FreeBSD"]: | ||
| self.cpp_info.system_libs.append("pthread") | ||
| self.cpp_info.libs = collect_libs(self) | ||
|
|
||
| # TODO: to remove in conan v2 once cmake_find_package* & pkg_config generators removed | ||
| self.cpp_info.names["cmake_find_package"] = "LibLZMA" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,26 @@ | ||
| cmake_minimum_required(VERSION 3.1) | ||
| project(test_package LANGUAGES C) | ||
|
|
||
| find_package(LibLZMA REQUIRED) | ||
|
|
||
| add_executable(${PROJECT_NAME} test_package.c) | ||
| target_link_libraries(${PROJECT_NAME} PRIVATE LibLZMA::LibLZMA) | ||
|
|
||
| # Test whether variables from https://cmake.org/cmake/help/latest/module/FindLibLZMA.html | ||
| # are properly defined in conan generators | ||
| set(_custom_vars | ||
| LIBLZMA_FOUND | ||
| LIBLZMA_INCLUDE_DIRS | ||
| LIBLZMA_LIBRARIES | ||
| LIBLZMA_VERSION_MAJOR | ||
| LIBLZMA_VERSION_MINOR | ||
| LIBLZMA_VERSION_PATCH | ||
| LIBLZMA_VERSION_STRING | ||
| ) | ||
| foreach(_custom_var ${_custom_vars}) | ||
| if(DEFINED _custom_var) | ||
| message(STATUS "${_custom_var}: ${${_custom_var}}") | ||
| else() | ||
| message(FATAL_ERROR "${_custom_var} not defined") | ||
| endif() | ||
| endforeach() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,26 @@ | ||
| from conan import ConanFile | ||
| from conan.tools.build import can_run | ||
| from conan.tools.cmake import CMake, cmake_layout | ||
| import os | ||
|
|
||
|
|
||
| class TestPackageConan(ConanFile): | ||
| settings = "os", "arch", "compiler", "build_type" | ||
| generators = "CMakeToolchain", "CMakeDeps", "VirtualRunEnv" | ||
| test_type = "explicit" | ||
|
|
||
| def layout(self): | ||
| cmake_layout(self) | ||
|
|
||
| def requirements(self): | ||
| self.requires(self.tested_reference_str) | ||
|
|
||
| def build(self): | ||
| cmake = CMake(self) | ||
| cmake.configure() | ||
| cmake.build() | ||
|
|
||
| def test(self): | ||
| if can_run(self): | ||
| bin_path = os.path.join(self.cpp.build.bindirs[0], "test_package") | ||
| self.run(bin_path, env="conanrun") |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
upgrade_projectlogic is lost in this conan v2 migration, I don't know what is the equivalent in the newMSBuildbuild helper.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and it's required, it fails on Windows with Visual Studio 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
conan-io/conan#12155