検索条件の文字列をエスケープする処理を関数化する

[berryzplus]

PR の目的

CGrepAgent::DoGrep関数を分かりやすくするために、関数内の重複処理に名前を付けて関数化します。処理に名前が付くことによって「何をしているか」が明確になり、分かりやすくなります。

カテゴリ

• リファクタリング

PR の背景

CGrepAgent::DoGrep関数は、Grep検索とGrep置換の実処理を担当する部分です。

長年の機能追加により、処理内容がかなりぐちゃぐちゃになっており、
リファクタリングが必要な関数だと思っています。

サクラエディタのGrep機能は比較的信頼できる部類のツールですが、
Grep処理がシングルスレッドで行われる都合でパフォーマンスがよくありません。

処理のマルチスレッド化を行うにあたっては、
基本的な部分の整理が必要と考え、
まずは「見たら分かる」レベルの簡単なリファクタリングを提案してみることにしました。

PR のメリット

• 検索条件の文字列リテラルをタイプ別設定に従ってエスケープする処理に名前が付きます。(EscapeStringLiteral)
• 検索対象文字列と置換後文字列のエスケープ処理を共通化するので、今後エスケープ処理を変えたくなったときに、どちらかの変更をし忘れる事態を防ぐことができます。

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

• 検索対象文字列と置換後文字列のエスケープ処理を共通化してしまうので、今後エスケープ処理を意図的に分けたくなったときに困る可能性があります。
  ※そういう趣旨の変更がレビューで通る事態は想像できませんが、将来どうするかは分からんので。

PR の影響範囲

• アプリ（＝サクラエディタ）の機能に影響はありません。
• 改修箇所は、Grep検索およびGrep置換の「検索条件」と、Grep置換の「置換後」の表示方法に関連する部分です。処理内容は一切変えていないので変更前後比較をしても何も変わりません。

関連チケット

参考資料

[AppVeyorBot]

✅ Build sakura 1.0.2474 completed (commit 2625abd27f by @berryzplus)

[AppVeyorBot]

✅ Build sakura 1.0.2475 completed (commit ea1c1d3d33 by @berryzplus)

[beru]

問題無いと思います。
動作確認はしていません…。

[berryzplus]

レビューありがとうございます。
何か問題が見つかったら別PRで対処していきます。

[usagisita]

cmemWork=>pcmGrepKey は、GUI、コマンドラインともに、普通に2048文字を超える検索に対応しているので、アウトですね。
cmemReplaceのほうも同様です。

[beru]

sakura/sakura_core/mem/CNativeW.cpp

Lines 85 to 104 in 48021e1

	//! バッファの最後にデータを追加する (フォーマット機能付き)
	void CNativeW::AppendStringF(const wchar_t* pszData, ...)
	{
	wchar_t buf[2048];
	// 整形
	va_list v;
	va_start(v, pszData);
	int len = _vsnwprintf_s(buf, _countof(buf), _TRUNCATE, pszData, v);
	int e = errno;
	va_end(v);
	if (len == -1) {
	DEBUG_TRACE(L"AppendStringF error. errno = %d", e);
	throw std::exception();
	}
	// 追加
	this->AppendString(buf, len);
	}

お、本当ですね。言われてみるとそういえばそうだった…感が…。

[beru]

#1135 を作成しました。