feat(Mapping): automatically remap duplicate

This commit fix @Vixyd comment,
There is no more warning for duplicate during startup,
Duplicates found at runtime are reported on the message section
(background).

The only counter intuitive case would be if user-defined and automatic
key maps are mixed (unlikely). In this case, if a user-defined key map
is already in use by a previous automatically assigned item, the
user-defined key map is ignored (and a warning is raised).
This would be costly to check and is now documented.

Author: CharlesGueunet

README.md

@@ -34,12 +34,15 @@ let g:quickmenu_options = "HL"
 Simply use the function below:
 
 ```VimL
-function quickmenu#append(text, action [, help = ''])
+function quickmenu#append(text, action [, help = ''][, ft = ''][, weight = 0][, key = ''])
 ```
 
 - `text` will be show in the quickmenu, vimscript in `%{...}` will be evaluated and expanded.
 - `action` is a piece of vimscript to be executed when a item is selected.
 - `help` will display in the cmdline if g:quickmenu_options contains `H`.
+- 'ft' will filter this item only for matching filetypes
+- 'weight' menu items will be sorted according to the weight
+- 'key' use this key as shortcut if not already assigned
 
 A item will be treated as "static text" (unselectable) If `action` is empty. `text` starting with "#" represents a new section.
 

autoload/quickmenu.vim

@@ -37,10 +37,6 @@ if !exists('g:quickmenu_options')
 	let g:quickmenu_options = ''
 endif
 
-if !exists('g:quickmenu_special_keys')
-	let g:quickmenu_special_keys = 1
-endif
-
 "----------------------------------------------------------------------
 " Internal State
 "----------------------------------------------------------------------
@@ -53,20 +49,6 @@ let s:quickmenu_name = '[quickmenu]'
 let s:quickmenu_line = 0
 let s:quickmenu_custom_keys = {}
 
-function! s:reset_key_map()
-    let s:quickmenu_custom_keys = {}
-	if g:quickmenu_special_keys == 1
-		" Prevent user to bind special keys
-		let s:quickmenu_custom_keys['g']=1
-		let s:quickmenu_custom_keys['G']=1
-		let s:quickmenu_custom_keys['j']=1
-		let s:quickmenu_custom_keys['k']=1
-		let s:quickmenu_custom_keys['q']=1
-	endif
-endfunction
-
-call s:reset_key_map()
-
 "----------------------------------------------------------------------
 " popup window management
 "----------------------------------------------------------------------
@@ -143,29 +125,28 @@ function! quickmenu#reset()
 	let s:quickmenu_items[s:quickmenu_mid] = []
 	let s:quickmenu_line = 0
 	let s:quickmenu_cursor[s:quickmenu_mid] = 0
-	call s:reset_key_map()
 endfunc
 
 function! quickmenu#append(text, event, ...)
 	let help = (a:0 >= 1)? a:1 : ''
 	let filetype = (a:0 >= 2)? a:2 : ''
 	let weight = (a:0 >= 3)? a:3 : 0
 	let item = {}
-	let item.key = ''
-	if a:0 >= 4
-		if has_key(s:quickmenu_custom_keys, a:4)
-			call s:errmsg("Quickmenu: Found duplicate binding for key ".a:4)
-		else
-			let item.key = a:4
-			let s:quickmenu_custom_keys[a:4]=1
-		endif
-    endif
+
 	let item.mode = 0
 	let item.event = a:event
 	let item.text = a:text
-	let item.ft = []
+
+	let item.key = ''
+	if a:0 >= 4
+		let item.key = a:4
+		" all used keys for this panel
+		let s:quickmenu_custom_keys[a:4]=1
+	endif
+
 	let item.weight = weight
 	let item.help = help
+
 	if a:event != ''
 		let item.mode = 0
 	elseif a:text[0] != '#'
@@ -174,9 +155,12 @@ function! quickmenu#append(text, event, ...)
 		let item.mode = 2
 		let item.text = matchstr(a:text, '^#\+\s*\zs.*')
 	endif
