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,16 +34,35 @@ build_meson:
       - _build
     expire_in: 3h
   script:
+    - apt-get -y build-dep .
     - meson . _build/ -Ddepdatadir=/usr/share
     - ninja -C _build install
 
 build_deb:
-    <<: *tags
+    tags:
+        - librem5
     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 .
+
+build_deb:arm64:
+    tags:
+        - 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 .
@@ -53,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,10 +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]]
@@ -15,8 +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)",
- "pkg-config 0.3.16 (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.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -33,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]]
@@ -44,19 +44,29 @@ 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)",
- "pkg-config 0.3.16 (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.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]]
+name = "clap"
+version = "2.32.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "bitflags 1.0.4 (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)",
+]
+
 [[package]]
 name = "dtoa"
-version = "0.4.4"
+version = "0.4.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
@@ -79,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)",
 ]
 
@@ -94,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]]
@@ -105,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)",
- "pkg-config 0.3.16 (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.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -119,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]]
@@ -136,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]]
@@ -146,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)",
- "pkg-config 0.3.16 (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.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -159,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]]
@@ -167,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)",
- "pkg-config 0.3.16 (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.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -177,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)",
- "pkg-config 0.3.16 (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.17 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
@@ -189,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)",
@@ -201,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)",
 ]
 
@@ -217,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]]
@@ -229,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]]
@@ -244,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]]
@@ -252,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)",
 ]
 
@@ -266,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)",
 ]
 
@@ -277,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)",
- "pkg-config 0.3.16 (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.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)",
@@ -299,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]]
@@ -307,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)",
- "memchr 2.2.1 (registry+https://github.com/rust-lang/crates.io-index)",
- "regex-syntax 0.6.12 (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.3.2 (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]]
@@ -324,6 +334,10 @@ name = "rs"
 version = "0.1.0"
 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)",
+ "clap 2.32.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "gdk 0.9.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "gio 0.5.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "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)",
@@ -331,50 +345,58 @@ 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_yaml 0.8.9 (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.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 = "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)",
 ]
 
+[[package]]
+name = "textwrap"
+version = "0.10.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+dependencies = [
+ "unicode-width 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
+]
+
 [[package]]
 name = "thread_local"
 version = "0.3.6"
@@ -383,6 +405,11 @@ dependencies = [
  "lazy_static 1.4.0 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
+[[package]]
+name = "unicode-width"
+version = "0.1.7"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+
 [[package]]
 name = "unicode-xid"
 version = "0.2.0"
@@ -417,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)",
 ]
 
@@ -430,13 +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 atk-sys 0.7.0 (registry+https://github.com/rust-lang/crates.io-index)" = "c7017e53393e713212aed7aea336b6553be4927f58c37070a56c2fe3d107e489"
 "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 dtoa 0.4.4 (registry+https://github.com/rust-lang/crates.io-index)" = "ea57b42383d091c85abcc2706240b94ab2a8fa1fc81c10ff23c4de06e2a90b5e"
+"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.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"
@@ -450,23 +478,25 @@ 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 proc-macro2 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" = "afdc77cc74ec70ed262262942ebb7dac3d479e9e5cfa2da1841c0806f6cdabcc"
+"checksum pkg-config 0.3.17 (registry+https://github.com/rust-lang/crates.io-index)" = "05da548ad6865900e60eaba7f589cc0783590a92e940c26953ff81ddbab2d677"
+"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 serde 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)" = "9796c9b7ba2ffe7a9ce53c2287dfc48080f4b2b362fcc245a259b3a7201119dd"
-"checksum serde_derive 1.0.101 (registry+https://github.com/rust-lang/crates.io-index)" = "4b133a43a1ecd55d4086bd5b4dc6c1751c68b1bfbeba7a5040442022c7e7c02e"
-"checksum serde_yaml 0.8.9 (registry+https://github.com/rust-lang/crates.io-index)" = "38b08a9a90e5260fe01c6480ec7c811606df6d3a660415808c3c3fa8ed95b582"
-"checksum syn 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)" = "66850e97125af79138385e9b88339cbcd037e3f28ceab8c5ad98e64f0f1f80bf"
+"checksum regex-syntax 0.6.14 (registry+https://github.com/rust-lang/crates.io-index)" = "b28dfe3fe9badec5dbf0a79a9cccad2cfc2ab5484bdb3e44cbd1ae8b3ba2be06"
+"checksum serde 1.0.104 (registry+https://github.com/rust-lang/crates.io-index)" = "414115f25f818d7dfccec8ee535d76949ae78584fc4f79a6f45a904bf8ab4449"
+"checksum serde_derive 1.0.104 (registry+https://github.com/rust-lang/crates.io-index)" = "128f9e303a5a29922045a830221b8f78ec74a5f544944f3d5984f8ec3895ef64"
+"checksum serde_yaml 0.8.11 (registry+https://github.com/rust-lang/crates.io-index)" = "691b17f19fc1ec9d94ec0b5864859290dff279dbd7b03f017afda54eb36c3c35"
+"checksum syn 1.0.14 (registry+https://github.com/rust-lang/crates.io-index)" = "af6f3550d8dff9ef7dc34d384ac6f107e5d31c8f57d9f28e0081503f547ac8f5"
+"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 winapi 0.3.8 (registry+https://github.com/rust-lang/crates.io-index)" = "8093091eeb260906a183e6ae1abdba2ef5ef2257a21801128899c3fc699229c6"

Cargo.toml

@@ -4,12 +4,22 @@ version = "0.1.0"
 
 [dependencies]
 bitflags = "1.0.*"
+clap = { version = "2.32.*", default-features = false }
 maplit = "1.0.*"
 regex = "1.1.*"
 serde = { version = "1.0.*", features = ["derive"] }
 serde_yaml = "0.8.*"
 xkbcommon = { version = "0.4.*", features = ["wayland"] }
 
+[dependencies.cairo-rs]
+version = "0.5.*"
+
+[dependencies.cairo-sys-rs]
+version = ""
+
+[dependencies.gdk]
+version = ""
+
 [dependencies.gio]
 version = ""
 features = ["v2_44"]
@@ -22,7 +32,6 @@ features = ["v2_44"]
 version = ""
 features = ["v2_44"]
 
-
 [dependencies.gtk]
 version = "0.5.*"
 features = ["v3_22"]

HACKING.md

@@ -1,130 +0,0 @@
-Hacking
-=======
-
-This document describes the standards for modifying and maintaining the *squeekboard* project.
-
-Development environment
------------------------
-
-*Squeekboard* is regularly built and tested on [the develpment environment](https://developer.puri.sm/Librem5/Development_Environment.html).
-
-Recent Fedora releases are likely to be tested as well.
-
-### Dependencies
-
-On a Debian based system run
-
-```sh
-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
-[debian/control][] file.
-
-Testing
--------
-
-Most common testing is done in CI. Occasionally, and for each release, do perform manual tests to make sure that
-
-- the application draws correctly
-- it shows when relevant
-- it changes layouts
-- it changes levels
-
-Testing with an application:
-
-```
-python3 tests/entry.py
-```
-
-Testing visibility:
-
-```
-$ busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b true
-$ busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b false
-```
-
-Testing layouts:
-
-Layouts can be selected using the GNOME Settings application.
-
-```
-# define all available layouts
-$ gsettings set org.gnome.desktop.input-sources sources "[('xkb', 'us'), ('xkb', 'ua')]"
-# choose the active layout
-$ gsettings set org.gnome.desktop.input-sources current 1
-```
-
-Coding
-------
-
-Code submitted should roughly match the style of surrounding code. Things that will *not* be accepted are ones that often lead to errors:
-
-- skipping brackets `{}` after every `if()`, `else`, and similar
-
-Bad example:
-
-```
-if (foo)
-  bar();
-```
-
-Good example:
-
-```
-if (foo) {
-  bar();
-}
-```
-
-- mixing tabs and spaces in the same block of code (or config)
-
-Strongly encouraged:
-
-- don't make lines too long. If it's longer than ~80 characters, it's probably unreadable already, and the code needs to be clarified;
-- put operators in the beginning of a continuation line
-
-Bad example:
-
-```
-foobar = verylongexpression +
-    anotherverylongexpression + 
-    yetanotherexpression;
-```
-
-Good example:
-
-```
-foobar = verylongexpression
-    + anotherverylongexpression
-    + yetanotherexpression;
-```
-
-- use `///` for documentation comments in front of definitions and `/*! ... */` for documentation comments in the beginning of modules (see [Rust doc-comments](https://doc.rust-lang.org/reference/comments.html#doc-comments))
-
-If in doubt, check [PEP8](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md), the [kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html), or the [Rust style guide](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md).
-
-Maintenance
------------
-
-Squeekboard uses Rust & Cargo for some of its dependencies.
-
-Use the `cargo.sh` script for maintaining the Cargo part of the build. The script takes the usual Cargo commands, after the first 2 positionsl arguments: source directory, and output artifact. So, `cargo test` becomes:
-
-```
-cd build_dir
-sh /source_path/cargo.sh '' test
-```
-
-### Cargo dependencies
-
-Dependencies must be specified in `Cargo.toml` with 2 numbers: "major.minor". Since bugfix version number is meant to not affect the interface, this allows for safe updates.
-
-`Cargo.lock` is used for remembering the revisions of all Rust dependencies. It should be updated often, preferably with each bugfix revision, and in a commit on its own:
-
-```
-cd build_dir
-sh /source_path/cargo.sh '' update
-ninja test
-```

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.

cargo.sh

@@ -11,14 +11,7 @@ SOURCE_DIR="$(dirname "$SCRIPT_PATH")"
 
 CARGO_TARGET_DIR="$(pwd)"
 export CARGO_TARGET_DIR
-if [ -n "${1}" ]; then
-    OUT_PATH="$(realpath "$1")"
-fi
 
 cd "$SOURCE_DIR"
-shift
 cargo "$@"
 
-if [ -n "${OUT_PATH}" ]; then
-    cp "${CARGO_TARGET_DIR}"/debug/librs.a "${OUT_PATH}"
-fi

cargo_build.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+# This script manages Cargo builds
+# while keeping the artifact directory within the build tree
+# instead of the source tree
+
+set -e
+
+SCRIPT_PATH="$(realpath "$0")"
+SOURCE_DIR="$(dirname "$SCRIPT_PATH")"
+
+RELEASE=""
+BINARY_DIR="debug"
+if [ "${1}" = "--release" ]; then
+    shift
+    BINARY_DIR="release"
+    RELEASE="--release"
+fi
+
+if [ "${1}" = "--rename" ]; then
+    shift
+    FILENAME="${1}"
+    shift
+fi
+OUT_PATH="$(realpath "${1}")"
+shift
+OUT_BASENAME="$(basename "${OUT_PATH}")"
+FILENAME="${FILENAME:-"${OUT_BASENAME}"}"
+
+sh "$SOURCE_DIR"/cargo.sh build $RELEASE "$@"
+
+if [ -n "${OUT_PATH}" ]; then
+    cp -a ./"${BINARY_DIR}"/"${FILENAME}" "${OUT_PATH}"
+fi

data/keyboards/de.yaml

@@ -1,19 +1,11 @@
-# German layout by Mark Müller
-# Version 2019111700
+# Maintained by: Mark Müller <markmueller86@gmail.com>
 ---
-bounds: { x: 0, y: 1, width: 360, height: 208 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 35.33, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 52.67, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 99.67, height: 52 }
-    special:
-        bounds: { x: 0, y: 0, width: 35.33, height: 52 }
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 62, height: 52 }
+    spaceline: { width: 99.67, height: 52 }
+    special: { width: 35.33, height: 52 }
 
 views:
     base:
@@ -53,7 +45,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "special"
@@ -83,7 +75,7 @@ buttons:
     space:
         outline: "spaceline"
         label: " "
-        keysym: "space"
+        text: " "
     Return:
         outline: "altline"
         icon: "key-enter"

data/keyboards/de_wide.yaml

@@ -0,0 +1,81 @@
+# Maintained by: Mark Müller <markmueller86@gmail.com>
+---
+outlines:
+    default: { width: 48, height: 42 }
+    altline: { width: 81, height: 42 }
+    wide: { width: 108, height: 42 }
+    spaceline: { width: 216, height: 42 }
+    special: { width: 48, height: 42 }
+
+views:
+    base:
+        - "q w e r t z u i o p ü"
+        - "a s d f g h j k l ö ä"
+        - "Shift_L   y x c v b n m  BackSpace"
+        - "show_numbers preferences         space        , . Return"
+    upper:
+        - "Q W E R T Z U I O P Ü"
+        - "A S D F G H J K L Ö Ä"
+        - "Shift_L   Y X C V B N M  BackSpace"
+        - "show_numbers preferences         space        ! ? Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # % & - _ + ( ) ß"
+        - "show_symbols   , \" ' : = < >  BackSpace"
+        - "show_letters preferences         space        , . Return"
+    symbols:
+        - "~ ` ´  · © ® ÷ × ¶"
+        - "€ £ $ ¥ ^ ° * { } |"
+        - "show_numbers   \\ / § π τ [ ]  BackSpace"
+        - "show_letters preferences         space        , . Return"
+    eschars:
+        - "ä è é ö ü Ä È É Ö Ü"
+        - "à â ê î ô À Â È Î Ô"
+        - "show_numbers  « » ç Ç æ œ ß  BackSpace"
+        - "show_letters preferences         space        „ “ Return"
+
+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: "altline"
+        label: "123"
+    show_letters:
+        action:
+            set_view: "base"
+        outline: "altline"
+        label: "abc"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    show_eschars:
+        action:
+            locking:
+                lock_view: "eschars"
+                unlock_view: "base"
+        outline: "altline"
+        label: "äÄ"
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "altline"
+        icon: "key-enter"
+        keysym: "Return"

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

@@ -1,17 +1,10 @@
 ---
-bounds: { x: 0, y: 1, width: 360, height: 210 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 35.33, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 52.67, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 99.67, height: 52 }
-    special:
-        bounds: { x: 0, y: 0, width: 44, height: 52 }
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 62, height: 52 }
+    spaceline: { width: 99.67, height: 52 }
+    special: { width: 44, height: 52 }
 
 views:
     base:
@@ -51,6 +44,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "default"
@@ -80,14 +74,14 @@ buttons:
 
     period:
         outline: "default"
-        label: "."
+        text: "."
     space:
         outline: "spaceline"
-        label: " "
+        text: " "
     Return:
         outline: "altline"
         icon: "key-enter"
+        keysym: "Return"
     colon:
-        label: ":"
-    "\"":
-        keysym: "quotedbl"
+        text: ":"
+

data/keyboards/fi.yaml

@@ -1,17 +1,10 @@
 ---
