Skip to content
Generate Haskell bindings for GObject-Introspection capable libraries
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
base Add OSX to travis Jul 21, 2019
bindings Add OSX to travis Jul 21, 2019
cairo Fix memory management of Matrix (#166) May 18, 2018
cmdline Inherit override info Jun 15, 2019
examples Rework signal connectors Jul 15, 2019
gi-gtk-hs Use TypeApplications in method overloading Jun 24, 2019
lib Add OSX to travis Jul 21, 2019
oldstyle Make the new style bindings the default May 19, 2016
overloading Release haskell-gi-overloading 1.0 Jul 30, 2017
test Add a test of typed closures Jun 2, 2019
travis Do not build everything twice in Travis OSX Jul 22, 2019
.editorconfig Add trim_trailing_whitespace to .editorconfig Nov 15, 2015
.gitgnore Repair travis Apr 14, 2018
.gitignore Add .so files to .gitignore [skip-ci] Jun 8, 2019
.gitmodules Modernize build Apr 19, 2018
.travis.yml Tell travis that we are using globs Jul 22, 2019
ChangeLog.md
DocTests.hs DocTests: Use pkg-config to find libs (#163) May 7, 2018
Gtk4.cabal.project Bindings for Gtk4 Jul 8, 2019
LICENSE Add static linking exception for haskell-gi and haskell-gi-base (#198) Nov 6, 2018
README.md Use v2-style commands in the README Jun 19, 2019
Setup.hs Revert "Remove Setup.hs, not needed" Nov 1, 2015
cabal.project Rename Gtk bindings folder to Gtk-3.0 Jul 8, 2019
haskell-gi.cabal Add haskell-gi to doctest dependencies Jun 25, 2019
osx.cabal.project Add OSX to travis Jul 21, 2019

README.md

haskell-gi

Generate Haskell bindings for GObject Introspection capable libraries.

Installation

To compile the bindings generated by haskell-gi, make sure that you have installed the necessary development packages for the libraries you are interested in. The following are examples for some common distributions. (If your distribution is not listed please send a pull request!)

Fedora

sudo dnf install gobject-introspection-devel webkitgtk4-devel gtksourceview3-devel

Debian / Ubuntu

sudo apt-get install libgirepository1.0-dev libwebkit2gtk-4.0-dev libgtksourceview-3.0-dev

Arch Linux

sudo pacman -S gobject-introspection gobject-introspection-runtime gtksourceview3 webkit2gtk

Mac OSX

Install Homebrew and install GTK+ and GObject Introspection:

brew install gobject-introspection gtk+ gtk+3

Ensure the path to libffi (probably /usr/local/opt/libffi/lib/pkgconfig) is in the PKG_CONFIG_PATH environment variable.

Windows

Please see here for detailed installation instructions in Windows.

⚠️ GHC 8.2.x ⚠️

Unfortunately there is a bug in 8.2.x versions of GHC that makes it panic when compiling bindings generated by haskell-gi. Versions 8.0.x and earlier of GHC are not affected by the bug, and version 8.4.1 has the bug fixed. The simplest workaround is to avoid using GHC 8.2.x when using bindings generated by haskell-gi. Alternatively, disabling overloading will avoid the bug.

Using the generated bindings

The most recent versions of the generated bindings are available from hackage. To install, start by making sure that you have a recent (2.0 or later) version of cabal-install, for instance:

$ cabal install cabal-install
$ cabal --version
cabal-install version 2.4.1.0
compiled using version 2.4.1.0 of the Cabal library

Here is an example "Hello World" program:

{-# LANGUAGE OverloadedStrings, OverloadedLabels #-}
{- cabal:
build-depends: base, haskell-gi-base, gi-gtk
-}

import qualified GI.Gtk as Gtk
import Data.GI.Base

main :: IO ()
main = do
  Gtk.init Nothing

  win <- new Gtk.Window [ #title := "Hi there" ]

  on win #destroy Gtk.mainQuit

  button <- new Gtk.Button [ #label := "Click me" ]

  on button #clicked (set button [ #sensitive := False,
                                   #label := "Thanks for clicking me" ])

  #add win button

  #showAll win

  Gtk.main

This program uses the new OverloadedLabels extension in GHC 8.0, so make sure you have a recent enough version of GHC installed. To run this program, copy it to a file (hello.hs, say), and then

$ cabal v2-run hello.hs

For a more involved example, see for instance this WebKit example. Further documentation can be found in the Wiki.

Translating from the C API to the haskell-gi generated API

The translation from the original C API to haskell-gi is fairly straightforward: for method names simply remove the library prefix (gtk, gdk, etc.), and convert to camelCase. I.e. gtk_widget_show becomes widgetShow in the module GI.Gtk (provided by the gi-gtk package).

For properties, add the type of the object as a prefix: so the sensitive property of GtkWidget becomes widgetSensitive in gi-gtk. These can be set using the new syntax, as follows:

b <- new Button [widgetSensitive := True]

or using set after having created the button

b `set` [widgetSensitive := False]

Alternatively you can use setWidgetSensitive and friends to set properties individually if you don't like the list syntax.

Finally, for signals you want to use the onTypeSignalName functions, for example onButtonClicked:

onButtonClicked b $ do ...

This is the basic dictionary. Note that all the resulting symbols can be conveniently searched in hoogle.

There is also support for the OverloadedLabels extension in GHC 8.0 or higher. So the examples above can be shortened (by omitting the type that introduces the signal/property/method) to

b <- new Button [#sensitive := True]
on b #clicked $ do ...
#show b

Hopefully this helps to get started! For any further questions there is a gitter channel that may be helpful at https://gitter.im/haskell-gi/haskell-gi.

Binding to new libraries

It should be rather easy to generate bindings to any library with gobject-introspection support, see the examples in the bindings folder. Pull requests appreciated!

Higher-Level Bindings

The bindings in haskell-gi aim for complete coverage of the bound APIs, but as a result they are imperative in flavour. For nicer, higher-level approaches based on these bindings, see:

Other Resources


Build Status Join the chat at https://gitter.im/haskell-gi/haskell-gi

You can’t perform that action at this time.