-
Notifications
You must be signed in to change notification settings - Fork 0
/
minibufexpl.vim
1838 lines (1630 loc) · 66.5 KB
/
minibufexpl.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
" Mini Buffer Explorer <minibufexpl.vim>
"
" HINT: Type zR if you don't know how to use folds
"
" Script Info and Documentation {{{
"=============================================================================
" Copyright: Copyright (C) 2002 & 2003 Bindu Wavell
" 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,
" minibufexplorer.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.
"
" Name Of File: minibufexpl.vim
" Description: Mini Buffer Explorer Vim Plugin
" Maintainer: Bindu Wavell <[email protected]>
" URL: http://vim.sourceforge.net/scripts/script.php?script_id=159
" Last Change: Sunday, June 21, 2004
" Version: 6.3.2
" Derived from Jeff Lanzarotta's bufexplorer.vim version 6.0.7
" Jeff can be reached at ([email protected]) and the
" original plugin can be found at:
" http://lanzarotta.tripod.com/vim/plugin/6/bufexplorer.vim.zip
"
" Usage: Normally, this file should reside in the plugins
" directory and be automatically sourced. If not, you must
" manually source this file using ':source minibufexplorer.vim'.
"
" You may use the default keymappings of
"
" <Leader>mbe - Opens MiniBufExplorer
"
" or you may want to add something like the following
" key mapping to your _vimrc/.vimrc file.
"
" map <Leader>b :MiniBufExplorer<cr>
"
" However, in most cases you won't need any key-bindings at all.
"
" <Leader> is usually backslash so type "\mbe" (quickly) to open
" the -MiniBufExplorer- window.
"
" Other keymappings include: <Leader>mbc to close the Explorer
" window, <Leader>mbu to force the Explorer to Update and
" <Leader>mbt to toggle the Explorer window; it will open if
" closed or close if open. Each of these key bindings can be
" overridden (see the notes on <Leader>mbe above.)
"
" You can map these additional commands as follows:
"
" map <Leader>c :CMiniBufExplorer<cr>
" map <Leader>u :UMiniBufExplorer<cr>
" map <Leader>t :TMiniBufExplorer<cr>
"
" NOTE: you can change the key binding used in these mappings
" so that they fit with your configuration of vim.
"
" You can also call each of these features by typing the
" following in command mode:
"
" :MiniBufExplorer " Open and/or goto Explorer
" :CMiniBufExplorer " Close the Explorer if it's open
" :UMiniBufExplorer " Update Explorer without navigating
" :TMiniBufExplorer " Toggle the Explorer window open and
" closed.
"
" To control where the new split window goes relative to the
" current window, use the setting:
"
" let g:miniBufExplSplitBelow=0 " Put new window above
" " current or on the
" " left for vertical split
" let g:miniBufExplSplitBelow=1 " Put new window below
" " current or on the
" " right for vertical split
"
" The default for this is read from the &splitbelow VIM option.
"
" By default we are now (as of 6.0.2) forcing the -MiniBufExplorer-
" window to open up at the edge of the screen. You can turn this
" off by setting the following variable in your .vimrc:
"
" let g:miniBufExplSplitToEdge = 0
"
" If you would like a vertical explorer you can assign the column
" width (in characters) you want for your explorer window with the
" following .vimrc variable (this was introduced in 6.3.0):
"
" let g:miniBufExplVSplit = 20 " column width in chars
"
" IN HORIZONTAL MODE:
" It is now (as of 6.1.1) possible to set a maximum height for
" the -MiniBufExplorer- window. You can set the max height by
" letting the following variable in your .vimrc:
"
" let g:miniBufExplMaxSize = <max lines: defualt 0>
"
" setting this to 0 will mean the window gets as big as
" needed to fit all your buffers.
"
" NOTE: This was g:miniBufExplMaxHeight before 6.3.0; the old
" setting is backwards compatible if you don't use MaxSize.
"
" As of 6.2.2 it is possible to set a minimum height for the
" -MiniBufExplorer- window. You can set the min height by
" letting the following variable in your .vimrc:
"
" let g:miniBufExplMinSize = <min height: default 1>
"
" NOTE: This was g:miniBufExplMinHeight before 6.3.0; the old
" setting is backwards compatible if you don't use MinSize.
"
" IN VERTICAL MODE: (as of 6.3.0)
" By default the vertical explorer has a fixed width. If you put:
"
" let g:miniBufExplMaxSize = <max width: default 0>
"
" into your .vimrc then MBE will attempt to set the width of the
" MBE window to be as wide as your widest tab. The width will not
" exceed MaxSize even if you have wider tabs.
"
" Accepting the default value of 0 for this will give you a fixed
" width MBE window.
"
" You can specify a MinSize for the vertical explorer window by
" putting the following in your .vimrc:
"
" let g:miniBufExplMinSize = <min width: default 1>
"
" This will have no effect unless you also specivy MaxSize.
"
" By default we are now (as of 6.0.1) turning on the MoreThanOne
" option. This stops the -MiniBufExplorer- from opening
" automatically until more than one eligible buffer is available.
" You can turn this feature off by setting the following variable
" in your .vimrc:
"
" let g:miniBufExplorerMoreThanOne=1
"
" (The following enhancement is as of 6.2.2)
" Setting this to 0 will cause the MBE window to be loaded even
" if no buffers are available. Setting it to 1 causes the MBE
" window to be loaded as soon as an eligible buffer is read. You
" can also set it to larger numbers. So if you set it to 4 for
" example the MBE window wouldn't auto-open until 4 eligibles
" buffers had been loaded. This is nice for folks that don't
" want an MBE window unless they are editing more than two or
" three buffers.
"
" To enable the optional mapping of Control + Vim Direction Keys
" [hjkl] to window movement commands, you can put the following into
" your .vimrc:
"
" let g:miniBufExplMapWindowNavVim = 1
"
" To enable the optional mapping of Control + Arrow Keys to window
" movement commands, you can put the following into your .vimrc:
"
" let g:miniBufExplMapWindowNavArrows = 1
"
" To enable the optional mapping of <C-TAB> and <C-S-TAB> to a
" function that will bring up the next or previous buffer in the
" current window, you can put the following into your .vimrc:
"
" let g:miniBufExplMapCTabSwitchBufs = 1
"
" To enable the optional mapping of <C-TAB> and <C-S-TAB> to mappings
" that will move to the next and previous (respectively) window, you
" can put the following into your .vimrc:
"
" let g:miniBufExplMapCTabSwitchWindows = 1
"
"
" NOTE: If you set the ...TabSwitchBufs AND ...TabSwitchWindows,
" ...TabSwitchBufs will be enabled and ...TabSwitchWindows
" will not.
"
" As of MBE 6.3.0, you can put the following into your .vimrc:
"
" let g:miniBufExplUseSingleClick = 1
"
" If you would like to single click on tabs rather than double
" clicking on them to goto the selected buffer.
"
" NOTE: If you use the single click option in taglist.vim you may
" need to get an updated version that includes a patch I
" provided to allow both explorers to provide single click
" buffer selection.
"
" It is possible to customize the the highlighting for the tabs in
" the MBE by configuring the following highlighting groups:
"
" MBENormal - for buffers that have NOT CHANGED and
" are NOT VISIBLE.
" MBEChanged - for buffers that HAVE CHANGED and are
" NOT VISIBLE
" MBEVisibleNormal - buffers that have NOT CHANGED and are
" VISIBLE
" MBEVisibleChanged - buffers that have CHANGED and are VISIBLE
"
" You can either link to an existing highlighting group by
" adding a command like:
"
" hi link MBEVisibleChanged Error
"
" to your .vimrc or you can specify exact foreground and background
" colors using the following syntax:
"
" hi MBEChanged guibg=darkblue ctermbg=darkblue termbg=white
"
" NOTE: If you set a colorscheme in your .vimrc you should do it
" BEFORE updating the MBE highlighting groups.
"
" If you use other explorers like TagList you can (As of 6.2.8) put:
"
" let g:miniBufExplModSelTarget = 1
"
" into your .vimrc in order to force MBE to try to place selected
" buffers into a window that does not have a nonmodifiable buffer.
" The upshot of this should be that if you go into MBE and select
" a buffer, the buffer should not show up in a window that is
" hosting an explorer.
"
" There is a VIM bug that can cause buffers to show up without
" their highlighting. The following setting will cause MBE to
" try and turn highlighting back on (introduced in 6.3.1):
"
" let g:miniBufExplForceSyntaxEnable = 1
"
" MBE has had a basic debugging capability for quite some time.
" However, it has not been very friendly in the past. As of 6.0.8,
" you can put one of each of the following into your .vimrc:
"
" let g:miniBufExplorerDebugLevel = 0 " MBE serious errors output
" let g:miniBufExplorerDebugLevel = 4 " MBE all errors output
" let g:miniBufExplorerDebugLevel = 10 " MBE reports everything
"
" You can also set a DebugMode to cause output to be target as
" follows (default is mode 3):
"
" let g:miniBufExplorerDebugMode = 0 " Errors will show up in
" " a vim window
" let g:miniBufExplorerDebugMode = 1 " Uses VIM's echo function
" " to display on the screen
" let g:miniBufExplorerDebugMode = 2 " Writes to a file
" " MiniBufExplorer.DBG
" let g:miniBufExplorerDebugMode = 3 " Store output in global:
" " g:miniBufExplorerDebugOutput
"
" Or if you are able to start VIM, you might just perform these
" at a command prompt right before you do the operation that is
" failing.
"
" History: Moved to end of file
"
" Known Issues: When debugging is turned on and set to output to a window, there
" are some cases where the window is opened more than once, there
" are other cases where an old debug window can be lost.
"
" Several MBE commands can break the window history so <C-W>[pnw]
" might not take you to the expected window.
"
" Todo: Add the ability to specify a regexp for eligible buffers
" allowing the ability to filter out certain buffers that
" you don't want to control from MBE
"
"=============================================================================
" }}}
" Startup Check
"
" Has this plugin already been loaded? {{{
"
if exists('loaded_minibufexplorer')
finish
endif
let loaded_minibufexplorer = 1
" }}}
" Mappings and Commands
"
" MBE Keyboard Mappings {{{
" If we don't already have keyboard mappings for MBE then create them
"
if !hasmapto('<Plug>MiniBufExplorer')
map <unique> <Leader>mbe <Plug>MiniBufExplorer
endif
if !hasmapto('<Plug>CMiniBufExplorer')
map <unique> <Leader>mbc <Plug>CMiniBufExplorer
endif
if !hasmapto('<Plug>UMiniBufExplorer')
map <unique> <Leader>mbu <Plug>UMiniBufExplorer
endif
if !hasmapto('<Plug>TMiniBufExplorer')
map <unique> <Leader>mbt <Plug>TMiniBufExplorer
endif
" }}}
" MBE <Script> internal map {{{
"
noremap <unique> <script> <Plug>MiniBufExplorer :call <SID>StartExplorer(1, -1)<CR>:<BS>
noremap <unique> <script> <Plug>CMiniBufExplorer :call <SID>StopExplorer(1)<CR>:<BS>
noremap <unique> <script> <Plug>UMiniBufExplorer :call <SID>AutoUpdate(-1)<CR>:<BS>
noremap <unique> <script> <Plug>TMiniBufExplorer :call <SID>ToggleExplorer()<CR>:<BS>
" }}}
" MBE commands {{{
"
if !exists(':MiniBufExplorer')
command! MiniBufExplorer call <SID>StartExplorer(1, -1)
endif
if !exists(':CMiniBufExplorer')
command! CMiniBufExplorer call <SID>StopExplorer(1)
endif
if !exists(':UMiniBufExplorer')
command! UMiniBufExplorer call <SID>AutoUpdate(-1)
endif
if !exists(':TMiniBufExplorer')
command! TMiniBufExplorer call <SID>ToggleExplorer()
endif
if !exists(':MBEbn')
command! MBEbn call <SID>CycleBuffer(1)
endif
if !exists(':MBEbp')
command! MBEbp call <SID>CycleBuffer(0)
endif " }}}
" Global Configuration Variables
"
" Debug Level {{{
"
" 0 = no logging
" 1=5 = errors ; 1 is the most important
" 5-9 = info ; 5 is the most important
" 10 = Entry/Exit
if !exists('g:miniBufExplorerDebugLevel')
let g:miniBufExplorerDebugLevel = 0
endif
" }}}
" Debug Mode {{{
"
" 0 = debug to a window
" 1 = use vim's echo facility
" 2 = write to a file named MiniBufExplorer.DBG
" in the directory where vim was started
" THIS IS VERY SLOW
" 3 = Write into g:miniBufExplorerDebugOutput
" global variable [This is the default]
if !exists('g:miniBufExplorerDebugMode')
let g:miniBufExplorerDebugMode = 3
endif
" }}}
" Allow auto update? {{{
"
" We start out with this off for startup, but once vim is running we
" turn this on.
if !exists('g:miniBufExplorerAutoUpdate')
let g:miniBufExplorerAutoUpdate = 0
endif
" }}}
" MoreThanOne? {{{
" Display Mini Buf Explorer when there are 'More Than One' eligible buffers
"
if !exists('g:miniBufExplorerMoreThanOne')
let g:miniBufExplorerMoreThanOne = 2
endif
" }}}
" Split below/above/left/right? {{{
" When opening a new -MiniBufExplorer- window, split the new windows below or
" above the current window? 1 = below, 0 = above.
"
if !exists('g:miniBufExplSplitBelow')
let g:miniBufExplSplitBelow = &splitbelow
endif
" }}}
" Split to edge? {{{
" When opening a new -MiniBufExplorer- window, split the new windows to the
" full edge? 1 = yes, 0 = no.
"
if !exists('g:miniBufExplSplitToEdge')
let g:miniBufExplSplitToEdge = 1
endif
" }}}
" MaxHeight (depreciated) {{{
" When sizing the -MiniBufExplorer- window, assign a maximum window height.
" 0 = size to fit all buffers, otherwise the value is number of lines for
" buffer. [Depreciated use g:miniBufExplMaxSize]
"
if !exists('g:miniBufExplMaxHeight')
let g:miniBufExplMaxHeight = 0
endif
" }}}
" MaxSize {{{
" Same as MaxHeight but also works for vertical splits if specified with a
" vertical split then vertical resizing will be performed. If left at 0
" then the number of columns in g:miniBufExplVSplit will be used as a
" static window width.
if !exists('g:miniBufExplMaxSize')
let g:miniBufExplMaxSize = g:miniBufExplMaxHeight
endif
" }}}
" MinHeight (depreciated) {{{
" When sizing the -MiniBufExplorer- window, assign a minumum window height.
" the value is minimum number of lines for buffer. Setting this to zero can
" cause strange height behavior. The default value is 1 [Depreciated use
" g:miniBufExplMinSize]
"
if !exists('g:miniBufExplMinHeight')
let g:miniBufExplMinHeight = 1
endif
" }}}
" MinSize {{{
" Same as MinHeight but also works for vertical splits. For vertical splits,
" this is ignored unless g:miniBufExplMax(Size|Height) are specified.
if !exists('g:miniBufExplMinSize')
let g:miniBufExplMinSize = g:miniBufExplMinHeight
endif
" }}}
" Horizontal or Vertical explorer? {{{
" For folks that like vertical explorers, I'm caving in and providing for
" veritcal splits. If this is set to 0 then the current horizontal
" splitting logic will be run. If however you want a vertical split,
" assign the width (in characters) you wish to assign to the MBE window.
"
if !exists('g:miniBufExplVSplit')
let g:miniBufExplVSplit = 0
endif
" }}}
" TabWrap? {{{
" By default line wrap is used (possibly breaking a tab name between two
" lines.) Turning this option on (setting it to 1) can take more screen
" space, but will make sure that each tab is on one and only one line.
"
if !exists('g:miniBufExplTabWrap')
let g:miniBufExplTabWrap = 0
endif
" }}}
" Extended window navigation commands? {{{
" Global flag to turn extended window navigation commands on or off
" enabled = 1, dissabled = 0
"
if !exists('g:miniBufExplMapWindowNav')
" This is for backwards compatibility and may be removed in a
" later release, please use the ...NavVim and/or ...NavArrows
" settings.
let g:miniBufExplMapWindowNav = 0
endif
if !exists('g:miniBufExplMapWindowNavVim')
let g:miniBufExplMapWindowNavVim = 0
endif
if !exists('g:miniBufExplMapWindowNavArrows')
let g:miniBufExplMapWindowNavArrows = 0
endif
if !exists('g:miniBufExplMapCTabSwitchBufs')
let g:miniBufExplMapCTabSwitchBufs = 0
endif
" Notice: that if CTabSwitchBufs is turned on then
" we turn off CTabSwitchWindows.
if g:miniBufExplMapCTabSwitchBufs == 1 || !exists('g:miniBufExplMapCTabSwitchWindows')
let g:miniBufExplMapCTabSwitchWindows = 0
endif
"
" If we have enabled control + vim direction key remapping
" then perform the remapping
"
" Notice: I left g:miniBufExplMapWindowNav in for backward
" compatibility. Eventually this mapping will be removed so
" please use the newer g:miniBufExplMapWindowNavVim setting.
if g:miniBufExplMapWindowNavVim || g:miniBufExplMapWindowNav
noremap <C-J> <C-W>j
noremap <C-K> <C-W>k
noremap <C-H> <C-W>h
noremap <C-L> <C-W>l
endif
"
" If we have enabled control + arrow key remapping
" then perform the remapping
"
if g:miniBufExplMapWindowNavArrows
noremap <C-Down> <C-W>j
noremap <C-Up> <C-W>k
noremap <C-Left> <C-W>h
noremap <C-Right> <C-W>l
endif
" If we have enabled <C-TAB> and <C-S-TAB> to switch buffers
" in the current window then perform the remapping
"
if g:miniBufExplMapCTabSwitchBufs
noremap <C-TAB> :call <SID>CycleBuffer(1)<CR>:<BS>
noremap <C-S-TAB> :call <SID>CycleBuffer(0)<CR>:<BS>
endif
"
" If we have enabled <C-TAB> and <C-S-TAB> to switch windows
" then perform the remapping
"
if g:miniBufExplMapCTabSwitchWindows
noremap <C-TAB> <C-W>w
noremap <C-S-TAB> <C-W>W
endif
" }}}
" Modifiable Select Target {{{
"
if !exists('g:miniBufExplModSelTarget')
let g:miniBufExplModSelTarget = 0
endif
"}}}
" Force Syntax Enable {{{
"
if !exists('g:miniBufExplForceSyntaxEnable')
let g:miniBufExplForceSyntaxEnable = 0
endif
" }}}
" Single/Double Click? {{{
" flag that can be set to 1 in a users .vimrc to allow
" single click switching of tabs. By default we use
" double click for tab selection.
"
if !exists('g:miniBufExplUseSingleClick')
let g:miniBufExplUseSingleClick = 0
endif
"
" attempt to perform single click mapping, it would be much
" nicer if we could nnoremap <buffer> ... however vim does
" not fire the <buffer> <leftmouse> when you use the mouse
" to enter a buffer.
"
if g:miniBufExplUseSingleClick == 1
let s:clickmap = ':if bufname("%") == "-MiniBufExplorer-" <bar> call <SID>MBEClick() <bar> endif <CR>'
if maparg('<LEFTMOUSE>', 'n') == ''
" no mapping for leftmouse
exec ':nnoremap <silent> <LEFTMOUSE> <LEFTMOUSE>' . s:clickmap
else
" we have a mapping
let g:miniBufExplDoneClickSave = 1
let s:m = ':nnoremap <silent> <LEFTMOUSE> <LEFTMOUSE>'
let s:m = s:m . substitute(substitute(maparg('<LEFTMOUSE>', 'n'), '|', '<bar>', 'g'), '\c^<LEFTMOUSE>', '', '')
let s:m = s:m . s:clickmap
exec s:m
endif
endif " }}}
" Variables used internally
"
" Script/Global variables {{{
" Global used to store the buffer list so we don't update the
" UI unless the list has changed.
if !exists('g:miniBufExplBufList')
let g:miniBufExplBufList = ''
endif
" Variable used as a mutex so that we don't do lots
" of AutoUpdates at the same time.
if !exists('g:miniBufExplInAutoUpdate')
let g:miniBufExplInAutoUpdate = 0
endif
" In debug mode 3 this variable will hold the debug output
if !exists('g:miniBufExplorerDebugOutput')
let g:miniBufExplorerDebugOutput = ''
endif
" In debug mode 3 this variable will hold the debug output
if !exists('g:miniBufExplForceDisplay')
let g:miniBufExplForceDisplay = 0
endif
" Variable used to pass maxTabWidth info between functions
let s:maxTabWidth = 0
" Variable used to count debug output lines
let s:debugIndex = 0
" }}}
" Setup an autocommand group and some autocommands {{{
" that keep our explorer updated automatically.
"
augroup MiniBufExplorer
autocmd MiniBufExplorer BufDelete * call <SID>DEBUG('-=> BufDelete AutoCmd', 10) |call <SID>AutoUpdate(expand('<abuf>'))
autocmd MiniBufExplorer BufEnter * call <SID>DEBUG('-=> BufEnter AutoCmd', 10) |call <SID>AutoUpdate(-1)
autocmd MiniBufExplorer VimEnter * call <SID>DEBUG('-=> VimEnter AutoCmd', 10) |let g:miniBufExplorerAutoUpdate = 1 |call <SID>AutoUpdate(-1)
" }}}
" Functions
"
" StartExplorer - Sets up our explorer and causes it to be displayed {{{
"
function! <SID>StartExplorer(sticky, delBufNum)
call <SID>DEBUG('===========================',10)
call <SID>DEBUG('Entering StartExplorer()' ,10)
call <SID>DEBUG('===========================',10)
if a:sticky == 1
let g:miniBufExplorerAutoUpdate = 1
endif
" Store the current buffer
let l:curBuf = bufnr('%')
" Prevent a report of our actions from showing up.
let l:save_rep = &report
let l:save_sc = &showcmd
let &report = 10000
set noshowcmd
call <SID>FindCreateWindow('-MiniBufExplorer-', -1, 1, 1)
" Make sure we are in our window
if bufname('%') != '-MiniBufExplorer-'
call <SID>DEBUG('StartExplorer called in invalid window',1)
let &report = l:save_rep
let &showcmd = l:save_sc
return
endif
" !!! We may want to make the following optional -- Bindu
" New windows don't cause all windows to be resized to equal sizes
set noequalalways
" !!! We may want to make the following optional -- Bindu
" We don't want the mouse to change focus without a click
set nomousefocus
" If folks turn numbering and columns on by default we will turn
" them off for the MBE window
setlocal foldcolumn=0
setlocal nonumber
if has("syntax")
syn clear
syn match MBENormal '\[[^\]]*\]'
syn match MBEChanged '\[[^\]]*\]+'
syn match MBEVisibleNormal '\[[^\]]*\]\*+\='
syn match MBEVisibleChanged '\[[^\]]*\]\*+'
if !exists("g:did_minibufexplorer_syntax_inits")
let g:did_minibufexplorer_syntax_inits = 1
hi def link MBENormal Comment
hi def link MBEChanged String
hi def link MBEVisibleNormal Special
hi def link MBEVisibleChanged Special
endif
endif
" If you press return in the -MiniBufExplorer- then try
" to open the selected buffer in the previous window.
nnoremap <buffer> <CR> :call <SID>MBESelectBuffer()<CR>:<BS>
" If you DoubleClick in the -MiniBufExplorer- then try
" to open the selected buffer in the previous window.
nnoremap <buffer> <2-LEFTMOUSE> :call <SID>MBEDoubleClick()<CR>:<BS>
" If you press d in the -MiniBufExplorer- then try to
" delete the selected buffer.
nnoremap <buffer> d :call <SID>MBEDeleteBuffer()<CR>:<BS>
" If you press w in the -MiniBufExplorer- then switch back
" to the previous window.
nnoremap <buffer> p :wincmd p<CR>:<BS>
" The following allow us to use regular movement keys to
" scroll in a wrapped single line buffer
nnoremap <buffer> j gj
nnoremap <buffer> k gk
nnoremap <buffer> <down> gj
nnoremap <buffer> <up> gk
" The following allows for quicker moving between buffer
" names in the [MBE] window it also saves the last-pattern
" and restores it.
nnoremap <buffer> <TAB> :call search('\[[0-9]*:[^\]]*\]')<CR>:<BS>
nnoremap <buffer> <S-TAB> :call search('\[[0-9]*:[^\]]*\]','b')<CR>:<BS>
call <SID>DisplayBuffers(a:delBufNum)
if (l:curBuf != -1)
call search('\['.l:curBuf.':'.expand('#'.l:curBuf.':t').'\]')
else
call <SID>DEBUG('No current buffer to search for',9)
endif
let &report = l:save_rep
let &showcmd = l:save_sc
call <SID>DEBUG('===========================',10)
call <SID>DEBUG('Completed StartExplorer()' ,10)
call <SID>DEBUG('===========================',10)
endfunction
" }}}
" StopExplorer - Looks for our explorer and closes the window if it is open {{{
"
function! <SID>StopExplorer(sticky)
call <SID>DEBUG('===========================',10)
call <SID>DEBUG('Entering StopExplorer()' ,10)
call <SID>DEBUG('===========================',10)
if a:sticky == 1
let g:miniBufExplorerAutoUpdate = 0
endif
let l:winNum = <SID>FindWindow('-MiniBufExplorer-', 1)
if l:winNum != -1
exec l:winNum.' wincmd w'
silent! close
wincmd p
endif
call <SID>DEBUG('===========================',10)
call <SID>DEBUG('Completed StopExplorer()' ,10)
call <SID>DEBUG('===========================',10)
endfunction
" }}}
" ToggleExplorer - Looks for our explorer and opens/closes the window {{{
"
function! <SID>ToggleExplorer()
call <SID>DEBUG('===========================',10)
call <SID>DEBUG('Entering ToggleExplorer()' ,10)
call <SID>DEBUG('===========================',10)
let g:miniBufExplorerAutoUpdate = 0
let l:winNum = <SID>FindWindow('-MiniBufExplorer-', 1)
if l:winNum != -1
call <SID>StopExplorer(1)
else
call <SID>StartExplorer(1, -1)
wincmd p
endif
call <SID>DEBUG('===========================',10)
call <SID>DEBUG('Completed ToggleExplorer()' ,10)
call <SID>DEBUG('===========================',10)
endfunction
" }}}
" FindWindow - Return the window number of a named buffer {{{
" If none is found then returns -1.
"
function! <SID>FindWindow(bufName, doDebug)
if a:doDebug
call <SID>DEBUG('Entering FindWindow()',10)
endif
" Try to find an existing window that contains
" our buffer.
let l:bufNum = bufnr(a:bufName)
if l:bufNum != -1
if a:doDebug
call <SID>DEBUG('Found buffer ('.a:bufName.'): '.l:bufNum,9)
endif
let l:winNum = bufwinnr(l:bufNum)
else
let l:winNum = -1
endif
return l:winNum
endfunction
" }}}
" FindCreateWindow - Attempts to find a window for a named buffer. {{{
"
" If it is found then moves there. Otherwise creates a new window and
" configures it and moves there.
"
" forceEdge, -1 use defaults, 0 below, 1 above
" isExplorer, 0 no, 1 yes
" doDebug, 0 no, 1 yes
"
function! <SID>FindCreateWindow(bufName, forceEdge, isExplorer, doDebug)
if a:doDebug
call <SID>DEBUG('Entering FindCreateWindow('.a:bufName.')',10)
endif
" Save the user's split setting.
let l:saveSplitBelow = &splitbelow
" Set to our new values.
let &splitbelow = g:miniBufExplSplitBelow
" Try to find an existing explorer window
let l:winNum = <SID>FindWindow(a:bufName, a:doDebug)
" If found goto the existing window, otherwise
" split open a new window.
if l:winNum != -1
if a:doDebug
call <SID>DEBUG('Found window ('.a:bufName.'): '.l:winNum,9)
endif
exec l:winNum.' wincmd w'
let l:winFound = 1
else
if g:miniBufExplSplitToEdge == 1 || a:forceEdge >= 0
let l:edge = &splitbelow
if a:forceEdge >= 0
let l:edge = a:forceEdge
endif
if l:edge
if g:miniBufExplVSplit == 0
exec 'bo sp '.a:bufName
else
exec 'bo vsp '.a:bufName
endif
else
if g:miniBufExplVSplit == 0
exec 'to sp '.a:bufName
else
exec 'to vsp '.a:bufName
endif
endif
else
if g:miniBufExplVSplit == 0
exec 'sp '.a:bufName
else
" &splitbelow doesn't affect vertical splits
" so we have to do this explicitly.. ugh.
if &splitbelow
exec 'rightb vsp '.a:bufName
else
exec 'vsp '.a:bufName
endif
endif
endif
let g:miniBufExplForceDisplay = 1
" Try to find an existing explorer window
let l:winNum = <SID>FindWindow(a:bufName, a:doDebug)
if l:winNum != -1
if a:doDebug
call <SID>DEBUG('Created and then found window ('.a:bufName.'): '.l:winNum,9)
endif
exec l:winNum.' wincmd w'
else
if a:doDebug
call <SID>DEBUG('FindCreateWindow failed to create window ('.a:bufName.').',1)
endif
return
endif
if a:isExplorer
" Turn off the swapfile, set the buffer type so that it won't get written,
" and so that it will get deleted when it gets hidden and turn on word wrap.
setlocal noswapfile
setlocal buftype=nofile
setlocal bufhidden=delete
if g:miniBufExplVSplit == 0
setlocal wrap
else
setlocal nowrap
exec('setlocal winwidth='.g:miniBufExplMinSize)
endif
endif
if a:doDebug
call <SID>DEBUG('Window ('.a:bufName.') created: '.winnr(),9)
endif
endif
" Restore the user's split setting.
let &splitbelow = l:saveSplitBelow
endfunction
" }}}
" DisplayBuffers - Wrapper for getting MBE window shown {{{
"
" Makes sure we are in our explorer, then erases the current buffer and turns
" it into a mini buffer explorer window.
"
function! <SID>DisplayBuffers(delBufNum)
call <SID>DEBUG('Entering DisplayBuffers()',10)
" Make sure we are in our window
if bufname('%') != '-MiniBufExplorer-'
call <SID>DEBUG('DisplayBuffers called in invalid window',1)
return
endif
" We need to be able to modify the buffer
setlocal modifiable
call <SID>ShowBuffers(a:delBufNum)
call <SID>ResizeWindow()
normal! zz
" Prevent the buffer from being modified.
setlocal nomodifiable
set nobuflisted
endfunction
" }}}
" Resize Window - Set width/height of MBE window {{{
"
" Makes sure we are in our explorer, then sets the height/width for our explorer
" window so that we can fit all of our information without taking extra lines.
"
function! <SID>ResizeWindow()
call <SID>DEBUG('Entering ResizeWindow()',10)
" Make sure we are in our window
if bufname('%') != '-MiniBufExplorer-'
call <SID>DEBUG('ResizeWindow called in invalid window',1)
return
endif
let l:width = winwidth('.')
" Horizontal Resize
if g:miniBufExplVSplit == 0
if g:miniBufExplTabWrap == 0
let l:length = strlen(getline('.'))
let l:height = 0
if (l:width == 0)
let l:height = winheight('.')
else
let l:height = (l:length / l:width)
" handle truncation from div
if (l:length % l:width) != 0
let l:height = l:height + 1
endif
endif
else
exec("setlocal textwidth=".l:width)
normal gg
normal gq}
normal G
let l:height = line('.')
normal gg
endif
" enforce max window height
if g:miniBufExplMaxSize != 0
if g:miniBufExplMaxSize < l:height
let l:height = g:miniBufExplMaxSize
endif
endif
" enfore min window height
if l:height < g:miniBufExplMinSize || l:height == 0
let l:height = g:miniBufExplMinSize
endif
call <SID>DEBUG('ResizeWindow to '.l:height.' lines',9)
exec('resize '.l:height)
" Vertical Resize
else
if g:miniBufExplMaxSize != 0
let l:newWidth = s:maxTabWidth
if l:newWidth > g:miniBufExplMaxSize
let l:newWidth = g:miniBufExplMaxSize
endif
if l:newWidth < g:miniBufExplMinSize
let l:newWidth = g:miniBufExplMinSize
endif
else
let l:newWidth = g:miniBufExplVSplit
endif
if l:width != l:newWidth
call <SID>DEBUG('ResizeWindow to '.l:newWidth.' columns',9)
exec('vertical resize '.l:newWidth)
endif
endif
endfunction