Initial commit

Author: ScribbleJ

.gitignore

@@ -0,0 +1,16 @@
+*.iml
+.gradle
+/local.properties
+/.idea
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties

README.md

@@ -0,0 +1,60 @@
+# Introduction
+
+This is very much a Work-In-Progress and that'll be evident at this early stage.  
+
+TapStrapApp (//TODO: Get a real name), Android Input Method Editor (IME) designed for use with the Tap Strap chording keyboard.
+This project aims to significantly enhance the typing experience for Tap Strap users by addressing the inherent limitations of the device's firmware.
+
+## Present Features:
+
+   * Useable for More Than Text: Overcomes the Tap Strap's issue of typing the wrong letter followed by a backspace.
+   * On-Screen IME Keyboard: Displays the current state, indicating the recently chorded fingers and held meta keys (ALT, SHIFT, CTRL, META). These indicators are also clickable for convenience.
+   * Advanced Chording Feedback: Shows the output for single, double, and triple taps (and beyond), offering more depth than the standard Tap Strap behavior.  These are also clickable if you like.
+   * Customizable Chording: Unlike the Tap Strap's web-based configuration, our IME allows local programming of any chord using standard CSV files, providing flexibility and extensive customization.  ANY CHORD.  You sick of several chords being reserved and un-editable in the Tap Systems Tapmapper?  NO LONGER!
+   * More Taps: You want triple-taps?  Quad-taps?  There's no limit!  I just don't know what you call 5 or more.  You want SHIFT mode to do double-taps, triple taps? Have it!  You want SWITCH mode to... okay you get it.
+   * More shifts/switches:  You can define as many different modes as you like and each can have infinite taps.
+   * (Optional) Tap Cycling: If you keep double-triple-etc tapping, after you go past the end of what's configured, it wraps back around to single-tap again, so you can "go back" without getting the wrong output first.
+   * Does All the Keys:  You know the list of like a thousand Android KeyCodes?  Well, we do!  ( See /config/DEFAULT_1 )  
+   * Multiple Configuration Profiles: Supports switching between unlimited chording configurations to suit different use cases.
+   * Super Untested And Unfinished Code: You won't see that from Tap Systems!
+
+## Upcoming Features:
+
+   * Hopefully nothing -- it would be infintely prefereable to see Tap Systems make these features available on-device, most particularly the elimination of the backspace behavior and the ability to program chords offline.  But until they do...
+   * Mouse mode
+   * Better UI/In-app Configuration
+   * System service to make it useful even when Android doesn't want to use the IME (anytime you're not in a text entry, basically) -- work more like a hardware keyboard.
+   * I'd still like to add a HID "passthrough" that allows you to connect your phone to another device and actually use the Tap Strap with these IME features on any bluetooth device.  But so far, no luck.
+
+## IMPORTANT NOTE:
+
+It's full of bugs and will probably set your phone on fire.  I can't take any responsibility for you choosing to use what's OBVIOUSLY unfinished code!
+
+## Getting Started
+
+### "Quick" Start:
+* Install APK
+* Run the "TapStrapIME" App and take note of the directory it tells you to put the configuration files into.
+* Copy the default configuration from /config in this repository or write you own and put them in the indicated directory on your phone.  You can use any file manager, or adb, there's a script in the config.
+* Go to your Android settings, find the keyboard settings (it varies) and you should find a page there where you can chose which of your installed IME/Kayboards are allowed to run.  Turn on TapStrapIME.  You can and should leave your usual keyboards enabled as well.
+* (Optional but HIGHLY suggested:) If you have an option to always display the keyboard switcher (maybe "Keyboard button") make sure it's turned on.
+* (Optional but suggested:) Probably on another settings screen, find the option to display the software keyboard even if a physical keyboard is attached.  
+* Start up your Tap Strap, make sure it's connected to your Android device successfully.  
+* Use the settings menu or the "Keyboard button" you just turned on to switch your default keyboard to the TapStrapIME.
+* Find someplace to input text and try it out.  The provided config files should match the defaults in the TapStrap hardware.
+
+
+## Developer's Note(s)
+
+I absolutely love the Tap Strap, but as soon as I finished learning all the single-tap letters, I realized I'd never be able to use it as a general-purpose keyboard while it had this typing-the-wrong-character-then-backspacing behavior.
+
+Although the best way to fix the problem would be in the Tap Strap firmware directly, Tap Systems haven't implemented an option to toggle the bizarre backspace behavior... yet.  They did provide a really nice SDK we used for this project, but it can only take you so far.
+
+If this project eventually becomes useful to you and you'd like to show support, the developer appreciates donations to the Kitten.Academy Patreon.  https://www.patreon.com/kittenacademy
+
+## Copyright Chris Jansen, etc, etc, you can use this for yourself, but we haven't arranged any licensing for you to modify the source or redistribute yet.
+
+Aside from the Android boilerplate and the actual Tap Systems SDK, this is all original code so as of now the licensing is pretty much my problem.
+I'm supposed to say "all rights reserved" here, right?
+
+I'm not easy to contact but you can try [email protected] if you like.

