https://github.com/leetal/ios-cmake
A CMake toolchain file for iOS/iPadOS, visionOS, macOS, watchOS & tvOS C/C++/Obj-C++ development
https://github.com/leetal/ios-cmake
c catalyst cmake cmake-scripts cmake-toolchain cpp ios ios-cmake ios-development macos macosx objective-c tvos tvos-cmake tvos-development tvos-simulator visionos watchos watchos-cmake watchos-development
Last synced: 14 days ago
JSON representation
A CMake toolchain file for iOS/iPadOS, visionOS, macOS, watchOS & tvOS C/C++/Obj-C++ development
- Host: GitHub
- URL: https://github.com/leetal/ios-cmake
- Owner: leetal
- License: bsd-3-clause
- Created: 2017-02-03T09:17:19.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T18:17:06.000Z (about 1 month ago)
- Last Synced: 2025-04-10T23:58:46.115Z (14 days ago)
- Topics: c, catalyst, cmake, cmake-scripts, cmake-toolchain, cpp, ios, ios-cmake, ios-development, macos, macosx, objective-c, tvos, tvos-cmake, tvos-development, tvos-simulator, visionos, watchos, watchos-cmake, watchos-development
- Language: CMake
- Homepage:
- Size: 493 KB
- Stars: 2,029
- Watchers: 45
- Forks: 463
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- AwesomeCppGameDev - ios-cmake - C++ development (Tools)
README
A CMake toolchain file for iOS (+ Catalyst), watchOS, tvOS and macOS development with full simulator support and toggleable options!
# ios-cmake
[](https://github.com/leetal/ios-cmake/actions/workflows/catalyst.yml) [](https://github.com/leetal/ios-cmake/actions/workflows/combined.yml) [](https://github.com/leetal/ios-cmake/actions/workflows/ios.yml)
[](https://github.com/leetal/ios-cmake/actions/workflows/macos.yml) [](https://github.com/leetal/ios-cmake/actions/workflows/tvos.yml) [](https://github.com/leetal/ios-cmake/actions/workflows/watchos.yml)
[](https://github.com/leetal/ios-cmake/actions/workflows/visionos.yml)
## Platform flag options (-DPLATFORM=_flag_)
* _OS_ - to build for iOS (armv7, armv7s, arm64) -- **DEPRECATED in favour of OS64**
* _OS64_ - to build for iOS (arm64 only)
* _OS64COMBINED_ - to build for iOS & iOS Simulator (FAT lib) (arm64, x86_64)
* _SIMULATOR_ - to build for iOS simulator 32 bit (i386) -- **DEPRECATED**
* _SIMULATOR64_ - to build for iOS simulator 64 bit (x86_64)
* _SIMULATORARM64_ - to build for iOS simulator 64 bit (arm64)
* _SIMULATOR64COMBINED_ - to build for iOS simulator 64 bit (FAT lib) (arm64, x86_64)
* _VISIONOS_ - to build for visionOS (arm64) -- **Apple Silicon Required**
* _VISIONOSCOMBINED_ - to build for visionOS & visionOS Simulator (FAT lib) (arm64) -- **Apple Silicon Required**
* _SIMULATOR_VISIONOS_ - to build for visionOS Simulator (arm64) -- **Apple Silicon Required**
* _TVOS_ - to build for tvOS (arm64)
* _TVOSCOMBINED_ - to build for tvOS & tvOS Simulator (arm64, x86_64)
* _SIMULATOR_TVOS_ - to build for tvOS Simulator (x86_64)
* _SIMULATORARM64_TVOS_ = to build for tvOS Simulator (arm64)
* _WATCHOS_ - to build for watchOS (armv7k, arm64_32)
* _WATCHOSCOMBINED_ - to build for watchOS & Simulator (armv7k, arm64_32, x86_64)
* _SIMULATOR_WATCHOS_ - to build for watchOS Simulator (x86_64)
* _SIMULATORARM64_WATCHOS_ = to build for watchOS Simulator (arm64)
* _SIMULATOR_WATCHOSCOMBINED_ = to build for watchOS Simulator (FAT lib) (arm64, x86_64)
* _MAC_ - to build for macOS (x86_64)
* _MAC_ARM64_ - to build for macOS on Apple Silicon (arm64)
* _MAC_UNIVERSAL_ - to build for macOS on x86_64 and Apple Silicon (arm64) combined
* _MAC_CATALYST_ - to build iOS for Mac (Catalyst, x86_64)
* _MAC_CATALYST_ARM64_ - to build iOS for Mac on Apple Silicon (Catalyst, arm64)
* _MAC_CATALYST_UNIVERSAL_ - to build iOS for Mac on x86_64 and Mac on arm64 combined (Catalyst, x86_64, arm64)
# Example usage
**_NOTE_: Change the `-DPLATFORM` to an applicable value if targeting another platform.**
```bash
cd example/example-lib
cmake -B build -G Xcode -DCMAKE_TOOLCHAIN_FILE=../../ios.toolchain.cmake -DPLATFORM=OS64
cmake --build build --config Release
```
This will build the library for the given PLATFORM. In this case, iOS with the arm64 architecture.
## COMBINED Options
The options called *COMBINED (OS64COMBINED, TVOSCOMBINED and WATCHOSCOMBINED) will build complete FAT-libraries for
the given platform. These FAT-libraries include slices for both device and simulator, making the distribution and
usage of the library much more simple!
Example:
```bash
cmake . -G Xcode -DCMAKE_TOOLCHAIN_FILE=../../ios.toolchain.cmake -DPLATFORM=OS64COMBINED
cmake --build . --config Release
cmake --install . --config Release # Necessary to build combined library
```
**_NOTE_: The COMBINED options _ONLY_ work with the Xcode generator (-G Xcode) on CMake versions 3.14+!**
---
### Exposed Variables
`XCODE_VERSION` - Version number (not including Build version) of Xcode detected.
`SDK_VERSION` - Version of SDK being used.
`CMAKE_OSX_ARCHITECTURES` - Architectures being compiled for (generated from PLATFORM).
`APPLE_TARGET_TRIPLE` - Used by autoconf build systems.
### Additional Options
`-DENABLE_BITCODE=(BOOL)` - Disabled by default, specify TRUE or 1 to enable bitcode
`-DENABLE_ARC=(BOOL)` - Enabled by default, specify FALSE or 0 to disable ARC
`-DENABLE_VISIBILITY=(BOOL)` - Disabled by default, specify TRUE or 1 to enable symbol visibility support
`-DENABLE_STRICT_TRY_COMPILE=(BOOL)` - Disabled by default, specify TRUE or 1 to enable strict compiler checks (will run linker on all compiler checks whenever needed)
`-DARCHS=(STRING)` - Valid values are: armv7, armv7s, arm64, i386, x86_64, armv7k, arm64_32. By default it will build for all valid architectures based on `-DPLATFORM` (see above)
__*To combine all platforms into the same FAT-library, either build any of the "*COMBINED*" platform types OR use the
LIPO tool. More information on how to combine libraries with LIPO is readily available on the net.*__
## Thanks To
* 🌟 A heartfelt thank you to everyone who contributes to keeping this repository up-to-date! Your support and collaboration are invaluable in managing and tracking all the changes. Your help is greatly appreciated! 🙏🎉