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 \ 's': ':call <SID>NM_search_prompt()<CR>',
109 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
110 \ '=': ':call <SID>NM_folders_refresh_view()<CR>',
111 \ '<Enter>': ':call <SID>NM_folders_show_search()<CR>',
114 " --- --- bindings for search screen {{{2
115 let g:notmuch_search_maps = {
116 \ '<Enter>': ':call <SID>NM_search_show_thread()<CR>',
117 \ '<C-]>': ':call <SID>NM_search_expand(''<cword>'')<CR>',
118 \ 'a': ':call <SID>NM_search_archive_thread()<CR>',
119 \ 'f': ':call <SID>NM_search_filter()<CR>',
120 \ 'm': ':call <SID>NM_new_mail()<CR>',
121 \ 'o': ':call <SID>NM_search_toggle_order()<CR>',
122 \ 'r': ':call <SID>NM_search_reply_to_thread()<CR>',
123 \ 's': ':call <SID>NM_search_prompt()<CR>',
124 \ ',s': ':call <SID>NM_search_edit()<CR>',
125 \ 't': ':call <SID>NM_search_filter_by_tag()<CR>',
126 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
127 \ '+': ':call <SID>NM_search_add_tags([])<CR>',
128 \ '-': ':call <SID>NM_search_remove_tags([])<CR>',
129 \ '=': ':call <SID>NM_search_refresh_view()<CR>',
130 \ '?': ':echo <SID>NM_search_thread_id()<CR>',
133 " --- --- bindings for show screen {{{2
134 let g:notmuch_show_maps = {
135 \ '<C-P>': ':call <SID>NM_show_previous(1, 0)<CR>',
136 \ '<C-N>': ':call <SID>NM_show_next(1, 0)<CR>',
137 \ '<C-]>': ':call <SID>NM_search_expand(''<cword>'')<CR>',
138 \ 'q': ':call <SID>NM_kill_this_buffer()<CR>',
140 \ 'b': ':call <SID>NM_show_fold_toggle(''b'', ''bdy'', !g:notmuch_show_fold_bodies)<CR>',
141 \ 'c': ':call <SID>NM_show_fold_toggle(''c'', ''cit'', !g:notmuch_show_fold_citations)<CR>',
142 \ 'h': ':call <SID>NM_show_fold_toggle(''h'', ''hdr'', !g:notmuch_show_fold_headers)<CR>',
143 \ 's': ':call <SID>NM_show_fold_toggle(''s'', ''sig'', !g:notmuch_show_fold_signatures)<CR>',
145 \ 'a': ':call <SID>NM_show_archive_thread()<CR>',
146 \ 'A': ':call <SID>NM_show_mark_read_then_archive_thread()<CR>',
147 \ 'N': ':call <SID>NM_show_mark_read_then_next_open_message()<CR>',
148 \ 'v': ':call <SID>NM_show_view_all_mime_parts()<CR>',
149 \ '+': ':call <SID>NM_show_add_tag()<CR>',
150 \ '-': ':call <SID>NM_show_remove_tag()<CR>',
151 \ '<Space>': ':call <SID>NM_show_advance_marking_read_and_archiving()<CR>',
152 \ '\|': ':call <SID>NM_show_pipe_message()<CR>',
154 \ '<S-Tab>': ':call <SID>NM_show_previous_fold()<CR>',
155 \ '<Tab>': ':call <SID>NM_show_next_fold()<CR>',
156 \ '<Enter>': ':call <SID>NM_show_toggle_fold()<CR>',
158 \ 'r': ':call <SID>NM_show_reply()<CR>',
159 \ 'm': ':call <SID>NM_new_mail()<CR>',
160 \ '?': ':echo <SID>NM_show_message_id() . '' @ '' . join(<SID>NM_show_search_words())<CR>',
163 " --- --- bindings for compose screen {{{2
164 let g:notmuch_compose_nmaps = {
165 \ ',s': ':call <SID>NM_compose_send()<CR>',
166 \ ',a': ':call <SID>NM_compose_attach()<CR>',
167 \ ',q': ':call <SID>NM_kill_this_buffer()<CR>',
168 \ '<Tab>': ':call <SID>NM_compose_next_entry_area()<CR>',
170 let g:notmuch_compose_imaps = {
171 \ '<Tab>': '<C-r>=<SID>NM_compose_next_entry_area()<CR>',
174 " --- implement folders screen {{{1
176 function! s:NM_cmd_folders(words)
178 echoe 'Not exapecting any arguments for folders command.'
183 for entry in g:notmuch_folders
184 let [ name, search ] = entry
185 let data = s:NM_run(cmd + [search])
186 let cnt = matchlist(data, '\(\d\+\)')[1]
187 call add(disp, printf('%9d %-20s (%s)', cnt, name, search))
188 call add(searches, search)
191 call <SID>NM_newBuffer('', 'folders', join(disp, "\n"))
192 let b:nm_searches = searches
193 let b:nm_timestamp = reltime()
195 call <SID>NM_cmd_folders_mksyntax()
196 call <SID>NM_set_map('n', g:notmuch_folders_maps)
201 function! s:NM_cmd_folders_mksyntax()
204 " --- --- folders screen action functions {{{2
206 function! s:NM_folders_refresh_view()
208 setlocal bufhidden=delete
209 call s:NM_cmd_folders([])
210 exec printf('norm %dG', lno)
213 function! s:NM_folders_show_search()
215 let search = b:nm_searches[line-1]
217 let prev_bufnr = bufnr('%')
218 setlocal bufhidden=hide
219 call <SID>NM_cmd_search([search])
220 setlocal bufhidden=delete
221 let b:nm_prev_bufnr = prev_bufnr
225 " --- implement search screen {{{1
227 function! s:NM_cmd_search(words)
229 if g:notmuch_search_newest_first
230 let cmd = cmd + ['--sort=newest-first']
232 let cmd = cmd + ['--sort=oldest-first']
234 let data = s:NM_run(cmd + a:words)
235 let lines = split(data, "\n")
236 let disp = copy(lines)
237 call map(disp, 's:NM_cmd_search_fmtline(v:val)')
239 call <SID>NM_newBuffer('', 'search', join(disp, "\n"))
240 let b:nm_raw_lines = lines
241 let b:nm_search_words = a:words
243 call <SID>NM_cmd_search_mksyntax()
244 call <SID>NM_set_map('n', g:notmuch_search_maps)
248 function! s:NM_cmd_search_fmtline(line)
249 let m = matchlist(a:line, '^\(thread:\S\+\)\s\([^]]\+\]\) \([^;]\+\); \(.*\) (\([^(]*\))$')
251 return 'ERROR PARSING: ' . a:line
253 let max = g:notmuch_search_from_column_width
255 if strlen(from) >= max
256 let from = substitute(m[3][0:max-4], '[^A-Za-z1-9_]*$', '', '') . '...'
258 return printf('%-20s %-20s | %s (%s)', m[2], from, m[4], m[5])
260 function! s:NM_cmd_search_mksyntax()
261 syntax clear nmSearchFrom
262 exec printf('syntax match nmSearchFrom /\(\] \)\@<=.\{%d\}/ oneline contained', g:notmuch_search_from_column_width)
265 " --- --- search screen action functions {{{2
267 function! s:NM_search_show_thread()
268 let id = <SID>NM_search_thread_id()
271 if exists('b:nm_search_words')
272 let words = ['('] + b:nm_search_words + [')', 'and', id]
275 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 = input(a:prompt)
331 let tags = split(text)
333 call map(tags, 'a:prefix . v:val')
336 let idx = len(tags) - 1
338 call insert(tags, a:joiner, idx)
342 let tags = b:nm_search_words + ['and', '('] + tags + [')']
344 let prev_bufnr = bufnr('%')
345 setlocal bufhidden=hide
346 call <SID>NM_cmd_search(tags)
347 setlocal bufhidden=delete
348 let b:nm_prev_bufnr = prev_bufnr
351 function! s:NM_search_toggle_order()
352 let g:notmuch_search_newest_first = !g:notmuch_search_newest_first
353 " FIXME: maybe this would be better done w/o reading re-reading the lines
354 " reversing the b:nm_raw_lines and the buffer lines would be better
355 call <SID>NM_search_refresh_view()
358 function! s:NM_search_reply_to_thread()
359 echo 'not implemented'
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 echo 'len=' . string(len(b:nm_raw_lines)) . ' mnum=' . string(mnum)
391 let info = b:nm_raw_lines[mnum]
392 let what = split(info, '\s\+')[0]
396 function! s:NM_search_add_remove_tags(prompt, prefix, intags)
397 if type(a:intags) != type([]) || len(a:intags) == 0
398 " TODO: input() can support completion
399 let text = input(a:prompt)
403 let tags = split(text, ' ')
407 call <SID>NM_add_remove_tags([], a:prefix, tags)
408 call <SID>NM_add_remove_tags_on_screen('', a:prefix, tags)
411 " --- implement show screen {{{1
413 function! s:NM_cmd_show(words)
414 let prev_bufnr = bufnr('%')
415 let data = s:NM_run(['show'] + a:words)
416 let lines = split(data, "\n")
418 let info = s:NM_cmd_show_parse(lines)
420 setlocal bufhidden=hide
421 call <SID>NM_newBuffer('', 'show', join(info['disp'], "\n"))
422 setlocal bufhidden=delete
423 let b:nm_words = a:words
424 let b:nm_raw_info = info
425 let b:nm_prev_bufnr = prev_bufnr
427 call <SID>NM_cmd_show_mkfolds()
428 call <SID>NM_cmd_show_mksyntax()
429 call <SID>NM_set_map('n', g:notmuch_show_maps)
430 setlocal foldtext=NM_cmd_show_foldtext()
432 setlocal foldcolumn=6
436 function! s:NM_show_previous(can_change_thread, find_matching)
437 let info = b:nm_raw_info
439 for msg in reverse(copy(info['msgs']))
440 if a:find_matching && msg['match'] == '0'
443 if lnum <= msg['start']
447 exec printf('norm %dGzt', msg['start'])
448 " TODO: try to fit the message on screen
451 if !a:can_change_thread
454 call <SID>NM_kill_this_buffer()
457 call <SID>NM_search_show_thread()
459 call <SID>NM_show_previous(0, a:find_matching)
461 echo 'No more messages.'
465 function! s:NM_show_next(can_change_thread, find_matching)
466 let info = b:nm_raw_info
468 for msg in info['msgs']
469 if a:find_matching && msg['match'] == '0'
472 if lnum >= msg['start']
476 exec printf('norm %dGzt', msg['start'])
477 " TODO: try to fit the message on screen
480 if a:can_change_thread
481 call <SID>NM_show_next_thread()
485 function! s:NM_show_next_thread()
486 call <SID>NM_kill_this_buffer()
487 if line('.') != line('$')
489 call <SID>NM_search_show_thread()
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 echo 'not implemented'
503 function! s:NM_show_mark_read_then_next_open_message()
504 echo 'not implemented'
507 function! s:NM_show_previous_message()
508 echo 'not implemented'
511 function! s:NM_show_reply()
512 echo 'not implemented'
515 function! s:NM_show_view_all_mime_parts()
516 echo 'not implemented'
519 function! s:NM_show_view_raw_message()
520 echo 'not implemented'
523 function! s:NM_show_add_tag()
524 echo 'not implemented'
527 function! s:NM_show_remove_tag()
528 echo 'not implemented'
531 " if entire message is not visible scroll down 1/2 page or less to get to the bottom of message
532 " otherwise go to next message
533 " any message that is viewed entirely has inbox and unread tags removed
534 function! s:NM_show_advance_marking_read_and_archiving()
535 let advance_tags = ['unread', 'inbox']
537 let vis_top = line('w0')
538 let vis_bot = line('w$')
540 let msg_top = <SID>NM_show_get_message_for_line(vis_top)
541 if !has_key(msg_top,'id')
542 echo "No top visible message."
545 " if the top message is the last message, just expunge the entire thread and move on
546 if msg_top['end'] == line('$')
548 for msg in b:nm_raw_info['msgs']
549 if has_key(msg,'match') && msg['match'] != '0'
553 call add(ids, msg['id'])
557 let filter = ['('] + advance_tags + [')', 'AND', '('] + ids + [')']
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 echo "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 call <SID>NM_add_remove_tags_on_screen(msg_top['start'], '-', advance_tags)
571 exec printf('norm %dG', vis_top)
572 call <SID>NM_show_next(0, 1)
573 if has_key(msg_top,'match') && msg_top['match'] != '0'
575 " do this last to hide the latency
576 let filter = ['('] + advance_tags + [')', '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_search_words()
633 if !exists('b:nm_words')
634 throw 'Eeek! no b:nm_words'
639 function! s:NM_show_fold_toggle(key, type, fold)
640 let info = b:nm_raw_info
645 for fld in info['folds']
647 exec printf('%dfold%s', fld[1], act)
650 exec printf('nnoremap <buffer> %s :call <SID>NM_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
654 " s:NM_cmd_show_parse returns the following dictionary:
655 " 'disp': lines to display
656 " 'msgs': message info dicts { start, end, id, depth, filename, descr, header }
657 " 'folds': fold info arrays [ type, start, end ]
658 " 'foldtext': fold text indexed by start line
659 function! s:NM_cmd_show_parse(inlines)
660 let info = { 'disp': [],
679 for line in a:inlines
680 let inlnum = inlnum + 1
686 if match(line, g:notmuch_show_part_end_regexp) != -1
687 let part_end = len(info['disp'])
689 call add(info['disp'], line)
692 if in_part == 'text/plain'
693 if !part_end && mode_type == ''
694 if match(line, g:notmuch_show_signature_regexp) != -1
695 let mode_type = 'sig'
696 let mode_start = len(info['disp'])
697 elseif match(line, g:notmuch_show_citation_regexp) != -1
698 let mode_type = 'cit'
699 let mode_start = len(info['disp'])
701 elseif mode_type == 'cit'
702 if part_end || match(line, g:notmuch_show_citation_regexp) == -1
703 let outlnum = len(info['disp'])
704 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
705 \ printf('[ %d-line citation. Press "c" to show. ]', outlnum - mode_start) ]
708 elseif mode_type == 'sig'
709 let outlnum = len(info['disp'])
710 if (outlnum - mode_start) > g:notmuch_show_signature_lines_max
713 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
714 \ printf('[ %d-line signature. Press "s" to show. ]', outlnum - mode_start) ]
721 " FIXME: this is a hack for handling two folds being added for one line
722 " we should handle addinga fold in a function
723 if len(foldinfo) && foldinfo[1] < foldinfo[2]
724 call add(info['folds'], foldinfo[0:3])
725 let info['foldtext'][foldinfo[1]] = foldinfo[4]
728 let foldinfo = [ 'text', part_start, part_end, len(info['msgs']),
729 \ printf('[ %d-line %s. Press "p" to show. ]', part_end - part_start, in_part) ]
731 call add(info['disp'], '')
735 if !has_key(msg,'body_start')
736 let msg['body_start'] = len(info['disp']) + 1
738 if match(line, g:notmuch_show_body_end_regexp) != -1
739 let body_end = len(info['disp'])
740 let foldinfo = [ 'bdy', body_start, body_end, len(info['msgs']),
741 \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
745 elseif match(line, g:notmuch_show_part_begin_regexp) != -1
746 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
747 let in_part = 'unknown'
751 call add(info['disp'],
752 \ printf('--- %s ---', in_part))
753 let part_start = len(info['disp']) + 1
758 let msg['descr'] = line
759 call add(info['disp'], line)
761 let msg['hdr_start'] = len(info['disp']) + 1
764 if match(line, g:notmuch_show_header_end_regexp) != -1
765 let hdr_start = msg['hdr_start']+1
766 let hdr_end = len(info['disp'])
767 let foldinfo = [ 'hdr', hdr_start, hdr_end, len(info['msgs']),
768 \ printf('[ %d-line headers. Press "h" to show. ]', hdr_end + 1 - hdr_start) ]
769 let msg['header'] = hdr
773 let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
776 if match(g:notmuch_show_headers, m[1]) != -1
777 call add(info['disp'], line)
784 if match(line, g:notmuch_show_message_end_regexp) != -1
785 let msg['end'] = len(info['disp'])
786 call add(info['disp'], '')
788 let foldinfo = [ 'msg', msg['start'], msg['end'], len(info['msgs']),
789 \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
791 call add(info['msgs'], msg)
798 elseif match(line, g:notmuch_show_header_begin_regexp) != -1
802 elseif match(line, g:notmuch_show_body_begin_regexp) != -1
803 let body_start = len(info['disp']) + 1
809 if match(line, g:notmuch_show_message_begin_regexp) != -1
810 let msg['start'] = len(info['disp']) + 1
812 let m = matchlist(line, g:notmuch_show_message_parse_regexp)
815 let msg['depth'] = m[2]
816 let msg['match'] = m[3]
817 let msg['filename'] = m[4]
824 if len(foldinfo) && foldinfo[1] < foldinfo[2]
825 call add(info['folds'], foldinfo[0:3])
826 let info['foldtext'][foldinfo[1]] = foldinfo[4]
832 function! s:NM_cmd_show_mkfolds()
833 let info = b:nm_raw_info
835 for afold in info['folds']
836 exec printf('%d,%dfold', afold[1], afold[2])
838 if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
839 \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
840 \ || (afold[0] == 'bdy' && g:notmuch_show_fold_bodies)
841 \ || (afold[0] == 'hdr' && g:notmuch_show_fold_headers)
843 elseif afold[0] == 'msg'
845 let msg = info['msgs'][idx]
846 if has_key(msg,'match') && msg['match'] == '0'
850 exec printf('%dfold%s', afold[1], state)
854 function! s:NM_cmd_show_mksyntax()
855 let info = b:nm_raw_info
857 for msg in info['msgs']
859 let start = msg['start']
860 let hdr_start = msg['hdr_start']
861 let body_start = msg['body_start']
863 exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
864 exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
865 exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
869 function! NM_cmd_show_foldtext()
870 let foldtext = b:nm_raw_info['foldtext']
871 return foldtext[v:foldstart]
875 " --- implement compose screen {{{1
877 function! s:NM_cmd_compose(words, body_lines)
878 let lines = !g:notmuch_compose_header_help ? [] : [
879 \ 'Notmuch-Help: Type in your message here; to help you use these bindings:',
880 \ 'Notmuch-Help: ,a - attach a file',
881 \ 'Notmuch-Help: ,s - send the message (Notmuch-Help lines will be removed)',
882 \ 'Notmuch-Help: ,q - abort the message',
883 \ 'Notmuch-Help: <Tab> - skip through header lines',
885 let start_on_line = 0
889 let m = matchlist(word, '^\([^:]\+\):\s*\(.*\)\s*$')
891 throw 'Eeek! bad parameter ''' . string(word) . ''''
893 let key = substitute(m[1], '\<\w', '\U&', 'g')
894 if !has_key(hdrs, key)
898 call add(hdrs[key], m[2])
902 if !has_key(hdrs, 'From') || !len(hdrs['From'])
903 let me = <SID>NM_compose_get_user_email()
904 let hdrs['From'] = [ me ]
907 for key in g:notmuch_compose_headers
908 let text = has_key(hdrs, key) ? join(hdrs[key], ', ') : ''
909 call add(lines, key . ': ' . text)
910 if !start_on_line && !strlen(text)
911 let start_on_line = len(lines)
915 for [key,val] in items(hdrs)
916 if match(g:notmuch_compose_headers, key) == -1
917 let line = key . ': ' . join(val, ', ')
918 call add(lines, line)
922 call extend(lines, [ '', '' ])
924 let start_on_line = len(lines) + 1
928 call extend(lines, a:body_lines)
932 call extend(lines, g:notmuch_signature)
934 let prev_bufnr = bufnr('%')
935 setlocal bufhidden=hide
936 call <SID>NM_newFileBuffer(g:notmuch_compose_temp_file_dir, '%s.mail',
938 setlocal bufhidden=hide
940 call <SID>NM_set_map('n', g:notmuch_compose_nmaps)
941 call <SID>NM_set_map('i', g:notmuch_compose_imaps)
943 call cursor(start_on_line, strlen(start_on_line) + 1)
944 if g:notmuch_compose_insert_mode_start
947 echo 'Type your message, use <TAB> to jump to next header and then body.'
950 function! s:NM_compose_send()
951 echo 'not implemented'
954 function! s:NM_compose_attach()
955 echo 'not implemented'
958 function! s:NM_compose_next_entry_area()
960 let hdr_end = <SID>NM_compose_find_line_match(1,'^$',1)
961 echo 'header end = ' . string(hdr_end)
964 let line = getline(lnum)
965 if match(line, '^\([^:]\+\):\s*$') == -1
966 call cursor(lnum, strlen(line) + 1)
969 while match(getline(lnum+1), '^\s') != -1
972 call cursor(lnum, strlen(getline(lnum)) + 1)
975 elseif lnum == hdr_end
976 call cursor(lnum+1, strlen(getline(lnum+1)) + 1)
980 if !getbufvar(bufnr('.'), '&et')
984 let shiftwidth = a:shiftwidth
985 let shiftwidth = shiftwidth - ((virtcol('.')-1) % shiftwidth)
986 " we assume no one has shiftwidth set to more than 40 :)
987 return ' '[0:shiftwidth]
991 " --- --- compose screen helper functions {{{2
993 function! s:NM_compose_get_user_email()
994 let name = substitute(system('id -u -n'), '\v(^\s*|\s*$|\n)', '', 'g')
995 let fqdn = substitute(system('hostname -f'), '\v(^\s*|\s*$|\n)', '', 'g')
997 " TODO: do this properly
998 return name . '@' . fqdn
1001 function! s:NM_compose_find_line_match(start, pattern, failure)
1003 let lend = line('$')
1005 if match(getline(lnum), a:pattern) != -1
1014 " --- notmuch helper functions {{{1
1016 function! s:NM_newBuffer(how, type, content)
1022 setlocal buftype=nofile readonly modifiable scrolloff=0 sidescrolloff=0
1023 silent put=a:content
1025 setlocal nomodifiable
1026 execute printf('set filetype=notmuch-%s', a:type)
1027 execute printf('set syntax=notmuch-%s', a:type)
1028 let b:nm_type = a:type
1031 function! s:NM_newFileBuffer(fdir, fname, type, lines)
1032 let fdir = expand(a:fdir)
1033 if !isdirectory(fdir)
1034 call mkdir(fdir, 'p')
1036 let file_name = <SID>NM_mktemp(fdir, a:fname)
1037 if writefile(a:lines, file_name)
1038 throw 'Eeek! couldn''t write to temporary file ' . file_name
1040 exec printf('edit %s', file_name)
1041 setlocal buftype= noreadonly modifiable scrolloff=0 sidescrolloff=0
1042 execute printf('set filetype=notmuch-%s', a:type)
1043 execute printf('set syntax=notmuch-%s', a:type)
1044 let b:nm_type = a:type
1047 function! s:NM_mktemp(dir, name)
1048 let time_stamp = strftime('%Y%m%d-%H%M%S')
1049 let file_name = substitute(a:dir,'/*$','/','') . printf(a:name, time_stamp)
1050 " TODO: check if it exists, try again
1054 function! s:NM_shell_escape(word)
1055 " TODO: use shellescape()
1056 let word = substitute(a:word, '''', '\\''', 'g')
1057 return '''' . word . ''''
1060 " this function was taken from git.vim, then fixed up
1061 " http://github.com/motemen/git-vim
1062 function! s:NM_shell_split(cmd)
1063 let l:split_cmd = []
1067 let t = match(cmd, '\S', iStart)
1073 let iSpace = match(cmd, '\v(\s|$)', iStart)
1078 let iQuote1 = match(cmd, '\(^["'']\|[^\\]\@<=["'']\)', iStart)
1079 if iQuote1 > iSpace || iQuote1 < iStart
1080 let iEnd = iSpace - 1
1081 let l:split_cmd += [ cmd[iStart : iEnd] ]
1083 let q = cmd[iQuote1]
1084 let iQuote2 = match(cmd, '[^\\]\@<=[' . q . ']', iQuote1 + 1)
1085 if iQuote2 < iQuote1
1086 throw 'No matching ' . q . ' quote'
1089 let l:split_cmd += [ cmd[iStart+1 : iEnd-1 ] ]
1093 let iStart = iEnd + 1
1100 function! s:NM_run(args)
1102 call map(words, 's:NM_shell_escape(v:val)')
1103 let cmd = g:notmuch_cmd . ' ' . join(words) . '< /dev/null'
1105 let start = reltime()
1106 let out = system(cmd)
1107 let err = v:shell_error
1108 let delta = reltime(start)
1110 if exists('g:notmuch_debug') && g:notmuch_debug
1111 echo printf('[%s] {%s} %s', reltimestr(delta), string(err), string(cmd))
1116 echo substitute(out, '\n*$', '', '')
1124 " --- external mail handling helpers {{{1
1126 function! s:NM_new_mail()
1127 echo 'not implemented'
1130 " --- other helpers {{{1
1132 function! s:NM_kill_this_buffer()
1133 if exists('b:nm_prev_bufnr')
1134 setlocal bufhidden=delete
1135 exec printf(":buffer %d", b:nm_prev_bufnr)
1137 echo "This is the last buffer; use :q<CR> to quit."
1141 function! s:NM_search_expand(arg)
1142 let word = expand(a:arg)
1143 let prev_bufnr = bufnr('%')
1144 setlocal bufhidden=hide
1145 call <SID>NM_cmd_search([word])
1146 setlocal bufhidden=delete
1147 let b:nm_prev_bufnr = prev_bufnr
1150 function! s:NM_add_remove_tags(filter, prefix, tags)
1151 let filter = len(a:filter) ? a:filter : [<SID>NM_search_thread_id()]
1153 echoe 'Eeek! I couldn''t find the thead id!'
1155 call map(a:tags, 'a:prefix . v:val')
1157 call extend(args, a:tags)
1158 call add(args, '--')
1159 call extend(args, filter)
1160 " TODO: handle errors
1161 call <SID>NM_run(args)
1164 function! s:NM_add_remove_tags_on_screen(online, prefix, tags)
1167 for tagname in a:tags
1168 exec printf('silent! %ss/(\([^)]*\)\<%s\>\([^)]*\))$/(\1\2)/', string(a:online), tagname)
1171 for tagname in a:tags
1172 exec printf('silent! %ss/(\([^)]*\)\([^)]*\))$/(\1 %s)/', string(a:online), tagname)
1175 setlocal nomodifiable
1178 " --- process and set the defaults {{{1
1180 function! NM_set_defaults(force)
1181 for [key, dflt] in items(s:notmuch_defaults)
1183 if !a:force && exists(key) && type(dflt) == type(eval(key))
1185 elseif type(dflt) == type(0)
1186 let cmd = printf('let %s = %d', key, dflt)
1187 elseif type(dflt) == type('')
1188 let cmd = printf('let %s = ''%s''', key, dflt)
1189 " FIXME: not sure why this didn't work when dflt is an array
1190 "elseif type(dflt) == type([])
1191 " let cmd = printf('let %s = %s', key, string(dflt))
1193 echoe printf('E: Unknown type in NM_set_defaults(%d) using [%s,%s]',
1194 \ a:force, key, string(dflt))
1200 call NM_set_defaults(0)
1202 " for some reason NM_set_defaults() didn't work for arrays...
1203 if !exists('g:notmuch_show_headers')
1204 let g:notmuch_show_headers = s:notmuch_show_headers_defaults
1206 if !exists('g:notmuch_initial_search_words')
1207 let g:notmuch_initial_search_words = s:notmuch_initial_search_words_defaults
1209 if !exists('g:notmuch_folders')
1210 let g:notmuch_folders = s:notmuch_folders_defaults
1213 if !exists('g:notmuch_signature')
1214 let g:notmuch_signature = s:notmuch_signature_defaults
1216 if !exists('g:notmuch_compose_headers')
1217 let g:notmuch_compose_headers = s:notmuch_compose_headers_defaults
1220 " --- assign keymaps {{{1
1222 function! s:NM_set_map(type, maps)
1224 for [key, code] in items(a:maps)
1225 exec printf('%snoremap <buffer> %s %s', a:type, key, code)
1227 " --- this is a hack for development :)
1228 nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>
1231 " --- command handler {{{1
1233 function! NotMuch(args)
1236 let args = 'folders'
1239 let words = <SID>NM_shell_split(args)
1240 if words[0] == 'folders' || words[0] == 'f'
1241 let words = words[1:]
1242 call <SID>NM_cmd_folders(words)
1244 elseif words[0] == 'search' || words[0] == 's'
1246 let words = words[1:]
1247 elseif exists('b:nm_search_words')
1248 let words = b:nm_search_words
1250 let words = g:notmuch_initial_search_words
1252 call <SID>NM_cmd_search(words)
1254 elseif words[0] == 'show'
1255 echoe 'show is not yet implemented.'
1257 elseif words[0] == 'new' || words[0] == 'compose'
1258 let words = words[1:]
1259 call <SID>NM_cmd_compose(words, [])
1262 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
1269 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
1270 cabbrev notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
1272 " vim: set ft=vim ts=8 sw=8 et foldmethod=marker :