New ccache binary recipe

Author: perseoGI

recipes/ccache/binary/ccache-autoinject.cmake

@@ -0,0 +1,25 @@
+include_guard()
+
+# Enable cache if available
+set(CACHE_OPTION "ccache" CACHE STRING "Compiler cache to be used")
+set(CACHE_OPTION_VALUES "ccache" "sccache")
+set(CCACHE_ARGS "base_dir=<CONAN_HOME>;hash_dir=false")
+set_property(CACHE CACHE_OPTION PROPERTY STRINGS ${CACHE_OPTION_VALUES})
+list(FIND CACHE_OPTION_VALUES ${CACHE_OPTION} CACHE_OPTION_INDEX)
+
+if(${CACHE_OPTION_INDEX} EQUAL -1)
+    message(
+      STATUS
+        "Using custom compiler cache system: '${CACHE_OPTION}', explicitly supported entries are ${CACHE_OPTION_VALUES}"
+    )
+endif()
+
+find_program(CACHE_BINARY NAMES ${CACHE_OPTION_VALUES})
+if(CACHE_BINARY)
+    message(STATUS "${CACHE_BINARY} found and enabled")
+    set(CMAKE_CXX_COMPILER_LAUNCHER "${CACHE_BINARY};${CCACHE_ARGS}" CACHE FILEPATH "CXX compiler cache used")
+    set(CMAKE_C_COMPILER_LAUNCHER "${CACHE_BINARY};${CCACHE_ARGS}" CACHE FILEPATH "C compiler cache used")
+else()
+    message(WARNING "${CACHE_OPTION} is enabled but was not found. Not using it")
+endif()
+

recipes/ccache/binary/conandata.yml

@@ -0,0 +1,14 @@
+sources:
+  "4.10.2":
+    Linux:
+      x86_64:
+        url: "https://github.com/ccache/ccache/releases/download/v4.10.2/ccache-4.10.2-linux-x86_64.tar.xz"
+        sha256: "80cab87bd510eca796467aee8e663c398239e0df1c4800a0b5dff11dca0b4f18"
+    Macos:
+      universal:
+        url: "https://github.com/ccache/ccache/releases/download/v4.10.2/ccache-4.10.2-darwin.tar.gz"
+        sha256: "d90514fff15943a8607e84e3f42d45f823915a92f99984f3fc88202f6295d1e8"
+    Windows:
+      x86_64:
+        url: "https://github.com/ccache/ccache/releases/download/v4.10.2/ccache-4.10.2-windows-x86_64.zip"
+        sha256: "6252f081876a9a9f700fae13a5aec5d0d486b28261d7f1f72ac11c7ad9df4da9"

recipes/ccache/binary/conanfile.py

@@ -0,0 +1,56 @@
+import os
+from pathlib import Path
+
+from conan import ConanFile
+from conan.errors import ConanInvalidConfiguration
+from conan.tools.files import get, copy, replace_in_file
+
+required_conan_version = ">=2.7"
+
+AUTOIJECT_CMAKE = "ccache-autoinject.cmake"
+
+class CcacheConan(ConanFile):
+    name = "ccache"
+    package_type = "application"
+    description = (
+        "Ccache (or “ccache”) is a compiler cache. It speeds up recompilation "
+        "by caching previous compilations and detecting when the same "
+        "compilation is being done again."
+    )
+    license = "GPL-3.0-or-later"
+    topics = ("compiler-cache", "recompilation", "cache", "compiler")
+    homepage = "https://ccache.dev"
+    url = "https://github.com/conan-io/conan-center-index"
+    settings = "os", "arch"
+    exports_sources = [AUTOIJECT_CMAKE]
+
+    def validate(self):
+        if self.settings.os != "Macos" and self.settings.arch != "x86_64":
+            raise ConanInvalidConfiguration("ccache binaries are only provided for x86_64 architectures")
+
+    def build(self):
+        arch = str(self.settings.arch) if self.settings.os != "Macos" else "universal"
+        get(self, **self.conan_data["sources"][self.version][str(self.settings.os)][arch],
+            destination=self.source_folder, strip_root=True)
+
+    def package_id(self):
+        if self.info.settings.os == "Macos":
+            del self.info.settings.arch
+
+    def package(self):
+        copy(self, "*GPL-*.txt", src=self.build_folder, dst=os.path.join(self.package_folder, "licenses"))
+        copy(self, "LICENSE.*", src=self.build_folder, dst=os.path.join(self.package_folder, "licenses"))
+        copy(self, "ccache", src=self.build_folder, dst=os.path.join(self.package_folder, "bin"))
+        copy(self, AUTOIJECT_CMAKE, src=self.build_folder, dst=self.package_folder)
+
+    def finalize(self):
+        copy(self, "*", src=self.immutable_package_folder, dst=self.package_folder)
+        # TODO: find a way of retrieving conan home without accessing private API
+        # replace_in_file(self, os.path.join(self.package_folder, AUTOIJECT_CMAKE), "<CONAN_HOME>", self._conan_helpers.cache.store)
+        replace_in_file(self, os.path.join(self.package_folder, AUTOIJECT_CMAKE), "<CONAN_HOME>", str(Path.home()))
+
+    def package_info(self):
+        self.cpp_info.libdirs = []
+        self.cpp_info.includedirs = []
+        if self.conf.get("user.ccache:auto_inject", default=True, check_type=bool):
+            self.conf_info.append("tools.cmake.cmaketoolchain:user_toolchain", os.path.join(self.package_folder, AUTOIJECT_CMAKE))

recipes/ccache/binary/test_package/CMakeLists.txt

@@ -0,0 +1,4 @@
+cmake_minimum_required(VERSION 3.15)
+project(test_package LANGUAGES CXX)
+
+add_executable(${PROJECT_NAME} test_package.cpp)

recipes/ccache/binary/test_package/conanfile.py

@@ -0,0 +1,32 @@
+import os
+from conan import ConanFile
+from conan.tools.build import can_run
+from conan.tools.cmake import CMake, cmake_layout
+from conan.errors import ConanException
+
+
+class TestPackageConan(ConanFile):
+    settings = "os", "arch", "compiler", "build_type"
+    generators = "CMakeToolchain"
+
+    def build_requirements(self):
+        self.tool_requires(self.tested_reference_str)
+
+    def test(self):
+        generated_file = os.path.join(self.dependencies.build[self.tested_reference_str].package_folder, "ccache-autoinject.cmake")
+        if not os.path.exists(generated_file):
+            raise ConanException("ccache-autoinject.cmake toolchain file does not exist")
+        user_toolchain = self.conf.get("tools.cmake.cmaketoolchain:user_toolchain", check_type=list)
+        if generated_file not in user_toolchain:
+            raise ConanException("ccache not found in user toolchain")
+
+        if can_run(self):
+            self.run("ccache --version", env="conanbuild")
+
+    def layout(self):
+        cmake_layout(self)
+
+    def build(self):
+        cmake = CMake(self)
+        cmake.configure()
+        cmake.build()

recipes/ccache/binary/test_package/test_package.cpp

@@ -0,0 +1,5 @@
+#include <iostream>
+
+int main() {
+    std::cout << "Hello world!\n";
+}

recipes/ccache/config.yml

@@ -0,0 +1,3 @@
+versions:
+  "4.10.2":
+    folder: binary