documentation

Author: mad-p

ConfigParams.md

@@ -103,6 +103,8 @@ MacTcodeは`config.json`形式の設定ファイルを使用してカスタマ
 "system": {
   "recentTextMaxLength": 20,
   "excludedApplications": ["com.apple.loginwindow", "com.apple.SecurityAgent"],
+  "disableOneYomiApplications": ["com.google.Chrome"],
+  "syncStatsInterval": 1200,
   "keyboardLayout": "dvorak",
   "keyboardLayoutMapping": [
     "1", "2", "3", "4", "5", "6", "7", "8", "9", "0",
@@ -116,6 +118,14 @@ MacTcodeは`config.json`形式の設定ファイルを使用してカスタマ
 
 - **`recentTextMaxLength`**: 最近入力したテキストの保存最大文字数（1-100）
 - **`excludedApplications`**: T-Code処理を無効化するアプリケーションのBundle IDリスト
+- **`disableOneYomiApplications`**: 1文字の読みを無効化するアプリケーションのBundle IDリスト
+  - Google Chromeなど、一部のアプリケーションでは1文字の読みでの変換が正しく動作しない場合があります
+  - このリストに含まれるアプリケーションでは、最低2文字の読みが必要になります
+- **`syncStatsInterval`**: 統計情報をファイルに出力する間隔（秒単位）
+  - デフォルト値: 1200（20分）
+  - 0に設定すると統計ファイルの出力が無効になります
+  - 統計情報は入力メソッド切り替え時やアプリケーション終了時に自動的に保存されます
+  - 詳細はREADME.mdの「統計情報の記録」セクションを参照してください
 - **`keyboardLayout`**: キーボードレイアウトの名前（"dvorak", "qwerty"等）
 - **`keyboardLayoutMapping`**: 40個のキー配列マッピング（文字列配列）
 - **`logEnabled`**: デバッグログの出力有効/無効

README.md

@@ -22,6 +22,7 @@ macOS用のT-Codeが使えるIMとして[MacUIM](https://github.com/e-kato/macui
 - [x] 全角入力モード (v0.1.4.1)
 - [x] 配布パッケージ、notarization
 - [x] configファイルサポート
+- [x] 統計情報の記録
 - [ ] パスワード入力時はパススルーする
 - [ ] メニュー(config再読み込みとかテンプレ生成とか)
 - [ ] 1行入力(T-Code変換をしつつバッファにため、一気に入力するモード)
@@ -49,7 +50,8 @@ MacTcodeは設定ファイルを使用してカスタマイズできます。
 
 ### 設定ファイルの場所
 
-設定ファイルは以下の場所に配置してください：
+
+設定ファイルはsandboxに対応したアプリケーションサポートディレクトリに配置してください。通常は以下の場所にあると思います。
 ```
 ~/Library/Containers/jp.mad-p.inputmethod.MacTcode/Data/Library/Application Support/MacTcode/config.json
 ```
@@ -84,6 +86,63 @@ MacTcodeを一度起動するとコピー先ディレクトリが作られます
 - **辞書ファイルパス**: 部首変換辞書のファイルパス
 - **ログ出力**: デバッグログの有効/無効
 - **バックスペース動作**: 変換時のバックスペース設定
+- **統計情報の記録**: 入力統計の自動記録（詳細は下記参照）
+
+## 統計情報の記録
+
+MacTcodeは入力操作の統計情報を自動的に記録します。
+
+### 統計ファイルの場所
+
+統計情報は `tc-record.txt` というファイルに追記されます。このファイルは設定ファイルと同じディレクトリにあります。
+
+### 記録される統計情報
+
+統計ファイルには以下の情報が記録されます：
+
+```
+2025-10-19 14:30:45 文字: 1234  部首:  45(3%)  交ぜ書き:  23(1%)  機能:  12(0%)
+```
+
+各項目の意味：
+- **日時**: 統計が記録された日時
+- **文字**: 基本文字の入力回数（T-Code基本入力）
+- **部首**: 部首変換の実行回数と全体に占める割合（%）
+- **交ぜ書き**: 交ぜ書き変換の実行回数と全体に占める割合（%）
+- **機能**: キーマップ内に割り当てられている機能(部首/交ぜ書き変換のトリガを含む)の実行回数と全体に占める割合（%）
+
+### 統計出力のタイミング
+
+統計情報は以下のタイミングで自動的に出力されます：
+
+1. **定期的な出力**: `syncStatsInterval`（デフォルト1200秒=20分）で設定した間隔が経過し、入力メソッドを切り替えたとき
+2. **アプリケーション終了時**: MacTcodeが終了するとき
+3. **シグナル受信時**: プロセスがSIGINTまたはSIGTERMを受信したとき
+
+### 統計出力の設定
+
+設定ファイル（`config.json`）の`system`セクションで統計出力を制御できます：
+
+```json
+"system": {
+  "syncStatsInterval": 1200
+}
+```
+
+- **`syncStatsInterval`**: 統計出力の間隔（秒単位）
+  - デフォルト値: 1200（20分）
+  - **0に設定すると統計ファイルへの出力が無効になります**
+  - 正の値: 指定した秒数ごとに統計を出力
+
+統計を記録したくない場合は、`syncStatsInterval`を0に設定してください：
+
+```json
+"system": {
+  "syncStatsInterval": 0
+}
+```
+
+詳細な設定方法については[ConfigParams.md](ConfigParams.md)を参照してください。
 
 ## 参考文献
 

TODO.md

@@ -1,32 +1,12 @@
-# 入力統計をファイルに出力
+✅ 完了: 以下のドキュメントを更新しました
 
-- 統計情報をカウントするため、大域変数を4つ用意する。すべてInt型
-    - basicCount
-    - bushuCount
-    - mazegakiCount
-    - functionCount
-    - totalActionCount
-- 以下の場合にカウントを増やす
-    - Command.textの処理時
-        - basicCountを1増やす
-        - totalActionCountを1増やす
-    - PostfixBushuActionの処理時
-        - bushuCountを1増やす
-    - PostfixMazegakiActionの処理時
-        - mazegakiCountを1増やす
-    - Command.actionの処理時
-        - functionCountを1増やす
-        - totalActionCountを1増やす
-- SIGINT, SIGTERMを受け取った場合、統計情報をファイルの末尾に追記する
-    - ファイル名は `tc-record`
-    - ファイルを置くディレクトリは applicationSupportDirectory/MacTcode とする
-        - UserConfigsクラスでconfig.jsonの場所を計算しているので、同様の方法とする
-    - ファイルおよびディアクトリが存在しなければ作成する
-    - 追記する内容は1行
-        - `\(date)文字: \(basicCount)  部首: \(bushuCount)(\(bushuPercent))  交ぜ書き: \(mazegakiCount)(\(mazegakiPercent)%)  機能: \(functionCount)(\(functionPercent)%)`
-        - dateは、書き出し時の日時をローカル時刻で `YYYY-mm-dd HH:MM` 形式で表現したもの
-        - basicCount, bushuCount, mazegakiCount, functionCountはそれぞれ同名の大域変数の値を `%4d` 形式で桁そろえしたもの
-        - bushuPercent, mazegakiPercent, functionPercentはそれぞれ、対応するCount変数の値のtotalActionCountを分母とした割合をパーセントで表現した整数部分
-- SIGINT, SIGTERMのハンドリングは以下の方法で登録したハンドラで行う
-    - signalによって、デフォルトハンドリングを SIG_IGN する
-    - DispatchSource.makeSignalSourceを用いてハンドラを登録する
+ConfigParams.md:
+- syncStatsIntervalの設定項目を追加
+- disableOneYomiApplicationsの設定項目を追加
+
+README.md:
+- 「統計情報の記録」セクションを新規追加
+  - 統計ファイルの場所: ~/Library/Application Support/MacTcode/tc-record.txt
+  - 記録される統計情報の意味（文字、部首、交ぜ書き、機能）
+  - 統計出力のタイミング
+  - syncStatsIntervalを0に設定すると統計ファイルは出力されないこと

sample-config.json

@@ -75,7 +75,8 @@
       ";", "q", "j", "k", "x", "b", "m", "w", "v", "z"
     ],
     "logEnabled" : false,
-    "recentTextMaxLength" : 20
+    "recentTextMaxLength" : 20,
+    "syncStatsInterval" : 1200
   },
   "ui" : {
     "backspaceDelay" : 0.05,