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 \ 'A': ':call <SID>NM_search_mark_read_then_archive_thread()<CR>',
122 \ 'f': ':call <SID>NM_search_filter()<CR>',
123 \ 'm': ':call <SID>NM_new_mail()<CR>',
124 \ 'o': ':call <SID>NM_search_toggle_order()<CR>',
125 \ 'r': ':call <SID>NM_search_reply_to_thread()<CR>',
126 \ 's': ':call <SID>NM_search_prompt()<CR>',
127 \ ',s': ':call <SID>NM_search_edit()<CR>',
128 \ 't': ':call <SID>NM_search_filter_by_tag()<CR>',
129 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
130 \ '+': ':call <SID>NM_search_add_tags([])<CR>',
131 \ '-': ':call <SID>NM_search_remove_tags([])<CR>',
132 \ '=': ':call <SID>NM_search_refresh_view()<CR>',
133 \ '?': ':echo <SID>NM_search_thread_id() . '' @ '' . join(<SID>NM_get_search_words())<CR>',
136 " --- --- bindings for show screen {{{2
137 let g:notmuch_show_maps = {
138 \ '<C-P>': ':call <SID>NM_show_previous(1, 0)<CR>',
139 \ '<C-N>': ':call <SID>NM_show_next(1, 0)<CR>',
140 \ '<C-]>': ':call <SID>NM_search_expand(''<cword>'')<CR>',
141 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
142 \ 's': ':call <SID>NM_search_prompt()<CR>',
144 \ 'b': ':call <SID>NM_show_fold_toggle(''b'', ''bdy'', !g:notmuch_show_fold_bodies)<CR>',
145 \ 'c': ':call <SID>NM_show_fold_toggle(''c'', ''cit'', !g:notmuch_show_fold_citations)<CR>',
146 \ 'h': ':call <SID>NM_show_fold_toggle(''h'', ''hdr'', !g:notmuch_show_fold_headers)<CR>',
147 \ 'i': ':call <SID>NM_show_fold_toggle(''s'', ''sig'', !g:notmuch_show_fold_signatures)<CR>',
149 \ 'a': ':call <SID>NM_show_archive_thread()<CR>',
150 \ 'A': ':call <SID>NM_show_mark_read_then_archive_thread()<CR>',
151 \ 'N': ':call <SID>NM_show_mark_read_then_next_open_message()<CR>',
152 \ 'v': ':call <SID>NM_show_view_all_mime_parts()<CR>',
153 \ '+': ':call <SID>NM_show_add_tag()<CR>',
154 \ '-': ':call <SID>NM_show_remove_tag()<CR>',
155 \ '<Space>': ':call <SID>NM_show_advance_marking_read_and_archiving()<CR>',
156 \ '\|': ':call <SID>NM_show_pipe_message()<CR>',
158 \ '<S-Tab>': ':call <SID>NM_show_previous_fold()<CR>',
159 \ '<Tab>': ':call <SID>NM_show_next_fold()<CR>',
160 \ '<Enter>': ':call <SID>NM_show_toggle_fold()<CR>',
162 \ 'r': ':call <SID>NM_show_reply()<CR>',
163 \ 'm': ':call <SID>NM_new_mail()<CR>',
164 \ '?': ':echo <SID>NM_show_message_id() . '' @ '' . join(<SID>NM_get_search_words())<CR>',
167 " --- --- bindings for compose screen {{{2
168 let g:notmuch_compose_nmaps = {
169 \ ',s': ':call <SID>NM_compose_send()<CR>',
170 \ ',a': ':call <SID>NM_compose_attach()<CR>',
171 \ ',q': ':call <SID>NM_kill_this_buffer()<CR>',
172 \ '<Tab>': ':call <SID>NM_compose_next_entry_area()<CR>',
174 let g:notmuch_compose_imaps = {
175 \ '<Tab>': '<C-r>=<SID>NM_compose_next_entry_area()<CR>',
178 " --- implement folders screen {{{1
180 function! s:NM_cmd_folders(words)
182 throw 'Not expecting any arguments for folders command.'
187 for entry in g:notmuch_folders
188 let [ name, search ] = entry
189 let data = s:NM_run(cmd + [search])
190 let cnt = matchlist(data, '\(\d\+\)')[1]
191 call add(disp, printf('%9d %-20s (%s)', cnt, name, search))
192 call add(searches, search)
195 call <SID>NM_newBuffer('', 'folders', join(disp, "\n"))
196 let b:nm_searches = searches
197 let b:nm_timestamp = reltime()
199 call <SID>NM_cmd_folders_mksyntax()
200 call <SID>NM_set_map('n', g:notmuch_folders_maps)
205 function! s:NM_cmd_folders_mksyntax()
208 " --- --- folders screen action functions {{{2
210 function! s:NM_folders_refresh_view()
212 setlocal bufhidden=delete
213 call s:NM_cmd_folders([])
214 exec printf('norm %dG', lno)
217 function! s:NM_folders_show_search()
219 let search = b:nm_searches[line-1]
221 let prev_bufnr = bufnr('%')
222 setlocal bufhidden=hide
223 call <SID>NM_cmd_search([search])
224 setlocal bufhidden=delete
225 let b:nm_prev_bufnr = prev_bufnr
229 " --- implement search screen {{{1
231 function! s:NM_cmd_search(words)
233 if g:notmuch_search_newest_first
234 let cmd = cmd + ['--sort=newest-first']
236 let cmd = cmd + ['--sort=oldest-first']
238 let data = s:NM_run(cmd + a:words)
239 let lines = split(data, "\n")
240 let disp = copy(lines)
241 call map(disp, 's:NM_cmd_search_fmtline(v:val)')
243 call <SID>NM_newBuffer('', 'search', join(disp, "\n"))
244 let b:nm_raw_lines = lines
245 let b:nm_search_words = a:words
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\(.\{12\}\) \[\(\d\+\)/\d\+\] \([^;]\+\); \%(\[[^\[]\+\] \)*\(.*\) (\([^(]*\))$')
254 return 'ERROR PARSING: ' . a:line
256 let max = g:notmuch_search_from_column_width
258 for at in split(m[4], ", ")
259 let p = min([stridx(at, "."), stridx(at, "@")])
260 call insert(flist, tolower(at[0:p - 1]))
262 let from = join(flist, ", ")
263 return printf("%-12s %3s %-20.20s | %s (%s)", m[2], m[3], from, m[5], m[6])
266 " --- --- search screen action functions {{{2
268 function! s:NM_search_show_thread(everything)
269 let words = [ <SID>NM_search_thread_id() ]
270 if !a:everything && exists('b:nm_search_words')
271 call extend(words, ['AND', '('])
272 call extend(words, b:nm_search_words)
275 call <SID>NM_cmd_show(words)
276 let b:nm_show_everything = a:everything
279 function! s:NM_search_prompt()
280 " TODO: input() can support completion
281 let text = input('NotMuch Search: ')
283 let tags = split(text)
285 let tags = s:notmuch_initial_search_words_defaults
287 let prev_bufnr = bufnr('%')
288 if b:nm_type == 'search' && exists('b:nm_prev_bufnr')
289 " TODO: we intend to replace the current buffer,
290 " ... maybe we could just clear it
291 let prev_bufnr = b:nm_prev_bufnr
292 setlocal bufhidden=delete
294 setlocal bufhidden=hide
296 call <SID>NM_cmd_search(tags)
297 setlocal bufhidden=delete
298 let b:nm_prev_bufnr = prev_bufnr
301 function! s:NM_search_edit()
302 " TODO: input() can support completion
303 let text = input('NotMuch Search: ', join(b:nm_search_words, ' '))
305 call <SID>NM_cmd_search(split(text))
309 function! s:NM_search_archive_thread()
310 call <SID>NM_add_remove_tags([], '-', ['inbox'])
314 function! s:NM_search_mark_read_then_archive_thread()
315 call <SID>NM_add_remove_tags([], '-', ['unread', 'inbox'])
319 function! s:NM_search_filter()
320 call <SID>NM_search_filter_helper('Filter: ', '', '')
323 function! s:NM_search_filter_by_tag()
324 call <SID>NM_search_filter_helper('Filter Tag(s): ', 'tag:', 'and')
327 function! s:NM_search_filter_helper(prompt, prefix, joiner)
328 " TODO: input() can support completion
329 let text = substitute(input(a:prompt), '\v(^\s*|\s*$|\n)', '', 'g')
334 let tags = b:nm_search_words + ['AND']
335 \ + <SID>NM_combine_tags(a:prefix, split(text), a:joiner, '()')
337 let prev_bufnr = bufnr('%')
338 setlocal bufhidden=hide
339 call <SID>NM_cmd_search(tags)
340 setlocal bufhidden=delete
341 let b:nm_prev_bufnr = prev_bufnr
344 function! s:NM_search_toggle_order()
345 let g:notmuch_search_newest_first = !g:notmuch_search_newest_first
346 " FIXME: maybe this would be better done w/o reading re-reading the lines
347 " reversing the b:nm_raw_lines and the buffer lines would be better
348 call <SID>NM_search_refresh_view()
351 function! s:NM_search_reply_to_thread()
353 call add(cmd, <SID>NM_search_thread_id())
355 call extend(cmd, <SID>NM_get_search_words())
357 let data = <SID>NM_run(cmd)
358 let lines = split(data, "\n")
359 call <SID>NM_newComposeBuffer(lines, 0)
362 function! s:NM_search_add_tags(tags)
363 call <SID>NM_search_add_remove_tags('Add Tag(s): ', '+', a:tags)
366 function! s:NM_search_remove_tags(tags)
367 call <SID>NM_search_add_remove_tags('Remove Tag(s): ', '-', a:tags)
370 function! s:NM_search_refresh_view()
372 let prev_bufnr = b:nm_prev_bufnr
373 setlocal bufhidden=delete
374 call <SID>NM_cmd_search(b:nm_search_words)
375 let b:nm_prev_bufnr = prev_bufnr
376 " FIXME: should find the line of the thread we were on if possible
377 exec printf('norm %dG', lno)
380 " --- --- search screen helper functions {{{2
382 function! s:NM_search_thread_id()
383 if !exists('b:nm_raw_lines')
384 throw 'Eeek! no b:nm_raw_lines'
386 let mnum = line('.') - 1
387 if len(b:nm_raw_lines) <= mnum
390 let info = b:nm_raw_lines[mnum]
391 let what = split(info, '\s\+')[0]
395 function! s:NM_search_add_remove_tags(prompt, prefix, intags)
396 if type(a:intags) != type([]) || len(a:intags) == 0
397 " TODO: input() can support completion
398 let text = input(a:prompt)
402 let tags = split(text, ' ')
406 call <SID>NM_add_remove_tags([], a:prefix, tags)
409 " --- implement show screen {{{1
411 function! s:NM_cmd_show(words)
412 let prev_bufnr = bufnr('%')
413 let data = s:NM_run(['show', '--entire-thread'] + a:words)
414 let lines = split(data, "\n")
416 let info = s:NM_cmd_show_parse(lines)
418 setlocal bufhidden=hide
419 call <SID>NM_newBuffer('', 'show', join(info['disp'], "\n"))
420 setlocal bufhidden=delete
421 let b:nm_search_words = a:words
422 let b:nm_raw_info = info
423 let b:nm_prev_bufnr = prev_bufnr
425 call <SID>NM_cmd_show_mkfolds()
426 call <SID>NM_cmd_show_mksyntax()
427 call <SID>NM_set_map('n', g:notmuch_show_maps)
428 setlocal foldtext=NM_cmd_show_foldtext()
430 setlocal foldcolumn=6
434 function! s:NM_show_previous(can_change_thread, find_matching)
435 let everything = exists('b:nm_show_everything') ? b:nm_show_everything : 0
436 let info = b:nm_raw_info
438 for msg in reverse(copy(info['msgs']))
439 if a:find_matching && msg['match'] == '0'
442 if lnum <= msg['start']
446 exec printf('norm %dGzt', msg['start'])
447 " TODO: try to fit the message on screen
450 if !a:can_change_thread
453 call <SID>NM_kill_this_buffer()
456 call <SID>NM_search_show_thread(everything)
458 call <SID>NM_show_previous(0, a:find_matching)
460 echo 'No more messages.'
464 function! s:NM_show_next(can_change_thread, find_matching)
465 let info = b:nm_raw_info
467 for msg in info['msgs']
468 if a:find_matching && msg['match'] == '0'
471 if lnum >= msg['start']
475 exec printf('norm %dGzt', msg['start'])
476 " TODO: try to fit the message on screen
479 if a:can_change_thread
480 call <SID>NM_show_next_thread()
484 function! s:NM_show_next_thread()
485 let everything = exists('b:nm_show_everything') ? b:nm_show_everything : 0
486 call <SID>NM_kill_this_buffer()
487 if line('.') != line('$')
489 call <SID>NM_search_show_thread(everything)
491 echo 'No more messages.'
495 function! s:NM_show_archive_thread()
496 echo 'not implemented'
499 function! s:NM_show_mark_read_then_archive_thread()
500 call <SID>NM_add_remove_tags(b:nm_search_words, '-', ['unread', 'inbox'])
501 call <SID>NM_show_next_thread()
504 function! s:NM_show_mark_read_then_next_open_message()
505 echo 'not implemented'
508 function! s:NM_show_previous_message()
509 echo 'not implemented'
512 function! s:NM_show_reply()
514 call add(cmd, <SID>NM_show_message_id())
516 call extend(cmd, <SID>NM_get_search_words())
518 let data = <SID>NM_run(cmd)
519 let lines = split(data, "\n")
520 call <SID>NM_newComposeBuffer(lines, 0)
523 function! s:NM_show_view_all_mime_parts()
524 echo 'not implemented'
527 function! s:NM_show_view_raw_message()
528 echo 'not implemented'
531 function! s:NM_show_add_tag()
532 echo 'not implemented'
535 function! s:NM_show_remove_tag()
536 echo 'not implemented'
539 " if entire message is not visible scroll down 1/2 page or less to get to the bottom of message
540 " otherwise go to next message
541 " any message that is viewed entirely has inbox and unread tags removed
542 function! s:NM_show_advance_marking_read_and_archiving()
543 let advance_tags = ['unread', 'inbox']
545 let vis_top = line('w0')
546 let vis_bot = line('w$')
548 let msg_top = <SID>NM_show_get_message_for_line(vis_top)
549 if !has_key(msg_top,'id')
550 throw "No top visible message."
553 " if the top message is the last message, just expunge the entire thread and move on
554 if msg_top['end'] == line('$')
556 for msg in b:nm_raw_info['msgs']
557 if has_key(msg,'match') && msg['match'] != '0'
558 call add(ids, msg['id'])
561 let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
563 \ + <SID>NM_combine_tags('', ids, 'OR', '()')
564 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
565 call <SID>NM_show_next(1, 1)
569 let msg_bot = <SID>NM_show_get_message_for_line(vis_bot)
570 if !has_key(msg_bot,'id')
571 throw "No bottom visible message."
574 " if entire message fits on the screen, read/archive it, move to the next one
575 if msg_top['id'] != msg_bot['id'] || msg_top['end'] <= vis_bot
576 exec printf('norm %dG', vis_top)
577 call <SID>NM_show_next(0, 1)
578 if has_key(msg_top,'match') && msg_top['match'] != '0'
580 " do this last to hide the latency
581 let filter = <SID>NM_combine_tags('tag:', advance_tags, 'OR', '()')
582 \ + ['AND', msg_top['id']]
583 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
588 " entire message does not fit on the screen, scroll down to bottom, max 1/2 screen
589 let jmp = winheight(winnr()) / 2
590 let max = msg_bot['end'] - vis_bot
594 exec printf('norm %dGzt', vis_top + jmp)
598 function! s:NM_show_pipe_message()
599 echo 'not implemented'
602 function! s:NM_show_previous_fold()
603 echo 'not implemented'
606 function! s:NM_show_next_fold()
607 echo 'not implemented'
610 function! s:NM_show_toggle_fold()
611 echo 'not implemented'
615 " --- --- show screen helper functions {{{2
617 function! s:NM_show_get_message_for_line(line)
618 for msg in b:nm_raw_info['msgs']
619 if a:line > msg['end']
627 function! s:NM_show_message_id()
628 if !exists('b:nm_raw_info')
629 throw 'Eeek! no b:nm_raw_info'
631 let msg = <SID>NM_show_get_message_for_line(line('.'))
638 function! s:NM_show_fold_toggle(key, type, fold)
639 let info = b:nm_raw_info
644 for fld in info['folds']
649 "let msg = info['msgs'][idx]
650 "if has_key(msg,'match') && msg['match'] == '0'
653 let cls = foldclosed(fld[1])
654 if cls != -1 && cls != fld[1]
657 exec printf('%dfold%s', fld[1], act)
659 exec printf('nnoremap <buffer> %s :call <SID>NM_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
663 " s:NM_cmd_show_parse returns the following dictionary:
664 " 'disp': lines to display
665 " 'msgs': message info dicts { start, end, id, depth, filename, descr, header }
666 " 'folds': fold info arrays [ type, start, end ]
667 " 'foldtext': fold text indexed by start line
668 function! s:NM_cmd_show_parse(inlines)
669 let info = { 'disp': [],
688 for line in a:inlines
689 let inlnum = inlnum + 1
695 if match(line, g:notmuch_show_part_end_regexp) != -1
696 let part_end = len(info['disp'])
698 call add(info['disp'], line)
701 if in_part == 'text/plain'
702 if !part_end && mode_type == ''
703 if match(line, g:notmuch_show_signature_regexp) != -1
704 let mode_type = 'sig'
705 let mode_start = len(info['disp'])
706 elseif match(line, g:notmuch_show_citation_regexp) != -1
707 let mode_type = 'cit'
708 let mode_start = len(info['disp'])
710 elseif mode_type == 'cit'
711 if part_end || match(line, g:notmuch_show_citation_regexp) == -1
712 let outlnum = len(info['disp'])
713 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
714 \ printf('[ %d-line citation. Press "c" to show. ]', outlnum - mode_start) ]
717 elseif mode_type == 'sig'
718 let outlnum = len(info['disp'])
719 if (outlnum - mode_start) > g:notmuch_show_signature_lines_max
722 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
723 \ printf('[ %d-line signature. Press "s" to show. ]', outlnum - mode_start) ]
730 " FIXME: this is a hack for handling two folds being added for one line
731 " we should handle addinga fold in a function
732 if len(foldinfo) && foldinfo[1] < foldinfo[2]
733 call add(info['folds'], foldinfo[0:3])
734 let info['foldtext'][foldinfo[1]] = foldinfo[4]
737 let foldinfo = [ 'text', part_start, part_end, len(info['msgs']),
738 \ printf('[ %d-line %s. Press "p" to show. ]', part_end - part_start, in_part) ]
740 call add(info['disp'], '')
744 if !has_key(msg,'body_start')
745 let msg['body_start'] = len(info['disp']) + 1
747 if match(line, g:notmuch_show_body_end_regexp) != -1
748 let body_end = len(info['disp'])
749 let foldinfo = [ 'bdy', body_start, body_end, len(info['msgs']),
750 \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
754 elseif match(line, g:notmuch_show_part_begin_regexp) != -1
755 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
756 let in_part = 'unknown'
760 call add(info['disp'],
761 \ printf('--- %s ---', in_part))
762 let part_start = len(info['disp']) + 1
767 let msg['descr'] = line
768 call add(info['disp'], line)
770 let msg['hdr_start'] = len(info['disp']) + 1
773 if match(line, g:notmuch_show_header_end_regexp) != -1
774 let hdr_start = msg['hdr_start']+1
775 let hdr_end = len(info['disp'])
776 let foldinfo = [ 'hdr', hdr_start, hdr_end, len(info['msgs']),
777 \ printf('[ %d-line headers. Press "h" to show. ]', hdr_end + 1 - hdr_start) ]
778 let msg['header'] = hdr
782 let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
785 if match(g:notmuch_show_headers, m[1]) != -1
786 call add(info['disp'], line)
793 if match(line, g:notmuch_show_message_end_regexp) != -1
794 let msg['end'] = len(info['disp'])
795 call add(info['disp'], '')
797 let foldinfo = [ 'msg', msg['start'], msg['end'], len(info['msgs']),
798 \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
800 call add(info['msgs'], msg)
807 elseif match(line, g:notmuch_show_header_begin_regexp) != -1
811 elseif match(line, g:notmuch_show_body_begin_regexp) != -1
812 let body_start = len(info['disp']) + 1
818 if match(line, g:notmuch_show_message_begin_regexp) != -1
819 let msg['start'] = len(info['disp']) + 1
821 let m = matchlist(line, g:notmuch_show_message_parse_regexp)
824 let msg['depth'] = m[2]
825 let msg['match'] = m[3]
826 let msg['filename'] = m[4]
833 if len(foldinfo) && foldinfo[1] < foldinfo[2]
834 call add(info['folds'], foldinfo[0:3])
835 let info['foldtext'][foldinfo[1]] = foldinfo[4]
841 function! s:NM_cmd_show_mkfolds()
842 let info = b:nm_raw_info
844 for afold in info['folds']
845 exec printf('%d,%dfold', afold[1], afold[2])
847 if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
848 \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
849 \ || (afold[0] == 'bdy' && g:notmuch_show_fold_bodies)
850 \ || (afold[0] == 'hdr' && g:notmuch_show_fold_headers)
852 elseif afold[0] == 'msg'
854 let msg = info['msgs'][idx]
855 if has_key(msg,'match') && msg['match'] == '0'
859 exec printf('%dfold%s', afold[1], state)
863 function! s:NM_cmd_show_mksyntax()
864 let info = b:nm_raw_info
866 for msg in info['msgs']
868 let start = msg['start']
869 let hdr_start = msg['hdr_start']
870 let body_start = msg['body_start']
872 exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
873 exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
874 exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
878 function! NM_cmd_show_foldtext()
879 let foldtext = b:nm_raw_info['foldtext']
880 return foldtext[v:foldstart]
884 " --- implement compose screen {{{1
886 function! s:NM_cmd_compose(words, body_lines)
888 let start_on_line = 0
892 let m = matchlist(word, '^\(\w[^:]*\):\s*\(.*\)\s*$')
894 throw 'Eeek! bad parameter ''' . string(word) . ''''
896 let key = substitute(m[1], '\<\w', '\U&', 'g')
897 if !has_key(hdrs, key)
901 call add(hdrs[key], m[2])
905 if !has_key(hdrs, 'From') || !len(hdrs['From'])
906 let me = <SID>NM_compose_get_user_email()
907 let hdrs['From'] = [ me ]
910 for key in g:notmuch_compose_headers
911 let text = has_key(hdrs, key) ? join(hdrs[key], ', ') : ''
912 call add(lines, key . ': ' . text)
913 if !start_on_line && !strlen(text)
914 let start_on_line = len(lines)
918 for [key,val] in items(hdrs)
919 if match(g:notmuch_compose_headers, key) == -1
920 let line = key . ': ' . join(val, ', ')
921 call add(lines, line)
927 let start_on_line = len(lines) + 1
931 call extend(lines, a:body_lines)
933 call extend(lines, [ '', '' ])
936 call <SID>NM_newComposeBuffer(lines, start_on_line)
939 function! s:NM_compose_send()
940 call <SID>NM_assert_buffer_type('compose')
941 let fname = expand('%')
943 let line = getline(lnum)
945 while match(line, '^$') == -1
946 if match(line, '^Notmuch-Help:') == -1
947 let hdr_starts = lnum - 1
951 let line = getline(lnum)
954 exec printf(':0,%dd', hdr_starts)
957 let cmdtxt = 'mailx -t < ' . fname
958 let out = system(cmdtxt)
959 let err = v:shell_error
963 call <SID>NM_newBuffer('new', 'error',
964 \ "While running...\n" .
965 \ ' ' . cmdtxt . "\n" .
967 \ "Failed with...\n" .
968 \ substitute(out, '^', ' ', 'g'))
970 echo 'Eeek! unable to send mail'
975 if !exists('b:nm_prev_bufnr')
978 let prev_bufnr = b:nm_prev_bufnr
980 if prev_bufnr == bufnr('%')
981 exec printf("buffer %d", prev_bufnr)
985 echo 'Mail sent successfully.'
988 function! s:NM_compose_attach()
989 echo 'not implemented'
992 function! s:NM_compose_next_entry_area()
994 let hdr_end = <SID>NM_compose_find_line_match(1,'^$',1)
997 let line = getline(lnum)
998 if match(line, '^\([^:]\+\):\s*$') == -1
999 call cursor(lnum, strlen(line) + 1)
1002 while match(getline(lnum+1), '^\s') != -1
1005 call cursor(lnum, strlen(getline(lnum)) + 1)
1008 elseif lnum == hdr_end
1009 call cursor(lnum+1, strlen(getline(lnum+1)) + 1)
1013 if !getbufvar(bufnr('.'), '&et')
1017 let shiftwidth = a:shiftwidth
1018 let shiftwidth = shiftwidth - ((virtcol('.')-1) % shiftwidth)
1019 " we assume no one has shiftwidth set to more than 40 :)
1020 return ' '[0:shiftwidth]
1024 " --- --- compose screen helper functions {{{2
1026 function! s:NM_compose_get_user_email()
1027 let name = substitute(system('id -u -n'), '\v(^\s*|\s*$|\n)', '', 'g')
1028 let fqdn = substitute(system('hostname -f'), '\v(^\s*|\s*$|\n)', '', 'g')
1030 " TODO: do this properly
1031 return name . '@' . fqdn
1034 function! s:NM_compose_find_line_match(start, pattern, failure)
1036 let lend = line('$')
1038 if match(getline(lnum), a:pattern) != -1
1047 " --- notmuch helper functions {{{1
1049 function! s:NM_newBuffer(how, type, content)
1055 setlocal buftype=nofile readonly modifiable scrolloff=0 sidescrolloff=0
1056 silent put=a:content
1058 setlocal nomodifiable
1059 execute printf('set filetype=notmuch-%s', a:type)
1060 execute printf('set syntax=notmuch-%s', a:type)
1061 let b:nm_type = a:type
1064 function! s:NM_newFileBuffer(fdir, fname, type, lines)
1065 let fdir = expand(a:fdir)
1066 if !isdirectory(fdir)
1067 call mkdir(fdir, 'p')
1069 let file_name = <SID>NM_mktemp(fdir, a:fname)
1070 if writefile(a:lines, file_name)
1071 throw 'Eeek! couldn''t write to temporary file ' . file_name
1073 exec printf('edit %s', file_name)
1074 setlocal buftype= noreadonly modifiable scrolloff=0 sidescrolloff=0
1075 execute printf('set filetype=notmuch-%s', a:type)
1076 execute printf('set syntax=notmuch-%s', a:type)
1077 let b:nm_type = a:type
1080 function! s:NM_newComposeBuffer(lines, start_on_line)
1082 let start_on_line = a:start_on_line
1083 let real_hdr_start = 1
1084 if g:notmuch_compose_header_help
1086 \ 'Notmuch-Help: Type in your message here; to help you use these bindings:',
1087 \ 'Notmuch-Help: ,a - attach a file',
1088 \ 'Notmuch-Help: ,s - send the message (Notmuch-Help lines will be removed)',
1089 \ 'Notmuch-Help: ,q - abort the message',
1090 \ 'Notmuch-Help: <Tab> - skip through header lines',
1092 call extend(lines, help_lines, 0)
1093 let real_hdr_start = len(help_lines)
1094 if start_on_line > 0
1095 let start_on_line = start_on_line + len(help_lines)
1098 call extend(lines, g:notmuch_signature)
1101 let prev_bufnr = bufnr('%')
1102 setlocal bufhidden=hide
1103 call <SID>NM_newFileBuffer(g:notmuch_compose_temp_file_dir, '%s.mail',
1105 setlocal bufhidden=hide
1106 let b:nm_prev_bufnr = prev_bufnr
1108 call <SID>NM_set_map('n', g:notmuch_compose_nmaps)
1109 call <SID>NM_set_map('i', g:notmuch_compose_imaps)
1111 if start_on_line > 0 && start_on_line <= len(lines)
1112 call cursor(start_on_line, strlen(getline(start_on_line)) + 1)
1114 call cursor(real_hdr_start, strlen(getline(real_hdr_start)) + 1)
1115 call <SID>NM_compose_next_entry_area()
1118 if g:notmuch_compose_insert_mode_start
1121 echo 'Type your message, use <TAB> to jump to next header and then body.'
1124 function! s:NM_assert_buffer_type(type)
1125 if !exists('b:nm_type') || b:nm_type != a:type
1126 throw printf('Eeek! expected type %s, but got %s.', a:type,
1127 \ exists(b:nm_type) ? b:nm_type : 'something else')
1131 function! s:NM_mktemp(dir, name)
1132 let time_stamp = strftime('%Y%m%d-%H%M%S')
1133 let file_name = substitute(a:dir,'/*$','/','') . printf(a:name, time_stamp)
1134 " TODO: check if it exists, try again
1138 function! s:NM_shell_escape(word)
1139 " TODO: use shellescape()
1140 let word = substitute(a:word, '''', '\\''', 'g')
1141 return '''' . word . ''''
1144 " this function was taken from git.vim, then fixed up
1145 " http://github.com/motemen/git-vim
1146 function! s:NM_shell_split(cmd)
1147 let l:split_cmd = []
1151 let t = match(cmd, '\S', iStart)
1157 let iSpace = match(cmd, '\v(\s|$)', iStart)
1162 let iQuote1 = match(cmd, '\(^["'']\|[^\\]\@<=["'']\)', iStart)
1163 if iQuote1 > iSpace || iQuote1 < iStart
1164 let iEnd = iSpace - 1
1165 let l:split_cmd += [ cmd[iStart : iEnd] ]
1167 let q = cmd[iQuote1]
1168 let iQuote2 = match(cmd, '[^\\]\@<=[' . q . ']', iQuote1 + 1)
1169 if iQuote2 < iQuote1
1170 throw 'No matching ' . q . ' quote'
1173 let l:split_cmd += [ cmd[iStart+1 : iEnd-1 ] ]
1177 let iStart = iEnd + 1
1184 function! s:NM_run(args)
1186 call map(words, 's:NM_shell_escape(v:val)')
1187 let cmd = g:notmuch_cmd . ' ' . join(words) . '< /dev/null'
1189 if exists('g:notmuch_debug') && g:notmuch_debug
1190 let start = reltime()
1191 let out = system(cmd)
1192 let err = v:shell_error
1193 let delta = reltime(start)
1195 echo printf('[%s] {%s} %s', reltimestr(delta), string(err), string(cmd))
1197 let out = system(cmd)
1198 let err = v:shell_error
1203 echo substitute(out, '\n*$', '', '')
1211 " --- external mail handling helpers {{{1
1213 function! s:NM_new_mail()
1214 call <SID>NM_cmd_compose([], [])
1217 " --- tag manipulation helpers {{{1
1219 " used to combine an array of words with prefixes and separators
1221 " NM_combine_tags('tag:', ['one', 'two', 'three'], 'OR', '()')
1222 " -> ['(', 'tag:one', 'OR', 'tag:two', 'OR', 'tag:three', ')']
1223 function! s:NM_combine_tags(word_prefix, words, separator, brackets)
1226 if len(res) && strlen(a:separator)
1227 call add(res, a:separator)
1229 call add(res, a:word_prefix . word)
1231 if len(res) > 1 && strlen(a:brackets)
1232 if strlen(a:brackets) != 2
1233 throw 'Eeek! brackets arg to NM_combine_tags must be 2 chars'
1235 call insert(res, a:brackets[0])
1236 call add(res, a:brackets[1])
1241 " --- other helpers {{{1
1243 function! s:NM_get_search_words()
1244 if !exists('b:nm_search_words')
1245 throw 'Eeek! no b:nm_search_words'
1247 return b:nm_search_words
1250 function! s:NM_kill_this_buffer()
1251 if exists('b:nm_prev_bufnr')
1252 let prev_bufnr = b:nm_prev_bufnr
1254 exec printf("buffer %d", prev_bufnr)
1256 echo "This is the last buffer; use :q<CR> to quit."
1260 function! s:NM_search_expand(arg)
1261 let word = expand(a:arg)
1262 let prev_bufnr = bufnr('%')
1263 setlocal bufhidden=hide
1264 call <SID>NM_cmd_search([word])
1265 setlocal bufhidden=delete
1266 let b:nm_prev_bufnr = prev_bufnr
1269 function! s:NM_add_remove_tags(filter, prefix, tags)
1270 let filter = len(a:filter) ? a:filter : [<SID>NM_search_thread_id()]
1272 throw 'Eeek! I couldn''t find the thead id!'
1274 call map(a:tags, 'a:prefix . v:val')
1276 call extend(args, a:tags)
1277 call add(args, '--')
1278 call extend(args, filter)
1279 " TODO: handle errors
1280 call <SID>NM_run(args)
1283 " --- process and set the defaults {{{1
1285 function! NM_set_defaults(force)
1286 for [key, dflt] in items(s:notmuch_defaults)
1288 if !a:force && exists(key) && type(dflt) == type(eval(key))
1290 elseif type(dflt) == type(0)
1291 let cmd = printf('let %s = %d', key, dflt)
1292 elseif type(dflt) == type('')
1293 let cmd = printf('let %s = ''%s''', key, dflt)
1294 " FIXME: not sure why this didn't work when dflt is an array
1295 "elseif type(dflt) == type([])
1296 " let cmd = printf('let %s = %s', key, string(dflt))
1298 echoe printf('E: Unknown type in NM_set_defaults(%d) using [%s,%s]',
1299 \ a:force, key, string(dflt))
1305 call NM_set_defaults(0)
1307 " for some reason NM_set_defaults() didn't work for arrays...
1308 if !exists('g:notmuch_show_headers')
1309 let g:notmuch_show_headers = s:notmuch_show_headers_defaults
1311 if !exists('g:notmuch_initial_search_words')
1312 let g:notmuch_initial_search_words = s:notmuch_initial_search_words_defaults
1314 if !exists('g:notmuch_folders')
1315 let g:notmuch_folders = s:notmuch_folders_defaults
1318 if !exists('g:notmuch_signature')
1319 let g:notmuch_signature = s:notmuch_signature_defaults
1321 if !exists('g:notmuch_compose_headers')
1322 let g:notmuch_compose_headers = s:notmuch_compose_headers_defaults
1325 " --- assign keymaps {{{1
1327 function! s:NM_set_map(type, maps)
1329 for [key, code] in items(a:maps)
1330 exec printf('%snoremap <buffer> %s %s', a:type, key, code)
1332 " --- this is a hack for development :)
1333 nnoremap ,nmr :runtime! plugin/notmuch.vim<CR>
1336 " --- command handler {{{1
1338 function! NotMuch(args)
1341 let args = 'folders'
1344 let words = <SID>NM_shell_split(args)
1345 if words[0] == 'folders' || words[0] == 'f'
1346 let words = words[1:]
1347 call <SID>NM_cmd_folders(words)
1349 elseif words[0] == 'search' || words[0] == 's'
1351 let words = words[1:]
1352 elseif exists('b:nm_search_words')
1353 let words = b:nm_search_words
1355 let words = g:notmuch_initial_search_words
1357 call <SID>NM_cmd_search(words)
1359 elseif words[0] == 'show'
1360 echoe 'show is not yet implemented.'
1362 elseif words[0] == 'new' || words[0] == 'compose'
1363 let words = words[1:]
1364 call <SID>NM_cmd_compose(words, [])
1367 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
1374 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
1375 cabbrev notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
1377 " vim: set ft=vim ts=8 sw=8 et foldmethod=marker :