Home

Awesome

PATTERN COMPLETE

by Ingo Karkat

DESCRIPTION

This plugin offers completions that either use the last search pattern or query for a regular expression, and then offer all matches for completion.

Without this plugin, you can just directly insert the contents of the last search pattern register via CTRL-R /, but the register can contain <word> boundary characters from a star search or other non-literal regexp atoms like \V, .*, etc., which you usually don't want inserted into the text.

SEE ALSO

USAGE

CTRL-X /                Use a "/"-delimited (g:PatternComplete_DelimitersPattern)
                        /{pattern}/ base before the cursor, or (if no such
                        base) the WORD before the cursor and allow further
                        refinement (press <Enter> to accept, <C-U> to discard
                        and enter something else, or just edit the preset), or
                        (if only whitespace before cursor) first query for
                        {pattern} (press <Enter> to conclude), and find
                        matches for {pattern}.
{Visual}CTRL-X /        The completion finds matches for the selected pattern.

CTRL-X *                Like above, but find matches for whole \<{pattern}\>,
                        or {pattern} surrounded by whitespace as a fallback.

{Visual}CTRL-X *        Find whole word (or whole WORD as a fallback) matches
                        for the selected pattern.

CTRL-X &                Find matches for the last search pattern, quote/.

CTRL-R &                Insert first match for the last search pattern
                        quote/ into the command-line.

CTRL-X ?                Find matches, reusing the {pattern} from the last
                        pattern completion.

CTRL-X g/               Like above, but instead of offering matches as
{Visual}CTRL-X g/       completion candidates, find common substrings and turn
CTRL-X g*               all matches into a Bash-like Brace Expression.
{Visual}CTRL-X g*       For example, /\<f\w\+\>/ yields foobar, fooxy and foon.
CTRL-X g&               Those will be inserted as foo{bar,xy,n}.
CTRL-X g?

INSTALLATION

The code is hosted in a Git repo at https://github.com/inkarkat/vim-PatternComplete You can use your favorite plugin manager, or "git clone" into a directory used for Vim packages. Releases are on the "stable" branch, the latest unstable development snapshot on "master".

This script is also packaged as a vimball. If you have the "gunzip" decompressor in your PATH, simply edit the *.vmb.gz package in Vim; otherwise, decompress the archive first, e.g. using WinZip. Inside Vim, install by sourcing the vimball or via the :UseVimball command.

vim PatternComplete*.vmb.gz
:so %

To uninstall, use the :RmVimball command.

DEPENDENCIES

CONFIGURATION

For a permanent configuration, put the following commands into your vimrc:

By default, the 'complete' option controls which buffers will be scanned for completion candidates. You can override that either for the entire plugin, or only for particular buffers; see CompleteHelper_complete for supported values.

let g:PatternComplete_complete = '.,w,b,u'

The possible regular expression delimiters for a /{pattern}/ base before the cursor (for i_CTRL-X_/ and i_CTRL-X_star) can be configured as a pattern:

let g:PatternComplete_DelimitersPattern = '[/?#@]'

Set to an empty string to disable the special parsing of delimited {patterns}.

The Brace Expression can be created according to strict rules that allow a expansion into the original matches:

let g:PatternComplete_AsBraceOptions = {'strict': 1}

By default, a different algorithm is chosen that trades full equivalence (between expression and substrings) for a shorter syntax that is better to understand:

let g:PatternComplete_AsBraceOptions = {'short': 1}

If you want to use different mappings, map your keys to the Plug>(PatternComplete) mapping targets before sourcing the script (e.g. in your vimrc):

imap <C-x>/ <Plug>(PatternCompleteInput)
imap <C-x>* <Plug>(PatternCompleteWordInput)
vmap <C-x>/ <Plug>(PatternCompleteInput)
vmap <C-x>* <Plug>(PatternCompleteWordInput)
imap <C-x>& <Plug>(PatternCompleteSearch)
cmap <C-r>& <Plug>(PatternCompleteSearchMatch)
imap <C-x>? <Plug>(PatternCompleteLast)

If you don't want the mappings that return all matches as a single Bash-like Brace Expression, you can disable them all at once via:

let g:PatternComplete_EnableBraceMappings = 0

Alternatively, you can tweak or disable them all individually, too:

imap <C-x>g/ <Plug>(PatternCompleteInputAsBrace)
imap <C-x>g* <Plug>(PatternCompleteWordInputAsBrace)
vmap <C-x>g/ <Plug>(PatternCompleteInputAsBrace)
vmap <C-x>g* <Plug>(PatternCompleteWordInputAsBrace)
imap <C-x>g& <Plug>(PatternCompleteSearchAsBrace)
imap <C-x>g? <Plug>(PatternCompleteLastAsBrace)

CONTRIBUTING

Report any bugs, send patches, or suggest features via the issue tracker at https://github.com/inkarkat/vim-PatternComplete/issues or email (address below).

HISTORY

1.20 RELEASEME
1.10 16-Sep-2017
1.02 28-Apr-2016
1.01 15-Jul-2013
1.00 01-Oct-2012
0.01 03-Oct-2011

Copyright: (C) 2011-2017 Ingo Karkat - The VIM LICENSE applies to this plugin.

Maintainer: Ingo Karkat ingo@karkat.de