Skip to content

[BETA] gtk3の実験的サポート テスト版-5 #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 45 commits into from

Conversation

ma8ma
Copy link
Owner

@ma8ma ma8ma commented Feb 2, 2019

gtkmm-2.4のかわりにgtkmm-3.0を使ってJDimをビルドするオプションを追加します。

PRはすぐにマージせずに開いておき一定期間経った後にgtk3-previewにマージされます。(ワークフローも参照)
マージしない期間は1週間程度を予定しています。

INSTALLREADME.mdにも情報が載っているのでそちらも参照してください。

注意

  • テスト版(beta)の段階なので不具合や不便な点がある可能性があります。
  • gtk2/3でUIのルック・アンド・フィールが異なる部分があります。
  • データ、履歴、設定などを保存するディレクトリはconfigureのオプションに関係なく共通です。 プロファイルを分けるには環境変数 JDIM_CACHE を利用してください。(README.mdを参照)

要件

masterブランチのJDimの導入方法に加えて以下が必要です

  • gtkmm-3.0 (バージョン3.18以上を推奨、Ubuntuではlibgtkmm-3.0-devをインストール)

configureのフラグ

  • --with-gtkmm3 gtkmm-2.4のかわりにgtkmm-3.0を使う(デフォルトは=no)

ビルド

リモートを追加してgtk3-beta-5ブランチをフェッチしチェックアウトするかリポジトリをクローンします。
./configureのフラグを追加してビルドしてください

# 既存のリポジトリにリモートを追加する場合
$ cd /path/to/JDim
$ git remote add ma8ma https://github.com/ma8ma/JDim.git
$ git fetch ma8ma gtk3-beta-5
$ git checkout -b gtk3-beta-5 --track remotes/ma8ma/gtk3-beta-5
$ autoreconf -i
$ ./configure --with-stdthread --with-gtkmm3
$ make

既知の問題

  • 板一覧やスレ一覧でマウスホイールによるスクロールが動作しないことがある。
    環境変数 GDK_CORE_DEVICE_EVENTS=1 を設定してjdを起動するとマウスホイール機能が使える。
    # シェルからJDを起動する場合
    $ GDK_CORE_DEVICE_EVENTS=1 ./src/jd
  • マウスホイールでタブを切り替える機能が動作しない環境がある。(gtk 3.20以上?)
  • タブのドラッグ・アンド・ドロップの矢印ポップアップの背景が透過しない環境がある。
    (アルファチャンネルが利用できない環境)

修正の説明

jdim-0.1.90-beta20190124 からの変更点

修正のルール

コーディングスタイル

  • clang-formatで修正した部分を整形しています。(一部は手直し)
  • JDimのコードをベースに設定を作っていますが、設定できないスタイルや意図的に変更したポイントがあります。(2c081e4 を参照)

ma8ma added 30 commits January 29, 2019 21:54
LLVMスタイルを元にJDスタイルを再現する
表記ゆれのある部分はJDのコードを調べて多数の方を採用する
曖昧な部分はLLVMスタイルを踏襲する

JDスタイルから変更した部分

* 単独のジャンプ文(continue, break, goto, return, throw)を除き
  if-else文のブロックに波括弧を付ける
  ```cpp
  // YES
  if( expr ) return 1;
  if( long_long_expr1 && long_long_expr2 )
      return long_long_func( long_long_value );
  if( expr ) {
      var = 20;
  }

  // NO
  if( expr ) var = 20;
  if( expr )
      var = 20;
  ```

* 空の文(;)を除きループ文のブロックに波括弧を付ける
  ```cpp
  // YES
  while( expr )
      ;
  while( expr ) {
      var += 1;
  }

  // NO
  while( expr );
  while( expr ) var += 1;
  while( expr )
      var += 1;
  ```

ツールで再現できていないスタイル

* マクロGTKMM_CHECK_VERSION()の引数
  -> スペースを取り除いてJDスタイルに準ずる
  ```cpp
  // YES
  #if GTKMM_CHECK_VERSION(2,10,0)
  #endif

  // NO (clang-format)
  #if GTKMM_CHECK_VERSION( 2, 10, 0 )
  #endif
  ```

* 制御構文の条件式の閉じ括弧とブロックの開き波括弧の間
  -> ツールで整形したままでよい
  ```cpp
  // OK (clang-format)
  if( expr ) {
  }

  // (JD style)
  if( expr ){
  }
  ```

* 否定演算子の後
  -> ツールで整形したままでよい
  ```cpp
  // OK (clang-format)
  func( !expr );

  // (JD style)
  func( ! expr );
  ```

* for文の条件式の初期化パートが空のとき
  -> ツールで整形したままでよい
  ```cpp
  // OK (clang-format)
  for( ; expr1; expr2 ) {
  }

  // (JD style)
  for(; expr1; expr2 ){
  }
  ```
gtkmm-2.4の代わりにgtkmm-3.0を使ってビルドするconfigureフラグを追加する
gtkmm-3.0のバージョンは3.18以上を推奨

