Release 1.16.0 "Clostridium botulinum"

This release contains fixes that make the project's dependencies more reliable, and therefore less likely to blow up when the world changes.

Apart from that, there are a lot of extra translations:
- Brazilian Portugese (Rafael Fontenelle)
- Ukrainian (Yuri Chornoivan)
- Swedish (Luna Jernberg)
- Friulian (Fabio Tomat)
- Romanian (Daniel Șerbănescu)
- Slovenian (Matej Urbančič)
- Dutch (Nathan Follens)
- Finnish (Jiri Grönroos)
- Persian (Danial Behzadi)
- Catalan (Jordi Mas i Hernandez)

.gitignore

@@ -1,5 +1,6 @@
-.zanata-cache/
 _build
+po/squeekboard.pot
+po/*.mo
 TAGS
 tags
 vgdump

.gitlab-ci.yml

@@ -1,34 +1,27 @@
-image: debian:bullseye
+image: pureos/byzantium
 
 stages:
   - build
   - test
 
-.tags: &tags
-  tags:
-    - librem5
-
 before_script:
   - apt-get -y update
-  - apt-get -y install wget ca-certificates gnupg
+  - apt-get -y install ca-certificates
-  - echo "deb [trusted=yes] http://ci.puri.sm/ bullseyeci main" > /etc/apt/sources.list.d/ci.list
-  - wget -O- https://ci.puri.sm/ci-repo.key | apt-key add -
-  - apt-get -y update
 
 build_docs:
-  <<: *tags
   stage: build
   artifacts:
     paths:
       - _build
   script:
-      - apt-get -y install python3-pip python3-sphinx
+    - apt-get -y install python3-pip python3-sphinx
-      - pip3 install recommonmark
+    - pip3 install recommonmark
-      - ./doc/build.sh _build
+    - ./doc/build.sh _build
+  except:
+    variables:
+      - $PKG_ONLY == "1"
 
 build_meson:
-  tags:
-    - librem5
   stage: build
   artifacts:
     paths:
@@ -38,115 +31,92 @@ build_meson:
     - apt-get -y build-dep .
     - meson . _build/ -Ddepdatadir=/usr/share --werror
     - ninja -C _build install
+  except:
+    variables:
+      - $PKG_ONLY == "1"
 
 build_deb:
-    tags:
+  stage: build
-        - librem5
+  artifacts:
-    stage: build
+    paths:
-    artifacts:
+      - '*.deb'
-      paths:
+  script:
-        - "*.deb"
+    - rm -f ../*.deb
-    script:
+    - apt-get -y build-dep .
-        - rm -f ../*.deb
+    - apt-get -y install devscripts
-        - apt-get -y build-dep .
+    - REV=$(git log -1 --format=%h)
-        - apt-get -y install devscripts
+    - VER=$(dpkg-parsechangelog -SVersion)
-        - debuild -i -us -uc -b
+    - DEBFULLNAME="Librem5 CI"
-        - cp ../*.deb .
+    - EMAIL="librem5-builds@lists.community.puri.sm"
-
+    - dch -v"$VER+librem5ci$CI_PIPELINE_ID.$REV" "$MSG"
-build_deb:amber:
+    - debuild -i -us -uc -b
-    image: pureos/amber
+    - cp ../*.deb .
-    tags:
-        - librem5
-    stage: build
-    artifacts:
-      paths:
-        - "*.deb"
-    script:
-        - echo "deb http://ci.puri.sm/ scratch librem5" > /etc/apt/sources.list.d/ci.list
-        - apt-get -y update
-        - rm -f ../*.deb
-        - apt-get -y build-dep .
-        - apt-get -y install devscripts
-        - debuild -i -us -uc -b
-        - cp ../*.deb .
-
-build_deb:buster:
-    image: "debian:buster"
-    tags:
-        - librem5
-    stage: build
-    artifacts:
-      paths:
-        - "*.deb"
-    script:
-        - echo "deb http://ci.puri.sm/ scratch librem5" > /etc/apt/sources.list.d/ci.list
-        - apt-get -y update
-        - rm -f ../*.deb
-        - apt-get -y build-dep .
-        - apt-get -y install devscripts
-        - debuild -i -us -uc -b
-        - cp ../*.deb .
-
 
 build_deb:arm64:
-    tags:
+  image: pureos/byzantium
-        - librem5:arm64
+  tags:
-    stage: build
+    - aarch64
-    artifacts:
+  stage: build
-      paths:
+  artifacts:
-        - "*.deb"
+    paths:
-    script:
+      - '*.deb'
-        - rm -f ../*.deb
+  script:
-        - apt-get -y build-dep .
+    - rm -f ../*.deb
-        - apt-get -y install devscripts
+    - apt-get -y build-dep .
-        - debuild -i -us -uc -b
+    - apt-get -y install devscripts
-        - cp ../*.deb .
+    - REV=$(git log -1 --format=%h)
-
+    - VER=$(dpkg-parsechangelog -SVersion)
-build_deb:arm64_buster:
+    - DEBFULLNAME="Librem5 CI"
-    image: "debian:buster"
+    - EMAIL="librem5-builds@lists.community.puri.sm"
-    tags:
+    - dch -v"$VER+librem5ci$CI_PIPELINE_ID.$REV" "$MSG"
-        - librem5:arm64
+    - debuild -i -us -uc -b
-    stage: build
+    - cp ../*.deb .
-    artifacts:
-      paths:
-        - "*.deb"
-    script:
-        - echo "deb http://ci.puri.sm/ scratch librem5" > /etc/apt/sources.list.d/ci.list
-        - apt-get -y update
-        - rm -f ../*.deb
-        - apt-get -y build-dep .
-        - apt-get -y install devscripts
-        - debuild -i -us -uc -b
-        - cp ../*.deb .
 
 test_lintian:
-    <<: *tags
-    stage: test
-    dependencies:
-        - build_deb
-    script:
-        - apt-get -y install lintian
-        - lintian *.deb
-
-test:
-  tags:
-    - librem5
   stage: test
   needs:
-    - build_meson
+    - job: build_deb
+      artifacts: true
+  script:
+    - apt-get -y install lintian
+    - lintian *.deb
+  except:
+    variables:
+      - $PKG_ONLY == "1"
+
+test:
+  stage: test
+  needs:
+    - job: build_meson
+      artifacts: true
   script:
     - apt-get -y build-dep .
     - apt-get -y install clang-tidy
     - ninja -C _build test
-    - cd _build
+    - tools/style-check_build _build
-    - clang-tidy --checks=-clang-diagnostic-missing-braces,readability-braces-around-statements, --warnings-as-errors=readability-braces-around-statements -extra-arg=-Wno-unknown-warning-option ../src/*.c ../eek/*.c ../eekboard/*.c
+  except:
+    variables:
+      - $PKG_ONLY == "1"
+
+test_style:
+  stage: test
+  needs: []
+  script:
+    - apt-get -y build-dep .
+    - tools/style-check_source
+  except:
+    variables:
+      - $PKG_ONLY == "1"
 
 check_release:
-  <<: *tags
   stage: test
+  needs: []
   only:
     refs:
       - master
   script:
     - apt-get -y install git python3
     - (head -n 1 ./debian/changelog && git tag) | ./debian/check_release.py
+  except:
+    variables:
+      - $PKG_ONLY == "1"

Cargo.deps

@@ -1,7 +1,6 @@
 # Dependencies which change based on build flags
 bitflags = "1.2.*"
 clap = { version = "2.33.*", default-features = false }
-regex = { version = "1.3.*", default-features = false, features = ["std", "unicode-case"] }
 
 [dependencies.cairo-rs]
 version = "0.7.*"

Cargo.deps.legacy

@@ -1,7 +1,6 @@
 # Dependencies which change based on build flags
 bitflags = "1.0.*"
 clap = { version = "2.32.*", default-features = false }
-regex = { version = "1.1.*", default-features = false, features = ['use_std'] }
 
 [dependencies.cairo-rs]
 version = "0.5.*"

Cargo.lock

@@ -1,5 +1,7 @@
 # This file is automatically @generated by Cargo.
 # It is not intended for manual editing.
+version = 3
+
 [[package]]
 name = "atk"
 version = "0.7.0"
@@ -26,6 +28,12 @@ dependencies = [
  "pkg-config",
 ]
 
+[[package]]
+name = "autocfg"
+version = "1.0.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "cdb031dd78e28731d87d56cc8ffef4a8f36ca26c38fe2de700543e627f8a464a"
+
 [[package]]
 name = "bitflags"
 version = "1.2.1"
@@ -59,27 +67,21 @@ dependencies = [
 
 [[package]]
 name = "cc"
-version = "1.0.65"
+version = "1.0.72"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "95752358c8f7552394baf48cd82695b345628ad3f170d607de3ca03b8dacca15"
+checksum = "22a9137b95ea06864e018375b72adfb7db6e6f68cfc8df5a04d00288050485ee"
 
 [[package]]
 name = "clap"
-version = "2.33.3"
+version = "2.33.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "37e58ac78573c40708d45522f0d80fa2f01cc4f9b4e2bf749807255454312002"
+checksum = "826bf7bc84f9435630275cb8e802a4a0ec792b615969934bd16d42ffed10f207"
 dependencies = [
  "bitflags",
  "textwrap",
  "unicode-width",
 ]
 
-[[package]]
-name = "dtoa"
-version = "0.4.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "134951f4028bdadb9b84baf4232681efbf277da25144b9b0ad65df75946c422b"
-
 [[package]]
 name = "fragile"
 version = "0.3.0"
@@ -257,6 +259,22 @@ dependencies = [
  "pkg-config",
 ]
 
+[[package]]
+name = "hashbrown"
+version = "0.11.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ab5ef0d4909ef3724cc8cce6ccc8572c5c817592e9285f5464f8e86f8bd3726e"
+
+[[package]]
+name = "indexmap"
+version = "1.8.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "282a6247722caba404c065016bbfa522806e51714c34f5dfc3e4a3a46fcb4223"
+dependencies = [
+ "autocfg",
+ "hashbrown",
+]
+
 [[package]]
 name = "lazy_static"
 version = "1.4.0"
@@ -265,15 +283,15 @@ checksum = "e2abad23fbc42b3700f2f279844dc832adb2b2eb069b2df918f455c4e18cc646"
 
 [[package]]
 name = "libc"
-version = "0.2.80"
+version = "0.2.113"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4d58d1b70b004888f764dfbf6a26a3b0342a1632d33968e4a179d8011c760614"
+checksum = "eef78b64d87775463c549fbd80e19249ef436ea3bf1de2a1eb7e717ec7fab1e9"
 
 [[package]]
 name = "linked-hash-map"
-version = "0.5.3"
+version = "0.5.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8dd5a6d5999d9907cda8ed67bbd137d3af8085216c2ac62de5be860bd41f304a"
+checksum = "7fb9b38af92608140b86b693604b9ffcc5824240a484d1ecd4795bacb2fe88f3"
 
 [[package]]
 name = "maplit"
@@ -320,43 +338,28 @@ dependencies = [
 
 [[package]]
 name = "pkg-config"
-version = "0.3.19"
+version = "0.3.24"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3831453b3449ceb48b6d9c7ad7c96d5ea673e9b470a1dc578c2ce6521230884c"
+checksum = "58893f751c9b0412871a09abd62ecd2a00298c6c83befa223ef98c52aef40cbe"
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.24"
+version = "1.0.36"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1e0704ee1a7e00d7bb417d0770ea303c1bccbabf0ef1667dae92b5967f5f8a71"
+checksum = "c7342d5883fbccae1cc37a2353b09c87c9b0f3afd73f5fb9bba687a1f733b029"
 dependencies = [
  "unicode-xid",
 ]
 
 [[package]]
 name = "quote"
-version = "1.0.7"
+version = "1.0.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "aa563d17ecb180e500da1cfd2b028310ac758de548efdd203e18f283af693f37"
+checksum = "864d3e96a899863136fc6e99f3d7cae289dafe43bf2c5ac19b70df7210c0a145"
 dependencies = [
  "proc-macro2",
 ]
 
-[[package]]
-name = "regex"
-version = "1.3.9"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9c3780fcf44b193bc4d09f36d2a3c87b251da4a046c87795a0d35f4f927ad8e6"
-dependencies = [
- "regex-syntax",
-]
-
-[[package]]
-name = "regex-syntax"
-version = "0.6.21"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3b181ba2dcf07aaccad5448e8ead58db5b742cf85dfe035e2227f137a539a189"
-
 [[package]]
 name = "rs"
 version = "0.1.0"
@@ -372,26 +375,31 @@ dependencies = [
  "gtk",
  "gtk-sys",
  "maplit",
- "regex",
  "serde",
  "serde_yaml",
  "xkbcommon",
 ]
 
 [[package]]
-name = "serde"
+name = "ryu"
-version = "1.0.117"
+version = "1.0.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b88fa983de7720629c9387e9f517353ed404164b1e482c970a90c1a4aaf7dc1a"
+checksum = "73b4b750c782965c211b42f022f59af1fbceabdd026623714f104152f1ec149f"
+
+[[package]]
+name = "serde"
+version = "1.0.135"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2cf9235533494ea2ddcdb794665461814781c53f19d87b76e571a1c35acbad2b"
 dependencies = [
  "serde_derive",
 ]
 
 [[package]]
 name = "serde_derive"
-version = "1.0.117"
+version = "1.0.135"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cbd1ae72adb44aab48f325a02444a5fc079349a8d804c1fc922aed3f7454c74e"
+checksum = "8dcde03d87d4c973c04be249e7d8f0b35db1c848c487bd43032808e59dd8328d"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -400,21 +408,21 @@ dependencies = [
 
 [[package]]
 name = "serde_yaml"
-version = "0.8.14"
+version = "0.8.23"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f7baae0a99f1a324984bcdc5f0718384c1f69775f1c7eec8b859b71b443e3fd7"
+checksum = "a4a521f2940385c165a24ee286aa8599633d162077a54bdcae2a6fd5a7bfa7a0"
 dependencies = [
- "dtoa",
+ "indexmap",
- "linked-hash-map",
+ "ryu",
  "serde",
  "yaml-rust",
 ]
 
 [[package]]
 name = "syn"
-version = "1.0.48"
+version = "1.0.86"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cc371affeffc477f42a221a1e4297aedcea33d47d19b61455588bd9d8f6b19ac"
+checksum = "8a65b3f4ffa0092e9887669db0eae07941f023991ab58ea44da8fe8e2d511c6b"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -432,15 +440,15 @@ dependencies = [
 
 [[package]]
 name = "unicode-width"
-version = "0.1.8"
+version = "0.1.9"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9337591893a19b88d8d87f2cec1e73fad5cdfd10e5a6f349f498ad6ea2ffb1e3"
+checksum = "3ed742d4ea2bd1176e236172c8429aaf54486e7ac098db29ffe6529e0ce50973"
 
 [[package]]
 name = "unicode-xid"
-version = "0.2.1"
+version = "0.2.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f7fe0bb3479651439c9112f72b6c505038574c9fbb575ed1bf3b797fa39dd564"
+checksum = "8ccb82d61f80a663efe1f787a51b16b5a51e3314d6ac365b08639f52387b33f3"
 
 [[package]]
 name = "winapi"
@@ -476,9 +484,9 @@ dependencies = [
 
 [[package]]
 name = "yaml-rust"
-version = "0.4.4"
+version = "0.4.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "39f0c922f1a334134dc2f7a8b67dc5d25f0735263feec974345ff706bcf20b0d"
+checksum = "56c1936c4cc7a1c9ab21a1ebb602eb942ba868cbd44a99cb7cdc5892335e1c85"
 dependencies = [
  "linked-hash-map",
 ]

Cargo.toml.in

@@ -23,14 +23,14 @@ rustc_less_1_36 = []
 
 # Dependencies which don't change based on build flags
 [dependencies.cairo-sys-rs]
-version = ""
+version = "0.9"
 
 [dependencies.glib-sys]
-version = ""
+version = "*"
 features = ["v2_44"]
 
 [dependencies.gtk-sys]
-version = ""
+version = "0.9"
 features = ["v3_22"]
 
 [dependencies]

README.md

@@ -1,7 +1,7 @@
-*squeekboard* - a Wayland virtual keyboard
+*squeekboard* - a Wayland on-screen keyboard
 ========================================
 
-*Squeekboard* is a virtual keyboard supporting Wayland, built primarily for the *Librem 5* phone.
+*Squeekboard* is a keyboard-shaped input method supporting Wayland, built primarily for the *Librem 5* phone.
 
 It squeaks because some Rust got inside.
 
@@ -11,20 +11,24 @@ Features
 ### Present
 
 - GTK3
-- Custom yaml-defined keyboards
+- Custom keyboard layouts defined in yaml
+- Input purpose dependent keyboard layouts
 - DBus interface to show and hide
-- Use Wayland input method protocol to show and hide
+- Use Wayland input method protocol to submit text
 - Use Wayland virtual keyboard protocol
 
-### Temporarily dropped
-
-- A settings interface
-
 ### TODO
 
-- Use Wayland input method protocol
+- Text prediction/correction
+- Use preedit
+- Submit actions like "next field" using a future Wayland protocol
 - Pick up DBus interface files from /usr/share
 
+Creating layouts
+-------------------
+
+If you want to work on layouts, check out the [guide](doc/tutorial.md).
+
 Building
 --------
 
@@ -35,7 +39,7 @@ See `.gitlab-ci.yml` or run `apt-get build-dep .`
 ### Build from git repo
 
 ```bash
-$ git clone https://source.puri.sm/Librem5/squeekboard.git
+$ git clone https://gitlab.gnome.org/World/Phosh/squeekboard.git
 $ cd squeekboard
 $ mkdir _build
 $ meson _build/
@@ -54,18 +58,31 @@ $ cd ../build/
 $ src/squeekboard
 ```
 
+Squeekboard's panel will appear whenever a compatible application requests an input method. Click a text field in any GTK application, like `python3 ./tools/entry.py`.
+
 Squeekboard honors the gnome "screen-keyboard-enabled" setting. Either enable this through gnome-settings under accessibility or run:
 
 ```bash
 $ gsettings set org.gnome.desktop.a11y.applications screen-keyboard-enabled true
 ```
 
-To make the keyboard show you can use either an application that does so automatically, like a text editor or `python3 ./tests/entry.py`, or you can manually trigger it with:
+Alternatively, force panel visibility manually with:
 
 ```bash
 busctl call --user sm.puri.OSK0 /sm/puri/OSK0 sm.puri.OSK0 SetVisible b true
 ```
 
+### What the compositor has to support
+
+A compatible compositor has to support the protocols:
+
+- layer-shell
+- virtual-keyboard-v1
+
+It's strongly recommended to support:
+
+- input-method-v2
+
 Developing
 ----------
 

cargo_build.py

@@ -34,7 +34,7 @@ if out_path:
     i = args.index(out_path)
     args.pop(i)    
 
-subprocess.run(['sh', "{}/cargo.sh".format(shlex.quote(source_dir.as_posix())), 'build']
+subprocess.run(['sh', "{}/cargo.sh".format(source_dir.as_posix()), 'build']
     + args,
     check=True)
 
@@ -43,7 +43,7 @@ if out_path:
     out_basename = out_path.name
     filename = filename or out_basename
     subprocess.run(['cp', '-a',
-        './{}/{}'.format(shlex.quote(binary_dir), shlex.quote(filename)),
+        './{}/{}'.format(binary_dir, filename),
         out_path],
         check=True)
 

data/common.css

@@ -0,0 +1,6 @@
+/* Theme independent style */
+
+sq_view.pin sq_button {
+    border-radius: 0px;
+    margin: 1px 1px 1px 1px;
+}

data/keyboards/am+phonetic.yaml

@@ -0,0 +1,84 @@
+# Armenian layout created by Norayr Chilingarian
+# Yerevan
+# Oct 2021
+---
+outlines:
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 32, height: 32 }
+    spaceline: { width: 142, height: 52 }
+    special: { width: 44, height: 52 }
+
+views:
+    base:
+        - "՝ է թ փ ձ ջ ւ և ռ չ ճ ֊ ժ"
+        - "ք ո ե ր տ ը ւ ի օ պ խ ծ շ"
+        - "ա ս դ ֆ գ հ յ կ լ ․"
+        - "Shift_L զ ղ ց վ բ ն մ ՛ BackSpace"
+        - "show_numbers preferences         space        period Return"
+    upper:
+        - "՝ Է Թ Փ Ձ Ջ Ւ և Ռ Չ Ճ — Ժ"
+        - "Ք Ո Ե Ր Տ Ը Ւ Ի Օ Պ Խ Ծ Շ"
+        - "Ա Ս Դ Ֆ Գ Հ Յ Կ Լ ։"
+        - "Shift_L Զ Ղ Ց Վ Բ Ն Մ ՞ BackSpace"
+        - "show_numbers preferences         space        period Return"
+    numbers:
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "ﬓ  ﬔ  ﬕ  ﬖ  ﬗ   ՟ և"
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "show_numbers_from_symbols   \\ % < > = [ ]  BackSpace"
+        - "* # $ / & - _ + ( )"
+        - "© ® £ € ¥ ^ ° @ { }"
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "show_letters preferences         space        period 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: "wide"
+        label: "123"
+    show_numbers_from_symbols:
+        action:
+            set_view: "numbers"
+        outline: "altline"
+        label: "123"
+    show_letters:
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "ԱԲԳ"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/am.yaml

@@ -0,0 +1,84 @@
+# Armenian layout created by Norayr Chilingarian
+# Yerevan
+# Oct 2021
+---
+outlines:
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 32, height: 32 }
+    spaceline: { width: 142, height: 52 }
+    special: { width: 44, height: 52 }
+
+views:
+    base:
+        - "՝ ֆ ձ ֊ , ։ ՞ ․ ՛ ) օ է ղ"
+        - "ճ փ բ ս մ ո ւ կ ը թ ծ ց »"
+        - "ջ վ գ ե ա ն ի տ հ պ ր"
+        - "Shift_L ժ դ չ յ զ լ ք խ շ ռ BackSpace"
+        - "show_numbers preferences         space        period Return"
+    upper:
+        - "՜ Ֆ Ձ — $ … ՟ և ՚ ( Օ Է Ղ"
+        - "Ճ Փ Բ Ս Մ Ո Ւ Կ Ը Թ Ծ Ց «"
+        - "Ջ Վ Գ Ե Ա Ն Ի Տ Հ Պ Պ Ր"
+        - "Shift_L Ժ Դ Չ Յ Զ Լ Ք Խ Շ Ռ BackSpace"
+        - "show_numbers preferences         space        period Return"
+    numbers:
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "ﬓ  ﬔ  ﬕ  ﬖ  ﬗ   ՟ և"
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "show_numbers_from_symbols   \\ % < > = [ ]  BackSpace"
+        - "* # $ / & - _ + ( )"
+        - "© ® £ € ¥ ^ ° @ { }"
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "show_letters preferences         space        period 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: "wide"
+        label: "123"
+    show_numbers_from_symbols:
+        action:
+            set_view: "numbers"
+        outline: "altline"
+        label: "123"
+    show_letters:
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "ԱԲԳ"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/ara.yaml

@@ -0,0 +1,70 @@
+# Maintained by: Khaled Eldoheiri <khalid@kdehairy.com>
+---
+outlines:
+    default: { width: 32.66, height: 52 }
+    altline: { width: 48.99, height: 52 }
+    wide: { width: 62, height: 52 }
+    spaceline: { width: 195.96, height: 52 }
+    special: { width: 35.66, height: 52 }
+
+views:
+    base:
+        - "ذ ض ص ث ق ف غ ع خ ح ج"
+        - "ش س ي ب ل ا ت ن م ك ط"
+        - "Shift_L ء ؤ ر ة و ز ظ د BackSpace"
+        - "show_numbers preferences         space        . Return"
+    extra:
+        - "ذ ض ص ث ق لإ إ ع خ ح ج"
+        - "ش س ى ب لأ أ ت ن م ك ط"
+        - "Shift_L ئ لآ لا ه آ ز ظ د 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"
+
+buttons:
+    Shift_L:
+        action:
+            locking:
+                lock_view: "extra"
+                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: "ض"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    space:
+        outline: "spaceline"
+        label: " "
+        text: " "
+    Return:
+        outline: "altline"
+        icon: "key-enter"
+        keysym: "Return"

data/keyboards/ara_wide.yaml

