Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/compnerd/swift-cmake-examples
Swift example projects
https://github.com/compnerd/swift-cmake-examples
Last synced: about 1 month ago
JSON representation
Swift example projects
- Host: GitHub
- URL: https://github.com/compnerd/swift-cmake-examples
- Owner: compnerd
- License: bsd-3-clause
- Created: 2019-05-23T00:28:33.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-02-01T02:41:45.000Z (11 months ago)
- Last Synced: 2024-08-05T10:18:50.612Z (5 months ago)
- Language: CMake
- Homepage:
- Size: 30.3 KB
- Stars: 118
- Watchers: 5
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CMake Examples for Swift
This repository contains example projects demonstrating how to setup a Swift project with CMake. Make sure to use the CMake Ninja generator and Ninja build tool. These hopefully cover a wide variety of use cases. Patches to add examples of missing use cases are welcome.
## Projects
- Hello Minimal
* Simple project with a pure Swift library and executable
- Build Dependencies
* Simple project with a library that depends on an external package which is built as part of the build
- Hello World
* Multi-library project with C and Swift code
# Why Use This
CMake is a meta-build system that allows you to generate the build rules using different build tools. It also makes it possible to setup the build in a way which supports cross-compiling for various targets (including Linux, Windows, and android).
# How to build with CMake
If `swiftc` is not in your path, you will need to add `-DCMAKE_Swift_COMPILER=`
with the path to swiftc.
Linux or macOS
```bash
cmake -B build -D CMAKE_BUILD_TYPE=RelWithDebInfo -D BUILD_TESTING=YES -G Ninja -S .
ninja -C build
ninja -C build test
```
Windows
> **NOTE:** we must build with the Release configuration on Windows as the Swift runtime
> in debug configuration is not distributed with the standard toolchain. MSVCRT cannot
> be used in different configurations in the same process, and will result in runtime
> failures.
```cmd
set SWIFTFLAGS=-sdk %SDKROOT%
cmake -B build -D CMAKE_BUILD_TYPE=Release -D CMAKE_Swift_FLAGS=%SWIFTFLAGS% -D BUILD_TESTING=YES -G Ninja -S .
ninja -C build
ninja -C build test
```
This invocation builds the project in release mode with debug information. This
enables optimized builds with debug information (or release only). Additionally, the standard
CMake option `BUILD_TESTING` is used to enable tests.
## What is supported
These project build on Linux, macOS, and Windows!
- `CMAKE_BUILD_TYPE`
* `Debug` (no optimizations, debug info)
* `Release` (all optimizations, no debug info)
* `RelWithDebInfo` (all optimizations, debug info)
* `MinSizeRel` (optimized for size)
- `MSVC_RUNTIME_LIBRARY` (*Windows Only*)
* `MultiThreadedDebugDLL` (`MDd`)
* `MultiThreadedDLL` (`MD`)