Skip to content

Commit

Permalink
Merge pull request #191 from lambdalisue/refactoring-mappings
Browse files Browse the repository at this point in the history 
Rename hidden/mark mappings/actions (previous one become deprecated)
  • Loading branch information
@lambdalisue
lambdalisue authored Aug 31, 2020
2 parents fc7e315 + 0a21cdb commit d3d9412
Show file tree
Hide file tree
Showing 7 changed files with 134 additions and 40 deletions.
9 changes: 9 additions & 0 deletions autoload/fern/action.vim
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
let s:Action = vital#fern#import('App.Action')
call s:Action.set_ignores([
\ 'hidden-set',
\ 'hidden-unset',
\ 'hidden-toggle',
\ 'mark-clear',
\ 'mark-set',
\ 'mark-unset',
\ 'mark-toggle',
\])

function! fern#action#_init() abort
call s:Action.init()
Expand Down
11 changes: 11 additions & 0 deletions autoload/fern/mapping.vim
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@ function! fern#mapping#init(scheme) abort
call fern#internal#scheme#mapping_init(a:scheme, disable_default_mappings)
endfunction

function! fern#mapping#deprecated(old, new) abort
call fern#util#deprecated(
\ printf('<Plug>(%s)', a:old),
\ printf('<Plug>(%s)', a:new),
\)
" Do NOT show the warning message more than once
silent execute printf('nmap <buffer> <Plug>(%s) <Plug>(%s)', a:old, a:new)
" Return new mapping
return printf("\<Plug>(%s)", a:new)
endfunction

call s:Config.config(expand('<sfile>:p'), {
\ 'mappings': [
\ 'drawer',
Expand Down
19 changes: 15 additions & 4 deletions autoload/fern/mapping/filter.vim
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
function! fern#mapping#filter#init(disable_default_mappings) abort
nnoremap <buffer><silent> <Plug>(fern-action-hidden-set) :<C-u>call <SID>call('hidden_set')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-hidden-unset) :<C-u>call <SID>call('hidden_unset')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-hidden-toggle) :<C-u>call <SID>call('hidden_toggle')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-hidden:set) :<C-u>call <SID>call('hidden_set')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-hidden:unset) :<C-u>call <SID>call('hidden_unset')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-hidden:toggle) :<C-u>call <SID>call('hidden_toggle')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-include) :<C-u>call <SID>call('include')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-exclude) :<C-u>call <SID>call('exclude')<CR>
" Alias
nmap <buffer> <Plug>(fern-action-hidden) <Plug>(fern-action-hidden:toggle)
if !a:disable_default_mappings
nmap <buffer><nowait> ! <Plug>(fern-action-hidden-toggle)
nmap <buffer><nowait> ! <Plug>(fern-action-hidden)
nmap <buffer><nowait> fi <Plug>(fern-action-include)
nmap <buffer><nowait> fe <Plug>(fern-action-exclude)
endif

" DEPRECATED:
nmap <buffer><silent><expr> <Plug>(fern-action-hidden-set)
\ fern#mapping#deprecated('fern-action-hidden-set', 'fern-action-hidden:set')
nmap <buffer><silent><expr> <Plug>(fern-action-hidden-unset)
\ fern#mapping#deprecated('fern-action-hidden-unset', 'fern-action-hidden:unset')
nmap <buffer><silent><expr> <Plug>(fern-action-hidden-toggle)
\ fern#mapping#deprecated('fern-action-hidden-toggle', 'fern-action-hidden:toggle')
endfunction

function! s:call(name, ...) abort
Expand Down
44 changes: 33 additions & 11 deletions autoload/fern/mapping/mark.vim
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,42 @@
let s:Promise = vital#fern#import('Async.Promise')

