xoi / vertfind Goto Github PK

vertfind is Vim plugin for vertical search.

For example the cursor moves from A to B by typing "<Leader>f" under following mapping.
A means position in the brackets to the right of 'A' character.
The same is true in B's case.

  noremap <expr> <Leader>f vertfind#Find('z')

  zzz A[x] zzz
  zzzxxxxxxzzz
  zzz B[z] zzz

==============================================================================
Functions:

vertfind#Find({pattern} [, {flags}])
		Search for vertical pattern {pattern}.

		{pattern} is a String or a List.  See Vertical pattern.

		{flags} is a String, which can contain these character flags:
		'b'	search backward instead of forward

vertfind#SmartFind([{flags}])
		Search for vertical pattern which suit the situation.

		{flags} is used like with vertfind#Find().

==============================================================================
Vertical pattern:

Vertical pattern is a String or a List.
The forms are following.

  {pattern}
  [{pattern}, ...]
  [[{flags}, {pattern}], ...]

{pattern} is a String, which is a regexp pattern.
When vertical pattern is a List this is a multiple lines pattern.
Vertical pattern {pattern} is equivalent to [{pattern}].
Vertical pattern [{pattern}, ...] is equivalent to [['', {pattern}], ...].

{flags} is a String, which can contain these character flags:
'<'	declare next element anchoring point
'!'	invert the sense of matching
'q'	interpret {pattern} as a fixed string

==============================================================================
Example setting:

  noremap <expr> f<C-@> vertfind#Find(['\S', ['!', '\S']])
  noremap <expr> F<C-@> vertfind#Find(['\S', ['!', '\S']], 'b')
  noremap <expr> f<C-V> vertfind#Find('\S')
  noremap <expr> F<C-V> vertfind#Find('\S', 'b')
  noremap <expr> f<C-L> vertfind#Find([['q', nr2char(getchar())]])
  noremap <expr> F<C-L> vertfind#Find([['q', nr2char(getchar())]], 'b')
  noremap <expr> f<C-B> vertfind#Find('[^' . escape(getline(".")[col(".") - 1], '\') . ']')
  noremap <expr> F<C-B> vertfind#Find('[^' . escape(getline(".")[col(".") - 1], '\') . ']', 'b')
  noremap f<C-A> f
  noremap F<C-A> F
  noremap <expr> <M-j> vertfind#SmartFind()
  noremap <expr> <M-k> vertfind#SmartFind('b')