+
+	let item.ft = []
 	for ft in split(filetype, ',')
 		let item.ft += [substitute(ft, '^\s*\(.\{-}\)\s*$', '\1', '')]
 	endfor
+
 	let index = -1
 	if !has_key(s:quickmenu_items, s:quickmenu_mid)
 		let s:quickmenu_items[s:quickmenu_mid] = []
@@ -199,7 +183,6 @@ endfunc
 
 function! quickmenu#current(mid)
 	let s:quickmenu_mid = a:mid
-	call s:reset_key_map()
 endfunc
 
 
@@ -378,7 +361,7 @@ function! s:set_cursor() abort
 		let find = select - 2
 	endif
 	if find < 0
-		call s:errmsg("fatal error in set_cursor() ".find)
+		call s:start_error_message("Quickmenu: fatal error in set_cursor() ".find)
 		return 
 	endif
 	let s:quickmenu_line = find + 2
@@ -453,6 +436,7 @@ endfunc
 " select items by &ft, generate keymap and add some default items
 "----------------------------------------------------------------------
 function! s:select_by_ft(mid, ft) abort
+   let duplicate_key_check = {}
 	let hint = '123456789abcdefhilmnoprstuvwxyzACDIOPQRSUX*'
 	" let hint = '12abcdefhlmnoprstuvwxyz*'
 	let items = []
@@ -478,9 +462,14 @@ function! s:select_by_ft(mid, ft) abort
 		let lastmode = item.mode
 		" allocate key for non-filetype specific items
 		if item.mode == 0 && len(item.ft) == 0
+			" discard already used mapping
+			if has_key(duplicate_key_check, item.key)
+				call s:run_error_message("Quickmenu: duplicate mapping for ".item.key)
+				let item.key = ''
+			endif
 			if item.key == ''
-				" Avdoid to remap existing key
-				while has_key(s:quickmenu_custom_keys, hint[index]) && index < strlen(hint)-1
+				" Avdoid to remap already used mapping
+				while has_key(duplicate_key_check, hint[index]) && index < strlen(hint)-1
 					let index += 1
 				endwhile
 				let item.key = hint[index]
@@ -489,6 +478,7 @@ function! s:select_by_ft(mid, ft) abort
 					let index = strlen(hint) - 1
 				endif
 			endif
+			let duplicate_key_check[item.key] = 1
 		endif
 		let items += [item]
 		if item.mode == 2 
@@ -500,9 +490,14 @@ function! s:select_by_ft(mid, ft) abort
 	" allocate key for filetype specific items
 	for item in items
 		if item.mode == 0 && len(item.ft) > 0
+			" discard already used mapping
+			if has_key(duplicate_key_check, item.key)
+				call s:run_error_message("Quickmenu: duplicate mapping for ".item.key)
+				let item.key = ''
+			endif
 			if item.key == ''
-				" Avdoid to remap existing key
-				while has_key(s:quickmenu_custom_keys, hint[index]) && index < strlen(hint)-1
+				" Avdoid to remap already used mapping
+				while has_key(duplicate_key_check, hint[index]) && index < strlen(hint)-1
 					let index += 1
 				endwhile
 				let item.key = hint[index]
@@ -511,6 +506,8 @@ function! s:select_by_ft(mid, ft) abort
 					let index = strlen(hint) - 1
 				endif
 			endif
+			" keep all used keys
+			let duplicate_key_check[item.key] = 1
 		endif
 	endfor
 	if len(items)
@@ -663,12 +660,16 @@ endfunc
 "----------------------------------------------------------------------
 " echo a error msg
 "----------------------------------------------------------------------
-function! s:errmsg(msg)
+function! s:start_error_message(msg)
 	echohl ErrorMsg
 	echo a:msg
 	echohl None
 endfunc
 
+function! s:run_error_message(msg)
+	echom a:msg
+endfunc
+
 
 "----------------------------------------------------------------------
 " echo highlight