isabella232 / callback-ios

PhoneGap iOS

PhoneGapLib is a static library that enables users to include PhoneGap in their iOS application projects easily, and also create new PhoneGap based iOS application projects through a Xcode project template.

Pre-requisites

Make sure you have installed the latest iOS SDK. Download it at http://developer.apple.com/ios

Build and install the Installer Package

You don't need to do this if you downloaded the installer from phonegap.com, this is only for developers that need to compile the source.

1. Launch "Terminal.app"
2. Navigate to the folder where the Makefile is
3. Type in "make" then press Enter

The installer should build "PhoneGapInstaller.dmg" into the dist folder, mount the .dmg, then:

1. Quit Xcode
2. Launch "PhoneGapInstaller.pkg" from the mounted .dmg, to install PhoneGapLib, the PhoneGap framework and the PhoneGap Xcode Templates.

Create a PhoneGap project (Xcode 3)

1. Launch Xcode, then under the File menu, select "New Project...".
2. Navigate to the "User Templates" section, select PhoneGap, then in the right pane, select "PhoneGap-based Application"
3. Select the "Choose..." button, name your project and choose the location where you want the new project to be.
4. Modify the contents of the "www" directory to add your HTML, CSS and Javascript.

Create a PhoneGap project (Xcode 4)

1. Launch Xcode, then under the File menu, select "New Project...".
2. Navigate to the "iOS" section, under "Applications" - then in the right pane, select "PhoneGap-based Application"
3. Select the "Next" button, name your project and company idenfifier, then select the "Next" button again.
4. Choose the location where you want the new project to be.
5. Run the project at least once to create the "www" folder in your project folder.
6. Drag and drop this "www" folder into your project in Xcode, and add it as a folder reference.
7. Modify the contents of the "www" directory to add your HTML, CSS and Javascript.

Uninstalling PhoneGapLib, PhoneGap.framework and the Xcode Templates

Use the "Uninstall PhoneGap" app included in the PhoneGap iOS DMG file, OR:

1. Launch "Terminal.app"
2. Navigate to the folder where Makefile is (this folder)
3. Type in "make uninstall" then press Enter

NOTE:

It will ask you to confirm whether you want to delete the installed PhoneGapLib directory (just in case you made changes there) as well as the PhoneGap framework. It will not ask for confirmation in deleting the installed Xcode templates.

Installer Notes

This installer will only install items under your home folder (signified by ~)

Items that will be installed:

1. Xcode global var in _~/Library/Preferences/com.apple.Xcode.plist _ (which will be listed under Xcode Preferences -> Source Trees)
2. PhoneGapLib Xcode static library project under ~/Documents/PhoneGapLib
3. Xcode project template in ~/Library/Application Support/Developer/Shared/Xcode/Project Templates/PhoneGap
4. Xcode 4 project template in ~/Library/Developer/Xcode/Templates/Project Templates/Application
5. PhoneGap Xcode static framework under /Users/Shared/PhoneGap/Frameworks/PhoneGap.framework (may change in future updates)
6. Symlink to the framework in (5) under ~/Library/Frameworks

To uninstall:

Delete the files listed above, or use the "Uninstall PhoneGap" app included in the PhoneGap iOS DMG file.

PhoneGapLib Tests

There is a Xcode project that will test PhoneGapLib according to the mobile spec. There is some setup needed before the project can be run. You will also need git installed and in your path.

Set up the test project:

1. Launch "Terminal.app"
2. Type in "chmod 755 update_test.sh"
3. Type in "./update_test.sh"

This will get the mobile-spec submodule and install it under the PhoneGapLibTests folder. You can then build and run the PhoneGapLibTest project to see the results.

You should run step (3) again before running any tests, to get the updated mobile-spec.

FAQ

1. In Xcode 4, I get an error that "The Start Page 'www/index.html' was not found."?

This is a known issue with the Xcode 4 Template - we can't specify a folder reference. You need to build the project at least once, then go to the folder where your project is in, and drag and drop in the www folder, then add it as a folder reference (will end up as a blue folder, not yellow), then run the project again. Check your project warnings as well for clues.

2. When I run the Installer, the installation fails?

Usually it's a folder permissions issue with the templates folder, changed by other third-party installers. You can trouble-shoot using the instructions here.

3. When I add Plugins, they are not found or won't compile?

Check your Xcode Run Log for clues.

This can be because of:

1. You did not add the plugin mapping in PhoneGap.plist/Plugins (contact the plugin creator for the proper mapping). The key is the service name used in the JavaScript interface and the value is the classname used in the Objective-C interface. Often the key and value are the same.
2. You did not add the plugin code as a "group" (yellow folder) but added it as a "folder reference" (blue folder)
3. You are having #import problems - see this article.