app/.gitignore

@@ -0,0 +1 @@
+/build

app/build.gradle.kts

@@ -0,0 +1,107 @@
+import java.io.ByteArrayOutputStream
+
+plugins {
+    id("com.android.application")
+    id("org.jetbrains.kotlin.android")
+}
+
+android {
+    namespace = "com.scribblej.tapstrapapp"
+    compileSdk = 34
+
+    val gitCommitHash: String by lazy {
+        ByteArrayOutputStream().also { outputStream ->
+            exec {
+                commandLine = "git rev-parse --short HEAD".split(" ")
+                standardOutput = outputStream
+            }
+        }.toString().trim()
+    }
+
+    defaultConfig {
+        applicationId = "com.scribblej.tapstrapapp"
+        minSdk = 26
+        targetSdk = 34
+        versionCode = 1
+        versionName = "1.0.$gitCommitHash"
+
+        vectorDrawables {
+            useSupportLibrary = true
+        }
+
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+    buildFeatures {
+        compose = true
+    }
+    composeOptions {
+        kotlinCompilerExtensionVersion = "1.4.3"
+    }
+    packaging {
+        resources {
+            excludes += "/META-INF/{AL2.0,LGPL2.1}"
+        }
+    }
+}
+
+dependencies {
+
+    implementation("androidx.appcompat:appcompat:1.6.1")
+
+    implementation("androidx.core:core-ktx:1.12.0")
+    implementation("androidx.percentlayout:percentlayout:1.0.0")
+    implementation("androidx.legacy:legacy-support-v4:1.0.0")
+
+    implementation("androidx.recyclerview:recyclerview:1.3.2")
+    implementation(platform("androidx.compose:compose-bom:2023.10.01"))
+    implementation("androidx.compose.ui:ui")
+    implementation("androidx.compose.ui:ui-tooling-preview")
+    implementation("androidx.wear.compose:compose-material:1.2.1")
+    implementation("androidx.wear.compose:compose-foundation:1.2.1")
+    implementation("androidx.activity:activity-compose:1.8.2")
+    implementation("androidx.compose.material:material-icons-core")
+
+    androidTestImplementation(platform("androidx.compose:compose-bom:2023.10.01"))
+    androidTestImplementation("androidx.compose.ui:ui-test-junit4")
+    debugImplementation("androidx.compose.ui:ui-tooling")
+    debugImplementation("androidx.compose.ui:ui-test-manifest")
+
+    implementation("androidx.lifecycle:lifecycle-viewmodel-ktx:2.6.2")
+    implementation("androidx.lifecycle:lifecycle-viewmodel-compose:2.6.2")
+    implementation("androidx.lifecycle:lifecycle-livedata-ktx:2.6.2")
+    implementation("androidx.lifecycle:lifecycle-runtime-compose:2.6.2")
+    implementation("androidx.lifecycle:lifecycle-viewmodel-savedstate:2.6.2")
+
+    // Annotation processor
+    annotationProcessor("androidx.lifecycle:lifecycle-compiler:2.6.2")
+
+    implementation("androidx.preference:preference-ktx:1.2.1")
+
+    // optional - helpers for implementing LifecycleOwner in a Service
+    implementation("androidx.lifecycle:lifecycle-service:2.6.2")
+
+    // optional - ProcessLifecycleOwner provides a lifecycle for the whole application process
+    implementation("androidx.lifecycle:lifecycle-process:2.6.2")
+
+    // Tap Strap
+    implementation("io.github.tapwithus:tap-android-sdk:0.3.6")
+
+    // Apache CSV parser (used in TapMap)
+    implementation("org.apache.commons:commons-csv:1.10.0")
+}

app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

app/src/main/AndroidManifest.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.scribblej.tapstrapapp">
+
+
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+
+    <uses-feature android:name="android.hardware.type.watch" android:required="false" />
+
+    <!-- Bluetooth Permissions -->
+    <uses-permission android:name="android.permission.BLUETOOTH"/>
+    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
+    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+
+    <!-- Location Permission (required for Bluetooth scanning on Android 6.0 and above) -->
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
+
+    <application
+        android:allowBackup="true"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:supportsRtl="true"
+        android:theme="@android:style/Theme.DeviceDefault">
+        <uses-library
+            android:name="com.google.android.wearable"
+            android:required="false" />
+
+        <meta-data
+            android:name="com.google.android.wearable.standalone"
+            android:value="true" />
+
+        <activity android:name=".presentation.TapInputSettings"
+            android:label="@string/tap_ime_name"
+            android:exported="true" >
+            <intent-filter>
+                <action android:name="android.settings.INPUT_METHOD_SETTINGS" />
+                <action android:name="android.intent.action.APPLICATION_PREFERENCES" />
+                <category android:name="android.intent.category.DEFAULT" />
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+
+        <service
+            android:name=".TapInputMethodService"
+            android:label="@string/tap_ime_name"
+            android:permission="android.permission.BIND_INPUT_METHOD"
+            android:theme="@android:style/Theme.DeviceDefault"
+            android:exported="true">
+            <intent-filter>
+                <action android:name="android.view.InputMethod" />
+            </intent-filter>
+            <meta-data
+                android:name="android.view.im"
+                android:resource="@xml/method" />
+        </service>
+    </application>
+</manifest>

app/src/main/java/com/scribblej/tapstrapapp/LifecycleInputMethodService.kt

@@ -0,0 +1,40 @@
+package com.scribblej.tapstrapapp
+
+import android.content.Intent
+import android.inputmethodservice.InputMethodService
+import androidx.annotation.CallSuper
+import androidx.lifecycle.Lifecycle
+import androidx.lifecycle.LifecycleOwner
+import androidx.lifecycle.ServiceLifecycleDispatcher
+
+abstract class LifecycleInputMethodService : InputMethodService(), LifecycleOwner {
+
+    protected val dispatcher = ServiceLifecycleDispatcher(this)
+
+    @CallSuper
+    override fun onCreate() {
+        dispatcher.onServicePreSuperOnCreate()
+        super.onCreate()
+    }
+
+    override fun onBindInput() {
+        super.onBindInput()
+        dispatcher.onServicePreSuperOnBind()
+    }
+
+    // this method is added only to annotate it with @CallSuper.
+    // In usual service super.onStartCommand is no-op, but in LifecycleService
+    // it results in mDispatcher.onServicePreSuperOnStart() call, because
+    // super.onStartCommand calls onStart().
+    @CallSuper
+    override fun onStartCommand(intent: Intent?, flags: Int, startId: Int): Int {
+        return super.onStartCommand(intent, flags, startId)
+    }
+
+    @CallSuper
+    override fun onDestroy() {
+        dispatcher.onServicePreSuperOnDestroy()
+        super.onDestroy()
+    }
+
+}

app/src/main/java/com/scribblej/tapstrapapp/MetaKeysManager.kt

@@ -0,0 +1,45 @@
+package com.scribblej.tapstrapapp
+
+object MetaKeysManager {
+    private var _metaKeys: Int = 0
+    val metaKeys: Int
+        get() = _metaKeys
+    private var _useOnce: Boolean = false
+    val useOnce: Boolean
+        get() = _useOnce
+
+    private val metaKeysObservers = mutableListOf<(Int, Boolean) -> Unit>()
+
+    fun activateMetaKeys(newMetaKeys: Int, newUseOnce: Boolean = false) {
+        _metaKeys = _metaKeys or newMetaKeys
+        _useOnce = newUseOnce
+        notifyObservers()
+    }
+
+    fun setMetaKeys(newMetaKeys: Int, newUseOnce: Boolean = false) {
+        _metaKeys = newMetaKeys
+        _useOnce = newUseOnce
+        notifyObservers()
+    }
+
+    fun resetMetaKeys() {
+        setMetaKeys(0,false)
+    }
+
+    fun toggleMetaKey(mK: Int) {
+        _metaKeys = _metaKeys xor mK
+        notifyObservers()
+    }
+
+    private fun notifyObservers() {
+        metaKeysObservers.forEach { it(_metaKeys, _useOnce) }
+    }
+
+    fun addObserver(observer: (Int, Boolean) -> Unit) {
+        metaKeysObservers.add(observer)
+    }
+
+    fun removeObserver(observer: (Int, Boolean) -> Unit) {
+        metaKeysObservers.remove(observer)
+    }
+}