1 " notmuch.vim plugin --- run notmuch within vim
3 " Copyright © Carl Worth
5 " This file is part of Notmuch.
7 " Notmuch is free software: you can redistribute it and/or modify it
8 " under the terms of the GNU General Public License as published by
9 " the Free Software Foundation, either version 3 of the License, or
10 " (at your option) any later version.
12 " Notmuch is distributed in the hope that it will be useful, but
13 " WITHOUT ANY WARRANTY; without even the implied warranty of
14 " MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 " General Public License for more details.
17 " You should have received a copy of the GNU General Public License
18 " along with Notmuch. If not, see <http://www.gnu.org/licenses/>.
20 " Authors: Bart Trojanowski <bart@jukie.net>
22 " --- configuration defaults {{{1
24 let s:notmuch_defaults = {
25 \ 'g:notmuch_cmd': 'notmuch' ,
26 \ 'g:notmuch_debug': 0 ,
28 \ 'g:notmuch_search_newest_first': 1 ,
29 \ 'g:notmuch_search_from_column_width': 20 ,
31 \ 'g:notmuch_show_fold_signatures': 1 ,
32 \ 'g:notmuch_show_fold_citations': 1 ,
33 \ 'g:notmuch_show_fold_bodies': 0 ,
34 \ 'g:notmuch_show_fold_headers': 1 ,
36 \ 'g:notmuch_show_message_begin_regexp': '
\fmessage{' ,
37 \ 'g:notmuch_show_message_end_regexp': '
\fmessage}' ,
38 \ 'g:notmuch_show_header_begin_regexp': '
\fheader{' ,
39 \ 'g:notmuch_show_header_end_regexp': '
\fheader}' ,
40 \ 'g:notmuch_show_body_begin_regexp': '
\fbody{' ,
41 \ 'g:notmuch_show_body_end_regexp': '
\fbody}' ,
42 \ 'g:notmuch_show_attachment_begin_regexp': '
\fattachment{' ,
43 \ 'g:notmuch_show_attachment_end_regexp': '
\fattachment}' ,
44 \ 'g:notmuch_show_part_begin_regexp': '
\fpart{' ,
45 \ 'g:notmuch_show_part_end_regexp': '
\fpart}' ,
46 \ 'g:notmuch_show_marker_regexp': '
\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$',
48 \ 'g:notmuch_show_message_parse_regexp': '\(id:[^ ]*\) depth:\([0-9]*\) match:\([0-9]*\) filename:\(.*\)$',
49 \ 'g:notmuch_show_tags_regexp': '(\([^)]*\))$' ,
51 \ 'g:notmuch_show_signature_regexp': '^\(-- \?\|_\+\)$' ,
52 \ 'g:notmuch_show_signature_lines_max': 12 ,
54 \ 'g:notmuch_show_citation_regexp': '^\s*>' ,
56 \ 'g:notmuch_compose_insert_mode_start': 1 ,
57 \ 'g:notmuch_compose_header_help': 1 ,
58 \ 'g:notmuch_compose_temp_file_dir': '~/.notmuch/compose/' ,
61 " defaults for g:notmuch_initial_search_words
62 " override with: let g:notmuch_initial_search_words = [ ... ]
63 let s:notmuch_initial_search_words_defaults = [
64 \ 'tag:inbox and tag:unread',
67 " defaults for g:notmuch_show_headers
68 " override with: let g:notmuch_show_headers = [ ... ]
69 let s:notmuch_show_headers_defaults = [
77 " defaults for g:notmuch_folders
78 " override with: let g:notmuch_folders = [ ... ]
79 let s:notmuch_folders_defaults = [
80 \ [ 'new', 'tag:inbox and tag:unread' ],
81 \ [ 'inbox', 'tag:inbox' ],
82 \ [ 'unread', 'tag:unread' ],
85 " defaults for g:notmuch_signature
86 " override with: let g:notmuch_signature = [ ... ]
87 let s:notmuch_signature_defaults = [
90 \ 'email sent from notmuch.vim plugin'
93 " defaults for g:notmuch_compose_headers
94 " override with: let g:notmuch_compose_headers = [ ... ]
95 let s:notmuch_compose_headers_defaults = [
103 " --- keyboard mapping definitions {{{1
105 " --- --- bindings for folders mode {{{2
107 let g:notmuch_folders_maps = {
108 \ 'm': ':call <SID>NM_new_mail()<CR>',
109 \ 's': ':call <SID>NM_search_prompt()<CR>',
110 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
111 \ '=': ':call <SID>NM_folders_refresh_view()<CR>',
112 \ '<Enter>': ':call <SID>NM_folders_show_search()<CR>',
115 " --- --- bindings for search screen {{{2
116 let g:notmuch_search_maps = {
117 \ '<Space>': ':call <SID>NM_search_show_thread(0)<CR>',
118 \ '<Enter>': ':call <SID>NM_search_show_thread(1)<CR>',
119 \ '<C-]>': ':call <SID>NM_search_expand(''<cword>'')<CR>',
120 \ 'a': ':call <SID>NM_search_archive_thread()<CR>',
121 \ 'f': ':call <SID>NM_search_filter()<CR>',
122 \ 'm': ':call <SID>NM_new_mail()<CR>',
123 \ 'o': ':call <SID>NM_search_toggle_order()<CR>',
124 \ 'r': ':call <SID>NM_search_reply_to_thread()<CR>',
125 \ 's': ':call <SID>NM_search_prompt()<CR>',
126 \ ',s': ':call <SID>NM_search_edit()<CR>',
127 \ 't': ':call <SID>NM_search_filter_by_tag()<CR>',
128 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
129 \ '+': ':call <SID>NM_search_add_tags([])<CR>',
130 \ '-': ':call <SID>NM_search_remove_tags([])<CR>',
131 \ '=': ':call <SID>NM_search_refresh_view()<CR>',
132 \ '?': ':echo <SID>NM_search_thread_id() . '' @ '' . join(<SID>NM_get_search_words())<CR>',
135 " --- --- bindings for show screen {{{2
136 let g:notmuch_show_maps = {
137 \ '<C-P>': ':call <SID>NM_show_previous(1, 0)<CR>',
138 \ '<C-N>': ':call <SID>NM_show_next(1, 0)<CR>',
139 \ '<C-]>': ':call <SID>NM_search_expand(''<cword>'')<CR>',
140 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
141 \ 's': ':call <SID>NM_search_prompt()<CR>',
143 \ 'b': ':call <SID>NM_show_fold_toggle(''b'', ''bdy'', !g:notmuch_show_fold_bodies)<CR>',
144 \ 'c': ':call <SID>NM_show_fold_toggle(''c'', ''cit'', !g:notmuch_show_fold_citations)<CR>',
145 \ 'h': ':call <SID>NM_show_fold_toggle(''h'', ''hdr'', !g:notmuch_show_fold_headers)<CR>',
146 \ 'i': ':call <SID>NM_show_fold_toggle(''s'', ''sig'', !g:notmuch_show_fold_signatures)<CR>',
148 \ 'a': ':call <SID>NM_show_archive_thread()<CR>',
149 \ 'A': ':call <SID>NM_show_mark_read_then_archive_thread()<CR>',
150 \ 'N': ':call <SID>NM_show_mark_read_then_next_open_message()<CR>',
151 \ 'v': ':call <SID>NM_show_view_all_mime_parts()<CR>',
152 \ '+': ':call <SID>NM_show_add_tag()<CR>',
153 \ '-': ':call <SID>NM_show_remove_tag()<CR>',
154 \ '<Space>': ':call <SID>NM_show_advance_marking_read_and_archiving()<CR>',
155 \ '\|': ':call <SID>NM_show_pipe_message()<CR>',
157 \ '<S-Tab>': ':call <SID>NM_show_previous_fold()<CR>',
158 \ '<Tab>': ':call <SID>NM_show_next_fold()<CR>',
159 \ '<Enter>': ':call <SID>NM_show_toggle_fold()<CR>',
161 \ 'r': ':call <SID>NM_show_reply()<CR>',
162 \ 'm': ':call <SID>NM_new_mail()<CR>',
163 \ '?': ':echo <SID>NM_show_message_id() . '' @ '' . join(<SID>NM_get_search_words())<CR>',
166 " --- --- bindings for compose screen {{{2
167 let g:notmuch_compose_nmaps = {
168 \ ',s': ':call <SID>NM_compose_send()<CR>',
169 \ ',a': ':call <SID>NM_compose_attach()<CR>',
170 \ ',q': ':call <SID>NM_kill_this_buffer()<CR>',
171 \ '<Tab>': ':call <SID>NM_compose_next_entry_area()<CR>',
173 let g:notmuch_compose_imaps = {
174 \ '<Tab>': '<C-r>=<SID>NM_compose_next_entry_area()<CR>',
177 " --- implement folders screen {{{1
179 function! s:NM_cmd_folders(words)
181 throw 'Not expecting any arguments for folders command.'
186 for entry in g:notmuch_folders
187 let [ name, search ] = entry
188 let data = s:NM_run(cmd + [search])
189 let cnt = matchlist(data, '\(\d\+\)')[1]
190 call add(disp, printf('%9d %-20s (%s)', cnt, name, search))
191 call add(searches, search)
194 call <SID>NM_newBuffer('', 'folders', join(disp, "\n"))
195 let b:nm_searches = searches
196 let b:nm_timestamp = reltime()
198 call <SID>NM_cmd_folders_mksyntax()
199 call <SID>NM_set_map('n', g:notmuch_folders_maps)
204 function! s:NM_cmd_folders_mksyntax()
207 " --- --- folders screen action functions {{{2
209 function! s:NM_folders_refresh_view()
211 setlocal bufhidden=delete
212 call s:NM_cmd_folders([])
213 exec printf('norm %dG', lno)
216 function! s:NM_folders_show_search()
218 let search = b:nm_searches[line-1]
220 let prev_bufnr = bufnr('%')
221 setlocal bufhidden=hide
222 call <SID>NM_cmd_search([search])
223 setlocal bufhidden=delete
224 let b:nm_prev_bufnr = prev_bufnr
228 " --- implement search screen {{{1
230 function! s:NM_cmd_search(words)
232 if g:notmuch_search_newest_first
233 let cmd = cmd + ['--sort=newest-first']
235 let cmd = cmd + ['--sort=oldest-first']
237 let data = s:NM_run(cmd + a:words)
238 let lines = split(data, "\n")
239 let disp = copy(lines)
240 call map(disp, 's:NM_cmd_search_fmtline(v:val)')
242 call <SID>NM_newBuffer('', 'search', join(disp, "\n"))
243 let b:nm_raw_lines = lines
244 let b:nm_search_words = a:words
246 call <SID>NM_set_map('n', g:notmuch_search_maps)
250 function! s:NM_cmd_search_fmtline(line)
251 let m = matchlist(a:line, '^\(thread:\S\+\)\s\(.\{12\}\) \[\(\d\+\)/\d\+\] \([^;]\+\); \%(\[[^\[]\+\] \)*\(.*\) (\([^(]*\))$')
253 return 'ERROR PARSING: ' . a:line
255 let max = g:notmuch_search_from_column_width
257 for at in split(m[4], ", ")
258 let p = min([stridx(at, "."), stridx(at, "@")])
259 call insert(flist, tolower(at[0:p - 1]))
261 let from = join(flist, ", ")
262 return printf("%-12s %3s %-20.20s | %s (%s)", m[2], m[3], from, m[5], m[6])
265 " --- --- search screen action functions {{{2
267 function! s:NM_search_show_thread(everything)
268 let words = [ <SID>NM_search_thread_id() ]
269 if !a:everything && exists('b:nm_search_words')
270 call extend(words, ['AND', '('])
271 call extend(words, b:nm_search_words)
274 call <SID>NM_cmd_show(words)
275 let b:nm_show_everything = a:everything
278 function! s:NM_search_prompt()
279 " TODO: input() can support completion
280 let text = input('NotMuch Search: ')
282 let tags = split(text)
284 let tags = s:notmuch_initial_search_words_defaults
286 let prev_bufnr = bufnr('%')
287 if b:nm_type == 'search' && exists('b:nm_prev_bufnr')
288 " TODO: we intend to replace the current buffer,
289 " ... maybe we could just clear it
290 let prev_bufnr = b:nm_prev_bufnr
291 setlocal bufhidden=delete
293 setlocal bufhidden=hide
295 call <SID>NM_cmd_search(tags)
296 setlocal bufhidden=delete
297 let b:nm_prev_bufnr = prev_bufnr
300 function! s:NM_search_edit()
301 " TODO: input() can support completion
302 let text = input('NotMuch Search: ', join(b:nm_search_words, ' '))
304 call <SID>NM_cmd_search(split(text))
308 function! s:NM_search_archive_thread()
309 call <SID>NM_add_remove_tags([], '-', ['inbox'])
313 function! s:NM_search_filter()
314 call <SID>NM_search_filter_helper('Filter: ', '', '')
317 function! s:NM_search_filter_by_tag()
318 call <SID>NM_search_filter_helper('Filter Tag(s): ', 'tag:', 'and')
321 function! s:NM_search_filter_helper(prompt, prefix, joiner)
322 " TODO: input() can support completion
323 let text = substitute(input(a:prompt), '\v(^\s*|\s*$|\n)', '', 'g')
328 let tags = b:nm_search_words + ['AND']
329 \ + <SID>NM_combine_tags(a:prefix, split(text), a:joiner, '()')
331 let prev_bufnr = bufnr('%')
332 setlocal bufhidden=hide
333 call <SID>NM_cmd_search(tags)
334 setlocal bufhidden=delete
335 let b:nm_prev_bufnr = prev_bufnr
338 function! s:NM_search_toggle_order()
339 let g:notmuch_search_newest_first = !g:notmuch_search_newest_first
340 " FIXME: maybe this would be better done w/o reading re-reading the lines
341 " reversing the b:nm_raw_lines and the buffer lines would be better
342 call <SID>NM_search_refresh_view()
345 function! s:NM_search_reply_to_thread()
347 call add(cmd, <SID>NM_search_thread_id())
349 call extend(cmd, <SID>NM_get_search_words())
351 let data = <SID>NM_run(cmd)
352 let lines = split(data, "\n")
353 call <SID>NM_newComposeBuffer(lines, 0)
356 function! s:NM_search_add_tags(tags)
357 call <SID>NM_search_add_remove_tags('Add Tag(s): ', '+', a:tags)
360 function! s:NM_search_remove_tags(tags)
361 call <SID>NM_search_add_remove_tags('Remove Tag(s): ', '-', a:tags)
364 function! s:NM_search_refresh_view()
366 let prev_bufnr = b:nm_prev_bufnr
367 setlocal bufhidden=delete
368 call <SID>NM_cmd_search(b:nm_search_words)
369 let b:nm_prev_bufnr = prev_bufnr
370 " FIXME: should find the line of the thread we were on if possible
371 exec printf('norm %dG', lno)
374 " --- --- search screen helper functions {{{2
376 function! s:NM_search_thread_id()
377 if !exists('b:nm_raw_lines')
378 throw 'Eeek! no b:nm_raw_lines'
380 let mnum = line('.') - 1
381 if len(b:nm_raw_lines) <= mnum
384 let info = b:nm_raw_lines[mnum]
385 let what = split(info, '\s\+')[0]
389 function! s:NM_search_add_remove_tags(prompt, prefix, intags)
390 if type(a:intags) != type([]) || len(a:intags) == 0
391 " TODO: input() can support completion
392 let text = input(a:prompt)
396 let tags = split(text, ' ')
400 call <SID>NM_add_remove_tags([], a:prefix, tags)
403 " --- implement show screen {{{1
405 function! s:NM_cmd_show(words)
406 let prev_bufnr = bufnr('%')
407 let data = s:NM_run(['show', '--entire-thread'] + a:words)
408 let lines = split(data, "\n")
410 let info = s:NM_cmd_show_parse(lines)
412 setlocal bufhidden=hide
413 call <SID>NM_newBuffer('', 'show', join(info['disp'], "\n"))
414 setlocal bufhidden=delete
415 let b:nm_search_words = a:words
416 let b:nm_raw_info = info
417 let b:nm_prev_bufnr = prev_bufnr
419 call <SID>NM_cmd_show_mkfolds()
420 call <SID>NM_cmd_show_mksyntax()
421 call <SID>NM_set_map('n', g:notmuch_show_maps)
422 setlocal foldtext=NM_cmd_show_foldtext()
424 setlocal foldcolumn=6
428 function! s:NM_show_previous(can_change_thread, find_matching)
429 let everything = exists('b:nm_show_everything') ? b:nm_show_everything : 0
430 let info = b:nm_raw_info
432 for msg in reverse(copy(info['msgs']))
433 if a:find_matching && msg['match'] == '0'
436 if lnum <= msg['start']
440 exec printf('norm %dGzt', msg['start'])
441 " TODO: try to fit the message on screen
444 if !a:can_change_thread
447 call <SID>NM_kill_this_buffer()
450 call <SID>NM_search_show_thread(everything)
452 call <SID>NM_show_previous(0, a:find_matching)
454 echo 'No more messages.'
458 function! s:NM_show_next(can_change_thread, find_matching)
459 let info = b:nm_raw_info
461 for msg in info['msgs']
462 if a:find_matching && msg['match'] == '0'
465 if lnum >= msg['start']
469 exec printf('norm %dGzt', msg['start'])
470 " TODO: try to fit the message on screen
473 if a:can_change_thread
474 call <SID>NM_show_next_thread()
478 function! s:NM_show_next_thread()
479 let everything = exists('b:nm_show_everything') ? b:nm_show_everything : 0
480 call <SID>NM_kill_this_buffer()
481 if line('.') != line('$')
483 call <SID>NM_search_show_thread(everything)
485 echo 'No more messages.'
489 function! s:NM_show_archive_thread()
490 echo 'not implemented'
493 function! s:NM_show_mark_read_then_archive_thread()
494 call <SID>NM_add_remove_tags(b:nm_search_words, '-', ['unread', 'inbox'])
495 call <SID>NM_show_next_thread()
498 function! s:NM_show_mark_read_then_next_open_message()
499 echo 'not implemented'
502 function! s:NM_show_previous_message()
503 echo 'not implemented'
506 function! s:NM_show_reply()
508 call add(cmd, <SID>NM_show_message_id())
510 call extend(cmd, <SID>NM_get_search_words())
512 let data = <SID>NM_run(cmd)
513 let lines = split(data, "\n")
514 call <SID>NM_newComposeBuffer(lines, 0)
517 function! s:NM_show_view_all_mime_parts()
518 echo 'not implemented'
521 function! s:NM_show_view_raw_message()
522 echo 'not implemented'
525 function! s:NM_show_add_tag()
526 echo 'not implemented'
529 function! s:NM_show_remove_tag()
530 echo 'not implemented'
533 " if entire message is not visible scroll down 1/2 page or less to get to the bottom of message
534 " otherwise go to next message
535 " any message that is viewed entirely has inbox and unread tags removed
536 function! s:NM_show_advance_marking_read_and_archiving()
537 let advance_tags = ['unread', 'inbox']
539 let vis_top = line('w0')
540 let vis_bot = line('w$')
542 let msg_top = <SID>NM_show_get_message_for_line(vis_top)
543 if !has_key(msg_top,'id')
544 throw "No top visible message."
547 " if the top message is the last message, just expunge the entire thread and move on
548 if msg_top['end'] == line('$')
550 for msg in b:nm_raw_info['msgs']
551 if has_key(msg,'match') && msg['match'] != '0'
552 call add(ids, msg['id'])
555 let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
557 \ + <SID>NM_combine_tags('', ids, 'OR', '()')
558 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
559 call <SID>NM_show_next(1, 1)
563 let msg_bot = <SID>NM_show_get_message_for_line(vis_bot)
564 if !has_key(msg_bot,'id')
565 throw "No bottom visible message."
568 " if entire message fits on the screen, read/archive it, move to the next one
569 if msg_top['id'] != msg_bot['id'] || msg_top['end'] <= vis_bot
570 exec printf('norm %dG', vis_top)
571 call <SID>NM_show_next(0, 1)
572 if has_key(msg_top,'match') && msg_top['match'] != '0'
574 " do this last to hide the latency
575 let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
576 \ + ['AND', msg_top['id']]
577 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
582 " entire message does not fit on the screen, scroll down to bottom, max 1/2 screen
583 let jmp = winheight(winnr()) / 2
584 let max = msg_bot['end'] - vis_bot
588 exec printf('norm %dGzt', vis_top + jmp)
592 function! s:NM_show_pipe_message()
593 echo 'not implemented'
596 function! s:NM_show_previous_fold()
597 echo 'not implemented'
600 function! s:NM_show_next_fold()
601 echo 'not implemented'
604 function! s:NM_show_toggle_fold()
605 echo 'not implemented'
609 " --- --- show screen helper functions {{{2
611 function! s:NM_show_get_message_for_line(line)
612 for msg in b:nm_raw_info['msgs']
613 if a:line > msg['end']
621 function! s:NM_show_message_id()
622 if !exists('b:nm_raw_info')
623 throw 'Eeek! no b:nm_raw_info'
625 let msg = <SID>NM_show_get_message_for_line(line('.'))
632 function! s:NM_show_fold_toggle(key, type, fold)
633 let info = b:nm_raw_info
638 for fld in info['folds']
643 "let msg = info['msgs'][idx]
644 "if has_key(msg,'match') && msg['match'] == '0'
647 let cls = foldclosed(fld[1])
648 if cls != -1 && cls != fld[1]
651 exec printf('%dfold%s', fld[1], act)
653 exec printf('nnoremap <buffer> %s :call <SID>NM_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
657 " s:NM_cmd_show_parse returns the following dictionary:
658 " 'disp': lines to display
659 " 'msgs': message info dicts { start, end, id, depth, filename, descr, header }
660 " 'folds': fold info arrays [ type, start, end ]
661 " 'foldtext': fold text indexed by start line
662 function! s:NM_cmd_show_parse(inlines)
663 let info = { 'disp': [],
682 for line in a:inlines
683 let inlnum = inlnum + 1
689 if match(line, g:notmuch_show_part_end_regexp) != -1
690 let part_end = len(info['disp'])
692 call add(info['disp'], line)
695 if in_part == 'text/plain'
696 if !part_end && mode_type == ''
697 if match(line, g:notmuch_show_signature_regexp) != -1
698 let mode_type = 'sig'
699 let mode_start = len(info['disp'])
700 elseif match(line, g:notmuch_show_citation_regexp) != -1
701 let mode_type = 'cit'
702 let mode_start = len(info['disp'])
704 elseif mode_type == 'cit'
705 if part_end || match(line, g:notmuch_show_citation_regexp) == -1
706 let outlnum = len(info['disp'])
707 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
708 \ printf('[ %d-line citation. Press "c" to show. ]', outlnum - mode_start) ]
711 elseif mode_type == 'sig'
712 let outlnum = len(info['disp'])
713 if (outlnum - mode_start) > g:notmuch_show_signature_lines_max
716 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
717 \ printf('[ %d-line signature. Press "s" to show. ]', outlnum - mode_start) ]
724 " FIXME: this is a hack for handling two folds being added for one line
725 " we should handle addinga fold in a function
726 if len(foldinfo) && foldinfo[1] < foldinfo[2]
727 call add(info['folds'], foldinfo[0:3])
728 let info['foldtext'][foldinfo[1]] = foldinfo[4]
731 let foldinfo = [ 'text', part_start, part_end, len(info['msgs']),
732 \ printf('[ %d-line %s. Press "p" to show. ]', part_end - part_start, in_part) ]
734 call add(info['disp'], '')
738 if !has_key(msg,'body_start')
739 let msg['body_start'] = len(info['disp']) + 1
741 if match(line, g:notmuch_show_body_end_regexp) != -1
742 let body_end = len(info['disp'])
743 let foldinfo = [ 'bdy', body_start, body_end, len(info['msgs']),
744 \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
748 elseif match(line, g:notmuch_show_part_begin_regexp) != -1
749 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
750 let in_part = 'unknown'
754 call add(info['disp'],
755 \ printf('--- %s ---', in_part))
756 let part_start = len(info['disp']) + 1
761 let msg['descr'] = line
762 call add(info['disp'], line)
764 let msg['hdr_start'] = len(info['disp']) + 1
767 if match(line, g:notmuch_show_header_end_regexp) != -1
768 let hdr_start = msg['hdr_start']+1
769 let hdr_end = len(info['disp'])
770 let foldinfo = [ 'hdr', hdr_start, hdr_end, len(info['msgs']),
771 \ printf('[ %d-line headers. Press "h" to show. ]', hdr_end + 1 - hdr_start) ]
772 let msg['header'] = hdr
776 let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
779 if match(g:notmuch_show_headers, m[1]) != -1
780 call add(info['disp'], line)
787 if match(line, g:notmuch_show_message_end_regexp) != -1
788 let msg['end'] = len(info['disp'])
789 call add(info['disp'], '')
791 let foldinfo = [ 'msg', msg['start'], msg['end'], len(info['msgs']),
792 \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
794 call add(info['msgs'], msg)
801 elseif match(line, g:notmuch_show_header_begin_regexp) != -1
805 elseif match(line, g:notmuch_show_body_begin_regexp) != -1
806 let body_start = len(info['disp']) + 1
812 if match(line, g:notmuch_show_message_begin_regexp) != -1
813 let msg['start'] = len(info['disp']) + 1
815 let m = matchlist(line, g:notmuch_show_message_parse_regexp)
818 let msg['depth'] = m[2]
819 let msg['match'] = m[3]
820 let msg['filename'] = m[4]
827 if len(foldinfo) && foldinfo[1] < foldinfo[2]
828 call add(info['folds'], foldinfo[0:3])
829 let info['foldtext'][foldinfo[1]] = foldinfo[4]
835 function! s:NM_cmd_show_mkfolds()
836 let info = b:nm_raw_info
838 for afold in info['folds']
839 exec printf('%d,%dfold', afold[1], afold[2])
841 if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
842 \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
843 \ || (afold[0] == 'bdy' && g:notmuch_show_fold_bodies)
844 \ || (afold[0] == 'hdr' && g:notmuch_show_fold_headers)
846 elseif afold[0] == 'msg'
848 let msg = info['msgs'][idx]
849 if has_key(msg,'match') && msg['match'] == '0'
853 exec printf('%dfold%s', afold[1], state)
857 function! s:NM_cmd_show_mksyntax()
858 let info = b:nm_raw_info
860 for msg in info['msgs']
862 let start = msg['start']
863 let hdr_start = msg['hdr_start']
864 let body_start = msg['body_start']
866 exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
867 exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
868 exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
872 function! NM_cmd_show_foldtext()
873 let foldtext = b:nm_raw_info['foldtext']
874 return foldtext[v:foldstart]
878 " --- implement compose screen {{{1
880 function! s:NM_cmd_compose(words, body_lines)
882 let start_on_line = 0
886 let m = matchlist(word, '^\(\w[^:]*\):\s*\(.*\)\s*$')
888 throw 'Eeek! bad parameter ''' . string(word) . ''''
890 let key = substitute(m[1], '\<\w', '\U&', 'g')
891 if !has_key(hdrs, key)
895 call add(hdrs[key], m[2])
899 if !has_key(hdrs, 'From') || !len(hdrs['From'])
900 let me = <SID>NM_compose_get_user_email()
901 let hdrs['From'] = [ me ]
904 for key in g:notmuch_compose_headers
905 let text = has_key(hdrs, key) ? join(hdrs[key], ', ') : ''
906 call add(lines, key . ': ' . text)
907 if !start_on_line && !strlen(text)
908 let start_on_line = len(lines)
912 for [key,val] in items(hdrs)
913 if match(g:notmuch_compose_headers, key) == -1
914 let line = key . ': ' . join(val, ', ')
915 call add(lines, line)
921 let start_on_line = len(lines) + 1
925 call extend(lines, a:body_lines)
927 call extend(lines, [ '', '' ])
930 call <SID>NM_newComposeBuffer(lines, start_on_line)
933 function! s:NM_compose_send()
934 call <SID>NM_assert_buffer_type('compose')
935 let fname = expand('%')
937 let line = getline(lnum)
940 while match(line, '^$') == -1
941 if match(line, '^Notmuch-Help:') != -1
943 elseif strlen(lst_hdr) && match(line, '^\s') != -1
944 let hdrs[lst_hdr][-1] = hdrs[lst_hdr][-1] . substitute(line, '^\s*', ' ', '')
946 let m = matchlist(line, '^\(\w[^:]*\):\s*\(.*\)\s*$')
949 throw printf('Eeek! invalid header on line %d', lnum)
951 let key = substitute(m[1], '\<\w', '\U&', 'g')
953 if !has_key(hdrs, key)
956 call add(hdrs[key], m[2])
961 let line = getline(lnum)
963 let body_starts = lnum
965 "[-a header] [-b bcc-addr] [-c cc-addr] [-s subject] to-addr
968 for [key, vals] in items(hdrs)
970 call extend(tos, vals)
981 elseif key == 'Subject'
989 call add(cmd, key . ': ' . val)
993 call extend(cmd, tos)
995 " TODO: make sure we have at least one target
996 " TODO: ask about empty jubject, etc
998 exec printf('0,%dd', body_starts)
1001 call map(cmd, 's:NM_shell_escape(v:val)')
1002 let cmdtxt = join(cmd) . '< ' . fname
1003 let out = system(cmdtxt)
1004 let err = v:shell_error
1008 call <SID>NM_newBuffer('new', 'error',
1009 \ "While running...\n" .
1010 \ ' ' . cmdtxt . "\n" .
1012 \ "Failed with...\n" .
1013 \ substitute(out, '^', ' ', 'g'))
1015 echo 'Eeek! unable to send mail'
1020 if !exists('b:nm_prev_bufnr')
1023 let prev_bufnr = b:nm_prev_bufnr
1025 if prev_bufnr == bufnr('%')
1026 exec printf("buffer %d", prev_bufnr)
1030 echo 'Mail sent successfully.'
1033 function! s:NM_compose_attach()
1034 echo 'not implemented'
1037 function! s:NM_compose_next_entry_area()
1038 let lnum = line('.')
1039 let hdr_end = <SID>NM_compose_find_line_match(1,'^$',1)
1042 let line = getline(lnum)
1043 if match(line, '^\([^:]\+\):\s*$') == -1
1044 call cursor(lnum, strlen(line) + 1)
1047 while match(getline(lnum+1), '^\s') != -1
1050 call cursor(lnum, strlen(getline(lnum)) + 1)
1053 elseif lnum == hdr_end
1054 call cursor(lnum+1, strlen(getline(lnum+1)) + 1)
1058 if !getbufvar(bufnr('.'), '&et')
1062 let shiftwidth = a:shiftwidth
1063 let shiftwidth = shiftwidth - ((virtcol('.')-1) % shiftwidth)
1064 " we assume no one has shiftwidth set to more than 40 :)
1065 return ' '[0:shiftwidth]
1069 " --- --- compose screen helper functions {{{2
1071 function! s:NM_compose_get_user_email()
1072 let name = substitute(system('id -u -n'), '\v(^\s*|\s*$|\n)', '', 'g')
1073 let fqdn = substitute(system('hostname -f'), '\v(^\s*|\s*$|\n)', '', 'g')
1075 " TODO: do this properly
1076 return name . '@' . fqdn
1079 function! s:NM_compose_find_line_match(start, pattern, failure)
1081 let lend = line('$')
1083 if match(getline(lnum), a:pattern) != -1
1092 " --- notmuch helper functions {{{1
1094 function! s:NM_newBuffer(how, type, content)
1100 setlocal buftype=nofile readonly modifiable scrolloff=0 sidescrolloff=0
1101 silent put=a:content
1103 setlocal nomodifiable
1104 execute printf('set filetype=notmuch-%s', a:type)
1105 execute printf('set syntax=notmuch-%s', a:type)
1106 let b:nm_type = a:type
1109 function! s:NM_newFileBuffer(fdir, fname, type, lines)
1110 let fdir = expand(a:fdir)
1111 if !isdirectory(fdir)
1112 call mkdir(fdir, 'p')
1114 let file_name = <SID>NM_mktemp(fdir, a:fname)
1115 if writefile(a:lines, file_name)
1116 throw 'Eeek! couldn''t write to temporary file ' . file_name
1118 exec printf('edit %s', file_name)
1119 setlocal buftype= noreadonly modifiable scrolloff=0 sidescrolloff=0
1120 execute printf('set filetype=notmuch-%s', a:type)
1121 execute printf('set syntax=notmuch-%s', a:type)
1122 let b:nm_type = a:type
1125 function! s:NM_newComposeBuffer(lines, start_on_line)
1127 let start_on_line = a:start_on_line
1128 let real_hdr_start = 1
1129 if g:notmuch_compose_header_help
1131 \ 'Notmuch-Help: Type in your message here; to help you use these bindings:',
1132 \ 'Notmuch-Help: ,a - attach a file',
1133 \ 'Notmuch-Help: ,s - send the message (Notmuch-Help lines will be removed)',
1134 \ 'Notmuch-Help: ,q - abort the message',
1135 \ 'Notmuch-Help: <Tab> - skip through header lines',
1137 call extend(lines, help_lines, 0)
1138 let real_hdr_start = len(help_lines)
1139 if start_on_line > 0
1140 let start_on_line = start_on_line + len(help_lines)
1143 call extend(lines, g:notmuch_signature)
1146 let prev_bufnr = bufnr('%')
1147 setlocal bufhidden=hide
1148 call <SID>NM_newFileBuffer(g:notmuch_compose_temp_file_dir, '%s.mail',
1150 setlocal bufhidden=hide
1151 let b:nm_prev_bufnr = prev_bufnr
1153 call <SID>NM_set_map('n', g:notmuch_compose_nmaps)
1154 call <SID>NM_set_map('i', g:notmuch_compose_imaps)
1156 if start_on_line > 0 && start_on_line <= len(lines)
1157 call cursor(start_on_line, strlen(getline(start_on_line)) + 1)
1159 call cursor(real_hdr_start, strlen(getline(real_hdr_start)) + 1)
1160 call <SID>NM_compose_next_entry_area()
1163 if g:notmuch_compose_insert_mode_start
1166 echo 'Type your message, use <TAB> to jump to next header and then body.'
1169 function! s:NM_assert_buffer_type(type)
1170 if !exists('b:nm_type') || b:nm_type != a:type
1171 throw printf('Eeek! expected type %s, but got %s.', a:type,
1172 \ exists(b:nm_type) ? b:nm_type : 'something else')
1176 function! s:NM_mktemp(dir, name)
1177 let time_stamp = strftime('%Y%m%d-%H%M%S')
1178 let file_name = substitute(a:dir,'/*$','/','') . printf(a:name, time_stamp)
1179 " TODO: check if it exists, try again
1183 function! s:NM_shell_escape(word)
1184 " TODO: use shellescape()
1185 let word = substitute(a:word, '''', '\\''', 'g')
1186 return '''' . word . ''''
1189 " this function was taken from git.vim, then fixed up
1190 " http://github.com/motemen/git-vim
1191 function! s:NM_shell_split(cmd)
1192 let l:split_cmd = []
1196 let t = match(cmd, '\S', iStart)
1202 let iSpace = match(cmd, '\v(\s|$)', iStart)
1207 let iQuote1 = match(cmd, '\(^["'']\|[^\\]\@<=["'']\)', iStart)
1208 if iQuote1 > iSpace || iQuote1 < iStart
1209 let iEnd = iSpace - 1
1210 let l:split_cmd += [ cmd[iStart : iEnd] ]
1212 let q = cmd[iQuote1]
1213 let iQuote2 = match(cmd, '[^\\]\@<=[' . q . ']', iQuote1 + 1)
1214 if iQuote2 < iQuote1
1215 throw 'No matching ' . q . ' quote'
1218 let l:split_cmd += [ cmd[iStart+1 : iEnd-1 ] ]
1222 let iStart = iEnd + 1
1229 function! s:NM_run(args)
1231 call map(words, 's:NM_shell_escape(v:val)')
1232 let cmd = g:notmuch_cmd . ' ' . join(words) . '< /dev/null'
1234 let start = reltime()
1235 let out = system(cmd)
1236 let err = v:shell_error
1237 let delta = reltime(start)
1239 if exists('g:notmuch_debug') && g:notmuch_debug
1240 echo printf('[%s] {%s} %s', reltimestr(delta), string(err), string(cmd))
1245 echo substitute(out, '\n*$', '', '')
1253 " --- external mail handling helpers {{{1
1255 function! s:NM_new_mail()
1256 call <SID>NM_cmd_compose([], [])
1259 " --- tag manipulation helpers {{{1
1261 " used to combine an array of words with prefixes and separators
1263 " NM_combine_tags('tag:', ['one', 'two', 'three'], 'OR', '()')
1264 " -> ['(', 'tag:one', 'OR', 'tag:two', 'OR', 'tag:three', ')']
1265 function! s:NM_combine_tags(word_prefix, words, separator, brackets)
1268 if len(res) && strlen(a:separator)
1269 call add(res, a:separator)
1271 call add(res, a:word_prefix . word)
1273 if len(res) > 1 && strlen(a:brackets)
1274 if strlen(a:brackets) != 2
1275 throw 'Eeek! brackets arg to NM_combine_tags must be 2 chars'
1277 call insert(res, a:brackets[0])
1278 call add(res, a:brackets[1])
1283 " --- other helpers {{{1
1285 function! s:NM_get_search_words()
1286 if !exists('b:nm_search_words')
1287 throw 'Eeek! no b:nm_search_words'
1289 return b:nm_search_words
1292 function! s:NM_kill_this_buffer()
1293 if exists('b:nm_prev_bufnr')
1294 let prev_bufnr = b:nm_prev_bufnr
1296 exec printf("buffer %d", prev_bufnr)
1298 echo "This is the last buffer; use :q<CR> to quit."
1302 function! s:NM_search_expand(arg)
1303 let word = expand(a:arg)
1304 let prev_bufnr = bufnr('%')
1305 setlocal bufhidden=hide
1306 call <SID>NM_cmd_search([word])
1307 setlocal bufhidden=delete
1308 let b:nm_prev_bufnr = prev_bufnr
1311 function! s:NM_add_remove_tags(filter, prefix, tags)
1312 let filter = len(a:filter) ? a:filter : [<SID>NM_search_thread_id()]
1314 throw 'Eeek! I couldn''t find the thead id!'
1316 call map(a:tags, 'a:prefix . v:val')
1318 call extend(args, a:tags)
1319 call add(args, '--')
1320 call extend(args, filter)
1321 " TODO: handle errors
1322 call <SID>NM_run(args)
1325 " --- process and set the defaults {{{1
1327 function! NM_set_defaults(force)
1328 for [key, dflt] in items(s:notmuch_defaults)
1330 if !a:force && exists(key) && type(dflt) == type(eval(key))
1332 elseif type(dflt) == type(0)
1333 let cmd = printf('let %s = %d', key, dflt)
1334 elseif type(dflt) == type('')
1335 let cmd = printf('let %s = ''%s''', key, dflt)
1336 " FIXME: not sure why this didn't work when dflt is an array
1337 "elseif type(dflt) == type([])
1338 " let cmd = printf('let %s = %s', key, string(dflt))
1340 echoe printf('E: Unknown type in NM_set_defaults(%d) using [%s,%s]',
1341 \ a:force, key, string(dflt))
1347 call NM_set_defaults(0)
1349 " for some reason NM_set_defaults() didn't work for arrays...
1350 if !exists('g:notmuch_show_headers')
1351 let g:notmuch_show_headers = s:notmuch_show_headers_defaults
1353 if !exists('g:notmuch_initial_search_words')
1354 let g:notmuch_initial_search_words = s:notmuch_initial_search_words_defaults
1356 if !exists('g:notmuch_folders')
1357 let g:notmuch_folders = s:notmuch_folders_defaults
1360 if !exists('g:notmuch_signature')
1361 let g:notmuch_signature = s:notmuch_signature_defaults
1363 if !exists('g:notmuch_compose_headers')
1364 let g:notmuch_compose_headers = s:notmuch_compose_headers_defaults
1367 " --- assign keymaps {{{1
1369 function! s:NM_set_map(type, maps)
1371 for [key, code] in items(a:maps)
1372 exec printf('%snoremap <buffer> %s %s', a:type, key, code)
1374 " --- this is a hack for development :)
1375 nnoremap ,nmr :runtime! plugin/notmuch.vim<CR>
1378 " --- command handler {{{1
1380 function! NotMuch(args)
1383 let args = 'folders'
1386 let words = <SID>NM_shell_split(args)
1387 if words[0] == 'folders' || words[0] == 'f'
1388 let words = words[1:]
1389 call <SID>NM_cmd_folders(words)
1391 elseif words[0] == 'search' || words[0] == 's'
1393 let words = words[1:]
1394 elseif exists('b:nm_search_words')
1395 let words = b:nm_search_words
1397 let words = g:notmuch_initial_search_words
1399 call <SID>NM_cmd_search(words)
1401 elseif words[0] == 'show'
1402 echoe 'show is not yet implemented.'
1404 elseif words[0] == 'new' || words[0] == 'compose'
1405 let words = words[1:]
1406 call <SID>NM_cmd_compose(words, [])
1409 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
1416 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
1417 cabbrev notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
1419 " vim: set ft=vim ts=8 sw=8 et foldmethod=marker :