function! fern#mapping#mark#init(disable_default_mappings) abort
nnoremap <buffer><silent> <Plug>(fern-action-mark-clear) :<C-u>call <SID>call('mark_clear')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-mark-toggle) :<C-u>call <SID>call('mark_toggle')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-mark-set) :<C-u>call <SID>call('mark_set')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-mark-unset :<C-u>call <SID>call('mark_unset')<CR>
vnoremap <buffer><silent> <Plug>(fern-action-mark-set) :call <SID>call('mark_set')<CR>
vnoremap <buffer><silent> <Plug>(fern-action-mark-unset) :call <SID>call('mark_unset')<CR>
vnoremap <buffer><silent> <Plug>(fern-action-mark-toggle) :call <SID>call('mark_toggle')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-mark:clear) :<C-u>call <SID>call('mark_clear')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-mark:set) :<C-u>call <SID>call('mark_set')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-mark:unset :<C-u>call <SID>call('mark_unset')<CR>
nnoremap <buffer><silent> <Plug>(fern-action-mark:toggle) :<C-u>call <SID>call('mark_toggle')<CR>
vnoremap <buffer><silent> <Plug>(fern-action-mark:set) :call <SID>call('mark_set')<CR>
vnoremap <buffer><silent> <Plug>(fern-action-mark:unset) :call <SID>call('mark_unset')<CR>
vnoremap <buffer><silent> <Plug>(fern-action-mark:toggle) :call <SID>call('mark_toggle')<CR>
" Alias
nmap <buffer> <Plug>(fern-action-mark) <Plug>(fern-action-mark:toggle)
vmap <buffer> <Plug>(fern-action-mark) <Plug>(fern-action-mark:toggle)
if !a:disable_default_mappings
nmap <buffer><nowait> <C-j> <Plug>(fern-action-mark-toggle)j
nmap <buffer><nowait> <C-k> k<Plug>(fern-action-mark-toggle)
nmap <buffer><nowait> - <Plug>(fern-action-mark-toggle)
vmap <buffer><nowait> - <Plug>(fern-action-mark-toggle)
nmap <buffer><nowait> <C-j> <Plug>(fern-action-mark)j
nmap <buffer><nowait> <C-k> k<Plug>(fern-action-mark)
nmap <buffer><nowait> - <Plug>(fern-action-mark)
vmap <buffer><nowait> - <Plug>(fern-action-mark)
endif

" DEPRECATED:
nmap <buffer><silent><expr> <Plug>(fern-action-mark-clear)
\ <SID>deprecated('fern-action-mark-clear', 'fern-action-mark:clear')
nmap <buffer><silent><expr> <Plug>(fern-action-mark-set)
\ <SID>deprecated('fern-action-mark-set', 'fern-action-mark:set')
nmap <buffer><silent><expr> <Plug>(fern-action-mark-unset)
\ <SID>deprecated('fern-action-mark-unset', 'fern-action-mark:unset')
nmap <buffer><silent><expr> <Plug>(fern-action-mark-toggle)
\ <SID>deprecated('fern-action-mark-toggle', 'fern-action-mark:toggle')
vmap <buffer><silent><expr> <Plug>(fern-action-mark-clear)
\ <SID>deprecated('fern-action-mark-clear', 'fern-action-mark:clear')
vmap <buffer><silent><expr> <Plug>(fern-action-mark-set)
\ <SID>deprecated('fern-action-mark-set', 'fern-action-mark:set')
vmap <buffer><silent><expr> <Plug>(fern-action-mark-unset)
\ <SID>deprecated('fern-action-mark-unset', 'fern-action-mark:unset')
vmap <buffer><silent><expr> <Plug>(fern-action-mark-toggle)
\ <SID>deprecated('fern-action-mark-toggle', 'fern-action-mark:toggle')
endfunction