-bounds: { x: 0, y: 0.33, width: 360, height: 210 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 32, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 48.39024, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    outline7:
-        bounds: { x: 0, y: 0, width: 88.97561, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 150.5853, height: 52 }
+    default: { width: 32, height: 52 }
+    altline: { width: 48.39024, height: 52 }
+    wide: { width: 62, height: 52 }
+    outline7: { width: 88.97561, height: 52 }
+    spaceline: { width: 150.5853, height: 52 }
 
 views:
     base:
@@ -46,6 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "altline"
@@ -69,108 +63,109 @@ buttons:
         outline: altline
     space:
         outline: spaceline
-        label: " "
+        text: " "
     Return:
         outline: "wide"
         icon: "key-enter"
+        keysym: "Return"
     aring:
-        label: "å"
+        text: "å"
     Aring:
-        label: "Å"
+        text: "Å"
     ouml:
-        label: "ö"
+        text: "ö"
     Ouml:
-        label: "Ö"
+        text: "Ö"
     auml:
-        label: "ä"
+        text: "ä"
     Auml:
-        label: "Ä"
+        text: "Ä"
     asterisk:
-        label: "*"
+        text: "*"
     asciitilde:
-        label: "~"
+        text: "~"
     quoteleft:
-        label: "`"
+        text: "`"
     bar:
-        label: "|"
+        text: "|"
     U00B7:
-        label: "·"
+        text: "·"
     squareroot:
-        label: "√"
+        text: "√"
     Greek_pi:
-        label: "π"
+        text: "π"
     division:
-        label: "÷"
+        text: "÷"
     multiply:
-        label: "×"
+        text: "×"
     paragraph:
-        label: "¶"
+        text: "¶"
     Greek_tau:
-        label: "τ"
+        text: "τ"
     copyright:
-        label: "©"
+        text: "©"
     numbersign:
-        label: "#"
+        text: "#"
     U00AE:
-        label: "®"
+        text: "®"
     at:
-        label: "@"
+        text: "@"
     dollar:
-        label: "$"
+        text: "$"
     U00A3:
-        label: "£"
+        text: "£"
     percent:
-        label: "%"
+        text: "%"
     EuroSign:
-        label: "€"
+        text: "€"
     ampersand:
-        label: "&"
+        text: "&"
     U00A5:
-        label: "¥"
+        text: "¥"
     minus:
-        label: "-"
+        text: "-"
     asciicircum:
-        label: "^"
+        text: "^"
     underscore:
-        label: "_"
+        text: "_"
     degree:
-        label: "°"
+        text: "°"
     plus:
-        label: "+"
+        text: "+"
     equal:
-        label: "="
+        text: "="
     parenleft:
-        label: "("
+        text: "("
     parenright:
-        label: ")"
+        text: ")"
     braceleft:
-        label: "{"
+        text: "{"
     braceright:
-        label: "}"
+        text: "}"
     comma:
-        label: ","
+        text: ","
     backslash:
-        label: "\\"
+        text: "\\"
     slash:
-        label: "/"
+        text: "/"
     quotedbl:
-        label: "\""
+        text: "\""
     quoteright:
-        label: "'"
+        text: "'"
     less:
-        label: "<"
+        text: "<"
     greater:
-        label: ">"
+        text: ">"
     colon:
-        label: ":"
+        text: ":"
     semicolon:
-        label: ";"
+        text: ";"
     exclam:
-        label: "!"
+        text: "!"
     question:
-        label: "?"
+        text: "?"
     bracketleft:
-        label: "["
+        text: "["
     bracketright:
-        label: "]"
+        text: "]"
 

data/keyboards/gr.yaml

@@ -2,19 +2,12 @@
 # University of the Aegean, Department of Mathematics, atsol@aegean.gr
 # Sep 2019
 ---
-bounds: { x: 0, y: 0.33, width: 360, height: 210 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 32, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 48.39024, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    outline7:
-        bounds: { x: 0, y: 0, width: 88.97561, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 150.5853, height: 52 }
+    default: { width: 32, height: 52 }
+    altline: { width: 48.39024, height: 52 }
+    wide: { width: 62, height: 52 }
+    outline7: { width: 88.97561, height: 52 }
+    spaceline: { width: 150.5853, height: 52 }
 
 views:
     base:
@@ -53,6 +46,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "altline"
@@ -86,111 +80,112 @@ buttons:
         label: "αι"
     period:
         outline: "altline"
-        label: "."
+        text: "."
     space:
         outline: spaceline
-        label: " "
+        text: " "
     Return:
         outline: "wide"
         icon: "key-enter"
+        keysym: "Return"
     aring:
-        label: "å"
+        text: "å"
     Aring:
-        label: "Å"
+        text: "Å"
     oslash:
-        label: "ø"
+        text: "ø"
     Oslash:
-        label: "Ø"
+        text: "Ø"
     ae:
-        label: "æ"
+        text: "æ"
     AE:
-        label: "Æ"
+        text: "Æ"
     asterisk:
-        label: "*"
+        text: "*"
     asciitilde:
-        label: "~"
+        text: "~"
     quoteleft:
-        label: "`"
+        text: "`"
     bar:
-        label: "|"
+        text: "|"
     U00B7:
-        label: "·"
+        text: "·"
     squareroot:
-        label: "√"
+        text: "√"
     Greek_pi:
-        label: "π"
+        text: "π"
     division:
-        label: "÷"
+        text: "÷"
     multiply:
-        label: "×"
+        text: "×"
     paragraph:
-        label: "¶"
+        text: "¶"
     Greek_tau:
-        label: "τ"
+        text: "τ"
     copyright:
-        label: "©"
+        text: "©"
     numbersign:
-        label: "#"
+        text: "#"
     U00AE:
-        label: "®"
+        text: "®"
     at:
-        label: "@"
+        text: "@"
     dollar:
-        label: "$"
+        text: "$"
     U00A3:
-        label: "£"
+        text: "£"
     percent:
-        label: "%"
+        text: "%"
     EuroSign:
-        label: "€"
+        text: "€"
     ampersand:
-        label: "&"
+        text: "&"
     U00A5:
-        label: "¥"
+        text: "¥"
     minus:
-        label: "-"
+        text: "-"
     asciicircum:
-        label: "^"
+        text: "^"
     underscore:
-        label: "_"
+        text: "_"
     degree:
-        label: "°"
+        text: "°"
     plus:
-        label: "+"
+        text: "+"
     equal:
-        label: "="
+        text: "="
     parenleft:
-        label: "("
+        text: "("
     parenright:
-        label: ")"
+        text: ")"
     braceleft:
-        label: "{"
+        text: "{"
     braceright:
-        label: "}"
+        text: "}"
     comma:
-        label: ","
+        text: ","
     backslash:
-        label: "\\"
+        text: "\\"
     slash:
-        label: "/"
+        text: "/"
     quotedbl:
-        label: "\""
+        text: "\""
     quoteright:
-        label: "'"
+        text: "'"
     less:
-        label: "<"
+        text: "<"
     greater:
-        label: ">"
+        text: ">"
     colon:
-        label: ":"
+        text: ":"
     semicolon:
-        label: ";"
+        text: ";"
     exclam:
-        label: "!"
+        text: "!"
     question:
-        label: "?"
+        text: "?"
     bracketleft:
-        label: "["
+        text: "["
     bracketright:
-        label: "]"
+        text: "]"
 

data/keyboards/it.yaml

@@ -1,19 +1,12 @@
 # Italian layout created by Antonio Pandolfo
 # 03 october 2019
 ---
-bounds: { x: 0, y: 1, width: 360, height: 210 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 35.33, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 52.67, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 99.67, height: 52 }
-    special:
-        bounds: { x: 0, y: 0, width: 44, height: 52 }
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 62, height: 52 }
+    spaceline: { width: 99.67, height: 52 }
+    special: { width: 44, height: 52 }
 
 views:
     base:
@@ -53,6 +46,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "default"
@@ -91,6 +85,7 @@ buttons:
     Return:
         outline: "altline"
         icon: "key-enter"
+        keysym: "Return"
     colon:
         label: ":"
     "\"":

data/keyboards/jp+kana.yaml

@@ -1,19 +1,11 @@
-# Japanese Kana layout by Mark Müller
-# Version 2019111800
+# Maintained by: Mark Müller <markmueller86@gmail.com>
 ---
-bounds: { x: 0, y: 1, width: 360, height: 208 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    default-wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    special:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
+    default: { width: 62, height: 52 }
+    default-wide: { width: 62, height: 52 }
+    altline: { width: 62, height: 52 }
+    wide: { width: 62, height: 52 }
+    special: { width: 62, height: 52 }
 
 views:
     base: # hiragana
@@ -203,7 +195,7 @@ buttons:
     BackSpace:
         outline: "wide"
         icon: "edit-clear-symbolic"
-        keysym: "BackSpace"
+        action: erase
     Return:
         outline: "wide"
         icon: "key-enter"
@@ -221,11 +213,11 @@ buttons:
         action: "show_prefs"
         outline: "special"
         icon: "keyboard-mode-symbolic"
-    # space button with unicode keysym for ideographic space
+    # space button using text tag for ideographic space
     space:
         outline: "default-wide"
         label: "␣"
-        keysym: "U3000"
+        text: "　"
     # switch to number view
     numbers:
         action:

data/keyboards/jp+kana_wide.yaml

@@ -0,0 +1,525 @@
+# Maintained by: Mark Müller <markmueller86@gmail.com>
+---
+outlines:
+    default: { width: 62, height: 42 }
+    default-wide: { width: 62, height: 42 }
+    altline: { width: 62, height: 42 }
+    wide: { width: 62, height: 42 }
+    special: { width: 62, height: 42 }
+
+views:
+    base: # hiragana
+        - "preferences _a ka sa BackSpace"
+        - "Left ta na ha Right"
+        - "カタカナ ma ya ra space"
+        - "switch2roman symbols wa punct Return"
+    _a:
+        - "preferences dummykey _a dummykey BackSpace"
+        - "あ い う え お"
+        - "ぁ ぃ ぅ ぇ ぉ" # 2 code points each
+        - "dummykey dummykey ゔ dummykey dummykey"
+    ka:
+        - "preferences dummykey ka dummykey BackSpace"
+        - "か き く け こ"
+        - "が ぎ ぐ げ ご"
+        - "ゕ dummykey dummykey ゖ dummykey"
+    sa:
+        - "preferences dummykey sa dummykey BackSpace"
+        - "さ し す せ そ"
+        - "ざ じ ず ぜ ぞ"
+    ta:
+        - "preferences dummykey ta dummykey BackSpace"
+        - "た ち つ て と"
+        - "だ ぢ づ で ど"
+        - "dummykey dummykey っ dummykey dummykey"
+    na:
+        - "preferences dummykey na dummykey BackSpace"
+        - "な に ぬ ね の"
+    ha:
+        - "preferences dummykey ha dummykey BackSpace"
+        - "は ひ ふ へ ほ"
+        - "ば び ぶ べ ぼ"
+        - "ぱ ぴ ぷ ぺ ぽ"
+    ma:
+        - "preferences dummykey ma dummykey BackSpace"
+        - "ま み む め も"
+    ya:
+        - "preferences dummykey ya dummykey BackSpace"
+        - "や dummykey ゆ dummykey よ"
+        - "ゃ dummykey ゅ dummykey ょ"
+    ra:
+        - "preferences dummykey ra dummykey BackSpace"
+        - "ら り る れ ろ"
+    wa:
+        - "preferences dummykey wa dummykey BackSpace"
+        - "わ ゐ dummykey ゑ を"
+        - "ゎ dummykey ん dummykey dummykey"
+    symbols:
+        - "preferences dummykey symbols dummykey BackSpace"
+        - "「 」 （ ） §"
+        - "【 】 ＜ ＞ ＝"
+        - "＋ ＊ ＆ ％ ＄ "
+    punct:
+        - "preferences dummykey punct dummykey BackSpace"
+        - "。 、 ？ ！ ー"
+
+        - "： ； ・ 〜 …"
+        - "♪ ” ’ ゙ ゚"
+        
+#a 	あア 	かカ 	さサ 	たタ 	なナ 	はハ 	まマ 	やヤ 	らラ 	わワ
+#i 	いイ 	きキ 	しシ 	ちチ 	にニ 	ひヒ 	みミ 	※      りリ 	ゐヰ
+#u 	うウ 	くク 	すス 	つツ 	ぬヌ 	ふフ 	むム 	ゆユ 	るル 	※
+#e 	えエ 	けケ 	せセ 	てテ 	ねネ 	へヘ 	めメ 	※      れレ 	ゑヱ
+#o 	おオ 	こコ 	そソ 	とト 	のノ 	ほホ 	もモ 	よヨ 	ろロ 	をヲ
+
+#      g       z       d       b       p      n
+#a 	が ガ 	ざ ザ 	だ ダ 	ば バ 	ぱ パ   ん ン
+#i 	ぎ ギ 	じ ジ 	ぢ ヂ 	び ビ 	ぴ ピ 
+#u 	ぐ グ 	ず ズ 	づ ヅ 	ぶ ブ 	ぷ プ 
+#e 	げ ゲ 	ぜ ゼ 	で デ 	べ ベ 	ぺ ペ 
+#o 	ご ゴ 	ぞ ゾ 	ど ド 	ぼ ボ 	ぽ ポ 
+
+    カタカナ: # katakana
+        - "preferences _A KA SA BackSpace"
+        - "Left TA NA HA Right"
+        - "ひらがな MA YA RA space"
+        - "switch2roman SYMBOLS WA PUNCT Return"
+    _A:
+        - "preferences DUMMYKEY _A DUMMYKEY BackSpace"
+        - "ア イ ウ エ オ"
+        - "ァ ィ ゥ ェ ォ"
+        - "DUMMYKEY DUMMYKEY ヴ DUMMYKEY DUMMYKEY"
+    KA:
+        - "preferences DUMMYKEY KA DUMMYKEY BackSpace"
+        - "カ キ ク ケ コ"
+        - "ガ ギ グ ゲ ゴ"
+        - "ヵ DUMMYKEY ㇰ ヶ DUMMYKEY"
+    SA:
+        - "preferences DUMMYKEY SA DUMMYKEY BackSpace"
+        - "サ シ ス セ ソ"
+        - "ザ ジ ズ ゼ ゾ"
+        - "DUMMYKEY ㇱ ㇲ DUMMYKEY DUMMYKEY"
+    TA:
+        - "preferences DUMMYKEY TA DUMMYKEY BackSpace"
+        - "タ チ ツ テ ト"
+        - "ダ ヂ ヅ デ ド"
+        - "DUMMYKEY DUMMYKEY ッ DUMMYKEY ㇳ"
+    NA: 
+        - "preferences DUMMYKEY NA DUMMYKEY BackSpace"
+        - "ナ ニ ヌ ネ ノ"
+        - "DUMMYKEY DUMMYKEY ㇴ DUMMYKEY DUMMYKEY"
+    HA:
+        - "preferences DUMMYKEY HA DUMMYKEY BackSpace"
+        - "ハ ヒ フ ヘ ホ"
+        - "バ ビ ブ ベ ボ"
+        - "パ ピ プ ペ ポ"
+    MA:
+        - "preferences DUMMYKEY MA DUMMYKEY BackSpace"
+        - "マ ミ ム メ モ"
+        - "DUMMYKEY DUMMYKEY ㇺ DUMMYKEY DUMMYKEY"
+    YA:
+        - "preferences DUMMYKEY YA DUMMYKEY BackSpace"
+        - "ヤ DUMMYKEY ユ DUMMYKEY ヨ"
+        - "ャ DUMMYKEY ュ DUMMYKEY ョ"
+    RA:
+        - "preferences DUMMYKEY RA DUMMYKEY BackSpace"
+        - "ラ リ ル レ ロ"
+        - "ㇻ ㇼ ㇽ ㇾ ㇿ"
+    WA:
+        - "preferences DUMMYKEY WA DUMMYKEY BackSpace"
+        - "ワ ヰ DUMMYKEY ヱ ヲ"
+        - "ヮ ヸ ン ヹ ヺ"
+    # numbers view
+    numbers:
+        - "preferences 1 2 3 BackSpace"
+        - "Left 4 5 6 Right"
+        - "roman 7 8 9 space"
+        - "switch2kana * 0 # Return"
+    # Roman alphabet view
+    roman:
+        - "preferences RSYM1 ABC DEF BackSpace"
+        - "Left GHI JKL MNO Right"
+        - "ひらがな PQRS TUV WXYZ space"
+        - "switch2num RSYM2 RSYM3 RSYM4 Return"
+    RSYM1:
+        - "preferences dummykey RSYM1 dummykey BackSpace"
+        - "@ # $ § :"
+        - "| € ¥ £ 1"
+    ABC:
+        - "preferences dummykey ABC dummykey BackSpace"
+        - "A B C Ä ç"
+        - "a b c ä 2"
+    DEF:
+        - "preferences dummykey DEF dummykey BackSpace"
+        - "D E F dummykey"
+        - "d e f 3"
+    GHI:
+        - "preferences dummykey GHI dummykey BackSpace"
+        - "G H I dummykey"
+        - "g h i 4"
+    JKL:
+        - "preferences dummykey JKL dummykey BackSpace"
+        - "J K L dummykey"
+        - "j k l 5"
+    MNO:
+        - "preferences dummykey MNO dummykey BackSpace"
+        - "M N O Ö dummykey"
+        - "m n o ö 6"
+    PQRS:
+        - "preferences dummykey PQRS dummykey BackSpace"
+        - "P Q R S ß"
+        - "p q r s 7"
+    TUV:
+        - "preferences dummykey TUV dummykey BackSpace"
+        - "T U V Ü dummykey"
+        - "t u v ü 8"
+    WXYZ:
+        - "preferences dummykey WXYZ dummykey BackSpace"
+        - "W X Y Z dummykey"
+        - "w x y z 9"
+    RSYM2:
+        - "preferences dummykey RSYM2 dummykey BackSpace"
+        - "( ) ' \" ~"
+        - "[ ] { } _"
+    RSYM3:
+        - "preferences dummykey RSYM3 dummykey BackSpace"
+        - "+ - * / ="
+        - "< > ^ ° 0"
+    RSYM4:
+        - "preferences dummykey RSYM4 dummykey BackSpace"
+        - ", . ? ! ;"
+        - "\\ ´ ` · ¶" 
+
+buttons:
+    # following 4 buttons use the corresponding xkb name as keysym
+    BackSpace:
+        outline: "wide"
+        icon: "edit-clear-symbolic"
+        action: erase
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    Left:
+        outline: "wide"
+        label: "←"
+        keysym: "Left"
+    Right:
+        outline: "wide"
+        label: "→"
+        keysym: "Right"
+    # special button "preferences" is handled in the code
+    preferences:
+        action: "show_prefs"
+        outline: "special"
+        icon: "keyboard-mode-symbolic"
+    # space button using text tag for ideographic space
+    space:
+        outline: "default-wide"
+        label: "␣"
+        text: "　"
+    # switch to number view
+    numbers:
+        action:
+            set_view: "numbers"
+        outline: "wide"
+        label: "123"
+    # switch to latin characters
+    roman:
+        action:
+            set_view: "roman"
+        outline: "wide"
+        label: "ᴀʙᴄ"
+    # toggle button with 3 different states
+    switch2roman: # switch from kana to latin characters view
+        action:
+            set_view: "roman"
+        outline: "wide"
+        label: "あᴀ₁"
+    switch2num: # switch from latin characters to numbers view
+        action:
+            set_view: "numbers"
+        outline: "wide"
+        label: "ぁA₁"
+    switch2kana: # switch from numbers to hiragana view
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "ぁᴀ1"
+    # Buttons for katakana and symbols
+    ひらがな:
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "あさ"
+    _a:
+        action:
+            locking:
+                lock_view: "_a"
+                unlock_view: "base"
+        outline: "altline"
+        label: "あ"
+    ka:
+        action:
+            locking:
+                lock_view: "ka"
+                unlock_view: "base"
+        outline: "altline"
+        label: "か"
+    sa:
+        action:
+            locking:
+                lock_view: "sa"
+                unlock_view: "base"
+        outline: "altline"
+        label: "さ"
+    ta:
+        action:
+            locking:
+                lock_view: "ta"
+                unlock_view: "base"
+        outline: "altline"
+        label: "た"
+    na:
+        action:
+            locking:
+                lock_view: "na"
+                unlock_view: "base"
+        outline: "altline"
+        label: "な"
+    ha:
+        action:
+            locking:
+                lock_view: "ha"
+                unlock_view: "base"
+        outline: "altline"
+        label: "は"
+    ma:
+        action:
+            locking:
+                lock_view: "ma"
+                unlock_view: "base"
+        outline: "altline"
+        label: "ま"
+    ya:
+        action:
+            locking:
+                lock_view: "ya"
+                unlock_view: "base"
+        outline: "altline"
+        label: "や"
+    ra:
+        action:
+            locking:
+                lock_view: "ra"
+                unlock_view: "base"
+        outline: "altline"
+        label: "ら"
+    wa:
+        action:
+            locking:
+                lock_view: "wa"
+                unlock_view: "base"
+        outline: "altline"
+        label: "わ"
+    dummykey:
+        action:
+            set_view: "base"
+        outline: "altline"
+        label: ""
+    # buttons available on different views like symbols and punct should go
+    # back to their corresponding view
+    symbols:
+        action:
+            locking:
+                lock_view: "symbols"
+                unlock_view: "base"
+        outline: "altline"
+        label: "（）"
+    punct:
+        action:
+            locking:
+                lock_view: "punct"
+                unlock_view: "base"
+        outline: "altline"
+        label: "。"
+    # Buttons for katakana and symbols
+    カタカナ:
+        action:
+            set_view: "カタカナ"
+        outline: "wide"
+        label: "アサ"
+    _A:
+        action:
+            locking:
+                lock_view: "_A"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "ア"
+    KA:
+        action:
+            locking:
+                lock_view: "KA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "カ"
+    SA:
+        action:
+            locking:
+                lock_view: "SA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "サ"
+    TA:
+        action:
+            locking:
+                lock_view: "TA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "タ"
+    NA:
+        action:
+            locking:
+                lock_view: "NA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "ナ"
+    HA:
+        action:
+            locking:
+                lock_view: "HA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "ハ"
+    MA:
+        action:
+            locking:
+                lock_view: "MA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "マ"
+    YA:
+        action:
+            locking:
+                lock_view: "YA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "ヤ"
+    RA:
+        action:
+            locking:
+                lock_view: "RA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "ラ"
+    WA:
+        action:
+            locking:
+                lock_view: "WA"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "ワ"
+    DUMMYKEY:
+        action:
+            set_view: "カタカナ"
+        outline: "altline"
+        label: ""
+    SYMBOLS:
+        action:
+            locking:
+                lock_view: "symbols"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "（）"
+    PUNCT:
+        action:
+            locking:
+                lock_view: "punct"
+                unlock_view: "カタカナ"
+        outline: "altline"
+        label: "。"
+    # Buttons for Latin charachters
+    RSYM1:
+        action:
+            locking:
+                lock_view: "RSYM1"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "@#"
+    ABC:
+        action:
+            locking:
+                lock_view: "ABC"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ᴀʙᴄ"
+    DEF:
+        action:
+            locking:
+                lock_view: "DEF"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ᴅᴇꜰ"
+    GHI:
+        action:
+            locking:
+                lock_view: "GHI"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ɢʜɪ"
+    JKL:
+        action:
+            locking:
+                lock_view: "JKL"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ᴊᴋʟ"
+    MNO:
+        action:
+            locking:
+                lock_view: "MNO"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ᴍɴᴏ"
+    PQRS:
+        action:
+            locking:
+                lock_view: "PQRS"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ᴘǫʀs"
+    TUV:
+        action:
+            locking:
+                lock_view: "TUV"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ᴛᴜᴠ"
+    WXYZ:
+        action:
+            locking:
+                lock_view: "WXYZ"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "ᴡxʏᴢ"
+    RSYM2:
+        action:
+            locking:
+                lock_view: "RSYM2"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "()"
+    RSYM3:
+        action:
+            locking:
+                lock_view: "RSYM3"
+                unlock_view: "roman"
+        outline: "altline"
+        label: "+-"
+    RSYM4:
+        action:
+            locking:
+                lock_view: "RSYM4"
+                unlock_view: "roman"
+        outline: "altline"
+        label: ",.?"

data/keyboards/no.yaml

@@ -1,17 +1,10 @@
 ---
-bounds: { x: 0, y: 0.33, width: 360, height: 210 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 32, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 48.39024, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    outline7:
-        bounds: { x: 0, y: 0, width: 88.97561, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 150.5853, height: 52 }
+    default: { width: 32, height: 52 }
+    altline: { width: 48.39024, height: 52 }
+    wide: { width: 62, height: 52 }
+    outline7: { width: 88.97561, height: 52 }
+    spaceline: { width: 150.5853, height: 52 }
 
 views:
     base:
@@ -26,13 +19,13 @@ views:
         - "show_numbers preferences         space        .    Return"
     numbers:
         - "1 2 3 4 5 6 7 8 9 0"
-        - "at numbersign dollar percent ampersand minus underscore plus parenleft parenright"
-        - "show_symbols   comma quotedbl quoteright colon semicolon exclam question  BackSpace"
+        - "@ # $ % & - _ + ( )"
+        - "show_symbols   , \" ' : ; ! ?  BackSpace"
         - "show_letters preferences         space        .    Return"
     symbols:
-        - "asciitilde quoteleft bar U00B7 squareroot Greek_pi Greek_tau division multiply paragraph"
-        - "copyright U00AE U00A3 EuroSign U00A5 asciicircum degree asterisk braceleft braceright"
-        - "show_numbers   backslash slash less greater equal bracketleft bracketright  BackSpace"
+        - "~ ` | U00B7 squareroot Greek_pi Greek_tau division multiply paragraph"
+        - "copyright U00AE U00A3 EuroSign U00A5 asciicircum degree * { }"
+        - "show_numbers   \\ / < > = [ ]  BackSpace"
         - "show_letters preferences         space        .    Return"
 
 buttons:
@@ -46,6 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: erase
     preferences:
         action: "show_prefs"
         outline: "altline"
@@ -69,108 +63,37 @@ buttons:
         outline: altline
     space:
         outline: spaceline
-        label: " "
+        text: " "
     Return:
         outline: "wide"
         icon: "key-enter"
-    aring:
-        label: "å"
-    Aring:
-        label: "Å"
-    oslash:
-        label: "ø"
-    Oslash:
-        label: "Ø"
-    ae:
-        label: "æ"
-    AE:
-        label: "Æ"
-    asterisk:
-        label: "*"
-    asciitilde:
-        label: "~"
-    quoteleft:
-        label: "`"
-    bar:
-        label: "|"
+        keysym: "Return"
     U00B7:
-        label: "·"
+        text: "·"
     squareroot:
-        label: "√"
+        text: "√"
     Greek_pi:
-        label: "π"
+        text: "π"
     division:
-        label: "÷"
+        text: "÷"
     multiply:
-        label: "×"
+        text: "×"
     paragraph:
-        label: "¶"
+        text: "¶"
     Greek_tau:
-        label: "τ"
+        text: "τ"
     copyright:
-        label: "©"
-    numbersign:
-        label: "#"
+        text: "©"
     U00AE:
-        label: "®"
-    at:
-        label: "@"
-    dollar:
-        label: "$"
+        text: "®"
     U00A3:
-        label: "£"
-    percent:
-        label: "%"
+        text: "£"
     EuroSign:
-        label: "€"
-    ampersand:
-        label: "&"
+        text: "€"
     U00A5:
-        label: "¥"
-    minus:
-        label: "-"
+        text: "¥"
     asciicircum:
-        label: "^"
-    underscore:
-        label: "_"
+        text: "^"
     degree:
-        label: "°"
-    plus:
-        label: "+"
-    equal:
-        label: "="
-    parenleft:
-        label: "("
-    parenright:
-        label: ")"
-    braceleft:
-        label: "{"
-    braceright:
-        label: "}"
-    comma:
-        label: ","
-    backslash:
-        label: "\\"
-    slash:
-        label: "/"
-    quotedbl:
-        label: "\""
-    quoteright:
-        label: "'"
-    less:
-        label: "<"
-    greater:
-        label: ">"
-    colon:
-        label: ":"
-    semicolon:
-        label: ";"
-    exclam:
-        label: "!"
-    question:
-        label: "?"
-    bracketleft:
-        label: "["
-    bracketright:
-        label: "]"
+        text: "°"
 

data/keyboards/number.yaml

@@ -1,15 +1,9 @@
 ---
-bounds: { x: 0, y: 0.33, width: 360, height: 210 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 37.46341, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 48.39024, height: 52 }
-    outline7:
-        bounds: { x: 0, y: 0, width: 88.97561, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 120.5853, height: 52 }
+    default: { width: 37.46341, height: 52 }
+    altline: { width: 48.39024, height: 52 }
+    outline7: { width: 88.97561, height: 52 }
+    spaceline: { width: 120.5853, height: 52 }
 
 views:
     base:
@@ -22,22 +16,24 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: erase
     space:
         outline: spaceline
-        label: " "
+        text: " "
     Return:
         outline: outline7
         icon: "key-enter"
+        keysym: "Return"
     asterisk:
-        label: "*"
+        text: "*"
     numbersign:
-        label: "#"
+        text: "#"
     minus:
-        label: "-"
+        text: "-"
     plus:
-        label: "+"
+        text: "+"
     parenleft:
-        label: "("
+        text: "("
     parenright:
-        label: ")"
+        text: ")"
 

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

@@ -1,17 +1,10 @@
 ---
-bounds: { x: 0, y: 0.33, width: 360, height: 210 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 32, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 48.39024, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    outline7:
-        bounds: { x: 0, y: 0, width: 88.97561, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 150.5853, height: 52 }
+    default: { width: 32, height: 52 }
+    altline: { width: 48.39024, height: 52 }
+    wide: { width: 62, height: 52 }
+    outline7: { width: 88.97561, height: 52 }
+    spaceline: { width: 150.5853, height: 52 }
 
 views:
     base:
@@ -46,6 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: erase
     preferences:
         action: "show_prefs"
         outline: "altline"
@@ -69,96 +63,97 @@ buttons:
         outline: altline
     space:
         outline: spaceline
-        label: " "
+        text: " "
     Return:
         outline: "wide"
         icon: "key-enter"
+        keysym: "Return"
     asterisk:
-        label: "*"
+        text: "*"
     asciitilde:
-        label: "~"
+        text: "~"
     quoteleft:
-        label: "`"
+        text: "`"
     bar:
-        label: "|"
+        text: "|"
     U00B7:
-        label: "·"
+        text: "·"
     squareroot:
-        label: "√"
+        text: "√"
     Greek_pi:
-        label: "π"
+        text: "π"
     division:
-        label: "÷"
+        text: "÷"
     multiply:
-        label: "×"
+        text: "×"
     paragraph:
-        label: "¶"
+        text: "¶"
     Greek_tau:
-        label: "τ"
+        text: "τ"
     copyright:
-        label: "©"
+        text: "©"
     numbersign:
-        label: "#"
+        text: "#"
     U00AE:
-        label: "®"
+        text: "®"
     at:
-        label: "@"
+        text: "@"
     dollar:
-        label: "$"
+        text: "$"
     U00A3:
-        label: "£"
+        text: "£"
     percent:
-        label: "%"
+        text: "%"
     EuroSign:
-        label: "€"
+        text: "€"
     ampersand:
-        label: "&"
+        text: "&"
     U00A5:
-        label: "¥"
+        text: "¥"
     minus:
-        label: "-"
+        text: "-"
     asciicircum:
-        label: "^"
+        text: "^"
     underscore:
-        label: "_"
+        text: "_"
     degree:
-        label: "°"
+        text: "°"
     plus:
-        label: "+"
+        text: "+"
     equal:
-        label: "="
+        text: "="
     parenleft:
-        label: "("
+        text: "("
     parenright:
-        label: ")"
+        text: ")"
     braceleft:
-        label: "{"
+        text: "{"
     braceright:
-        label: "}"
+        text: "}"
     comma:
-        label: ","
+        text: ","
     backslash:
-        label: "\\"
+        text: "\\"
     slash:
-        label: "/"
+        text: "/"
     quotedbl:
-        label: "\""
+        text: "\""
     quoteright:
-        label: "'"
+        text: "'"
     less:
-        label: "<"
+        text: "<"
     greater:
-        label: ">"
+        text: ">"
     colon:
-        label: ":"
+        text: ":"
     semicolon:
-        label: ";"
+        text: ";"
     exclam:
-        label: "!"
+        text: "!"
     question:
-        label: "?"
+        text: "?"
     bracketleft:
-        label: "["
+        text: "["
     bracketright:
-        label: "]"
+        text: "]"
 

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

@@ -1,17 +1,10 @@
 ---
-bounds: { x: 0, y: 1, width: 360, height: 208 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 35.33, height: 52 }
-    altline:
-        bounds: { x: 0, y: 0, width: 52.67, height: 52 }
-    wide:
-        bounds: { x: 0, y: 0, width: 62, height: 52 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 142, height: 52 }
-    special:
-        bounds: { x: 0, y: 0, width: 44, height: 52 }
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 62, height: 52 }
+    spaceline: { width: 142, height: 52 }
+    special: { width: 44, height: 52 }
 
 views:
     base:
@@ -46,8 +39,9 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: erase
     preferences:
-        action: "show_prefs"
+        action: show_prefs
         outline: "special"
         icon: "keyboard-mode-symbolic"
     show_numbers:
@@ -72,14 +66,13 @@ buttons:
         label: "*/="
     period:
         outline: "special"
-        label: "."
+        text: "."
     space:
         outline: "spaceline"
-        label: " "
+        text: " "
     Return:
         outline: "wide"
         icon: "key-enter"
+        keysym: "Return"
     colon:
-        label: ":"
-    "\"":
-        keysym: "quotedbl"
+        text: ":"

data/keyboards/us_wide.yaml

@@ -1,39 +1,32 @@
 ---
-bounds: { x: 0, y: 1, width: 540, height: 168 }
-
 outlines:
-    default:
-        bounds: { x: 0, y: 0, width: 54, height: 42 }
-    altline:
-        bounds: { x: 0, y: 0, width: 81, height: 42 }
-    wide:
-        bounds: { x: 0, y: 0, width: 108, height: 42 }
-    spaceline:
-        bounds: { x: 0, y: 0, width: 216, height: 42 }
-    special:
-        bounds: { x: 0, y: 0, width: 54, height: 42 }
+    default: { width: 54, height: 42 }
+    altline: { width: 81, height: 42 }
+    wide: { width: 108, height: 42 }
+    spaceline: { width: 216, 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        period Return"
+        - "show_numbers preferences         space        . 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        period Return"
+        - "show_numbers preferences         space        . Return"
     numbers:
         - "1 2 3 4 5 6 7 8 9 0"
         - "@ # $ % & - _ + ( )"
         - "show_symbols   , \" ' colon ; ! ?  BackSpace"
-        - "show_letters preferences         space        period Return"
+        - "show_letters preferences         space        . Return"
     symbols:
         - "~ ` | · √ π τ ÷ × ¶"
         - "© ® £ € ¥ ^ ° * { }"
         - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
-        - "show_letters preferences         space        period Return"
+        - "show_letters preferences         space        . Return"
 
 buttons:
     Shift_L:
@@ -46,6 +39,7 @@ buttons:
     BackSpace:
         outline: "altline"
         icon: "edit-clear-symbolic"
+        action: "erase"
     preferences:
         action: "show_prefs"
         outline: "special"
@@ -70,16 +64,15 @@ buttons:
             set_view: "symbols"
         outline: "altline"
         label: "*/="
-    period:
+    ".":
         outline: "special"
-        label: "."
+        text: "."
     space:
         outline: "spaceline"
-        label: " "
+        text: " "
     Return:
         outline: "wide"
         icon: "key-enter"
+        keysym: "Return"
     colon:
-        label: ":"
-    "\"":
-        keysym: "quotedbl"
+        text: ":"

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)
-de German
-el Greek
-es Spanish
-fi Finnish
-it Italian
-jp+kana Japanese (kana)
-no Norwegian
-se Swedish
-
+emoji Emoji
+terminal Terminal

data/langs/pl-PL.txt

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

data/squeekboard.gresources.xml

@@ -2,6 +2,7 @@
 <gresources>
   <gresource prefix="/sm/puri/squeekboard">
    <file compressed="true">style.css</file>
+   <file compressed="true">style-Adwaita:dark.css</file>
    <file compressed="true" preprocess="xml-stripblanks">popup.ui</file>
    <file>icons/key-enter.svg</file>
    <file>icons/key-shift.svg</file>

data/style-Adwaita:dark.css

@@ -0,0 +1,51 @@
+sq_view {
+    background-color: rgba(0, 0, 0, 255);
+    color: #ffffff;
+    font-family: cantarell, sans-serif;
+    font-size: 25px;
+}
+
+sq_view sq_button {
+    color: #deddda;
+    background: #464448;
+    border-style: solid;
+    border-width: 1px;
+    border-color: #5e5c64;
+    border-radius: 3px;
+    margin: 4px 2px 4px 2px;
+}
+
+sq_view.wide sq_button {
+    margin: 1px 1px 1px 1px;
+}
+
+sq_button:active {
+    background: #747077;
+    border-color: #96949d;
+}
+
+sq_button.altline,
+sq_button.special,
+sq_button.wide {
+    background: #2b292f;
+    border-color: #3e3a44;
+}
+
+sq_button.locked {
+    background: #ffffff;
+    color: #2b292f;
+}
+
+sq_button.action {
+    font-size: 0.75em;
+}
+
+#Return {
+    background: #1c71d8;
+    border-color: #1a5fb4;
+}
+
+#Return:active {
+    background: #1c71d8;
+    border-color: #3584e4;
+}

data/style.css

@@ -1,15 +1,16 @@
 sq_view {
-    background-color: rgba(0, 0, 0, 255);
-    color: #ffffff;
+    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 {
-    color: #deddda;
-    background: #464448;
+    color: @theme_fg_color; /*#deddda;*/
+    background: mix(@theme_bg_color, @theme_base_color, -0.5); /* #464448; */
     border-style: solid;
     border-width: 1px;
-    border-color: #5e5c64;
+    border-color: @borders; /* #5e5c64;*/
     border-radius: 3px;
     margin: 4px 2px 4px 2px;
 }
@@ -18,29 +19,36 @@ sq_view.wide sq_button {
     margin: 1px 1px 1px 1px;
 }
 
-sq_button:active {
-    background: #747077;
-    border-color: #96949d;
+sq_button:active,
+sq_button.altline:active,
+sq_button.special:active,
+sq_button.wide:active {
+    background: mix(@theme_bg_color, @theme_selected_bg_color, 0.4);/* #747077; */
+    border-color: mix(@borders, @theme_selected_fg_color, 0.5);/* #96949d; */
 }
 
 sq_button.altline,
 sq_button.special,
 sq_button.wide {
-    background: #2b292f;
-    border-color: #3e3a44;
+    background: mix(@theme_bg_color, @theme_base_color, 0.5); /*#2b292f;*/
+    border-color: @borders; /* #3e3a44; */
 }
 
 sq_button.locked {
-    background: #ffffff;
-    color: #2b292f;
+    background: @theme_fg_color; /*#ffffff;*/
+    color: @theme_bg_color; /*#2b292f;*/
+}
+
+sq_button.action {
+    font-size: 0.75em;
 }
 
 #Return {
-    background: #1c71d8;
-    border-color: #1a5fb4;
+    background: @theme_selected_bg_color; /* #1c71d8; */
+    border-color: @borders; /*#1a5fb4;*/
 }
 
 #Return:active {
-    background: #1c71d8;
-    border-color: #3584e4;
+    background: mix(@theme_selected_bg_color, @theme_bg_color, 0.4); /*#1c71d8;*/
+    border-color: @borders; /*#3584e4;*/
 }

dco.txt

@@ -0,0 +1,39 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+
+

debian/changelog

@@ -1,3 +1,198 @@
+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 ]
+  * keycodes: Sort to eliminate runtime indeterminism
+  * switcher: Switch layout on menu item click
+  * Drop squeek_key
+  * renderer: Remove some unneeded vars
+  * renderer: Simplified outline rendering
+  * renderer: Drop row from button rendering
+  * renderer: Drop unused params
+  * renderer: Simplify surface rendering
+  * rendering: Simplify Cairo context usage, remove unneeded calls.
+  * rendering: Remove unneeded redraw after button release
+  * renderer: Remove unused locked key render function
+  * renderer: Simply cut off when painting outside bounds
+  * renderer: Render whole keyboard the same way as pressed buttons
+
+  [ Mark Müller ]
+  * layout: add German wide layout
+
+  [ Dorota Czaplejewicz ]
+  * renderer: Remove unused functions
+  * cleanup: Remove references to squeek_view
+  * cleanup: Unbox View and Row
+  * cleanup: Remove unused single frame draw
+  * positioning: Calculate sizes instead of storing, move position out of widgets
+  * positioning: Clean up unused code
+  * Fix old Rust woes
+
+  [ Mark Müller ]
+  * layout: add Japanese Kana wide layout
+
+  [ Dorota Czaplejewicz ]
+  * Entry test: Add Terminal input purpose
+  * readme: Add note about Cargo dependencies
+  * Create a library/UI module separation
+  * hacking: Add DCO and licensing requirement
+  * Fix internal .md link
+
+  [ Mark Müller ]
+  * squeekboard-test-layout: add argument parsing and some more output
+
+  [ Dorota Czaplejewicz ]
+  * Use clap in the lockfile
+  * parsing: Remove bounds which weren't used anyway
+  * layout: Respect margins
+  * CI: Build arm64 .deb
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Mon, 23 Dec 2019 11:58:57 +0000
+
+squeekboard (1.4.0) amber-phone; urgency=medium
+
+  * "text" property in layouts
+  * Adjusts to user's color scheme
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Mon, 02 Dec 2019 19:37:01 +0000
+
+squeekboard (1.3.2) amber-phone; urgency=medium
+
+  * Make sure all key presses get accepted by the compositor
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Tue, 26 Nov 2019 15:36:27 +0000
+
 squeekboard (1.3.1) amber-phone; urgency=medium
 
   * Update and fix layouts and languages

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,9 +9,11 @@ Build-Depends:
  ninja-build,
  pkg-config,
  libglib2.0-dev,
