aboutsummaryrefslogtreecommitdiffstats
path: root/share/qbs/modules/ib/IBModule.qbs
blob: e6183e20c2d301c9d0db7953090af5e614ba6582 (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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
/****************************************************************************
**
** 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.BundleTools
import qbs.DarwinTools
import qbs.File
import qbs.Host
import qbs.FileInfo
import qbs.ModUtils
import qbs.Process
import 'ib.js' as Ib

Module {
    Depends { name: "xcode"; required: false }

    Probe {
        id: ibProbe
        property string toolPath: ibtoolPath // input
        property string toolVersion // output
        configure: {
            toolVersion = Ib.ibtoolVersion(toolPath);
            found = true;
        }
    }

    condition: Host.os().includes("darwin") && qbs.targetOS.includes("darwin")

    property bool warnings: true
    property bool errors: true
    property bool notices: true

    property stringList flags

    // tiffutil specific
    property string tiffutilName: "tiffutil"
    property string tiffutilPath: FileInfo.joinPaths("/usr/bin", tiffutilName)
    property bool combineHidpiImages: true

    // iconutil specific
    property string iconutilName: "iconutil"
    property string iconutilPath: FileInfo.joinPaths("/usr/bin", iconutilName)

    // XIB/NIB specific
    property string ibtoolName: "ibtool"
    property string ibtoolPath: FileInfo.joinPaths(xcode.developerPath, "/usr/bin", ibtoolName)
    property bool flatten: true
    property string module
    property bool autoActivateCustomFonts: true

    // Asset catalog specific
    property string actoolName: xcode.present ? "actool" : "ictool"
    property string actoolPath: FileInfo.joinPaths(xcode.developerPath, "/usr/bin", actoolName)
    property string appIconName
    property string launchImageName
    property bool compressPngs: true

    // private properties
    property string outputFormat: "human-readable-text"
    property string tiffSuffix: ".tiff"
    property string appleIconSuffix: ".icns"
    property string compiledAssetCatalogSuffix: ".car"
    property string compiledNibSuffix: ".nib"
    property string compiledStoryboardSuffix: ".storyboardc"

    version: ibtoolVersion
    property string ibtoolVersion: ibProbe.toolVersion
    property var ibtoolVersionParts: ibtoolVersion ? ibtoolVersion.split('.').map(function(item) { return parseInt(item, 10); }) : []
    property int ibtoolVersionMajor: ibtoolVersionParts[0]
    property int ibtoolVersionMinor: ibtoolVersionParts[1]
    property int ibtoolVersionPatch: ibtoolVersionParts[2]

    property stringList targetDevices: xcode.present
                                       ? xcode.targetDevices
                                       : DarwinTools.targetDevices(qbs.targetOS)

    validate: {
        var validator = new ModUtils.PropertyValidator("ib");
        validator.setRequiredProperty("ibtoolVersion", ibtoolVersion);
        validator.setRequiredProperty("ibtoolVersionMajor", ibtoolVersionMajor);
        validator.setRequiredProperty("ibtoolVersionMinor", ibtoolVersionMinor);
        validator.addVersionValidator("ibtoolVersion", ibtoolVersion, 2, 3);
        validator.addRangeValidator("ibtoolVersionMajor", ibtoolVersionMajor, 1);
        validator.addRangeValidator("ibtoolVersionMinor", ibtoolVersionMinor, 0);
        if (ibtoolVersionPatch !== undefined)
            validator.addRangeValidator("ibtoolVersionPatch", ibtoolVersionPatch, 0);
        validator.validate();
    }

    FileTagger {
        patterns: ["*.png"]
        fileTags: ["png"]
    }

    FileTagger {
        patterns: ["*.iconset"] // bundle
        fileTags: ["iconset"]
    }

    FileTagger {
        patterns: ["*.nib", "*.xib"]
        fileTags: ["nib"]
    }

    FileTagger {
        patterns: ["*.storyboard"]
        fileTags: ["storyboard"]
    }

    FileTagger {
        patterns: ["*.xcassets"] // bundle
        fileTags: ["assetcatalog"]
    }

    Rule {
        multiplex: true
        inputs: ["png"]

        outputFileTags: ["tiff"]
        outputArtifacts: Ib.tiffutilArtifacts(product, inputs)

        prepare: Ib.prepareTiffutil.apply(Ib, arguments)
    }

    Rule {
        inputs: ["iconset"]

        outputFileTags: ["icns", "bundle.input"]
        outputArtifacts: ([{
            filePath: FileInfo.joinPaths(product.destinationDirectory, input.completeBaseName +
                                         ModUtils.moduleProperty(product, "appleIconSuffix")),
            fileTags: ["icns", "bundle.input"],
            bundle: {
                _bundleFilePath: FileInfo.joinPaths(BundleTools.destinationDirectoryForResource(product, input),
                                                    input.completeBaseName +
                                                    ModUtils.moduleProperty(product, "appleIconSuffix"))
            }
        }])

        prepare: {
            var args = ["--convert", "icns", "--output", output.filePath, input.filePath];
            var cmd = new Command(ModUtils.moduleProperty(product, "iconutilPath"), args);
            cmd.description = "compiling " + input.fileName;
            return cmd;
        }
    }

    Rule {
        inputs: ["nib", "storyboard"]

        outputFileTags: {
            var tags = ["partial_infoplist"];
            for (var i = 0; i < inputs.length; ++i)
                tags = tags.uniqueConcat(ModUtils.allFileTags(Ib.ibtoolFileTaggers(inputs[i])));
            return tags;
        }

        outputArtifacts: Ib.ibtoolOutputArtifacts(product, inputs, input)

        prepare: {
            var cmd = new Command(ModUtils.moduleProperty(product, "ibtoolPath"),
                                  Ib.ibtooldArguments(product, inputs, input, outputs));
            cmd.description = "compiling " + input.fileName;

            // Also display the language name of the nib/storyboard being compiled if it has one
            var localizationKey = DarwinTools.localizationKey(input.filePath);
            if (localizationKey)
                cmd.description += ' (' + localizationKey + ')';

            cmd.highlight = 'compiler';

            // May not be strictly needed, but is set by some versions of Xcode
            if (input.fileTags.includes("storyboard"))
                cmd.environment.push("IBSC_MINIMUM_COMPATIBILITY_VERSION=" +
                                     (product.moduleProperty("cpp", "minimumDarwinVersion") || ""));

            cmd.stdoutFilterFunction = function(output) {
                return "";
            };

            return cmd;
        }
    }

    Rule {
        inputs: ["assetcatalog"]
        multiplex: true

        outputArtifacts: Ib.actoolOutputArtifacts(product, inputs)
        outputFileTags: ["bundle.input", "compiled_assetcatalog", "partial_infoplist"]

        prepare: {
            var mkdir = new JavaScriptCommand();
            mkdir.silent = true;
            mkdir.sourceCode = function () {
                File.makePath(FileInfo.joinPaths(product.buildDirectory, "actool.dir"));
            };

            var cmd = new Command(ModUtils.moduleProperty(product, "actoolPath"),
                                  Ib.ibtooldArguments(product, inputs, input, outputs));
            cmd.description = inputs["assetcatalog"].map(function (input) {
                return "compiling " + input.fileName;
            }).join('\n');
            cmd.highlight = "compiler";

            cmd.stdoutFilterFunction = function(output) {
                return "";
            };

            return [mkdir, cmd];
        }
    }
}