見出しや箇条書きなどを除きREADME.mdの文章をですます調にする
gtk3 removes many implementation details and struct members from
public headers.

挙動の変更
リセットフラグを設定できないため即時リセットするように変更する
Gtk::Widget::on_expose_event() is removed.
Gdk::Drawable API is deprecated.
cairomm 1.12.0 がメモリリークを起こしたので C API を使うことで
問題を回避する
コードの重複とプリプロセッサの分散を減らす
コードの重複とプリプロセッサの分散を減らす
Gtk::Widget::on_expose_event() is changed to on_draw().
条件コンパイルでGDK_<keyname>をGDK_KEY_<keyname>に置き換えると
コードが重複して読みにくいので古い名前を使う

gtk 2.22.0未満のサポートを打ち切れば条件コンパイル無しで置き換えられる
gtk3からGtk::Notebookのswitch-pageシグナルハンドラの
引数GtkNotebookPage*がGtk::Widget*に変更されたので
GtkNotebookPageがGtk::Widgetの別名になるようにusingを追加する
* The parameter type of Gdk::Window::set_cursor() becomes shared smart
  pointer type.
* The parameter type of Gtk::FileChooserDialog::add_filter() becomes
  shared smart pointer type.
GDK_WINDOW_XWINDOW() is removed since gtk3.
Gtk::Widget::render_icon() is renamed to render_icon_pixbuf() since
gtk3.

render_icon()の呼び出し箇所に条件コンパイルでrender_icon_pixbuf()
の呼び出しを追加してくと差分が大きくなりコードが読みづらくなる
そのためgtk3版ではローカル変数にrender_icon()を実装する
Gdk::Display::get_pointer() is removed since gtk3.
…rea()

gtkmmのAPIを使わない理由
Gdk::Window::get_update_area()の戻り値のスマートポインター
Cairo::RefPtr<Cairo::Region>をboolに評価しようとすると
segmentation faultする
この結果、スレビューをスクロールしようとしたときにJDがクラッシュした
Gtk::Widget::shape_combine_mask() is removed since gtk3.
NOTE: アルファチャンネルが利用できない環境では背景を透過できない
Gtk::MenuItemにGtk::HBoxを追加する方法は動作しなくなった
* Use Gtk::Widget::override_font() instead of modify_font()
* Use Gtk::StyleContext to get label font instead of Gtk::Style
* Use Gtk::StyleContext to get entry font instead of Gtk::Style
* Use Gtk::Widget::override_color() instead of modify_fg()
* Use Gtk::Widget::override_color() instead of modify_text()
* Use Gtk::Widget::override_background_color() instead of modify_bg()
* Use Gtk::Widget::override_background_color() instead of modify_base()
* Use Gtk::Widget::unset_color() instead of unset_fg()
* Use Gtk::StyleContext to get entry color instead of Gtk::Style
* Use Gtk::StyleContext to get bg color instead of Gtk::Style

ウィジェットの配色ではなくGTKテーマの設定から色を取得するように
変更した箇所がある
* Use Gtk::Widget::set_margin_xxx() instead of Gtk::(Rc)Style::set_(x|y)thickness()
* Use Gtk::Widget::get_margin_xxx() instead of Gtk::(Rc)Style::get_(x|y)thickness()
DragableNoteBookの主なロジックのうち以下をgtk3でも動くように変更する

* タブの描画は、自前で描画するのをやめてデフォルトのハンドラを使う

* タブ幅の計算は、タブの代わりにラベルの領域を使う

既知の問題
* DnDでタブを並べ替えるときに表示する目標の矢印はタブの境界からずれる

* DnDのドロップ範囲がタブの領域より狭くなっている

* タブの上でマウスホイールするとページが切り替わる機能は
  先頭<->最後尾の場合を除いて機能しない

* ラベルの領域からシグナルを拾うのでタブの端付近では
  ドラッグを開始できない

既存のロジックは実装の詳細をgtkのソースコードから引用して使うことで
タブの領域を取得する。gtk3ではデータ構造の変更[1]により今までの方法が
できなくなった。

[1]: gtk 3.20から_GtkNotebookPageは割り当てられた領域(GtkAllocation)
を持たなくなった。
https://gitlab.gnome.org/GNOME/gtk/blob/gtk-2-24/gtk/gtknotebook.c#L148
https://gitlab.gnome.org/GNOME/gtk/blob/gtk-3-24/gtk/gtknotebook.c#L293
タブDnDの目標矢印が境界からずれる&ドロップ範囲がタブの領域より
狭くなっている不具合を低減する。GTKテーマによってはドロップ先を示す
矢印の描画に問題が発生する可能性がある。

XXX: この修正はラベルの左右の余白の大きさが同じであることを前提とする
* Omit DragableNoteBook::draw_box() and get_alloc_notebook().

* Omit custom draw for DragableNoteBook, TabNotebook TabSwitchButton,
  ToolBarNotebook and ViewNotebook.

枠の描画や座標取得のメソッドを省略しDragableNoteBookの描画処理は
自前でやらない

