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>
24 if !exists('g:notmuch_cmd')
25 let g:notmuch_cmd = 'notmuch'
28 if !exists('g:notmuch_search_reverse')
29 let g:notmuch_search_reverse = 1
32 " --- used to match output of notmuch
34 let s:notmuch_show_message_begin_regexp = '^
\fmessage{'
35 let s:notmuch_show_message_end_regexp = '^
\fmessage}'
36 let s:notmuch_show_header_begin_regexp = '^
\fheader{'
37 let s:notmuch_show_header_end_regexp = '^
\fheader}'
38 let s:notmuch_show_body_begin_regexp = '^
\fbody{'
39 let s:notmuch_show_body_end_regexp = '^
\fbody}'
40 let s:notmuch_show_attachment_begin_regexp = '^
\fattachment{'
41 let s:notmuch_show_attachment_end_regexp = '^
\fattachment}'
42 let s:notmuch_show_part_begin_regexp = '^
\fpart{'
43 let s:notmuch_show_part_end_regexp = '^
\fpart}'
44 let s:notmuch_show_marker_regexp = '^
\f\\(message\\|header\\|body\\|attachment\\|part\\)[{}].*$'
46 let s:notmuch_show_message_parse_regexp = '\(id:[^ ]*\) depth:\([0-9]*\) filename:\(.*\)$'
47 let s:notmuch_show_tags_regexp = '(\([^)]*\))$'
49 let s:notmuch_show_signature_regexp = '^\(-- \?\|_\+\)$'
50 let s:notmuch_show_signature_lines_max = 12
52 let s:notmuch_show_citation_regexp = '^\s*>'
54 let s:notmuch_show_headers = [ 'Subject', 'From' ]
56 let g:notmuch_show_fold_signatures = 1
57 let g:notmuch_show_fold_citations = 1
59 " --- implement search screen
61 function! s:NM_cmd_search(words)
63 if g:notmuch_search_reverse
64 let cmd = cmd + ['--reverse']
66 let data = s:NM_run(cmd + a:words)
67 "let data = substitute(data, '27/27', '25/27', '')
68 "let data = substitute(data, '\[4/4\]', '[0/4]', '')
69 let lines = split(data, "\n")
70 let disp = copy(lines)
71 call map(disp, 'substitute(v:val, "^thread:\\S* ", "", "")' )
73 call s:NM_newBuffer('search', join(disp, "\n"))
74 let b:nm_raw_lines = lines
76 nnoremap <buffer> <Enter> :call <SID>NM_search_display()<CR>
77 nnoremap <buffer> s :call <SID>NM_cmd_search(split(input('NotMuch Search:')))<CR>
82 function! s:NM_search_display()
83 if !exists('b:nm_raw_lines')
84 echo 'no b:nm_raw_lines'
87 let info = b:nm_raw_lines[line-1]
88 let what = split(info, '\s\+')[0]
89 call s:NM_cmd_show([what])
94 " --- implement show screen
96 function! s:NM_cmd_show(words)
97 let prev_bufnr = bufnr('%')
98 let data = s:NM_run(['show'] + a:words)
99 let lines = split(data, "\n")
101 let info = s:NM_cmd_show_parse(lines)
103 call s:NM_newBuffer('show', join(info['disp'], "\n"))
104 setlocal bufhidden=delete
105 let b:nm_raw_info = info
106 let b:nm_prev_bufnr = prev_bufnr
108 call s:NM_cmd_show_mkfolds()
109 call s:NM_cmd_show_mksyntax()
110 setlocal foldtext=NM_cmd_show_foldtext()
112 setlocal foldcolumn=6
114 exec printf("nnoremap <buffer> q :b %d<CR>", b:nm_prev_bufnr)
115 nnoremap <buffer> <C-N> :call <SID>NM_cmd_show_next()<CR>
116 nnoremap <buffer> c :call <SID>NM_cmd_show_fold_toggle('c', 'cit', !g:notmuch_show_fold_citations)<CR>
117 nnoremap <buffer> s :call <SID>NM_cmd_show_fold_toggle('s', 'sig', !g:notmuch_show_fold_signatures)<CR>
120 function! s:NM_cmd_show_next()
121 let info = b:nm_raw_info
124 for msg in info['msgs']
126 if lnum >= msg['start']
130 exec printf('norm %dG', msg['start'])
135 call <SID>NM_search_display()
138 function! s:NM_cmd_show_fold_toggle(key, type, fold)
139 let info = b:nm_raw_info
144 for fld in info['folds']
146 exec printf('%dfold%s', fld[1], act)
149 exec printf('nnoremap <buffer> %s :call <SID>NM_cmd_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
153 " s:NM_cmd_show_parse returns the following dictionary:
154 " 'disp': lines to display
155 " 'msgs': message info dicts { start, end, id, depth, filename, descr, header }
156 " 'folds': fold info arrays [ type, start, end ]
157 " 'foldtext': fold text indexed by start line
158 function! s:NM_cmd_show_parse(inlines)
159 let info = { 'disp': [],
178 for line in a:inlines
179 let inlnum = inlnum + 1
185 if match(line, s:notmuch_show_part_end_regexp) != -1
186 let part_end = len(info['disp'])
188 call add(info['disp'], line)
191 if in_part == 'text/plain'
192 if !part_end && mode_type == ''
193 if match(line, s:notmuch_show_signature_regexp) != -1
194 let mode_type = 'sig'
195 let mode_start = len(info['disp'])
196 elseif match(line, s:notmuch_show_citation_regexp) != -1
197 let mode_type = 'cit'
198 let mode_start = len(info['disp'])
200 elseif mode_type == 'cit'
201 if part_end || match(line, s:notmuch_show_citation_regexp) == -1
202 let outlnum = len(info['disp'])
203 let foldinfo = [ mode_type, mode_start, outlnum,
204 \ printf('[ %d-line citation. Press "c" to show. ]', outlnum - mode_start) ]
207 elseif mode_type == 'sig'
208 let outlnum = len(info['disp'])
209 if (outlnum - mode_start) > s:notmuch_show_signature_lines_max
210 echoe 'line ' . outlnum . ' stopped matching'
213 let foldinfo = [ mode_type, mode_start, outlnum,
214 \ printf('[ %d-line signature. Press "s" to show. ]', outlnum - mode_start) ]
221 " FIXME: this is a hack for handling two folds being added for one line
222 " we should handle addinga fold in a function
224 call add(info['folds'], foldinfo[0:2])
225 let info['foldtext'][foldinfo[1]] = foldinfo[3]
228 let foldinfo = [ 'text', part_start, part_end,
229 \ printf('[ %d-line %s. Press "p" to show. ]', part_end - part_start, in_part) ]
231 call add(info['disp'], '')
235 if !has_key(msg,'body_start')
236 let msg['body_start'] = len(info['disp']) + 1
238 if match(line, s:notmuch_show_body_end_regexp) != -1
239 let body_end = len(info['disp'])
240 let foldinfo = [ 'body', body_start, body_end,
241 \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
245 elseif match(line, s:notmuch_show_part_begin_regexp) != -1
246 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
247 let in_part = 'unknown'
251 call add(info['disp'],
252 \ printf('--- %s ---', in_part))
253 let part_start = len(info['disp']) + 1
258 let msg['descr'] = line
259 call add(info['disp'], line)
261 let msg['hdr_start'] = len(info['disp']) + 1
264 if match(line, s:notmuch_show_header_end_regexp) != -1
265 let msg['header'] = hdr
269 let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
272 if match(s:notmuch_show_headers, m[1]) != -1
273 call add(info['disp'], line)
280 if match(line, s:notmuch_show_message_end_regexp) != -1
281 let msg['end'] = len(info['disp'])
282 call add(info['disp'], '')
284 let foldinfo = [ 'match', msg['start'], msg['end'],
285 \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
287 call add(info['msgs'], msg)
294 elseif match(line, s:notmuch_show_header_begin_regexp) != -1
298 elseif match(line, s:notmuch_show_body_begin_regexp) != -1
299 let body_start = len(info['disp']) + 1
305 if match(line, s:notmuch_show_message_begin_regexp) != -1
306 let msg['start'] = len(info['disp']) + 1
308 let m = matchlist(line, s:notmuch_show_message_parse_regexp)
311 let msg['depth'] = m[2]
312 let msg['filename'] = m[3]
320 call add(info['folds'], foldinfo[0:2])
321 let info['foldtext'][foldinfo[1]] = foldinfo[3]
327 function! s:NM_cmd_show_mkfolds()
328 let info = b:nm_raw_info
330 for afold in info['folds']
331 exec printf('%d,%dfold', afold[1], afold[2])
332 if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
333 \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
334 exec printf('%dfoldclose', afold[1])
336 exec printf('%dfoldopen', afold[1])
341 function! s:NM_cmd_show_mksyntax()
342 let info = b:nm_raw_info
344 for msg in info['msgs']
346 let start = msg['start']
347 let hdr_start = msg['hdr_start']
348 let body_start = msg['body_start']
350 exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
351 exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
352 exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
356 function! NM_cmd_show_foldtext()
357 let foldtext = b:nm_raw_info['foldtext']
358 return foldtext[v:foldstart]
362 " --- helper functions
364 function! s:NM_newBuffer(ft, content)
366 setlocal buftype=nofile readonly modifiable
369 setlocal nomodifiable
370 execute printf('set filetype=notmuch-%s', a:ft)
371 execute printf('set syntax=notmuch-%s', a:ft)
374 function! s:NM_run(args)
375 let cmd = g:notmuch_cmd . ' ' . join(a:args) . '< /dev/null'
376 let out = system(cmd)
379 echo substitute(out, '\n*$', '', '')
388 " --- command handler
390 function! NotMuch(args)
392 call s:NM_cmd_search(['tag:inbox'])
398 let words = split(a:args)
399 " TODO: handle commands passed as arguments
401 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
408 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
409 cabbrev notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
411 " --- hacks, only for development :)
413 nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>