Add conanfile.py to support builds with Conan

Support building with Conan against Qt6 base binary package.
Default the 'shared' option to the value of the Qt build.

The build recipe expects to locate QTDIR from env.
The 'qt-cmake(.bat)' is used for the build.

'CMAKE_TOOLCHAIN_FILE' is used to pick the toolchain
file for cross compilations.

For Android builds 'ANDROID_SDK_ROOT' and
'ANDROID_NDK_ROOT' need to be passed from env.

Pick-to: 6.1
Change-Id: I6a22bb20fd72afa00564d19c35a3c3b6b8966116
Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>

1 files changed, 145 insertions, 0 deletions

diff --git a/conanfile.py b/conanfile.py
new file mode 100644
index 00000000..1cc05263
--- /dev/null
+++ b/conanfile.py
@@ -0,0 +1,145 @@
+#############################################################################
+##
+## Copyright (C) 2021 The Qt Company Ltd.
+## Contact: https://www.qt.io/licensing/
+##
+## This file is part of the release tools of the Qt Toolkit.
+##
+## $QT_BEGIN_LICENSE:GPL-EXCEPT$
+## Commercial License Usage
+## Licensees holding valid commercial Qt licenses may use this file in
+## accordance with the commercial license agreement provided with the
+## Software or, alternatively, in accordance with the terms contained in
+## a written agreement between you and The Qt Company. For licensing terms
+## and conditions see https://www.qt.io/terms-conditions. For further
+## information use the contact form at https://www.qt.io/contact-us.
+##
+## GNU General Public License Usage
+## Alternatively, this file may be used under the terms of the GNU
+## General Public License version 3 as published by the Free Software
+## Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+## included in the packaging of this file. Please review the following
+## information to ensure the GNU General Public License requirements will
+## be met: https://www.gnu.org/licenses/gpl-3.0.html.
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+
+from conans import ConanFile, tools, CMake
+import os
+
+
+class QtConanError(Exception):
+    pass
+
+
+class QtVirtualKeyboard(ConanFile):
+    name = "qtvirtualkeyboard"
+    version = "6.1.0"
+    license = "GPL-3.0+, Commercial Qt License Agreement"
+    author = "The Qt Company <https://www.qt.io/contact-us>"
+    url = "https://code.qt.io/cgit/qt/qtvirtualkeyboard.git/"
+    description = (
+        "The Qt Virtual Keyboard project provides an input framework and "
+        "reference keyboard frontend for Qt on Linux Desktop/X11, "
+        "Windows Desktop, and Boot2Qt targets."
+    )
+    topics = ("qt", "qt6", "input", "keyboard")
+    settings = "os", "compiler", "build_type", "arch"
+    options = {
+        "shared": [True, False, "default"],
+        "qt6": "ANY",
+    }  # "qt6" is needed to model unique package_id for the Add-on build per used Qt6 version
+    default_options = {
+        "shared": "default",  # default: Use the value of the Qt build
+        "qt6": None,
+    }
+    exports_sources = "*", "!conan*.*"
+
+    def source(self):
+        # sources are installed next to recipe, no need to clone etc. sources here
+        pass
+
+    def _get_cmake_prefix_path(self):
+        # 'QTDIR' provided as env variable in profile file which is part
+        # of the Qt essential binary package(s)
+        cmake_prefix_path = os.environ.get("QTDIR")
+        if not cmake_prefix_path:
+            raise QtConanError("'QTDIR' not defined! The 'QTDIR' needs to point to "
+                               "Qt installation directory.")
+        print(f"CMAKE_PREFIX_PATH for '{self.name}/{self.version}' build is: "
+              f"{cmake_prefix_path}")
+        return cmake_prefix_path
+
+    def _read_env(self, key):
+        value = os.environ.get(key)
+        if not value:
+            raise QtConanError(f"{self.settings.os} build specified but '{key}' "
+                               "was not defined?")
+        return value
+
+    def _get_qtcmake(self):
+        qt_install_path = self._get_cmake_prefix_path()
+        ext = ".bat" if tools.os_info.is_windows else ""
+        qtcmake = os.path.abspath(os.path.join(qt_install_path, "bin", "qt-cmake" + ext))
+        if not os.path.exists(qtcmake):
+            raise QtConanError(f"Unable to locate {qtcmake} from 'QTDIR': {qt_install_path}")
+        return qtcmake
+
+    def _get_cmake_tool(self):
+        cmake = CMake(self, cmake_program=self._get_qtcmake())
+        cmake.verbose = True
+
+        # Qt modules need to be 'installed'.
+        # We need to direct the 'make install' to some directory under Conan cache,
+        # place it under the current build directory which is also under the Conan cache.
+        # Note, the actual 'make install' is called in "package()".
+        install_dir = os.path.join(os.getcwd(), "_install_tmp")
+        cmake.definitions["CMAKE_INSTALL_PREFIX"] = install_dir
+
+        # Use the value of the Qt build
+        if self.options.shared.value == "default":
+            del cmake.definitions["BUILD_SHARED_LIBS"]
+
+        cmake_toolchain_file = os.environ.get("CMAKE_TOOLCHAIN_FILE")
+        if cmake_toolchain_file:
+            cmake.definitions["CMAKE_TOOLCHAIN_FILE"] = cmake_toolchain_file
+
+        if self.settings.os == "Android":
+            cmake.definitions["ANDROID_SDK_ROOT"] = self._read_env("ANDROID_SDK_ROOT")
+            cmake.definitions["ANDROID_NDK_ROOT"] = self._read_env("ANDROID_NDK_ROOT")
+
+        if self.settings.os == "iOS":
+            # Instead of Conan's auto-added 'Darwin', explicitly pass 'iOS'.
+            cmake.definitions["CMAKE_SYSTEM_NAME"] = "iOS"
+
+            # Remove the explicit sysroot, let CMake detect the sysroots, to ensure
+            # that multi-arch builds work.
+            del cmake.definitions["CMAKE_OSX_SYSROOT"]
+
+            # Remove the conan provided architecture, instead rely on the architectures set
+            # by the Qt toolchain file, which with official Qt packages most likely means
+            # multi-arch iOS.
+            del cmake.definitions["CMAKE_OSX_ARCHITECTURES"]
+
+        return cmake
+
+    def build(self):
+        cmake = self._get_cmake_tool()
+        self.run(f"{self._get_qtcmake()} '{self.source_folder}' {cmake.command_line}")
+        self.run(f"cmake --build . {cmake.build_config}")
+
+    def package(self):
+        #  see "CMAKE_INSTALL_PREFIX" above
+        install_dir = os.path.join(os.getcwd(), "_install_tmp")
+        self.run("cmake --build . --target install")
+        self.copy("*", src=install_dir, dst=".")
+
+    def package_info(self):
+        # used for the actual library filename, Ordered list with the library names
+        self.cpp_info.libs = ["Qt6VirtualKeyboard"]
+
+    def deploy(self):
+        self.copy("*")  # copy from current package
+        self.copy_deps("*")  # copy from dependencies