SwiftGObject

A Swift wrapper around gobject-2.x that is largely auto-generated from gobject-introspection. For up to date (auto-generated) reference documentation, see https://rhx.github.io/SwiftGObject/

Prerequisites

Swift

To build, you need at least Swift 4.2 (Swift 5.x should work fine), download 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
Apple Swift version 5.1 (swiftlang-1100.0.270.13 clang-1100.0.33.7)
Target: x86_64-apple-darwin18.6.0

on macOS, or on Linux you should get something like:

$ swift --version
Swift version 5.1 (swift-5.1-RELEASE)
Target: x86_64-unknown-linux-gnu

GLib 2.46 or higher

These Swift wrappers have been tested with glib-2.46, 2.48, 2.52, 2.56, 2.58, 2.60, and 2.62. They should work with higher versions, but YMMV. Also make sure you have gobject-introspection and its .gir files installed.

Linux

Ubuntu

On Ubuntu 18.04 and 16.04 you can use the glib that comes with the distribution. Just install with the apt package manager:

sudo apt update
sudo apt install libglib2.0-dev glib-networking gobject-introspection libgirepository1.0-dev libxml2-dev

If you prefer a newer version of glib, you can also install it from the GNOME 3 Staging PPA (see https://launchpad.net/~gnome3-team/+archive/ubuntu/gnome3-staging), but be aware that this can be a bit dangerous (as this removes packages that can be vital, particularly if you use a GNOME-based desktop), so only do this if you know what you are doing:

sudo add-apt-repository ppa:gnome3-team/gnome3-staging
sudo apt update
sudo apt dist-upgrade
sudo apt install libglib2.0-dev glib-networking gobject-introspection libgirepository1.0-dev libxml2-dev
Fedora

On Fedora 29, you can use the glib that comes with the distribution. Just install with the dnf package manager:

sudo dnf install glib2-devel gobject-introspection-devel libxml2-devel

macOS

On macOS, you can install glib 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 glib:

brew update
brew install glib glib-networking gobject-introspection

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/SwiftGObject.git
cd SwiftGObject
./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 GObject.xcodeproj

After that, use the (usual) Build and Test buttons to build/test this package.

Documentation

You can find reference documentation inside the docs folder. This was generated using the jazzy tool. If you want to generate your own documentation, matching your local installation, you can use the generate-documentation.sh script in the repository. Unfortunately, at this stage jazzy only works on macOS (and crashes under Linux), so this will currently only work on a Mac.

Troubleshooting

Here are some common errors you might encounter and how to fix them.

Old Swift toolchain or Xcode

If you get an error such as

$ ./build.sh 
error: unable to invoke subcommand: /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/swift-package (No such file or directory)

this probably means that your Swift toolchain is too old. 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