Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-03-23 17:49:57 +08:00
Code Issues Projects Releases Wiki Activity

feat(layer): add open_quickfix layer option

Browse Source 
add `open_quickfix` layer option for `gtags` layer.
update `:h spacevim-layer-gtags`.

close https://github.com/SpaceVim/SpaceVim/issues/4135
This commit is contained in:
Shidong Wang 2021-09-20 19:15:52 +08:00
parent 6a1437f49f
commit 03b62e1ad7
2 changed files with 148 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
autoload/SpaceVim/layers/gtags.vim
View File

@ -5,6 +5,31 @@
" URL: https://spacevim.org " URL: https://spacevim.org
" License: GPLv3 " License: GPLv3
"============================================================================= "=============================================================================
scriptencoding utf-8
""
" @section gtags, layer-gtags
" @parentsection layers
" `gtags` layer provides |gtags| integration for SpaceVim.
" To load this layer:
" >
" [[layers]]
" name = 'gtags'
" <
" @subsection Layer options
"
" The layer option can be used when loading the `gtags` layer, for example:
" >
" [[layers]]
" name = 'gtags'
" auto_update = true
" open_quickfix = 0
" <
" 1. `auto_update`: enable/disable database update automatically.
" 2. `open_quickfix`: This setting will open the |quickfix| list when
" adding entries. same as |g:gtags_open_list|
" 3. `gtagslabel`: the backend of gtags command, you can use `ctags` or
" `pygments`. It is empty string by default.
if exists('s:gtagslabel') if exists('s:gtagslabel')
finish finish
@ -15,6 +40,7 @@ let s:FILE = SpaceVim#api#import('file')
let s:gtagslabel = '' let s:gtagslabel = ''
let s:auto_update = 1 let s:auto_update = 1
let g:tags_cache_dir = '~/.cache/SpaceVim/tags/' let g:tags_cache_dir = '~/.cache/SpaceVim/tags/'
let g:gtags_open_list = 2
function! SpaceVim#layers#gtags#plugins() abort function! SpaceVim#layers#gtags#plugins() abort
return [ return [
@ -49,17 +75,18 @@ function! SpaceVim#layers#gtags#config() abort
endfunction endfunction
function! SpaceVim#layers#gtags#set_variable(var) abort function! SpaceVim#layers#gtags#set_variable(var) abort
let s:gtagslabel = get(a:var, let s:gtagslabel = get(a:var,
\ 'gtagslabel', \ 'gtagslabel',
\ '') \ '')
let g:tags_cache_dir = get(a:var, let g:tags_cache_dir = get(a:var,
\ 'tags_cache_dir', \ 'tags_cache_dir',
\ g:tags_cache_dir) \ g:tags_cache_dir)
let s:auto_update = get(a:var, let s:auto_update = get(a:var,
\ 'auto_update', \ 'auto_update',
\ s:auto_update) \ s:auto_update)
let g:gtags_open_list = get(a:var,
\ 'open_quickfix',
\ g:gtags_open_list)
endfunction endfunction
function! SpaceVim#layers#gtags#health() abort function! SpaceVim#layers#gtags#health() abort

214
doc/SpaceVim.txt
View File

@ -93,101 +93,102 @@ CONTENTS *SpaceVim-contents*
8. format........................................|SpaceVim-layer-format| 8. format........................................|SpaceVim-layer-format|
9. git..............................................|SpaceVim-layer-git| 9. git..............................................|SpaceVim-layer-git|
10. github.......................................|SpaceVim-layer-github| 10. github.......................................|SpaceVim-layer-github|
11. incsearch.................................|SpaceVim-layer-incsearch| 11. gtags.........................................|SpaceVim-layer-gtags|
12. indentmove...............................|SpaceVim-layer-indentmove| 12. incsearch.................................|SpaceVim-layer-incsearch|
13. lang#actionscript.................|SpaceVim-layer-lang-actionscript| 13. indentmove...............................|SpaceVim-layer-indentmove|
14. lang#agda.................................|SpaceVim-layer-lang-agda| 14. lang#actionscript.................|SpaceVim-layer-lang-actionscript|
15. lang#asciidoc.........................|SpaceVim-layer-lang-asciidoc| 15. lang#agda.................................|SpaceVim-layer-lang-agda|
16. lang#asepctj...........................|SpaceVim-layer-lang-asepctj| 16. lang#asciidoc.........................|SpaceVim-layer-lang-asciidoc|
17. lang#assembly.........................|SpaceVim-layer-lang-assembly| 17. lang#asepctj...........................|SpaceVim-layer-lang-asepctj|
18. lang#autohotkey.....................|SpaceVim-layer-lang-autohotkey| 18. lang#assembly.........................|SpaceVim-layer-lang-assembly|
19. lang#batch...............................|SpaceVim-layer-lang-batch| 19. lang#autohotkey.....................|SpaceVim-layer-lang-autohotkey|
20. lang#c.......................................|SpaceVim-layer-lang-c| 20. lang#batch...............................|SpaceVim-layer-lang-batch|
21. lang#chapel.............................|SpaceVim-layer-lang-chapel| 21. lang#c.......................................|SpaceVim-layer-lang-c|
22. lang#clojure...........................|SpaceVim-layer-lang-clojure| 22. lang#chapel.............................|SpaceVim-layer-lang-chapel|
23. lang#coffeescript.................|SpaceVim-layer-lang-coffeescript| 23. lang#clojure...........................|SpaceVim-layer-lang-clojure|
24. lang#crystal...........................|SpaceVim-layer-lang-crystal| 24. lang#coffeescript.................|SpaceVim-layer-lang-coffeescript|
25. lang#csharp.............................|SpaceVim-layer-lang-csharp| 25. lang#crystal...........................|SpaceVim-layer-lang-crystal|
26. lang#d.......................................|SpaceVim-layer-lang-d| 26. lang#csharp.............................|SpaceVim-layer-lang-csharp|
27. lang#dart.................................|SpaceVim-layer-lang-dart| 27. lang#d.......................................|SpaceVim-layer-lang-d|
28. lang#dockerfile.....................|SpaceVim-layer-lang-dockerfile| 28. lang#dart.................................|SpaceVim-layer-lang-dart|
29. lang#e.......................................|SpaceVim-layer-lang-e| 29. lang#dockerfile.....................|SpaceVim-layer-lang-dockerfile|
30. lang#eiffel.............................|SpaceVim-layer-lang-eiffel| 30. lang#e.......................................|SpaceVim-layer-lang-e|
31. lang#elixir.............................|SpaceVim-layer-lang-elixir| 31. lang#eiffel.............................|SpaceVim-layer-lang-eiffel|
32. lang#elm...................................|SpaceVim-layer-lang-elm| 32. lang#elixir.............................|SpaceVim-layer-lang-elixir|
33. lang#erlang.............................|SpaceVim-layer-lang-erlang| 33. lang#elm...................................|SpaceVim-layer-lang-elm|
34. lang#extra...............................|SpaceVim-layer-lang-extra| 34. lang#erlang.............................|SpaceVim-layer-lang-erlang|
35. lang#forth...............................|SpaceVim-layer-lang-forth| 35. lang#extra...............................|SpaceVim-layer-lang-extra|
36. lang#fortran...........................|SpaceVim-layer-lang-fortran| 36. lang#forth...............................|SpaceVim-layer-lang-forth|
37. lang#foxpro.............................|SpaceVim-layer-lang-foxpro| 37. lang#fortran...........................|SpaceVim-layer-lang-fortran|
38. lang#fsharp.............................|SpaceVim-layer-lang-fsharp| 38. lang#foxpro.............................|SpaceVim-layer-lang-foxpro|
39. lang#go.....................................|SpaceVim-layer-lang-go| 39. lang#fsharp.............................|SpaceVim-layer-lang-fsharp|
40. lang#goby.................................|SpaceVim-layer-lang-goby| 40. lang#go.....................................|SpaceVim-layer-lang-go|
41. lang#gosu.................................|SpaceVim-layer-lang-gosu| 41. lang#goby.................................|SpaceVim-layer-lang-goby|
42. lang#graphql...........................|SpaceVim-layer-lang-graphql| 42. lang#gosu.................................|SpaceVim-layer-lang-gosu|
43. lang#groovy.............................|SpaceVim-layer-lang-groovy| 43. lang#graphql...........................|SpaceVim-layer-lang-graphql|
44. lang#hack.................................|SpaceVim-layer-lang-hack| 44. lang#groovy.............................|SpaceVim-layer-lang-groovy|
45. lang#haskell...........................|SpaceVim-layer-lang-haskell| 45. lang#hack.................................|SpaceVim-layer-lang-hack|
46. lang#html.................................|SpaceVim-layer-lang-html| 46. lang#haskell...........................|SpaceVim-layer-lang-haskell|
47. lang#hy.....................................|SpaceVim-layer-lang-hy| 47. lang#html.................................|SpaceVim-layer-lang-html|
48. lang#idris...............................|SpaceVim-layer-lang-idris| 48. lang#hy.....................................|SpaceVim-layer-lang-hy|
49. lang#io.....................................|SpaceVim-layer-lang-io| 49. lang#idris...............................|SpaceVim-layer-lang-idris|
50. lang#j.......................................|SpaceVim-layer-lang-j| 50. lang#io.....................................|SpaceVim-layer-lang-io|
51. lang#janet...............................|SpaceVim-layer-lang-janet| 51. lang#j.......................................|SpaceVim-layer-lang-j|
52. lang#java.................................|SpaceVim-layer-lang-java| 52. lang#janet...............................|SpaceVim-layer-lang-janet|
53. lang#javascript.....................|SpaceVim-layer-lang-javascript| 53. lang#java.................................|SpaceVim-layer-lang-java|
54. lang#json.................................|SpaceVim-layer-lang-json| 54. lang#javascript.....................|SpaceVim-layer-lang-javascript|
55. lang#julia...............................|SpaceVim-layer-lang-julia| 55. lang#json.................................|SpaceVim-layer-lang-json|
56. lang#kotlin.............................|SpaceVim-layer-lang-kotlin| 56. lang#julia...............................|SpaceVim-layer-lang-julia|
57. lang#latex...............................|SpaceVim-layer-lang-latex| 57. lang#kotlin.............................|SpaceVim-layer-lang-kotlin|
58. lang#lisp.................................|SpaceVim-layer-lang-lisp| 58. lang#latex...............................|SpaceVim-layer-lang-latex|
59. lang#livescript.....................|SpaceVim-layer-lang-livescript| 59. lang#lisp.................................|SpaceVim-layer-lang-lisp|
60. lang#lua...................................|SpaceVim-layer-lang-lua| 60. lang#livescript.....................|SpaceVim-layer-lang-livescript|
61. lang#markdown.........................|SpaceVim-layer-lang-markdown| 61. lang#lua...................................|SpaceVim-layer-lang-lua|
62. lang#moonscript.....................|SpaceVim-layer-lang-moonscript| 62. lang#markdown.........................|SpaceVim-layer-lang-markdown|
63. lang#nim...................................|SpaceVim-layer-lang-nim| 63. lang#moonscript.....................|SpaceVim-layer-lang-moonscript|
64. lang#nix...................................|SpaceVim-layer-lang-nix| 64. lang#nim...................................|SpaceVim-layer-lang-nim|
65. lang#ocaml...............................|SpaceVim-layer-lang-ocaml| 65. lang#nix...................................|SpaceVim-layer-lang-nix|
66. lang#pact.................................|SpaceVim-layer-lang-pact| 66. lang#ocaml...............................|SpaceVim-layer-lang-ocaml|
67. lang#pascal.............................|SpaceVim-layer-lang-pascal| 67. lang#pact.................................|SpaceVim-layer-lang-pact|
68. lang#perl.................................|SpaceVim-layer-lang-perl| 68. lang#pascal.............................|SpaceVim-layer-lang-pascal|
69. lang#php...................................|SpaceVim-layer-lang-php| 69. lang#perl.................................|SpaceVim-layer-lang-perl|
70. lang#pony.................................|SpaceVim-layer-lang-pony| 70. lang#php...................................|SpaceVim-layer-lang-php|
71. lang#processing.....................|SpaceVim-layer-lang-processing| 71. lang#pony.................................|SpaceVim-layer-lang-pony|
72. lang#prolog.............................|SpaceVim-layer-lang-prolog| 72. lang#processing.....................|SpaceVim-layer-lang-processing|
73. lang#puppet.............................|SpaceVim-layer-lang-puppet| 73. lang#prolog.............................|SpaceVim-layer-lang-prolog|
74. lang#purescript.....................|SpaceVim-layer-lang-purescript| 74. lang#puppet.............................|SpaceVim-layer-lang-puppet|
75. lang#python.............................|SpaceVim-layer-lang-python| 75. lang#purescript.....................|SpaceVim-layer-lang-purescript|
76. lang#racket.............................|SpaceVim-layer-lang-racket| 76. lang#python.............................|SpaceVim-layer-lang-python|
77. lang#racket................................|SpaceVim-layer-lang-red| 77. lang#racket.............................|SpaceVim-layer-lang-racket|
78. lang#reason.............................|SpaceVim-layer-lang-reason| 78. lang#racket................................|SpaceVim-layer-lang-red|
79. lang#ring....................................|SpaceVim-layer-lang-r| 79. lang#reason.............................|SpaceVim-layer-lang-reason|
80. lang#ring.................................|SpaceVim-layer-lang-ring| 80. lang#ring....................................|SpaceVim-layer-lang-r|
81. lang#ruby.................................|SpaceVim-layer-lang-ruby| 81. lang#ring.................................|SpaceVim-layer-lang-ring|
82. lang#rust.................................|SpaceVim-layer-lang-rust| 82. lang#ruby.................................|SpaceVim-layer-lang-ruby|
83. lang#scala...............................|SpaceVim-layer-lang-scala| 83. lang#rust.................................|SpaceVim-layer-lang-rust|
84. lang#scheme.............................|SpaceVim-layer-lang-scheme| 84. lang#scala...............................|SpaceVim-layer-lang-scala|
85. lang#sh.....................................|SpaceVim-layer-lang-sh| 85. lang#scheme.............................|SpaceVim-layer-lang-scheme|
86. lang#sml...................................|SpaceVim-layer-lang-sml| 86. lang#sh.....................................|SpaceVim-layer-lang-sh|
87. lang#swig................................|SpaceVim-layer-lang-swift| 87. lang#sml...................................|SpaceVim-layer-lang-sml|
88. lang#swig.................................|SpaceVim-layer-lang-swig| 88. lang#swig................................|SpaceVim-layer-lang-swift|
89. lang#tcl...................................|SpaceVim-layer-lang-tcl| 89. lang#swig.................................|SpaceVim-layer-lang-swig|
90. lang#toml.................................|SpaceVim-layer-lang-toml| 90. lang#tcl...................................|SpaceVim-layer-lang-tcl|
91. lang#typescript.....................|SpaceVim-layer-lang-typescript| 91. lang#toml.................................|SpaceVim-layer-lang-toml|
92. lang#v.......................................|SpaceVim-layer-lang-v| 92. lang#typescript.....................|SpaceVim-layer-lang-typescript|
93. lang#vbnet...............................|SpaceVim-layer-lang-vbnet| 93. lang#v.......................................|SpaceVim-layer-lang-v|
94. lang#wolfram...........................|SpaceVim-layer-lang-wolfram| 94. lang#vbnet...............................|SpaceVim-layer-lang-vbnet|
95. lang#xml...................................|SpaceVim-layer-lang-xml| 95. lang#wolfram...........................|SpaceVim-layer-lang-wolfram|
96. lang#xquery.............................|SpaceVim-layer-lang-xquery| 96. lang#xml...................................|SpaceVim-layer-lang-xml|
97. language server protocol........................|SpaceVim-layer-lsp| 97. lang#xquery.............................|SpaceVim-layer-lang-xquery|
98. leaderf.....................................|SpaceVim-layer-leaderf| 98. language server protocol........................|SpaceVim-layer-lsp|
99. operator...................................|SpaceVim-layer-operator| 99. leaderf.....................................|SpaceVim-layer-leaderf|
100. shell........................................|SpaceVim-layer-shell| 100. operator..................................|SpaceVim-layer-operator|
101. test..........................................|SpaceVim-layer-test| 101. shell........................................|SpaceVim-layer-shell|
102. tmux..........................................|SpaceVim-layer-tmux| 102. test..........................................|SpaceVim-layer-test|
103. tools#dash..............................|SpaceVim-layer-tools-dash| 103. tmux..........................................|SpaceVim-layer-tmux|
104. tools#zeal..............................|SpaceVim-layer-tools-zeal| 104. tools#dash..............................|SpaceVim-layer-tools-dash|
105. ui..............................................|SpaceVim-layer-ui| 105. tools#zeal..............................|SpaceVim-layer-tools-zeal|
106. ui..............................................|SpaceVim-layer-ui|
7. Usage....................................................|SpaceVim-usage| 7. Usage....................................................|SpaceVim-usage|
1. buffers-and-files..................|SpaceVim-usage-buffers-and-files| 1. buffers-and-files..................|SpaceVim-usage-buffers-and-files|
2. custom_plugins........................|SpaceVim-usage-custom_plugins| 2. custom_plugins........................|SpaceVim-usage-custom_plugins|
@ -1572,6 +1573,29 @@ MAPPINGS
normal SPC g h p show PRs in browser normal SPC g h p show PRs in browser
< <
==============================================================================
GTAGS *SpaceVim-layer-gtags*
`gtags` layer provides |gtags| integration for SpaceVim. To load this layer:
>
[[layers]]
name = 'gtags'
<
LAYER OPTIONS
The layer option can be used when loading the `gtags` layer, for example:
>
[[layers]]
name = 'gtags'
auto_update = true
open_quickfix = 0
<
1. `auto_update`: enable/disable database update automatically.
2. `open_quickfix`: This setting will open the |quickfix| list when
adding entries. same as |g:gtags_open_list|
3. `gtagslabel`: the backend of gtags command, you can use `ctags` or
`pygments`. It is empty string by default.
============================================================================== ==============================================================================
INCSEARCH *SpaceVim-layer-incsearch* INCSEARCH *SpaceVim-layer-incsearch*