-
-
Notifications
You must be signed in to change notification settings - Fork 485
/
tagbar.vim
4120 lines (3519 loc) · 132 KB
/
tagbar.vim
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
" ============================================================================
" File: tagbar.vim
" Description: List the current file's tags in a sidebar, ordered by class etc
" Author: Jan Larres <jan@majutsushi.net>
" Licence: Vim licence
" Website: https://preservim.github.io/tagbar
" Version: 3.1.1
" Note: This plugin was heavily inspired by the 'Taglist' plugin by
" Yegappan Lakshmanan and uses a small amount of code from it.
"
" Original taglist copyright notice:
" Permission is hereby granted to use and distribute this code,
" with or without modifications, provided that this copyright
" notice is copied with it. Like anything else that's free,
" taglist.vim is provided *as is* and comes with no warranty of
" any kind, either expressed or implied. In no event will the
" copyright holder be liable for any damamges resulting from the
" use of this software.
" ============================================================================
scriptencoding utf-8
" Initialization {{{1
" If another plugin calls an autoloaded Tagbar function on startup before the
" plugin/tagbar.vim file got loaded, load it explicitly
if exists(':Tagbar') == 0
runtime plugin/tagbar.vim
endif
if exists(':Tagbar') == 0
echomsg 'Tagbar: Could not load plugin code, check your runtimepath!'
finish
endif
" Basic init {{{2
redir => s:ftype_out
silent filetype
redir END
if s:ftype_out !~# 'detection:ON'
echomsg 'Tagbar: Filetype detection is turned off, skipping plugin'
unlet s:ftype_out
finish
endif
unlet s:ftype_out
let g:tagbar#icon_closed = g:tagbar_iconchars[0]
let g:tagbar#icon_open = g:tagbar_iconchars[1]
let s:type_init_done = 0
let s:autocommands_done = 0
let s:statusline_in_use = 0
let s:init_done = 0
" 0: not checked yet; 1: checked and found; 2: checked and not found
let s:checked_ctags = 0
let s:checked_ctags_types = 0
let s:ctags_is_uctags = 0
let s:new_window = 1
let s:is_maximized = 0
let s:winrestcmd = ''
let s:short_help = 1
let s:nearby_disabled = 0
let s:paused = 0
let s:pwin_by_tagbar = 0
let s:buffer_seqno = 0
let s:vim_quitting = 0
let s:last_alt_bufnr = -1
let s:window_expanded = 0
let s:expand_bufnr = -1
let s:window_pos = {
\ 'pre' : { 'x' : 0, 'y' : 0 },
\ 'post' : { 'x' : 0, 'y' : 0 }
\}
let s:delayed_update_files = []
let g:loaded_tagbar = 1
let s:last_highlight_tline = 0
let s:warnings = {
\ 'type': [],
\ 'encoding': 0
\ }
let s:singular_types = {
\ 'Classes': 'Class',
\ 'Delegates': 'Delegate',
\ 'Enumeration values': 'Enumeration value',
\ 'Enumerations': 'Enumeration',
\ 'Error codes': 'Error code',
\ 'Error domains': 'Error domain',
\ 'Fields': 'Field',
\ 'Interfaces': 'Interface',
\ 'JavaScript funtions': 'JavaScript function',
\ 'Methods': 'Method',
\ 'MobiLink Conn Scripts': 'MobiLink Conn Script',
\ 'MobiLink Properties': 'MobiLink Property',
\ 'MobiLink Table Scripts': 'MobiLink Table Script',
\ 'Properties': 'Property',
\ 'Signals': 'Signal',
\ 'Structures': 'Structure',
\ 'autocommand groups': 'autocommand group',
\ 'block data': 'block data',
\ 'block label': 'block label',
\ 'chapters': 'chapter',
\ 'classes': 'class',
\ 'commands': 'command',
\ 'common blocks': 'common block',
\ 'components': 'component',
\ 'constant definitions': 'constant definition',
\ 'constants': 'constant',
\ 'constructors': 'constructor',
\ 'cursors': 'cursor',
\ 'data items': 'data item',
\ 'defines': 'define',
\ 'derived types and structures': 'derived type and structure',
\ 'domains': 'domain',
\ 'entities': 'entity',
\ 'entry points': 'entry point',
\ 'embedded': 'embedded',
\ 'enum constants': 'enum constant',
\ 'enum types': 'enum type',
\ 'enumerations': 'enumeration',
\ 'enumerators': 'enumerator',
\ 'enums': 'enum',
\ 'events': 'event',
\ 'exception declarations': 'exception declaration',
\ 'exceptions': 'exception',
\ 'features': 'feature',
\ 'fields': 'field',
\ 'file descriptions': 'file description',
\ 'formats': 'format',
\ 'fragments': 'fragment',
\ 'function definitions': 'function definition',
\ 'functions': 'function',
\ 'functor definitions': 'functor definition',
\ 'global variables': 'global variable',
\ 'group items': 'group item',
\ 'imports': 'import',
\ 'includes': 'include',
\ 'indexes': 'index',
\ 'interfaces': 'interface',
\ 'javascript functions': 'JavaScript function',
\ 'labels': 'label',
\ 'macro definitions': 'macro definition',
\ 'macros': 'macro',
\ 'maps': 'map',
\ 'members': 'member',
\ 'methods': 'method',
\ 'modules or functors': 'module or function',
\ 'modules': 'module',
\ 'mxtags': 'mxtag',
\ 'named anchors': 'named anchor',
\ 'namelists': 'namelist',
\ 'namespaces': 'namespace',
\ 'net data types': 'net data type',
\ 'packages': 'package',
\ 'package': 'package',
\ 'paragraphs': 'paragraph',
\ 'parts': 'part',
\ 'patterns': 'pattern',
\ 'ports': 'port',
\ 'procedures': 'procedure',
\ 'program ids': 'program id',
\ 'programs': 'program',
\ 'projects': 'project',
\ 'properties': 'property',
\ 'prototypes': 'prototype',
\ 'publications': 'publication',
\ 'record definitions': 'record definition',
\ 'record fields': 'record field',
\ 'records': 'record',
\ 'register data types': 'register data type',
\ 'sections': 'section',
\ 'services': 'services',
\ 'sets': 'sets',
\ 'signature declarations': 'signature declaration',
\ 'singleton methods': 'singleton method',
\ 'slots': 'slot',
\ 'structs': 'struct',
\ 'structure declarations': 'structure declaration',
\ 'structure fields': 'structure field',
\ 'subparagraphs': 'subparagraph',
\ 'subroutines': 'subroutine',
\ 'subsections': 'subsection',
\ 'subsubsections': 'subsubsection',
\ 'subtypes': 'subtype',
\ 'synonyms': 'synonym',
\ 'tables': 'table',
\ 'targets': 'target',
\ 'tasks': 'task',
\ 'triggers': 'trigger',
\ 'type definitions': 'type definition',
\ 'type names': 'type name',
\ 'typedefs': 'typedef',
\ 'types': 'type',
\ 'unions': 'union',
\ 'value bindings': 'value binding',
\ 'variables': 'variable',
\ 'views': 'view',
\ 'vimball filenames': 'vimball filename'}
" s:Init() {{{2
function! s:Init(silent) abort
if s:checked_ctags == 2 && a:silent
return 0
elseif s:checked_ctags != 1
if !s:CheckForExCtags(a:silent)
return 0
endif
endif
if !s:type_init_done
call s:InitTypes()
endif
if !s:autocommands_done
call s:CreateAutocommands()
call s:AutoUpdate(fnamemodify(expand('%'), ':p'), 0)
endif
let s:init_done = 1
return 1
endfunction
" s:InitTypes() {{{2
function! s:InitTypes() abort
call tagbar#debug#log('Initializing types')
let supported_types = s:GetSupportedFiletypes()
if s:ctags_is_uctags
let s:known_types = tagbar#types#uctags#init(supported_types)
else
let s:known_types = tagbar#types#ctags#init(supported_types)
endif
" Use dart_ctags if available
let dart_ctags = s:CheckFTCtags('dart_ctags', 'dart')
if dart_ctags !=# ''
let supported_types['dart'] = 1
call tagbar#debug#log('Detected dart_ctags, overriding typedef')
let type_dart = tagbar#prototypes#typeinfo#new()
let type_dart.ctagstype = 'dart'
let type_dart.kinds = [
\ {'short' : 'l', 'long' : 'library', 'fold' : 0, 'stl' : 0},
\ {'short' : 't', 'long' : 'export', 'fold' : 0, 'stl' : 0},
\ {'short' : 'i', 'long' : 'imports', 'fold' : 1, 'stl' : 0},
\ {'short' : 'D', 'long' : 'dart', 'fold' : 0, 'stl' : 0},
\ {'short' : 'U', 'long' : 'pub', 'fold' : 0, 'stl' : 0},
\ {'short' : 'L', 'long' : 'local', 'fold' : 0, 'stl' : 0},
\ {'short' : 'P', 'long' : 'part', 'fold' : 0, 'stl' : 0},
\ {'short' : 'p', 'long' : 'part of', 'fold' : 0, 'stl' : 0},
\ {'short' : 'C', 'long' : 'consts', 'fold' : 0, 'stl' : 0},
\ {'short' : 'v', 'long' : 'variables', 'fold' : 0, 'stl' : 0},
\ {'short' : 'F', 'long' : 'functions', 'fold' : 0, 'stl' : 0},
\ {'short' : 'E', 'long' : 'enums', 'fold' : 0, 'stl' : 0},
\ {'short' : 'e', 'long' : 'constants', 'fold' : 0, 'stl' : 0},
\ {'short' : 'x', 'long' : 'mixins', 'fold' : 0, 'stl' : 0},
\ {'short' : 'c', 'long' : 'classes', 'fold' : 0, 'stl' : 0},
\ {'short' : 'd', 'long' : 'extends', 'fold' : 0, 'stl' : 0},
\ {'short' : 'w', 'long' : 'with', 'fold' : 0, 'stl' : 0},
\ {'short' : 'z', 'long' : 'implements', 'fold' : 0, 'stl' : 0},
\ {'short' : 'n', 'long' : 'on', 'fold' : 0, 'stl' : 0},
\ {'short' : 'r', 'long' : 'constructors', 'fold' : 0, 'stl' : 0},
\ {'short' : 'a', 'long' : 'abstract functions', 'fold' : 0, 'stl' : 0},
\ {'short' : 'f', 'long' : 'fields', 'fold' : 0, 'stl' : 0},
\ {'short' : 'm', 'long' : 'methods', 'fold' : 0, 'stl' : 0},
\ {'short' : 'M', 'long' : 'static methods', 'fold' : 0, 'stl' : 0},
\ {'short' : 'g', 'long' : 'getters', 'fold' : 0, 'stl' : 0},
\ {'short' : 's', 'long' : 'setters', 'fold' : 0, 'stl' : 0},
\ {'short' : 'o', 'long' : 'operators', 'fold' : 0, 'stl' : 0},
\ ]
let type_dart.sro = ':'
let type_dart.kind2scope = {
\ 'c' : 'class',
\ 'E' : 'enum',
\ 'x' : 'mixin',
\ 'i' : 'directive'
\ }
let type_dart.scope2kind = {
\ 'class' : 'c',
\ 'enum' : 'E',
\ 'mixin' : 'x',
\ 'directive' : 'i'
\ }
let type_dart.ctagsbin = dart_ctags
let type_dart.ctagsargs = '-l'
let type_dart.ftype = 'dart'
call type_dart.createKinddict()
let s:known_types.dart = type_dart
endif
" Use jsctags/doctorjs if available
let jsctags = s:CheckFTCtags('jsctags', 'javascript')
if jsctags !=# ''
call tagbar#debug#log('Detected jsctags, overriding typedef')
let type_javascript = tagbar#prototypes#typeinfo#new()
let type_javascript.ctagstype = 'javascript'
let type_javascript.kinds = [
\ {'short' : 'v', 'long' : 'variables', 'fold' : 0, 'stl' : 0},
\ {'short' : 'f', 'long' : 'functions', 'fold' : 0, 'stl' : 1}
\ ]
let type_javascript.sro = '.'
let type_javascript.kind2scope = {
\ 'v' : 'namespace',
\ 'f' : 'namespace'
\ }
let type_javascript.scope2kind = {
\ 'namespace' : 'f'
\ }
let type_javascript.ctagsbin = jsctags
let type_javascript.ctagsargs = '-f -'
let type_javascript.ftype = 'javascript'
call type_javascript.createKinddict()
let s:known_types.javascript = type_javascript
endif
" Use gotags if available
let gotags = s:CheckFTCtags('gotags', 'go')
if gotags !=# ''
call tagbar#debug#log('Detected gotags, overriding typedef')
let type_go = tagbar#prototypes#typeinfo#new()
let type_go.ctagstype = 'go'
let type_go.kinds = [
\ {'short' : 'p', 'long' : 'package', 'fold' : 0, 'stl' : 0},
\ {'short' : 'i', 'long' : 'imports', 'fold' : 1, 'stl' : 0},
\ {'short' : 'c', 'long' : 'constants', 'fold' : 0, 'stl' : 0},
\ {'short' : 'v', 'long' : 'variables', 'fold' : 0, 'stl' : 0},
\ {'short' : 't', 'long' : 'types', 'fold' : 0, 'stl' : 0},
\ {'short' : 'n', 'long' : 'intefaces', 'fold' : 0, 'stl' : 0},
\ {'short' : 'w', 'long' : 'fields', 'fold' : 0, 'stl' : 0},
\ {'short' : 'e', 'long' : 'embedded', 'fold' : 0, 'stl' : 0},
\ {'short' : 'm', 'long' : 'methods', 'fold' : 0, 'stl' : 0},
\ {'short' : 'r', 'long' : 'constructors', 'fold' : 0, 'stl' : 0},
\ {'short' : 'f', 'long' : 'functions', 'fold' : 0, 'stl' : 0},
\ ]
let type_go.sro = '.'
let type_go.kind2scope = {
\ 't' : 'ctype',
\ 'n' : 'ntype'
\ }
let type_go.scope2kind = {
\ 'ctype' : 't',
\ 'ntype' : 'n'
\ }
let type_go.ctagsbin = gotags
let type_go.ctagsargs = '-sort -silent'
let type_go.ftype = 'go'
call type_go.createKinddict()
let s:known_types.go = type_go
endif
call s:LoadUserTypeDefs()
" Add an 'unknown' kind to the types for pseudotags that we can't
" determine the correct kind for since they don't have any children that
" are not pseudotags and that therefore don't provide scope information
for typeinfo in values(s:known_types)
if has_key(typeinfo, 'kind2scope')
let unknown_kind =
\ {'short' : '?', 'long' : 'unknown', 'fold' : 0, 'stl' : 1}
" Check for existence first since some types exist under more than
" one name
if index(typeinfo.kinds, unknown_kind) == -1
call add(typeinfo.kinds, unknown_kind)
endif
let typeinfo.kind2scope['?'] = 'unknown'
endif
endfor
let s:type_init_done = 1
endfunction
" s:LoadUserTypeDefs() {{{2
function! s:LoadUserTypeDefs(...) abort
if a:0 > 0
let type = a:1
let defdict = {}
let defdict[type] = g:tagbar_type_{type}
else
let defdict = tagbar#getusertypes()
endif
let transformed = {}
for [type, def] in items(defdict)
let transformed[type] = s:TransformUserTypeDef(def)
let transformed[type].ftype = type
endfor
for [key, value] in items(transformed)
call tagbar#debug#log("Initializing user type '" . key . "'")
if !has_key(s:known_types, key) || get(value, 'replace', 0)
let s:known_types[key] = tagbar#prototypes#typeinfo#new(value)
else
call extend(s:known_types[key], value)
endif
call s:known_types[key].createKinddict()
endfor
endfunction
" s:TransformUserTypeDef() {{{2
" Transform the user definitions into the internal format
function! s:TransformUserTypeDef(def) abort
let newdef = copy(a:def)
if has_key(a:def, 'kinds')
let newdef.kinds = []
let kinds = a:def.kinds
for kind in kinds
let kindlist = split(kind, ':')
let kinddict = {'short' : kindlist[0], 'long' : kindlist[1]}
let kinddict.fold = get(kindlist, 2, 0)
let kinddict.stl = get(kindlist, 3, 1)
call add(newdef.kinds, kinddict)
endfor
endif
" If the user only specified one of kind2scope and scope2kind then use it
" to generate the respective other
if has_key(a:def, 'kind2scope') && !has_key(a:def, 'scope2kind')
let newdef.scope2kind = {}
for [key, value] in items(a:def.kind2scope)
let newdef.scope2kind[value] = key
endfor
elseif has_key(a:def, 'scope2kind') && !has_key(a:def, 'kind2scope')
let newdef.kind2scope = {}
for [key, value] in items(a:def.scope2kind)
let newdef.kind2scope[value] = key
endfor
endif
return newdef
endfunction
" s:RestoreSession() {{{2
" Properly restore Tagbar after a session got loaded
function! s:RestoreSession() abort
if s:init_done
call tagbar#debug#log('Tagbar already initialized; not restoring session')
return
endif
call tagbar#debug#log('Restoring session')
let curfile = fnamemodify(bufname('%'), ':p')
let tagbarwinnr = bufwinnr(s:TagbarBufName())
if tagbarwinnr == -1
" Tagbar wasn't open in the saved session, nothing to do
return
endif
let in_tagbar = 1
if winnr() != tagbarwinnr
call s:goto_win(tagbarwinnr, 1)
let in_tagbar = 0
endif
let s:last_autofocus = 0
call s:Init(0)
call s:InitWindow(g:tagbar_autoclose)
call s:AutoUpdate(curfile, 0)
if !in_tagbar
call s:goto_win('p')
endif
endfunction
" s:MapKeys() {{{2
function! s:MapKeys() abort
call tagbar#debug#log('Mapping keys')
nnoremap <script> <silent> <buffer> <2-LeftMouse>
\ :call <SID>JumpToTag(0)<CR>
nnoremap <script> <silent> <buffer> <LeftRelease>
\ <LeftRelease>:call <SID>CheckMouseClick()<CR>
inoremap <script> <silent> <buffer> <2-LeftMouse>
\ <C-o>:call <SID>JumpToTag(0)<CR>
inoremap <script> <silent> <buffer> <LeftRelease>
\ <LeftRelease><C-o>:call <SID>CheckMouseClick()<CR>
let maps = [
\ ['jump', 'JumpToTag(0)'],
\ ['preview', 'JumpToTag(1)'],
\ ['previewwin', 'ShowInPreviewWin()'],
\ ['nexttag', 'GotoNextToplevelTag(1)'],
\ ['prevtag', 'GotoNextToplevelTag(-1)'],
\ ['showproto', 'ShowPrototype(0)'],
\ ['hidenonpublic', 'ToggleHideNonPublicTags()'],
\
\ ['openfold', 'OpenFold()'],
\ ['closefold', 'CloseFold()'],
\ ['togglefold', 'ToggleFold()'],
\ ['openallfolds', 'SetFoldLevel(99, 1)'],
\ ['closeallfolds', 'SetFoldLevel(0, 1)'],
\ ['incrementfolds', 'ChangeFoldLevel(1, 1)'],
\ ['decrementfolds', 'ChangeFoldLevel(-1, 1)'],
\ ['nextfold', 'GotoNextFold()'],
\ ['prevfold', 'GotoPrevFold()'],
\
\ ['togglesort', 'ToggleSort()'],
\ ['togglecaseinsensitive', 'ToggleCaseInsensitive()'],
\ ['toggleautoclose', 'ToggleAutoclose()'],
\ ['togglepause', 'TogglePause()'],
\ ['zoomwin', 'ZoomWindow()'],
\ ['close', 'CloseWindow()'],
\ ['help', 'ToggleHelp()'],
\ ]
let map_options = ' <script> <silent> <buffer> '
if v:version > 703 || (v:version == 703 && has('patch1261'))
let map_options .= ' <nowait> '
endif
for [map, func] in maps
let def = get(g:, 'tagbar_map_' . map)
if type(def) == type('')
let keys = [def]
else
let keys = def
endif
for key in keys
if !empty(key)
execute 'nnoremap' . map_options . key .
\ ' :call <SID>' . func . '<CR>'
endif
endfor
unlet def
endfor
let b:tagbar_mapped_keys = 1
endfunction
" s:CreateAutocommands() {{{2
function! s:CreateAutocommands() abort
call tagbar#debug#log('Creating autocommands')
augroup TagbarAutoCmds
autocmd!
autocmd BufEnter * if expand('<amatch>') !~ '__Tagbar__.*' |
\ let s:last_alt_bufnr = bufnr('#') |
\ endif
if exists('##QuitPre')
autocmd QuitPre * let s:vim_quitting = 1
endif
autocmd WinEnter * nested call s:HandleOnlyWindow()
if !g:tagbar_no_autocmds
if !g:tagbar_silent
autocmd CursorHold __Tagbar__.* call s:ShowPrototype(1)
endif
autocmd WinEnter __Tagbar__.* call s:SetStatusLine()
autocmd WinLeave __Tagbar__.* call s:SetStatusLine()
if g:tagbar_show_balloon == 1 && has('balloon_eval')
autocmd WinEnter __Tagbar__.*
\ let s:beval = &beval |
\ set ballooneval
autocmd WinLeave __Tagbar__.*
\ if exists("s:beval") |
\ let &beval = s:beval |
\ endif
endif
if g:tagbar_autopreview
autocmd CursorMoved __Tagbar__.* nested call s:ShowInPreviewWin()
endif
autocmd WinEnter * if bufwinnr(s:TagbarBufName()) == -1 |
\ call s:ShrinkIfExpanded() |
\ endif
autocmd BufWritePost *
\ call s:HandleBufWrite(fnamemodify(expand('<afile>'), ':p'))
autocmd CursorHold,CursorHoldI * call s:do_delayed_update()
" BufReadPost is needed for reloading the current buffer if the file
" was changed by an external command; see commit 17d199f
autocmd BufReadPost,BufEnter,CursorHold,FileType * call
\ s:AutoUpdate(fnamemodify(expand('<afile>'), ':p'), 0)
if g:tagbar_highlight_follow_insert
autocmd CursorHoldI * call
\ s:AutoUpdate(fnamemodify(expand('<afile>'), ':p'), 0)
endif
" Suspend Tagbar while grep commands are running, since we don't want
" to process files that only get loaded temporarily to search them
autocmd QuickFixCmdPre *grep* let s:tagbar_qf_active = 1
autocmd QuickFixCmdPost *grep* if exists('s:tagbar_qf_active') |
\ unlet s:tagbar_qf_active |
\ endif
autocmd VimEnter * call s:CorrectFocusOnStartup()
endif
augroup END
" Separate these autocmds out from the others as we want to always perform
" these actions even if the tagbar window closes.
augroup TagbarCleanupAutoCmds
autocmd!
if !g:tagbar_no_autocmds
autocmd BufDelete,BufWipeout *
\ nested call s:HandleBufDelete(expand('<afile>'), expand('<abuf>'))
endif
augroup END
let s:autocommands_done = 1
endfunction
" s:CheckForExCtags() {{{2
" Test whether the ctags binary is actually Exuberant Ctags and not BSD ctags
" (or something else)
function! s:CheckForExCtags(silent) abort
call tagbar#debug#log('Checking for Exuberant Ctags')
if !exists('g:tagbar_ctags_bin')
let ctagsbins = []
let ctagsbins += ['ctags-exuberant'] " Debian
let ctagsbins += ['exuberant-ctags']
let ctagsbins += ['exctags'] " FreeBSD, NetBSD
let ctagsbins += ['/usr/local/bin/ctags'] " Homebrew
let ctagsbins += ['/opt/local/bin/ctags'] " Macports
let ctagsbins += ['ectags'] " OpenBSD
let ctagsbins += ['ctags']
let ctagsbins += ['ctags.exe']
let ctagsbins += ['tags']
let ctagsbins += ['universal-ctags']
for ctags in ctagsbins
if executable(ctags)
let g:tagbar_ctags_bin = ctags
break
endif
endfor
if !exists('g:tagbar_ctags_bin')
let l:errmsg = 'Tagbar: Exuberant ctags not found!'
let l:infomsg = 'Please download Exuberant Ctags from' .
\ ' ctags.sourceforge.net and install it in a' .
\ ' directory in your $PATH or set g:tagbar_ctags_bin.'
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent)
let s:checked_ctags = 2
return 0
endif
else
" reset 'wildignore' temporarily in case *.exe is included in it
let wildignore_save = &wildignore
set wildignore&
let g:tagbar_ctags_bin = expand(g:tagbar_ctags_bin)
let &wildignore = wildignore_save
if !executable(g:tagbar_ctags_bin)
let l:errmsg = 'Tagbar: Exuberant ctags not found at ' .
\ "'" . g:tagbar_ctags_bin . "'!"
let l:infomsg = 'Please check your g:tagbar_ctags_bin setting.'
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent)
let s:checked_ctags = 2
return 0
endif
endif
let ctags_cmd = s:EscapeCtagsCmd(g:tagbar_ctags_bin, '--version')
if ctags_cmd ==# ''
let s:checked_ctags = 2
return 0
endif
let ctags_output = s:ExecuteCtags(ctags_cmd)
call tagbar#debug#log("Command output:\n" . ctags_output)
call tagbar#debug#log('Exit code: ' . s:shell_error)
if s:shell_error || ctags_output !~# '\(Exuberant\|Universal\) Ctags'
let l:errmsg = 'Tagbar: Ctags doesn''t seem to be Exuberant Ctags!'
let l:infomsg = 'BSD ctags will NOT WORK.' .
\ ' Please download Exuberant Ctags from ctags.sourceforge.net' .
\ ' and install it in a directory in your $PATH' .
\ ' or set g:tagbar_ctags_bin.'
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent,
\ ctags_cmd, ctags_output, s:shell_error)
let s:checked_ctags = 2
return 0
elseif !s:CheckExCtagsVersion(ctags_output)
let l:errmsg = 'Tagbar: Exuberant Ctags is too old!'
let l:infomsg = 'You need at least version 5.5 for Tagbar to work.' .
\ ' Please download a newer version from ctags.sourceforge.net.'
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent, ctags_cmd, ctags_output)
let s:checked_ctags = 2
return 0
else
let s:checked_ctags = 1
return 1
endif
endfunction
" s:CtagsErrMsg() {{{2
function! s:CtagsErrMsg(errmsg, infomsg, silent, ...) abort
call tagbar#debug#log(a:errmsg)
let ctags_cmd = a:0 > 0 ? a:1 : ''
let ctags_output = a:0 > 1 ? a:2 : ''
let exit_code_set = a:0 > 2
if exit_code_set
let exit_code = a:3
endif
if !a:silent
call s:warning(a:errmsg)
echomsg a:infomsg
if ctags_cmd ==# ''
return
endif
echomsg 'Executed command: "' . ctags_cmd . '"'
if ctags_output !=# ''
echomsg 'Command output:'
for line in split(ctags_output, '\n')
echomsg line
endfor
else
echomsg 'Command output is empty.'
endif
if exit_code_set
echomsg 'Exit code: ' . exit_code
endif
endif
endfunction
" s:CheckExCtagsVersion() {{{2
function! s:CheckExCtagsVersion(output) abort
call tagbar#debug#log('Checking Exuberant Ctags version')
if a:output =~? 'Universal Ctags'
call tagbar#debug#log('Found Universal Ctags, assuming compatibility')
let s:ctags_is_uctags = 1
return 1
endif
if a:output =~? 'Exuberant Ctags compatiable PHP enhancement'
call tagbar#debug#log('Found phpctags, assuming compatibility')
return 1
endif
if a:output =~? 'Exuberant Ctags Development'
call tagbar#debug#log('Found development version, assuming compatibility')
return 1
endif
let matchlist = matchlist(a:output, '\vExuberant Ctags (\d+)\.(\d+)')
let major = matchlist[1]
let minor = matchlist[2]
call tagbar#debug#log("Ctags version: major='" . major . "', minor='" . minor . "'")
return major >= 6 || (major == 5 && minor >= 5)
endfunction
" s:CheckFTCtags() {{{2
function! s:CheckFTCtags(bin, ftype) abort
if exists('g:tagbar_type_' . a:ftype)
let userdef = g:tagbar_type_{a:ftype}
if has_key(userdef, 'kinds')
return ''
elseif has_key(userdef, 'ctagsbin')
return userdef.ctagsbin
endif
endif
if executable(a:bin)
return a:bin
endif
return ''
endfunction
" s:GetSupportedFiletypes() {{{2
function! s:GetSupportedFiletypes() abort
call tagbar#debug#log('Getting filetypes supported by Exuberant Ctags')
let ctags_cmd = s:EscapeCtagsCmd(g:tagbar_ctags_bin, '--list-languages')
if ctags_cmd ==# ''
return
endif
let ctags_output = s:ExecuteCtags(ctags_cmd)
if s:shell_error
" this shouldn't happen as potential problems would have already been
" caught by the previous ctags checking
return
endif
let types = split(ctags_output, '\n\+')
let supported_types = {}
for type in types
if match(type, '\[disabled\]') == -1
let supported_types[tolower(type)] = 1
endif
endfor
return supported_types
endfunction
" Known files {{{1
let s:known_files = {
\ '_files' : {}
\ }
" s:known_files.get() {{{2
function! s:known_files.get(fname) abort dict
return get(self._files, a:fname, {})
endfunction
" s:known_files.put() {{{2
" Optional second argument is the filename
function! s:known_files.put(fileinfo, ...) abort dict
if a:0 == 1
let self._files[a:1] = a:fileinfo
else
let fname = a:fileinfo.fpath
let self._files[fname] = a:fileinfo
endif
endfunction
" s:known_files.has() {{{2
function! s:known_files.has(fname) abort dict
return has_key(self._files, a:fname)
endfunction
" s:known_files.rm() {{{2
function! s:known_files.rm(fname) abort dict
if s:known_files.has(a:fname)
call tagbar#debug#log('Removing fileinfo for [' . a:fname . ']')
call remove(self._files, a:fname)
endif
endfunction
" Window management {{{1
" s:ToggleWindow() {{{2
function! s:ToggleWindow(flags) abort
call tagbar#debug#log('ToggleWindow called')
let tagbarwinnr = bufwinnr(s:TagbarBufName())
if tagbarwinnr != -1
call s:CloseWindow()
return
endif
call s:OpenWindow(a:flags)
call tagbar#debug#log('ToggleWindow finished')
endfunction
" s:OpenWindow() {{{2
function! s:OpenWindow(flags) abort
call tagbar#debug#log("OpenWindow called with flags: '" . a:flags . "'")
let autofocus = a:flags =~# 'f'
let jump = a:flags =~# 'j'
let autoclose = a:flags =~# 'c'
let curfile = fnamemodify(bufname('%'), ':p')
let curline = line('.')
" If the tagbar window is already open check jump flag
" Also set the autoclose flag if requested
let tagbarwinnr = bufwinnr(s:TagbarBufName())
if tagbarwinnr != -1
if winnr() != tagbarwinnr && jump
call s:goto_win(tagbarwinnr)
call s:HighlightTag(g:tagbar_autoshowtag != 2, 1, 1, curline)
endif
call tagbar#debug#log('OpenWindow finished, Tagbar already open')
return
endif
" Use the window ID if the functionality exists, this is more reliable
" since the window number can change due to the Tagbar window opening
if exists('*win_getid')
let prevwinid = win_getid()
if winnr('$') > 1
call s:goto_win('p', 1)
let pprevwinid = win_getid()
call s:goto_win('p', 1)
endif
else
let prevwinnr = winnr()
if winnr('$') > 1
call s:goto_win('p', 1)
let pprevwinnr = winnr()
call s:goto_win('p', 1)
endif
endif
" This is only needed for the CorrectFocusOnStartup() function
let s:last_autofocus = autofocus
if !s:Init(0)
return 0
endif
" Expand the Vim window to accommodate for the Tagbar window if requested
" and save the window positions to be able to restore them later.
if g:tagbar_expand >= 1 && !s:window_expanded &&
\ (has('gui_running') || g:tagbar_expand == 2)
let s:window_pos.pre.x = getwinposx()
let s:window_pos.pre.y = getwinposy()
let &columns += g:tagbar_width + 1
let s:window_pos.post.x = getwinposx()
let s:window_pos.post.y = getwinposy()
let s:window_expanded = 1
endif
let s:window_opening = 1
if g:tagbar_position =~# 'vertical'
let size = g:tagbar_width
let mode = 'vertical '
else
let size = g:tagbar_height
let mode = ''
endif
exe 'silent keepalt ' . g:tagbar_position . size . 'split ' . s:TagbarBufName()
exe 'silent ' . mode . 'resize ' . size
unlet s:window_opening
call s:InitWindow(autoclose)
" If the current file exists, but is empty, it means that it had a
" processing error before opening the window, most likely due to a call to
" currenttag() in the statusline. Remove the entry so an error message
" will be shown if the processing still fails.
if empty(s:known_files.get(curfile))
call s:known_files.rm(curfile)
endif
call s:AutoUpdate(curfile, 0)
call s:HighlightTag(g:tagbar_autoshowtag != 2, 1, 1, curline)
if !(g:tagbar_autoclose || autofocus || g:tagbar_autofocus)
if exists('*win_getid')
if exists('pprevwinid')
noautocmd call win_gotoid(pprevwinid)
endif
call win_gotoid(prevwinid)
else
" If the Tagbar winnr is identical to one of the saved values
" then that means that the window numbers have changed.
" Just jump back to the previous window since we won't be able to
" restore the window history.
if winnr() == prevwinnr
\ || (exists('pprevwinnr') && winnr() == pprevwinnr)
call s:goto_win('p')
else
if exists('pprevwinnr')
call s:goto_win(pprevwinnr, 1)
endif
call s:goto_win(prevwinnr)
endif
endif
endif
call tagbar#debug#log('OpenWindow finished')
endfunction
" s:InitWindow() {{{2
function! s:InitWindow(autoclose) abort
call tagbar#debug#log('InitWindow called with autoclose: ' . a:autoclose)
" Buffer-local options
setlocal filetype=tagbar
setlocal noreadonly " in case the "view" mode is used
setlocal buftype=nofile
setlocal bufhidden=hide
setlocal noswapfile
setlocal nobuflisted
setlocal nomodifiable
setlocal textwidth=0
setlocal colorcolumn=""
if g:tagbar_scrolloff > 0
execute 'setlocal scrolloff=' . g:tagbar_scrolloff
endif
if g:tagbar_show_balloon == 1 && has('balloon_eval')