https://github.com/rhx/swiftcoglpango
A Swift wrapper around coglpango that is largely auto-generated from gobject-introspection
https://github.com/rhx/swiftcoglpango
cogl pango swift swift-wrappers
Last synced: about 1 month ago
JSON representation
A Swift wrapper around coglpango that is largely auto-generated from gobject-introspection
- Host: GitHub
- URL: https://github.com/rhx/swiftcoglpango
- Owner: rhx
- License: bsd-2-clause
- Created: 2016-09-25T09:46:27.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2022-04-25T20:13:59.000Z (about 4 years ago)
- Last Synced: 2025-03-22T22:36:24.525Z (about 1 year ago)
- Topics: cogl, pango, swift, swift-wrappers
- Language: Shell
- Homepage: https://rhx.github.io/SwiftCoglPango/
- Size: 590 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwiftCoglPango
A Swift wrapper around coglpango that is largely auto-generated from gobject-introspection.
For up to date (auto-generated) reference documentation, see https://rhx.github.io/SwiftCoglPango/
## What is new?
Version 15 of gir2swift provides a Package Manager Plugin. This requires Swift 5.6 or higher.
(older versions can be used via the [swift52](https://github.com/rhx/SwiftCoglPango/tree/swift52) branch).
## Prerequisites
### Swift 5.6 or higher
To build, download Swift from https://swift.org/download/ -- if you are using macOS, make sure you have the command line tools installed as well). Test that your compiler works using `swift --version`, which should give you something like
$ swift --version
swift-driver version: 1.45.2 Apple Swift version 5.6 (swiftlang-5.6.0.323.62 clang-1316.0.20.8)
Target: x86_64-apple-darwin20.3.0
on macOS, or on Linux you should get something like:
$ swift --version
Swift version 5.6.1 (swift-5.6.1-RELEASE)
Target: x86_64-unknown-linux-gnu
### GLib 2.56 and Cogl-1.22 or higher
These Swift wrappers have been tested with cogl-1.22 as well as glib-2.56, 2.58, 2.60, 2.62, 2.64, 2.66, 2.68, 2.70, and 2.72. They should work with higher versions, but YMMV. Also make sure you have `gobject-introspection` and its `.gir` files installed.
#### Linux
##### Ubuntu
On Ubuntu 20.04 and 22.04 you can use the glib that comes with the distribution. Just install with the `apt` package manager:
sudo apt update
sudo apt install libcogl-dev gir1.2-cogl-1.0 libcogl-pango-dev gir1.2-coglpango-1.0 libgdk-pixbuf2.0-dev gir1.2-gdkpixbuf-2.0 gobject-introspection libgirepository1.0-dev libxml2-dev jq
On Ubuntu 18.04, the name of the packages are slightly different. Install the following with the `apt` package manager:
sudo apt update
sudo apt install libCogl2-dev libCogl-gobject2 libcogl-pango-dev gir1.2-coglpango-1.0 libgdk-pixbuf2.0-dev libgdk-pixbuf2.0-dev gobject-introspection libgirepository1.0-dev libxml2-dev jq
##### Fedora
On Fedora 29, you can use the gtk that comes with the distribution. Just install with the `dnf` package manager:
sudo dnf install cogl-devel pango-devel gdk-pixbuf2-devel glib2-devel gobject-introspection-devel libxml2-devel jq
#### macOS
On macOS, you can install glib and cogl using HomeBrew (for setup instructions, see http://brew.sh). Once you have a running HomeBrew installation, you can use it to install a native version of cogl:
brew update
brew install cogl pango gdk-pixbuf glib glib-networking gobject-introspection pkg-config
## Usage
Normally, you don't build this package directly (but for testing you can - see 'Building' below). Instead you need to embed SwiftCoglPango into your own project using the [Swift Package Manager](https://swift.org/package-manager/). After installing the prerequisites (see 'Prerequisites' below), add `SwiftCoglPango` as a dependency to your `Package.swift` file, e.g.:
```Swift
// swift-tools-version:5.6
import PackageDescription
let package = Package(name: "MyPackage",
dependencies: [
.package(url: "https://github.com/rhx/gir2swift.git", branch: "main"),
.package(url: "https://github.com/rhx/SwiftCoglPango.git", branch: "main"),
],
targets: [
.target(name: "MyPackage",
dependencies: [
.product(name: "CoglPango", package: "SwiftCoglPango")
]
)
]
)
```
## Building
Normally, you don't build this package directly, but you embed it into your own project (see 'Usage' above). However, you can build and test this module separately to ensure that everything works. Make sure you have all the prerequisites installed (see above). After that, you can simply clone this repository and build the command line executable (be patient, this will download all the required dependencies and take a while to compile) using
git clone https://github.com/rhx/SwiftCoglPango.git
cd SwiftCoglPango
swift build
swift test
## Building
Normally, you don't build this package directly, but you embed it into your own project (see 'Embedding' below). However, you can build and test this module separately to ensure that everything works. Make sure you have all the prerequisites installed (see above). After that, you can simply clone this repository and build the command line executable (be patient, this will download all the required dependencies and take a while to compile) using
git clone https://github.com/rhx/SwiftCoglPango.git
cd SwiftCoglPango
./build.sh
./test.sh
### Xcode
On macOS, you can build the project using Xcode instead. To do this, you need to create an Xcode project first, then open the project in the Xcode IDE:
./xcodegen.sh
open CoglPango.xcodeproj
After that, use the (usual) Build and Test buttons to build/test this package.
## Documentation
You can generate documentation using the [DocC plugin](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/). To preview documentation matching your local installation, simply run
swift package --disable-sandbox preview-documentation
then navigate to the URL shown for the local preview server. Make sure you have JavaScript enabled in your browser.
Alternatively, you can create static documentation using [jazzy](https://github.com/realm/jazzy).
Make sure you have [sourcekitten](https://github.com/jpsim/SourceKitten) and [jazzy](https://github.com/realm/jazzy) installed, e.g. on macOS (x86_64):
brew install ruby sourcekitten
/usr/local/opt/ruby/bin/gem install jazzy
./generate-jazzy.sh
## Troubleshooting
Here are some common errors you might encounter and how to fix them.
### Missing `.gir` Files
If you get an error such as
Girs located at
Cannot open '/GLib-2.0.gir': No such file or directory
Make sure that you have the relevant `gobject-introspection` packages installed (as per the Pre-requisites section), including their `.gir` and `.pc` files.
### Old Swift toolchain or Xcode
If, when you run `swift build`, you get a `Segmentation fault (core dumped)` or circular dependency error such as
warning: circular dependency detected while parsing pangocairo: harfbuzz -> freetype2 -> harfbuzz
this probably means that your Swift toolchain is too old, particularly on Linux.
Make sure the latest toolchain is the one that is found when you run the Swift compiler (see above).
If you get an older version, make sure that the right version of the swift compiler is found first in your `PATH`. On macOS, use xcode-select to select and install the latest version, e.g.:
sudo xcode-select -s /Applications/Xcode.app
xcode-select --install