@@ -0,0 +1,70 @@
+# Maintained by: Khaled Eldoheiri <khalid@kdehairy.com>
+---
+outlines:
+    default: { width: 49, height: 42 }
+    altline: { width: 73.5, height: 42 }
+    wide: { width: 108, height: 42 }
+    spaceline: { width: 324, height: 42 }
+    special: { width: 49, height: 42 }
+
+views:
+    base:
+        - "ذ ض ص ث ق ف غ ع خ ح ج"
+        - "ش س ي ب ل ا ت ن م ك ط"
+        - "Shift_L ء ؤ ر ة و ز ظ د BackSpace"
+        - "show_numbers preferences         space        . Return"
+    extra:
+        - "ذ ض ص ث ق لإ إ ع خ ح ج"
+        - "ش س ى ب لأ أ ت ن م ك ط"
+        - "Shift_L ئ لآ لا ه آ ز ظ د 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"
+
+buttons:
+    Shift_L:
+        action:
+            locking:
+                lock_view: "extra"
+                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: "ض"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    space:
+        outline: "spaceline"
+        label: " "
+        text: " "
+    Return:
+        outline: "altline"
+        icon: "key-enter"
+        keysym: "Return"

data/keyboards/bg+phonetic.yaml

@@ -0,0 +1,78 @@
+---
+outlines:
+    default: { width: 32.72, height: 52 }
+    altline: { width: 47, height: 52 }
+    wide: { width: 49.09, height: 52 }
+    spaceline: { width: 185, height: 52 }
+    special: { width: 44, height: 52 }
+
+views:
+    base:
+        - "я в е р т ъ у и о п ю"
+        - "а с д ф г х й к л ш щ"
+        - "Shift_L з ь ц ж б н м ч BackSpace"
+        - "show_numbers preferences         space   .    Return"
+    upper:
+        - "Я В Е Р Т Ъ У И О П Ю"
+        - "А С Д Ф Г Х Й К Л Ш Щ"
+        - "Shift_L З Ь Ц Ж Б Н М Ч BackSpace"
+        - "show_numbers preferences         space   ,    Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # € % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ $ ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  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: "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: "*/="
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+    "\"":
+        keysym: "quotedbl"

data/keyboards/bg.yaml

@@ -8,19 +8,19 @@ outlines:
 
 views:
     base:
-        - "я в е р т ъ у и о п ю"
+        - "у е и ш щ к с д з ц б"
-        - "а с д ф г х й к л ш щ"
+        - "ь я а о ж г т н в м ч"
-        - "Shift_L з ь ц ж б н м ч BackSpace"
+        - "Shift_L ю й ъ ф х п р л BackSpace"
         - "show_numbers preferences         space   .    Return"
     upper:
-        - "Я В Е Р Т Ъ У И О П Ю"
+        - "У Е И Ш Щ К С Д З Ц Б"
-        - "А С Д Ф Г Х Й К Л Ш Щ"
+        - "Ь Я А О Ж Г Т Н В М Ч"
-        - "Shift_L З Ь Ц Ж Б Н М Ч BackSpace"
+        - "Shift_L Ю Й Ъ Ф Х П Р Л BackSpace"
         - "show_numbers preferences         space   ,    Return"
     numbers:
         - "1 2 3 4 5 6 7 8 9 0"
         - "@ # € % & - _ + ( )"
-        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_symbols , \" ' colon ; ! ? ѝ BackSpace"
         - "show_letters preferences         space        Return"
     symbols:
         - "~ ` | · √ π τ ÷ × ¶"

data/keyboards/ch+de.yaml

@@ -0,0 +1,73 @@
+# Maintained by Patrick Jörg <patrickjoerg@gmx.ch>. No Copyright, enjoy!
+
+---
+outlines:
+    default:   { width: 35.33, height: 52 }
+    altline:   { width: 48,    height: 52 }
+    wide:      { width: 59,    height: 52 }
+    spaceline: { width: 70,    height: 52 }
+    special:   { width: 28,    height: 52 }
+
+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"
+
+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: "*/="
+    space:
+        outline: "spaceline"
+        label: " "
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    "\"":
+        keysym: "quotedbl"

data/keyboards/ch+fr.yaml

@@ -0,0 +1,91 @@
+# Maintained by: Jordi Bossy <jordi@bossy.space>. No Copyright, enjoy!
+---
+outlines:
+    default:   { width: 35.33, height: 52 }
+    altline:   { width: 48,    height: 52 }
+    wide:      { width: 59,    height: 52 }
+    spaceline: { width: 70,    height: 52 }
+    special:   { width: 28,    height: 52 }
+
+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 show_eschars 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 show_eschars preferences    \"  space        , . Return"
+    numbers:      
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ * + - = ( ) ~ < >"
+        - "show_symbols  # & / \\ √ ; : BackSpace"
+        - "show_letters show_eschars preferences    _   space        , . Return"
+    symbols:
+        - "€ $ £ ¥ % | § µ [ ]"
+        - "© ® § ` ^ { } · ¡ ¿"
+        - "show_numbers  « » ÷ × “ ” „ BackSpace"
+        - "show_letters show_eschars preferences    -   space        , . Return"
+    eschars:
+        - "à â ç é è ê î ô ù û"
+        - "À Â Ç É È Ê Î Ô Ù Û"
+        - "show_numbers  æ œ ä ë ï ö ü  BackSpace"
+        - "show_letters_from_accents 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: "âÂ"
+    show_letters_from_accents:
+        action:
+            locking:
+                lock_view: "eschars"
+                unlock_view: "base"
+        outline: "altline"
+        label: "âÂ"
+    space:
+        outline: "spaceline"
+        label: " "
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    "\"":
+        keysym: "quotedbl"

data/keyboards/ch.yaml

@@ -0,0 +1,93 @@
+# Maintained by: Jordy Bossy <jordi@bossy.space>
+# and Patrick Jörg <patrickjoerg@gmx.ch>. No Copyright, enjoy!
+
+---
+outlines:
+    default:   { width: 35.33, height: 52 }
+    altline:   { width: 48,    height: 52 }
+    wide:      { width: 59,    height: 52 }
+    spaceline: { width: 70,    height: 52 }
+    special:   { width: 28,    height: 52 }
+
+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 show_eschars 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 show_eschars preferences    \"  space        , . Return"
+    numbers:      
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ * + - = ( ) ~ < > ? !"
+        - "show_symbols  # & / \\ √ ; : BackSpace"
+        - "show_letters show_eschars preferences    _   space        , . Return"
+    symbols:
+        - "€ $ £ ¥ % | § µ [ ]"
+        - "© ® § ` ^ { } · ¡ ¿"
+        - "show_numbers  « » ÷ × “ ” „ BackSpace"
+        - "show_letters show_eschars preferences    -   space        , . Return"
+    eschars:
+        - "à â ç é è ê î ô ù û"
+        - "À Â Ç É È Ê Î Ô Ù Û"
+        - "show_numbers  æ œ ä ë ï ö ü  BackSpace"
+        - "show_letters_from_accents 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: "âÂ"
+    show_letters_from_accents:
+        action:
+            locking:
+                lock_view: "eschars"
+                unlock_view: "base"
+        outline: "altline"
+        label: "âÂ"
+    space:
+        outline: "spaceline"
+        label: " "
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    "\"":
+        keysym: "quotedbl"

data/keyboards/ch_wide.yaml

@@ -0,0 +1,93 @@
+# Maintained by: Jordy Bossy <jordy@bossy.space>
+# and Patrick Jörg <patrickjoerg@gmx.ch>. No Copyright, enjoy!
+
+---
+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 show_eschars 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 show_eschars preferences    \"  space        , . Return"
+    numbers:      
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ * + - = ( ) ~ < > ? !"
+        - "show_symbols  # & / \\ √ ; : BackSpace"
+        - "show_letters show_eschars preferences    _   space        , . Return"
+    symbols:
+        - "€ $ £ ¥ % | § µ [ ]"
+        - "© ® § ` ^ { } · ¡ ¿"
+        - "show_numbers  « » ÷ × “ ” „ BackSpace"
+        - "show_letters show_eschars preferences    -   space        , . Return"
+    eschars:
+        - "à â ç é è ê î ô ù û"
+        - "À Â Ç É È Ê Î Ô Ù Û"
+        - "show_numbers  æ œ ä ë ï ö ü  BackSpace"
+        - "show_letters_from_accents 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: "äÄ"
+    show_letters_from_accents:
+        action:
+            locking:
+                lock_view: "eschars"
+                unlock_view: "base"
+        outline: "altline"
+        label: "âÂ"
+    space:
+        outline: "spaceline"
+        label: " "
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    "\"":
+        keysym: "quotedbl"

data/keyboards/email/us.yaml

