-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
704 lines (532 loc) · 25.1 KB
/
README
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
<<<<<<< HEAD
This is a mirror of http://www.vim.org/scripts/script.php?script_id=1984
Repository:
https://bitbucket.org/ns9tks/vim-fuzzyfinder/
Issues:
http://bitbucket.org/ns9tks/vim-fuzzyfinder/issues/
Download latest(development) version
https://bitbucket.org/ns9tks/vim-fuzzyfinder/get/tip.zip
Sceenshot:
Buffer mode:
http://cdn.bitbucket.org/ns9tks/vim-fuzzyfinder/downloads/fuzzyfinder-buffer.png
File mode (searching from all files in vim runtime directories using abbreviation/multiple-search)
http://cdn.bitbucket.org/ns9tks/vim-fuzzyfinder/downloads/fuzzyfinder-file-abbrev.png
==============================================================================
INTRODUCTION *fuf-introduction*
FuzzyFinder provides convenient ways to quickly reach the
buffer/file/command/bookmark/tag you want. FuzzyFinder searches with the
fuzzy/partial pattern to which it converted an entered pattern.
Entered pattern Fuzzy pattern Partial pattern ~
>
abc *a*b*c* *abc*
dir/file dir/*f*i*l*e* dir/*file*
d*r/file d*r/*f*i*l*e* d*r/*file*
../**/s ../**/*s* ../**/*s*
(** allows searching a directory tree.)
<
You will be happy when:
"./AhLongLongLongLongLongFile.txt"
"./AhLongLongLongLongLongName.txt"
"./OhLongLongLongLongLongFile.txt"
"./OhLongLongLongLongLongName.txt" <- you want :O
Type "ON" and "OhLongLongLongLongLongName.txt" will be selected. :D
FuzzyFinder can search:
- buffers
- files
- directories
- most recently used files
- files around most recently used files
- most recently used command-lines
- bookmarked files
- bookmarked directories
- tags
- files which are included in current tagfiles
- jump list
- change list
- buffer lines
- quickfix
- help
FuzzyFinder also provides APIs to use its system of searching files or
selecting items.
FuzzyFinder supports multibyte characters.
==============================================================================
INSTALLATION *fuf-installation*
=======
This is a mirror of http://www.vim.org/scripts/script.php?script_id=3252
Repository:
https://bitbucket.org/ns9tks/vim-l9/
Issues:
http://bitbucket.org/ns9tks/vim-l9/issues/
Download latest(development) version
https://bitbucket.org/ns9tks/vim-l9/get/tip.zip
==============================================================================
INTRODUCTION *l9-introduction*
l9 is a Vim-script library, which provides some utility functions and commands
for programming in Vim.
==============================================================================
INSTALLATION *l9-installation*
>>>>>>> c822b05ee0886f9a9703227dc85a6d47612c4bf1
Put all files into your runtime directory. If you have the zip file, extract
it to your runtime directory.
You should place the files as follows:
>
<<<<<<< HEAD
<your runtime directory>/plugin/fuf.vim
<your runtime directory>/doc/fuf.txt
=======
<your runtime directory>/plugin/l9.vim
<your runtime directory>/doc/l9.txt
>>>>>>> c822b05ee0886f9a9703227dc85a6d47612c4bf1
...
<
If you are disgusted to make your runtime directory confused with a lot of
plugins, put each of the plugins into a directory individually and just add
the directory path to 'runtimepath'. It's easy to uninstall plugins.
Then update your help tags files to enable help for this plugin. See
|add-local-help| for details.
<<<<<<< HEAD
Requirements: ~
- L9 library (vimscript #3252)
==============================================================================
USAGE *fuf-usage*
You can launch FuzzyFinder by the following commands:
Command Mode ~
|:FufBuffer| - Buffer mode (|fuf-buffer-mode|)
|:FufFile| - File mode (|fuf-file-mode|)
|:FufCoverageFile| - Coverage-File mode (|fuf-coveragefile-mode|)
|:FufDir| - Directory mode (|fuf-dir-mode|)
|:FufMruFile| - MRU-File mode (|fuf-mrufile-mode|)
|:FufMruCmd| - MRU-Command mode (|fuf-mrucmd-mode|)
|:FufBookmarkFile| - Bookmark-File mode (|fuf-bookmarkfile-mode|)
|:FufBookmarkDir| - Bookmark-Dir mode (|fuf-bookmarkdir-mode|)
|:FufTag| - Tag mode (|fuf-tag-mode|)
|:FufBufferTag| - Buffer-Tag mode (|fuf-buffertag-mode|)
|:FufTaggedFile| - Tagged-File mode (|fuf-taggedfile-mode|)
|:FufJumpList| - Jump-List mode (|fuf-jumplist-mode|)
|:FufChangeList| - Change-List mode (|fuf-changelist-mode|)
|:FufQuickfix| - Quickfix mode (|fuf-quickfix-mode|)
|:FufLine| - Line mode (|fuf-line-mode|)
|:FufHelp| - Help mode (|fuf-help-mode|)
It is recommended to map these commands.
These commands open 1-line buffer to enter search pattern and start insert
mode.
FuzzyFinder searchs for matching items with an entered pattern and shows them
in a completion menu. For more details on pattern matching, see
|fuf-search-patterns|.
If there are a lot of matching items, FuzzyFinder limits the number of
enumerating items (|g:fuf_enumeratingLimit|) to speed up a response time, and
highlights the pattern with "Error" group.
The first item in the completion menu will be selected automatically.
Typing <C-w> deletes one block of an entered pattern before the cursor, like a
directory name.
with <C-s> (|g:fuf_keyPrevPattern|) and <C-^> (|g:fuf_keyNextPattern|), You
can recall patterns which have been entered before from history.
You can open a selected item in various ways:
<CR> (|g:fuf_keyOpen|) - opens in a previous window.
<C-j> (|g:fuf_keyOpenSplit|) - opens in a split window.
<C-k> (|g:fuf_keyOpenVsplit|) - opens in a vertical-split window.
<C-l> (|g:fuf_keyOpenTabpage|) - opens in a new tab page.
To cancel and return to previous window, just leave Insert mode.
With <C-\><C-\> (|g:fuf_keySwitchMatching|), You can switch search method
between fuzzy matching and partial matching.
With <C-t> (|g:fuf_keyNextMode|) and <C-y> (|g:fuf_keyPrevMode|), You can
switch current mode without leaving Insert mode .
You can preview selected item with <C-@> (|g:fuf_keyPreview|) in some modes.
Repeating the key on the same item shows another information. The height
of command-line area is changed to |g:fuf_previewHeight| when you launch a
mode supporting preview. This feature is available when |g:fuf_previewHeight|
is not 0.
==============================================================================
MODES *fuf-modes*
*fuf-buffer-mode*
Buffer mode ~
This mode provides an interface to select a buffer from a list of existing
buffers and open it.
Press <C-]> (|g:fuf_buffer_keyDelete|) in this mode and selected buffer will
be deleted.
*fuf-file-mode*
File mode ~
This mode provides an interface to search a file tree for a file and open it.
*fuf-coveragefile-mode*
Coverage-File mode ~
This mode provides an interface to select a file from all files of a preset
coverage and open it.
By default, This mode lists all files under the current working directory
recursively. (|g:fuf_coveragefile_globPatterns|)
If you want to search other coverage, execute |FufCoverageFileRegister|
command to register new search coverage and |FufCoverageFileChange| command to
choose a search coverage and launch Coverage-File mode.
In addition, there is another way to change a search coverage with
|fuf#setOneTimeVariables()| function.
Example: search only .h and .c files:
>
call fuf#setOneTimeVariables(['g:fuf_coveragefile_globPatterns', ['**/*.h', '**/*.c']])
\ | FufCoverageFile
<
Example: search your home directory in addition to the default coverage:
>
call fuf#setOneTimeVariables(['g:fuf_coveragefile_globPatterns', g:fuf_coveragefile_globPatterns + ['~/**/.*', '~/**/*']])
\ | FufCoverageFile
<
*fuf-dir-mode*
Directory mode ~
This mode provides an interface to search a file tree for a directory and
change the current directory.
*fuf-mrufile-mode*
MRU-File mode ~
This mode provides an interface to select a file from the most recently used
files and open it.
Press <C-]> (|g:fuf_mrufile_keyExpand|) in this mode and files around the most
recently used files are listed. Each time the key is pressed, the search range
are expanded one level along the directory tree upwardly/downwardly.
This mode is set to disable by default (|g:fuf_modesDisable|) because
processes for this mode in |BufEnter| and |BufWritePost| could cause
Performance issue.
See also: |FufMruFileInCwd|
*fuf-mrucmd-mode*
MRU-Command mode ~
This mode provides an interface to select a command from the most recently
used commands and execute it.
This mode is set to disable by default (|g:fuf_modesDisable|) because mapping
<CR> of Command-line mode required by this mode has side effects.
*fuf-bookmarkfile-mode*
Bookmark-File mode ~
This mode provides an interface to select one of the bookmarks you have added
beforehand and jump there.
You can add a cursor line to bookmarks by |:FufBookmarkFileAdd| command.
Execute that command and you will be prompted to enter a bookmark name.
FuzzyFinder adjusts a line number for jump. If a line of bookmarked position
does not match to a pattern when the bookmark was added, FuzzyFinder searches
a matching line around bookmarked position. So you can jump to a bookmarked
line even if the line is out of bookmarked position. If you want to jump to
bookmarked line number without the adjustment, set
|g:fuf_bookmarkfile_searchRange| option to 0.
Press <C-]> (|g:fuf_bookmarkfile_keyDelete|) in this mode and selected
bookmark will be deleted.
*fuf-bookmarkdir-mode*
Bookmark-Dir mode ~
This mode provides an interface to select one of the bookmarks you have added
beforehand and change the current directory.
You can add a directory to bookmarks by |:FufBookmarkDirAdd| command. Execute
that command and you will be prompted to enter a directory path and a
bookmark name.
Press <C-]> (|g:fuf_bookmarkdir_keyDelete|) in this mode and selected bookmark
will be deleted.
*fuf-tag-mode*
Tag mode ~
This mode provides an interface to select a tag and jump to the definition of
it.
Following mapping is a replacement for <C-]>:
>
noremap <silent> <C-]> :FufTagWithCursorWord!<CR>
<
*fuf-buffertag-mode*
Buffer-Tag mode ~
This mode provides an interface to select a tag of current buffer or all
buffers and jump to the definition of it.
Tag list is instantly created when FuzzyFinder is launched, so there is no
need to make tags file in advance.
|FufBufferTag| covers current buffer and |FufBufferTagAll| covers all buffers.
Following mapping is a replacement for <C-]>:
>
nnoremap <silent> <C-]> :FufBufferTagWithCursorWord!<CR>
vnoremap <silent> <C-]> :FufBufferTagAllWithSelectedText!<CR>
<
or
>
nnoremap <silent> <C-]> :FufBufferTagAllWithCursorWord!<CR>
vnoremap <silent> <C-]> :FufBufferTagAllWithSelectedText!<CR>
<
This mode is inspired by taglist.vim (vimscript #273) and refered its codes.
*fuf-taggedfile-mode*
Tagged-File mode ~
This mode provides an interface to select one of the files which are included
in current tagfiles and open it.
*fuf-jumplist-mode*
Jump-List mode ~
This mode provides an interface to select one from the |jumplist| of the
current window and jump there.
*fuf-changelist-mode*
Change-List mode ~
This mode provides an interface to select one from the |changelist| of the
current buffer and jump there.
*fuf-quickfix-mode*
Quickfix mode ~
This mode provides an interface to select one from the |quickfix| list and
jump there.
*fuf-line-mode*
Line mode ~
This mode provides an interface to select a line from current buffer and jump
there.
*fuf-help-mode*
Help mode ~
This mode provides an interface to select a help tag and jump to the help
page.
*fuf-givenfile-mode*
Given-File mode ~
This mode provides an API to open a selected file from a given list.
API function:
>
function fuf#givenfile#launch(
\ initialPattern, partialMatching, prompt, items)
<
initialPattern - String which is inserted after launching
FuzzyFinder.
partialMatching - If non-zero, enable partial matching instead of
fuzzy matching.
prompt - Prompt string
items - List of items.
Example of use:
>
" Open one of your dotfiles.
call fuf#givenfile#launch('', 0, '>', split(glob('~/.*'), "\n"))
<
*fuf-givendir-mode*
Given-Directory mode ~
This mode provides an API to change current working directory to a selected
one from a given list.
API function:
>
function fuf#givendir#launch(
\ initialPattern, partialMatching, prompt, items)
<
initialPattern - String which is inserted after launching
FuzzyFinder.
partialMatching - If non-zero, enable partial matching instead of
fuzzy matching.
prompt - Prompt string
items - List of items.
Example of use:
>
" Change current working directory to one of your runtime directory.
call fuf#givendir#launch('', 0, '>', split(&runtimepath, ','))
<
*fuf-givencmd-mode*
Given-Command mode ~
This mode provides an API to execute a selected command from a given list.
A selected command is executed by |feedkeys()|, so it is able to emulate a
series of key input in Normal mode.
API function:
>
function fuf#givencmd#launch(
\ initialPattern, partialMatching, prompt, items)
<
initialPattern - String which is inserted after launching
FuzzyFinder.
partialMatching - If non-zero, enable partial matching instead of
fuzzy matching.
prompt - Prompt string
items - List of items.
Example of use:
>
function GetAllCommands()
redir => commands
silent command
redir END
return map((split(commands, "\n")[3:]),
\ '":" . matchstr(v:val, ''^....\zs\S*'')')
endfunction
" execute one of the user-defined commands
call fuf#givencmd#launch('', 0, '>', GetAllCommands())
<
*fuf-callbackfile-mode*
Callback-File mode ~
This mode provides an API to find and get a file path which is selected by an
user.
API function:
>
function fuf#callbackfile#launch(
\ initialPattern, partialMatching, prompt, exclude, listener)
<
initialPattern - String which is inserted after launching
FuzzyFinder.
partialMatching - If non-zero, enable partial matching instead of
fuzzy matching.
prompt - Prompt string.
exclude - Regexp pattern for items which you want to exclude
from completion list.
listener - |Dictionary| which has 'onComplete' and 'onAbort'.
They are called at the end of FuzzyFinder.
listener.onComplete(item, method) is called with 2
arguments which are a name of selected item and a
number of open method when completed.
listener.onAbort() is called when aborted.
Example of use:
>
let listener = {}
function listener.onComplete(item, method)
echo "Item: " . a:item . "\nMethod: " . a:method
endfunction
function listener.onAbort()
echo "Abort"
endfunction
" Find a file from current working directory.
call fuf#callbackfile#launch('', 0, '>', '', listener)
" Find a file from home directory.
call fuf#callbackfile#launch('~/', 0, '>', '', listener)
<
*fuf-callbackitem-mode*
Callback-Item mode ~
This mode provides an API to get an item which is selected from a given list
by an user.
API function:
>
function fuf#callbackitem#launch(
\ initialPattern, partialMatching, prompt, listener, items, forPath)
<
initialPattern - String which is inserted after launching
FuzzyFinder.
partialMatching - If non-zero, enable partial matching instead of
fuzzy matching.
prompt - Prompt string
listener - |Dictionary| which has 'onComplete' and 'onAbort'.
They are called at the end of FuzzyFinder.
listener.onComplete(item, method) is called with 2
arguments which are a name of selected item and a
number of open method when completed.
listener.onAbort() is called when aborted.
items - List of items.
forPath - If non-zero, use a matching method for files.
Example of use:
>
let listener = {}
function listener.onComplete(item, method)
echo "Item: " . a:item . "\nMethod: " . a:method
endfunction
function listener.onAbort()
echo "Abort"
endfunction
" Select an item from a given list.
call fuf#callbackitem#launch('', 0, '>', listener, ['ed', 'vi', 'vim'], 0)
" Select a file from a given list.
call fuf#callbackitem#launch('', 0, '>', listener, ['../foo/bar', 'baz'], 1)
<
==============================================================================
DETAILED TOPICS *fuf-detailed-topics*
*fuf-setting-one-time-option* *fuf#setOneTimeVariables()*
Setting One-Time Options ~
If you want to set one-time options only for the next FuzzyFinder,
|fuf#setOneTimeVariables()| function will be of help. This function is used as
follows:
>
call fuf#setOneTimeVariables(['g:fuf_ignoreCase', 0], ['&lines', 50])
<
This function takes 0 or more arguments and each of them is a pair of a
variable name and its value. Specified options will be set practically next
time FuzzyFinder is launched, and restored when FuzzyFinder is closed.
*fuf-search-patterns*
Search Patterns ~
You can enter one primary pattern and zero or more refining patterns as search
patterns. An entered pattern is separated by ";" (|g:fuf_patternSeparator|),
and the first pattern is a primary pattern and the rest of patterns is a
refining pattern.
>
primary refining refining
|----------| |-------| |----|
>MruFile>bookmark.vim;autoload/;/home/
<
A refining pattern is used to narrow down the list of matching items by
another pattern.
With a primary pattern, FuzzyFinder does fuzzy matching or partial matching,
which you specified. With a refining pattern, FuzzyFinder does partial
matching by default. (|g:fuf_fuzzyRefining|)
When you enter a number as refining pattern, it also can match the index of
each item.
In a mode which targets a static set of file paths (such as Buffer or MRU-File
mode, not File or Directory) and |g:fuf_splitPathMatching| is non-zero,
matching with a primary pattern is divided into head part and tail part and
done individually.
>
head tail
|------||-----|
foo/bar/baz.vim
fuzzy matching example:
+----------------+---------+---------+---------+
| item \ pattern | foo/bar | foo/ | bar |
+----------------+---------+---------+---------+
| foo/bar | match | match | match |
| foo/abc | unmatch | match | unmatch |
| abc/bar | unmatch | unmatch | match |
| foobar | unmatch | unmatch | match |
| foooo/barrrr | match | match | match |
| foooo/fooooo | unmatch | match | unmatch |
+----------------+---------+---------+---------+
<
refining pattern can match anywhere on each path in the above case.
*fuf-sorting-of-completion-items*
Sorting Of Completion Items ~
FuzzyFinder sorts completion items with some rules.
An item, one part of which is matched with a whole pattern, is placed upper.
E.g., with the pattern "bc", the item "abc" is placed upper than "bac".
In the above case, items, each having matching part at the head of itself, are
placed upper than others. E.g., with the pattern "foo", the item "foobar" is
placed upper than "foobarbaz".
And the shorter the length of the item after matching position puts it higher.
E.g., with the pattern "bar", the item "foobar" is placed upper than
"foobarbaz".
If a pattern matches an item at only word boundaries of it, the item is placed
upper. E.g., with a pattern "fb", items such as "fooBarBaz" and "foo_bar_baz"
is placed upper.
Plus, FuzzyFinder has a learning system. An item which has been completed in
the past with current pattern is placed upper.
*fuf-reusing-window*
Reusing Of A Window Containing Target Buffer/File ~
If a window containing target buffer is found in current tab page when
FuzzyFinder is going to open the buffer in a split new window, move to it. If
a window containing target buffer is found in other tab page when FuzzyFinder
is going to open the buffer in a new tab page, move to it.
You can disable that feature via 'reuse_window' options if always want to open
a buffer in a new window.
*fuf-hiding-menu*
To Hide The Completion Menu Temporarily In FuzzyFinder ~
You can close it by <C-e> and reopen it by <C-x><C-o>.
*fuf-abbreviation* *fuf-multiple-search*
Abbreviations And Multiple Search ~
You can use abbreviations and multiple search in all modes by setting
|g:fuf_abbrevMap| option.
For example, set as below:
>
let g:fuf_abbrevMap = {
\ "^doc:" : [
\ "~/project/**/doc/",
\ ".vim/doc/",
\ ],
\ }
<
and enter "doc:txt" in File mode, then FuzzyFinder searches by the following
patterns:
"~/project/**/doc/*t*x*t*"
".vim/doc/*t*x*t*"
and show concatenated search results.
*fuf-data-file*
Data File ~
FuzzyFinder writes completion statistics, MRU data, bookmark, etc to files
under |g:fuf_dataDir|.
|:FufEditDataFile| command is helpful in editing your data files. This command
reads the data file in new unnamed buffer. Write the buffer and the data file
will be updated.
*fuf-cache*
Cache ~
Once a cache was created, It is not automatically updated to speed up the
response time by default. To update it, use |:FufRenewCache| command.
*fuf-dot-sequence*
Going Up Parent Directories With Dot Sequence ~
You can go up parent directories with entering dot sequence. Dot sequence
after a path separator is expanded to "../" sequence.
Dot sequence Expanded pattern ~
/.. /../
/... /../../
/.... /../../../
*fuf-how-to-add-mode*
How To Add Mode ~
To add "mymode" mode, put the source file at autoload/fuf/mymode.vim and call
fuf#addMode("mymode") .
*fuf-migemo*
What Is Migemo ~
Migemo is a search method for Japanese language.
=======
==============================================================================
USAGE *l9-usage*
See source code.
>>>>>>> c822b05ee0886f9a9703227dc85a6d47612c4bf1
==============================================================================