A Swift wrapper around atk-1.x that is largely auto-generated from gobject-introspection. For up to date (auto-generated) reference documentation, see https://rhx.github.io/SwiftAtk/
This branch supports Swift 5.2, but is now unmaintained.
The main and development branches will require newer versions of Swift.
Version 12 of gir2swift pulls in PR#10, addressing several issues:
- Improvements to the Build experience and LSP rhx/SwiftGtk#34
- Fix issues with LLDB rhx/SwiftGtk#39
- Controversial: Implicitly marks all declarations named "priv" as if they had attribute
private=1 - Prevents all "Private" records from generating unless generated in their instance record
-aoption generates all records
- Introduces CI
- For Class metadata types no longer generates class wrappers. Ref structs now contain static method which returnes the GType of the class and instance of the Class metatype wrapped in the Ref struct.
- Adds final class GWeak where T could be any Ref struct of a type which supports ARC. This class is a property wrapper which contains weak reference to any instance of T. This is especially beneficial for capture lists.
- Adds support for weak observation.
- Constructors and factories of GObjectInitiallyUnowned classes now consume floating reference upon initialisation as advised by the GObject documentation
Partially implemented:
- Typed signal generation. Issues shown in rhx/SwiftGtk#35 hat remain to be addressed are listed here: mikolasstuchlik/gir2swift#2.
Version 11 introduces a new type system into gir2swift,
to ensure it has a representation of the underlying types.
This is necessary for Swift 5.3 onwards, which requires more stringent casts.
As a consequence, accessors can accept and return idiomatic Swift rather than
underlying types or pointers.
This means that a lot of the changes will be source-breaking for code that
was compiled against libraries built with earlier versions of gir2swift.
- Requires Swift 5.2 or later
- Wrapper code is now
@inlinableto enable the compiler to optimise away most of the wrappers - Parameters and return types use more idiomatic Swift (e.g.
Refwrappers instead of pointers,Intinstead ofgint, etc.) - Functions that take or return records now are templated instead of using the type-erased Protocol
ErrorTypehas been renamedGLibErrorto ensure it neither clashes withSwift.Errornor theGLib.ErrorTypescanner enum- Parameters or return types for records/classes now use the corresponding, lightweight Swift
Refwrapper instead of the underlying pointer
To build, you need at least Swift 5.2 (Swift 5.3 is required for gtk4; also some Linux distributions have issues and seem to require at least Swift 5.5), 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.4 (swiftlang-1205.0.26.9 clang-1205.0.19.55)
Target: x86_64-apple-darwin20.5.0
on macOS, or on Linux you should get something like:
$ swift --version
Swift version 5.4 (swift-5.4-RELEASE)
Target: x86_64-unknown-linux-gnu
These Swift wrappers have been tested with atk-2.28 and 2.36 as well as glib-2.56, 2.58, 2.60, 2.62, 2.64, 2.66, and 2.68. They should work with higher versions, but YMMV. Also make sure you have gobject-introspection and its .gir files installed.
On Ubuntu 18.04 and 16.04 you can use the atk that comes with the distribution. Just install with the apt package manager:
sudo apt update
sudo apt install libatk1.0-dev gir1.2-atk-1.0 gobject-introspection libgirepository1.0-dev libxml2-dev
If you prefer a newer version of gtk, 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 libatk1.0-dev gir1.2-atk-1.0 gobject-introspection libgirepository1.0-dev libxml2-dev
On Fedora 29, you can use the gtk that comes with the distribution. Just install with the dnf package manager:
sudo dnf install atk-devel glib2-devel gobject-introspection-devel libxml2-devel
On macOS, you can install atk 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 atk:
brew update
brew install atk glib glib-networking gobject-introspection pkg-config
Normally, you don't build this package directly (but for testing you can - see 'Building' below). Instead you need to embed SwiftAtk into your own project using the Swift Package Manager. After installing the prerequisites (see 'Prerequisites' below), add SwiftAtk as a dependency to your Package.swift file, e.g.:
// swift-tools-version:5.3
import PackageDescription
let package = Package(name: "MyPackage",
dependencies: [
.package(name: "gir2swift", url: "https://github.com/rhx/gir2swift.git", .branch("main")),
.package(name: "Atk", url: "https://github.com/rhx/SwiftAtk.git", .branch("main")),
],
targets: [.target(name: "MyPackage", dependencies: ["Atk"])]
)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/SwiftAtk.git
cd SwiftAtk
./run-gir2swift.sh
swift build
swift test
Please note that on macOS, due to a bug in the Swift Package Manager prior to Swift 5.4,
if you have Xcode-12.4 or older, you need to pass in the build flags manually,
i.e. instead of swift build and swift test you can run
swift build `./run-gir2swift.sh flags -noUpdate`
swift test `./run-gir2swift.sh flags -noUpdate`
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 Atk.xcodeproj
After that, use the (usual) Build and Test buttons to build/test this package.
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
./run-gir2swift.sh
./generate-documentation.sh
Here are some common errors you might encounter and how to fix them.
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
-
When building, a lot of warnings appear. This is largely an issue with automatic
RawRepresentableconformance in the Swift Standard library. As a workaround, you can turn this off by passing the-Xswiftc -suppress-warningsparameter when building. -
The current build system does not support directory paths with spaces (e.g. the
My Drivedirectory used by Google Drive File Stream). -
BUILD_DIR is not supported in the current build system.
As a workaround, you can use the old build scripts, e.g. ./build.sh (instead of run-gir2swift.sh and swift build) to build a package.
