freeglut/3.2.1

from conans import ConanFile, CMake, tools

from conans.errors import ConanInvalidConfiguration

import os

required_conan_version = ">=1.43.0"

class freeglutConan(ConanFile):

    name = "freeglut"

    description = "Open-source alternative to the OpenGL Utility Toolkit (GLUT) library"

    topics = ("freeglut", "opengl", "gl", "glut", "utility", "toolkit", "graphics")

    url = "https://github.com/conan-io/conan-center-index"

    homepage = "http://freeglut.sourceforge.net"

    license = "X11"

    settings = "os", "arch", "compiler", "build_type"

    options = {

        "shared": [True, False],

        "fPIC": [True, False],

        "gles": [True, False],

        "print_errors_at_runtime": [True, False],

        "print_warnings_at_runtime": [True, False],

        "replace_glut": [True, False],

    }

    default_options = {

        "shared": False,

        "fPIC": True,

        "gles": False,

        "print_errors_at_runtime": True,

        "print_warnings_at_runtime": True,

        "replace_glut": True,

    }

    generators = "cmake"

    _cmake = None

    @property

    def _source_subfolder(self):

        return "source_subfolder"

    @property

    def _build_subfolder(self):

        return "build_subfolder"

    def export_sources(self):

        self.copy("CMakeLists.txt")

        for patch in self.conan_data.get("patches", {}).get(self.version, []):

            self.copy(patch["patch_file"])

    def config_options(self):

        if self.settings.os == "Windows":

            del self.options.fPIC

    def configure(self):

        if self.options.shared:

            del self.options.fPIC

        del self.settings.compiler.libcxx

        del self.settings.compiler.cppstd

    def requirements(self):

        self.requires("opengl/system")

        self.requires("glu/system")

        if self.settings.os == "Linux":

            self.requires("xorg/system")

    def validate(self):

        if self.settings.os == "Macos":

            # see https://github.com/dcnieho/FreeGLUT/issues/27

            # and https://sourceforge.net/p/freeglut/bugs/218/

            # also, it seems to require `brew cask install xquartz`

            raise ConanInvalidConfiguration("%s does not support macos" % self.name)

        if (self.settings.compiler == "gcc" and self.settings.compiler.version >= tools.Version("10.0")) or \

            (self.settings.compiler == "clang" and self.settings.compiler.version >= tools.Version("11.0")):

            # see https://github.com/dcnieho/FreeGLUT/issues/86

            raise ConanInvalidConfiguration("%s does not support gcc >= 10 and clang >= 11" % self.name)

    def source(self):

        tools.get(**self.conan_data["sources"][self.version],

                  strip_root=True, destination=self._source_subfolder)

    def _configure_cmake(self):

        if self._cmake:

            return self._cmake

        # See https://github.com/dcnieho/FreeGLUT/blob/44cf4b5b85cf6037349c1c8740b2531d7278207d/README.cmake

        self._cmake = CMake(self, set_cmake_flags=True)

        self._cmake.definitions["FREEGLUT_BUILD_DEMOS"] = False

        self._cmake.definitions["FREEGLUT_BUILD_STATIC_LIBS"] = not self.options.shared

        self._cmake.definitions["FREEGLUT_BUILD_SHARED_LIBS"] = self.options.shared

        self._cmake.definitions["FREEGLUT_GLES"] = self.options.gles

        self._cmake.definitions["FREEGLUT_PRINT_ERRORS"] = self.options.print_errors_at_runtime

        self._cmake.definitions["FREEGLUT_PRINT_WARNINGS"] = self.options.print_warnings_at_runtime

        self._cmake.definitions["FREEGLUT_INSTALL_PDB"] = False

        self._cmake.definitions["INSTALL_PDB"] = False

        self._cmake.definitions["FREEGLUT_REPLACE_GLUT"] = self.options.replace_glut

        # cmake.definitions["FREEGLUT_WAYLAND"] = "ON" if self.options.wayland else "OFF" # nightly version only as of now

        self._cmake.configure(build_folder=self._build_subfolder)

        return self._cmake

    def build(self):

        cmake = self._configure_cmake()

        cmake.build()

    def package(self):

        self.copy(pattern="COPYING", dst="licenses", src=self._source_subfolder)

        cmake = self._configure_cmake()

        cmake.install()

        tools.rmdir(os.path.join(self.package_folder, "lib", "pkgconfig"))

        tools.rmdir(os.path.join(self.package_folder, "lib", "cmake"))

    def package_info(self):

        config_target = "freeglut" if self.options.shared else "freeglut_static"

        pkg_config = "freeglut" if self.settings.os == "Windows" else "glut"

        self.cpp_info.set_property("cmake_find_mode", "both")

        self.cpp_info.set_property("cmake_module_file_name", "GLUT")

        self.cpp_info.set_property("cmake_module_target_name", "GLUT::GLUT")

        self.cpp_info.set_property("cmake_file_name", "FreeGLUT")

        self.cpp_info.set_property("cmake_target_name", "FreeGLUT::{}".format(config_target))

        self.cpp_info.set_property("pkg_config_name", pkg_config)

        # TODO: back to global scope in conan v2 once cmake_find_package_* generators removed

        self.cpp_info.components["freeglut_"].libs = tools.collect_libs(self)

        if self.settings.os == "Linux":

            self.cpp_info.components["freeglut_"].system_libs.extend(["pthread", "m", "dl", "rt"])

        elif self.settings.os == "Windows":

            if not self.options.shared:

                self.cpp_info.components["freeglut_"].defines.append("FREEGLUT_STATIC=1")

            self.cpp_info.components["freeglut_"].defines.append("FREEGLUT_LIB_PRAGMAS=0")

            self.cpp_info.components["freeglut_"].system_libs.extend(["glu32", "gdi32", "winmm", "user32"])

        # TODO: to remove in conan v2 once cmake_find_package_* & pkg_config generators removed

        self.cpp_info.names["cmake_find_package"] = "GLUT"

        self.cpp_info.names["cmake_find_package_multi"] = "FreeGLUT"

        self.cpp_info.names["pkg_config"] = pkg_config

        self.cpp_info.components["freeglut_"].names["cmake_find_package"] = "GLUT"

        self.cpp_info.components["freeglut_"].set_property("cmake_module_target_name", "GLUT::GLUT")

        self.cpp_info.components["freeglut_"].names["cmake_find_package_multi"] = config_target

        self.cpp_info.components["freeglut_"].set_property("cmake_target_name", "FreeGLUT::{}".format(config_target))

        self.cpp_info.components["freeglut_"].set_property("pkg_config_name", pkg_config)

        self.cpp_info.components["freeglut_"].requires.extend(["opengl::opengl", "glu::glu"])

        if self.settings.os == "Linux":

            self.cpp_info.components["freeglut_"].requires.append("xorg::xorg")