摘要：也就是，是一個非常強大的源碼符號索引工具。韋大的中符號索引篇對有比較詳細的介紹，本文再做一些補充。的最新版本已經是，該版本了韋大文中提到的下面文件名大小寫的。

Gtags也就是GNU GLOBAL，是一個非常強大的源碼符號索引工具。它通過建立索引數據庫，不但可以查找函數的定義，還可以查找函數的所有引用（被調用的地方）；而且它還可以增量地更新索引數據庫，當代碼有所改變時，它可以在很短的時間內更新索引數據庫，保持索引數據庫和代碼同步。
韋大的 Vim 8 中 C/C++ 符號索引：GTags 篇 對 gtags 有比較詳細的介紹，本文再做一些補充。

GLOBAL-6.6.3 released

Gtags的最新版本已經是6.6.3，該版本 fix了韋大文中提到的 Windows下面文件名大小寫的 bug。

在 Linux上，不配置let $GTAGSCONF = "/path/to/share/gtags/gtags.conf"也可以正常工作。

當項目文件的路徑包含非ASCII字符時，使用pygments會報UnicodeEncodeError: "latin-1" codec can"t encode characters in position 5-8: ordinal not in range(256)

LeaderF 可以自己管理 gtags 數據庫（GTAGS，GRTAGS，GPATH），它不會在你的項目目錄下生成任何額外的文件或目錄。gtags 數據庫文件存儲在$HOME/.LfCache/gtags/%PATH%OF%YOUR%PROJECT/下面， %PATH%OF%YOUR%PROJECT 是把你項目路徑中的 或 / 替換成 %。
只要設置let g:Lf_GtagsAutoGenerate = 1， LeaderF 就會在打開第一個文件時自動生成 gtags 數據庫。當代碼有更改并且已經有 gtags 數據庫生成時，更改的代碼會自動同步到 gtags 數據庫（即使g:Lf_GtagsAutoGenerate是0）。
只有在項目根目錄下有g:Lf_RootMarkers（默認值是[".git", ".hg", ".svn"]）里面指定的文件或目錄時，LeaderF 才會自動生成 gtags 數據庫；否則只能手動生成 gtags 數據庫：Leaderf gtags --update，但是當代碼有更改時，gtags 數據庫依然可以自動更新。

具體使用方法可以用:Leaderf gtags -h來查看。

usage:
Leaderf[!] gtags [-h] [--remove] [--recall]
Leaderf[!] gtags --update [--gtagsconf ] [--gtagslabel ] [--accept-dotfiles]
                 [--skip-unreadable] [--skip-symlink []] [--gtagslibpath  [ ...]]
Leaderf[!] gtags [--current-buffer | --all-buffers | --all] [--result ] [COMMON_OPTIONS]
Leaderf[!] gtags -d  [--auto-jump []] [-i] [--literal] [--path-style ] [-S ]
                 [--append] [--match-path] [--gtagsconf ] [--gtagslabel ] [COMMON_OPTIONS]
Leaderf[!] gtags -r  [--auto-jump []] [-i] [--literal] [--path-style ] [-S ]
                 [--append] [--match-path] [--gtagsconf ] [--gtagslabel ] [COMMON_OPTIONS]
Leaderf[!] gtags -s  [-i] [--literal] [--path-style ] [-S ] [--append]
                 [--match-path] [--gtagsconf ] [--gtagslabel ] [COMMON_OPTIONS]
Leaderf[!] gtags -g  [-i] [--literal] [--path-style ] [-S ] [--append]
                 [--match-path] [--gtagsconf ] [--gtagslabel ] [COMMON_OPTIONS]
Leaderf[!] gtags --by-context [-i] [--literal] [--path-style ] [-S ] [--append]
                 [--match-path] [--gtagsconf ] [--gtagslabel ] [COMMON_OPTIONS]

[COMMON_OPTIONS]: [--reverse] [--stayOpen] [--input  | --cword]
                  [--top | --bottom | --left | --right | --belowright | --aboveleft | --fullScreen]
                  [--nameOnly | --fullPath | --fuzzy | --regexMode] [--nowrap]
 

optional arguments:
  -h, --help            show this help message and exit

specific arguments:
  --update              Create tag files if tag files do not exist, update the tag files otherwise.
  --remove              Remove the tag files generated.
  --accept-dotfiles     Accept files and directories whose names begin with a dot. By default, gtags
                        ignores them.
  --skip-unreadable     Skip unreadable files.
  --gtagsconf     Set environment variable GTAGSCONF to .
  --gtagslabel   Set environment variable GTAGSLABEL to .
  --skip-symlink []
                        Skip symbolic links. If type is "f" then skip only symbolic links for file, else
                        if "d" then skip only symbolic links for directory. The default value of type is
                        "a" (all symbolic links).
  --gtagslibpath  [ ...]
                        Specify the paths to search for library functions.
  -d , --definition 
                        Show locations of definitions.
  -r , --reference 
                        Show reference to a symbol which has definitions.
  -s , --symbol 
                        Show reference to a symbol which has no definition.
  -g , --grep 
                        Show all lines which match to the .
  --by-context          Decide tag type by context at cursor position. If the context is a definition of
                        the pattern then use -r, else if there is at least one definition of the pattern
                        then use -d, else use -s. Regular expression is not allowed for pattern.
  -i, --ignore-case     Ignore case distinctions in the pattern.
  --literal             Execute literal search instead of regular expression search.
  --path-style 
                        Show path names using , which may be one of: `relative`, `absolute`,
                        `shorter`, `abslib` or `through`. `relative` means relative path. `absolute`
                        means absolute path. `shorter` means the shorter one of relative and absolute
                        path. `abslib` means absolute path for libraries (GTAGSLIBPATH) and relative path
                        for the rest. `through` means the relative path from the project root directory
                        (internal format of GPATH). The default is `relative`.
  -S , --scope 
                        Show only tags which exist under  directory.
  --recall              Recall last search. If the result window is closed, reopen it.
  --match-path          Match the file path when fuzzy searching.
  --append              Append to the previous search results.
  --current-buffer      Show tags in current buffer.
  --all-buffers         Show tags in all listed buffers.
  --all                 Show tags in the whole project.
  --result      Show result using format, which may be one of: `ctags`(default), `ctags-x`,
                        `ctags-mod`.
  --auto-jump []  Jump to the tag directly when there is only one match.  can be "h", "v" or
                        "t", which mean jump to a horizontally, vertically split window, or a new tabpage
                        respectively. If  is omitted, jump to a position in current window.

