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 s:notmuch_show_fold_signatures = 1
57 let s: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>
118 function! s:NM_cmd_show_next()
119 let info = b:nm_raw_info
122 for msg in info['msgs']
124 if lnum >= msg['start']
128 exec printf('norm %dG', msg['start'])
133 call <SID>NM_search_display()
136 " s:NM_cmd_show_parse returns the following dictionary:
137 " 'disp': lines to display
138 " 'msgs': message info dicts { start, end, id, depth, filename, descr, header }
139 " 'folds': fold info arrays [ type, start, end ]
140 " 'foldtext': fold text indexed by start line
141 function! s:NM_cmd_show_parse(inlines)
142 let info = { 'disp': [],
161 for line in a:inlines
162 let inlnum = inlnum + 1
168 if match(line, s:notmuch_show_part_end_regexp) != -1
169 let part_end = len(info['disp'])
171 call add(info['disp'], line)
174 if in_part == 'text/plain'
175 if !part_end && mode_type == ''
176 if match(line, s:notmuch_show_signature_regexp) != -1
177 let mode_type = 'sig'
178 let mode_start = len(info['disp'])
179 elseif match(line, s:notmuch_show_citation_regexp) != -1
180 let mode_type = 'cit'
181 let mode_start = len(info['disp'])
183 elseif mode_type == 'cit'
184 if part_end || match(line, s:notmuch_show_citation_regexp) == -1
185 let outlnum = len(info['disp'])
186 let foldinfo = [ mode_type, mode_start, outlnum,
187 \ printf('[ %d-line citation. Press "c" to show. ]', outlnum - mode_start) ]
190 elseif mode_type == 'sig'
191 let outlnum = len(info['disp'])
192 if (outlnum - mode_start) > s:notmuch_show_signature_lines_max
193 echoe 'line ' . outlnum . ' stopped matching'
196 let foldinfo = [ mode_type, mode_start, outlnum,
197 \ printf('[ %d-line signature. Press "s" to show. ]', outlnum - mode_start) ]
204 " FIXME: this is a hack for handling two folds being added for one line
205 " we should handle addinga fold in a function
207 call add(info['folds'], foldinfo[0:2])
208 let info['foldtext'][foldinfo[1]] = foldinfo[3]
211 let foldinfo = [ 'text', part_start, part_end,
212 \ printf('[ %d-line %s. Press "p" to show. ]', part_end - part_start, in_part) ]
214 call add(info['disp'], '')
218 if !has_key(msg,'body_start')
219 let msg['body_start'] = len(info['disp']) + 1
221 if match(line, s:notmuch_show_body_end_regexp) != -1
222 let body_end = len(info['disp'])
223 let foldinfo = [ 'body', body_start, body_end,
224 \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
228 elseif match(line, s:notmuch_show_part_begin_regexp) != -1
229 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
230 let in_part = 'unknown'
234 call add(info['disp'],
235 \ printf('--- %s ---', in_part))
236 let part_start = len(info['disp']) + 1
241 let msg['descr'] = line
242 call add(info['disp'], line)
244 let msg['hdr_start'] = len(info['disp']) + 1
247 if match(line, s:notmuch_show_header_end_regexp) != -1
248 let msg['header'] = hdr
252 let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
255 if match(s:notmuch_show_headers, m[1]) != -1
256 call add(info['disp'], line)
263 if match(line, s:notmuch_show_message_end_regexp) != -1
264 let msg['end'] = len(info['disp'])
265 call add(info['disp'], '')
267 let foldinfo = [ 'match', msg['start'], msg['end'],
268 \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
270 call add(info['msgs'], msg)
277 elseif match(line, s:notmuch_show_header_begin_regexp) != -1
281 elseif match(line, s:notmuch_show_body_begin_regexp) != -1
282 let body_start = len(info['disp']) + 1
288 if match(line, s:notmuch_show_message_begin_regexp) != -1
289 let msg['start'] = len(info['disp']) + 1
291 let m = matchlist(line, s:notmuch_show_message_parse_regexp)
294 let msg['depth'] = m[2]
295 let msg['filename'] = m[3]
303 call add(info['folds'], foldinfo[0:2])
304 let info['foldtext'][foldinfo[1]] = foldinfo[3]
310 function! s:NM_cmd_show_mkfolds()
311 let info = b:nm_raw_info
313 for afold in info['folds']
314 exec printf('%d,%dfold', afold[1], afold[2])
315 if (afold[0] == 'sig' && s:notmuch_show_fold_signatures)
316 \ || (afold[0] == 'cit' && s:notmuch_show_fold_citations)
317 exec printf('%dfoldclose', afold[1])
319 exec printf('%dfoldopen', afold[1])
324 function! s:NM_cmd_show_mksyntax()
325 let info = b:nm_raw_info
327 for msg in info['msgs']
329 let start = msg['start']
330 let hdr_start = msg['hdr_start']
331 let body_start = msg['body_start']
333 exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
334 exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
335 exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
339 function! NM_cmd_show_foldtext()
340 let foldtext = b:nm_raw_info['foldtext']
341 return foldtext[v:foldstart]
345 " --- helper functions
347 function! s:NM_newBuffer(ft, content)
349 setlocal buftype=nofile readonly modifiable
352 setlocal nomodifiable
353 execute printf('set filetype=notmuch-%s', a:ft)
354 execute printf('set syntax=notmuch-%s', a:ft)
357 function! s:NM_run(args)
358 let cmd = g:notmuch_cmd . ' ' . join(a:args) . '< /dev/null'
359 let out = system(cmd)
362 echo substitute(out, '\n*$', '', '')
371 " --- command handler
373 function! NotMuch(args)
375 call s:NM_cmd_search(['tag:inbox'])
381 let words = split(a:args)
382 " TODO: handle commands passed as arguments
384 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
391 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
392 cabbrev notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
394 " --- hacks, only for development :)
396 nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>