PR #31 を個人的な好みで調整

* 消せない baseRomajiMap の上にカスタムを重ねるのではなく、ゼロベースで設定
  * 個人的には dhi のようなローマ字を使わないので、dh の時点で d を捨ててほしいから
* ローマ字かな変換ルールはハードウェアキーボードのための機能なので少し隠す
  * 設定を一気に確認できるよう EditText で表示・編集

- app/build.gradle: テストが asset 内の skk-kana-rule.conf を使用できるようにする
- app/src/androidTest/.../SKKSettingsActivityUITest.kt: ソフトウェアキーボード設定が画面の下に隠れていたのでスワイプしておく
- app/src/main/AndroidManifest.xml: SKKKanaRuleManager ダークテーマ対応
- assets/azik-kana-rule.conf:
  - リンク切れに archive.org で対応
  - 途中ぽい文書にブツ切りで対応
  - 実装に合わせて説明を調整
    - 2要素のみ対応
    - 未確定ローマ字の残しは非対応
    - okuri 非対応
    - ; は対応
    - `z,,‥` は `z,,‥` の誤り
- SKKKanaRule.kt:
  - 既定で skk-kana-rule.conf を読む
  - 関数直前のコメントの行頭が # だとホバーツールチップで大きく表示されるので括弧に
- SKKKanaRuleManager.kt:
  - レイアウト調整 (新しめの Android 用?)
  - ルールを TextEdit にして、onPause で保存
- engine/RomajiConverter.kt:
  - mBaseRomajiMap を廃止して外部 asset の skk-kana-rule.conf に
  - それに合わせて mEffectiveMap は mRomajiMap という名前に戻す
  - skkPrefs.useSmallK は既定で false なので skkPrefs==null でも false 動作に (よく分かっていない)
- engine/SKKHiraganaState.kt: rule.conf の `キー,<shift>別キー` 書式に対応
- layout/activity_kana_rule_manager.xml: 常に conf を使用するので TextView を廃止、EditText 追加
- xml/prefs_hard_key.xml, xml/prefs_main.xml: かなルール管理をハードキー部門下に移動
- test/RomajiConverterTest.kt:
  - tearDown で skk-kana-rule.conf を読むように (これでいいのか分かっていない)
  - useSmallK は false 前提
  - 設定されていないと何も変換しない

Author: tamo

app/build.gradle

@@ -37,6 +37,7 @@ android {
 
     testOptions {
         unitTests.returnDefaultValues = true
+        unitTests.includeAndroidResources = true
     }
 }
 
@@ -49,6 +50,7 @@ dependencies {
     implementation 'androidx.constraintlayout:constraintlayout:2.2.1'
     testImplementation 'androidx.test.ext:junit-ktx:1.3.0'
     testImplementation 'androidx.test:core-ktx:1.7.0'
+    testImplementation 'org.robolectric:robolectric:4.16.1'
     androidTestImplementation 'androidx.test:runner:1.7.0'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.7.0'
     androidTestImplementation 'androidx.test.ext:junit-ktx:1.3.0'

app/src/androidTest/java/jp/deadend/noname/skk/SKKSettingsActivityUITest.kt

@@ -217,6 +217,8 @@ class SKKSettingsActivityUITest {
     @Test
     fun testSoftKeyFragment() {
         assert(skkPrefs.useSoftKey == "auto")
+        // 下の方が見えないのでスワイプアップしておく
+        onView(isRoot()).perform(swipeUp())
         onView(withText("ソフトウェアキーボードの設定")).perform(click())
         onView(withText("ソフトウェアキーボードの表示"))
             .check(matches(hasSibling(withText("自動"))))

app/src/main/AndroidManifest.xml

@@ -60,7 +60,7 @@
         <activity
             android:name=".SKKKanaRuleManager"
             android:label="@string/label_kana_rule_manager_activity"
-            android:theme="@style/Theme.AppCompat.Light.DarkActionBar" />
+            android:theme="@style/Theme.AppCompat.DayNight.NoActionBar" />
         <activity
             android:name=".SKKMushroom"
             android:label="@string/label_mushroom"

app/src/main/assets/azik-kana-rule.conf

@@ -1,38 +1,21 @@
 # -*- coding: utf-8 -*-
 # AZIK (Automated Z-key Input method for Kana) for AndroidSKK
 # 考案者: 木村 清 氏 (http://hp.vector.co.jp/authors/VA002116/azik/azikindex.html)
+# https://web.archive.org/web/19990427131147/http://hp.vector.co.jp:80/authors/VA002116/azikinfo.htm
+
 # CorvusSKKを元にしたAZIK入力ルール (https://github.com/nathancorvussolis/corvusskk/blob/3.3.0/installer/config-sample/config%20-%20azik-uskbd.xml) を元にした
 # macSKK (https://github.com/mtgto/macSKK) の設定ファイルを参考に
-# AndroidSKK 用のサンプルとして構成したものですが、さらに元は
+# AndroidSKK 用のサンプルとして構成したものです
 
 # ひらかな・カタカナ・半角カナ入力モードでのキー入力変換マップ
 # UTF-8 + LF (BOMなし) で記述してください。
 # #で始まる行は無視されます。
 
-# 各行はカンマ区切りで2-5要素記述する必要があります。
+# 各行はカンマ区切りで2要素記述する必要があります。
 # 各要素でカンマを使用したい場合は , と記述してください。
 # 第一要素でシャープを使用したい場合は ♯ と記述してください。
 # 1つ目: ローマ字入力で確定入力されるまでに入力される文字列を指定してください。
 # 2つ目: ひらがなモードで入力される文字を指定してください。
-# 3つ目: カタカナモードで入力される文字を指定してください。
-# 省略時はひらがなモードで入力される文字を自動でカタカナに変換します。
-# 記号などはカタカナに変換できないのでそのまま使用されます。
-# 4つ目: 半角カナ入力モードで入力される文字を指定してください。
-# 省略時はひらがなモードで入力される文字を自動で半角に変換します。
-# 5つ目: 未確定のローマ字として残す文字を指定してください。
-# 省略された場合は未確定文字として残るローマ字がないことを表します。
-# 例えば "tt,っ,ッ,ｯ,t" という行がある場合、
-# "tt" と入力したときには "っ" をひらがなモードで入力し "t" が未確定のローマ字として残ります。
-#
-# 2つ目の要素に "<okuri>" を含めると、送り仮名付きのルールを定義できます。
-# 例えば "gq,が<okuri>い" という行がある場合:
-# - シフトなしで gq と入力すると "がい" がそのまま入力されます。
-# - シフトを押しながら入力すると "が" を読み部分、"い" を送り仮名として辞書変換を開始します。
-# AZIKなどで「願い(ねがい)」を NegQ (4打鍵) で変換開始できるようになります。
-
-# qを「ん」、;を「っ」にするルールもそのまま記載しているためSKKのデフォルトキーバインドと衝突しています。
-# (衝突する場合はキーバインドが優先されます)
-# キーバインドを変更するか入力ルールを変更してください。
 
 a,あ
 i,い
@@ -590,11 +573,13 @@ xxo,ぉ
 xxya,ゃ
 xxyu,ゅ
 xxyo,ょ
-# 二文字目だけシフトが必要な入力は現在のmacSKKではルールに記述できないためコメントアウト
+# 二文字目だけシフトが必要な入力は実装されていないためコメントアウト
 # kA,ゕ
 # kE,ゖ
 
 # 促音、撥音、長音符
+# qを「ん」にするルールもそのまま記載していますがSKKのデフォルトキーバインドが優先されます
+# nnを使うか他の設定にしてください
 
 ;,っ
 q,ん
@@ -639,7 +624,7 @@ wr,われ
 ?,？
 ],」
 z ,　
-z,,‥
+z&comma;,‥
 z-,～
 z~,〜
 z.,…

app/src/main/assets/skk-kana-rule.conf

@@ -0,0 +1,206 @@
+a,あ
+i,い
+u,う
+e,え
+o,お
+ka,か
+ki,き
+ku,く
+ke,け
+ko,こ
+sa,さ
+si,し
+su,す
+se,せ
+so,そ
+ta,た
+ti,ち
+tu,つ
+te,て
+to,と
+na,な
+ni,に
+nu,ぬ
+ne,ね
+no,の
+ha,は
+hi,ひ
+hu,ふ
+he,へ
+ho,ほ
+ma,ま
+mi,み
+mu,む
+me,め
+mo,も
+ya,や
+yu,ゆ
+yo,よ
+ra,ら
+ri,り
+ru,る
+re,れ
+ro,ろ
+wa,わ
+wi,うぃ
+we,うぇ
+wo,を
+nn,ん
+ga,が
+gi,ぎ
+gu,ぐ
+ge,げ
+go,ご
+za,ざ
+zi,じ
+zu,ず
+ze,ぜ
+zo,ぞ
+da,だ
+di,ぢ
+du,づ
+de,で
+do,ど
+ba,ば
+bi,び
+bu,ぶ
+be,べ
+bo,ぼ
+pa,ぱ
+pi,ぴ
+pu,ぷ
+pe,ぺ
+po,ぽ
+va,う゛ぁ
+vi,う゛ぃ
+vu,う゛
+ve,う゛ぇ
+vo,う゛ぉ
+#va,ゔぁ
+#vi,ゔぃ
+#vu,ゔ
+#ve,ゔぇ
+#vo,ゔぉ
+#vyu,ゔゅ
+
+xa,ぁ
+xi,ぃ
+xu,ぅ
+xe,ぇ
+xo,ぉ
+xtu,っ
+xke,ヶ
+cha,ちゃ
+chi,ち
+chu,ちゅ
+che,ちぇ
+cho,ちょ
+fa,ふぁ
+fi,ふぃ
+fu,ふ
+fe,ふぇ
+fo,ふぉ
+
+xya,ゃ
+xyu,ゅ
+xyo,ょ
+xwa,ゎ
+kya,きゃ
+kyi,きぃ
+kyu,きゅ
+kye,きぇ
+kyo,きょ
+gya,ぎゃ
+gyi,ぎぃ
+gyu,ぎゅ
+gye,ぎぇ
+gyo,ぎょ
+sya,しゃ
+syi,しぃ
+syu,しゅ
+sye,しぇ
+syo,しょ
+sha,しゃ
+shi,し
+shu,しゅ
+she,しぇ
+sho,しょ
+ja,じゃ
+ji,じ
+ju,じゅ
+je,じぇ
+jo,じょ
+jya,じゃ
+jyi,じぃ
+jyu,じゅ
+jye,じぇ
+jyo,じょ
+zya,じゃ
+zyi,じぃ
+zyu,じゅ
+zye,じぇ
+zyo,じょ
+tya,ちゃ
+tyi,ちぃ
+tyu,ちゅ
+tye,ちぇ
+tyo,ちょ
+tha,てゃ
+thi,てぃ
+thu,てゅ
+the,てぇ
+tho,てょ
+dha,でゃ
+dhi,でぃ
+dhu,でゅ
+dhe,でぇ
+dho,でょ
+dya,ぢゃ
+dyi,ぢぃ
+dyu,ぢゅ
+dye,ぢぇ
+dyo,ぢょ
+nya,にゃ
+nyi,にぃ
+nyu,にゅ
+nye,にぇ
+nyo,にょ
+hya,ひゃ
+hyi,ひぃ
+hyu,ひゅ
+hye,ひぇ
+hyo,ひょ
+pya,ぴゃ
+pyi,ぴぃ
+pyu,ぴゅ
+pye,ぴぇ
+pyo,ぴょ
+bya,びゃ
+byi,びぃ
+byu,びゅ
+bye,びぇ
+byo,びょ
+mya,みゃ
+mya,みぃ
+myu,みゅ
+mye,みぇ
+myo,みょ
+rya,りゃ
+ryi,りぃ
+ryu,りゅ
+rye,りぇ
+ryo,りょ
+
+z,,‥
+z-,〜
+z.,…
+z/,・
+z[,『
+z],』
+zh,←
+zj,↓
+zk,↑
+zl,→
+#z ,　
+#z(,（
+#z),）

app/src/main/java/jp/deadend/noname/skk/SKKKanaRule.kt

@@ -8,18 +8,19 @@ import java.io.IOException
 
 object SKKKanaRule {
     internal const val INTERNAL_FILE_NAME = "kana-rule.conf"
+    internal const val DEFAULT_RULE_FILE = "skk-kana-rule.conf"
     private const val MAX_FILE_SIZE = 1 * 1024 * 1024 // 1MB
 
-    fun exists(context: Context): Boolean =
-        getInternalFile(context).exists()
-
-    private fun getInternalFile(context: Context): File =
-        File(context.filesDir, INTERNAL_FILE_NAME)
+    fun getInternalFile(context: Context): File {
+        val file = File(context.filesDir, INTERNAL_FILE_NAME)
+        if (!file.exists()) clear(context)
+        return file
+    }
 
     /**
      * kana-rule.conf テキストをパースして Map<入力列, ひらがな> を返す。
-     * フォーマット: 入力,ひらがな[,カタカナ]
-     * # で始まる行と空行は無視する。
+     * フォーマット: 入力,ひらがな
+     * (# で始まる行と空行は無視する。)
      */
     fun parse(text: String): Map<String, String> {
         val result = mutableMapOf<String, String>()
@@ -29,6 +30,8 @@ object SKKKanaRule {
             val fields = trimmed.split(",")
             if (fields.size < 2) continue
             val input = fields[0].trim()
+                .replace("&sharp;", "#", ignoreCase = true)
+                .replace("&comma;", ",", ignoreCase = true)
             val hiragana = fields[1].trim()
             if (input.isNotEmpty() && hiragana.isNotEmpty()) {
                 result[input] = hiragana
@@ -43,7 +46,6 @@ object SKKKanaRule {
      */
     fun loadFromInternalStorage(context: Context): Map<String, String>? {
         val file = getInternalFile(context)
-        if (!file.exists()) return null
         if (file.length() > MAX_FILE_SIZE) {
             Log.e("SKK", "SKKKanaRule#loadFromInternalStorage() Error: File is too large")
             return null
@@ -68,7 +70,10 @@ object SKKKanaRule {
                 if (sizeIndex != -1 && cursor.moveToFirst()) {
                     val size = cursor.getLong(sizeIndex)
                     if (size > MAX_FILE_SIZE) {
-                        Log.e("SKK", "SKKKanaRule#saveFromUri() Error: File is too large ($size bytes)")
+                        Log.e(
+                            "SKK",
+                            "SKKKanaRule#saveFromUri() Error: File is too large ($size bytes)"
+                        )
                         return false
                     }
                 }
@@ -93,9 +98,12 @@ object SKKKanaRule {
     }
 
     /**
-     * 内部ストレージの kana-rule.conf を削除する。
+     * 内部ストレージの kana-rule.conf を初期化する。
      */
     fun clear(context: Context) {
-        getInternalFile(context).delete()
+        val file = File(context.filesDir, INTERNAL_FILE_NAME)
+        val defaultRule = context.resources.assets.open(DEFAULT_RULE_FILE)
+            .bufferedReader().use { it.readText() }
+        file.writeText(defaultRule)
     }
 }