ノート線描画を少し分かりやすくする

[berryzplus]

PR の目的

ノート線描画に関わるコードを整理して、メンテナンスしやすくします。

カテゴリ

• リファクタリング

PR の背景

#1065 (comment) で指摘した内容を実装してみました。

1. 指定した範囲内にノート線を描くメソッドに単数形の名前が付いている
   ⇒ 元々複数の横線を描く目的のメソッドだから改名しよう！
2. 引数の型が int になので、ピクセル指定か桁指定か紛らわしい(と思った)
   ※ 最近の Windows GDI では、ピクセル位置を指定するのに LONG 型の変数を使います。
   ⇒ 引数がピクセル指定であることを明示するために LONG 型に訂正しよう！
3. 領域を受け取る関数は left, top, right, bottom の順に指定するのが標準(だと思います)
   ⇒ 標準 に合わせて指定順を変更しよう！
4. 複数の線分を描く目的の関数なのに、線分を1本ずつ描いているのが効率悪い(気がする)
   ⇒ 描画に必要なデータを作る処理とAPI呼出を分離して一撃で描画するように改善しよう！

PR のメリット

• ノート線描画の処理が少し分かりやすくなります。

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

• メソッドの引数変更を伴うので、影響範囲が広いです。
• この対応を行うことにより、ノート線描画にもDPI対応が必要であることに気付きましたが、放置しています。

PR の影響範囲

• アプリ(=サクラエディタ)の機能に影響がある変更です。
  • ただし、見た目も体感速度も変化してない気がします。
• ノート線描画を行う処理に影響します。
  • 通常の描画処理(行番号を含む行データの描画)
  • 通常の描画処理(行番号のみの描画)
  • 対括弧の強調表示により上書き描画を行う際のノート線の描画処理
• ノート線描画の処理内容が変更になります。
  • 変更前) 描画するノート線の本数分だけ MoveToEx + LineTo 繰り返し。
  • 変更後) 描画するノート線の本数に関わらず PolyPolyLine 一発。
• 変更による影響として大きいのは、今後のメンテナンスがしやすくなる(主観)ことだと思っています。

関連チケット

#1065 ノート線描画、指定桁縦線描画、折り返し桁縦線描画、を行毎ではなく一括で行うように変更

参考資料

https://docs.microsoft.com/en-us/windows/win32/api/wingdi/nf-wingdi-polypolyline
https://docs.microsoft.com/en-us/windows/win32/api/wingdi/nf-wingdi-movetoex
https://docs.microsoft.com/en-us/windows/win32/api/wingdi/nf-wingdi-lineto

[AppVeyorBot]

✅ Build sakura 1.0.2292 completed (commit 3c10afb5e1 by @berryzplus)

[beru]

問題無いと思います。

[beru]

処理時間の観点からのコメントですが、ノート線描画を有効にした場合 CTextDrawer::DispLineNumber から呼び出される CTextDrawer::DispNoteLines の処理に 5% 程度時間が掛かっているようです（Performance Profiler で確認）。

共通設定のウィンドウの「行番号とテキストの隙間」の値が 0 ドットだと、left と right の値は同じになる事が多いので呼び出す意味が無いような気がします。

高速化の為に CTextDrawer::DispLineNumber 内で呼び出さずに CEditView::OnPaint2 内で呼び出せると良いですが、ちょっとその変更は行いにくいかもしれません。

ところでノート線の存在って今まで意識してませんでした。使ってる人いるのかな…。

[berryzplus]

レビューありがとうございます。
#1067 のレビューで、入れといたほうがよいキャストがあることに気付いたので後で追加コミットつみます。

処理時間の観点からのコメントですが、ノート線描画を有効にした場合 CTextDrawer::DispLineNumber から呼び出される CTextDrawer::DispNoteLines の処理に 5% 程度時間が掛かっているようです（Performance Profiler で確認）。

共通設定のウィンドウの「行番号とテキストの隙間」の値が 0 ドットだと、left と right の値は同じになる事が多いので呼び出す意味が無いような気がします。

高速化の為に CTextDrawer::DispLineNumber 内で呼び出さずに CEditView::OnPaint2 内で呼び出せると良いですが、ちょっとその変更は行いにくいかもしれません。

いけるんじゃないかな？と 😃

• CTextDrawer::DispLineNumber 行単位で行番号を描画する関数
• CTextDrawer::DispNoteLines 範囲指定で複数のノート線を描画する関数

役割を明確にしたことによって、外に出したほうが良いと分かったから外に出します、で問題ない気がします。

ところでノート線の存在って今まで意識してませんでした。使ってる人いるのかな…。

サクラエディタのユーザー層には「文筆家」という職業の人がいるらしいです。
twitterのつぶやき数でもってそう思ってるだけなので本当かどうかは知りません。

モノ書きの人にとってみれば、横書きテキストにノート線がはいっていると落ち着くのかも。
デフォルトの色指定だと薄い青紫になってて、ちょうど本物の紙のノートみたいですし。

[AppVeyorBot]

✅ Build sakura 1.0.2294 completed (commit 09fc78fef6 by @berryzplus)

[berryzplus]

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