4. I get this error in my Xcode Run Log - 'ERROR whitelist rejection: url='http://<MYHOSTNAME>/'

This error occurs because of the new white-list feature in version 1.1.

You will have to add any hosts your app uses or connects to (hostnames/IP addresses only, without the protocol) in PhoneGap.plist/ExternalHosts. Wildcards are supported.

This includes external http/https/ftp/ftps links in:

1. HTML anchor tags
2. connections in JavaScript (i.e through XMLHttpRequest)
3. connections through Objective-C plugins

5. How do I effectively upgrade my project?

1. Create a new project
2. Copy your files into the www folder EXCEPT your phonegap-*.js files
3. In your index.html, edit the script tag to point to the new phonegap-*.js file
4. If you have plugins, copy them to the Plugins folder then re-add them in Xcode (NOT as folder references in blue, they should be folder groups in yellow).
5. Modify PhoneGap.plist/Plugins to add your plugin mappings (see FAQ question(s) above)
6. Modify PhoneGap.plist/ExternalHosts to add your external hosts to the white-list (see FAQ question(s) above)

6. I've got 'symbol not found' errors during runtime? Usually it's because I'm deploying to an iOS 3.x device.

With version 0.9.6, we implemented the W3C Media Capture API, which requires use of some iOS 4 APIs and frameworks. If you are deploying to an iOS 3.x device, you will need to "weak/optional" link three frameworks: UIKit, CoreMedia, and AVFoundation.

If you get a "Symbol not found: NSConcreteGlobalBlock", you will have to weak link libSystem through a command-line option.

This is because the LLVM compiler strong links NSConcreteGlobalBlock, but gcc weak links (correctly). Add a linker flag in "Other Linker Flags" in your project target: "-weak_library /usr/lib/libSystem.B.dylib"

Starting with version 1.1, when creating a new project, the weak-linking is added through a linker flag so you will not need to do this manually.

7. How do I override the location of the start page www/index.html?

You can override it by copy and pasting these functions 'wwwFolderName' and 'startPage' into your project's AppDelegate.m, and make the appropriate changes.

8. What's the difference between the Xcode 3 and Xcode 4 templates?

The PhoneGapLib static library is only used by the Xcode 3 template. The Xcode 4 template uses PhoneGap.framework (a static framework) because of Xcode 4's template limitations. Both are based off the same code, just packaged differently.

You can still create projects using the command line if you want to use the Xcode 3 Template in Xcode 4. This is particularly useful for developers debugging the PhoneGap core.

Links:

1. https://build.phonegap.com/generate
2. https://raw.github.com/phonegap/phonegap-iphone/1.0.0/create_project.sh

9. In Xcode 3, I want to have a project-specific copy of PhoneGapLib for my project, not a global one. How do I do this?

In your project, there should be a PhoneGapBuildSettings.xcconfig file. Modify the PHONEGAPLIB variable in the file to point to your project specific PhoneGapLib folder. You can use relative paths, off $(PROJECT_DIR).

10. In Xcode 4, I want to have a project-specific copy of PhoneGap.framework for my project, not a global one. How do I do this?

A. Remove the existing PhoneGap.framework from your project, and drag and drop your own PhoneGap.framework in, that's all there is to it. To compile your own version of PhoneGap.framework, go to ~/Documents/PhoneGapLib and run the Xcode project with the UniversalFramework target. You might need to modify the USER_FRAMEWORK_SEARCH_PATHS in your project as well.

11. I've got other PhoneGap-specific issues not covered here?

A. Older pre-1.0 issues have been put in the PhoneGap iOS FAQ on the Wiki.

12. On an iOS 3.2 iPad, and launching an iPhone only app, when I use the Media Capture API, the user interface shown is iPad sized, not iPhone sized?

A. You must delete the *~ipad.png images from Capture.bundle if they want to build an iPhone only app and have captureAudio() display properly on an iPad. This additional fix is just for iPad running iOS 3.2 - if the requested *~ipad.png is not available it returns the iPhone sized image.

13. I get this linker error: "ld: warning: ignoring file libPhoneGap.a, file was built for archive which is not the architecture being linked (armv7)"

A. In your project's Build Settings, set "Build for Active Architecture Only" to NO. This has been fixed in PhoneGap 1.2 for newly created projects. This is usually because Xcode 4 will only build for armv7 by default, and not armv6.

BUGS?

File them at PhoneGap-iOS GitHub Issues

MORE INFO

• http://docs.phonegap.com
• http://wiki.phonegap.com
• http://groups.google.com/group/phonegap
• #phonegap channel on Freenode IRC