sponsor Vim development Vim logo Vim Book Ad

MotionComplete : Insert mode completion for chunks covered by queried {motion} or text object.

 script karma  Rating 0/0, Downloaded by 179    Comments, bugs, improvements  Vim wiki

created by
Ingo Karkat
 
script type
utility
 
description
DESCRIPTION
Most insert mode completions complete only the current word (or an entire
line), so one has to repeat i_CTRL-X_CTRL-N to complete the following words.
For longer completions, this is slow, especially because you sometimes have to
choose from multiple choices.
The completion provided by this plugin assumes that you know a Vim motion
(e.g. '3e', ')' or '/bar/e') or text object which covers the text you want
completed. When you invoke the completion, the completion base (some text
before the cursor, or the currently selected text) will be presented and the
motion to cover the completion text (including the completion base) will be
queried. Then, the list of completion candidates will be prepared and selected
in the usual way.

SEE ALSO
- Check out the CompleteHelper.vim plugin page (vimscript #3914) for a full
  list of insert mode completions powered by it.

USAGE
In insert mode, invoke the completion via CTRL-X CTRL-M.

This completion method is probably only used for longer matches, as
invoking this completion method with the querying of the {motion} isn't
very fast. For motions that cover many words or entire sentences, an empty
base isn't helpful, there would be far too many matches. To ensure a
completion base, this completion includes more than the usual keyword
characters directly before the cursor. It looks for the following before the
cursor, possibly with whitespace between it and the cursor:
- keyword character(s), e.g "foo" in "return (foo|"
- non-keyword non-whitespace character(s), e.g. "/*" in "return 0; /* |"
- keyword character(s) followed by non-keyword non-whitespace characters,
  e.g. "foo(" in "return foo(|"
When the completion base starts with a keyword character, matches must start
at a \<word border.
Alternatively, you can pre-select the base (via select or visual mode) before
invoking the completion. This ensures that the best context for completion is
chosen.

Input the {motion}.
You can then search forward and backward via CTRL-N / CTRL-P, as usual.

CTRL-X CTRL-M           The completion first queries for {motion} (press
                        <Enter> to conclude), then finds matches starting with
                        the MotionComplete-base text before the cursor,
                        covering {motion}.

{Visual}CTRL-X CTRL-M   The completion first queries for {motion} (press
                        <Enter> to conclude), then finds matches starting with
                        the selected text, covering {motion}.
                        Use this to define the completion base text (quickly
                        done from insert mode via [CTRL-]SHIFT-<Left>) for
                        better matches.

EXAMPLE
A quick|
       ^ cursor, just triggered motion completion.

(Somewhere else, a match:)
    v---v completion base
The quick brown fox jumps over the lazy dog.
    ^----------- "5w" --------^ completion via motion 5w
 
install details
INSTALLATION
This script is 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 MotionComplete*.vmb.gz
    :so %
To uninstall, use the :RmVimball command.

DEPENDENCIES
- Requires Vim 7.0 or higher.
- Requires the CompleteHelper.vim plugin (vimscript #3914).

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

Analoguous to the 'complete' option, you can specify which buffers will be
scanned for completion candidates. Currently, '.' (current buffer), and 'w'
(buffers from other windows) are supported.
    let g:MotionComplete_complete = '.,w'
The global setting can be overridden for a particular buffer
(b:MotionComplete_complete).

To avoid that huge amounts of text are offered for completion, the maximum
number of characters to be captured by {motion} is limited:
    let g:MotionComplete_maxCaptureLength = &columns * 3

To speed up the search and to avoid that many lines are offered for
completion, the maximum number of lines to be searched for /pattern/ and
?pattern? motions is limited:
    let g:MotionComplete_searchScopeLines = 5

If you want to use different mappings, map your keys to the
<Plug>(MotionComplete) mapping targets _before_ sourcing the script (e.g.
in your vimrc):
    imap <C-x><C-m> <Plug>(MotionComplete)
    xmap <C-x><C-m> <Plug>(MotionComplete)
    smap <C-x><C-m> <Plug>(MotionComplete)
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
MotionComplete-1.00.vmb.gz 1.00 2012-10-12 7.0 Ingo Karkat Initial upload
ip used for rating: 54.89.139.226

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
SourceForge.net Logo