Module bundle
The 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".
General Properties
isBundle
Type: | bool |
Default: | true for application and dynamic library products on OS X and iOS, false otherwise |
Whether the product should actually be packaged as a bundle as opposed to a flat file. This allows a product indirectly dependent on the bundle
module to retain control of whether it should actually be built as a bundle.
isShallow
Type: | bool |
Default: | true for iOS applications |
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.
identifierPrefix
Type: | string |
Default: | org.example |
Prefix for the product's bundle identifier. If identifier
is left unset, the bundle identifier will be a concatenation of this value and the identifier
property, separated by a '.'. This corresponds to the organization identifier in Xcode.
identifier
Type: | string |
Default: | combination of identifierPrefix and the product's target name formatted as an RFC 1034 identifier |
The bundle's identifier. If left unset, the bundle identifier will be a concatenation of this value and the identifierPrefix
property, separated by a '.'.
extension
Type: | string |
Default: | "app" for "APPL" packages, "framework" for "FMWK" packages, "bundle" for "BNDL" and custom packages |
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.
packageType
Type: | string |
Default: | "APPL" for applications, "FMWK" for frameworks "BNDL" for custom bundles |
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.
signature
Type: | string |
Default: | "????" |
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.
bundleName
Type: | string |
Default: | combination of the product's targetName and bundle's extension |
The file name of the bundle's wrapper directory. This property should not normally need to be changed.
frameworkVersion
Type: | string |
Default: | "A" |
For framework bundles, the version of the framework. Unused for other package types.
publicHeaders
Type: | pathList |
Default: | undefined |
List of public header files to copy to a framework bundle's Headers subdirectory.
privateHeaders
Type: | pathList |
Default: | undefined |
List of private header files to copy to a framework bundle's PrivateHeaders subdirectory.
resources
Type: | pathList |
Default: | undefined |
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.
infoPlistFile
Type: | path |
Default: | undefined |
Path to the Info.plist file used by the bundle. The contents of this file will be aggregated with the values in infoPlist
. If infoPlistFile
and infoPlist
contain the same key, the latter will take precedence, but may also be overridden during postprocessing (see processInfoPlist
). If undefined, will not be taken into account.
infoPlist
Type: | object |
Default: | undefined |
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 infoPlistFile
. If infoPlist
and infoPlistFile
contain the same key, the former will take precedence, but may also be overridden during postprocessing (see processInfoPlist
). If undefined, will not be taken into account.
processInfoPlist
Type: | bool |
Default: | true |
Whether to perform post-processing on the aggregated Info.plist contents. If this property is 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 infoPlistFile
property and the 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.
embedInfoPlist
Type: | bool |
Default: | true if the product is a command line tool, otherwise false . |
Whether to create a __TEXT section in the product's executable containing the processed Info.plist. Only applies to command line applications.
infoPlistFormat
Type: | string |
Allowed Values: | "xml1" , "binary1" , "json" , "same-as-input" |
Default: | "binary1" for iOS; "same-as-input" or "xml1" for OS X depending on whether infoPlistFile is specified; undefined for all other operating systems. |
The file format to write the product's resulting Info.plist in.
Path Specific Properties
All properties in this section are read-only properties specifying file paths relative to the directory containing the bundle.
infoPlistPath
Type: | string |
Path that the Info.plist file will be written to. If embedInfoPlist
is true
, this will point to a file in a temporary directory.
infoPlistPath
Type: | string |
Path that the PkgInfo file will be written to.
versionPlistPath
Type: | string |
Path that the version.plist file will be written to.
executablePath
Type: | string |
Path that the main executable file will be written to.
executableFolderPath
Type: | string |
Path of the directory where the main exectuable will be written. Not to be confused with executablesFolderPath
.
executablesFolderPath
Type: | string |
Path of the directory where auxiliary executables will be copied. Not to be confused with executableFolderPath
.
frameworksFolderPath
Type: | string |
Path of the directory where internal frameworks will be copied.
pluginsFolderPath
Type: | string |
Path of the directory where plugins will be copied.
privateHeadersFolderPath
Type: | string |
Path of the directory where private header files will be copied.
publicHeadersFolderPath
Type: | string |
Path of the directory where public headers files will be copied.
scriptsFolderPath
Type: | string |
Path of the directory where script files will be copied.
sharedFrameworksFolderPath
Type: | string |
Path of the directory where shared frameworks will be copied.
sharedSupportFolderPath
Type: | string |
Path of the directory where shared support files will be copied.
unlocalizedResourcesFolderPath
Type: | string |
Path of the directory where non-localized resource files will be copied. This is the same as the base resources path.
contentsFolderPath
Type: | string |
Path of the bundle's Contents subdirectory.