+ libgnome-desktop-3-dev,
  libgtk-3-dev,
  libcroco3-dev,
  librust-bitflags-1-dev (>= 1.0),
+ librust-clap-2+default-dev (>= 2.32),
  librust-gio+v2-44-dev,
  librust-glib+v2-44-dev,
  librust-glib-sys-dev,
@@ -25,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
 
@@ -36,7 +35,20 @@ Architecture: linux-any
 Depends:
 # for the Adwaita-dark theme
  gnome-themes-extra-data,
- ${shlibs:Depends}
- ${misc:Depends}
+ ${shlibs: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:
+ python3,
+ python3-gi,
+ ${shlibs:Depends},
+ ${misc:Depends},
+Description: Resources for making Squeekboard layouts
+ Tools for creating and testing Squeekboard layouts:
+ .
+  * squeekboard-entry
+  * squeekboard-test-layout

debian/squeekboard-devel.install

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

debian/squeekboard.install

@@ -0,0 +1,2 @@
+tools/squeekboard-restyled usr/bin
+usr/bin/squeekboard /usr/bin

debian/squeekboard.lintian-overrides

@@ -1,2 +1,2 @@
 # yaml-rust 0.4.3 shares some roots with libyaml, including the string which lintian checks, creating a false positive
-squeekboard binary: embedded-library usr/bin/squeekboard-real: libyaml
+squeekboard binary: embedded-library usr/bin/squeekboard: libyaml

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

@@ -0,0 +1,184 @@
+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](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
+-----------------------
+
+*Squeekboard* is regularly built and tested on [the develpment environment](https://developer.puri.sm/Librem5/Development_Environment.html).
+
+Recent Fedora releases are likely to be tested as well.
+
+### Dependencies
+
+On a Debian based system run
+
+```sh
+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 [`debian/control`](https://source.puri.sm/Librem5/squeekboard/blob/master/debian/control) file.
+
+Testing
+-------
+
+Most common testing is done in CI. Occasionally, and for each release, do perform manual tests to make sure that
+
+- the application draws correctly
+- it shows when relevant
+- it changes layouts
+- it changes views
+
+Testing with an application:
+
+```
+python3 tools/entry.py
+```
+
+Testing visibility:
+
+```
+$ busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b true
+$ busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b false
+```
+
+Testing layouts:
+
+Layouts can be selected using the GNOME Settings application.
+
+```
+# define all available layouts. First one is currently selected.
+$ gsettings set org.gnome.desktop.input-sources sources "[('xkb', 'us'), ('xkb', 'de')]"
+```
+
+Coding
+------
+
+### Project structure
+
+Rust modules should be split into 2 categories: libraries, and user interface. They differ in the way they do error handling.
+
+Libraries should:
+
+- not panic due to external surprises, only due to internal inconsistencies
+- pass errors and surprises they can't handle to the callers instead
+- not silence errors and surprises
+
+User interface modules should:
+
+- try to provide safe values whenever they encounter an error
+- do the logging
+- give libraries the ability to report errors and surprises (e.g. via giving them loggers)
+
+### Style
+
+Code submitted should roughly match the style of surrounding code. Things that will *not* be accepted are ones that often lead to errors:
+
+- skipping brackets `{}` after every `if()`, `else`, and similar
+
+Bad example:
+
+```
+if (foo)
+  bar();
+```
+
+Good example:
+
+```
+if (foo) {
+  bar();
+}
+```
+
+- mixing tabs and spaces in the same block of code (or config)
+
+Strongly encouraged:
+
+- don't make lines too long. If it's longer than ~80 characters, it's probably unreadable already, and the code needs to be clarified;
+- put operators in the beginning of a continuation line
+
+Bad example:
+
+```
+foobar = verylongexpression +
+    anotherverylongexpression + 
+    yetanotherexpression;
+```
+
+Good example:
+
+```
+foobar = verylongexpression
+    + anotherverylongexpression
+    + yetanotherexpression;
+```
+
+- use `///` for documentation comments in front of definitions and `/*! ... */` for documentation comments in the beginning of modules (see [Rust doc-comments](https://doc.rust-lang.org/reference/comments.html#doc-comments))
+
+If in doubt, check [PEP8](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md), the [kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html), or the [Rust style guide](https://github.com/rust-dev-tools/fmt-rfcs/blob/master/guide/guide.md).
+
+Maintenance
+-----------
+
+Squeekboard uses Rust & Cargo for some of its dependencies.
+
+Use the `cargo.sh` script for maintaining the Cargo part of the build. The script takes the usual Cargo commands, after the first 2 positionsl arguments: source directory, and output artifact. So, `cargo test` becomes:
+
+```
+cd build_dir
+sh /source_path/cargo.sh test
+```
+
+### Cargo dependencies
+
+All Cargo dependencies must be selected in the version available in PureOS, and added to the file `debian/control`. Please check with https://software.pureos.net/search_pkg?term=librust .
+
+Dependencies must be specified in `Cargo.toml` with 2 numbers: "major.minor". Since bugfix version number is meant to not affect the interface, this allows for safe updates.
+
+`Cargo.lock` is used for remembering the revisions of all Rust dependencies. It should be updated often, preferably with each bugfix revision, and in a commit on its own:
+
+```
+cd build_dir
+sh /source_path/cargo.sh update
+ninja test
+```

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,32 +39,23 @@
 
 #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;
-    LevelKeyboard *keyboard; // unowned reference; it's kept in server-context (FIXME)
+    EekRenderer *renderer; // owned, nullable
+    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;
 
 G_DEFINE_TYPE_WITH_PRIVATE (EekGtkKeyboard, eek_gtk_keyboard, GTK_TYPE_DRAWING_AREA)
 
-static void       render_pressed_button      (GtkWidget *widget, struct button_place *place);
-static void       render_released_button     (GtkWidget *widget,
-                                              const struct squeek_button *button);
-
 static void
 eek_gtk_keyboard_real_realize (GtkWidget      *self)
 {
@@ -85,38 +76,63 @@ eek_gtk_keyboard_real_draw (GtkWidget *self,
                             cairo_t   *cr)
 {
     EekGtkKeyboardPrivate *priv =
-	    eek_gtk_keyboard_get_instance_private (EEK_GTK_KEYBOARD (self));
+        eek_gtk_keyboard_get_instance_private (EEK_GTK_KEYBOARD (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));
     }
 
-    // render the keyboard without any key activity (TODO: from a cached buffer)
-    eek_renderer_render_keyboard (priv->renderer, cr);
-    // render only a few remaining changes
-    squeek_layout_draw_all_changed(priv->keyboard->layout, EEK_GTK_KEYBOARD(self));
+    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));
+        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);
 
@@ -128,8 +144,11 @@ static void depress(EekGtkKeyboard *self,
                     gdouble x, gdouble y, guint32 time)
 {
     EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
-    squeek_layout_depress(priv->keyboard->layout, priv->keyboard->manager->virtual_keyboard,
+    if (!priv->keyboard) {
+        return;
+    }
+    squeek_layout_depress(priv->keyboard->layout,
+                          priv->submission,
                           x, y, eek_renderer_get_transformation(priv->renderer), time, self);
 }
 
@@ -137,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,
-                       x, y, eek_renderer_get_transformation(priv->renderer), time, self);
+    if (!priv->keyboard) {
+        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);
-
-    squeek_layout_release(priv->keyboard->layout, priv->keyboard->manager->virtual_keyboard, eek_renderer_get_transformation(priv->renderer), time, self);
+    if (!priv->keyboard) {
+        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
@@ -170,6 +199,18 @@ eek_gtk_keyboard_real_button_release_event (GtkWidget      *self,
     return TRUE;
 }
 
+static gboolean
+eek_gtk_keyboard_leave_event (GtkWidget      *self,
+                              GdkEventCrossing *event)
+{
+    if (event->type == GDK_LEAVE_NOTIFY) {
+        // TODO: can the event have different coords than the previous move event?
+        release(EEK_GTK_KEYBOARD(self), event->time);
+    }
+    return TRUE;
+}
+
+
 static gboolean
 eek_gtk_keyboard_real_motion_notify_event (GtkWidget      *self,
                                            GdkEventMotion *event)
@@ -217,11 +258,12 @@ static void
 eek_gtk_keyboard_real_unmap (GtkWidget *self)
 {
     EekGtkKeyboardPrivate *priv =
-	    eek_gtk_keyboard_get_instance_private (EEK_GTK_KEYBOARD (self));
+        eek_gtk_keyboard_get_instance_private (EEK_GTK_KEYBOARD (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));
     }
 
@@ -234,6 +276,7 @@ eek_gtk_keyboard_set_property (GObject      *object,
                                const GValue *value,
                                GParamSpec   *pspec)
 {
+    (void)value;
     switch (prop_id) {
     default:
         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
@@ -248,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;
     }
@@ -279,6 +323,9 @@ eek_gtk_keyboard_class_init (EekGtkKeyboardClass *klass)
         eek_gtk_keyboard_real_button_release_event;
     widget_class->motion_notify_event =
         eek_gtk_keyboard_real_motion_notify_event;
+    widget_class->leave_notify_event =
+        eek_gtk_keyboard_leave_event;
+
     widget_class->touch_event = handle_touch_event;
 
     gobject_class->set_property = eek_gtk_keyboard_set_property;
@@ -287,128 +334,50 @@ eek_gtk_keyboard_class_init (EekGtkKeyboardClass *klass)
 
 static void
 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);
 }
-
-static void
-render_pressed_button (GtkWidget *widget,
-                       struct button_place *place)
-{
-    EekGtkKeyboard        *self = EEK_GTK_KEYBOARD (widget);
-    EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
-    GdkWindow         *window  = gtk_widget_get_window (widget);
-    cairo_region_t    *region  = gdk_window_get_clip_region (window);
-    GdkDrawingContext *context = gdk_window_begin_draw_frame (window, region);
-    cairo_t           *cr      = gdk_drawing_context_get_cairo_context (context);
-
-    eek_renderer_render_button (priv->renderer, cr, place, 1.0, TRUE);
-/*
-    eek_renderer_render_key (priv->renderer, cr, key, 1.5, TRUE);
-*/
-    gdk_window_end_draw_frame (window, context);
-
-    cairo_region_destroy (region);
-}
-
-void
-eek_gtk_render_locked_button (EekGtkKeyboard *self, struct button_place place)
-{
-    EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
-    GdkWindow         *window  = gtk_widget_get_window (GTK_WIDGET(self));
-    cairo_region_t    *region  = gdk_window_get_clip_region (window);
-    GdkDrawingContext *context = gdk_window_begin_draw_frame (window, region);
-    cairo_t           *cr      = gdk_drawing_context_get_cairo_context (context);
-
-    eek_renderer_render_button (priv->renderer, cr, &place, 1.0, TRUE);
-
-    gdk_window_end_draw_frame (window, context);
-
-    cairo_region_destroy (region);
-}
-
-// TODO: does it really redraw the entire keyboard?
-static void
-render_released_button (GtkWidget *widget,
-                        const struct squeek_button *button)
-{
-    (void)button;
-    EekGtkKeyboard        *self = EEK_GTK_KEYBOARD (widget);
-    EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
-    GdkWindow         *window  = gtk_widget_get_window (widget);
-    cairo_region_t    *region  = gdk_window_get_clip_region (window);
-    GdkDrawingContext *context = gdk_window_begin_draw_frame (window, region);
-    cairo_t           *cr      = gdk_drawing_context_get_cairo_context (context);
-
-    eek_renderer_render_keyboard (priv->renderer, cr);
-
-    gdk_window_end_draw_frame (window, context);
-
-    cairo_region_destroy (region);
-}
-
-void
-eek_gtk_on_button_pressed (struct button_place place,
-                   EekGtkKeyboard *self)
-{
-    EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
-    /* renderer may have not been set yet if the widget is a popup */
-    if (!priv->renderer)
-        return;
-
-    if (!place.row) {
-        return;
-    }
-    render_pressed_button (GTK_WIDGET(self), &place);
-    gtk_widget_queue_draw (GTK_WIDGET(self));
-
-#if HAVE_LIBCANBERRA
-    ca_gtk_play_for_widget (widget, 0,
-                            CA_PROP_EVENT_ID, "button-pressed",
-                            CA_PROP_EVENT_DESCRIPTION, "virtual key pressed",
-                            CA_PROP_APPLICATION_ID, "org.fedorahosted.Eekboard",
-                            NULL);
-#endif
-}
-
-void
-eek_gtk_on_button_released (const struct squeek_button *button,
-                    struct squeek_view *view,
-                    EekGtkKeyboard *self)
-{
-    (void)view;
-    EekGtkKeyboardPrivate *priv = eek_gtk_keyboard_get_instance_private (self);
-
-    /* renderer may have not been set yet if the widget is a popup */
-    if (!priv->renderer)
-        return;
-
-    render_released_button (GTK_WIDGET(self), button);
-    gtk_widget_queue_draw (GTK_WIDGET(self));
-
-#if HAVE_LIBCANBERRA
-    ca_gtk_play_for_widget (widget, 0,
-                            CA_PROP_EVENT_ID, "button-released",
-                            CA_PROP_EVENT_DESCRIPTION, "virtual key pressed",
-                            CA_PROP_APPLICATION_ID, "org.fedorahosted.Eekboard",
-                            NULL);
-#endif
-}

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,49 +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"
-#include "eekboard/eekboard-context-service.h"
-#include "eekboard/key-emitter.h"
-#include "keymap.h"
-#include "src/keyboard.h"
+#define _XOPEN_SOURCE 500
+#include <fcntl.h>
+#include <string.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) {
-    self->layout = layout;
-}
-
-LevelKeyboard *level_keyboard_new(EekboardContextService *manager, struct squeek_layout *layout) {
+LevelKeyboard*
+level_keyboard_new (struct squeek_layout *layout)
+{
     LevelKeyboard *keyboard = g_new0(LevelKeyboard, 1);
-    level_keyboard_init(keyboard, layout);
-    keyboard->manager = manager;
+
+    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");
+    }
+
+    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;
 }
