Prog/TagSystem/rtags の履歴(No.13)

Top/Prog/TagSystem/rtags

目次†

目次
rtags

↑

rtags†

rtags は、llvm をバックエンドに使用したタグ検索システム。
コンパイラのライブラリを使って解析する為、同名の関数や多重継承でオーバーライドされた関数が複数あっても正しいものに辿り着ける。
問い合わせを受けてから解析することもあるらしく、応答が遅いときがある。
Linux kernel のような巨大なプロジェクトでは、タグ生成の為の情報として使われる json ファイルの生成や問い合わせ時の解析時のパフォーマンスが下がるので、あまり適さない。
コメント文字列のような、コンパイルに使われないものについては検索出来ない。（cscopeではコメント文字列も検索対象に出来る）
このように、cscope や gtags 等の他のタグシステムとは長所・短所共に異なるので、これらのタグシステムの一つと組み合わせて使うのが良いと思われる。

↑

環境構築（debian パッケージを使用）†

必要な関連パッケージをインストールする
```
# apt-get install rtags
```
コマンド名はオリジナルから若干アレンジされているので注意（他パッケージとの名前の干渉を避ける為と思われる）。
コマンド名

オリジナル debian パッケージ版

rc rtags-rc

rdm rtags-rdm

rp rp
- rc に関しては、9base パッケージの rc コマンドとの重複を避けるためと思われる。

コマンド名
オリジナル	debian パッケージ版
rc	rtags-rc
rdm	rtags-rdm
rp	rp

↑

環境構築（自前ビルド）†

必要な関連パッケージをインストールする
```
# apt-get install clang libclang-dev cmake
```
rtags をビルドする（rtags がディストリビューションでパッケージが用意されているなら、そちらを使うと良い）
1. コードを取得する
```
$ git clone --recursive https://github.com/Andersbakken/rtags
```
2. ビルドする
```
$ cd rtags
$ git submodule init
$ git submodule update
$ mkdir build
$ cd build
$ cmake ..
$ make
$ sudo make install
```
rtags をインストールする
- ビルドすると rtags/build/bin に以下の実行形式が生成されるので、環境変数 PATH の通っているところに配置する。
```
$ ls rtags/build/bin
rc  rdm  rp
```

↑

タグを生成する†

まず、daemon を起動する
```
$ rdm --daemon
```
タグを生成する方法は2つある

↑

1. rc コマンドに直接渡す†

実際に compile するときのコマンドを rc に渡す。
```
$ rc gcc $(CFLAGS) $(SRCS)
```

↑

2. rc -Jコマンドで compile_commands.json を読み込ませる†

compile_commands.json は、cmake か bear で生成する。
- bear を使う場合（cmake を使わない、Makefile のみのプロジェクトの場合）
  - 注：下記の make で呼ばれる Makefile で clang を使っていると、後述のコマンド "rc -J . " を実行したときに失敗することがある模様。その為、Makefile でコンパイラの指定は clang ではなく gcc を使うと良い。
  - bear コマンドがインストールされていない場合は、インストールする
```
# apt-get install bear
```
  - bear コマンドの実行（環境によっては "--" が不要な場合があるので注意。）
```
$ bear -- make
```
  - 既に compile_command.json があり、且つクリーンビルドでない場合は、 bear に --append オプションが必要（まだ試してはない）
- cmake で生成する場合
  T.B.D.
rc -Jコマンドで compile_commands.json を読み込ませる
```
$ rc -J .
```
- ここでエラーになる場合、compile_commands.json が無意味な内容になっている可能性がある。
  - 原因としては、ビルド済みの環境で bear コマンドを走らせていた可能性がある。
  - 対策としては、make clean してから再度 bear -- make を実行する必要がある。

↑

emacs から rtags を使う†

rtags.el を、 emacs の load-path の通っているところに置く。rtags.el は、rtag リポジトリの下記にある
```
build/src/rtags.el
```

init.el

