開発者ブログ

開発チームの海老原です。
みなさん今日も元気にソースコード追ってますか？　ということで今回は技術ネタです。

普段どおり楽しくコードを追ってたら、手嶋荘住人の川原君に、
「探索スキル高いですねー」
と感心されてしまったので、僕がコードを追うのに使っている方法を紹介していきます。

■本日のテーマ

「foo() という関数がどこで使われているか見たい！」
といったときのソースコードの追い方をご紹介します。

■前提環境

僕が開発に使用している以下の OS を想定して解説します。
といってもまあ UNIX 系 OS ならほとんどそのまま参考になるでしょう。
・Debian sid
・Mac OS X Leopard

■ go “ack” !

さて、本日のテーマ、
「foo() という関数がどこで使われているか見たい！」
というとき、こんなコマンドを叩いている方はいませんか？

$ grep -rw "foo(" .

これでも目的は果たせます。しかし、

・結果が見づらい
・subversion などのバージョン管理システムが使うディレクトリも対象にしてしまう（パイプで繋ぐことで回避は可能）
などといった欠点があります。

これを一気に解決してくれるだけでなく、ソースコード検索において
強力な機能を提供してくれるツールが ack です。
http://search.cpan.org/dist/ack

ack は CPAN で提供されているので、インストールは CPAN シェルに入って……
と言いたいところですが、 Debian では apt でインストールすることができます。
やっぱり Debian はいいですね。

# apt-get install ack-grep

その他の OS では、普通に CPAN でインストールするか、パッケージを取ってきて
展開して設置という手段を採る必要があります。 まあ CPAN でインストールするのが妥当でしょう。

以下のコマンドで CPAN シェルに入ってください。

# cpan

CPAN を使うのがはじめてであればここで設定に必要な事項の入力が求められます。
CPAN の設定についてはここでは解説しませんので、「CPAN 設定」などで検索してみてください。

準備が整ったら、 CPAN シェル上で以下のコマンドをタイプしてください。

cpan> install App::Ack

あとは指示に従えばインストールが完了するはずです。シェルから抜けてください。

cpan> exit

これで晴れて ack を利用できるようになりました！

それでは以下のコマンドを叩いて grep との差を見せつけてやりましょう。

（Debian の場合）

$ ack-grep -w "foo("

（それ以外）
$ ack -w "foo("

すごく見やすい！　しかも .svn ディレクトリもご丁寧に無視してくれている！
これはもう使い倒していくしかないですね。

ということで、簡単に ack の便利な使い方を紹介していきます。

■ ack を使いこなす

前後の行を表示する

先ほどの例だと、「どこで」関数が使われているかはわかりますが、
「どうやって」「なぜ」関数が使われているかが伺い知れなかったりします。
そんなときにはこれ。

（Debian の場合）
$ ack-grep -C10 -w "foo("

（それ以外）
$ ack -C10 -w "foo("

この -C10 で、ヒットした行と前後をあわせての 10 行分の結果を出力してくれます。

前しか必要ないなら -B10、後ろだけなら -A10 と指定することもできます。

検索パターンに正規表現を使う

正規表現は grep でも使えるんですが、 ack では Perl 準拠の正規表現で書けるところがミソです。

lib ディレクトリ以下で、 op というプレフィックスがついたクラスなどの定義を見たい場合、
こんな感じでコマンドを実行してみてはどうでしょうか。

（Debian の場合）
$ ack-grep "(class|interface)s+opS+" lib

（それ以外）
$ ack "(class|interface)s+opS+" lib

「条件にマッチする」ファイルの一覧を表示

ack ではヒットしたファイル名のみを出力することができます。
lib ディレクトリ以下で OpenPNE のライセンス表記が含まれるファイルをリストアップします。

（Debian の場合）
$ ack-grep -l " * This file is part of the OpenPNE package" lib

（それ以外）
$ ack -l " * This file is part of the OpenPNE package" lib

これと xargs コマンドを併用することで、他のコマンドとの連携が可能になるなど応用できます。
（以下の例では条件にマッチしたファイルを削除します）


$ ack-grep -l "cholesterol" | xargs rm -f


「条件にマッチしない」ファイルの一覧を表示

逆もできます。
今度はライセンス表記が含まれないファイルをリストアップします。

（Debian の場合）
$ ack-grep -L " * This file is part of the OpenPNE package" lib

（それ以外）
$ ack -L " * This file is part of the OpenPNE package" lib

もちろんこれも他のコマンドと組み合わせやすくて重宝します。


$ ack-grep -L "Kousuke Ebihara " | xargs rm -f


■他にも便利な使い方がたくさん

ack には紹介しきれないくらい多くの便利なオプション（-f や –thpppt など）が存在します。

また、設定ファイル .ackrc によって検索対象のルールを作成することもできます。

ぜひ、 http://search.cpan.org/dist/ack/ack-base のマニュアルをご覧ください。
きっと新しい活用方法が見つかるはず！

コードリーディングを楽しむには、 ack のような便利なツールが不可欠です。
ぜひみなさんも今回紹介したテクニックを活用して、コードと友達になりましょう！

それでは、よいコードリーディングライフを！

関連記事:

• OpenPNE 開発者流のソースコードの追い方 #2 – Rak 編
• 【1968】津田さんからのTwitterレポート公開
• symfony 1.3 で Symfony Templating を試してみた
• 09月17日 OpenPNE勉強会inオープンソースカンファレンス
• OpenPNE 開発者流のソースコードの追い方 #3 – vim + ctags 編