タイプ別設定のインポートでバージョンチェックが正しく働いていなかった

[usagisita]

PR の目的

タイプ別設定インポートのときに表示される、iniファイルのバージョン情報が必ず「?」になっていた不具合を修正します。

カテゴリ

• 不具合修正

PR の背景

Visual StudioでWarningLevel4のチェックをしていたところ、見つけた不具合のひとつです。
せっかくなので直したいです。

PR のメリット

バグが修正されます。

PR のデメリット (トレードオフとかあれば)

仕様・動作説明

読み込みのためにszKeyVersionという変数が宣言されていましたが、これが定数の同名のiniキー名を隠ぺいしていました。
そのため、IOProfileDataの行でキー名「?」を読み込もうとして、必ず失敗していました。
変数名を変更したうえで長さの心配がないstd::wstringに置き換えました。

PR の影響範囲

タイプ別設定のインポート時に表示される、バージョンが違う時の警告のダイアログの表示だけです。

テスト内容

テスト1

手順

古いバージョンのタイプ別設定のエクスポートしたiniファイルを用意します。
そうでない場合は、最新版でエクスポートしたiniファイルをエディタで開いて、末尾にある[Info]のszKeyStructureVersionを小さい値に書き換えます。

タイプ別設定一覧でインポートしようとすると、
「エクスポートしたsakura(?/177)とバージョンが異なります。
インポートしてもよろしいですか？」
というようなダイアログが表示されます。
修正前は「?」になっています。
PRの修正後は「2.4.2.0」のようにiniの[Info]szVersionキーの内容が表示されるようになります。

関連 issue, PR

参考資料

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication

[AppVeyorBot]

✅ Build sakura 1.0.3625 completed (commit 2a55226a05 by @usagisita)

[berryzplus]

やや悩ましいです。

間違いました。

[usagisita]

L"szKeyVersion"で直るというのは、自分もそう思います。
ただし「変数名の隠ぺい(？)」も「C-スタイル固定長配列文字列」も一応、SonarCloudの警告対象のようでした。
https://sonarcloud.io/project/issues?directories=sakura_core%2Ftypeprop&fileUuids=AWdx6FIKcrQ7oSxgA3n6&id=sakura-editor_sakura&open=AWdx6FwTcrQ7oSxgA4wX&resolved=false

[berryzplus]

L"szKeyVersion"で直るというのは、自分もそう思います。
ただし「変数名の隠ぺい(？)」も「C-スタイル固定長配列文字列」も一応、SonarCloudの警告対象のようでした。
https://sonarcloud.io/project/issues?directories=sakura_core%2Ftypeprop&fileUuids=AWdx6FIKcrQ7oSxgA3n6&id=sakura-editor_sakura&open=AWdx6FwTcrQ7oSxgA4wX&resolved=false

ようやく理解しました。

問題あるのはこっちのコードで、PR修正内容は正しそうです。

sakura/sakura_core/typeprop/CImpExpManager.cpp

Line 62 in decf0ad

static const wchar_t szKeyVersion[] = L"szVersion";

👆のコードの問題点

• グローバルスコープに宣言するものに、それと分かる命名をしていない。
  他を見たら分かると思いますが g_szKeyVersion ないし KEY_VERSION とする方針っぽいです。
• 「定数」を定義するのに constexpr 修飾を付けていない。
  コンパイル時定数 constexpr は C++11 からなので、仕方ないといえば仕方ないっす。

この問題の対処は別件としてリファクタリングしたほうが良いかもしれません。

[usagisita]

レビューありがとうございました。
マージします。