@@ -0,0 +1,81 @@
+---
+outlines:
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 62, height: 52 }
+    spaceline: { width: 106.67, 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        at period 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        at period Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # $ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        at period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        at period 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
+    at:
+        outline: "special"
+        text: "@"
+    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: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/es+cat.yaml

@@ -0,0 +1,87 @@
+---
+outlines:
+    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:
+        - "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 show_eschars preferences         space        ? period 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 show_eschars preferences         space        ¿ period Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # € % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! = BackSpace"
+        - "show_letters show_eschars preferences         space        ? period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ $ ¥ ^ ° * { }"
+        - "show_numbers   \\ / < > = [ ]  BackSpace"
+        - "show_letters show_eschars preferences         space        ? period Return"
+    eschars:
+        - "á é í ó ú Á É Í Ó Ú"
+        - "à è ì ò ù À È Ì Ò Ù"
+        - "show_numbers ü ç ï Ü Ç Ï ¡  BackSpace"
+        - "show_letters show_eschars 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: "default"
+        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: "àÀ"
+
+    period:
+        outline: "default"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "altline"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+

data/keyboards/il.yaml

@@ -0,0 +1,71 @@
+---
+outlines:
+    default: { width: 40, height: 60 }
+    altline: { width: 56, height: 60 }
+    wide: { width: 62, height: 60 }
+    spaceline: { width: 142, height: 60 }
+    special: { width: 44, height: 60 }
+
+views:
+    base:
+        - "' - ק  ר א ט ו ן ם פ"
+        - "ש ד ג כ ע י ח ל ך ף"
+        - "ז ס ב ה נ מ צ ת ץ  BackSpace"
+        - "show_numbers comma preferences         space        period 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"
+
+buttons:
+    BackSpace:
+        outline: "default"
+        icon: "edit-clear-symbolic"
+        action: erase
+    comma:
+        outline: "special"
+        text: ","
+        
+    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: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+

data/keyboards/ir.yaml

@@ -0,0 +1,78 @@
+---
+outlines:
+    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:
+        - "ض ص ق ف غ ع ه خ ح ج"
+        - "ش س ی ب ل ا ت ن م ک"
+        - "Shift_L   ظ ط ز ر ذ د و  BackSpace"
+        - "show_numbers preferences         space        period Return"
+    upper:
+        - "پ { } [ ] ّ   َ   ِ  ُ چ"
+        - "ؤ‌ ئ ي‌ إ أ آ ة‌ » « گ"
+        - "Shift_L  ك ٓ ژ ء > < ؟  BackSpace"
+        - "show_numbers preferences         space        period Return"
+    numbers:
+        - "۱ ۲ ۳ ۴ ۵ ۶ ۷ ۸ ۹ ۰"
+        - "@ # ﷼ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ؛ ! ?  BackSpace"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        period 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: "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: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/ir_wide.yaml

@@ -0,0 +1,78 @@
+---
+outlines:
+    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:
+        - "ض ص ق ف غ ع ه خ ح ج"
+        - "ش س ی ب ل ا ت ن م ک"
+        - "Shift_L   ظ ط ز ر ذ د و  BackSpace"
+        - "show_numbers preferences         space        period Return"
+    upper:
+        - "پ { } [ ] ّ   َ   ِ  ُ چ"
+        - "ؤ‌ ئ ي‌ إ أ آ ة‌ » « گ"
+        - "Shift_L  ك ٓ ژ ء > < ؟  BackSpace"
+        - "show_numbers preferences         space        period Return"
+    numbers:
+        - "۱ ۲ ۳ ۴ ۵ ۶ ۷ ۸ ۹ ۰"
+        - "@ # ﷼ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ؛ ! ?  BackSpace"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        period 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: "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: "*/="
+    ".":
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/it+fur.yaml

@@ -22,7 +22,7 @@ views:
     numbers:
         - "1 2 3 4 5 6 7 8 9 0"
         - "@ # € % & - _ + ( )"
-        - "show_symbols   , \" ' colon ; ! =  BackSpace"
+        - "show_symbols   , \" ' : ; ! =  BackSpace"
         - "show_letters show_eschars preferences         space        ? . Return"
     symbols:
         - "~ ` | · √ π τ ÷ × ¶"
@@ -86,7 +86,4 @@ buttons:
         outline: "altline"
         icon: "key-enter"
         keysym: "Return"
-    colon:
+
-        label: ":"
-    "\"":
-        keysym: "quotedbl"

data/keyboards/it.yaml

@@ -22,7 +22,7 @@ views:
     numbers:
         - "1 2 3 4 5 6 7 8 9 0"
         - "@ # € % & - _ + ( )"
-        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_symbols   , \" ' : ; ! ?  BackSpace"
         - "show_letters show_eschars preferences         space        ? . Return"
     symbols:
         - "~ ` | · √ π τ ÷ × ¶"
@@ -84,7 +84,4 @@ buttons:
         outline: "altline"
         icon: "key-enter"
         keysym: "Return"
-    colon:
+
-        label: ":"
-    "\"":
-        keysym: "quotedbl"

data/keyboards/jp+kana.yaml

@@ -438,7 +438,7 @@ buttons:
                 unlock_view: "カタカナ"
         outline: "altline"
         label: "。"
-    # Buttons for Latin charachters
+    # Buttons for Latin characters
     RSYM1:
         action:
             locking:

data/keyboards/jp+kana_wide.yaml

@@ -438,7 +438,7 @@ buttons:
                 unlock_view: "カタカナ"
         outline: "altline"
         label: "。"
-    # Buttons for Latin charachters
+    # Buttons for Latin characters
     RSYM1:
         action:
             locking:

data/keyboards/pin/us.yaml

@@ -0,0 +1,20 @@
+---
+margins: { top: 4, side: 0, bottom: 4 }
+outlines:
+    default: { width: 120, height: 52 }
+
+views:
+    base:
+        - "1 2 3"
+        - "4 5 6"
+        - "7 8 9"
+        - "BackSpace 0 Return"
+
+buttons:
+    BackSpace:
+        icon: "edit-clear-symbolic"
+        action: erase
+    Return:
+        icon: "key-enter"
+        keysym: "Return"
+

data/keyboards/pl.yaml

@@ -52,6 +52,8 @@ buttons:
             locking:
                 lock_view: "upper_accents"
                 unlock_view: "accents"
+                looks_locked_from:
+                    - "upper"
         outline: "altline"
         icon: "key-shift"
     BackSpace:
@@ -94,6 +96,8 @@ buttons:
             locking:
                 lock_view: "upper_accents"
                 unlock_view: "upper"
+                looks_locked_from:
+                    - "accents"
         outline: "altline"
         label: "ĄĘ"
     period:

data/keyboards/terminal/fr.yaml

@@ -0,0 +1,220 @@
+---
+outlines:
+    action:    { width: 59,    height: 46 }
+    small:     { width: 50,    height: 22 }
+    default:   { width: 35.33, height: 46 }
+    altline:   { width: 48,    height: 46 }
+    wide:      { width: 50,    height: 46 }
+    spaceline: { width: 110,   height: 46 }
+    special:   { width: 44,    height: 46 }
+
+views:
+    base:
+        - "Ctrl Alt Tabsmall ↑ ↓ ← →"
+        - "a z e r t y u i o p"
+        - "q s d f g h j k l m"
+        - "Shift_L   w x c v b n period   BackSpace"
+        - "show_numbers preferences         space        show_eschars show_actions Return"
+    upper:
+        - "Ctrl Alt Tabsmall PgUp PgDn Home End"
+        - "A Z E R T Y U I O P"
+        - "Q S D F G H J K L M"
+        - "Shift_L   W X C V B N ,  BackSpace"
+        - "show_numbers preferences         space        show_eschars show_actions Return"
+    numbers:
+        - "Ctrl Alt Tabsmall ↑ ↓ ← →"
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # € % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        show_eschars show_actions Return"
+    symbols:
+        - "Ctrl Alt Tabsmall ↑ ↓ ← →"
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ $ ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        show_eschars show_actions Return"
+    eschars:
+        - "Ctrl Alt Tabsmall ↑ ↓ ← →"
+        - "à â ç é è ê î ô ù û"
+        - "À Â Ç É È Ê Î Ô Ù Û"
+        - "show_numbers_from_symbols  æ œ ä ë ï ö ü  BackSpace"
+        - "show_letters preferences         space        show_eschars show_actions Return"
+    actions:
+        - "Ctrl Alt PgUp PgDn Home End"
+        - "F1  F2  F3  F4  F5  F6"
+        - "F7  F8  F9  F10 F11 F12"
+        - "Esc Tab Pause Insert Up Del"
+        - "show_letters Menu Break Left Down Right"
+
+ 
+buttons:
+    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"
+    Tabsmall:
+        outline: "small"
+        keysym: "Tab"
+        label: "Tab"
+    Del:
+        outline: "action"
+        keysym: "Delete"
+    Insert:
+        outline: "action"
+        keysym: "Insert"
+    Menu:
+        outline: "action"
+        keysym: "Menu"
+    Pause:
+        outline: "action"
+        keysym: "Pause"
+    Break:
+        outline: "action"
+        keysym: "Break"
+    Home:
+        outline: "small"
+        keysym: "Home"
+    End:
+        outline: "small"
+        keysym: "End"
+    PgUp:
+        outline: "small"
+        keysym: "Page_Up"
+    PgDn:
+        outline: "small"
+        keysym: "Page_Down"
+    "↑":
+        outline: "small"
+        keysym: "Up"
+    "↓":
+        outline: "small"
+        keysym: "Down"
+    "←":
+        outline: "small"
+        keysym: "Left"
+    "→":
+        outline: "small"
+        keysym: "Right"
+    Up:
+        label: "↑"
+        outline: "action"
+        keysym: "Up"
+    Left:
+        label: "←"
+        outline: "action"
+        keysym: "Left"
+    Down:
+        label: "↓"
+        outline: "action"
+        keysym: "Down"
+    Right:
+        label: "→"
+        outline: "action"
+        keysym: "Right"
+    Ctrl:
+        modifier: "Control"
+        outline: "small"
+        label: "Ctrl"
+    Alt:
+        modifier: "Alt"
+        outline: "small"
+        label: "Alt"
+    period:
+        outline: "special"
+        text: "."
+    show_actions:
+        action:
+            set_view: "actions"
+        outline: "special"
+        label: ">_"
+    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_eschars:
+        action:
+            locking:
+                lock_view: "eschars"
+                unlock_view: "base"
+        outline: "altline"
+        label: "âÂ"
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+    "\"":
+        keysym: "quotedbl"

data/keyboards/terminal/fr_wide.yaml

@@ -0,0 +1,223 @@
+---
+outlines:
+    action:    { width: 90,   height: 37 }
+    small:     { width: 67.4, height: 22 }
+    default:   { width: 54,  height: 37 }
+    altline:   { width: 81,  height: 37 }
+    wide:      { width: 100, height: 37 }
+    spaceline: { width: 110, height: 37 }
+    special:   { width: 54,  height: 37 }
+
+views:
+    base:
+        - "EscSmall TabSmall Ctrl Alt ↑ ↓ ← →"
+        - "a z e r t y u i o p"
+        - "q s d f g h j k l m"
+        - "Shift_L   w x c v b n period   BackSpace"
+        - "show_numbers preferences         space        show_eschars show_actions Return"
+    upper:
+        - "EscSmall TabSmall Ctrl Alt PgUp PgDn Home End"
+        - "A Z E R T Y U I O P"
+        - "Q S D F G H J K L M"
+        - "Shift_L   W X C V B N ,  BackSpace"
+        - "show_numbers preferences         space        show_eschars show_actions Return"
+    numbers:
+        - "EscSmall TabSmall Ctrl Alt ↑ ↓ ← →"
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # € % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        show_eschars show_actions Return"
+    symbols:
+        - "EscSmall TabSmall Ctrl Alt ↑ ↓ ← →"
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ $ ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        show_eschars show_actions Return"
+    eschars:
+        - "EscSmall TabSmall Ctrl Alt ↑ ↓ ← →"
+        - "à â ç é è ê î ô ù û"
+        - "À Â Ç É È Ê Î Ô Ù Û"
+        - "show_numbers_from_symbols  æ œ ä ë ï ö ü  BackSpace"
+        - "show_letters preferences         space        show_eschars show_actions Return"
+    actions:
+        - "EscSmall TabSmall Ctrl Alt PgUp PgDn Home End"
+        - "F1  F2  F3  F4  F5  F6"
+        - "F7  F8  F9  F10 F11 F12"
+        - "Esc Tab Pause Insert Up Del"
+        - "show_letters Menu Break Left Down Right"
+ 
+buttons:
+    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"
+    EscSmall:
+        outline: "small"
+        keysym: "Escape"
+        label: "Esc"
+    Tab:
+        outline: "action"
+        keysym: "Tab"
+    TabSmall:
+        outline: "small"
+        keysym: "Tab"
+        label: "Tab"
+    Del:
+        outline: "action"
+        keysym: "Delete"
+    Insert:
+        outline: "action"
+        keysym: "Insert"
+    Menu:
+        outline: "action"
+        keysym: "Menu"
+    Pause:
+        outline: "action"
+        keysym: "Pause"
+    Break:
+        outline: "action"
+        keysym: "Break"
+    Home:
+        outline: "small"
+        keysym: "Home"
+    End:
+        outline: "small"
+        keysym: "End"
+    PgUp:
+        outline: "small"
+        keysym: "Page_Up"
+    PgDn:
+        outline: "small"
+        keysym: "Page_Down"
+    "↑":
+        outline: "small"
+        keysym: "Up"
+    "↓":
+        outline: "small"
+        keysym: "Down"
+    "←":
+        outline: "small"
+        keysym: "Left"
+    "→":
+        outline: "small"
+        keysym: "Right"
+    Up:
+        label: "↑"
+        outline: "action"
+        keysym: "Up"
+    Left:
+        label: "←"
+        outline: "action"
+        keysym: "Left"
+    Down:
+        label: "↓"
+        outline: "action"
+        keysym: "Down"
+    Right:
+        label: "→"
+        outline: "action"
+        keysym: "Right"
+    Ctrl:
+        modifier: "Control"
+        outline: "small"
+        label: "Ctrl"
+    Alt:
+        modifier: "Alt"
+        outline: "small"
+        label: "Alt"
+    period:
+        outline: "special"
+        text: "."
+    show_actions:
+        action:
+            set_view: "actions"
+        outline: "special"
+        label: ">_"
+    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_eschars:
+        action:
+            locking:
+                lock_view: "eschars"
+                unlock_view: "base"
+        outline: "altline"
+        label: "âÂ"
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+    "\"":
+        keysym: "quotedbl"

data/keyboards/terminal/us.yaml

@@ -147,9 +147,6 @@ buttons:
     Pause:
         outline: "action"
         keysym: "Pause"
-    Menu:
-        outline: "action"
-        keysym: "Menu"
     Break:
         outline: "action"
         keysym: "Break"
@@ -201,4 +198,3 @@ buttons:
         modifier: "Alt"
         outline: "small"
         label: "Alt"
-

data/keyboards/terminal/us_wide.yaml

@@ -155,9 +155,6 @@ buttons:
     Pause:
         outline: "action"
         keysym: "Pause"
-    Menu:
-        outline: "action"
-        keysym: "Menu"
     Break:
         outline: "action"
         keysym: "Break"
@@ -208,4 +205,4 @@ buttons:
     Alt:
         modifier: "Alt"
         outline: "small"
-        label: "Alt"
+        label: "Alt"

data/keyboards/th_wide.yaml

@@ -0,0 +1,84 @@
+---
+outlines:
+    default: { width: 75, height: 56 }
+    altline: { width: 75, height: 56 }
+    wide: { width: 135, height: 56 }
+    spaceline: { width: 450, height: 56 }
+    spacelinesymbol: { width: 300, height: 56 }
+    special: { width: 90, height: 56 }
+
+views:
+    base:
+        - "ๅ / _ ภ ถ ุ ึ ค ต จ ข ช"
+        - "ๆ ไ ำ พ ะ ั ี ร น ย บ ล"
+        - "ฟ ห ก ด เ ้ ่ า ส ว ง ฃ"
+        - "Shift_L   ผ ป แ อ ิ ื ท ม ใ ฝ   BackSpace"
+        - "show_numbers preferences         space        period Return"
+    upper:
+        - "+ ๑ ๒ ๓ ๔ ู ฿ ๕ ๖ ๗ ๘ ๙"
+        - "๐ \" ฎ ฑ ธ ํ ๊ ณ ฯ ญ ฐ ,"
+        - "ฤ ฆ ฏ โ ฌ ็ ๋ ษ ศ ซ . ฅ"
+        - "Shift_L   ( ) ฉ ฮ ฺ ์ ? ฒ ฬ ฦ  BackSpace"
+        - "show_numbers preferences         space        period Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # $ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         spacesymbol        period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         spacesymbol        period 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: "wide"
+        label: "123"
+    show_numbers_from_symbols:
+        action:
+            set_view: "numbers"
+        outline: "altline"
+        label: "123"
+    show_letters:
+        action:
+            set_view: "base"
+        outline: "wide"
+        label: "กขค"
+    show_symbols:
+        action:
+            set_view: "symbols"
+        outline: "altline"
+        label: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    spacesymbol:
+        outline: "spacelinesymbol"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/url/us.yaml

@@ -0,0 +1,81 @@
+---
+outlines:
+    default: { width: 35.33, height: 52 }
+    altline: { width: 52.67, height: 52 }
+    wide: { width: 62, height: 52 }
+    spaceline: { width: 106.67, 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        slash period 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        slash period Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # $ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        slash period Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  BackSpace"
+        - "show_letters preferences         space        slash period 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: "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: "*/="
+    period:
+        outline: "special"
+        text: "."
+    slash:
+        outline: "special"
+        text: "/"
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/us+colemak_wide.yaml

@@ -0,0 +1,78 @@
+---
+outlines:
+    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 f p g j l u y"
+        - "a r s t d h n e i o"
+        - "Shift_L   z x c v b k m  BackSpace"
+        - "show_numbers preferences         space        . Return"
+    upper:
+        - "Q W F P G J L U Y"
+        - "A R S T D H N E I O"
+        - "Shift_L   Z X C V B K M  BackSpace"
+        - "show_numbers preferences         space        . Return"
+    numbers:
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "@ # $ % & - _ + ( )"
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "show_letters preferences         space        . Return"
+    symbols:
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "© ® £ € ¥ ^ ° * { }"
+        - "show_numbers_from_symbols   \\ / < > = [ ]  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: "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: "*/="
+    ".":
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"

data/keyboards/us+dvorak.yaml

@@ -0,0 +1,89 @@
+---
+outlines:
+    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:
+        - "Shift_L   p y f g c r l  BackSpace"
+        - "a o e u i d h t n s"
+        - ", q j k x b m w v z"
+        - "show_numbers preferences         space        period Return"
+    upper:
+        - "Shift_L   P Y F G C R L  BackSpace"
+        - "A O E U I D H T N S"
+        - ", Q J K X B M W V Z"
+        - "show_numbers preferences         space        period Return"
+    numbers:
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "* # $ / & - _ + ( )"
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "show_numbers_from_symbols   \\ % < > = [ ]  BackSpace"
+        - "© ® £ € ¥ ^ ° @ { }"
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "show_letters preferences         space        period 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: "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: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+
+# The US QWERTY layout has fewer letters on the third row, and so has
+# the shift & backspace keys placed there. In contrast, the US DVORAK
+# layout has fewer letters on the first row, which makes it a good
+# choice for the shift & backspace keys. That leads to what may be,
+# for many people, an unexpected layout in numbers mode: the numerals
+# are on the third row (not the first) so that the backspace key
+# remains in a consistent location regardless of mode, without
+# sacrificing key width. (Once could argue that in numbers mode, the
+# numerals should be closer to the enter key.) As with any keyboard
+# layout, familiarity comes with repeated use.

data/keyboards/us+dvorak_wide.yaml

@@ -0,0 +1,89 @@
+---
+outlines:
+    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:
+        - "Shift_L   p y f g c r l  BackSpace"
+        - "a o e u i d h t n s"
+        - ", q j k x b m w v z"
+        - "show_numbers preferences         space        period Return"
+    upper:
+        - "Shift_L   P Y F G C R L  BackSpace"
+        - "A O E U I D H T N S"
+        - ", Q J K X B M W V Z"
+        - "show_numbers preferences         space        period Return"
+    numbers:
+        - "show_symbols   , \" ' colon ; ! ?  BackSpace"
+        - "* # $ / & - _ + ( )"
+        - "1 2 3 4 5 6 7 8 9 0"
+        - "show_letters preferences         space        period Return"
+    symbols:
+        - "show_numbers_from_symbols   \\ % < > = [ ]  BackSpace"
+        - "© ® £ € ¥ ^ ° @ { }"
+        - "~ ` | · √ π τ ÷ × ¶"
+        - "show_letters preferences         space        period 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: "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: "*/="
+    period:
+        outline: "special"
+        text: "."
+    space:
+        outline: "spaceline"
+        text: " "
+    Return:
+        outline: "wide"
+        icon: "key-enter"
+        keysym: "Return"
+    colon:
+        text: ":"
+
+# The US QWERTY layout has fewer letters on the third row, and so has
+# the shift & backspace keys placed there. In contrast, the US DVORAK
+# layout has fewer letters on the first row, which makes it a good
+# choice for the shift & backspace keys. That leads to what may be,
+# for many people, an unexpected layout in numbers mode: the numerals
+# are on the third row (not the first) so that the backspace key
+# remains in a consistent location regardless of mode, without
+# sacrificing key width. (Once could argue that in numbers mode, the
+# numerals should be closer to the enter key.) As with any keyboard
+# layout, familiarity comes with repeated use.

data/langs/bg-BG.txt

@@ -1,13 +0,0 @@
-bg Български
-de Немски
-es Испански
-emoji Емоджи
-fi Френски
-gr Гръцки
-it Италянски
-no Норевежки
-pl Полски
-ru Руски
-se Шведски
-terminal Терминал
-us Английски (САЩ)

data/langs/cs-CZ.txt

@@ -1,21 +0,0 @@
-be Belgická
-cz Česká
-cz+qwerty Česká (QWERTY)
-de Německá
-dk Dánská
-emoji Emoji
-es Španělská
-fi Finská
-fr Francouzská
-gr Řecká
-it Italská
-jp Japonská
-jp+kana Japonská (Kana)
-no Norská
-pl Polská
-ru Ruská
-se Švédská
-terminal Terminál
-th Thajská
-ua Ukrajinská
-us Anglická (USA)

data/langs/en-US.txt

@@ -1,2 +0,0 @@
-emoji Emoji
-terminal Terminal

data/langs/es-ES.txt

@@ -1,7 +0,0 @@
-us Inglés (EE.UU.)
-de Alemán
-el Griego
-es Español
-it Italiano
-jp+kana Japonés (Kana)
-no Noruego

data/langs/fur-IT.txt

@@ -1,18 +0,0 @@
-be Belgjic
-br Brasilian
-de Todesc
-dk Danês
-es Spagnûl
-fi Finlandês
-fr Francês
-it+fur Furlan
-gr Grêc
-it Talian
-jp+kana Gjaponês (Kana)
-no Norvegjês
-pl Polac
-ru Rus
-se Svedês
-terminal Terminâl
-ua Ucrain
-us American (USA)

data/langs/pl-PL.txt

@@ -1,2 +0,0 @@
-emoji emoji
-terminal terminal

data/langs/ru-RU.txt

@@ -1,11 +0,0 @@
-de Немецкий
-es Испанский
-fi Финский
-gr Греческий
-it Итальянский
-no Норвежский
-pl Польский
-ru Русский
-se Шведский
-terminal Терминал
-us Английский (США)

data/meson.build

@@ -12,7 +12,7 @@ desktopconf.set('bindir', bindir)
 
 desktop_file = 'sm.puri.Squeekboard.desktop'
 
-i18n.merge_file('desktop',
+i18n.merge_file(
     input: configure_file(
       input: desktop_file + '.in.in',
       output: desktop_file + '.in',

data/popover.ui

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<interface>
+  <menu id="app-menu">
+    <item>
+      <!-- translators: This is a emmoji keyboard layout -->
+      <attribute name="label" translatable="yes">Emoji</attribute>
+      <attribute name="action">layout</attribute>
+      <attribute name="target">emoji</attribute>
+    </item>
+    <item>
+      <!-- translators: This is a terminal keyboard layout -->
+      <attribute name="label" translatable="yes">Terminal</attribute>
+      <attribute name="action">layout</attribute>
+      <attribute name="target">terminal</attribute>
+    </item>
+    <section>
+      <item>
+        <attribute name="label" translatable="yes">Keyboard Settings</attribute>
+        <attribute name="action">settings</attribute>
+      </item>
+    </section>
+  </menu>
+</interface>

data/popup.ui

@@ -1,19 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- Generated with glade 3.22.1 -->
-<interface>
-  <requires lib="gtk+" version="3.16"/>
-  <object class="GtkPopoverMenu" id="main_menu">
-    <property name="can_focus">False</property>
-    <child>
-      <object class="GtkBox" id="box">
-        <property name="visible">True</property>
-        <property name="can_focus">False</property>
-        <property name="orientation">vertical</property>
-      </object>
-      <packing>
-        <property name="submenu">main</property>
-        <property name="position">1</property>
-      </packing>
-    </child>
-  </object>
-</interface>

data/sm.puri.Squeekboard.desktop.in.in

@@ -1,7 +1,7 @@
 [Desktop Entry]
 Name=Squeekboard
-GenericName=Squeekboard Virtual Keyboard
+GenericName=On Screen Keyboard
-Comment=Virtual Keyboard
+Comment=An on screen virtual keyboard
 Exec=@bindir@/squeekboard
 Terminal=false
 Type=Application

data/squeekboard.gresources.xml

@@ -1,9 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <gresources>
   <gresource prefix="/sm/puri/squeekboard">
+   <file compressed="true">common.css</file>
    <file compressed="true">style.css</file>
    <file compressed="true">style-Adwaita:dark.css</file>
-   <file compressed="true" preprocess="xml-stripblanks">popup.ui</file>
+   <file compressed="true" preprocess="xml-stripblanks">popover.ui</file>
    <file>icons/key-enter.svg</file>
    <file>icons/key-shift.svg</file>
    <file>icons/keyboard-mode-symbolic.svg</file>

data/style-Adwaita:dark.css

@@ -31,11 +31,16 @@ sq_button.wide {
     border-color: #3e3a44;
 }
 
-sq_button.locked {
+sq_button.latched {
     background: #ffffff;
     color: #2b292f;
 }
 
+sq_button.locked {
+    background: #ffffff;
+    color: #1c71d8;
+}
+
 sq_button.action {
     font-size: 0.75em;
 }
@@ -53,3 +58,5 @@ sq_button.small {
     background: #1c71d8;
     border-color: #3584e4;
 }
+
+@import url("resource:///sm/puri/squeekboard/common.css");

data/style.css

@@ -34,11 +34,16 @@ sq_button.wide {
     border-color: @borders; /* #3e3a44; */
 }
 
-sq_button.locked {
+sq_button.latched {
     background: @theme_fg_color; /*#ffffff;*/
     color: @theme_bg_color; /*#2b292f;*/
 }
 
+sq_button.locked {
+    background: @theme_fg_color; /*#ffffff;*/
+    color: mix(@theme_selected_bg_color, @theme_bg_color, 0.4); /*#2b292f;*/
+}
+
 sq_button.action {
     font-size: 0.75em;
 }
@@ -56,3 +61,5 @@ sq_button.small {
     background: mix(@theme_selected_bg_color, @theme_bg_color, 0.4); /*#1c71d8;*/
     border-color: @borders; /*#3584e4;*/
 }
+
+@import url("resource:///sm/puri/squeekboard/common.css");

debian/changelog

@@ -1,3 +1,325 @@
+squeekboard (1.16.0-1) experimental; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * build: Remove regex crate
+  * ci: Use bookworm image
+  * build: Pin transitive dependencies
+  * cargo: Update Cargo.lock with pinned dependencies
+  * CI: Use byzantium as the base
+  * cargo: Bump dependencies
+
+  [ Guido Günther ]
+  * po: Fix ui file name
+  * entry: Mark as executable
+  * entry: Only activate purpose timer when focused
+  * entry: Add another input hint
+  * Add entry test using GTK4
+
+  [ Rafael Fontenelle ]
+  * Add Brazilian Portuguese translation
+
+  [ Yuri Chornoivan ]
+  * Add Ukrainian translation
+
+  [ Luna Jernberg ]
+  * Add Swedish Translation
+  * Update sv.po
+  * Update LINGUAS
+
+  [ Fabio Tomat ]
+  * Add Friulian translation
+
+  [ Daniel Șerbănescu ]
+  * Add Romanian translation
+
+  [ Matej Urbančič ]
+  * Add Slovenian translation
+
+  [ Nathan Follens ]
+  * Add Dutch translation
+
+  [ Jiri Grönroos ]
+  * Add Finnish translation
+
+  [ Danial Behzadi ]
+  * Add Persian translation
+
+  [ Jordi Mas i Hernandez ]
+  * Add Catalan translation
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Tue, 25 Jan 2022 11:24:04 +0000
+
+squeekboard (1.15.0-1) experimental; urgency=medium
+
+  [ Khaled Eldoheiri ]
+  * Introduce Arabic keyboard layout
+
+  [ Dorota Czaplejewicz ]
+  * Docs: Release procedure
+  * build: Fix "any" dependency versioning
+  * readme: Mention the layout guide
+  * dbus: Hint that maybe squeekboard is running
+  * readme: Change self-reference to repo to gnome
+  * docs: Move env vars section to debugging
+  * readme: Clarify basic running steps
+  * readme: Put emphasis on being an input method
+  * readme: Update features
+  * ci: Use cached artifacts in the test
+  * ci: Move release test to the start
+  * ci: Start lintian test right after deb build
+  * ci: Add git revision and CI pipeline number to .deb artifacts
+  * ci: Use bookworm image
+  * ci: Reformat yaml file
+  * ci: Include pre-build style check
+  * popover: Fix reentrancy problem
+  * submission: Wrap the structure in a safe wrapper
+  * util: Add ArcWrapped
+  * animation: Prototype a way of handling state and applying it separately
+  * state: Connect the animation state machine to the rest
+  * event_loop: Separate and use for physical keyboard presence
+  * Revert "util: Add ArcWrapped"
+  * Revert "ci: Use bookworm image"
+  * ci: Fix formatting
+  * ci: Make indentation close to original again
+  * cargo: version bump
+
+  [ Jordi ]
+  * Introduce Swiss French keyboard layout
+  * improve accents layout behavior and code cleaning
+
+  [ Plamen Stoev ]
+  * Rename bg to bg+phonetic
+  * Add 'bg' layout
+  * Translate more layout names in Bulgarian
+
+  [ William Wold ]
+  * Show error when Layer Shell is not supported
+  * Update entry.py file path in readme
+  * Update zwp_text_input_v3 (comment changes only)
+  * Update zwp_input_method_v2
+
+  [ Patrick Jörg ]
+  * Introduce Swiss German keyboard layout
+  * Introducing ch+de layout and modified ch.yaml fallback
+  * Added ch_wide
+
+  [ ZenWalker ]
+  * layersurface: avoid duplicate assignment
+
+  [ T. Zack Crawford ]
+  * Update tutorial.md to clarify steps in creating a custom layout
+
+  [ Guido Günther ]
+  * gitlab-ci: Adjust CI tags
+  * gitlab-ci: Drop build for outdated distributions
+  * data: Fix build with meson 0.60.0
+  * main: Remove trailing whitespace
+  * main: Honor --help and -h
+  * eek-renderer: Add log domain
+  * eek-renderer: Fix indentation
+  * eek-renderer: Honor theme changes (Closes: #296)
+  * main: Drop broken support G_BUS_TYPE_SYSTEM
+  * main: Avoid two error variables in the same function
+  * main: Use dark theme when run in a Phosh session (Closes: #242)
+  * gtk-keyboard: Don't set variable to NULL twice in a row
+  * renderer: Use `g_debug ()`
+  * main: Add debug flag to always show squeekboard on start
+  * renderer: Disconnect theme change signal handler
+  * main: Add debug flag to show GTK inspector
+  * README: Document SQUEEKBOARD_DEBUG environment variable
+  * Move style-check to separate script
+  * Honor input-purpose PIN
+  * entry: Use a scrolled window
+  * entry: Set a margin on the grids
+  * entry: Add a random text entry field
+  * imservice: Invoke eekboard_context_service_set_hint_purpose unconditionally
+    (Closes: #311)
+  * langs: Don't use empty translation file (Closes: #313)
+  * Initialize gettext
+  * Reuse the unused popover ui file for i18n (Closes: #315)
+  * po: Add German translation
+  * gresources: Drop popup.ui
+  * Revert "gresources: Drop popup.ui"
+  * gitlab-ci: Add PKG_ONLY
+  * layout: Drop trailing whitespace
+  * Use special pin keyboard
+  * layout: Keep content purpose around
+  * renderer: Set style class based on input purpose
+  * pin: Use less margin
+  * debian: Install translations
+  * debian: Switch to dh 13
+  * debian: Install desktop file
+  * eekboard-context-service: Don't translate property names
+  * server-context-servide: Don't translate application name
+  * data: Make generic name truly generic
+  * po: Add desktop file to translatable files
+  * Add URL and EMail keyboard variants for us (Closes: #65)
+  * gitignore: Drop zanata dir
+  * gitignore: Ignore generated po files
+  * popover: Move Emoji and Terminal to ui file
+  * popover: Add translator notes
+  * popover: Make the ui file match the code file name
+  * Remove emoji and terminal from translations
+  * popover: Don't complain about missing translations
+  * Drop custom translation handling
+  * Drop locale_config
+  * Remove custom translations
+
+  [ PhilProg ]
+  * Add documentation about compositors
+
+  [ Norayr Chilingarian ]
+  * armenian typewriter and phonetic keyboards.
+  * armenian layout also added to meson.build etc.
+
+  [ Arnaud Ferraris ]
+  * resources: add wide FR terminal keyboard
+
+  [ Sebastian Krzyszkowiak ]
+  * renderer: Take context scale into account when drawing icons (Closes: #139)
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Sun, 19 Dec 2021 14:11:06 +0000
+
+squeekboard (1.14.0pureos0~amber0) amber-phone; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * data: Split into loading and parsing
+  * layout: Remove unused code
+  * build: Fix unnecessary shell quotes
+  * popover: Allow spanning outside panel area
+  * cargo: Update dependencies before release
+
+  [ undef ]
+  * Fix typos jp keyboard comments
+
+  [ anteater ]
+  * use the correct GtkStyleProviderPriority to indicate that the styles are provided by the application
+  * remove some unnecessary unsafe code
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Sat, 15 May 2021 12:45:20 +0000
+
+squeekboard (1.13.0pureos0~amber0) amber-phone; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * layout: Latch keys when clicked twice
+  * layout: Add stateless view switching
+  * layout: Plug in stateless view switching
+  * layout: Remove the little abomination of view change promise
+  * view: Ąto-unlatching when multiple latching buttons pressed
+  * renderer: Bring button drawing closer to Rust
+  * ffi: Eliminate squeek_button and squeek_row
+  * imservice: Increment serials on receiving done, not sending commit
+  * input-method: Fix commit/done mixup in protocol text
+  * CI: fix xheck_tag to be compatible with Amber
+  * italian: Fix colon
+  * popover: Fix prematurely deallocated CString
+  * Rust: Remove unnecessary no_mangle statements to silence warnings
+  * renderer: Reduce reliance on knowing the transform
+  * renderer: Split mutable geometry and place it directly in GtkKeyboard
+  * Revert "moved data/langs/he_IL.txt -> data/langs/he-IL.txt to better conform with existing translations."
+  * layout: Make it possible to opt out of latching per-key
+  * renderer: Mark latched buttons differently than locked
+  * appearance: Colour latched/locked according to design
+  * docs: Describe view switching
+  * language-terminal: Place keyboards in a sub-path
+  * layout selection: Fix emoji and number
+  * rust: Fix compiler warnings
+  * layout: Take into account text purpose again
+  * layouts: Make selection testable
+  * layouts: Stop assuming that layout name always changes on switch
+  * Cargo: Version bump
+
+  [ J.D. Laub ]
+  * Add US Dvorak layout (and Colemak wide)
+  *     Add US Dvorak layout (and Colemak wide)
+
+  [ Jordi Masip ]
+  * Catalan keyboard layout
+
+  [ Myth ]
+  * Added hebrew keyboard layout
+
+  [ David96 ]
+  * Add Mod4 (Windows) key
+
+  [ Panawat Wong-klaew ]
+  * Add wide Thai keyboard layout
+
+  [ Guido Günther ]
+  * server-main: Add quit()
+  * server-main: Properly register to gnome-session (Closes: #274)
+
+  [ Kozova1 ]
+  * Added Hebrew translations for most layouts.
+  * moved data/langs/he_IL.txt -> data/langs/he-IL.txt to better conform with existing translations.
+  * Fixed Hebrew layout.
+  * moved data/langs/he_IL.txt -> data/langs/he-IL.txt to better conform with existing translations.
+
+  [ M33 ]
+  * Revert "Update tests/meson.build"
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Mon, 12 Apr 2021 10:40:32 +0000
+
+squeekboard (1.12.0pureos0~amber0) amber-phone; urgency=medium
+
+  [ Dorota Czaplejewicz ]
+  * docs: Correct Cargo update instructions
+  * visibility: Centralize keyboard panel visibility policy and handling
+  * build: Fix release
+  * tests: Prefer the env var for finding test layouts
+  * tests: Explicitly pass source directory to tests
+  * debian: Build reproducibly
+  * tests: Allow legacy mode to have much longer tests.
+  * build: Enable unused warnings in C
+  * build: Enable wformat to remove warnings about missing wformat
+  * build: Fail on any C warnings when strict
+  * data: Made data flow in fallback clearer
+  * data: Flattened layout fallback function
+  * layouts: Use base as fallback for alternative layouts
+  * layouts: Simplify the main flow of source list
+  * tests: Add some description to the list of tested layouts
+  * layout_names: Unmess the list of builtin layouts
+  * dbus: Reset hints if text input missing
+  * visibility: Stop calling GTK functions from the visibility manager
+
+  [ Wannaphong Phatthiyaphaibun ]
+  * Add thai keyboard
+  * Update resources.rs
+  * Update meson.build
+  * escape " on thai keyboard
+
+  [ clonex10100 ]
+  * Added US Colemak Keyboard Layout
+
+  [ Henry-Nicolas Tourneur ]
+  * d/rules: fix an FTBFS on mips64el with GOT > 64kb
+  * d/rules: export RUSTFLAGS only on architecture that needs it
+  * d/rules: export RUSTFLAGS only on architecture that needs it
+
+  [ Jiří Stránský ]
+  * Add Czech keyboard layouts
+
+  [ Stefan Grotz ]
+  * Esperanto keyboard
+
+  [ Vladimir ]
+  * Bulgarian language keyboard layout
+
+  [ Vladimir Stoilov ]
+  * bulgarian add translation and to needed lists
+  * Fix bulgarian layout size
+
+  [ Andreas Rönnquist ]
+  * no: Use wide button switching between numbers, symbols and base
+
+  [ jranaraki ]
+  * Farsi/Persian keyboard layout
+  * Farsi/Persian keyboard layout
+  * Added requirements to resources.rs and meson.build
+  * Updated the layout to provide more convenient and faster typing experience
+
+ -- Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>  Sun, 10 Jan 2021 09:43:42 +0000
+
 squeekboard (1.11.1) amber-phone; urgency=medium
 
   [ Mark Müller ]

debian/check_release.py

@@ -5,6 +5,7 @@ Feed it the first changelog line, and then all available tags.
 """
 
 import re, sys
-tag = "v" + re.findall("\\((.*)\\)", input())[0]
+version = re.findall("\\((.*)\\)", input())[0]
+tag = 'v' + re.findall("([0-9]+\\.[0-9]+\\.[0-9]+).*", version)[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/compat

@@ -1 +0,0 @@
-10

debian/control

@@ -4,7 +4,7 @@ Priority: optional
 Maintainer: Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
 Build-Depends:
  cargo,
- debhelper (>= 10),
+ debhelper-compat (= 13),
  meson (>=0.51.0),
  ninja-build,
  pkg-config,
@@ -20,13 +20,13 @@ Build-Depends:
  librust-gtk+v3-22-dev (>= 0.5),
  librust-gtk-sys-dev,
  librust-maplit-1-dev (>= 1.0),
- librust-regex-1-dev (>= 1.1),
  librust-serde-derive-1-dev (>= 1.0),
  librust-serde-yaml-0.8-dev (>= 0.8),
  librust-xkbcommon-0.4+wayland-dev (>= 0.4),
  libwayland-dev (>= 1.16),
  lsb-release,
  python3,
+ python3-ruamel.yaml,
  rustc,
  wayland-protocols (>= 1.14),
 Standards-Version: 4.1.3

debian/squeekboard.install

@@ -1,2 +1,4 @@
 tools/squeekboard-restyled usr/bin
 usr/bin/squeekboard /usr/bin
+usr/share/applications/
+usr/share/locale/

doc/hacking.md

@@ -90,6 +90,15 @@ Layouts can be selected using the GNOME Settings application.
 $ gsettings set org.gnome.desktop.input-sources sources "[('xkb', 'us'), ('xkb', 'de')]"
 ```
 
+### Environment Variables
+
+Besides the environment variables supported by GTK and [GLib](https://docs.gtk.org/glib/running.html) applications
+squeekboard honors the `SQUEEKBOARD_DEBUG` environment variable which can
+contain a comma separated list of:
+
+- `force-show` : Show squeekboard on startup independent of any gsettings or compositor requests
+- `gtk-inspector`: Spawn [gtk-inspector](https://wiki.gnome.org/Projects/GTK/Inspector)
+
 Coding
 ------
 
@@ -111,6 +120,16 @@ User interface modules should:
 
 ### Style
 
+Note that some portions, like the .gitlab-ci.yml file have accummulated enough style/whitespace conflicts that an enforced style checker is now applied.
+
+To fix your contributions before submitting a change, use:
+
+```
+./tools/style-check_source --apply
+```
+
+* * *
+
 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 ([SCI CERT C: EXP19-C](https://wiki.sei.cmu.edu/confluence/display/c/EXP19-C.+Use+braces+for+the+body+of+an+if%2C+for%2C+or+while+statement))
@@ -175,14 +194,73 @@ All Cargo dependencies must be selected in the version available in PureOS, and
 
 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 must correspond to the default dependency configuration: without flags to use older or newer versions of dependencies. It should be updated often, preferably with each bugfix revision, and in a commit on its own:
+Releases
+----------
+
+Squeekboard should get a new release every time something interesting comes in. Preferably when there are no known bugs too. People will rely on theose releases, after all.
+
+### 1. Update `Cargo.toml`.
+
+While the file is not actually used, it's a good idea to save the config in case some rare bug appears in dependencies.
 
 ```
-cd build_dir
+cd squeekboard-build
-ninja ./Cargo.toml
-sh /source_path/cargo.sh update
 ninja test
-cp ./Cargo.lock /source_path/
+cp ./Cargo.lock .../squeekboard-source
 ```
 
-Since version 1.9.3, `Cargo.lock` is not actually used by the build system, due to `Cargo.toml` being generated at every build.
+Then commit the updated `Cargo.lock`.
+
+### 2. Choose the version number
+
+Squeekboard tries to use semantic versioning. It's 3 numbers separated by dots: "a.b.c". Releases which only fix bugs and nothing else are "a.b.c+1". Releases which add user-visible features in addition to bug fixes are "a.b+1.0". Releases which, in addition to the previous, change *the user contract* in incompatible ways are "a+1.0.0". "The user contract" means plugin APIs that are deemed stable, or the way language switching works, etc. In other words, incompatible changes to developers, or big changes to users bump "a" to the next natural number.
+
+### 3. Update the number in `meson.build`
+
+It's in the `project(version: xxx)` statement.
+
+### 4. Update packaging
+
+Packaging is in the `debian/` directory, and creates builds that can be quickly tested.
+
+```
+cd squeekboard-source
+gbp dch --multimaint-merge  --ignore-branch
+```
+
+Inspect `debian/changelog`, and make sure the first line contains the correct version number and suite. For example:
+
+```
+squeekboard (1.13.0pureos0~amber0) amber-phone; urgency=medium
+```
+
+Commit the updated `debian/changelog`. The commit message should contain the release version and a description of changes.
+
+> Release 1.13.0 "Externality"
+>
+> Changes:
+>
+> - A system for latching and locking views
+> ...
+
+### 5. Create a signed tag for downstreams
+
+The tag should be the version number with "v" in front of it. The tag message should be "squeekboard" and the tag name. Push it to the upstream repository:
+
+```
+git tag -s -u my_address@example.com v1.13.0 -m "squeekboard v1.13.0"
+git push v1.13.0
+```
+
+### 5. Create a signed tag for packaging
+
+Similar to the above, but format it for the PureOS downstream.
+
+```
+git tag -s -u my_address@example.com 'pureos/1.13.0pureos0_amber0' -m 'squeekboard 1.13.0pureos0_amber0'
+git push 'pureos/1.13.0pureos0_amber0'
+```
+
+### 6. Rejoice
+
+You released a new version of Squeekboard, and made it available on PureOS. Congratulations.

doc/index.md

@@ -6,6 +6,7 @@ Contents
 
 * [Tutorial](tutorial.md)
 * [Contributing](hacking.md)
+* [Switching views](views.md)
 
 Introduction
 ------------
@@ -21,6 +22,8 @@ Layouts are created using a text-based format, based on YAML.
 
 TODO: Provide a description of the format.
 
+Squeekboard layouts are separated into *views* and use a *room metaphor* to [switch views](views.md).
+
 Contributions
 -------------
 

doc/latching.svg

@@ -0,0 +1,594 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="177.92439mm"
+   height="88.144363mm"
+   viewBox="0 0 177.92439 88.144364"
+   version="1.1"
+   id="svg8"
+   sodipodi:docname="latching.svg"
+   inkscape:version="1.0.1 (3bc2e813f5, 2020-09-07)">
+  <defs
+     id="defs2">
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Mend"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Mend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.4,0,0,-0.4,-4,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1098" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow2Sstart"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow2Sstart"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(0.3,0,0,0.3,-0.69,0)"
+         d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+         id="path1119" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow2Mstart"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow2Mstart"
+       inkscape:isstock="true">
+      <path
+         transform="scale(0.6)"
+         d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+         id="path1113" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-5" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect848" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect848-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-9" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect848-8" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect916" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-4" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect951" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect986" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect1061" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-5"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#00ad12;fill-opacity:1;fill-rule:evenodd;stroke:#00ad12;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-7" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect1549" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-8"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#101010;fill-opacity:1;fill-rule:evenodd;stroke:#101010;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-8" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-3" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect1845" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-38" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect1960" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-3-9" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect2304" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-3-4" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect2304-7" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-2"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#6c6c6c;fill-opacity:1;fill-rule:evenodd;stroke:#6c6c6c;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-89" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-2-6"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#00ad12;fill-opacity:1;fill-rule:evenodd;stroke:#00ad12;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-89-8" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-21" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect2574" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-2-6-1"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#00ad12;fill-opacity:1;fill-rule:evenodd;stroke:#00ad12;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-89-8-0" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-2-6-6"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#00ad12;fill-opacity:1;fill-rule:evenodd;stroke:#00ad12;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-89-8-2" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10-1-8" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect3021" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-8-3"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#101010;fill-opacity:1;fill-rule:evenodd;stroke:#101010;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-8-5" />
+    </marker>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="1.3358025"
+     inkscape:cx="212.63846"
+     inkscape:cy="105.21093"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     inkscape:document-rotation="0"
+     showgrid="false"
+     fit-margin-top="4"
+     fit-margin-left="4"
+     fit-margin-right="4"
+     fit-margin-bottom="4"
+     lock-margins="true"
+     inkscape:window-width="1298"
+     inkscape:window-height="708"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title />
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-72.097892,-53.326191)">
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#101010;stroke-width:0.264999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow1Lend-8-3)"
+       d="m 134.9616,86.141869 c 17.5759,-11.622767 35.93283,0 35.93283,0"
+       id="path1087-1-6" />
+    <g
+       id="g2948">
+      <circle
+         style="color:#000000;overflow:visible;fill:#ffffff;stroke:#000000;stroke-width:0.499999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="path1065-6"
+         cx="129.67093"
+         cy="92.793152"
+         r="7.8844509" />
+      <text
+         xml:space="preserve"
+         id="text833-0"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-10);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(46.071199,-1.2662626)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>A</tspan></tspan></text>
+    </g>
+    <rect
+       style="color:#000000;overflow:visible;fill:#f8f8f8;fill-opacity:1;stroke:#000000;stroke-width:0.555679;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+       id="rect2066"
+       width="1.4562259"
+       height="10.90563"
+       x="81.767418"
+       y="75.519585"
+       ry="0.9693895" />
+    <g
+       id="g905"
+       transform="translate(0,-0.85044703)">
+      <circle
+         style="color:#000000;overflow:visible;fill:#ffffff;stroke:#000000;stroke-width:0.499999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="path1065"
+         cx="83.154755"
+         cy="93.6436"
+         r="7.8844509" />
+      <text
+         xml:space="preserve"
+         id="text833"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan
+             style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none">a</tspan></tspan></text>
+    </g>
+    <g
+       id="g905-3-7"
+       transform="translate(92.82116,-0.85044861)">
+      <circle
+         style="color:#000000;overflow:visible;fill:#ffffff;stroke:#000000;stroke-width:0.499999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="path1065-6-7"
+         cx="83.557831"
+         cy="93.6436"
+         r="7.8844509" />
+      <text
+         xml:space="preserve"
+         id="text833-0-5"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-10-1);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>Ą</tspan></tspan></text>
+    </g>
+    <g
+       id="g905-1"
+       transform="translate(68.838914,-17.67039)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#e2e2e2;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-8"
+         width="10.583333"
+         height="13.79613"
+         x="78.878532"
+         y="85.920006"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-7"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-2);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.2686286,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan> ̨̂ ̈</tspan></tspan></text>
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#101010;stroke-width:0.264999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow1Lend-8)"
+       d="m 88.446425,85.89509 c 17.575895,-11.622767 35.932835,0 35.932835,0"
+       id="path1087-1" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:monospace;-inkscape-font-specification:monospace;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="99.186691"
+       y="66.221436"
+       id="text1035-89"><tspan
+         sodipodi:role="line"
+         id="tspan1033-6"
+         x="99.186691"
+         y="66.221436"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">locking</tspan></text>
+    <g
+       id="g905-1-4"
+       transform="translate(22.423434,-17.67039)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#e2e2e2;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-8-3"
+         width="10.583333"
+         height="13.79613"
+         x="78.878532"
+         y="85.920006"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-7-3"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-2-3);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>⇧</tspan></tspan></text>
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.5, 0.5;stroke-dashoffset:0;stroke-opacity:1"
+       d="m 83.251484,76.550079 c -0.31498,0 -0.944941,-0.314981 -0.944941,0 0,0.31498 0.770221,0.262079 0.944941,0 0.212555,-0.318834 0.08197,-0.862973 -0.188988,-1.133929 -0.132651,-0.13265 -1.931144,0.354037 -2.078869,0.944941 -0.108038,0.432149 0.877467,-0.188989 1.322916,-0.188989 0.339244,0 0.626121,0.262042 0.944941,0.377977 0.374434,0.136158 0.777569,0.199796 1.133928,0.377976 0.113894,0.05695 -0.0037,0.439732 0.944941,0.755952 0.544156,0.181385 1.78847,0.275251 2.267857,0.377976 0.448438,0.09609 0.881944,0.251984 1.322917,0.377977 0.063,0.188988 0.388199,0.566964 0.188988,0.566964 -0.195153,0 -0.745291,-0.93961 0,-0.566964 0.281726,0.140863 0.485859,0.404908 0.755952,0.566964 1.460327,0.876196 3.039871,1.714659 4.346726,2.834821 0.966187,0.828161 1.495207,2.006597 2.645833,2.645834 2.876101,1.597834 5.000414,0.287454 7.370534,1.133929 0.4783,0.170821 0.85136,0.567325 1.32292,0.755952 1.8557,0.74228 0.94424,0.230907 2.26785,0.377976 1.47287,0.16365 2.67387,1.06159 4.15774,0.566965 1.22233,-0.407443 3.2674,-1.377519 4.15774,-2.267858 0.39842,-0.398422 0.42845,-1.053404 0.75595,-1.511905 0.50136,-0.70189 1.27041,-1.107171 1.7009,-1.889881 2.28615,-4.156632 0.41931,-1.931216 3.2128,-4.724702 0.18898,-0.188988 0.33491,-0.434362 0.56696,-0.566964 0.864,-0.493714 5.11938,-0.281812 6.04762,-0.188989 0.34449,0.03445 3.71968,0.978261 3.96875,1.133929 0.35339,0.220868 1.41179,1.650838 1.88988,1.889881 0.80324,0.40162 2.22057,0.354332 3.02381,0.755952 1.24832,0.624162 -0.45041,0.669376 -0.18899,1.322917 0.1193,0.298244 0.64418,0.0762 0.94494,0.188988 0.28702,0.107634 1.48279,1.113549 1.5119,1.133929 2.56034,1.792236 -0.96522,-0.855663 2.26786,1.133928 1.61516,0.993946 2.82802,2.547938 4.53572,3.401785 2.03418,1.017093 4.38487,-0.122885 6.42559,-0.377975 1.6791,-0.209886 3.23813,0.06137 4.91369,-0.566965 0.50424,-0.18909 1.82709,-1.701063 2.26786,-2.078869 0.45926,-0.393653 1.0853,-0.707329 1.5119,-1.133928 0.81561,-0.815609 1.44764,-1.826091 2.45685,-2.456845 0.28768,-0.179799 0.65726,-0.198178 0.94494,-0.377977 0.28791,-0.179945 0.60349,-0.774216 0.94494,-0.94494 0.23232,-0.116159 0.51479,-0.09252 0.75595,-0.188988 0.21089,-0.08436 0.33983,-0.377976 0.56697,-0.377976 0.14086,0 0.23711,0.188988 0.37797,0.188988 0.0891,0 0.126,-0.125992 0.18899,-0.188988 0.18899,-0.063 0.36976,-0.217161 0.56696,-0.188988 0.77174,0.110248 1.92711,0.94494 3.02381,0.94494 0.16785,0 0.94189,-0.862638 1.13393,-0.94494 0.19546,-0.08377 1.57981,-0.364523 1.7009,-0.377977 0.72233,-0.08026 2.11645,0.340388 2.64583,-0.188988"
+       id="path2010" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;line-height:125%;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="73.802078"
+       y="72.354546"
+       id="text2091"><tspan
+         sodipodi:role="line"
+         id="tspan2089"
+         x="73.802078"
+         y="72.354546"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">SAVED</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;line-height:125%;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="164.55956"
+       y="72.354546"
+       id="text2091-8"><tspan
+         sodipodi:role="line"
+         id="tspan2089-8"
+         x="164.55956"
+         y="72.354546"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">CURRENT</tspan><tspan
+         sodipodi:role="line"
+         x="164.55956"
+         y="79.410095"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         id="tspan3432" /></text>
+    <g
+       id="g2259"
+       transform="matrix(1.0856157,0,0,0.94777147,-19.677062,6.4360598)">
+      <path
+         id="rect2111-9"
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.499999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 179.53502,72.72924 h 5.84717 l -1.37074,1.931346 h -3.04292 z"
+         sodipodi:nodetypes="ccccc" />
+      <path
+         id="rect2111-9-0"
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.499999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 179.4049,80.846668 h 5.84717 l -1.23711,-1.931347 h -3.17655 z"
+         sodipodi:nodetypes="ccccc" />
+      <g
+         id="g2247"
+         transform="translate(-0.04032786,-0.04319387)">
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,75.343053 2.96688,-0.19452"
+           id="path2145"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,76.112065 2.96688,-0.19452"
+           id="path2145-3"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,76.881078 2.96688,-0.19452"
+           id="path2145-0"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,77.65009 2.96688,-0.19452"
+           id="path2145-2"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,78.419102 2.96688,-0.19452"
+           id="path2145-4"
+           sodipodi:nodetypes="cc" />
+      </g>
+    </g>
+    <g
+       id="g905-0"
+       transform="translate(157.32586,-0.83970203)" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:monospace;-inkscape-font-specification:monospace;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="145.70187"
+       y="66.221436"
+       id="text1035-89-2"><tspan
+         sodipodi:role="line"
+         id="tspan1033-6-9"
+         x="145.70187"
+         y="66.221436"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">locking</tspan></text>
+  </g>
+</svg>

doc/latching_return.svg

@@ -0,0 +1,631 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="169.9455mm"
+   height="98.072433mm"
+   viewBox="0 0 169.94549 98.072434"
+   version="1.1"
+   id="svg8"
+   sodipodi:docname="latching_return.svg"
+   inkscape:version="1.0.1 (3bc2e813f5, 2020-09-07)">
+  <defs
+     id="defs2">
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10-1" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-5"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-7" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-38" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-3-9" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-3-4" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-2-6"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-89-8" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-21" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-2-6-1"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-89-8-0" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-2-6-6"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-89-8-2" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10-1-8" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-12" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10-7" />
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.94455498"
+     inkscape:cx="314.8465"
+     inkscape:cy="213.42055"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     inkscape:document-rotation="0"
+     showgrid="false"
+     fit-margin-top="4"
+     fit-margin-left="4"
+     fit-margin-right="4"
+     fit-margin-bottom="4"
+     lock-margins="true"
+     inkscape:window-width="1298"
+     inkscape:window-height="708"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1"
+     showguides="false" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-70.551731,-46.47634)">
+    <g
+       id="g3858"
+       transform="translate(1.354821,1.4005714)">
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="204.75821"
+         y="130.07979"
+         id="text2293-4"><tspan
+           sodipodi:role="line"
+           id="tspan2291-1"
+           x="204.75821"
+           y="130.07979"
+           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">✄</tspan></text>
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.5861px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="194.54915"
+         y="128.70164"
+         id="text2293-0-5-8"><tspan
+           sodipodi:role="line"
+           id="tspan2291-6-7-5"
+           x="194.54915"
+           y="128.70164"
+           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.5861px;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">cuts</tspan></text>
+      <path
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.05833, 0.529167;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 210.34971,123.9389 c 0.0233,0.14006 0.07,0.27818 0.07,0.42017 0,0.0738 -0.07,0.13627 -0.07,0.21009 0,0.11902 0.0582,0.23171 0.07,0.35014 0.049,0.49035 0.0857,0.98109 0.14006,1.4706 0.018,0.1624 -0.0269,0.32902 0,0.4902 0.0435,0.26077 0.11166,0.3369 0,0.56023 -0.0209,0.0418 0.033,0.10705 0,0.14006 -0.0369,0.0369 -0.10315,0.0331 -0.14006,0.07"
+         id="path3816-9" />
+      <path
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.05833, 0.529167;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 209.9819,128.43627 c -0.12445,0.48957 -0.1295,0.98859 -0.0743,1.48553 0.0118,0.10583 0.01,0.21643 0.0248,0.32186 -0.002,0.0627 0.0396,0.11405 0.0495,0.17332 0.0144,0.0866 -0.0193,0.077 0,0.17331 0.0124,0.0621 0.20619,0.18971 0.24759,0.22283"
+         id="path3820-7" />
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.3;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Lend-2-6-1)"
+       d="m 180.7405,85.345284 c 21.77006,-11.52723 44.50758,0 44.50758,0"
+       id="path1087-3-0-8" />
+    <rect
+       style="color:#000000;overflow:visible;fill:#f8f8f8;fill-opacity:1;stroke:#000000;stroke-width:0.555679;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+       id="rect2066"
+       width="1.4562259"
+       height="10.90563"
+       x="81.767418"
+       y="75.519585"
+       ry="0.9693895" />
+    <g
+       id="g905-3-7"
+       transform="translate(92.629263,-0.8504468)">
+      <text
+         xml:space="preserve"
+         id="text833-0-5"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-10-1);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>Ą</tspan></tspan></text>
+      <rect
+         style="color:#000000;overflow:visible;fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-4-9"
+         width="10.583333"
+         height="13.79613"
+         x="78.266167"
+         y="86.745537"
+         ry="1.937705" />
+    </g>
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:0.4em;font-family:monospace;-inkscape-font-specification:monospace;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="174.86499"
+       y="130.79413"
+       id="text1035-8"><tspan
+         sodipodi:role="line"
+         x="174.86499"
+         y="130.79413"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;text-align:center;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         id="tspan2277">locking</tspan><tspan
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;text-align:center;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         sodipodi:role="line"
+         x="174.86499"
+         y="135.11462"
+         id="tspan1606" /></text>
+    <g
+       id="g905-1-6"
+       transform="translate(90.668095,26.90725)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-8-0"
+         width="10.583333"
+         height="13.79613"
+         x="78.878532"
+         y="85.920006"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-7-4"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-2-38);fill:#f8f8f8;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.2686286,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan
+             style="fill:#f8f8f8;fill-opacity:1"> ̨̂ ̈</tspan></tspan></text>
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.5, 0.5;stroke-dashoffset:0;stroke-opacity:1"
+       d="m 83.251484,76.550079 c -0.31498,0 -0.944941,-0.314981 -0.944941,0 0,0.31498 0.770221,0.262079 0.944941,0 0.212555,-0.318834 0.08197,-0.862973 -0.188988,-1.133929 -0.132651,-0.13265 -1.931144,0.354037 -2.078869,0.944941 -0.108038,0.432149 0.877467,-0.188989 1.322916,-0.188989 0.339244,0 0.626121,0.262042 0.944941,0.377977 0.374434,0.136158 0.777569,0.199796 1.133928,0.377976 0.113894,0.05695 -0.0037,0.439732 0.944941,0.755952 0.544156,0.181385 1.78847,0.275251 2.267857,0.377976 0.448438,0.09609 0.881944,0.251984 1.322917,0.377977 0.063,0.188988 0.388199,0.566964 0.188988,0.566964 -0.195153,0 -0.745291,-0.93961 0,-0.566964 0.281726,0.140863 0.485859,0.404908 0.755952,0.566964 1.460327,0.876196 3.039871,1.714659 4.346726,2.834821 0.966187,0.828161 1.495207,2.006597 2.645833,2.645834 2.876101,1.597834 5.000414,0.287454 7.370534,1.133929 0.4783,0.170821 0.85136,0.567325 1.32292,0.755952 1.8557,0.74228 0.94424,0.230907 2.26785,0.377976 1.47287,0.16365 2.67387,1.06159 4.15774,0.566965 1.22233,-0.407443 3.2674,-1.377519 4.15774,-2.267858 0.39842,-0.398422 0.42845,-1.053404 0.75595,-1.511905 0.50136,-0.70189 1.27041,-1.107171 1.7009,-1.889881 2.28615,-4.156632 0.41931,-1.931216 3.2128,-4.724702 0.18898,-0.188988 0.33491,-0.434362 0.56696,-0.566964 0.864,-0.493714 5.11938,-0.281812 6.04762,-0.188989 0.34449,0.03445 3.71968,0.978261 3.96875,1.133929 0.35339,0.220868 1.41179,1.650838 1.88988,1.889881 0.80324,0.40162 2.22057,0.354332 3.02381,0.755952 1.24832,0.624162 -0.45041,0.669376 -0.18899,1.322917 0.1193,0.298244 0.64418,0.0762 0.94494,0.188988 0.28702,0.107634 1.48279,1.113549 1.5119,1.133929 2.56034,1.792236 -0.96522,-0.855663 2.26786,1.133928 1.61516,0.993946 2.82802,2.547938 4.53572,3.401785 2.03418,1.017093 4.38487,-0.122885 6.42559,-0.377975 1.6791,-0.209886 3.23813,0.06137 4.91369,-0.566965 0.50424,-0.18909 1.82709,-1.701063 2.26786,-2.078869 0.45926,-0.393653 1.0853,-0.707329 1.5119,-1.133928 0.81561,-0.815609 1.44764,-1.826091 2.45685,-2.456845 0.28768,-0.179799 0.65726,-0.198178 0.94494,-0.377977 0.28791,-0.179945 0.60349,-0.774216 0.94494,-0.94494 0.23232,-0.116159 0.51479,-0.09252 0.75595,-0.188988 0.21089,-0.08436 0.33983,-0.377976 0.56697,-0.377976 0.14086,0 0.23711,0.188988 0.37797,0.188988 0.0891,0 0.126,-0.125992 0.18899,-0.188988 0.18899,-0.063 0.36976,-0.217161 0.56696,-0.188988 0.77174,0.110248 1.92711,0.94494 3.02381,0.94494 0.16785,0 0.94189,-0.862638 1.13393,-0.94494 0.19546,-0.08377 1.57981,-0.364523 1.7009,-0.377977 0.72233,-0.08026 2.11645,0.340388 2.64583,-0.188988"
+       id="path2010" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;line-height:125%;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="74.331245"
+       y="71.825378"
+       id="text2091"><tspan
+         sodipodi:role="line"
+         id="tspan2089"
+         x="74.331245"
+         y="71.825378"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">SAVED</tspan></text>
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;line-height:125%;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="164.23172"
+       y="70.186089"
+       id="text2091-8"><tspan
+         sodipodi:role="line"
+         id="tspan2089-8"
+         x="164.23172"
+         y="70.186089"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">CURRENT</tspan><tspan
+         sodipodi:role="line"
+         x="164.23172"
+         y="77.241638"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:5.64444px;font-family:'Abyssinica SIL';-inkscape-font-specification:'Abyssinica SIL';fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         id="tspan3432" /></text>
+    <g
+       id="g2259"
+       transform="matrix(1.0856157,0,0,0.94777147,-20.206229,4.319393)">
+      <path
+         id="rect2111-9"
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.499999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 179.53502,72.72924 h 5.84717 l -1.37074,1.931346 h -3.04292 z"
+         sodipodi:nodetypes="ccccc" />
+      <path
+         id="rect2111-9-0"
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.499999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 179.4049,80.846668 h 5.84717 l -1.23711,-1.931347 h -3.17655 z"
+         sodipodi:nodetypes="ccccc" />
+      <g
+         id="g2247"
+         transform="translate(-0.04032786,-0.04319387)">
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,75.343053 2.96688,-0.19452"
+           id="path2145"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,76.112065 2.96688,-0.19452"
+           id="path2145-3"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,76.881078 2.96688,-0.19452"
+           id="path2145-0"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,77.65009 2.96688,-0.19452"
+           id="path2145-2"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,78.419102 2.96688,-0.19452"
+           id="path2145-4"
+           sodipodi:nodetypes="cc" />
+      </g>
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.3;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Lend-5)"
+       d="m 173.01207,99.691217 c 0,0 -8.37295,13.367043 -0.26038,13.813423 9.36786,0.51544 7.89797,-9.16673 6.50059,-13.41252"
+       id="path2269"
+       sodipodi:nodetypes="csc" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="176.93353"
+       y="138.21815"
+       id="text2293"><tspan
+         sodipodi:role="line"
+         id="tspan2291"
+         x="176.93353"
+         y="138.21815"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">✄</tspan></text>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.3;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Lend-2-6)"
+       d="m 181.46685,99.71436 c 21.61425,11.51564 44.18902,0 44.18902,0"
+       id="path1087-3-0" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:monospace;-inkscape-font-specification:monospace;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="195.7271"
+       y="122.96945"
+       id="text1035-89-7"><tspan
+         sodipodi:role="line"
+         id="tspan1033-6-5"
+         x="195.7271"
+         y="122.96945"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">set_view</tspan></text>
+    <g
+       id="g905-1-4-4"
+       transform="translate(120.23594,18.477932)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#e2e2e2;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-8-3-8"
+         width="10.583333"
+         height="13.79613"
+         x="78.878532"
+         y="85.920006"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-7-3-1"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-2-3-4);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>⇧</tspan></tspan></text>
+    </g>
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:0.36em;font-family:monospace;-inkscape-font-specification:monospace;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="196.99921"
+       y="61.359337"
+       id="text1035-89-4"><tspan
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         sodipodi:role="line"
+         id="tspan3987"
+         x="196.99921"
+         y="61.359337">locking</tspan><tspan
+         sodipodi:role="line"
+         x="196.99921"
+         y="65.362335"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         id="tspan3985">pops: false</tspan></text>
+    <g
+       id="g905-1-4-9"
+       transform="translate(120.23594,-18.828317)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#e2e2e2;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-8-3-2"
+         width="10.583333"
+         height="13.79613"
+         x="78.878532"
+         y="85.920006"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-7-3-2"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-2-3-9);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>⇧</tspan></tspan></text>
+    </g>
+    <g
+       id="g905-0"
+       transform="translate(147.8008,-0.83970203)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-5"
+         width="10.583333"
+         height="13.79613"
+         x="77.863091"
+         y="86.745537"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-1"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-21);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>ą</tspan></tspan></text>
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.3;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;marker-end:url(#Arrow1Lend-2-6-6)"
+       d="m 170.49256,99.691217 c -49.40563,31.667983 -82.046134,0 -82.046134,0"
+       id="path1087-3-0-5"
+       sodipodi:nodetypes="cc" />
+    <g
+       id="g905-3-7-6"
+       transform="translate(45.925334,26.134402)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-4-9-8"
+         width="10.583333"
+         height="13.79613"
+         x="78.266167"
+         y="86.745537"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-0-5-2"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-10-1-8);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>Ą</tspan></tspan></text>
+    </g>
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:0.4em;font-family:sans-serif;-inkscape-font-specification:sans-serif;text-align:center;letter-spacing:0px;word-spacing:0px;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="129.60217"
+       y="131.30838"
+       id="text1035-8-4"><tspan
+         sodipodi:role="line"
+         x="129.60217"
+         y="131.30838"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;text-align:center;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         id="tspan2277-2">text</tspan><tspan
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:sans-serif;-inkscape-font-specification:sans-serif;text-align:center;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         sodipodi:role="line"
+         x="129.60217"
+         y="135.62888"
+         id="tspan1606-4" /></text>
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.58611px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="123.67847"
+       y="136.8163"
+       id="text2293-0"><tspan
+         sodipodi:role="line"
+         id="tspan2291-6"
+         x="123.67847"
+         y="136.8163"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.58611px;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">returns</tspan></text>
+    <g
+       id="g905"
+       transform="translate(1.1299757e-7,-0.85044747)">
+      <circle
+         style="color:#000000;overflow:visible;fill:#ffffff;stroke:#000000;stroke-width:0.499999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="path1065"
+         cx="83.154755"
+         cy="93.6436"
+         r="7.8844509" />
+      <text
+         xml:space="preserve"
+         id="text833"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-12);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan
+             style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none">a</tspan></tspan></text>
+    </g>
+    <g
+       id="g2948">
+      <circle
+         style="color:#000000;overflow:visible;fill:#ffffff;stroke:#000000;stroke-width:0.499999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="path1065-6"
+         cx="129.67093"
+         cy="92.793152"
+         r="7.8844509" />
+      <text
+         xml:space="preserve"
+         id="text833-0"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-10-7);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(46.071199,-1.2662626)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>A</tspan></tspan></text>
+    </g>
+    <g
+       id="g2259-3"
+       transform="matrix(0.61171471,0,0,0.53404326,8.8050741,94.418409)">
+      <path
+         id="rect2111-9-1"
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.499999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 179.53502,72.72924 h 5.84717 l -1.37074,1.931346 h -3.04292 z"
+         sodipodi:nodetypes="ccccc" />
+      <path
+         id="rect2111-9-0-7"
+         style="color:#000000;overflow:visible;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.499999;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 179.4049,80.846668 h 5.84717 l -1.23711,-1.931347 h -3.17655 z"
+         sodipodi:nodetypes="ccccc" />
+      <g
+         id="g2247-5"
+         transform="translate(-0.04032786,-0.04319387)">
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,75.343053 2.96688,-0.19452"
+           id="path2145-9"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,76.112065 2.96688,-0.19452"
+           id="path2145-3-6"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,76.881078 2.96688,-0.19452"
+           id="path2145-0-2"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,77.65009 2.96688,-0.19452"
+           id="path2145-2-1"
+           sodipodi:nodetypes="cc" />
+        <path
+           style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.363778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+           d="m 181.02302,78.419102 2.96688,-0.19452"
+           id="path2145-4-7"
+           sodipodi:nodetypes="cc" />
+      </g>
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.265;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.06, 0.53;stroke-dashoffset:0;stroke-opacity:1"
+       d="m 119.51485,135.86385 c -0.50656,0.62998 -2.26796,0.26701 -2.85105,0.85011 -0.52314,0.52314 2.02401,2.4426 3.96141,3.16913 2.94083,1.1028 4.79827,0.22 7.72476,-0.19807 0.3268,-0.0467 0.66473,0.0543 0.99035,0 1.72749,-0.28792 3.39512,-0.79539 5.14984,-0.99036 1.10207,-0.12245 0.49735,0.0622 1.58457,0.19807 0.91825,0.11479 1.8542,0.0832 2.77299,0.19807 0.86919,0.10865 1.70964,-0.19807 2.57492,-0.19807"
+       id="path3796" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.5861px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="166.72447"
+       y="136.84001"
+       id="text2293-0-5"><tspan
+         sodipodi:role="line"
+         id="tspan2291-6-7"
+         x="166.72447"
+         y="136.84001"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.5861px;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">cuts</tspan></text>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.05833, 0.529166;stroke-dashoffset:0;stroke-opacity:1"
+       d="m 182.52503,132.07727 c 0.0233,0.14006 0.07,0.27818 0.07,0.42017 0,0.0738 -0.07,0.13627 -0.07,0.21009 0,0.11902 0.0582,0.23171 0.07,0.35014 0.049,0.49035 0.0857,0.98109 0.14006,1.4706 0.018,0.1624 -0.0269,0.32902 0,0.4902 0.0435,0.26077 0.11166,0.3369 0,0.56023 -0.0209,0.0418 0.033,0.10705 0,0.14006 -0.0369,0.0369 -0.10315,0.0331 -0.14006,0.07"
+       id="path3816" />
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.05833, 0.529166;stroke-dashoffset:0;stroke-opacity:1"
+       d="m 182.15722,136.57464 c -0.12445,0.48957 -0.1295,0.98859 -0.0743,1.48553 0.0118,0.10583 0.01,0.21643 0.0248,0.32186 -0.002,0.0627 0.0396,0.11405 0.0495,0.17332 0.0144,0.0866 -0.0193,0.077 0,0.17331 0.0124,0.0621 0.20619,0.18971 0.24759,0.22283"
+       id="path3820" />
+    <g
+       id="g3858-9"
+       transform="translate(1.354821,-73.436839)">
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="204.75821"
+         y="130.07979"
+         id="text2293-4-6"><tspan
+           sodipodi:role="line"
+           id="tspan2291-1-4"
+           x="204.75821"
+           y="130.07979"
+           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">✄</tspan></text>
+      <text
+         xml:space="preserve"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.5861px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         x="194.54915"
+         y="128.70164"
+         id="text2293-0-5-8-3"><tspan
+           sodipodi:role="line"
+           id="tspan2291-6-7-5-3"
+           x="194.54915"
+           y="128.70164"
+           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:4.5861px;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">cuts</tspan></text>
+      <path
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.05833, 0.529167;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 210.34971,123.9389 c 0.0233,0.14006 0.07,0.27818 0.07,0.42017 0,0.0738 -0.07,0.13627 -0.07,0.21009 0,0.11902 0.0582,0.23171 0.07,0.35014 0.049,0.49035 0.0857,0.98109 0.14006,1.4706 0.018,0.1624 -0.0269,0.32902 0,0.4902 0.0435,0.26077 0.11166,0.3369 0,0.56023 -0.0209,0.0418 0.033,0.10705 0,0.14006 -0.0369,0.0369 -0.10315,0.0331 -0.14006,0.07"
+         id="path3816-9-3" />
+      <path
+         style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264583;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:1.05833, 0.529167;stroke-dashoffset:0;stroke-opacity:1"
+         d="m 209.9819,128.43627 c -0.12445,0.48957 -0.1295,0.98859 -0.0743,1.48553 0.0118,0.10583 0.01,0.21643 0.0248,0.32186 -0.002,0.0627 0.0396,0.11405 0.0495,0.17332 0.0144,0.0866 -0.0193,0.077 0,0.17331 0.0124,0.0621 0.20619,0.18971 0.24759,0.22283"
+         id="path3820-7-8" />
+    </g>
+  </g>
+</svg>

doc/switching.svg

@@ -0,0 +1,386 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="70.905495mm"
+   height="78.260262mm"
+   viewBox="0 0 70.905494 78.260262"
+   version="1.1"
+   id="svg8"
+   inkscape:version="1.0.1 (3bc2e813f5, 2020-09-07)"
+   sodipodi:docname="switching.svg">
+  <defs
+     id="defs2">
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow1Mend"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Mend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.4,0,0,-0.4,-4,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1098" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow2Sstart"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow2Sstart"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(0.3,0,0,0.3,-0.69,0)"
+         d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+         id="path1119" />
+    </marker>
+    <marker
+       style="overflow:visible"
+       id="Arrow2Mstart"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow2Mstart"
+       inkscape:isstock="true">
+      <path
+         transform="scale(0.6)"
+         d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1"
+         id="path1113" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-5" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect848" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect848-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-9" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect848-8" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect916" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-4" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect951" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-10-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect986" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect1061" />
+    <marker
+       style="overflow:visible"
+       id="Arrow1Lend-5"
+       refX="0"
+       refY="0"
+       orient="auto"
+       inkscape:stockid="Arrow1Lend"
+       inkscape:isstock="true">
+      <path
+         transform="matrix(-0.8,0,0,-0.8,-10,0)"
+         style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:1pt;stroke-opacity:1"
+         d="M 0,0 5,-5 -12.5,0 5,5 Z"
+         id="path1092-7" />
+    </marker>
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect835-2-1" />
+    <rect
+       x="80.886902"
+       y="89.202377"
+       width="18.898809"
+       height="20.410713"
+       id="rect1549" />
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.98994949"
+     inkscape:cx="136.49044"
+     inkscape:cy="110.83537"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     inkscape:document-rotation="0"
+     showgrid="false"
+     fit-margin-top="4"
+     fit-margin-left="4"
+     fit-margin-right="4"
+     fit-margin-bottom="4"
+     lock-margins="true"
+     inkscape:window-width="1298"
+     inkscape:window-height="708"
+     inkscape:window-x="0"
+     inkscape:window-y="0"
+     inkscape:window-maximized="1" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-70.899889,-58.974186)">
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.265;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow1Lend)"
+       d="m 88.446426,85.895089 c 17.575894,-11.622767 35.932844,0 35.932844,0"
+       id="path1087" />
+    <g
+       id="g905"
+       transform="translate(0,-0.85044703)">
+      <circle
+         style="color:#000000;overflow:visible;fill:#ffffff;stroke:#000000;stroke-width:0.5;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="path1065"
+         cx="83.03434"
+         cy="93.834679"
+         r="7.8844509" />
+      <text
+         xml:space="preserve"
+         id="text833"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.16231537,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan
+             style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:sans-serif;fill:#000000;fill-opacity:1;stroke:none">a</tspan></tspan></text>
+    </g>
+    <g
+       id="g905-3"
+       transform="translate(46.113101,-0.85044703)">
+      <circle
+         style="color:#000000;overflow:visible;fill:#ffffff;stroke:#000000;stroke-width:0.499999;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1"
+         id="path1065-3"
+         cx="83.557831"
+         cy="93.366959"
+         r="7.8844509" />
+      <text
+         xml:space="preserve"
+         id="text833-0"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-10);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>A</tspan></tspan></text>
+    </g>
+    <g
+       id="g905-7"
+       transform="translate(-0.94494048,73.232887)">
+      <text
+         xml:space="preserve"
+         id="text833-6"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-4);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>ą</tspan></tspan></text>
+      <rect
+         style="color:#000000;overflow:visible;fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-3"
+         width="10.583333"
+         height="13.79613"
+         x="77.863091"
+         y="86.745537"
+         ry="1.937705" />
+    </g>
+    <g
+       id="g905-3-7"
+       transform="translate(49.136911,68.319196)">
+      <text
+         xml:space="preserve"
+         id="text833-0-5"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-10-1);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>Ą</tspan></tspan></text>
+      <rect
+         style="color:#000000;overflow:visible;fill:none;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-4-9"
+         width="10.583333"
+         height="13.79613"
+         x="78.266167"
+         y="86.745537"
+         ry="1.937705" />
+    </g>
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="90.548096"
+       y="65.654472"
+       id="text1035"><tspan
+         sodipodi:role="line"
+         id="tspan1033"
+         x="90.548096"
+         y="65.654472"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52778px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">set_view: upper</tspan></text>
+    <g
+       id="g905-1"
+       transform="translate(22.423437,-17.670388)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#e2e2e2;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-8"
+         width="10.583333"
+         height="13.79613"
+         x="78.878532"
+         y="85.920006"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-7"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-2);fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan>⇧</tspan></tspan></text>
+    </g>
+    <path
+       style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.264999;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1;marker-end:url(#Arrow1Lend-5)"
+       d="m 124.74085,99.691217 c -17.5759,11.622773 -35.932849,0 -35.932849,0"
+       id="path1087-4" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:0.4em;font-family:monospace;-inkscape-font-specification:monospace;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+       x="91.116165"
+       y="123.76147"
+       id="text1035-8"><tspan
+         sodipodi:role="line"
+         id="tspan1033-5"
+         x="91.116165"
+         y="123.76147"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px">locking</tspan><tspan
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         sodipodi:role="line"
+         id="tspan1604"
+         x="91.116165"
+         y="128.08197">lock_view: upper</tspan><tspan
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:3.52777px;font-family:monospace;-inkscape-font-specification:monospace;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583px"
+         sodipodi:role="line"
+         x="91.116165"
+         y="132.40247"
+         id="tspan1606">unlock_view: lower</tspan></text>
+    <g
+       id="g905-1-9"
+       transform="translate(22.423437,17.64464)">
+      <rect
+         style="color:#000000;overflow:visible;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.5;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+         id="rect900-8-7"
+         width="10.583333"
+         height="13.79613"
+         x="78.878532"
+         y="85.920006"
+         ry="1.937705" />
+      <text
+         xml:space="preserve"
+         id="text833-7-5"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:7.9375px;line-height:125%;font-family:sans-serif;-inkscape-font-specification:sans-serif;letter-spacing:0px;word-spacing:0px;white-space:pre;shape-inside:url(#rect835-2-1);fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:0.264583px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;"
+         transform="translate(-0.04189825,-0.41581583)"><tspan
+           x="80.886719"
+           y="96.225952"><tspan
+             style="fill:#ffffff;fill-opacity:1">⇧</tspan></tspan></text>
+    </g>
+  </g>
+</svg>

doc/tutorial.md

@@ -21,7 +21,8 @@ Creating a layout is easy. You don't need to recompile things, just edit and tes
 ### 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 
+* Select and enable the input source you would like to change from the Region & Language section of the device settings. Perhaps use "A user-defined custom layout" listed under Other.
+* Find the correct name of the .yaml file associated with that input source. This can be found with the command 
 
 ```
 gsettings get org.gnome.desktop.input-sources sources
@@ -29,12 +30,14 @@ gsettings get org.gnome.desktop.input-sources sources
 
 The output should be something like this: `[('xkb', 'us'), ('xkb', 'de')]`
 So for example “de.yaml” would be the correct name for the German keyboard layout.
-
 If the name of your layout is not translated correctly in the list, you can fix it by adding it and recompiling Squeekboard.
 
+There is also associated files for that layout in landscape, terminal, number, emoji mode. They can be found at something analogous to `us_wide.yaml`, `terminal/us.yaml`, `number/us.yaml`, `emoji/us.yaml`, respectively.
+
 ### Testing the layout
 
 Copy your yaml file to `~/.local/share/squeekboard/keyboards/` for testing purposes. From there it should get picked up by squeekboard automatically.
+The yaml file will overwrite the default settings for that layout. If you want to go back to default, simply remove the file.
 
 You can also use the `test_layout` tool from the -devel package to check it for errors:
 

doc/views.md

@@ -0,0 +1,64 @@
+Switching views
+=========
+
+Squeekboard layout files are separated into *views*.
+
+What are views?
+-------------------
+
+A view is the button arrangement which you see on Squeekboard's panel. The view always spans the entire panel area, so it's not possible to see two views at the same time, even if the layout contains multiple views.
+
+Views are useful because they allow to have many more buttons than would fit on the panel at the same time. That works because views can be switched.
+
+Views are different from layouts: they can be switched without affecting the active language, and without touching the globe button. Layouts cannot share views, so switching layouts *always* switches views.
+
+Switching views
+------------------
+
+The model selected for switching views is less similar to "levels" known from physical keyboards, but closer to "rooms", which may resemble a game map.
+
+Buttons don't have states. It's more of a model where each view is a room, and buttons are doors. Switching means moving to the next room, and buttons highlight according to which view/room they lead to or from.
+
+There are two basic kinds of switching buttons: one way (`set_view`), and two way (`locking`). `locking` is the more sophisticated one. When placed inside `lock_view`, it is drawn highlighted, and goes to `unlock view`. When placed inside any other view, it behaves like `set_view`.
+
+![Diagram showing two transitions: from lowercase via `set_view` to uppercase, and back via `locking`](switching.svg) This diagram shows which buttons can switch between two views. Views are shown as circles, and buttons as rounded rectangles.
+The two buttons are separate, and visible only in the view *from which the switch starts*. Note that the `locking` button is shown highlighted. That's because it's in `upper` view, which matches its `lock_view`.
+
+Latching
+----------
+
+`locking` buttons provide a second mode of operation: latching. It's useful when the target view is needed only for a single button press, like entering a single accent or a single capital letter in Latin scripts.
+
+When a latching button is pressed, the keyboard remembers to come back to the current (source) view, and then the view is switched. If another `locking` button is pressed, the source view stays in memory. If a text button is pressed, the view from memory is shown again, and forgotten.
+
+![Diagram showing the switches needed to travel across 3 views: a→A→Ą, while latching.](latching.svg) In this diagram, the dashed line connects the view the typist is seeing to the view remembered for unlatching.
+
+There are two ways to erase the memory without going back to the remembered view. Pressing the button again will permanently switch to the current view, and `set_view` will permanently switch to its target.
+
+In the room metaphor, it's as if tying a thread inside the room before going through the door to the next one. And another `locking` door while holding the thread. Once the Minotaur is slain (text button pressed), the hero follows the thread back to the starting room.
+
+The typist hero cuts the thread in two circumstances: when staying longer in the current room (press button again), or when moving through a `set_view` door.
+
+![Diagram showing possible ways to stop latching, by staying in Ą, by unlatching back to a, and by moving on to ą view.](latching_return.svg) This diagram shows the possible ways to stop latching. One is by pressing a text button, which takes back to the original view. Another is pressing a locking button which appears highlighted (note that it can be any button, what matters is its `lock_view`). Finally, switching to another view using a button that doesn't keep the latch on forgets latching.
+
+The layout author should pay attention that `set_view`'s lack of latching does not come as a surprise to typists.
+
+
+Differences from keyboard levels
+---------------------------------------
+
+Views are **not** like keyboard levels.
+
+On a physical keyboard, the number of buttons can not change when switching levels. In Squeekboard, they can have any arrangement of buttons you could imagine.
+
+When switching levels on a keyboard, for example by pressing Shift, the key press not only affects the meaning of other keys, but also tells the application that it's pressed down. In Squeekboard, pressing buttons to change layouts *does not* do anything but switch the layout. Pressing the switching button especially *does not* tell the application that it was pressed. (This is the reason Shift and AltGr modifiers are not implemented in Squeekboard.)
+
+Why not use the "views" model?
+-------------------------------------
+
+Squeekboard's goal is to support as many scripts as possible, and the author of the initial design doesn't know a whole lot. There are two problems with using the levels metaphor:
+
+Firstly, the levels model assumes that there is a "base" and an "active" level. This does not work well with scripts that have different but equivalent modes of writing. An example is the Kana layout with Katakana and Hiragana, which are both "base".
+Both systems could have been combined, but the view switching designer doesn't have enough experience with different scripts to do that. Some scripts may have different non-hierarchical ways to switch character groups (Balinese?), which could make combining hierarchy with free-form switching even harder.
+
+Secondly, when dealing with languages with a hierarchy, we end up with extra work to eliminate nonsensical combinations. With "symbols" and "uppercase" levels, what does it mean to have both engaged? Eliminating that means extra work. Either validating layouts, so that it's not possible to engage "uppercase" from "symbols", or duplicating, so that "uppercase+symbols" is the same as just "symbols". With "accents" in the mix, this could become a challenge to design well.

eek/eek-gtk-keyboard.c

@@ -45,6 +45,8 @@
 typedef struct _EekGtkKeyboardPrivate
 {
     EekRenderer *renderer; // owned, nullable
+    struct render_geometry render_geometry; // mutable
+
     EekboardContextService *eekboard_context; // unowned reference
     struct submission *submission; // unowned reference
 
@@ -72,12 +74,23 @@ eek_gtk_keyboard_real_realize (GtkWidget      *self)
     GTK_WIDGET_CLASS (eek_gtk_keyboard_parent_class)->realize (self);
 }
 
+static void set_allocation_size(EekGtkKeyboard *gtk_keyboard,
+    struct squeek_layout *layout, gdouble width, gdouble height)
+{
+    // This is where size-dependent surfaces would be released
+    EekGtkKeyboardPrivate *priv =
+        eek_gtk_keyboard_get_instance_private (gtk_keyboard);
+    priv->render_geometry = eek_render_geometry_from_allocation_size(
+        layout, width, height);
+}
+
 static gboolean
 eek_gtk_keyboard_real_draw (GtkWidget *self,
                             cairo_t   *cr)
 {
+    EekGtkKeyboard *keyboard = EEK_GTK_KEYBOARD (self);
     EekGtkKeyboardPrivate *priv =
-        eek_gtk_keyboard_get_instance_private (EEK_GTK_KEYBOARD (self));
+        eek_gtk_keyboard_get_instance_private (keyboard);
     GtkAllocation allocation;
     gtk_widget_get_allocation (self, &allocation);
 
@@ -92,15 +105,14 @@ eek_gtk_keyboard_real_draw (GtkWidget *self,
                     priv->keyboard,
                     pcontext);
 
-        eek_renderer_set_allocation_size (priv->renderer,
+        set_allocation_size (keyboard, priv->keyboard->layout,
-                                          priv->keyboard->layout,
+            allocation.width, allocation.height);
-                                          allocation.width,
-                                          allocation.height);
         eek_renderer_set_scale_factor (priv->renderer,
                                        gtk_widget_get_scale_factor (self));
     }
 
-    eek_renderer_render_keyboard (priv->renderer, priv->submission, cr, priv->keyboard);
+    eek_renderer_render_keyboard (priv->renderer, priv->render_geometry,
+        priv->submission, cr, priv->keyboard);
     return FALSE;
 }
 
@@ -117,8 +129,9 @@ static void
 eek_gtk_keyboard_real_size_allocate (GtkWidget     *self,
                                      GtkAllocation *allocation)
 {
+    EekGtkKeyboard *keyboard = EEK_GTK_KEYBOARD (self);
     EekGtkKeyboardPrivate *priv =
-        eek_gtk_keyboard_get_instance_private (EEK_GTK_KEYBOARD (self));
+        eek_gtk_keyboard_get_instance_private (keyboard);
     // check if the change would switch types
     enum squeek_arrangement_kind new_type = get_type(
                 (uint32_t)(allocation->width - allocation->x),
@@ -130,10 +143,8 @@ eek_gtk_keyboard_real_size_allocate (GtkWidget     *self,
     }
 
     if (priv->renderer) {
-        eek_renderer_set_allocation_size (priv->renderer,
+        set_allocation_size (keyboard, priv->keyboard->layout,
-                                          priv->keyboard->layout,
+            allocation->width, allocation->height);
-                                          allocation->width,
-                                          allocation->height);
     }
 
     GTK_WIDGET_CLASS (eek_gtk_keyboard_parent_class)->
@@ -162,7 +173,7 @@ static void depress(EekGtkKeyboard *self,
     }
     squeek_layout_depress(priv->keyboard->layout,
                           priv->submission,
-                          x, y, eek_renderer_get_transformation(priv->renderer), time, self);
+                          x, y, priv->render_geometry.widget_to_layout, time, self);
 }
 
 static void drag(EekGtkKeyboard *self,
@@ -174,7 +185,7 @@ static void drag(EekGtkKeyboard *self,
     }
     squeek_layout_drag(eekboard_context_service_get_keyboard(priv->eekboard_context)->layout,
                        priv->submission,
-                       x, y, eek_renderer_get_transformation(priv->renderer), time,
+                       x, y, priv->render_geometry.widget_to_layout, time,
                        priv->eekboard_context, self);
 }
 
@@ -185,8 +196,7 @@ static void release(EekGtkKeyboard *self, guint32 time)
         return;
     }
     squeek_layout_release(eekboard_context_service_get_keyboard(priv->eekboard_context)->layout,
-                          priv->submission,
+                          priv->submission, priv->render_geometry.widget_to_layout, time,
-                          eek_renderer_get_transformation(priv->renderer), time,
                           priv->eekboard_context, self);
 }
 
@@ -306,7 +316,6 @@ eek_gtk_keyboard_dispose (GObject *object)
     if (priv->renderer) {
         eek_renderer_free(priv->renderer);
         priv->renderer = NULL;
-        priv->renderer = NULL;
     }
 
     if (priv->keyboard) {
@@ -396,6 +405,24 @@ eek_gtk_keyboard_new (EekboardContextService *eekservice,
     priv->submission = submission;
     priv->layout = layout;
     priv->renderer = NULL;
+    // This should really be done on initialization.
+    // Before the widget is allocated,
+    // we don't really know what geometry it takes.
+    // When it's off the screen, we also kinda don't.
+    struct render_geometry initial_geometry = {
+        // Set to 100 just to make sure if there's any attempt to use it,
+        // it actually gives plausible results instead of blowing up,
+        // e.g. on zero division.
+        .allocation_width = 100,
+        .allocation_height = 100,
+        .widget_to_layout = {
+            .origin_x = 0,
+            .origin_y = 0,
+            .scale = 1,
+        },
+    };
+    priv->render_geometry = initial_geometry;
+
     g_signal_connect (eekservice,
                       "notify::keyboard",
                       G_CALLBACK(on_notify_keyboard),

eek/eek-gtk-keyboard.h

@@ -28,6 +28,7 @@
 #include <glib.h>
 #include <gtk/gtk.h>
 
+#include "eek/eek-renderer.h"
 #include "eek/eek-types.h"
 
 struct submission;

eek/eek-renderer.c

@@ -18,7 +18,7 @@
  * 02110-1301 USA
  */
 
-#include "config.h"
+#define G_LOG_DOMAIN "squeekboard-eek-renderer"
 
 #include <math.h>
 #include <string.h>
@@ -33,10 +33,6 @@
 static void render_button_label (cairo_t *cr, GtkStyleContext *ctx,
                                                 const gchar *label, EekBounds bounds);
 
-void eek_render_button                         (EekRenderer *self,
-                                                cairo_t     *cr, const struct squeek_button *button,
-                                                gboolean     pressed, gboolean locked);
-
 static void
 render_outline (cairo_t     *cr,
                 GtkStyleContext *ctx,
@@ -60,32 +56,40 @@ render_outline (cairo_t     *cr,
         position.x, position.y, position.width, position.height);
 }
 
-static void render_button_in_context(gint scale_factor,
+float get_scale(cairo_t *cr) {
+    double width = 1;
+    double height = 1;
+    cairo_user_to_device_distance (cr, &width, &height);
+    return width;
+}
+
+/// Rust interface
+void eek_render_button_in_context(uint32_t scale_factor,
                                      cairo_t     *cr,
                                      GtkStyleContext *ctx,
-                                     const struct squeek_button *button) {
+                                     EekBounds bounds,
+                                     const char *icon_name,
+                                     const gchar *label) {
     /* blank background */
     cairo_set_source_rgba (cr, 0.0, 0.0, 0.0, 0.0);
     cairo_paint (cr);
 
-    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(button);
-
     if (icon_name) {
+        int context_scale = ceil (get_scale (cr));
         cairo_surface_t *icon_surface =
-            eek_renderer_get_icon_surface (icon_name, 16, scale_factor);
+            eek_renderer_get_icon_surface (icon_name, 16, scale_factor * context_scale);
         if (icon_surface) {
-            gint width = cairo_image_surface_get_width (icon_surface);
+            double width = cairo_image_surface_get_width (icon_surface);
-            gint height = cairo_image_surface_get_height (icon_surface);
+            double height = cairo_image_surface_get_height (icon_surface);
 
             cairo_save (cr);
             cairo_translate (cr,
-                             (bounds.width - (double)width / scale_factor) / 2,
+                             (bounds.width - width / (scale_factor * context_scale)) / 2,
-                             (bounds.height - (double)height / scale_factor) / 2);
+                             (bounds.height - height / (scale_factor * context_scale)) / 2);
             cairo_rectangle (cr, 0, 0, width, height);
             cairo_clip (cr);
             /* Draw the shape of the icon using the foreground color */
@@ -104,25 +108,27 @@ static void render_button_in_context(gint scale_factor,
         }
     }
 
-    const gchar *label = squeek_button_get_label(button);
     if (label) {
-        render_button_label (cr, ctx, label, squeek_button_get_bounds(button));
+        render_button_label (cr, ctx, label, bounds);
     }
 }
 
-void
+/// Prepare context for drawing the button.
-eek_render_button (EekRenderer *self,
+/// The context MUST be released using the corresponing "put" procedure
-            cairo_t     *cr,
+/// before drawing the next button.
-            const struct squeek_button *button,
+/// Interface for Rust.
-               gboolean     pressed,
+GtkStyleContext *
-               gboolean     locked)
+eek_get_style_context_for_button (EekRenderer *self,
+                                  const char *name,
+                                  const char *outline_name,
+                                  const char *locked_class,
+                                  uint64_t     pressed)
 {
     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(button);
     gtk_widget_path_iter_set_name (path, -1, name);
 
     /* Update the style context with the updated widget path. */
@@ -131,19 +137,22 @@ eek_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(button);
+    if (locked_class) {
-    if (locked) {
+        gtk_style_context_add_class(ctx, locked_class);
-        gtk_style_context_add_class(ctx, "locked");
     }
     gtk_style_context_add_class(ctx, outline_name);
+    return ctx;
+}
 
-    render_button_in_context(self->scale_factor, cr, ctx, button);
+/// Interface for Rust.
-
+void eek_put_style_context_for_button(GtkStyleContext *ctx,
+                                      const char *outline_name,
+                                      const char *locked_class) {
     // Save and restore functions don't work if gtk_render_* was used in between
     gtk_style_context_set_state(ctx, GTK_STATE_FLAG_NORMAL);
     gtk_style_context_remove_class(ctx, outline_name);
-    if (locked) {
+    if (locked_class) {
-        gtk_style_context_remove_class(ctx, "locked");
+        gtk_style_context_remove_class(ctx, locked_class);
     }
 }
 
@@ -194,22 +203,23 @@ render_button_label (cairo_t     *cr,
 // FIXME: Pass just the active modifiers instead of entire submission
 void
 eek_renderer_render_keyboard (EekRenderer *self,
+                              struct render_geometry geometry,
                               struct submission *submission,
                                    cairo_t     *cr,
                               LevelKeyboard *keyboard)
 {
-    g_return_if_fail (self->allocation_width > 0.0);
+    g_return_if_fail (geometry.allocation_width > 0.0);
-    g_return_if_fail (self->allocation_height > 0.0);
+    g_return_if_fail (geometry.allocation_height > 0.0);
 
     /* Paint the background covering the entire widget area */
     gtk_render_background (self->view_context,
                            cr,
                            0, 0,
-                           self->allocation_width, self->allocation_height);
+                           geometry.allocation_width, geometry.allocation_height);
 
     cairo_save(cr);
-    cairo_translate (cr, self->widget_to_layout.origin_x, self->widget_to_layout.origin_y);
+    cairo_translate (cr, geometry.widget_to_layout.origin_x, geometry.widget_to_layout.origin_y);
-    cairo_scale (cr, self->widget_to_layout.scale, self->widget_to_layout.scale);
+    cairo_scale (cr, geometry.widget_to_layout.scale, geometry.widget_to_layout.scale);
 
     squeek_draw_layout_base_view(keyboard->layout, self, cr);
     squeek_layout_draw_all_changed(keyboard->layout, self, cr, submission);
@@ -226,6 +236,8 @@ eek_renderer_free (EekRenderer        *self)
     g_object_unref(self->css_provider);
     g_object_unref(self->view_context);
     g_object_unref(self->button_context);
+    g_clear_signal_handler (&self->theme_name_id, gtk_settings_get_default());
+
     // this is where renderer-specific surfaces would be released
 
     free(self);
@@ -257,14 +269,49 @@ static GType button_type(void) {
     return type;
 }
 
+
+static void
+on_gtk_theme_name_changed (GtkSettings *settings, gpointer foo, EekRenderer *self)
+{
+  g_autofree char *name = NULL;
+
+  g_object_get (settings, "gtk-theme-name", &name, NULL);
+  g_debug ("GTK theme: %s", name);
+
+  gtk_style_context_remove_provider_for_screen (gdk_screen_get_default (),
+                                                GTK_STYLE_PROVIDER (self->css_provider));
+  gtk_style_context_remove_provider (self->button_context,
+                                     GTK_STYLE_PROVIDER(self->css_provider));
+  gtk_style_context_remove_provider (self->view_context,
+                                     GTK_STYLE_PROVIDER(self->css_provider));
+
+  g_set_object (&self->css_provider, squeek_load_style());
+
+  gtk_style_context_add_provider_for_screen (gdk_screen_get_default (),
+                                             GTK_STYLE_PROVIDER (self->css_provider),
+                                             GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
+  gtk_style_context_add_provider (self->button_context,
+                                  GTK_STYLE_PROVIDER(self->css_provider),
+                                  GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
+  gtk_style_context_add_provider (self->view_context,
+                                  GTK_STYLE_PROVIDER(self->css_provider),
+                                  GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
+}
+
+
 static void
 renderer_init (EekRenderer *self)
 {
     self->pcontext = NULL;
-    self->allocation_width = 0.0;
-    self->allocation_height = 0.0;
     self->scale_factor = 1;
 
+    GtkSettings *gtk_settings;
+
+    gtk_settings = gtk_settings_get_default ();
+
+    self->theme_name_id = g_signal_connect (gtk_settings, "notify::gtk-theme-name",
+                                            G_CALLBACK (on_gtk_theme_name_changed), self);
+
     self->css_provider = squeek_load_style();
 }
 
@@ -276,6 +323,7 @@ eek_renderer_new (LevelKeyboard  *keyboard,
     renderer_init(renderer);
     renderer->pcontext = pcontext;
     g_object_ref (renderer->pcontext);
+    const char *purpose_class = "normal";
 
     /* Create a style context for the layout */
     GtkWidgetPath *path = gtk_widget_path_new();
@@ -289,7 +337,7 @@ eek_renderer_new (LevelKeyboard  *keyboard,
     }
     gtk_style_context_add_provider (renderer->view_context,
         GTK_STYLE_PROVIDER(renderer->css_provider),
-        GTK_STYLE_PROVIDER_PRIORITY_USER);
+        GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
 
     /* Create a style context for the buttons */
     path = gtk_widget_path_new();
@@ -297,6 +345,55 @@ eek_renderer_new (LevelKeyboard  *keyboard,
     if (squeek_layout_get_kind(keyboard->layout) == ARRANGEMENT_KIND_WIDE) {
         gtk_widget_path_iter_add_class(path, -1, "wide");
     }
+    /* Add style classes based on purpose */
+    switch (squeek_layout_get_purpose (keyboard->layout)) {
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NORMAL:
+        purpose_class = "normal";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_ALPHA:
+        purpose_class = "alpha";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_DIGITS:
+        purpose_class = "digits";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NUMBER:
+        purpose_class = "number";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PHONE:
+        purpose_class = "phone";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_URL:
+        purpose_class = "url";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_EMAIL:
+        purpose_class = "email";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_NAME:
+        purpose_class = "name";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PASSWORD:
+        purpose_class = "password";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_PIN:
+        purpose_class = "pin";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_DATE:
+        purpose_class = "date";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_TIME:
+        purpose_class = "time";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_DATETIME:
+        purpose_class = "datetime";
+        break;
+    case ZWP_TEXT_INPUT_V3_CONTENT_PURPOSE_TERMINAL:
+        purpose_class = "terminal";
+        break;
+    default:
+        g_warning ("Unknown input purpose %d", squeek_layout_get_purpose(keyboard->layout));
+    }
+    gtk_widget_path_iter_add_class(path, -1, purpose_class);
+
     gtk_widget_path_append_type(path, button_type());
     renderer->button_context = gtk_style_context_new ();
     gtk_style_context_set_path(renderer->button_context, path);
@@ -305,26 +402,22 @@ eek_renderer_new (LevelKeyboard  *keyboard,
     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);
+        GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
     return renderer;
 }
 
-void
+struct render_geometry
-eek_renderer_set_allocation_size (EekRenderer *renderer,
+eek_render_geometry_from_allocation_size (struct squeek_layout *layout,
-                                  struct squeek_layout *layout,
                                   gdouble      width,
                                   gdouble      height)
 {
-    g_return_if_fail (width > 0.0 && height > 0.0);
+    struct render_geometry ret = {
-
+        .allocation_width = width,
-    renderer->allocation_width = width;
+        .allocation_height = height,
-    renderer->allocation_height = height;
+        .widget_to_layout = squeek_layout_calculate_transformation(
-
+            layout, width, height),
-    renderer->widget_to_layout = squeek_layout_calculate_transformation(
+    };
-                layout,
+    return ret;
-                renderer->allocation_width, renderer->allocation_height);
-
-    // This is where size-dependent surfaces would be released
 }
 
 void
@@ -333,6 +426,11 @@ eek_renderer_set_scale_factor (EekRenderer *renderer, gint scale)
     renderer->scale_factor = scale;
 }
 
+/// Rust interface.
+uint32_t eek_renderer_get_scale_factor(EekRenderer *renderer) {
+    return renderer->scale_factor;
+}
+
 cairo_surface_t *
 eek_renderer_get_icon_surface (const gchar *icon_name,
                                gint size,
@@ -356,8 +454,3 @@ eek_renderer_get_icon_surface (const gchar *icon_name,
     }
     return surface;
 }
-
-struct transformation
-eek_renderer_get_transformation (EekRenderer *renderer) {
-    return renderer->widget_to_layout;
-}

eek/eek-renderer.h

@@ -39,24 +39,27 @@ typedef struct EekRenderer
     GtkStyleContext *button_context; // TODO: maybe move a copy to each button
     /// Style class for rendering the view and button CSS.
     gchar *extra_style; // owned
+    // Theme name change signal handler id
+    gulong theme_name_id;
 
     // Mutable state
+    gint scale_factor; /* the outputs scale factor */
+} EekRenderer;
+
+
+/// Mutable part of the renderer state.
+/// TODO: Possibly should include scale factor.
+struct render_geometry {
     /// Background extents
     gdouble allocation_width;
     gdouble allocation_height;
-    gint scale_factor; /* the outputs scale factor */
     /// Coords transformation
     struct transformation widget_to_layout;
-} EekRenderer;
+};
-
 
 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, struct squeek_layout *layout,
-                                                gdouble          width,
-                                                gdouble          height);
 void             eek_renderer_set_scale_factor (EekRenderer     *renderer,
                                                 gint             scale);
 
@@ -64,13 +67,14 @@ cairo_surface_t *eek_renderer_get_icon_surface(const gchar     *icon_name,
                                                 gint             size,
                                                 gint             scale);
 
-void             eek_renderer_render_keyboard  (EekRenderer     *renderer, struct submission *submission,
+void             eek_renderer_render_keyboard  (EekRenderer     *renderer, struct render_geometry geometry, struct submission *submission,
                                                 cairo_t         *cr, LevelKeyboard *keyboard);
 void
 eek_renderer_free (EekRenderer        *self);
 
-struct transformation
+struct render_geometry
-eek_renderer_get_transformation (EekRenderer *renderer);
+eek_render_geometry_from_allocation_size (struct squeek_layout *layout,
+    gdouble      width, gdouble      height);
 
 G_END_DECLS
 #endif  /* EEK_RENDERER_H */

eek/eek-types.h

@@ -90,13 +90,5 @@ struct transformation {
     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/layersurface.c

@@ -312,7 +312,6 @@ on_phosh_layer_surface_unmapped (PhoshLayerSurface *self, gpointer unused)
   PhoshLayerSurfacePrivate *priv;
 
   g_return_if_fail (PHOSH_IS_LAYER_SURFACE (self));
-  priv = phosh_layer_surface_get_instance_private (self);
 
   priv = phosh_layer_surface_get_instance_private (self);
   if (priv->layer_surface) {

eekboard/eekboard-context-service.c

@@ -128,30 +128,22 @@ settings_get_layout(GSettings *settings, char **type, char **layout)
 
 void
 eekboard_context_service_use_layout(EekboardContextService *context, struct squeek_layout_state *state, uint32_t timestamp) {
-    gchar *layout_name = state->overlay_name;
+    gchar *layout_name = state->layout_name;
+    gchar *overlay_name = state->overlay_name;
 
+    // try to get the best keyboard layout
     if (layout_name == NULL) {
-        layout_name = state->layout_name;
+        layout_name = "us";
-
-        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:
-            ;
-        }
-
-        if (layout_name == NULL) {
-            layout_name = "us";
-        }
     }
 
+    // overlay is "Normal" for most layouts, we will only look for "terminal" in rust code.
+    // for now just avoid passing a null pointer
+    if (overlay_name == NULL) {
+        overlay_name = "";    // fallback to Normal
+    }
+    
     // generic part follows
-    struct squeek_layout *layout = squeek_load_layout(layout_name, state->arrangement);
+    struct squeek_layout *layout = squeek_load_layout(layout_name, state->arrangement, state->purpose, overlay_name);
     LevelKeyboard *keyboard = level_keyboard_new(layout);
     // set as current
     LevelKeyboard *previous_keyboard = context->keyboard;
@@ -225,7 +217,7 @@ eekboard_context_service_class_init (EekboardContextServiceClass *klass)
      * Emitted when @context is destroyed.
      */
     signals[DESTROYED] =
-        g_signal_new (I_("destroyed"),
+        g_signal_new ("destroyed",
                       G_TYPE_FROM_CLASS(gobject_class),
                       G_SIGNAL_RUN_LAST,
                       0,

meson.build

@@ -1,7 +1,7 @@
 project(
     'squeekboard',
     'c', 'rust',
-    version: '1.10.0',
+    version: '1.16.0',
     license: 'GPLv3',
     meson_version: '>=0.51.0',
     default_options: [
@@ -36,8 +36,6 @@ add_project_arguments(
 
 i18n = import('i18n')
 
-conf_data = configuration_data()
-
 if get_option('buildtype').startswith('debug')
     add_project_arguments('-DDEBUG=1', language : 'c')
 endif
@@ -63,6 +61,7 @@ endif
 prefix = get_option('prefix')
 bindir = join_paths(prefix, get_option('bindir'))
 datadir = join_paths(prefix, get_option('datadir'))
+localedir = join_paths(prefix, get_option('localedir'))
 desktopdir = join_paths(datadir, 'applications')
 pkgdatadir = join_paths(datadir, meson.project_name())
 if get_option('depdatadir') == ''
@@ -72,6 +71,10 @@ else
 endif
 dbusdir = join_paths(depdatadir, 'dbus-1/interfaces')
 
+conf_data = configuration_data()
+conf_data.set_quoted('GETTEXT_PACKAGE', 'squeekboard')
+conf_data.set_quoted('LOCALEDIR', localedir)
+
 summary = [
         '',
         '------------------',
@@ -114,6 +117,7 @@ cargo_script = find_program('cargo.sh')
 cargo_build = find_program('cargo_build.py')
 
 subdir('data')
+subdir('po')
 subdir('protocols')
 subdir('src')
 subdir('tools')

po/LINGUAS

@@ -0,0 +1,11 @@
+ca
+de
+fa
+fi
+fur
+nl
+pt_BR
+ro
+sl
+uk
+sv

po/POTFILES.in

@@ -0,0 +1,2 @@
+data/popover.ui
+data/sm.puri.Squeekboard.desktop.in.in

po/ca.po

@@ -0,0 +1,45 @@
+# Catalan translation for squeekboard.
+# Copyright (C) 2022 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# maite <maite.guix@gmail.com>, 2022.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2022-01-11 14:31+0000\n"
+"PO-Revision-Date: 2022-01-20 10:53+0100\n"
+"Last-Translator: maite guix <maite.guix@me.com>\n"
+"Language-Team: Catalan <gnome@llistes.softcatala.org>\n"
+"Language: ca\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 3.0.1\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Emoji"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Terminal"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Configuració del teclat"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Teclat virtual"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Teclat en pantalla"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "Un teclat virtual en pantalla"

po/de.po

@@ -0,0 +1,22 @@
+# German translations for squeekboard package.
+# Copyright (C) 2021 THE squeekboard'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# Automatically generated, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2021-12-03 18:41+0100\n"
+"PO-Revision-Date: 2021-12-03 18:41+0100\n"
+"Last-Translator: Automatically generated\n"
+"Language-Team: none\n"
+"Language: de\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=ASCII\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: data/popup.ui:15
+msgid "Keyboard Settings"
+msgstr "Tastatureinstellungen"

po/fa.po

@@ -0,0 +1,45 @@
+# Persian translation for squeekboard.
+# Copyright (C) 2022 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# Danial Behzadi <dani.behzi@ubuntu.com>, 2022.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-26 15:15+0000\n"
+"PO-Revision-Date: 2022-01-11 18:01+0330\n"
+"Language-Team: Persian <fa@li.org>\n"
+"Language: fa\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Last-Translator: Danial Behzadi <dani.behzi@ubuntu.com>\n"
+"X-Generator: Poedit 3.0\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "شکلک"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "پایانه"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "تنظیمات صفحه‌کلید"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "اسکوییک‌برد"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "صفحه‌کلید لمسی"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "یک صفحهٔ کلید لمسی مجازی"

po/fi.po

@@ -0,0 +1,46 @@
+# Finnish translation for squeekboard.
+# Copyright (C) 2021 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# Jiri Grönroos <jiri.gronroos@iki.fi>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-25 13:55+0000\n"
+"PO-Revision-Date: 2021-12-26 17:15+0200\n"
+"Last-Translator: Jiri Grönroos <jiri.gronroos+l10n@iki.fi>\n"
+"Language-Team: Finnish <lokalisointi-lista@googlegroups.com>\n"
+"Language: fi\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"X-Generator: Poedit 3.0.1\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Emoji"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Pääte"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Näppäimistön asetukset"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Squeekboard"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Näyttönäppäimistö"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "Virtuaalinen näyttönäppäimistö"

po/fur.po

@@ -0,0 +1,45 @@
+# Friulian translation for squeekboard.
+# Copyright (C) 2021 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# Fabio Tomat <f.t.public@gmail.com>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-22 13:33+0000\n"
+"PO-Revision-Date: 2021-12-22 15:06+0100\n"
+"Last-Translator: Fabio Tomat <f.t.public@gmail.com>\n"
+"Language-Team: Friulian <fur@li.org>\n"
+"Language: fur\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 3.0.1\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Emoji"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Terminâl"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Impostazions tastiere"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Squeekboard"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Tastiere a visôr"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "Une tastiere virtuâl a visôr"

po/meson.build

@@ -0,0 +1,2 @@
+i18n = import('i18n')
+i18n.gettext('squeekboard', preset : 'glib')

po/nl.po

@@ -0,0 +1,48 @@
+# Dutch translation for squeekboard.
+# Copyright (C) 2021 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# Jan Jasper de Kroon <jajadekroon@gmail.com>, 2021.
+# Nathan Follens <nfollens@gnome.org>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-23 15:18+0000\n"
+"PO-Revision-Date: 2021-12-25 14:04+0100\n"
+"Last-Translator: Nathan Follens <nfollens@gnome.org>\n"
+"Language-Team: Dutch <gnome-nl-list@gnome.org>\n"
+"Language: nl\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"X-Generator: Poedit 3.0.1\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Emoji"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Terminal"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Toetsenbordinstellingen"
+
+# Dit is de naam van de applicatie
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Squeekboard"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Schermtoetsenbord"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "Een virtueel schermtoetsenbord"

po/pt_BR.po

@@ -0,0 +1,46 @@
+# Brazilian Portuguese translation for squeekboard.
+# Copyright (C) 2021 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# Rafael Fontenelle <rafaelff@gnome.org>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-22 10:36+0000\n"
+"PO-Revision-Date: 2021-12-22 09:38-0300\n"
+"Last-Translator: Rafael Fontenelle <rafaelff@gnome.org>\n"
+"Language-Team: Brazilian Portuguese <gnome-pt_br-list@gnome.org>\n"
+"Language: pt_BR\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+"X-Generator: Poedit 3.0.1\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Emoji"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Terminal"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Configurações do teclado"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Squeekboard"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Teclado virtual"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "Um teclado virtual"

po/ro.po

@@ -0,0 +1,47 @@
+# Romanian translation for squeekboard.
+# Copyright (C) 2021 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# libre <eposta1@pm.me>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-22 14:45+0000\n"
+"PO-Revision-Date: 2021-12-22 20:05+0100\n"
+"Last-Translator: libre <eposta1@pm.me>\n"
+"Language-Team: Romanian <gnomero-list@lists.sourceforge.net>\n"
+"Language: ro\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=3; plural=(n==1 ? 0 : (n==0 || (n%100 > 0 && n%100 < "
+"20)) ? 1 : 2);;\n"
+"X-Generator: Gtranslator 3.30.1\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Emoji"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Terminal"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Opțiuni tastatură"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Squeekboard"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Tastatură pe ecran"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "O tastatură virtuală pe ecran"

po/sl.po

@@ -0,0 +1,49 @@
+# Slovenian translation for squeekboard.
+# Copyright (C) 2021 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+#
+# Matej Urbančič <mateju@src.gnome.org>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-22 19:14+0000\n"
+"PO-Revision-Date: 2021-12-23 16:17+0100\n"
+"Last-Translator: Matej Urbančič <mateju@svn.gnome.org>\n"
+"Language-Team: Slovenian GNOME Translation Team <gnome-si@googlegroups.com>\n"
+"Language: sl_SI\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=4; plural=(n%100==1 ? 1 : n%100==2 ? 2 : n%100==3 || n"
+"%100==4 ? 3 : 0);\n"
+"X-Poedit-SourceCharset: utf-8\n"
+"X-Generator: Poedit 3.0.1\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Izrazne ikone"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Terminal"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Nastavitve tipkovnice"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Cvilkovnica"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Zaslonska tipkovnica"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "Navidezna zaslonska tipkovnica"

po/sv.po

@@ -0,0 +1,48 @@
+# Swedish translations for squeekboard package.
+# Copyright (C) 2021 THE squeekboard'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+# Automatically generated, 2021.
+#
+# Luna Jernberg <droidbittin@gmail.com>, 2021.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/"
+"issues\n"
+"POT-Creation-Date: 2021-12-22 12:47+0000\n"
+"PO-Revision-Date: 2021-12-22 14:15+0100\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"X-Generator: Poedit 3.0\n"
+"Last-Translator: \n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Language: sv\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr "Emoji"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr "Terminal"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr "Tangentbordsinställningar"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr "Squeekboard"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr "Skärmtangentbord"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr "Ett virtuellt skärmtangentbord"

po/uk.po

@@ -0,0 +1,51 @@
+# Ukrainian translation for squeekboard.
+# Copyright (C) 2021 squeekboard's COPYRIGHT HOLDER
+# This file is distributed under the same license as the squeekboard package.
+#
+# Yuri Chornoivan <yurchor@ukr.net>, 2021.
+msgid ""
+msgstr ""
+"Project-Id-Version: squeekboard master\n"
+"Report-Msgid-Bugs-To: https://gitlab.gnome.org/World/Phosh/squeekboard/issues\n"
+"POT-Creation-Date: 2021-12-22 10:36+0000\n"
+"PO-Revision-Date: 2021-12-22 14:46+0200\n"
+"Last-Translator: Yuri Chornoivan <yurchor@ukr.net>\n"
+"Language-Team: Ukrainian <trans-uk@lists.fedoraproject.org>\n"
+"Language: uk\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=4; plural=n==1 ? 3 : n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n"
+"X-Generator: Lokalize 20.12.0\n"
+
+#. translators: This is a emmoji keyboard layout
+#: data/popover.ui:6
+msgid "Emoji"
+msgstr ""
+"Емодзі"
+
+#. translators: This is a terminal keyboard layout
+#: data/popover.ui:12
+msgid "Terminal"
+msgstr ""
+"Термінал"
+
+#: data/popover.ui:18
+msgid "Keyboard Settings"
+msgstr ""
+"Параметри клавіатури"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:3
+msgid "Squeekboard"
+msgstr ""
+"Squeekboard"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:4
+msgid "On Screen Keyboard"
+msgstr ""
+"Екранна клавіатура"
+
+#: data/sm.puri.Squeekboard.desktop.in.in:5
+msgid "An on screen virtual keyboard"
+msgstr ""
+"Екранна віртуальна клавіатура"

protocols/input-method-unstable-v2.xml

@@ -2,6 +2,9 @@
 <protocol name="input_method_unstable_v2">
 
   <copyright>
+    Copyright © 2008-2011 Kristian Høgsberg
+    Copyright © 2010-2011 Intel Corporation
+    Copyright © 2012-2013 Collabora, Ltd.
     Copyright © 2012, 2013 Intel Corporation
     Copyright © 2015, 2016 Jan Arne Petersen
     Copyright © 2017, 2018 Red Hat, Inc.
@@ -29,14 +32,14 @@
 
   <description summary="Protocol for creating input methods">
     This protocol allows applications to act as input methods for compositors.
-    
+
     An input method context is used to manage the state of the input method.
 
     Text strings are UTF-8 encoded, their indices and lengths are in bytes.
 
     This document adheres to the RFC 2119 when using words like "must",
     "should", "may", etc.
-    
+
     Warning! The protocol described in this file is experimental and
     backward incompatible changes may be made. Backward compatible changes
     may be added together with the corresponding interface version bump.
@@ -72,18 +75,19 @@
         Notification that a text input focused on this seat requested the input
         method to be activated.
 
-        This request must be issued every time a text input requests an input
+        This event serves the purpose of providing the compositor with an
-        method.
+        active input method.
 
-        This request resets all state associated with previous enable, disable,
+        This event resets all state associated with previous enable, disable,
-        set_surrounding_text, set_text_change_cause, set_content_type, and
+        surrounding_text, text_change_cause, and content_type events, as well
-        set_cursor_rectangle requests, as well as the state associated with
+        as the state associated with set_preedit_string, commit_string, and
-        preedit_string, commit_string, and delete_surrounding_text events. In
+        delete_surrounding_text requests. In addition, it marks the
-        addition, it marks the input method object as active.
+        zwp_input_method_v2 object as active, and makes any existing
+        zwp_input_popup_surface_v2 objects visible.
 
-        The set_surrounding_text, set_content_type and set_cursor_rectangle
+        The surrounding_text, and content_type events must follow before the
-        requests must follow before the next done event if the text input
+        next done event if the text input supports the respective
-        supports the respective functionality.
+        functionality.
 
         State set with this event is double-buffered. It will get applied on
         the next zwp_input_method_v2.done event, and stay valid until changed.
@@ -92,13 +96,12 @@
 
     <event name="deactivate">
       <description summary="deactivate event">
-        Notification that this seat's current text input requested the input
+        Notification that no focused text input currently needs an active 
-        method to be deactivated.
+        input method on this seat.
 
-        This event mrks the zwp_input_method_v2 object as inactive.
+        This event marks the zwp_input_method_v2 object as inactive. The
-
+        compositor must make all existing zwp_input_popup_surface_v2 objects
-        When the seat has the keyboard capability the text-input focus follows
+        invisible until the next activate event.
-        the keyboard focus.
 
         State set with this event is double-buffered. It will get applied on
         the next zwp_input_method_v2.done event, and stay valid until changed.
@@ -107,7 +110,7 @@
 
     <event name="surrounding_text">
       <description summary="surrounding text event">
-        Sets the surrounding plain text around the cursor, excluding the
+        Updates the surrounding plain text around the cursor, excluding the
         preedit text.
 
         If any preedit text is present, it is replaced with the cursor for the
@@ -125,7 +128,7 @@
         buffer. If there is no selected text, anchor must be the same as
         cursor.
 
-        If this request does not arrive before the first done event, the input
+        If this event does not arrive before the first done event, the input
         method may assume that the text input does not support this
         functionality and ignore following surrounding_text events.
 
@@ -166,7 +169,7 @@
     <event name="content_type">
       <description summary="content purpose and hint">
         Indicates the content type and hint for the current
-        input_method_context instance.
+        zwp_input_method_v2 instance.
 
         Values set with this event are double-buffered. They will get applied
         on the next zwp_input_method_v2.done event.
@@ -213,14 +216,14 @@
         4000 bytes.
 
         Values set with this event are double-buffered. They must be applied
-        and reset to initial on the next zwp_text_input_v3.done event.
+        and reset to initial on the next zwp_text_input_v3.commit request.
 
         The initial value of text is an empty string.
       </description>
       <arg name="text" type="string"/>
     </request>
 
-    <request name="preedit_string">
+    <request name="set_preedit_string">
       <description summary="pre-edit string">
         Send the pre-edit string text to the application text input.
 
@@ -275,7 +278,7 @@
 
     <request name="commit">
       <description summary="apply state">
-        Apply state changes from commit_string, preedit_string and
+        Apply state changes from commit_string, set_preedit_string and
         delete_surrounding_text requests.
 
         The state relating to these events is double-buffered, and each one
@@ -294,11 +297,10 @@
 
         The serial number reflects the last state of the zwp_input_method_v2
         object known to the client. The value of the serial argument must be
-        equal to the number of commit requests already issued on that object.
+        equal to the number of done events already issued by that object. When
-        When the compositor receives a done event with a serial different than
+        the compositor receives a commit request with a serial different than
-        the number of past commit requests, it must proceed as normal, except
+        the number of past done events, it must proceed as normal, except it
-        it should not change the current state of the zwp_input_method_v2
+        should not change the current state of the zwp_input_method_v2 object.
-        object.
       </description>
       <arg name="serial" type="uint"/>
     </request>
@@ -307,6 +309,10 @@
       <description summary="create popup surface">
         Creates a new zwp_input_popup_surface_v2 object wrapping a given
         surface.
+
+        The surface gets assigned the "input_popup" role. If the surface
+        already has an assigned role, the compositor must issue a protocol
+        error.
       </description>
       <arg name="id" type="new_id" interface="zwp_input_popup_surface_v2"/>
       <arg name="surface" type="object" interface="wl_surface"/>
@@ -327,9 +333,10 @@
 
         Releasing the resulting wl_keyboard object releases the grab.
       </description>
-      <arg name="keyboard" type="new_id" interface="wl_keyboard"/>
+      <arg name="keyboard" type="new_id"
+        interface="zwp_input_method_keyboard_grab_v2"/>
     </request>
-    
+
     <event name="unavailable">
       <description summary="input method unavailable">
         The input method ceased to be available.
@@ -347,15 +354,25 @@
       </description>
     </event>
 
-    <request name="destroy" type="destructor"/>
+    <request name="destroy" type="destructor">
+      <description summary="destroy the text input">
+        Destroys the zwp_text_input_v2 object and any associated child
+        objects, i.e. zwp_input_popup_surface_v2 and
+        zwp_input_method_keyboard_grab_v2.
+      </description>
+    </request>
   </interface>
 
   <interface name="zwp_input_popup_surface_v2" version="1">
     <description summary="popup surface">
-      This surface is a popup for interacting with an input method.
+      This interface marks a surface as a popup for interacting with an input
+      method.
 
       The compositor should place it near the active text input area. It must
       be visible if and only if the input method is in the active state.
+
+      The client must not destroy the underlying wl_surface while the
+      zwp_input_popup_surface_v2 object exists.
     </description>
 
     <event name="text_input_rectangle">
@@ -375,6 +392,75 @@
     <request name="destroy" type="destructor"/>
   </interface>
 
+  <interface name="zwp_input_method_keyboard_grab_v2" version="1">
+    <!-- Closely follows wl_keyboard version 6 -->
+    <description summary="keyboard grab">
+      The zwp_input_method_keyboard_grab_v2 interface represents an exclusive
+      grab of the wl_keyboard interface associated with the seat.
+    </description>
+
+    <event name="keymap">
+      <description summary="keyboard mapping">
+        This event provides a file descriptor to the client which can be
+        memory-mapped to provide a keyboard mapping description.
+      </description>
+      <arg name="format" type="uint" enum="wl_keyboard.keymap_format"
+        summary="keymap format"/>
+      <arg name="fd" type="fd" summary="keymap file descriptor"/>
+      <arg name="size" type="uint" summary="keymap size, in bytes"/>
+    </event>
+
+    <event name="key">
+      <description summary="key event">
+        A key was pressed or released.
+        The time argument is a timestamp with millisecond granularity, with an
+        undefined base.
+      </description>
+      <arg name="serial" type="uint" summary="serial number of the key event"/>
+      <arg name="time" type="uint" summary="timestamp with millisecond granularity"/>
+      <arg name="key" type="uint" summary="key that produced the event"/>
+      <arg name="state" type="uint" enum="wl_keyboard.key_state"
+        summary="physical state of the key"/>
+    </event>
+
+    <event name="modifiers">
+      <description summary="modifier and group state">
+        Notifies clients that the modifier and/or group state has changed, and
+        it should update its local state.
+      </description>
+      <arg name="serial" type="uint" summary="serial number of the modifiers event"/>
+      <arg name="mods_depressed" type="uint" summary="depressed modifiers"/>
+      <arg name="mods_latched" type="uint" summary="latched modifiers"/>
+      <arg name="mods_locked" type="uint" summary="locked modifiers"/>
+      <arg name="group" type="uint" summary="keyboard layout"/>
+    </event>
+
+    <request name="release" type="destructor">
+      <description summary="release the grab object"/>
+    </request>
+
+    <event name="repeat_info">
+      <description summary="repeat rate and delay">
+        Informs the client about the keyboard's repeat rate and delay.
+
+        This event is sent as soon as the zwp_input_method_keyboard_grab_v2
+        object has been created, and is guaranteed to be received by the
+        client before any key press event.
+
+        Negative values for either rate or delay are illegal. A rate of zero
+        will disable any repeating (regardless of the value of delay).
+
+        This event can be sent later on as well with a new value if necessary,
+        so clients should continue listening for the event past the creation
+        of zwp_input_method_keyboard_grab_v2.
+      </description>
+      <arg name="rate" type="int"
+	   summary="the rate of repeating keys in characters per second"/>
+      <arg name="delay" type="int"
+	   summary="delay in milliseconds since key down until repeating starts"/>
+    </event>
+  </interface>
+
   <interface name="zwp_input_method_manager_v2" version="1">
     <description summary="input method manager">
       The input method manager allows the client to become the input method on

protocols/text-input-unstable-v3.xml

@@ -94,6 +94,12 @@
         zwp_text_input_v3.disable when there is no longer any input focus on
         the current surface.
 
+        Clients must not enable more than one text input on the single seat
+        and should disable the current text input before enabling the new one.
+        At most one instance of text input may be in enabled state per instance,
+        Requests to enable the another text input when some text input is active
+        must be ignored by compositor.
+
         This request resets all state associated with previous enable, disable,
         set_surrounding_text, set_text_change_cause, set_content_type, and
         set_cursor_rectangle requests, as well as the state associated with
@@ -307,6 +313,9 @@
       <description summary="enter event">
         Notification that this seat's text-input focus is on a certain surface.
 
+        If client has created multiple text input objects, compositor must send
+        this event to all of them.
+
         When the seat has the keyboard capability the text-input focus follows
         the keyboard focus. This event sets the current surface for the
         text-input object.
@@ -321,7 +330,9 @@
         set.
 
         The leave notification clears the current surface. It is sent before
-        the enter notification for the new focus.
+        the enter notification for the new focus. After leave event, compositor
+        must ignore requests from any text input instances until next enter
+        event.
 
         When the seat has the keyboard capability the text-input focus follows
         the keyboard focus.

src/action.rs

@@ -10,13 +10,14 @@ pub struct KeySym(pub String);
 type View = String;
 
 /// Use to send modified keypresses
-#[derive(Debug, Clone, PartialEq, Eq, Hash)]
+#[derive(Debug, Clone, Copy, 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,
+    Mod4,
 }
 
 /// Action to perform on the keypress and, in reverse, on keyrelease
@@ -29,6 +30,11 @@ pub enum Action {
         lock: View,
         /// When unlocked by pressing it or emitting a key
         unlock: View,
+        /// Whether key has a latched state
+        /// that pops when another key is pressed.
+        latches: bool,
+        /// Should take on *locked* appearance whenever latch comes back to those views.
+        looks_locked_from: Vec<View>,
     },
     /// Hold this modifier for as long as the button is pressed
     ApplyModifier(Modifier),
@@ -48,14 +54,24 @@ pub enum Action {
 impl Action {
     pub fn is_locked(&self, view_name: &str) -> bool {
         match self {
-            Action::LockView { lock, unlock: _ } => lock == view_name,
+            Action::LockView { lock, unlock: _, latches: _, looks_locked_from: _ } => lock == view_name,
+            _ => false,
+        }
+    }
+    pub fn has_locked_appearance_from(&self, locked_view_name: &str) -> bool {
+        match self {
+            Action::LockView { lock: _, unlock: _, latches: _, looks_locked_from } => {
+                looks_locked_from.iter()
+                    .find(|view| locked_view_name == view.as_str())
+                    .is_some()
+            },
             _ => 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,
+            Action::LockView { lock, unlock: _, latches: _, looks_locked_from: _ } => lock == view_name,
             _ => false,
         }
     }

src/animation.rs

@@ -0,0 +1,17 @@
+/* Copyright (C) 2020 Purism SPC
+ * SPDX-License-Identifier: GPL-3.0+
+ */
+
+/*! Animation details */
+
+use std::time::Duration;
+
+/// The keyboard should hide after this has elapsed to prevent flickering.
+pub const HIDING_TIMEOUT: Duration = Duration::from_millis(200);
+
+/// The outwardly visible state of visibility
+#[derive(PartialEq, Debug, Clone)]
+pub enum Outcome {
+    Visible,
+    Hidden,
+}

src/config.h.in

@@ -2,3 +2,9 @@
  * Autogenerated by the Meson build system.
  * Do not edit, your changes will be lost.
  */
+
+#pragma once
+
+#mesondefine GETTEXT_PACKAGE
+
+#mesondefine LOCALEDIR

src/data/loading.rs

@@ -0,0 +1,427 @@
+/* Copyright (C) 2020-2021 Purism SPC
+ * SPDX-License-Identifier: GPL-3.0+
+ */
+
+/*! Loading layout files */
+
+use std::env;
+use std::fmt;
+use std::path::PathBuf;
+use std::convert::TryFrom;
+
+use super::{ Error, LoadError };
+use super::parsing;
+
+use ::layout::ArrangementKind;
+use ::logging;
+use ::util::c::as_str;
+use ::xdg;
+use ::imservice::ContentPurpose;
+
+// traits, derives
+use ::logging::Warn;
+
+
+/// Gathers stuff defined in C or called by C
+pub mod c {
+    use super::*;
+    use std::os::raw::c_char;
+
+    #[no_mangle]
+    pub extern "C"
+    fn squeek_load_layout(
+        name: *const c_char,    // name of the keyboard
+        type_: u32,             // type like Wide
+        variant: u32,          // purpose variant like numeric, terminal...
+        overlay: *const c_char, // the overlay (looking for "terminal")
+    ) -> *mut ::layout::Layout {
+        let type_ = match type_ {
+            0 => ArrangementKind::Base,
+            1 => ArrangementKind::Wide,
+            _ => panic!("Bad enum value"),
+        };
+        
+        let name = as_str(&name)
+            .expect("Bad layout name")
+            .expect("Empty layout name");
+
+        let variant = ContentPurpose::try_from(variant)
+                    .or_print(
+                        logging::Problem::Warning,
+                        "Received invalid purpose value",
+                    )
+                    .unwrap_or(ContentPurpose::Normal);
+
+        let overlay_str = as_str(&overlay)
+                .expect("Bad overlay name")
+                .expect("Empty overlay name");
+        let overlay_str = match overlay_str {
+            "" => None,
+            other => Some(other),
+        };
+
+        let (kind, layout) = load_layout_data_with_fallback(&name, type_, variant, overlay_str);
+        let layout = ::layout::Layout::new(layout, kind, variant);
+        Box::into_raw(Box::new(layout))
+    }
+}
+
+const FALLBACK_LAYOUT_NAME: &str = "us";
+
+
+#[derive(Debug, Clone, PartialEq)]
+enum DataSource {
+    File(PathBuf),
+    Resource(String),
+}
+
+impl fmt::Display for DataSource {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            DataSource::File(path) => write!(f, "Path: {:?}", path.display()),
+            DataSource::Resource(name) => write!(f, "Resource: {}", name),
+        }
+    }
+}
+
+/* All functions in this family carry around ArrangementKind,
+ * because it's not guaranteed to be preserved,
+ * and the resulting layout needs to know which version was loaded.
+ * See `squeek_layout_get_kind`.
+ * Possible TODO: since this is used only in styling,
+ * and makes the below code nastier than needed, maybe it should go.
+ */
+
+/// Returns ordered names treating `name` as the base name,
+/// ignoring any `+` inside.
+fn _get_arrangement_names(name: &str, arrangement: ArrangementKind)
+    -> Vec<(ArrangementKind, String)>
+{
+    let name_with_arrangement = match arrangement {    
+        ArrangementKind::Base => name.into(),
+        ArrangementKind::Wide => format!("{}_wide", name),
+    };
+    
+    let mut ret = Vec::new();
+    if name_with_arrangement != name {
+        ret.push((arrangement, name_with_arrangement));
+    }
+    ret.push((ArrangementKind::Base, name.into()));
+    ret
+}
+
+/// Returns names accounting for any `+` in the `name`,
+/// including the fallback to the default layout.
+fn get_preferred_names(name: &str, kind: ArrangementKind)
+    -> Vec<(ArrangementKind, String)>
+{
+    let mut ret = _get_arrangement_names(name, kind);
+    
+    let base_name_preferences = {
+        let mut parts = name.splitn(2, '+');
+        match parts.next() {
+            Some(base) => {
+                // The name is already equal to base, so nothing to add
+                if base == name {
+                    vec![]
+                } else {
+                    _get_arrangement_names(base, kind)
+                }
+            },
+            // The layout's base name starts with a "+". Weird but OK.
+            None => {
+                log_print!(logging::Level::Surprise, "Base layout name is empty: {}", name);
+                vec![]
+            }
+        }
+    };
+    
+    ret.extend(base_name_preferences.into_iter());
+    let fallback_names = _get_arrangement_names(FALLBACK_LAYOUT_NAME, kind);
+    ret.extend(fallback_names.into_iter());
+    ret
+}
+
+/// Includes the subdirectory before the forward slash.
+type LayoutPath = String;
+
+// This is only used inside iter_fallbacks_with_meta.
+// Placed at the top scope
+// because `use LayoutPurpose::*;`
+// complains about "not in scope" otherwise.
+// This seems to be a Rust 2015 edition problem.
+/// Helper for determining where to look up the layout.
+enum LayoutPurpose<'a> {
+    Default,
+    Special(&'a str),
+}
+
+/// Returns the directory string
+/// where the layout should be looked up, including the slash.
+fn get_directory_string(
+    content_purpose: ContentPurpose,
+    overlay: Option<&str>) -> String
+{
+    use self::LayoutPurpose::*;
+
+    let layout_purpose = match overlay {
+        None => match content_purpose {
+            ContentPurpose::Email => Special("email"),
+            ContentPurpose::Digits => Special("number"),
+            ContentPurpose::Number => Special("number"),
+            ContentPurpose::Phone => Special("number"),
+            ContentPurpose::Pin => Special("pin"),
+            ContentPurpose::Terminal => Special("terminal"),
+            ContentPurpose::Url => Special("url"),
+            _ => Default,
+        },
+        Some(overlay) => Special(overlay),
+    };
+
+    // For intuitiveness,
+    // default purpose layouts are stored in the root directory,
+    // as they correspond to typical text
+    // and are seen the most often.
+    match layout_purpose {
+        Default => "".into(),
+        Special(purpose) => format!("{}/", purpose),
+    }
+}
+
+/// Returns an iterator over all fallback paths.
+fn to_layout_paths(
+    name_fallbacks: Vec<(ArrangementKind, String)>,
+    content_purpose: ContentPurpose,
+    overlay: Option<&str>,
+) -> impl Iterator<Item=(ArrangementKind, LayoutPath)> {
+    let prepend_directory = get_directory_string(content_purpose, overlay);
+
+    name_fallbacks.into_iter()
+        .map(move |(arrangement, name)|
+            (arrangement, format!("{}{}", prepend_directory, name))
+        )
+}
+
+type LayoutSource = (ArrangementKind, DataSource);
+
+fn to_layout_sources(
+    layout_paths: impl Iterator<Item=(ArrangementKind, LayoutPath)>,
+    filesystem_path: Option<PathBuf>,
+) -> impl Iterator<Item=LayoutSource> {
+    layout_paths.flat_map(move |(arrangement, layout_path)| {
+        let mut sources = Vec::new();
+        if let Some(path) = &filesystem_path {
+            sources.push((
+                arrangement,
+                DataSource::File(
+                    path.join(&layout_path)
+                        .with_extension("yaml")
+                )
+            ));
+        };
+        sources.push((arrangement, DataSource::Resource(layout_path.clone())));
+        sources.into_iter()
+    })
+}
+
+/// Returns possible sources, with first as the most preferred one.
+/// Trying order: native lang of the right kind, native base,
+/// fallback lang of the right kind, fallback base
+fn iter_layout_sources(
+    name: &str,
+    arrangement: ArrangementKind,
+    purpose: ContentPurpose,
+    ui_overlay: Option<&str>,
+    layout_storage: Option<PathBuf>,
+) -> impl Iterator<Item=LayoutSource> {
+    let names = get_preferred_names(name, arrangement);
+    let paths = to_layout_paths(names, purpose, ui_overlay);
+    to_layout_sources(paths, layout_storage)
+}
+
+fn load_layout_data(source: DataSource)
+    -> Result<::layout::LayoutData, LoadError>
+{
+    let handler = logging::Print {};
+    match source {
+        DataSource::File(path) => {
+            parsing::Layout::from_file(path.clone())
+                .map_err(LoadError::BadData)
+                .and_then(|layout|
+                    layout.build(handler).0.map_err(LoadError::BadKeyMap)
+                )
+        },
+        DataSource::Resource(name) => {
+            parsing::Layout::from_resource(&name)
+                .and_then(|layout|
+                    layout.build(handler).0.map_err(LoadError::BadKeyMap)
+                )
+        },
+    }
+}
+
+fn load_layout_data_with_fallback(
+    name: &str,
+    kind: ArrangementKind,
+    purpose: ContentPurpose,
+    overlay: Option<&str>,
+) -> (ArrangementKind, ::layout::LayoutData) {
+
+    // Build the path to the right keyboard layout subdirectory
+    let path = env::var_os("SQUEEKBOARD_KEYBOARDSDIR")
+        .map(PathBuf::from)
+        .or_else(|| xdg::data_path("squeekboard/keyboards"));
+
+    for (kind, source) in iter_layout_sources(&name, kind, purpose, overlay, path) {
+        let layout = load_layout_data(source.clone());
+        match layout {
+            Err(e) => match (e, source) {
+                (
+                    LoadError::BadData(Error::Missing(e)),
+                    DataSource::File(file)
+                ) => log_print!(
+                    logging::Level::Debug,
+                    "Tried file {:?}, but it's missing: {}",
+                    file, e
+                ),
+                (e, source) => log_print!(
+                    logging::Level::Warning,
+                    "Failed to load layout from {}: {}, skipping",
+                    source, e
+                ),
+            },
+            Ok(layout) => {
+                log_print!(logging::Level::Info, "Loaded layout {}", source);
+                return (kind, layout);
+            }
+        }
+    }
+
+    panic!("No useful layout found!");
+}
+
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    use ::logging::ProblemPanic;
+
+    #[test]
+    fn parsing_fallback() {
+        assert!(parsing::Layout::from_resource(FALLBACK_LAYOUT_NAME)
+            .map(|layout| layout.build(ProblemPanic).0.unwrap())
+            .is_ok()
+        );
+    }
+    
+    /// First fallback should be to builtin, not to FALLBACK_LAYOUT_NAME
+    #[test]
+    fn test_fallback_basic_builtin() {
+        let sources = iter_layout_sources("nb", ArrangementKind::Base, ContentPurpose::Normal, None, None);
+        
+        assert_eq!(
+            sources.collect::<Vec<_>>(),
+            vec!(
+                (ArrangementKind::Base, DataSource::Resource("nb".into())),
+                (
+                    ArrangementKind::Base,
+                    DataSource::Resource(FALLBACK_LAYOUT_NAME.into())
+                ),
+            )
+        );
+    }
+    
+    /// Prefer loading from file system before builtin.
+    #[test]
+    fn test_preferences_order_path() {
+        let sources = iter_layout_sources("nb", ArrangementKind::Base, ContentPurpose::Normal, None, Some(".".into()));
+        
+        assert_eq!(
+            sources.collect::<Vec<_>>(),
+            vec!(
+                (ArrangementKind::Base, DataSource::File("./nb.yaml".into())),
+                (ArrangementKind::Base, DataSource::Resource("nb".into())),
+                (
+                    ArrangementKind::Base,
+                    DataSource::File("./us.yaml".into())
+                ),
+                (
+                    ArrangementKind::Base,
+                    DataSource::Resource("us".into())
+                ),
+            )
+        );
+    }
+
+    /// If layout contains a "+", it should reach for what's in front of it too.
+    #[test]
+    fn test_preferences_order_base() {
+        let sources = iter_layout_sources("nb+aliens", ArrangementKind::Base, ContentPurpose::Normal, None, None);
+
+        assert_eq!(
+            sources.collect::<Vec<_>>(),
+            vec!(
+                (ArrangementKind::Base, DataSource::Resource("nb+aliens".into())),
+                (ArrangementKind::Base, DataSource::Resource("nb".into())),
+                (
+                    ArrangementKind::Base,
+                    DataSource::Resource(FALLBACK_LAYOUT_NAME.into())
+                ),
+            )
+        );
+    }
+
+    #[test]
+    fn test_preferences_order_arrangement() {
+        let sources = iter_layout_sources("nb", ArrangementKind::Wide, ContentPurpose::Normal, None, None);
+
+        assert_eq!(
+            sources.collect::<Vec<_>>(),
+            vec!(
+                (ArrangementKind::Wide, DataSource::Resource("nb_wide".into())),
+                (ArrangementKind::Base, DataSource::Resource("nb".into())),
+                (
+                    ArrangementKind::Wide,
+                    DataSource::Resource("us_wide".into())
+                ),
+                (
+                    ArrangementKind::Base,
+                    DataSource::Resource("us".into())
+                ),
+            )
+        );
+    }
+
+    #[test]
+    fn test_preferences_order_overlay() {
+        let sources = iter_layout_sources("nb", ArrangementKind::Base, ContentPurpose::Normal, Some("terminal"), None);
+
+        assert_eq!(
+            sources.collect::<Vec<_>>(),
+            vec!(
+                (ArrangementKind::Base, DataSource::Resource("terminal/nb".into())),
+                (
+                    ArrangementKind::Base,
+                    DataSource::Resource("terminal/us".into())
+                ),
+            )
+        );
+    }
+
+    #[test]
+    fn test_preferences_order_hint() {
+        let sources = iter_layout_sources("nb", ArrangementKind::Base, ContentPurpose::Terminal, None, None);
+
+        assert_eq!(
+            sources.collect::<Vec<_>>(),
+            vec!(
+                (ArrangementKind::Base, DataSource::Resource("terminal/nb".into())),
+                (
+                    ArrangementKind::Base,
+                    DataSource::Resource("terminal/us".into())
+                ),
+            )
+        );
+    }
+}

src/data/mod.rs

@@ -0,0 +1,65 @@
+/* Copyright (C) 2020-2021 Purism SPC
+ * SPDX-License-Identifier: GPL-3.0+
+ */
+
+/*! Combined module for dealing with layout files */
+
+mod loading;
+pub mod parsing;
+
+use std::io;
+use std::fmt;
+
+use ::keyboard::FormattingError;
+
+/// Errors encountered loading the layout into yaml
+#[derive(Debug)]
+pub enum Error {
+    Yaml(serde_yaml::Error),
+    Io(io::Error),
+    /// The file was missing.
+    /// It's distinct from Io in order to make it matchable
+    /// without calling io::Error::kind()
+    Missing(io::Error),
+}
+
+impl fmt::Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Error::Yaml(e) => write!(f, "YAML: {}", e),
+            Error::Io(e) => write!(f, "IO: {}", e),
+            Error::Missing(e) => write!(f, "Missing: {}", e),
+        }
+    }
+}
+
+impl From<io::Error> for Error {
+    fn from(e: io::Error) -> Self {
+        let kind = e.kind();
+        match kind {
+            io::ErrorKind::NotFound => Error::Missing(e),
+            _ => Error::Io(e),
+        }
+    }
+}
+
+
+#[derive(Debug)]
+pub enum LoadError {
+    BadData(Error),
+    MissingResource,
+    BadResource(serde_yaml::Error),
+    BadKeyMap(FormattingError),
+}
+
+impl fmt::Display for LoadError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        use self::LoadError::*;
+        match self {
+            BadData(e) => write!(f, "Bad data: {}", e),
+            MissingResource => write!(f, "Missing resource"),
+            BadResource(e) => write!(f, "Bad resource: {}", e),
+            BadKeyMap(e) => write!(f, "Bad key map: {}", e),
+        }
+    }
+}

src/data/parsing.rs

@@ -1,32 +1,30 @@
-/**! The parsing of the data files for layouts */
+/* Copyright (C) 2020-2021 Purism SPC
+ * SPDX-License-Identifier: GPL-3.0+
+ */
 
-// TODO: find a nice way to make sure non-positive sizes don't break layouts
+/*! Parsing of the data files containing layouts */
 
 use std::cell::RefCell;
 use std::collections::{ HashMap, HashSet };
-use std::env;
 use std::ffi::CString;
-use std::fmt;
 use std::fs;
-use std::io;
 use std::path::PathBuf;
 use std::rc::Rc;
 use std::vec::Vec;
 
 use xkbcommon::xkb;
 
+use super::{ Error, LoadError };
+
 use ::action;
 use ::keyboard::{
     KeyState, PressType,
     generate_keymaps, generate_keycodes, KeyCode, FormattingError
 };
 use ::layout;
-use ::layout::ArrangementKind;
 use ::logging;
-use ::resources;
-use ::util::c::as_str;
 use ::util::hash_map_map;
-use ::xdg;
+use ::resources;
 
 // traits, derives
 use serde::Deserialize;
@@ -34,206 +32,7 @@ use std::io::BufReader;
 use std::iter::FromIterator;
 use ::logging::Warn;
 
-/// Gathers stuff defined in C or called by C
+// TODO: find a nice way to make sure non-positive sizes don't break layouts
-pub mod c {
-    use super::*;
-    use std::os::raw::c_char;
-
-    #[no_mangle]
-    pub extern "C"
-    fn squeek_load_layout(
-        name: *const c_char,
-        type_: u32,
-    ) -> *mut ::layout::Layout {
-        let type_ = match type_ {
-            0 => ArrangementKind::Base,
-            1 => ArrangementKind::Wide,
-            _ => panic!("Bad enum value"),
-        };
-        let name = as_str(&name)
-            .expect("Bad layout name")
-            .expect("Empty layout name");
-
-        let (kind, layout) = load_layout_data_with_fallback(&name, type_);
-        let layout = ::layout::Layout::new(layout, kind);
-        Box::into_raw(Box::new(layout))
-    }
-}
-
-const FALLBACK_LAYOUT_NAME: &str = "us";
-
-#[derive(Debug)]
-pub enum LoadError {
-    BadData(Error),
-    MissingResource,
-    BadResource(serde_yaml::Error),
-    BadKeyMap(FormattingError),
-}
-
-impl fmt::Display for LoadError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        use self::LoadError::*;
-        match self {
-            BadData(e) => write!(f, "Bad data: {}", e),
-            MissingResource => write!(f, "Missing resource"),
-            BadResource(e) => write!(f, "Bad resource: {}", e),
-            BadKeyMap(e) => write!(f, "Bad key map: {}", e),
-        }
-    }
-}
-
-#[derive(Debug, Clone, PartialEq)]
-enum DataSource {
-    File(PathBuf),
-    Resource(String),
-}
-
-impl fmt::Display for DataSource {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self {
-            DataSource::File(path) => write!(f, "Path: {:?}", path.display()),
-            DataSource::Resource(name) => write!(f, "Resource: {}", name),
-        }
-    }
-}
-
-type LayoutSource = (ArrangementKind, DataSource);
-
-/// Lists possible sources, with 0 as the most preferred one
-/// Trying order: native lang of the right kind, native base,
-/// fallback lang of the right kind, fallback base
-fn list_layout_sources(
-    name: &str,
-    kind: ArrangementKind,
-    keyboards_path: Option<PathBuf>,
-) -> Vec<LayoutSource> {
-    // Just a simplification of often called code.
-    let add_by_name = |
-        mut ret: Vec<LayoutSource>,
-        name: &str,
-        kind: &ArrangementKind,
-    | -> Vec<LayoutSource> {
-        if let Some(path) = keyboards_path.clone() {
-            ret.push((
-                kind.clone(),
-                DataSource::File(
-                    path.join(name.to_owned()).with_extension("yaml")
-                )
-            ))
-        }
-
-        ret.push((
-            kind.clone(),
-            DataSource::Resource(name.into())
-        ));
-        ret
-    };
-
-    // Another grouping.
-    let add_by_kind = |ret, name: &str, kind| {
-        let ret = match kind {
-            &ArrangementKind::Base => ret,
-            kind => add_by_name(
-                ret,
-                &name_with_arrangement(name.into(), kind),
-                kind,
-            ),
-        };
-
-        add_by_name(ret, name, &ArrangementKind::Base)
-    };
-
-    fn name_with_arrangement(name: String, kind: &ArrangementKind) -> String {
-        match kind {    
-            ArrangementKind::Base => name,
-            ArrangementKind::Wide => name + "_wide",
-        }
-    }
-
-    let ret = Vec::new();
-
-    // Name as given takes priority.
-    let ret = add_by_kind(ret, name, &kind);
-
-    // Then try non-alternative name if applicable (`us` for `us+colemak`).
-    let ret = {
-        let mut parts = name.splitn(2, '+');
-        match parts.next() {
-            Some(base) => {
-                // The name is already equal to base, so it was already added.
-                if base == name { ret }
-                else {
-                    add_by_kind(ret, base, &kind)
-                }
-            },
-            // The layout's base name starts with a "+". Weird but OK.
-            None => {
-                log_print!(logging::Level::Surprise, "Base layout name is empty: {}", name);
-                ret
-            }
-        }
-    };
-
-    // No other choices left, so give anything.
-    add_by_kind(ret, FALLBACK_LAYOUT_NAME.into(), &kind)
-}
-
-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(handler).0.map_err(LoadError::BadKeyMap)
-                )
-        },
-        DataSource::Resource(name) => {
-            Layout::from_resource(&name)
-                .and_then(|layout|
-                    layout.build(handler).0.map_err(LoadError::BadKeyMap)
-                )
-        },
-    }
-}
-
-fn load_layout_data_with_fallback(
-    name: &str,
-    kind: ArrangementKind,
-) -> (ArrangementKind, ::layout::LayoutData) {
-    let path = env::var_os("SQUEEKBOARD_KEYBOARDSDIR")
-        .map(PathBuf::from)
-        .or_else(|| xdg::data_path("squeekboard/keyboards"));
-    
-    for (kind, source) in list_layout_sources(name, kind, path) {
-        let layout = load_layout_data(source.clone());
-        match layout {
-            Err(e) => match (e, source) {
-                (
-                    LoadError::BadData(Error::Missing(e)),
-                    DataSource::File(file)
-                ) => log_print!(
-                    logging::Level::Debug,
-                    "Tried file {:?}, but it's missing: {}",
-                    file, e
-                ),
-                (e, source) => log_print!(
-                    logging::Level::Warning,
-                    "Failed to load layout from {}: {}, skipping",
-                    source, e
-                ),
-            },
-            Ok(layout) => {
-                log_print!(logging::Level::Info, "Loaded layout {}", source);
-                return (kind, layout);
-            }
-        }
-    }
-
-    panic!("No useful layout found!");
-}
 
 /// The root element describing an entire keyboard
 #[derive(Debug, Deserialize, PartialEq)]
@@ -289,7 +88,13 @@ struct ButtonMeta {
 #[serde(deny_unknown_fields)]
 enum Action {
     #[serde(rename="locking")]
-    Locking { lock_view: String, unlock_view: String },
+    Locking {
+        lock_view: String,
+        unlock_view: String,
+        pops: Option<bool>,
+        #[serde(default)]
+        looks_locked_from: Vec<String>,
+    },
     #[serde(rename="set_view")]
     SetView(String),
     #[serde(rename="show_prefs")]
@@ -320,37 +125,6 @@ struct Outline {
     height: f64,
 }
 
-/// Errors encountered loading the layout into yaml
-#[derive(Debug)]
-pub enum Error {
-    Yaml(serde_yaml::Error),
-    Io(io::Error),
-    /// The file was missing.
-    /// It's distinct from Io in order to make it matchable
-    /// without calling io::Error::kind()
-    Missing(io::Error),
-}
-
-impl fmt::Display for Error {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self {
-            Error::Yaml(e) => write!(f, "YAML: {}", e),
-            Error::Io(e) => write!(f, "IO: {}", e),
-            Error::Missing(e) => write!(f, "Missing: {}", e),
-        }
-    }
-}
-
-impl From<io::Error> for Error {
-    fn from(e: io::Error) -> Self {
-        let kind = e.kind();
-        match kind {
-            io::ErrorKind::NotFound => Error::Missing(e),
-            _ => Error::Io(e),
-        }
-    }
-}
-
 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>,
@@ -543,7 +317,7 @@ fn create_action<H: logging::Handler>(
         Text(String),
         Keysym(String),
         Modifier(Modifier),
-    };
+    }
     
     let submission = match (
         &symbol_meta.action,
@@ -600,7 +374,9 @@ fn create_action<H: logging::Handler>(
             )
         ),
         SubmitData::Action(Action::Locking {
-            lock_view, unlock_view
+            lock_view, unlock_view,
+            pops,
+            looks_locked_from,
         }) => ::action::Action::LockView {
             lock: filter_view_name(
                 name,
@@ -614,6 +390,8 @@ fn create_action<H: logging::Handler>(
                 &view_names,
                 warning_handler,
             ),
+            latches: pops.unwrap_or(true),
+            looks_locked_from,
         },
         SubmitData::Action(
             Action::ShowPrefs
@@ -658,6 +436,9 @@ fn create_action<H: logging::Handler>(
             Modifier::Alt => action::Action::ApplyModifier(
                 action::Modifier::Alt,
             ),
+            Modifier::Mod4 => action::Action::ApplyModifier(
+                action::Modifier::Mod4,
+            ),
             unsupported_modifier => {
                 warning_handler.handle(
                     logging::Level::Bug,
@@ -763,10 +544,13 @@ fn extract_symbol_names<'a>(actions: &'a [(&str, action::Action)])
         .map(|named_keysym| named_keysym.0)
 }
 
+
 #[cfg(test)]
 mod tests {
     use super::*;
-
+    
+    use std::env;
+    
     use ::logging::ProblemPanic;
 
     fn path_from_root(file: &'static str) -> PathBuf {
@@ -916,50 +700,6 @@ mod tests {
         );
     }
 
-    #[test]
-    fn parsing_fallback() {
-        assert!(Layout::from_resource(FALLBACK_LAYOUT_NAME)
-            .map(|layout| layout.build(ProblemPanic).0.unwrap())
-            .is_ok()
-        );
-    }
-    
-    /// First fallback should be to builtin, not to FALLBACK_LAYOUT_NAME
-    #[test]
-    fn fallbacks_order() {
-        let sources = list_layout_sources("nb", ArrangementKind::Base, None);
-        
-        assert_eq!(
-            sources,
-            vec!(
-                (ArrangementKind::Base, DataSource::Resource("nb".into())),
-                (
-                    ArrangementKind::Base,
-                    DataSource::Resource(FALLBACK_LAYOUT_NAME.into())
-                ),
-            )
-        );
-    }
-
-    /// If layout contains a "+", it should reach for what's in front of it too.
-    #[test]
-    fn fallbacks_order_base() {
-        let sources = list_layout_sources("nb+aliens", ArrangementKind::Base, None);
-
-        assert_eq!(
-            sources,
-            vec!(
-                (ArrangementKind::Base, DataSource::Resource("nb+aliens".into())),
-                (ArrangementKind::Base, DataSource::Resource("nb".into())),
-                (
-                    ArrangementKind::Base,
-                    DataSource::Resource(FALLBACK_LAYOUT_NAME.into())
-                ),
-            )
-        );
-    }
-    
-
     #[test]
     fn unicode_keysym() {
         let keysym = xkb::keysym_from_name(

src/dbus.c

@@ -19,7 +19,9 @@
 #include "config.h"
 
 #include "dbus.h"
+#include "main.h"
 
+#include <inttypes.h>
 #include <stdio.h>
 #include <gio/gio.h>
 
@@ -44,11 +46,6 @@ dbus_handler_destroy(DBusHandler *service)
         service->introspection_data = NULL;
     }
 
-    if (service->context) {
-        g_signal_handlers_disconnect_by_data (service->context, service);
-        service->context = NULL;
-    }
-
     free(service);
 }
 
@@ -57,38 +54,25 @@ handle_set_visible(SmPuriOSK0 *object, GDBusMethodInvocation *invocation,
                    gboolean arg_visible, gpointer user_data) {
     DBusHandler *service = user_data;
 
-    if (service->context) {
+    if (arg_visible) {
-        if (arg_visible) {
+        squeek_state_send_force_visible (service->state_manager);
-            server_context_service_show_keyboard (service->context);
+    } else {
-        } else {
+        squeek_state_send_force_hidden(service->state_manager);
-            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)
+                      const gchar     *object_path,
+                  struct squeek_state_manager *state_manager)
 {
     DBusHandler *self = calloc(1, sizeof(DBusHandler));
     self->object_path = g_strdup(object_path);
     self->connection = connection;
+    self->state_manager = state_manager;
 
     self->dbus_interface = sm_puri_osk0_skeleton_new();
     g_signal_connect(self->dbus_interface, "handle-set-visible",
@@ -109,16 +93,9 @@ dbus_handler_new (GDBusConnection *connection,
     return self;
 }
 
-void
+// Exported to Rust
-dbus_handler_set_ui_context(DBusHandler *service,
+void dbus_handler_set_visible(DBusHandler *service,
-                             ServerContextService *context)
+                       uint8_t visible)
 {
-    g_return_if_fail (!service->context);
+    sm_puri_osk0_set_visible(service->dbus_interface, visible);
-
-    service->context = context;
-
-    g_signal_connect_swapped (service->context,
-                              "notify::visible",
-                              G_CALLBACK(on_visible),
-                              service);
 }