MapLibreParticleLab/platform/ios/DEVELOPING.md

Contributing to the Mapbox iOS SDK

This document explains how to build the Mapbox iOS SDK from source. It is intended for advanced developers who wish to contribute to Mapbox GL and the Mapbox iOS SDK.

Requirements

The Mapbox iOS SDK and iosapp demo application build against the iOS 7.0 SDK. The SDK is intended to run on iOS 7.0 and above, while iosapp is intended to run on iOS 8.0 and above due to the use of a dynamic framework. Both require Xcode on a computer running OS X.

Building the SDK

Install core dependencies, then run

make iproj

which will create and open an Xcode workspace that includes both the SDK source and some Objective-C test applications. Before building, use the scheme picker button in the toolbar to change the scheme to “iosapp” and the destination to one of the simulators or connected devices listed in the menu.

“iosapp” is only one of several shared schemes. Others include:

• “CI” builds exactly what gets built for continuous integration on Bitrise.
• “bench” is a simple benchmarking application. For more consistent results between runs, run platform/ios/benchmark/assets/{glyphs,tiles}/download.sh to download any necessary resources.
• “dynamic” builds the SDK as a dynamic framework.
• “static” builds the SDK as a static library and separate resource bundle.
• “dynamic+static” is a combination of the “dynamic” and “static” schemes.

If you don’t have an Apple Developer account, change the destination to a simulator such as “iPhone 6s” before you run and build the app.

iproj is only one of several available make rules. Others include:

• make ipackage builds both dynamic and static frameworks in the Release configuration for devices and the iOS Simulator.
• make ipackage-sim builds a dynamic framework in the Debug configuration for the iOS simulator. This is the fastest target.
• make ipackage-strip builds both dynamic and static frameworks in the Release configuration, stripped of debug symbols, for devices and the iOS Simulator.
• make iframework builds a dynamic framework in the Release configuration for devices and the iOS Simulator. The CocoaPods pod downloads the output of this target.
• make ifabric builds a special static framework for compatibility with the Fabric Mac application.

You can customize the build output by passing the following arguments into the make invocation:

• BUILD_DEVICE=false builds only for the iOS Simulator.
• FORMAT=dynamic builds only a dynamic framework. FORMAT=static builds only a static framework, for compatibility with iOS 7.x.
• SYMBOLS=NO strips the build output of any debug symbols, yielding much smaller binaries.

These targets require that you install jazzy for generating API documentation:

[sudo] gem install jazzy

Contributing

Adding a source code file

To add an Objective-C header or implementation file to the iOS SDK:

1. Add the file to the Headers or Compile Sources build phase, as appropriate, of both the “dynamic” and “static” targets. You can either use the Build Phases tab of the project editor or the Target Membership section of the File inspector.
2. (Optional.) If it’s a public header, change its visibility from Project to Public and import it in the iOS SDK’s umbrella header.
3. (Optional.) If the file would also be used by the OS X SDK, make sure it’s in platform/darwin/src/, then consult the companion OS X document for further instructions.

Adding a resource

To add a resource (such as an image, SSL certificate, property list, or strings table) to the iOS SDK:

1. Add the header to the Copy Bundle Resources build phase of both the “dynamic” and “bundle” targets. You can either use the Build Phases tab of the project editor or the Target Membership section of the File inspector.
2. (Optional.) If the resource would also be used by the OS X SDK, make sure it’s in platform/darwin/resources/, then consult the companion OS X document for further instructions.

Adding user-facing text

To add or update text that the user may see in the iOS SDK:

1. Make sure the implementation file imports NSBundle+MGLAdditions.h.
2. Use the NSLocalizedStringWithDefaultValue() macro:

• key is a unique identifier that won’t change if the user-facing text ever needs to change.
• tbl is Foundation in code shared between the iOS and OS X SDKs, or nil otherwise.
• bundle is nil; the redefined macro looks for the SDK bundle at runtime and ignores this argument.
• val is the English string.

1. (Optional.) When dealing with a number followed by a pluralized word, do not split the string. Instead, use a format string and make val ambiguous, like %d file(s). Then pluralize for English in the appropriate .stringsdict file. See platform/darwin/resources/en.lproj/Foundation.stringsdict for an example. Localizers should do likewise for their languages.
2. Run make genstrings and commit any changes it makes to .strings files. The make rule also updates the OS X SDK’s strings tables.

Testing

make test-ios builds and runs unit tests of cross-platform code as well as the SDK.

To run these unit tests on the command line, install ios-sim version 3.2.0 (not any other version):

brew tap mapbox/homebrew-ios-sim-3
brew install mapbox/homebrew-ios-sim-3/ios-sim

To instead run the tests in Xcode:

1. Run make iproj to set up the workspace.
2. Change the scheme to “test (platform project)” and press Command-R to run core unit tests.
3. Change the scheme to “CI” and press Command-U to run SDK integration tests.

Access tokens

The included applications use Mapbox vector tiles, which require a Mapbox account and API access token. Obtain an access token on the Mapbox account page. You will be prompted for this access token the first time you launch the demo or benchmarking application. In the iOS Simulator, you can paste your access token by pressing Command-V, holding down the left mouse button in the text field, and pressing the Paste button that appears.

Using iosapp

• Pan to move
• Pinch to zoom
• Use two fingers to rotate
• Double-tap to zoom in one level
• Two-finger single-tap to zoom out one level
• Double-tap, long-pressing the second, then pan up and down to "quick zoom" (iPhone only, meant for one-handed use)
• Use the debug menu to add test annotations, reset position, and cycle through the debug options.