技術/UNIX/GLOBAL(gtags,htags)

• [ Prev ]
• [ Next ]
• [ 技術 ]

ソースコードタグシステムの GNU GLOBAL メモ。日本人が作ったGNUツール。

• http://www.gnu.org/software/global/
• http://www.tamacom.com/global-j.html
• http://www.gnu.org/software/global/manual/global.html

ソースコードを解析するのに便利。特に、htagsコマンドでHTML化してくれる機能が特徴的。

使い方メモ

結構有名で、ブログとかでもまとめてる人がいるので適当に検索すれば大体分かる。

まずTAGデータを作成するには、ソースコードツリーのTOPにcdして、

gtags

すればOK。カレントディレクトリ=ソースコードツリーのTOPに、GTAGSを初めとするTAGデータファイルが作られる。
TAGデータファイルを別のディレクトリに作成したい場合は(例：CDROM中のソースコードを解析したい)、

gtags 別ディレクトリ

とすればOK.

あと、gtags.confを"/etc/gtags.conf" or "$HOME/.globalrc"に置いておくと(アーカイブなりパッケージなりに入ってるので適当にコピー)、色々設定を変更できる。
GLOBAL自体はC/C++/Java/PHP4/yaccに対応しているのだけれど、例えばvimにくっついてくるctagsとかを使うともっと対応種別が増やせるのでそっちを使いたい、という場合に、設定ファイルを編集する。

• "GNU Global 関係"
  • http://eigyr.dip.jp/gtags.html

↑の「パーサを変更する。」が参考になるかも。あと本家ドキュメント参照。

HTMLを生成させたい場合は、GTAGSとGRTAGSのあるディレクトリにcdして

htags

コマンドを実行すれば基本的にOK. "HTML"というディレクトリがカレントディレクトリに作成されて、その中に沢山HTMLファイルが出来る。

GTAGSのあるディレクトリを指定したい時とか、HTMLを作成したいディレクトリを指定する場合は

htags -d GTAGS,GRTAGSディレクトリ  HTML作成ディレクトリ

とする。

オススメオプションを自動適用したい場合は "--sugest" が良いよ、とあるけど個人的には以下の組み合わせで充分。

htags -anosT --tabs 4

こうすると、関数の前後のナビゲーションリンクであるとか、検索CGI用のフォームとかが消えるので、スッキリシンプルなHTMLになる。"--sugest"だとそういうのも付いてしまうので、HTMLがごてごてしてしまう。

他、参考URL：

• ソースコードを快適に読むための GNU GLOBAL 入門 (前編) - まちゅダイアリー(2009-03-07)
  • http://www.machu.jp/diary/20090307.html#p01
• ソースコードを快適に読むための GNU GLOBAL 入門 (中編) - まちゅダイアリー(2009-03-08)
  • http://www.machu.jp/diary/20090308.html#p01
• ソースコードを快適に読むための GNU GLOBAL 入門 (後編) - まちゅダイアリー(2009-03-09)
  • http://www.machu.jp/diary/20090309.html#p01

スタイルを弄りたい場合などは "-x" or "--xhtml" つけた方が良いかも。MSYSでコンパイルされたWindowsバイナリだと、"(...)/style.cssが見つからないよ～"と怒られるかも知れないが、アーカイブ中のstyle.cssを適当に探して、見つかったらHTMLの下に放り込めばOK.

• [ Prev ]
• [ Next ]
• [ 技術 ]