Application Bundle: what changed
Revision 3 to 4. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | - | ||
| 2 | - | ||
| 3 | - | ||
| 4 | - | ||
| 5 | - | ||
| 6 | - | ||
| 7 | - | ||
| 8 | - | ||
| 9 | - | ||
| 10 | - | ||
| 11 | - | ||
| 12 | - | ||
| 13 | - | ||
| 14 | - | ||
| 15 | - | ||
| 16 | - | ||
| 17 | - | ||
| 18 | - | ||
| 19 | - | ||
| 20 | - | ||
| 21 | - | ||
| 22 | 1 | ## Overview | |
| 23 | 2 | ||
| 24 | - | ||
| 3 | + | An application bundle is a directory with the extension ".app" on macOS systems. It contains the application executable, resource files, library files (if any), help files and information about the application and is necessary for the correct execution of applications. The Mac Finder treats this .app directory as the application file and by default does not show any of its sub-directories. | |
| 25 | 4 | ||
| 26 | - | ||
| 5 | + | From within Lazarus it is used for the [[Carbon Interface|Carbon]] and [[Cocoa Interface|Cocoa]] interfaces, but one can also build applications with other interfaces (eg Gtk or Qt) by using scripts. | |
| 27 | 6 | ||
| 28 | - | ||
| 7 | + | You can learn more about application bundles in the Apple Bundle Programming Guide. | |
| 29 | 8 | ||
| 30 | - | ||
| 9 | + | Application (bundle) settings are located in the property list file: [[macOS property list files|Info.plist]] located in the `bundle.app/Contents/` directory. | |
| 31 | 10 | ||
| 32 | - | ||
| 11 | + | The **PkgInfo** file is an alternative way to specify the type and creator codes of your application or bundle. This file is not required, but can improve performance for code that accesses this information. Regardless of whether you provide this file, you should always include type and creator information in your information property list file using the CFBundlePackageType and CFBundleSignature keys, respectively. The contents of the PkgInfo file are the 4-byte package type followed by the 4-byte signature of your application. Thus, for the TextEdit application, whose type is 'APPL' and whose signature is 'ttxt', the file would contain the ASCII string “APPLttxt”. | |
| 33 | 12 | ||
| 34 | - | ||
| 13 | + | To access the application bundle contents in Finder, you need to right click (ctrl-left click) on a bundle and select *Show Package Contents* | |
| 35 | 14 | ||
| 36 | - | ||
| 15 | + |  | |
| 37 | 16 | ||
| 38 | - | ||
| 17 | + |  | |
| 39 | 18 | ||
| 40 | 19 | ## Application bundle layout | |
| 41 | 20 | ||
| 42 | - | ||
| 43 | - | ||
| 44 | - | ||
| 45 | - | ||
| 46 | - | ||
| 47 | - | ||
| 48 | - | ||
| 49 | - | ||
| 50 | - | ||
| 21 | + | The basic structure of a Mac application bundle: | |
| 51 | 22 | ||
| 52 | - | ||
| 53 | - | ||
| 54 | - | ||
| 55 | - | ||
| 56 | - | ||
| 57 | - | ||
| 58 | - | ||
| 59 | - | ||
| 23 | + | `MyApp.app/`\ | |
| 24 | + | ` Contents/`\ | |
| 25 | + | ` Info.plist`\ | |
| 26 | + | ` MacOS/`\ | |
| 27 | + | ` PkgInfo`\ | |
| 28 | + | ` Resources/` | |
| 29 | + | ||
| 30 | + | | Sub-Directory of the Contents directory | Usage description | | |
| 31 | + | |----|----| | |
| 32 | + | | MacOS | (Required) Contains the application’s standalone executable code. Typically, this directory contains only one binary file with your application’s main entry point and statically linked code. However, you may put other standalone executables (such as command-line tools) in this directory as well. | | |
| 33 | + | | Resources | Contains all of the application’s resource files. The contents of this directory are further organized to distinguish between localized and nonlocalized resources. For more information about the structure of this directory, see [[Add an Apple Help Book to your macOS app|Adding a Help Book - Bundle layouts]]. | | |
| 34 | + | | Frameworks | Contains any private shared libraries and frameworks used by the executable. The frameworks in this directory are revision-locked to the application and cannot be superseded by any other, even newer, versions that may be available to the operating system. In other words, the frameworks included in this directory take precedence over any other similarly named frameworks found in other parts of the operating system. For information on how to add shared libraries to your application bundle, see [[macOS Dynamic Libraries]]. | | |
| 35 | + | | PlugIns | Contains loadable bundles that extend the basic features of your application. You use this directory to include code modules that must be loaded into your application’s process space in order to be used. You would not use this directory to store standalone executables. | | |
| 36 | + | | SharedSupport | Contains additional non-critical resources that do not impact the ability of the application to run. You might use this directory to include things like document templates, clip art, and tutorials that your application expects to be present but that do not affect the ability of your application to run. | | |
| 37 | + | ||
| 60 | 38 | ## Creating the Application Bundle | |
| 61 | 39 | ||
| 62 | 40 | ### Using Lazarus | |
| 63 | 41 | ||
| 64 | - | ||
| 65 | - | ||
| 66 | - | ||
| 42 | + | Open a project in the Lazarus IDE and go to Project -\> Project Options -\> Application tab and push the [[IDE Window: Project Options|Create Application Bundle]] button. The resulting Application Bundle will contain a symbolic link to the real executable. | |
| 67 | 43 | ||
| 68 | - | ||
| 44 | + | > **Note:** You must remove the symbolic link and copy the real executable "project1" into the `project1.app/Contents/MacOS/` directory to distribute the application and use it on another computer. | |
| 69 | 45 | ||
| 70 | 46 | ### Using the Lazarus command-line tool | |
| 71 | 47 | ||
| 72 | - | ||
| 48 | + | Open `/Applications/Lazarus/components/macfiles/examples/createmacapplication.lpi` in the Lazarus IDE. Compile. | |
| 73 | 49 | ||
| 74 | - | ||
| 75 | - | ||
| 50 | + | Open a Terminal of your choice and type: | |
| 51 | + | ||
| 52 | + | ``` bash | |
| 76 | 53 | cd project1/ | |
| 77 | - | ||
| 78 | - | ||
| 54 | + | /Applications/Lazarus/components/macfiles/examples/createmacapplication project1 | |
| 55 | + | ln -s ../../../project1 project1.app/Contents/MacOS/project1 | |
| 79 | 56 | ``` | |
| 80 | 57 | ||
| 81 | 58 | ### Using a shell script | |
| 82 | 59 | ||
| 83 | - | ||
| 60 | + | You can adapt the following shell script to create a customized application bundle for your application. It allows the creation of either a debug or a release bundle. | |
| 84 | 61 | ||
| 85 | - | ||
| 86 | - | ||
| 62 | + | - In the debug bundle, a link to the executable is placed, allowing for debugging using the Lazarus IDE, | |
| 63 | + | - In the release bundle, the executable is copied so the application bundle as a whole can be used stand-alone/copied to other locations. | |
| 87 | 64 | ||
| 88 | - | ||
| 65 | + | ``` bash | |
| 89 | 66 | #!/bin/sh | |
| 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 | - | ||
| 67 | + | # Force Bourne shell in case tcsh is default. | |
| 68 | + | # | |
| 69 | + | ||
| 70 | + | # | |
| 71 | + | # Reads the bundle type | |
| 72 | + | # | |
| 73 | + | ||
| 74 | + | echo "========================================================" | |
| 75 | + | echo " Bundle creation script" | |
| 76 | + | echo "========================================================" | |
| 77 | + | echo "" | |
| 78 | + | echo " Please select which kind of bundle you would like to build:" | |
| 79 | + | echo "" | |
| 80 | + | echo " 1 > Debug bundle" | |
| 81 | + | echo " 2 > Release bundle" | |
| 82 | + | echo " 0 > Exit" | |
| 83 | + | ||
| 84 | + | read command | |
| 85 | + | ||
| 86 | + | case $command in | |
| 87 | + | ||
| 88 | + | 1) ;; | |
| 89 | + | ||
| 90 | + | 2) ;; | |
| 91 | + | ||
| 92 | + | 0) exit 0;; | |
| 93 | + | ||
| 94 | + | *) echo "Invalid command" | |
| 95 | + | exit 0;; | |
| 96 | + | ||
| 97 | + | esac | |
| 98 | + | ||
| 99 | + | # | |
| 100 | + | # Creates the bundle | |
| 101 | + | # | |
| 102 | + | ||
| 103 | + | appname=Magnifier | |
| 104 | + | appfolder=$appname.app | |
| 105 | + | macosfolder=$appfolder/Contents/MacOS | |
| 106 | + | plistfile=$appfolder/Contents/Info.plist | |
| 107 | + | appfile=magnifier | |
| 108 | + | ||
| 109 | + | PkgInfoContents="APPL????" | |
| 110 | + | ||
| 111 | + | # | |
| 112 | + | if ! [ -e $appfile ] | |
| 113 | + | then | |
| 114 | + | echo "$appfile does not exist" | |
| 115 | + | elif [ -e $appfolder ] | |
| 116 | + | then | |
| 117 | + | echo "$appfolder already exists" | |
| 118 | + | else | |
| 119 | + | echo "Creating $appfolder..." | |
| 120 | + | mkdir $appfolder | |
| 121 | + | mkdir $appfolder/Contents | |
| 122 | + | mkdir $appfolder/Contents/MacOS | |
| 123 | + | mkdir $appfolder/Contents/Frameworks # optional, for including libraries or frameworks | |
| 124 | + | mkdir $appfolder/Contents/Resources | |
| 125 | + | ||
| 126 | + | # | |
| 127 | + | # For a debug bundle, | |
| 128 | + | # Instead of copying executable into .app folder after each compile, | |
| 129 | + | # simply create a symbolic link to executable. | |
| 130 | + | # | |
| 131 | + | if [ $command = 1 ]; then | |
| 132 | + | ln -s ../../../$appname $macosfolder/$appname | |
| 133 | + | else | |
| 134 | + | cp $appname $macosfolder/$appname | |
| 135 | + | fi | |
| 136 | + | ||
| 137 | + | # Copy the resource files to the correct place | |
| 138 | + | cp *.bmp $appfolder/Contents/Resources | |
| 139 | + | cp icon3.ico $appfolder/Contents/Resources | |
| 140 | + | cp icon3.png $appfolder/Contents/Resources | |
| 141 | + | cp macicon.icns $appfolder/Contents/Resources | |
| 142 | + | cp docs/*.* $appfolder/Contents/Resources | |
| 143 | + | # | |
| 144 | + | # Create PkgInfo file. | |
| 145 | + | echo $PkgInfoContents >$appfolder/Contents/PkgInfo | |
| 146 | + | # | |
| 147 | + | # Create information property list file (Info.plist). | |
| 148 | + | echo '<?xml version="1.0" encoding="UTF-8"?>' >$plistfile | |
| 149 | + | echo '<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">' >>$plistfile | |
| 150 | + | echo '<plist version="1.0">' >>$plistfile | |
| 151 | + | echo '<dict>' >>$plistfile | |
| 152 | + | echo ' <key>CFBundleDevelopmentRegion</key>' >>$plistfile | |
| 153 | + | echo ' <string>English</string>' >>$plistfile | |
| 154 | + | echo ' <key>CFBundleExecutable</key>' >>$plistfile | |
| 155 | + | echo ' <string>'$appname'</string>' >>$plistfile | |
| 156 | + | echo ' <key>CFBundleIconFile</key>' >>$plistfile | |
| 157 | + | echo ' <string>macicon.icns</string>' >>$plistfile | |
| 158 | + | echo ' <key>CFBundleIdentifier</key>' >>$plistfile | |
| 159 | + | echo ' <string>org.magnifier.magnifier</string>' >>$plistfile | |
| 160 | + | echo ' <key>CFBundleInfoDictionaryVersion</key>' >>$plistfile | |
| 161 | + | echo ' <string>6.0</string>' >>$plistfile | |
| 162 | + | echo ' <key>CFBundlePackageType</key>' >>$plistfile | |
| 163 | + | echo ' <string>APPL</string>' >>$plistfile | |
| 164 | + | echo ' <key>CFBundleSignature</key>' >>$plistfile | |
| 165 | + | echo ' <string>MAG#</string>' >>$plistfile | |
| 166 | + | echo ' <key>CFBundleVersion</key>' >>$plistfile | |
| 167 | + | echo ' <string>1.0</string>' >>$plistfile | |
| 168 | + | echo '</dict>' >>$plistfile | |
| 169 | + | echo '</plist>' >>$plistfile | |
| 170 | + | fi | |
| 194 | 171 | ``` | |
| 195 | 172 | ||
| 196 | 173 | ## Executing an application via the Application Bundle | |
| 197 | 174 | ||
| 198 | - | ||
| 199 | - | ||
| 175 | + | You can start the application from the Lazarus IDE, by clicking on its Finder icon or in the native macOS Terminal.app by typing: | |
| 176 | + | ||
| 177 | + | ``` bash | |
| 200 | 178 | open project1.app | |
| 201 | 179 | ``` | |
| 202 | 180 | ||
| 203 | - | ||
| 204 | - | ||
| 181 | + | or | |
| 182 | + | ||
| 183 | + | ``` bash | |
| 205 | 184 | ./project1.app/Contents/MacOS/project1 | |
| 206 | 185 | ``` | |
| 207 | 186 | ||
| 208 | 187 | ## See also | |
| 209 | 188 | ||
| 210 | - | ||
| 211 | - | ||
| 212 | - | ||
| 213 | - | ||
| 189 | + | - [[Add an Apple Help Book to your macOS app]] | |
| 190 | + | - [[Deploying Your Application|Deploying your macOS application]] | |
| 191 | + | - [[Hiding a macOS app from the Dock]] | |
| 192 | + | - [[macOS property list files]] | |
| 214 | 193 | ||
| 215 | 194 | ## External links | |
| 216 | 195 | ||
| 217 | - | ||
| 218 | - | ||
| 219 | - | ||
| 220 | - | ||
| 221 | - | ||
| 222 | - | ||
| 196 | + | - [Apple: NSBundle class](https://developer.apple.com/documentation/foundation/nsbundle) | |
| 197 | + | - [Apple: Bundle Resources](https://developer.apple.com/documentation/bundleresources/) | |
| 198 | + | - [Apple: CFBundle](https://developer.apple.com/documentation/corefoundation/cfbundle) | |
| 199 | + | - [Apple: Bundle Configuration](https://developer.apple.com/documentation/bundleresources/information_property_list/bundle_configuration) | |
| 200 | + | - [Apple: Resource Programming Guide](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/LoadingResources/Introduction/Introduction.html) | |
| 201 | + | - [Apple: Bundle Programming Guide](https://developer.apple.com/library/archive/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html) | |
| 223 | 202 | ||
| 224 | 203 | --- | |
| 225 | - | ||
| 204 | + | *From the Free Pascal wiki, page "Application Bundle", as it stood on 2022-03-13 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |