TERATERM.INI ファイル保存待ち時間を短くする

[tomo3136a]

提案となります。

設定の保存(Save setup...)は、待ち時間が長いです。
前々から時間がかかっていましたが、バージョンを重ねるごとに長くなっています。

ゆびおりの簡易確認ですが、自分の環境では、以下でした。

version	wait
4.84	3秒
4.108	4秒
5.1	4.5秒
5.2	4.5秒
5.3	5秒
5.4.0	5秒
5.5.0	5秒
5.6.1	6秒
5.7.0	6秒

設定の保存のどの処理で時間がかかっているかというと ttpset\ttset.c の _WriteIniFile() 関数になります。

_WriteIniFile() 関数では、WritePrivateProfileString() を設定項目すべてに対して行っています。
この操作が積もりに積もって待ち時間を長くしています。
バージョンを重ねるごとに機能追加により項目が増えていくため、当然といえば当然です。

設定の読み込み(Restore setup...) は、保存と違い、一瞬で処理が終わるため、待ち時間は気になりません。

そこで緩和策として以下を考えました。

通常は、数点の設定項目の書き換えだけでよいはずです。
各項目ごとの WritePrivateProfileString() を行う前に TERATEM.INI ファイルの内容を読み出し、
値が書き込み値と同じなら書き込みを行わないようにすることで時間のかかる処理を大幅に減らします。

実験してみたところ保存は一瞬で終わり、持ち時間は無くなります。問題が解消します。
細かいチェックはできていませんが、それほど難しい変更をしてはいないので使えそうです。

いかがでしょうか。

[tomo3136a]

設計法方針とかイメージとかあるかもしれないので、そこらへんに問題なければ PR したいと思います。

[hkanou]

ご提案頂きありがとうございます。

設計法方針とかイメージとかあるかもしれないので、そこらへんに問題なければ PR したいと思います。

設定の保存(Save setup...)時間の短縮は、ユーザエクスペリエンスを向上させる有益な改善と考えています。
以下の2点が気になりました。

1. INIファイル内のコメントが消えないか？
2. プラグイン TTXCopyIniFile.dll との整合性
   https://github.com/TeraTermProject/teraterm/blob/main/TTXSamples/TTXCopyIniFile/ReadMe-ja.txt

前向きに検討させて頂ければと思います。

[tomo3136a]

1. INIファイル内のコメントが消えないか？

実験してみたコードではコメントは消えないです。

2. プラグイン TTXCopyIniFile.dll との整合性

プラグイン TTXCopyIniFile.dll の有無で何が変わるのか調査中です。
説明の内容より現象を発生させる方法を想定してリリース版で試してみていますが、
このプラグインを必要とする手順を見つけられていません。
もう少し調べてみようと思いますが、
可能であればこうすれば説明の内容にある「コメント等が消えてしまう」という現象を出す手順をお教えいただけないでしょうか。

[tomo3136a]

特に急ぐものでもないと思いますので、時間が出来たらお教えいただければと思います。

[nmaya]

検討ありがとうございます。

この操作が積もりに積もって待ち時間を長くしています。
バージョンを重ねるごとに機能追加により項目が増えていくため、当然といえば当然です。

4.84から5.7.0で項目数が2倍にまで膨れ上がっているかというと、そういうことはないと思います。
参考情報として、手元では Defender を切れば一瞬で処理が終わります。

TERATEM.INI ファイルの内容を読み出し、値が書き込み値と同じなら

「書き込みたいINIファイルが存在しない場合」または「書き込みたいINIファイルがあるがキーが存在しない場合」があります。
GetPrivateProfileString/Int にはデフォルト値がありますので、読み込めない場合にはその値が返ってきます。
「書き込みたいINIファイルからその設定を読み出す」→「デフォルト値が読み込まれる」→「値が同じ」→「その設定はINIファイルに書き込まれない」となる可能性があります。
このような場合に対応する設計があるでしょうか。

[tomo3136a]

ご指摘ありがとうございます。

4.84から5.7.0で項目数が2倍にまで膨れ上がっているかというと、そういうことはないと思います。

表の値は、普段使用している自分の環境での結果で、環境のよると考えております。
別のPCで確認したとき(5.7.0のみ確認)は、待ち時間は半分ぐらいでした。
それでも待ち時間を感じるのでスムーズの感じない。

参考情報として、手元では Defender を切れば一瞬で処理が終わります。

待ち時間の発生は、Tera Term に非があるとは思っておらず、 Anti-malware などが介在しているのだろうとは思っています。
「Defender を切る」というのは現実の環境としてはないかなと思い、待ち時間を減らせないかと考えました。

