Skip to content

Add vimtex_mappings_prefix to configure leader mappings prefix #2611

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wintermute-cell wants to merge 2 commits into from
Closed

Add vimtex_mappings_prefix to configure leader mappings prefix #2611

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef08d60
add vimtex_mappings_prefix to configure leader mappings prefix
wintermute-cell Dec 30, 2022
ccf040c
use function to apply mapping prefix, including <localleader>, add do…
wintermute-cell Jan 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 29 additions & 23 deletions autoload/vimtex.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,17 +117,23 @@ function! s:init_buffer() abort " {{{1
endfor
endfunction

" }}}1
function! s:map_prefixed(ftype, mode, lhs, rhs) abort " {{{1
let l:lhs = g:vimtex_mappings_prefix . a:lhs
call s:map(a:ftype, a:mode, l:lhs, a:rhs)
endfunction

" }}}1
function! s:init_default_mappings() abort " {{{1
if !g:vimtex_mappings_enabled | return | endif

call s:map(0, 'n', '<localleader>li', '<plug>(vimtex-info)')
call s:map(0, 'n', '<localleader>lI', '<plug>(vimtex-info-full)')
call s:map(0, 'n', '<localleader>lx', '<plug>(vimtex-reload)')
call s:map(0, 'n', '<localleader>lX', '<plug>(vimtex-reload-state)')
call s:map(1, 'n', '<localleader>ls', '<plug>(vimtex-toggle-main)')
call s:map(0, 'n', '<localleader>lq', '<plug>(vimtex-log)')
call s:map(1, 'n', '<localleader>la', '<plug>(vimtex-context-menu)')
call s:map_prefixed(0, 'n', 'i', '<plug>(vimtex-info)')
call s:map_prefixed(0, 'n', 'I', '<plug>(vimtex-info-full)')
call s:map_prefixed(0, 'n', 'x', '<plug>(vimtex-reload)')
call s:map_prefixed(0, 'n', 'X', '<plug>(vimtex-reload-state)')
call s:map_prefixed(1, 'n', 's', '<plug>(vimtex-toggle-main)')
call s:map_prefixed(0, 'n', 'q', '<plug>(vimtex-log)')
call s:map_prefixed(1, 'n', 'a', '<plug>(vimtex-context-menu)')

call s:map(0, 'n', 'ds$', '<plug>(vimtex-env-delete-math)')
call s:map(0, 'n', 'cs$', '<plug>(vimtex-env-change-math)')
Expand Down Expand Up @@ -157,17 +163,17 @@ function! s:init_default_mappings() abort " {{{1
call s:map(0, 'n', '<F8>', '<plug>(vimtex-delim-add-modifiers)')

if g:vimtex_compiler_enabled
call s:map(0, 'n', '<localleader>ll', '<plug>(vimtex-compile)')
call s:map(0, 'n', '<localleader>lo', '<plug>(vimtex-compile-output)')
call s:map(1, 'n', '<localleader>lL', '<plug>(vimtex-compile-selected)')
call s:map(1, 'x', '<localleader>lL', '<plug>(vimtex-compile-selected)')
call s:map(0, 'n', '<localleader>lk', '<plug>(vimtex-stop)')
call s:map(0, 'n', '<localleader>lK', '<plug>(vimtex-stop-all)')
call s:map(0, 'n', '<localleader>le', '<plug>(vimtex-errors)')
call s:map(0, 'n', '<localleader>lc', '<plug>(vimtex-clean)')
call s:map(0, 'n', '<localleader>lC', '<plug>(vimtex-clean-full)')
call s:map(0, 'n', '<localleader>lg', '<plug>(vimtex-status)')
call s:map(0, 'n', '<localleader>lG', '<plug>(vimtex-status-all)')
call s:map_prefixed(0, 'n', 'l', '<plug>(vimtex-compile)')
call s:map_prefixed(0, 'n', 'o', '<plug>(vimtex-compile-output)')
call s:map_prefixed(1, 'n', 'L', '<plug>(vimtex-compile-selected)')
call s:map_prefixed(1, 'x', 'L', '<plug>(vimtex-compile-selected)')
call s:map_prefixed(0, 'n', 'k', '<plug>(vimtex-stop)')
call s:map_prefixed(0, 'n', 'K', '<plug>(vimtex-stop-all)')
call s:map_prefixed(0, 'n', 'e', '<plug>(vimtex-errors)')
call s:map_prefixed(0, 'n', 'c', '<plug>(vimtex-clean)')
call s:map_prefixed(0, 'n', 'C', '<plug>(vimtex-clean-full)')
call s:map_prefixed(0, 'n', 'g', '<plug>(vimtex-status)')
call s:map_prefixed(0, 'n', 'G', '<plug>(vimtex-status-all)')
endif

if g:vimtex_motion_enabled
Expand Down Expand Up @@ -288,19 +294,19 @@ function! s:init_default_mappings() abort " {{{1
endif

if g:vimtex_toc_enabled
call s:map(0, 'n', '<localleader>lt', '<plug>(vimtex-toc-open)')
call s:map(0, 'n', '<localleader>lT', '<plug>(vimtex-toc-toggle)')
call s:map_prefixed(0, 'n', 't', '<plug>(vimtex-toc-open)')
call s:map_prefixed(0, 'n', 'T', '<plug>(vimtex-toc-toggle)')
endif

if has_key(b:vimtex, 'viewer')
call s:map(0, 'n', '<localleader>lv', '<plug>(vimtex-view)')
call s:map_prefixed(0, 'n', 'v', '<plug>(vimtex-view)')
if !empty(maparg('<plug>(vimtex-reverse-search)', 'n'))
call s:map(1, 'n', '<localleader>lr', '<plug>(vimtex-reverse-search)')
call s:map_prefixed(1, 'n', 'r', '<plug>(vimtex-reverse-search)')
endif
endif

if g:vimtex_imaps_enabled
call s:map(0, 'n', '<localleader>lm', '<plug>(vimtex-imaps-list)')
call s:map_prefixed(0, 'n', 'm', '<plug>(vimtex-imaps-list)')
endif

if g:vimtex_doc_enabled
Expand Down
2 changes: 2 additions & 0 deletions autoload/vimtex/options.vim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,8 @@ function! vimtex#options#init() abort " {{{1
call s:init_option('vimtex_mappings_disable', {})
call s:init_option('vimtex_mappings_override_existing', 0)

call s:init_option('vimtex_mappings_prefix', '<localleader>l')

call s:init_option('vimtex_matchparen_enabled', 1)
call s:init_option('vimtex_motion_enabled', 1)

Expand Down
5 changes: 5 additions & 0 deletions doc/vimtex.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2104,6 +2104,11 @@ OPTIONS *vimtex-options*
<
Default value: {}

*g:vimtex_mappings_prefix*
The default prefix for all usually `<localleader>` based mappings.

Default value: <localleader>l

*g:vimtex_mappings_override_existing*
Control behaviour on mapping conflicts, in particular whether or not to
override pre-existing mappings. By default, VimTeX does not override existing
Expand Down