sfml: Test suport for SFML 3 rc1

recipes/sfml/3.x/conandata.yml

@@ -0,0 +1,17 @@
+sources:
+  "3.0.0-rc.1":
+    url: "https://github.com/SFML/SFML/archive/refs/tags/3.0.0-rc.1.tar.gz"
+    sha256: "680da7f4398a5766787ea9ca69dd1c9a4871cf3c4834ddfad922425c6f792dc8"
+patches:
+  "3.0.0-rc.1":
+    - patch_file: "patches/3.0.0-0001-use-zlib-bzip-freetype-conan.patch"
+      patch_description: "use zlib bzip2 and freetype from conan"
+      patch_type: "conan"
+    # TODO: Delete this one when this gets released in a future rc or final version
+    - patch_file: "patches/3.0.0-0002-windows-arm-build.patch"
+      patch_description: "fix windows arm build"
+      patch_type: "backport"
+      patch_source: "https://github.com/SFML/SFML/pull/3229"
+    - patch_file: "patches/3.0.0-0003-conan-choose-osx-deplyment-target.patch"
+      patch_description: "let conan choose osx deployment target"
+      patch_type: "conan"

recipes/sfml/3.x/conanfile.py

@@ -0,0 +1,333 @@
+from conan import ConanFile
+from conan.errors import ConanInvalidConfiguration
+from conan.tools.android import android_abi
+from conan.tools.build import check_min_cppstd
+from conan.tools.cmake import CMake, CMakeDeps, CMakeToolchain, cmake_layout
+from conan.tools.env import VirtualBuildEnv
+from conan.tools.files import apply_conandata_patches, export_conandata_patches, get, rmdir, copy, replace_in_file
+from conan.tools.microsoft import is_msvc_static_runtime
+from conan.tools.scm import Version
+import os
+
+required_conan_version = ">=1.53.0"
+
+
+class SfmlConan(ConanFile):
+    name = "sfml"
+    description = "Simple and Fast Multimedia Library."
+    license = "Zlib"
+    url = "https://github.com/conan-io/conan-center-index"
+    homepage = "https://www.sfml-dev.org"
+    topics = ("multimedia", "games", "graphics", "audio")
+    package_type = "library"
+    settings = "os", "arch", "compiler", "build_type"
+    options = {
+        "shared": [True, False],
+        "fPIC": [True, False],
+        # modules
+        "window": [True, False],
+        "graphics": [True, False],
+        "network": [True, False],
+        "audio": [True, False],
+        # window module options
+        "opengl": ["es", "desktop"],
+        "use_drm": [True, False],  # Linux only
+        # "use_mesa3d": [True, False],  # Windows only, not available in CCI
+
+    }
+    default_options = {
+        "shared": False,
+        "fPIC": True,
+        "window": True,
+        "graphics": True,
+        "network": True,
+        "audio": True,
+        "opengl": "desktop",
+        "use_drm": False,
+        # "use_mesa3d": False,
+    }
+
+    # TODO: Fill as needed, can't find an official source,
+    #  going by compilation failures right now
+    @property
+    def _min_compiler_versions(self):
+        return {
+            "gcc": 9
+        }
+
+    @property
+    def _min_cppstd(self):
+        return 17
+
+    def export_sources(self):
+        export_conandata_patches(self)
+
+    def config_options(self):
+        if self.settings.os == "Windows":
+            del self.options.fPIC
+        else:
+            pass
+            # TODO: Handle mesa3d
+            # del self.options.use_mesa3d
+
+        # As per CMakeLists.txt#L44, Android is always shared
+        if self.settings.os == "Android":
+            del self.options.shared
+            del self.options.fPIC
+            self.package_type = "shared-library"
+
+    def configure(self):
+        if self.options.get_safe("shared"):
+            self.options.rm_safe("fPIC")
+
+        if not self.options.window:
+            del self.options.opengl
+            del self.options.use_drm
+        elif self.settings.os != "Linux":
+            del self.options.use_drm  # For Window module but only available on Linux
+
+    def layout(self):
+        cmake_layout(self, src_folder="src")
+
+    def requirements(self):
+        if self.options.window:
+            if self.settings.os in ["Linux", "FreeBSD"]:
+                if self.options.get_safe("use_drm"):
+                    self.requires("libdrm/2.4.120")
+                    # TODO, for now this branch is validate()ed out
+                    # self.requires("libgbm/20.3.0")  # Missing in CCI?
+                else:
+                    self.requires("xorg/system")
+                if self.settings.os == "Linux":
+                    self.requires("libudev/system")
+
+            if self.settings.os not in ("iOS", "Android"):  # Handled as a framework
+                self.requires("opengl/system")
+
+        if self.options.graphics:
+            if self.settings.os == "Android" or self.settings.os == "iOS":
+                self.requires("zlib/[>=1.2.11 <2]")
+            if self.settings.os == "iOS":
+                self.requires("bzip2/1.0.8")
+            self.requires("freetype/2.13.2")
+
+        if self.options.audio:
+            self.requires("vorbis/1.3.7")
+            self.requires("flac/1.4.3")
+
+    def build_requirements(self):
+        self.tool_requires("cmake/[>=3.24 <4]")
+
+    def validate(self):
+        if self.settings.compiler.cppstd:
+            check_min_cppstd(self, self._min_cppstd)
+
+        compiler_version = self._min_compiler_versions.get(str(self.settings.compiler))
+        if compiler_version and (Version(self.settings.compiler.version) < compiler_version):
+            raise ConanInvalidConfiguration(f"{self.name} requires C++{self._min_cppstd} with {self.settings.compiler} {compiler_version} or newer")
+
+        if self.options.graphics and not self.options.window:
+            raise ConanInvalidConfiguration(f"-o={self.ref}:graphics=True requires -o={self.ref}:window=True")
+
+        if self.options.get_safe("shared") and is_msvc_static_runtime(self):
+            raise ConanInvalidConfiguration(f"{self.ref} does not support shared libraries with static runtime")
+
+        if self.settings.os not in ["Windows", "Linux", "FreeBSD", "Android", "Macos", "iOS"]:
+            raise ConanInvalidConfiguration(f"{self.ref} not supported on {self.settings.os}")
+
+        # TODO: Mesa support, or another way to get gbm
+        if self.options.get_safe("use_drm"):
+            raise ConanInvalidConfiguration(f"{self.ref} does not support -o=use_drm=True, contributions are welcome")
+
+    def validate_build(self):
+        if self.settings.os == "Macos" and self.settings.compiler != "apple-clang":
+            raise ConanInvalidConfiguration(f"{self.ref} is not supported on {self.settings.os} with {self.settings.compiler}")
+
+    def source(self):
+        get(self, **self.conan_data["sources"][self.version], strip_root=True)
+
+    def generate(self):
+        venv = VirtualBuildEnv(self)
+        venv.generate()
+        tc = CMakeToolchain(self)
+
+        tc.variables["SFML_BUILD_WINDOW"] = self.options.window
+        tc.variables["SFML_BUILD_GRAPHICS"] = self.options.graphics
+        tc.variables["SFML_BUILD_NETWORK"] = self.options.network
+        tc.variables["SFML_BUILD_AUDIO"] = self.options.audio
+
+        if self.options.window:
+            tc.variables["SFML_OPENGL_ES"] = True if self.options.opengl == "es" else False
+
+            if self.settings.os == "Linux":
+                tc.variables["SFML_USE_DRM"] = self.options.use_drm
+
+        tc.variables["SFML_GENERATE_PDB"] = False  # PDBs not allowed in CCI
+
+        if self.settings.os == "Windows":
+            tc.cache_variables["SFML_USE_STATIC_STD_LIBS"] = is_msvc_static_runtime(self)
+
+        tc.cache_variables["SFML_USE_SYSTEM_DEPS"] = True
+
+        if self.settings.os == "Windows":
+            tc.cache_variables["SFML_USE_MESA3D"] = False  # self.options.use_mesa3d
+
+        tc.variables["SFML_INSTALL_PKGCONFIG_FILES"] = False
+        tc.cache_variables["SFML_WARNINGS_AS_ERRORS"] = False
+
+        # Tip: You can use this locally to test the extras when adding a new version,
+        # uncomment both to build examples, or run them manually
+        # tc.variables["SFML_CONFIGURE_EXTRAS"] = True
+        # tc.variables["SFML_BUILD_EXAMPLES"] = True
+
+        # TODO: Remove in Conan 2
+        if not self.settings.compiler.cppstd:
+            tc.cache_variables["CMAKE_CXX_STANDARD"] = self._min_cppstd
+
+        tc.generate()
+        deps = CMakeDeps(self)
+        deps.set_property("flac", "cmake_file_name", "FLAC")
+        deps.generate()
+
+    def _patch_sources(self):
+        apply_conandata_patches(self)
+        # Remove cocoa example - xcode needed
+        # TODO: Remove once we no longer build examples
+        replace_in_file(self, os.path.join(self.source_folder, "examples", "CMakeLists.txt"),
+                        "add_subdirectory(cocoa)", "")
+
+    def build(self):
+        self._patch_sources()
+        cmake = CMake(self)
+        cmake.configure()
+        cmake.build()
+
+    def package(self):
+        copy(self, "license.md", self.source_folder, os.path.join(self.package_folder, "licenses"))
+        cmake = CMake(self)
+        cmake.install()
+
+        rmdir(self, os.path.join(self.package_folder, "lib", "cmake"))
+        rmdir(self, os.path.join(self.package_folder, "share"))
+
+    def _default_module(self, name):
+        self.cpp_info.components[name].set_property("cmake_target_name", f"SFML::{name.capitalize()}")
+
+        libname = f"sfml-{name}"
+        # main is always static as per SFML/Main/CMakeLists.txt#L16 STATIC definition
+        if name != "main" and (self.options.get_safe("shared") or self.settings.os == "Android"):
+            if self.settings.build_type == "Debug":
+                libname += "-d"
+            if self.settings.os == "Windows":
+                # TODO: Windows shared does set_target_properties(${target} PROPERTIES SUFFIX "-${PROJECT_VERSION_MAJOR}${CMAKE_SHARED_LIBRARY_SUFFIX}")
+                # Should we handle it here? It compiles either way
+                pass
+        else:
+            libname += "-s"
+            self.cpp_info.components[name].defines = ["SFML_STATIC"]
+            if self.settings.build_type == "Debug":
+                libname += "-d"
+        self.cpp_info.components[name].libs = [libname]
+
+        # CMakeLists.txt#L87 - Android libs are in lib/<CMAKE_ANDROID_ARCH_ABI>
+        if self.settings.os == "Android":
+            self.cpp_info.components[name].libdirs = [os.path.join("lib", android_abi(self))]
+
+    def package_info(self):
+        self.cpp_info.set_property("cmake_file_name", "SFML")
+        self.cpp_info.set_property("pkg_config_name", "sfml-all")
+
+        # if self.options.get_safe("opengl") == "desktop":
+        # -DSFML_OPENGL_ES
+        # -DGL_GLEXT_PROTOTYPES
+
+        # TODO: libatomic when gcc for graphics and audio, but only if not available?
+        # code says: (e.g. Raspberry Pi 3 armhf), GCC requires linking libatomic to use <atomic> features
+
+        modules = ["system"]
+        if self.settings.os in ["Windows", "iOS", "Android"]:
+            modules.append("main")
+
+        modules.extend(module for module in ["window", "graphics", "network", "audio"] if self.options.get_safe(module))
+
+        for module in modules:
+            self._default_module(module)
+            if hasattr(self, f"_{module}_module"):
+                getattr(self, f"_{module}_module")()
+
+        # TODO: to remove in conan v2 once cmake_find_package* & pkg_config generators removed
+        self.cpp_info.names["cmake_find_package"] = "SFML"
+        self.cpp_info.names["cmake_find_package_multi"] = "SFML"
+        self.cpp_info.names["pkgconfig"] = "sfml-all"
+
+    def _system_module(self):
+        if self.settings.os in ["Linux", "FreeBSD"]:
+            self.cpp_info.components["system"].system_libs = ["pthread", "rt"]
+        elif self.settings.os == "Windows":
+            self.cpp_info.components["system"].system_libs = ["winmm"]
+        elif self.settings.os == "Android":
+            self.cpp_info.components["system"].system_libs = ["log", "android"]
+
+    def _window_module(self):
+        if self.options.window:
+            self.cpp_info.components["window"].requires = ["system"]
+            if self.settings.os in ["Linux", "FreeBSD"]:
+                self.cpp_info.components["window"].system_libs.append("dl")
+                if self.options.get_safe("use_drm"):
+                    self.cpp_info.components["window"].requires.append("libdrm::libdrm")
+                    # TODO
+                    # self.cpp_info.components["window"].requires.append("libgbm::libgbm")
+                else:
+                    self.cpp_info.components["window"].requires.extend(["xorg::x11", "xorg::xrandr", "xorg::xcursor", "xorg::xi"])
+
+            if self.settings.os == "iOS":
+                self.cpp_info.components["window"].frameworks = ["OpenGLES"]
+            elif self.settings.os == "Android":
+                self.cpp_info.components["window"].system_libs.extend(["egl", "GLESv2"])
+            else:
+                self.cpp_info.components["window"].requires.append("opengl::opengl")
+
+            if self.settings.os == "Linux":
+                self.cpp_info.components["window"].requires.append("libudev::libudev")
+            elif self.settings.os == "Windows":
+                self.cpp_info.components["window"].system_libs.extend(["gdi32", "winmm"])
+            elif self.settings.os == "FreeBSD":
+                self.cpp_info.components["window"].system_libs.append("usbhid")
+            elif self.settings.os == "Macos":
+                # CoreServices is pulled from Carbon, even if it does not show up in the upstream CMakeLists.txt
+                self.cpp_info.components["window"].frameworks = ["Foundation", "AppKit", "IOKit", "Carbon", "CoreServices"]
+            elif self.settings.os == "iOS":
+                self.cpp_info.components["window"].frameworks = ["Foundation", "UIKit", "CoreGraphics", "QuartzCore", "CoreMotion"]
+            elif self.settings.os == "Android":
+                self.cpp_info.components["window"].system_libs = ["android"]
+
+    def _graphics_module(self):
+        if self.options.graphics:
+            self.cpp_info.components["graphics"].requires = ["window"]
+            if self.settings.os == "Android" or self.settings.os == "iOS":
+                self.cpp_info.components["graphics"].requires.append("zlib::zlib")
+            if self.settings.os == "iOS":
+                self.cpp_info.components["graphics"].requires.append("bzip2::bzip2")
+            self.cpp_info.components["graphics"].requires.append("freetype::freetype")
+            # TODO: Atomic
+
+    def _network_module(self):
+        if self.options.network:
+            self.cpp_info.components["network"].requires = ["system"]
+
+            if self.settings.os == "Windows":
+                self.cpp_info.components["network"].system_libs = ["ws2_32"]
+
+    def _audio_module(self):
+        if self.options.audio:
+            self.cpp_info.components["audio"].requires = ["vorbis::vorbis", "flac::flac", "system"]
+            if self.settings.os == "iOS":
+                self.cpp_info.components["audio"].frameworks = ["Foundation", "CoreFoundation", "CoreAudio", "AudioToolbox", "AVFoundation"]
+            else:
+                self.cpp_info.components["audio"].requires.extend(["vorbis::vorbisfile", "vorbis::vorbisenc"])
+
+            if self.settings.os == "Android":
+                self.cpp_info.components["audio"].system_libs = ["android", "OpenSLES"]
+
+            if self.settings.os == "Linux":
+                self.cpp_info.components["audio"].system_libs = ["dl"]

