label-mode: support multibyte labels

Useful especially with 'keymap'.
fix #246

Author: justinmk

autoload/sneak/label.vim

@@ -12,6 +12,16 @@ let s:matchmap = {}
 let s:match_ids = []
 let s:orig_conceal_matches = []
 
+if exists('*strcharpart')
+  func! s:strchar(s, i) abort
+    return strcharpart(a:s, a:i, 1)
+  endf
+else
+  func! s:strchar(s, i) abort
+    return matchstr(a:s, '.\{'.a:i.'\}\zs.')
+  endf
+endif
+
 func! s:placematch(c, pos) abort
   let s:matchmap[a:c] = a:pos
   let pat = '\%'.a:pos[0].'l\%'.a:pos[1].'c.'
@@ -76,8 +86,7 @@ func! s:do_label(s, v, reverse, label) abort "{{{
     endif
 
     if i < s:maxmarks
-      "TODO: multibyte-aware substring: matchstr('asdfäöü', '.\{4\}\zs.') https://github.com/Lokaltog/vim-easymotion/issues/16#issuecomment-34595066
-      let c = strpart(g:sneak#target_labels, i, 1)
+      let c = s:strchar(g:sneak#target_labels, i)
       call s:placematch(c, p)
     else "we have exhausted the target labels; grab the first non-labeled match.
       let overflow = p
@@ -107,7 +116,7 @@ func! s:do_label(s, v, reverse, label) abort "{{{
     call feedkeys(choice) "exit label-mode and fall through to Vim.
     return ""
   else "valid target was selected
-    let p = mappedtoNext ? s:matchmap[strpart(g:sneak#target_labels, 0, 1)] : s:matchmap[choice]
+    let p = mappedtoNext ? s:matchmap[s:strchar(g:sneak#target_labels, 0)] : s:matchmap[choice]
     call cursor(p[0], p[1])
   endif
 
@@ -202,23 +211,24 @@ func! s:is_special_key(key) abort
     \ || (g:sneak#opt.s_next && maparg(a:key, 'n') =~# '<Plug>Sneak\(_s\|Forward\)')
 endf
 
-"we must do this because:
-"  - we don't know which keys the user assigned to Sneak_;/Sneak_,
-"  - we need to reserve special keys like <Esc> and <Tab>
+" We must do this because:
+"  - Don't know which keys the user assigned to Sneak_;/Sneak_,
+"  - Must reserve special keys like <Esc> and <Tab>
 func! sneak#label#sanitize_target_labels() abort
-  let nrkeys = sneak#util#strlen(g:sneak#target_labels)
+  let nrbytes = len(g:sneak#target_labels)
   let i = 0
-  while i < nrkeys
+  while i < nrbytes
+    " Intentionally using byte-index for use with substitute().
     let k = strpart(g:sneak#target_labels, i, 1)
     if s:is_special_key(k) "remove the char
       let g:sneak#target_labels = substitute(g:sneak#target_labels, '\%'.(i+1).'c.', '', '')
-      "move ; (or s if 'clever-s' is enabled) to the front.
+      " Move ; (or s if 'clever-s' is enabled) to the front.
       if !g:sneak#opt.absolute_dir
             \ && ((!g:sneak#opt.s_next && maparg(k, 'n') =~# '<Plug>Sneak\(_;\|Next\)')
             \     || (maparg(k, 'n') =~# '<Plug>Sneak\(_s\|Forward\)'))
         let g:sneak#target_labels = k . g:sneak#target_labels
       else
-        let nrkeys -= 1
+        let nrbytes -= 1
         continue
       endif
     endif

doc/sneak.txt

@@ -148,9 +148,10 @@ NORMAL-MODE
 (previous) match. Additional matches are highlighted until the cursor is
 moved. Works across multiple lines.
 
-If a |language-mapping| is activated, Sneak waits for keymapped sequences as
-needed and searches for the keymapped result as expected. (Requires Vim 7.3+)
-'keymap' 'iminsert' |mbyte-keymap|
+If a |language-mapping| ('keymap') is active Sneak waits for keymapped
+sequences as needed and searches for the keymapped result as expected. You
+probably want to set |g:sneak#target_labels| to labels that make sense for
+your preferred 'keymap'.
 
 [count]s enters |sneak-vertical-scope| mode.
 
@@ -263,66 +264,65 @@ g:sneak#t_reset = 1
 
     Note: Defaults to 0 if you mapped f (or t) to any |sneak-mappings|.
 
-    0 : Pressing |f| (or |t|) will NOT clear the last Sneak search. So you could
-        define different maps for <Plug>Sneak_; or <Plug>Sneak_, and still
-        use ; and , for |f| and |t| as usual.
+    0: Pressing |f| (or |t|) will NOT clear the last Sneak search. So you could
+       define different maps for <Plug>Sneak_; or <Plug>Sneak_, and still
+       use ; and , for |f| and |t| as usual.
 
-    1 : Pressing |f| (or |t|) causes Sneak to "reset" so that |;| and |,| will apply
-        to the last f (or t) motion instead of the last s or S. This makes it
-        possible to use ; and , for all three motions (f, t, and s).
+    1: Pressing |f| (or |t|) causes Sneak to "reset" so that |;| and |,| will apply
+       to the last f (or t) motion instead of the last s or S. This makes it
+       possible to use ; and , for all three motions (f, t, and s).
 
-        Note: if f (or t) was already mapped by you or a plugin, Sneak will
-        not override the existing mapping unless you explicitly set f_reset
-        (or t_reset). This means Sneak will not be able to reset ; or , when
-        you invoke f or t. See the README.md FAQ regarding "f-enhancement"
-        plugins.
+       Note: if f (or t) was already mapped by you or a plugin, Sneak will
+       not override the existing mapping unless you explicitly set f_reset
+       (or t_reset). This means Sneak will not be able to reset ; or , when
+       you invoke f or t. See the README.md FAQ regarding "f-enhancement"
+       plugins.
 
 g:sneak#s_next = 0
 
-    0 : Disable |sneak-clever-s|.
+    0: Disable |sneak-clever-s|.
 
-    1 : Enable |sneak-clever-s|. It works like this: immediately after
-        invoking Sneak, press "s" _again_ to go to the next match, or "S" for
-        the previous match. This behavior persists until you move the cursor.
-        Note: You can still use |;| and |,| as usual.
+    1: Enable |sneak-clever-s|. It works like this: immediately after
+       invoking Sneak, press "s" _again_ to go to the next match, or "S" for
+       the previous match. This behavior persists until you move the cursor.
+       Note: You can still use |;| and |,| as usual.
 
 g:sneak#absolute_dir = 0
 
-    0 : Relative direction. |;| goes to the next match in the direction of the
-        initial s/S invocation and |,| goes in the opposite direction.
+    0: Relative direction. |;| goes to the next match in the direction of the
+       initial s/S invocation and |,| goes in the opposite direction.
 
-    1 : Absolute direction. Repeat via |;| or |,| always goes forwards or
-        backwards respectively.
-        Note: With |sneak-clever-s|, s and S behave the same as |;| and |,|.
+    1: Absolute direction. Repeat via |;| or |,| always goes forwards or
+       backwards respectively.
+       Note: With |sneak-clever-s|, s and S behave the same as |;| and |,|.
 
 g:sneak#use_ic_scs = 0
 
-    0 : Always case-sensitive
+    0: Always case-sensitive
 
-    1 : Case sensitivity is determined by 'ignorecase' and 'smartcase'.
+    1: Case sensitivity is determined by 'ignorecase' and 'smartcase'.
 
 g:sneak#map_netrw = 1
 
-    0 : Don't do any special handling of "file manager" buffers (such as
-        |netrw| or filebeagle).
+    0: Don't do any special handling of "file manager" buffers (such as
+       |netrw| or filebeagle).
 
-    1 : Set up Sneak mappings (s and S) in "file manager" buffers (|:Ex|,
-        |:Vex|, filebeagle) and replace the default buffer-local s and
-        S mappings with <leader>s and <leader>S.
+    1: Set up Sneak mappings (s and S) in "file manager" buffers (|:Ex|,
+       |:Vex|, filebeagle) and replace the default buffer-local s and
+       S mappings with <leader>s and <leader>S.
 
 g:sneak#label = 0
 
-    0 : Disable |sneak-label-mode|.
+    0: Disable |sneak-label-mode|.
 
-    1 : Enable |sneak-label-mode| if the Vim |+conceal| feature is available.
+    1: Enable |sneak-label-mode| if the Vim |+conceal| feature is available.
 
-                                                           *g:sneak#label_esc*
-g:sneak#label_esc = "\<Space>"
+g:sneak#label_esc = "\<Space>"                             *g:sneak#label_esc*
 
     Exit |sneak-label-mode| as if <Esc> were pressed.
         https://github.com/justinmk/vim-sneak/issues/122
 
-g:sneak#target_labels = ";sftunq/SFGHLTUNRMQZ?0"
+g:sneak#target_labels = ";sftunq/SFGHLTUNRMQZ?0"       *g:sneak#target_labels*
 
     List of characters used to label the target locations. |sneak-label-mode|
 

tests/test.vader

@@ -899,9 +899,9 @@ Expect:
   foo æfïïooæ ïoòôõïo ïïofoo fïxïooïo
 
 ###########################################################
-# test language keymap
+# 'keymap'
 
-Execute (activate language keymap):
+Execute (SETUP):
   set keymap=bulgarian-phonetic
 
 Given:
@@ -918,17 +918,37 @@ Expect:
   абцдё еёееёП ЯВЕРПО
   абцдёё еёееёП ЯВЕРПО
 
-Do (repeat search for multi-keymap):
+Do:
   se::e::;x
-Expect:
+Expect (repeat search for multi-keymap):
   abcdef abcdef abcdef
   абцдеф АБЦДЕФ абцдеф
   абцдёё еёееёП ЯВЕРПО
   абцдё еёееёП ЯВЕРПО
 
-Execute (deactivate language keymap):
+Execute (SETUP):
+  let g:sneak#target_labels = 'адсфгхйкл;'
+  let g:sneak#label = 1
+  call sneak#init()
+  call sneak#label#sanitize_target_labels()
+  Assert ';адсфгхйкл' ==# g:sneak#target_labels
+Given:
+  яверуипоо пасдфкййл;
+  яверуипоо пасдфкййл;
+  яверуипоо пасдфкййл;
+  яверуипоо пасдфкййл;
+  яверуипоо пасдфкййл;
+Do:
+  dzсдд
+Expect (keymap + label-mode + multibyte labels):
+  сдфкййл;
+  яверуипоо пасдфкййл;
+
+Execute (TEARDOWN):
   set iminsert=0
   set keymap=
+  let g:sneak#label = 0
+  call sneak#init()
 
 ###########################################################
 # Sneak_f and Sneak_t
@@ -1023,16 +1043,16 @@ Expect:
   ab7cdef ab8cdef ab9cdef ab0cdef ab1cdef ab2cdef
   ab1cdef ab2cdef ab3cdef ab4cdef ab5cdef ab6cdef
 
-Do (FIXME inclusive f-delete forward):
+Do:
   dvfe
-Expect:
+Expect (FIXME inclusive f-delete forward):
   ef ab2cdef ab3cdef ab4cdef ab5cdef ab6cdef
   ab7cdef ab8cdef ab9cdef ab0cdef ab1cdef ab2cdef
   ab1cdef ab2cdef ab3cdef ab4cdef ab5cdef ab6cdef
 
-Do (FIXME inclusive t-delete forward):
+Do:
   dvte
-Expect:
+Expect (FIXME inclusive t-delete forward):
   def ab2cdef ab3cdef ab4cdef ab5cdef ab6cdef
   ab7cdef ab8cdef ab9cdef ab0cdef ab1cdef ab2cdef
   ab1cdef ab2cdef ab3cdef ab4cdef ab5cdef ab6cdef
@@ -1090,7 +1110,7 @@ Given:
   abcdef abcdef abcdef
 
 # issue #35
-Do (sneak 'f', then Vim default 't', then sneak 'f'):
+Do (sneak f, then Vim default t, then sneak f):
   fderxtcrx
   :\<C-U>doautocmd CursorMoved\<CR>
   :\<C-U>doautocmd CursorMoved\<CR>