-
-struct squeek_view *level_keyboard_current(LevelKeyboard *keyboard)
-{
-    return squeek_layout_get_current_view(keyboard->layout);
-}

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,17 +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);
 
-struct squeek_view *level_keyboard_current(LevelKeyboard *keyboard);
-LevelKeyboard *level_keyboard_new(EekboardContextService *manager, struct squeek_layout *layout);
-void level_keyboard_deinit(LevelKeyboard *self);
+LevelKeyboard*
+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

@@ -26,145 +26,17 @@
 
 #include "eek-keyboard.h"
 #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;
-
-    gdouble allocation_width;
-    gdouble allocation_height;
-    gdouble scale;
-    gint scale_factor; /* the outputs scale factor */
-    gint origin_x;
-    gint origin_y;
-
-    PangoFontDescription *font; // owned reference
-    cairo_surface_t *keyboard_surface;
-
-} 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,
-                                                const struct squeek_button *button);
+static void render_button_label (cairo_t *cr, GtkStyleContext *ctx,
+                                                const gchar *label, EekBounds bounds);
 
-static void invalidate                         (EekRenderer *renderer);
-static void render_button                         (EekRenderer *self,
-                                                cairo_t     *cr, EekBounds view_bounds, struct button_place *place,
+void eek_render_button                         (EekRenderer *self,
+                                                cairo_t     *cr, const struct squeek_button *button,
                                                 gboolean     pressed, gboolean locked);
 
-struct _CreateKeyboardSurfaceCallbackData {
-    cairo_t *cr;
-    EekRenderer *renderer;
-    struct squeek_view *view;
-    struct squeek_row *row;
-};
-typedef struct _CreateKeyboardSurfaceCallbackData CreateKeyboardSurfaceCallbackData;
-
-static void
-create_keyboard_surface_button_callback (struct squeek_button *button,
-                                      gpointer    user_data)
-{
-    CreateKeyboardSurfaceCallbackData *data = user_data;
-    EekBounds bounds = squeek_button_get_bounds(button);
-
-    cairo_save (data->cr);
-
-    cairo_translate (data->cr, bounds.x, bounds.y);
-    cairo_rectangle (data->cr,
-                     0.0,
-                     0.0,
-                     bounds.width + 100,
-                     bounds.height + 100);
-    cairo_clip (data->cr);
-    struct button_place place = {
-        .row = data->row,
-        .button = button,
-    };
-    render_button (data->renderer, data->cr, squeek_view_get_bounds(data->view), &place, FALSE, FALSE);
-
-    cairo_restore (data->cr);
-}
-
-static void
-create_keyboard_surface_row_callback (struct squeek_row *row,
-                                          gpointer    user_data)
-{
-    CreateKeyboardSurfaceCallbackData *data = user_data;
-
-    EekBounds bounds = squeek_row_get_bounds(row);
-
-    cairo_save (data->cr);
-    cairo_translate (data->cr, bounds.x, bounds.y);
-
-    gint angle = squeek_row_get_angle (row);
-    cairo_rotate (data->cr, angle * G_PI / 180);
-
-    data->row = row;
-    squeek_row_foreach(row, create_keyboard_surface_button_callback, data);
-
-    cairo_restore (data->cr);
-}
-
-static void
-render_keyboard_surface (EekRenderer *renderer, struct squeek_view *view)
-{
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-
-    GdkRGBA color = {0};
-    gtk_style_context_get_color (priv->view_context, GTK_STATE_FLAG_NORMAL, &color);
-
-    EekBounds bounds = squeek_view_get_bounds (level_keyboard_current(priv->keyboard));
-
-    CreateKeyboardSurfaceCallbackData data = {
-        .cr = cairo_create (priv->keyboard_surface),
-        .renderer = renderer,
-        .view = view,
-    };
-
-    /* Paint the background covering the entire widget area */
-    gtk_render_background (priv->view_context,
-                           data.cr,
-                           0, 0,
-                           priv->allocation_width, priv->allocation_height);
-    gtk_render_frame (priv->view_context,
-                      data.cr,
-                      0, 0,
-                      priv->allocation_width, priv->allocation_height);
-
-    cairo_save (data.cr);
-    cairo_scale (data.cr, priv->scale, priv->scale);
-    cairo_translate (data.cr, bounds.x, bounds.y);
-
-    cairo_set_source_rgba (data.cr,
-                           color.red,
-                           color.green,
-                           color.blue,
-                           color.alpha);
-
-    /* draw rows */
-    squeek_view_foreach(level_keyboard_current(priv->keyboard),
-                        create_keyboard_surface_row_callback,
-                        &data);
-
-    cairo_restore (data.cr);
-
-    cairo_destroy (data.cr);
-}
-
 static void
 render_outline (cairo_t     *cr,
                 GtkStyleContext *ctx,
@@ -188,47 +60,20 @@ render_outline (cairo_t     *cr,
         position.x, position.y, position.width, position.height);
 }
 
-static void render_button_in_context(EekRenderer *self,
-                                     gdouble scale,
-                                     gint scale_factor,
+static void render_button_in_context(gint scale_factor,
                                      cairo_t     *cr,
                                      GtkStyleContext *ctx,
-                                     EekBounds view_bounds,
-                                     struct button_place *place,
-                                     gboolean active) {
-    cairo_surface_t *outline_surface = NULL;
+                                     const struct squeek_button *button) {
+    /* blank background */
+    cairo_set_source_rgba (cr, 0.0, 0.0, 0.0, 0.0);
+    cairo_paint (cr);
 
-    /* render outline */
-    EekBounds bounds = squeek_button_get_bounds(place->button);
-
-    {
-        cairo_t *cr;
-
-        // Outline will be drawn on the outside of the button, so the
-        // surface needs to be bigger than the button
-        outline_surface =
-            cairo_image_surface_create (CAIRO_FORMAT_ARGB32,
-                                        (int)ceil(bounds.width) + 10,
-                                        (int)ceil(bounds.height) + 10);
-        cr = cairo_create (outline_surface);
-
-        /* blank background */
-        cairo_set_source_rgba (cr, 0.0, 0.0, 0.0, 0.0);
-        cairo_paint (cr);
-
-        cairo_save (cr);
-        eek_renderer_apply_transformation_for_button (cr, view_bounds, place, 1.0, FALSE);
-        render_outline (cr, ctx, bounds);
-        cairo_restore (cr);
-
-        cairo_destroy (cr);
-    }
-    cairo_set_source_surface (cr, outline_surface, 0.0, 0.0);
-    cairo_surface_destroy(outline_surface);
+    EekBounds bounds = squeek_button_get_bounds(button);
+    render_outline (cr, ctx, bounds);
     cairo_paint (cr);
 
     /* render icon (if any) */
-    const char *icon_name = squeek_button_get_icon_name(place->button);
+    const char *icon_name = squeek_button_get_icon_name(button);
 
     if (icon_name) {
         cairo_surface_t *icon_surface =
@@ -258,25 +103,26 @@ static void render_button_in_context(EekRenderer *self,
             return;
         }
     }
-    eek_renderer_render_button_label (self, cr, ctx, place->button);
+
+    const gchar *label = squeek_button_get_label(button);
+    if (label) {
+        render_button_label (cr, ctx, label, squeek_button_get_bounds(button));
+    }
 }
 
-static void
-render_button (EekRenderer *self,
+void
+eek_render_button (EekRenderer *self,
             cairo_t     *cr,
-               EekBounds view_bounds,
-            struct button_place *place,
+            const struct squeek_button *button,
                gboolean     pressed,
                gboolean     locked)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
-
-    GtkStyleContext *ctx = priv->button_context;
+    GtkStyleContext *ctx = self->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;
     path = gtk_widget_path_copy (gtk_style_context_get_path (ctx));
-    const char *name = squeek_button_get_name(place->button);
+    const char *name = squeek_button_get_name(button);
     gtk_widget_path_iter_set_name (path, -1, name);
 
     /* Update the style context with the updated widget path. */
@@ -285,13 +131,13 @@ render_button (EekRenderer *self,
        (pressed) or normal. */
     gtk_style_context_set_state(ctx,
         pressed ? GTK_STATE_FLAG_ACTIVE : GTK_STATE_FLAG_NORMAL);
-    const char *outline_name = squeek_button_get_outline_name(place->button);
+    const char *outline_name = squeek_button_get_outline_name(button);
     if (locked) {
         gtk_style_context_add_class(ctx, "locked");
     }
     gtk_style_context_add_class(ctx, outline_name);
 
-    render_button_in_context(self, priv->scale, priv->scale_factor, cr, ctx, view_bounds, place, pressed);
+    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);
@@ -301,85 +147,17 @@ render_button (EekRenderer *self,
     }
 }
 
-/**
- * eek_renderer_apply_transformation_for_key:
- * @self: The renderer used to render the key
- * @cr: The Cairo rendering context used for rendering
- * @key: The key to be transformed
- * @scale: The factor used to scale the key bounds before rendering
- * @rotate: Whether to rotate the key by the angle defined for the key's
- *   in its section definition
- *
- *  Applies a transformation, consisting of scaling and rotation, to the
- *  current rendering context using the bounds for the given key. The scale
- *  factor is separate to the normal scale factor for the keyboard as a whole
- *  and is applied cumulatively. It is typically used to render larger than
- *  normal keys for popups.
-*/
-void
-eek_renderer_apply_transformation_for_button (cairo_t     *cr,
-                                              EekBounds view_bounds,
-                                           struct button_place *place,
-                                           gdouble      scale,
-                                           gboolean     rotate)
-{
-    EekBounds bounds, rotated_bounds;
-    gdouble s;
-
-    eek_renderer_get_button_bounds (view_bounds, place, &bounds, FALSE);
-    eek_renderer_get_button_bounds (view_bounds, place, &rotated_bounds, TRUE);
-
-    gint angle = squeek_row_get_angle (place->row);
-
-    cairo_scale (cr, scale, scale);
-    if (rotate) {
-        s = sin (angle * G_PI / 180);
-        if (s < 0)
-            cairo_translate (cr, 0, - bounds.width * s);
-        else
-            cairo_translate (cr, bounds.height * s, 0);
-        cairo_rotate (cr, angle * G_PI / 180);
-    }
-}
-
 static void
-eek_renderer_render_button_label (EekRenderer *self,
-                                  cairo_t     *cr,
-                                  GtkStyleContext *ctx,
-                                  const struct squeek_button *button)
+render_button_label (cairo_t     *cr,
+                     GtkStyleContext *ctx,
+                     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;
-
-
-    if (!priv->font) {
-        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));
-
+    gtk_style_context_get(ctx,
+                          gtk_style_context_get_state(ctx),
+                          "font", &font,
+                          NULL);
     PangoLayout *layout = pango_cairo_create_layout (cr);
     pango_layout_set_font_description (layout, font);
     pango_font_description_free (font);
@@ -389,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_SCALE * bounds.width * scale);
+    pango_layout_set_width (layout, PANGO_SCALE * bounds.width);
 
     PangoRectangle extents = { 0, };
     pango_layout_get_extents (layout, NULL, &extents);
@@ -414,170 +191,46 @@ eek_renderer_render_button_label (EekRenderer *self,
     g_object_unref (layout);
 }
 
-/*
- * eek_renderer_real_render_key:
- * @self: The renderer used to render the key
- * @cr: The Cairo rendering context used for rendering
- * @key: The key to be transformed
- * @scale: The factor used to scale the key bounds before rendering
- * @rotate: Whether to rotate the key by the angle defined for the key's
- *   in its section definition
- *
- *   Renders a key separately from the normal keyboard rendering.
-*/
-static void
-eek_renderer_real_render_button (EekRenderer *self,
-                              cairo_t     *cr,
-                              struct button_place *place,
-                              gdouble      scale,
-                              gboolean     rotate)
+// FIXME: Pass just the active modifiers instead of entire submission
+void
+eek_renderer_render_keyboard (EekRenderer *self,
+                              struct submission *submission,
+                                   cairo_t     *cr,
+                              LevelKeyboard *keyboard)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
-    EekBounds bounds;
+    g_return_if_fail (self->allocation_width > 0.0);
+    g_return_if_fail (self->allocation_height > 0.0);
 
-    EekBounds view_bounds = squeek_view_get_bounds (level_keyboard_current(priv->keyboard));
-    eek_renderer_get_button_bounds (view_bounds, place, &bounds, rotate);
+    /* Paint the background covering the entire widget area */
+    gtk_render_background (self->view_context,
+                           cr,
+                           0, 0,
+                           self->allocation_width, self->allocation_height);
 
-    cairo_save (cr);
-    /* Because this function is called separately from the keyboard rendering
-       function, the transformation for the context needs to be set up */
-    cairo_translate (cr, priv->origin_x, priv->origin_y);
-    cairo_scale (cr, priv->scale, priv->scale);
-    cairo_translate (cr, bounds.x, bounds.y);
+    cairo_save(cr);
+    cairo_translate (cr, self->widget_to_layout.origin_x, self->widget_to_layout.origin_y);
+    cairo_scale (cr, self->widget_to_layout.scale, self->widget_to_layout.scale);
 
-    eek_renderer_apply_transformation_for_button (cr, view_bounds, place, scale, rotate);
-    struct squeek_key *key = squeek_button_get_key(place->button);
-    render_button (
-                self, cr, view_bounds, place,
-                squeek_key_is_pressed(key) != 0,
-                squeek_key_is_locked (key) != 0
-    );
+    squeek_draw_layout_base_view(keyboard->layout, self, cr);
+    squeek_layout_draw_all_changed(keyboard->layout, self, cr, submission);
     cairo_restore (cr);
 }
 
