Add Conan module provider

The Conan module provider will extract information from generated
conanbuildinfo.json files and create a module for every dependency. It
also extract some useful information like the rootpath to the installed
package and environment variables defined by required packages.

Fixes: QBS-1665
Change-Id: I46f34667564c73f74feb2de2609d12d22a703f85

scripts/conan-profiles/mac_x64/qbs-test

@@ -0,0 +1,8 @@
+[settings]
+arch=x86_64
+build_type=Release
+compiler=apple-clang
+compiler.cppstd=17
+compiler.libcxx=libc++
+compiler.version=13
+os=Macos

scripts/conan-profiles/win_x64/qbs-test

@@ -0,0 +1,9 @@
+[settings]
+arch=x86_64
+build_type=Release
+compiler=msvc
+compiler.cppstd=14
+compiler.runtime=dynamic
+compiler.runtime_type=Release
+compiler.version=193
+os=Windows

scripts/setup-conan-profiles.sh

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+#############################################################################
+##
+## Copyright (C) 2024 Ivan Komissarov ([email protected]).
+## Contact: https://www.qt.io/licensing/
+##
+## This file is part of Qbs.
+##
+## $QT_BEGIN_LICENSE:LGPL$
+## 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 Lesser General Public License Usage
+## Alternatively, this file may be used under the terms of the GNU Lesser
+## General Public License version 3 as published by the Free Software
+## Foundation and appearing in the file LICENSE.LGPL3 included in the
+## packaging of this file. Please review the following information to
+## ensure the GNU Lesser General Public License version 3 requirements
+## will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+##
+## GNU General Public License Usage
+## Alternatively, this file may be used under the terms of the GNU
+## General Public License version 2.0 or (at your option) the GNU General
+## Public license version 3 or any later version approved by the KDE Free
+## Qt Foundation. The licenses are as published by the Free Software
+## Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+## 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-2.0.html and
+## https://www.gnu.org/licenses/gpl-3.0.html.
+##
+## $QT_END_LICENSE$
+##
+#############################################################################
+set -eu
+
+case "$OSTYPE" in
+    *darwin*)
+        HOST_OS=mac_x64
+        ;;
+    msys)
+        HOST_OS=win_x64
+        ;;
+    *)
+        HOST_OS=
+        ;;
+esac
+
+if [ -z "${HOST_OS}" ]; then
+    exit 0
+fi
+
+mkdir -p "${HOME}/.conan2/profiles"
+SCRIPT_DIR=$( cd "$(dirname "$0")" ; pwd -P )
+cp ${SCRIPT_DIR}/conan-profiles/mac_x64/* "${HOME}/.conan2/profiles"

share/qbs/imports/qbs/Probes/JsonFileProbe.qbs

@@ -0,0 +1,49 @@
+/****************************************************************************
+**
+** Copyright (C) 2024 Ivan Komissarov ([email protected]).
+** Contact: http://www.qt.io/licensing
+**
+** This file is part of Qbs.
+**
+** 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 http://www.qt.io/terms-conditions. For further information
+** use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+import qbs.File
+import qbs.TextFile
+
+Probe {
+    // Inputs
+    property path filePath
+    // Outputs
+    property var json
+    configure: {
+        if (!filePath || !File.exists(filePath))
+            return;
+
+        var jsonFile = new TextFile(filePath, TextFile.ReadOnly);
+        const result = JSON.parse(jsonFile.readAll());
+        jsonFile.close();
+        json = result;
+        found = true;
+    }
+}

share/qbs/module-providers/conan.js

@@ -0,0 +1,170 @@
+/****************************************************************************
+**
+** Copyright (C) 2024 Kai Dohmen
+** Copyright (C) 2024 Ivan Komissarov ([email protected]).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qbs.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** 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-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+var File = require("qbs.File");
+var FileInfo = require("qbs.FileInfo");
+var ModUtils = require("qbs.ModUtils");
+var TextFile = require("qbs.TextFile");
+
+const architectureMap = {
+    'x86': 'x86',
+    'x86_64': 'x86_64',
+    'ppc32be': 'ppc',
+    'ppc32': 'ppc',
+    'ppc64le': 'ppc64',
+    'ppc64': 'ppc64',
+    'armv4': 'arm',
+    'armv4i': 'arm',
+    'armv5el': 'arm',
+    'armv5hf': 'arm',
+    'armv6': 'arm',
+    'armv7': 'arm',
+    'armv7hf': 'arm',
+    'armv7s': 'arm',
+    'armv7k': 'arm',
+    'armv8': 'arm64',
+    'armv8_32': 'arm64',
+    'armv8.3': 'arm64',
+    'sparc': 'sparc',
+    'sparcv9': 'sparc64',
+    'mips': 'mips',
+    'mips64': 'mips64',
+    'avr': 'avr',
+    's390': 's390x',
+    's390x': 's390x',
+    'sh4le': 'sh'
+}
+
+// TODO: ios-simulator? see core.qbs for inspiration?
+const platformMap = {
+    'Windows': 'windows',
+    'WindowsStore': 'windows',
+    'WindowsCE': 'windows',
+    'Linux': 'linux',
+    'Macos': 'macos',
+    'Android': 'android',
+    'iOS': 'ios',
+    'watchOS': 'watchos',
+    'tvOS': 'tvos',
+    'FreeBSD': 'freebsd',
+    'SunOS': 'solaris',
+    'AIX': 'aix',
+    'Emscripten': undefined,
+    'Arduino': 'none',
+    'Neutrino': 'qnx',
+    'baremetal': 'none',
+    'VxWorks': 'vxworks',
+}
+
+function configure(moduleName, outputBaseDir, jsonProbe) {
+    const json = jsonProbe.json;
+
+    const moduleMapping = {
+        "protobuf": "protobuflib"
+    }
+    var reverseMapping = {}
+    for (var key in moduleMapping)
+        reverseMapping[moduleMapping[key]] = key
+    const realModuleName = reverseMapping[moduleName] || moduleName;
+
+    console.info("Setting up Conan module '" + moduleName + "'");
+
+    if (json.modules[realModuleName] === undefined)
+        return [];
+
+    // TODO: could it be that there are multiple deps with the same name? different build variants?
+    const dep = json.modules[realModuleName];
+
+    const outputDir = FileInfo.joinPaths(outputBaseDir, "modules", moduleName.replace(".", "/"));
+    File.makePath(outputDir);
+    const outputFilePath = FileInfo.joinPaths(outputDir, "module.qbs");
+
+    const cppInfo = dep.cpp_info;
+
+    function writeCppProperty(propertyName, propertyValue) {
+        // skip empty props for simplicity of the module file
+        if (propertyValue === undefined || propertyValue.length !== 0) {
+            module.writeLine(
+                    "    cpp." + propertyName + ":" + ModUtils.toJSLiteral(propertyValue));
+        }
+    }
+
+    var module = new TextFile(outputFilePath, TextFile.WriteOnly);
+    module.writeLine("Module {");
+
+    const architecture = architectureMap[dep.settings.arch];
+    const platform = platformMap[dep.settings.os];
+
+    module.writeLine("    readonly property string architecture: " + ModUtils.toJSLiteral(architecture));
+    module.writeLine("    readonly property string platform: " + ModUtils.toJSLiteral(platform));
+    // TODO: do we need to check buildVariant?
+    module.writeLine("    condition: qbs.targetPlatform === platform");
+    module.writeLine("          && (!qbs.architecture || architecture && qbs.architecture === architecture)");
+
+    module.writeLine("    Depends { name: 'cpp' }");
+
+    dep.dependencies.forEach(function(dep) {
+        module.write("    Depends { name: '" + dep + "'");
+        module.writeLine(" }");
+    })
+
+    console.info(JSON.stringify(cppInfo));
+    // NOTE: we can introduce a module, say "binPaths" and inject the value like we do for cpp
+    // the BinaryProbe will read the merged value from that module
+    if (cppInfo.bindirs !== undefined && cppInfo.bindirs.length >= 0) {
+        module.writeLine("    readonly property stringList binPaths: " + ModUtils.toJSLiteral(cppInfo.bindirs));
+    }
+
+    // TODO: we need to use actual artifacts from conan instead of raw props for
+    // installation/signing purposes
+    writeCppProperty("systemIncludePaths", cppInfo.includedirs);
+    writeCppProperty("libraryPaths", cppInfo.libdirs);
+    writeCppProperty("dynamicLibraries", (cppInfo.libs || []).concat(cppInfo.system_libs || []));
+    writeCppProperty("frameworkPaths", cppInfo.frameworkdirs);
+    writeCppProperty("frameworks", cppInfo.frameworks);
+    writeCppProperty("defines", cppInfo.defines);
+    writeCppProperty("cFlags", cppInfo.cflags);
+    writeCppProperty("cxxFlags", cppInfo.cxxflags);
+    writeCppProperty("linkerFlags", (cppInfo.sharedlinkflags || []).concat(cppInfo.exelinkflags || []));
+    module.writeLine("}");
+    module.close();
+
+    return "";
+}

share/qbs/module-providers/conan.qbs

@@ -0,0 +1,18 @@
+import qbs.Probes
+import "conan.js" as ConanHelper
+
+ModuleProvider {
+    /* input */
+    property path conanDepsFile
+
+    isEager: false
+
+    Probes.JsonFileProbe {
+        id: jsonProbe
+        filePath: conanDepsFile
+    }
+
+    relativeSearchPaths: {
+        return ConanHelper.configure(moduleName, outputBaseDir, jsonProbe);
+    }
+}

share/qbs/modules/protobuf/cpp/protobufcpp.qbs

@@ -13,6 +13,7 @@ ProtobufBase {
 
     property string _cxxLanguageVersion: "c++17"
 
+    _binPaths: protobuflib.present ? protobuflib.binPaths : undefined
     cpp.includePaths: outputDir
 
     Depends { name: "cpp" }

share/qbs/modules/protobuf/protobufbase.qbs

@@ -6,6 +6,7 @@ import "protobuf.js" as HelperFunctions
 Module {
     property string compilerName: "protoc"
     property string compilerPath: compilerProbe.filePath
+    property stringList _binPaths
 
     property pathList importPaths: []
 
@@ -19,5 +20,6 @@ Module {
     Probes.BinaryProbe {
         id: compilerProbe
         names: [compilerName]
+        searchPaths: _binPaths
     }
 }