「書き込みたいINIファイルからその設定を読み出す」→「デフォルト値が読み込まれる」→「値が同じ」→「その設定はINIファイルに書き込まれない」となる> 可能性があります。

INIファイルの存在は、書き出すことが目的ではなくてTera Termに設定を取り込むことで状態を復元することが目的だと思います。
以下は、Tera Termの動作的には同じに思えます。

• ...→「その設定はINIファイルに書き込まれない」→「デフォルト値が読み込まれる」→「デフォルト値でTera Termが動作する」
• ...→「その設定(デフォルト値)をINIファイルに書き込む」→「その設定(デフォルト値)が読み込まれる」→「その設定(デフォルト値)でTera Termが動作する」

このような場合に対応する設計があるでしょうか。

実験コードでは、INIファイルに書き込みたい値とINIファイルからの読み込み値の比較であり、 GetPrivateProfileString/Int のデフォルト値は、参照していません。
実験コードを検討用として PR してみました。(PR #1541)
※仮の時は Draft Pull Request みたいなことが書いてあったので、使ってみました。
何が差分になったのかわかりませんが、使い方が間違っていたらご指摘願います。

案は、以下となります。

teraterm/common/inifile_com.cpp と teraterm/ttpset/ttset.c 内で呼び出される WritePrivateProfileStringW が対象となります。
WritePrivateProfileStringW を新たに作った WritePrivateProfileStringWFileW で置き換えて使います。
※作った関数の関数名は不適切かもしれません。
※また、実験的に作ったので、WritePrivateProfileStringW を関数マクロで置き換えていますが、関数マクロでではなく、関数へ置き換えた方が将来的に間違いが起きないかもしれません。

WritePrivateProfileStringWFileW 内の動作

1. 書き込みの設定値が NULL の場合は、"" とします。
2. デフォルト値は "" としてINIファイルから読み込みます。(以下、値は読み込み値と称す)
   INIファイルが存在しない場合、 "" となります。
   キーが存在しない場合、 "" となります。
   キーが存在する場合、INIファイルからの読み込み値となります。
3. 読み込み値が "" の場合、デフォルト値は "*" に換えてINIファイルから読み込みます。
   キーが存在しない場合は "" にならないので、読み込み値を書き込みの設定値と異なる文字列にします。
4. 書き込みの設定値と読み込み値を文字列比較します。
5. 書き込みの設定値と読み込み値が同じなら書き込みはしない。
6. 異なるなら Win32API の WritePrivateProfileStringW で書き込む。

書き込みを行う条件

• 書き込みの設定値とINIファイルからの読み込み値が異なる文字列の場合
• INIファイルにキーが存在しない場合

[tomo3136a]

何が差分になったのかわかりませんが...

PR の説明のところのアイコンがDraft用になっているのと、説明に「Draft」を明記されてました。

[hkanou]

実験してみたコードではコメントは消えないです。

ご確認頂きありがとうございます。

プラグイン TTXCopyIniFile.dll の有無で何が変わるのか調査中です。

TTXCopyIniFile.dll は、起動時のINIファイルと保存時の INI ファイルが異なる場合に、コメントが消えないよう、起動時の INI ファイルを保存時の INI ファイルにコピーします。
OSDN のフォーラムが参照出来なくなっており TTXCopyIniFile.dll の状況は不明ですが、同じ処理が ttermpro にも存在しますので、既に ttermpro に取り込まれているようです。(リリース版には TTXCopyIniFile.dll が含まれていません)

teraterm/teraterm/teraterm/vtwin.cpp

Line 4826 in 4dc7034

CopyFileW(PrevSetupFNW, ts.SetupFNameW, TRUE);

可能であればこうすれば説明の内容にある「コメント等が消えてしまう」という現象を出す手順をお教えいただけないでしょうか。

現在の ttermpro では「コメント等が消えてしまう」現象は解消されており、TTXCopyIniFile.dll は気にしなくて良いように思われます。

[hkanou]

以下は、Tera Termの動作的には同じに思えます。
...→「その設定はINIファイルに書き込まれない」→「デフォルト値が読み込まれる」→「デフォルト値でTera Termが動作する」
...→「その設定(デフォルト値)をINIファイルに書き込む」→「その設定(デフォルト値)が読み込まれる」→「その設定(デフォルト値)でTera Termが動作する」

デフォルト値で動作するパラメタについて、INIファイルにキーが存在しなくても Tera Term の動作自体は同じです。
ただし、一部の設定項目は GUI から変更できず、INI ファイルを直接編集する必要があります。
その場合、キーとデフォルト値が INI ファイル内に存在していた方が、ユーザが値を編集しやすくなります。
また、キーが存在することで、設定項目があること自体に気づく可能性が高まります。
そのため、デフォルト値の場合も INI 内にキーを残しておくことが好ましいように思われます。

[nmaya]

INIファイルの存在は、書き出すことが目的ではなくてTera Termに設定を取り込むことで状態を復元することが目的だと思います。

おっしゃるとおり、書き出した設定を改めて読み込んですべて復元されることが望ましいと思います。
書き出しと読み込みで Tera Term のバージョンが違い、デフォルト値が変わる可能性があります。
したがって、すべて書き出されるのがよいと考えます。

[hkanou]

※仮の時は Draft Pull Request みたいなことが書いてあったので、使ってみました。

GitHub の推奨する使い方です。

※作った関数の関数名は不適切かもしれません。

WritePrivateProfileStringWifNeeded() のような関数名が良さそうです。

※また、実験的に作ったので、WritePrivateProfileStringW を関数マクロで置き換えていますが、関数マクロでではなく、関数へ置き換えた方が将来的に間違いが起きないかもしれません。

おっしゃるとおり、最終的には関数にするのが良いと思います。

[nmaya]

したがって、すべて書き出されるのがよいと考えます。

少し言葉が足りなかったように思いました。

• 1 INIファイルが存在しない
  • 書き込む
• INIファイルがある
  • 2 キーが存在しない
    • 書き込む
  • キーが存在する
    • 3 読み込んだ値と現在の設定値が同じ※
      • 書き込まない
    • 4 読み込んだ値と現在の設定値が異なる
      • 書き込む

これでよいと思いますが、※の「読み込んだ値と現在の設定値の比較」が「単に読み込んだ値」では不十分と考えます。

---

PR を拝見しました。

• WritePrivateProfileString で NULL を書き込むのはキーの削除動作だったと思いますので、NULL を判定して置き換えるのはなにかおかしい気がします。
• lenW_max より長い文字列が INI に書き込まれていたときどうなるでしょうか。
• ぱっと思いつくのは DelimList くらいですが、* を設定しうる設定項目があるかもしれません。

[nmaya]

こういう感じだとパターンを網羅できそうでしょうか？

Int
int 値1 = GetPrivarteProfileInt（デフォルト値1）
int 値2 = GetPrivarteProfileInt（デフォルト値2）

if (値1 != 値2) {
  // 1 ファイルなし・2 キーなし
  // またはキーあって値がない ... GetPrivarteProfileStringを使えば判定できそうだが、このケースを分ける必要はない？
  書き込む
}
else if (現在値 == 値1) { // 値2でも同じ
  // 3 同じなので書き込まない
}
else {
 // 4 異なるので書き込む
}
-----
String
値 = GetPrivarteProfileString（デフォルト値 すごくランダムな文字列）

if (値 == すごくランダムな文字列) {
  // 1 ファイルなし・2 キーなし
  書き込む
}
else if (現在値 == 値) {
  // 3 同じなので書き込まない
}
else {
 // 4 異なるので書き込む
}

[tomo3136a]

現在の ttermpro では「コメント等が消えてしまう」現象は解消されており、TTXCopyIniFile.dll は気にしなくて良いように思われます。

そのようです。自分が調べた範囲でも「コメント等が消えてしまう」現象は解消されているように見えます。
だとすると、TTXCopyIniFile.dll も TTXAdditionalTitle.dll 同様 (deprecated) 扱いか、 Portable 版の _TTXFixedWinSize.dll の様に先頭の _ を外さないと有効にならない が良いように思いました。

コメントが消える現象で見つけられたのは、次の手順ぐらいでした。

1. Tera Term 起動後に TERATERM.INI を削除。
2. その後、設定の保存をするとコメントは消える。

TTXCopyIniFile.dll の目的とは少し異なるし、TTXCopyIniFile.dll の有無でこの現象は解消されない。

コメントいただいた通り、TTXCopyIniFile.dll は気にしないようにします。

[tomo3136a]

@hkanou @nmaya

そのため、デフォルト値の場合も INI 内にキーを残しておくことが好ましいように思われます。

そうですね。省略可能でもキーは明示されている方が使いやすそうです。

書き出しと読み込みで Tera Term のバージョンが違い、デフォルト値が変わる可能性があります。

後方互換性の確保のため、バージョン違いでデフォルト値が変わる可能性はまずはないと感じています。
とはいえ、可能性は0ではないのでデフォルト値でも書き込むという方針には賛成です。