MapLibreParticleLab/platform/ios/CONTRIBUTING.md

Contributing to MapLibre Native for iOS

This document explains how to build MapLibre Native for iOS from source. It is intended for advanced developers who wish to contribute to the library.

If you have a usage question for a product built on MapLibre Native (such as our iOS or Android SDKs), please create a discussion thread on GitHub Discussions.

If you want to contribute code:

1. Please familiarize yourself with the install process.

2. Ensure that existing pull requests and issues don’t already cover your contribution or question.

3. Pull requests are gladly accepted. If there are any changes that developers using one of the GL SDKs should be aware of, please update the main section of the iOS changelog or macOS changelog.

4. Prefix your commit messages with the platform(s) your changes affect: [ios] or [macos].

Requirements

See the "Requirements" section in INSTALL.md.

Building the SDK

Create and open an Xcode workspace that includes both the SDK source and some Objective-C test applications by running:

# make and open the Xcode workspace
make iproj

# make Xcode workspace, but run in headless mode
make iproj CI=1

# Make Frameworks
make xcframework BUILDTYPE=Release

Xcode schemes

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:

• 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.
• CI builds exactly what gets built by our continuous integration service.
• 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.

If you don’t have an Apple Developer account, change the destination to a simulator before you build and run the app.

Packaging builds

Install jazzy for generating API documentation:

[sudo] gem install jazzy

Build and package the SDK by using the make iframework command. You can customize the build output by passing the following arguments into the make invocation:

• BUILDTYPE=Release will optimize for distribution. Defaults to Debug.
• BUILD_DEVICE=false builds only for the iOS Simulator.
• FORMAT=dynamic builds only a dynamic framework. FORMAT=static builds only a static framework, for legacy compatibility.
• SYMBOLS=NO strips the build output of debug symbols. Defaults to YES.

An example command that creates a dynamic framework suitable for eventual App Store distribution:

make iframework BUILDTYPE=Release

The products of these build commands can be found in the build/ios/pkg folder at the base of the repository.

Documentation

We are moving away from the legacy Jazzy documentation towards Apple's documentation generator DocC. DocC has great Xcode intergration. See the open issues if you want to help.

• For a general introduction to DocC, including for example a demonstration of the custom Markdown that DocC uses that allows for cross-linking, see this WWDC video: https://developer.apple.com/videos/play/wwdc2021/10166/
• For instructions of how to write a tutorial in DooC format: https://developer.apple.com/documentation/docc/building-an-interactive-tutorial
• For instructions of how to write supplemental documentation: https://www.swift.org/documentation/docc/adding-supplemental-content-to-a-documentation-catalog

The most convenient way to generate the DocC based documentation locally is using Xcode by going to Product > Build Documentation. A new window will pop up (screenshot).

Jazzy Documentation

The code samples in the header files & iOS API Documentation are generated by a unit test.

An example of auto generated documentation is the unit test MLNDocumentationExampleTests.swift which generates styling examples in the .h file for styling either a Circle, Heatmap, or Line. For more details see Adding a code example.

Use make to update API documentation:

# Updates the header `.h` with unit tested code from Swift
make darwin-style-code

# refresh the documentation in the folder `documentation/`
make idocument

# open the folder `documentation/` in macOS Finder
open documentation/
# serve documentation/

Contributing

Making any symbol public

To add any Objective-C type, constant, or member to the iOS SDK’s public interface:

1. Ensure that the symbol is pure Objective-C and does not rely on any language features specific to Objective-C++ or the C11 dialect of C – so no namespaced types or classes named with emoji! 🙃 Most projects that depend on this SDK are either written in pure Objective-C (GNU99 dialect) or Swift, which cannot yet bridge C++ types.
2. Name the symbol according to Cocoa naming conventions. Use the MLN class prefix to avoid conflicts with client code. If the symbol has an analogue in MapKit, name the symbol according to MapKit.
3. Provide full documentation comments. We use jazzy to produce the documentation found in the SDK distribution and on the website for this SDK. We also recognize that many developers rely on Xcode’s Quick Help feature. jazzy supports Markdown formatting; however, Quick Help supports only HeaderDoc syntax and a subset of Doxygen syntax. For hyperlinks, use HTML syntax, which is recognized by both tools.

Making a type or constant public

To add an Objective-C class, protocol, category, typedef, enumeration, or global constant to the iOS maps SDK’s public interface:

1. (Optional.) Add the macro MLN_EXPORT prior to the declaration for classes and global constants when adding them in shared headers located in platform/darwin. To use this macro, include MLNFoundation.h. You can check whether all public symbols are exported correctly by running make darwin-check-public-symbols.
2. (Optional.) Add the type or constant’s name to the relevant category in the custom_categories section of the jazzy configuration file. This is required for classes and protocols and also recommended for any other type that is strongly associated with a particular class or protocol. If you leave out this step, the symbol will appear in an “Other” section in the generated HTML documentation’s table of contents.
3. (Optional.) If the symbol would also be publicly exposed in the macOS maps SDK, consult the companion macOS document for further instructions.

Adding a source code file

To add an Objective-C header or implementation file to the iOS maps 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. Audit new headers for nullability. Typically, you will wrap a header with NS_ASSUME_NONNULL_BEGIN and NS_ASSUME_NONNULL_END.
3. (Optional.) If it’s a public header, change its visibility from Project to Public and import it in the iOS SDK’s umbrella header.
4. (Optional.) If the file would also be used by the macOS maps SDK, make sure it’s in platform/darwin/src/, then consult the companion macOS document for further instructions.
5. Run scripts/generate-file-lists.js to update the generated source file list for third party build systems.

Adding a resource

