A Swift wrapper around clutter that is largely auto-generated from gobject-introspection
Version 12 of gir2swift pulls in PR#10, addressing several issues:
private=1
-a
option generates all recordsPartially implemented:
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
.
gir
file@inlinable
to enable the compiler to optimise away most of the wrappersRef
wrappers instead of pointers, Int
instead of gint
, etc.)ErrorType
has been renamed GLibError
to ensure it neither clashes with Swift.Error
nor the GLib.ErrorType
scanner enumRef
wrapper instead of the underlying pointerTo build, you need at least Swift 5.2 (but 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 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 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 libclutter-1.0-dev gir1.2-clutter-1.0 libcogl-dev gir1.2-cogl-1.0 libcogl-pango-dev gir1.2-coglpango-1.0 libgdk-pixbuf2.0-dev gir1.2-gdkpixbuf-2.0 libglib2.0-dev glib-networking gobject-introspection libgirepository1.0-dev libxml2-dev jq
On Fedora 29, you can use the gtk that comes with the distribution. Just install with the dnf
package manager:
sudo dnf install clutter-devel cogl-devel pango-devel cairo-devel cairo-gobject-devel glib2-devel gobject-introspection-devel libxml2-devel
On macOS, you can install glib and Clutter 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 Clutter:
brew update
brew install clutter 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 SwiftClutter into your own project using the Swift Package Manager. After installing the prerequisites (see 'Prerequisites' below), add SwiftClutter
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: "Clutter", url: "https://github.com/rhx/SwiftClutter.git", .branch("main")),
],
targets: [.target(name: "MyPackage", dependencies: ["Clutter"])]
)
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/SwiftClutter.git
cd SwiftClutter
./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`
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/SwiftClutter.git
cd SwiftClutter
./build.sh
./test.sh
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 Clutter.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.
.gir
FilesIf 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.
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, some Linux distributions require at least Swift 5.5). 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 RawRepresentable
conformance in the Swift Standard library. As a workaround, you can turn this off by passing the -Xswiftc -suppress-warnings
parameter when building.
The current build system does not support directory paths with spaces (e.g. the My Drive
directory 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.
link |
Stars: 0 |
Last commit: 2 years ago |
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics