ctags -x で定義一覧表

    twitter 上で ctags, GLOBAL, cscope と、メソッドなどの定義情報を生成するツールの話がほんの一部で盛り上がっていたので、試しに普段 cron で回してるだけで使っていない（ひどい）ctags のオプションを調べてみた。

    すると -x というやつが「読む」ための出力を得るには便利そう。

    -x   Print a tabular cross reference file to standard output.

    結果、

    /sw/lib/ruby/1.8$ ctags -R -x .
...
GServer          class        82 gserver.rb       class GServer
serve            method       86 gserver.rb       def serve(io)
stop             singleton method   92 gserver.rb       def GServer.stop(port, host = DEFAULT_HOST)
in_service?      singleton method   98 gserver.rb       def GServer.in_service?(port, host = DEFAULT_HOST)
stop             method      103 gserver.rb       def stop
stopped?         method      111 gserver.rb       def stopped?
shutdown         method      115 gserver.rb       def shutdown
connections      method      119 gserver.rb       def connections
join             method      123 gserver.rb       def join
connecting       method      130 gserver.rb       def connecting(client)
disconnecting    method      137 gserver.rb       def disconnecting(clientPort)
starting         method      144 gserver.rb       def starting()
stopping         method      148 gserver.rb       def stopping()
error            method      154 gserver.rb       def error(detail)
log              method      158 gserver.rb       def log(msg)
initialize       method      167 gserver.rb       def initialize(port, host = DEFAULT_HOST, maxConnections = 4,
start            method      181 gserver.rb       def start(maxConnections = -1)
^L
gserver.rb,0

    みたいな感じ1。フォーマットは

    定義されたキーワード 種別 行番号 ファイル名 行の内容

    かな？ この連続のあと

    ^L
ファイル名,0

    ってくるのがちょっと意味がよく分からないけど。

    ただこれ、人間の目ではテーブルに見えるけど、カラムの区切りがスペースなので、行の中身にスペースを使っていると（というか普通使うよね）カラムの区切りのスペースと区別できなくなっちゃうのがちょっと残念。awk でもいいけど join() がないので Ruby で、

    ruby -n -e 'puts $_.chomp.split( " ", 5 ).join( "\t" )'

    こんな感じでタブ区切りのテーブルにできる。中にタブコードを使っていないなら、この方法で作ったファイルを拡張子 csv とかで保存すると Excel とかで見やすくなる。

    タブとスペースが混在している場合は御愁傷様。諦めて RFC 4180 に従って吐き出すのがいいかな？ そういうライブラリは使い慣れておくべきかも。

    試した限りでは ctags, etags, exuberant ctags どれでもできそう。

    あ！ "singleton method" なんてスペース入りの種別があるじゃないか。なんだよー。勘弁してよー。行番号の前にホワイトスペース以外のカタマリが2つの場合と3つの場合があるのか。うーぬぬぬ。

    まぁ気が向いたらまた今度。

    1. サンプルは Fink で入れた Ruby の GServer クラス ↩

    More