;;; rtags.el の設定
(when (require 'rtags nil 'noerror)
  (when (executable-find "rtags-rc")
    (setq rtags-rc-binary-name  "rtags-rc"))  ; debian では rc  -> rtags-rc  に変更されている
  (when (executable-find "rtags-rdm")
    (setq rtags-rdm-binary-name "rtags-rdm")) ; debian では rdm -> rtags-rdm に変更さている
  (defun rtags-local-conf ()
    (rtags-mode)
    (rtags-start-process-unless-running)
    (setq rtags-autostart-diagnostics t)
    (rtags-diagnostics)
    (setq rtags-completions-enabled t)
    ;;; キーバインド：ネットでよく見掛ける設定から
    (local-set-key (kbd "M-.") 'rtags-find-symbol-at-point)
    (local-set-key (kbd "M-;") 'rtags-find-symbol)
    (local-set-key (kbd "M-@") 'rtags-find-references)
    (local-set-key (kbd "M-,") 'rtags-location-stack-back)

    ;;; キーバインド：実際にはこちらを使う
    ;;; xcscope.el に操作感を似せつつ、併用出来るようキーバインドが被らないようにしている
    (local-set-key (kbd "C-c d d") 'rtags-find-symbol-at-point)
    (local-set-key (kbd "C-c d s") 'rtags-find-all-references-at-point)
    (local-set-key (kbd "C-c d c") 'rtags-find-all-functions-called-this-function)
    (local-set-key (kbd "C-c d f") 'rtags-find-file)
    (local-set-key (kbd "C-c d <") 'rtags-location-stack-back)
    (local-set-key (kbd "C-c d >") 'rtags-location-stack-forward)
    (define-key rtags-mode-map "p" 'rtags-previous-match)
    (define-key rtags-mode-map "n" 'rtags-next-match)
    )
  (add-hook 'c-mode-common-hook   'rtags-local-conf)
  (add-hook 'c++-mode-common-hook 'rtags-local-conf)
  (add-hook 'objc-mode-hook       'rtags-local-conf)
)

上記では、Debian / Ubuntu のパッケージで rc, rdm のコマンド名が変更されているのにも対応している。

↑

Makefile に rtags 用 tag 生成の target を仕込む（おまけ）†

下記を Makefile の target として仕込み、

$ make rtags

とすれば、tag 生成までの一通りの処理が実行される（但し、 clean ターゲットは別途用意されている前提となる）：

# for rtags:
RTAGS_CMD_RC    := /usr/bin/rtags-rc
RTAGS_CMD_RDM   := /usr/bin/rtags-rdm
BEAR_CMD        := /usr/bin/bear
COMPILE_DB_FILE := compile_commands.json

IS_RTAGS_RDM_STARTED := $(shell ls -1 /run/user/$(shell id -u)/rdm.socket 2>/dev/null| wc -l)


rtags : rtags-kill-daemon rtags-delete-compile-db clean rtags-start-daemon rtags-create-compile-db rtags-load-compile-db

rtags-kill-daemon :
ifeq ($(IS_RTAGS_RDM_STARTED),1)
	pgrep rtags-rdm | xargs kill -KILL;
endif

rtags-delete-compile-db :
	$(RMF) $(COMPILE_DB_FILE)

rtags-start-daemon :
	$(RTAGS_CMD_RDM) --daemon;

rtags-create-compile-db :
	$(BEAR_CMD) -- make;

rtags-load-compile-db :
	$(RTAGS_CMD_RC) -J .;

↑

バージョン組み合わせメモ†

version			distribution	remark
rtags	rtags.el	emacs	distribution	remark
2.38-3	2.38.130	27.1	Debian 11 (bullseye)
2.37-1	2.37.130	26.3	Ubuntu 20.04 (focal)

↑

linux kernel に使えるか？†

対象：linux-6.1.1
compile_command.json 生成
- bear コマンドを使ったところ、ビルド開始から json 生成完了までおよそ24時間ほど掛かった。
- 指定したオプションでコンパイル対象となっていないファイルは compile_command.json にも記載されない為、rtags の検索対象からも外れる。

↑

Prog/TagSystem/rtags の履歴(No.13)

目次†

rtags†

環境構築（debian パッケージを使用）†

環境構築（自前ビルド）†

タグを生成する†

1. rc コマンドに直接渡す†

2. rc -Jコマンドで compile_commands.json を読み込ませる†

emacs から rtags を使う†

Makefile に rtags 用 tag 生成の target を仕込む（おまけ）†

バージョン組み合わせメモ†

linux kernel に使えるか？†

参考リンク†