From 9bdfb49d08232b9c226cbdc31fe4a820696bb597 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Karl=20Yngve=20Lerv=C3=A5g?= <karl.yngve+git@gmail.com>
Date: Sat, 7 Nov 2015 23:28:03 +0100
Subject: [PATCH] Updated initialization of default mappings

Now a default mapping is not created if the user has defined a custom mapping
for the corresponding <plug>(vimtex-...) mapping.
---
 autoload/vimtex.vim | 131 +++++++++++++++++++++++---------------------
 doc/vimtex.txt      |  28 +++++++---
 2 files changed, 88 insertions(+), 71 deletions(-)

diff --git a/autoload/vimtex.vim b/autoload/vimtex.vim
index 077dc25..6928ed1 100644
--- a/autoload/vimtex.vim
+++ b/autoload/vimtex.vim
@@ -183,6 +183,7 @@ function! s:init_buffer() " {{{1
   "
   " Attach autocommands
   "
+
   augroup vimtex_buffers
     au BufFilePre  <buffer> call s:filename_changed_pre()
     au BufFilePost <buffer> call s:filename_changed_post()
@@ -195,84 +196,90 @@ endfunction
 function! s:init_mappings() " {{{1
   if !get(g:,'vimtex_mappings_enabled', 1) | return | endif
 
-  nmap <silent><buffer> <localleader>li <plug>(vimtex-info)
+  function! s:map(mode, lhs, rhs)
+    if !hasmapto(a:rhs, a:mode)
+      silent execute a:mode . 'map <silent><buffer>' a:lhs a:rhs
+    endif
+  endfunction
 
-  nmap <silent><buffer> dse  <plug>(vimtex-delete-env)
-  nmap <silent><buffer> dsc  <plug>(vimtex-delete-cmd)
-  nmap <silent><buffer> cse  <plug>(vimtex-change-env)
-  nmap <silent><buffer> csc  <plug>(vimtex-change-cmd)
-  nmap <silent><buffer> tse  <plug>(vimtex-toggle-star)
-  nmap <silent><buffer> tsd  <plug>(vimtex-toggle-delim)
-  nmap <silent><buffer> <F7> <plug>(vimtex-create-cmd)
-  imap <silent><buffer> <F7> <plug>(vimtex-create-cmd)
-  imap <silent><buffer> ]]   <plug>(vimtex-close-env)
+  call s:map('n', '<localleader>li', '<plug>(vimtex-info)')
+
+  call s:map('n', 'dse', '<plug>(vimtex-delete-env)')
+  call s:map('n', 'dsc', '<plug>(vimtex-delete-cmd)')
+  call s:map('n', 'cse', '<plug>(vimtex-change-env)')
+  call s:map('n', 'csc', '<plug>(vimtex-change-cmd)')
+  call s:map('n', 'tse', '<plug>(vimtex-toggle-star)')
+  call s:map('n', 'tsd', '<plug>(vimtex-toggle-delim)')
+  call s:map('n', '<F7>', '<plug>(vimtex-create-cmd)')
+  call s:map('i', '<F7>', '<plug>(vimtex-create-cmd)')
+  call s:map('i', ']]', '<plug>(vimtex-close-env)')
 
   if g:vimtex_latexmk_enabled
-    nmap <silent><buffer> <localleader>ll <plug>(vimtex-compile-toggle)
-    nmap <silent><buffer> <localleader>lo <plug>(vimtex-compile-output)
-    nmap <silent><buffer> <localleader>lk <plug>(vimtex-stop)
-    nmap <silent><buffer> <localleader>lK <plug>(vimtex-stop-all)
-    nmap <silent><buffer> <localleader>le <plug>(vimtex-errors)
-    nmap <silent><buffer> <localleader>lc <plug>(vimtex-clean)
-    nmap <silent><buffer> <localleader>lC <plug>(vimtex-clean-full)
-    nmap <silent><buffer> <localleader>lg <plug>(vimtex-status)
-    nmap <silent><buffer> <localleader>lG <plug>(vimtex-status-all)
+    call s:map('n', '<localleader>ll', '<plug>(vimtex-compile-toggle)')
+    call s:map('n', '<localleader>lo', '<plug>(vimtex-compile-output)')
+    call s:map('n', '<localleader>lk', '<plug>(vimtex-stop)')
+    call s:map('n', '<localleader>lK', '<plug>(vimtex-stop-all)')
+    call s:map('n', '<localleader>le', '<plug>(vimtex-errors)')
+    call s:map('n', '<localleader>lc', '<plug>(vimtex-clean)')
+    call s:map('n', '<localleader>lC', '<plug>(vimtex-clean-full)')
+    call s:map('n', '<localleader>lg', '<plug>(vimtex-status)')
+    call s:map('n', '<localleader>lG', '<plug>(vimtex-status-all)')
   endif
 
   if g:vimtex_motion_enabled
