act-act about projects rss

erlcscope and ascope.el

Browsing Erlang code

EmacsでErlangのコードをリファクタリングしていると、ある関数を呼び出している関数をすべてピックアップしたい、ということがあります。これまではEtagsを使っていましたが、以下のページでerlcscpeというツールが紹介されていたので、試してみました。

erlcscpeのプロジェクトサマリに「Program which builds cscope database for erlang files」とあるように、これはErlangのコードを解析してcscopeのデータベースを作成するツールです。

Cscopeについては、以前Linux Kernelのコードを読む際に使ったことがあり、使い方等は以下のページに記載しています。

How use

一般的なデータベース作成の流れは、ソースコードのコンパイルしが完了したら即erlcscopeでデータベースを再作成する、という方式だと思います。

私は通常、作りながらコードナビゲーションを多用することはそんなにないので、任意の契機でデータベースを再作成・再読み込みできれば良いと考えています。そこで今回は、それらを実行するキーバインドを用意し、好きな契機でデータベースの再作成を行うようにしました。

erlcscope

erlcscopeを実行すると、以下の2つのファイルが生成されます。

  • cscope.files
  • cscope.out

「cscope.files」はデータベースに登録されるソースコードのリスト、「cscope.out」はデータベースです。現状ではこの2つのファイルはカレントディレクトリに生成されるのですが、elispから呼び出す場合はこのカレントディレクトリの扱いが面倒なので、erlcscopeの引数に指定するInPathの直下に出力するように手を入れました。以降は、以下のページにあるerlcscopeを使用する前提で記載します。

本来であれば以下の3つの場所をそれぞれ指定できるようにするべきだと思うのですが、面倒なので今回はInPathの直下に纏めています。

  • ソースコードのトップディレクトリ
  • cscope.fileを出力する場所
  • cscope.outを出力する場所

インストールはREADME.mdを参照してください。そのままだと「/usr/local/bin」にインストールされるので、変更したい場合はMakefileに記載されている「DEST_BIN」の値を修正する必要があります。

ascope.el

Emacsでcscopeのデータベースを読み取ってナビゲートするelispは、ascope.elを使うことにしました。これは単にpackege.elでインストールできるから、という理由です。

インストール後、ascope.elを使用する為に、以下のようなelispファイルを作成し、Emacs起動時にinit-loader.elから読み込むようにしました。カレントディレクトリにデーターベースファイル(cscope.out)があると、自動的に読み込みます。

70-ascope.el

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
(require 'ascope)

(global-set-key (kbd "C-c s I") 'ascope-init)
(global-set-key (kbd "C-c s s") 'ascope-find-this-symbol)
(global-set-key (kbd "C-c s d") 'ascope-find-global-definition)
(global-set-key (kbd "C-c s g") 'ascope-find-global-definition)
(global-set-key (kbd "C-c s t") 'ascope-find-this-text-string)
(global-set-key (kbd "C-c s c") 'ascope-find-functions-calling-this-function)
(global-set-key (kbd "C-c s C") 'ascope-find-called-functions)
(global-set-key (kbd "C-c s i") 'ascope-find-files-including-file)
(global-set-key (kbd "C-c s a") 'ascope-all-symbol-assignments)
(global-set-key (kbd "C-c s o") 'ascope-clear-overlay-arrow)
(global-set-key (kbd "C-c s p") 'ascope-pop-mark)

(setq pwd (getenv "PWD"))
(cond ((file-exists-p (expand-file-name "cscope.out" pwd))
  (ascope-init (concat pwd "/"))))

erlcscope.el

次に、erlcscopeでデータベースを作成し、それをascope.elで再読み込みするelispファイルを作成しました。このファイルもinit-loader.elで読み込むようにしておきます。

90-erlcscope.el

1
2
3
4
5
6
7
8
9
10
11
12
13
(defun erlcscope-reload-all (rdir)
  (interactive "DSpecify the top directory: ")
  (setq dir (file-truename rdir))
  (setq cscope_files_path (expand-file-name "cscope.files" dir))
  (cond ((file-exists-p cscope_files_path)
    (delete-file cscope_files_path)))
  (message (concat "generate index.. " dir))
  (call-process "erlcscope" nil "*erlcscope*" nil dir)
  (message "erlcscope: generate ok")
  (ascope-init (concat dir "/"))
)

(global-set-key (kbd "C-c s R") 'erlcscope-reload-all)

これで、Emacsを起動して”C-c s R”を実行してInPathを指定すると、InPathの下にデータベースを作成してascope.elで再読み込みします。

Conclusion

erlcscopeascope.elを導入して、Erlangのコードをブラウジングできるようになりました。InPathに含めればdepのコードも対象になります。こういったツールは、ガリガリとコードを書いている時にはあまり使わないかもしれませんが、デバッグやリファクタリング時に関数の呼び出しの流れを確認したい場合に便利です。