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
|
/****************************************************************************
**
** Copyright (C) 2015 Digia Plc and/or its subsidiary(-ies).
** Copyright (C) 2015 Jake Petroules.
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Build Suite.
**
** 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 Digia. For licensing terms and
** conditions see http://www.qt.io/licensing. 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, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
/*!
\contentspage index.html
\page bundle-module.html
\ingroup list-of-modules
\title Module bundle
\brief Provides Core Foundation bundle support.
The \c bundle module contains properties and rules for building and working with
Core Foundation bundles on OS X and iOS (commonly known as CFBundles or simply "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 OS X and iOS.
\note Core Foundation bundles are not to be confused with Mach-O loadable modules, which are
also referred to as (loadable) "bundles" in Apple parlance.
In \QBS, Core Foundation bundles are referred to as "bundles",
while Mach-O loadable bundles are referred to as "loadable modules".
\section1 General Properties
\section2 isBundle
\table
\row \li \b{Type:} \li \c{bool}
\row \li \b{Default:} \li \c{true} for application and dynamic
library products on OS X and iOS,
\c{false} otherwise
\endtable
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.
\section2 isShallow
\table
\row \li \b{Type:} \li \c{bool}
\row \li \b{Default:} \li \c{true} for iOS applications
\endtable
Whether the bundle directory tree is "shallow", i.e. whether it lacks a Contents
subdirectory. This is the default for iOS applications and should normally never be changed.
\section2 identifierPrefix
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{org.example}
\endtable
Prefix for the product's bundle identifier. If \c{identifier} is left unset, the bundle
identifier will be a concatenation of this value and the \c{identifier} property,
separated by a '.'. This corresponds to the organization identifier in Xcode.
\section2 identifier
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li combination of \c{identifierPrefix} and the product's
target name formatted as an RFC 1034 identifier
\endtable
The bundle's identifier. If left unset, the bundle
identifier will be a concatenation of this value and the \c{identifierPrefix} property,
separated by a '.'.
\section2 extension
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{"app"} for \c{"APPL"} packages,
\c{"framework"} for \c{"FMWK"} packages,
\c{"bundle"} for \c{"BNDL"} and custom packages
\endtable
The extension of the bundle's wrapper directory (minus the leading '.'). This property
should not normally need to be set unless creating a custom bundle type.
\section2 packageType
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{"APPL"} for applications,
\c{"FMWK"} for frameworks
\c{"BNDL"} for custom bundles
\endtable
The four-letter file type code of the bundle, specified in the bundle's PkgInfo file and in
the bundle's Info.plist as the value for the CFBundlePackageType key.
This property should almost never need to be changed, though specifying an
alternative package type for custom bundles is allowed.
\section2 signature
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{"????"}
\endtable
The four-letter signature specific to the bundle, also known as the creator code, specified
in the bundle's PkgInfo file and in the bundle's Info.plist as the value for the CFBundleSignature key.
This property should normally never need to be set.
\section2 bundleName
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li combination of the product's \c{targetName} and bundle's \c{extension}
\endtable
The file name of the bundle's wrapper directory.
This property should not normally need to be changed.
\section2 frameworkVersion
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Default:} \li \c{"A"}
\endtable
For framework bundles, the version of the framework. Unused for other package types.
\section2 publicHeaders
\table
\row \li \b{Type:} \li \c{pathList}
\row \li \b{Default:} \li \c{undefined}
\endtable
List of public header files to copy to a framework bundle's Headers subdirectory.
\section2 privateHeaders
\table
\row \li \b{Type:} \li \c{pathList}
\row \li \b{Default:} \li \c{undefined}
\endtable
List of private header files to copy to a framework bundle's PrivateHeaders subdirectory.
\section2 resources
\table
\row \li \b{Type:} \li \c{pathList}
\row \li \b{Default:} \li \c{undefined}
\endtable
List of resources to copy to a bundle's Resources subdirectory. Files will automatically
be copied into lproj subdirectories corresponding to the input files' paths.
\section2 infoPlistFile
\table
\row \li \b{Type:} \li \c{path}
\row \li \b{Default:} \li \c{undefined}
\endtable
Path to the Info.plist file used by the bundle.
The contents of this file will be aggregated with the values in \c{infoPlist}.
If \c{infoPlistFile} and \c{infoPlist} contain the same key, the latter will take precedence,
but may also be overridden during postprocessing (see \c{processInfoPlist}).
If undefined, will not be taken into account.
\section2 infoPlist
\table
\row \li \b{Type:} \li \c{object}
\row \li \b{Default:} \li \c{undefined}
\endtable
Dictionary of key-value pairs to add to the bundle's Info.plist.
The contents of this property will be aggregated with the values from \c{infoPlistFile}.
If \c{infoPlist} and \c{infoPlistFile} contain the same key, the former will take precedence,
but may also be overridden during postprocessing (see \c{processInfoPlist}).
If undefined, will not be taken into account.
\section2 processInfoPlist
\table
\row \li \b{Type:} \li \c{bool}
\row \li \b{Default:} \li \c{true}
\endtable
Whether to perform post-processing on the aggregated 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 the file
specified by the \c{infoPlistFile} property and the \c{infoPlist} property.
First, values from a list of defaults will be added to the dictionary if they were not already
present. Then, values from the AdditionalInfo key of the platform SDK's Info.plist file will be
added to the dictionary if they were not already present, as well as some other miscellaneous
keys, such as BuildMachineOSBuild and UIDeviceFamily (on iOS).
Finally, variable expansions will be performed such that substrings of the form $(VAR) or ${VAR}
will be replaced with their corresponding environment variables.
\section2 embedInfoPlist
\table
\row \li \b{Type:} \li \c{bool}
\row \li \b{Default:} \li \c{true} if the product is a command line tool,
otherwise \c{false}.
\endtable
Whether to create a __TEXT section in the product's executable containing the processed Info.plist.
Only applies to command line applications.
\section2 infoPlistFormat
\table
\row \li \b{Type:} \li \c{string}
\row \li \b{Allowed Values:} \li \c{"xml1"}, \c{"binary1"}, \c{"json"}, \c{"same-as-input"}
\row \li \b{Default:} \li \c{"binary1"} for iOS; \c{"same-as-input"} or \c{"xml1"}
for OS X depending on whether \c{infoPlistFile} is
specified; undefined for all other operating systems.
\endtable
The file format to write the product's resulting Info.plist in.
\section1 Path Specific Properties
All properties in this section are read-only properties specifying file paths
relative to the directory containing the bundle.
\section2 infoPlistPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path that the Info.plist file will be written to. If \c{embedInfoPlist} is \c{true}, this will
point to a file in a temporary directory.
\section2 infoPlistPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path that the PkgInfo file will be written to.
\section2 versionPlistPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path that the version.plist file will be written to.
\section2 executablePath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path that the main executable file will be written to.
\section2 executableFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where the main exectuable will be written.
Not to be confused with \c{executablesFolderPath}.
\section2 executablesFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where auxiliary executables will be copied.
Not to be confused with \c{executableFolderPath}.
\section2 frameworksFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where internal frameworks will be copied.
\section2 pluginsFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where plugins will be copied.
\section2 privateHeadersFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where private header files will be copied.
\section2 publicHeadersFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where public headers files will be copied.
\section2 scriptsFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where script files will be copied.
\section2 sharedFrameworksFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where shared frameworks will be copied.
\section2 sharedSupportFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where shared support files will be copied.
\section2 unlocalizedResourcesFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the directory where non-localized resource files will be copied.
This is the same as the base resources path.
\section2 contentsFolderPath
\table
\row \li \b{Type:} \li \c{string}
\endtable
Path of the bundle's Contents subdirectory.
*/
|