function! s:call(name, ...) abort
Expand Down
21 changes: 5 additions & 16 deletions autoload/fern/mapping/open.vim
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,6 @@ function! fern#mapping#open#init(disable_default_mappings) abort
\ "\<Plug>(fern-action-expand)",
\ )
" For backword compatibility
nmap <buffer><silent><expr> <Plug>(fern-open-or-enter)
\ <SID>deprecated('fern-open-or-enter', 'fern-action-open-or-enter')
nmap <buffer><silent><expr> <Plug>(fern-open-or-expand)
\ <SID>deprecated('fern-open-or-expand', 'fern-action-open-or-expand')
" Alias map
nmap <buffer><silent> <Plug>(fern-action-open:edit) <Plug>(fern-action-open:edit-or-error)
nmap <buffer><silent> <Plug>(fern-action-open) <Plug>(fern-action-open:edit)
Expand All @@ -56,17 +50,12 @@ function! fern#mapping#open#init(disable_default_mappings) abort
nmap <buffer><nowait> E <Plug>(fern-action-open:side)
nmap <buffer><nowait> t <Plug>(fern-action-open:tabedit)
endif
endfunction

function! s:deprecated(old, new) abort
call fern#util#deprecated(
\ printf('<Plug>(%s)', a:old),
\ printf('<Plug>(%s)', a:new),
\)
" Do NOT show the warning message more than once
silent execute printf('nmap <buffer> <Plug>(%s) <Plug>(%s)', a:old, a:new)
" Return new mapping
return printf("\<Plug>(%s)", a:new)
" DEPRECATED:
nmap <buffer><silent><expr> <Plug>(fern-open-or-enter)
\ fern#mapping#deprecated('fern-open-or-enter', 'fern-action-open-or-enter')
nmap <buffer><silent><expr> <Plug>(fern-open-or-expand)
\ fern#mapping#deprecated('fern-open-or-expand', 'fern-action-open-or-expand')
endfunction

function! s:call(name, ...) abort
Expand Down
27 changes: 25 additions & 2 deletions autoload/vital/_fern/App/Action.vim
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@
function! s:_SID() abort
return matchstr(expand('<sfile>'), '<SNR>\zs\d\+\ze__SID$')
endfunction
execute join(['function! vital#_fern#App#Action#import() abort', printf("return map({'list': '', 'get_prefix': '', 'init': '', 'call': '', 'set_prefix': ''}, \"vital#_fern#function('<SNR>%s_' . v:key)\")", s:_SID()), 'endfunction'], "\n")
execute join(['function! vital#_fern#App#Action#import() abort', printf("return map({'list': '', 'get_prefix': '', 'get_hiddens': '', 'init': '', 'set_ignores': '', 'call': '', 'get_ignores': '', 'set_hiddens': '', 'set_prefix': ''}, \"vital#_fern#function('<SNR>%s_' . v:key)\")", s:_SID()), 'endfunction'], "\n")
delfunction s:_SID
" ___vital___
let s:prefix = matchstr(
\ fnamemodify(expand('<sfile>'), ':p:h:h:t'),
\ '^\%(__\zs.*\ze__\|_\zs.*\)$',
\)
let s:hiddens = []
let s:ignores = []

function! s:get_prefix() abort
return s:prefix
Expand All @@ -20,6 +22,22 @@ function! s:set_prefix(prefix) abort
let s:prefix = a:prefix
endfunction

function! s:get_hiddens() abort
return copy(s:hiddens)
endfunction

function! s:set_hiddens(hiddens) abort
let s:hiddens = a:hiddens
endfunction

function! s:get_ignores() abort
return copy(s:ignores)
endfunction

function! s:set_ignores(ignores) abort
let s:ignores = a:ignores
endfunction