-    nmap <silent><buffer> %  <plug>(vimtex-%)
-    xmap <silent><buffer> %  <plug>(vimtex-%)
-    omap <silent><buffer> %  <plug>(vimtex-%)
-    nmap <silent><buffer> }  <plug>(vimtex-})
-    nmap <silent><buffer> {  <plug>(vimtex-{)
-    xmap <silent><buffer> }  <plug>(vimtex-})
-    xmap <silent><buffer> {  <plug>(vimtex-{)
-    omap <silent><buffer> }  <plug>(vimtex-})
-    omap <silent><buffer> {  <plug>(vimtex-{)
-    xmap <silent><buffer> ip <plug>(vimtex-ip)
-    xmap <silent><buffer> ap <plug>(vimtex-ap)
-    omap <silent><buffer> ip <plug>(vimtex-ip)
-    omap <silent><buffer> ap <plug>(vimtex-ap)
-    nmap <silent><buffer> ]] <plug>(vimtex-]])
-    nmap <silent><buffer> ][ <plug>(vimtex-][)
-    nmap <silent><buffer> [] <plug>(vimtex-[])
-    nmap <silent><buffer> [[ <plug>(vimtex-[[)
-    xmap <silent><buffer> ]] <plug>(vimtex-]])
-    xmap <silent><buffer> ][ <plug>(vimtex-][)
-    xmap <silent><buffer> [] <plug>(vimtex-[])
-    xmap <silent><buffer> [[ <plug>(vimtex-[[)
-    omap <silent><buffer> ]] <plug>(vimtex-]])
-    omap <silent><buffer> ][ <plug>(vimtex-][)
-    omap <silent><buffer> [] <plug>(vimtex-[])
-    omap <silent><buffer> [[ <plug>(vimtex-[[)
-    xmap <silent><buffer> ie <plug>(vimtex-ie)
-    xmap <silent><buffer> ae <plug>(vimtex-ae)
-    omap <silent><buffer> ie <plug>(vimtex-ie)
-    omap <silent><buffer> ae <plug>(vimtex-ae)
-    xmap <silent><buffer> i$ <plug>(vimtex-i$)
-    xmap <silent><buffer> a$ <plug>(vimtex-a$)
-    omap <silent><buffer> i$ <plug>(vimtex-i$)
-    omap <silent><buffer> a$ <plug>(vimtex-a$)
-    xmap <silent><buffer> id <plug>(vimtex-id)
-    xmap <silent><buffer> ad <plug>(vimtex-ad)
-    omap <silent><buffer> id <plug>(vimtex-id)
-    omap <silent><buffer> ad <plug>(vimtex-ad)
+    call s:map('n', '%', '<plug>(vimtex-%)')
+    call s:map('x', '%', '<plug>(vimtex-%)')
+    call s:map('o', '%', '<plug>(vimtex-%)')
+    call s:map('n', '}', '<plug>(vimtex-})')
+    call s:map('n', '{', '<plug>(vimtex-{)')
+    call s:map('x', '}', '<plug>(vimtex-})')
+    call s:map('x', '{', '<plug>(vimtex-{)')
+    call s:map('o', '}', '<plug>(vimtex-})')
+    call s:map('o', '{', '<plug>(vimtex-{)')
+    call s:map('n', ']]', '<plug>(vimtex-]])')
+    call s:map('n', '][', '<plug>(vimtex-][)')
+    call s:map('n', '[]', '<plug>(vimtex-[])')
+    call s:map('n', '[[', '<plug>(vimtex-[[)')
+    call s:map('x', ']]', '<plug>(vimtex-]])')
+    call s:map('x', '][', '<plug>(vimtex-][)')
+    call s:map('x', '[]', '<plug>(vimtex-[])')
+    call s:map('x', '[[', '<plug>(vimtex-[[)')
+    call s:map('o', ']]', '<plug>(vimtex-]])')
+    call s:map('o', '][', '<plug>(vimtex-][)')
+    call s:map('o', '[]', '<plug>(vimtex-[])')
+    call s:map('o', '[[', '<plug>(vimtex-[[)')
+    call s:map('x', 'ie', '<plug>(vimtex-ie)')
+    call s:map('x', 'ae', '<plug>(vimtex-ae)')
+    call s:map('o', 'ie', '<plug>(vimtex-ie)')
+    call s:map('o', 'ae', '<plug>(vimtex-ae)')
+    call s:map('x', 'i$', '<plug>(vimtex-i$)')
+    call s:map('x', 'a$', '<plug>(vimtex-a$)')
+    call s:map('o', 'i$', '<plug>(vimtex-i$)')
+    call s:map('o', 'a$', '<plug>(vimtex-a$)')
+    call s:map('x', 'id', '<plug>(vimtex-id)')
+    call s:map('x', 'ad', '<plug>(vimtex-ad)')
+    call s:map('o', 'id', '<plug>(vimtex-id)')
+    call s:map('o', 'ad', '<plug>(vimtex-ad)')
+    call s:map('x', 'ip', '<plug>(vimtex-ip)')
+    call s:map('x', 'ap', '<plug>(vimtex-ap)')
+    call s:map('o', 'ip', '<plug>(vimtex-ip)')
+    call s:map('o', 'ap', '<plug>(vimtex-ap)')
   endif
 
   if g:vimtex_toc_enabled
-    nmap <silent><buffer> <localleader>lt <plug>(vimtex-toc-open)
-    nmap <silent><buffer> <localleader>lT <plug>(vimtex-toc-toggle)
+    call s:map('n', '<localleader>lt', '<plug>(vimtex-toc-open)')
+    call s:map('n', '<localleader>lT', '<plug>(vimtex-toc-toggle)')
   endif
 
   if g:vimtex_labels_enabled
-    nmap <silent><buffer> <localleader>ly <plug>(vimtex-labels-open)
-    nmap <silent><buffer> <localleader>lY <plug>(vimtex-labels-toggle)
+    call s:map('n', '<localleader>ly', '<plug>(vimtex-labels-open)')
+    call s:map('n', '<localleader>lY', '<plug>(vimtex-labels-toggle)')
   endif
 
   if g:vimtex_view_enabled
-    nmap <silent><buffer> <localleader>lv <plug>(vimtex-view)
+    call s:map('n', '<localleader>lv', '<plug>(vimtex-view)')
     if has_key(b:vimtex.viewer, 'reverse_search')
-      nmap <silent><buffer> <localleader>lr <plug>(vimtex-reverse-search)
+      call s:map('n', '<localleader>lr', '<plug>(vimtex-reverse-search)')
     endif
   endif
 endfunction
diff --git a/doc/vimtex.txt b/doc/vimtex.txt
index fbb95db..27f121b 100644
--- a/doc/vimtex.txt
+++ b/doc/vimtex.txt
@@ -244,22 +244,32 @@ USAGE                                                            *vimtex-usage*
 Default mappings~
                                                       *vimtex-default-mappings*
 
-|vimtex| is designed to be controlled by a selection of mappings.  The default
-mappings are listed below.  Most of the mappings are also available as
-commands, see |vimtex-commands|.
+|vimtex| is designed to be controlled by a selection of mappings.  Note,
+though, that most of the mappings are also available as commands, see
+|vimtex-commands|.
 
-In addition to the mappings listed below, |vimtex| provides convenient insert
-mode mappings to make it easier and faster to type mathematical equations.
-This feature is explained in more detail later, see |vimtex-imaps|.
+Many of the mappings utilize the |maplocalleader|. The right-hand sides are
+provided as <plug>-mappings, see |using-<plug>|. For any given <plug> map, the
+default mapping will only be created if it does not already exist. This means
+that if a user defines a custom mapping, e.g. with >
 
-If one prefers, one may disable the default mappings through the option
-|g:vimtex_mappings_enabled|.  One can then define custom mappings through the
-listed RHS <plug>-maps or by mapping the available commands.
+  nmap <space>li <plug>(vimtex-info)
+
+then the corresponding default left-hand side will not be mapped.
+
+If one prefers, one may disable all the default mappings through the option
+|g:vimtex_mappings_enabled|.  One must then define custom mappings for all
+desired features through the listed RHS <plug>-maps or by mapping the
+available commands.
 
 In the below list of mappings, LHS is the default mapping, RHS is the
 corresponding <plug>-maps, and MODE indicates in which vim mode the mappings
 are valid.
 
+In addition to the mappings listed below, |vimtex| provides convenient insert
+mode mappings to make it easier and faster to type mathematical equations.
+This feature is explained in more detail later, see |vimtex-imaps|.
+
   -----------------------------------------------------------~
    LHS              RHS                                 MODE~
   -----------------------------------------------------------~