]> git.notmuchmail.org Git - notmuch/blobdiff - vim/plugin/notmuch.vim
make search screen mappings configurable via dictionary
[notmuch] / vim / plugin / notmuch.vim
index 6e1f8b14a8ed7a8f1b25df1c5d52db3aef7810a7..b9fc8d220288d7968bd2385c39fb32942a200e00 100644 (file)
 "
 " Authors: Bart Trojanowski <bart@jukie.net>
 
-" --- defaults
-
-if !exists('g:notmuch_cmd')
-        let g:notmuch_cmd = 'notmuch'
-endif
-
-if !exists('g:notmuch_search_reverse')
-        let g:notmuch_search_reverse = 1
+" --- configuration defaults {{{1
+
+let s:notmuch_defaults = {
+        \ 'g:notmuch_cmd':                           'notmuch'                    ,
+        \ 'g:notmuch_search_reverse':                1                            ,
+        \ 'g:notmuch_show_fold_signatures':          1                            ,
+        \ 'g:notmuch_show_fold_citations':           1                            ,
+        \
+        \ 'g:notmuch_show_message_begin_regexp':     '^\fmessage{'                ,
+        \ 'g:notmuch_show_message_end_regexp':       '^\fmessage}'                ,
+        \ 'g:notmuch_show_header_begin_regexp':      '^\fheader{'                 ,
+        \ 'g:notmuch_show_header_end_regexp':        '^\fheader}'                 ,
+        \ 'g:notmuch_show_body_begin_regexp':        '^\fbody{'                   ,
+        \ 'g:notmuch_show_body_end_regexp':          '^\fbody}'                   ,
+        \ 'g:notmuch_show_attachment_begin_regexp':  '^\fattachment{'             ,
+        \ 'g:notmuch_show_attachment_end_regexp':    '^\fattachment}'             ,
+        \ 'g:notmuch_show_part_begin_regexp':        '^\fpart{'                   ,
+        \ 'g:notmuch_show_part_end_regexp':          '^\fpart}'                   ,
+        \ 'g:notmuch_show_marker_regexp':            '^\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$',
+        \
+        \ 'g:notmuch_show_message_parse_regexp':     '\(id:[^ ]*\) depth:\([0-9]*\) filename:\(.*\)$',
+        \ 'g:notmuch_show_tags_regexp':              '(\([^)]*\))$'               ,
+        \
+        \ 'g:notmuch_show_signature_regexp':         '^\(-- \?\|_\+\)$'           ,
+        \ 'g:notmuch_show_signature_lines_max':      12                           ,
+        \
+        \ 'g:notmuch_show_citation_regexp':          '^\s*>'                      ,
+        \ }
+
+" for some reason NM_set_defaults() didn't work for arrays...
+if !exists('g:notmuch_show_headers')
+        let g:notmuch_show_headers = [ 'Subject', 'From' ]
 endif
 
-" --- used to match output of notmuch
-
-let s:notmuch_show_message_begin_regexp    = '^\fmessage{'
-let s:notmuch_show_message_end_regexp      = '^\fmessage}'
-let s:notmuch_show_header_begin_regexp     = '^\fheader{'
-let s:notmuch_show_header_end_regexp       = '^\fheader}'
-let s:notmuch_show_body_begin_regexp       = '^\fbody{'
-let s:notmuch_show_body_end_regexp         = '^\fbody}'
-let s:notmuch_show_attachment_begin_regexp = '^\fattachment{'
-let s:notmuch_show_attachment_end_regexp   = '^\fattachment}'
-let s:notmuch_show_part_begin_regexp       = '^\fpart{'
-let s:notmuch_show_part_end_regexp         = '^\fpart}'
-let s:notmuch_show_marker_regexp           = '^\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$'
-
-let s:notmuch_show_message_parse_regexp    = '\(id:[^ ]*\) depth:\([0-9]*\) filename:\(.*\)$'
-let s:notmuch_show_tags_regexp             = '(\([^)]*\))$'
-
-let s:notmuch_show_signature_regexp        = '^\(-- \?\|_\+\)$'
-let s:notmuch_show_signature_lines_max     = 12
+" --- keyboard mapping definitions {{{1
+
+let g:notmuch_search_maps = {
+        \ '<Enter>': ':call <SID>NM_search_display()<CR>',
+        \ 's':       ':call <SID>NM_cmd_search(split(input(''NotMuch Search:'')))<CR>',
+        \ }
+
+" --- process and set the defaults {{{1
+
+function! NM_set_defaults(force)
+        for [key, dflt] in items(s:notmuch_defaults)
+                let cmd = ''
+                if !a:force && exists(key) && type(dflt) == type(eval(key))
+                        continue
+                elseif type(dflt) == type(0)
+                        let cmd = printf('let %s = %d', key, dflt)
+                elseif type(dflt) == type('')
+                        let cmd = printf('let %s = ''%s''', key, dflt)
+                "elseif type(dflt) == type([])
+                "        let cmd = printf('let %s = %s', key, string(dflt))
+                else
+                        echoe printf('E: Unknown type in NM_set_defaults(%d) using [%s,%s]',
+                                                \ a:force, key, string(dflt))
+                        continue
+                endif
+                echoe cmd
+                exec cmd
+        endfor
+endfunction
+call NM_set_defaults(0)
 
-let s:notmuch_show_citation_regexp         = '^\s*>'
+" --- assign keymaps {{{1
 
-let s:notmuch_show_headers                 = [ 'Subject', 'From' ]
+function! s:NM_set_map(maps)
+        for [key, code] in items(a:maps)
+                exec printf('nnoremap <buffer> %s %s', key, code)
+        endfor
+endfunction
 
-let s:notmuch_show_fold_signatures         = 1
-let s:notmuch_show_fold_citations          = 1
 
-" --- implement search screen
+" --- implement search screen {{{1
 
 function! s:NM_cmd_search(words)
         let cmd = ['search']
@@ -73,8 +110,7 @@ function! s:NM_cmd_search(words)
         call s:NM_newBuffer('search', join(disp, "\n"))
         let b:nm_raw_lines = lines
 
-        nnoremap <buffer> <Enter> :call <SID>NM_search_display()<CR>
-        nnoremap <buffer> s       :call <SID>NM_cmd_search(split(input('NotMuch Search:')))<CR>
+        call <SID>NM_set_map(g:notmuch_search_maps)
         setlocal cursorline
         setlocal nowrap
 endfunction
@@ -91,10 +127,10 @@ function! s:NM_search_display()
 endfunction
 
 
-" --- implement show screen
+" --- implement show screen {{{1
 
 function! s:NM_cmd_show(words)
-        let bufnr = bufnr('%')
+        let prev_bufnr = bufnr('%')
         let data = s:NM_run(['show'] + a:words)
         let lines = split(data, "\n")
 
@@ -103,6 +139,7 @@ function! s:NM_cmd_show(words)
         call s:NM_newBuffer('show', join(info['disp'], "\n"))
         setlocal bufhidden=delete
         let b:nm_raw_info = info
+        let b:nm_prev_bufnr = prev_bufnr
 
         call s:NM_cmd_show_mkfolds()
         call s:NM_cmd_show_mksyntax()
@@ -110,9 +147,45 @@ function! s:NM_cmd_show(words)
         setlocal fillchars=
         setlocal foldcolumn=6
 
-        exec printf("nnoremap <buffer> q :b %d<CR>", bufnr)
+        exec printf("nnoremap <buffer> q :b %d<CR>", b:nm_prev_bufnr)
+        nnoremap <buffer> <C-N> :call <SID>NM_cmd_show_next()<CR>
+        nnoremap <buffer> c     :call <SID>NM_cmd_show_fold_toggle('c', 'cit', !g:notmuch_show_fold_citations)<CR>
+        nnoremap <buffer> s     :call <SID>NM_cmd_show_fold_toggle('s', 'sig', !g:notmuch_show_fold_signatures)<CR>
+endfunction
+
+function! s:NM_cmd_show_next()
+        let info = b:nm_raw_info
+        let lnum = line('.')
+        let cnt = 0
+        for msg in info['msgs']
+                let cnt = cnt + 1
+                if lnum >= msg['start']
+                        continue
+                endif
+
+                exec printf('norm %dG', msg['start'])
+                norm zz
+                return
+        endfor
+        norm qj
+        call <SID>NM_search_display()
 endfunction
 
+function! s:NM_cmd_show_fold_toggle(key, type, fold)
+        let info = b:nm_raw_info
+        let act = 'open'
+        if a:fold
+                let act = 'close'
+        endif
+        for fld in info['folds']
+                if fld[0] == a:type
+                        exec printf('%dfold%s', fld[1], act)
+                endif
+        endfor
+        exec printf('nnoremap <buffer> %s :call <SID>NM_cmd_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
+endfunction
+
+
 " s:NM_cmd_show_parse returns the following dictionary:
 "    'disp':     lines to display
 "    'msgs':     message info dicts { start, end, id, depth, filename, descr, header }
@@ -145,7 +218,7 @@ function! s:NM_cmd_show_parse(inlines)
                 if strlen(in_part)
                         let part_end = 0
 
-                        if match(line, s:notmuch_show_part_end_regexp) != -1
+                        if match(line, g:notmuch_show_part_end_regexp) != -1
                                 let part_end = len(info['disp'])
                         else
                                 call add(info['disp'], line)
@@ -153,23 +226,23 @@ function! s:NM_cmd_show_parse(inlines)
 
                         if in_part == 'text/plain'
                                 if !part_end && mode_type == ''
-                                        if match(line, s:notmuch_show_signature_regexp) != -1
+                                        if match(line, g:notmuch_show_signature_regexp) != -1
                                                 let mode_type = 'sig'
                                                 let mode_start = len(info['disp'])
-                                        elseif match(line, s:notmuch_show_citation_regexp) != -1
+                                        elseif match(line, g:notmuch_show_citation_regexp) != -1
                                                 let mode_type = 'cit'
                                                 let mode_start = len(info['disp'])
                                         endif
                                 elseif mode_type == 'cit'
-                                        if part_end || match(line, s:notmuch_show_citation_regexp) == -1
-                                                let outlnum = len(info['disp']) -1
+                                        if part_end || match(line, g:notmuch_show_citation_regexp) == -1
+                                                let outlnum = len(info['disp'])
                                                 let foldinfo = [ mode_type, mode_start, outlnum,
                                                                \ printf('[ %d-line citation.  Press "c" to show. ]', outlnum - mode_start) ]
                                                 let mode_type = ''
                                         endif
                                 elseif mode_type == 'sig'
                                         let outlnum = len(info['disp'])
-                                        if (outlnum - mode_start) > s:notmuch_show_signature_lines_max
+                                        if (outlnum - mode_start) > g:notmuch_show_signature_lines_max
                                                 echoe 'line ' . outlnum . ' stopped matching'
                                                 let mode_type = ''
                                         elseif part_end
@@ -198,14 +271,14 @@ function! s:NM_cmd_show_parse(inlines)
                         if !has_key(msg,'body_start')
                                 let msg['body_start'] = len(info['disp']) + 1
                         endif
-                        if match(line, s:notmuch_show_body_end_regexp) != -1
+                        if match(line, g:notmuch_show_body_end_regexp) != -1
                                 let body_end = len(info['disp'])
                                 let foldinfo = [ 'body', body_start, body_end,
                                                \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
 
                                 let in_body = 0
 
-                        elseif match(line, s:notmuch_show_part_begin_regexp) != -1
+                        elseif match(line, g:notmuch_show_part_begin_regexp) != -1
                                 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
                                 let in_part = 'unknown'
                                 if len(m)
@@ -224,7 +297,7 @@ function! s:NM_cmd_show_parse(inlines)
                                 let msg['hdr_start'] = len(info['disp']) + 1
 
                         else
-                                if match(line, s:notmuch_show_header_end_regexp) != -1
+                                if match(line, g:notmuch_show_header_end_regexp) != -1
                                         let msg['header'] = hdr
                                         let in_header = 0
                                         let hdr = {}
@@ -232,7 +305,7 @@ function! s:NM_cmd_show_parse(inlines)
                                         let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
                                         if len(m)
                                                 let hdr[m[1]] = m[2]
-                                                if match(s:notmuch_show_headers, m[1]) != -1
+                                                if match(g:notmuch_show_headers, m[1]) != -1
                                                         call add(info['disp'], line)
                                                 endif
                                         endif
@@ -240,7 +313,7 @@ function! s:NM_cmd_show_parse(inlines)
                         endif
 
                 elseif in_message
-                        if match(line, s:notmuch_show_message_end_regexp) != -1
+                        if match(line, g:notmuch_show_message_end_regexp) != -1
                                 let msg['end'] = len(info['disp'])
                                 call add(info['disp'], '')
 
@@ -254,21 +327,21 @@ function! s:NM_cmd_show_parse(inlines)
                                 let in_body = 0
                                 let in_part = ''
 
-                        elseif match(line, s:notmuch_show_header_begin_regexp) != -1
+                        elseif match(line, g:notmuch_show_header_begin_regexp) != -1
                                 let in_header = 1
                                 continue
 
-                        elseif match(line, s:notmuch_show_body_begin_regexp) != -1
+                        elseif match(line, g:notmuch_show_body_begin_regexp) != -1
                                 let body_start = len(info['disp']) + 1
                                 let in_body = 1
                                 continue
                         endif
 
                 else
-                        if match(line, s:notmuch_show_message_begin_regexp) != -1
+                        if match(line, g:notmuch_show_message_begin_regexp) != -1
                                 let msg['start'] = len(info['disp']) + 1
 
-                                let m = matchlist(line, s:notmuch_show_message_parse_regexp)
+                                let m = matchlist(line, g:notmuch_show_message_parse_regexp)
                                 if len(m)
                                         let msg['id'] = m[1]
                                         let msg['depth'] = m[2]
@@ -292,8 +365,8 @@ function! s:NM_cmd_show_mkfolds()
 
         for afold in info['folds']
                 exec printf('%d,%dfold', afold[1], afold[2])
-                if (afold[0] == 'sig' && s:notmuch_show_fold_signatures)
-                 \ || (afold[0] == 'cit' && s:notmuch_show_fold_citations)
+                if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
+                 \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
                         exec printf('%dfoldclose', afold[1])
                 else
                         exec printf('%dfoldopen', afold[1])
@@ -322,7 +395,7 @@ function! NM_cmd_show_foldtext()
 endfunction
 
 
-" --- helper functions
+" --- helper functions {{{1
 
 function! s:NM_newBuffer(ft, content)
         enew
@@ -348,7 +421,7 @@ function! s:NM_run(args)
 endfunction
 
 
-" --- command handler
+" --- command handler {{{1
 
 function! NotMuch(args)
         if !strlen(a:args)
@@ -366,11 +439,13 @@ function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
 endfunction
 
 
-" --- glue
+" --- glue {{{1
 
 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
 cabbrev  notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
 
-" --- hacks, only for development :)
+" --- hacks, only for development :) {{{1
 
 nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>
+
+" vim: set ft=vim ts=8 sw=8 et foldmethod=marker :