変更の理由
描画処理に必要な座標はgtkのソースコードを引用して実装の詳細に
アクセスして取得している。gtk3ではデータ構造が変更された影響で
今までのコードが使えなくなった。
gtk3ではツールバーのカスタム描画をしない。
gtk2のJDToolbarの描画処理はgtkのソースコードを引用することで
実装の詳細にアクセスして行っている。gtk3ではデータ構造が
変更された影響で今までのコードが使えなくなった。

さらにGTKテーマによってはツールバーの子ウィジェットの配色がテーマに
従わないことがある。ツールバーからcssクラスGTK_STYLE_CLASS_TOOLBARを
削除することで配色を修正する。
style-changed signal is removed since gtk3.
スタイルを反映するシグナルハンドラを省略する
GTK3版ではGtkNotebook in GtkNotebookの背景色は問題がないように見える
gtk3 removes many implementation details and struct members from
public headers.
ハックによる枠の描画は省略する
GTK+ 3.9.2からGTK/GDKのダブルバッファ処理が再構成された [1]
この影響でスレビューのスクロール時に画面のちらつきが発生するようになった
ちらつきを抑えるため3.9.2以降の環境ではデフォルトのダブルバッファを使う

[1]: https://gitlab.gnome.org/GNOME/gtk/commit/d22fd7223c75f4720ddb982c659efb0d8d7543c4
デフォルトの設定ではウインドウの幅が狭いとエントリーが表示されない
gtk3では伸縮するウィジェットを持つダイアログを表示したときに
ウインドウのサイズが小さい場合があるためデフォルトのサイズを
設定するための機能を追加する
ma8ma and others added 15 commits February 1, 2019 22:32
Gtk::POLICY_NEVERを設定するとスクロール機能自体がなくなり
コンテンツに合わせてGtk::ScrolledWindowのサイズが拡大してしまう
gtk3はマウスホイールによるGtkNotebookのタブの切り替えが
動作しなくなったのでシグナルハンドラを使って再現する

未修正の問題
この修正に関係なくホイールが全く反応しない環境がある(>= gtk 3.20?)
が厳密な条件は分からない
gtk3 removes many implementation details and struct members from
public headers.

XXX: フラット表示は装飾がない前提でcssが設定されている

* Fix compile error for debug log.  Thanks to @ooinu.

Co-authored-by: ooinu <45452777+ooinu@users.noreply.github.com>
overrideメソッドの代わりにcssの設定で書き込みビューの配色を設定する
また、書き込みビューの配色にGTKテーマを使う設定を合わせて追加する
overrideメソッドでは配色の変更が上手くいかない環境があるので
cssを使って変更する。
ステータスバーのテキスト部分が上手く配色されないGTKテーマがあるので
明示的に設定する
GDK needs a transient parent window to display a popup window.

[gtk+] wayland: prefer subsurface when possible
https://mail.gnome.org/archives/commits-list/2016-January/msg02035.html
C++11モードではmoveの妨げになるので戻り値のconstを取り除く
C++11モードではmoveの妨げになるので戻り値のconstを取り除く
算術型の引数と戻り値はconst参照を取り除き値渡し/値返しする
C++11モードではmoveの妨げになるので戻り値のconstを取り除く
…K+3)

マウスホイールによるスクロールを使えるようにするため
環境変数GDK_CORE_DEVICE_EVENTSの設定を行うオプションを追加する
スレビューをタッチスクリーン操作に対応させる
Thanks @tack1953 for testing.

* スレビューをタッチして上下にスワイプするとスクロールし
  指を離すと減速して止まる。(慣性スクロール)
* URLやレス番号などのリンクをタップすると
  マウスの左ボタンクリックと同じように処理する。
* 2本指タップするとマウスの右ボタンクリックと同じように処理する。
* テキストの上でダブルタップをすると単語を範囲選択する。

テストモード

環境変数`GTK_TEST_TOUCHSCREEN`を設定してJDを起動すると
マウスの左クリック+上下ドラッグでスレビューをスクロールできる
```sh
GTK_TEST_TOUCHSCREEN=1 ./src/jdim
```

Co-authored-by: tack1953 <tack1953@users.noreply.github.com>
GTK3サポートを追加する(テスト版)

jdim-0.1.90-beta20190124 からの変更点

* リベースしてmasterブランチを更新する(e71005e)
* --disable-xinput-extensionオプションを追加
* スレビューのタッチスクリーン対応を追加
@ma8ma ma8ma closed this in 567a9cc Feb 7, 2019
@ma8ma ma8ma deleted the gtk3-beta-5 branch February 7, 2019 14:24
@ma8ma
Copy link
Owner Author

ma8ma commented Feb 7, 2019

GTK3版(beta)をご利用の皆様へお知らせです。
上流JDimproved/JDimのmasterブランチにGTK3版がマージされました。(JDimproved#30)これによりGTK3版はJDimprovedのリポジトリから利用できるようになります。このgtk3-previewブランチはタッチスクリーン操作のテストに使いますのでよろしくお願いいたします。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants