X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=vim%2Fplugin%2Fnotmuch.vim;h=a10b9a3a94bde749b3dc55f722fc05e804379e92;hp=a57b2ae8a1a9b16db3663e49dd36c8fde5db1f04;hb=84f33e6546eb11a30eed74652fa408ae7ac192be;hpb=c6314fa2347fff97436acc0591cc4e6e557a19d6 diff --git a/vim/plugin/notmuch.vim b/vim/plugin/notmuch.vim index a57b2ae8..a10b9a3a 100644 --- a/vim/plugin/notmuch.vim +++ b/vim/plugin/notmuch.vim @@ -19,45 +19,82 @@ " " Authors: Bart Trojanowski -" --- defaults - -if !exists('g:notmuch_cmd') - let g:notmuch_cmd = 'notmuch' -endif - -if !exists('g:notmuch_search_reverse') - let g:notmuch_search_reverse = 1 -endif - -" --- used to match output of notmuch - -let s:notmuch_show_message_begin_regexp = '^ message{' -let s:notmuch_show_message_end_regexp = '^ message}' -let s:notmuch_show_header_begin_regexp = '^ header{' -let s:notmuch_show_header_end_regexp = '^ header}' -let s:notmuch_show_body_begin_regexp = '^ body{' -let s:notmuch_show_body_end_regexp = '^ body}' -let s:notmuch_show_attachment_begin_regexp = '^ attachment{' -let s:notmuch_show_attachment_end_regexp = '^ attachment}' -let s:notmuch_show_part_begin_regexp = '^ part{' -let s:notmuch_show_part_end_regexp = '^ part}' -let s:notmuch_show_marker_regexp = '^ \\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$' - -let s:notmuch_show_id_regexp = '\(id:[^ ]*\)' -let s:notmuch_show_depth_regexp = ' depth:\([0-9]*\) ' -let s:notmuch_show_filename_regexp = 'filename:\(.*\)$' -let s:notmuch_show_tags_regexp = '(\([^)]*\))$' - -let s:notmuch_show_signature_regexp = '^\(-- \?\|_\+\)$' -let s:notmuch_show_signature_lines_max = 12 - -" --- implement search screen +" --- 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': '^ message{' , + \ 'g:notmuch_show_message_end_regexp': '^ message}' , + \ 'g:notmuch_show_header_begin_regexp': '^ header{' , + \ 'g:notmuch_show_header_end_regexp': '^ header}' , + \ 'g:notmuch_show_body_begin_regexp': '^ body{' , + \ 'g:notmuch_show_body_end_regexp': '^ body}' , + \ 'g:notmuch_show_attachment_begin_regexp': '^ attachment{' , + \ 'g:notmuch_show_attachment_end_regexp': '^ attachment}' , + \ 'g:notmuch_show_part_begin_regexp': '^ part{' , + \ 'g:notmuch_show_part_end_regexp': '^ part}' , + \ 'g:notmuch_show_marker_regexp': '^ \\(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*>' , + \ } + +" defaults for g:notmuch_initial_search_words +" override with: let g:notmuch_initial_search_words = [ ... ] +let s:notmuch_initial_search_words_defaults = [ + \ 'tag:inbox' + \ ] + +" defaults for g:notmuch_show_headers +" override with: let g:notmuch_show_headers = [ ... ] +let s:notmuch_show_headers_defaults = [ + \ 'Subject', + \ 'From' + \ ] + +" --- keyboard mapping definitions {{{1 + +" --- --- bindings for search screen {{{2 +let g:notmuch_search_maps = { + \ '': ':call NM_search_show_thread()', + \ 'a': ':call NM_search_archive_thread()', + \ 'f': ':call NM_search_filter()', + \ 'm': ':call NM_new_mail()', + \ 'o': ':call NM_search_toggle_order()', + \ 'r': ':call NM_search_reply_to_thread()', + \ 's': ':call NM_search_prompt()', + \ 'S': ':call NM_search_edit()', + \ 't': ':call NM_search_filter_by_tag()', + \ '+': ':call NM_search_add_tags([])', + \ '-': ':call NM_search_remove_tags([])', + \ '=': ':call NM_search_refresh_view()', + \ } + +" --- --- bindings for show screen {{{2 +let g:notmuch_show_maps = { + \ 'q': ':call NM_cmd_show_quit()', + \ '': ':call NM_cmd_show_next()', + \ 'c': ':call NM_cmd_show_fold_toggle(''c'', ''cit'', !g:notmuch_show_fold_citations)', + \ 's': ':call NM_cmd_show_fold_toggle(''s'', ''sig'', !g:notmuch_show_fold_signatures)', + \ } + +" --- implement search screen {{{1 function! s:NM_cmd_search(words) let cmd = ['search'] if g:notmuch_search_reverse let cmd = cmd + ['--reverse'] endif + let g:notmuch_current_search_words = a:words let data = s:NM_run(cmd + a:words) "let data = substitute(data, '27/27', '25/27', '') "let data = substitute(data, '\[4/4\]', '[0/4]', '') @@ -66,68 +103,382 @@ function! s:NM_cmd_search(words) call map(disp, 'substitute(v:val, "^thread:\\S* ", "", "")' ) call s:NM_newBuffer('search', join(disp, "\n")) - let b:nm_raw_data = lines + let b:nm_raw_lines = lines - nnoremap :call NM_search_display() - nnoremap s :call NM_cmd_search(split(input('NotMuch Search:'))) + call NM_set_map(g:notmuch_search_maps) setlocal cursorline setlocal nowrap endfunction -function! s:NM_search_display() - if !exists('b:nm_raw_data') - echo 'no b:nm_raw_data' +" --- --- search screen action functions {{{2 + +function! s:NM_search_show_thread() + let id = NM_search_find_thread_id() + if id != '' + call s:NM_cmd_show([id]) + endif +endfunction + +function! s:NM_search_prompt() + " TODO: input() can support completion + let text = input('NotMuch Search: ') + if strlen(text) + call NM_cmd_search(split(text)) + endif +endfunction + +function! s:NM_search_edit() + " TODO: input() can support completion + let text = input('NotMuch Search: ', join(g:notmuch_current_search_words, ' ')) + if strlen(text) + call NM_cmd_search(split(text)) + endif +endfunction + +function! s:NM_search_archive_thread() + call NM_search_remove_tags('inbox') + norm j +endfunction + +function! s:NM_search_filter() + echoe 'Not implemented' +endfunction + +function! s:NM_new_mail() + echoe 'Not implemented' +endfunction + +function! s:NM_search_toggle_order() + echoe 'Not implemented' +endfunction + +function! s:NM_search_reply_to_thread() + echoe 'Not implemented' +endfunction + +function! s:NM_search_filter_by_tag() + echoe 'Not implemented' +endfunction + +function! s:NM_search_add_tags(tags) + call NM_search_add_remove_tags('Add Tag(s): ', '+', a:tags) +endfunction + +function! s:NM_search_remove_tags(tags) + call NM_search_add_remove_tags('Remove Tag(s): ', '-', a:tags) +endfunction + +function! s:NM_search_refresh_view() + let lno = line('.') + call s:NM_cmd_search(g:notmuch_current_search_words) + " FIXME: should find the line of the thread we were on if possible + exec printf('norm %dG', lno) +endfunction + +" --- --- search screen helper functions {{{2 + +function! s:NM_search_find_thread_id() + if !exists('b:nm_raw_lines') + echoe 'no b:nm_raw_lines' + return '' else let line = line('.') - let info = b:nm_raw_data[line-1] + let info = b:nm_raw_lines[line-1] let what = split(info, '\s\+')[0] - call s:NM_cmd_show([what]) + return what endif endfunction +function! s:NM_search_add_remove_tags(prompt, prefix, intags) + let id = NM_search_find_thread_id() + if id != '' + if type(a:intags) != type([]) || len(a:intags) == 0 + " TODO: input() can support completion + let text = input(a:prompt) + if !strlen(text) + return + endif + let tags = split(text, ' ') + else + let tags = a:intags + endif + call map(tags, 'a:prefix . v:val') + " TODO: handle errors + call NM_run(['tag'] + tags + ['--', id]) + call NM_search_refresh_view() + endif +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") - call s:NM_newBuffer('show', data) + let info = s:NM_cmd_show_parse(lines) + + call s:NM_newBuffer('show', join(info['disp'], "\n")) setlocal bufhidden=delete - let b:nm_raw_data = data + 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() + call NM_set_map(g:notmuch_show_maps) + setlocal foldtext=NM_cmd_show_foldtext() + setlocal fillchars= + setlocal foldcolumn=6 - exec printf("nnoremap q :b %d", bufnr) endfunction -function! s:NM_cmd_show_mkfolds() - let modetype = '' - let modeline = -1 - let lnum = 1 - while lnum <= line('$') - let line = getline(lnum) - if modetype == '' - if match(line, s:notmuch_show_signature_regexp) != -1 - let modetype = 'sig' - let modeline = lnum - echo "start=" . modeline +function! s:NM_cmd_show_quit() + exec printf(":buffer %d", b:nm_prev_bufnr) +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 NM_search_show_thread() +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 %s :call NM_cmd_show_fold_toggle(''%s'', ''%s'', %d)', 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 } +" 'folds': fold info arrays [ type, start, end ] +" 'foldtext': fold text indexed by start line +function! s:NM_cmd_show_parse(inlines) + let info = { 'disp': [], + \ 'msgs': [], + \ 'folds': [], + \ 'foldtext': {} } + let msg = {} + let hdr = {} + + let in_message = 0 + let in_header = 0 + let in_body = 0 + let in_part = '' + + let body_start = -1 + let part_start = -1 + + let mode_type = '' + let mode_start = -1 + + let inlnum = 0 + for line in a:inlines + let inlnum = inlnum + 1 + let foldinfo = [] + + if strlen(in_part) + let part_end = 0 + + if match(line, g:notmuch_show_part_end_regexp) != -1 + let part_end = len(info['disp']) + else + call add(info['disp'], line) + endif + + if in_part == 'text/plain' + if !part_end && mode_type == '' + if match(line, g:notmuch_show_signature_regexp) != -1 + let mode_type = 'sig' + let mode_start = len(info['disp']) + 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, 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) > g:notmuch_show_signature_lines_max + echoe 'line ' . outlnum . ' stopped matching' + let mode_type = '' + elseif part_end + let foldinfo = [ mode_type, mode_start, outlnum, + \ printf('[ %d-line signature. Press "s" to show. ]', outlnum - mode_start) ] + let mode_type = '' + endif + endif + endif + + if part_end + " FIXME: this is a hack for handling two folds being added for one line + " we should handle addinga fold in a function + if len(foldinfo) + call add(info['folds'], foldinfo[0:2]) + let info['foldtext'][foldinfo[1]] = foldinfo[3] + endif + + let foldinfo = [ 'text', part_start, part_end, + \ printf('[ %d-line %s. Press "p" to show. ]', part_end - part_start, in_part) ] + let in_part = '' + call add(info['disp'], '') + endif + + elseif in_body + if !has_key(msg,'body_start') + let msg['body_start'] = len(info['disp']) + 1 + endif + 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, g:notmuch_show_part_begin_regexp) != -1 + let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)') + let in_part = 'unknown' + if len(m) + let in_part = m[2] + endif + call add(info['disp'], + \ printf('--- %s ---', in_part)) + let part_start = len(info['disp']) + 1 + endif + + elseif in_header + if in_header == 1 + let msg['descr'] = line + call add(info['disp'], line) + let in_header = 2 + let msg['hdr_start'] = len(info['disp']) + 1 + + else + if match(line, g:notmuch_show_header_end_regexp) != -1 + let msg['header'] = hdr + let in_header = 0 + let hdr = {} + else + let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$') + if len(m) + let hdr[m[1]] = m[2] + if match(g:notmuch_show_headers, m[1]) != -1 + call add(info['disp'], line) + endif + endif + endif + endif + + elseif in_message + if match(line, g:notmuch_show_message_end_regexp) != -1 + let msg['end'] = len(info['disp']) + call add(info['disp'], '') + + let foldinfo = [ 'match', msg['start'], msg['end'], + \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ] + + call add(info['msgs'], msg) + let msg = {} + let in_message = 0 + let in_header = 0 + let in_body = 0 + let in_part = '' + + elseif match(line, g:notmuch_show_header_begin_regexp) != -1 + let in_header = 1 + continue + + elseif match(line, g:notmuch_show_body_begin_regexp) != -1 + let body_start = len(info['disp']) + 1 + let in_body = 1 + continue endif - elseif modetype == 'sig' - if (lnum - modeline) > s:notmuch_show_signature_lines_max - let modetype = '' - elseif match(line, s:notmuch_show_part_end_regexp) != -1 - exec printf('%d,%dfold', modeline, lnum) - let modetype = '' + + else + if match(line, g:notmuch_show_message_begin_regexp) != -1 + let msg['start'] = len(info['disp']) + 1 + + let m = matchlist(line, g:notmuch_show_message_parse_regexp) + if len(m) + let msg['id'] = m[1] + let msg['depth'] = m[2] + let msg['filename'] = m[3] + endif + + let in_message = 1 endif endif - let lnum = lnum + 1 - endwhile + if len(foldinfo) + call add(info['folds'], foldinfo[0:2]) + let info['foldtext'][foldinfo[1]] = foldinfo[3] + endif + endfor + return info +endfunction + +function! s:NM_cmd_show_mkfolds() + let info = b:nm_raw_info + + for afold in info['folds'] + exec printf('%d,%dfold', afold[1], afold[2]) + 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]) + endif + endfor +endfunction + +function! s:NM_cmd_show_mksyntax() + let info = b:nm_raw_info + let cnt = 0 + for msg in info['msgs'] + let cnt = cnt + 1 + let start = msg['start'] + let hdr_start = msg['hdr_start'] + let body_start = msg['body_start'] + let end = msg['end'] + exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1) + exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start) + exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end) + endfor +endfunction + +function! NM_cmd_show_foldtext() + let foldtext = b:nm_raw_info['foldtext'] + return foldtext[v:foldstart] endfunction -" --- helper functions +" --- notmuch helper functions {{{1 function! s:NM_newBuffer(ft, content) enew @@ -152,12 +503,54 @@ function! s:NM_run(args) endif endfunction +" --- 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 + exec cmd + endfor +endfunction +call NM_set_defaults(0) + +" for some reason NM_set_defaults() didn't work for arrays... +if !exists('g:notmuch_show_headers') + let g:notmuch_show_headers = s:notmuch_show_headers_defaults +endif +if !exists('g:notmuch_initial_search_words') + let g:notmuch_initial_search_words = s:notmuch_initial_search_words_defaults +endif + +" this is the default querry +let g:notmuch_current_search_words = g:notmuch_initial_search_words -" --- command handler + +" --- assign keymaps {{{1 + +function! s:NM_set_map(maps) + for [key, code] in items(a:maps) + exec printf('nnoremap %s %s', key, code) + endfor +endfunction + +" --- command handler {{{1 function! NotMuch(args) if !strlen(a:args) - call s:NM_cmd_search(['tag:inbox']) + call s:NM_cmd_search(g:notmuch_current_search_words) return endif @@ -171,11 +564,13 @@ function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos) endfunction -" --- glue +" --- glue {{{1 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch() cabbrev notmuch =(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch') -" --- hacks, only for development :) +" --- hacks, only for development :) {{{1 nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim:call NotMuch('') + +" vim: set ft=vim ts=8 sw=8 et foldmethod=marker :