common arguments:
  --reverse             show results in bottom-up order
  --stayOpen            don"t quit LeaderF after accepting an entry
  --input        specifies INPUT as the pattern inputted in advance
  --cword               current word under cursor is inputted in advance
  --top                 the LeaderF window is at the top of the screen
  --bottom              the LeaderF window is at the bottom of the screen
  --left                the LeaderF window is at the left of the screen
  --right               the LeaderF window is at the right of the screen
  --belowright          the LeaderF window is at the belowright of the screen
  --aboveleft           the LeaderF window is at the aboveleft of the screen
  --fullScreen          the LeaderF window takes up the full screen
  --nameOnly            LeaderF is in NameOnly mode by default
  --fullPath            LeaderF is in FullPath mode by default
  --fuzzy               LeaderF is in Fuzzy mode by default
  --regexMode           LeaderF is in Regex mode by default
  --nowrap              long lines in the LeaderF window won"t wrap
  --next                Jump to the next result.
  --previous            Jump to the previous result.

If [!] is given, enter normal mode directly.

注意：如果:Leaderf后面有感嘆號，會直接進入normal模式；如果沒有感嘆號，則是輸入模式，此時可以輸入字符來進行模糊匹配過濾。可以用tab鍵在兩個模式間來回切換。

Leaderf[!] gtags --update [--gtagsconf ] [--gtagslabel ] [--accept-dotfiles]
                 [--skip-unreadable] [--skip-symlink []] [--gtagslibpath  [ ...]]

此命令完全異步，不會卡住你的UI。

--gtagsconf

用來指定 gtags.conf 文件的路徑，一般情況下不需要指定，默認值就可以很好地工作。對于Windows上，如果相對于gtags.exe所在路徑有../share/gtags/gtags.conf，也不需要指定該選項。如果需要用戶自己特有的針對 gtags 的配置，可以指定用戶的配置文件。

也可以在vimrc里設置g:Lf_Gtagsconf達到同樣的目的。

--gtagslabel

用來指定gtagslabel，如果不指定，默認值是 "default"。是 gtags.conf 中的：

default
使用內置parser，只支持 6 種語言（C，C++，Java，PHP4，Yacc，匯編）。

ctags
使用exuberant-ctags作為語言parser，支持 40+ 種語言，只能生成定義索引不能生成引用索引。

new-ctags
使用universal-ctags作為語言parser，支持 100+ 種語言，只能生成定義索引不能生成引用索引。雖然貌似universal-ctags已經支持生成引用tags，但是依然不能配合gtags工作（見這里），我也試了各種操作都沒成功，也許是因為這個PR沒有被merge。

pygments
使用pygments作為語言parser，號稱支持300+種語言。

native-pygments
對于原生支持的6種語言使用內置parser，其他語言使用pygments作為parser。

等等

也可以在`vimrc`里設置`g:Lf_Gtagslabel`達到同樣的目的。

--gtagslibpath [ ...]

用來指定項目所用 library 的 Paths，這樣就可以生成 library 的索引，查找定義或引用時可以跳轉到 library 代碼中去。后面指定的路徑還可以是一個或多個其他項目路徑，跳轉時可以跳到其他項目中的文件。

Leaderf[!] gtags [--current-buffer | --all-buffers | --all] [--result ] [COMMON_OPTIONS]

此命令可以列出當前buffer、所有打開的buffer或者整個項目的tags。

Leaderf[!] gtags等同于Leaderf[!] gtags --all，列出整個項目的tags。

--result 指定顯示格式，可以是ctags(default), ctags-x或者ctags-mod。

ctags格式

ctags-x格式

ctags-mod格式

Leaderf[!] gtags -d  [--auto-jump []] [-i] [--literal] [--path-style ] [-S ]
                 [--append] [--match-path] [--gtagsconf ] [--gtagslabel ] [COMMON_OPTIONS]
Leaderf[!] gtags -r  [--auto-jump []] [-i] [--literal] [--path-style ] [-S ]
                 [--append] [--match-path] [--gtagsconf ] [--gtagslabel ] [COMMON_OPTIONS]

可以是正則表達式。

--auto-jump [] 意思是如果只有一個結果直接跳過去。

Leaderf[!] gtags -g 功能已被Leaderf rg包含。

Leaderf gtags --next 和 Leaderf gtags --previous相當于quickfix的:cnext和:cprevious命令，在LeaderF結果窗口關閉的情況下也可以使用。

更多內容請參考:Leaderf gtags -h 和 doc。

let g:Lf_GtagsAutoGenerate = 1
let g:Lf_Gtagslabel = "native-pygments"
noremap fr :=printf("Leaderf! gtags -r %s --auto-jump", expand(""))
noremap fd :=printf("Leaderf! gtags -d %s --auto-jump", expand(""))
noremap fo :=printf("Leaderf! gtags --recall %s", "")
noremap fn :=printf("Leaderf gtags --next %s", "")
noremap fp :=printf("Leaderf gtags --previous %s", "")