]> git.notmuchmail.org Git - notmuch/blobdiff - vim/plugin/notmuch.vim
vim: generalize compose buffer function further
[notmuch] / vim / plugin / notmuch.vim
index 47a226100180b8a566995548d2103ab00c08ba03..ef3260ed085473a0943f9820f86f0994d993a45c 100644 (file)
@@ -33,17 +33,17 @@ let s:notmuch_defaults = {
         \ 'g:notmuch_show_fold_bodies':              0                            ,
         \ 'g:notmuch_show_fold_headers':             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_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]*\) match:\([0-9]*\) filename:\(.*\)$',
         \ 'g:notmuch_show_tags_regexp':              '(\([^)]*\))$'               ,
@@ -127,7 +127,7 @@ let g:notmuch_search_maps = {
         \ '+':          ':call <SID>NM_search_add_tags([])<CR>',
         \ '-':          ':call <SID>NM_search_remove_tags([])<CR>',
         \ '=':          ':call <SID>NM_search_refresh_view()<CR>',
-        \ '?':          ':echo <SID>NM_search_thread_id()<CR>',
+        \ '?':          ':echo <SID>NM_search_thread_id() . ''  @ '' . join(<SID>NM_get_search_words())<CR>',
         \ }
 
 " --- --- bindings for show screen {{{2
@@ -157,7 +157,7 @@ let g:notmuch_show_maps = {
         \
         \ 'r':          ':call <SID>NM_show_reply()<CR>',
         \ 'm':          ':call <SID>NM_new_mail()<CR>',
-        \ '?':          ':echo <SID>NM_show_message_id() . ''  @ '' . join(<SID>NM_show_search_words())<CR>',
+        \ '?':          ':echo <SID>NM_show_message_id() . ''  @ '' . join(<SID>NM_get_search_words())<CR>',
         \ }
 
 " --- --- bindings for compose screen {{{2