function! s:init() abort
execute printf(
\ 'nnoremap <buffer><silent> <Plug>(%s-action-choice) :<C-u>call <SID>_map_choice()<CR>',
Expand Down Expand Up @@ -107,8 +125,10 @@ function! s:list(...) abort
call map(rs2, { _, v -> ['', v[2], v[0]] })

let rs = uniq(sort(rs1 + rs2, Sort), Sort)
call filter(rs, { -> index(s:ignores, v:val[1]) is# -1 })
if conceal
call filter(rs, { -> v:val[1] !~# ':' || !empty(v:val[0]) })
call filter(rs, { -> index(s:hiddens, v:val[1]) is# -1 })
endif

return rs
Expand Down Expand Up @@ -199,10 +219,13 @@ function! s:_complete_choice(arglead, cmdline, cursorpos) abort
endif
let names = copy(b:{s:prefix}_action.actions)
let names += ['capture', 'verbose']
call filter(names, { -> index(s:ignores, v:val) is# -1 })
if empty(a:arglead)
call filter(names, { -> v:val !~# ':' })
call filter(names, { -> index(s:hiddens, v:val) is# -1 })
endif
return filter(names, { -> v:val =~# '^' . a:arglead })
call filter(names, { -> v:val =~# '^' . a:arglead })
return names
endfunction

function! s:_compare(i1, i2) abort
Expand Down
43 changes: 36 additions & 7 deletions doc/fern.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -665,18 +665,31 @@ GLOBAL *fern-mapping-global*
The original window width will be restored once user leave the window.
It only works on a drawer style fern window.

*<Plug>(fern-action-hidden-set)*
*<Plug>(fern-action-hidden:set)*
Show hidden nodes. For example hidden nodes in file:// scheme is a
file or directory starts from '.' character.

*<Plug>(fern-action-hidden-unset)*
*<Plug>(fern-action-hidden:unset)*
Hide hidden nodes. For example hidden nodes in file:// scheme is a
file or directory starts from '.' character.

*<Plug>(fern-action-hidden-toggle)*
*<Plug>(fern-action-hidden:toggle)*
Toggle hidden nodes. For example hidden nodes in file:// scheme is a
file or directory starts from '.' character.

*<Plug>(fern-action-hidden)*
An alias to "hidden:toggle" action. Users can overwrite this mapping
to change the default behavior of "hidden" action.

*<Plug>(fern-action-hidden-set)*
DEPRECATED: Use |<Plug>(fern-action-hidden:set)| instead.

*<Plug>(fern-action-hidden-unset)*
DEPRECATED: Use |<Plug>(fern-action-hidden:unset)| instead.

*<Plug>(fern-action-hidden-toggle)*
DEPRECATED: Use |<Plug>(fern-action-hidden:toggle)| instead.

*<Plug>(fern-action-include)*
Open a prompt to enter include filter. Users can type a |pattern| to
filter nodes recursively.
Expand All @@ -685,17 +698,33 @@ GLOBAL *fern-mapping-global*
Open a prompt to enter exclude filter. Users can type a |pattern| to
filter nodes recursively.

*<Plug>(fern-action-mark-clear)*
*<Plug>(fern-action-mark:clear)*
Clear existing marks.

*<Plug>(fern-action-mark-toggle)*
*<Plug>(fern-action-mark:set)*
Set marks on cursor node(s).

*<Plug>(fern-action-mark:unset)*
Unset marks on cursor node(s).

*<Plug>(fern-action-mark:toggle)*
Toggle marks on cursor node(s).

*<Plug>(fern-action-mark)*
An alias to "mark:toggle" action. Users can overwrite this mapping to
change the default behavior of "mark" action.

*<Plug>(fern-action-mark-clear)*
DEPRECATED: Use |<Plug>(fern-action-mark:clear)| instead.

*<Plug>(fern-action-mark-set)*
Set marks on cursor node(s).
DEPRECATED: Use |<Plug>(fern-action-mark:set)| instead.

*<Plug>(fern-action-mark-unset)*
Unset marks on cursor node(s).
DEPRECATED: Use |<Plug>(fern-action-mark:unset)| instead.

*<Plug>(fern-action-mark-toggle)*
DEPRECATED: Use |<Plug>(fern-action-mark:toggle)| instead.

*<Plug>(fern-action-debug)*
Echo debug information of a cursor node.
Expand Down

0 comments on commit d3d9412

Please sign in to comment.