layout_state: Don't always operate on the global instance

Introduce a callback in `outputs::Outputs` that calls on every `wl_output.done`, and a dummy consumer in `ui_manager`.

This is sufficient to detect display height changes.

.gitlab-ci.yml

@@ -14,7 +14,17 @@ before_script:
   - echo "deb http://ci.puri.sm/ scratch librem5" > /etc/apt/sources.list.d/ci.list
   - wget -O- https://ci.puri.sm/ci-repo.key | apt-key add -
   - apt-get -y update
-  - apt-get -y build-dep .
+
+build_docs:
+  <<: *tags
+  stage: build
+  artifacts:
+    paths:
+      - _build
+  script:
+      - apt-get -y install python3-pip python3-sphinx
+      - pip3 install recommonmark
+      - ./doc/build.sh _build
 
 build_meson:
   <<: *tags
@@ -24,6 +34,7 @@ build_meson:
       - _build
     expire_in: 3h
   script:
+    - apt-get -y build-dep .
     - meson . _build/ -Ddepdatadir=/usr/share
     - ninja -C _build install
 
@@ -35,20 +46,23 @@ build_deb:
       paths:
         - "*.deb"
     script:
+        - rm -f ../*.deb
+        - apt-get -y build-dep .
         - apt-get -y install devscripts
         - debuild -i -us -uc -b
         - cp ../*.deb .
 
-build_deb_aarch64:
+build_deb:arm64:
-    image: multiarch/debian-debootstrap:arm64-buster
     tags:
-        - ARM64
+        - librem5:arm64
     allow_failure: true
     stage: build
     artifacts:
       paths:
         - "*.deb"
     script:
+        - rm -f ../*.deb
+        - apt-get -y build-dep .
         - apt-get -y install devscripts
         - debuild -i -us -uc -b
         - cp ../*.deb .
@@ -68,4 +82,15 @@ test:
   needs:
     - build_meson
   script:
+    - apt-get -y build-dep .
     - ninja -C _build test
+
+check_release:
+  <<: *tags
+  stage: test
+  only:
+    refs:
+      - master
+  script:
+    - apt-get -y install git python3
+    - (head -n 1 ./debian/changelog && git tag) | ./debian/check_release.py

Cargo.lock

@@ -2,18 +2,10 @@
 # It is not intended for manual editing.
 [[package]]
 name = "aho-corasick"
-version = "0.7.6"
+version = "0.7.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "memchr 2.2.1 (registry+https://github.com/rust-lang/crates.io-index)",
+ "memchr 2.3.2 (registry+https://github.com/rust-lang/crates.io-index)",
-]
-
-[[package]]
-name = "ansi_term"
-version = "0.11.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-dependencies = [
- "winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -23,17 +15,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
-]
-
-[[package]]
-name = "atty"
-version = "0.2.13"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-dependencies = [
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
- "winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -50,7 +33,7 @@ dependencies = [
  "glib 0.6.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -61,14 +44,14 @@ dependencies = [
  "glib 0.6.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
  "winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "cc"
-version = "1.0.45"
+version = "1.0.50"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
@@ -76,18 +59,14 @@ name = "clap"
 version = "2.32.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "atty 0.2.13 (registry+https://github.com/rust-lang/crates.io-index)",
  "bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
- "strsim 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "textwrap 0.10.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
- "vec_map 0.8.1 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "dtoa"
-version = "0.4.4"
+version = "0.4.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
@@ -110,7 +89,7 @@ dependencies = [
  "glib 0.6.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
  "pango 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
@@ -125,7 +104,7 @@ dependencies = [
  "glib 0.6.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -136,8 +115,8 @@ dependencies = [
  "gio-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -150,9 +129,9 @@ dependencies = [
  "gio-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
  "pango-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -167,7 +146,7 @@ dependencies = [
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "lazy_static 1.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -177,8 +156,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -190,7 +169,7 @@ dependencies = [
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "lazy_static 1.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -198,8 +177,8 @@ name = "glib-sys"
 version = "0.7.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -208,8 +187,8 @@ version = "0.7.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -220,7 +199,7 @@ dependencies = [
  "bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
  "cairo-rs 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "cairo-sys-rs 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "cc 1.0.45 (registry+https://github.com/rust-lang/crates.io-index)",
+ "cc 1.0.50 (registry+https://github.com/rust-lang/crates.io-index)",
  "gdk 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gdk-pixbuf 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gdk-pixbuf-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -232,7 +211,7 @@ dependencies = [
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gtk-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "lazy_static 1.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
  "pango 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
@@ -248,9 +227,9 @@ dependencies = [
  "gio-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
  "pango-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -260,7 +239,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
 name = "libc"
-version = "0.2.62"
+version = "0.2.66"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
@@ -275,7 +254,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
 name = "memchr"
-version = "2.2.1"
+version = "2.3.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
@@ -283,7 +262,7 @@ name = "memmap"
 version = "0.7.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
  "winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
@@ -297,7 +276,7 @@ dependencies = [
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "lazy_static 1.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
  "pango-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
@@ -308,18 +287,18 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
  "glib-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gobject-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
- "pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)",
+ "pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "pkg-config"
-version = "0.3.16"
+version = "0.3.17"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.4"
+version = "1.0.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
  "unicode-xid 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -330,7 +309,7 @@ name = "quote"
 version = "1.0.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "proc-macro2 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
+ "proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -338,16 +317,16 @@ name = "regex"
 version = "1.1.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "aho-corasick 0.7.6 (registry+https://github.com/rust-lang/crates.io-index)",
+ "aho-corasick 0.7.8 (registry+https://github.com/rust-lang/crates.io-index)",
- "memchr 2.2.1 (registry+https://github.com/rust-lang/crates.io-index)",
+ "memchr 2.3.2 (registry+https://github.com/rust-lang/crates.io-index)",
- "regex-syntax 0.6.12 (registry+https://github.com/rust-lang/crates.io-index)",
+ "regex-syntax 0.6.14 (registry+https://github.com/rust-lang/crates.io-index)",
  "thread_local 0.3.6 (registry+https://github.com/rust-lang/crates.io-index)",
  "utf8-ranges 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "regex-syntax"
-version = "0.6.12"
+version = "0.6.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
@@ -366,51 +345,46 @@ dependencies = [
  "gtk-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "maplit 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)",
  "regex 1.1.9 (registry+https://github.com/rust-lang/crates.io-index)",
- "serde 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)",
+ "serde 1.0.104 (registry+https://github.com/rust-lang/crates.io-index)",
- "serde_yaml 0.8.9 (registry+https://github.com/rust-lang/crates.io-index)",
+ "serde_yaml 0.8.11 (registry+https://github.com/rust-lang/crates.io-index)",
  "xkbcommon 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "serde"
-version = "1.0.101"
+version = "1.0.104"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "serde_derive 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)",
+ "serde_derive 1.0.104 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.101"
+version = "1.0.104"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "proc-macro2 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
+ "proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)",
  "quote 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)",
- "syn 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)",
+ "syn 1.0.14 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
 name = "serde_yaml"
-version = "0.8.9"
+version = "0.8.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "dtoa 0.4.4 (registry+https://github.com/rust-lang/crates.io-index)",
+ "dtoa 0.4.5 (registry+https://github.com/rust-lang/crates.io-index)",
  "linked-hash-map 0.5.2 (registry+https://github.com/rust-lang/crates.io-index)",
- "serde 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)",
+ "serde 1.0.104 (registry+https://github.com/rust-lang/crates.io-index)",
  "yaml-rust 0.4.3 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
-[[package]]
-name = "strsim"
-version = "0.7.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-
 [[package]]
 name = "syn"
-version = "1.0.5"
+version = "1.0.14"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "proc-macro2 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
+ "proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)",
  "quote 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)",
  "unicode-xid 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
@@ -446,11 +420,6 @@ name = "utf8-ranges"
 version = "1.0.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
-[[package]]
-name = "vec_map"
-version = "0.8.1"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-
 [[package]]
 name = "winapi"
 version = "0.3.8"
@@ -475,7 +444,7 @@ name = "xkbcommon"
 version = "0.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 dependencies = [
- "libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)",
+ "libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)",
  "memmap 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
@@ -488,16 +457,14 @@ dependencies = [
 ]
 
 [metadata]
-"checksum aho-corasick 0.7.6 (registry+https://github.com/rust-lang/crates.io-index)" = "58fb5e95d83b38284460a5fda7d6470aa0b8844d283a0b614b8535e880800d2d"
+"checksum aho-corasick 0.7.8 (registry+https://github.com/rust-lang/crates.io-index)" = "743ad5a418686aad3b87fd14c43badd828cf26e214a00f92a384291cf22e1811"
-"checksum ansi_term 0.11.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ee49baf6cb617b853aa8d93bf420db2383fab46d314482ca2803b40d5fde979b"
 "checksum atk-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "c7017e53393e713212aed7aea336b6553be4927f58c37070a56c2fe3d107e489"
-"checksum atty 0.2.13 (registry+https://github.com/rust-lang/crates.io-index)" = "1803c647a3ec87095e7ae7acfca019e98de5ec9a7d01343f611cf3152ed71a90"
 "checksum bitflags 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" = "228047a76f468627ca71776ecdebd732a3423081fcf5125585bcd7c49886ce12"
 "checksum cairo-rs 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "dd940f0d609699e343ef71c4af5f66423afbf30d666f796dabd8fd15229cf5b6"
 "checksum cairo-sys-rs 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d25596627380be4381247dba06c69ad05ca21b3b065bd9827e416882ac41dcd2"
-"checksum cc 1.0.45 (registry+https://github.com/rust-lang/crates.io-index)" = "4fc9a35e1f4290eb9e5fc54ba6cf40671ed2a2514c3eeb2b2a908dda2ea5a1be"
+"checksum cc 1.0.50 (registry+https://github.com/rust-lang/crates.io-index)" = "95e28fa049fda1c330bcf9d723be7663a899c4679724b34c81e9f5a326aab8cd"
 "checksum clap 2.32.0 (registry+https://github.com/rust-lang/crates.io-index)" = "b957d88f4b6a63b9d70d5f454ac8011819c6efa7727858f458ab71c756ce2d3e"
-"checksum dtoa 0.4.4 (registry+https://github.com/rust-lang/crates.io-index)" = "ea57b42383d091c85abcc2706240b94ab2a8fa1fc81c10ff23c4de06e2a90b5e"
+"checksum dtoa 0.4.5 (registry+https://github.com/rust-lang/crates.io-index)" = "4358a9e11b9a09cf52383b451b49a169e8d797b68aa02301ff586d70d9661ea3"
 "checksum fragile 0.3.0 (registry+https://github.com/rust-lang/crates.io-index)" = "05f8140122fa0d5dcb9fc8627cfce2b37cc1500f752636d46ea28bc26785c2f9"
 "checksum gdk 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)" = "bcc52c7244046df9d959df87289f1fc5cca23f9f850bab0c967963e2ecb83a96"
 "checksum gdk-pixbuf 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "bc3aa730cb4df3de5d9fed59f43afdf9e5fb2d3d10bfcbd04cec031435ce87f5"
@@ -511,29 +478,27 @@ dependencies = [
 "checksum gtk 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "56a6b30f194f09a17bb7ffa95c3ecdb405abd3b75ff981f831b1f6d18fe115ff"
 "checksum gtk-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d487d333a4b87072e6bf9f2e55befa0ebef01b9496c2e263c0f4a1ff3d6c04b1"
 "checksum lazy_static 1.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
-"checksum libc 0.2.62 (registry+https://github.com/rust-lang/crates.io-index)" = "34fcd2c08d2f832f376f4173a231990fa5aef4e99fb569867318a227ef4c06ba"
+"checksum libc 0.2.66 (registry+https://github.com/rust-lang/crates.io-index)" = "d515b1f41455adea1313a4a2ac8a8a477634fbae63cc6100e3aebb207ce61558"
 "checksum linked-hash-map 0.5.2 (registry+https://github.com/rust-lang/crates.io-index)" = "ae91b68aebc4ddb91978b11a1b02ddd8602a05ec19002801c5666000e05e0f83"
 "checksum maplit 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)" = "3e2e65a1a2e43cfcb47a895c4c8b10d1f4a61097f9f254f183aee60cad9c651d"
-"checksum memchr 2.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "88579771288728879b57485cc7d6b07d648c9f0141eb955f8ab7f9d45394468e"
+"checksum memchr 2.3.2 (registry+https://github.com/rust-lang/crates.io-index)" = "53445de381a1f436797497c61d851644d0e8e88e6140f22872ad33a704933978"
 "checksum memmap 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "6585fd95e7bb50d6cc31e20d4cf9afb4e2ba16c5846fc76793f11218da9c475b"
 "checksum pango 0.5.0 (registry+https://github.com/rust-lang/crates.io-index)" = "4c2cb169402a3eb1ba034a7cc7d95b8b1c106e9be5ba4be79a5a93dc1a2795f4"
 "checksum pango-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "d6eb49268e69dd0c1da5d3001a61aac08e2e9d2bfbe4ae4b19b9963c998f6453"
-"checksum pkg-config 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)" = "72d5370d90f49f70bd033c3d75e87fc529fbfff9d6f7cccef07d6170079d91ea"
+"checksum pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)" = "05da548ad6865900e60eaba7f589cc0783590a92e940c26953ff81ddbab2d677"
-"checksum proc-macro2 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" = "afdc77cc74ec70ed262262942ebb7dac3d479e9e5cfa2da1841c0806f6cdabcc"
+"checksum proc-macro2 1.0.8 (registry+https://github.com/rust-lang/crates.io-index)" = "3acb317c6ff86a4e579dfa00fc5e6cca91ecbb4e7eb2df0468805b674eb88548"
 "checksum quote 1.0.2 (registry+https://github.com/rust-lang/crates.io-index)" = "053a8c8bcc71fcce321828dc897a98ab9760bef03a4fc36693c231e5b3216cfe"
 "checksum regex 1.1.9 (registry+https://github.com/rust-lang/crates.io-index)" = "d9d8297cc20bbb6184f8b45ff61c8ee6a9ac56c156cec8e38c3e5084773c44ad"
-"checksum regex-syntax 0.6.12 (registry+https://github.com/rust-lang/crates.io-index)" = "11a7e20d1cce64ef2fed88b66d347f88bd9babb82845b2b858f3edbf59a4f716"
+"checksum regex-syntax 0.6.14 (registry+https://github.com/rust-lang/crates.io-index)" = "b28dfe3fe9badec5dbf0a79a9cccad2cfc2ab5484bdb3e44cbd1ae8b3ba2be06"
-"checksum serde 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)" = "9796c9b7ba2ffe7a9ce53c2287dfc48080f4b2b362fcc245a259b3a7201119dd"
+"checksum serde 1.0.104 (registry+https://github.com/rust-lang/crates.io-index)" = "414115f25f818d7dfccec8ee535d76949ae78584fc4f79a6f45a904bf8ab4449"
-"checksum serde_derive 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)" = "4b133a43a1ecd55d4086bd5b4dc6c1751c68b1bfbeba7a5040442022c7e7c02e"
+"checksum serde_derive 1.0.104 (registry+https://github.com/rust-lang/crates.io-index)" = "128f9e303a5a29922045a830221b8f78ec74a5f544944f3d5984f8ec3895ef64"
-"checksum serde_yaml 0.8.9 (registry+https://github.com/rust-lang/crates.io-index)" = "38b08a9a90e5260fe01c6480ec7c811606df6d3a660415808c3c3fa8ed95b582"
+"checksum serde_yaml 0.8.11 (registry+https://github.com/rust-lang/crates.io-index)" = "691b17f19fc1ec9d94ec0b5864859290dff279dbd7b03f017afda54eb36c3c35"
-"checksum strsim 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "bb4f380125926a99e52bc279241539c018323fab05ad6368b56f93d9369ff550"
+"checksum syn 1.0.14 (registry+https://github.com/rust-lang/crates.io-index)" = "af6f3550d8dff9ef7dc34d384ac6f107e5d31c8f57d9f28e0081503f547ac8f5"
-"checksum syn 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)" = "66850e97125af79138385e9b88339cbcd037e3f28ceab8c5ad98e64f0f1f80bf"
 "checksum textwrap 0.10.0 (registry+https://github.com/rust-lang/crates.io-index)" = "307686869c93e71f94da64286f9a9524c0f308a9e1c87a583de8e9c9039ad3f6"
 "checksum thread_local 0.3.6 (registry+https://github.com/rust-lang/crates.io-index)" = "c6b53e329000edc2b34dbe8545fd20e55a333362d0a321909685a19bd28c3f1b"
 "checksum unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)" = "caaa9d531767d1ff2150b9332433f32a24622147e5ebb1f26409d5da67afd479"
 "checksum unicode-xid 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)" = "826e7639553986605ec5979c7dd957c7895e93eabed50ab2ffa7f6128a75097c"
 "checksum utf8-ranges 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" = "b4ae116fef2b7fea257ed6440d3cfcff7f190865f170cdad00bb6465bf18ecba"
-"checksum vec_map 0.8.1 (registry+https://github.com/rust-lang/crates.io-index)" = "05c78687fb1a80548ae3250346c3db86a80a7cdd77bda190189f2d0a0987c81a"
 "checksum winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)" = "8093091eeb260906a183e6ae1abdba2ef5ef2257a21801128899c3fc699229c6"
 "checksum winapi-i686-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
 "checksum winapi-x86_64-pc-windows-gnu 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)" = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"

Cargo.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 
 [dependencies]
 bitflags = "1.0.*"
-clap = "2.32.*"
+clap = { version = "2.32.*", default-features = false }
 maplit = "1.0.*"
 regex = "1.1.*"
 serde = { version = "1.0.*", features = ["derive"] }

README.md

@@ -56,4 +56,4 @@ $ src/squeekboard
 Developing
 ----------
 
-See `HACKING.md`
+See [`docs/hacking.md`](docs/hacking.md) for this copy, or the [official documentation](https://developer.puri.sm/projects/squeekboard/) for the current release.

data/keyboards/de.yaml

@@ -45,7 +45,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "special"

data/keyboards/de_wide.yaml

@@ -45,7 +45,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "special"

data/keyboards/emoji.yaml

@@ -0,0 +1,80 @@
+---
+outlines:
+    default: { width: 52, height: 52 }
+    altline: { width: 40, height: 52 }
+    narrow: { width: 22, height: 52 }
+
+views:
+    base:
+        - "😀 😁 😅 😂 😊 😇 🙃"
+        - "😍 😘 😋 😜 😎 🥳 😔"
+        - "😢 😭 😡 😱 🤔 😬 🙄"
+        - "preferences blank 1 2 3 4 5 6 blank BackSpace"
+    two:
+        - "🤩 🤨 🤓 😴 🤢 🤮 😈"
+        - "💩 🙌 👏 👍 👎 👌 👋"
+        - "💪 🖕 🙏 💋 🤦‍♀️ 🤷‍♀️ 💃"
+        - "preferences blank 1 2 3 4 5 6 blank BackSpace"
+    three:
+        - "🐶 🐱 🐯 🙈 🐴 🦄 🌳"
+        - "🍀 🌹 💫 ⭐️ ✨ 💥 🔥"
+        - "🌈 ☀️ 🌤 🌧 ⛄️ ☂️ 🌊"
+        - "preferences blank 1 2 3 4 5 6 blank BackSpace"
+    four:
+        - "🍎 🍓 🍑 🍍 🍆 🥑 🥦"
+        - "🍕 🎂 🍫 🍿 🍻 🍾 🍽"
+        - "⚽️ 🏀 🏓 🏆 🎹 🎸 🎯"
+        - "preferences blank 1 2 3 4 5 6 blank BackSpace"
+    five:
+        - "🚗 🚌 🚲 🚄 🚂 ✈️ 🛰"
+        - "🚀 🛸 🚁 🚦 🏝 🏔 ⛺️"
+        - "🏠 🏢 🏥 🏛 🛤 🌅 🎇"
+        - "preferences blank 1 2 3 4 5 6 blank BackSpace"
+    six:
+        - "⌚️ 📱 💻 🖥 🖨 🕹 ✉️"
+        - "📞 ☎️ ⏰ ⏳ 📈 📉 📌"
+        - "🎁 ❤️ 💕 💯 ✅ ❎ 📢"
+        - "preferences blank 1 2 3 4 5 6 blank BackSpace"
+
+buttons:
+    1:
+        action:
+            set_view: "base"
+        outline: "altline"
+        label: "1"
+    2:
+        action:
+            set_view: "two"
+        outline: "altline"
+        label: "2"
+    3:
+        action:
+            set_view: "three"
+        outline: "altline"
+        label: "3"
+    4:
+        action:
+            set_view: "four"
+        outline: "altline"
+        label: "4"
+    5:
+        action:
+            set_view: "five"
+        outline: "altline"
+        label: "5"
+    6:
+        action:
+            set_view: "six"
+        outline: "altline"
+        label: "6"
+    preferences:
+        action: "show_prefs"
+        outline: "altline"
+        icon: "keyboard-mode-symbolic"
+    BackSpace:
+        outline: "altline"
+        icon: "edit-clear-symbolic"
+        keysym: BackSpace
+    blank:
+        outline: "narrow"
+        text: ""

data/keyboards/es.yaml

@@ -44,7 +44,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "default"

data/keyboards/fi.yaml

@@ -39,7 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "altline"

data/keyboards/gr.yaml

@@ -46,7 +46,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "altline"

data/keyboards/it.yaml

@@ -46,7 +46,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "default"

data/keyboards/jp+kana.yaml

@@ -195,7 +195,7 @@ buttons:
     BackSpace:
         outline: "wide"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: erase
     Return:
         outline: "wide"
         icon: "key-enter"

data/keyboards/jp+kana_wide.yaml

@@ -195,7 +195,7 @@ buttons:
     BackSpace:
         outline: "wide"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: erase
     Return:
         outline: "wide"
         icon: "key-enter"

data/keyboards/no.yaml

@@ -39,7 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: erase
     preferences:
         action: "show_prefs"
         outline: "altline"

data/keyboards/number.yaml

@@ -16,14 +16,14 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: erase
     space:
         outline: spaceline
         text: " "
     Return:
         outline: outline7
         icon: "key-enter"
-        keysym: "BackSpace"
+        keysym: "Return"
     asterisk:
         text: "*"
     numbersign:

data/keyboards/pl.yaml

@@ -0,0 +1,110 @@
+---
+outlines:
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 59, height: 52 }
+    spaceline: { width: 140, height: 52 }
+    special: { width: 44, height: 52 }
+
+views:
+    base:
+        - "q w e r t y u i o p"
+        - "a s d f g h j k l"
+        - "Shift_L   z x c v b n m  BackSpace"
+        - "show_numbers preferences         space        show_accents Return"
+    upper:
+        - "Q W E R T Y U I O P"
+        - "A S D F G H J K L"
+        - "Shift_L   Z X C V B N M  BackSpace"
+        - "show_numbers preferences         space        show_upper_accents Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # $ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        period Return"
+    accents:
+        - "q w ę r t y u i ó p"
+        - "ą ś d f g h j k ł"
+        - "accents_show_upper   ż ź ć v b ń m  BackSpace"
+        - "show_numbers preferences         space        show_accents Return"
+    upper_accents:
+        - "Q W Ę R T Y U I Ó P"
+        - "Ą Ś D F G H J K Ł"
+        - "accents_show_upper   Ż Ź Ć V B Ń M  BackSpace"
+        - "show_numbers preferences         space        show_upper_accents Return"
+
+
+buttons:
+    Shift_L:
+        action:
+            locking:
+                lock_view: "upper"
+                unlock_view: "base"
+        outline: "altline"
+        icon: "key-shift"
+    accents_show_upper:
+        action:
+            locking:
+                lock_view: "upper_accents"
+                unlock_view: "accents"
+        outline: "altline"
+        icon: "key-shift"
+    BackSpace:
+        outline: "altline"
+        icon: "edit-clear-symbolic"
+        keysym: "BackSpace"
+    preferences:
+        action: "show_prefs"
+        outline: "special"
+        icon: "keyboard-mode-symbolic"
+    show_numbers:
+        action:
+            set_view: "numbers"
+        outline: "wide"
+        label: "123"
+    show_numbers_from_symbols:
+        action:
+            set_view: "numbers"
+        outline: "altline"
+        label: "123"
+    show_letters:
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "ABC"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    show_accents:
+        action:
+            locking:
+                lock_view: "accents"
+                unlock_view: "base"
+        outline: "altline"
+        label: "ąę"
+    show_upper_accents:
+        action:
+            locking:
+                lock_view: "upper_accents"
+                unlock_view: "upper"
+        outline: "altline"
+        label: "ĄĘ"
+    period:
+        outline: "altline"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/pl_wide.yaml

@@ -0,0 +1,102 @@
+---
+outlines:
+    default: { width: 54, height: 42 }
+    altline: { width: 81, height: 42 }
+    wide: { width: 100, height: 42 }
+    spaceline: { width: 206, height: 42 }
+    special: { width: 54, height: 42 }
+
+views:
+    base:
+        - "q w e r t y u i o p"
+        - "a s d f g h j k l"
+        - "Shift_L   z x c v b n m  BackSpace"
+        - "show_numbers preferences         space        show_accents Return"
+    upper:
+        - "Q W E R T Y U I O P"
+        - "A S D F G H J K L"
+        - "Shift_L   Z X C V B N M  BackSpace"
+        - "show_numbers preferences         space        show_upper_accents Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # $ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        period Return"
+    accents:
+        - "q w ę r t y u i ó p"
+        - "ą ś d f g h j k ł"
+        - "Shift_L   ż ź ć v b ń m  BackSpace"
+        - "show_numbers preferences         space        show_accents Return"
+    upper_accents:
+        - "Q W Ę R T Y U I Ó P"
+        - "Ą Ś D F G H J K Ł"
+        - "Shift_L   Ż Ź Ć V B Ń M  BackSpace"
+        - "show_numbers preferences         space        show_upper_accents Return"
+
+buttons:
+    Shift_L:
+        action:
+            locking:
+                lock_view: "upper"
+                unlock_view: "base"
+        outline: "altline"
+        icon: "key-shift"
+    BackSpace:
+        outline: "altline"
+        icon: "edit-clear-symbolic"
+        keysym: "BackSpace"
+    preferences:
+        action: "show_prefs"
+        outline: "special"
+        icon: "keyboard-mode-symbolic"
+    show_numbers:
+        action:
+            set_view: "numbers"
+        outline: "wide"
+        label: "123"
+    show_numbers_from_symbols:
+        action:
+            set_view: "numbers"
+        outline: "altline"
+        label: "123"
+    show_letters:
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "ABC"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    show_accents:
+        action:
+            locking:
+                lock_view: "accents"
+                unlock_view: "base"
+        outline: "altline"
+        label: "ąę"
+    show_upper_accents:
+        action:
+            locking:
+                lock_view: "upper_accents"
+                unlock_view: "upper"
+        outline: "altline"
+        label: "ĄĘ"
+    period:
+        outline: "altline"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/se.yaml

@@ -39,7 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: erase
     preferences:
         action: "show_prefs"
         outline: "altline"

data/keyboards/terminal.yaml

@@ -0,0 +1,159 @@
+---
+outlines:
+    default: { width: 35.33, height: 52 }
+    action:  { width: 59,    height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 59, height: 52 }
+    spaceline: { width: 140, height: 52 }
+    special: { width: 44, height: 52 }
+
+views:
+    base:
+        - "q w e r t y u i o p"
+        - "a s d f g h j k l"
+        - "Shift_L   z x c v b n m  BackSpace"
+        - "show_numbers preferences      space        show_actions Return"
+    upper:
+        - "Q W E R T Y U I O P"
+        - "A S D F G H J K L"
+        - "Shift_L   Z X C V B N M  BackSpace"
+        - "show_numbers preferences      space        show_actions Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "* # $ / & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° @ { }"
+        - "show_numbers_from_symbols   \\ % < > = [ ]  BackSpace"
+        - "show_letters preferences         space        period Return"
+    actions:
+        - "F1  F2  F3  F4  F5  F6"
+        - "F7  F8  F9  F10 F11 F12"
+        - "Esc Tab Del PgUp ↑ PgDn"
+        - "show_letters Home End ← ↓ →"
+
+buttons:
+    Shift_L:
+        action:
+            locking:
+                lock_view: "upper"
+                unlock_view: "base"
+        outline: "altline"
+        icon: "key-shift"
+    BackSpace:
+        outline: "altline"
+        icon: "edit-clear-symbolic"
+        action: erase
+    preferences:
+        action: "show_prefs"
+        outline: "special"
+        icon: "keyboard-mode-symbolic"
+    show_numbers:
+        action:
+            set_view: "numbers"
+        outline: "wide"
+        label: "123"
+    show_numbers_from_symbols:
+        action:
+            set_view: "numbers"
+        outline: "altline"
+        label: "123"
+    show_letters:
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "ABC"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "τ=\\"
+    show_actions:
+        action:
+            set_view: "actions"
+        outline: "altline"
+        label: ">_"
+    period:
+        outline: "altline"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+    F1:
+        outline: "action"
+        keysym: "F1"
+    F2:
+        outline: "action"
+        keysym: "F2"
+    F3:
+        outline: "action"
+        keysym: "F3"
+    F4:
+        outline: "action"
+        keysym: "F4"
+    F5:
+        outline: "action"
+        keysym: "F5"
+    F6:
+        outline: "action"
+        keysym: "F6"
+    F7:
+        outline: "action"
+        keysym: "F7"
+    F8:
+        outline: "action"
+        keysym: "F8"
+    F9:
+        outline: "action"
+        keysym: "F9"
+    F10:
+        outline: "action"
+        keysym: "F10"
+    F11:
+        outline: "action"
+        keysym: "F11"
+    F12:
+        outline: "action"
+        keysym: "F12"
+    Esc:
+        outline: "action"
+        keysym: "Escape"
+    Tab:
+        outline: "action"
+        keysym: "Tab"
+    Del:
+        outline: "action"
+        keysym: "Delete"
+    Home:
+        outline: "action"
+        keysym: "Home"
+    End:
+        outline: "action"
+        keysym: "End"
+    PgUp:
+        outline: "action"
+        keysym: "Page_Up"
+    PgDn:
+        outline: "action"
+        keysym: "Page_Down"
+    "↑":
+        outline: "action"
+        keysym: "Up"
+    "↓":
+        outline: "action"
+        keysym: "Down"
+    "←":
+        outline: "action"
+        keysym: "Left"
+    "→":
+        outline: "action"
+        keysym: "Right"
+

data/keyboards/us.yaml

@@ -39,9 +39,9 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: erase
     preferences:
-        action: "show_prefs"
+        action: show_prefs
         outline: "special"
         icon: "keyboard-mode-symbolic"
     show_numbers:

data/keyboards/us_wide.yaml

@@ -39,7 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "special"

data/langs/de-DE.txt

@@ -1,8 +0,0 @@
-us Englisch (US)
-de Deutsch
-el Griechisch
-es Spanisch
-it Italienisch
-jp+kana Japanisch (Kana)
-no Norwegisch
-

data/langs/en-US.txt

@@ -1,10 +1,2 @@
-us English (US)
+emoji Emoji
-de German
+terminal Terminal
-el Greek
-es Spanish
-fi Finnish
-it Italian
-jp+kana Japanese (kana)
-no Norwegian
-se Swedish
-

data/langs/ja-JP.txt

@@ -1,8 +0,0 @@
-us 英語 (US)
-de ドイツ語
-el ギリシャ語
-es スペイン語
-it イタリア語
-jp+kana 日本語 (かな)
-nb ノルウェー語
-

data/langs/pl-PL.txt

@@ -1,9 +1,2 @@
-us angielski (USA)
+emoji emoji
-de niemiecki
+terminal terminal
-el grecki
-es hiszpański
-fi fiński
-it włoski
-jp+kana japoński (kana)
-no norweski
-se szwedzki

data/style-Adwaita:dark.css

@@ -2,6 +2,7 @@ sq_view {
     background-color: rgba(0, 0, 0, 255);
     color: #ffffff;
     font-family: cantarell, sans-serif;
+    font-size: 25px;
 }
 
 sq_view sq_button {
@@ -35,6 +36,10 @@ sq_button.locked {
     color: #2b292f;
 }
 
+sq_button.action {
+    font-size: 0.75em;
+}
+
 #Return {
     background: #1c71d8;
     border-color: #1a5fb4;

data/style.css

@@ -2,6 +2,7 @@ sq_view {
     background-color: @theme_base_color; /*rgba(0, 0, 0, 255);*/
     color: @theme_text_color; /*#ffffff;*/
     font-family: cantarell, sans-serif;
+    font-size: 25px;
 }
 
 sq_view sq_button {
@@ -38,6 +39,10 @@ sq_button.locked {
     color: @theme_bg_color; /*#2b292f;*/
 }
 
+sq_button.action {
+    font-size: 0.75em;
+}
+
 #Return {
     background: @theme_selected_bg_color; /* #1c71d8; */
     border-color: @borders; /*#1a5fb4;*/

debian/changelog

@@ -1,3 +1,135 @@
+squeekboard (1.9.0) amber-phone; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * imservice: Add commit_string method
+  * submission: Handle submitting strings
+  * input_method: Use for erasing
+  * logging: Use in merged functions
+  * translations: Remove redundant ones
+  * translations: Translate builtin layouts
+  * greek: Rename to gr which is used by gnome settings
+
+  [ Sebastian Krzyszkowiak ]
+  * layouts: Add Polish layouts
+
+  [ Dorota Czaplejewicz ]
+  * locks: Draw based on current view
+  * locking: Lock keys statelessly
+  * layouts: Better accented uppercase in PL
+  * emoji: Add more choices
+  * row: Eliminate angle
+  * layout: Center views relative to each other and the layout bounds
+  * drawing: Generalized foreach_visible_button
+  * variant: Fix double-free
+  * variant: Fix leak
+  * keyboard_layout: Fix leak
+  * layout: Improve scoping of locked variable
+  * terminal: Make */ easier to reach
+
+  [ Sebastian Krzyszkowiak ]
+  * layouts: terminal: Use altline outline for dot key
+
+  [ Dorota Czaplejewicz ]
+  * text input: Disable erasing
+  * cargo: Update deps
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Wed, 19 Feb 2020 14:32:39 +0000
+
+squeekboard (1.8.1) amber-phone; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * action: Rename Level to View
+  * keyboard: Introduce a KeyCode type wrapping u32
+  * layout: Centralize handling key releases
+  * layout: Make handling presses uniform
+  * UI: Drop indirection for show/hide functions
+  * managers: Move visible flag to UI manager
+  * dbus_service: Remove unused function
+  * dbus: Remove unneeded gobjectness
+  * dbus: Rename handler from eekboard_service
+  * context: Moved keymap setting together with its generation
+  * key-emitter: Remove unused
+  * eekboard_context_service: Drop unused enable property
+  * services: Split out layout management from EekboardContextService
+  * submission: Move away from virtual-keyboard
+  * submission: Create a new wrapper over imservice
+  * imservice: Limited scope of unsafe
+  * EekGtkKeyboard: Use a direct reference to EekboardContext
+  * submission: Take over virtual_keyboard handling
+  * keyboard: Cleanups of unused code
+  * levelkeyboard: Drop unused manager references
+  * keyboard: Gather up keymap handling, drop layout
+  * submission: Remove wildcard reexport
+  * imservice: Rename commit_state to done to match protocol
+  * ci: Clean up `..` before it's searched for artifacts
+  * dbus: Log error on dbus exit
+  * logging: Try to improve common operations
+  * imservice: Return something more resembling an Error on failure
+  * logging: Unified to remove random eprint calls
+  * press_key: Use proper logging
+  * number: Fix keysym for Return
+  * build: Strip clap of optional features
+  * layouts: Fix segfault on switching to wide
+  * font: Use font from style context
+  * font: Only pass relevant data to label renderer
+
+  [ Sebastian Krzyszkowiak ]
+  * layout: terminal: Swap positions of preferences and actions button
+  * layout: terminal: Show actions button on all views
+  * layout: terminal: Replace actions button with period on symbols view
+
+  [ Dorota Czaplejewicz ]
+  * setup: Connect ui to the state manager
+  * debian: Add missing commas
+
+  [ David Boddie ]
+  * Tidy build file and docs
+  * Use pip to install recommonmark
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Fri, 31 Jan 2020 09:59:12 +0000
+
+squeekboard (1.8.0) amber-phone; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * translations: Use gnome-desktop's xkb info database for layout names
+  * translations: Make the code cleaner
+  * overlay: Add terminal
+  * eek-layout: Remove unused
+  * pre-release: Update deps
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Tue, 14 Jan 2020 13:55:00 +0000
+
+squeekboard (1.7.0) amber-phone; urgency=medium
+
+  * New terminal layout appearing on terminal input hint
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Wed, 08 Jan 2020 11:53:07 +0000
+
+squeekboard (1.7.0) amber-phone; urgency=medium
+
+  * New terminal layout appearing on terminal input hint
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Wed, 08 Jan 2020 11:53:07 +0000
+
+squeekboard (1.6.0) amber-phone; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * tools: Move entry.py
+  * build: Move building of squeekboard-test-layout to tools
+  * packaging: Install entty.py as squeekboard-entry
+  * Remove unused build dependencies
+  * Remove unused header generator
+  * logging: Move all facilities to one file
+  * logging: Described the design
+  * logging: Add described log levels
+  * popover: Install emoji layout
+  * popover: Show overlays as selected
+  * Fix old Rust woes
+  * emoji: Add a passable layout
+  * Fix g_ and stdlib allocation/free mismatches
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Thu, 02 Jan 2020 12:02:50 +0000
+ 
 squeekboard (1.5.0) amber-phone; urgency=medium
 
   [ Dorota Czaplejewicz ]

debian/check_release.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+
+"""Checks tag before release.
+Feed it the first changelog line, and then all available tags.
+"""
+
+import re, sys
+tag = "v" + re.findall("\\((.*)\\)", input())[0]
+if tag not in map(str.strip, sys.stdin.readlines()):
+    raise Exception("Changelog's current version doesn't have a tag. Push the tag!")

debian/control

@@ -9,6 +9,7 @@ Build-Depends:
  ninja-build,
  pkg-config,
  libglib2.0-dev,
+ libgnome-desktop-3-dev,
  libgtk-3-dev,
  libcroco3-dev,
  librust-bitflags-1-dev (>= 1.0),
@@ -26,9 +27,6 @@ Build-Depends:
  libwayland-dev (>= 1.16),
  rustc,
  wayland-protocols (>= 1.14),
-# for running the tests
- xvfb,
- xauth,
 Standards-Version: 4.1.3
 Homepage: https://source.puri.sm/Librem5/squeekboard
 
@@ -37,17 +35,20 @@ Architecture: linux-any
 Depends:
 # for the Adwaita-dark theme
  gnome-themes-extra-data,
- ${shlibs:Depends}
+ ${shlibs:Depends},
- ${misc:Depends}
+ ${misc:Depends},
 Description: On-screen keyboard for Wayland
  Virtual keyboard supporting Wayland, built primarily for the Librem 5 phone.
 
 Package: squeekboard-devel
 Architecture: linux-any
 Depends:
- ${shlibs:Depends}
+ python3,
- ${misc:Depends}
+ python3-gi,
+ ${shlibs:Depends},
+ ${misc:Depends},
 Description: Resources for making Squeekboard layouts
- Tools for creating Squeekboard layouts:
+ Tools for creating and testing Squeekboard layouts:
  .
+  * squeekboard-entry
   * squeekboard-test-layout

debian/squeekboard-devel.install

@@ -1 +1,2 @@
 usr/bin/squeekboard-test-layout /usr/bin
+usr/bin/squeekboard-entry /usr/bin

doc/build.sh

@@ -0,0 +1,22 @@
+#!/bin/sh
+
+# Builds the documentation and places in the selected directory,
+# or the working directory.
+
+set -e
+
+SCRIPT_PATH="$(realpath "$0")"
+DOCS_DIR="$(dirname "$SCRIPT_PATH")"
+
+TARGET_DIR="${1:-./}"
+
+SPHINX=sphinx-build
+
+if [ ! -d $DOCS_DIR/_static ]; then
+    mkdir -p $DOCS_DIR/_static
+fi
+
+if ! which sphinx-build ; then
+    SPHINX=sphinx-build-3
+fi
+$SPHINX -b html "${DOCS_DIR}" "${TARGET_DIR}"

doc/conf.py

@@ -0,0 +1,165 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'squeekboard'
+copyright = 'Squeekboard contributors'
+author = 'Dorota Czaplejewicz'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'recommonmark'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.md'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'squeekboarddoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'squeekboard.tex', 'squeekboard Documentation',
+     'Dorota Czaplejewicz', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'squeekboard', 'squeekboard Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'squeekboard', 'squeekboard Documentation',
+     author, 'squeekboard', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+from recommonmark.transform import AutoStructify
+
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'enable_auto_toc_tree': True,
+        'auto_toc_tree_section': 'Contents',
+    }, True)
+    app.add_transform(AutoStructify)

