Linuxでのコード読み (vim/GNU global)

1. はじめに

比較的軽い環境でのコード読みを実現するためのvim/global環境設定をメモしておく。すでに同じような記事があちこちあるが、自分用のメモである。キーバインドはいろいろあるそうなので、徐々に増やす。

2. 環境設定

2.1. コマンド実行

以下のコマンドを実行する

sudo apt update
sudo apt install global
mkdir -p ~/.vim/plugin
wget -P ~/.vim/plugin https://raw.githubusercontent.com/harai/gnu-global/origin/gtags.vim

2.2. vim設定

.vimrcに以下の設定を追加する。

cat >> ~/.vimrc << "EOF"
map <C-g> :Gtags 
map <C-h> :Gtags -f %<CR>
map <C-j> :GtagsCursor<CR>
nmap <C-k> :Gtags -r <C-r><C-w><CR>
map <C-n> :cn<CR>
map <C-p> :cp<CR>
EOF

3. コード読み

3.1. コード作成

以下のコマンドで、該当コードに対してタグを作成する。

gtags -v

3.2. コード検索(vim内で)

• Ctrl + j 関数定義に移動する。
• Ctrl + k 関数の使用場所を探す。
• Ctrl + o カーソルを戻す。
• Ctrl + n カーソルを下に動かす。
• Ctrl + p カーソルを上に動かす。
• Ctrl + w k 上のウィンドウへ移動する。
• Ctrl + w j 下のウィンドウへ移動する。

A. 参考資料

• GNU GLOBALとvimで巨大なコードでも快適にコードリーディング
• gtags.vimでエラーが出る
  • Ubuntu 16.04等古い版では、gtags.vimの設定ファイルでエラーが発生する。その時この対応が必要となる。
  • Error: invalid arguments. please use the latest GLOBAL.