-static void
-eek_renderer_real_render_keyboard (EekRenderer *self,
-                                   cairo_t     *cr)
+void
+eek_renderer_free (EekRenderer        *self)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
-    cairo_pattern_t *source;
-
-    g_return_if_fail (priv->keyboard);
-    g_return_if_fail (priv->allocation_width > 0.0);
-    g_return_if_fail (priv->allocation_height > 0.0);
-
-    cairo_save (cr);
-
-    cairo_translate (cr, priv->origin_x, priv->origin_y);
-
-    if (priv->keyboard_surface)
-        cairo_surface_destroy (priv->keyboard_surface);
-
-    priv->keyboard_surface = cairo_surface_create_for_rectangle (
-        cairo_get_target (cr), 0, 0,
-        priv->allocation_width, priv->allocation_height);
-
-    render_keyboard_surface (self, squeek_layout_get_current_view(priv->keyboard->layout));
-
-    cairo_set_source_surface (cr, priv->keyboard_surface, 0.0, 0.0);
-    source = cairo_get_source (cr);
-    cairo_pattern_set_extend (source, CAIRO_EXTEND_PAD);
-    cairo_paint (cr);
-
-    cairo_restore (cr);
-}
-
-static void
-eek_renderer_set_property (GObject      *object,
-                           guint         prop_id,
-                           const GValue *value,
-                           GParamSpec   *pspec)
-{
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (
-            EEK_RENDERER(object));
-
-    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;
+    if (self->pcontext) {
+        g_object_unref (self->pcontext);
+        self->pcontext = NULL;
     }
+    g_object_unref(self->css_provider);
+    g_object_unref(self->view_context);
+    g_object_unref(self->button_context);
+    // this is where renderer-specific surfaces would be released
+
+    free(self);
 }
 
-static void
-eek_renderer_get_property (GObject    *object,
-                           guint       prop_id,
-                           GValue     *value,
-                           GParamSpec *pspec)
-{
-    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 will release all allocated surfaces and font if any */
-    invalidate (EEK_RENDERER(object));
-
-    G_OBJECT_CLASS (eek_renderer_parent_class)->dispose (object);
-}
-
-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;
-
-    klass->render_button = eek_renderer_real_render_button;
-    klass->render_keyboard = eek_renderer_real_render_keyboard;
-
-    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);
@@ -605,200 +258,83 @@ static GType button_type() {
 }
 
 static void
-eek_renderer_init (EekRenderer *self)
+renderer_init (EekRenderer *self)
 {
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (self);
-
-    priv->keyboard = NULL;
-    priv->pcontext = NULL;
-    priv->border_width = 1.0;
-    priv->allocation_width = 0.0;
-    priv->allocation_height = 0.0;
-    priv->scale = 1.0;
-    priv->scale_factor = 1;
-    priv->font = NULL;
-    priv->keyboard_surface = NULL;
+    self->pcontext = NULL;
+    self->allocation_width = 0.0;
+    self->allocation_height = 0.0;
+    self->scale_factor = 1;
 
     GtkIconTheme *theme = gtk_icon_theme_get_default ();
 
     gtk_icon_theme_add_resource_path (theme, "/sm/puri/squeekboard/icons");
 
-    /* Create a default CSS provider and load a style sheet */
-    priv->css_provider = gtk_css_provider_new ();
-    gtk_css_provider_load_from_resource (priv->css_provider,
-        "/sm/puri/squeekboard/style.css");
-}
-
-static void
-invalidate (EekRenderer *renderer)
-{
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-
-    if (priv->keyboard_surface) {
-        cairo_surface_destroy (priv->keyboard_surface);
-        priv->keyboard_surface = NULL;
-    }
+    self->css_provider = squeek_load_style();
 }
 
 EekRenderer *
 eek_renderer_new (LevelKeyboard  *keyboard,
                   PangoContext *pcontext)
 {
-    EekRenderer *renderer = g_object_new (EEK_TYPE_RENDERER,
-                         "pango-context", pcontext,
-                         NULL);
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-    priv->keyboard = keyboard;
+    EekRenderer *renderer = calloc(1, sizeof(EekRenderer));
+    renderer_init(renderer);
+    renderer->pcontext = pcontext;
+    g_object_ref (renderer->pcontext);
 
     /* 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();
-    gtk_style_context_set_path(priv->view_context, path);
+    renderer->view_context = gtk_style_context_new();
+    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) {
-        gtk_style_context_add_class(priv->view_context, "wide");
+    if (squeek_layout_get_kind(keyboard->layout) == ARRANGEMENT_KIND_WIDE) {
+        gtk_style_context_add_class(renderer->view_context, "wide");
     }
-    gtk_style_context_add_provider (priv->view_context,
-        GTK_STYLE_PROVIDER(priv->css_provider),
+    gtk_style_context_add_provider (renderer->view_context,
+        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 ();
-    gtk_style_context_set_path(priv->button_context, path);
+    renderer->button_context = gtk_style_context_new ();
+    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_state (priv->button_context, GTK_STATE_FLAG_NORMAL);
-    gtk_style_context_add_provider (priv->button_context,
-        GTK_STYLE_PROVIDER(priv->css_provider),
+    gtk_style_context_set_parent(renderer->button_context, renderer->view_context);
+    gtk_style_context_set_state (renderer->button_context, GTK_STATE_FLAG_NORMAL);
+    gtk_style_context_add_provider (renderer->button_context,
+        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)
 {
-    gdouble scale;
-
-    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;
-    priv->allocation_height = height;
+    renderer->widget_to_layout = squeek_layout_calculate_transformation(
+                layout,
+                renderer->allocation_width, renderer->allocation_height);
 
-    /* Calculate a scale factor to use when rendering the keyboard into the
-       available space. */
-    EekBounds bounds = squeek_view_get_bounds (level_keyboard_current(priv->keyboard));
-
-    gdouble w = (bounds.x * 2) + bounds.width;
-    gdouble h = (bounds.y * 2) + bounds.height;
-
-    scale = MIN(width / w, height / h);
-
-    priv->scale = scale;
-    /* Set the rendering offset in widget coordinates to center the keyboard */
-    priv->origin_x = (gint)floor((width - (scale * w)) / 2);
-    priv->origin_y = (gint)floor((height - (scale * h)) / 2);
-    invalidate (renderer);
-}
-
-void
-eek_renderer_get_size (EekRenderer *renderer,
-                       gdouble     *width,
-                       gdouble     *height)
-{
-    g_return_if_fail (EEK_IS_RENDERER(renderer));
-
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-
-    EekBounds bounds = squeek_view_get_bounds (level_keyboard_current(priv->keyboard));
-    if (width)
-        *width = bounds.width;
-    if (height)
-        *height = bounds.height;
-}
-
-void
-eek_renderer_get_button_bounds (EekBounds view_bounds,
-                                struct button_place *place,
-                             EekBounds   *bounds,
-                             gboolean     rotate)
-{
-    gint angle = 0;
-    EekPoint points[4], min, max;
-
-    g_return_if_fail (place);
-    g_return_if_fail (bounds != NULL);
-
-    EekBounds button_bounds = squeek_button_get_bounds(place->button);
-    EekBounds row_bounds = squeek_row_get_bounds (place->row);
-
-    if (!rotate) {
-        button_bounds.x += view_bounds.x + row_bounds.x;
-        button_bounds.y += view_bounds.y + row_bounds.y;
-        *bounds = button_bounds;
-        return;
-    }
-    points[0].x = button_bounds.x;
-    points[0].y = button_bounds.y;
-    points[1].x = points[0].x + button_bounds.width;
-    points[1].y = points[0].y;
-    points[2].x = points[1].x;
-    points[2].y = points[1].y + button_bounds.height;
-    points[3].x = points[0].x;
-    points[3].y = points[2].y;
-
-    if (rotate) {
-        angle = squeek_row_get_angle (place->row);
-    }
-
-    min = points[2];
-    max = points[0];
-    for (unsigned i = 0; i < G_N_ELEMENTS(points); i++) {
-        eek_point_rotate (&points[i], angle);
-        if (points[i].x < min.x)
-            min.x = points[i].x;
-        if (points[i].x > max.x)
-            max.x = points[i].x;
-        if (points[i].y < min.y)
-            min.y = points[i].y;
-        if (points[i].y > max.y)
-            max.y = points[i].y;
-    }
-    bounds->x = view_bounds.x + row_bounds.x + min.x;
-    bounds->y = view_bounds.y + row_bounds.y + min.y;
-    bounds->width = (max.x - min.x);
-    bounds->height = (max.y - min.y);
-}
-
-gdouble
-eek_renderer_get_scale (EekRenderer *renderer)
-{
-    g_return_val_if_fail (EEK_IS_RENDERER(renderer), 0);
-
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-
-    return priv->scale;
+    // This is where size-dependent surfaces would be released
 }
 
 void
 eek_renderer_set_scale_factor (EekRenderer *renderer, gint scale)
 {
-    g_return_if_fail (EEK_IS_RENDERER(renderer));
-
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-    priv->scale_factor = scale;
+    renderer->scale_factor = scale;
 }
 
 cairo_surface_t *
@@ -825,86 +361,7 @@ eek_renderer_get_icon_surface (const gchar *icon_name,
     return surface;
 }
 
-void
-eek_renderer_render_button (EekRenderer *renderer,
-                         cairo_t     *cr,
-                         struct button_place *place,
-                         gdouble      scale,
-                         gboolean     rotate)
-{
-    g_return_if_fail (EEK_IS_RENDERER(renderer));
-    g_return_if_fail (place);
-    g_return_if_fail (scale >= 0.0);
-
-    EEK_RENDERER_GET_CLASS(renderer)->
-        render_button (renderer, cr, place, scale, rotate);
-}
-
-void
-eek_renderer_render_keyboard (EekRenderer *renderer,
-                              cairo_t     *cr)
-{
-    g_return_if_fail (EEK_IS_RENDERER(renderer));
-    EEK_RENDERER_GET_CLASS(renderer)->render_keyboard (renderer, cr);
-}
-
-static gboolean
-sign (EekPoint *p1, EekPoint *p2, EekPoint *p3)
-{
-    // FIXME: what is this actually checking?
-    return (p1->x - p3->x) * (p2->y - p3->y) -
-        (p2->x - p3->x) * (p1->y - p3->y);
-}
-
-uint32_t
-eek_are_bounds_inside (EekBounds bounds, EekPoint point, EekPoint origin, int32_t angle)
-{
-    EekPoint points[4];
-    gboolean b1, b2, b3;
-
-    points[0].x = bounds.x;
-    points[0].y = bounds.y;
-    points[1].x = points[0].x + bounds.width;
-    points[1].y = points[0].y;
-    points[2].x = points[1].x;
-    points[2].y = points[1].y + bounds.height;
-    points[3].x = points[0].x;
-    points[3].y = points[2].y;
-
-    for (unsigned i = 0; i < G_N_ELEMENTS(points); i++) {
-        eek_point_rotate (&points[i], angle);
-        points[i].x += origin.x;
-        points[i].y += origin.y;
-    }
-
-    b1 = sign (&point, &points[0], &points[1]) < 0.0;
-    b2 = sign (&point, &points[1], &points[2]) < 0.0;
-    b3 = sign (&point, &points[2], &points[0]) < 0.0;
-
-    if (b1 == b2 && b2 == b3) {
-        return 1;
-    }
-
-    b1 = sign (&point, &points[2], &points[3]) < 0.0;
-    b2 = sign (&point, &points[3], &points[0]) < 0.0;
-    b3 = sign (&point, &points[0], &points[2]) < 0.0;
-
-    if (b1 == b2 && b2 == b3) {
-        return 1;
-    }
-    return 0;
-}
-
 struct transformation
 eek_renderer_get_transformation (EekRenderer *renderer) {
-    struct transformation failed = {0};
-    g_return_val_if_fail (EEK_IS_RENDERER(renderer), failed);
-
-    EekRendererPrivate *priv = eek_renderer_get_instance_private (renderer);
-    struct transformation ret = {
-        .origin_x = priv->origin_x,
-        .origin_y = priv->origin_y,
-        .scale = priv->scale,
-    };
-    return ret;
+    return renderer->widget_to_layout;
 }

eek/eek-renderer.h

@@ -25,75 +25,49 @@
 #include <pango/pangocairo.h>
 
 #include "eek-types.h"
-#include "src/layout.h"
+#include "src/submission.h"
 
-G_BEGIN_DECLS
+struct squeek_layout;
 
-#define EEK_TYPE_RENDERER (eek_renderer_get_type())
-G_DECLARE_DERIVABLE_TYPE (EekRenderer, eek_renderer, EEK, RENDERER, GObject)
-
-struct _EekRendererClass
+/// Renders LevelKayboards
+/// It cannot adjust styles at runtime.
+typedef struct EekRenderer
 {
-    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
 
-    void             (* render_button)         (EekRenderer *self,
-                                             cairo_t     *cr,
-                                             struct button_place *place,
-                                             gdouble      scale,
-                                             gboolean     rotate);
+    // Mutable state
+    /// Background extents
+    gdouble allocation_width;
+    gdouble allocation_height;
+    gint scale_factor; /* the outputs scale factor */
+    /// Coords transformation
+    struct transformation widget_to_layout;
+} EekRenderer;
 
-    void             (* render_keyboard)    (EekRenderer *self,
-                                             cairo_t     *cr);
-
-    cairo_surface_t *(* get_icon_surface)   (EekRenderer *self,
-                                             const gchar *icon_name,
-                                             gint         size,
-                                             gint         scale);
-
-    /*< 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_get_size         (EekRenderer     *renderer,
-                                                gdouble         *width,
-                                                gdouble         *height);
-void             eek_renderer_get_button_bounds   (EekBounds view_bounds,
-                                                struct button_place *button,
-                                                EekBounds       *bounds,
-                                                gboolean         rotate);
-
-gdouble          eek_renderer_get_scale        (EekRenderer     *renderer);
 void             eek_renderer_set_scale_factor (EekRenderer     *renderer,
                                                 gint             scale);
 
-void             eek_renderer_render_button       (EekRenderer     *renderer,
-                                                cairo_t         *cr,
-                                                struct button_place *place,
-                                                gdouble          scale,
-                                                gboolean         rotate);
-
 cairo_surface_t *eek_renderer_get_icon_surface(const gchar     *icon_name,
                                                 gint             size,
                                                 gint             scale);
 
-void             eek_renderer_render_keyboard  (EekRenderer     *renderer,
-                                                cairo_t         *cr);
-void             eek_renderer_set_border_width (EekRenderer     *renderer,
-                                                gdouble          border_width);
-void             eek_renderer_apply_transformation_for_button
-                                               (cairo_t         *cr,
-                                                EekBounds view_bounds,
-                                                struct button_place *place,
-                                                gdouble          scale,
-                                                gboolean         rotate);
+void             eek_renderer_render_keyboard  (EekRenderer     *renderer, struct submission *submission,
+                                                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;
 
 /**
@@ -88,5 +89,14 @@ struct transformation {
     gdouble origin_y;
     gdouble scale;
 };
+
+struct squeek_button;
+struct squeek_row;
+
+/// Represents the path to the button within a view
+struct button_place {
+    const struct squeek_row *row;
+    const struct squeek_button *button;
+};
 G_END_DECLS
 #endif  /* EEK_TYPES_H */

eek/eek-xml-layout.c