@@ -175,7 +175,7 @@ let g:notmuch_compose_imaps = {
 
 function! s:NM_cmd_folders(words)
         if len(a:words)
-                echoe 'Not exapecting any arguments for folders command.'
+                throw 'Not exapecting any arguments for folders command.'
         endif
         let cmd = ['count']
         let disp = []
@@ -269,7 +269,7 @@ function! s:NM_search_show_thread()
         if id != ''
                 let words = [id]
                 if exists('b:nm_search_words')
-                        let words = ['('] + b:nm_search_words + [')', 'and', id]
+                        let words = ['('] + b:nm_search_words + [')', 'AND', id]
                 endif
                 if len(words)
                         call <SID>NM_cmd_show(words)
@@ -323,23 +323,13 @@ endfunction
 
 function! s:NM_search_filter_helper(prompt, prefix, joiner)
         " TODO: input() can support completion
-        let text = input(a:prompt)
+        let text = substitute(input(a:prompt), '\v(^\s*|\s*$|\n)', '', 'g')
         if !strlen(text)
                 return
         endif
 
-        let tags = split(text)
-        if strlen(a:prefix)
-                call map(tags, 'a:prefix . v:val')
-        endif
-        if strlen(a:joiner)
-                let idx = len(tags) - 1
-                while idx > 0
-                        call insert(tags, a:joiner, idx)
-                        let idx = idx - 1
-                endwhile
-        endif
-        let tags = b:nm_search_words + ['and', '('] + tags + [')']
+        let tags = b:nm_search_words + ['AND']
+                 \ + <SID>NM_combine_tags(a:prefix, split(text), a:joiner, '()')
 
         let prev_bufnr = bufnr('%')
         setlocal bufhidden=hide
@@ -387,7 +377,6 @@ function! s:NM_search_thread_id()
         if len(b:nm_raw_lines) <= mnum
                 return ''
         endif
-        echo 'len=' . string(len(b:nm_raw_lines)) . '  mnum=' . string(mnum)
         let info = b:nm_raw_lines[mnum]
         let what = split(info, '\s\+')[0]
         return what
@@ -420,7 +409,7 @@ function! s:NM_cmd_show(words)
         setlocal bufhidden=hide
         call <SID>NM_newBuffer('', 'show', join(info['disp'], "\n"))
         setlocal bufhidden=delete
-        let b:nm_words = a:words
+        let b:nm_search_words = a:words
         let b:nm_raw_info = info
         let b:nm_prev_bufnr = prev_bufnr
 
@@ -539,7 +528,7 @@ function! s:NM_show_advance_marking_read_and_archiving()
 
         let msg_top = <SID>NM_show_get_message_for_line(vis_top)
         if !has_key(msg_top,'id')
-                echo "No top visible message."
+                throw "No top visible message."
         endif
 
         " if the top message is the last message, just expunge the entire thread and move on
@@ -547,14 +536,12 @@ function! s:NM_show_advance_marking_read_and_archiving()
                 let ids = []
                 for msg in b:nm_raw_info['msgs']
                         if has_key(msg,'match') && msg['match'] != '0'
-                                if len(ids)
-                                        call add(ids, 'OR')
-                                endif
                                 call add(ids, msg['id'])
                         endif
                 endfor
-
-                let filter = ['('] + advance_tags + [')', 'AND', '('] + ids + [')']
+                let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
+                         \ + ['AND']
+                         \ + <SID>NM_combine_tags('', ids, 'OR', '()')
                 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
                 call <SID>NM_show_next(1, 1)
                 return
@@ -562,7 +549,7 @@ function! s:NM_show_advance_marking_read_and_archiving()
 
         let msg_bot = <SID>NM_show_get_message_for_line(vis_bot)
         if !has_key(msg_bot,'id')
-                echo "No bottom visible message."
+                throw "No bottom visible message."
         endif
 
         " if entire message fits on the screen, read/archive it, move to the next one
@@ -573,7 +560,8 @@ function! s:NM_show_advance_marking_read_and_archiving()
                 if has_key(msg_top,'match') && msg_top['match'] != '0'
                         redraw
                         " do this last to hide the latency
-                        let filter = ['('] + advance_tags + [')', 'AND', msg_top['id']]
+                        let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
+                                 \ + ['AND', msg_top['id']]
                         call <SID>NM_add_remove_tags(filter, '-', advance_tags)
                 endif
                 return
@@ -629,13 +617,6 @@ function! s:NM_show_message_id()
         return ''
 endfunction
 
-function! s:NM_show_search_words()
-        if !exists('b:nm_words')
-                throw 'Eeek! no b:nm_words'
-        endif
-        return b:nm_words
-endfunction
-
 function! s:NM_show_fold_toggle(key, type, fold)
         let info = b:nm_raw_info
         let act = 'open'
@@ -875,13 +856,7 @@ endfunction
 " --- implement compose screen {{{1
 
 function! s:NM_cmd_compose(words, body_lines)
-        let lines = !g:notmuch_compose_header_help ? [] : [
-                  \ 'Notmuch-Help: Type in your message here; to help you use these bindings:',
-                  \ 'Notmuch-Help:   ,a    - attach a file',
-                  \ 'Notmuch-Help:   ,s    - send the message (Notmuch-Help lines will be removed)',
-                  \ 'Notmuch-Help:   ,q    - abort the message',
-                  \ 'Notmuch-Help:   <Tab> - skip through header lines',
-                  \ ]
+        let lines = []
         let start_on_line = 0
 
         let hdrs = { }
@@ -919,7 +894,7 @@ function! s:NM_cmd_compose(words, body_lines)
                 endif
         endfor
 
-        call extend(lines, [ '', '' ])
+        call add(lines, '')
         if !start_on_line
                 let start_on_line = len(lines) + 1
         endif
@@ -927,25 +902,10 @@ function! s:NM_cmd_compose(words, body_lines)
         if len(a:body_lines)
                 call extend(lines, a:body_lines)
         else
-                call add(lines, '')
+                call extend(lines, [ '', '' ])
         endif
-        call extend(lines, g:notmuch_signature)
-
-        let prev_bufnr = bufnr('%')
-        setlocal bufhidden=hide
-        call <SID>NM_newFileBuffer(g:notmuch_compose_temp_file_dir, '%s.mail',
-                                  \ 'compose', lines)
-        setlocal bufhidden=hide
-        let b:nm_prev_bufnr = prev_bufnr
 
-        call <SID>NM_set_map('n', g:notmuch_compose_nmaps)
-        call <SID>NM_set_map('i', g:notmuch_compose_imaps)
-
-        call cursor(start_on_line, strlen(start_on_line) + 1)
-        if g:notmuch_compose_insert_mode_start
-                startinsert!
-        endif
-        echo 'Type your message, use <TAB> to jump to next header and then body.'
+        call <SID>NM_newComposeBuffer(lines, start_on_line)
 endfunction
 
 function! s:NM_compose_send()
@@ -1051,7 +1011,6 @@ endfunction
 function! s:NM_compose_next_entry_area()
         let lnum = line('.')
         let hdr_end = <SID>NM_compose_find_line_match(1,'^$',1)
-        echo 'header end = ' . string(hdr_end)
         if lnum < hdr_end
                 let lnum = lnum + 1
                 let line = getline(lnum)
@@ -1137,6 +1096,50 @@ function! s:NM_newFileBuffer(fdir, fname, type, lines)
         let b:nm_type = a:type
 endfunction
 
+function! s:NM_newComposeBuffer(lines, start_on_line)
+        let lines = a:lines
+        let start_on_line = a:start_on_line
+        let real_hdr_start = 1
+        if g:notmuch_compose_header_help
+                let help_lines = [
+                  \ 'Notmuch-Help: Type in your message here; to help you use these bindings:',
+                  \ 'Notmuch-Help:   ,a    - attach a file',
+                  \ 'Notmuch-Help:   ,s    - send the message (Notmuch-Help lines will be removed)',
+                  \ 'Notmuch-Help:   ,q    - abort the message',
+                  \ 'Notmuch-Help:   <Tab> - skip through header lines',
+                  \ ]
+                call extend(lines, help_lines, 0)
+                let real_hdr_start = len(help_lines)
+                if start_on_line > 0
+                        let start_on_line = start_on_line + len(help_lines)
+                endif
+        endif
+        call extend(lines, g:notmuch_signature)
+
+
+        let prev_bufnr = bufnr('%')
+        setlocal bufhidden=hide
+        call <SID>NM_newFileBuffer(g:notmuch_compose_temp_file_dir, '%s.mail',
+                                  \ 'compose', lines)
+        setlocal bufhidden=hide
+        let b:nm_prev_bufnr = prev_bufnr
+
+        call <SID>NM_set_map('n', g:notmuch_compose_nmaps)
+        call <SID>NM_set_map('i', g:notmuch_compose_imaps)
+
+        if start_on_line > 0 && start_on_line <= len(lines)
+                call cursor(start_on_line, strlen(getline(start_on_line)) + 1)
+        else
+                call cursor(real_hdr_start, strlen(getline(real_hdr_start) + 1)
+                call <SID>NM_compose_next_entry_area()
+        endif
+
+        if g:notmuch_compose_insert_mode_start
+                startinsert!
+        endif
+        echo 'Type your message, use <TAB> to jump to next header and then body.'
+endfunction
+
 function! s:NM_assert_buffer_type(type)
         if !exists('b:nm_type') || b:nm_type != a:type
                 throw printf('Eeek! expected type %s, but got %s.', a:type,
@@ -1227,12 +1230,43 @@ function! s:NM_new_mail()
         echo 'not implemented'
 endfunction
 
+" --- tag manipulation helpers {{{1
+
+" used to combine an array of words with prefixes and separators
+" example:
+"     NM_combine_tags('tag:', ['one', 'two', 'three'], 'OR', '()')
+"  -> ['(', 'tag:one', 'OR', 'tag:two', 'OR', 'tag:three', ')']
+function! s:NM_combine_tags(word_prefix, words, separator, brackets)
+        let res = []
+        for word in a:words
+                if len(res) && strlen(a:separator)
+                        call add(res, a:separator)
+                endif
+                call add(res, a:word_prefix . word)
+        endfor
+        if len(res) > 1 && strlen(a:brackets)
+                if strlen(a:brackets) != 2
+                        throw 'Eeek! brackets arg to NM_combine_tags must be 2 chars'
+                endif
+                call insert(res, a:brackets[0])
+                call add(res, a:brackets[1])
+        endif
+        return res
+endfunction
+
 " --- other helpers {{{1
 
+function! s:NM_get_search_words()
+        if !exists('b:nm_search_words')
+                throw 'Eeek! no b:nm_search_words'
+        endif
+        return b:nm_search_words
+endfunction
+
 function! s:NM_kill_this_buffer()
         if exists('b:nm_prev_bufnr')
                 let prev_bufnr = b:nm_prev_bufnr
-                bdelete
+                bdelete!
                 exec printf("buffer %d", prev_bufnr)
         else
                 echo "This is the last buffer; use :q<CR> to quit."
@@ -1251,7 +1285,7 @@ endfunction
 function! s:NM_add_remove_tags(filter, prefix, tags)
         let filter = len(a:filter) ? a:filter : [<SID>NM_search_thread_id()]
         if !len(filter)
-                echoe 'Eeek! I couldn''t find the thead id!'
+                throw 'Eeek! I couldn''t find the thead id!'
         endif
         call map(a:tags, 'a:prefix . v:val')
         let args = ['tag']
@@ -1270,7 +1304,7 @@ function! s:NM_add_remove_tags_on_screen(online, prefix, tags)
                 endfor
         else
                 for tagname in a:tags
-                        exec printf('silent! %ss/(\([^)]*\)\([^)]*\))$/(\1 %s)/', string(a:online), tagname)
+                        exec printf('silent! %ss/(\([^)]*\))$/(\1 %s)/', string(a:online), tagname)
                 endfor
         endif
         setlocal nomodifiable
@@ -1326,7 +1360,7 @@ function! s:NM_set_map(type, maps)
                 exec printf('%snoremap <buffer> %s %s', a:type, key, code)
         endfor
         " --- this is a hack for development :)
-        nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>
+        nnoremap ,nmr :runtime! plugin/notmuch.vim<CR>
 endfunction
 
 " --- command handler {{{1