recipes/sfml/3.x/patches/3.0.0-0001-use-zlib-bzip-freetype-conan.patch

@@ -0,0 +1,25 @@
+diff --git a/src/SFML/Graphics/CMakeLists.txt b/src/SFML/Graphics/CMakeLists.txt
+index 1e77eec..42bcbd5 100644
+--- a/src/SFML/Graphics/CMakeLists.txt
++++ b/src/SFML/Graphics/CMakeLists.txt
+@@ -111,13 +111,16 @@ endif()
+
+ # find external libraries
+ if(SFML_OS_ANDROID)
+-    target_link_libraries(sfml-graphics PRIVATE z)
++    find_package(ZLIB REQUIRED)
++    target_link_libraries(sfml-graphics PRIVATE ZLIB::ZLIB)
+ elseif(SFML_OS_IOS)
+-    target_link_libraries(sfml-graphics PRIVATE z bz2)
++    find_package(ZLIB REQUIRED)
++    find_package(BZip2 REQUIRED)
++    target_link_libraries(sfml-graphics PRIVATE ZLIB::ZLIB BZip2::BZip2)
+ endif()
+
+-find_package(Freetype REQUIRED)
+-target_link_libraries(sfml-graphics PRIVATE Freetype::Freetype)
++find_package(freetype REQUIRED)
++target_link_libraries(sfml-graphics PRIVATE freetype)
+
+ # add preprocessor symbols
+ target_compile_definitions(sfml-graphics PRIVATE "STBI_FAILURE_USERMSG")