linuxBean14.04(162)LibreOfficeのC++の拡張機能の例をCUIのデバッガにかける

LibreOffice 5.3 SDK - Examplesのcomplextoolbarcontrolsの例をgdbでデバッガにかけようと思ったのですが、IDEでのやり方がよくわからずまずgdbのCUIでとっかかりが掴めました。

前の関連記事：linuxBean14.04(161)brush-Makefileのバグを修正する

complextoolbarcontrolsのインストール

complextoolbarcontrolsのC++の例はLibreOfficeのSDKに含まれています。

コンパイルはlinuxBean14.04(132)LibreOfiice5.2のSDKの例をコンパイルするでやりました。

個別にコンパイルするときはデバッグ情報を付加するためにmake DEBUG=yesでやります。

コンパイル後~/libreoffice5.2_sdk/LINUXexample.out/binにcomplextoolbarcontrols.oxtができているのでそれをLibreOfficeの拡張機能マネージャーで登録します。


Writerを起動するとこんなツールバーが表示されます。

表示→ツールバー→Complex Toolbar Controlsでツールバーを消せます。

このツールバーが何をしているのかは、この時点では左端の画像ボタンをクリックするとブラウザが起動してLibreOfficeのホームページが表示されるということしかわかりませんでした。

で、これをLibreOffice5(28)MRI - UNO Object Inspection Tool:その4のPythonの拡張機能と同様にしてデバッガにかけようとしましたがだいぶ四苦八苦しましたがとりあえずgdbのCUIでやる方法がわかりました。

どこにブレークポイントを張るのか決める

まずどこにブレークポイントをかけるのか/opt/libreoffice5.2/sdk/examples/cpp/complextoolbarcontrolsにあるソースをみて決めておきます。

    if ( aURL.Protocol == "vnd.demo.complextoolbarcontrols.demoaddon:" )
    {
        if ( aURL.Path == "ImageButtonCmd" )
        {
   
            // open the LibreOffice web page
            ::rtl::OUString sURL("http://www.libreoffice.org");
            Reference< XSystemShellExecute > xSystemShellExecute(
                SystemShellExecute::create(mxContext) );

MyProtocolHandler.cxxの220行目にツールバーの画像ボタンをクリックしたときに起動される部分を見つけました。

で、どうやってブレークポイントを設定するかです。

(gdb)  break <クラス名>::<関数名>
(gdb)  break <ファイル名>:<行番号>
(gdb)  break <ファイル名>:<関数名>
GDBの使い方 - PukiWiki

この解説をみつけてようやくわかりました。

まず<クラス名>::<関数名>で設定してみることにしました。

C++ではクラス定義をヘッダファイルに書くことが一般的だそうで、この例でもMyProtocolHandler.hに書いてありました。

MyProtocolHandler.cxxの220行目に該当するクラスはMyProtocolHandler.hの117行目にあってクラス名はBaseDispatch、関数名はdispatchとわかりました。

void SAL_CALL BaseDispatch::dispatch( const URL& aURL, const Sequence < PropertyValue >& lArgs ) throw (RuntimeException)

まあヘッダファイルを見なくてもcxxファイルだけみても207行目に<クラス名>::<関数名>が書いてありました。

SAL_CALLというのが何かわからなかったのですが、これはWhat is SAL_CALL in c++? - Stack Overflowに解説がありました。

文字列置換のマクロが定義してあって、マイクロソフトのコンパイラを使うときにだけ__cdeclという文字列が入るようです。

Linuxではgccとg++を使うので関係なさそうです。

ちなみにgccとg++の違いについて調べてみるとg++はgccに-lstdc++オプションを付けたものだそうです。([roast] 2012/5/19 -> gccとg++って、厳密には違うらしいね。 | myun2's blog）

complextoolbarcontrolsのMakefileの出力ログを見るとまずgccでcxxファイルからoファイルを作って、最後にg++で複数のoファイルをまとめてsoファイルにしています。

基本を再チェック～gcc～＠謎の処理系 SunOS 4.1.4を読むとgccでC++をコンパイルできる例もあるようです。

gdbで拡張機能のC++をブレークする

/opt/libreoffice5.2/programでTerminalを起動します。

gdb

まずこれでgdbを起動しました。

pq@pq-VirtualBox:/opt/libreoffice5.2/program$ gdb
GNU gdb (Ubuntu 7.7.1-0ubuntu5~14.04.2) 7.7.1
Copyright (C) 2014 Free Software Foundation, Inc.

プロンプトが(gdb)に変化します。

file soffice.bin

LibreOfficeの本体をgdbに読み込みます。

(gdb) file soffice.bin
Reading symbols from soffice.bin...(no debugging symbols found)...done.

LibreOffice本体はバイナリをインストールしたものなのでデバッグ情報が含まれていませんが、デバッガでみたいのは拡張機能の部分だけなので問題ありません。

break BaseDispatch::dispatch

先ほど決めたクラス名と関数名を使ってブレークポイントを設定しました。

(gdb) break BaseDispatch::dispatch
Function "BaseDispatch::dispatch" not defined.
Make breakpoint pending on future shared library load? (y or [n]) y

Breakpoint 1 (BaseDispatch::dispatch) pending.

まだgdbが拡張機能を読み込んでいない状態なのでBaseDispatch::dispatchがないと言われます。

まあそういわれると予測していたのでそれ以外の方法を調べていて四苦八苦していたわけですが、やってみるとgdbでは定義が見つからないところにもyと回答するとブレークポイントが貼れました。

run

これでfileコマンドで読み込んでいたsoffice.binをgdbから起動しました。

(gdb) run
Starting program: /opt/libreoffice5.2/program/soffice.bin 
[Thread debugging using libthread_db enabled]
Using host libthread_db library "/lib/i386-linux-gnu/libthread_db.so.1".
[New Thread 0xb1c7fb40 (LWP 6898)]
[New Thread 0xb05d2b40 (LWP 6968)]
[New Thread 0xafbffb40 (LWP 6969)]
[New Thread 0xab38bb40 (LWP 6970)]
[New Thread 0xaa4beb40 (LWP 6971)]
[New Thread 0xa9cbdb40 (LWP 6972)]
[Thread 0xb05d2b40 (LWP 6968) exited]
[New Thread 0xb05d2b40 (LWP 6973)]
[New Thread 0xa91cfb40 (LWP 6976)]
[Thread 0xa91cfb40 (LWP 6976) exited]
[New Thread 0xa91cfb40 (LWP 6977)]
[New Thread 0xa867bb40 (LWP 6978)]
[Thread 0xa91cfb40 (LWP 6977) exited]
[New Thread 0xa91cfb40 (LWP 6979)]
[Thread 0xa91cfb40 (LWP 6979) exited]
[New Thread 0xa91cfb40 (LWP 6980)]
[Thread 0xa91cfb40 (LWP 6980) exited]

LibreOfficeのスタート画面がでてくるのでそこから「Writer文書ドキュメント」ボタンをクリックしてWriterを起動しました。

それで表示されたComplex Toolbar Controlsツールバーの画像ボタンをクリックするとWriterが止まります。