launcher: Animated vector describing swipe gesture

Replace the short video with an animated vector image that shows the
swipe gesture.

This is much lighter and reliable than the mp4 video, which failed to
play on many devices.

Source for the image of the key is in inkscape SVG format in srcs/res
and is converted to an android drawable when needed. The swipe animation
is hand-written.

.gitattributes

@@ -0,0 +1 @@
+srcs/juloo.keyboard2/ComposeKeyData.java -diff

.github/workflows/check-layouts.yml

@@ -1,19 +1,26 @@
 name: Check layouts
 
-# Runs 'gen_layouts.py' and checks that the generated file were uptodate.
-# This doesn't run 'check_layout.py'.
-
 on:
   workflow_dispatch:
   push:
   pull_request:
 
 jobs:
-  check-layouts:
+  gen-layouts:
+    name: Generated files
     runs-on: ubuntu-latest
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - run: python3 gen_layouts.py
-    - name: Check that the generated layouts.xml is uptodate, run python3 gen_layouts.py otherwise
+    - name: "Check that the generated 'layouts.xml' is uptodate, otherwise run 'python3 gen_layouts.py'"
+      run: git diff --exit-code
+  check-layouts:
+    name: check_layout.output
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+    - run: python3 check_layout.py
+    - name: "Check that the generated 'check_layout.output' is uptodate, otherwise run 'python3 check_layout.py'"
       run: git diff --exit-code

.github/workflows/check-translations.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
     - run: python3 sync_translations.py
-    - name: Check that strings files are uptodate, run python3 sync_translations.py otherwise
-      run: git diff --exit-code
+    - name: "Check that strings files are uptodate, otherwise run 'python3 sync_translations.py'"
+      run: git add -N . && git diff --exit-code

.github/workflows/make-apk.yml

@@ -9,39 +9,41 @@ jobs:
   Build-Apk:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/setup-java@v3
+    - uses: actions/setup-java@v4
       with:
         distribution: 'zulu' # See 'Supported distributions' for available options
-        java-version: '11'
+        java-version: '17'
     - name: Checkout repo
-      uses: actions/checkout@v3
-    - name: Cache debug certificate
-      uses: actions/cache@v3
-      with:
-        path: _build/debug.keystore
-        key: debug-keystore
-    - name: Restore debug keystore from github Secrets 
+      uses: actions/checkout@v4
+    - name: Restore debug keystore from GitHub Secrets
       run: |
-        mkdir -p _build
-        cd "_build"
         # Check if exist and use the secret named DEBUG_KEYSTORE
         # The contents of the secret can be obtained -
-        #    from the debug.keystore.asc from you local _build folder
+        #  from the debug.keystore.asc from you local folder 
+        #  (refer to CONTRIBUTING.md Using the local debug.keystore on the Github CI actions)
         if [[ ! "${{ secrets.DEBUG_KEYSTORE }}" = "" ]]; then
             echo "${{ secrets.DEBUG_KEYSTORE }}" > "debug.keystore.asc"
             if [[ -s "debug.keystore.asc" ]]; then
+                echo "Restoring debug keystore from GitHub secrets"
                 gpg -d --passphrase "debug0" --batch "debug.keystore.asc" > "debug.keystore"
             fi
         fi
-    - name: Build
-      run: make
+    - name: Build debug APK
+      uses: gradle/gradle-build-action@v3
+      env:
+        DEBUG_KEYSTORE: "debug.keystore"
+        DEBUG_KEYSTORE_PASSWORD: debug0
+        DEBUG_KEY_ALIAS: debug
+        DEBUG_KEY_PASSWORD: debug0
+      with:
+        arguments: assembleDebug
     - name: Artifact naming
       run: |
         artifact="${{github.repository_owner}} ${{github.ref_name}}"
         artifact="${artifact//\//-}" # replace slashes
         echo "artifact=${artifact}" >> $GITHUB_ENV
-    - name: Save debug apk
-      uses: actions/upload-artifact@v3
+    - name: Upload debug APK
+      uses: actions/upload-artifact@v4
       with:
         name: "${{env.artifact}} debug_apk"
-        path: _build/*.apk
+        path: build/outputs/apk/debug/*.apk

.gitignore

@@ -1,4 +1,12 @@
 *.keystore
 *.keystore.asc
-_build
 /*-keystore.conf
+*.iml
+.gradle
+/local.properties
+/.idea
+.DS_Store
+/captures
+/build
+# Directory _build is not used anymore
+/_build

AndroidManifest.xml

@@ -1,25 +1,32 @@
 <?xml version="1.0" encoding="utf-8"?>
-<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="juloo.keyboard2" android:versionCode="35" android:versionName="1.23.0" android:hardwareAccelerated="false">
-  <uses-sdk android:minSdkVersion="4" android:targetSdkVersion="33"/>
-  <application android:label="@string/app_name" android:allowBackup="true" android:icon="@drawable/ic_launcher" android:hardwareAccelerated="false">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" android:hardwareAccelerated="false">
+  <uses-permission android:name="android.permission.VIBRATE"/>
+  <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
+
+  <application android:label="@string/app_name" android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:hardwareAccelerated="false">
     <service android:name="juloo.keyboard2.Keyboard2" android:label="@string/app_name" android:permission="android.permission.BIND_INPUT_METHOD" android:exported="true" android:directBootAware="true">
       <intent-filter>
         <action android:name="android.view.InputMethod"/>
       </intent-filter>
       <meta-data android:name="android.view.im" android:resource="@xml/method"/>
     </service>
-    <activity android:name="juloo.keyboard2.SettingsActivity" android:icon="@drawable/ic_launcher" android:label="@string/settings_activity_label" android:theme="@style/android:Theme.DeviceDefault" android:exported="true" android:directBootAware="true">
+    <activity android:name="juloo.keyboard2.SettingsActivity" android:icon="@mipmap/ic_launcher" android:label="@string/settings_activity_label" android:theme="@style/appTheme" android:exported="true" android:directBootAware="true">
       <intent-filter>
         <action android:name="android.intent.action.MAIN"/>
       </intent-filter>
     </activity>
-    <activity android:name="juloo.keyboard2.LauncherActivity" android:icon="@drawable/ic_launcher" android:label="@string/app_name" android:theme="@style/android:Theme.DeviceDefault" android:exported="true" android:directBootAware="true">
+    <activity android:name="juloo.keyboard2.LauncherActivity" android:icon="@mipmap/ic_launcher" android:theme="@style/appTheme" android:exported="true" android:directBootAware="true">
       <intent-filter>
         <action android:name="android.intent.action.MAIN"/>
         <category android:name="android.intent.category.LAUNCHER"/>
       </intent-filter>
     </activity>
   </application>
-  <uses-permission android:name="android.permission.VIBRATE"/>
-  <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
+
+  <!-- To query enabled input methods for voice IME detection -->
+  <queries>
+    <intent>
+      <action android:name="android.view.InputMethod" />
+    </intent>
+  </queries>
 </manifest>

CONTRIBUTING.md

@@ -4,52 +4,46 @@ Thanks for contributing :)
 
 ## Building the app
 
-The application doesn't use Gradle and it might be hard to use some features of
-Android Studio.
-
-Fortunately, there's not many dependencies:
-- OpenJDK 8
+The application uses Gradle and can be used with Android Studio, but using
+Android Studio is not required. The build dependencies are:
+- OpenJDK 17
 - Android SDK: build tools (minimum `28.0.1`), platform `30`
-- Make sure to have the `$ANDROID_HOME` environment variable set.
+
+Python 3 is required to update generated files but not to build the app.
+
+For Android Studio users, no more setup is needed.
 
 For Nix users, the right environment can be obtained with `nix-shell ./shell.nix`.
-Instructions to install Nix are [here](https://nixos.wiki/wiki/Nix_Installation_Guide).
+Instructions to install Nix are [here](https://wiki.nixos.org/wiki/Nix_Installation_Guide).
+
+If you don't use Android Studio or Nix, you have to inform Gradle about the
+location of your Android SDK by either:
+- Setting the `ANDROID_HOME` environment variable to point to the android sdk or
+- Creating the file `local.properties` and writing
+  `sdk.dir=<location_of_android_home>` into it.
 
 Building the debug apk:
 
 ```sh
-make
+./gradlew assembleDebug
 ```
 
-If the build succeed, the debug apk is located in `_build/juloo.keyboard2.debug.apk`.
+Nix users can call gradle directly: `gradle assembleDebug`.
 
-## Using the local debug.keystore on the Github CI actions
-
-It's possible to save the local debug.keystore into a github secret, so the same keystore is utilized to build the debug apk in the CI github actions.
-Doing this, they wil have the same signature, thus the debug apk can be updated without having to uninstall it first.
-
-After you sucessfully run `make`, (thus a debug.keystore exists) you can use this second command to generate a base64 stringified version of it
-
-```sh
-cd _build
-gpg -c --armor --pinentry-mode loopback --passphrase debug0 --yes "debug.keystore"
-```
-
-A file will be generated inside the local `_build/` folder, called `debug.keystore.asc`
-
-You can copy the content of this file, and with that, paste it into a new github secret in your repo settings.
-
-The secret must be named `DEBUG_KEYSTORE`
+If the build succeeds, the debug apk is located in `build/outputs/apk/debug/app-debug.apk`.
 
 ## Debugging on your phone
 
 First [Enable adb debugging on your device](https://developer.android.com/studio/command-line/adb#Enabling).
-Then connect your phone to your computer using an USB cable or wireless
+Then connect your phone to your computer using an USB cable or via wireless
 debugging.
 
+If you use Android Studio, this process will be automatic and you don't have to
+follow this guide anymore.
+
 And finally, install the application with:
 ```sh
-make installd
+./gradlew installDebug
 ```
 
 The released version of the application won't be removed, both versions will
@@ -57,11 +51,13 @@ be installed at the same time.
 
 ## Debugging the application: INSTALL_FAILED_UPDATE_INCOMPATIBLE
 
-`make installd` can fail with the following error message:
+`./gradlew installDebug` can fail with the following error message:
 
 ```
-adb: failed to install _build/juloo.keyboard2.debug.apk: Failure [INSTALL_FAILED_UPDATE_INCOMPATIBLE: Package juloo.keyboard2.debug signatures do not match previously installed version; ignoring!]
-make: *** [Makefile:20: installd] Error 1
+FAILURE: Build failed with an exception.
+* What went wrong:
+Execution failed for task ':installDebug'.
+> java.util.concurrent.ExecutionException: com.android.builder.testing.api.DeviceException: com.android.ddmlib.InstallException: INSTALL_FAILED_UPDATE_INCOMPATIBLE: Existing package juloo.keyboard2.debug signatures do not match newer version; ignoring!
 ```
 
 The application can't be "updated" because the temporary certificate has been
@@ -70,36 +66,57 @@ The application must be enabled again in the settings.
 
 ```sh
 adb uninstall juloo.keyboard2.debug
-make installd
+./gradlew installDebug
 ```
 
+## Specifying a debug signing certificate on Github Actions
+
+It's possible to specify the signing certificate that the automated build
+should use.
+After you successfully run `./gradlew asssembleDebug`, (thus a debug.keystore
+exists) you can use this second command to generate a base64 stringified
+version of it:
+
+```sh
+gpg -c --armor --pinentry-mode loopback --passphrase debug0 --yes "debug.keystore"
+```
+
+This will create the file `debug.keystore.asc`, paste its content into a new
+Github secret named `DEBUG_KEYSTORE`.
+
 ## Guidelines
 
 ### Adding a layout
 
-Layouts are defined in XML, see `res/xml/latn_qwerty_us.xml`.
+Layouts are defined in XML, see `srcs/layouts/latn_qwerty_us.xml`.
 An online tool for editing layout files written by @Lixquid is available
 [here](https://unexpected-keyboard-layout-editor.lixquid.com/).
 
 Makes sure to specify the `name` attribute like in `latn_qwerty_us.xml`,
 otherwise the layout won't be added to the app.
 
-The layout file must be placed in the `res/xml/` directory and named according to:
+The layout file must be placed in the `srcs/layouts` directory and named
+according to:
 - script (`latn` for latin, etc..)
 - layout name (eg. the name of a standard)
 - country code (or language code if more adequate)
 
-Then, run `make gen_layouts` to add the layout to the app.
+Then, run `./gradlew genLayoutsList` to add the layout to the app.
 
 The last step will update the file `res/values/layouts.xml`, that you should
 not edit directly.
 
-Run `make check_layouts` to check some properties about your layout. This will
-change the file `check_layout.output`, which you should commit.
+Run `./gradlew checkKeyboardLayouts` to check some properties about your
+layout. This will change the file `check_layout.output`, which you should
+commit.
+
+Layouts are CC0 licensed by default. If you do not want your layout to be
+released into the public domain, add a copyright notice at the top of the file
+and a mention in `srcs/layouts/LICENSE`.
 
 #### Adding a programming layout
 
-A programming layout must contains every ASCII characters.
+A programming layout must contain all ASCII characters.
 The current programming layouts are: QWERTY, Dvorak and Colemak.
 
 See for example, Dvorak, added in https://github.com/Julow/Unexpected-Keyboard/pull/16
@@ -133,32 +150,52 @@ and other extra keys to show.
 
 The list of language tags (generally two letters)
 and locales (generally of the form `xx_XX`)
-can be found in this stackoverflow answer: https://stackoverflow.com/a/7989085
+can be found in this [stackoverflow answer](https://stackoverflow.com/a/7989085)
 
-### Translations
+### Updating translations
 
-Translations are always welcome !
+The text used in the app is written in `res/values-<language_tag>/strings.xml`.
 
-See for example: 1723288 (Latvian), baf867a (French).
-The app can be translated by writing `res/values-<language code>/strings.xml`
-(for example `values-fr`, `values-lv`), based on the default:
-`res/values/strings.xml` (English).
+The list of language tags can be found in this
+[stackoverflow answer](https://stackoverflow.com/a/7989085)
+
+The first part before the `_` is used, for example,
+`res/values-fr/strings.xml` for French,
+`res/values-lv/strings.xml` for Latvian.
+
+Commented-out lines indicate missing translations:
+
+```xml
+  <!-- <string name="pref_layouts_add">Add an alternate layout</string> -->
+```
+
+Remove the `<!--` and `-->` parts and change the text.
+
+### Adding a translation
+
+The `res/values-<language_tag>/strings.xml` file must be created by copying the
+default translation in `res/values/strings.xml`, which contain the structure of
+the file and the English strings.
 
 To check that `strings.xml` is formatted correctly, run
 `python sync_translations.py`. This will modify your files.
 
-The store description is found in `metadata/android/<locale>/`,
-`short_description.txt` and `full_description.txt`.
-The short description must not exceed 80 characters.
+Store descriptions in `fastlane/metadata/android/` are updated automatically.
 Translating changelogs is not useful.
 
-The app name might be partially translated, the "unexpected" word should remain
-untranslated.
+The app name might be partially translated, the "Unexpected" word should remain
+untranslated if possible.
 
 As translations need to be updated regularly, you can subscribe to this issue
 to receive a notification when an update is needed:
 https://github.com/Julow/Unexpected-Keyboard/issues/373
 
+### Adding Compose key sequences
+
+New Compose sequences can be added into `srcs/compose/compose/extra.json`.
+If a entirely new family of sequences were to be added, a new `.json` file can
+be created in the same directory to host them.
+
 ### Adding key combinations
 
 Key combinations are defined in `srcs/juloo.keyboard2/KeyModifier.java`.

FUNDING.yml

@@ -0,0 +1,3 @@
+github: [ Julow ]
+liberapay: Julow
+custom: [ "https://paypal.me/JulesAguillon" ]

Makefile

@@ -1,139 +0,0 @@
-# Configuration
-
-PACKAGE_NAME = juloo.keyboard2
-
-ANDROID_PLATFORM_VERSION = android-30
-JAVA_VERSION = 1.7
-
-SRC_DIR = srcs
-RES_DIR = res
-
-EXTRA_JARS =
-
-# /
-
-debug: _build/$(PACKAGE_NAME).debug.apk
-release: _build/$(PACKAGE_NAME).apk
-
-installd: _build/$(PACKAGE_NAME).debug.apk
-	adb install -r "$<"
-
-clean:
-	rm -rf _build/*.dex _build/class _build/gen _build/*.apk _build/*.unsigned-apk \
-		_build/*.idsig _build/assets
-
-rebuild_special_font: _build/special_font.ttf
-	cp "$<" srcs/special_font/result.ttf
-
-sync_translations:
-	python sync_translations.py
-
-check_layouts:
-	python check_layout.py $(wildcard res/xml/*.xml) > check_layout.output
-
-gen_layouts:
-	python gen_layouts.py
-
-# Will modify the source tree.
-runtest: rebuild_special_font sync_translations check_layouts gen_layouts
-
-.PHONY: release debug installd clean rebuild_special_font check_layouts \
-	sync_translations runtest gen_layouts
-
-$(shell mkdir -p _build)
-
-ifndef ANDROID_HOME
-$(error ANDROID_HOME not set)
-endif
-
-ANDROID_BUILD_TOOLS = $(lastword $(sort $(wildcard $(ANDROID_HOME)/build-tools/*)))
-ANDROID_PLATFORM = $(ANDROID_HOME)/platforms/$(ANDROID_PLATFORM_VERSION)
-
-ifeq ($(shell [ -d "$(ANDROID_PLATFORM)" ] && echo ok),)
-$(error Android platform not found. Want $(ANDROID_PLATFORM_VERSION), \
-	found $(notdir $(wildcard $(ANDROID_HOME)/platforms/*)))
-endif
-
-JAVAC_FLAGS = -source $(JAVA_VERSION) -target $(JAVA_VERSION) -encoding utf8
-
-# Source files
-
-MANIFEST_FILE = AndroidManifest.xml
-JAVA_FILES = $(shell find $(SRC_DIR) -name '*.java')
-RES_FILES = $(shell find $(RES_DIR) -type f)
-
-# Debug signing
-
-DEBUG_KEYSTORE = _build/debug.keystore
-DEBUG_PASSWD = debug0
-
-$(DEBUG_KEYSTORE):
-	echo y | keytool -genkeypair -dname "cn=d, ou=e, o=b, c=ug" \
-		-alias debug -keypass $(DEBUG_PASSWD) -keystore "$@" \
-		-keyalg rsa -storepass $(DEBUG_PASSWD) -validity 10000
-
-_build/%.debug.apk: _build/%.debug.unsigned-apk $(DEBUG_KEYSTORE)
-	$(ANDROID_BUILD_TOOLS)/apksigner sign --in "$<" --out "$@" \
-		--ks $(DEBUG_KEYSTORE) --ks-key-alias debug --ks-pass "pass:$(DEBUG_PASSWD)"
-
-# Debug apk
-
-_build/$(PACKAGE_NAME).debug.unsigned-apk: AAPT_PACKAGE_FLAGS+=--rename-manifest-package $(PACKAGE_NAME).debug --product debug
-
-# Release signing
-
-# %-keystore.conf should declare KEYSTORE, KEYNAME and KEYSTOREPASS
-#  it is interpreted as a shell script
-_build/%.apk: _build/%.unsigned-apk %-keystore.conf
-	eval `cat $(word 2,$^)` && \
-	$(ANDROID_BUILD_TOOLS)/apksigner sign --in "$<" --out "$@" \
-		--ks "$$KEYSTORE" --ks-key-alias "$$KEYNAME" --ks-pass "pass:$$KEYSTOREPASS"
-
-# Package
-
-_build/%.unsigned-apk: _build/%.unaligned-apk
-	$(ANDROID_BUILD_TOOLS)/zipalign -fp 4 "$<" "$@"
-
-APK_EXTRA_FILES = classes.dex assets/special_font.ttf
-
-_build/%.unaligned-apk: $(addprefix _build/,$(APK_EXTRA_FILES)) $(MANIFEST_FILE)
-	$(ANDROID_BUILD_TOOLS)/aapt package -f -M $(MANIFEST_FILE) -S $(RES_DIR) \
-		-I $(ANDROID_PLATFORM)/android.jar -F "$@" $(AAPT_PACKAGE_FLAGS)
-	cd $(@D) && $(ANDROID_BUILD_TOOLS)/aapt add $(@F) $(APK_EXTRA_FILES)
-
-# Copy the special font file into _build because aapt requires relative paths
-_build/assets/special_font.ttf: srcs/special_font/result.ttf
-	mkdir -p $(@D)
-	cp "$<" "$@"
-
-# R.java
-
-GEN_DIR = _build/gen
-R_FILE = $(GEN_DIR)/$(subst .,/,$(PACKAGE_NAME))/R.java
-
-$(R_FILE): $(RES_FILES) $(MANIFEST_FILE)
-	mkdir -p "$(@D)"
-	$(ANDROID_BUILD_TOOLS)/aapt package -f -m -S $(RES_DIR) -J $(GEN_DIR) \
-		-M $(MANIFEST_FILE) -I $(ANDROID_PLATFORM)/android.jar
-
-# Compile java classes and build classes.dex
-
-OBJ_DIR = _build/class
-# A$B.class files are ignored
-# CLASS_FILES = $(JAVA_FILES:$(SRC_DIR)/%.java=$(OBJ_DIR)/%.class) \
-# 	$(R_FILE:$(GEN_DIR)/%.java=$(OBJ_DIR)/%.class)
-
-_build/classes.dex: $(JAVA_FILES) $(R_FILE)
-	mkdir -p $(OBJ_DIR)
-	javac -d $(OBJ_DIR) $(JAVAC_FLAGS) \
-		-classpath $(ANDROID_PLATFORM)/android.jar:$(EXTRA_JARS) \
-		-sourcepath $(SRC_DIR):$(GEN_DIR) \
-		$^
-	$(ANDROID_BUILD_TOOLS)/d8 --output $(@D) $(OBJ_DIR)/*/*/* $(subst :, ,$(EXTRA_JARS))
-
-# Font file
-
-FONT_GLYPHS = $(wildcard srcs/special_font/*.svg)
-
-_build/special_font.ttf: srcs/special_font/build.pe $(FONT_GLYPHS)
-	fontforge -lang=ff -script $< "$@" $(FONT_GLYPHS)

README.md

@@ -9,9 +9,7 @@
 
 Lightweight and privacy-conscious virtual keyboard for Android.
 
-| <img src="/metadata/android/en-US/images/phoneScreenshots/1.png" alt="Screenshot-1" /> | <img src="/metadata/android/en-US/images/phoneScreenshots/2.png" alt="Screenshot-2"/> | <img src="/metadata/android/en-US/images/phoneScreenshots/3.png" alt="Screenshot-3"/> |
-| --- | --- | --- |
-| <img src="/metadata/android/en-US/images/phoneScreenshots/4.png" alt="Screenshot-4" /> | <img src="/metadata/android/en-US/images/phoneScreenshots/5.png" alt="Screenshot-5" /> | <img src="/metadata/android/en-US/images/phoneScreenshots/6.png" alt="Screenshot-6" /> |
+https://github.com/Julow/Unexpected-Keyboard/assets/2310568/28f8f6fe-ac13-46f3-8c5e-d62443e16d0d
 
 The main feature is that you can type more characters by swiping the keys towards the corners.
 
@@ -20,8 +18,14 @@ Now perfect for everyday use.
 
 This application contains no ads, doesn't make any network requests and is Open Source.
 
+Usage: to apply the symbols located in the corners of each key, slide your finger in the direction of the symbols. For example, the Settings are opened by sliding in the left down corner.
+
+| <img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" alt="Screenshot-1" /> | <img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" alt="Screenshot-2"/> | <img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" alt="Screenshot-3"/> |
+| --- | --- | --- |
+| <img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" alt="Screenshot-4" /> | <img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" alt="Screenshot-5" /> | <img src="/fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" alt="Screenshot-6" /> |
+
 ## Similar apps
-* [Calculator++](https://github.com/Bubu/android-calculatorpp) - Calculator with a similar UX, swipe to corners for advanced math symbols and operators. Works up to Android 13 but maybe unmaintained.
+* [Calculator++](https://git.bubu1.eu/Bubu/android-calculatorpp) - Calculator with a similar UX, swipe to corners for advanced math symbols and operators.
 
 ## Contributing
 

build.gradle

@@ -0,0 +1,199 @@
+plugins {
+  id 'com.android.application' version '8.1.1'
+}
+
+dependencies {
+  testImplementation "junit:junit:4.13.2"
+}
+
+android {
+  namespace 'juloo.keyboard2'
+  compileSdk 34
+
+  defaultConfig {
+    applicationId "juloo.keyboard2"
+    minSdk 11
+    targetSdkVersion 35
+    versionCode 42
+    versionName "1.29.1"
+  }
+
+  sourceSets {
+    main {
+      manifest.srcFile 'AndroidManifest.xml'
+      java.srcDirs = ['srcs/juloo.keyboard2']
+      res.srcDirs = ['res', 'build/generated-resources']
+      assets.srcDirs = ['assets']
+    }
+
+    test {
+      java.srcDirs = ['test']
+    }
+  }
+
+  signingConfigs {
+    // Debug builds will always be signed. If no environment variables are set, a default
+    // keystore will be initialized by the task initDebugKeystore and used. This keystore
+    // can be uploaded to GitHub secrets by following instructions in CONTRIBUTING.md
+    // in order to always receive correctly signed debug APKs from the CI.
+    debug {
+      storeFile(System.env.DEBUG_KEYSTORE ? file(System.env.DEBUG_KEYSTORE) : file("debug.keystore"))
+      storePassword(System.env.DEBUG_KEYSTORE_PASSWORD ? "$System.env.DEBUG_KEYSTORE_PASSWORD" : "debug0")
+      keyAlias(System.env.DEBUG_KEY_ALIAS ? "$System.env.DEBUG_KEY_ALIAS" : "debug")
+      keyPassword(System.env.DEBUG_KEY_PASSWORD ? "$System.env.DEBUG_KEY_PASSWORD" : "debug0")
+    }
+
+    release {
+      if (System.env.RELEASE_KEYSTORE) {
+        storeFile file(System.env.RELEASE_KEYSTORE)
+        storePassword "$System.env.RELEASE_KEYSTORE_PASSWORD"
+        keyAlias "$System.env.RELEASE_KEY_ALIAS"
+        keyPassword "$System.env.RELEASE_KEY_PASSWORD"
+      }
+    }
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled true
+      shrinkResources true
+      debuggable false
+      proguardFiles getDefaultProguardFile('proguard-android-optimize.txt')
+      resValue "string", "app_name", "@string/app_name_release"
+      signingConfig signingConfigs.release
+    }
+
+    debug {
+      minifyEnabled false
+      shrinkResources false
+      debuggable true
+      applicationIdSuffix ".debug"
+      resValue "string", "app_name", "@string/app_name_debug"
+      resValue "bool", "debug_logs", "true"
+      signingConfig signingConfigs.debug
+    }
+  }
+
+  // Name outputs after the application ID.
+  android.applicationVariants.all { variant ->
+    variant.outputs.all {
+      outputFileName = "${applicationId}.apk"
+    }
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_7
+    targetCompatibility JavaVersion.VERSION_1_7
+  }
+
+  lintOptions {
+    // Translation are already checked by 'syncTranslations'
+    disable 'MissingTranslation'
+  }
+}
+
+tasks.register('buildKeyboardFont') {
+  println "\nBuilding assets/special_font.ttf"
+  mkdir "$buildDir"
+  exec {
+    workingDir "$projectDir/srcs/special_font"
+    def svgFiles = workingDir.listFiles().findAll {
+      it.isFile() && it.name.endsWith(".svg")
+    }
+    commandLine("fontforge", "-lang=ff", "-script", "build.pe", "$buildDir/special_font.ttf", *svgFiles)
+  }
+  copy {
+    from "$buildDir/special_font.ttf"
+    into "assets"
+  }
+}
+
+tasks.register('genEmojis') {
+  println "\nGenerating res/raw/emojis.txt"
+  exec {
+    workingDir = projectDir
+    commandLine "python", "gen_emoji.py"
+  }
+}
+
+tasks.withType(Test).configureEach {
+  dependsOn 'genLayoutsList'
+  dependsOn 'checkKeyboardLayouts'
+  dependsOn 'syncTranslations'
+  dependsOn 'compileComposeSequences'
+}
+
+tasks.register('genLayoutsList') {
+  println "\nGenerating res/values/layouts.xml"
+  exec {
+    workingDir = projectDir
+    commandLine "python", "gen_layouts.py"
+  }
+}
+
+tasks.register('checkKeyboardLayouts') {
+  println "\nChecking layouts"
+  exec {
+    def layouts = new File(projectDir, "srcs/layouts").listFiles().findAll {
+      it.name.endsWith(".xml")
+    }
+    workingDir = projectDir
+    commandLine("python", "check_layout.py", *layouts)
+    standardOutput = new FileOutputStream("${projectDir}/check_layout.output")
+  }
+}
+
+tasks.register('syncTranslations') {
+  println "\nUpdating translations"
+  exec {
+    workingDir = projectDir
+    commandLine "python", "sync_translations.py"
+  }
+}
+
+tasks.register('compileComposeSequences') {
+  def out = "srcs/juloo.keyboard2/ComposeKeyData.java"
+  println "\nGenerating ${out}"
+  exec {
+    def sequences = new File(projectDir, "srcs/compose").listFiles().findAll {
+      !it.name.endsWith(".py") && !it.name.endsWith(".md")
+    }
+    workingDir = projectDir
+    commandLine("python", "srcs/compose/compile.py", *sequences)
+    standardOutput = new FileOutputStream("${projectDir}/${out}")
+  }
+}
+
+tasks.named("preBuild") {
+  dependsOn += "initDebugKeystore"
+  dependsOn += "copyRawQwertyUS"
+  dependsOn += "copyLayoutDefinitions"
+}
+
+tasks.register('initDebugKeystore') {
+  if (!file("debug.keystore").exists()) {
+    println "Initializing default debug keystore"
+    exec {
+      // A shell script might be needed if this line requires input from the user
+      commandLine "keytool", "-genkeypair", "-dname", "cn=d, ou=e, o=b, c=ug", "-alias", "debug", "-keypass", "debug0", "-keystore", "debug.keystore", "-keyalg", "rsa", "-storepass", "debug0", "-validity", "10000"
+    }
+  }
+}
+
+// latn_qwerty_us is used as a raw resource by the custom layout option.
+tasks.register('copyRawQwertyUS')
+{
+  copy {
+    from "srcs/layouts/latn_qwerty_us.xml"
+    into "build/generated-resources/raw"
+  }
+}
+
+tasks.register('copyLayoutDefinitions')
+{
+  copy {
+    from "srcs/layouts"
+    include "*.xml"
+    into "build/generated-resources/xml"
+  }
+}

check_layout.output

@@ -1,107 +1,148 @@
-# res/xml/arab_alt.xml
+# arab_alt
 Layout includes some ASCII punctuation but not all, missing: !, ", ', +, -, /, :, ;, <, =, >, ?, [, \, ], _, |, ~
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
-2 warnings
-# res/xml/arab_pc_ckb.xml
-Layout includes some ASCII punctuation but not all, missing: ", %, ', +, ,, ., :, ;, <, =, >, ?, `, |, ~
 1 warnings
-# res/xml/arab_pc_ir.xml
-Duplicate keys: (, )
-Layout includes some ASCII punctuation but not all, missing: ", %, ', ,, /, ;, <, =, >, ?, [, \, ], `, {, |, }
+# arab_hamvaj_tly
+Layout includes some ASCII punctuation but not all, missing: ", %, ', ,, /, ;, <, =, >, ?, [, \, ], _, `, {, |, }
+Layout doesn't define some important keys, missing: loc esc
 2 warnings
-# res/xml/arab_pc.xml
+# arab_pc
 Layout includes some ASCII punctuation but not all, missing: !, ', +, ;, ?, \, |
 1 warnings
-# res/xml/beng_national.xml
+# arab_pc_ckb
+Layout includes some ASCII punctuation but not all, missing: ", %, ', +, ,, ., :, ;, <, =, >, ?, `, |, ~
+1 warnings
+# arab_pc_hindu
+Layout includes some ASCII punctuation but not all, missing: !, ', +, ;, ?, \, |
+1 warnings
+# arab_pc_ir
+Layout includes some ASCII punctuation but not all, missing: ", %, ', ,, /, ;, <, =, >, ?, [, \, ], `, {, |, }
+1 warnings
+# armenian_ph_am
+0 warnings
+# beng_national
 Layout includes some ASCII punctuation but not all, missing: $
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
-Layout doesn't specify a script.
-3 warnings
-# res/xml/beng_provat.xml
+1 warnings
+# beng_provat
 Layout includes some ASCII punctuation but not all, missing: $, &, *, ., /, <, >, [, \, ], `, {, |, }
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
-Layout doesn't specify a script.
-3 warnings
-# res/xml/cyrl_jcuken_ru.xml
+1 warnings
+# cyrl_jcuken_ru
 0 warnings
-# res/xml/cyrl_jcuken_uk.xml
+# cyrl_jcuken_uk
 0 warnings
-# res/xml/cyrl_yaverti.xml
+# cyrl_lynyertz_sr
+0 warnings
+# cyrl_ueishsht
+0 warnings
+# cyrl_yaverti
 Layout includes some ASCII punctuation but not all, missing: ~
 1 warnings
-# res/xml/deva_alt.xml
-Layout includes some ASCII punctuation but not all, missing: #, $, %, &, ', (, ), *, +, ., /, :, <, =, >, @, [, \, ], ^, _, `, {, |, }, ~
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
+# cyrl_yqukeng_tj
+Layout doesn't define some important keys, missing: loc esc, loc tab
+These keys are now added automatically, unexpected: f11_placeholder, f12_placeholder
 2 warnings
-# res/xml/deva_inscript.xml
-Duplicate keys: , ।
-Layout includes some ASCII punctuation but not all, missing: ", $, ', ^, _, `, |
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
+# cyrl_yxukeng_os
+Layout includes some ASCII punctuation but not all, missing: ", #, $, &, ', @, [, ], ~
+Layout doesn't define some important keys, missing: loc esc, loc tab
+These keys are now added automatically, unexpected: f11_placeholder, f12_placeholder
 3 warnings
-# res/xml/grek_qwerty.xml
+# deva_alt
+Layout includes some ASCII punctuation but not all, missing: #, $, %, &, ', (, ), +, ., /, :, <, =, >, [, \, ], ^, _, `, {, |, }, ~
+Layout doesn't define some important keys, missing: loc esc, loc tab
+2 warnings
+# deva_inscript
+Duplicate keys: ।
+Layout includes some ASCII punctuation but not all, missing: ", $, ', ^, _, `, |
+2 warnings
+# grek_qwerty
 Duplicate keys: ;
 1 warnings
-# res/xml/hang_dubeolsik_kr.xml
-0 warnings
-# res/xml/hebr_1_il.xml
+# guj_phonetic_in
+Duplicate keys: ટ, ડ
+1 warnings
+# hang_dubeolsik_kr
+Layout doesn't define some important keys, missing: loc esc, loc tab
+1 warnings
+# hebr_1_il
 Layout includes some ASCII punctuation but not all, missing: (, ), <, >, [, ], {, }
 1 warnings
-# res/xml/hebr_2_il.xml
+# hebr_2_il
 Layout includes some ASCII punctuation but not all, missing: (, ), <, >, [, ], {, }
 1 warnings
-# res/xml/latn_azerty_fr.xml
+# latn_azerty_fr
 0 warnings
-# res/xml/latn_bone.xml
-Layout includes some ASCII punctuation but not all, missing: $
-Layout redefines the bottom row but some important keys are missing, missing: switch_backward
+# latn_bepo_fr
+0 warnings
+# latn_bone
+Layout doesn't define some important keys, missing: loc esc, loc tab
+Layout redefines the bottom row but some important keys are missing, missing: cursor_left, cursor_right, loc compose, loc end, loc home, loc page_down, loc page_up, loc switch_clipboard, loc switch_greekmath, loc voice_typing, switch_backward
 2 warnings
-# res/xml/latn_colemak.xml
+# latn_colemak
+Some keys contain whitespaces, unexpected:  ́
+1 warnings
+# latn_dvorak
 0 warnings
-# res/xml/latn_dvorak.xml
+# latn_neo2
+Layout redefines the bottom row but some important keys are missing, missing: loc switch_clipboard
+1 warnings
+# latn_qwerty_br
 0 warnings
-# res/xml/latn_neo2.xml
-Duplicate keys: -
-Layout redefines the bottom row but some important keys are missing, missing: switch_forward
-2 warnings
-# res/xml/latn_qwerty_br.xml
+# latn_qwerty_cz
 0 warnings
-# res/xml/latn_qwerty_es.xml
+# latn_qwerty_da
 0 warnings
-# res/xml/latn_qwerty_hu.xml
+# latn_qwerty_es
 0 warnings
-# res/xml/latn_qwerty_lv.xml
+# latn_qwerty_gb
 0 warnings
-# res/xml/latn_qwerty_no.xml
+# latn_qwerty_hu
 0 warnings
-# res/xml/latn_qwerty_pl.xml
+# latn_qwerty_jp
 0 warnings
-# res/xml/latn_qwerty_ro.xml
+# latn_qwerty_lv
 0 warnings
-# res/xml/latn_qwerty_se.xml
+# latn_qwerty_no
+0 warnings
+# latn_qwerty_pl
+0 warnings
+# latn_qwerty_ro
+0 warnings
+# latn_qwerty_se
 Duplicate keys: !, ', ,, -, ., ?
 1 warnings
-# res/xml/latn_qwerty_tr.xml
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
-1 warnings
-# res/xml/latn_qwerty_us.xml
+# latn_qwerty_sk
 0 warnings
-# res/xml/latn_qwerty_vi.xml
-Layout includes some ASCII punctuation but not all, missing: \
-1 warnings
-# res/xml/latn_qwertz_cz_multifunctional.xml
+# latn_qwerty_sr
+0 warnings
+# latn_qwerty_tly
+Duplicate keys: a, c, j, q
+Layout doesn't define some important keys, missing: loc esc, loc tab
+2 warnings
+# latn_qwerty_tr
+0 warnings
+# latn_qwerty_us
+0 warnings
+# latn_qwerty_vi
+0 warnings
+# latn_qwertz
+0 warnings
+# latn_qwertz_cz
+0 warnings
+# latn_qwertz_cz_multifunctional
 Layout includes some ASCII punctuation but not all, missing: `
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
-2 warnings
-# res/xml/latn_qwertz_cz.xml
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
 1 warnings
-# res/xml/latn_qwertz_de.xml
+# latn_qwertz_de
 0 warnings
-# res/xml/latn_qwertz_hu.xml
+# latn_qwertz_fr_ch
 0 warnings
-# res/xml/latn_qwertz_sk.xml
-Layout includes some ASCII punctuation but not all, missing: \, `
-Layout doesn't define some important keys, missing: f11_placeholder, f12_placeholder
-2 warnings
-# res/xml/latn_qwertz.xml
+# latn_qwertz_hu
 0 warnings
+# latn_qwertz_sk
+Layout includes some ASCII punctuation but not all, missing: `
+1 warnings
+# shaw_imperial_en
+0 warnings
+# urdu_phonetic_ur
+Duplicate keys:  
+Layout includes some ASCII punctuation but not all, missing: <, >, ?, `, |, ~
+Some keys contain whitespaces, unexpected:  
+3 warnings

check_layout.py

@@ -1,12 +1,19 @@
 import xml.etree.ElementTree as ET
-import sys
+import sys, os
 
 warning_count = 0
 
 KNOWN_NOT_LAYOUT = set([
-    "res/xml/number_row.xml", "res/xml/numpad.xml", "res/xml/pin.xml",
-    "res/xml/bottom_row.xml", "res/xml/settings.xml", "res/xml/method.xml",
-    "res/xml/greekmath.xml", "res/xml/numeric.xml" ])
+    "number_row", "numpad", "pin",
+    "bottom_row", "settings", "method",
+    "greekmath", "numeric", "emoji_bottom_row",
+    "clipboard_bottom_row" ])
+
+KEY_ATTRIBUTES = set([
+    "key0",
+    "key1", "key2", "key3", "key4", "key5", "key6", "key7", "key8",
+    "nw", "ne", "sw", "se", "w", "e", "n", "s"
+    ])
 
 def warn(msg):
     global warning_count
@@ -34,6 +41,15 @@ def unexpected_keys(keys, symbols, msg):
     if len(unexpected) > 0:
         warn("%s, unexpected: %s" % (msg, key_list_str(unexpected)))
 
+# Write to [keys] and [dup].
+def parse_row_from_et(row, keys, dup):
+    for key in row:
+        for attr in key.keys():
+            if attr in KEY_ATTRIBUTES:
+                k = key.get(attr).removeprefix("\\")
+                if k in keys: dup.add(k)
+                keys.add(k)
+
 def parse_layout(fname):
     keys = set()
     dup = set()
@@ -41,12 +57,16 @@ def parse_layout(fname):
     if root.tag != "keyboard":
         return None
     for row in root:
-        for key in row:
-            for attr in key.keys():
-                if attr.startswith("key"):
-                    k = key.get(attr).removeprefix("\\")
-                    if k in keys: dup.add(k)
-                    keys.add(k)
+        parse_row_from_et(row, keys, dup)
+    return root, keys, dup
+
+def parse_row(fname):
+    keys = set()
+    dup = set()
+    root = ET.parse(fname).getroot()
+    if root.tag != "row":
+        return None
+    parse_row_from_et(root, keys, dup)
     return root, keys, dup
 
 def check_layout(layout):
@@ -55,24 +75,22 @@ def check_layout(layout):
     missing_some_of(keys, "~!@#$%^&*(){}`[]=\\-_;:/.,?<>'\"+|", "ASCII punctuation")
     missing_some_of(keys, "0123456789", "digits")
     missing_required(keys,
-                     ["esc", "tab", "backspace", "delete",
-                      "f11_placeholder", "f12_placeholder"],
+                     ["loc esc", "loc tab", "backspace", "delete"],
                      "Layout doesn't define some important keys")
     unexpected_keys(keys,
                     ["copy", "paste", "cut", "selectAll", "shareText",
-                     "pasteAsPlainText", "undo", "redo", "replaceText",
-                     "textAssist", "autofill" ],
+                     "pasteAsPlainText", "undo", "redo" ],
                     "Layout contains editing keys")
     unexpected_keys(keys,
                     [ "f1", "f2", "f3", "f4", "f5", "f6", "f7", "f8", "f9",
                      "f10", "f11", "f12" ],
                     "Layout contains function keys")
+    unexpected_keys(keys, [""], "Layout contains empty strings")
+    unexpected_keys(keys, ["loc"], "Special keyword cannot be a symbol")
+    unexpected_keys(keys, filter(lambda k: k.strip()!=k, keys), "Some keys contain whitespaces")
+    unexpected_keys(keys, ["f11_placeholder", "f12_placeholder"], "These keys are now added automatically")
 
-    bottom_row_keys = [
-            "ctrl", "fn", "switch_numeric", "change_method", "switch_emoji",
-            "config", "switch_forward", "switch_backward", "enter", "action",
-            "left", "up", "right", "down", "space"
-            ]
+    _, bottom_row_keys, _ = parse_row("res/xml/bottom_row.xml")
 
     if root.get("bottom_row") == "false":
         missing_required(keys, bottom_row_keys,
@@ -84,14 +102,15 @@ def check_layout(layout):
     if root.get("script") == None:
         warn("Layout doesn't specify a script.")
 
-for fname in sys.argv[1:]:
-    if fname in KNOWN_NOT_LAYOUT:
+for fname in sorted(sys.argv[1:]):
+    layout_id, _ = os.path.splitext(os.path.basename(fname))
+    if layout_id in KNOWN_NOT_LAYOUT:
         continue
     layout = parse_layout(fname)
     if layout == None:
-        print("Not a layout file: %s" % fname)
+        print("Not a layout file: %s" % layout_id)
     else:
-        print("# %s" % fname)
+        print("# %s" % layout_id)
         warning_count = 0
         check_layout(layout)
         print("%d warnings" % warning_count)

doc/Custom-layouts.md

@@ -0,0 +1,155 @@
+# Custom layouts
+You select a key layout for Unexpected Keyboard by calling up the Settings page (swipe the gear icon) and, at the top of the page, either tapping an existing layout or tapping _Add an alternate layout_. This displays a menu of available layouts. You can define your own layout by choosing _Custom layout_ at the bottom of this menu. Unexpected Keyboard now displays code in the XML format. You make changes by replacing this with different code and tapping OK.
+
+We recommend you keep your work in a file outside Unexpected Keyboard (named something like `MyChanges.xml`). If you installed a new version of Unexpected from a different website (with a different signature), then the work you did solely by editing the XML inside Unexpected would be lost.
+
+Put initial contents into your file in one of these ways:
+* Copypaste the code Unexpected displays for _Custom layout_.
+* Make a copy of one of the built-in layouts found in [`/srcs/layouts`](https://github.com/Julow/Unexpected-Keyboard/tree/master/srcs/layouts).
+* Use the [web-based editor](https://unexpected-keyboard-layout-editor.lixquid.com/). Interact with this web page to define keys and swipes and move keys to desired positions, and it will write the XML code for you. You can make the web page put the XML in a text file or copy it to the clipboard.
+
+When you have prepared suitable XML code in one of these ways, copy it to the clipboard and paste it into Unexpected Keyboard.
+
+## XML language overview
+A layout XML file comprises tags that start with `<` and end with `>`.
+* Every layout file starts with this declaration:
+  `<?xml version="1.0" encoding="utf-8"?>`
+* Certain tags come in pairs—an opening tag and a closing tag—and apply to everything between them.
+  * The `<keyboard>`...`</keyboard>` pair says that the material between them is the definition of your keyboard. There can be only one of these.
+  * The `<row>`...`</row>` pair encloses the definition of a single row.
+  * An optional `<modmap>`...`</modmap>` pair contains instructions if you want to change the behavior of a modifier key such as Shift.
+* Stand-alone tags include `<key`...`/>`, which defines a single key.
+
+A tag can have properties, defined using an equals sign and a pair of ASCII double quotes. For example, `<key key0="a" />` defines the "a" key. The `key0` property of the `key` tag says which key you are defining, and the tag's location inside `<row>`...`</row>` specifies where it will go in the row.
+
+### Example
+Here is a complete keyboard file with a single row containing an "a" key on the left and a "b" key on the right:
+
+    <?xml version="1.0" encoding="utf-8"?>
+    <keyboard name="Simple example" script="latin">
+        <row>
+            <key key0="a" />
+            <key key0="b" />
+        </row>
+    </keyboard>
+
+## Keyboard metadata
+
+The `<keyboard>`...`</keyboard>` pair follows the declaration tag and encloses the whole keyboard. The following properties may be used (The first two appear in the example above):
+
+* `name`: The name of the keyboard. The name you specify will appear in the Settings menu. If not present, the layout will just appear as “Custom layout”.
+
+* `script`: The (main) writing system that the keyboard supports. The possible values are `arabic`, `armenian`, `bengali`, `cyrillic`, `devanagari`, `gujarati`, `hangul`, `hebrew`, `latin`, `persian`, `shavian`, and `urdu`. It defaults to `latin`.
+
+* `numpad_script`: The script to use for the numpad. This is useful for scripts where a different, non-ASCII set of numerals is used, like Devanagari and Arabic. It defaults to the same as `script`.
+
+* `bottom_row`: Whether or not to show the built-in bottom row. It accepts `true` or `false`, and defaults to `true`. If your custom layout defines the bottom row, then specify `bottom_row="false"` to disable the built-in bottom row.
+  + We recommend your layout use the built-in bottom row, because it is still evolving and your layout will incorporate innovations in future versions. However, to define your own, the current definition of the bottom row is in [bottom_row.xml](https://github.com/Julow/Unexpected-Keyboard/res/xml/bottom_row.xml). You can copypaste this XML into your custom layout as a starting point.
+  + Likewise, the current definition of the top (number) row is in [number_row.xml](https://github.com/Julow/Unexpected-Keyboard/res/xml/number_row.xml).
+
+* `locale_extra_keys`: Whether Unexpected should add language-dependent extra keys from [method.xml](../res/xml/method.xml) to this layout. It accepts `true` or `false`, and defaults to `true`. To disable these automatic additions, specify `locale_extra_keys="false"`.
+
+## Row
+The `<row>`...`</row>` pair encloses one row on the keyboard. It has only one optional property:
+* `height`: The height of the row: a positive floating-point value.
+
+A row's default height is 1.0 (one quarter of the keyboard height specified on the Settings menu). The `height` property makes the row taller or shorter than this. For example, if you define a 5-row keyboard but one row has `height="0.7"`, then the keyboard's total height is 4.7 units. If the total is different from 4.0, the keyboard will be taller or shorter than that specified in Settings.
+
+## Key
+The `<key />` tag defines a key on the keyboard. Its position in the sequence of keys inside `<row>`...`</row>` indicates its position in the row from left to right. What the key does is defined by optional properties.
+
+### Taps
+What the key does when tapped is defined by the optional `key0` property. For example, `<key key0="a" />` defines the "a" key. Unexpected Keyboard provides a legend in the middle of the key.
+
+When the Shift modifier is tapped, the "a" key becomes the "A" key and the legend temporarily changes. The Fn modifier makes a different change. You can override this behavior with a modmap (see below).
+
+### Swipes
+The following optional properties define the effects of swipes:
+* `n`, `ne`, `e`, `se`, `s`, `sw`, `w`, `nw`: What the key should do when it is swiped in the direction of that compass point. ("North" means upward and "East" is to the right.)
+<TABLE ALIGN=CENTER>
+  <TR>
+    <TD STYLE="width: 6em;">nw</TD><TD>n</TD><TD>ne</TD>
+  </TR>
+  <TR ALIGN=CENTER>
+    <TD>w</TD><TD>&nbsp;</TD><TD>e</TD>
+  </TR>
+  <TR>
+    <TD>sw</TD><TD>s</TD><TD>se</TD>
+  </TR>
+</TABLE>
+
+* `key1` through `key8` is an older way to achieve the same effects. The directions are ordered as follows:
+<TABLE ALIGN=CENTER>
+  <TR>
+    <TD>key1</TD><TD>key7</TD><TD>key2</TD>
+  </TR>
+  <TR>
+    <TD>key5</TD><TD>&nbsp;</TD><TD>key6</TD>
+  </TR>
+  <TR>
+    <TD>key3</TD><TD>key8</TD><TD>key4</TD>
+  </TR>
+</TABLE>
+
+You can define a swipe only once with either compass-point or numeric notation. Unexpected Keyboard automatically puts a small legend in that direction from the center of the key.
+
+* `slider`: If `slider="true"`, and the key also has `w` and `e` properties, then the key tracks horizontal finger motion precisely and sends the `w` and `e` keystrokes repeatedly. In built-in layouts, this makes the space bar send left and right characters as the user slides on the space bar.
+* `anticircle`: The key value to send when doing an anti-clockwise gesture on the key.
+
+### Layout
+A key may have the following properties to control the row's layout:
+* `width`: The width of the key, a positive floating-point value. It defaults to 1.0
+* `shift`: How much empty space to add to the left of this key, a non-negative floating-point value. It defaults to 0.0
+
+Normally, a key's width is 1.0 unit. Unexpected Keyboard occupies the full width of the screen, and the row defining the highest number of units (in widths plus shifts) is as wide as the screen. A row whose width is a smaller number of units has empty space on the right.
+
+### Extra legend
+* `indication`: An optional extra legend to show under the main label. For example, `<key key0="2" indication="ABC" />` displays ABC at the bottom of the 2 key, as on a pinpad or some telephones. If the key also defines a downward swipe with `s` or `key8`, the legends overlap.
+
+### Possible key values
+Built-in strings that assign a special function to a key are described in [this page](Possible-key-values.md). For example, `se="copy"` means a southeasterly swipe produces the Copy key. If a key value does not match any of the built-in strings, it outputs that text _verbatim_. For example, `key0="a"` simply outputs the letter a.
+
+In a layout, a key value can also start with the `loc` prefix. These are place-holders; the tap or swipe does nothing unless enabled through the "Add keys to keyboard" option in the Settings menu, or implicitly enabled by the language the device is set to use. For example, `ne="loc accent_aigu"` says that a northeast swipe produces the acute accent combinatorial key—if enabled.
+
+## Modmap
+The `<modmap>`...`</modmap>` pair encloses custom mappings for modifier keys. The modmap is placed inside the `<keyboard>`...`</keyboard>` pair, but outside any row. A layout can have at most one modmap. It can contain any number of mappings. Each mapping has an `a` property and a `b` property and maps the `a` key to the `b` key. Valid values are listed in [Possible key values](Possible-key-values.md).
+
+The following mappings are supported:
+
+```xml
+  <shift a="before" b="after" />
+```
+This means that when the Shift modifier is on, the key `before` is changed into `after`.
+
+```xml
+  <fn a="before" b="after" />
+```
+This means that when the Fn modifier is on, the key `before` is changed into `after`.
+
+```xml
+  <ctrl a="before" b="after" />
+```
+This means that when the Ctrl modifier is on, the key `before` is changed into `after`. The `<ctrl />` mapping is special in that the Ctrl modifier is applied to `after` after the mapping.
+
+The clockwise circle and the round-trip gestures are affected by both `<shift />` and `<fn />` mappings. The Shift mappings are used first and if that did not modify the key, the Fn mappings are used instead.
+
+### Examples
+① Turkish keyboards use the Latin alphabet, but when "i" is shifted, it should produce "İ". This is achieved with the following mapping: 
+
+```xml
+    <shift a="i" b="İ" />
+```
+② Cyrillic layouts have no V key. A layout can define Ctrl-V with the following mapping:
+
+```xml
+    <ctrl a="в" b="v" />
+```
+This maps Ctrl+в to Ctrl+V—not to v.
+
+## Portrait vs. landscape
+Unexpected Keyboard remembers *separately* which layout has last been used in portrait and landscape orientation. So you may have one custom layout for portrait orientation, but another custom layout for landscape orientation, and Unexpected Keyboard will switch between them without your intervention.
+
+## Contributing your layout
+The Unexpected Keyboard project enthusiastically accepts user contributions, including custom layouts. (See the guidance for layouts at [CONTRIBUTING.md](https://github.com/Julow/Unexpected-Keyboard/blob/master/CONTRIBUTING.md#Adding-a-layout)).
+* Submit a layout that has innovations of possible interest to other users at [Unexpected-Keyboard-layouts](https://github.com/Julow/Unexpected-Keyboard-layouts).
+* Propose that your layout be included in the set of built-in layouts by making a Pull Request for an addition to [srcs/layouts](https://github.com/Julow/Unexpected-Keyboard/tree/master/srcs/layouts). Please show that such a layout is standard in your locale or has a substantial number of users.

doc/Possible-key-values.md

@@ -0,0 +1,190 @@
+# Key values
+
+This is an exhaustive list of special values accepted for the `key0` through `key8` or `nw` through `se` attributes on a key.
+
+Any string that does not exactly match these will be printed verbatim.
+A key can output multiple characters, but cannot combine multiple built-in key values.
+
+## Escape codes
+Value | Escape code for
+:---- | :------
+`\?`  | `?`
+`\#`  | `#`
+`\@`  | `@`
+`\n`  | Literal newline character. This is different from `enter` and `action` in certain apps.
+`\t`  | Literal tab character. This is different from `tab` in certain apps.
+`\\`  | `\`
+
+XML escape codes also work, including:
+
+Value    | Escape code for
+:------- | :------
+`&`  | `&`
+`&lt;`   | `<`
+`&gt;`   | `>`
+`&quot;` | `"`
+
+## Modifiers
+System modifiers are sent to the app, which is free to do whatever they want in response.
+The other modifiers only exist within the keyboard.
+Value       | Meaning
+:---------- | :------
+`shift`     | System modifier.
+`ctrl`      | System modifier.
+`alt`       | System modifier.
+`meta`      | System modifier. Equivalent to the Windows key.
+`fn`        | Activates Fn mode, which assigns letters and symbols to special characters. e.g. `fn` `!` = `¡`
+`compose`   | Compose key. Enables composing characters using Linux-like shortcuts; e.g. `Compose` `A` `single quote` types `Á` (A with acute accent).
+`capslock`  | Actives and locks Shift
+
+## Special keys
+These keys are sent to apps, which are free to ignore them. The keyboard does not perform editing in response to these keys.
+
+`esc`, `enter`,
+`up`, `right`,
+`down`, `left`,
+`page_up`, `page_down`,
+`home`, `end`,
+`backspace`, `delete`,
+`insert`, `scroll_lock`,
+`f1`-`f12`,
+`tab`, `copy`,
+`paste`, `cut`,
+`selectAll`, `pasteAsPlainText`,
+`undo`, `redo`
+
+## Whitespace
+Value   | Meaning
+:------ | :------
+`space` | Space bar.
+`nbsp`  | Non-breaking space.
+`nnbsp` | Narrow non-breaking space.
+`zwj`   | Zero-width joiner.
+`zwnj`  | Zero-width non-joiner.
+
+## Keyboard editing actions
+These keys perform editing on the text without sending keys that the app can interpret differently or ignore.
+Value              | Meaning
+:----------------- | :------
+`cursor_left`      | Moves the cursor position to the left directly, without sending a `left` key event.
+`cursor_right`     | Moves the cursor position to the right directly, without sending a `right` key event.
+
+## Other modifiers and diacritics
+Value                | Meaning
+:------------------- | :------
+`accent_aigu`        | Acute accent. `á`
+`accent_caron`       | Háček. `č`
+`accent_cedille`     | Cedilla. `ç`
+`accent_circonflexe` | Circumflex. `â`
+`accent_grave`       | Grave accent. `à`
+`accent_macron`      | Macron. `ā`
+`accent_ring`        | Ring accent. `å`
+`accent_tilde`       | Tilde. `ã`
+`accent_trema`       | Dieresis/umlaut. `ä`
+`accent_ogonek`      | Ogonek. `ą`
+`accent_dot_above`   | Dot accent. `ż` If applied to the lowercase `i`, removes the dot instead for Turkish. `ı`
+`accent_double_aigu` | Double acute accent. `ő`
+`accent_slash`       | Slash through. `ø`
+`accent_arrow_right` | Right arrow above, used to denote a vector. `a⃗`
+`accent_breve`       | Breve. `ă`
+`accent_bar`         | Bar/strikethrough. `ɨ`
+`accent_dot_below`   | Dot below. `ạ`
+`accent_horn`        | Horn accent. `ơ`
+`accent_hook_above`  | Hook accent. `ả`
+`superscript`        | Superscript. `ᵃ`
+`subscript`          | Subscript. `ₐ`
+`ordinal`            | Turns `a` and `o` into `ª` and `º`.
+`arrows`             | Turns `1`-`4` and `6`-`9` into arrows.
+`box`                | Turns `1`-`9`, `0`, and `.` into single-line, thin box-drawing characters.
+
+## Bidirectional
+Value   | Meaning
+:------ | :------
+`lrm`   | Left-to-right mark.
+`rlm`   | Right-to-left mark.
+`b(`, `b)`, `b[`, `b]`, `b{`, `b}`, `blt`, `bgt` | Sends the bracket characters, but with mirrored key legends for right-to-left languages. (`blt` and `bgt` print `<` and `>` respectively.)
+
+## Hebrew
+Keys ending in `_placeholder` are normally hidden unless the Fn key is pressed.
+
+`qamats`, `patah`,
+`sheva`, `dagesh`,
+`hiriq`, `segol`,
+`tsere`, `holam`,
+`qubuts`, `hataf_patah`,
+`hataf_qamats`, `hataf_segol`,
+`shindot`, `shindot_placeholder`,
+`sindot`, `sindot_placeholder`,
+`geresh`, `gershayim`,
+`maqaf`, `rafe`,
+`ole`, `ole_placeholder`,
+`meteg`, `meteg_placeholder`
+
+## Keyboard behavior keys
+Value                  | Meaning
+:--------------------- | :------
+`config`               | Gear icon; opens Unexpected Keyboard settings.
+`switch_text`          | Switch to the text layer (main layer).
+`switch_numeric`       | Switch to the numeric layer.
+`switch_emoji`         | Switch to the emoji layer.
+`switch_back_emoji`    | Switch to the text layer from the emoji layer.
+`switch_forward`       | Change the keyboard layout, as long as Unexpected Keyboard has multiple keyboard layouts enabled in the settings.
+`switch_backward`      | Change the keyboard layout to the previous one in the list.
+`switch_greekmath`     | Switch to the Greek & Math Symbols layer.
+`switch_clipboard`     | Switch to the clipboard pane.
+`change_method`        | Open the input method picker dialog.
+`change_method_prev`   | Switch to the previously used input method.
+`action`               | Performs a special context-sensitive operation related to the Enter key. For example, in the Twitter (X) app, `enter` adds a new line, while `action` posts.
+`voice_typing`         | Begin voice typing.
+`voice_typing_chooser` | Shows a menu where you can choose which voice typing provider to use, then begins voice typing when you make a selection.
+`shareText`            | Emit a share Intent for the selected text. **Oddity:** This is in CamelCase.
+
+## Unused
+These keys are known to do nothing.
+
+`replaceText`, `textAssist`,
+`autofill`, `removed`
+
+## Placeholders
+These keys are normally hidden unless the Fn modifier is activated.
+
+`f11_placeholder` | `f12_placeholder`
+
+## Complex keys
+
+More complex keys are of this form:
+
+```
+:<kind> <attributes>:<payload>
+```
+
+Where `<kind>` is one of the kinds documented below and `<attributes>` is a
+space separated list of attributes. `<payload>` depends on the `<kind>`.
+
+Attributes are:
+- `symbol='Sym'` specifies the symbol to be shown on the keyboard.
+- `flags='<flags>'` changes the behavior of the key.
+  `<flags>` is a coma separated list of:
+  + `dim`: Make the symbol dimmer.
+  + `small`: Make the symbol smaller.
+
+### Kind `str`
+
+Defines a key that outputs an arbitrary string. `<payload>` is a string wrapped
+in single-quotes (`'`), escaping of other single quotes is allowed with `\'`.
+
+For example:
+- `:str:'Arbitrary string with a \' inside'`
+- `:str symbol='Symbol':'Output string'`
+
+### Kind `char`
+
+Defines a key that outputs a single character. `<payload>` is the character to
+output, unquoted.
+This kind of key can be used to define a character key with a different symbol
+on it. `char` keys can be modified by `ctrl` and other modifiers, unlike `str`
+keys.
+
+For example:
+- `:char symbol='q':љ`, which is used to implement `ctrl` shortcuts in cyrillic
+  layouts.

fastlane/metadata/android/cs-CZ/full_description.txt

@@ -0,0 +1,6 @@
+Hlavní funkcí je možnost psát více znaků posunutím kláves směrem k rohům.
+
+Tato aplikace byla původně navržena pro programátory používající Termux.
+Nyní je ideální pro každodenní použití.
+
+Tato aplikace neobsahuje žádné reklamy, nevyužívá připojení k síti a je Open Source.

fastlane/metadata/android/en-US/changelogs/36.txt

@@ -0,0 +1,9 @@
+Allow selecting any number of standard and custom layouts.
+Allow adding custom keys to the keyboard.
+Changed behavior of auto-added keys (often dead-keys).
+New layouts.
+Improved layouts and language support.
+Improved the space bar slider, and many more.
+Updated translations.
+
+Thanks to the contributors: @ChasmSolacer, @ElucGeek, @GoRaN909, @RZHSSNZDH, @Shareef101, @Validbit, @eandersons, @nitsvga, @polyctena, @sdrapha, @syskill

fastlane/metadata/android/en-US/changelogs/37.txt

@@ -0,0 +1,8 @@
+Improved custom layout option.
+Allow selecting voice typing app with a long press.
+The numpad can work with other numeral systems.
+New and updated layouts.
+New themes.
+Many small improvements.
+
+Thanks to the contributors: @pharook, @syskill, @ojas-bhagavath, @lrvideckis, @lyubomirv, @matthiakl, @deftkHD, @V6lhost, @RZHSSNZDH, @RetrogisusDEV, @rafasaurus, @krtsgnr7230, @eandersons, @ChasmSolacer, @Validbit, @polyctena

fastlane/metadata/android/en-US/changelogs/38.txt

@@ -0,0 +1,7 @@
+The custom vibration setting is back.
+Allow to hide the keyboard switching key.
+Fixed modifier keys in some development apps.
+Updated translations.
+Bug fixes and general improvements.
+
+Many thanks to the contributors: @abb128, @marciozomb13, @RetrogisusDEV, @Sestowner, @vedamanavi, @krtsgnr7230

fastlane/metadata/android/en-US/changelogs/39.txt

@@ -0,0 +1,6 @@
+New layouts: QWERTY (Slovak), Gujarati phonetic
+Add Linux Compose key to type a variety of characters using known combinations.
+Fixed localized numpad and number row.
+Many improvements and bug fixes.
+
+Huge thanks to the contributors: @Yogesh-B, @ChasmSolacer, @matthiakl, @Sestowner, @RyanGibb, @BogdanLata, @RetrogisusDEV, @V6lhost, @ErrrorMaxx, @sdrapha, @vedamanavi

fastlane/metadata/android/en-US/changelogs/40.txt

@@ -0,0 +1,11 @@
+MessagEase and Thumb-Key inspired gestures with the anti-clockwise circle being
+completely configurable.
+
+Updated emojis.
+Improved Hangul (Korean) support.
+Added Danish support.
+Improved spacebar slider.
+Updated translations.
+Various improvements and fixes to the app and layouts.
+
+Many thanks to the contributors: @alotbsol555 @bkmgit @Cheesebaron @CloneWith @eandersons @JapanYoshi @Julow @la-ninpre @m15a @marciozomb13 @polyctena @solokot @Spike-from-NH @tmqCypher @Validbit

fastlane/metadata/android/en-US/changelogs/41.txt

@@ -0,0 +1,8 @@
+Clipboard pane
+
+New Monet theme
+Improvements to custom layouts
+Options to disable key repeat and the circle gesture
+Options to disable the Tab and Esc keys
+
+Many thanks to the contributors: @alotbsol555 @ChasmSolacer @eandersons @polyctena @Sestowner @solokot @Spike-from-NH @TadaCZE @V6lhost @Validbit

fastlane/metadata/android/en-US/changelogs/42.txt

@@ -0,0 +1,6 @@
+Fix crash on Android 6.
+Fix scaling issues for layouts with few columns.
+Added Serbian layouts.
+Layout and compose key tweaks. Improvements to custom layouts. Added Menu key.
+
+Many thanks to the contributors: @adrian4096 @asivery @bokidori @dingodoppelt @RZHSSNZDH

fastlane/metadata/android/en-US/video.txt

@@ -0,0 +1 @@
+https://www.youtube.com/watch?v=rwGvWesPFX8

fastlane/metadata/android/ja-JP/full_description.txt

@@ -0,0 +1,7 @@
+このキーボードは、キーの角をスワイプすることで様々なキーを入力できます。
+
+このアプリは元々はTermuxでのプログラミング用に設計されました。
+しかし、今では普段の入力にも適しています。
+PCキーボードでの半角入力を再現しています。日本語入力、変換は出来ません。
+
+このアプリは広告を含まず、インターネットに接続せず、そしてオープンソースです。

fastlane/metadata/android/ja-JP/short_description.txt

@@ -0,0 +1 @@
+軽量でプライバシーに配慮したAndroid用仮想キーボード

fastlane/metadata/android/ko-KR/full_description.txt

@@ -0,0 +1,6 @@
+주요 기능은 모서리 방향으로 키를 스와이프하여 더 많은 문자를 입력할 수 있다는 것입니다.
+
+이 앱은 처음에는 Termux를 사용하는 프로그래머들을 위한 것으로 개발되었습니다.
+지금은 일상적인 용도로도 완벽합니다.
+
+이 응용 프로그램에는 광고가 없으며 네트워크 요청을 하지 않고 오픈 소스입니다.

fastlane/metadata/android/pl-PL/title.txt

@@ -0,0 +1 @@
+Unexpected Keyboard

fastlane/metadata/android/pt-BR/full_description.txt

@@ -0,0 +1,6 @@
+A principal característica é que você pode digitar mais caracteres deslizando as teclas para os cantos.
+
+O app foi criado originalmente para desenvolvedores que usam Termux.
+Agora aperfeiçoado para o uso diário.
+
+Este aplicativo não contém anúncios, não faz nenhuma solicitação de rede e é Open Source.

fastlane/metadata/android/ro/title.txt

@@ -0,0 +1 @@
+Unexpected Keyboard

fastlane/metadata/android/ru-RU/full_description.txt

@@ -0,0 +1,6 @@
+Главная особенность клавиатуры — это возможность легко напечатать любой ASCII-символ жестами в углы клавиш.
+
+Приложение изначально было разработано для использования с Termux.
+На данный момент оно также удобно в повседневном использовании.
+
+Приложение не содержит рекламы, не осуществляет никаких запросов в сеть и имеет открытый исходный код.

fastlane/metadata/android/ru-RU/title.txt

@@ -0,0 +1 @@
+Unexpected Keyboard

fastlane/metadata/android/tr-TR/full_description.txt

@@ -0,0 +1,6 @@
+Bu uygulama özünde tuşların kenarlarından kaydırarak daha fazla karakter yazabilmek amacıyla geliştirildi.
+
+Bu uygulama aslında Termux kullanıcıları için geliştirildi.
+Artık gündelik kullanım için de uygun.
+
+Bu uygulama açık kaynaklıdır. Reklam içermez ve internete bağlanmaz.

fastlane/metadata/android/tr-TR/short_description.txt

@@ -0,0 +1 @@
+Android için hafif ve güvenlik odaklı bir sanal klavye uygulaması.

fastlane/metadata/android/tr-TR/title.txt

@@ -0,0 +1 @@
+Unexpected Keyboard

fastlane/metadata/android/uk/full_description.txt

@@ -0,0 +1,6 @@
+Головна особливість полягає в тому, що ви можете вводити більше символів, проводячи клавіші до кутів.
+
+Ця програма спочатку була розроблена для програмістів, які використовують Termux.
+Тепер ідеально підходить для щоденного використання.
+
+Ця програма не містить реклами, не надсилає жодних мережевих запитів і має відкритий код.

fastlane/metadata/android/uk/short_description.txt

@@ -0,0 +1 @@
+Легка та конфіденційна віртуальна клавіатура для Android.