aboutsummaryrefslogtreecommitdiffstats
path: root/share/qbs/modules/qbs/common.qbs
blob: 8b31092a992e9eaf5fec571d52f95c0b3861b9eb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** 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.Environment
import qbs.FileInfo
import qbs.ModUtils
import qbs.PathTools
import qbs.Utilities

Module {
    readonly property string configurationName: "default"
    property string defaultBuildVariant: {
        switch (configurationName.toLowerCase()) {
        case "release":
            return "release";
        default:
            return "debug";
        }
    }

    property string buildVariant: defaultBuildVariant

    property bool enableDebugCode: buildVariant == "debug"
    property bool debugInformation: (buildVariant !== "release")
    property string optimization: (buildVariant === "debug" ? "none" : "fast")
    readonly property string hostPlatform: undefined // set internally
    readonly property stringList hostOS: Utilities.canonicalPlatform(hostPlatform)
    property string hostOSVersion: {
        if (hostOS && hostOS.includes("macos")) {
            return Utilities.getNativeSetting("/System/Library/CoreServices/ServerVersion.plist", "ProductVersion") ||
                   Utilities.getNativeSetting("/System/Library/CoreServices/SystemVersion.plist", "ProductVersion");
        } else if (hostOS && hostOS.includes("windows")) {
            var version = Utilities.getNativeSetting(windowsRegistryKey, "CurrentVersion");
            return version + "." + hostOSBuildVersion;
        }
    }
    readonly property string hostArchitecture: undefined // set internally

    property string hostOSBuildVersion: {
        if (hostOS.includes("macos")) {
            return Utilities.getNativeSetting("/System/Library/CoreServices/ServerVersion.plist", "ProductBuildVersion") ||
                   Utilities.getNativeSetting("/System/Library/CoreServices/SystemVersion.plist", "ProductBuildVersion");
        } else if (hostOS.includes("windows")) {
            return Utilities.getNativeSetting(windowsRegistryKey, "CurrentBuildNumber");
        }
    }

    readonly property var hostOSVersionParts: hostOSVersion ? hostOSVersion.split('.').map(function(item) { return parseInt(item, 10); }) : []
    readonly property int hostOSVersionMajor: hostOSVersionParts[0] || 0
    readonly property int hostOSVersionMinor: hostOSVersionParts[1] || 0
    readonly property int hostOSVersionPatch: hostOSVersionParts[2] || 0

    property string targetPlatform: hostPlatform
    readonly property stringList targetOS: Utilities.canonicalPlatform(targetPlatform)
    property string pathListSeparator: hostOS.includes("windows") ? ";" : ":"
    property string pathSeparator: hostOS.includes("windows") ? "\\" : "/"
    property string nullDevice: hostOS.includes("windows") ? "NUL" : "/dev/null"
    property path shellPath: hostOS.includes("windows") ? windowsShellPath : "/bin/sh"
    property string profile: project.profile
    property string toolchainType: {
        if (targetOS.includes("windows"))
            return hostOS.includes("windows") ? "msvc" : "mingw";
        if (targetOS.includes("darwin"))
            return hostOS.includes("macos") ? "xcode" : "clang";
        if (targetOS.includes("freebsd"))
            return "clang";
        if (targetOS.includes("qnx"))
            return "qcc";
        if (targetOS.containsAny(["haiku", "vxworks", "unix"]))
            return "gcc";
    }
    readonly property stringList toolchain: Utilities.canonicalToolchain(toolchainType)
    property string architecture
    property bool install: false
    property path installSourceBase
    property string installRoot: project.buildDirectory + "/install-root"
    property string installDir
    property string installPrefix: targetOS.includes("unix") ? "/usr/local" : ""
    property path sysroot

    PropertyOptions {
        name: "buildVariant"
        allowedValues: ['debug', 'release', 'profiling']
        description: "name of the build variant"
    }

    PropertyOptions {
        name: "optimization"
        allowedValues: ['none', 'fast', 'small']
        description: "optimization level"
    }

    validate: {
        var validator = new ModUtils.PropertyValidator("qbs");
        validator.setRequiredProperty("hostOS", hostOS);
        validator.setRequiredProperty("targetOS", targetOS);
        validator.addCustomValidator("targetOS", targetOS, function (value) {
            if (!value || (value.includes("osx") && !value.includes("macos")))
                return false;
            return true;
        }, "the value 'osx' has been replaced by 'macos'; use that instead and update "
            + "hostOS and targetOS condition checks in your project accordingly");
        if (hostOS && (hostOS.includes("windows") || hostOS.includes("macos"))) {
            validator.setRequiredProperty("hostOSVersion", hostOSVersion,
                                          "could not detect host operating system version; " +
                                          "verify that system files and registry keys have not " +
                                          "been modified.");
            if (hostOSVersion)
                validator.addVersionValidator("hostOSVersion", hostOSVersion, 2, 4);

            validator.setRequiredProperty("hostOSBuildVersion", hostOSBuildVersion,
                                          "could not detect host operating system build version; " +
                                          "verify that system files or registry have not been " +
                                          "tampered with.");
        }

        validator.addCustomValidator("architecture", architecture, function (value) {
            return !architecture || architecture === Utilities.canonicalArchitecture(architecture);
        }, "'" + architecture + "' is invalid." + (architecture
            ? " You must use the canonical name '" + Utilities.canonicalArchitecture(architecture)
            : "") + "'");

        validator.addCustomValidator("toolchain", toolchain, function (value) {
            if (toolchain === undefined)
                return false; // cannot have null toolchain, empty is valid... for now
            var canonical = Utilities.canonicalToolchain.apply(Utilities, toolchain);
            for (var i = 0; i < Math.max(canonical.length, toolchain.length); ++i) {
                if (canonical[i] !== toolchain[i])
                    return false;
            }
            return true;
        }, "'" + toolchain + "' is invalid. You must use the canonical list '" +
        Utilities.canonicalToolchain.apply(Utilities, toolchain) + "'");

        validator.addCustomValidator("toolchain", toolchain, function (value) {
            // None of the pairs listed here may appear in the same toolchain list.
            // Note that this check is applied AFTER canonicalization, so for example
            // {"clang", "msvc"} need not be checked, since a toolchain containing clang is
            // guaranteed to also contain gcc.
            var pairs = [
                ["gcc", "msvc"],
                ["llvm", "mingw"]
            ];
            var canonical = Utilities.canonicalToolchain.apply(Utilities, value);
            for (var i = 0; i < pairs.length; ++i) {
                if (canonical.includes(pairs[i][0]) && canonical.includes(pairs[i][1]))
                    return false;
            }
            return true;
        }, "'" + toolchain + "' contains one or more mutually exclusive toolchain types.");

        validator.validate();
    }

    // private properties
    property string windowsRegistryKey: "HKEY_LOCAL_MACHINE\\Software\\Microsoft\\Windows NT\\CurrentVersion"
    property path windowsSystemRoot: FileInfo.fromWindowsSeparators(Utilities.getNativeSetting(windowsRegistryKey, "SystemRoot"))
    property path windowsShellPath: FileInfo.fromWindowsSeparators(Environment.getEnv("COMSPEC")) || FileInfo.joinPaths(windowsSystemRoot, "System32", "cmd.exe")
    property string windowsPathVariable: hostOS.includes("windows") ? "PATH" : "WINEPATH"

    property var commonRunEnvironment: ({})
    setupRunEnvironment: {
        var env = product.qbs.commonRunEnvironment;
        for (var i in env) {
            var v = new ModUtils.EnvironmentVariable(i, product.qbs.pathListSeparator,
                                                     product.qbs.hostOS.includes("windows"));
            v.value = env[i];
            v.set();
        }
    }

    // Properties that can be set for multiplexing products.
    property stringList profiles: []
    property stringList architectures: []
    property stringList buildVariants: []

    // internal properties
    readonly property string version: [versionMajor, versionMinor, versionPatch].join(".")
    readonly property int versionMajor: undefined // set internally
    readonly property int versionMinor: undefined // set internally
    readonly property int versionPatch: undefined // set internally
    readonly property var multiplexMap: ({
        profiles: "profile",
        architectures: "architecture",
        buildVariants: "buildVariant"
    })
}