doc/hacking.md

@@ -3,10 +3,42 @@ Hacking
 
 This document describes the standards for modifying and maintaining the *squeekboard* project.
 
+Principles
+----------
+
+The project was built upon some guiding principles, which should be respected primarily by the maintainers, but also by contributors to avoid needlessly rejected changes.
+
+The overarching principle of *squeekboard* is to empower users.
+
+Software is primarily meant to solve problems of its users. Often in the quest to make software better, a hard distinction is made between the developer, who becomes the creator, and the user, who takes the role of the consumer, without direct influence on the software they use.
+This project aims to give users the power to make the software work for them by blurring the lines between users and developers.
+
+Nonwithstanding its current state, *squeekboard* must be structured in a way that provides users a gradual way to gain more experience and power to adjust it. It must be easy, in order of importance:
+
+- to use the software,
+- to modify its resources,
+- to change its behaviour,
+- to contribute upstream.
+
+To give an idea of what it means in practice, those are some examples of what has been important for *squeekboard* so far:
+
+- being quick and useable,
+- allowing local overrides of resources and config,
+- storing resources and config as editable, standard files,
+- having complete, up to date documentation of interfaces,
+- having an easy process of sending contributions,
+- adapting to to user's settings and constrains without overriding them,
+- avoiding compiling whenever possible,
+- making it easy to build,
+- having code that is [simple and obvious](https://www.python.org/dev/peps/pep-0020/),
+- having an easy process of testing and accepting contributions.
+
+You may notice that they are ordered roughly from "user-focused" to "maintainer-focused". While good properties are desired, sometimes they conflict, and maintainers should give additional weight to those benefitting the user compared to those benefitting regular contributors.
+
 Sending patches
 ---------------
 
-By submitting a change to this project, you agree to license it under the [GPL license version 3](./COPYING), or any later version. You also certify that your contribution fulfills the [Developer's Certificate of Origin 1.1](./dco.txt).
+By submitting a change to this project, you agree to license it under the [GPL license version 3](https://source.puri.sm/Librem5/squeekboard/blob/master/COPYING), or any later version. You also certify that your contribution fulfills the [Developer's Certificate of Origin 1.1](https://source.puri.sm/Librem5/squeekboard/blob/master/dco.txt).
 
 Development environment
 -----------------------
@@ -24,8 +56,7 @@ sudo apt-get -y install build-essential
 sudo apt-get -y build-dep .
 ```
 
-For an explicit list of dependencies check the `Build-Depends` entry in the
+For an explicit list of dependencies check the `Build-Depends` entry in the [`debian/control`](https://source.puri.sm/Librem5/squeekboard/blob/master/debian/control) file.
-[`debian/control`](./debian/control) file.
 
 Testing
 -------
@@ -40,7 +71,7 @@ Most common testing is done in CI. Occasionally, and for each release, do perfor
 Testing with an application:
 
 ```
-python3 tests/entry.py
+python3 tools/entry.py
 ```
 
 Testing visibility:

doc/index.md

@@ -0,0 +1,27 @@
+Welcome to squeekboard's documentation!
+=======================================
+
+Contents
+--------
+
+* [Tutorial](tutorial.md)
+* [Contributing](hacking.md)
+
+Introduction
+------------
+
+Squeekboard is the on-screen keyboard for the Librem 5 phone. For information about building, look at the [README](https://source.puri.sm/Librem5/squeekboard/blob/master/README.md).
+
+Layouts
+-------
+
+Squeekboard allows user-provided keyboard layouts. They can be created without recompiling the keyboard code. The [tutorial](tutorial.md) explains the process in detail.
+
+Layouts are created using a text-based format, based on YAML.
+
+TODO: Provide a description of the format.
+
+Contributions
+-------------
+
+Anyone is free to modify *squeekboard*. See the [contributing document](hacking.md).

doc/tutorial.md

@@ -0,0 +1,55 @@
+Kareema's guide to creating layouts
+===================================
+
+It’s long overdue to write a comprehensive guide how to add a keyboard layout from start. But unfortunately, I don’t have much time left ATM. A lot of information can be found in [this ](https://forums.puri.sm/t/using-non-latin-language-on-librem-5/7103/5) thread.
+
+So at least I will try to start writing a short how-to here and edit this post as I find the time. Hope this helps a bit - comments and corrections welcome.
+
+**Get one of the existing keyboard layouts**
+
+* You can get one of the keyboards from the squeekboard git repository : [https://source.puri.sm/Librem5/squeekboard ](https://source.puri.sm/Librem5/squeekboard)
+* The keyboard layouts are located in the subdirectory `data/keyboard/` in the `.yaml` files
+* Take a look and try to understand them :slight_smile:
+
+**Fork your own copy of squeekboard**
+
+* Best way would be to start with a fork of the squeekboard repository: Create a user account at https://source.puri.sm/, go the the squeekboard git repository, press “Fork” in the web interface. You can find further instructions [here](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html#creating-a-fork).
+* Clone your fork locally with `git clone` and use the uri of your forked repo there
+
+**Workflow to edit your keyboard and get it merged**
+
+* A generic guide how the workflow to contribute works, can be found at https://developer.puri.sm/Librem5/Contact/Contributing.html
+* Create a branch: Name it “keyboard-layout-mylanguage” or whatever
+* Checkout your branch, edit your keyboard layout and commit your changes
+* Push the local changes (to the branch of your fork of squeekboard)
+* Create a merge request for the branch to get your changes merged to the official squeekboard git repository
+
+**Compile squeekboard**
+
+* Follow the instructions found in “Building” section of the squeekboard’s README: Running squeekboard: [https://source.puri.sm/Librem5/squeekboard/blob/master/README.md#building ](https://source.puri.sm/Librem5/squeekboard/blob/master/README.md#building)
+
+**Running squeekboard**
+
+* Follow these instructions to run squeekboard: [https://source.puri.sm/Librem5/squeekboard/blob/master/README.md#running ](https://source.puri.sm/Librem5/squeekboard/blob/master/README.md#running)
+* Additionally take a look at the contribution document for [testing info](HACKING.md#testing)
+* You can either test it locally on your Linux system or use the [QEMU Librem 5 image ](https://developer.puri.sm/Librem5/Development_Environment/Boards/emulators.html)
+* To test squeekboard locally, you need phoc. Either compile that from the sources as well or use the CI repository ci.puri.sm for Debian based systems:
+  `deb [arch=amd64] http://ci.puri.sm/ scratch librem5`
+
+Squeekboard can be installed from there as a Debian package, too (that’s what I often do). But beware - there be dragons! You could bork your system with these packages and you should probably disable this repository again after installing what you need - these packages are not meant for production systems (or so I heard :wink: )
+
+**Creating the keyboard layout**
+
+* To be written: For the time being, take a look at [Using non-latin language on Librem 5 ](https://forums.puri.sm/t/using-non-latin-language-on-librem-5/7103/5)
+* The correct name of the .yaml file can be found with the command `gsettings get org.gnome.desktop.input-sources sources`
+
+The output should be something like this: `[('xkb', 'us'), ('xkb', 'de')]`
+So f.ex. “de.yaml” would be the correct name for the German keyboard layout.
+* The translations for the keyboard layout names in the different languages can be found at `data/langs/`
+* Don’t forget to add your newly created layout or translation to `src/resources.rs` and the layout to `tests/meson.build` (that’s for me, because I always forget it)
+
+**Testing the layout**
+
+* Copy your yaml file to `~/.local/share/squeekboard/keyboards/` for testing purposes. From there it should get picked up by squeekboard
+* To test the translations in `data/langs/` , you have to compile squeekboard
+

eek/eek-gtk-keyboard.c

@@ -39,22 +39,17 @@
 
 #include "eekboard/eekboard-context-service.h"
 #include "src/layout.h"
+#include "src/submission.h"
 
-enum {
-    PROP_0,
-    PROP_LAST
-};
-
-/* since 2.91.5 GDK_DRAWABLE was removed and gdk_cairo_create takes
-   GdkWindow as the argument */
-#ifndef GDK_DRAWABLE
-#define GDK_DRAWABLE(x) (x)
-#endif
 
 typedef struct _EekGtkKeyboardPrivate
 {
-    EekRenderer *renderer;
+    EekRenderer *renderer; // owned, nullable
-    LevelKeyboard *keyboard; // unowned reference; it's kept in server-context (FIXME)
+    LayoutHolder *eekboard_context; // unowned reference
+    struct submission *submission; // unowned reference
+
+    struct squeek_layout_state *layout; // unowned
+    LevelKeyboard *keyboard; // unowned reference; it's kept in server-context
 
     GdkEventSequence *sequence; // unowned reference
 } EekGtkKeyboardPrivate;
@@ -85,31 +80,59 @@ eek_gtk_keyboard_real_draw (GtkWidget *self,
     GtkAllocation allocation;
     gtk_widget_get_allocation (self, &allocation);
 
+    if (!priv->keyboard) {
+        return FALSE;
+    }
+
     if (!priv->renderer) {
         PangoContext *pcontext = gtk_widget_get_pango_context (self);
 
-        priv->renderer = eek_renderer_new (priv->keyboard, pcontext);
+        priv->renderer = eek_renderer_new (
+                    priv->keyboard,
+                    pcontext);
 
         eek_renderer_set_allocation_size (priv->renderer,
+                                          priv->keyboard->layout,
                                           allocation.width,
                                           allocation.height);
         eek_renderer_set_scale_factor (priv->renderer,
                                        gtk_widget_get_scale_factor (self));
     }
 
-    eek_renderer_render_keyboard (priv->renderer, cr);
+    eek_renderer_render_keyboard (priv->renderer, priv->submission, cr, priv->keyboard);
     return FALSE;
 }
 
+// Units of pixel size
+static enum squeek_arrangement_kind get_type(uint32_t width, uint32_t height) {
+    (void)height;
+    if (width < 1080) {
+        return ARRANGEMENT_KIND_BASE;
+    }
+    return ARRANGEMENT_KIND_WIDE;
+}
+
 static void
 eek_gtk_keyboard_real_size_allocate (GtkWidget     *self,
                                      GtkAllocation *allocation)
 {
     EekGtkKeyboardPrivate *priv =
         eek_gtk_keyboard_get_instance_private (EEK_GTK_KEYBOARD (self));
+    uint32_t scale = (uint32_t)gtk_widget_get_scale_factor(self);
+    // check if the change would switch types
+    enum squeek_arrangement_kind new_type = get_type(
+                (uint32_t)(allocation->width - allocation->x) * scale,
+                (uint32_t)(allocation->height - allocation->y) * scale);
+    if (priv->layout->arrangement != new_type) {
+        struct squeek_layout_state layout = *priv->layout;
+        layout.arrangement = new_type;
+
+        eek_layout_holder_use_layout(priv->eekboard_context, &layout);
+    }
 
     if (priv->renderer)
         eek_renderer_set_allocation_size (priv->renderer,
+                                          priv->keyboard->layout,
                                           allocation->width,
                                           allocation->height);
 
@@ -121,8 +144,11 @@ static void depress(EekGtkKeyboard *self,
                     gdouble x, gdouble y, guint32 time)
 {
     EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
+    if (!priv->keyboard) {
-    squeek_layout_depress(priv->keyboard->layout, priv->keyboard->manager->virtual_keyboard,
+        return;
+    }
+    squeek_layout_depress(priv->keyboard->layout,
+                          priv->submission,
                           x, y, eek_renderer_get_transformation(priv->renderer), time, self);
 }
 
@@ -130,15 +156,25 @@ static void drag(EekGtkKeyboard *self,
                  gdouble x, gdouble y, guint32 time)
 {
     EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-    squeek_layout_drag(priv->keyboard->layout, priv->keyboard->manager->virtual_keyboard,
+    if (!priv->keyboard) {
-                       x, y, eek_renderer_get_transformation(priv->renderer), time, self);
+        return;
+    }
+    squeek_layout_drag(eek_layout_holder_get_keyboard(priv->eekboard_context)->layout,
+                       priv->submission,
+                       x, y, eek_renderer_get_transformation(priv->renderer), time,
+                       priv->eekboard_context, self);
 }
 
 static void release(EekGtkKeyboard *self, guint32 time)
 {
     EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
+    if (!priv->keyboard) {
-    squeek_layout_release(priv->keyboard->layout, priv->keyboard->manager->virtual_keyboard, eek_renderer_get_transformation(priv->renderer), time, self);
+        return;
+    }
+    squeek_layout_release(eek_layout_holder_get_keyboard(priv->eekboard_context)->layout,
+                          priv->submission,
+                          eek_renderer_get_transformation(priv->renderer), time,
+                          priv->eekboard_context, self);
 }
 
 static gboolean
@@ -226,7 +262,8 @@ eek_gtk_keyboard_real_unmap (GtkWidget *self)
 
     if (priv->keyboard) {
         squeek_layout_release_all_only(
-            priv->keyboard->layout, priv->keyboard->manager->virtual_keyboard,
+            priv->keyboard->layout,
+            priv->submission,
             gdk_event_get_time(NULL));
     }
 
@@ -254,14 +291,15 @@ eek_gtk_keyboard_dispose (GObject *object)
     EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
 
     if (priv->renderer) {
-        g_object_unref (priv->renderer);
+        eek_renderer_free(priv->renderer);
         priv->renderer = NULL;
         priv->renderer = NULL;
     }
 
     if (priv->keyboard) {
         squeek_layout_release_all_only(
-            priv->keyboard->layout, priv->keyboard->manager->virtual_keyboard,
+            priv->keyboard->layout,
+            priv->submission,
             gdk_event_get_time(NULL));
         priv->keyboard = NULL;
     }
@@ -300,23 +338,46 @@ eek_gtk_keyboard_init (EekGtkKeyboard *self)
     (void)self;
 }
 
+static void
+on_notify_keyboard (GObject              *object,
+                    GParamSpec           *spec,
+                    EekGtkKeyboard *self) {
+    (void)spec;
+    EekGtkKeyboardPrivate *priv = (EekGtkKeyboardPrivate*)eek_gtk_keyboard_get_instance_private (self);
+    priv->keyboard = eek_layout_holder_get_keyboard(LAYOUT_HOLDER(object));
+    if (priv->renderer) {
+        eek_renderer_free(priv->renderer);
+    }
+    priv->renderer = NULL;
+    gtk_widget_queue_draw(GTK_WIDGET(self));
+}
+
 /**
- * eek_gtk_keyboard_new:
- * @keyboard: an #EekKeyboard
- *
  * Create a new #GtkWidget displaying @keyboard.
  * Returns: a #GtkWidget
  */
 GtkWidget *
-eek_gtk_keyboard_new (LevelKeyboard *keyboard)
+eek_gtk_keyboard_new (LayoutHolder *eekservice,
+                      struct submission *submission,
+                      struct squeek_layout_state *layout)
 {
     EekGtkKeyboard *ret = EEK_GTK_KEYBOARD(g_object_new (EEK_TYPE_GTK_KEYBOARD, NULL));
     EekGtkKeyboardPrivate *priv = (EekGtkKeyboardPrivate*)eek_gtk_keyboard_get_instance_private (ret);
-    priv->keyboard = keyboard;
+    priv->eekboard_context = eekservice;
+    priv->submission = submission;
+    priv->layout = layout;
+    priv->renderer = NULL;
+    g_signal_connect (eekservice,
+                      "notify::keyboard",
+                      G_CALLBACK(on_notify_keyboard),
+                      ret);
+    on_notify_keyboard(G_OBJECT(eekservice), NULL, ret);
+    /* TODO: this is how a compound keyboard
+     * made out of a layout and a suggestion bar could start.
+     * GtkBox *box = GTK_BOX(gtk_box_new(GTK_ORIENTATION_VERTICAL, 0));
+    GtkEntry *fill = GTK_ENTRY(gtk_entry_new());
+    gtk_box_pack_start(box, GTK_WIDGET(fill), FALSE, FALSE, 0);
+    gtk_box_pack_start(box, GTK_WIDGET(ret), TRUE, TRUE, 0);
+    return GTK_WIDGET(box);*/
     return GTK_WIDGET(ret);
 }
-
-EekRenderer *eek_gtk_keyboard_get_renderer(EekGtkKeyboard *self) {
-    EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-    return priv->renderer;
-}

eek/eek-gtk-keyboard.h

@@ -28,7 +28,10 @@
 #include <glib.h>
 #include <gtk/gtk.h>
 
-typedef struct _LevelKeyboard LevelKeyboard; // including causes weird bugs
+#include "eek/eek-types.h"
+
+struct submission;
+struct squeek_layout_state;
 
 G_BEGIN_DECLS
 #define EEK_TYPE_GTK_KEYBOARD (eek_gtk_keyboard_get_type())
@@ -45,7 +48,7 @@ struct _EekGtkKeyboardClass
 };
 
 GType      eek_gtk_keyboard_get_type  (void) G_GNUC_CONST;
-GtkWidget *eek_gtk_keyboard_new       (LevelKeyboard *keyboard);
+GtkWidget *eek_gtk_keyboard_new       (LayoutHolder *eekservice, struct submission *submission, struct squeek_layout_state *layout);
 
 G_END_DECLS
 #endif  /* EEK_GTK_KEYBOARD_H */

eek/eek-keyboard.c

@@ -18,42 +18,76 @@
  * 02110-1301 USA
  */
 
-/**
- * SECTION:eek-keyboard
- * @short_description: Base class of a keyboard
- * @see_also: #EekSection
- *
- * The #EekKeyboardClass class represents a keyboard, which consists
- * of one or more sections of the #EekSectionClass class.
- */
-
 #include "config.h"
-#include <glib/gprintf.h>
 
-#include "eek-enumtypes.h"
+#define _XOPEN_SOURCE 500
-#include "eekboard/eekboard-context-service.h"
+#include <fcntl.h>
-#include "eekboard/key-emitter.h"
+#include <string.h>
-#include "keymap.h"
+#include <sys/mman.h>
+#include <sys/random.h> // TODO: this is Linux-specific
+#include <xkbcommon/xkbcommon.h>
+
+
 #include "eek-keyboard.h"
 
-void level_keyboard_deinit(LevelKeyboard *self) {
+void level_keyboard_free(LevelKeyboard *self) {
     xkb_keymap_unref(self->keymap);
     close(self->keymap_fd);
     squeek_layout_free(self->layout);
-}
-
-void level_keyboard_free(LevelKeyboard *self) {
-    level_keyboard_deinit(self);
     g_free(self);
 }
 
-void level_keyboard_init(LevelKeyboard *self, struct squeek_layout *layout) {
+LevelKeyboard*
-    self->layout = layout;
+level_keyboard_new (struct squeek_layout *layout)
+{
+    LevelKeyboard *keyboard = g_new0(LevelKeyboard, 1);
+
+    if (!keyboard) {
+        g_error("Failed to create a keyboard");
+    }
+    keyboard->layout = layout;
+
+    struct xkb_context *context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
+    if (!context) {
+        g_error("No context created");
     }
 
-LevelKeyboard *level_keyboard_new(EekboardContextService *manager, struct squeek_layout *layout) {
+    const gchar *keymap_str = squeek_layout_get_keymap(keyboard->layout);
-    LevelKeyboard *keyboard = g_new0(LevelKeyboard, 1);
+
-    level_keyboard_init(keyboard, layout);
+    struct xkb_keymap *keymap = xkb_keymap_new_from_string(context, keymap_str,
-    keyboard->manager = manager;
+        XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS);
+
+    if (!keymap)
+        g_error("Bad keymap:\n%s", keymap_str);
+
+    xkb_context_unref(context);
+    keyboard->keymap = keymap;
+
+    keymap_str = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_FORMAT_TEXT_V1);
+    keyboard->keymap_len = strlen(keymap_str) + 1;
+
+    g_autofree char *path = strdup("/eek_keymap-XXXXXX");
+    char *r = &path[strlen(path) - 6];
+    getrandom(r, 6, GRND_NONBLOCK);
+    for (unsigned i = 0; i < 6; i++) {
+        r[i] = (r[i] & 0b1111111) | 0b1000000; // A-z
+        r[i] = r[i] > 'z' ? '?' : r[i]; // The randomizer doesn't need to be good...
+    }
+    int keymap_fd = shm_open(path, O_RDWR | O_CREAT | O_EXCL, 0600);
+    if (keymap_fd < 0) {
+        g_error("Failed to set up keymap fd");
+    }
+    keyboard->keymap_fd = keymap_fd;
+    shm_unlink(path);
+    if (ftruncate(keymap_fd, (off_t)keyboard->keymap_len)) {
+        g_error("Failed to increase keymap fd size");
+    }
+    char *ptr = mmap(NULL, keyboard->keymap_len, PROT_WRITE, MAP_SHARED,
+        keymap_fd, 0);
+    if ((void*)ptr == (void*)-1) {
+        g_error("Failed to set up mmap");
+    }
+    strncpy(ptr, keymap_str, keyboard->keymap_len);
+    munmap(ptr, keyboard->keymap_len);
     return keyboard;
 }

eek/eek-keyboard.h

@@ -28,7 +28,6 @@
 #include <glib-object.h>
 #include <xkbcommon/xkbcommon.h>
 #include "eek-types.h"
-#include "eek-layout.h"
 #include "src/layout.h"
 
 G_BEGIN_DECLS
@@ -41,16 +40,14 @@ struct _LevelKeyboard {
     size_t keymap_len; // length of the data inside keymap_fd
 
     guint id; // as a key to layout choices
-
-    EekboardContextService *manager; // unowned reference
 };
 typedef struct _LevelKeyboard LevelKeyboard;
 
 gchar *             eek_keyboard_get_keymap
                                      (LevelKeyboard *keyboard);
 
-LevelKeyboard *level_keyboard_new(EekboardContextService *manager, struct squeek_layout *layout);
+LevelKeyboard*
-void level_keyboard_deinit(LevelKeyboard *self);
+level_keyboard_new (struct squeek_layout *layout);
 void level_keyboard_free(LevelKeyboard *self);
 
 G_END_DECLS

eek/eek-layout.c

@@ -1,47 +0,0 @@
-/* 
- * Copyright (C) 2010-2011 Daiki Ueno <ueno@unixuser.org>
- * Copyright (C) 2010-2011 Red Hat, Inc.
- * 
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- * 
- * This library is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
- * 
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301 USA
- */
-
-/**
- * SECTION:eek-layout
- * @short_description: Base class of a layout engine
- *
- * The #EekLayout class is a base class of layout engine which
- * arranges keyboard elements.
- */
-
-#include "config.h"
-
-#include "eek-layout.h"
-#include "eek-keyboard.h"
-#include "eekboard/eekboard-context-service.h"
-#include "eek-xml-layout.h"
-
-G_DEFINE_ABSTRACT_TYPE (EekLayout, eek_layout, G_TYPE_OBJECT)
-
-static void
-eek_layout_class_init (EekLayoutClass *klass)
-{
-    klass->create_keyboard = NULL;
-}
-
-void
-eek_layout_init (EekLayout *self)
-{
-}

eek/eek-layout.h

@@ -1,60 +0,0 @@
-/* 
- * Copyright (C) 2010-2011 Daiki Ueno <ueno@unixuser.org>
- * Copyright (C) 2010-2011 Red Hat, Inc.
- * 
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public License
- * as published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- * 
- * This library is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
- * 
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
- * 02110-1301 USA
- */
-
-#if !defined(__EEK_H_INSIDE__) && !defined(EEK_COMPILATION)
-#error "Only <eek/eek.h> can be included directly."
-#endif
-
-#ifndef EEK_LAYOUT_H
-#define EEK_LAYOUT_H 1
-
-#include <glib-object.h>
-#include "eek-types.h"
-#include "src/layout.h"
-
-G_BEGIN_DECLS
-
-#define EEK_TYPE_LAYOUT (eek_layout_get_type())
-G_DECLARE_DERIVABLE_TYPE (EekLayout, eek_layout, EEK, LAYOUT, GObject)
-
-/**
- * EekLayoutClass:
- * @create_keyboard: virtual function for creating a keyboard
- */
-struct _EekLayoutClass
-{
-    /*< private >*/
-    GObjectClass parent_class;
-
-    /*< public >*/
-    LevelKeyboard* (* create_keyboard) (EekboardContextService *manager,
-                                      EekLayout *self,
-                                      gdouble    initial_width,
-                                      gdouble    initial_height);
-
-    /*< private >*/
-    /* padding */
-    gpointer pdummy[24];
-};
-
-GType        eek_layout_get_type  (void) G_GNUC_CONST;
-
-G_END_DECLS
-#endif  /* EEK_LAYOUT_H */

eek/eek-renderer.c

@@ -28,36 +28,10 @@
 #include "eek-renderer.h"
 #include "src/style.h"
 
-enum {
-    PROP_0,
-    PROP_PCONTEXT,
-    PROP_LAST
-};
-
-typedef struct _EekRendererPrivate
-{
-    LevelKeyboard *keyboard; // unowned
-    PangoContext *pcontext; // owned
-    GtkCssProvider *css_provider; // owned
-    GtkStyleContext *view_context; // owned
-    GtkStyleContext *button_context; // TODO: maybe move a copy to each button
-
-    gdouble border_width; // FIXME: border of what?
-
-    gdouble allocation_width;
-    gdouble allocation_height;
-    gint scale_factor; /* the outputs scale factor */
-    struct transformation widget_to_layout;
-
-    PangoFontDescription *font; // owned reference
-
-} EekRendererPrivate;
-
-G_DEFINE_TYPE_WITH_PRIVATE (EekRenderer, eek_renderer, G_TYPE_OBJECT)
 
 /* eek-keyboard-drawing.c */
-static void eek_renderer_render_button_label (EekRenderer *self, cairo_t *cr, GtkStyleContext *ctx,
+static void render_button_label (cairo_t *cr, GtkStyleContext *ctx,
-                                                const struct squeek_button *button);
+                                                const gchar *label, EekBounds bounds);
 
 void eek_render_button                         (EekRenderer *self,
                                                 cairo_t     *cr, const struct squeek_button *button,
@@ -86,8 +60,7 @@ render_outline (cairo_t     *cr,
         position.x, position.y, position.width, position.height);
 }
 
-static void render_button_in_context(EekRenderer *self,
+static void render_button_in_context(gint scale_factor,
-                                     gint scale_factor,
                                      cairo_t     *cr,
                                      GtkStyleContext *ctx,
                                      const struct squeek_button *button) {
@@ -130,7 +103,11 @@ static void render_button_in_context(EekRenderer *self,
             return;
         }
     }
-    eek_renderer_render_button_label (self, cr, ctx, button);
+
+    const gchar *label = squeek_button_get_label(button);
+    if (label) {
+        render_button_label (cr, ctx, label, squeek_button_get_bounds(button));
+    }
 }
 
 void
@@ -140,9 +117,7 @@ eek_render_button (EekRenderer *self,
                gboolean     pressed,
                gboolean     locked)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
+    GtkStyleContext *ctx = self->button_context;
-
-    GtkStyleContext *ctx = priv->button_context;
     /* Set the name of the button on the widget path, using the name obtained
        from the button's symbol. */
     g_autoptr (GtkWidgetPath) path = NULL;
@@ -162,7 +137,7 @@ eek_render_button (EekRenderer *self,
     }
     gtk_style_context_add_class(ctx, outline_name);
 
-    render_button_in_context(self, priv->scale_factor, cr, ctx, button);
+    render_button_in_context(self->scale_factor, cr, ctx, button);
 
     // Save and restore functions don't work if gtk_render_* was used in between
     gtk_style_context_set_state(ctx, GTK_STATE_FLAG_NORMAL);
@@ -173,43 +148,16 @@ eek_render_button (EekRenderer *self,
 }
 
 static void
-eek_renderer_render_button_label (EekRenderer *self,
+render_button_label (cairo_t     *cr,
-                                  cairo_t     *cr,
                      GtkStyleContext *ctx,
-                                  const struct squeek_button *button)
+                     const gchar *label,
+                     EekBounds bounds)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
-
-    const gchar *label = squeek_button_get_label(button);
-
-    if (!label) {
-        return;
-    }
-
     PangoFontDescription *font;
-    gdouble scale;
+    gtk_style_context_get(ctx,
-
+                          gtk_style_context_get_state(ctx),
-
+                          "font", &font,
-    if (!priv->font) {
+                          NULL);
-        const PangoFontDescription *base_font;
-        gdouble size;
-
-        base_font = pango_context_get_font_description (priv->pcontext);
-        // FIXME: Base font size on the same size unit used for button sizing,
-        // and make the default about 1/3 of the current row height
-        size = 30000.0;
-        priv->font = pango_font_description_copy (base_font);
-        pango_font_description_set_size (priv->font, (gint)round(size * 0.6));
-    }
-
-    EekBounds bounds = squeek_button_get_bounds(button);
-    scale = MIN((bounds.width - priv->border_width) / bounds.width,
-                (bounds.height - priv->border_width) / bounds.height);
-
-    font = pango_font_description_copy (priv->font);
-    pango_font_description_set_size (font,
-                                     (gint)round(pango_font_description_get_size (font) * scale));
-
     PangoLayout *layout = pango_cairo_create_layout (cr);
     pango_layout_set_font_description (layout, font);
     pango_font_description_free (font);
@@ -219,8 +167,7 @@ eek_renderer_render_button_label (EekRenderer *self,
     if (line->resolved_dir == PANGO_DIRECTION_RTL) {
         pango_layout_set_alignment (layout, PANGO_ALIGN_RIGHT);
     }
-    pango_layout_set_width (layout,
+    pango_layout_set_width (layout, PANGO_SCALE * bounds.width);
-                            PANGO_SCALE * bounds.width * scale);
 
     PangoRectangle extents = { 0, };
     pango_layout_get_extents (layout, NULL, &extents);
@@ -244,119 +191,46 @@ eek_renderer_render_button_label (EekRenderer *self,
     g_object_unref (layout);
 }
 
+// FIXME: Pass just the active modifiers instead of entire submission
 void
 eek_renderer_render_keyboard (EekRenderer *self,
-                                   cairo_t     *cr)
+                              struct submission *submission,
+                                   cairo_t     *cr,
+                              LevelKeyboard *keyboard)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
+    g_return_if_fail (self->allocation_width > 0.0);
-
+    g_return_if_fail (self->allocation_height > 0.0);
-    g_return_if_fail (priv->keyboard);
-    g_return_if_fail (priv->allocation_width > 0.0);
-    g_return_if_fail (priv->allocation_height > 0.0);
 
     /* Paint the background covering the entire widget area */
-    gtk_render_background (priv->view_context,
+    gtk_render_background (self->view_context,
                            cr,
                            0, 0,
-                           priv->allocation_width, priv->allocation_height);
+                           self->allocation_width, self->allocation_height);
 
     cairo_save(cr);
-    cairo_translate (cr, priv->widget_to_layout.origin_x, priv->widget_to_layout.origin_y);
+    cairo_translate (cr, self->widget_to_layout.origin_x, self->widget_to_layout.origin_y);
-    cairo_scale (cr, priv->widget_to_layout.scale, priv->widget_to_layout.scale);
+    cairo_scale (cr, self->widget_to_layout.scale, self->widget_to_layout.scale);
 
-    squeek_draw_layout_base_view(priv->keyboard->layout, self, cr);
+    squeek_draw_layout_base_view(keyboard->layout, self, cr);
-    squeek_layout_draw_all_changed(priv->keyboard->layout, self, cr);
+    squeek_layout_draw_all_changed(keyboard->layout, self, cr, submission);
     cairo_restore (cr);
 }
 
-static void
+void
-eek_renderer_set_property (GObject      *object,
+eek_renderer_free (EekRenderer        *self)
-                           guint         prop_id,
-                           const GValue *value,
-                           GParamSpec   *pspec)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (
+    if (self->pcontext) {
-            EEK_RENDERER(object));
+        g_object_unref (self->pcontext);
-
+        self->pcontext = NULL;
-    switch (prop_id) {
-    case PROP_PCONTEXT:
-        priv->pcontext = g_value_get_object (value);
-        g_object_ref (priv->pcontext);
-        break;
-    default:
-        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
-        break;
     }
-}
+    g_object_unref(self->css_provider);
-
+    g_object_unref(self->view_context);
-static void
+    g_object_unref(self->button_context);
-eek_renderer_get_property (GObject    *object,
-                           guint       prop_id,
-                           GValue     *value,
-                           GParamSpec *pspec)
-{
-    (void)value;
-    switch (prop_id) {
-    default:
-        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
-        break;
-    }
-}
-
-static void
-eek_renderer_dispose (GObject *object)
-{
-    EekRenderer        *self = EEK_RENDERER (object);
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
-
-    if (priv->keyboard) {
-        priv->keyboard = NULL;
-    }
-    if (priv->pcontext) {
-        g_object_unref (priv->pcontext);
-        priv->pcontext = NULL;
-    }
-
     // this is where renderer-specific surfaces would be released
 
-    G_OBJECT_CLASS (eek_renderer_parent_class)->dispose (object);
+    free(self);
 }
 
-static void
-eek_renderer_finalize (GObject *object)
-{
-    EekRenderer        *self = EEK_RENDERER(object);
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
-
-    g_object_unref(priv->css_provider);
-    g_object_unref(priv->view_context);
-    g_object_unref(priv->button_context);
-    pango_font_description_free (priv->font);
-    G_OBJECT_CLASS (eek_renderer_parent_class)->finalize (object);
-}
-
-static void
-eek_renderer_class_init (EekRendererClass *klass)
-{
-    GObjectClass      *gobject_class = G_OBJECT_CLASS (klass);
-    GParamSpec        *pspec;
-
-    gobject_class->set_property = eek_renderer_set_property;
-    gobject_class->get_property = eek_renderer_get_property;
-    gobject_class->dispose = eek_renderer_dispose;
-    gobject_class->finalize = eek_renderer_finalize;
-
-    pspec = g_param_spec_object ("pango-context",
-                                 "Pango Context",
-                                 "Pango Context",
-                                 PANGO_TYPE_CONTEXT,
-                                 G_PARAM_CONSTRUCT_ONLY | G_PARAM_WRITABLE);
-    g_object_class_install_property (gobject_class,
-                                     PROP_PCONTEXT,
-                                     pspec);
-}
-
-
 static GType new_type(char *name) {
     GTypeInfo info = {0};
     info.class_size = sizeof(GtkWidgetClass);
@@ -384,83 +258,75 @@ static GType button_type() {
 }
 
 static void
-eek_renderer_init (EekRenderer *self)
+renderer_init (EekRenderer *self)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
+    self->pcontext = NULL;
-
+    self->allocation_width = 0.0;
-    priv->keyboard = NULL;
+    self->allocation_height = 0.0;
-    priv->pcontext = NULL;
+    self->scale_factor = 1;
-    priv->border_width = 1.0;
-    priv->allocation_width = 0.0;
-    priv->allocation_height = 0.0;
-    priv->scale_factor = 1;
-    priv->font = NULL;
 
     GtkIconTheme *theme = gtk_icon_theme_get_default ();
 
     gtk_icon_theme_add_resource_path (theme, "/sm/puri/squeekboard/icons");
 
-    priv->css_provider = squeek_load_style();
+    self->css_provider = squeek_load_style();
 }
 
 EekRenderer *
 eek_renderer_new (LevelKeyboard  *keyboard,
                   PangoContext *pcontext)
 {
-    EekRenderer *renderer = g_object_new (EEK_TYPE_RENDERER,
+    EekRenderer *renderer = calloc(1, sizeof(EekRenderer));
-                         "pango-context", pcontext,
+    renderer_init(renderer);
-                         NULL);
+    renderer->pcontext = pcontext;
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
+    g_object_ref (renderer->pcontext);
-    priv->keyboard = keyboard;
 
     /* Create a style context for the layout */
     GtkWidgetPath *path = gtk_widget_path_new();
     gtk_widget_path_append_type(path, view_type());
 
-    priv->view_context = gtk_style_context_new();
+    renderer->view_context = gtk_style_context_new();
-    gtk_style_context_set_path(priv->view_context, path);
+    gtk_style_context_set_path(renderer->view_context, path);
     gtk_widget_path_unref(path);
-    if (squeek_layout_get_kind(priv->keyboard->layout) == ARRANGEMENT_KIND_WIDE) {
+    if (squeek_layout_get_kind(keyboard->layout) == ARRANGEMENT_KIND_WIDE) {
-        gtk_style_context_add_class(priv->view_context, "wide");
+        gtk_style_context_add_class(renderer->view_context, "wide");
     }
-    gtk_style_context_add_provider (priv->view_context,
+    gtk_style_context_add_provider (renderer->view_context,
-        GTK_STYLE_PROVIDER(priv->css_provider),
+        GTK_STYLE_PROVIDER(renderer->css_provider),
         GTK_STYLE_PROVIDER_PRIORITY_USER);
 
     /* Create a style context for the buttons */
     path = gtk_widget_path_new();
     gtk_widget_path_append_type(path, view_type());
-    if (squeek_layout_get_kind(priv->keyboard->layout) == ARRANGEMENT_KIND_WIDE) {
+    if (squeek_layout_get_kind(keyboard->layout) == ARRANGEMENT_KIND_WIDE) {
         gtk_widget_path_iter_add_class(path, -1, "wide");
     }
     gtk_widget_path_append_type(path, button_type());
-    priv->button_context = gtk_style_context_new ();
+    renderer->button_context = gtk_style_context_new ();
-    gtk_style_context_set_path(priv->button_context, path);
+    gtk_style_context_set_path(renderer->button_context, path);
     gtk_widget_path_unref(path);
-    gtk_style_context_set_parent(priv->button_context, priv->view_context);
+    gtk_style_context_set_parent(renderer->button_context, renderer->view_context);
-    gtk_style_context_set_state (priv->button_context, GTK_STATE_FLAG_NORMAL);
+    gtk_style_context_set_state (renderer->button_context, GTK_STATE_FLAG_NORMAL);
-    gtk_style_context_add_provider (priv->button_context,
+    gtk_style_context_add_provider (renderer->button_context,
-        GTK_STYLE_PROVIDER(priv->css_provider),
+        GTK_STYLE_PROVIDER(renderer->css_provider),
         GTK_STYLE_PROVIDER_PRIORITY_USER);
     return renderer;
 }
 
 void
 eek_renderer_set_allocation_size (EekRenderer *renderer,
+                                  struct squeek_layout *layout,
                                   gdouble      width,
                                   gdouble      height)
 {
-    g_return_if_fail (EEK_IS_RENDERER(renderer));
     g_return_if_fail (width > 0.0 && height > 0.0);
 
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
+    renderer->allocation_width = width;
+    renderer->allocation_height = height;
 
-    priv->allocation_width = width;
+    renderer->widget_to_layout = squeek_layout_calculate_transformation(
-    priv->allocation_height = height;
+                layout,
-
+                renderer->allocation_width, renderer->allocation_height);
-    priv->widget_to_layout = squeek_layout_calculate_transformation(
-                priv->keyboard->layout,
-                priv->allocation_width, priv->allocation_height);
 
     // This is where size-dependent surfaces would be released
 }
@@ -468,10 +334,7 @@ eek_renderer_set_allocation_size (EekRenderer *renderer,
 void
 eek_renderer_set_scale_factor (EekRenderer *renderer, gint scale)
 {
-    g_return_if_fail (EEK_IS_RENDERER(renderer));
+    renderer->scale_factor = scale;
-
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-    priv->scale_factor = scale;
 }
 
 cairo_surface_t *
@@ -500,9 +363,5 @@ eek_renderer_get_icon_surface (const gchar *icon_name,
 
 struct transformation
 eek_renderer_get_transformation (EekRenderer *renderer) {
-    struct transformation failed = {0};
+    return renderer->widget_to_layout;
-    g_return_val_if_fail (EEK_IS_RENDERER(renderer), failed);
-
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-    return priv->widget_to_layout;
 }

eek/eek-renderer.h

@@ -25,31 +25,36 @@
 #include <pango/pangocairo.h>
 
 #include "eek-types.h"
+#include "src/submission.h"
 
-G_BEGIN_DECLS
+struct squeek_layout;
 
-#define EEK_TYPE_RENDERER (eek_renderer_get_type())
+/// Renders LevelKayboards
-G_DECLARE_DERIVABLE_TYPE (EekRenderer, eek_renderer, EEK, RENDERER, GObject)
+/// It cannot adjust styles at runtime.
-
+typedef struct EekRenderer
-struct _EekRendererClass
 {
-    GObjectClass parent_class;
+    PangoContext *pcontext; // owned
+    GtkCssProvider *css_provider; // owned
+    GtkStyleContext *view_context; // owned
+    GtkStyleContext *button_context; // TODO: maybe move a copy to each button
+    /// Style class for rendering the view and button CSS.
+    gchar *extra_style; // owned
 
-    cairo_surface_t *(* get_icon_surface)   (EekRenderer *self,
+    // Mutable state
-                                             const gchar *icon_name,
+    /// Background extents
-                                             gint         size,
+    gdouble allocation_width;
-                                             gint         scale);
+    gdouble allocation_height;
+    gint scale_factor; /* the outputs scale factor */
+    /// Coords transformation
+    struct transformation widget_to_layout;
+} EekRenderer;
 
-    /*< private >*/
-    /* padding */
-    gpointer pdummy[23];
-};
 
 GType            eek_renderer_get_type         (void) G_GNUC_CONST;
 EekRenderer     *eek_renderer_new              (LevelKeyboard     *keyboard,
                                                 PangoContext    *pcontext);
 void             eek_renderer_set_allocation_size
-                                               (EekRenderer     *renderer,
+                                               (EekRenderer     *renderer, struct squeek_layout *layout,
                                                 gdouble          width,
                                                 gdouble          height);
 void             eek_renderer_set_scale_factor (EekRenderer     *renderer,
@@ -59,8 +64,10 @@ cairo_surface_t *eek_renderer_get_icon_surface(const gchar     *icon_name,
                                                 gint             size,
                                                 gint             scale);
 
-void             eek_renderer_render_keyboard  (EekRenderer     *renderer,
+void             eek_renderer_render_keyboard  (EekRenderer     *renderer, struct submission *submission,
-                                                cairo_t         *cr);
+                                                cairo_t         *cr, LevelKeyboard *keyboard);
+void
+eek_renderer_free (EekRenderer        *self);
 
 struct transformation
 eek_renderer_get_transformation (EekRenderer *renderer);

eek/eek-types.h

@@ -37,7 +37,8 @@ G_BEGIN_DECLS
 
 typedef struct _EekBounds EekBounds;
 
-typedef struct _EekboardContextService EekboardContextService;
+typedef struct _LayoutHolder LayoutHolder;
+typedef struct _ServerContextService ServerContextService;
 typedef struct _LevelKeyboard LevelKeyboard;
 
 /**

eek/eek-xml-layout.c

@@ -1,38 +0,0 @@
-/*
- * Copyright (C) 2011 Daiki Ueno <ueno@unixuser.org>
- * Copyright (C) 2011 Red Hat, Inc.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-/**
- * SECTION:eek-xml-layout
- * @short_description: Layout engine which loads layout information from XML
- */
-
-#include "config.h"
-
-#include "eek-keyboard.h"
-#include "src/layout.h"
-
-#include "eek-xml-layout.h"
-
-LevelKeyboard *
-eek_xml_layout_real_create_keyboard (const char *keyboard_type,
-                                     EekboardContextService *manager,
-                                     enum squeek_arrangement_kind t)
-{
-    struct squeek_layout *layout = squeek_load_layout(keyboard_type, t);
-    return level_keyboard_new(manager, layout);
-}

eek/eek-xml-layout.h

@@ -1,36 +0,0 @@
-/* 
- * Copyright (C) 2011 Daiki Ueno <ueno@unixuser.org>
- * Copyright (C) 2011 Red Hat, Inc.
- * 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-#if !defined(__EEK_H_INSIDE__) && !defined(EEK_COMPILATION)
-#error "Only <eek/eek.h> can be included directly."
-#endif
-
-#ifndef EEK_XML_LAYOUT_H
-#define EEK_XML_LAYOUT_H 1
-
-#include "eek-types.h"
-#include "src/layout.h"
-
-G_BEGIN_DECLS
-
-LevelKeyboard *
-eek_xml_layout_real_create_keyboard (const char *keyboard_type,
-                                     EekboardContextService *manager,
-                                     enum squeek_arrangement_kind t);
-G_END_DECLS
-#endif  /* EEK_XML_LAYOUT_H */

eek/eek.h

@@ -23,7 +23,6 @@
 #define __EEK_H_INSIDE__ 1
 
 #include "eek-keyboard.h"
-#include "eek-layout.h"
 
 void eek_init (void);
 

eek/keymap.h

@@ -1,8 +0,0 @@
-#include <gdk/gdk.h>
-#include <xkbcommon/xkbcommon.h>
-
-gboolean
-squeek_keymap_get_entries_for_keyval (struct xkb_keymap     *xkb_keymap,
-                                      guint          keyval,
-                                      GdkKeymapKey **keys,
-                                      guint          *n_keys);

eek/meson.build

@@ -1,8 +0,0 @@
-gnome = import('gnome')
-
-enum_headers = [
-  'eek-types.h',
-]
-
-enums = gnome.mkenums_simple('eek-enumtypes', sources: enum_headers)
-

eekboard/eekboard-context-service.c

@@ -16,31 +16,15 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/**
- * SECTION:eekboard-context-service
- * @short_description: base server implementation of eekboard input
- * context service
- *
- * The #EekboardService class provides a base server side
- * implementation of eekboard input context service.
- */
-
 #include "config.h"
 
-#include <fcntl.h>
 #include <stdio.h>
-#define _XOPEN_SOURCE 500
-#include <string.h>
-#include <sys/mman.h>
-#include <sys/random.h> // TODO: this is Linux-specific
-#include <xkbcommon/xkbcommon.h>
 
 #include <gio/gio.h>
 
-#include "eekboard/key-emitter.h"
 #include "wayland.h"
 
-#include "eek/eek-xml-layout.h"
+#include "eek/eek-keyboard.h"
 #include "src/server-context-service.h"
 
 #include "eekboard/eekboard-context-service.h"
@@ -48,102 +32,20 @@
 enum {
     PROP_0, // Magic: without this, keyboard is not useable in g_object_notify
     PROP_KEYBOARD,
-    PROP_VISIBLE,
     PROP_LAST
 };
 
-enum {
+#define LAYOUT_HOLDER_GET_PRIVATE(obj)                       \
-    ENABLED,
+    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EEKBOARD_TYPE_LAYOUT_HOLDER, LayoutHolderPrivate))
-    DISABLED,
-    DESTROYED,
-    LAST_SIGNAL
-};
-
-static guint signals[LAST_SIGNAL] = { 0, };
-
-#define EEKBOARD_CONTEXT_SERVICE_GET_PRIVATE(obj)                       \
-    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EEKBOARD_TYPE_CONTEXT_SERVICE, EekboardContextServicePrivate))
-
-struct _EekboardContextServicePrivate {
-    gboolean enabled;
-    gboolean visible;
 
+struct _LayoutHolderPrivate {
     LevelKeyboard *keyboard; // currently used keyboard
-    GHashTable *keyboard_hash; // a table of available keyboards, per layout
 
-    GSettings *settings;
+    /// Needed for keymap changes after keyboard updates
-    uint32_t hint;
+    struct submission *submission; // unowned
-    uint32_t purpose;
 };
 
-G_DEFINE_TYPE_WITH_PRIVATE (EekboardContextService, eekboard_context_service, G_TYPE_OBJECT);
+G_DEFINE_TYPE_WITH_PRIVATE (LayoutHolder, layout_holder, G_TYPE_OBJECT);
-
-static LevelKeyboard *
-eekboard_context_service_real_create_keyboard (EekboardContextService *self,
-                                               const gchar            *keyboard_type,
-                                               enum squeek_arrangement_kind t)
-{
-    LevelKeyboard *keyboard = eek_xml_layout_real_create_keyboard(keyboard_type, self, t);
-    if (!keyboard) {
-        g_error("Failed to create a keyboard");
-    }
-
-    struct xkb_context *context = xkb_context_new(XKB_CONTEXT_NO_FLAGS);
-    if (!context) {
-        g_error("No context created");
-    }
-
-    const gchar *keymap_str = squeek_layout_get_keymap(keyboard->layout);
-
-    struct xkb_keymap *keymap = xkb_keymap_new_from_string(context, keymap_str,
-        XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS);
-
-    if (!keymap)
-        g_error("Bad keymap:\n%s", keymap_str);
-
-    xkb_context_unref(context);
-    keyboard->keymap = keymap;
-
-    keymap_str = xkb_keymap_get_as_string(keymap, XKB_KEYMAP_FORMAT_TEXT_V1);
-    keyboard->keymap_len = strlen(keymap_str) + 1;
-
-    g_autofree char *path = strdup("/eek_keymap-XXXXXX");
-    char *r = &path[strlen(path) - 6];
-    getrandom(r, 6, GRND_NONBLOCK);
-    for (unsigned i = 0; i < 6; i++) {
-        r[i] = (r[i] & 0b1111111) | 0b1000000; // A-z
-        r[i] = r[i] > 'z' ? '?' : r[i]; // The randomizer doesn't need to be good...
-    }
-    int keymap_fd = shm_open(path, O_RDWR | O_CREAT | O_EXCL, 0600);
-    if (keymap_fd < 0) {
-        g_error("Failed to set up keymap fd");
-    }
-    keyboard->keymap_fd = keymap_fd;
-    shm_unlink(path);
-    if (ftruncate(keymap_fd, (off_t)keyboard->keymap_len)) {
-        g_error("Failed to increase keymap fd size");
-    }
-    char *ptr = mmap(NULL, keyboard->keymap_len, PROT_WRITE, MAP_SHARED,
-        keymap_fd, 0);
-    if ((void*)ptr == (void*)-1) {
-        g_error("Failed to set up mmap");
-    }
-    strncpy(ptr, keymap_str, keyboard->keymap_len);
-    munmap(ptr, keyboard->keymap_len);
-    return keyboard;
-}
-
-static void
-eekboard_context_service_real_show_keyboard (EekboardContextService *self)
-{
-    self->priv->visible = TRUE;
-}
-
-static void
-eekboard_context_service_real_hide_keyboard (EekboardContextService *self)
-{
-    self->priv->visible = FALSE;
-}
 
 static void
 eekboard_context_service_set_property (GObject      *object,
@@ -151,17 +53,8 @@ eekboard_context_service_set_property (GObject      *object,
                                        const GValue *value,
                                        GParamSpec   *pspec)
 {
-    EekboardContextService *context = EEKBOARD_CONTEXT_SERVICE(object);
+    (void)value;
-
     switch (prop_id) {
-    case PROP_KEYBOARD:
-        if (context->priv->keyboard)
-            g_object_unref (context->priv->keyboard);
-        context->priv->keyboard = g_value_get_object (value);
-        break;
-    case PROP_VISIBLE:
-        context->priv->visible = g_value_get_boolean (value);
-        break;
     default:
         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
         break;
@@ -169,79 +62,79 @@ eekboard_context_service_set_property (GObject      *object,
 }
 
 static void
-eekboard_context_service_get_property (GObject    *object,
+layout_holder_get_property (GObject    *object,
                                        guint       prop_id,
                                        GValue     *value,
                                        GParamSpec *pspec)
 {
-    EekboardContextService *context = EEKBOARD_CONTEXT_SERVICE(object);
+    LayoutHolder *context = LAYOUT_HOLDER(object);
 
     switch (prop_id) {
     case PROP_KEYBOARD:
         g_value_set_object (value, context->priv->keyboard);
         break;
-    case PROP_VISIBLE:
-        g_value_set_boolean (value, context->priv->visible);
-        break;
     default:
         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
         break;
     }
 }
 
-static void
-eekboard_context_service_dispose (GObject *object)
-{
-    EekboardContextService *context = EEKBOARD_CONTEXT_SERVICE(object);
-
-    if (context->priv->keyboard_hash) {
-        g_hash_table_destroy (context->priv->keyboard_hash);
-        context->priv->keyboard_hash = NULL;
-    }
-
-    G_OBJECT_CLASS (eekboard_context_service_parent_class)->
-        dispose (object);
-}
-
 static void
 settings_get_layout(GSettings *settings, char **type, char **layout)
 {
+    if (!settings) {
+        return;
+    }
     GVariant *inputs = g_settings_get_value(settings, "sources");
+    if (g_variant_n_children(inputs) == 0) {
+        g_warning("No system layout present");
+        *type = NULL;
+        *layout = NULL;
+    } else {
         // current layout is always first
         g_variant_get_child(inputs, 0, "(ss)", type, layout);
     }
+    g_variant_unref(inputs);
+}
 
 void
-eekboard_context_service_update_layout(EekboardContextService *context, enum squeek_arrangement_kind t)
+eek_layout_holder_use_layout(LayoutHolder *context, struct squeek_layout_state *state) {
-{
+    *context->layout = *state;
-    g_autofree gchar *keyboard_type = NULL;
+    gchar *layout_name = state->overlay_name;
-    g_autofree gchar *keyboard_layout = NULL;
-    settings_get_layout(context->priv->settings, &keyboard_type, &keyboard_layout);
 
-    if (!keyboard_type) {
+    if (layout_name == NULL) {
-        keyboard_type = g_strdup("us");
+        layout_name = state->layout_name;
-    }
-    if (!keyboard_layout) {
-        keyboard_layout = g_strdup("undefined");
-    }
 
-    EekboardContextServicePrivate *priv = EEKBOARD_CONTEXT_SERVICE_GET_PRIVATE(context);
+        switch (state->purpose) {
-
-    switch (priv->purpose) {
         case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NUMBER:
         case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PHONE:
-        keyboard_layout = g_strdup("number");
+            layout_name = "number";
+            break;
+        case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_TERMINAL:
+            layout_name = "terminal";
             break;
         default:
             ;
         }
 
+        if (layout_name == NULL) {
+            layout_name = "us";
+        }
+    }
+
     // generic part follows
-    LevelKeyboard *keyboard = eekboard_context_service_real_create_keyboard(context, keyboard_layout, t);
+    struct squeek_layout *layout = squeek_load_layout(layout_name, state->arrangement);
+    LevelKeyboard *keyboard = level_keyboard_new(layout);
     // set as current
     LevelKeyboard *previous_keyboard = context->priv->keyboard;
     context->priv->keyboard = keyboard;
+    // Update the keymap if necessary.
+    // TODO: Update submission on change event
+    if (context->priv->submission) {
+        submission_set_keyboard(context->priv->submission, keyboard);
+    }
 
+    // Update UI
     g_object_notify (G_OBJECT(context), "keyboard");
 
     // replacing the keyboard above will cause the previous keyboard to get destroyed from the UI side (eek_gtk_keyboard_dispose)
@@ -250,251 +143,141 @@ eekboard_context_service_update_layout(EekboardContextService *context, enum squ
     }
 }
 
-static void update_layout_and_type(EekboardContextService *context) {
+static void
-    eekboard_context_service_update_layout(context, server_context_service_get_layout_type(context));
+layout_holder_init (LayoutHolder *self) {
+    self->priv = LAYOUT_HOLDER_GET_PRIVATE(self);
+}
+
+static void
+layout_holder_class_init (LayoutHolderClass *klass)
+{
+    GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+    GParamSpec *pspec;
+
+    gobject_class->set_property = eekboard_context_service_set_property;
+    gobject_class->get_property = layout_holder_get_property;
+
+    /**
+     * An #LevelKeyboard currently active in this context.
+     */
+    pspec = g_param_spec_pointer("keyboard",
+                                 "Keyboard",
+                                 "Keyboard",
+                                 G_PARAM_READABLE);
+    g_object_class_install_property (gobject_class,
+                                     PROP_KEYBOARD,
+                                     pspec);
+}
+
+/**
+ * Get keyboard currently active in @context.
+ * Returns: (transfer none): a LevelKeyboard
+ */
+LevelKeyboard *
+eek_layout_holder_get_keyboard (LayoutHolder *context)
+{
+    return context->priv->keyboard;
+}
+
+void eekboard_context_service_set_hint_purpose(LayoutHolder *context,
+                                               uint32_t hint, uint32_t purpose)
+{
+    if (context->layout->hint != hint || context->layout->purpose != purpose) {
+        context->layout->hint = hint;
+        context->layout->purpose = purpose;
+        eek_layout_holder_use_layout(context, context->layout);
+    }
+}
+
+void
+eekboard_context_service_set_overlay(LayoutHolder *context, const char* name) {
+    if (g_strcmp0(context->layout->overlay_name, name)) {
+        g_free(context->layout->overlay_name);
+        context->layout->overlay_name = g_strdup(name);
+        eek_layout_holder_use_layout(context, context->layout);
+    }
+}
+
+const char*
+eekboard_context_service_get_overlay(LayoutHolder *context) {
+    return context->layout->overlay_name;
+}
+
+LayoutHolder *eek_layout_holder_new(struct squeek_layout_state *state)
+{
+    LayoutHolder *context = g_object_new (EEKBOARD_TYPE_LAYOUT_HOLDER, NULL);
+    context->layout = state;
+    eek_layout_holder_use_layout(context, context->layout);
+    return context;
+}
+
+void eek_layout_holder_set_submission(LayoutHolder *context, struct submission *submission) {
+    context->priv->submission = submission;
+    if (context->priv->submission) {
+        submission_set_keyboard(context->priv->submission, context->priv->keyboard);
+    }
+}
+
+static void settings_update_layout(struct gsettings_tracker *self) {
+    // The layout in the param must be the same layout as held by context.
+    g_autofree gchar *keyboard_layout = NULL;
+    g_autofree gchar *keyboard_type = NULL;
+    settings_get_layout(self->gsettings,
+                        &keyboard_type, &keyboard_layout);
+
+    if (g_strcmp0(self->layout->layout_name, keyboard_layout) != 0 || self->layout->overlay_name) {
+        g_free(self->layout->overlay_name);
+        self->layout->overlay_name = NULL;
+        if (keyboard_layout) {
+            g_free(self->layout->layout_name);
+            self->layout->layout_name = g_strdup(keyboard_layout);
+        }
+        // This must actually update the UI.
+        eek_layout_holder_use_layout(self->context, self->layout);
+    }
 }
 
 static gboolean
-settings_handle_layout_changed(GSettings *s,
+handle_layout_changed(GSettings *s,
                                gpointer keys, gint n_keys,
                                gpointer user_data) {
     (void)s;
     (void)keys;
     (void)n_keys;
-    EekboardContextService *context = user_data;
+    struct gsettings_tracker *self = user_data;
-    update_layout_and_type(context);
+    settings_update_layout(self);
     return TRUE;
 }
 
-static void
+void eek_gsettings_tracker_init(struct gsettings_tracker *tracker, LayoutHolder *context, struct squeek_layout_state *layout)
-eekboard_context_service_constructed (GObject *object)
 {
-    EekboardContextService *context = EEKBOARD_CONTEXT_SERVICE (object);
+    tracker->layout = layout;
-    context->virtual_keyboard = zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(
+    tracker->context = context;
-                squeek_wayland->virtual_keyboard_manager,
-                squeek_wayland->seat);
-    if (!context->virtual_keyboard) {
-        g_error("Programmer error: Failed to receive a virtual keyboard instance");
-    }
-    update_layout_and_type(context);
-}
 
-static void
+    const char *schema_name = "org.gnome.desktop.input-sources";
-eekboard_context_service_class_init (EekboardContextServiceClass *klass)
+    GSettingsSchemaSource *ssrc = g_settings_schema_source_get_default();
-{
+    if (ssrc) {
-    GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+        GSettingsSchema *schema = g_settings_schema_source_lookup(ssrc,
-    GParamSpec *pspec;
+                                                                  schema_name,
-
+                                                                  TRUE);
-    klass->show_keyboard = eekboard_context_service_real_show_keyboard;
+        if (schema) {
-    klass->hide_keyboard = eekboard_context_service_real_hide_keyboard;
+            // Not referencing the found schema directly,
-
+            // because it's not clear how...
-    gobject_class->constructed = eekboard_context_service_constructed;
+            tracker->gsettings = g_settings_new (schema_name);
-    gobject_class->set_property = eekboard_context_service_set_property;
+            gulong conn_id = g_signal_connect(tracker->gsettings, "change-event",
-    gobject_class->get_property = eekboard_context_service_get_property;
+                                              G_CALLBACK(handle_layout_changed),
-    gobject_class->dispose = eekboard_context_service_dispose;
+                                              tracker);
-
-    /**
-     * EekboardContextService::enabled:
-     * @context: an #EekboardContextService
-     *
-     * Emitted when @context is enabled.
-     */
-    signals[ENABLED] =
-        g_signal_new (I_("enabled"),
-                      G_TYPE_FROM_CLASS(gobject_class),
-                      G_SIGNAL_RUN_LAST,
-                      G_STRUCT_OFFSET(EekboardContextServiceClass, enabled),
-                      NULL,
-                      NULL,
-                      g_cclosure_marshal_VOID__VOID,
-                      G_TYPE_NONE,
-                      0);
-
-    /**
-     * EekboardContextService::disabled:
-     * @context: an #EekboardContextService
-     *
-     * Emitted when @context is enabled.
-     */
-    signals[DISABLED] =
-        g_signal_new (I_("disabled"),
-                      G_TYPE_FROM_CLASS(gobject_class),
-                      G_SIGNAL_RUN_LAST,
-                      G_STRUCT_OFFSET(EekboardContextServiceClass, disabled),
-                      NULL,
-                      NULL,
-                      g_cclosure_marshal_VOID__VOID,
-                      G_TYPE_NONE,
-                      0);
-
-    /**
-     * EekboardContextService::destroyed:
-     * @context: an #EekboardContextService
-     *
-     * Emitted when @context is destroyed.
-     */
-    signals[DESTROYED] =
-        g_signal_new (I_("destroyed"),
-                      G_TYPE_FROM_CLASS(gobject_class),
-                      G_SIGNAL_RUN_LAST,
-                      G_STRUCT_OFFSET(EekboardContextServiceClass, destroyed),
-                      NULL,
-                      NULL,
-                      g_cclosure_marshal_VOID__VOID,
-                      G_TYPE_NONE,
-                      0);
-
-    /**
-     * EekboardContextService:keyboard:
-     *
-     * An #EekKeyboard currently active in this context.
-     */
-    pspec = g_param_spec_pointer("keyboard",
-                                 "Keyboard",
-                                 "Keyboard",
-                                 G_PARAM_READWRITE);
-    g_object_class_install_property (gobject_class,
-                                     PROP_KEYBOARD,
-                                     pspec);
-
-    /**
-     * EekboardContextService:visible:
-     *
-     * Flag to indicate if keyboard is visible or not.
-     */
-    pspec = g_param_spec_boolean ("visible",
-                                  "Visible",
-                                  "Visible",
-                                  FALSE,
-                                  G_PARAM_READWRITE);
-    g_object_class_install_property (gobject_class,
-                                     PROP_VISIBLE,
-                                     pspec);
-}
-
-static void
-eekboard_context_service_init (EekboardContextService *self)
-{
-    self->priv = EEKBOARD_CONTEXT_SERVICE_GET_PRIVATE(self);
-
-    self->priv->keyboard_hash =
-        g_hash_table_new_full (g_direct_hash,
-                               g_direct_equal,
-                               NULL,
-                               (GDestroyNotify)g_object_unref);
-
-    self->priv->settings = g_settings_new ("org.gnome.desktop.input-sources");
-    gulong conn_id = g_signal_connect(self->priv->settings, "change-event",
-                                      G_CALLBACK(settings_handle_layout_changed),
-                                      self);
             if (conn_id == 0) {
-        g_warning ("Could not connect to gsettings updates, layout"
+                g_warning ("Could not connect to gsettings updates, "
-                   " changing unavailable");
+                           "automatic layout changing unavailable");
             }
+        } else {
+            g_warning("Gsettings schema %s is not installed on the system. "
+                      "Layout switching unavailable", schema_name);
+        }
+    } else {
+        g_warning("No gsettings schemas installed. Layout switching unavailable.");
     }
 
-/**
+    settings_update_layout(tracker);
- * eekboard_context_service_enable:
- * @context: an #EekboardContextService
- *
- * Enable @context.  This function is called when @context is pushed
- * by eekboard_service_push_context().
- */
-void
-eekboard_context_service_enable (EekboardContextService *context)
-{
-    g_return_if_fail (EEKBOARD_IS_CONTEXT_SERVICE(context));
-
-    if (!context->priv->enabled) {
-        context->priv->enabled = TRUE;
-        g_signal_emit (context, signals[ENABLED], 0);
-    }
-}
-
-/**
- * eekboard_context_service_disable:
- * @context: an #EekboardContextService
- *
- * Disable @context.  This function is called when @context is pushed
- * by eekboard_service_pop_context().
- */
-void
-eekboard_context_service_disable (EekboardContextService *context)
-{
-    g_return_if_fail (EEKBOARD_IS_CONTEXT_SERVICE(context));
-
-    if (context->priv->enabled) {
-        context->priv->enabled = FALSE;
-        g_signal_emit (context, signals[DISABLED], 0);
-    }
-}
-
-void
-eekboard_context_service_show_keyboard (EekboardContextService *context)
-{
-    g_return_if_fail (EEKBOARD_IS_CONTEXT_SERVICE(context));
-
-    if (!context->priv->visible) {
-        EEKBOARD_CONTEXT_SERVICE_GET_CLASS(context)->show_keyboard (context);
-    }
-}
-
-void
-eekboard_context_service_hide_keyboard (EekboardContextService *context)
-{
-    g_return_if_fail (EEKBOARD_IS_CONTEXT_SERVICE(context));
-
-    if (context->priv->visible) {
-        EEKBOARD_CONTEXT_SERVICE_GET_CLASS(context)->hide_keyboard (context);
-    }
-}
-
-/**
- * eekboard_context_service_destroy:
- * @context: an #EekboardContextService
- *
- * Destroy @context.
- */
-void
-eekboard_context_service_destroy (EekboardContextService *context)
-{
-    g_return_if_fail (EEKBOARD_IS_CONTEXT_SERVICE(context));
-
-    if (context->priv->enabled) {
-        eekboard_context_service_disable (context);
-    }
-    g_signal_emit (context, signals[DESTROYED], 0);
-}
-
-/**
- * eekboard_context_service_get_keyboard:
- * @context: an #EekboardContextService
- *
- * Get keyboard currently active in @context.
- * Returns: (transfer none): an #EekKeyboard
- */
-LevelKeyboard *
-eekboard_context_service_get_keyboard (EekboardContextService *context)
-{
-    return context->priv->keyboard;
-}
-
-void eekboard_context_service_set_keymap(EekboardContextService *context,
-                                         const LevelKeyboard *keyboard)
-{
-    zwp_virtual_keyboard_v1_keymap(context->virtual_keyboard,
-        WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,
-        keyboard->keymap_fd, keyboard->keymap_len);
-}
-
-void eekboard_context_service_set_hint_purpose(EekboardContextService *context,
-                                               uint32_t hint, uint32_t purpose)
-{
-    EekboardContextServicePrivate *priv = EEKBOARD_CONTEXT_SERVICE_GET_PRIVATE(context);
-
-    if (priv->hint != hint || priv->purpose != purpose) {
-        priv->hint = hint;
-        priv->purpose = purpose;
-        update_layout_and_type(context);
-    }
 }

eekboard/eekboard-context-service.h

@@ -22,90 +22,68 @@
 #ifndef EEKBOARD_CONTEXT_SERVICE_H
 #define EEKBOARD_CONTEXT_SERVICE_H 1
 
-#include <eek/eek.h>
+#include "src/submission.h"
+#include "src/layout.h"
 
 #include "virtual-keyboard-unstable-v1-client-protocol.h"
 #include "text-input-unstable-v3-client-protocol.h"
 
 G_BEGIN_DECLS
 
-#define EEKBOARD_CONTEXT_SERVICE_PATH "/org/fedorahosted/Eekboard/Context_%d"
+#define EEKBOARD_TYPE_LAYOUT_HOLDER (layout_holder_get_type())
-#define EEKBOARD_CONTEXT_SERVICE_INTERFACE "org.fedorahosted.Eekboard.Context"
+#define LAYOUT_HOLDER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EEKBOARD_TYPE_LAYOUT_HOLDER, LayoutHolder))
-
-#define EEKBOARD_TYPE_CONTEXT_SERVICE (eekboard_context_service_get_type())
-#define EEKBOARD_CONTEXT_SERVICE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EEKBOARD_TYPE_CONTEXT_SERVICE, EekboardContextService))
 #define EEKBOARD_CONTEXT_SERVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), EEKBOARD_TYPE_CONTEXT_SERVICE, EekboardContextServiceClass))
 #define EEKBOARD_IS_CONTEXT_SERVICE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EEKBOARD_TYPE_CONTEXT_SERVICE))
 #define EEKBOARD_IS_CONTEXT_SERVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EEKBOARD_TYPE_CONTEXT_SERVICE))
 #define EEKBOARD_CONTEXT_SERVICE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EEKBOARD_TYPE_CONTEXT_SERVICE, EekboardContextServiceClass))
 
 
-typedef struct _EekboardContextServiceClass EekboardContextServiceClass;
+typedef struct _LayoutHolderClass LayoutHolderClass;
-typedef struct _EekboardContextServicePrivate EekboardContextServicePrivate;
+typedef struct _LayoutHolderPrivate LayoutHolderPrivate;
 
 /**
- * EekboardContextService:
+ * Handles layout state, and virtual-keyboard.
  *
  * TODO: Restrict to managing keyboard layouts, and maybe button repeats,
  * and the virtual keyboard protocol.
- *
- * The #EekboardContextService structure contains only private data
- * and should only be accessed using the provided API.
  */
-struct _EekboardContextService {
+struct _LayoutHolder {
     GObject parent;
-
+    LayoutHolderPrivate *priv;
-    EekboardContextServicePrivate *priv;
+    struct squeek_layout_state *layout; // Unowned
-
-    struct zwp_virtual_keyboard_v1 *virtual_keyboard;
 };
 
-/**
+struct _LayoutHolderClass {
- * EekboardContextServiceClass:
- * @create_keyboard: virtual function for create a keyboard from string
- * @show_keyboard: virtual function for show a keyboard
- * @hide_keyboard: virtual function for hide a keyboard
- * @enabled: class handler for #EekboardContextService::enabled signal
- * @disabled: class handler for #EekboardContextService::disabled signal
- */
-struct _EekboardContextServiceClass {
     /*< private >*/
     GObjectClass parent_class;
 
-    /*< public >*/
-    struct squeek_view *(*create_keyboard)    (EekboardContextService *self,
-                                        const gchar            *keyboard_type);
-    void         (*show_keyboard)      (EekboardContextService *self);
-    void         (*hide_keyboard)      (EekboardContextService *self);
-
-    /* signals */
-    void         (*enabled)            (EekboardContextService *self);
-    void         (*disabled)           (EekboardContextService *self);
-    void         (*destroyed)          (EekboardContextService *self);
-
     /*< private >*/
     /* padding */
     gpointer pdummy[24];
 };
 
-GType         eekboard_context_service_get_type
+GType         layout_holder_get_type(void) G_GNUC_CONST;
-                                              (void) G_GNUC_CONST;
-void          eekboard_context_service_enable (EekboardContextService *context);
-void          eekboard_context_service_disable (EekboardContextService *context);
-void          eekboard_context_service_show_keyboard
-                                              (EekboardContextService *context);
-void          eekboard_context_service_hide_keyboard
-                                              (EekboardContextService *context);
-void          eekboard_context_service_destroy (EekboardContextService *context);
-LevelKeyboard *eekboard_context_service_get_keyboard(EekboardContextService *context);
 
-void eekboard_context_service_set_keymap(EekboardContextService *context,
+/// Handles gsettings os-level keyboard layout switches.
+struct gsettings_tracker {
+    GSettings *gsettings; // Owned reference
+    LayoutHolder *context; // Unowned
+    struct squeek_layout_state *layout; // Unowned
+};
+
+void eek_gsettings_tracker_init(struct gsettings_tracker* tracker, LayoutHolder *context, struct squeek_layout_state *layout);
+
+LayoutHolder *eek_layout_holder_new(struct squeek_layout_state *state);
+void eek_layout_holder_set_submission(LayoutHolder *context, struct submission *submission);
+LevelKeyboard *eek_layout_holder_get_keyboard(LayoutHolder *context);
+
+void eekboard_context_service_set_keymap(LayoutHolder *context,
                                          const LevelKeyboard *keyboard);
 
-void eekboard_context_service_set_hint_purpose(EekboardContextService *context,
+void eekboard_context_service_set_hint_purpose(LayoutHolder *context,
                                                uint32_t hint,
                                                uint32_t purpose);
 void
-eekboard_context_service_update_layout(EekboardContextService *context, enum squeek_arrangement_kind t);
+eek_layout_holder_use_layout(LayoutHolder *context, struct squeek_layout_state *layout);
 G_END_DECLS
 #endif  /* EEKBOARD_CONTEXT_SERVICE_H */

eekboard/eekboard-service.c

@@ -1,310 +0,0 @@
-/*
- * Copyright (C) 2010-2011 Daiki Ueno <ueno@unixuser.org>
- * Copyright (C) 2010-2011 Red Hat, Inc.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-/**
- * SECTION:eekboard-service
- * @short_description: base implementation of eekboard service
- *
- * Provides a dbus object, and contains the context.
- *
- * The #EekboardService class provides a base server side
- * implementation of eekboard service.
- */
-
-#include "config.h"
-
-#include "sm.puri.OSK0.h"
-
-#include <stdio.h>
-
-#include <gio/gio.h>
-
-#include "eekboard/eekboard-service.h"
-
-enum {
-    PROP_0,
-    PROP_OBJECT_PATH,
-    PROP_CONNECTION,
-    PROP_LAST
-};
-
-enum {
-    DESTROYED,
-    LAST_SIGNAL
-};
-
-static guint signals[LAST_SIGNAL] = { 0, };
-
-typedef struct _EekboardServicePrivate
-{
-    GDBusConnection *connection;
-    SmPuriOSK0 *dbus_interface;
-    GDBusNodeInfo *introspection_data;
-    guint registration_id;
-    char *object_path;
-
-    EekboardContextService *context; // unowned reference
-} EekboardServicePrivate;
-
-G_DEFINE_TYPE_WITH_PRIVATE (EekboardService, eekboard_service, G_TYPE_OBJECT)
-
-static void
-eekboard_service_set_property (GObject      *object,
-                               guint         prop_id,
-                               const GValue *value,
-                               GParamSpec   *pspec)
-{
-    EekboardService *service = EEKBOARD_SERVICE(object);
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (service);
-    GDBusConnection *connection;
-
-    switch (prop_id) {
-    case PROP_OBJECT_PATH:
-        if (priv->object_path)
-            g_free (priv->object_path);
-        priv->object_path = g_value_dup_string (value);
-        break;
-    case PROP_CONNECTION:
-        connection = g_value_get_object (value);
-        if (priv->connection)
-            g_object_unref (priv->connection);
-        priv->connection = g_object_ref (connection);
-        break;
-    default:
-        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
-        break;
-    }
-}
-
-static void
-eekboard_service_get_property (GObject    *object,
-                               guint       prop_id,
-                               GValue     *value,
-                               GParamSpec *pspec)
-{
-    EekboardService *service = EEKBOARD_SERVICE(object);
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (service);
-
-    switch (prop_id) {
-    case PROP_OBJECT_PATH:
-        g_value_set_string (value, priv->object_path);
-        break;
-    case PROP_CONNECTION:
-        g_value_set_object (value, priv->connection);
-        break;
-    default:
-        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
-        break;
-    }
-}
-
-static void
-eekboard_service_dispose (GObject *object)
-{
-    EekboardService *service = EEKBOARD_SERVICE(object);
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (service);
-
-    if (priv->connection) {
-        if (priv->registration_id > 0) {
-            g_dbus_connection_unregister_object (priv->connection,
-                                                 priv->registration_id);
-            priv->registration_id = 0;
-        }
-
-        g_object_unref (priv->connection);
-        priv->connection = NULL;
-    }
-
-    if (priv->introspection_data) {
-        g_dbus_node_info_unref (priv->introspection_data);
-        priv->introspection_data = NULL;
-    }
-
-    if (priv->context) {
-        g_signal_handlers_disconnect_by_data (priv->context, service);
-        priv->context = NULL;
-    }
-
-    G_OBJECT_CLASS (eekboard_service_parent_class)->dispose (object);
-}
-
-static void
-eekboard_service_finalize (GObject *object)
-{
-    EekboardService *service = EEKBOARD_SERVICE(object);
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (service);
-
-    g_free (priv->object_path);
-
-    G_OBJECT_CLASS (eekboard_service_parent_class)->finalize (object);
-}
-
-static gboolean
-handle_set_visible(SmPuriOSK0 *object, GDBusMethodInvocation *invocation,
-                   gboolean arg_visible, gpointer user_data) {
-    EekboardService *service = user_data;
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (service);
-
-    if (priv->context) {
-        if (arg_visible) {
-            eekboard_context_service_show_keyboard (priv->context);
-        } else {
-            eekboard_context_service_hide_keyboard (priv->context);
-        }
-    }
-    sm_puri_osk0_complete_set_visible(object, invocation);
-    return TRUE;
-}
-
-static void on_visible(EekboardService *service,
-                       GParamSpec *pspec,
-                       EekboardContextService *context)
-{
-    gboolean visible;
-    EekboardServicePrivate *priv;
-
-    g_return_if_fail (EEKBOARD_IS_SERVICE (service));
-    g_return_if_fail (EEKBOARD_IS_CONTEXT_SERVICE (context));
-
-    priv = eekboard_service_get_instance_private (service);
-    g_object_get (context, "visible", &visible, NULL);
-
-    sm_puri_osk0_set_visible(priv->dbus_interface, visible);
-}
-
-static void
-eekboard_service_constructed (GObject *object)
-{
-    EekboardService *service = EEKBOARD_SERVICE(object);
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (service);
-
-    priv->dbus_interface = sm_puri_osk0_skeleton_new();
-    g_signal_connect(priv->dbus_interface, "handle-set-visible",
-                     G_CALLBACK(handle_set_visible), service);
-
-    if (priv->connection && priv->object_path) {
-        GError *error = NULL;
-
-        if (!g_dbus_interface_skeleton_export(G_DBUS_INTERFACE_SKELETON(priv->dbus_interface),
-                                              priv->connection,
-                                              priv->object_path,
-                                              &error)) {
-            g_warning("Error registering dbus object: %s\n", error->message);
-            g_clear_error(&error);
-        }
-    }
-}
-
-static void
-eekboard_service_class_init (EekboardServiceClass *klass)
-{
-    GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
-    GParamSpec *pspec;
-
-    klass->create_context = NULL;
-
-    gobject_class->constructed = eekboard_service_constructed;
-    gobject_class->set_property = eekboard_service_set_property;
-    gobject_class->get_property = eekboard_service_get_property;
-    gobject_class->dispose = eekboard_service_dispose;
-    gobject_class->finalize = eekboard_service_finalize;
-
-    /**
-     * EekboardService::destroyed:
-     * @service: an #EekboardService
-     *
-     * The ::destroyed signal is emitted when the service is vanished.
-     */
-    signals[DESTROYED] =
-        g_signal_new (I_("destroyed"),
-                      G_TYPE_FROM_CLASS(gobject_class),
-                      G_SIGNAL_RUN_LAST,
-                      0,
-                      NULL,
-                      NULL,
-                      g_cclosure_marshal_VOID__VOID,
-                      G_TYPE_NONE,
-                      0);
-
-    /**
-     * EekboardService:object-path:
-     *
-     * D-Bus object path.
-     */
-    pspec = g_param_spec_string ("object-path",
-                                 "Object-path",
-                                 "Object-path",
-                                 NULL,
-                                 G_PARAM_CONSTRUCT | G_PARAM_READWRITE);
-    g_object_class_install_property (gobject_class,
-                                     PROP_OBJECT_PATH,
-                                     pspec);
-
-    /**
-     * EekboardService:connection:
-     *
-     * D-Bus connection.
-     */
-    pspec = g_param_spec_object ("connection",
-                                 "Connection",
-                                 "Connection",
-                                 G_TYPE_DBUS_CONNECTION,
-                                 G_PARAM_CONSTRUCT | G_PARAM_READWRITE);
-    g_object_class_install_property (gobject_class,
-                                     PROP_CONNECTION,
-                                     pspec);
-}
-
-static void
-eekboard_service_init (EekboardService *self)
-{
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (self);
-
-    priv->context = NULL;
-}
-
-/**
- * eekboard_service_new:
- * @connection: a #GDBusConnection
- * @object_path: object path
- */
-EekboardService *
-eekboard_service_new (GDBusConnection *connection,
-                      const gchar     *object_path)
-{
-    return g_object_new (EEKBOARD_TYPE_SERVICE,
-                         "object-path", object_path,
-                         "connection", connection,
-                         NULL);
-}
-
-void
-eekboard_service_set_context(EekboardService *service,
-                             EekboardContextService *context)
-{
-    EekboardServicePrivate *priv = eekboard_service_get_instance_private (service);
-
-    g_return_if_fail (!priv->context);
-
-    priv->context = context;
-
-    g_signal_connect_swapped (priv->context,
-                              "notify::visible",
-                              G_CALLBACK(on_visible),
-                              service);
-}

eekboard/eekboard-service.h

@@ -1,55 +0,0 @@
-/* 
- * Copyright (C) 2010-2011 Daiki Ueno <ueno@unixuser.org>
- * Copyright (C) 2010-2011 Red Hat, Inc.
- * 
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-#ifndef EEKBOARD_SERVICE_H
-#define EEKBOARD_SERVICE_H 1
-
-#define __EEKBOARD_SERVICE_H_INSIDE__ 1
-
-#include "eekboard/eekboard-context-service.h"
-
-G_BEGIN_DECLS
-
-#define EEKBOARD_SERVICE_PATH "/sm/puri/OSK0"
-#define EEKBOARD_SERVICE_INTERFACE "sm.puri.OSK0"
-
-#define EEKBOARD_TYPE_SERVICE (eekboard_service_get_type())
-G_DECLARE_DERIVABLE_TYPE (EekboardService, eekboard_service, EEKBOARD, SERVICE, GObject)
-
-/**
- * EekboardServiceClass:
- * @create_context: virtual function for creating a context
- */
-struct _EekboardServiceClass {
-    /*< private >*/
-    GObjectClass parent_class;
-
-    /*< public >*/
-    EekboardContextService *(*create_context) (EekboardService *self);
-
-    /*< private >*/
-    /* padding */
-    gpointer pdummy[24];
-};
-
-GType             eekboard_service_get_type (void) G_GNUC_CONST;
-EekboardService * eekboard_service_new      (GDBusConnection *connection,
-                                             const gchar     *object_path);
-void              eekboard_service_set_context(EekboardService *service,
-                                               EekboardContextService *context);
-G_END_DECLS
-#endif  /* EEKBOARD_SERVICE_H */

eekboard/key-emitter.c

@@ -1,136 +0,0 @@
-/*
- * Copyright (C) 2011 Daiki Ueno <ueno@unixuser.org>
- * Copyright (C) 2011 Red Hat, Inc.
- * Copyright (C) 2019 Purism, SPC
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-/* This file is responsible for managing keycode data and emitting keycodes. */
-
-#include "eekboard/key-emitter.h"
-
-#include <gdk/gdk.h>
-#include <X11/XKBlib.h>
-
-#include "eekboard/eekboard-context-service.h"
-
-// TODO: decide whether it's this struct that carries the keyboard around in key-emitter or if the whole manager should be dragged around
-// if this is the carrier, then it should be made part of the manager
-// hint: check which fields need to be persisted between keypresses; which between keyboards
-typedef struct {
-    struct zwp_virtual_keyboard_v1 *virtual_keyboard; // unowned copy
-    struct xkb_keymap *keymap; // unowned copy
-    XkbDescRec *xkb;
-    guint modifier_keycodes[8];
-    guint modifier_indices[MOD_IDX_LAST];
-    guint group;
-} SeatEmitter;
-
-
-int send_virtual_keyboard_key(
-    struct zwp_virtual_keyboard_v1 *keyboard,
-    unsigned int keycode,
-    unsigned is_press,
-    uint32_t timestamp
-) {
-    zwp_virtual_keyboard_v1_key(keyboard, timestamp, keycode, (unsigned)is_press);
-    return 0;
-}
-
-/* Finds the first key code for each modifier and saves it in modifier_keycodes */
-static void
-update_modifier_info (SeatEmitter *client)
-{
-    client->modifier_indices[MOD_IDX_SHIFT] = xkb_keymap_mod_get_index(client->keymap, XKB_MOD_NAME_SHIFT);
-    client->modifier_indices[MOD_IDX_CAPS] = xkb_keymap_mod_get_index(client->keymap, XKB_MOD_NAME_CAPS);
-    client->modifier_indices[MOD_IDX_CTRL] = xkb_keymap_mod_get_index(client->keymap, XKB_MOD_NAME_CTRL);
-    client->modifier_indices[MOD_IDX_ALT] = xkb_keymap_mod_get_index(client->keymap, XKB_MOD_NAME_ALT);
-    client->modifier_indices[MOD_IDX_NUM] = xkb_keymap_mod_get_index(client->keymap, XKB_MOD_NAME_NUM);
-    client->modifier_indices[MOD_IDX_MOD3] = xkb_keymap_mod_get_index(client->keymap, "Mod3");
-    client->modifier_indices[MOD_IDX_LOGO] = xkb_keymap_mod_get_index(client->keymap, XKB_MOD_NAME_LOGO);
-    client->modifier_indices[MOD_IDX_ALTGR] = xkb_keymap_mod_get_index(client->keymap, "Mod5");
-    client->modifier_indices[MOD_IDX_NUMLK] = xkb_keymap_mod_get_index(client->keymap, "NumLock");
-    client->modifier_indices[MOD_IDX_ALSO_ALT] = xkb_keymap_mod_get_index(client->keymap, "Alt");
-    client->modifier_indices[MOD_IDX_LVL3] = xkb_keymap_mod_get_index(client->keymap, "LevelThree");
-    client->modifier_indices[MOD_IDX_LALT] = xkb_keymap_mod_get_index(client->keymap, "LAlt");
-    client->modifier_indices[MOD_IDX_RALT] = xkb_keymap_mod_get_index(client->keymap, "RAlt");
-    client->modifier_indices[MOD_IDX_RCONTROL] = xkb_keymap_mod_get_index(client->keymap, "RControl");
-    client->modifier_indices[MOD_IDX_LCONTROL] = xkb_keymap_mod_get_index(client->keymap, "LControl");
-    client->modifier_indices[MOD_IDX_SCROLLLK] = xkb_keymap_mod_get_index(client->keymap, "ScrollLock");
-    client->modifier_indices[MOD_IDX_LVL5] = xkb_keymap_mod_get_index(client->keymap, "LevelFive");
-    client->modifier_indices[MOD_IDX_ALSO_ALTGR] = xkb_keymap_mod_get_index(client->keymap, "AltGr");
-    client->modifier_indices[MOD_IDX_META] = xkb_keymap_mod_get_index(client->keymap, "Meta");
-    client->modifier_indices[MOD_IDX_SUPER] = xkb_keymap_mod_get_index(client->keymap, "Super");
-    client->modifier_indices[MOD_IDX_HYPER] = xkb_keymap_mod_get_index(client->keymap, "Hyper");
-
-    /*
-    for (xkb_mod_index_t i = 0;
-         i < xkb_keymap_num_mods(client->keymap);
-         i++) {
-        g_log("squeek", G_LOG_LEVEL_DEBUG, "%s", xkb_keymap_mod_get_name(client->keymap, i));
-    }*/
-}
-
-static void
-send_fake_key (SeatEmitter *emitter,
-               LevelKeyboard *keyboard,
-               guint    keycode,
-               gboolean pressed,
-               uint32_t timestamp)
-{
-    zwp_virtual_keyboard_v1_modifiers(emitter->virtual_keyboard, 0, 0, 0, 0);
-    send_virtual_keyboard_key (emitter->virtual_keyboard, keycode - 8, (unsigned)pressed, timestamp);
-    zwp_virtual_keyboard_v1_modifiers(emitter->virtual_keyboard, 0, 0, 0, 0);
-}
-
-void
-emit_key_activated (EekboardContextService *manager,
-                    LevelKeyboard     *keyboard,
-                    guint            keycode,
-                    gboolean pressed,
-                    uint32_t timestamp)
-{
-    /* FIXME: figure out how to deal with Client after key presses go through
-    if (g_strcmp0 (eek_symbol_get_name (symbol), "cycle-keyboard") == 0) {
-        client->keyboards_head = g_slist_next (client->keyboards_head);
-        if (client->keyboards_head == NULL)
-            client->keyboards_head = client->keyboards;
-        eekboard_context_set_keyboard (client->context,
-                                       GPOINTER_TO_UINT(client->keyboards_head->data),
-                                       NULL);
-        return;
-    }
-
-    if (g_strcmp0 (eek_symbol_get_name (symbol), "preferences") == 0) {
-        gchar *argv[2];
-        GError *error;
-
-        argv[0] = g_build_filename (LIBEXECDIR, "eekboard-setup", NULL);
-        argv[1] = NULL;
-
-        error = NULL;
-        if (!g_spawn_async (NULL, argv, NULL, 0, NULL, NULL, NULL, &error)) {
-            g_warning ("can't spawn %s: %s", argv[0], error->message);
-            g_error_free (error);
-        }
-        g_free (argv[0]);
-        return;
-    }
-*/
-    SeatEmitter emitter = {0};
-    emitter.virtual_keyboard = manager->virtual_keyboard;
-    update_modifier_info (&emitter);
-    send_fake_key (&emitter, keyboard, keycode, pressed, timestamp);
-}

eekboard/key-emitter.h

@@ -1,45 +0,0 @@
-#ifndef KEYEMITTER_H
-#define KEYEMITTER_H
-
-#include <inttypes.h>
-#include <glib.h>
-
-#include "eek/eek.h"
-
-#include "virtual-keyboard-unstable-v1-client-protocol.h"
-
-/// Indices obtained by xkb_keymap_mod_get_name
-enum mod_indices {
-    MOD_IDX_SHIFT,
-    MOD_IDX_CAPS,
-    MOD_IDX_CTRL,
-    MOD_IDX_ALT,
-    MOD_IDX_NUM,
-    MOD_IDX_MOD3,
-    MOD_IDX_LOGO,
-    MOD_IDX_ALTGR,
-    MOD_IDX_NUMLK, // Caution, not sure which is the right one
-    MOD_IDX_ALSO_ALT, // Not sure why, alt emits the first alt on my setup
-    MOD_IDX_LVL3,
-
-    // Not sure if the next 4 are used at all
-    MOD_IDX_LALT,
-    MOD_IDX_RALT,
-    MOD_IDX_RCONTROL,
-    MOD_IDX_LCONTROL,
-
-    MOD_IDX_SCROLLLK,
-    MOD_IDX_LVL5,
-    MOD_IDX_ALSO_ALTGR, // Not used on my layout
-    MOD_IDX_META,
-    MOD_IDX_SUPER,
-    MOD_IDX_HYPER,
-
-    MOD_IDX_LAST,
-};
-
-void
-emit_key_activated (EekboardContextService *manager, LevelKeyboard *keyboard,
-                    guint            keycode,
-                    gboolean pressed, uint32_t timestamp);
-#endif // KEYEMITTER_H

meson.build

@@ -1,7 +1,7 @@
 project(
     'squeekboard',
     'c', 'rust',
-    version: '1.5.0',
+    version: '1.8.0',
     license: 'GPLv3',
     meson_version: '>=0.51.0',
     default_options: [
@@ -40,6 +40,7 @@ else
 endif
 
 prefix = get_option('prefix')
+bindir = join_paths(prefix, get_option('bindir'))
 datadir = join_paths(prefix, get_option('datadir'))
 pkgdatadir = join_paths(datadir, meson.project_name())
 if get_option('depdatadir') == ''
@@ -65,6 +66,6 @@ cargo_build = find_program('cargo_build.sh')
 
 subdir('data')
 subdir('protocols')
-subdir('eek')
 subdir('src')
+subdir('tools')
 subdir('tests')

squeekboard.doap

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Project xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns="http://usefulinc.com/ns/doap#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns:admin="http://webns.net/mvcb/">
+ <name>squeekboard</name>
+ <shortdesc>A Wayland virtual keyboard</shortdesc>
+ <description>A virtual keyboard supporting Wayland, built primarily for the Librem 5 phone.</description>
+ <homepage rdf:resource="https://source.puri.sm/Librem5/squeekboard" />
+ <bug-database rdf:resource="https://source.puri.sm/Librem5/squeekboard/issues" />
+ <os>Linux</os>
+ <license rdf:resource="http://usefulinc.com/doap/licenses/gpl" />
+ <maintainer>
+  <foaf:Person>
+     <foaf:name>Dorota Czaplejewicz</foaf:name>
+     <foaf:mbox rdf:resource="mailto:dorota.czaplejewicz@puri.sm" />
+  </foaf:Person>
+ </maintainer>
+ 
+</Project>

src/action.rs

@@ -6,12 +6,15 @@ use std::ffi::CString;
 #[derive(Debug, Clone, PartialEq)]
 pub struct KeySym(pub String);
 
-/// Use to switch layouts
+/// Use to switch views
-type Level = String;
+type View = String;
 
 /// Use to send modified keypresses
-#[derive(Debug, Clone, PartialEq)]
+#[derive(Debug, Clone, PartialEq, Eq, Hash)]
 pub enum Modifier {
+    /// Control and Alt are the only modifiers
+    /// which doesn't interfere with levels,
+    /// so it's simple to implement as levels are deprecated in squeekboard.
     Control,
     Alt,
 }
@@ -20,21 +23,40 @@ pub enum Modifier {
 #[derive(Debug, Clone, PartialEq)]
 pub enum Action {
     /// Switch to this view
-    SetLevel(Level),
+    SetView(View),
     /// Switch to a view and latch
-    LockLevel {
+    LockView {
-        lock: Level,
+        lock: View,
         /// When unlocked by pressing it or emitting a key
-        unlock: Level,
+        unlock: View,
     },
-    /// Set this modifier TODO: release?
+    /// Hold this modifier for as long as the button is pressed
-    SetModifier(Modifier),
+    ApplyModifier(Modifier),
     /// Submit some text
     Submit {
-        /// Text to submit with input-method
+        /// Text to submit with input-method.
+        /// If None, then keys are to be submitted instead.
         text: Option<CString>,
         /// The key events this symbol submits when submitting text is not possible
         keys: Vec<KeySym>,
     },
+    /// Erase a position behind the cursor
+    Erase,
     ShowPreferences,
 }
+
+impl Action {
+    pub fn is_locked(&self, view_name: &str) -> bool {
+        match self {
+            Action::LockView { lock, unlock: _ } => lock == view_name,
+            _ => false,
+        }
+    }
+    pub fn is_active(&self, view_name: &str) -> bool {
+        match self {
+            Action::SetView(view) => view == view_name,
+            Action::LockView { lock, unlock: _ } => lock == view_name,
+            _ => false,
+        }
+    }
+}

src/data.rs

@@ -15,23 +15,24 @@ use std::vec::Vec;
 
 use xkbcommon::xkb;
 
+use ::action;
 use ::keyboard::{
     KeyState, PressType,
     generate_keymap, generate_keycodes, FormattingError
 };
 use ::layout;
 use ::layout::ArrangementKind;
+use ::logging;
 use ::resources;
 use ::util::c::as_str;
 use ::util::hash_map_map;
 use ::xdg;
 
 // traits, derives
+use serde::Deserialize;
 use std::io::BufReader;
 use std::iter::FromIterator;
-use serde::Deserialize;
+use ::logging::Warn;
-use util::WarningHandler;
-
 
 /// Gathers stuff defined in C or called by C
 pub mod c {
@@ -154,18 +155,10 @@ fn list_layout_sources(
     ret
 }
 
-struct PrintWarnings;
-
-impl WarningHandler for PrintWarnings {
-    fn handle(&mut self, warning: &str) {
-        println!("{}", warning);
-    }
-}
-
 fn load_layout_data(source: DataSource)
     -> Result<::layout::LayoutData, LoadError>
 {
-    let handler = PrintWarnings{};
+    let handler = logging::Print {};
     match source {
         DataSource::File(path) => {
             Layout::from_file(path.clone())
@@ -198,16 +191,21 @@ fn load_layout_data_with_fallback(
                 (
                     LoadError::BadData(Error::Missing(e)),
                     DataSource::File(file)
-                ) => eprintln!( // TODO: print in debug logging level
+                ) => log_print!(
+                    logging::Level::Debug,
                     "Tried file {:?}, but it's missing: {}",
                     file, e
                 ),
-                (e, source) => eprintln!(
+                (e, source) => log_print!(
+                    logging::Level::Warning,
                     "Failed to load layout from {}: {}, skipping",
                     source, e
                 ),
             },
-            Ok(layout) => return (kind, layout),
+            Ok(layout) => {
+                log_print!(logging::Level::Info, "Loaded layout {}", source);
+                return (kind, layout);
+            }
         }
     }
 
@@ -242,14 +240,20 @@ type ButtonIds = String;
 #[derive(Debug, Default, Deserialize, PartialEq)]
 #[serde(deny_unknown_fields)]
 struct ButtonMeta {
-    /// Special action to perform on activation. Conflicts with keysym, text.
+    // TODO: structure (action, keysym, text, modifier) as an enum
+    // to detect conflicts and missing values at compile time
+    /// Special action to perform on activation.
+    /// Conflicts with keysym, text, modifier.
     action: Option<Action>,
     /// The name of the XKB keysym to emit on activation.
-    /// Conflicts with action, text
+    /// Conflicts with action, text, modifier.
     keysym: Option<String>,
     /// The text to submit on activation. Will be derived from ID if not present
-    /// Conflicts with action, keysym
+    /// Conflicts with action, keysym, modifier.
     text: Option<String>,
+    /// The modifier to apply while the key is locked
+    /// Conflicts with action, keysym, text
+    modifier: Option<Modifier>,
     /// If not present, will be derived from text or the button ID
     label: Option<String>,
     /// Conflicts with label
@@ -267,6 +271,23 @@ enum Action {
     SetView(String),
     #[serde(rename="show_prefs")]
     ShowPrefs,
+    /// Remove last character
+    #[serde(rename="erase")]
+    Erase,
+}
+
+#[derive(Debug, Clone, PartialEq, Deserialize)]
+#[serde(deny_unknown_fields)]
+enum Modifier {
+    Control,
+    Shift,
+    Lock,
+    #[serde(alias="Mod1")]
+    Alt,
+    Mod2,
+    Mod3,
+    Mod4,
+    Mod5,
 }
 
 #[derive(Debug, Clone, Deserialize, PartialEq)]
@@ -338,7 +359,7 @@ impl Layout {
         serde_yaml::from_reader(infile).map_err(Error::Yaml)
     }
 
-    pub fn build<H: WarningHandler>(self, mut warning_handler: H)
+    pub fn build<H: logging::Handler>(self, mut warning_handler: H)
         -> (Result<::layout::LayoutData, FormattingError>, H)
     {
         let button_names = self.views.values()
@@ -389,13 +410,16 @@ impl Layout {
                             )
                     }).collect()
                 },
+                action::Action::Erase => vec![
+                    *keymap.get("BackSpace")
+                        .expect(&format!("BackSpace missing from keymap")),
+                ],
                 _ => Vec::new(),
             };
             (
                 name.into(),
                 KeyState {
                     pressed: PressType::Released,
-                    locked: false,
                     keycodes,
                     action,
                 }
@@ -420,8 +444,8 @@ impl Layout {
             )}
         );
 
-        let views = HashMap::from_iter(
+        let views: Vec<_> = self.views.iter()
-            self.views.iter().map(|(name, view)| {
+            .map(|(name, view)| {
                 let rows = view.iter().map(|row| {
                     let buttons = row.split_ascii_whitespace()
                         .map(|name| {
@@ -435,8 +459,7 @@ impl Layout {
                                 &mut warning_handler,
                             ))
                         });
-                    ::layout::Row {
+                    layout::Row {
-                        angle: 0,
                         buttons: add_offsets(
                             buttons,
                             |button| button.size.width,
@@ -449,9 +472,26 @@ impl Layout {
                     name.clone(),
                     layout::View::new(rows)
                 )
-            })
+            }).collect();
+
+        // Center views on the same point.
+        let views = {
+            let total_size = layout::View::calculate_super_size(
+                views.iter().map(|(_name, view)| view).collect()
             );
 
+            HashMap::from_iter(views.into_iter().map(|(name, view)| (
+                name,
+                (
+                    layout::c::Point {
+                        x: (total_size.width - view.get_width()) / 2.0,
+                        y: (total_size.height - view.get_height()) / 2.0,
+                    },
+                    view,
+                ),
+            )))
+        };
+
         (
             Ok(::layout::LayoutData {
                 views: views,
@@ -472,7 +512,7 @@ impl Layout {
     }
 }
 
-fn create_action<H: WarningHandler>(
+fn create_action<H: logging::Handler>(
     button_info: &HashMap<String, ButtonMeta>,
     name: &str,
     view_names: Vec<&String>,
@@ -490,27 +530,35 @@ fn create_action<H: WarningHandler>(
         Action(Action),
         Text(String),
         Keysym(String),
+        Modifier(Modifier),
     };
     
     let submission = match (
         &symbol_meta.action,
         &symbol_meta.keysym,
-        &symbol_meta.text
+        &symbol_meta.text,
+        &symbol_meta.modifier,
     ) {
-        (Some(action), None, None) => SubmitData::Action(action.clone()),
+        (Some(action), None, None, None) => SubmitData::Action(action.clone()),
-        (None, Some(keysym), None) => SubmitData::Keysym(keysym.clone()),
+        (None, Some(keysym), None, None) => SubmitData::Keysym(keysym.clone()),
-        (None, None, Some(text)) => SubmitData::Text(text.clone()),
+        (None, None, Some(text), None) => SubmitData::Text(text.clone()),
-        (None, None, None) => SubmitData::Text(name.into()),
+        (None, None, None, Some(modifier)) => {
+            SubmitData::Modifier(modifier.clone())
+        },
+        (None, None, None, None) => SubmitData::Text(name.into()),
         _ => {
-            warning_handler.handle(&format!(
+            warning_handler.handle(
-                "Button {} has more than one of (action, keysym, text)",
+                logging::Level::Warning,
-                name
+                &format!(
-            ));
+                    "Button {} has more than one of (action, keysym, text, modifier)",
+                    name,
+                ),
+            );
             SubmitData::Text("".into())
         },
     };
 
-    fn filter_view_name<H: WarningHandler>(
+    fn filter_view_name<H: logging::Handler>(
         button_name: &str,
         view_name: String,
         view_names: &Vec<&String>,
@@ -519,10 +567,13 @@ fn create_action<H: WarningHandler>(
         if view_names.contains(&&view_name) {
             view_name
         } else {
-            warning_handler.handle(&format!("Button {} switches to missing view {}",
+            warning_handler.handle(
+                logging::Level::Warning,
+                &format!("Button {} switches to missing view {}",
                     button_name,
                     view_name,
-            ));
+                ),
+            );
             "base".into()
         }
     }
@@ -530,7 +581,7 @@ fn create_action<H: WarningHandler>(
     match submission {
         SubmitData::Action(
             Action::SetView(view_name)
-        ) => ::action::Action::SetLevel(
+        ) => ::action::Action::SetView(
             filter_view_name(
                 name, view_name.clone(), &view_names,
                 warning_handler,
@@ -538,7 +589,7 @@ fn create_action<H: WarningHandler>(
         ),
         SubmitData::Action(Action::Locking {
             lock_view, unlock_view
-        }) => ::action::Action::LockLevel {
+        }) => ::action::Action::LockView {
             lock: filter_view_name(
                 name,
                 lock_view.clone(),
@@ -555,33 +606,31 @@ fn create_action<H: WarningHandler>(
         SubmitData::Action(
             Action::ShowPrefs
         ) => ::action::Action::ShowPreferences,
+        SubmitData::Action(Action::Erase) => action::Action::Erase,
         SubmitData::Keysym(keysym) => ::action::Action::Submit {
             text: None,
             keys: vec!(::action::KeySym(
                 match keysym_valid(keysym.as_str()) {
                     true => keysym.clone(),
                     false => {
-                        warning_handler.handle(&format!(
+                        warning_handler.handle(
+                            logging::Level::Warning,
+                            &format!(
                                 "Keysym name invalid: {}",
                                 keysym,
-                        ));
+                            ),
+                        );
                         "space".into() // placeholder
                     },
                 }
             )),
         },
         SubmitData::Text(text) => ::action::Action::Submit {
-            text: {
+            text: CString::new(text.clone()).or_warn(
-                CString::new(text.clone())
+                warning_handler,
-                    .map_err(|e| {
+                logging::Problem::Warning,
-                        warning_handler.handle(&format!(
+                &format!("Text {} contains problems", text),
-                            "Text {} contains problems: {:?}",
+            ),
-                            text,
-                            e
-                        ));
-                        e
-                    }).ok()
-            },
             keys: text.chars().map(|codepoint| {
                 let codepoint_string = codepoint.to_string();
                 ::action::KeySym(match keysym_valid(codepoint_string.as_str()) {
@@ -589,13 +638,33 @@ fn create_action<H: WarningHandler>(
                     false => format!("U{:04X}", codepoint as u32),
                 })
             }).collect(),
+        },
+        SubmitData::Modifier(modifier) => match modifier {
+            Modifier::Control => action::Action::ApplyModifier(
+                action::Modifier::Control,
+            ),
+            Modifier::Alt => action::Action::ApplyModifier(
+                action::Modifier::Alt,
+            ),
+            unsupported_modifier => {
+                warning_handler.handle(
+                    logging::Level::Bug,
+                    &format!(
+                        "Modifier {:?} unsupported", unsupported_modifier,
+                    ),
+                );
+                action::Action::Submit {
+                    text: None,
+                    keys: Vec::new(),
                 }
+            },
+        },
     }
 }
 
 /// TODO: Since this will receive user-provided data,
 /// all .expect() on them should be turned into soft fails
-fn create_button<H: WarningHandler>(
+fn create_button<H: logging::Handler>(
     button_info: &HashMap<String, ButtonMeta>,
     outlines: &HashMap<String, Outline>,
     name: &str,
@@ -619,14 +688,11 @@ fn create_button<H: WarningHandler>(
     } else if let Some(text) = &button_meta.text {
         ::layout::Label::Text(
             CString::new(text.as_str())
-                .unwrap_or_else(|e| {
+                .or_warn(
-                    warning_handler.handle(&format!(
+                    warning_handler,
-                        "Text {} is invalid: {}",
+                    logging::Problem::Warning,
-                        text,
+                    &format!("Text {} is invalid", text),
-                        e,
+                ).unwrap_or_else(|| CString::new("").unwrap())
-                    ));
-                    CString::new("").unwrap()
-                })
         )
     } else {
         ::layout::Label::Text(cname.clone())
@@ -637,7 +703,10 @@ fn create_button<H: WarningHandler>(
             if outlines.contains_key(outline) {
                 outline.clone()
             } else {
-                warning_handler.handle(&format!("Outline named {} does not exist! Using default for button {}", outline, name));
+                warning_handler.handle(
+                    logging::Level::Warning,
+                    &format!("Outline named {} does not exist! Using default for button {}", outline, name)
+                );
                 "default".into()
             }
         }
@@ -646,12 +715,11 @@ fn create_button<H: WarningHandler>(
 
     let outline = outlines.get(&outline_name)
         .map(|outline| (*outline).clone())
-        .unwrap_or_else(|| {
+        .or_warn(
-            warning_handler.handle(
+            warning_handler,
-                &format!("No default outline defined! Using 1x1!")
+            logging::Problem::Warning,
-            );
+            "No default outline defined! Using 1x1!",
-            Outline { width: 1f64, height: 1f64 }
+        ).unwrap_or(Outline { width: 1f64, height: 1f64 });
-        });
 
     layout::Button {
         name: cname,
@@ -671,14 +739,7 @@ mod tests {
     use super::*;
     
     use std::error::Error as ErrorTrait;
-
+    use ::logging::ProblemPanic;
-    struct PanicWarn;
-    
-    impl WarningHandler for PanicWarn {
-        fn handle(&mut self, warning: &str) {
-            panic!("{}", warning);
-        }
-    }
 
     #[test]
     fn test_parse_path() {
@@ -695,6 +756,7 @@ mod tests {
                         keysym: None,
                         action: None,
                         text: None,
+                        modifier: None,
                         label: Some("test".into()),
                         outline: None,
                     }
@@ -748,10 +810,10 @@ mod tests {
     fn test_layout_punctuation() {
         let out = Layout::from_file(PathBuf::from("tests/layout_key1.yaml"))
             .unwrap()
-            .build(PanicWarn).0
+            .build(ProblemPanic).0
             .unwrap();
         assert_eq!(
-            out.views["base"]
+            out.views["base"].1
                 .get_rows()[0].1
                 .buttons[0].1
                 .label,
@@ -763,10 +825,10 @@ mod tests {
     fn test_layout_unicode() {
         let out = Layout::from_file(PathBuf::from("tests/layout_key2.yaml"))
             .unwrap()
-            .build(PanicWarn).0
+            .build(ProblemPanic).0
             .unwrap();
         assert_eq!(
-            out.views["base"]
+            out.views["base"].1
                 .get_rows()[0].1
                 .buttons[0].1
                 .label,
@@ -779,10 +841,10 @@ mod tests {
     fn test_layout_unicode_multi() {
         let out = Layout::from_file(PathBuf::from("tests/layout_key3.yaml"))
             .unwrap()
-            .build(PanicWarn).0
+            .build(ProblemPanic).0
             .unwrap();
         assert_eq!(
-            out.views["base"]
+            out.views["base"].1
                 .get_rows()[0].1
                 .buttons[0].1
                 .state.borrow()
@@ -794,7 +856,7 @@ mod tests {
     #[test]
     fn parsing_fallback() {
         assert!(Layout::from_resource(FALLBACK_LAYOUT_NAME)
-            .map(|layout| layout.build(PanicWarn).0.unwrap())
+            .map(|layout| layout.build(ProblemPanic).0.unwrap())
             .is_ok()
         );
     }
@@ -836,13 +898,14 @@ mod tests {
                         keysym: None,
                         text: None,
                         action: None,
+                        modifier: None,
                         label: Some("test".into()),
                         outline: None,
                     }
                 },
                 ".",
                 Vec::new(),
-                &mut PanicWarn,
+                &mut ProblemPanic,
             ),
             ::action::Action::Submit {
                 text: Some(CString::new(".").unwrap()),
@@ -855,7 +918,7 @@ mod tests {
     fn test_layout_margins() {
         let out = Layout::from_file(PathBuf::from("tests/layout_margins.yaml"))
             .unwrap()
-            .build(PanicWarn).0
+            .build(ProblemPanic).0
             .unwrap();
         assert_eq!(
             out.margins,

src/dbus.c

@@ -0,0 +1,124 @@
+/*
+ * Copyright (C) 2010-2011 Daiki Ueno <ueno@unixuser.org>
+ * Copyright (C) 2010-2011 Red Hat, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "config.h"
+
+#include "dbus.h"
+
+#include <stdio.h>
+#include <gio/gio.h>
+
+void
+dbus_handler_destroy(DBusHandler *service)
+{
+    g_free (service->object_path);
+
+    if (service->connection) {
+        if (service->registration_id > 0) {
+            g_dbus_connection_unregister_object (service->connection,
+                                                 service->registration_id);
+            service->registration_id = 0;
+        }
+
+        g_object_unref (service->connection);
+        service->connection = NULL;
+    }
+
+    if (service->introspection_data) {
+        g_dbus_node_info_unref (service->introspection_data);
+        service->introspection_data = NULL;
+    }
+
+    if (service->context) {
+        g_signal_handlers_disconnect_by_data (service->context, service);
+        service->context = NULL;
+    }
+
+    free(service);
+}
+
+static gboolean
+handle_set_visible(SmPuriOSK0 *object, GDBusMethodInvocation *invocation,
+                   gboolean arg_visible, gpointer user_data) {
+    DBusHandler *service = user_data;
+
+    if (service->context) {
+        if (arg_visible) {
+            server_context_service_show_keyboard (service->context);
+        } else {
+            server_context_service_hide_keyboard (service->context);
+        }
+    }
+    sm_puri_osk0_complete_set_visible(object, invocation);
+    return TRUE;
+}
+
+static void on_visible(DBusHandler *service,
+                       GParamSpec *pspec,
+                       ServerContextService *context)
+{
+    (void)pspec;
+    gboolean visible;
+
+    g_return_if_fail (SERVER_IS_CONTEXT_SERVICE (context));
+
+    g_object_get (context, "visible", &visible, NULL);
+
+    sm_puri_osk0_set_visible(service->dbus_interface, visible);
+}
+
+DBusHandler *
+dbus_handler_new (GDBusConnection *connection,
+                      const gchar     *object_path)
+{
+    DBusHandler *self = calloc(1, sizeof(DBusHandler));
+    self->object_path = g_strdup(object_path);
+    self->connection = connection;
+
+    self->dbus_interface = sm_puri_osk0_skeleton_new();
+    g_signal_connect(self->dbus_interface, "handle-set-visible",
+                     G_CALLBACK(handle_set_visible), self);
+
+    if (self->connection && self->object_path) {
+        GError *error = NULL;
+
+        if (!g_dbus_interface_skeleton_export(G_DBUS_INTERFACE_SKELETON(self->dbus_interface),
+                                              self->connection,
+                                              self->object_path,
+                                              &error)) {
+            g_warning("Error registering dbus object: %s\n", error->message);
+            g_clear_error(&error);
+            // TODO: return an error
+        }
+    }
+    return self;
+}
+
+void
+dbus_handler_set_ui_context(DBusHandler *service,
+                             ServerContextService *context)
+{
+    g_return_if_fail (!service->context);
+
+    service->context = context;
+
+    g_signal_connect_swapped (service->context,
+                              "notify::visible",
+                              G_CALLBACK(on_visible),
+                              service);
+}

src/dbus.h

@@ -0,0 +1,48 @@
+/* 
+ * Copyright (C) 2010-2011 Daiki Ueno <ueno@unixuser.org>
+ * Copyright (C) 2010-2011 Red Hat, Inc.
+ * Copyright (C) 2019-2020 Purism, SPC
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#ifndef DBUS_H_
+#define DBUS_H_ 1
+
+#include "server-context-service.h"
+
+#include "sm.puri.OSK0.h"
+
+G_BEGIN_DECLS
+
+#define DBUS_SERVICE_PATH "/sm/puri/OSK0"
+#define DBUS_SERVICE_INTERFACE "sm.puri.OSK0"
+
+typedef struct _DBusHandler
+{
+    GDBusConnection *connection;
+    SmPuriOSK0 *dbus_interface;
+    GDBusNodeInfo *introspection_data;
+    guint registration_id;
+    char *object_path;
+
+    ServerContextService *context; // unowned reference
+} DBusHandler;
+
+DBusHandler * dbus_handler_new      (GDBusConnection *connection,
+                                             const gchar     *object_path);
+void              dbus_handler_set_ui_context(DBusHandler *service,
+                                               ServerContextService *context);
+void dbus_handler_destroy(DBusHandler*);
+G_END_DECLS
+#endif  /* DBUS_H_ */

src/drawing.rs

@@ -3,9 +3,11 @@
 use cairo;
 use std::cell::RefCell;
 
+use ::action::Action;
 use ::keyboard;
 use ::layout::{ Button, Layout };
 use ::layout::c::{ EekGtkKeyboard, Point };
+use ::submission::Submission;
 
 use glib::translate::FromGlibPtrNone;
 use gtk::WidgetExt;
@@ -37,30 +39,37 @@ mod c {
         );
     }
 
+    /// Draws all buttons that are not in the base state
     #[no_mangle]
     pub extern "C"
     fn squeek_layout_draw_all_changed(
         layout: *mut Layout,
         renderer: EekRenderer,
         cr: *mut cairo_sys::cairo_t,
+        submission: *const Submission,
     ) {
         let layout = unsafe { &mut *layout };
+        let submission = unsafe { &*submission };
         let cr = unsafe { cairo::Context::from_raw_none(cr) };
+        let active_modifiers = submission.get_active_modifiers();
 
-        let view = layout.get_current_view();
+        layout.foreach_visible_button(|offset, button| {
-        for (row_offset, row) in &view.get_rows() {
-            for (x_offset, button) in &row.buttons {
             let state = RefCell::borrow(&button.state).clone();
-                if state.pressed == keyboard::PressType::Pressed || state.locked {
+            let active_mod = match &state.action {
+                Action::ApplyModifier(m) => active_modifiers.contains(m),
+                _ => false,
+            };
+            let locked = state.action.is_active(&layout.current_view)
+                | active_mod;
+            if state.pressed == keyboard::PressType::Pressed || locked {
                 render_button_at_position(
                     renderer, &cr,
-                        row_offset + Point { x: *x_offset, y: 0.0 },
+                    offset,
                     button.as_ref(),
-                        state.pressed, state.locked,
+                    state.pressed, locked,
                 );
             }
-            }
+        })
-        }
     }
     
     #[no_mangle]
@@ -72,17 +81,15 @@ mod c {
     ) {
         let layout = unsafe { &mut *layout };
         let cr = unsafe { cairo::Context::from_raw_none(cr) };
-        let view = layout.get_current_view();
+        
-        for (row_offset, row) in &view.get_rows() {
+        layout.foreach_visible_button(|offset, button| {
-            for (x_offset, button) in &row.buttons {
             render_button_at_position(
                 renderer, &cr,
-                    row_offset + Point { x: *x_offset, y: 0.0 },
+                offset,
                 button.as_ref(),
                 keyboard::PressType::Released, false,
             );
-            }
+        })
-        }
     }
 }
 

src/imservice.c

@@ -1,9 +1,17 @@
-#include "imservice.h"
+#include "submission.h"
 
 #include <glib.h>
 
-#include "eekboard/eekboard-context-service.h"
+struct imservice;
 
+void imservice_handle_input_method_activate(void *data, struct zwp_input_method_v2 *input_method);
+void imservice_handle_input_method_deactivate(void *data, struct zwp_input_method_v2 *input_method);
+void imservice_handle_surrounding_text(void *data, struct zwp_input_method_v2 *input_method,
+                                       const char *text, uint32_t cursor, uint32_t anchor);
+void imservice_handle_done(void *data, struct zwp_input_method_v2 *input_method);
+void imservice_handle_content_type(void *data, struct zwp_input_method_v2 *input_method, uint32_t hint, uint32_t purpose);
+void imservice_handle_text_change_cause(void *data, struct zwp_input_method_v2 *input_method, uint32_t cause);
+void imservice_handle_unavailable(void *data, struct zwp_input_method_v2 *input_method);
 
 static const struct zwp_input_method_v2_listener input_method_listener = {
     .activate = imservice_handle_input_method_activate,
@@ -11,29 +19,51 @@ static const struct zwp_input_method_v2_listener input_method_listener = {
     .surrounding_text = imservice_handle_surrounding_text,
     .text_change_cause = imservice_handle_text_change_cause,
     .content_type = imservice_handle_content_type,
-    .done = imservice_handle_commit_state,
+    .done = imservice_handle_done,
     .unavailable = imservice_handle_unavailable,
 };
 
-struct imservice* get_imservice(EekboardContextService *context,
+struct submission* get_submission(struct zwp_input_method_manager_v2 *immanager,
-                                struct zwp_input_method_manager_v2 *manager,
+                                  struct zwp_virtual_keyboard_manager_v1 *vkmanager,
+                                  struct wl_seat *seat,
+                                  LayoutHolder *state) {
+    struct zwp_input_method_v2 *im = NULL;
+    if (immanager) {
+        im = zwp_input_method_manager_v2_get_input_method(immanager, seat);
+    }
+    struct zwp_virtual_keyboard_v1 *vk = NULL;
+    if (vkmanager) {
+        vk = zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(vkmanager, seat);
+    }
+    return submission_new(im, vk, state);
+}
+
+/// Un-inlined
+struct zwp_input_method_v2 *imservice_manager_get_input_method(struct zwp_input_method_manager_v2 *manager,
                                    struct wl_seat *seat) {
-    struct zwp_input_method_v2 *im = zwp_input_method_manager_v2_get_input_method(manager, seat);
+    return zwp_input_method_manager_v2_get_input_method(manager, seat);
-    struct imservice *imservice = imservice_new(im, context);
+}
 
-    /* Add a listener, passing the imservice instance to make it available to
+/// Un-inlined to let Rust link to it
-       callbacks. */
+void imservice_connect_listeners(struct zwp_input_method_v2 *im, struct imservice* imservice) {
     zwp_input_method_v2_add_listener(im, &input_method_listener, imservice);
-
-    return imservice;
 }
 
-void imservice_make_visible(EekboardContextService *context) {
+void
-    eekboard_context_service_show_keyboard (context);
+eek_input_method_commit_string(struct zwp_input_method_v2 *zwp_input_method_v2, const char *text)
+{
+    zwp_input_method_v2_commit_string(zwp_input_method_v2, text);
 }
 
-void imservice_try_hide(EekboardContextService *context) {
+void
-    eekboard_context_service_hide_keyboard (context);
+eek_input_method_delete_surrounding_text(struct zwp_input_method_v2 *zwp_input_method_v2, uint32_t before_length, uint32_t after_length) {
+    zwp_input_method_v2_delete_surrounding_text(zwp_input_method_v2, before_length, after_length);
+};
+
+void
+eek_input_method_commit(struct zwp_input_method_v2 *zwp_input_method_v2, uint32_t serial)
+{
+    zwp_input_method_v2_commit(zwp_input_method_v2, serial);
 }
 
 /// Declared explicitly because _destroy is inline,

src/imservice.h

@@ -1,25 +0,0 @@
-#ifndef __IMSERVICE_H
-#define __IMSERVICE_H
-
-#include "input-method-unstable-v2-client-protocol.h"
-#include "eek/eek-types.h"
-
-struct imservice;
-
-struct imservice* get_imservice(EekboardContextService *context,
-                                struct zwp_input_method_manager_v2 *manager,
-                                struct wl_seat *seat);
-
-// Defined in Rust
-struct imservice* imservice_new(struct zwp_input_method_v2 *im,
-                                EekboardContextService *context);
-void imservice_handle_input_method_activate(void *data, struct zwp_input_method_v2 *input_method);
-void imservice_handle_input_method_deactivate(void *data, struct zwp_input_method_v2 *input_method);
-void imservice_handle_surrounding_text(void *data, struct zwp_input_method_v2 *input_method,
-                                       const char *text, uint32_t cursor, uint32_t anchor);
-void imservice_handle_commit_state(void *data, struct zwp_input_method_v2 *input_method);
-void imservice_handle_content_type(void *data, struct zwp_input_method_v2 *input_method, uint32_t hint, uint32_t purpose);
-void imservice_handle_text_change_cause(void *data, struct zwp_input_method_v2 *input_method, uint32_t cause);
-void imservice_handle_unavailable(void *data, struct zwp_input_method_v2 *input_method);
-
-#endif

src/imservice.rs

@@ -1,12 +1,20 @@
+/*! Manages zwp_input_method_v2 protocol.
+ * 
+ * Library module.
+ */
+
 use std::boxed::Box;
 use std::ffi::CString;
+use std::fmt;
 use std::num::Wrapping;
 use std::string::String;
 
+use ::logging;
 use ::util::c::into_cstring;
 
 // Traits
 use std::convert::TryFrom;
+use ::logging::Warn;
 
 
 /// Gathers stuff defined in C or called by C
@@ -15,44 +23,33 @@ pub mod c {
 
     use std::os::raw::{c_char, c_void};
 
+    pub use ::submission::c::UIManager;
+    pub use ::submission::c::StateManager;
+
     // The following defined in C
         
     /// struct zwp_input_method_v2*
     #[repr(transparent)]
     pub struct InputMethod(*const c_void);
 
-    /// EekboardContextService*
-    #[repr(transparent)]
-    pub struct UIManager(*const c_void);
-    
     #[no_mangle]
     extern "C" {
         fn imservice_destroy_im(im: *mut c::InputMethod);
-        fn eekboard_context_service_set_hint_purpose(imservice: *const UIManager, hint: u32, purpose: u32);
+        #[allow(improper_ctypes)] // IMService will never be dereferenced in C
-        fn eekboard_context_service_show_keyboard(imservice: *const UIManager);
+        pub fn imservice_connect_listeners(im: *mut InputMethod, imservice: *const IMService);
-        fn eekboard_context_service_hide_keyboard(imservice: *const UIManager);
+        pub fn eek_input_method_commit_string(im: *mut InputMethod, text: *const c_char);
+        pub fn eek_input_method_delete_surrounding_text(im: *mut InputMethod, before: u32, after: u32);
+        pub fn eek_input_method_commit(im: *mut InputMethod, serial: u32);
+        fn eekboard_context_service_set_hint_purpose(state: *const StateManager, hint: u32, purpose: u32);
+        fn server_context_service_show_keyboard(imservice: *const UIManager);
+        fn server_context_service_hide_keyboard(imservice: *const UIManager);
     }
     
     // The following defined in Rust. TODO: wrap naked pointers to Rust data inside RefCells to prevent multiple writers
     
-    #[no_mangle]
-    pub unsafe extern "C"
-    fn imservice_new(im: *const InputMethod, ui_manager: *const UIManager) -> *mut IMService {
-        Box::<IMService>::into_raw(Box::new(
-            IMService {
-                im: im,
-                ui_manager: ui_manager,
-                pending: IMProtocolState::default(),
-                current: IMProtocolState::default(),
-                preedit_string: String::new(),
-                serial: Wrapping(0u32),
-            }
-        ))
-    }
-    
     // TODO: is unsafe needed here?
     #[no_mangle]
-    pub unsafe extern "C"
+    pub extern "C"
     fn imservice_handle_input_method_activate(imservice: *mut IMService,
         im: *const InputMethod)
     {
@@ -65,7 +62,7 @@ pub mod c {
     }
     
     #[no_mangle]
-    pub unsafe extern "C"
+    pub extern "C"
     fn imservice_handle_input_method_deactivate(imservice: *mut IMService,
         im: *const InputMethod)
     {
@@ -77,7 +74,7 @@ pub mod c {
     }
     
     #[no_mangle]
-    pub unsafe extern "C"
+    pub extern "C"
     fn imservice_handle_surrounding_text(imservice: *mut IMService,
         im: *const InputMethod,
         text: *const c_char, cursor: u32, _anchor: u32)
@@ -93,7 +90,7 @@ pub mod c {
     }
     
     #[no_mangle]
-    pub unsafe extern "C"
+    pub extern "C"
     fn imservice_handle_content_type(imservice: *mut IMService,
         im: *const InputMethod,
         hint: u32, purpose: u32)
@@ -101,23 +98,27 @@ pub mod c {
         let imservice = check_imservice(imservice, im).unwrap();
         imservice.pending = IMProtocolState {
             content_hint: {
-                ContentHint::from_bits(hint).unwrap_or_else(|| {
+                ContentHint::from_bits(hint)
-                    eprintln!("Warning: received invalid hint flags");
+                    .or_print(
-                    ContentHint::NONE
+                        logging::Problem::Warning,
-                })
+                        "Received invalid hint flags",
+                    )
+                    .unwrap_or(ContentHint::NONE)
             },
             content_purpose: {
-                ContentPurpose::try_from(purpose).unwrap_or_else(|_e| {
+                ContentPurpose::try_from(purpose)
-                    eprintln!("Warning: Received invalid purpose value");
+                    .or_print(
-                    ContentPurpose::Normal
+                        logging::Problem::Warning,
-                })
+                        "Received invalid purpose value",
+                    )
+                    .unwrap_or(ContentPurpose::Normal)
             },
             ..imservice.pending.clone()
         };
     }
     
     #[no_mangle]
-    pub unsafe extern "C"
+    pub extern "C"
     fn imservice_handle_text_change_cause(imservice: *mut IMService,
         im: *const InputMethod,
         cause: u32)
@@ -125,55 +126,67 @@ pub mod c {
         let imservice = check_imservice(imservice, im).unwrap();
         imservice.pending = IMProtocolState {
             text_change_cause: {
-                ChangeCause::try_from(cause).unwrap_or_else(|_e| {
+                ChangeCause::try_from(cause)
-                    eprintln!("Warning: received invalid cause value");
+                    .or_print(
-                    ChangeCause::InputMethod
+                        logging::Problem::Warning,
-                })
+                        "Received invalid cause value",
+                    )
+                    .unwrap_or(ChangeCause::InputMethod)
             },
             ..imservice.pending.clone()
         };
     }
     
     #[no_mangle]
-    pub unsafe extern "C"
+    pub extern "C"
-    fn imservice_handle_commit_state(imservice: *mut IMService,
+    fn imservice_handle_done(imservice: *mut IMService,
         im: *const InputMethod)
     {
         let imservice = check_imservice(imservice, im).unwrap();
         let active_changed = imservice.current.active ^ imservice.pending.active;
 
-        imservice.serial += Wrapping(1u32);
         imservice.current = imservice.pending.clone();
         imservice.pending = IMProtocolState {
             active: imservice.current.active,
             ..IMProtocolState::default()
         };
+
         if active_changed {
             if imservice.current.active {
-                eekboard_context_service_show_keyboard(imservice.ui_manager);
+                if let Some(ui) = imservice.ui_manager {
+                    unsafe { server_context_service_show_keyboard(ui); }
+                }
+                unsafe {
                     eekboard_context_service_set_hint_purpose(
-                    imservice.ui_manager,
+                        imservice.state_manager,
                         imservice.current.content_hint.bits(),
-                    imservice.current.content_purpose.clone() as u32);
+                        imservice.current.content_purpose.clone() as u32,
+                    );
+                }
             } else {
-                eekboard_context_service_hide_keyboard(imservice.ui_manager);
+                if let Some(ui) = imservice.ui_manager {
+                    unsafe { server_context_service_hide_keyboard(ui); }
+                }
             }
         }
     }
     
+    // TODO: this is really untested
     #[no_mangle]
-    pub unsafe extern "C"
+    pub extern "C"
     fn imservice_handle_unavailable(imservice: *mut IMService,
         im: *mut InputMethod)
     {
         let imservice = check_imservice(imservice, im).unwrap();
-        imservice_destroy_im(im);
+        unsafe { imservice_destroy_im(im); }
 
         // no need to care about proper double-buffering,
         // the keyboard is already decommissioned
         imservice.current.active = false;
 
-        eekboard_context_service_hide_keyboard(imservice.ui_manager);
+        if let Some(ui) = imservice.ui_manager {
+            unsafe { server_context_service_hide_keyboard(ui); }
+        }
     }    
 
     // FIXME: destroy and deallocate
@@ -246,10 +259,17 @@ pub enum ContentPurpose {
     Terminal = 13,
 }
 
+// Utilities from ::logging need a printable error type
+pub struct UnrecognizedValue;
+
+impl fmt::Display for UnrecognizedValue {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "Unrecognized value")
+    }
+}
+
 impl TryFrom<u32> for ContentPurpose {
-    // There's only one way to fail: number not in protocol,
+    type Error = UnrecognizedValue;
-    // so no special error type is needed
-    type Error = ();
     fn try_from(num: u32) -> Result<Self, Self::Error> {
         use self::ContentPurpose::*;
         match num {
@@ -267,7 +287,7 @@ impl TryFrom<u32> for ContentPurpose {
             11 => Ok(Time),
             12 => Ok(Datetime),
             13 => Ok(Terminal),
-            _ => Err(()),
+            _ => Err(UnrecognizedValue),
         }
     }
 }
@@ -280,14 +300,12 @@ pub enum ChangeCause {
 }
 
 impl TryFrom<u32> for ChangeCause {
-    // There's only one way to fail: number not in protocol,
+    type Error = UnrecognizedValue;
-    // so no special error type is needed
-    type Error = ();
     fn try_from(num: u32) -> Result<Self, Self::Error> {
         match num {
             0 => Ok(ChangeCause::InputMethod),
             1 => Ok(ChangeCause::Other),
-            _ => Err(())
+            _ => Err(UnrecognizedValue)
         }
     }
 }
@@ -318,12 +336,92 @@ impl Default for IMProtocolState {
 
 pub struct IMService {
     /// Owned reference (still created and destroyed in C)
-    pub im: *const c::InputMethod,
+    pub im: *mut c::InputMethod,
     /// Unowned reference. Be careful, it's shared with C at large
-    ui_manager: *const c::UIManager,
+    state_manager: *const c::StateManager,
+    /// Unowned reference. Be careful, it's shared with C at large
+    pub ui_manager: Option<*const c::UIManager>,
 
     pending: IMProtocolState,
     current: IMProtocolState, // turn current into an idiomatic representation?
     preedit_string: String,
     serial: Wrapping<u32>,
 }
+
+pub enum SubmitError {
+    /// The input method had not been activated
+    NotActive,
+}
+
+impl IMService {
+    pub fn new(
+        im: *mut c::InputMethod,
+        state_manager: *const c::StateManager,
+    ) -> Box<IMService> {
+        // IMService will be referenced to by C,
+        // so it needs to stay in the same place in memory via Box
+        let imservice = Box::new(IMService {
+            im,
+            ui_manager: None,
+            state_manager,
+            pending: IMProtocolState::default(),
+            current: IMProtocolState::default(),
+            preedit_string: String::new(),
+            serial: Wrapping(0u32),
+        });
+        unsafe {
+            c::imservice_connect_listeners(
+                im,
+                imservice.as_ref() as *const IMService,
+            );
+        }
+        imservice
+    }
+    
+    pub fn commit_string(&self, text: &CString) -> Result<(), SubmitError> {
+        match self.current.active {
+            true => {
+                unsafe {
+                    c::eek_input_method_commit_string(self.im, text.as_ptr())
+                }
+                Ok(())
+            },
+            false => Err(SubmitError::NotActive),
+        }
+    }
+
+    pub fn delete_surrounding_text(
+        &self,
+        before: u32, after: u32,
+    ) -> Result<(), SubmitError> {
+        match self.current.active {
+            true => {
+                unsafe {
+                    c::eek_input_method_delete_surrounding_text(
+                        self.im,
+                        before, after,
+                    )
+                }
+                Ok(())
+            },
+            false => Err(SubmitError::NotActive),
+        }
+    }
+
+    pub fn commit(&mut self) -> Result<(), SubmitError> {
+        match self.current.active {
+            true => {
+                unsafe {
+                    c::eek_input_method_commit(self.im, self.serial.0)
+                }
+                self.serial += Wrapping(1u32);
+                Ok(())
+            },
+            false => Err(SubmitError::NotActive),
+        }
+    }
+
+    pub fn is_active(&self) -> bool {
+        self.current.active
+    }
+}

src/keyboard.rs

@@ -1,13 +1,17 @@
 /*! State of the emulated keyboard and keys.
  * Regards the keyboard as if it was composed of switches. */
 
+use std::cell::RefCell;
 use std::collections::HashMap;
 use std::fmt;
 use std::io;
+use std::rc::Rc;
 use std::string::FromUtf8Error;
 
 use ::action::Action;
+use ::logging;
 
+// Traits
 use std::io::Write;
 use std::iter::{ FromIterator, IntoIterator };
 
@@ -17,16 +21,64 @@ pub enum PressType {
     Pressed = 1,
 }
 
+pub type KeyCode = u32;
+
+bitflags!{
+    /// Map to `virtual_keyboard.modifiers` modifiers values
+    /// From https://www.x.org/releases/current/doc/kbproto/xkbproto.html#Keyboard_State
+    pub struct Modifiers: u8 {
+        const SHIFT = 0x1;
+        const LOCK = 0x2;
+        const CONTROL = 0x4;
+        /// Alt
+        const MOD1 = 0x8;
+        const MOD2 = 0x10;
+        const MOD3 = 0x20;
+        /// Meta
+        const MOD4 = 0x40;
+        /// AltGr
+        const MOD5 = 0x80;
+    }
+}
+
+/// When the submitted actions of keys need to be tracked,
+/// they need a stable, comparable ID
+#[derive(PartialEq)]
+pub struct KeyStateId(*const KeyState);
+
 #[derive(Debug, Clone)]
 pub struct KeyState {
     pub pressed: PressType,
-    pub locked: bool,
+    /// A cache of raw keycodes derived from Action::Submit given a keymap
-    /// A cache of raw keycodes derived from Action::Sumbit given a keymap
+    pub keycodes: Vec<KeyCode>,
-    pub keycodes: Vec<u32>,
     /// Static description of what the key does when pressed or released
     pub action: Action,
 }
 
+impl KeyState {
+    #[must_use]
+    pub fn into_released(self) -> KeyState {
+        KeyState {
+            pressed: PressType::Released,
+            ..self
+        }
+    }
+
+    #[must_use]
+    pub fn into_pressed(self) -> KeyState {
+        KeyState {
+            pressed: PressType::Pressed,
+            ..self
+        }
+    }
+
+    /// KeyStates instances are the unique identifiers of pressed keys,
+    /// and the actions submitted with them.
+    pub fn get_id(keystate: &Rc<RefCell<KeyState>>) -> KeyStateId {
+        KeyStateId(keystate.as_ptr() as *const KeyState)
+    }
+}
+
 /// Sorts an iterator by converting it to a Vector and back
 fn sorted<'a, I: Iterator<Item=&'a str>>(
     iter: I
@@ -42,9 +94,10 @@ fn sorted<'a, I: Iterator<Item=&'a str>>(
 pub fn generate_keycodes<'a, C: IntoIterator<Item=&'a str>>(
     key_names: C
 ) -> HashMap<String, u32> {
+    let special_keysyms = ["BackSpace", "Return"].iter().map(|&s| s);
     HashMap::from_iter(
         // sort to remove a source of indeterminism in keycode assignment
-        sorted(key_names.into_iter())
+        sorted(key_names.into_iter().chain(special_keysyms))
             .map(|name| String::from(name))
             .zip(9..)
     )
@@ -71,7 +124,10 @@ impl From<io::Error> for FormattingError {
     }
 }
 
-/// Generates a de-facto single level keymap. TODO: actually drop second level
+/// Generates a de-facto single level keymap.
+// TODO: don't rely on keys and their order,
+// but rather on what keysyms and keycodes are in use.
+// Iterating actions makes it hard to deduplicate keysyms.
 pub fn generate_keymap(
     keystates: &HashMap::<String, KeyState>
 ) -> Result<String, FormattingError> {
@@ -86,8 +142,14 @@ pub fn generate_keymap(
     )?;
     
     for (name, state) in keystates.iter() {
-        if let Action::Submit { text: _, keys } = &state.action {
+        match &state.action {
-            if let 0 = keys.len() { eprintln!("Key {} has no keysyms", name); };
+            Action::Submit { text: _, keys } => {
+                if let 0 = keys.len() {
+                    log_print!(
+                        logging::Level::Warning,
+                        "Key {} has no keysyms", name,
+                    );
+                };
                 for (named_keysym, keycode) in keys.iter().zip(&state.keycodes) {
                     write!(
                         buf,
@@ -97,6 +159,23 @@ pub fn generate_keymap(
                         keycode,
                     )?;
                 }
+            },
+            Action::Erase => {
+                let mut keycodes = state.keycodes.iter();
+                write!(
+                    buf,
+                    "
+        <BackSpace> = {};",
+                    keycodes.next().expect("Erase key has no keycode"),
+                )?;
+                if let Some(_) = keycodes.next() {
+                    log_print!(
+                        logging::Level::Bug,
+                        "Erase key has multiple keycodes",
+                    );
+                }
+            },
+            _ => {},
         }
     }
     
@@ -108,7 +187,9 @@ pub fn generate_keymap(
     xkb_symbols \"squeekboard\" {{
 
         name[Group1] = \"Letters\";
-        name[Group2] = \"Numbers/Symbols\";"
+        name[Group2] = \"Numbers/Symbols\";
+        
+        key <BackSpace> {{ [ BackSpace ] }};"
     )?;
     
     for (name, state) in keystates.iter() {
@@ -166,7 +247,6 @@ mod tests {
                     keys: vec!(KeySym("a".into()), KeySym("c".into())),
                 },
                 keycodes: vec!(9, 10),
-                locked: false,
                 pressed: PressType::Released,
             },
         }).unwrap();

src/layout.h

@@ -7,13 +7,23 @@
 #include "eek/eek-gtk-keyboard.h"
 #include "eek/eek-renderer.h"
 #include "eek/eek-types.h"
+#include "src/submission.h"
 #include "virtual-keyboard-unstable-v1-client-protocol.h"
+#include "text-input-unstable-v3-client-protocol.h"
 
 enum squeek_arrangement_kind {
     ARRANGEMENT_KIND_BASE = 0,
     ARRANGEMENT_KIND_WIDE = 1,
 };
 
+struct squeek_layout_state {
+    enum squeek_arrangement_kind arrangement;
+    enum zwp_text_input_v3_content_purpose purpose;
+    enum zwp_text_input_v3_content_hint hint;
+    char *layout_name;
+    char *overlay_name;
+};
+
 struct squeek_layout;
 
 EekBounds squeek_button_get_bounds(const struct squeek_button*);
@@ -33,19 +43,26 @@ const char *squeek_layout_get_keymap(const struct squeek_layout*);
 enum squeek_arrangement_kind squeek_layout_get_kind(const struct squeek_layout *);
 void squeek_layout_free(struct squeek_layout*);
 
-void squeek_layout_release(struct squeek_layout *layout, struct zwp_virtual_keyboard_v1 *virtual_keyboard,
+void squeek_layout_release(struct squeek_layout *layout,
+                           struct submission *submission,
                            struct transformation widget_to_layout,
                            uint32_t timestamp,
+                           LayoutHolder *manager,
                            EekGtkKeyboard *ui_keyboard);
-void squeek_layout_release_all_only(struct squeek_layout *layout, struct zwp_virtual_keyboard_v1 *virtual_keyboard, uint32_t timestamp);
+void squeek_layout_release_all_only(struct squeek_layout *layout,
-void squeek_layout_depress(struct squeek_layout *layout, struct zwp_virtual_keyboard_v1 *virtual_keyboard,
+                                    struct submission *submission,
+                                    uint32_t timestamp);
+void squeek_layout_depress(struct squeek_layout *layout,
+                           struct submission *submission,
                            double x_widget, double y_widget,
                            struct transformation widget_to_layout,
                            uint32_t timestamp, EekGtkKeyboard *ui_keyboard);
-void squeek_layout_drag(struct squeek_layout *layout, struct zwp_virtual_keyboard_v1 *virtual_keyboard,
+void squeek_layout_drag(struct squeek_layout *layout,
+                        struct submission *submission,
                         double x_widget, double y_widget,
                         struct transformation widget_to_layout,
-                        uint32_t timestamp, EekGtkKeyboard *ui_keyboard);
+                        uint32_t timestamp, LayoutHolder *manager,
-void squeek_layout_draw_all_changed(struct squeek_layout *layout, EekRenderer* renderer, cairo_t     *cr);
+                        EekGtkKeyboard *ui_keyboard);
+void squeek_layout_draw_all_changed(struct squeek_layout *layout, EekRenderer* renderer, cairo_t     *cr, struct submission *submission);
 void squeek_draw_layout_base_view(struct squeek_layout *layout, EekRenderer* renderer, cairo_t     *cr);
 #endif

src/layout.rs

@@ -20,16 +20,21 @@
 use std::cell::RefCell;
 use std::collections::{ HashMap, HashSet };
 use std::ffi::CString;
+use std::fmt;
 use std::rc::Rc;
 use std::vec::Vec;
 
 use ::action::Action;
 use ::drawing;
-use ::keyboard::{ KeyState, PressType };
+use ::keyboard::KeyState;
-use ::submission::{ Timestamp, VirtualKeyboard };
+use ::logging;
+use ::manager;
+use ::submission::{ Submission, SubmitData, Timestamp };
 use ::util::find_max_double;
 
+// Traits
 use std::borrow::Borrow;
+use ::logging::Warn;
 
 /// Gathers stuff defined in C or called by C
 pub mod c {
@@ -143,6 +148,11 @@ pub mod c {
         }
     }
     
+    // This is constructed only in C, no need for warnings
+    #[allow(dead_code)]
+    #[repr(transparent)]
+    pub struct LevelKeyboard(*const c_void);
+
     // The following defined in Rust. TODO: wrap naked pointers to Rust data inside RefCells to prevent multiple writers
 
     #[no_mangle]
@@ -239,64 +249,66 @@ pub mod c {
         unsafe { Box::from_raw(layout) };
     }
 
-    /// Entry points for more complex procedures and algoithms which span multiple modules
+    /// Entry points for more complex procedures and algorithms which span multiple modules
     pub mod procedures {
         use super::*;
 
-        use ::submission::c::ZwpVirtualKeyboardV1;
-
-        // This is constructed only in C, no need for warnings
-        #[allow(dead_code)]
-        #[repr(transparent)]
-        pub struct LevelKeyboard(*const c_void);
-
         /// Release pointer in the specified position
         #[no_mangle]
         pub extern "C"
         fn squeek_layout_release(
             layout: *mut Layout,
-            virtual_keyboard: ZwpVirtualKeyboardV1, // TODO: receive a reference to the backend
+            submission: *mut Submission,
             widget_to_layout: Transformation,
             time: u32,
+            manager: manager::c::Manager,
             ui_keyboard: EekGtkKeyboard,
         ) {
             let time = Timestamp(time);
             let layout = unsafe { &mut *layout };
-            let virtual_keyboard = VirtualKeyboard(virtual_keyboard);
+            let submission = unsafe { &mut *submission };
+            let ui_backend = UIBackend {
+                widget_to_layout,
+                keyboard: ui_keyboard,
+            };
+
             // The list must be copied,
             // because it will be mutated in the loop
             for key in layout.pressed_keys.clone() {
                 let key: &Rc<RefCell<KeyState>> = key.borrow();
                 seat::handle_release_key(
                     layout,
-                    &virtual_keyboard,
+                    submission,
-                    &widget_to_layout,
+                    Some(&ui_backend),
                     time,
-                    ui_keyboard,
+                    Some(manager),
                     key,
                 );
             }
             drawing::queue_redraw(ui_keyboard);
         }
 
-        /// Release all buittons but don't redraw
+        /// Release all buttons but don't redraw
         #[no_mangle]
         pub extern "C"
         fn squeek_layout_release_all_only(
             layout: *mut Layout,
-            virtual_keyboard: ZwpVirtualKeyboardV1, // TODO: receive a reference to the backend
+            submission: *mut Submission,
             time: u32,
         ) {
             let layout = unsafe { &mut *layout };
-            let virtual_keyboard = VirtualKeyboard(virtual_keyboard);
+            let submission = unsafe { &mut *submission };
             // The list must be copied,
             // because it will be mutated in the loop
             for key in layout.pressed_keys.clone() {
                 let key: &Rc<RefCell<KeyState>> = key.borrow();
-                layout.release_key(
+                seat::handle_release_key(
-                    &virtual_keyboard,
+                    layout,
+                    submission,
+                    None, // don't update UI
+                    Timestamp(time),
+                    None, // don't switch layouts
                     &mut key.clone(),
-                    Timestamp(time)
                 );
             }
         }
@@ -305,28 +317,27 @@ pub mod c {
         pub extern "C"
         fn squeek_layout_depress(
             layout: *mut Layout,
-            virtual_keyboard: ZwpVirtualKeyboardV1, // TODO: receive a reference to the backend
+            submission: *mut Submission,
             x_widget: f64, y_widget: f64,
             widget_to_layout: Transformation,
             time: u32,
             ui_keyboard: EekGtkKeyboard,
         ) {
             let layout = unsafe { &mut *layout };
+            let submission = unsafe { &mut *submission };
             let point = widget_to_layout.forward(
                 Point { x: x_widget, y: y_widget }
             );
 
-            let state = {
+            let state = layout.find_button_by_position(point)
-                let view = layout.get_current_view();
+                .map(|place| place.button.state.clone());
-                view.find_button_by_position(point)
-                    .map(|place| place.button.state.clone())
-            };
             
-            if let Some(mut state) = state {
+            if let Some(state) = state {
-                layout.press_key(
+                seat::handle_press_key(
-                    &VirtualKeyboard(virtual_keyboard),
+                    layout,
-                    &mut state,
+                    submission,
                     Timestamp(time),
+                    &state,
                 );
                 // maybe TODO: draw on the display buffer here
                 drawing::queue_redraw(ui_keyboard);
@@ -340,24 +351,27 @@ pub mod c {
         pub extern "C"
         fn squeek_layout_drag(
             layout: *mut Layout,
-            virtual_keyboard: ZwpVirtualKeyboardV1, // TODO: receive a reference to the backend
+            submission: *mut Submission,
             x_widget: f64, y_widget: f64,
             widget_to_layout: Transformation,
             time: u32,
+            manager: manager::c::Manager,
             ui_keyboard: EekGtkKeyboard,
         ) {
             let time = Timestamp(time);
             let layout = unsafe { &mut *layout };
-            let virtual_keyboard = VirtualKeyboard(virtual_keyboard);
+            let submission = unsafe { &mut *submission };
-
+            let ui_backend = UIBackend {
-            let point = widget_to_layout.forward(
+                widget_to_layout,
+                keyboard: ui_keyboard,
+            };
+            let point = ui_backend.widget_to_layout.forward(
                 Point { x: x_widget, y: y_widget }
             );
             
             let pressed = layout.pressed_keys.clone();
             let button_info = {
-                let view = layout.get_current_view();
+                let place = layout.find_button_by_position(point);
-                let place = view.find_button_by_position(point);
                 place.map(|place| {(
                     place.button.state.clone(),
                     place.button.clone(),
@@ -365,7 +379,7 @@ pub mod c {
                 )})
             };
 
-            if let Some((mut state, _button, _view_position)) = button_info {
+            if let Some((state, _button, _view_position)) = button_info {
                 let mut found = false;
                 for wrapped_key in pressed {
                     let key: &Rc<RefCell<KeyState>> = wrapped_key.borrow();
@@ -374,16 +388,21 @@ pub mod c {
                     } else {
                         seat::handle_release_key(
                             layout,
-                            &virtual_keyboard,
+                            submission,
-                            &widget_to_layout,
+                            Some(&ui_backend),
                             time,
-                            ui_keyboard,
+                            Some(manager),
                             key,
                         );
                     }
                 }
                 if !found {
-                    layout.press_key(&virtual_keyboard, &mut state, time);
+                    seat::handle_press_key(
+                        layout,
+                        submission,
+                        time,
+                        &state,
+                    );
                     // maybe TODO: draw on the display buffer here
                 }
             } else {
@@ -391,10 +410,10 @@ pub mod c {
                     let key: &Rc<RefCell<KeyState>> = wrapped_key.borrow();
                     seat::handle_release_key(
                         layout,
-                        &virtual_keyboard,
+                        submission,
-                        &widget_to_layout,
+                        Some(&ui_backend),
                         time,
-                        ui_keyboard,
+                        Some(manager),
                         key,
                     );
                 }
@@ -463,8 +482,6 @@ pub struct Button {
 pub struct Row {
     /// Buttons together with their offset from the left
     pub buttons: Vec<(f64, Box<Button>)>,
-    /// Angle is not really used anywhere...
-    pub angle: i32,
 }
 
 impl Row {    
@@ -531,14 +548,14 @@ impl View {
         })
     }
     
-    fn get_width(&self) -> f64 {
+    pub fn get_width(&self) -> f64 {
         // No need to call `get_rows()`,
         // as the biggest row is the most far reaching in both directions
         // because they are all centered.
         find_max_double(self.rows.iter(), |(_offset, row)| row.get_width())
     }
     
-    fn get_height(&self) -> f64 {
+    pub fn get_height(&self) -> f64 {
         self.rows.iter().next_back()
             .map(|(y_offset, row)| row.get_height() + y_offset)
             .unwrap_or(0.0)
@@ -555,6 +572,21 @@ impl View {
             row,
         )}).collect()
     }
+
+    /// Returns a size which contains all the views
+    /// if they are all centered on the same point.
+    pub fn calculate_super_size(views: Vec<&View>) -> Size {
+        Size {
+            height: find_max_double(
+                views.iter(),
+                |view| view.get_height(),
+            ),
+            width: find_max_double(
+                views.iter(),
+                |view| view.get_width(),
+            ),
+        }
+    }
 }
 
 /// The physical characteristic of layout for the purpose of styling
@@ -582,7 +614,8 @@ pub struct Layout {
     // Views own the actual buttons which have state
     // Maybe they should own UI only,
     // and keys should be owned by a dedicated non-UI-State?
-    pub views: HashMap<String, View>,
+    /// Point is the offset within the layout
+    pub views: HashMap<String, (c::Point, View)>,
 
     // Non-UI stuff
     /// xkb keymap applicable to the contained keys. Unchangeable
@@ -596,18 +629,25 @@ pub struct Layout {
     // When the list tracks actual location,
     // it becomes possible to place popovers and other UI accurately.
     pub pressed_keys: HashSet<::util::Pointer<RefCell<KeyState>>>,
-    pub locked_keys: HashSet<::util::Pointer<RefCell<KeyState>>>,
 }
 
 /// A builder structure for picking up layout data from storage
 pub struct LayoutData {
-    pub views: HashMap<String, View>,
+    /// Point is the offset within layout
+    pub views: HashMap<String, (c::Point, View)>,
     pub keymap_str: CString,
     pub margins: Margins,
 }
 
+#[derive(Debug)]
 struct NoSuchView;
 
+impl fmt::Display for NoSuchView {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "No such view")
+    }
+}
+
 // Unfortunately, changes are not atomic due to mutability :(
 // An error will not be recoverable
 // The usage of &mut on Rc<RefCell<KeyState>> doesn't mean anything special.
@@ -620,13 +660,17 @@ impl Layout {
             views: data.views,
             keymap_str: data.keymap_str,
             pressed_keys: HashSet::new(),
-            locked_keys: HashSet::new(),
             margins: data.margins,
         }
     }
 
+    pub fn get_current_view_position(&self) -> &(c::Point, View) {
+        &self.views
+            .get(&self.current_view).expect("Selected nonexistent view")
+    }
+
     pub fn get_current_view(&self) -> &View {
-        self.views.get(&self.current_view).expect("Selected nonexistent view")
+        &self.views.get(&self.current_view).expect("Selected nonexistent view").1
     }
 
     fn set_view(&mut self, view: String) -> Result<(), NoSuchView> {
@@ -638,98 +682,11 @@ impl Layout {
         }
     }
 
-    fn release_key(
-        &mut self,
-        virtual_keyboard: &VirtualKeyboard,
-        mut key: &mut Rc<RefCell<KeyState>>,
-        time: Timestamp,
-    ) {
-        if !self.pressed_keys.remove(&::util::Pointer(key.clone())) {
-            eprintln!("Warning: key {:?} was not pressed", key);
-        }
-        virtual_keyboard.switch(
-            &mut key.borrow_mut(),
-            PressType::Released,
-            time,
-        );
-        self.set_level_from_press(&mut key);
-    }
-    
-    fn press_key(
-        &mut self,
-        virtual_keyboard: &VirtualKeyboard,
-        key: &mut Rc<RefCell<KeyState>>,
-        time: Timestamp,
-    ) {
-        if !self.pressed_keys.insert(::util::Pointer(key.clone())) {
-            eprintln!("Warning: key {:?} was already pressed", key);
-        }
-        virtual_keyboard.switch(
-            &mut key.borrow_mut(),
-            PressType::Pressed,
-            time,
-        );
-    }
-
-    fn set_level_from_press(&mut self, key: &Rc<RefCell<KeyState>>) {
-        let keys = self.locked_keys.clone();
-        for key in &keys {
-            self.locked_keys.remove(key);
-            self.set_state_from_press(key.borrow());
-        }
-
-        // Don't handle the same key twice, but handle it at least once,
-        // because its press is the reason we're here
-        if !keys.contains(&::util::Pointer(key.clone())) {
-            self.set_state_from_press(key);
-        }
-    }
-
-    fn set_state_from_press(&mut self, key: &Rc<RefCell<KeyState>>) {
-        // Action should not hold a reference to key,
-        // because key is later borrowed for mutation. So action is cloned.
-        // RefCell::borrow() is covered up by (dyn Borrow)::borrow()
-        // if used like key.borrow() :(
-        let action = RefCell::borrow(key).action.clone();
-        let view_name = match action {
-            Action::SetLevel(name) => {
-                Some(name.clone())
-            },
-            Action::LockLevel { lock, unlock } => {
-                let locked = {
-                    let mut key = key.borrow_mut();
-                    key.locked ^= true;
-                    key.locked
-                };
-
-                if locked {
-                    self.locked_keys.insert(::util::Pointer(key.clone()));
-                }
-
-                Some(if locked { lock } else { unlock }.clone())
-            },
-            _ => None,
-        };
-
-        if let Some(view_name) = view_name {
-            if let Err(_e) = self.set_view(view_name.clone()) {
-                eprintln!("No such view: {}, ignoring switch", view_name)
-            };
-        };
-    }
-
     /// Calculates size without margins
     fn calculate_inner_size(&self) -> Size {
-        Size {
+        View::calculate_super_size(
-            height: find_max_double(
+            self.views.iter().map(|(_, (_offset, v))| v).collect()
-                self.views.iter(),
+        )
-                |(_name, view)| view.get_height(),
-            ),
-            width: find_max_double(
-                self.views.iter(),
-                |(_name, view)| view.get_width(),
-            ),
-        }
     }
 
     /// Size including margins
@@ -764,6 +721,42 @@ impl Layout {
             scale: 1.0,
         })
     }
+
+    fn find_button_by_position(&self, point: c::Point) -> Option<ButtonPlace> {
+        let (offset, layout) = self.get_current_view_position();
+        layout.find_button_by_position(point - offset)
+    }
+
+    pub fn foreach_visible_button<F>(&self, mut f: F)
+        where F: FnMut(c::Point, &Box<Button>)
+    {
+        let (view_offset, view) = self.get_current_view_position();
+        for (row_offset, row) in &view.get_rows() {
+            for (x_offset, button) in &row.buttons {
+                let offset = view_offset
+                    + row_offset.clone()
+                    + c::Point { x: *x_offset, y: 0.0 };
+                f(offset, button);
+            }
+        }
+    }
+
+    pub fn get_locked_keys(&self) -> Vec<Rc<RefCell<KeyState>>> {
+        let mut out = Vec::new();
+        let view = self.get_current_view();
+        for (_, row) in &view.get_rows() {
+            for (_, button) in &row.buttons {
+                let locked = {
+                    let state = RefCell::borrow(&button.state).clone();
+                    state.action.is_locked(&self.current_view)
+                };
+                if locked {
+                    out.push(button.state.clone());
+                }
+            }
+        }
+        out
+    }
 }
 
 mod procedures {
@@ -815,7 +808,6 @@ mod procedures {
 
             let row = Row {
                 buttons: vec!((0.1, button)),
-                angle: 0,
             };
 
             let view = View {
@@ -842,42 +834,207 @@ mod procedures {
     }
 }
 
+pub struct UIBackend {
+    widget_to_layout: c::Transformation,
+    keyboard: c::EekGtkKeyboard,
+}
+
 /// Top level procedures, dispatching to everything
 mod seat {
     use super::*;
 
-    // TODO: turn into release_button
+    fn try_set_view(layout: &mut Layout, view_name: String) {
+        layout.set_view(view_name.clone())
+            .or_print(
+                logging::Problem::Bug,
+                &format!("Bad view {}, ignoring", view_name),
+            );
+    }
+
+    /// A vessel holding an obligation to switch view.
+    /// Use with #[must_use]
+    struct ViewChange<'a> {
+        layout: &'a mut Layout,
+        view_name: Option<String>,
+    }
+    
+    impl<'a> ViewChange<'a> {
+        fn choose_view(self, view_name: String) -> ViewChange<'a> {
+            ViewChange {
+                view_name: Some(view_name),
+                ..self
+            }
+        }
+        fn apply(self) {
+            if let Some(name) = self.view_name {
+                try_set_view(self.layout, name);
+            }
+        }
+    }
+
+    /// Find all impermanent view changes and undo them in an arbitrary order.
+    /// Return an obligation to actually switch the view.
+    /// The final view is the "unlock" view
+    /// from one of the currently stuck keys.
+    // As long as only one stuck button is used, this should be fine.
+    // This is guaranteed because pressing a lock button unlocks all others.
+    // TODO: Make some broader guarantee about the resulting view,
+    // e.g. by maintaining a stack of stuck keys.
+    #[must_use]
+    fn unstick_locks(layout: &mut Layout) -> ViewChange {
+        let mut new_view = None;
+        for key in layout.get_locked_keys().clone() {
+            let key: &Rc<RefCell<KeyState>> = key.borrow();
+            let key = RefCell::borrow(key);
+            match &key.action {
+                Action::LockView { lock: _, unlock: view } => {
+                    new_view = Some(view.clone());
+                },
+                a => log_print!(
+                    logging::Level::Bug,
+                    "Non-locking action {:?} was found inside locked keys",
+                    a,
+                ),
+            };
+        }
+        
+        ViewChange {
+            layout,
+            view_name: new_view,
+        }
+    }
+
+    pub fn handle_press_key(
+        layout: &mut Layout,
+        submission: &mut Submission,
+        time: Timestamp,
+        rckey: &Rc<RefCell<KeyState>>,
+    ) {
+        if !layout.pressed_keys.insert(::util::Pointer(rckey.clone())) {
+            log_print!(
+                logging::Level::Bug,
+                "Key {:?} was already pressed", rckey,
+            );
+        }
+        let key: KeyState = {
+            RefCell::borrow(rckey).clone()
+        };
+        let action = key.action.clone();
+        match action {
+            Action::Submit {
+                text: Some(text),
+                keys: _,
+            } => submission.handle_press(
+                KeyState::get_id(rckey),
+                SubmitData::Text(&text),
+                &key.keycodes,
+                time,
+            ),
+            Action::Submit {
+                text: None,
+                keys: _,
+            } => submission.handle_press(
+                KeyState::get_id(rckey),
+                SubmitData::Keycodes,
+                &key.keycodes,
+                time,
+            ),
+            Action::Erase => submission.handle_press(
+                KeyState::get_id(rckey),
+                SubmitData::Erase,
+                &key.keycodes,
+                time,
+            ),
+            _ => {},
+        };
+        RefCell::replace(rckey, key.into_pressed());
+    }
+
     pub fn handle_release_key(
         layout: &mut Layout,
-        virtual_keyboard: &VirtualKeyboard,
+        submission: &mut Submission,
-        widget_to_layout: &c::Transformation,
+        ui: Option<&UIBackend>,
         time: Timestamp,
-        ui_keyboard: c::EekGtkKeyboard,
+        manager: Option<manager::c::Manager>,
-        key: &Rc<RefCell<KeyState>>,
+        rckey: &Rc<RefCell<KeyState>>,
     ) {
-        layout.release_key(virtual_keyboard, &mut key.clone(), time);
+        let key: KeyState = {
+            RefCell::borrow(rckey).clone()
+        };
+        let action = key.action.clone();
 
+        // update
+        let key = key.into_released();
+
+        // process changes
+        match action {
+            Action::Submit { text: _, keys: _ }
+                | Action::Erase
+            => {
+                unstick_locks(layout).apply();
+                submission.handle_release(KeyState::get_id(rckey), time);
+            },
+            Action::SetView(view) => {
+                try_set_view(layout, view)
+            },
+            Action::LockView { lock, unlock } => {
+                let gets_locked = !key.action.is_locked(&layout.current_view);
+                unstick_locks(layout)
+                    // It doesn't matter what the resulting view should be,
+                    // it's getting changed anyway.
+                    .choose_view(
+                        match gets_locked {
+                            true => lock.clone(),
+                            false => unlock.clone(),
+                        }
+                    )
+                    .apply()
+            },
+            Action::ApplyModifier(modifier) => {
+                // FIXME: key id is unneeded with stateless locks
+                let key_id = KeyState::get_id(rckey);
+                let gets_locked = !submission.is_modifier_active(modifier.clone());
+                match gets_locked {
+                    true => submission.handle_add_modifier(
+                        key_id,
+                        modifier, time,
+                    ),
+                    false => submission.handle_drop_modifier(key_id, time),
+                }
+            }
+            // only show when UI is present
+            Action::ShowPreferences => if let Some(ui) = &ui {
+                // only show when layout manager is available
+                if let Some(manager) = manager {
                     let view = layout.get_current_view();
-        let action = RefCell::borrow(key).action.clone();
-        if let Action::ShowPreferences = action {
                     let places = ::layout::procedures::find_key_places(
-                view, key
+                        view, &rckey,
                     );
-            // getting first item will cause mispositioning
+                    // Getting first item will cause mispositioning
                     // with more than one button with the same key
-            // on the keyboard
+                    // on the keyboard.
-            if let Some((offset, button)) = places.get(0) {
+                    if let Some((position, button)) = places.get(0) {
                         let bounds = c::Bounds {
-                    x: offset.x, y: offset.y,
+                            x: position.x,
+                            y: position.y,
                             width: button.size.width,
                             height: button.size.height,
                         };
                         ::popover::show(
-                    ui_keyboard,
+                            ui.keyboard,
-                    widget_to_layout.reverse_bounds(bounds)
+                            ui.widget_to_layout.reverse_bounds(bounds),
+                            manager,
                         );
                     }
                 }
+            },
+        };
+
+        let pointer = ::util::Pointer(rckey.clone());
+        // Apply state changes
+        layout.pressed_keys.remove(&pointer);
+        // Commit activated button state changes
+        RefCell::replace(rckey, key);
     }
 }
 
@@ -886,13 +1043,13 @@ mod test {
     use super::*;
 
     use std::ffi::CString;
+    use ::keyboard::PressType;
 
     pub fn make_state() -> Rc<RefCell<::keyboard::KeyState>> {
         Rc::new(RefCell::new(::keyboard::KeyState {
             pressed: PressType::Released,
-            locked: false,
             keycodes: Vec::new(),
-            action: Action::SetLevel("default".into()),
+            action: Action::SetView("default".into()),
         }))
     }
 
@@ -917,7 +1074,6 @@ mod test {
             (
                 0.0,
                 Row {
-                    angle: 0,
                     buttons: vec![(
                         0.0,
                         Box::new(Button {
@@ -930,7 +1086,6 @@ mod test {
             (
                 10.0,
                 Row {
-                    angle: 0,
                     buttons: vec![(
                         0.0,
                         Box::new(Button {
@@ -954,7 +1109,6 @@ mod test {
             (
                 0.0,
                 Row {
-                    angle: 0,
                     buttons: vec![(
                         0.0,
                         Box::new(Button {
@@ -969,7 +1123,6 @@ mod test {
             current_view: String::new(),
             keymap_str: CString::new("").unwrap(),
             kind: ArrangementKind::Base,
-            locked_keys: HashSet::new(),
             pressed_keys: HashSet::new(),
             // Lots of bottom margin
             margins: Margins {
@@ -979,7 +1132,7 @@ mod test {
                 bottom: 1.0,
             },
             views: hashmap! {
-                String::new() => view,
+                String::new() => (c::Point { x: 0.0, y: 0.0 }, view),
             },
         };
         assert_eq!(

src/lib.rs

@@ -15,6 +15,9 @@ extern crate regex;
 extern crate serde;
 extern crate xkbcommon;
 
+#[macro_use]
+mod logging;
+
 mod action;
 pub mod data;
 mod drawing;
@@ -24,11 +27,14 @@ mod keyboard;
 mod layout;
 mod locale;
 mod locale_config;
+mod manager;
 mod outputs;
 mod popover;
 mod resources;
-mod submission;
 mod style;
+mod submission;
 pub mod tests;
 pub mod util;
+mod ui_manager;
+mod vkeyboard;
 mod xdg;

src/locale.rs

@@ -1,21 +1,106 @@
-/*! Locale-specific functions */
+/*! Locale-specific functions. 
+ * 
+ * This file is intended as a library:
+ * it must pass errors upwards
+ * and panicking is allowed only when
+ * this code encounters an internal inconsistency.
+ */
 
 use std::cmp;
-use std::ffi::CString;
+use std::ffi::{ CStr, CString };
+use std::fmt;
+use std::os::raw::c_char;
+use std::ptr;
+use std::str::Utf8Error;
 
 mod c {
-    use std::os::raw::c_char;
+    use super::*;
+    use std::os::raw::c_void;
 
     #[allow(non_camel_case_types)]
     pub type c_int = i32;
 
+    #[derive(Clone, Copy)]
+    #[repr(C)]
+    pub struct GnomeXkbInfo(*const c_void);
+
     #[no_mangle]
     extern "C" {
         // from libc
         pub fn strcoll(cs: *const c_char, ct: *const c_char) -> c_int;
+        // from gnome-desktop3
+        pub fn gnome_xkb_info_new() -> GnomeXkbInfo;
+        pub fn gnome_xkb_info_get_layout_info (
+            info: GnomeXkbInfo,
+            id: *const c_char,
+            display_name: *mut *const c_char,
+            short_name: *const *const c_char,
+            xkb_layout: *const *const c_char,
+            xkb_variant: *const *const c_char
+        ) -> c_int;
+        pub fn g_object_unref(o: GnomeXkbInfo);
     }
 }
 
+#[derive(Debug)]
+pub enum Error {
+    StringConversion(Utf8Error),
+    NoInfo,
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        fmt::Debug::fmt(&self, f)
+    }
+}
+
+pub struct XkbInfo(c::GnomeXkbInfo);
+
+impl XkbInfo {
+    pub fn new() -> XkbInfo {
+        XkbInfo(unsafe { c::gnome_xkb_info_new() })
+    }
+    pub fn get_display_name(&self, id: &str) -> Result<String, Error> {
+        let id = cstring_safe(id);
+        let id_ref = id.as_ptr();
+        let mut display_name: *const c_char = ptr::null();
+        let found = unsafe {
+            c::gnome_xkb_info_get_layout_info(
+                self.0,
+                id_ref,
+                &mut display_name as *mut *const c_char,
+                ptr::null(), ptr::null(), ptr::null(),
+            )
+        };
+        if found != 0 && !display_name.is_null() {
+            let display_name = unsafe { CStr::from_ptr(display_name) };
+            display_name.to_str()
+                .map(str::to_string)
+                .map_err(Error::StringConversion)
+        } else {
+            Err(Error::NoInfo)
+        }
+    }
+}
+
+impl Drop for XkbInfo {
+    fn drop(&mut self) {
+        unsafe { c::g_object_unref(self.0) }
+    }
+}
+
+#[derive(Clone, Debug, PartialEq)]
+pub struct Translation<'a>(pub &'a str);
+
+impl<'a> Translation<'a> {
+    pub fn to_owned(&'a self) -> OwnedTranslation {
+        OwnedTranslation(self.0.to_owned())
+    }
+}
+
+#[derive(Clone, Debug, PartialEq)]
+pub struct OwnedTranslation(pub String);
+
 fn cstring_safe(s: &str) -> CString {
     CString::new(s)
         .unwrap_or(CString::new("").unwrap())

src/logging.rs

@@ -0,0 +1,201 @@
+/*! Logging library.
+ * 
+ * This is probably the only part of squeekboard
+ * that should be doing any direct printing.
+ * 
+ * There are several approaches to logging,
+ * in the order of increasing flexibility and/or purity:
+ * 
+ * 1. `println!` directly
+ * 
+ *   It can't be easily replaced by a different solution
+ * 
+ * 2. simple `log!` macro
+ * 
+ *   Replacing the destination at runtime other than globally would be awkward,
+ *   so no easy way to suppress errors for things that don't matter,
+ *   but formatting is still easy.
+ * 
+ * 3. logging to a mutable destination type
+ * 
+ *   Can be easily replaced, but logging `Result` types,
+ *   which should be done by calling a method on the result,
+ *   can't be formatted directly.
+ *   Cannot be parallelized.
+ * 
+ * 4. logging to an immutable destination type
+ * 
+ *   Same as above, except it can be parallelized.
+ *   Logs being outputs, they get returned
+ *   instead of being misleadingly passed back through arguments.
+ *   It seems more difficult to pass the logger around,
+ *   but this may be a solved problem from the area of functional programming.
+ * 
+ * This library generally aims at the approach in 3.
+ * */
+
+use std::fmt::Display;
+
+/// Levels are not in order.
+pub enum Level {
+    // Levels for reporting violated constraints
+    /// The program violated a self-imposed constraint,
+    /// ended up in an inconsistent state, and cannot recover.
+    /// Handlers must not actually panic. (should they?)
+    Panic,
+    /// The program violated a self-imposed constraint,
+    /// ended up in an inconsistent state, but some state can be recovered.
+    Bug,
+    /// Invalid data given by an external source,
+    /// some state of the program must be dropped.
+    Error,
+    // Still violated constraints, but harmless
+    /// Invalid data given by an external source, parts of data are ignored.
+    /// No previous program state needs to be dropped.
+    Warning,
+    /// External source not in an expected state,
+    /// but not violating any protocols (including no relevant protocol).
+    Surprise,
+    // Informational
+    /// A change in internal state that results in a change of behaviour
+    /// that a user can observe, and a tinkerer might find useful.
+    /// E.g. selection of external sources, like loading user's UI files,
+    /// language switch, overrides.
+    Info,
+    /// Information useful for application developer only.
+    /// Should be limited to information gotten from external sources,
+    /// and more tricky parts of internal state.
+    Debug,
+}
+
+impl Level {
+    fn as_str(&self) -> &'static str {
+        match self {
+            Level::Panic => "Panic",
+            Level::Bug => "Bug",
+            Level::Error => "Error",
+            Level::Warning => "Warning",
+            Level::Surprise => "Surprise",
+            Level::Info => "Info",
+            Level::Debug => "Debug",
+        }
+    }
+}
+
+impl From<Problem> for Level {
+    fn from(problem: Problem) -> Level {
+        use self::Level::*;
+        match problem {
+            Problem::Panic => Panic,
+            Problem::Bug => Bug,
+            Problem::Error => Error,
+            Problem::Warning => Warning,
+            Problem::Surprise => Surprise,
+        }
+    }
+}
+
+/// Only levels which indicate problems
+/// To use with `Result::Err` handlers,
+/// which are needed only when something went off the optimal path.
+/// A separate type ensures that `Err`
+/// can't end up misclassified as a benign event like `Info`.
+pub enum Problem {
+    Panic,
+    Bug,
+    Error,
+    Warning,
+    Surprise,
+}
+
+/// Sugar for approach 2
+// TODO: avoid, deprecate.
+// Handler instances should be long lived, not one per call.
+macro_rules! log_print {
+    ($level:expr, $($arg:tt)*) => (::logging::print($level, &format!($($arg)*)))
+}
+
+/// Approach 2
+pub fn print(level: Level, message: &str) {
+    Print{}.handle(level, message)
+}
+
+/// Sugar for logging errors in results.
+pub trait Warn where Self: Sized {
+    type Value;
+    /// Approach 2.
+    fn or_print(self, level: Problem, message: &str) -> Option<Self::Value> {
+        self.or_warn(&mut Print {}, level.into(), message)
+    }
+    /// Approach 3.
+    fn or_warn<H: Handler>(
+        self,
+        handler: &mut H,
+        level: Problem,
+        message: &str,
+    ) -> Option<Self::Value>;
+}
+
+impl<T, E: Display> Warn for Result<T, E> {
+    type Value = T;
+    fn or_warn<H: Handler>(
+        self,
+        handler: &mut H,
+        level: Problem,
+        message: &str,
+    ) -> Option<T> {
+        self.map_err(|e| {
+            handler.handle(level.into(), &format!("{}: {}", message, e));
+            e
+        }).ok()
+    }
+}
+
+impl<T> Warn for Option<T> {
+    type Value = T;
+    fn or_warn<H: Handler>(
+        self,
+        handler: &mut H,
+        level: Problem,
+        message: &str,
+    ) -> Option<T> {
+        self.or_else(|| {
+            handler.handle(level.into(), message);
+            None
+        })
+    }
+}
+
+/// A mutable handler for text warnings.
+/// Approach 3.
+pub trait Handler {
+    /// Handle a log message
+    fn handle(&mut self, level: Level, message: &str);
+}
+
+/// Prints info to stdout, everything else to stderr
+pub struct Print;
+
+impl Handler for Print {
+    fn handle(&mut self, level: Level, message: &str) {
+        match level {
+            Level::Info => println!("Info: {}", message),
+            l => eprintln!("{}: {}", l.as_str(), message),
+        }
+    }
+}
+
+/// Warning handler that will panic
+/// at any warning, error, surprise, bug, or panic.
+/// Don't use except in tests
+pub struct ProblemPanic;
+
+impl Handler for ProblemPanic {
+    fn handle(&mut self, level: Level, message: &str) {
+        use self::Level::*;
+        match level {
+            Panic | Bug | Error | Warning | Surprise => panic!("{}", message),
+            l => Print{}.handle(l, message),
+        }
+    }
+}

src/manager.rs

@@ -0,0 +1,34 @@
+/*! Procedures relating to the management of the switching of layouts */
+use ::util;
+
+pub mod c {
+    use std::os::raw::{c_char, c_void};
+
+    /// EekboardContextService*
+    #[repr(transparent)]
+    #[derive(Clone, Copy)]
+    pub struct Manager(*const c_void);
+    
+    #[no_mangle]
+    extern "C" {
+        pub fn eekboard_context_service_set_overlay(
+            manager: Manager,
+            name: *const c_char,
+        );
+
+        pub fn eekboard_context_service_get_overlay(
+            manager: Manager,
+        ) -> *const c_char;
+    }
+}
+
+/// Returns the overlay name.
+/// The result lifetime is "as long as the C copy lives"
+pub fn get_overlay(manager: c::Manager) -> Option<String> {
+    let raw_str = unsafe {
+        c::eekboard_context_service_get_overlay(manager)
+    };
+    // this string is generated from Rust, should never be invalid
+    util::c::as_str(&raw_str).unwrap()
+        .map(String::from)
+}

src/meson.build

@@ -12,23 +12,20 @@ config_h = configure_file(
 
 sources = [
   config_h,
+  'dbus.c',
   'imservice.c',
   'server-context-service.c',
+  'ui_manager.c',
   'wayland.c',
   '../eek/eek.c',
   '../eek/eek-element.c',
   '../eek/eek-gtk-keyboard.c',
   '../eek/eek-keyboard.c',
-  '../eek/eek-layout.c',
   '../eek/eek-renderer.c',
   '../eek/eek-types.c',
-  '../eek/eek-xml-layout.c',
   '../eek/layersurface.c',
   dbus_src,
-  enums,
-  '../eekboard/key-emitter.c',
   '../eekboard/eekboard-context-service.c',
-  '../eekboard/eekboard-service.c',
   #  '../eekboard/eekboard-xklutil.c',
   squeekboard_resources,
   wl_proto_sources,
@@ -40,6 +37,7 @@ cc = meson.get_compiler('c')
 deps = [
 #  dependency('glib-2.0', version: '>=2.26.0'),
   dependency('gio-2.0', version: '>=2.26.0'),
+  dependency('gnome-desktop-3.0', version: '>=3.0'),
   dependency('gtk+-3.0', version: '>=3.0'),
   dependency('libcroco-0.6'),
   dependency('wayland-client', version: '>=1.14'),
@@ -112,16 +110,3 @@ squeekboard = executable('squeekboard',
     '-DEEK_COMPILATION=1'],
 )
 
-bindir = join_paths(prefix, get_option('bindir'))
-
-test_layout = custom_target('squeekboard-test-layout',
-    build_by_default: true,
-    # meson doesn't track all inputs, cargo does
-    build_always_stale: true,
-    output: ['squeekboard-test-layout'],
-    console: true,
-    command: [cargo_build] + cargo_build_flags
-        + ['--rename', 'test_layout', '@OUTPUT@', '--bin', 'test_layout'],
-    install: true,
-    install_dir: bindir,
-)

src/outputs.h

@@ -4,10 +4,14 @@
 #include "wayland-client-protocol.h"
 
 struct squeek_outputs;
+struct squeek_output_handle {
+    struct wl_output *output;
+    struct squeek_outputs *outputs;
+};
 
 struct squeek_outputs *squeek_outputs_new();
 void squeek_outputs_free(struct squeek_outputs*);
 void squeek_outputs_register(struct squeek_outputs*, struct wl_output *output);
-struct wl_output *squeek_outputs_get_current(struct squeek_outputs*);
+struct squeek_output_handle squeek_outputs_get_current(struct squeek_outputs*);
 int32_t squeek_outputs_get_perceptual_width(struct squeek_outputs*, struct wl_output *output);
 #endif

src/outputs.rs

@@ -1,7 +1,15 @@
+/* Copyright (C) 2019-2020 Purism SPC
+ * SPDX-License-Identifier: GPL-3.0+
+ */
+
 /*! Managing Wayland outputs */
 
+use std::cell::RefCell;
 use std::vec::Vec;
+use ::logging;
 
+// traits
+use ::logging::Warn;
 
 /// Gathers stuff defined in C or called by C
 pub mod c {
@@ -14,7 +22,7 @@ pub mod c {
     // Defined in C
 
     #[repr(transparent)]
-    #[derive(Clone, PartialEq)]
+    #[derive(Clone, PartialEq, Copy, Hash)]
     pub struct WlOutput(*const c_void);
 
     #[repr(C)]
@@ -60,7 +68,7 @@ pub mod c {
     }
 
     /// Map to `wl_output.transform` values
-    #[derive(Clone)]
+    #[derive(Clone, PartialEq)]
     pub enum Transform {
         Normal = 0,
         Rotated90 = 1,
@@ -100,7 +108,29 @@ pub mod c {
         ) -> i32;
     }
 
-    type COutputs = ::util::c::Wrapped<Outputs>;
+    pub type COutputs = ::util::c::Wrapped<Outputs>;
+
+    /// A stable reference to an output.
+    #[derive(Clone)]
+    #[repr(C)]
+    pub struct OutputHandle {
+        wl_output: WlOutput,
+        outputs: COutputs,
+    }
+
+    impl OutputHandle {
+        // Cannot return an Output reference
+        // because COutputs is too deeply wrapped
+        pub fn get_state(&self) -> Option<OutputState> {
+            let outputs = self.outputs.clone_ref();
+            let outputs = outputs.borrow();
+            find_output(&outputs, self.wl_output.clone()).map(|o| o.current.clone())
+        }
+
+        pub fn get_id(&self) -> OutputId {
+            OutputId { wl_output: self.wl_output }
+        }
+    }
 
     // Defined in Rust
 
@@ -108,28 +138,43 @@ pub mod c {
         outputs: COutputs,
         wl_output: WlOutput,
         _x: i32, _y: i32,
-        _phys_width: i32, _phys_height: i32,
+        phys_width: i32, phys_height: i32,
         _subpixel: i32,
         _make: *const c_char, _model: *const c_char,
         transform: i32,
     ) {
-        let transform = Transform::from_u32(transform as u32).unwrap_or_else(
+        let transform = Transform::from_u32(transform as u32)
-            || {
+            .or_print(
-                eprintln!(
+                logging::Problem::Warning,
-                    "Warning: received invalid wl_output.transform value"
+                "Received invalid wl_output.transform value",
-                );
+            ).unwrap_or(Transform::Normal);
-                Transform::Normal
-            }
-        );
 
         let outputs = outputs.clone_ref();
         let mut collection = outputs.borrow_mut();
         let output_state: Option<&mut OutputState>
             = find_output_mut(&mut collection, wl_output)
                 .map(|o| &mut o.pending);
+
         match output_state {
-            Some(state) => { state.transform = Some(transform) },
+            Some(state) => {
-            None => eprintln!("Wayland error: Got mode on unknown output"),
+                state.transform = Some(transform);
+                state.phys_size = {
+                    if (phys_width > 0) & (phys_height > 0) {
+                        Some(SizeMM { width: phys_width, height: phys_height })
+                    } else {
+                        log_print!(
+                            logging::Level::Surprise,
+                            "Impossible physical dimensions: {}mm × {}mm",
+                            phys_width, phys_height,
+                        );
+                        None
+                    }
+                }
+            },
+            None => log_print!(
+                logging::Level::Warning,
+                "Got geometry on unknown output",
+            ),
         };
     }
 
@@ -141,10 +186,12 @@ pub mod c {
         height: i32,
         _refresh: i32,
     ) {
-        let flags = Mode::from_bits(flags).unwrap_or_else(|| {
+        let flags = Mode::from_bits(flags)
-            eprintln!("Warning: received invalid wl_output.mode flags");
+            .or_print(
-            Mode::NONE
+                logging::Problem::Warning,
-        });
+                "Received invalid wl_output.mode flags",
+            ).unwrap_or(Mode::NONE);
+
         let outputs = outputs.clone_ref();
         let mut collection = outputs.borrow_mut();
         let output_state: Option<&mut OutputState>
@@ -156,22 +203,36 @@ pub mod c {
                     state.current_mode = Some(super::Mode { width, height});
                 }
             },
-            None => eprintln!("Wayland error: Got mode on unknown output"),
+            None => log_print!(
+                logging::Level::Warning,
+                "Got mode on unknown output",
+            ),
         };
     }
 
     extern fn outputs_handle_done(
-        outputs: COutputs,
+        outputs_raw: COutputs,
         wl_output: WlOutput,
     ) {
-        let outputs = outputs.clone_ref();
+        let outputs = outputs_raw.clone_ref();
-        let mut collection = outputs.borrow_mut();
+        {
+            let mut collection = RefCell::borrow_mut(&outputs);
             let output = find_output_mut(&mut collection, wl_output);
             match output {
                 Some(output) => { output.current = output.pending.clone(); }
-            None => eprintln!("Wayland error: Got done on unknown output"),
+                None => log_print!(
+                    logging::Level::Warning,
+                    "Got done on unknown output",
+                ),
             };
         }
+        let collection = RefCell::borrow(&outputs);
+        if let Some(ref cb) = &collection.update_cb {
+            let mut cb = RefCell::borrow_mut(cb);
+            let cb = Box::as_mut(&mut cb);
+            cb(OutputHandle { wl_output, outputs: outputs_raw });
+        }
+    }
 
     extern fn outputs_handle_scale(
         outputs: COutputs,
@@ -185,14 +246,20 @@ pub mod c {
                 .map(|o| &mut o.pending);
         match output_state {
             Some(state) => { state.scale = factor; }
-            None => eprintln!("Wayland error: Got done on unknown output"),
+            None => log_print!(
+                logging::Level::Warning,
+                "Got scale on unknown output",
+            ),
         };
     }
 
     #[no_mangle]
     pub extern "C"
     fn squeek_outputs_new() -> COutputs {
-        COutputs::new(Outputs { outputs: Vec::new() })
+        COutputs::new(Outputs {
+            outputs: Vec::new(),
+            update_cb: None,
+        })
     }
 
     #[no_mangle]
@@ -226,43 +293,15 @@ pub mod c {
     
     #[no_mangle]
     pub extern "C"
-    fn squeek_outputs_get_current(raw_collection: COutputs) -> WlOutput {
+    fn squeek_outputs_get_current(raw_collection: COutputs) -> OutputHandle {
         let collection = raw_collection.clone_ref();
         let collection = collection.borrow();
-        collection.outputs[0].output.clone()
+        OutputHandle {
+            wl_output: collection.outputs[0].output.clone(),
+            outputs: raw_collection.clone(),
+        }
     }
 
-    #[no_mangle]
-    pub extern "C"
-    fn squeek_outputs_get_perceptual_width(
-        raw_collection: COutputs,
-        wl_output: WlOutput,
-    ) -> i32 {
-        let collection = raw_collection.clone_ref();
-        let collection = collection.borrow();
-
-        let output_state = find_output(&collection, wl_output)
-            .map(|o| &o.current);
-        match output_state {
-            Some(OutputState {
-                current_mode: Some(super::Mode { width, height } ),
-                transform: Some(transform),
-                scale,
-            }) => {
-                match transform {
-                    Transform::Normal
-                    | Transform::Rotated180
-                    | Transform::Flipped
-                    | Transform::FlippedRotated180 => width / scale,
-                    _ => height / scale,
-                }
-            },
-            _ => {
-                eprintln!("Not enough info registered on output");
-                0
-            },
-        }
-    }
     // TODO: handle unregistration
     
     fn find_output(
@@ -288,27 +327,112 @@ pub mod c {
     }
 }
 
-#[derive(Clone)]
+/// Generic size
+#[derive(Clone, Debug)]
+pub struct Size {
+    pub width: u32,
+    pub height: u32,
+}
+
+#[derive(Clone, PartialEq)]
+pub struct SizeMM {
+    pub width: i32,
+    pub height: i32,
+}
+
+/// wl_output mode
+#[derive(Clone, PartialEq)]
 struct Mode {
     width: i32,
     height: i32,
 }
 
-#[derive(Clone)]
+#[derive(Clone, PartialEq)]
 pub struct OutputState {
     current_mode: Option<Mode>,
+    phys_size: Option<SizeMM>,
     transform: Option<c::Transform>,
-    scale: i32,
+    pub scale: i32,
 }
 
 impl OutputState {
+    // More properly, this would have been a builder kind of struct,
+    // with wl_output gradually adding properties to it
+    // before it reached a fully initialized state,
+    // when it would transform into a struct without all (some?) of the Options.
+    // However, it's not clear which state is fully initialized,
+    // and whether it would make things easier at all anyway.
     fn uninitialized() -> OutputState {
         OutputState {
             current_mode: None,
+            phys_size: None,
             transform: None,
             scale: 1,
         }
     }
+
+    pub fn get_pixel_size(&self) -> Option<Size> {
+        use self::c::Transform;
+        match self {
+            OutputState {
+                current_mode: Some(Mode { width, height } ),
+                transform: Some(transform),
+                phys_size: _,
+                scale: _,
+            } => Some(
+                match transform {
+                    Transform::Normal
+                    | Transform::Rotated180
+                    | Transform::Flipped
+                    | Transform::FlippedRotated180 => Size {
+                        width: *width as u32,
+                        height: *height as u32,
+                    },
+                    _ => Size {
+                        width: *height as u32,
+                        height: *width as u32,
+                    },
+                }
+            ),
+            _ => None,
+        }
+    }
+    
+    /// Returns transformed dimensions
+    pub fn get_phys_size(&self) -> Option<Size> {
+        use self::c::Transform;
+        match self {
+            OutputState {
+                current_mode: _,
+                transform: Some(transform),
+                phys_size: Some(SizeMM { width, height }),
+                scale: _,
+            } => Some(
+                match transform {
+                    Transform::Normal
+                    | Transform::Rotated180
+                    | Transform::Flipped
+                    | Transform::FlippedRotated180 => Size {
+                        width: *width as u32,
+                        height: *height as u32,
+                    },
+                    _ => Size {
+                        width: *height as u32,
+                        height: *width as u32,
+                    },
+                }
+            ),
+            _ => None,
+        }
+    }
+}
+
+/// A comparable ID of an output
+#[derive(Clone, PartialEq, Hash)]
+pub struct OutputId {
+    // WlOutput is a unique pointer, so it will not repeat
+    // even if there are multiple output managers.
+    wl_output: c::WlOutput,
 }
 
 pub struct Output {
@@ -317,6 +441,38 @@ pub struct Output {
     current: OutputState,
 }
 
+/// The manager of all outputs.
+// This is the target of several callbacks,
+// so it should only be used with a stable place in memory, like `Rc<RefCell>`.
+// It should not be instantiated externally or copied,
+// or it will not receive those callbacks and be somewhat of an empty shell.
+// It should be safe to use as long as the fields are not `pub`,
+// and there's no `Clone`, and this module's API only ever gives out
+// references wrapped in `Rc<RefCell>`.
+// For perfectness, it would only ever give out immutable opaque references,
+// but that's not practical at the moment.
+// `mem::swap` could replace the value inside,
+// but as long as the swap is atomic,
+// that should not cause an inconsistent state.
 pub struct Outputs {
     outputs: Vec<Output>,
+    // The RefCell is here to let the function be called
+    // while holding only a read-reference to `Outputs`.
+    // Otherwise anything trying to get useful data from OutputHandle
+    // will fail to acquire reference to Outputs.
+    // TODO: Maybe pass only current state along with Outputs and Output hash.
+    // The only reason a full OutputHandle is here
+    // is to be able to track the right Output.
+    update_cb: Option<RefCell<Box<dyn FnMut(c::OutputHandle)>>>,
+}
+
+impl Outputs {
+    /// The function will get called whenever
+    /// any output changes or is removed or created.
+    /// If output handle doesn't return state, the output just went down.
+    /// It cannot modify anything in Outputs.
+    // FIXME: handle output destruction
+    pub fn set_update_cb(&mut self, callback: Box<dyn FnMut(c::OutputHandle)>) {
+        self.update_cb = Some(RefCell::new(callback));
+    }
 }

src/popover.rs

@@ -2,9 +2,13 @@
 
 use gio;
 use gtk;
-use ::layout::c::EekGtkKeyboard;
+use std::ffi::CString;
-use ::locale::compare_current_locale;
+use ::layout::c::{ Bounds, EekGtkKeyboard };
+use ::locale;
+use ::locale::{ OwnedTranslation, Translation, compare_current_locale };
 use ::locale_config::system_locale;
+use ::logging;
+use ::manager;
 use ::resources;
 
 use gio::ActionMapExt;
@@ -15,6 +19,7 @@ use glib::variant::ToVariant;
 use gtk::PopoverExt;
 use gtk::WidgetExt;
 use std::io::Write;
+use ::logging::Warn;
 
 mod variants {
     use glib;
@@ -24,6 +29,7 @@ mod variants {
 
     use glib::ToVariant;
     use glib::translate::FromGlibPtrFull;
+    use glib::translate::FromGlibPtrNone;
     use glib::translate::ToGlibPtr;
 
     /// Unpacks tuple & array variants
@@ -86,13 +92,13 @@ mod variants {
             unsafe {
                 let ret = glib_sys::g_variant_builder_end(builder);
                 glib_sys::g_variant_builder_unref(builder);
-                glib::Variant::from_glib_full(ret)
+                glib::Variant::from_glib_none(ret)
             }
         }
     }
 }
 
-fn make_menu_builder(inputs: Vec<(&str, &str)>) -> gtk::Builder {
+fn make_menu_builder(inputs: Vec<(&str, OwnedTranslation)>) -> gtk::Builder {
     let mut xml: Vec<u8> = Vec::new();
     writeln!(
         xml,
@@ -101,7 +107,7 @@ fn make_menu_builder(inputs: Vec<(&str, &str)>) -> gtk::Builder {
   <menu id=\"app-menu\">
     <section>"
     ).unwrap();
-    for (input_name, human_name) in inputs {
+    for (input_name, translation) in inputs {
         writeln!(
             xml,
             "
@@ -110,7 +116,7 @@ fn make_menu_builder(inputs: Vec<(&str, &str)>) -> gtk::Builder {
             <attribute name=\"action\">layout</attribute>
             <attribute name=\"target\">{}</attribute>
         </item>",
-            human_name,
+            translation.0,
             input_name,
         ).unwrap();
     }
@@ -126,8 +132,28 @@ fn make_menu_builder(inputs: Vec<(&str, &str)>) -> gtk::Builder {
     )
 }
 
+fn get_settings(schema_name: &str) -> Option<gio::Settings> {
+    let mut error_handler = logging::Print{};
+    gio::SettingsSchemaSource::get_default()
+        .or_warn(
+            &mut error_handler,
+            logging::Problem::Surprise,
+            "No gsettings schemas installed.",
+        )
+        .and_then(|sss| 
+            sss.lookup(schema_name, true)
+                .or_warn(
+                    &mut error_handler,
+                    logging::Problem::Surprise,
+                    &format!("Gsettings schema {} not installed", schema_name),
+                )
+        )
+        .map(|_sschema| gio::Settings::new(schema_name))
+}
+
 fn set_layout(kind: String, name: String) {
-    let settings = gio::Settings::new("org.gnome.desktop.input-sources");
+    let settings = get_settings("org.gnome.desktop.input-sources");
+    if let Some(settings) = settings {
         let inputs = settings.get_value("sources").unwrap();
         let current = (kind.clone(), name.clone());
         let inputs = variants::get_tuples(inputs).into_iter()
@@ -136,52 +162,200 @@ fn set_layout(kind: String, name: String) {
             .chain(inputs).collect();
         settings.set_value(
             "sources",
-        &variants::ArrayPairString(inputs).to_variant()
+            &variants::ArrayPairString(inputs).to_variant(),
         );
         settings.apply();
     }
+}
 
-pub fn show(window: EekGtkKeyboard, position: ::layout::c::Bounds) {
+/// A reference to what the user wants to see
-    unsafe { gtk::set_initialized() };
+#[derive(PartialEq, Clone, Debug)]
-    let window = unsafe { gtk::Widget::from_glib_none(window.0) };
+enum LayoutId {
+    /// Affects the layout in system settings
+    System {
+        kind: String,
+        name: String,
+    },
+    /// Only affects what this input method presents
+    Local(String),
+}
 
-    let settings = gio::Settings::new("org.gnome.desktop.input-sources");
+impl LayoutId {
-    let inputs = settings.get_value("sources").unwrap();
+    fn get_name(&self) -> &str {
-    let inputs = variants::get_tuples(inputs);
+        match &self {
+            LayoutId::System { kind: _, name } => name.as_str(),
+            LayoutId::Local(name) => name.as_str(),
+        }
+    }
+}
 
-    let input_names: Vec<&str> = inputs.iter()
+fn set_visible_layout(
-        .map(|(_kind, name)| name.as_str())
+    manager: manager::c::Manager,
-        .collect();
+    layout_id: LayoutId,
+) {
+    match layout_id {
+        LayoutId::System { kind, name } => set_layout(kind, name),
+        LayoutId::Local(name) => {
+            let name = CString::new(name.as_str()).unwrap();
+            let name_ptr = name.as_ptr();
+            unsafe {
+                manager::c::eekboard_context_service_set_overlay(
+                    manager,
+                    name_ptr,
+                )
+            }
+        },
+    }
+}
 
-    let translations = system_locale()
+/// Takes into account first any overlays, then system layouts from the list
+fn get_current_layout(
+    manager: manager::c::Manager,
+    system_layouts: &Vec<LayoutId>,
+) -> Option<LayoutId> {
+    match manager::get_overlay(manager) {
+        Some(name) => Some(LayoutId::Local(name)),
+        None => system_layouts.get(0).map(LayoutId::clone),
+    }
+}
+
+/// Translates all provided layout names according to current locale,
+/// for the purpose of display (i.e. errors will be caught and reported)
+fn translate_layout_names(layouts: &Vec<LayoutId>) -> Vec<OwnedTranslation> {
+    // This procedure is rather ugly...
+    // Xkb lookup *must not* be applied to non-system layouts,
+    // so both translators can't be merged into one lookup table,
+    // therefore must be done in two steps.
+    // `XkbInfo` being temporary also means
+    // that its return values must be copied,
+    // forcing the use of `OwnedTranslation`.
+    enum Status {
+        /// xkb names should get all translated here
+        Translated(OwnedTranslation),
+        /// Builtin names need builtin translations
+        Remaining(String),
+    }
+
+    // Attempt to take all xkb names from gnome-desktop's xkb info.
+    let xkb_translator = locale::XkbInfo::new();
+
+    let translated_names = layouts.iter()
+        .map(|id| match id {
+            LayoutId::System { name, kind: _ } => {
+                xkb_translator.get_display_name(name)
+                    .map(|s| Status::Translated(OwnedTranslation(s)))
+                    .or_print(
+                        logging::Problem::Surprise,
+                        &format!("No display name for xkb layout {}", name),
+                    ).unwrap_or_else(|| Status::Remaining(name.clone()))
+            },
+            LayoutId::Local(name) => Status::Remaining(name.clone()),
+        });
+
+    // Non-xkb layouts and weird xkb layouts
+    // still need to be looked up in the internal database.
+    let builtin_translations = system_locale()
         .map(|locale|
             locale.tags_for("messages")
                 .next().unwrap() // guaranteed to exist
                 .as_ref()
                 .to_owned()
         )
-        .and_then(|lang| resources::get_layout_names(lang.as_str()));
+        .or_print(logging::Problem::Surprise, "No locale detected")
-
+        .and_then(|lang| {
-    // sorted collection of human and machine names
+            resources::get_layout_names(lang.as_str())
-    let mut human_names: Vec<(&str, &str)> = match translations {
+                .or_print(
-        Some(translations) => {
+                    logging::Problem::Surprise,
-            input_names.iter()
+                    &format!("No translations for locale {}", lang),
-                .map(|name| (*name, *translations.get(name).unwrap_or(name)))
+                )
-                .collect()
-        },
-        // display bare codes
-        None => {
-            input_names.iter()
-                .map(|n| (*n, *n)) // turns &&str into &str
-                .collect()
-        }
-    };
-
-    human_names.sort_unstable_by(|(_, human_label_a), (_, human_label_b)| {
-        compare_current_locale(human_label_a, human_label_b)
         });
 
-    let builder = make_menu_builder(human_names);
+    match builtin_translations {
+        Some(translations) => {
+            translated_names
+                .map(|status| match status {
+                    Status::Remaining(name) => {
+                        translations.get(name.as_str())
+                            .unwrap_or(&Translation(name.as_str()))
+                            .to_owned()
+                    },
+                    Status::Translated(t) => t,
+                })
+                .collect()
+        },
+        None => {
+            translated_names
+                .map(|status| match status {
+                    Status::Remaining(name) => OwnedTranslation(name),
+                    Status::Translated(t) => t,
+                })
+                .collect()
+        },
+    }
+}
+
+pub fn show(
+    window: EekGtkKeyboard,
+    position: Bounds,
+    manager: manager::c::Manager,
+) {
+    unsafe { gtk::set_initialized() };
+    let window = unsafe { gtk::Widget::from_glib_none(window.0) };
+
+    let overlay_layouts = resources::get_overlays().into_iter()
+        .map(|name| LayoutId::Local(name.to_string()));
+
+    let settings = get_settings("org.gnome.desktop.input-sources");
+    let inputs = settings
+        .map(|settings| {
+            let inputs = settings.get_value("sources").unwrap();
+            variants::get_tuples(inputs)
+        })
+        .unwrap_or_else(|| Vec::new());
+    
+    let system_layouts: Vec<LayoutId> = inputs.into_iter()
+        .map(|(kind, name)| LayoutId::System { kind, name })
+        .collect();
+
+    let all_layouts: Vec<LayoutId> = system_layouts.clone()
+        .into_iter()
+        .chain(overlay_layouts)
+        .collect();
+
+    let translated_names = translate_layout_names(&all_layouts);
+    
+    // sorted collection of human and machine names
+    let mut human_names: Vec<(OwnedTranslation, LayoutId)> = translated_names
+        .into_iter()
+        .zip(all_layouts.clone().into_iter())
+        .collect();
+
+    human_names.sort_unstable_by(|(tr_a, _), (tr_b, _)| {
+        compare_current_locale(&tr_a.0, &tr_b.0)
+    });
+
+    // GVariant doesn't natively support `enum`s,
+    // so the `choices` vector will serve as a lookup table.
+    let choices_with_translations: Vec<(String, (OwnedTranslation, LayoutId))>
+        = human_names.into_iter()
+            .enumerate()
+                .map(|(i, human_entry)| {(
+                    format!("{}_{}", i, human_entry.1.get_name()),
+                    human_entry,
+                )}).collect();
+
+
+    let builder = make_menu_builder(
+        choices_with_translations.iter()
+            .map(|(id, (translation, _))| (id.as_str(), (*translation).clone()))
+            .collect()
+    );
+
+    let choices: Vec<(String, LayoutId)>
+        = choices_with_translations.into_iter()
+            .map(|(id, (_tr, layout))| (id, layout))
+            .collect();
+
     // Much more debuggable to populate the model & menu
     // from a string representation
     // than add items imperatively
@@ -195,27 +369,45 @@ pub fn show(window: EekGtkKeyboard, position: ::layout::c::Bounds) {
         height: position.width.floor() as i32,
     });
 
-    if let Some(current_name) = input_names.get(0) {
+    if let Some(current_layout) = get_current_layout(manager, &system_layouts) {
-        let current_name = current_name.to_variant();
+        let current_name_variant = choices.iter()
+            .find(
+                |(_id, layout)| layout == &current_layout
+            ).unwrap()
+            .0.to_variant();
 
         let layout_action = gio::SimpleAction::new_stateful(
             "layout",
-            Some(current_name.type_()),
+            Some(current_name_variant.type_()),
-            &current_name,
+            &current_name_variant,
         );
 
-        layout_action.connect_change_state(|_action, state| {
+        let menu_inner = menu.clone();
+        layout_action.connect_change_state(move |_action, state| {
             match state {
                 Some(v) => {
                     v.get::<String>()
-                        .or_else(|| {
+                        .or_print(
-                            eprintln!("Variant is not string: {:?}", v);
+                            logging::Problem::Bug,
-                            None
+                            &format!("Variant is not string: {:?}", v)
-                        })
+                        )
-                        .map(|state| set_layout("xkb".into(), state));
+                        .map(|state| {
+                            let (_id, layout) = choices.iter()
+                                .find(
+                                    |choices| state == choices.0
+                                ).unwrap();
+                            set_visible_layout(
+                                manager,
+                                layout.clone(),
+                            )
+                        });
                 },
-                None => eprintln!("No variant selected"),
+                None => log_print!(
+                    logging::Level::Debug,
+                    "No variant selected",
+                ),
             };
+            menu_inner.popdown();
         });
 
         let action_group = gio::SimpleActionGroup::new();

src/resources.rs

@@ -3,6 +3,7 @@
  */
 
 use std::collections::HashMap;
+use ::locale::Translation;
 
 use std::iter::FromIterator;
 
@@ -10,19 +11,26 @@ use std::iter::FromIterator;
 // and what a convenience layout. "_wide" is not a layout,
 // neither is "number"
 const KEYBOARDS: &[(*const str, *const str)] = &[
+    // layouts
     ("us", include_str!("../data/keyboards/us.yaml")),
     ("us_wide", include_str!("../data/keyboards/us_wide.yaml")),
     ("de", include_str!("../data/keyboards/de.yaml")),
     ("de_wide", include_str!("../data/keyboards/de_wide.yaml")),
-    ("el", include_str!("../data/keyboards/el.yaml")),
     ("es", include_str!("../data/keyboards/es.yaml")),
     ("fi", include_str!("../data/keyboards/fi.yaml")),
+    ("gr", include_str!("../data/keyboards/gr.yaml")),
     ("it", include_str!("../data/keyboards/it.yaml")),
     ("jp+kana", include_str!("../data/keyboards/jp+kana.yaml")),
     ("jp+kana_wide", include_str!("../data/keyboards/jp+kana_wide.yaml")),
     ("no", include_str!("../data/keyboards/no.yaml")),
     ("number", include_str!("../data/keyboards/number.yaml")),
+    ("pl", include_str!("../data/keyboards/pl.yaml")),
+    ("pl_wide", include_str!("../data/keyboards/pl_wide.yaml")),
     ("se", include_str!("../data/keyboards/se.yaml")),
+    // layout+overlay
+    ("terminal", include_str!("../data/keyboards/terminal.yaml")),
+    // Overlays
+    ("emoji", include_str!("../data/keyboards/emoji.yaml")),
 ];
 
 pub fn get_keyboard(needle: &str) -> Option<&'static str> {
@@ -39,6 +47,19 @@ pub fn get_keyboard(needle: &str) -> Option<&'static str> {
         })
 }
 
+const OVERLAY_NAMES: &[*const str] = &[
+    "emoji",
+    "terminal",
+];
+
+pub fn get_overlays() -> Vec<&'static str> {
+    OVERLAY_NAMES.iter()
+        .map(|name| {
+            let name: *const str = *name;
+            unsafe { &*name }
+        }).collect()
+}
+
 /// Translations of the layout identifier strings
 const LAYOUT_NAMES: &[(*const str, *const str)] = &[
     ("de-DE", include_str!("../data/langs/de-DE.txt")),
@@ -49,7 +70,7 @@ const LAYOUT_NAMES: &[(*const str, *const str)] = &[
 ];
 
 pub fn get_layout_names(lang: &str)
-    -> Option<HashMap<&'static str, &'static str>>
+    -> Option<HashMap<&'static str, Translation<'static>>>
 {
     let translations = LAYOUT_NAMES.iter()
         .find(|(name, _data)| {
@@ -63,7 +84,7 @@ pub fn get_layout_names(lang: &str)
     translations.map(make_mapping)
 }
 
-fn parse_line(line: &str) -> Option<(&str, &str)> {
+fn parse_line(line: &str) -> Option<(&str, Translation)> {
     let comment = line.trim().starts_with("#");
     if comment {
         None
@@ -71,11 +92,11 @@ fn parse_line(line: &str) -> Option<(&str, &str)> {
         let mut iter = line.splitn(2, " ");
         let name = iter.next().unwrap();
         // will skip empty and unfinished lines
-        iter.next().map(|tr| (name, tr.trim()))
+        iter.next().map(|tr| (name, Translation(tr.trim())))
     }
 }
 
-fn make_mapping(data: &str) -> HashMap<&str, &str> {
+fn make_mapping(data: &str) -> HashMap<&str, Translation> {
     HashMap::from_iter(
         data.split("\n")
             .filter_map(parse_line)
@@ -86,10 +107,17 @@ fn make_mapping(data: &str) -> HashMap<&str, &str> {
 mod test {
     use super::*;
 
+    #[test]
+    fn check_overlays_present() {
+        for name in get_overlays() {
+            assert!(get_keyboard(name).is_some());
+        }
+    }
+
     #[test]
     fn mapping_line() {
         assert_eq!(
-            Some(("name", "translation")),
+            Some(("name", Translation("translation"))),
             parse_line("name translation")
         );
     }

src/server-context-service.c

@@ -23,37 +23,40 @@
 #include "eek/eek.h"
 #include "eek/eek-gtk-keyboard.h"
 #include "eek/layersurface.h"
+#include "eekboard/eekboard-context-service.h"
+#include "submission.h"
 #include "wayland.h"
-
 #include "server-context-service.h"
 
 enum {
     PROP_0,
-    PROP_SIZE_CONSTRAINT_LANDSCAPE,
+    PROP_VISIBLE,
-    PROP_SIZE_CONSTRAINT_PORTRAIT,
     PROP_LAST
 };
 
 typedef struct _ServerContextServiceClass ServerContextServiceClass;
 
 struct _ServerContextService {
-    EekboardContextService parent;
+    GObject parent;
 
+    LayoutHolder *state; // unowned
+    /// Needed for instantiating the widget
+    struct submission *submission; // unowned
+    struct squeek_layout_state *layout;
+    struct ui_manager *manager; // unowned
+
+    gboolean visible;
     PhoshLayerSurface *window;
-    GtkWidget *widget;
+    GtkWidget *widget; // nullable
     guint hiding;
     guint last_requested_height;
-    enum squeek_arrangement_kind last_type;
-
-    gdouble size_constraint_landscape[2];
-    gdouble size_constraint_portrait[2];
 };
 
 struct _ServerContextServiceClass {
-    EekboardContextServiceClass parent_class;
+    GObjectClass parent_class;
 };
 
-G_DEFINE_TYPE (ServerContextService, server_context_service, EEKBOARD_TYPE_CONTEXT_SERVICE);
+G_DEFINE_TYPE(ServerContextService, server_context_service, G_TYPE_OBJECT);
 
 static void
 on_destroy (GtkWidget *widget, gpointer user_data)
@@ -65,39 +68,7 @@ on_destroy (GtkWidget *widget, gpointer user_data)
     context->window = NULL;
     context->widget = NULL;
 
-    eekboard_context_service_destroy (EEKBOARD_CONTEXT_SERVICE (context));
+    //eekboard_context_service_destroy (EEKBOARD_CONTEXT_SERVICE (context));
-}
-
-static void
-make_widget (ServerContextService *context);
-
-static void
-on_notify_keyboard (GObject              *object,
-                    GParamSpec           *spec,
-                    ServerContextService *context)
-{
-    const LevelKeyboard *keyboard = eekboard_context_service_get_keyboard (EEKBOARD_CONTEXT_SERVICE(context));
-
-    if (!keyboard)
-        g_error("Programmer error: keyboard layout was unset!");
-
-    // The keymap will get set even if the window is hidden.
-    // It's not perfect,
-    // but simpler than adding a check in the window showing procedure
-    eekboard_context_service_set_keymap(EEKBOARD_CONTEXT_SERVICE(context),
-                                        keyboard);
-
-    /* Recreate the keyboard widget to keep in sync with the keymap. */
-    if (context->window)
-        make_widget(context);
-
-    gboolean visible;
-    g_object_get (context, "visible", &visible, NULL);
-
-    if (visible) {
-        eekboard_context_service_hide_keyboard(EEKBOARD_CONTEXT_SERVICE(context));
-        eekboard_context_service_show_keyboard(EEKBOARD_CONTEXT_SERVICE(context));
-    }
 }
 
 static void
@@ -116,26 +87,6 @@ on_notify_unmap (GObject    *object,
     g_object_set (context, "visible", FALSE, NULL);
 }
 
-static uint32_t
-calculate_height(int32_t width)
-{
-    uint32_t height = 180;
-    if (width < 360 && width > 0) {
-        height = ((unsigned)width * 7 / 12); // to match 360×210
-    } else if (width < 540) {
-        height = 180 + (540 - (unsigned)width) * 30 / 180; // smooth transition
-    }
-    return height;
-}
-
-enum squeek_arrangement_kind get_type(uint32_t width, uint32_t height) {
-    (void)height;
-    if (width < 540) {
-        return ARRANGEMENT_KIND_BASE;
-    }
-    return ARRANGEMENT_KIND_WIDE;
-}
-
 static void
 on_surface_configure(PhoshLayerSurface *surface, ServerContextService *context)
 {
@@ -145,14 +96,8 @@ on_surface_configure(PhoshLayerSurface *surface, ServerContextService *context)
                  "configured-width", &width,
                  "configured-height", &height,
                  NULL);
-    // check if the change would switch types
-    enum squeek_arrangement_kind new_type = get_type((uint32_t)width, (uint32_t)height);
-    if (context->last_type != new_type) {
-        context->last_type = new_type;
-        eekboard_context_service_update_layout(EEKBOARD_CONTEXT_SERVICE(context), context->last_type);
-    }
 
-    guint desired_height = calculate_height(width);
+    guint desired_height = squeek_uiman_get_perceptual_height(context->manager);
     guint configured_height = (guint)height;
     // if height was already requested once but a different one was given
     // (for the same set of surrounding properties),
@@ -175,14 +120,14 @@ make_window (ServerContextService *context)
     if (context->window)
         g_error("Window already present");
 
-    struct wl_output *output = squeek_outputs_get_current(squeek_wayland->outputs);
+    struct squeek_output_handle output = squeek_outputs_get_current(squeek_wayland->outputs);
-    int32_t width = squeek_outputs_get_perceptual_width(squeek_wayland->outputs, output);
+    squeek_uiman_set_output(context->manager, output);
-    uint32_t height = calculate_height(width);
+    uint32_t height = squeek_uiman_get_perceptual_height(context->manager);
 
     context->window = g_object_new (
         PHOSH_TYPE_LAYER_SURFACE,
         "layer-shell", squeek_wayland->layer_shell,
-        "wl-output", output,
+        "wl-output", output.output,
         "height", height,
         "anchor", ZWLR_LAYER_SURFACE_V1_ANCHOR_BOTTOM
                   | ZWLR_LAYER_SURFACE_V1_ANCHOR_LEFT
@@ -194,6 +139,7 @@ make_window (ServerContextService *context)
         NULL
     );
 
+    squeek_uiman_set_surface(context->manager, context->window);
     g_object_connect (context->window,
                       "signal::destroy", G_CALLBACK(on_destroy), context,
                       "signal::map", G_CALLBACK(on_notify_map), context,
@@ -228,34 +174,11 @@ make_widget (ServerContextService *context)
         gtk_widget_destroy(context->widget);
         context->widget = NULL;
     }
-
+    context->widget = eek_gtk_keyboard_new (context->state, context->submission, context->layout);
-    LevelKeyboard *keyboard = eekboard_context_service_get_keyboard (EEKBOARD_CONTEXT_SERVICE(context));
-
-    context->widget = eek_gtk_keyboard_new (keyboard);
 
     gtk_widget_set_has_tooltip (context->widget, TRUE);
     gtk_container_add (GTK_CONTAINER(context->window), context->widget);
-    gtk_widget_show (context->widget);
+    gtk_widget_show_all(context->widget);
-}
-
-static void
-server_context_service_real_show_keyboard (EekboardContextService *_context)
-{
-    ServerContextService *context = SERVER_CONTEXT_SERVICE(_context);
-
-    if (context->hiding) {
-	    g_source_remove (context->hiding);
-	    context->hiding = 0;
-    }
-
-    if (!context->window)
-        make_window (context);
-    if (!context->widget)
-        make_widget (context);
-
-    EEKBOARD_CONTEXT_SERVICE_CLASS (server_context_service_parent_class)->
-        show_keyboard (_context);
-    gtk_widget_show (GTK_WIDGET(context->window));
 }
 
 static gboolean
@@ -268,20 +191,49 @@ on_hide (ServerContextService *context)
 }
 
 static void
-server_context_service_real_hide_keyboard (EekboardContextService *_context)
+server_context_service_real_show_keyboard (ServerContextService *context)
 {
-    ServerContextService *context = SERVER_CONTEXT_SERVICE(_context);
+    if (context->hiding) {
+	    g_source_remove (context->hiding);
+	    context->hiding = 0;
+    }
 
-    if (!context->hiding)
+    if (!context->window)
-	context->hiding = g_timeout_add (200, (GSourceFunc) on_hide, context);
+        make_window (context);
+    if (!context->widget)
+        make_widget (context);
 
-    EEKBOARD_CONTEXT_SERVICE_CLASS (server_context_service_parent_class)->
+    context->visible = TRUE;
-        hide_keyboard (_context);
+    gtk_widget_show (GTK_WIDGET(context->window));
 }
 
 static void
-server_context_service_real_destroyed (EekboardContextService *_context)
+server_context_service_real_hide_keyboard (ServerContextService *context)
 {
+    if (!context->hiding)
+        context->hiding = g_timeout_add (200, (GSourceFunc) on_hide, context);
+
+    context->visible = FALSE;
+}
+
+void
+server_context_service_show_keyboard (ServerContextService *context)
+{
+    g_return_if_fail (SERVER_IS_CONTEXT_SERVICE(context));
+
+    if (!context->visible) {
+        server_context_service_real_show_keyboard (context);
+    }
+}
+
+void
+server_context_service_hide_keyboard (ServerContextService *context)
+{
+    g_return_if_fail (SERVER_IS_CONTEXT_SERVICE(context));
+
+    if (context->visible) {
+        server_context_service_real_hide_keyboard (context);
+    }
 }
 
 static void
@@ -291,20 +243,10 @@ server_context_service_set_property (GObject      *object,
                                      GParamSpec   *pspec)
 {
     ServerContextService *context = SERVER_CONTEXT_SERVICE(object);
-    GVariant *variant;
 
     switch (prop_id) {
-    case PROP_SIZE_CONSTRAINT_LANDSCAPE:
+    case PROP_VISIBLE:
-        variant = g_value_get_variant (value);
+        context->visible = g_value_get_boolean (value);
-        g_variant_get (variant, "(dd)",
-                       &context->size_constraint_landscape[0],
-                       &context->size_constraint_landscape[1]);
-        break;
-    case PROP_SIZE_CONSTRAINT_PORTRAIT:
-        variant = g_value_get_variant (value);
-        g_variant_get (variant, "(dd)",
-                       &context->size_constraint_portrait[0],
-                       &context->size_constraint_portrait[1]);
         break;
 
     default:
@@ -313,6 +255,23 @@ server_context_service_set_property (GObject      *object,
     }
 }
 
+static void
+server_context_service_get_property (GObject    *object,
+                                       guint       prop_id,
+                                       GValue     *value,
+                                       GParamSpec *pspec)
+{
+    ServerContextService *context = SERVER_CONTEXT_SERVICE(object);
+    switch (prop_id) {
+    case PROP_VISIBLE:
+        g_value_set_boolean (value, context->visible);
+        break;
+    default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+        break;
+    }
+}
+
 static void
 server_context_service_dispose (GObject *object)
 {
@@ -327,54 +286,38 @@ server_context_service_dispose (GObject *object)
 static void
 server_context_service_class_init (ServerContextServiceClass *klass)
 {
-    EekboardContextServiceClass *context_class = EEKBOARD_CONTEXT_SERVICE_CLASS(klass);
     GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
     GParamSpec *pspec;
 
-    context_class->show_keyboard = server_context_service_real_show_keyboard;
-    context_class->hide_keyboard = server_context_service_real_hide_keyboard;
-    context_class->destroyed = server_context_service_real_destroyed;
-
     gobject_class->set_property = server_context_service_set_property;
+    gobject_class->get_property = server_context_service_get_property;
     gobject_class->dispose = server_context_service_dispose;
 
-    pspec = g_param_spec_variant ("size-constraint-landscape",
+    /**
-                                  "Size constraint landscape",
+     * Flag to indicate if keyboard is visible or not.
-                                  "Size constraint landscape",
+     */
-                                  G_VARIANT_TYPE("(dd)"),
+    pspec = g_param_spec_boolean ("visible",
-                                  NULL,
+                                  "Visible",
-                                  G_PARAM_WRITABLE);
+                                  "Visible",
+                                  FALSE,
+                                  G_PARAM_READWRITE);
     g_object_class_install_property (gobject_class,
-                                     PROP_SIZE_CONSTRAINT_LANDSCAPE,
+                                     PROP_VISIBLE,
-                                     pspec);
-
-    pspec = g_param_spec_variant ("size-constraint-portrait",
-                                  "Size constraint portrait",
-                                  "Size constraint portrait",
-                                  G_VARIANT_TYPE("(dd)"),
-                                  NULL,
-                                  G_PARAM_WRITABLE);
-    g_object_class_install_property (gobject_class,
-                                     PROP_SIZE_CONSTRAINT_PORTRAIT,
                                      pspec);
 }
 
 static void
-server_context_service_init (ServerContextService *context)
+server_context_service_init (ServerContextService *state) {
-{
+    (void)state;
-    g_signal_connect (context,
-                      "notify::keyboard",
-                      G_CALLBACK(on_notify_keyboard),
-                      context);
 }
 
-EekboardContextService *
+ServerContextService *
-server_context_service_new ()
+server_context_service_new (LayoutHolder *state, struct submission *submission, struct squeek_layout_state *layout, struct ui_manager *uiman)
 {
-    return EEKBOARD_CONTEXT_SERVICE(g_object_new (SERVER_TYPE_CONTEXT_SERVICE, NULL));
+    ServerContextService *ui = g_object_new (SERVER_TYPE_CONTEXT_SERVICE, NULL);
-}
+    ui->submission = submission;
-
+    ui->state = state;
-enum squeek_arrangement_kind server_context_service_get_layout_type(EekboardContextService *service)
+    ui->layout = layout;
-{
+    ui->manager = uiman;
-    return SERVER_CONTEXT_SERVICE(service)->last_type;
+    return ui;
 }

src/server-context-service.h

@@ -18,8 +18,9 @@
 #ifndef SERVER_CONTEXT_SERVICE_H
 #define SERVER_CONTEXT_SERVICE_H 1
 
-#include "eekboard/eekboard-service.h"
 #include "src/layout.h"
+#include "src/submission.h"
+#include "ui_manager.h"
 
 G_BEGIN_DECLS
 
@@ -30,12 +31,16 @@ G_BEGIN_DECLS
 #define SERVER_IS_CONTEXT_SERVICE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SERVER_TYPE_CONTEXT_SERVICE))
 #define SERVER_CONTEXT_SERVICE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SERVER_TYPE_CONTEXT_SERVICE, ServerContextServiceClass))
 
-/** Manages the liecycle of the window displaying layouts. */
+/** Manages the lifecycle of the window displaying layouts. */
 typedef struct _ServerContextService ServerContextService;
 
-EekboardContextService *server_context_service_new ();
+GType         server_context_service_get_type
-enum squeek_arrangement_kind server_context_service_get_layout_type(EekboardContextService*);
+                                              (void) G_GNUC_CONST;
 
+ServerContextService *server_context_service_new(LayoutHolder *state, struct submission *submission, struct squeek_layout_state *layout, struct ui_manager *uiman);
+enum squeek_arrangement_kind server_context_service_get_layout_type(ServerContextService *);
+void server_context_service_show_keyboard (ServerContextService *context);
+void server_context_service_hide_keyboard (ServerContextService *context);
 G_END_DECLS
 #endif  /* SERVER_CONTEXT_SERVICE_H */
 

src/server-main.c

@@ -25,11 +25,14 @@
 
 #include "config.h"
 
-#include "eekboard/eekboard-service.h"
 #include "eek/eek.h"
-#include "imservice.h"
+#include "eekboard/eekboard-context-service.h"
+#include "dbus.h"
+#include "layout.h"
 #include "outputs.h"
+#include "submission.h"
 #include "server-context-service.h"
+#include "ui_manager.h"
 #include "wayland.h"
 
 #include <gdk/gdkwayland.h>
@@ -37,9 +40,14 @@
 
 /// Global application state
 struct squeekboard {
-    struct squeek_wayland wayland;
+    struct squeek_wayland wayland; // Just hooks.
-    EekboardContextService *context;
+    DBusHandler *dbus_handler; // Controls visibility of the OSK.
-    struct imservice *imservice;
+    LayoutHolder *layout_holder; // Currently used layout & keyboard.
+    ServerContextService *ui_context; // mess, includes the entire UI
+    struct submission *submission; // Wayland text input handling.
+    struct squeek_layout_state layout_choice; // Currently wanted layout.
+    struct ui_manager *ui_manager; // UI shape tracker/chooser. TODO: merge with layuot choice
+    struct gsettings_tracker gsettings_tracker; // Gsettings handling.
 };
 
 
@@ -64,31 +72,14 @@ on_name_lost (GDBusConnection *connection,
               gpointer         user_data)
 {
     // TODO: could conceivable continue working
+    // if intrnal changes stop sending dbus changes
     (void)connection;
     (void)name;
     (void)user_data;
+    g_error("DBus unavailable, unclear how to continue.");
     exit (1);
 }
 
-static void
-on_destroyed (EekboardService *service,
-              gpointer      user_data)
-{
-    (void)service;
-    GMainLoop *loop = user_data;
-
-    g_main_loop_quit (loop);
-}
-
-static EekboardContextService *create_context() {
-    EekboardContextService *context = server_context_service_new ();
-    g_object_set_data_full (G_OBJECT(context),
-                            "owner", g_strdup ("sender"),
-                            (GDestroyNotify)g_free);
-    eekboard_context_service_enable (context);
-    return context;
-}
-
 // Wayland
 
 static void
@@ -209,8 +200,14 @@ main (int argc, char **argv)
         exit(1);
     }
 
-    instance.context = create_context();
+    if (!instance.wayland.input_method_manager) {
+        g_warning("Wayland input method interface not available");
+    }
 
+    instance.ui_manager = squeek_uiman_new(instance.wayland.outputs);
+
+    instance.layout_holder = eek_layout_holder_new(&instance.layout_choice);
+    eek_gsettings_tracker_init(&instance.gsettings_tracker, instance.layout_holder, &instance.layout_choice);
     // set up dbus
 
     // TODO: make dbus errors non-always-fatal
@@ -232,9 +229,9 @@ main (int argc, char **argv)
         error = NULL;
         connection = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
         if (connection == NULL) {
-            g_printerr ("Can't connect to the bus: %s\n", error->message);
+            g_printerr ("Can't connect to the bus: %s. "
+                        "Visibility switching unavailable.", error->message);
             g_error_free (error);
-            exit (1);
         }
         break;
     case G_BUS_TYPE_NONE:
@@ -256,18 +253,19 @@ main (int argc, char **argv)
         g_assert_not_reached ();
         break;
     }
-
+    guint owner_id = 0;
-    EekboardService *service = eekboard_service_new (connection, EEKBOARD_SERVICE_PATH);
+    DBusHandler *service = NULL;
+    if (connection) {
+        service = dbus_handler_new(connection, DBUS_SERVICE_PATH);
 
         if (service == NULL) {
             g_printerr ("Can't create dbus server\n");
             exit (1);
-    } else {
-        eekboard_service_set_context(service, instance.context);
         }
+        instance.dbus_handler = service;
 
-    guint owner_id = g_bus_own_name_on_connection (connection,
+        owner_id = g_bus_own_name_on_connection (connection,
-                                             EEKBOARD_SERVICE_INTERFACE,
+                                                 DBUS_SERVICE_INTERFACE,
                                                  G_BUS_NAME_OWNER_FLAGS_NONE,
                                                  on_name_acquired,
                                                  on_name_lost,
@@ -277,30 +275,47 @@ main (int argc, char **argv)
             g_printerr ("Can't own the name\n");
             exit (1);
         }
-
-    struct imservice *imservice = NULL;
-    if (instance.wayland.input_method_manager) {
-        imservice = get_imservice(instance.context,
-                                  instance.wayland.input_method_manager,
-                                  instance.wayland.seat);
-        if (imservice) {
-            instance.imservice = imservice;
-        } else {
-            g_warning("Failed to register as an input method");
     }
+
+    instance.submission = get_submission(instance.wayland.input_method_manager,
+                                         instance.wayland.virtual_keyboard_manager,
+                                         instance.wayland.seat,
+                                         instance.layout_holder);
+
+    eek_layout_holder_set_submission(instance.layout_holder, instance.submission);
+
+    ServerContextService *ui_context = server_context_service_new(
+                instance.layout_holder,
+                instance.submission,
+                &instance.layout_choice,
+                instance.ui_manager);
+    if (!ui_context) {
+        g_error("Could not initialize GUI");
+        exit(1);
+    }
+    instance.ui_context = ui_context;
+    if (instance.submission) {
+        submission_set_ui(instance.submission, instance.ui_context);
+    }
+    if (instance.dbus_handler) {
+        dbus_handler_set_ui_context(instance.dbus_handler, instance.ui_context);
     }
 
     session_register();
 
     GMainLoop *loop = g_main_loop_new (NULL, FALSE);
 
-    g_signal_connect (service, "destroyed", G_CALLBACK(on_destroyed), loop);
-
     g_main_loop_run (loop);
 
+    if (connection) {
+        if (service) {
+            if (owner_id != 0) {
                 g_bus_unown_name (owner_id);
+            }
             g_object_unref (service);
+        }
         g_object_unref (connection);
+    }
     g_main_loop_unref (loop);
 
     squeek_wayland_deinit (&instance.wayland);

src/style.rs

@@ -16,12 +16,13 @@
  * License along with this library. If not, see <http://www.gnu.org/licenses/>.Free
  */
 
-/*! CSS data loading */
+/*! CSS data loading. */
 
 use std::env;
+use ::logging;
 
 use glib::object::ObjectExt;
-use util::Warn;
+use logging::Warn;
 
 /// Gathers stuff defined in C or called by C
 pub mod c {
@@ -83,7 +84,11 @@ fn get_theme_name(settings: &gtk::Settings) -> GtkTheme {
         .map_err(|e| {
             match &e {
                 env::VarError::NotPresent => {},
-                e => eprintln!("GTK_THEME variable invalid: {}", e),
+                // maybe TODO: forward this warning?
+                e => log_print!(
+                    logging::Level::Surprise,
+                    "GTK_THEME variable invalid: {}", e,
+                ),
             };
             e
         }).ok();
@@ -93,13 +98,13 @@ fn get_theme_name(settings: &gtk::Settings) -> GtkTheme {
         None => GtkTheme {
             name: {
                 settings.get_property("gtk-theme-name")
-                    .ok_warn("No theme name")
+                    .or_print(logging::Problem::Surprise, "No theme name")
                     .and_then(|value| value.get::<String>())
                     .unwrap_or(DEFAULT_THEME_NAME.into())
             },
             variant: {
                 settings.get_property("gtk-application-prefer-dark-theme")
-                    .ok_warn("No settings key")
+                    .or_print(logging::Problem::Surprise, "No settings key")
                     .and_then(|value| value.get::<bool>())
                     .and_then(|dark_preferred| match dark_preferred {
                         true => Some("dark".into()),

src/submission.h

@@ -0,0 +1,19 @@
+#ifndef __SUBMISSION_H
+#define __SUBMISSION_H
+
+#include "input-method-unstable-v2-client-protocol.h"
+#include "virtual-keyboard-unstable-v1-client-protocol.h"
+#include "eek/eek-types.h"
+
+struct submission;
+
+struct submission* get_submission(struct zwp_input_method_manager_v2 *immanager,
+                                  struct zwp_virtual_keyboard_manager_v1 *vkmanager,
+                                  struct wl_seat *seat,
+                                  LayoutHolder *state);
+
+// Defined in Rust
+struct submission* submission_new(struct zwp_input_method_v2 *im, struct zwp_virtual_keyboard_v1 *vk, LayoutHolder *state);
+void submission_set_ui(struct submission *self, ServerContextService *ui_context);
+void submission_set_keyboard(struct submission *self, LevelKeyboard *keyboard);
+#endif

src/submission.rs

@@ -1,69 +1,246 @@
-/*! Managing the events belonging to virtual-keyboard interface. */
+/*! Managing the state of text input in the application.
+ * 
+ * This is a library module.
+ * 
+ * It needs to combine text-input and virtual-keyboard protocols
+ * to achieve a consistent view of the text-input state,
+ * and to submit exactly what the user wanted.
+ * 
+ * It must also not get tripped up by sudden disappearances of interfaces.
+ * 
+ * The virtual-keyboard interface is always present.
+ * 
+ * The text-input interface may not be presented,
+ * and, for simplicity, no further attempt to claim it is made.
+ * 
+ * The text-input interface may be enabled and disabled at arbitrary times,
+ * and those events SHOULD NOT cause any lost events.
+ * */
 
-use ::keyboard::{ KeyState, PressType };
+use std::collections::HashSet;
+use std::ffi::CString;
+use ::action::Modifier;
+use ::imservice;
+use ::imservice::IMService;
+use ::keyboard::{ KeyCode, KeyStateId, Modifiers, PressType };
+use ::util::vec_remove;
+use ::vkeyboard::VirtualKeyboard;
+
+// traits
+use std::iter::FromIterator;
 
 /// Gathers stuff defined in C or called by C
 pub mod c {
+    use super::*;
+    
     use std::os::raw::c_void;
 
+    use ::imservice::c::InputMethod;
+    use ::layout::c::LevelKeyboard;
+    use ::vkeyboard::c::ZwpVirtualKeyboardV1;
+
+    // The following defined in C
+
+    /// ServerContextService*
     #[repr(transparent)]
-    #[derive(Clone, Copy)]
+    pub struct UIManager(*const c_void);
-    pub struct ZwpVirtualKeyboardV1(*const c_void);
+
+    /// EekboardContextService*
+    #[repr(transparent)]
+    pub struct StateManager(*const c_void);
 
     #[no_mangle]
-    extern "C" {
+    pub extern "C"
-        /// Checks if point falls within bounds,
+    fn submission_new(
-        /// which are relative to origin and rotated by angle (I think)
+        im: *mut InputMethod,
-        pub fn eek_virtual_keyboard_v1_key(
+        vk: ZwpVirtualKeyboardV1,
-            virtual_keyboard: ZwpVirtualKeyboardV1,
+        state_manager: *const StateManager
-            timestamp: u32,
+    ) -> *mut Submission {
-            keycode: u32,
+        let imservice = if im.is_null() {
-            press: u32,
+            None
-        );
+        } else {
+            Some(IMService::new(im, state_manager))
+        };
+        // TODO: add vkeyboard too
+        Box::<Submission>::into_raw(Box::new(
+            Submission {
+                imservice,
+                modifiers_active: Vec::new(),
+                virtual_keyboard: VirtualKeyboard(vk),
+                pressed: Vec::new(),
+            }
+        ))
+    }
+
+    /// Use to initialize the UI reference
+    #[no_mangle]
+    pub extern "C"
+    fn submission_set_ui(submission: *mut Submission, ui_manager: *const UIManager) {
+        if submission.is_null() {
+            panic!("Null submission pointer");
+        }
+        let submission: &mut Submission = unsafe { &mut *submission };
+        if let Some(ref mut imservice) = &mut submission.imservice {
+            imservice.ui_manager = if ui_manager.is_null() {
+                None
+            } else {
+                Some(ui_manager)
+            }
+        };
+    }
+
+    #[no_mangle]
+    pub extern "C"
+    fn submission_set_keyboard(submission: *mut Submission, keyboard: LevelKeyboard) {
+        if submission.is_null() {
+            panic!("Null submission pointer");
+        }
+        let submission: &mut Submission = unsafe { &mut *submission };
+        submission.virtual_keyboard.update_keymap(keyboard);
     }
 }
 
 #[derive(Clone, Copy)]
 pub struct Timestamp(pub u32);
 
-/// Layout-independent backend. TODO: Have one instance per program or seat
+enum SubmittedAction {
-pub struct VirtualKeyboard(pub c::ZwpVirtualKeyboardV1);
+    /// A collection of keycodes that were pressed
+    VirtualKeyboard(Vec<KeyCode>),
+    IMService,
+}
 
-impl VirtualKeyboard {
+pub struct Submission {
-    // TODO: split out keyboard state management
+    imservice: Option<Box<IMService>>,
-    pub fn switch(
+    virtual_keyboard: VirtualKeyboard,
-        &self,
+    modifiers_active: Vec<(KeyStateId, Modifier)>,
-        key: &mut KeyState,
+    pressed: Vec<(KeyStateId, SubmittedAction)>,
-        action: PressType,
+}
-        timestamp: Timestamp,
+
+pub enum SubmitData<'a> {
+    Text(&'a CString),
+    Erase,
+    Keycodes,
+}
+
+impl Submission {
+    /// Sends a submit text event if possible;
+    /// otherwise sends key press and makes a note of it
+    pub fn handle_press(
+        &mut self,
+        key_id: KeyStateId,
+        data: SubmitData,
+        keycodes: &Vec<KeyCode>,
+        time: Timestamp,
     ) {
-        key.pressed = action.clone();
+        let mods_are_on = !self.modifiers_active.is_empty();
 
-        let keycodes_count = key.keycodes.len();
+        let was_committed_as_text = match (&mut self.imservice, mods_are_on) {
-        for keycode in key.keycodes.iter() {
+            (Some(imservice), false) => {
-            let keycode = keycode - 8;
+                enum Outcome {
-            match (&key.pressed, keycodes_count) {
+                    Submitted(Result<(), imservice::SubmitError>),
-                // Pressing a key made out of a single keycode is simple:
+                    NotSubmitted,
-                // press on press, release on release.
+                };
-                (_, 1) => unsafe {
+
-                    c::eek_virtual_keyboard_v1_key(
+                let submit_outcome = match data {
-                        self.0, timestamp.0, keycode, action.clone() as u32
+                    SubmitData::Text(text) => {
-                    );
+                        Outcome::Submitted(imservice.commit_string(text))
                     },
-                // A key made of multiple keycodes
+                    SubmitData::Erase => {
-                // has to submit them one after the other
+                        /* Delete_surrounding_text takes byte offsets,
-                (PressType::Pressed, _) => unsafe {
+                         * so cannot work without get_surrounding_text.
-                    c::eek_virtual_keyboard_v1_key(
+                         * This is a bug in the protocol.
-                        self.0, timestamp.0, keycode, PressType::Pressed as u32
+                         */
-                    );
+                        // imservice.delete_surrounding_text(1, 0),
-                    c::eek_virtual_keyboard_v1_key(
+                        Outcome::NotSubmitted
-                        self.0, timestamp.0, keycode, PressType::Released as u32
-                    );
                     },
-                // Design choice here: submit multiple all at press time
+                    SubmitData::Keycodes => Outcome::NotSubmitted,
-                // and do nothing at release time
+                };
-                (PressType::Released, _) => {},
+
-            }
+                match submit_outcome {
-        }
+                    Outcome::Submitted(result) => {
+                        match result.and_then(|()| imservice.commit()) {
+                            Ok(()) => true,
+                            Err(imservice::SubmitError::NotActive) => false,
+                        }
+                    },
+                    Outcome::NotSubmitted => false,
+                }
+            },
+            (_, _) => false,
+        };
+
+        let submit_action = match was_committed_as_text {
+            true => SubmittedAction::IMService,
+            false => {
+                self.virtual_keyboard.switch(
+                    keycodes,
+                    PressType::Pressed,
+                    time,
+                );
+                SubmittedAction::VirtualKeyboard(keycodes.clone())
+            },
+        };
+        
+        self.pressed.push((key_id, submit_action));
+    }
+    
+    pub fn handle_release(&mut self, key_id: KeyStateId, time: Timestamp) {
+        let index = self.pressed.iter().position(|(id, _)| *id == key_id);
+        if let Some(index) = index {
+            let (_id, action) = self.pressed.remove(index);
+            match action {
+                // string already sent, nothing to do
+                SubmittedAction::IMService => {},
+                // no matter if the imservice got activated,
+                // keys must be released
+                SubmittedAction::VirtualKeyboard(keycodes) => {
+                    self.virtual_keyboard.switch(
+                        &keycodes,
+                        PressType::Released,
+                        time,
+                    )
+                },
+            }
+        };
+    }
+    
+    pub fn handle_add_modifier(
+        &mut self,
+        key_id: KeyStateId,
+        modifier: Modifier, _time: Timestamp,
+    ) {
+        self.modifiers_active.push((key_id, modifier));
+        self.update_modifiers();
+    }
+
+    pub fn handle_drop_modifier(
+        &mut self,
+        key_id: KeyStateId,
+        _time: Timestamp,
+    ) {
+        vec_remove(&mut self.modifiers_active, |(id, _)| *id == key_id);
+        self.update_modifiers();
+    }
+
+    fn update_modifiers(&mut self) {
+        let raw_modifiers = self.modifiers_active.iter()
+            .map(|(_id, m)| match m {
+                Modifier::Control => Modifiers::CONTROL,
+                Modifier::Alt => Modifiers::MOD1,
+            })
+            .fold(Modifiers::empty(), |m, n| m | n);
+        self.virtual_keyboard.set_modifiers_state(raw_modifiers);
+    }
+
+    pub fn is_modifier_active(&self, modifier: Modifier) -> bool {
+        self.modifiers_active.iter()
+            .position(|(_id, m)| *m == modifier)
+            .is_some()
+    }
+
+    pub fn get_active_modifiers(&self) -> HashSet<Modifier> {
+        HashSet::from_iter(
+            self.modifiers_active.iter().map(|(_id, m)| m.clone())
+        )
     }
 }

src/tests.rs

@@ -1,17 +1,22 @@
 /*! Testing functionality */
 
 use ::data::Layout;
+use ::logging;
 use xkbcommon::xkb;
 
-use ::util::WarningHandler;
-
 
 pub struct CountAndPrint(u32);
 
-impl WarningHandler for CountAndPrint {
+impl logging::Handler for CountAndPrint {
-    fn handle(&mut self, warning: &str) {
+    fn handle(&mut self, level: logging::Level, warning: &str) {
-        self.0 = self.0 + 1;
+        use logging::Level::*;
-        println!("{}", warning);
+        match level {
+            Panic | Bug | Error | Warning | Surprise => {
+                self.0 += 1;
+            },
+            _ => {}
+        }
+        logging::Print{}.handle(level, warning)
     }
 }
 
@@ -34,7 +39,7 @@ fn check_layout(layout: Layout) {
     let (layout, handler) = layout.build(handler);
 
     if handler.0 > 0 {
-        println!("{} mistakes in layout", handler.0)
+        println!("{} problems while parsing layout", handler.0)
     }
 
     let layout = layout.expect("layout broken");
@@ -55,7 +60,7 @@ fn check_layout(layout: Layout) {
     let state = xkb::State::new(&keymap);
     
     // "Press" each button with keysyms
-    for view in layout.views.values() {
+    for (_pos, view) in layout.views.values() {
         for (_y, row) in &view.get_rows() {
             for (_x, button) in &row.buttons {
                 let keystate = button.state.borrow();

src/ui_manager.c

@@ -0,0 +1,8 @@
+#include "eek/layersurface.h"
+
+void squeek_manager_set_surface_height(PhoshLayerSurface *surface, uint32_t desired_height) {
+    phosh_layer_surface_set_size(surface, 0,
+                             (gint)desired_height);
+    phosh_layer_surface_set_exclusive_zone(surface, (gint)desired_height);
+    phosh_layer_surface_wl_surface_commit (surface);
+}

src/ui_manager.h

@@ -0,0 +1,15 @@
+#ifndef UI_MANAGER__
+#define UI_MANAGER__
+
+#include <inttypes.h>
+#include "eek/layersurface.h"
+#include "outputs.h"
+
+struct ui_manager;
+
+struct ui_manager *squeek_uiman_new(struct squeek_outputs *outputs);
+void squeek_uiman_set_output(struct ui_manager *uiman, struct squeek_output_handle output);
+void squeek_uiman_set_surface(struct ui_manager *uiman, PhoshLayerSurface *surface);
+uint32_t squeek_uiman_get_perceptual_height(struct ui_manager *uiman);
+
+#endif

src/ui_manager.rs

@@ -0,0 +1,241 @@
+/* Copyright (C) 2020 Purism SPC
+ * SPDX-License-Identifier: GPL-3.0+
+ */
+
+/*! Centrally manages the shape of the UI widgets, and the choice of layout.
+ * 
+ * Coordinates this based on information collated from all possible sources.
+ */
+
+use std::cell::RefCell;
+use std::cmp::min;
+use std::rc::Rc;
+
+use ::logging;
+use ::outputs::{ OutputId, Outputs, OutputState};
+use ::outputs::c::OutputHandle;
+
+// Traits
+use ::logging::Warn;
+
+mod c {
+    use super::*;
+    use std::os::raw::c_void;
+    use ::outputs::c::COutputs;
+    use ::util::c::Wrapped;
+
+    #[derive(Clone, Copy)]
+    #[repr(C)]
+    pub struct PhoshLayerSurface(*const c_void);
+
+    extern "C" {
+        // Rustc wrongly assumes
+        // that COutputs allows C direct access to the underlying RefCell.
+        #[allow(improper_ctypes)]
+        pub fn squeek_manager_set_surface_height(
+            surface: PhoshLayerSurface,
+            height: u32,
+        );
+    }
+
+    #[no_mangle]
+    pub extern "C"
+    fn squeek_uiman_new(outputs: COutputs) -> Wrapped<Manager> {
+        let uiman_raw = Wrapped::new(Manager::new());
+        if !outputs.is_null() {
+            let uiman = uiman_raw.clone_ref();
+            let outputs = outputs.clone_ref();
+            let mut outputs = outputs.borrow_mut();
+            register_output_man(uiman, &mut outputs);
+        }
+        uiman_raw
+    }
+
+    /// Used to size the layer surface containing all the OSK widgets.
+    #[no_mangle]
+    pub extern "C"
+    fn squeek_uiman_get_perceptual_height(
+        uiman: Wrapped<Manager>,
+    ) -> u32 {
+        let uiman = uiman.clone_ref();
+        let uiman = uiman.borrow();
+        // TODO: what to do when there's no output?
+        uiman.state.get_perceptual_height().unwrap_or(0)
+    }
+
+    #[no_mangle]
+    pub extern "C"
+    fn squeek_uiman_set_output(
+        uiman: Wrapped<Manager>,
+        output: OutputHandle,
+    ) {
+        let uiman = uiman.clone_ref();
+        let mut uiman = uiman.borrow_mut();
+        uiman.set_output(output)
+    }
+
+    #[no_mangle]
+    pub extern "C"
+    fn squeek_uiman_set_surface(
+        uiman: Wrapped<Manager>,
+        surface: PhoshLayerSurface,
+    ) {
+        let uiman = uiman.clone_ref();
+        let mut uiman = uiman.borrow_mut();
+        // Surface is not state, so doesn't need to propagate updates.
+        uiman.surface = Some(surface);
+    }
+}
+
+/// Stores current state of all things influencing what the UI should look like.
+#[derive(Clone, PartialEq)]
+pub struct ManagerState {
+    current_output: Option<(OutputId, OutputState)>,
+    //// Pixel size of the surface. Needs explicit updating.
+    //surface_size: Option<Size>,
+}
+
+impl ManagerState {
+    /// The largest ideal heigth for the keyboard as a whole
+    /// judged by the ease of hitting targets within.
+    /// Ideally related to finger size, the crammedness of the layout,
+    /// distance from display, and motor skills of the user.
+    // FIXME: Start by making this aware of display's dpi,
+    // then layout number of rows.
+    fn get_max_target_height(output: &OutputState) -> u32 {
+        let layout_rows = 4; // FIXME: use number from layout.
+        let px_size = output.get_pixel_size();
+        let phys_size = output.get_phys_size();
+
+        let finger_height_px = match (px_size, phys_size) {
+            (Some(px_size), Some(phys_size)) => {
+                // Fudged to result in 420px from the original design.
+                // That gives about 9.5mm per finger height.
+                // Maybe floats are not the best choice here,
+                // but it gets rounded ASAP. Consider rationals.
+                let keyboard_fraction_of_display: f64 = 420. / 1440.;
+                let keyboard_mm = keyboard_fraction_of_display * 130.;
+                let finger_height_mm = keyboard_mm / 4.;
+                // TODO: Take into account target shape/area, not just height.
+                finger_height_mm * px_size.height as f64 / phys_size.height as f64
+            },
+            (_, None) => output.scale as f64 * 52.5, // match total 420px at scale 2 from original design
+            (None, Some(_)) => {
+                log_print!(
+                    logging::Level::Surprise,
+                    "Output has physical size data but no pixel info",
+                );
+                output.scale as f64 * 52.5
+            },
+        };
+        (layout_rows as f64 * finger_height_px) as u32
+    }
+
+    fn get_perceptual_height(&self) -> Option<u32> {
+        let output_info = (&self.current_output).as_ref()
+            .map(|(_id, os)| (
+                os.scale as u32,
+                os.get_pixel_size(),
+                ManagerState::get_max_target_height(&os),
+            ));
+        match output_info {
+            Some((scale, Some(px_size), target_height)) => Some({
+                let height = if (px_size.width < 720) & (px_size.width > 0) {
+                    px_size.width * 7 / 12 // to match 360×210
+                } else if px_size.width < 1080 {
+                    360 + (1080 - px_size.width) * 60 / 360 // smooth transition
+                } else {
+                    360
+                };
+
+                // Don't exceed half the display size.
+                let height = min(height, px_size.height / 2);
+                // Don't waste screen space by exceeding best target height.
+                let height = min(height, target_height);
+                height / scale
+            }),
+            Some((scale, None, _)) => Some(360 / scale),
+            None => None,
+        }
+    }
+}
+
+pub struct Manager {
+    state: ManagerState,
+    surface: Option<c::PhoshLayerSurface>,
+}
+
+impl Manager {
+    fn new() -> Manager {
+        Manager {
+            state: ManagerState { current_output: None, },
+            surface: None,
+        }
+    }
+    fn set_output(&mut self, output: OutputHandle) {
+        let output_state = output.get_state()
+            .or_warn(
+                &mut logging::Print,
+                logging::Problem::Bug,
+                // This is really bad. It only happens when the layer surface
+                // is placed, and it happens once.
+                // The layer surface is on an output that can't be tracked.
+                "Tried to set output that's not known to exist. Ignoring.",
+            );
+        self.state.current_output = output_state.map(
+            |state| (output.get_id(), state)
+        );
+        // TODO: At the time of writing, this function is only used once,
+        // before the layer surface is initialized.
+        // Therefore it doesn't update anything. Maybe it should in the future,
+        // if it sees more use.
+    }
+
+    fn handle_output_change(&mut self, output: OutputHandle) {
+        let (id, output_state) = match &self.state.current_output {
+            Some((id, state)) => {
+                if *id != output.get_id() { return } // Not the current output.
+                else { (id.clone(), state.clone()) }
+            },
+            None => return, // Keyboard isn't on any output.
+        };
+        if let Some(new_output_state) = output.get_state() {
+            if new_output_state != output_state {
+                let new_state = ManagerState {
+                    current_output: Some((id.clone(), new_output_state)),
+                    ..self.state.clone()
+                };
+                if let Some(surface) = &self.surface {
+                    let new_height = new_state.get_perceptual_height();
+                    if new_height != self.state.get_perceptual_height() {
+                        // TODO: here hard-size the keyboard and suggestion box too.
+                        match new_height {
+                            Some(new_height) => unsafe {
+                                c::squeek_manager_set_surface_height(
+                                    *surface,
+                                    new_height,
+                                )
+                            }
+                            None => log_print!(
+                                logging::Level::Bug,
+                                "Can't calculate new size",
+                            ),
+                        }
+                    }
+                }
+                self.state = new_state;
+            }
+        };
+    }
+}
+
+fn register_output_man(
+    ui_man: Rc<RefCell<Manager>>,
+    output_man: &mut Outputs,
+) {
+    let ui_man = ui_man.clone();
+    output_man.set_update_cb(Box::new(move |output: OutputHandle| {
+        let mut ui_man = ui_man.borrow_mut();
+        ui_man.handle_output_change(output)
+    }))
+}

src/util.rs

@@ -21,6 +21,7 @@ pub mod c {
     
     use std::borrow::ToOwned;
     
+    // The lifetime on input limits the existence of the result
     pub fn as_str(s: &*const c_char) -> Result<Option<&str>, Utf8Error> {
         if s.is_null() {
             Ok(None)
@@ -93,11 +94,13 @@ pub mod c {
         }
         /// Extracts the reference to the data.
         /// It may cause problems if attempted in more than one place
+        // FIXME: check for null
         pub unsafe fn unwrap(self) -> Rc<RefCell<T>> {
             Rc::from_raw(self.0)
         }
         
-        /// Creates a new Rc reference to the same data
+        /// Creates a new Rc reference to the same data.
+        /// Use for accessing the underlying data as a reference.
         pub fn clone_ref(&self) -> Rc<RefCell<T>> {
             // A bit dangerous: the Rc may be in use elsewhere
             let used_rc = unsafe { Rc::from_raw(self.0) };
@@ -105,6 +108,10 @@ pub mod c {
             Rc::into_raw(used_rc); // prevent dropping the original reference
             rc
         }
+
+        pub fn is_null(&self) -> bool {
+            self.0.is_null()
+        }
     }
     
     impl<T> Clone for Wrapped<T> {
@@ -129,6 +136,7 @@ pub mod c {
     impl<T> COpaquePtr for Wrapped<T> {}
 }
 
+/// Clones the underlying data structure, like ToOwned.
 pub trait CloneOwned {
     type Owned;
     fn clone_owned(&self) -> Self::Owned;
@@ -189,27 +197,17 @@ impl<T> Borrow<Rc<T>> for Pointer<T> {
     }
 }
 
-/// Sugar for logging errors in results
-pub trait Warn {
-    type Value;
-    fn ok_warn(self, msg: &str) -> Option<Self::Value>;
-}
-
-impl<T, E: std::error::Error> Warn for Result<T, E> {
-    type Value = T;
-    fn ok_warn(self, msg: &str) -> Option<T> {
-        self.map_err(|e| {
-            eprintln!("{}: {}", msg, e);
-            e
-        }).ok()
-    }
-}
-
 pub trait WarningHandler {
     /// Handle a warning
     fn handle(&mut self, warning: &str);
 }
 
+/// Removes the first matcing item
+pub fn vec_remove<T, F: FnMut(&T) -> bool>(v: &mut Vec<T>, pred: F) -> Option<T> {
+    let idx = v.iter().position(pred);
+    idx.map(|idx| v.remove(idx))
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;

src/vkeyboard.rs

@@ -0,0 +1,88 @@
+/*! Managing the events belonging to virtual-keyboard interface. */
+
+use ::keyboard::{ KeyCode, Modifiers, PressType };
+use ::layout::c::LevelKeyboard;
+use ::submission::Timestamp;
+
+/// Gathers stuff defined in C or called by C
+pub mod c {
+    use super::*;
+    use std::os::raw::c_void;
+
+    #[repr(transparent)]
+    #[derive(Clone, Copy)]
+    pub struct ZwpVirtualKeyboardV1(*const c_void);
+
+    #[no_mangle]
+    extern "C" {
+        pub fn eek_virtual_keyboard_v1_key(
+            virtual_keyboard: ZwpVirtualKeyboardV1,
+            timestamp: u32,
+            keycode: u32,
+            press: u32,
+        );
+
+        pub fn eek_virtual_keyboard_update_keymap(
+            virtual_keyboard: ZwpVirtualKeyboardV1,
+            keyboard: LevelKeyboard,
+        );
+        
+        pub fn eek_virtual_keyboard_set_modifiers(
+            virtual_keyboard: ZwpVirtualKeyboardV1,
+            modifiers: u32,
+        );
+    }
+}
+
+/// Layout-independent backend. TODO: Have one instance per program or seat
+pub struct VirtualKeyboard(pub c::ZwpVirtualKeyboardV1);
+
+impl VirtualKeyboard {
+    // TODO: error out if keymap not set
+    pub fn switch(
+        &self,
+        keycodes: &Vec<KeyCode>,
+        action: PressType,
+        timestamp: Timestamp,
+    ) {
+        let keycodes_count = keycodes.len();
+        for keycode in keycodes.iter() {
+            let keycode = keycode - 8;
+            match (action, keycodes_count) {
+                // Pressing a key made out of a single keycode is simple:
+                // press on press, release on release.
+                (_, 1) => unsafe {
+                    c::eek_virtual_keyboard_v1_key(
+                        self.0, timestamp.0, keycode, action.clone() as u32
+                    );
+                },
+                // A key made of multiple keycodes
+                // has to submit them one after the other
+                (PressType::Pressed, _) => unsafe {
+                    c::eek_virtual_keyboard_v1_key(
+                        self.0, timestamp.0, keycode, PressType::Pressed as u32
+                    );
+                    c::eek_virtual_keyboard_v1_key(
+                        self.0, timestamp.0, keycode, PressType::Released as u32
+                    );
+                },
+                // Design choice here: submit multiple all at press time
+                // and do nothing at release time
+                (PressType::Released, _) => {},
+            }
+        }
+    }
+    
+    pub fn set_modifiers_state(&self, modifiers: Modifiers) {
+        let modifiers = modifiers.bits() as u32;
+        unsafe {
+            c::eek_virtual_keyboard_set_modifiers(self.0, modifiers);
+        }
+    }
+    
+    pub fn update_keymap(&self, keyboard: LevelKeyboard) {
+        unsafe {
+            c::eek_virtual_keyboard_update_keymap(self.0, keyboard);
+        }
+    }
+}

src/wayland.c

@@ -1,3 +1,5 @@
+#include "eek/eek-keyboard.h"
+
 #include "wayland.h"
 
 struct squeek_wayland *squeek_wayland = NULL;
@@ -11,6 +13,19 @@ eek_virtual_keyboard_v1_key(struct zwp_virtual_keyboard_v1 *zwp_virtual_keyboard
     zwp_virtual_keyboard_v1_key(zwp_virtual_keyboard_v1, time, key, state);
 }
 
+
+void eek_virtual_keyboard_update_keymap(struct zwp_virtual_keyboard_v1 *zwp_virtual_keyboard_v1, const LevelKeyboard *keyboard) {
+    zwp_virtual_keyboard_v1_keymap(zwp_virtual_keyboard_v1,
+        WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1,
+        keyboard->keymap_fd, keyboard->keymap_len);
+}
+
+void
+eek_virtual_keyboard_set_modifiers(struct zwp_virtual_keyboard_v1 *zwp_virtual_keyboard_v1, uint32_t mods_depressed) {
+    zwp_virtual_keyboard_v1_modifiers(zwp_virtual_keyboard_v1,
+                                      mods_depressed, 0, 0, 0);
+}
+
 int squeek_output_add_listener(struct wl_output *wl_output,
                                 const struct wl_output_listener *listener, void *data) {
     return wl_output_add_listener(wl_output, listener, data);

tests/meson.build

@@ -50,14 +50,18 @@ endforeach
 foreach layout : [
     'us', 'us_wide',
     'de', 'de_wide',
-    'el',
     'es',
     'fi',
+    'gr',
     'it',
     'jp+kana','jp+kana_wide',
     'no',
     'number',
+    'pl', 'pl_wide',
     'se',
+    'terminal',
+    
+    'emoji',
 ]
     test(
         'test_layout_' + layout,

tools/entry.py

@@ -12,6 +12,19 @@ except AttributeError:
     print("Terminal purpose not available on this GTK version", file=sys.stderr)
     terminal = []
 
+def new_grid(items, set_type):
+    grid = Gtk.Grid(orientation='vertical', column_spacing=8, row_spacing=8)
+    i = 0
+    for text, value in items:
+        l = Gtk.Label(label=text)
+        e = Gtk.Entry(hexpand=True)
+        set_type(e, value)
+        grid.attach(l, 0, i, 1, 1)
+        grid.attach(e, 1, i, 1, 1)
+        i += 1
+    return grid
+
+
 class App(Gtk.Application):
 
     purposes = [
@@ -27,20 +40,23 @@ class App(Gtk.Application):
         ("PIN", Gtk.InputPurpose.PIN),
     ] + terminal
 
+    hints = [
+        ("OSK provided", Gtk.InputHints.INHIBIT_OSK)
+    ]
+
     def do_activate(self):
         w = Gtk.ApplicationWindow(application=self)
-        grid = Gtk.Grid(orientation='vertical', column_spacing=8, row_spacing=8)
+        notebook = Gtk.Notebook()
-        i = 0
+        def add_purpose(entry, purpose):
-        for text, purpose in self.purposes:
+            entry.set_input_purpose(purpose)
+        def add_hint(entry, hint):
+            entry.set_input_hints(hint)
+        purpose_grid = new_grid(self.purposes, add_purpose)
+        hint_grid = new_grid(self.hints, add_hint)
 
-            l = Gtk.Label(label=text)
+        notebook.append_page(purpose_grid, Gtk.Label(label="Purposes"))
-            e = Gtk.Entry(hexpand=True)
+        notebook.append_page(hint_grid, Gtk.Label(label="Hints"))
-            e.set_input_purpose(purpose)
+        w.add(notebook)
-            grid.attach(l, 0, i, 1, 1)
-            grid.attach(e, 1, i, 1, 1)
-            i += 1
-
-        w.add(grid)
         w.show_all()
 
 app = App()

tools/meson.build

@@ -0,0 +1,19 @@
+entry = configure_file(
+    copy: true,
+    input: 'entry.py',
+    output: 'squeekboard-entry',
+    install: true,
+    install_dir: bindir,
+)
+
+test_layout = custom_target('squeekboard-test-layout',
+    build_by_default: true,
+    # meson doesn't track all inputs, cargo does
+    build_always_stale: true,
+    output: ['squeekboard-test-layout'],
+    console: true,
+    command: [cargo_build] + cargo_build_flags
+        + ['--rename', 'test_layout', '@OUTPUT@', '--bin', 'test_layout'],
+    install: true,
+    install_dir: bindir,
+)