To add a resource (such as an image, SSL certificate, property list, or strings table) to the iOS maps 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 macOS maps SDK, make sure it’s in platform/darwin/resources/, then consult the companion macOS document for further instructions.

Adding user-facing text

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

1. Make sure the implementation file imports NSBundle+MLNAdditions.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 macOS maps 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 macOS maps SDK’s strings tables.

Adding a localization

Warning

This section is outdated.

Translations of all the Mapbox GL Native SDKs are managed in Transifex. If your language already has a translation, feel free to complete or proofread it. Otherwise, please request your language. Note that we’re primarily interested in languages that iOS supports as system languages.

Once you’ve finished translating the SDK into a new language in Transifex, perform these steps to make Xcode aware of the translation:

1. In ios.xcworkspace, open the project editor for ios.xcodeproj. Using the project editor’s sidebar or tab bar dropdown, go to the “ios” project; under the Localizations section of the Info tab, click the + button to add your language to the project.
2. In the sheet that appears, select all the .strings and .stringsdict files but not the .storyboard file. (LaunchScreen.storyboard is part of the iosapp example application, which is not localized.) If your language lacks declension and pluralization, as in the case of Chinese, omit the .stringsdict files.
3. In the Project navigator, expand each .stringsdict file in the project. An additional version for your localization should be listed; translate it. See Apple’s documentation on the .stringsdict format.
4. In the Project navigator, select Demo App/Localizable.strings and then, in the File Inspector, check the box for your new localization.
5. Repeat the steps above in macos.xcworkspace.

The .strings files should still be in the original English – that’s expected. Now you can pull your translations into this repository:

1. (First time only.) Download the tx command line tool and configure your .transifexrc.
2. Run tx pull -a.
3. Convert any added .strings files from UTF-16 encoding to UTF-8 encoding to facilitate diffing and merging. You can convert the file encoding using Xcode’s File inspector or the following command (substituting MYLANG for the locale code):

find platform/{darwin,ios}/resources platform/macos/sdk -path '*/MYLANG.lproj/*.strings' -exec textutil -convert txt -extension strings -inputencoding UTF-16 -encoding UTF-8 {} -output {} \;

Adding a code example

To add an example code listing to the documentation for a class or class member:

1. Add a test case named in the form testMLNClass or testMLNClass$method to MLNDocumentationExamplesTests.
2. Wrap the code you'd like to appear in the documentation within the following comment blocks:

   //#-example-code
   ...
   //#-end-example-code
   

3. Insert an empty Swift code block inside the header file where you'd like the example code to be inserted.
4. Run make darwin-update-examples to extract example code from the test method below and insert it into the header. SourceKitten is required and will be installed automatically using Homebrew.

Customizing compilation settings

You can provide an optional and custom xcconfig file named platform/darwin/developer.xcconfig to set custom build options. This file is ignored by git. These custom settings apply to all configurations (Debug, Release, RelWithDebInfo), but do not apply to the core mbgl files. This mechanism allows you to try different compiler settings (for example when testing an Xcode beta).

Testing

You can review test results in $(IOS_OUTPUT_PATH)/Logs/Test. make ios-test builds and runs unit tests of cross-platform code and of the SDK. Other types of tests available include:

• make ios-integration-test runs UI tests from the "Integration Test Harness" scheme.
• make ios-sanitize runs unit tests from the "CI" scheme with the Thread Sanitizer and Undefined Behavior Sanitizer enabled.
• make ios-sanitize-address runs unit tests from the "CI" scheme with the Address Sanitizer enabled.
• make ios-static-analyzer runs unit tests from the "CI" scheme with the Static Analyzer enabled.
• make ios-uitest runs user interface testing from the "iosapp" scheme. These commands are run by default on a single Simulator. To enable legacy iOS versions and more device types, add MORE_SIMULATORS=YES. Use IOS_LATEST=YES, IOS_11=YES, etc. to test on specific iOS versions. To only run a specific test or class of tests, add ONLY_TESTING=test/MLNNameOfTestClass/testNameOfTest. To skip a specific test or class of tests, add SKIP_TESTING=test/MLNNameOfTestClass/testNameOfTest. To run the cross-platform tests in Xcode instead of on the command line:

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

Testing from the command line

# Change Directory
cd platform/ios/platform/ios
# Test Scheme CI
xcodebuild test -scheme CI \
  -destination 'platform=iOS Simulator,OS=14.5,name=iPhone SE (2nd generation)'
# Test Scheme with Test Plan over OS versions
xcodebuild test -scheme CI -testPlan CI-Expressions \
  -destination 'platform=iOS Simulator,OS=14.5,name=iPhone SE (2nd generation)'
xcodebuild test -scheme CI -testPlan CI-Expressions \
  -destination 'platform=iOS Simulator,OS=15.4,name=iPhone SE (3rd generation)'
xcodebuild test -scheme CI -testPlan CI-Expressions \
  -destination 'platform=iOS Simulator,OS=15.5,name=iPhone SE (3rd generation)'

Access tokens

Warning

This section is outdated.

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.

Before running the demo ("iosapp") or benchmarking ("bench") applications, first create a new text file called .mapbox or mapbox in your home directory containing your access token. The access token will then be automatically inserted into the application's Info.plist at runtime.

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" (meant for one-handed use)
• Use the debug menu to add test annotations, reset position, and cycle through the debug options.

Simulator

You can run automated test on a Simulator or Device by changing to the Scheme iosapp and choosing Product > Test (or use ⌘-U). Use ⌘-9 to navigate to Reports to see results and browse through screenshots. This method of testing should work well with CI tools such as GitHub Actions, Xcode Server Bots, & AWS Device Farm.