@@ -1,40 +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/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);
-    squeek_layout_place_contents(layout);
-    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 {
-    ENABLED,
-    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;
+#define LAYOUT_HOLDER_GET_PRIVATE(obj)                       \
+    (G_TYPE_INSTANCE_GET_PRIVATE ((obj), EEKBOARD_TYPE_LAYOUT_HOLDER, LayoutHolderPrivate))
 
+struct _LayoutHolderPrivate {
     LevelKeyboard *keyboard; // currently used keyboard
-    GHashTable *keyboard_hash; // a table of available keyboards, per layout
 
-    GSettings *settings;
-    uint32_t hint;
-    uint32_t purpose;
+    /// Needed for keymap changes after keyboard updates
+    struct submission *submission; // unowned
 };
 
-G_DEFINE_TYPE_WITH_PRIVATE (EekboardContextService, eekboard_context_service, 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;
-}
+G_DEFINE_TYPE_WITH_PRIVATE (LayoutHolder, layout_holder, G_TYPE_OBJECT);
 
 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,93 +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)
 {
-    GVariant *inputs = g_settings_get_value(settings, "sources");
-    guint32 index;
-    g_settings_get(settings, "current", "u", &index);
-
-    GVariantIter *iter;
-    g_variant_get(inputs, "a(ss)", &iter);
-
-    for (unsigned i = 0;
-         g_variant_iter_loop(iter, "(ss)", type, layout);
-         i++) {
-        if (i == index) {
-            //printf("Found layout %s %s\n", *type, *layout);
-            break;
-        }
+    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_iter_free(iter);
     g_variant_unref(inputs);
 }
 
 void
-eekboard_context_service_update_layout(EekboardContextService *context, enum squeek_arrangement_kind t)
-{
-    g_autofree gchar *keyboard_type = NULL;
-    g_autofree gchar *keyboard_layout = NULL;
-    settings_get_layout(context->priv->settings, &keyboard_type, &keyboard_layout);
+eek_layout_holder_use_layout(LayoutHolder *context, struct squeek_layout_state *state) {
+    *context->layout = *state;
+    gchar *layout_name = state->overlay_name;
 
-    if (!keyboard_type) {
-        keyboard_type = g_strdup("us");
-    }
-    if (!keyboard_layout) {
-        keyboard_layout = g_strdup("undefined");
-    }
+    if (layout_name == NULL) {
+        layout_name = state->layout_name;
 
-    EekboardContextServicePrivate *priv = EEKBOARD_CONTEXT_SERVICE_GET_PRIVATE(context);
+        switch (state->purpose) {
+        case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NUMBER:
+        case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PHONE:
+            layout_name = "number";
+            break;
+        case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_TERMINAL:
+            layout_name = "terminal";
+            break;
+        default:
+            ;
+        }
 
-    switch (priv->purpose) {
-    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NUMBER:
-    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PHONE:
-        keyboard_layout = g_strdup("number");
-        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)
@@ -264,251 +143,141 @@ eekboard_context_service_update_layout(EekboardContextService *context, enum squ
     }
 }
 
-static void update_layout_and_type(EekboardContextService *context) {
-    eekboard_context_service_update_layout(context, server_context_service_get_layout_type(context));
+static void
+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;
-    update_layout_and_type(context);
+    struct gsettings_tracker *self = user_data;
+    settings_update_layout(self);
     return TRUE;
 }
 
-static void
-eekboard_context_service_constructed (GObject *object)
+void eek_gsettings_tracker_init(struct gsettings_tracker *tracker, LayoutHolder *context, struct squeek_layout_state *layout)
 {
-    EekboardContextService *context = EEKBOARD_CONTEXT_SERVICE (object);
-    context->virtual_keyboard = zwp_virtual_keyboard_manager_v1_create_virtual_keyboard(
-                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
-eekboard_context_service_class_init (EekboardContextServiceClass *klass)
-{
-    GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
-    GParamSpec *pspec;
-
-    klass->show_keyboard = eekboard_context_service_real_show_keyboard;
-    klass->hide_keyboard = eekboard_context_service_real_hide_keyboard;
-
-    gobject_class->constructed = eekboard_context_service_constructed;
-    gobject_class->set_property = eekboard_context_service_set_property;
-    gobject_class->get_property = eekboard_context_service_get_property;
-    gobject_class->dispose = eekboard_context_service_dispose;
-
-    /**
-     * 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"
-                   " changing unavailable");
-    }
-}
-
-/**
- * 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);
+    tracker->layout = layout;
+    tracker->context = context;
+
+    const char *schema_name = "org.gnome.desktop.input-sources";
+    GSettingsSchemaSource *ssrc = g_settings_schema_source_get_default();
+    if (ssrc) {
+        GSettingsSchema *schema = g_settings_schema_source_lookup(ssrc,
+                                                                  schema_name,
+                                                                  TRUE);
+        if (schema) {
+            // Not referencing the found schema directly,
+            // because it's not clear how...
+            tracker->gsettings = g_settings_new (schema_name);
+            gulong conn_id = g_signal_connect(tracker->gsettings, "change-event",
+                                              G_CALLBACK(handle_layout_changed),
+                                              tracker);
+            if (conn_id == 0) {
+                g_warning ("Could not connect to gsettings updates, "
+                           "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/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_CONTEXT_SERVICE_INTERFACE "org.fedorahosted.Eekboard.Context"
-
-#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_TYPE_LAYOUT_HOLDER (layout_holder_get_type())
+#define LAYOUT_HOLDER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EEKBOARD_TYPE_LAYOUT_HOLDER, LayoutHolder))
 #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 _EekboardContextServicePrivate EekboardContextServicePrivate;
+typedef struct _LayoutHolderClass LayoutHolderClass;
+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;
-
-    EekboardContextServicePrivate *priv;
-
-    struct zwp_virtual_keyboard_v1 *virtual_keyboard;
+    LayoutHolderPrivate *priv;
+    struct squeek_layout_state *layout; // Unowned
 };
 
-/**
- * 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 {
+struct _LayoutHolderClass {
     /*< 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
-                                              (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);
+GType         layout_holder_get_type(void) G_GNUC_CONST;
 
-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

examples/test_layout.rs

@@ -1,52 +1,10 @@
 extern crate rs;
-extern crate xkbcommon;
 
+use rs::tests::check_builtin_layout;
 use std::env;
 
-use rs::data::{ Layout, LoadError };
-
-use xkbcommon::xkb;
-
-
-fn check_layout(name: &str) {
-    let layout = Layout::from_resource(name)
-        .and_then(|layout| layout.build().map_err(LoadError::BadKeyMap))
-        .expect("layout broken");
-    
-    let context = xkb::Context::new(xkb::CONTEXT_NO_FLAGS);
-    
-    let keymap_str = layout.keymap_str
-        .clone()
-        .into_string().expect("Failed to decode keymap string");
-    
-    let keymap = xkb::Keymap::new_from_string(
-        &context,
-        keymap_str.clone(),
-        xkb::KEYMAP_FORMAT_TEXT_V1,
-        xkb::KEYMAP_COMPILE_NO_FLAGS,
-    ).expect("Failed to create keymap");
-
-    let state = xkb::State::new(&keymap);
-    
-    // "Press" each button with keysyms
-    for view in layout.views.values() {
-        for row in &view.rows {
-            for button in &row.buttons {
-                let keystate = button.state.borrow();
-                for keycode in &keystate.keycodes {
-                    match state.key_get_one_sym(*keycode) {
-                        xkb::KEY_NoSymbol => {
-                            eprintln!("{}", keymap_str);
-                            panic!("Keysym {} on key {:?} can't be resolved", keycode, button.name);
-                        },
-                        _ => {},
-                    }
-                }
-            }
-        }
-    }
-}
-
 fn main() -> () {
-    check_layout(env::args().nth(1).expect("No argument given").as_str());
+    check_builtin_layout(
+        env::args().nth(1).expect("No argument given").as_str()
+    );
 }

meson.build

@@ -1,7 +1,7 @@
 project(
     'squeekboard',
     'c', 'rust',
-    version: '1.3.1',
+    version: '1.8.0',
     license: 'GPLv3',
     meson_version: '>=0.51.0',
     default_options: [
@@ -33,8 +33,14 @@ endif
 if get_option('buildtype') != 'plain'
     add_project_arguments('-fstack-protector-strong', language: 'c')
 endif
+if get_option('buildtype') == 'release'
+    cargo_build_flags = ['--release'] # for artifacts
+else
+    cargo_build_flags = []
+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') == ''
@@ -54,11 +60,12 @@ summary = [
 ]
 message('\n'.join(summary))
 
-cargo = find_program('cargo')
+dep_cargo = find_program('cargo')
 cargo_script = find_program('cargo.sh')
+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
-type Level = String;
+/// Use to switch views
+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 {
-        lock: Level,
+    LockView {
+        lock: View,
         /// When unlocked by pressing it or emitting a key
-        unlock: Level,
+        unlock: View,
     },
-    /// Set this modifier TODO: release?
-    SetModifier(Modifier),
+    /// Hold this modifier for as long as the button is pressed
+    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/bin/test_layout.rs

@@ -0,0 +1,16 @@
+#[macro_use]
+extern crate clap;
+extern crate rs;
+
+use rs::tests::check_layout_file;
+
+fn main() -> () {
+    let matches = clap_app!(test_layout =>
+        (name: "squeekboard-test-layout")
+        (about: "Test keyboard layout for errors. Returns OK or an error message containing further information.")
+        (@arg INPUT: +required "Yaml keyboard layout file to test")
+    ).get_matches();
+    if check_layout_file(matches.value_of("INPUT").unwrap()) == () {
+        println!("Test result: OK");
+    }
+}

src/data.rs

@@ -1,5 +1,7 @@
 /**! The parsing of the data files for layouts */
 
+// TODO: find a nice way to make sure non-positive sizes don't break layouts
+
 use std::cell::RefCell;
 use std::collections::{ HashMap, HashSet };
 use std::env;
@@ -13,22 +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;
 
 /// Gathers stuff defined in C or called by C
 pub mod c {
@@ -154,18 +158,19 @@ fn list_layout_sources(
 fn load_layout_data(source: DataSource)
     -> Result<::layout::LayoutData, LoadError>
 {
+    let handler = logging::Print {};
     match source {
         DataSource::File(path) => {
             Layout::from_file(path.clone())
                 .map_err(LoadError::BadData)
                 .and_then(|layout|
-                    layout.build().map_err(LoadError::BadKeyMap)
+                    layout.build(handler).0.map_err(LoadError::BadKeyMap)
                 )
         },
         DataSource::Resource(name) => {
             Layout::from_resource(&name)
                 .and_then(|layout|
-                    layout.build().map_err(LoadError::BadKeyMap)
+                    layout.build(handler).0.map_err(LoadError::BadKeyMap)
                 )
         },
     }
@@ -186,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);
+            }
         }
     }
 
@@ -206,41 +216,53 @@ fn load_layout_data_with_fallback(
 #[derive(Debug, Deserialize, PartialEq)]
 #[serde(deny_unknown_fields)]
 pub struct Layout {
-    bounds: Bounds,
+    #[serde(default)]
+    margins: Margins,
     views: HashMap<String, Vec<ButtonIds>>,
     #[serde(default)] 
     buttons: HashMap<String, ButtonMeta>,
     outlines: HashMap<String, Outline>
 }
 
-#[derive(Debug, Clone, Deserialize, PartialEq)]
+#[derive(Debug, Clone, Deserialize, PartialEq, Default)]
 #[serde(deny_unknown_fields)]
-struct Bounds {
-    x: f64,
-    y: f64,
-    width: f64,
-    height: f64,
+struct Margins {
+    top: f64,
+    bottom: f64,
+    side: f64,
 }
 
 /// Buttons are embedded in a single string
 type ButtonIds = String;
 
+/// All info about a single button
+/// Buttons can have multiple instances though.
 #[derive(Debug, Default, Deserialize, PartialEq)]
 #[serde(deny_unknown_fields)]
 struct ButtonMeta {
-    /// Action other than keysym (conflicts with keysym)
+    // 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 outline. If not present, will be "default"
-    outline: Option<String>,
-    /// FIXME: start using it
+    /// The name of the XKB keysym to emit on activation.
+    /// Conflicts with action, text, modifier.
     keysym: Option<String>,
-    /// If not present, will be derived from the button ID
+    /// The text to submit on activation. Will be derived from ID if not present
+    /// 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
     icon: Option<String>,
+    /// The name of the outline. If not present, will be "default"
+    outline: Option<String>,
 }
 
-#[derive(Debug, Deserialize, PartialEq)]
+#[derive(Debug, Deserialize, PartialEq, Clone)]
 #[serde(deny_unknown_fields)]
 enum Action {
     #[serde(rename="locking")]
@@ -249,12 +271,30 @@ 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)]
 #[serde(deny_unknown_fields)]
 struct Outline {
-    bounds: Bounds,
+    width: f64,
+    height: f64,
 }
 
 /// Errors encountered loading the layout into yaml
@@ -288,6 +328,20 @@ impl From<io::Error> for Error {
     }
 }
 
+pub fn add_offsets<'a, I: 'a, T, F: 'a>(iterator: I, get_size: F)
+    -> impl Iterator<Item=(f64, T)> + 'a
+    where I: Iterator<Item=T>,
+        F: Fn(&T) -> f64,
+{
+    let mut offset = 0.0;
+    iterator.map(move |item| {
+        let size = get_size(&item);
+        let value = (offset, item);
+        offset += size;
+        value
+    })
+}
+
 impl Layout {
     pub fn from_resource(name: &str) -> Result<Layout, LoadError> {
         let data = resources::get_keyboard(name)
@@ -296,7 +350,7 @@ impl Layout {
                     .map_err(LoadError::BadResource)
     }
 
-    fn from_file(path: PathBuf) -> Result<Layout, Error> {
+    pub fn from_file(path: PathBuf) -> Result<Layout, Error> {
         let infile = BufReader::new(
             fs::OpenOptions::new()
                 .read(true)
@@ -305,8 +359,8 @@ impl Layout {
         serde_yaml::from_reader(infile).map_err(Error::Yaml)
     }
 
-    pub fn build(self)
-        -> Result<::layout::LayoutData, FormattingError>
+    pub fn build<H: logging::Handler>(self, mut warning_handler: H)
+        -> (Result<::layout::LayoutData, FormattingError>, H)
     {
         let button_names = self.views.values()
             .flat_map(|rows| {
@@ -323,7 +377,8 @@ impl Layout {
                 create_action(
                     &self.buttons,
                     name,
-                    self.views.keys().collect()
+                    self.views.keys().collect(),
+                    &mut warning_handler,
                 )
             )}).collect();
 
@@ -355,26 +410,31 @@ 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,
                 }
             )
         });
 
-        let button_states
-            = HashMap::<String, KeyState>::from_iter(
-                button_states
-            );
+        let button_states = HashMap::<String, KeyState>::from_iter(
+            button_states
+        );
 
         // TODO: generate from symbols
-        let keymap_str = generate_keymap(&button_states)?;
+        let keymap_str = match generate_keymap(&button_states) {
+            Err(e) => { return (Err(e), warning_handler) },
+            Ok(v) => v,
+        };
 
         let button_states_cache = hash_map_map(
             button_states,
@@ -384,146 +444,232 @@ impl Layout {
             )}
         );
 
-        let views = HashMap::from_iter(
-            self.views.iter().map(|(name, view)| {(
-                name.clone(),
-                Box::new(::layout::View {
-                    bounds: ::layout::c::Bounds {
-                        x: self.bounds.x,
-                        y: self.bounds.y,
-                        width: self.bounds.width,
-                        height: self.bounds.height,
-                    },
-                    rows: view.iter().map(|row| {
-                        Box::new(::layout::Row {
-                            angle: 0,
-                            bounds: None,
-                            buttons: row.split_ascii_whitespace().map(|name| {
-                                Box::new(create_button(
-                                    &self.buttons,
-                                    &self.outlines,
-                                    name,
-                                    button_states_cache.get(name.into())
-                                        .expect("Button state not created")
-                                        .clone()
-                                ))
-                            }).collect(),
-                        })
-                    }).collect(),
-                })
-            )})
-        );
+        let views: Vec<_> = self.views.iter()
+            .map(|(name, view)| {
+                let rows = view.iter().map(|row| {
+                    let buttons = row.split_ascii_whitespace()
+                        .map(|name| {
+                            Box::new(create_button(
+                                &self.buttons,
+                                &self.outlines,
+                                name,
+                                button_states_cache.get(name.into())
+                                    .expect("Button state not created")
+                                    .clone(),
+                                &mut warning_handler,
+                            ))
+                        });
+                    layout::Row {
+                        buttons: add_offsets(
+                            buttons,
+                            |button| button.size.width,
+                        ).collect()
+                    }
+                });
+                let rows = add_offsets(rows, |row| row.get_height())
+                    .collect();
+                (
+                    name.clone(),
+                    layout::View::new(rows)
+                )
+            }).collect();
 
-        Ok(::layout::LayoutData {
-            views: views,
-            keymap_str: {
-                CString::new(keymap_str)
-                    .expect("Invalid keymap string generated")
-            },
-        })
+        // 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,
+                keymap_str: {
+                    CString::new(keymap_str)
+                        .expect("Invalid keymap string generated")
+                },
+                // FIXME: use a dedicated field
+                margins: layout::Margins {
+                    top: self.margins.top,
+                    left: self.margins.side,
+                    bottom: self.margins.bottom,
+                    right: self.margins.side,
+                },
+            }),
+            warning_handler,
+        )
     }
 }
 
-fn create_action(
+fn create_action<H: logging::Handler>(
     button_info: &HashMap<String, ButtonMeta>,
     name: &str,
     view_names: Vec<&String>,
+    warning_handler: &mut H,
 ) -> ::action::Action {
     let default_meta = ButtonMeta::default();
     let symbol_meta = button_info.get(name)
         .unwrap_or(&default_meta);
-    
-    fn filter_view_name(
-        button_name: &str,
-        view_name: String,
-        view_names: &Vec<&String>
-    ) -> String {
-        if view_names.contains(&&view_name) {
-            view_name
-        } else {
-            eprintln!(
-                "Button {} switches to missing view {}",
-                button_name,
-                view_name
-            );
-            "base".into()
-        }
-    }
-    
+
     fn keysym_valid(name: &str) -> bool {
         xkb::keysym_from_name(name, xkb::KEYSYM_NO_FLAGS) != xkb::KEY_NoSymbol
     }
     
-    let keysyms = match &symbol_meta.action {
-        // Non-submit action
-        Some(_) => Vec::new(),
-        // Submit action
-        None => match &symbol_meta.keysym {
-            // Keysym given explicitly
-            Some(keysym) => vec!(match keysym_valid(keysym.as_str()) {
-                true => keysym.clone(),
-                false => {
-                    eprintln!("Keysym name invalid: {}", keysym);
-                    "space".into() // placeholder
-                },
-            }),
-            // Keysyms left open to derive
-            // TODO: when button name is meant diretly as xkb keysym name,
-            // mark it so, e.g. with a "#"
-            None => match keysym_valid(name) {
-                // Button name is actually a valid xkb name
-                true => vec!(String::from(name)),
-                // Button name is not a valid xkb name,
-                // so assume it's a literal string to be submitted
-                false => {
-                    if name.chars().count() == 0 {
-                        // A name read from yaml with no valid Unicode.
-                        // Highly improbable, but let's be safe.
-                        eprintln!("Key {} doesn't have any characters", name);
-                        vec!("space".into()) // placeholder
-                    } else {
-                        name.chars().map(|codepoint| {
-                            let codepoint_string = codepoint.to_string();
-                            match keysym_valid(codepoint_string.as_str()) {
-                                true => codepoint_string,
-                                false => format!("U{:04X}", codepoint as u32),
-                            }
-                        }).collect()
-                    }
-                },
-            },
-        },
+    enum SubmitData {
+        Action(Action),
+        Text(String),
+        Keysym(String),
+        Modifier(Modifier),
     };
     
-    match &symbol_meta.action {
-        Some(Action::SetView(view_name)) => ::action::Action::SetLevel(
-            filter_view_name(name, view_name.clone(), &view_names)
+    let submission = match (
+        &symbol_meta.action,
+        &symbol_meta.keysym,
+        &symbol_meta.text,
+        &symbol_meta.modifier,
+    ) {
+        (Some(action), None, None, None) => SubmitData::Action(action.clone()),
+        (None, Some(keysym), None, None) => SubmitData::Keysym(keysym.clone()),
+        (None, None, Some(text), None) => SubmitData::Text(text.clone()),
+        (None, None, None, Some(modifier)) => {
+            SubmitData::Modifier(modifier.clone())
+        },
+        (None, None, None, None) => SubmitData::Text(name.into()),
+        _ => {
+            warning_handler.handle(
+                logging::Level::Warning,
+                &format!(
+                    "Button {} has more than one of (action, keysym, text, modifier)",
+                    name,
+                ),
+            );
+            SubmitData::Text("".into())
+        },
+    };
+
+    fn filter_view_name<H: logging::Handler>(
+        button_name: &str,
+        view_name: String,
+        view_names: &Vec<&String>,
+        warning_handler: &mut H,
+    ) -> String {
+        if view_names.contains(&&view_name) {
+            view_name
+        } else {
+            warning_handler.handle(
+                logging::Level::Warning,
+                &format!("Button {} switches to missing view {}",
+                    button_name,
+                    view_name,
+                ),
+            );
+            "base".into()
+        }
+    }
+
+    match submission {
+        SubmitData::Action(
+            Action::SetView(view_name)
+        ) => ::action::Action::SetView(
+            filter_view_name(
+                name, view_name.clone(), &view_names,
+                warning_handler,
+            )
         ),
-        Some(Action::Locking {
+        SubmitData::Action(Action::Locking {
             lock_view, unlock_view
-        }) => ::action::Action::LockLevel {
-            lock: filter_view_name(name, lock_view.clone(), &view_names),
+        }) => ::action::Action::LockView {
+            lock: filter_view_name(
+                name,
+                lock_view.clone(),
+                &view_names,
+                warning_handler,
+            ),
             unlock: filter_view_name(
                 name,
                 unlock_view.clone(),
-                &view_names
+                &view_names,
+                warning_handler,
             ),
         },
-        Some(Action::ShowPrefs) => ::action::Action::ShowPreferences,
-        None => ::action::Action::Submit {
+        SubmitData::Action(
+            Action::ShowPrefs
+        ) => ::action::Action::ShowPreferences,
+        SubmitData::Action(Action::Erase) => action::Action::Erase,
+        SubmitData::Keysym(keysym) => ::action::Action::Submit {
             text: None,
-            keys: keysyms.into_iter().map(::action::KeySym).collect(),
+            keys: vec!(::action::KeySym(
+                match keysym_valid(keysym.as_str()) {
+                    true => keysym.clone(),
+                    false => {
+                        warning_handler.handle(
+                            logging::Level::Warning,
+                            &format!(
+                                "Keysym name invalid: {}",
+                                keysym,
+                            ),
+                        );
+                        "space".into() // placeholder
+                    },
+                }
+            )),
+        },
+        SubmitData::Text(text) => ::action::Action::Submit {
+            text: CString::new(text.clone()).or_warn(
+                warning_handler,
+                logging::Problem::Warning,
+                &format!("Text {} contains problems", text),
+            ),
+            keys: text.chars().map(|codepoint| {
+                let codepoint_string = codepoint.to_string();
+                ::action::KeySym(match keysym_valid(codepoint_string.as_str()) {
+                    true => codepoint_string,
+                    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(
+fn create_button<H: logging::Handler>(
     button_info: &HashMap<String, ButtonMeta>,
     outlines: &HashMap<String, Outline>,
     name: &str,
     state: Rc<RefCell<KeyState>>,
+    warning_handler: &mut H,
 ) -> ::layout::Button {
     let cname = CString::new(name.clone())
         .expect("Bad name");
@@ -539,6 +685,15 @@ fn create_button(
     } else if let Some(icon) = &button_meta.icon {
         ::layout::Label::IconName(CString::new(icon.as_str())
             .expect("Bad icon"))
+    } else if let Some(text) = &button_meta.text {
+        ::layout::Label::Text(
+            CString::new(text.as_str())
+                .or_warn(
+                    warning_handler,
+                    logging::Problem::Warning,
+                    &format!("Text {} is invalid", text),
+                ).unwrap_or_else(|| CString::new("").unwrap())
+        )
     } else {
         ::layout::Label::Text(cname.clone())
     };
@@ -548,7 +703,10 @@ fn create_button(
             if outlines.contains_key(outline) {
                 outline.clone()
             } else {
-                eprintln!("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()
             }
         }
@@ -557,22 +715,19 @@ fn create_button(
 
     let outline = outlines.get(&outline_name)
         .map(|outline| (*outline).clone())
-        .unwrap_or_else(|| {
-            eprintln!("No default outline defied Using 1x1!");
-            Outline {
-                bounds: Bounds { x: 0f64, y: 0f64, width: 1f64, height: 1f64 },
-            }
-        });
+        .or_warn(
+            warning_handler,
+            logging::Problem::Warning,
+            "No default outline defined! Using 1x1!",
+        ).unwrap_or(Outline { width: 1f64, height: 1f64 });
 
-    ::layout::Button {
+    layout::Button {
         name: cname,
         outline_name: CString::new(outline_name).expect("Bad outline"),
         // TODO: do layout before creating buttons
-        bounds: ::layout::c::Bounds {
-            x: outline.bounds.x,
-            y: outline.bounds.y,
-            width: outline.bounds.width,
-            height: outline.bounds.height,
+        size: layout::Size {
+            width: outline.width,
+            height: outline.height,
         },
         label: label,
         state: state,
@@ -584,13 +739,14 @@ mod tests {
     use super::*;
     
     use std::error::Error as ErrorTrait;
+    use ::logging::ProblemPanic;
 
     #[test]
     fn test_parse_path() {
         assert_eq!(
             Layout::from_file(PathBuf::from("tests/layout.yaml")).unwrap(),
             Layout {
-                bounds: Bounds { x: 0f64, y: 0f64, width: 0f64, height: 0f64 },
+                margins: Margins { top: 0f64, bottom: 0f64, side: 0f64 },
                 views: hashmap!(
                     "base".into() => vec!("test".into()),
                 ),
@@ -599,16 +755,14 @@ mod tests {
                         icon: None,
                         keysym: None,
                         action: None,
+                        text: None,
+                        modifier: None,
                         label: Some("test".into()),
                         outline: None,
                     }
                 },
                 outlines: hashmap!{
-                    "default".into() => Outline {
-                        bounds: Bounds {
-                            x: 0f64, y: 0f64, width: 0f64, height: 0f64
-                        }, 
-                    }
+                    "default".into() => Outline { width: 0f64, height: 0f64 }, 
                 },
             }
         );
@@ -656,12 +810,12 @@ mod tests {
     fn test_layout_punctuation() {
         let out = Layout::from_file(PathBuf::from("tests/layout_key1.yaml"))
             .unwrap()
-            .build()
+            .build(ProblemPanic).0
             .unwrap();
         assert_eq!(
-            out.views["base"]
-                .rows[0]
-                .buttons[0]
+            out.views["base"].1
+                .get_rows()[0].1
+                .buttons[0].1
                 .label,
             ::layout::Label::Text(CString::new("test").unwrap())
         );
@@ -671,12 +825,12 @@ mod tests {
     fn test_layout_unicode() {
         let out = Layout::from_file(PathBuf::from("tests/layout_key2.yaml"))
             .unwrap()
-            .build()
+            .build(ProblemPanic).0
             .unwrap();
         assert_eq!(
-            out.views["base"]
-                .rows[0]
-                .buttons[0]
+            out.views["base"].1
+                .get_rows()[0].1
+                .buttons[0].1
                 .label,
             ::layout::Label::Text(CString::new("test").unwrap())
         );
@@ -687,12 +841,12 @@ mod tests {
     fn test_layout_unicode_multi() {
         let out = Layout::from_file(PathBuf::from("tests/layout_key3.yaml"))
             .unwrap()
-            .build()
+            .build(ProblemPanic).0
             .unwrap();
         assert_eq!(
-            out.views["base"]
-                .rows[0]
-                .buttons[0]
+            out.views["base"].1
+                .get_rows()[0].1
+                .buttons[0].1
                 .state.borrow()
                 .keycodes.len(),
             2
@@ -702,7 +856,7 @@ mod tests {
     #[test]
     fn parsing_fallback() {
         assert!(Layout::from_resource(FALLBACK_LAYOUT_NAME)
-            .and_then(|layout| layout.build().map_err(LoadError::BadKeyMap))
+            .map(|layout| layout.build(ProblemPanic).0.unwrap())
             .is_ok()
         );
     }
@@ -742,17 +896,37 @@ mod tests {
                     ".".into() => ButtonMeta {
                         icon: None,
                         keysym: None,
+                        text: None,
                         action: None,
+                        modifier: None,
                         label: Some("test".into()),
                         outline: None,
                     }
                 },
                 ".",
-                Vec::new()
+                Vec::new(),
+                &mut ProblemPanic,
             ),
             ::action::Action::Submit {
-                text: None,
+                text: Some(CString::new(".").unwrap()),
                 keys: vec!(::action::KeySym("U002E".into())),
+            },
+        );
+    }
+
+    #[test]
+    fn test_layout_margins() {
+        let out = Layout::from_file(PathBuf::from("tests/layout_margins.yaml"))
+            .unwrap()
+            .build(ProblemPanic).0
+            .unwrap();
+        assert_eq!(
+            out.margins,
+            layout::Margins {
+                top: 1.0,
+                bottom: 3.0,
+                left: 2.0,
+                right: 2.0,
             }
         );
     }

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

@@ -0,0 +1,127 @@
+/*! Drawing the UI */
+
+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;
+
+mod c {
+    use super::*;
+
+    use cairo_sys;
+    use std::os::raw::c_void;
+    
+    // This is constructed only in C, no need for warnings
+    #[allow(dead_code)]
+    #[repr(transparent)]
+    #[derive(Clone, Copy)]
+    pub struct EekRenderer(*const c_void);
+
+    #[no_mangle]
+    extern "C" {
+        // Button and View inside CButtonPlace are safe to pass to C
+        // as long as they don't outlive the call
+        // and nothing dereferences them
+        #[allow(improper_ctypes)]
+        pub fn eek_render_button(
+            renderer: EekRenderer,
+            cr: *mut cairo_sys::cairo_t,
+            button: *const Button,
+            pressed: u64,
+            locked: u64,
+        );
+    }
+
+    /// 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();
+
+        layout.foreach_visible_button(|offset, button| {
+            let state = RefCell::borrow(&button.state).clone();
+            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,
+                    offset,
+                    button.as_ref(),
+                    state.pressed, locked,
+                );
+            }
+        })
+    }
+    
+    #[no_mangle]
+    pub extern "C"
+    fn squeek_draw_layout_base_view(
+        layout: *mut Layout,
+        renderer: EekRenderer,
+        cr: *mut cairo_sys::cairo_t,
+    ) {
+        let layout = unsafe { &mut *layout };
+        let cr = unsafe { cairo::Context::from_raw_none(cr) };
+        
+        layout.foreach_visible_button(|offset, button| {
+            render_button_at_position(
+                renderer, &cr,
+                offset,
+                button.as_ref(),
+                keyboard::PressType::Released, false,
+            );
+        })
+    }
+}
+
+/// Renders a button at a position (button's own bounds ignored)
+pub fn render_button_at_position(
+    renderer: c::EekRenderer,
+    cr: &cairo::Context,
+    position: Point,
+    button: &Button,
+    pressed: keyboard::PressType,
+    locked: bool,
+) {
+    cr.save();
+    cr.translate(position.x, position.y);
+    cr.rectangle(
+        0.0, 0.0,
+        button.size.width, button.size.height
+    );
+    cr.clip();
+    unsafe {
+        c::eek_render_button(
+            renderer,
+            cairo::Context::to_raw_none(&cr),
+            button as *const Button,
+            pressed as u64,
+            locked as u64,
+        )
+    };
+    cr.restore();
+}
+
+pub fn queue_redraw(keyboard: EekGtkKeyboard) {
+    let widget = unsafe { gtk::Widget::from_glib_none(keyboard.0) };
+    widget.queue_draw();
+}

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 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);
-    struct imservice *imservice = imservice_new(im, context);
+struct submission* get_submission(struct zwp_input_method_manager_v2 *immanager,
+                                  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);
+}
 
-    /* Add a listener, passing the imservice instance to make it available to
-       callbacks. */
+/// Un-inlined
+struct zwp_input_method_v2 *imservice_manager_get_input_method(struct zwp_input_method_manager_v2 *manager,
+                                   struct wl_seat *seat) {
+    return zwp_input_method_manager_v2_get_input_method(manager, seat);
+}
+
+/// Un-inlined to let Rust link to it
+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) {
-    eekboard_context_service_show_keyboard (context);
+void
+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) {
-    eekboard_context_service_hide_keyboard (context);
+void
+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,58 +1,55 @@
+/*! 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
 pub mod c {
     use super::*;
-    
+
     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);
-        fn eekboard_context_service_show_keyboard(imservice: *const UIManager);
-        fn eekboard_context_service_hide_keyboard(imservice: *const UIManager);
+        #[allow(improper_ctypes)] // IMService will never be dereferenced in C
+        pub fn imservice_connect_listeners(im: *mut InputMethod, imservice: *const IMService);
+        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(|| {
-                    eprintln!("Warning: received invalid hint flags");
-                    ContentHint::NONE
-                })
+                ContentHint::from_bits(hint)
+                    .or_print(
+                        logging::Problem::Warning,
+                        "Received invalid hint flags",
+                    )
+                    .unwrap_or(ContentHint::NONE)
             },
             content_purpose: {
-                ContentPurpose::try_from(purpose).unwrap_or_else(|_e| {
-                    eprintln!("Warning: Received invalid purpose value");
-                    ContentPurpose::Normal
-                })
+                ContentPurpose::try_from(purpose)
+                    .or_print(
+                        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,56 +126,68 @@ pub mod c {
         let imservice = check_imservice(imservice, im).unwrap();
         imservice.pending = IMProtocolState {
             text_change_cause: {
-                ChangeCause::try_from(cause).unwrap_or_else(|_e| {
-                    eprintln!("Warning: received invalid cause value");
-                    ChangeCause::InputMethod
-                })
+                ChangeCause::try_from(cause)
+                    .or_print(
+                        logging::Problem::Warning,
+                        "Received invalid cause value",
+                    )
+                    .unwrap_or(ChangeCause::InputMethod)
             },
             ..imservice.pending.clone()
         };
     }
     
     #[no_mangle]
-    pub unsafe extern "C"
-    fn imservice_handle_commit_state(imservice: *mut IMService,
+    pub extern "C"
+    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);
-                eekboard_context_service_set_hint_purpose(
-                    imservice.ui_manager,
-                    imservice.current.content_hint.bits(),
-                    imservice.current.content_purpose.clone() as u32);
+                if let Some(ui) = imservice.ui_manager {
+                    unsafe { server_context_service_show_keyboard(ui); }
+                }
+                unsafe {
+                    eekboard_context_service_set_hint_purpose(
+                        imservice.state_manager,
+                        imservice.current.content_hint.bits(),
+                        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,
-    // so no special error type is needed
-    type Error = ();
+    type Error = UnrecognizedValue;
     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,
-    // so no special error type is needed
-    type Error = ();
+    type Error = UnrecognizedValue;
     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.h

@@ -1,12 +0,0 @@
-#ifndef __KEYBOARD_H
-#define __KEYBOARD_H
-
-#include "inttypes.h"
-#include "stdbool.h"
-#include "virtual-keyboard-unstable-v1-client-protocol.h"
-
-struct squeek_key;
-
-uint32_t squeek_key_is_pressed(struct squeek_key *key);
-uint32_t squeek_key_is_locked(struct squeek_key *key);
-#endif

src/keyboard.rs

@@ -1,64 +1,105 @@
 /*! 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 };
-use ::util::CloneOwned;
 
-/// Gathers stuff defined in C or called by C
-pub mod c {
-    use super::*;
-    use ::util::c;
-
-    pub type CKeyState = c::Wrapped<KeyState>;
-
-    // The following defined in Rust. TODO: wrap naked pointers to Rust data inside RefCells to prevent multiple writers
-
-    #[no_mangle]
-    pub extern "C"
-    fn squeek_key_is_pressed(key: CKeyState) -> u32 {
-        //let key = unsafe { Rc::from_raw(key.0) };
-        return key.clone_owned().pressed as u32;
-    }
-
-    #[no_mangle]
-    pub extern "C"
-    fn squeek_key_is_locked(key: CKeyState) -> u32 {
-        return key.clone_owned().locked as u32;
-    }
-}
-
-#[derive(Debug, Clone, Copy)]
+#[derive(Debug, Clone, Copy, PartialEq)]
 pub enum PressType {
     Released = 0,
     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::Sumbit given a keymap
-    pub keycodes: Vec<u32>,
+    /// A cache of raw keycodes derived from Action::Submit given a keymap
+    pub keycodes: Vec<KeyCode>,
     /// Static description of what the key does when pressed or released
     pub action: Action,
 }
 
-/// Generates a mapping where each key gets a keycode, starting from 8
+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
+) -> impl Iterator<Item=&'a str> {
+    let mut v: Vec<&'a str> = iter.collect();
+    v.sort();
+    v.into_iter()
+}
+
+/// Generates a mapping where each key gets a keycode, starting from ~~8~~
+/// HACK: starting from 9, because 8 results in keycode 0,
+/// which the compositor likes to discard
 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(
-        key_names.into_iter()
+        // sort to remove a source of indeterminism in keycode assignment
+        sorted(key_names.into_iter().chain(special_keysyms))
             .map(|name| String::from(name))
-            .zip(8..)
+            .zip(9..)
     )
 }
 
@@ -83,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> {
@@ -98,17 +142,40 @@ pub fn generate_keymap(
     )?;
     
     for (name, state) in keystates.iter() {
-        if let Action::Submit { text: _, keys } = &state.action {
-            if let 0 = keys.len() { eprintln!("Key {} has no keysyms", name); };
-            for (named_keysym, keycode) in keys.iter().zip(&state.keycodes) {
+        match &state.action {
+            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,
+                        "
+        <{}> = {};",
+                        named_keysym.0,
+                        keycode,
+                    )?;
+                }
+            },
+            Action::Erase => {
+                let mut keycodes = state.keycodes.iter();
                 write!(
                     buf,
                     "
-        <{}> = {};",
-                    named_keysym.0,
-                    keycode,
+        <BackSpace> = {};",
+                    keycodes.next().expect("Erase key has no keycode"),
                 )?;
-            }
+                if let Some(_) = keycodes.next() {
+                    log_print!(
+                        logging::Level::Bug,
+                        "Erase key has multiple keycodes",
+                    );
+                }
+            },
+            _ => {},
         }
     }
     
@@ -120,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() {
@@ -178,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

@@ -5,34 +5,26 @@
 #include <glib.h>
 #include "eek/eek-element.h"
 #include "eek/eek-gtk-keyboard.h"
+#include "eek/eek-renderer.h"
 #include "eek/eek-types.h"
-#include "src/keyboard.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_button;
-struct squeek_row;
-struct squeek_view;
-struct squeek_layout;
-
-/// Represents the path to the button within a view
-struct button_place {
-    const struct squeek_row *row;
-    const struct squeek_button *button;
+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;
 };
 
-int32_t squeek_row_get_angle(const struct squeek_row*);
-
-EekBounds squeek_row_get_bounds(const struct squeek_row*);
-
-typedef void (*ButtonCallback) (struct squeek_button *button, gpointer user_data);
-void squeek_row_foreach(struct squeek_row*,
-                            ButtonCallback   callback,
-                            gpointer      user_data);
+struct squeek_layout;
 
 EekBounds squeek_button_get_bounds(const struct squeek_button*);
 const char *squeek_button_get_label(const struct squeek_button*);
@@ -40,40 +32,37 @@ const char *squeek_button_get_icon_name(const struct squeek_button*);
 const char *squeek_button_get_name(const struct squeek_button*);
 const char *squeek_button_get_outline_name(const struct squeek_button*);
 
-struct squeek_key *squeek_button_get_key(const struct squeek_button*);
-uint32_t *squeek_button_has_key(const struct squeek_button* button,
-                                const struct squeek_key *key);
 void squeek_button_print(const struct squeek_button* button);
 
-
-EekBounds squeek_view_get_bounds(const struct squeek_view*);
-
-typedef void (*RowCallback) (struct squeek_row *row, gpointer user_data);
-void squeek_view_foreach(struct squeek_view*,
-                            RowCallback   callback,
-                            gpointer      user_data);
-
-void
-squeek_layout_place_contents(struct squeek_layout*);
-struct squeek_view *squeek_layout_get_current_view(struct squeek_layout*);
+struct transformation squeek_layout_calculate_transformation(
+        const struct squeek_layout *layout,
+        double allocation_width, double allocation_size);
 
 struct squeek_layout *squeek_load_layout(const char *name, uint32_t type);
 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_depress(struct squeek_layout *layout, struct zwp_virtual_keyboard_v1 *virtual_keyboard,
+void squeek_layout_release_all_only(struct squeek_layout *layout,
+                                    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);
-void squeek_layout_draw_all_changed(struct squeek_layout *layout, EekGtkKeyboard *ui_keyboard);
+                        uint32_t timestamp, LayoutHolder *manager,
+                        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/lib.rs

@@ -1,5 +1,8 @@
 #[macro_use]
 extern crate bitflags;
+extern crate cairo;
+extern crate cairo_sys;
+extern crate gdk;
 extern crate gio;
 extern crate glib;
 extern crate glib_sys;
@@ -12,17 +15,26 @@ extern crate regex;
 extern crate serde;
 extern crate xkbcommon;
 
+#[macro_use]
+mod logging;
+
 mod action;
 pub mod data;
+mod drawing;
 pub mod float_ord;
 pub mod imservice;
 mod keyboard;
 mod layout;
 mod locale;
 mod locale_config;
+mod manager;
 mod outputs;
 mod popover;
 mod resources;
+mod style;
 mod submission;
-mod util;
+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'),
@@ -58,7 +56,7 @@ rslibs = custom_target(
     output: ['librs.a'],
     install: false,
     console: true,
-    command: [cargo_script, '@OUTPUT@', 'build']
+    command: [cargo_build] + cargo_build_flags + ['@OUTPUT@', '--lib']
 )
 
 build_rstests = custom_target(
@@ -72,14 +70,14 @@ build_rstests = custom_target(
     output: ['src'],
     install: false,
     console: true,
-    command: [cargo_script, '', 'test', '--no-run'],
+    command: [cargo_script, 'test', '--no-run'],
     depends: rslibs, # no point building tests if the code itself fails
 )
 
 test(
     'rstest',
     cargo_script,
-    args: ['', 'test'],
+    args: ['test'],
     # this is a whole Carg-based test suite, let it run for a while
     timeout: 900,
     depends: build_rstests,
@@ -97,20 +95,7 @@ libsqueekboard = static_library('libsqueekboard',
     '-DEEK_COMPILATION=1'],
 )
 
-# the straight binary needs to be demoted in favor of the wrapper script
-# due to styling being inconsistent
-bindir = join_paths(prefix, get_option('bindir'))
-wrapper_conf = configuration_data()
-wrapper_conf.set('bindir', bindir)
-configure_file(
-  input: '../tools/squeekboard.in',
-  output: 'squeekboard',
-  install_dir: bindir,
-  configuration: wrapper_conf,
-  install: true,
-)
-
-squeekboard = executable('squeekboard-real',
+squeekboard = executable('squeekboard',
   'server-main.c',
   wl_proto_sources,
   squeekboard_resources,
@@ -124,3 +109,4 @@ squeekboard = executable('squeekboard-real',
     '-DEEKBOARD_COMPILATION=1',
     '-DEEK_COMPILATION=1'],
 )
+

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(
-            || {
-                eprintln!(
-                    "Warning: received invalid wl_output.transform value"
-                );
-                Transform::Normal
-            }
-        );
+        let transform = Transform::from_u32(transform as u32)
+            .or_print(
+                logging::Problem::Warning,
+                "Received invalid wl_output.transform value",
+            ).unwrap_or(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) },
-            None => eprintln!("Wayland error: Got mode on unknown output"),
+            Some(state) => {
+                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(|| {
-            eprintln!("Warning: received invalid wl_output.mode flags");
-            Mode::NONE
-        });
+        let flags = Mode::from_bits(flags)
+            .or_print(
+                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,21 +203,35 @@ 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 mut collection = outputs.borrow_mut();
-        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"),
-        };
+        let outputs = outputs_raw.clone_ref();
+        {
+            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 => 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(
@@ -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()
-    }
-
-    #[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
-            },
+        OutputHandle {
+            wl_output: collection.outputs[0].output.clone(),
+            outputs: raw_collection.clone(),
         }
     }
+
     // 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,25 +2,34 @@
 
 use gio;
 use gtk;
-use ::layout::c::EekGtkKeyboard;
-use ::locale::compare_current_locale;
+use std::ffi::CString;
+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::ActionExt;
 use gio::ActionMapExt;
 use gio::SettingsExt;
+use gio::SimpleActionExt;
 use glib::translate::FromGlibPtrNone;
 use glib::variant::ToVariant;
 use gtk::PopoverExt;
 use gtk::WidgetExt;
 use std::io::Write;
+use ::logging::Warn;
 
 mod variants {
     use glib;
+    use glib::Variant;
     use glib_sys;
+    use std::os::raw::c_char;
 
+    use glib::ToVariant;
     use glib::translate::FromGlibPtrFull;
+    use glib::translate::FromGlibPtrNone;
     use glib::translate::ToGlibPtr;
 
     /// Unpacks tuple & array variants
@@ -49,9 +58,47 @@ mod variants {
             })
             .collect()
     }
+
+    /// "a(ss)" variant
+    /// Rust doesn't allow implementing existing traits for existing types
+    pub struct ArrayPairString(pub Vec<(String, String)>);
+    
+    impl ToVariant for ArrayPairString {
+        fn to_variant(&self) -> Variant {
+            let tspec = "a(ss)".to_glib_none();
+            let builder = unsafe {
+                let vtype = glib_sys::g_variant_type_checked_(tspec.0);
+                glib_sys::g_variant_builder_new(vtype)
+            };
+            let ispec = "(ss)".to_glib_none();
+            for (a, b) in &self.0 {
+                let a = a.to_glib_none();
+                let b = b.to_glib_none();
+                // string pointers are weak references
+                // and will get silently invalidated
+                // as soon as the source is out of scope
+                {
+                    let a: *const c_char = a.0;
+                    let b: *const c_char = b.0;
+                    unsafe {
+                        glib_sys::g_variant_builder_add(
+                            builder,
+                            ispec.0,
+                            a, b
+                        );
+                    }
+                }
+            }
+            unsafe {
+                let ret = glib_sys::g_variant_builder_end(builder);
+                glib_sys::g_variant_builder_unref(builder);
+                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,
@@ -60,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,
             "
@@ -69,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();
     }
@@ -85,60 +132,230 @@ fn make_menu_builder(inputs: Vec<(&str, &str)>) -> gtk::Builder {
     )
 }
 
-fn set_layout(kind: String, name: String) {
-    let settings = gio::Settings::new("org.gnome.desktop.input-sources");
-    let inputs = settings.get_value("sources").unwrap();
-    let inputs = variants::get_tuples(inputs).into_iter();
-    for (index, (ikind, iname)) in inputs.enumerate() {
-        if (&ikind, &iname) == (&kind, &name) {
-            settings.set_uint("current", index as u32);
-        }
-    }
-    settings.apply();
+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))
 }
 
-pub fn show(window: EekGtkKeyboard, position: ::layout::c::Bounds) {
-    unsafe { gtk::set_initialized() };
-    let window = unsafe { gtk::Widget::from_glib_none(window.0) };
+fn set_layout(kind: String, name: String) {
+    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()
+            .filter(|t| t != &current);
+        let inputs = vec![(kind, name)].into_iter()
+            .chain(inputs).collect();
+        settings.set_value(
+            "sources",
+            &variants::ArrayPairString(inputs).to_variant(),
+        );
+        settings.apply();
+    }
+}
 
-    let settings = gio::Settings::new("org.gnome.desktop.input-sources");
-    let inputs = settings.get_value("sources").unwrap();
-    let current = settings.get_uint("current") as usize;
-    let inputs = variants::get_tuples(inputs);
-    
-    let input_names: Vec<&str> = inputs.iter()
-        .map(|(_kind, name)| name.as_str())
-        .collect();
+/// A reference to what the user wants to see
+#[derive(PartialEq, Clone, Debug)]
+enum LayoutId {
+    /// Affects the layout in system settings
+    System {
+        kind: String,
+        name: String,
+    },
+    /// Only affects what this input method presents
+    Local(String),
+}
 
-    let translations = system_locale()
+impl LayoutId {
+    fn get_name(&self) -> &str {
+        match &self {
+            LayoutId::System { kind: _, name } => name.as_str(),
+            LayoutId::Local(name) => name.as_str(),
+        }
+    }
+}
+
+fn set_visible_layout(
+    manager: manager::c::Manager,
+    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,
+                )
+            }
+        },
+    }
+}
+
+/// 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| {
+            resources::get_layout_names(lang.as_str())
+                .or_print(
+                    logging::Problem::Surprise,
+                    &format!("No translations for locale {}", lang),
+                )
+        });
 
-    // sorted collection of human and machine names
-    let mut human_names: Vec<(&str, &str)> = match translations {
+    match builtin_translations {
         Some(translations) => {
-            input_names.iter()
-                .map(|name| (*name, *translations.get(name).unwrap_or(name)))
+            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()
         },
-        // display bare codes
         None => {
-            input_names.iter()
-                .map(|n| (*n, *n)) // turns &&str into &str
+            translated_names
+                .map(|status| match status {
+                    Status::Remaining(name) => OwnedTranslation(name),
+                    Status::Translated(t) => t,
+                })
                 .collect()
-        }
-    };
+        },
+    }
+}
 
-    human_names.sort_unstable_by(|(_, human_label_a), (_, human_label_b)| {
-        compare_current_locale(human_label_a, human_label_b)
+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)
     });
 
-    let builder = make_menu_builder(human_names);
+    // 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
@@ -152,39 +369,53 @@ pub fn show(window: EekGtkKeyboard, position: ::layout::c::Bounds) {
         height: position.width.floor() as i32,
     });
 
-    let initial_state = input_names[current].to_variant();
+    if let Some(current_layout) = get_current_layout(manager, &system_layouts) {
+        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(initial_state.type_()),
-        &initial_state,
-    );
+        let layout_action = gio::SimpleAction::new_stateful(
+            "layout",
+            Some(current_name_variant.type_()),
+            &current_name_variant,
+        );
 
-    let action_group = gio::SimpleActionGroup::new();
-    action_group.add_action(&layout_action);
+        let menu_inner = menu.clone();
+        layout_action.connect_change_state(move |_action, state| {
+            match state {
+                Some(v) => {
+                    v.get::<String>()
+                        .or_print(
+                            logging::Problem::Bug,
+                            &format!("Variant is not string: {:?}", v)
+                        )
+                        .map(|state| {
+                            let (_id, layout) = choices.iter()
+                                .find(
+                                    |choices| state == choices.0
+                                ).unwrap();
+                            set_visible_layout(
+                                manager,
+                                layout.clone(),
+                            )
+                        });
+                },
+                None => log_print!(
+                    logging::Level::Debug,
+                    "No variant selected",
+                ),
+            };
+            menu_inner.popdown();
+        });
+
+        let action_group = gio::SimpleActionGroup::new();
+        action_group.add_action(&layout_action);
+
+        menu.insert_action_group("popup", Some(&action_group));
+    };
 
-    menu.insert_action_group("popup", Some(&action_group));
     menu.bind_model(Some(&model), Some("popup"));
-
-    menu.connect_closed(move |_menu| {
-        let state = match layout_action.get_state() {
-            Some(v) => {
-                let s = v.get::<String>().or_else(|| {
-                    eprintln!("Variant is not string: {:?}", v);
-                    None
-                });
-                // FIXME: the `get_state` docs call for unrefing,
-                // but the function is nowhere to be found
-                // glib::Variant::unref(v);
-                s
-            },
-            None => {
-                eprintln!("No variant selected");
-                None
-            },
-        };
-        set_layout("xkb".into(), state.unwrap_or("us".into()));
-    });
-
     menu.popup();
 }

src/resources.rs

@@ -3,6 +3,7 @@
  */
 
 use std::collections::HashMap;
+use ::locale::Translation;
 
 use std::iter::FromIterator;
 
@@ -10,17 +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")),
-    ("el", include_str!("../data/keyboards/el.yaml")),
+    ("de_wide", include_str!("../data/keyboards/de_wide.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> {
@@ -37,16 +47,30 @@ 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")),
     ("en-US", include_str!("../data/langs/en-US.txt")),
     ("es-ES", include_str!("../data/langs/es-ES.txt")),
+    ("ja-JP", include_str!("../data/langs/ja-JP.txt")),
     ("pl-PL", include_str!("../data/langs/pl-PL.txt")),
 ];
 
 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)| {
@@ -60,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
@@ -68,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)
@@ -83,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_SIZE_CONSTRAINT_PORTRAIT,
+    PROP_VISIBLE,
     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));
-}
-
-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));
-    }
+    //eekboard_context_service_destroy (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);
-    int32_t width = squeek_outputs_get_perceptual_width(squeek_wayland->outputs, output);
-    uint32_t height = calculate_height(width);
+    struct squeek_output_handle output = squeek_outputs_get_current(squeek_wayland->outputs);
+    squeek_uiman_set_output(context->manager, output);
+    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;
     }
-
-    LevelKeyboard *keyboard = eekboard_context_service_get_keyboard (EEKBOARD_CONTEXT_SERVICE(context));
-
-    context->widget = eek_gtk_keyboard_new (keyboard);
+    context->widget = eek_gtk_keyboard_new (context->state, context->submission, context->layout);
 
     gtk_widget_set_has_tooltip (context->widget, TRUE);
     gtk_container_add (GTK_CONTAINER(context->window), context->widget);
-    gtk_widget_show (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));
+    gtk_widget_show_all(context->widget);
 }
 
 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)
-	context->hiding = g_timeout_add (200, (GSourceFunc) on_hide, context);
+    if (!context->window)
+        make_window (context);
+    if (!context->widget)
+        make_widget (context);
 
-    EEKBOARD_CONTEXT_SERVICE_CLASS (server_context_service_parent_class)->
-        hide_keyboard (_context);
+    context->visible = TRUE;
+    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:
-        variant = g_value_get_variant (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]);
+    case PROP_VISIBLE:
+        context->visible = g_value_get_boolean (value);
         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",
-                                  "Size constraint landscape",
-                                  G_VARIANT_TYPE("(dd)"),
-                                  NULL,
-                                  G_PARAM_WRITABLE);
+    /**
+     * 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_SIZE_CONSTRAINT_LANDSCAPE,
-                                     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,
+                                     PROP_VISIBLE,
                                      pspec);
 }
 
 static void
-server_context_service_init (ServerContextService *context)
-{
-    g_signal_connect (context,
-                      "notify::keyboard",
-                      G_CALLBACK(on_notify_keyboard),
-                      context);
+server_context_service_init (ServerContextService *state) {
+    (void)state;
 }
 
-EekboardContextService *
-server_context_service_new ()
+ServerContextService *
+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));
-}
-
-enum squeek_arrangement_kind server_context_service_get_layout_type(EekboardContextService *service)
-{
-    return SERVER_CONTEXT_SERVICE(service)->last_type;
+    ServerContextService *ui = g_object_new (SERVER_TYPE_CONTEXT_SERVICE, NULL);
+    ui->submission = submission;
+    ui->state = state;
+    ui->layout = layout;
+    ui->manager = uiman;
+    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 ();
-enum squeek_arrangement_kind server_context_service_get_layout_type(EekboardContextService*);
+GType         server_context_service_get_type
+                                              (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;
-    EekboardContextService *context;
-    struct imservice *imservice;
+    struct squeek_wayland wayland; // Just hooks.
+    DBusHandler *dbus_handler; // Controls visibility of the OSK.
+    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,51 +253,69 @@ main (int argc, char **argv)
         g_assert_not_reached ();
         break;
     }
+    guint owner_id = 0;
+    DBusHandler *service = NULL;
+    if (connection) {
+        service = dbus_handler_new(connection, DBUS_SERVICE_PATH);
 
-    EekboardService *service = eekboard_service_new (connection, EEKBOARD_SERVICE_PATH);
-
-    if (service == NULL) {
-        g_printerr ("Can't create dbus server\n");
-        exit (1);
-    } else {
-        eekboard_service_set_context(service, instance.context);
-    }
-
-    guint owner_id = g_bus_own_name_on_connection (connection,
-                                             EEKBOARD_SERVICE_INTERFACE,
-                                             G_BUS_NAME_OWNER_FLAGS_NONE,
-                                             on_name_acquired,
-                                             on_name_lost,
-                                             NULL,
-                                             NULL);
-    if (owner_id == 0) {
-        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");
+        if (service == NULL) {
+            g_printerr ("Can't create dbus server\n");
+            exit (1);
         }
+        instance.dbus_handler = service;
+
+        owner_id = g_bus_own_name_on_connection (connection,
+                                                 DBUS_SERVICE_INTERFACE,
+                                                 G_BUS_NAME_OWNER_FLAGS_NONE,
+                                                 on_name_acquired,
+                                                 on_name_lost,
+                                                 NULL,
+                                                 NULL);
+        if (owner_id == 0) {
+            g_printerr ("Can't own the name\n");
+            exit (1);
+        }
+    }
+
+    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);
 
-    g_bus_unown_name (owner_id);
-    g_object_unref (service);
-    g_object_unref (connection);
+    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.h

@@ -0,0 +1,7 @@
+#ifndef __STYLE_H
+#define __STYLE_H
+#include "gtk/gtk.h"
+
+GtkCssProvider *squeek_load_style();
+
+#endif

src/style.rs

@@ -0,0 +1,129 @@
+/* 
+ * Copyright (C) 2000 Red Hat, Inc.
+ * Copyright (C) 2019 Purism, SPC
+ *
+ * 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, see <http://www.gnu.org/licenses/>.Free
+ */
+
+/*! CSS data loading. */
+
+use std::env;
+use ::logging;
+
+use glib::object::ObjectExt;
+use logging::Warn;
+
+/// Gathers stuff defined in C or called by C
+pub mod c {
+    use super::*;
+    use gio;
+    use gtk;
+    use gtk_sys;
+    
+    use gtk::CssProviderExt;
+    use glib::translate::ToGlibPtr;
+
+    /// Loads the layout style based on current theme
+    /// without having to worry about string allocation
+    #[no_mangle]
+    pub extern "C"
+    fn squeek_load_style() -> *const gtk_sys::GtkCssProvider {
+        unsafe { gtk::set_initialized() };
+        let theme = gtk::Settings::get_default()
+            .map(|settings| get_theme_name(&settings));
+        
+        let css_name = path_from_theme(theme);
+
+        let resource_name = if gio::resources_get_info(
+            &css_name,
+            gio::ResourceLookupFlags::NONE
+        ).is_ok() {
+            css_name
+        } else { // use default if this path doesn't exist
+            path_from_theme(None)
+        };
+
+        let provider = gtk::CssProvider::new();
+        provider.load_from_resource(&resource_name);
+        provider.to_glib_full()
+    }
+}
+
+// not Adwaita, but rather fall back to default
+const DEFAULT_THEME_NAME: &str = "";
+
+struct GtkTheme {
+    name: String,
+    variant: Option<String>,
+}
+
+/// Gets theme as determined by the toolkit
+/// Ported from GTK's gtksettings.c
+fn get_theme_name(settings: &gtk::Settings) -> GtkTheme {
+    let env_theme = env::var("GTK_THEME")
+        .map(|theme| {
+            let mut parts = theme.splitn(2, ":");
+            GtkTheme {
+                // guaranteed at least empty string
+                // as the first result from splitting a string
+                name: parts.next().unwrap().into(),
+                variant: parts.next().map(String::from)
+            }
+        })
+        .map_err(|e| {
+            match &e {
+                env::VarError::NotPresent => {},
+                // maybe TODO: forward this warning?
+                e => log_print!(
+                    logging::Level::Surprise,
+                    "GTK_THEME variable invalid: {}", e,
+                ),
+            };
+            e
+        }).ok();
+
+    match env_theme {
+        Some(theme) => theme,
+        None => GtkTheme {
+            name: {
+                settings.get_property("gtk-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")
+                    .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()),
+                        false => None,
+                    })
+            },
+        },
+    }
+}
+
+fn path_from_theme(theme: Option<GtkTheme>) -> String {
+    format!(
+        "/sm/puri/squeekboard/style{}.css",
+        match theme {
+            Some(GtkTheme { name, variant: Some(variant) }) => {
+                format!("-{}:{}", name, variant)
+            },
+            Some(GtkTheme { name, variant: None }) => format!("-{}", name),
+            None => "".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 ZwpVirtualKeyboardV1(*const c_void);
+    pub struct UIManager(*const c_void);
+
+    /// EekboardContextService*
+    #[repr(transparent)]
+    pub struct StateManager(*const c_void);
 
     #[no_mangle]
-    extern "C" {
-        /// Checks if point falls within bounds,
-        /// which are relative to origin and rotated by angle (I think)
-        pub fn eek_virtual_keyboard_v1_key(
-            virtual_keyboard: ZwpVirtualKeyboardV1,
-            timestamp: u32,
-            keycode: u32,
-            press: u32,
-        );
+    pub extern "C"
+    fn submission_new(
+        im: *mut InputMethod,
+        vk: ZwpVirtualKeyboardV1,
+        state_manager: *const StateManager
+    ) -> *mut Submission {
+        let imservice = if im.is_null() {
+            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
-pub struct VirtualKeyboard(pub c::ZwpVirtualKeyboardV1);
+enum SubmittedAction {
+    /// A collection of keycodes that were pressed
+    VirtualKeyboard(Vec<KeyCode>),
+    IMService,
+}
 
-impl VirtualKeyboard {
-    // TODO: split out keyboard state management
-    pub fn switch(
-        &self,
-        key: &mut KeyState,
-        action: PressType,
-        timestamp: Timestamp,
+pub struct Submission {
+    imservice: Option<Box<IMService>>,
+    virtual_keyboard: VirtualKeyboard,
+    modifiers_active: Vec<(KeyStateId, Modifier)>,
+    pressed: Vec<(KeyStateId, SubmittedAction)>,
+}
+
+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();
-        for keycode in key.keycodes.iter() {
-            let keycode = keycode - 8;
-            match (&key.pressed, 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
-                    );
+        let was_committed_as_text = match (&mut self.imservice, mods_are_on) {
+            (Some(imservice), false) => {
+                enum Outcome {
+                    Submitted(Result<(), imservice::SubmitError>),
+                    NotSubmitted,
+                };
+
+                let submit_outcome = match data {
+                    SubmitData::Text(text) => {
+                        Outcome::Submitted(imservice.commit_string(text))
+                    },
+                    SubmitData::Erase => {
+                        /* Delete_surrounding_text takes byte offsets,
+                         * so cannot work without get_surrounding_text.
+                         * This is a bug in the protocol.
+                         */
+                        // imservice.delete_surrounding_text(1, 0),
+                        Outcome::NotSubmitted
+                    },
+                    SubmitData::Keycodes => Outcome::NotSubmitted,
+                };
+
+                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,
+                    )
                 },
-                // 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 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

@@ -0,0 +1,83 @@
+/*! Testing functionality */
+
+use ::data::Layout;
+use ::logging;
+use xkbcommon::xkb;
+
+
+pub struct CountAndPrint(u32);
+
+impl logging::Handler for CountAndPrint {
+    fn handle(&mut self, level: logging::Level, warning: &str) {
+        use logging::Level::*;
+        match level {
+            Panic | Bug | Error | Warning | Surprise => {
+                self.0 += 1;
+            },
+            _ => {}
+        }
+        logging::Print{}.handle(level, warning)
+    }
+}
+
+impl CountAndPrint {
+    fn new() -> CountAndPrint {
+        CountAndPrint(0)
+    }
+}
+
+pub fn check_builtin_layout(name: &str) {
+    check_layout(Layout::from_resource(name).expect("Invalid layout data"))
+}
+
+pub fn check_layout_file(path: &str) {
+    check_layout(Layout::from_file(path.into()).expect("Invalid layout file"))
+}
+
+fn check_layout(layout: Layout) {
+    let handler = CountAndPrint::new();
+    let (layout, handler) = layout.build(handler);
+
+    if handler.0 > 0 {
+        println!("{} problems while parsing layout", handler.0)
+    }
+
+    let layout = layout.expect("layout broken");
+
+    let context = xkb::Context::new(xkb::CONTEXT_NO_FLAGS);
+    
+    let keymap_str = layout.keymap_str
+        .clone()
+        .into_string().expect("Failed to decode keymap string");
+    
+    let keymap = xkb::Keymap::new_from_string(
+        &context,
+        keymap_str.clone(),
+        xkb::KEYMAP_FORMAT_TEXT_V1,
+        xkb::KEYMAP_COMPILE_NO_FLAGS,
+    ).expect("Failed to create keymap");
+
+    let state = xkb::State::new(&keymap);
+    
+    // "Press" each button with keysyms
+    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();
+                for keycode in &keystate.keycodes {
+                    match state.key_get_one_sym(*keycode) {
+                        xkb::KEY_NoSymbol => {
+                            eprintln!("{}", keymap_str);
+                            panic!("Keysym {} on key {:?} can't be resolved", keycode, button.name);
+                        },
+                        _ => {},
+                    }
+                }
+            }
+        }
+    }
+
+    if handler.0 > 0 {
+        panic!("Layout contains mistakes");
+    }
+}

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

@@ -2,6 +2,8 @@
 use std::collections::HashMap;
 use std::rc::Rc;
 
+use ::float_ord::FloatOrd;
+
 use std::borrow::Borrow;
 use std::hash::{ Hash, Hasher };
 use std::iter::FromIterator;
@@ -19,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)
@@ -91,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) };
@@ -103,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> {
@@ -127,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;
@@ -142,6 +152,16 @@ pub fn hash_map_map<K, V, F, K1, V1>(map: HashMap<K, V>, mut f: F)
     )
 }
 
+pub fn find_max_double<T, I, F>(iterator: I, get: F)
+    -> f64
+    where I: Iterator<Item=T>,
+        F: Fn(&T) -> f64
+{
+    iterator.map(|value| FloatOrd(get(&value)))
+        .max().unwrap_or(FloatOrd(0f64))
+        .0
+}
+
 /// Compares pointers but not internal values of Rc
 pub struct Pointer<T>(pub Rc<T>);
 
@@ -177,6 +197,17 @@ impl<T> Borrow<Rc<T>> for Pointer<T> {
     }
 }
 
+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::*;