search

rhx / SwiftGtk

A Swift wrapper around gtk-3.x and gtk-4.x that is largely auto-generated from gobject-introspection
https://rhx.github.io/SwiftGtk/
BSD 2-Clause "Simplified" License
327 stars 26 forks source link
gnome gobject-introspection gtk gtk3 gtk4 linux macos swift swift-wrapper

readme

SwiftGtk

A Swift wrapper around gtk-3.x and gtk-4.x that is largely auto-generated from gobject-introspection. This project tries to make gtk more "swifty" than using the plain C language interface. For up to date (auto-generated) reference documentation, see https://rhx.github.io/SwiftGtk/

macOS 11 build macOS 10.15 build macOS gtk4 build Ubuntu 20.04 build Ubuntu 18.04 build

What is new?

Support for gtk 4 was added via the gtk4 branch.

Version 15 of gir2swift provides a Package Manager Plugin. This requires Swift 5.6 or higher (older versions can be used via the swift52 branch).

Usage

Normally, you don't build this package directly (but for testing you can - see 'Building' below). Instead you need to embed SwiftGtk into your own project using the Swift Package Manager. After installing the prerequisites (see 'Prerequisites' below), you can do this by creating a new, empty project folder and then running the projgen.sh script, e.g.:

mkdir MyProject
cd MyProject
curl -L https://git.io/SwiftGtk3.sh | sh

After this, you should be able to import Gtk in your sources and use swift build to build your project. Alternatively, you can manually download run-gir2swift.sh and add SwiftGtk as a dependency to your Package.swift file, e.g.:

// 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/SwiftGtk.git",  branch: "gtk3"),
    ],
    targets: [
        .target(name: "MyPackage",
                dependencies: [
                    .product(name: "Gtk", package: "SwiftGtk")
                ]
        )
    ]
)

For gtk4 replace .branch("gtk3") with .branch("gtk4").

Examples

You can find some example projects on GitHub that show how to use SwiftGtk:

Build Scripts

The demo applications come with build scripts that configure some environment variables and pass required arguments when calling swift build, swift package, etc. The easiest way to get started is to clone one of the following projects, then copy all the *.sh shell scripts into your own project. Also, if you want to be able to build a desktop app, create a Resources folder, and copy (at least) the Info.plist file as well:

You can build, test, or run your project using the usual Swift compiler commands:

swift build
swift test
swift run

You can also build the project using Xcode on macOS instead. To do this, you need to create an Xcode project first, then open the project in the Xcode IDE:

./xcodegen.sh
open MyPackage.xcodeproj

After that, use the (usual) Build and Test buttons to build/test this package. Please note that, at this stage, the Swift Package manager is not able to create App targets for Xcode (so to build a macOs app rather than just a command line executable, you still need to use the build.sh script that calls app-wrapper.sh to create the standalone app bundle).

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.90.11.1 Apple Swift version 5.10 (swiftlang-5.10.0.13 clang-1500.3.9.4)
Target: arm64-apple-macosx13.0

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

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

Gtk 3.22 or higher

The Swift wrappers have been tested with glib-2.56, 2.58, 2.60, 2.62, 2.64, 2.66, 2.68, 2.70, 2.72, 2.74, 2.76, 2.78 and 2.80, and gdk/gtk 3.22, 3.24 as well as 4.0, 4.2, 4.4, 4.6, 4.8, 4.10, 4.12, and 4.14 on the gtk4 branch. They should work with higher versions, but YMMV. Also make sure you have gobject-introspection and its .gir files installed.

Linux

Ubuntu

On Ubuntu 22.04, 20.04, and 18.04, you can use the gtk that comes with the distribution. Just install with the apt package manager:

sudo apt update
sudo apt install libgtk-3-dev gir1.2-gtksource-3.0 libcogl-pango-dev libcogl-path-dev libcogl-dev libpango1.0-dev gir1.2-pango-1.0 libgdk-pixbuf2.0-dev gir1.2-gdkpixbuf-2.0 libgraphene-1.0-dev gir1.2-graphene-1.0 libglib2.0-dev glib-networking gobject-introspection libgirepository1.0-dev libxml2-dev jq

Ubuntu 18.04 also requires you to install libcogl-gles2-dev.

Fedora

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

sudo dnf install gtk3-devel pango-devel cairo-devel cairo-gobject-devel glib2-devel gobject-introspection-devel libxml2-devel jq

macOS

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

brew update
brew install gtk+3 glib glib-networking gobject-introspection pkg-config jq

Building

As pointed out in the 'Usage' section above, you don't normally build this package directly, but instead you embed it into your own project. 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/SwiftGtk.git
cd SwiftGtk
swift build
swift test

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. Make sure you have sourcekitten and jazzy installed, e.g. on macOS:

brew install sourcekitten
sudo gem install jazzy
./generate-documentation.sh

Troubleshooting

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

SwiftGtk takes a very long time to build

Yes, gtk is a huge beast. The Swift interface generated from the gtk header files is close to 300,000 lines. This takes some time to build!

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 (at the time of this writing, at least Swift 5.6 is required). 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