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 exapecting 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_cmd_search_mksyntax()
247 call <SID>NM_set_map('n', g:notmuch_search_maps)
251 function! s:NM_cmd_search_fmtline(line)
252 let m = matchlist(a:line, '^\(thread:\S\+\)\s\([^]]\+\]\) \([^;]\+\); \(.*\) (\([^(]*\))$')
254 return 'ERROR PARSING: ' . a:line
256 let max = g:notmuch_search_from_column_width
258 if strlen(from) >= max
259 let from = substitute(m[3][0:max-4], '[^A-Za-z1-9_]*$', '', '') . '...'
261 return printf('%-20s %-20s | %s (%s)', m[2], from, m[4], m[5])
263 function! s:NM_cmd_search_mksyntax()
264 syntax clear nmSearchFrom
265 exec printf('syntax match nmSearchFrom /\(\] \)\@<=.\{%d\}/ oneline contained', g:notmuch_search_from_column_width)
268 " --- --- search screen action functions {{{2
270 function! s:NM_search_show_thread(everything)
271 let words = [ <SID>NM_search_thread_id() ]
272 if !a:everything && exists('b:nm_search_words')
273 call extend(words, ['AND', '('])
274 call extend(words, b:nm_search_words)
277 call <SID>NM_cmd_show(words)
280 function! s:NM_search_prompt()
281 " TODO: input() can support completion
282 let text = input('NotMuch Search: ')
284 let tags = split(text)
286 let tags = s:notmuch_initial_search_words_defaults
288 let prev_bufnr = bufnr('%')
289 if b:nm_type == 'search' && exists('b:nm_prev_bufnr')
290 " TODO: we intend to replace the current buffer,
291 " ... maybe we could just clear it
292 let prev_bufnr = b:nm_prev_bufnr
293 setlocal bufhidden=delete
295 setlocal bufhidden=hide
297 call <SID>NM_cmd_search(tags)
298 setlocal bufhidden=delete
299 let b:nm_prev_bufnr = prev_bufnr
302 function! s:NM_search_edit()
303 " TODO: input() can support completion
304 let text = input('NotMuch Search: ', join(b:nm_search_words, ' '))
306 call <SID>NM_cmd_search(split(text))
310 function! s:NM_search_archive_thread()
311 call <SID>NM_add_remove_tags_on_screen('', '-', ['inbox'])
312 call <SID>NM_add_remove_tags([], '-', ['inbox'])
316 function! s:NM_search_filter()
317 call <SID>NM_search_filter_helper('Filter: ', '', '')
320 function! s:NM_search_filter_by_tag()
321 call <SID>NM_search_filter_helper('Filter Tag(s): ', 'tag:', 'and')
324 function! s:NM_search_filter_helper(prompt, prefix, joiner)
325 " TODO: input() can support completion
326 let text = substitute(input(a:prompt), '\v(^\s*|\s*$|\n)', '', 'g')
331 let tags = b:nm_search_words + ['AND']
332 \ + <SID>NM_combine_tags(a:prefix, split(text), a:joiner, '()')
334 let prev_bufnr = bufnr('%')
335 setlocal bufhidden=hide
336 call <SID>NM_cmd_search(tags)
337 setlocal bufhidden=delete
338 let b:nm_prev_bufnr = prev_bufnr
341 function! s:NM_search_toggle_order()
342 let g:notmuch_search_newest_first = !g:notmuch_search_newest_first
343 " FIXME: maybe this would be better done w/o reading re-reading the lines
344 " reversing the b:nm_raw_lines and the buffer lines would be better
345 call <SID>NM_search_refresh_view()
348 function! s:NM_search_reply_to_thread()
350 call add(cmd, <SID>NM_search_thread_id())
352 call extend(cmd, <SID>NM_get_search_words())
354 let data = <SID>NM_run(cmd)
355 let lines = split(data, "\n")
356 call <SID>NM_newComposeBuffer(lines, 0)
359 function! s:NM_search_add_tags(tags)
360 call <SID>NM_search_add_remove_tags('Add Tag(s): ', '+', a:tags)
363 function! s:NM_search_remove_tags(tags)
364 call <SID>NM_search_add_remove_tags('Remove Tag(s): ', '-', a:tags)
367 function! s:NM_search_refresh_view()
369 let prev_bufnr = b:nm_prev_bufnr
370 setlocal bufhidden=delete
371 call <SID>NM_cmd_search(b:nm_search_words)
372 let b:nm_prev_bufnr = prev_bufnr
373 " FIXME: should find the line of the thread we were on if possible
374 exec printf('norm %dG', lno)
377 " --- --- search screen helper functions {{{2
379 function! s:NM_search_thread_id()
380 if !exists('b:nm_raw_lines')
381 throw 'Eeek! no b:nm_raw_lines'
383 let mnum = line('.') - 1
384 if len(b:nm_raw_lines) <= mnum
387 let info = b:nm_raw_lines[mnum]
388 let what = split(info, '\s\+')[0]
392 function! s:NM_search_add_remove_tags(prompt, prefix, intags)
393 if type(a:intags) != type([]) || len(a:intags) == 0
394 " TODO: input() can support completion
395 let text = input(a:prompt)
399 let tags = split(text, ' ')
403 call <SID>NM_add_remove_tags([], a:prefix, tags)
404 call <SID>NM_add_remove_tags_on_screen('', a:prefix, tags)
407 " --- implement show screen {{{1
409 function! s:NM_cmd_show(words)
410 let prev_bufnr = bufnr('%')
411 let data = s:NM_run(['show'] + a:words)
412 let lines = split(data, "\n")
414 let info = s:NM_cmd_show_parse(lines)
416 setlocal bufhidden=hide
417 call <SID>NM_newBuffer('', 'show', join(info['disp'], "\n"))
418 setlocal bufhidden=delete
419 let b:nm_search_words = a:words
420 let b:nm_raw_info = info
421 let b:nm_prev_bufnr = prev_bufnr
423 call <SID>NM_cmd_show_mkfolds()
424 call <SID>NM_cmd_show_mksyntax()
425 call <SID>NM_set_map('n', g:notmuch_show_maps)
426 setlocal foldtext=NM_cmd_show_foldtext()
428 setlocal foldcolumn=6
432 function! s:NM_show_previous(can_change_thread, find_matching)
433 let info = b:nm_raw_info
435 for msg in reverse(copy(info['msgs']))
436 if a:find_matching && msg['match'] == '0'
439 if lnum <= msg['start']
443 exec printf('norm %dGzt', msg['start'])
444 " TODO: try to fit the message on screen
447 if !a:can_change_thread
450 call <SID>NM_kill_this_buffer()
453 call <SID>NM_search_show_thread()
455 call <SID>NM_show_previous(0, a:find_matching)
457 echo 'No more messages.'
461 function! s:NM_show_next(can_change_thread, find_matching)
462 let info = b:nm_raw_info
464 for msg in info['msgs']
465 if a:find_matching && msg['match'] == '0'
468 if lnum >= msg['start']
472 exec printf('norm %dGzt', msg['start'])
473 " TODO: try to fit the message on screen
476 if a:can_change_thread
477 call <SID>NM_show_next_thread()
481 function! s:NM_show_next_thread()
482 call <SID>NM_kill_this_buffer()
483 if line('.') != line('$')
485 call <SID>NM_search_show_thread()
487 echo 'No more messages.'
491 function! s:NM_show_archive_thread()
492 echo 'not implemented'
495 function! s:NM_show_mark_read_then_archive_thread()
496 echo 'not implemented'
499 function! s:NM_show_mark_read_then_next_open_message()
500 echo 'not implemented'
503 function! s:NM_show_previous_message()
504 echo 'not implemented'
507 function! s:NM_show_reply()
509 call add(cmd, <SID>NM_show_message_id())
511 call extend(cmd, <SID>NM_get_search_words())
513 let data = <SID>NM_run(cmd)
514 let lines = split(data, "\n")
515 call <SID>NM_newComposeBuffer(lines, 0)
518 function! s:NM_show_view_all_mime_parts()
519 echo 'not implemented'
522 function! s:NM_show_view_raw_message()
523 echo 'not implemented'
526 function! s:NM_show_add_tag()
527 echo 'not implemented'
530 function! s:NM_show_remove_tag()
531 echo 'not implemented'
534 " if entire message is not visible scroll down 1/2 page or less to get to the bottom of message
535 " otherwise go to next message
536 " any message that is viewed entirely has inbox and unread tags removed
537 function! s:NM_show_advance_marking_read_and_archiving()
538 let advance_tags = ['unread', 'inbox']
540 let vis_top = line('w0')
541 let vis_bot = line('w$')
543 let msg_top = <SID>NM_show_get_message_for_line(vis_top)
544 if !has_key(msg_top,'id')
545 throw "No top visible message."
548 " if the top message is the last message, just expunge the entire thread and move on
549 if msg_top['end'] == line('$')
551 for msg in b:nm_raw_info['msgs']
552 if has_key(msg,'match') && msg['match'] != '0'
553 call add(ids, msg['id'])
556 let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
558 \ + <SID>NM_combine_tags('', ids, 'OR', '()')
559 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
560 call <SID>NM_show_next(1, 1)
564 let msg_bot = <SID>NM_show_get_message_for_line(vis_bot)
565 if !has_key(msg_bot,'id')
566 throw "No bottom visible message."
569 " if entire message fits on the screen, read/archive it, move to the next one
570 if msg_top['id'] != msg_bot['id'] || msg_top['end'] <= vis_bot
571 call <SID>NM_add_remove_tags_on_screen(msg_top['start'], '-', advance_tags)
572 exec printf('norm %dG', vis_top)
573 call <SID>NM_show_next(0, 1)
574 if has_key(msg_top,'match') && msg_top['match'] != '0'
576 " do this last to hide the latency
577 let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
578 \ + ['AND', msg_top['id']]
579 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
584 " entire message does not fit on the screen, scroll down to bottom, max 1/2 screen
585 let jmp = winheight(winnr()) / 2
586 let max = msg_bot['end'] - vis_bot
590 exec printf('norm %dGzt', vis_top + jmp)
594 function! s:NM_show_pipe_message()
595 echo 'not implemented'
598 function! s:NM_show_previous_fold()
599 echo 'not implemented'
602 function! s:NM_show_next_fold()
603 echo 'not implemented'
606 function! s:NM_show_toggle_fold()
607 echo 'not implemented'
611 " --- --- show screen helper functions {{{2
613 function! s:NM_show_get_message_for_line(line)
614 for msg in b:nm_raw_info['msgs']
615 if a:line > msg['end']
623 function! s:NM_show_message_id()
624 if !exists('b:nm_raw_info')
625 throw 'Eeek! no b:nm_raw_info'
627 let msg = <SID>NM_show_get_message_for_line(line('.'))
634 function! s:NM_show_fold_toggle(key, type, fold)
635 let info = b:nm_raw_info
640 for fld in info['folds']
645 "let msg = info['msgs'][idx]
646 "if has_key(msg,'match') && msg['match'] == '0'
649 let cls = foldclosed(fld[1])
650 if cls != -1 && cls != fld[1]
653 exec printf('%dfold%s', fld[1], act)
655 exec printf('nnoremap <buffer> %s :call <SID>NM_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
659 " s:NM_cmd_show_parse returns the following dictionary:
660 " 'disp': lines to display
661 " 'msgs': message info dicts { start, end, id, depth, filename, descr, header }
662 " 'folds': fold info arrays [ type, start, end ]
663 " 'foldtext': fold text indexed by start line
664 function! s:NM_cmd_show_parse(inlines)
665 let info = { 'disp': [],
684 for line in a:inlines
685 let inlnum = inlnum + 1
691 if match(line, g:notmuch_show_part_end_regexp) != -1
692 let part_end = len(info['disp'])
694 call add(info['disp'], line)
697 if in_part == 'text/plain'
698 if !part_end && mode_type == ''
699 if match(line, g:notmuch_show_signature_regexp) != -1
700 let mode_type = 'sig'
701 let mode_start = len(info['disp'])
702 elseif match(line, g:notmuch_show_citation_regexp) != -1
703 let mode_type = 'cit'
704 let mode_start = len(info['disp'])
706 elseif mode_type == 'cit'
707 if part_end || match(line, g:notmuch_show_citation_regexp) == -1
708 let outlnum = len(info['disp'])
709 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
710 \ printf('[ %d-line citation. Press "c" to show. ]', outlnum - mode_start) ]
713 elseif mode_type == 'sig'
714 let outlnum = len(info['disp'])
715 if (outlnum - mode_start) > g:notmuch_show_signature_lines_max
718 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
719 \ printf('[ %d-line signature. Press "s" to show. ]', outlnum - mode_start) ]
726 " FIXME: this is a hack for handling two folds being added for one line
727 " we should handle addinga fold in a function
728 if len(foldinfo) && foldinfo[1] < foldinfo[2]
729 call add(info['folds'], foldinfo[0:3])
730 let info['foldtext'][foldinfo[1]] = foldinfo[4]
733 let foldinfo = [ 'text', part_start, part_end, len(info['msgs']),
734 \ printf('[ %d-line %s. Press "p" to show. ]', part_end - part_start, in_part) ]
736 call add(info['disp'], '')
740 if !has_key(msg,'body_start')
741 let msg['body_start'] = len(info['disp']) + 1
743 if match(line, g:notmuch_show_body_end_regexp) != -1
744 let body_end = len(info['disp'])
745 let foldinfo = [ 'bdy', body_start, body_end, len(info['msgs']),
746 \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
750 elseif match(line, g:notmuch_show_part_begin_regexp) != -1
751 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
752 let in_part = 'unknown'
756 call add(info['disp'],
757 \ printf('--- %s ---', in_part))
758 let part_start = len(info['disp']) + 1
763 let msg['descr'] = line
764 call add(info['disp'], line)
766 let msg['hdr_start'] = len(info['disp']) + 1
769 if match(line, g:notmuch_show_header_end_regexp) != -1
770 let hdr_start = msg['hdr_start']+1
771 let hdr_end = len(info['disp'])
772 let foldinfo = [ 'hdr', hdr_start, hdr_end, len(info['msgs']),
773 \ printf('[ %d-line headers. Press "h" to show. ]', hdr_end + 1 - hdr_start) ]
774 let msg['header'] = hdr
778 let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
781 if match(g:notmuch_show_headers, m[1]) != -1
782 call add(info['disp'], line)
789 if match(line, g:notmuch_show_message_end_regexp) != -1
790 let msg['end'] = len(info['disp'])
791 call add(info['disp'], '')
793 let foldinfo = [ 'msg', msg['start'], msg['end'], len(info['msgs']),
794 \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
796 call add(info['msgs'], msg)
803 elseif match(line, g:notmuch_show_header_begin_regexp) != -1
807 elseif match(line, g:notmuch_show_body_begin_regexp) != -1
808 let body_start = len(info['disp']) + 1
814 if match(line, g:notmuch_show_message_begin_regexp) != -1
815 let msg['start'] = len(info['disp']) + 1
817 let m = matchlist(line, g:notmuch_show_message_parse_regexp)
820 let msg['depth'] = m[2]
821 let msg['match'] = m[3]
822 let msg['filename'] = m[4]
829 if len(foldinfo) && foldinfo[1] < foldinfo[2]
830 call add(info['folds'], foldinfo[0:3])
831 let info['foldtext'][foldinfo[1]] = foldinfo[4]
837 function! s:NM_cmd_show_mkfolds()
838 let info = b:nm_raw_info
840 for afold in info['folds']
841 exec printf('%d,%dfold', afold[1], afold[2])
843 if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
844 \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
845 \ || (afold[0] == 'bdy' && g:notmuch_show_fold_bodies)
846 \ || (afold[0] == 'hdr' && g:notmuch_show_fold_headers)
848 elseif afold[0] == 'msg'
850 let msg = info['msgs'][idx]
851 if has_key(msg,'match') && msg['match'] == '0'
855 exec printf('%dfold%s', afold[1], state)
859 function! s:NM_cmd_show_mksyntax()
860 let info = b:nm_raw_info
862 for msg in info['msgs']
864 let start = msg['start']
865 let hdr_start = msg['hdr_start']
866 let body_start = msg['body_start']
868 exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
869 exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
870 exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
874 function! NM_cmd_show_foldtext()
875 let foldtext = b:nm_raw_info['foldtext']
876 return foldtext[v:foldstart]
880 " --- implement compose screen {{{1
882 function! s:NM_cmd_compose(words, body_lines)
884 let start_on_line = 0
888 let m = matchlist(word, '^\(\w[^:]*\):\s*\(.*\)\s*$')
890 throw 'Eeek! bad parameter ''' . string(word) . ''''
892 let key = substitute(m[1], '\<\w', '\U&', 'g')
893 if !has_key(hdrs, key)
897 call add(hdrs[key], m[2])
901 if !has_key(hdrs, 'From') || !len(hdrs['From'])
902 let me = <SID>NM_compose_get_user_email()
903 let hdrs['From'] = [ me ]
906 for key in g:notmuch_compose_headers
907 let text = has_key(hdrs, key) ? join(hdrs[key], ', ') : ''
908 call add(lines, key . ': ' . text)
909 if !start_on_line && !strlen(text)
910 let start_on_line = len(lines)
914 for [key,val] in items(hdrs)
915 if match(g:notmuch_compose_headers, key) == -1
916 let line = key . ': ' . join(val, ', ')
917 call add(lines, line)
923 let start_on_line = len(lines) + 1
927 call extend(lines, a:body_lines)
929 call extend(lines, [ '', '' ])
932 call <SID>NM_newComposeBuffer(lines, start_on_line)
935 function! s:NM_compose_send()
936 call <SID>NM_assert_buffer_type('compose')
937 let fname = expand('%')
939 let line = getline(lnum)
942 while match(line, '^$') == -1
943 if match(line, '^Notmuch-Help:') != -1
945 elseif strlen(lst_hdr) && match(line, '^\s') != -1
946 let hdrs[lst_hdr][-1] = hdrs[lst_hdr][-1] . substitute(line, '^\s*', ' ', '')
948 let m = matchlist(line, '^\(\w[^:]*\):\s*\(.*\)\s*$')
951 throw printf('Eeek! invalid header on line %d', lnum)
953 let key = substitute(m[1], '\<\w', '\U&', 'g')
955 if !has_key(hdrs, key)
958 call add(hdrs[key], m[2])
963 let line = getline(lnum)
965 let body_starts = lnum
967 "[-a header] [-b bcc-addr] [-c cc-addr] [-s subject] to-addr
970 for [key, vals] in items(hdrs)
972 call extend(tos, vals)
983 elseif key == 'Subject'
991 call add(cmd, key . ': ' . val)
995 call extend(cmd, tos)
997 " TODO: make sure we have at least one target
998 " TODO: ask about empty jubject, etc
1000 exec printf('0,%dd', body_starts)
1003 call map(cmd, 's:NM_shell_escape(v:val)')
1004 let cmdtxt = join(cmd) . '< ' . fname
1005 let out = system(cmdtxt)
1006 let err = v:shell_error
1010 call <SID>NM_newBuffer('new', 'error',
1011 \ "While running...\n" .
1012 \ ' ' . cmdtxt . "\n" .
1014 \ "Failed with...\n" .
1015 \ substitute(out, '^', ' ', 'g'))
1017 echo 'Eeek! unable to send mail'
1022 if !exists('b:nm_prev_bufnr')
1025 let prev_bufnr = b:nm_prev_bufnr
1027 if prev_bufnr == bufnr('%')
1028 exec printf("buffer %d", prev_bufnr)
1032 echo 'Mail sent successfully.'
1035 function! s:NM_compose_attach()
1036 echo 'not implemented'
1039 function! s:NM_compose_next_entry_area()
1040 let lnum = line('.')
1041 let hdr_end = <SID>NM_compose_find_line_match(1,'^$',1)
1044 let line = getline(lnum)
1045 if match(line, '^\([^:]\+\):\s*$') == -1
1046 call cursor(lnum, strlen(line) + 1)
1049 while match(getline(lnum+1), '^\s') != -1
1052 call cursor(lnum, strlen(getline(lnum)) + 1)
1055 elseif lnum == hdr_end
1056 call cursor(lnum+1, strlen(getline(lnum+1)) + 1)
1060 if !getbufvar(bufnr('.'), '&et')
1064 let shiftwidth = a:shiftwidth
1065 let shiftwidth = shiftwidth - ((virtcol('.')-1) % shiftwidth)
1066 " we assume no one has shiftwidth set to more than 40 :)
1067 return ' '[0:shiftwidth]
1071 " --- --- compose screen helper functions {{{2
1073 function! s:NM_compose_get_user_email()
1074 let name = substitute(system('id -u -n'), '\v(^\s*|\s*$|\n)', '', 'g')
1075 let fqdn = substitute(system('hostname -f'), '\v(^\s*|\s*$|\n)', '', 'g')
1077 " TODO: do this properly
1078 return name . '@' . fqdn
1081 function! s:NM_compose_find_line_match(start, pattern, failure)
1083 let lend = line('$')
1085 if match(getline(lnum), a:pattern) != -1
1094 " --- notmuch helper functions {{{1
1096 function! s:NM_newBuffer(how, type, content)
1102 setlocal buftype=nofile readonly modifiable scrolloff=0 sidescrolloff=0
1103 silent put=a:content
1105 setlocal nomodifiable
1106 execute printf('set filetype=notmuch-%s', a:type)
1107 execute printf('set syntax=notmuch-%s', a:type)
1108 let b:nm_type = a:type
1111 function! s:NM_newFileBuffer(fdir, fname, type, lines)
1112 let fdir = expand(a:fdir)
1113 if !isdirectory(fdir)
1114 call mkdir(fdir, 'p')
1116 let file_name = <SID>NM_mktemp(fdir, a:fname)
1117 if writefile(a:lines, file_name)
1118 throw 'Eeek! couldn''t write to temporary file ' . file_name
1120 exec printf('edit %s', file_name)
1121 setlocal buftype= noreadonly modifiable scrolloff=0 sidescrolloff=0
1122 execute printf('set filetype=notmuch-%s', a:type)
1123 execute printf('set syntax=notmuch-%s', a:type)
1124 let b:nm_type = a:type
1127 function! s:NM_newComposeBuffer(lines, start_on_line)
1129 let start_on_line = a:start_on_line
1130 let real_hdr_start = 1
1131 if g:notmuch_compose_header_help
1133 \ 'Notmuch-Help: Type in your message here; to help you use these bindings:',
1134 \ 'Notmuch-Help: ,a - attach a file',
1135 \ 'Notmuch-Help: ,s - send the message (Notmuch-Help lines will be removed)',
1136 \ 'Notmuch-Help: ,q - abort the message',
1137 \ 'Notmuch-Help: <Tab> - skip through header lines',
1139 call extend(lines, help_lines, 0)
1140 let real_hdr_start = len(help_lines)
1141 if start_on_line > 0
1142 let start_on_line = start_on_line + len(help_lines)
1145 call extend(lines, g:notmuch_signature)
1148 let prev_bufnr = bufnr('%')
1149 setlocal bufhidden=hide
1150 call <SID>NM_newFileBuffer(g:notmuch_compose_temp_file_dir, '%s.mail',
1152 setlocal bufhidden=hide
1153 let b:nm_prev_bufnr = prev_bufnr
1155 call <SID>NM_set_map('n', g:notmuch_compose_nmaps)
1156 call <SID>NM_set_map('i', g:notmuch_compose_imaps)
1158 if start_on_line > 0 && start_on_line <= len(lines)
1159 call cursor(start_on_line, strlen(getline(start_on_line)) + 1)
1161 call cursor(real_hdr_start, strlen(getline(real_hdr_start)) + 1)
1162 call <SID>NM_compose_next_entry_area()
1165 if g:notmuch_compose_insert_mode_start
1168 echo 'Type your message, use <TAB> to jump to next header and then body.'
1171 function! s:NM_assert_buffer_type(type)
1172 if !exists('b:nm_type') || b:nm_type != a:type
1173 throw printf('Eeek! expected type %s, but got %s.', a:type,
1174 \ exists(b:nm_type) ? b:nm_type : 'something else')
1178 function! s:NM_mktemp(dir, name)
1179 let time_stamp = strftime('%Y%m%d-%H%M%S')
1180 let file_name = substitute(a:dir,'/*$','/','') . printf(a:name, time_stamp)
1181 " TODO: check if it exists, try again
1185 function! s:NM_shell_escape(word)
1186 " TODO: use shellescape()
1187 let word = substitute(a:word, '''', '\\''', 'g')
1188 return '''' . word . ''''
1191 " this function was taken from git.vim, then fixed up
1192 " http://github.com/motemen/git-vim
1193 function! s:NM_shell_split(cmd)
1194 let l:split_cmd = []
1198 let t = match(cmd, '\S', iStart)
1204 let iSpace = match(cmd, '\v(\s|$)', iStart)
1209 let iQuote1 = match(cmd, '\(^["'']\|[^\\]\@<=["'']\)', iStart)
1210 if iQuote1 > iSpace || iQuote1 < iStart
1211 let iEnd = iSpace - 1
1212 let l:split_cmd += [ cmd[iStart : iEnd] ]
1214 let q = cmd[iQuote1]
1215 let iQuote2 = match(cmd, '[^\\]\@<=[' . q . ']', iQuote1 + 1)
1216 if iQuote2 < iQuote1
1217 throw 'No matching ' . q . ' quote'
1220 let l:split_cmd += [ cmd[iStart+1 : iEnd-1 ] ]
1224 let iStart = iEnd + 1
1231 function! s:NM_run(args)
1233 call map(words, 's:NM_shell_escape(v:val)')
1234 let cmd = g:notmuch_cmd . ' ' . join(words) . '< /dev/null'
1236 let start = reltime()
1237 let out = system(cmd)
1238 let err = v:shell_error
1239 let delta = reltime(start)
1241 if exists('g:notmuch_debug') && g:notmuch_debug
1242 echo printf('[%s] {%s} %s', reltimestr(delta), string(err), string(cmd))
1247 echo substitute(out, '\n*$', '', '')
1255 " --- external mail handling helpers {{{1
1257 function! s:NM_new_mail()
1258 call <SID>NM_cmd_compose([], [])
1261 " --- tag manipulation helpers {{{1
1263 " used to combine an array of words with prefixes and separators
1265 " NM_combine_tags('tag:', ['one', 'two', 'three'], 'OR', '()')
1266 " -> ['(', 'tag:one', 'OR', 'tag:two', 'OR', 'tag:three', ')']
1267 function! s:NM_combine_tags(word_prefix, words, separator, brackets)
1270 if len(res) && strlen(a:separator)
1271 call add(res, a:separator)
1273 call add(res, a:word_prefix . word)
1275 if len(res) > 1 && strlen(a:brackets)
1276 if strlen(a:brackets) != 2
1277 throw 'Eeek! brackets arg to NM_combine_tags must be 2 chars'
1279 call insert(res, a:brackets[0])
1280 call add(res, a:brackets[1])
1285 " --- other helpers {{{1
1287 function! s:NM_get_search_words()
1288 if !exists('b:nm_search_words')
1289 throw 'Eeek! no b:nm_search_words'
1291 return b:nm_search_words
1294 function! s:NM_kill_this_buffer()
1295 if exists('b:nm_prev_bufnr')
1296 let prev_bufnr = b:nm_prev_bufnr
1298 exec printf("buffer %d", prev_bufnr)
1300 echo "This is the last buffer; use :q<CR> to quit."
1304 function! s:NM_search_expand(arg)
1305 let word = expand(a:arg)
1306 let prev_bufnr = bufnr('%')
1307 setlocal bufhidden=hide
1308 call <SID>NM_cmd_search([word])
1309 setlocal bufhidden=delete
1310 let b:nm_prev_bufnr = prev_bufnr
1313 function! s:NM_add_remove_tags(filter, prefix, tags)
1314 let filter = len(a:filter) ? a:filter : [<SID>NM_search_thread_id()]
1316 throw 'Eeek! I couldn''t find the thead id!'
1318 call map(a:tags, 'a:prefix . v:val')
1320 call extend(args, a:tags)
1321 call add(args, '--')
1322 call extend(args, filter)
1323 " TODO: handle errors
1324 call <SID>NM_run(args)
1327 function! s:NM_add_remove_tags_on_screen(online, prefix, tags)
1330 for tagname in a:tags
1331 exec printf('silent! %ss/(\([^)]*\)\<%s\>\([^)]*\))$/(\1\2)/', string(a:online), tagname)
1334 for tagname in a:tags
1335 exec printf('silent! %ss/(\([^)]*\))$/(\1 %s)/', string(a:online), tagname)
1338 setlocal nomodifiable
1341 " --- process and set the defaults {{{1
1343 function! NM_set_defaults(force)
1344 for [key, dflt] in items(s:notmuch_defaults)
1346 if !a:force && exists(key) && type(dflt) == type(eval(key))
1348 elseif type(dflt) == type(0)
1349 let cmd = printf('let %s = %d', key, dflt)
1350 elseif type(dflt) == type('')
1351 let cmd = printf('let %s = ''%s''', key, dflt)
1352 " FIXME: not sure why this didn't work when dflt is an array
1353 "elseif type(dflt) == type([])
1354 " let cmd = printf('let %s = %s', key, string(dflt))
1356 echoe printf('E: Unknown type in NM_set_defaults(%d) using [%s,%s]',
1357 \ a:force, key, string(dflt))
1363 call NM_set_defaults(0)
1365 " for some reason NM_set_defaults() didn't work for arrays...
1366 if !exists('g:notmuch_show_headers')
1367 let g:notmuch_show_headers = s:notmuch_show_headers_defaults
1369 if !exists('g:notmuch_initial_search_words')
1370 let g:notmuch_initial_search_words = s:notmuch_initial_search_words_defaults
1372 if !exists('g:notmuch_folders')
1373 let g:notmuch_folders = s:notmuch_folders_defaults
1376 if !exists('g:notmuch_signature')
1377 let g:notmuch_signature = s:notmuch_signature_defaults
1379 if !exists('g:notmuch_compose_headers')
1380 let g:notmuch_compose_headers = s:notmuch_compose_headers_defaults
1383 " --- assign keymaps {{{1
1385 function! s:NM_set_map(type, maps)
1387 for [key, code] in items(a:maps)
1388 exec printf('%snoremap <buffer> %s %s', a:type, key, code)
1390 " --- this is a hack for development :)
1391 nnoremap ,nmr :runtime! plugin/notmuch.vim<CR>
1394 " --- command handler {{{1
1396 function! NotMuch(args)
1399 let args = 'folders'
1402 let words = <SID>NM_shell_split(args)
1403 if words[0] == 'folders' || words[0] == 'f'
1404 let words = words[1:]
1405 call <SID>NM_cmd_folders(words)
1407 elseif words[0] == 'search' || words[0] == 's'
1409 let words = words[1:]
1410 elseif exists('b:nm_search_words')
1411 let words = b:nm_search_words
1413 let words = g:notmuch_initial_search_words
1415 call <SID>NM_cmd_search(words)
1417 elseif words[0] == 'show'
1418 echoe 'show is not yet implemented.'
1420 elseif words[0] == 'new' || words[0] == 'compose'
1421 let words = words[1:]
1422 call <SID>NM_cmd_compose(words, [])
1425 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
1432 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
1433 cabbrev notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
1435 " vim: set ft=vim ts=8 sw=8 et foldmethod=marker :