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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
|
/****************************************************************************
**
** Copyright (C) 2015 Jake Petroules.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\qmltype bundle
\inqmlmodule QbsModules
\since Qbs 1.4
\brief Provides Core Foundation bundle support.
The \c bundle module contains properties and rules for building and working with
Core Foundation bundles on Apple platforms (commonly known as CFBundles or simply \e bundles),
directories with a standardized hierarchical structure that hold executable code and resources.
Examples include applications, frameworks, and plugins.
This module is available on all platforms but is currently only useful on Apple platforms.
\note Core Foundation bundles are not to be confused with Mach-O loadable modules, which are
also referred to as (loadable) \e bundles in Apple parlance.
In \QBS, Core Foundation bundles are referred to as \e bundles,
while Mach-O loadable bundles are referred to as \e {loadable modules}.
\section2 Relevant File Tags
\target filetags-bundle
\table
\header
\li Tag
\li Auto-tagged File Names
\li Since
\li Description
\row
\li \c{"bundle.content"}
\li -
\li 1.8
\li Attached to the output artifacts of the rule that produces the
bundle.
\row
\li \c{"infoplist"}
\li \c{Info.plist}, \c{*-Info.plist}
\li 1.5
\li Source files with this tag are Info property lists files or fragments that are merged
into the bundle's final \c Info.plist.
\endtable
*/
/*!
\qmlproperty bool bundle::isBundle
Whether the product should actually be packaged as a bundle as opposed to a
flat file. This allows a product indirectly dependent on the \c{bundle}
module to retain control of whether it should actually be built as a bundle.
\defaultvalue \c{true} for applications and dynamic libraries on Apple
platforms, \c{false} otherwise.
*/
/*!
\qmlproperty bool bundle::isShallow
\readonly
Whether the bundle directory tree is \e shallow. That is, whether it lacks a
\c Contents subdirectory. This is the default on all platforms other than
macOS.
\defaultvalue \c{false} on macOS, otherwise \c{true}.
*/
/*!
\qmlproperty string bundle::identifierPrefix
A prefix for the product's bundle identifier. If \l{bundle::}{identifier}
is left unset, the bundle identifier will be a concatenation of this value
and the \l{Product::targetName}{Product.targetName} property formatted as
an RFC-1034 identifier, separated by a period (.). This corresponds to the
organization identifier in Xcode.
\defaultvalue \c{org.example}
*/
/*!
\qmlproperty string bundle::identifier
The bundle's identifier. If left unset, the bundle identifier will be a
concatenation of the \l{bundle::}{identifierPrefix} value and the
\l{Product::targetName}{Product.targetName} propertyy formatted as an
RFC-1034 identifier, separated by a period (.).
\defaultvalue A combination of \l{bundle::}{identifierPrefix} and the
product's target name formatted as an RFC-1034 identifier.
*/
/*!
\qmlproperty string bundle::extension
The extension of the bundle's wrapper directory, without the leading period
(.).
This property should not normally need to be set unless creating a custom
bundle type.
\defaultvalue \c{"app"} for \c{"APPL"} packages, \c{"framework"} for
\c{"FMWK"} packages, and \c{"bundle"} for \c{"BNDL"} and custom packages.
*/
/*!
\qmlproperty string bundle::packageType
The four-letter file type code of the bundle, specified in the bundle's
\c PkgInfo file and in the bundle's \c Info.plist as the value for the
\c CFBundlePackageType key.
This property should almost never need to be changed, even though specifying
an alternative package type for custom bundles is allowed.
\defaultvalue \c{"APPL"} for applications, \c{"FMWK"} for frameworks, and
\c{"BNDL"} for custom bundles.
*/
/*!
\qmlproperty bool bundle::generatePackageInfo
\since Qbs 1.5
Whether to generate a \c PkgInfo file for the bundle.
This property should almost never need to be changed, even though enabling
it when specifying an alternative package type for custom bundles using
\l{bundle::}{packageType} is allowed.
\defaultvalue \c{true} for applications, otherwise \c{false}.
*/
/*!
\qmlproperty string bundle::signature
The four-letter signature specific to the bundle, also known as the creator
code, specified in the bundle's \c PkgInfo file and in the bundle's
\c Info.plist as the value for the \c CFBundleSignature key.
This property should normally never need to be set.
\defaultvalue \c{"????"}
*/
/*!
\qmlproperty string bundle::bundleName
The file name of the bundle's wrapper directory.
This property should not normally need to be changed.
\defaultvalue A combination of the product's \l{Product::}{targetName} and
bundle's \l{bundle::}{extension}.
*/
/*!
\qmlproperty string bundle::frameworkVersion
For framework bundles, the version of the framework. Not used for other
package types.
\defaultvalue \c{"A"}
*/
/*!
\qmlproperty pathList bundle::publicHeaders
A list of public header files to copy to a framework bundle's \c Headers
subdirectory.
\nodefaultvalue
*/
/*!
\qmlproperty pathList bundle::privateHeaders
A list of private header files to copy to a framework bundle's
\c PrivateHeaders subdirectory
\nodefaultvalue
*/
/*!
\qmlproperty pathList bundle::resources
A list of resources to copy to a bundle's \c Resources subdirectory. Files
will automatically be copied into \c lproj subdirectories corresponding to
the input files' paths.
\nodefaultvalue
*/
/*!
\qmlproperty var bundle::infoPlist
A dictionary of key-value pairs to add to the bundle's \c Info.plist.
The contents of this property will be aggregated with the values from any
\c plist files. If this property and any \c plist files contain the same
key, this property will take precedence. However, it might be overridden
during postprocessing (see \l{bundle::}{processInfoPlist}).
If \c undefined, will not be taken into account.
\nodefaultvalue
*/
/*!
\qmlproperty bool bundle::processInfoPlist
Whether to perform post-processing on the aggregated \c Info.plist contents.
If this property is \c{true}, various post-processing operations will be
applied to the bundle's property list dictionary after it has been
aggregated from the contents of any \c plist files on disk, and the
\l{bundle::}{infoPlist} property.
First, values from a list of defaults will be added to the dictionary if
they were not already present. Second, values from the \c AdditionalInfo key
of the platform SDK's \c Info.plist file will be added to the dictionary if
they were not already present, as well as some other miscellaneous keys,
such as \c BuildMachineOSBuild and \c UIDeviceFamily (on iOS). Finally,
variable expansions will be performed such that substrings of the form
\c $(VAR) or \c ${VAR} will be replaced with their corresponding environment
variables.
\defaultvalue \c{true}
*/
/*!
\qmlproperty bool bundle::embedInfoPlist
Whether to create a \c{__TEXT} section in the product's executable
containing the processed \c Info.plist.
Only applies to command line applications.
\defaultvalue \c{true} if the product is a command line tool, otherwise
\c{false}.
*/
/*!
\qmlproperty string bundle::infoPlistFormat
The file format to write the product's resulting \c Info.plist in.
Possible values are:
\list
\li \c{"binary1"}
\li \c{"json"}
\li \c{"same-as-input"}
\li \c{"xml1"}
\endlist
\defaultvalue \c{"binary1"} for iOS, \c{"same-as-input"} or \c{"xml1"}
for macOS depending on whether a \c plist file is used, and \c{undefined}
for all other operating systems.
*/
/*!
\qmlproperty string bundle::infoPlistPath
\readonly
The path that the \c Info.plist file will be written to.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::infoStringsPath
\readonly
\since Qbs 1.5
The path that the \c InfoPlist.strings file will be written to.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::pkgInfoPath
\readonly
The path that the \c PkgInfo file will be written to.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::versionPlistPath
\readonly
The path that the \c version.plist file will be written to.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::executablePath
\readonly
The path that the main executable file will be written to.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::contentsFolderPath
\readonly
The path of the bundle's \c Contents subdirectory.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::documentationFolderPath
\readonly
\since Qbs 1.5
The path of the directory where documentation will be written.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::executableFolderPath
\readonly
The path of the directory where the main exectuable will be written.
The path is relative to the directory that contains the bundle.
Not to be confused with \l{bundle::}{executablesFolderPath}.
*/
/*!
\qmlproperty string bundle::executablesFolderPath
\readonly
The path of the directory where auxiliary executables will be copied.
The path is relative to the directory that contains the bundle.
Not to be confused with \l{bundle::}{executableFolderPath}.
*/
/*!
\qmlproperty string bundle::frameworksFolderPath
\readonly
The path of the directory where internal frameworks will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::javaFolderPath
\readonly
\since Qbs 1.5
The path of the directory where Java content will be written.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::localizedResourcesFolderPath
\readonly
\since Qbs 1.5
The path of the directory where localized resource files will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::pluginsFolderPath
\readonly
The path of the directory where plugins will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::privateHeadersFolderPath
\readonly
The path of the directory where private header files will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::publicHeadersFolderPath
\readonly
The path of the directory where public headers files will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::scriptsFolderPath
\readonly
The path of the directory where script files will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::sharedFrameworksFolderPath
\readonly
The path of the directory where shared frameworks will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::sharedSupportFolderPath
\readonly
The path of the directory where shared support files will be copied.
The path is relative to the directory that contains the bundle.
*/
/*!
\qmlproperty string bundle::unlocalizedResourcesFolderPath
\readonly
The path of the directory where non-localized resource files will be copied.
The path is relative to the directory that contains the bundle.
This is the same as the base resources path.
*/
/*!
\qmlproperty string bundle::versionsFolderPath
\readonly
\since Qbs 1.5
The path of the bundle's \c Versions subdirectory.
The path is relative to the directory that contains the bundle.
This is only relevant for (non-shallow) framework bundles.
*/
|