git.notmuchmail.org Git - notmuch/blob - vim/plugin/notmuch.vim

   1 " notmuch.vim plugin --- run notmuch within vim
   2 "
   3 " Copyright © Carl Worth
   4 "
   5 " This file is part of Notmuch.
   6 "
   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.
  11 "
  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.
  16 "
  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/>.
  19 "
  20 " Authors: Bart Trojanowski <bart@jukie.net>
  21
  22 " --- configuration defaults {{{1
  23
  24 let s:notmuch_defaults = {
  25         \ 'g:notmuch_cmd':                           'notmuch'                    ,
  26         \ 'g:notmuch_debug':                         0                            ,
  27         \
  28         \ 'g:notmuch_search_newest_first':           1                            ,
  29         \ 'g:notmuch_search_from_column_width':      20                           ,
  30         \
  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                            ,
  35         \
  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\\)[{}].*$',
  47         \
  48         \ 'g:notmuch_show_message_parse_regexp':     '\(id:[^ ]*\) depth:\([0-9]*\) match:\([0-9]*\) filename:\(.*\)$',
  49         \ 'g:notmuch_show_tags_regexp':              '(\([^)]*\))$'               ,
  50         \
  51         \ 'g:notmuch_show_signature_regexp':         '^\(-- \?\|_\+\)$'           ,
  52         \ 'g:notmuch_show_signature_lines_max':      12                           ,
  53         \
  54         \ 'g:notmuch_show_citation_regexp':          '^\s*>'                      ,
  55         \ }
  56
  57 " defaults for g:notmuch_initial_search_words
  58 " override with: let g:notmuch_initial_search_words = [ ... ]
  59 let s:notmuch_initial_search_words_defaults = [
  60         \ 'tag:inbox and tag:unread',
  61         \ ]
  62
  63 " defaults for g:notmuch_show_headers
  64 " override with: let g:notmuch_show_headers = [ ... ]
  65 let s:notmuch_show_headers_defaults = [
  66         \ 'Subject',
  67         \ 'To',
  68         \ 'Cc',
  69         \ 'Bcc',
  70         \ 'Date',
  71         \ ]
  72
  73 " defaults for g:notmuch_folders
  74 " override with: let g:notmuch_folders = [ ... ]
  75 let s:notmuch_folders_defaults = [
  76         \ [ 'new',    'tag:inbox and tag:unread' ],
  77         \ [ 'inbox',  'tag:inbox'                ],
  78         \ [ 'unread', 'tag:unread'               ],
  79         \ ]
  80
  81 " --- keyboard mapping definitions {{{1
  82
  83 " --- --- bindings for folders mode {{{2
  84
  85 let g:notmuch_folders_maps = {
  86         \ 's':          ':call <SID>NM_search_prompt()<CR>',
  87         \ 'q':          ':call <SID>NM_kill_this_buffer()<CR>',
  88         \ '=':          ':call <SID>NM_folders_refresh_view()<CR>',
  89         \ '<Enter>':    ':call <SID>NM_folders_show_search()<CR>',
  90         \ }
  91
  92 " --- --- bindings for search screen {{{2
  93 let g:notmuch_search_maps = {
  94         \ '<Enter>':    ':call <SID>NM_search_show_thread()<CR>',
  95         \ '<C-]>':      ':call <SID>NM_search_expand(''<cword>'')<CR>',
  96         \ 'a':          ':call <SID>NM_search_archive_thread()<CR>',
  97         \ 'f':          ':call <SID>NM_search_filter()<CR>',
  98         \ 'm':          ':call <SID>NM_new_mail()<CR>',
  99         \ 'o':          ':call <SID>NM_search_toggle_order()<CR>',
 100         \ 'r':          ':call <SID>NM_search_reply_to_thread()<CR>',
 101         \ 's':          ':call <SID>NM_search_prompt()<CR>',
 102         \ ',s':         ':call <SID>NM_search_edit()<CR>',
 103         \ 't':          ':call <SID>NM_search_filter_by_tag()<CR>',
 104         \ 'q':          ':call <SID>NM_kill_this_buffer()<CR>',
 105         \ '+':          ':call <SID>NM_search_add_tags([])<CR>',
 106         \ '-':          ':call <SID>NM_search_remove_tags([])<CR>',
 107         \ '=':          ':call <SID>NM_search_refresh_view()<CR>',
 108         \ '?':          ':echo <SID>NM_search_thread_id()<CR>',
 109         \ }
 110
 111 " --- --- bindings for show screen {{{2
 112 let g:notmuch_show_maps = {
 113         \ '<C-P>':      ':call <SID>NM_show_previous(1, 0)<CR>',
 114         \ '<C-N>':      ':call <SID>NM_show_next(1, 0)<CR>',
 115         \ '<C-]>':      ':call <SID>NM_search_expand(''<cword>'')<CR>',
 116         \ 'q':          ':call <SID>NM_kill_this_buffer()<CR>',
 117         \
 118         \ 'b':          ':call <SID>NM_show_fold_toggle(''b'', ''bdy'', !g:notmuch_show_fold_bodies)<CR>',
 119         \ 'c':          ':call <SID>NM_show_fold_toggle(''c'', ''cit'', !g:notmuch_show_fold_citations)<CR>',
 120         \ 'h':          ':call <SID>NM_show_fold_toggle(''h'', ''hdr'', !g:notmuch_show_fold_headers)<CR>',
 121         \ 's':          ':call <SID>NM_show_fold_toggle(''s'', ''sig'', !g:notmuch_show_fold_signatures)<CR>',
 122         \
 123         \ 'a':          ':call <SID>NM_show_archive_thread()<CR>',
 124         \ 'A':          ':call <SID>NM_show_mark_read_then_archive_thread()<CR>',
 125         \ 'N':          ':call <SID>NM_show_mark_read_then_next_open_message()<CR>',
 126         \ 'v':          ':call <SID>NM_show_view_all_mime_parts()<CR>',
 127         \ '+':          ':call <SID>NM_show_add_tag()<CR>',
 128         \ '-':          ':call <SID>NM_show_remove_tag()<CR>',
 129         \ '<Space>':    ':call <SID>NM_show_advance_marking_read_and_archiving()<CR>',
 130         \ '\|':         ':call <SID>NM_show_pipe_message()<CR>',
 131         \
 132         \ '<S-Tab>':    ':call <SID>NM_show_previous_fold()<CR>',
 133         \ '<Tab>':      ':call <SID>NM_show_next_fold()<CR>',
 134         \ '<Enter>':    ':call <SID>NM_show_toggle_fold()<CR>',
 135         \
 136         \ 'r':          ':call <SID>NM_show_reply()<CR>',
 137         \ 'm':          ':call <SID>NM_new_mail()<CR>',
 138         \ '?':          ':echo <SID>NM_show_message_id() . ''  @ '' . join(<SID>NM_show_search_words())<CR>',
 139         \ }
 140
 141
 142 " --- implement folders screen {{{1
 143
 144 function! s:NM_cmd_folders(words)
 145         if len(a:words)
 146                 echoe 'Not exapecting any arguments for folders command.'
 147         endif
 148         let cmd = ['count']
 149         let disp = []
 150         let searches = []
 151         for entry in g:notmuch_folders
 152                 let [ name, search ] = entry
 153                 let data = s:NM_run(cmd + [search])
 154                 let cnt = matchlist(data, '\(\d\+\)')[1]
 155                 call add(disp, printf('%9d %-20s (%s)', cnt, name, search))
 156                 call add(searches, search)
 157         endfor
 158
 159         call <SID>NM_newBuffer('folders', join(disp, "\n"))
 160         let b:nm_searches = searches
 161         let b:nm_timestamp = reltime()
 162
 163         call <SID>NM_cmd_folders_mksyntax()
 164         call <SID>NM_set_map(g:notmuch_folders_maps)
 165         setlocal cursorline
 166         setlocal nowrap
 167 endfunction
 168
 169 function! s:NM_cmd_folders_mksyntax()
 170 endfunction
 171
 172 " --- --- folders screen action functions {{{2
 173
 174 function! s:NM_folders_refresh_view()
 175         let lno = line('.')
 176         setlocal bufhidden=delete
 177         call s:NM_cmd_folders([])
 178         exec printf('norm %dG', lno)
 179 endfunction
 180
 181 function! s:NM_folders_show_search()
 182         let line = line('.')
 183         let search = b:nm_searches[line-1]
 184
 185         let prev_bufnr = bufnr('%')
 186         setlocal bufhidden=hide
 187         call <SID>NM_cmd_search([search])
 188         setlocal bufhidden=delete
 189         let b:nm_prev_bufnr = prev_bufnr
 190 endfunction
 191
 192
 193 " --- implement search screen {{{1
 194
 195 function! s:NM_cmd_search(words)
 196         let cmd = ['search']
 197         if g:notmuch_search_newest_first
 198                 let cmd = cmd + ['--sort=newest-first']
 199         else
 200                 let cmd = cmd + ['--sort=oldest-first']
 201         endif
 202         let data = s:NM_run(cmd + a:words)
 203         let lines = split(data, "\n")
 204         let disp = copy(lines)
 205         call map(disp, 's:NM_cmd_search_fmtline(v:val)')
 206
 207         call <SID>NM_newBuffer('search', join(disp, "\n"))
 208         let b:nm_raw_lines = lines
 209         let b:nm_search_words = a:words
 210
 211         call <SID>NM_cmd_search_mksyntax()
 212         call <SID>NM_set_map(g:notmuch_search_maps)
 213         setlocal cursorline
 214         setlocal nowrap
 215 endfunction
 216 function! s:NM_cmd_search_fmtline(line)
 217         let m = matchlist(a:line, '^\(thread:\S\+\)\s\([^]]\+\]\) \([^;]\+\); \(.*\) (\([^(]*\))$')
 218         if !len(m)
 219                 return 'ERROR PARSING: ' . a:line
 220         endif
 221         let max = g:notmuch_search_from_column_width
 222         let from = m[3]
 223         if strlen(from) >= max
 224                 let from = substitute(m[3][0:max-4], '[^A-Za-z1-9_]*$', '', '') . '...'
 225         endif
 226         return printf('%-20s %-20s | %s (%s)', m[2], from, m[4], m[5])
 227 endfunction
 228 function! s:NM_cmd_search_mksyntax()
 229         syntax clear nmSearchFrom
 230         exec printf('syntax match nmSearchFrom /\(\] \)\@<=.\{%d\}/ oneline contained', g:notmuch_search_from_column_width)
 231 endfunction
 232
 233 " --- --- search screen action functions {{{2
 234
 235 function! s:NM_search_show_thread()
 236         let id = <SID>NM_search_thread_id()
 237         if id != ''
 238                 let words = [id]
 239                 if exists('b:nm_search_words')
 240                         let words = ['('] + b:nm_search_words + [')', 'and', id]
 241                 endif
 242                 if len(words)
 243                         call <SID>NM_cmd_show(words)
 244                 endif
 245         endif
 246 endfunction
 247
 248 function! s:NM_search_prompt()
 249         " TODO: input() can support completion
 250         let text = input('NotMuch Search: ')
 251         if strlen(text)
 252                 let tags = split(text)
 253         else
 254                 let tags = s:notmuch_initial_search_words_defaults
 255         endif
 256         let prev_bufnr = bufnr('%')
 257         if b:nm_type == 'search'
 258                 " TODO: we intend to replace the current buffer,
 259                 "       ... maybe we could just clear it
 260                 let prev_bufnr = b:nm_prev_bufnr
 261                 setlocal bufhidden=delete
 262         else
 263                 setlocal bufhidden=hide
 264         endif
 265         call <SID>NM_cmd_search(tags)
 266         setlocal bufhidden=delete
 267         let b:nm_prev_bufnr = prev_bufnr
 268 endfunction
 269
 270 function! s:NM_search_edit()
 271         " TODO: input() can support completion
 272         let text = input('NotMuch Search: ', join(b:nm_search_words, ' '))
 273         if strlen(text)
 274                 call <SID>NM_cmd_search(split(text))
 275         endif
 276 endfunction
 277
 278 function! s:NM_search_archive_thread()
 279         call <SID>NM_add_remove_tags_on_screen('', '-', ['inbox'])
 280         call <SID>NM_add_remove_tags([], '-', ['inbox'])
 281         norm j
 282 endfunction
 283
 284 function! s:NM_search_filter()
 285         call <SID>NM_search_filter_helper('Filter: ', '', '')
 286 endfunction
 287
 288 function! s:NM_search_filter_by_tag()
 289         call <SID>NM_search_filter_helper('Filter Tag(s): ', 'tag:', 'and')
 290 endfunction
 291
 292 function! s:NM_search_filter_helper(prompt, prefix, joiner)
 293         " TODO: input() can support completion
 294         let text = input(a:prompt)
 295         if !strlen(text)
 296                 return
 297         endif
 298
 299         let tags = split(text)
 300         if strlen(a:prefix)
 301                 call map(tags, 'a:prefix . v:val')
 302         endif
 303         if strlen(a:joiner)
 304                 let idx = len(tags) - 1
 305                 while idx > 0
 306                         call insert(tags, a:joiner, idx)
 307                         let idx = idx - 1
 308                 endwhile
 309         endif
 310         let tags = b:nm_search_words + ['and', '('] + tags + [')']
 311
 312         let prev_bufnr = bufnr('%')
 313         setlocal bufhidden=hide
 314         call <SID>NM_cmd_search(tags)
 315         setlocal bufhidden=delete
 316         let b:nm_prev_bufnr = prev_bufnr
 317 endfunction
 318
 319 function! s:NM_search_toggle_order()
 320         let g:notmuch_search_newest_first = !g:notmuch_search_newest_first
 321         " FIXME: maybe this would be better done w/o reading re-reading the lines
 322         "         reversing the b:nm_raw_lines and the buffer lines would be better
 323         call <SID>NM_search_refresh_view()
 324 endfunction
 325
 326 function! s:NM_search_reply_to_thread()
 327         echo 'not implemented'
 328 endfunction
 329
 330 function! s:NM_search_add_tags(tags)
 331         call <SID>NM_search_add_remove_tags('Add Tag(s): ', '+', a:tags)
 332 endfunction
 333
 334 function! s:NM_search_remove_tags(tags)
 335         call <SID>NM_search_add_remove_tags('Remove Tag(s): ', '-', a:tags)
 336 endfunction
 337
 338 function! s:NM_search_refresh_view()
 339         let lno = line('.')
 340         let prev_bufnr = b:nm_prev_bufnr
 341         setlocal bufhidden=delete
 342         call <SID>NM_cmd_search(b:nm_search_words)
 343         let b:nm_prev_bufnr = prev_bufnr
 344         " FIXME: should find the line of the thread we were on if possible
 345         exec printf('norm %dG', lno)
 346 endfunction
 347
 348 " --- --- search screen helper functions {{{2
 349
 350 function! s:NM_search_thread_id()
 351         if !exists('b:nm_raw_lines')
 352                 echoe 'no b:nm_raw_lines'
 353                 return ''
 354         else
 355                 let line = line('.')
 356                 let info = b:nm_raw_lines[line-1]
 357                 let what = split(info, '\s\+')[0]
 358                 return what
 359         endif
 360 endfunction
 361
 362 function! s:NM_search_add_remove_tags(prompt, prefix, intags)
 363         if type(a:intags) != type([]) || len(a:intags) == 0
 364                 " TODO: input() can support completion
 365                 let text = input(a:prompt)
 366                 if !strlen(text)
 367                         return
 368                 endif
 369                 let tags = split(text, ' ')
 370         else
 371                 let tags = a:intags
 372         endif
 373         call <SID>NM_add_remove_tags([], a:prefix, tags)
 374         call <SID>NM_add_remove_tags_on_screen('', a:prefix, tags)
 375 endfunction
 376
 377 " --- implement show screen {{{1
 378
 379 function! s:NM_cmd_show(words)
 380         let prev_bufnr = bufnr('%')
 381         let data = s:NM_run(['show'] + a:words)
 382         let lines = split(data, "\n")
 383
 384         let info = s:NM_cmd_show_parse(lines)
 385
 386         setlocal bufhidden=hide
 387         call <SID>NM_newBuffer('show', join(info['disp'], "\n"))
 388         setlocal bufhidden=delete
 389         let b:nm_words = a:words
 390         let b:nm_raw_info = info
 391         let b:nm_prev_bufnr = prev_bufnr
 392
 393         call <SID>NM_cmd_show_mkfolds()
 394         call <SID>NM_cmd_show_mksyntax()
 395         call <SID>NM_set_map(g:notmuch_show_maps)
 396         setlocal foldtext=NM_cmd_show_foldtext()
 397         setlocal fillchars=
 398         setlocal foldcolumn=6
 399
 400 endfunction
 401
 402 function! s:NM_show_previous(can_change_thread, find_matching)
 403         let info = b:nm_raw_info
 404         let lnum = line('.')
 405         for msg in reverse(copy(info['msgs']))
 406                 if a:find_matching && msg['match'] == '0'
 407                         continue
 408                 endif
 409                 if lnum <= msg['start']
 410                         continue
 411                 endif
 412
 413                 exec printf('norm %dGzt', msg['start'])
 414                 " TODO: try to fit the message on screen
 415                 return
 416         endfor
 417         if !a:can_change_thread
 418                 return
 419         endif
 420         call <SID>NM_kill_this_buffer()
 421         if line('.') > 1
 422                 norm k
 423                 call <SID>NM_search_show_thread()
 424                 norm G
 425                 call <SID>NM_show_previous(0, a:find_matching)
 426         else
 427                 echo 'No more messages.'
 428         endif
 429 endfunction
 430
 431 function! s:NM_show_next(can_change_thread, find_matching)
 432         let info = b:nm_raw_info
 433         let lnum = line('.')
 434         for msg in info['msgs']
 435                 if a:find_matching && msg['match'] == '0'
 436                         continue
 437                 endif
 438                 if lnum >= msg['start']
 439                         continue
 440                 endif
 441
 442                 exec printf('norm %dGzt', msg['start'])
 443                 " TODO: try to fit the message on screen
 444                 return
 445         endfor
 446         if a:can_change_thread
 447                 call <SID>NM_show_next_thread()
 448         endif
 449 endfunction
 450
 451 function! s:NM_show_next_thread()
 452         call <SID>NM_kill_this_buffer()
 453         if line('.') != line('$')
 454                 norm j
 455                 call <SID>NM_search_show_thread()
 456         else
 457                 echo 'No more messages.'
 458         endif
 459 endfunction
 460
 461 function! s:NM_show_archive_thread()
 462         echo 'not implemented'
 463 endfunction
 464
 465 function! s:NM_show_mark_read_then_archive_thread()
 466         echo 'not implemented'
 467 endfunction
 468
 469 function! s:NM_show_mark_read_then_next_open_message()
 470         echo 'not implemented'
 471 endfunction
 472
 473 function! s:NM_show_previous_message()
 474         echo 'not implemented'
 475 endfunction
 476
 477 function! s:NM_show_reply()
 478         echo 'not implemented'
 479 endfunction
 480
 481 function! s:NM_show_view_all_mime_parts()
 482         echo 'not implemented'
 483 endfunction
 484
 485 function! s:NM_show_view_raw_message()
 486         echo 'not implemented'
 487 endfunction
 488
 489 function! s:NM_show_add_tag()
 490         echo 'not implemented'
 491 endfunction
 492
 493 function! s:NM_show_remove_tag()
 494         echo 'not implemented'
 495 endfunction
 496
 497 " if entire message is not visible scroll down 1/2 page or less to get to the bottom of message
 498 " otherwise go to next message
 499 " any message that is viewed entirely has inbox and unread tags removed
 500 function! s:NM_show_advance_marking_read_and_archiving()
 501         let advance_tags = ['unread', 'inbox']
 502
 503         let vis_top = line('w0')
 504         let vis_bot = line('w$')
 505
 506         let msg_top = <SID>NM_show_get_message_for_line(vis_top)
 507         if !has_key(msg_top,'id')
 508                 echo "No top visible message."
 509         endif
 510
 511         " if the top message is the last message, just expunge the entire thread and move on
 512         if msg_top['end'] == line('$')
 513                 let ids = []
 514                 for msg in b:nm_raw_info['msgs']
 515                         if has_key(msg,'match') && msg['match'] != '0'
 516                                 if len(ids)
 517                                         call add(ids, 'OR')
 518                                 endif
 519                                 call add(ids, msg['id'])
 520                         endif
 521                 endfor
 522
 523                 let filter = ['('] + advance_tags + [')', 'AND', '('] + ids + [')']
 524                 call <SID>NM_add_remove_tags(filter, '-', advance_tags)
 525                 call <SID>NM_show_next(1, 1)
 526                 return
 527         endif
 528
 529         let msg_bot = <SID>NM_show_get_message_for_line(vis_bot)
 530         if !has_key(msg_bot,'id')
 531                 echo "No bottom visible message."
 532         endif
 533
 534         " if entire message fits on the screen, read/archive it, move to the next one
 535         if msg_top['id'] != msg_bot['id'] || msg_top['end'] <= vis_bot
 536                 call <SID>NM_add_remove_tags_on_screen(msg_top['start'], '-', advance_tags)
 537                 exec printf('norm %dG', vis_top)
 538                 call <SID>NM_show_next(0, 1)
 539                 if has_key(msg_top,'match') && msg_top['match'] != '0'
 540                         redraw
 541                         " do this last to hide the latency
 542                         let filter = ['('] + advance_tags + [')', 'AND', msg_top['id']]
 543                         call <SID>NM_add_remove_tags(filter, '-', advance_tags)
 544                 endif
 545                 return
 546         endif
 547
 548         " entire message does not fit on the screen, scroll down to bottom, max 1/2 screen
 549         let jmp = winheight(winnr()) / 2
 550         let max = msg_bot['end'] - vis_bot
 551         if jmp > max
 552                 let jmp = max
 553         endif
 554         exec printf('norm %dGzt', vis_top + jmp)
 555         return
 556 endfunction
 557
 558 function! s:NM_show_pipe_message()
 559         echo 'not implemented'
 560 endfunction
 561
 562 function! s:NM_show_previous_fold()
 563         echo 'not implemented'
 564 endfunction
 565
 566 function! s:NM_show_next_fold()
 567         echo 'not implemented'
 568 endfunction
 569
 570 function! s:NM_show_toggle_fold()
 571         echo 'not implemented'
 572 endfunction
 573
 574
 575 " --- --- show screen helper functions {{{2
 576
 577 function! s:NM_show_get_message_for_line(line)
 578         for msg in b:nm_raw_info['msgs']
 579                 if a:line > msg['end']
 580                         continue
 581                 endif
 582                 return msg
 583         endfor
 584         return {}
 585 endfunction
 586
 587 function! s:NM_show_message_id()
 588         if !exists('b:nm_raw_info')
 589                 echoe 'no b:nm_raw_info'
 590                 return ''
 591         endif
 592         let msg = <SID>NM_show_get_message_for_line(line('.'))
 593         if has_key(msg,'id')
 594                 return msg['id']
 595         endif
 596         return ''
 597 endfunction
 598
 599 function! s:NM_show_search_words()
 600         if !exists('b:nm_words')
 601                 echoe 'no b:nm_words'
 602                 return []
 603         endif
 604         return b:nm_words
 605 endfunction
 606
 607 function! s:NM_show_fold_toggle(key, type, fold)
 608         let info = b:nm_raw_info
 609         let act = 'open'
 610         if a:fold
 611                 let act = 'close'
 612         endif
 613         for fld in info['folds']
 614                 if fld[0] == a:type
 615                         exec printf('%dfold%s', fld[1], act)
 616                 endif
 617         endfor
 618         exec printf('nnoremap <buffer> %s :call <SID>NM_show_fold_toggle(''%s'', ''%s'', %d)<CR>', a:key, a:key, a:type, !a:fold)
 619 endfunction
 620
 621
 622 " s:NM_cmd_show_parse returns the following dictionary:
 623 "    'disp':     lines to display
 624 "    'msgs':     message info dicts { start, end, id, depth, filename, descr, header }
 625 "    'folds':    fold info arrays [ type, start, end ]
 626 "    'foldtext': fold text indexed by start line
 627 function! s:NM_cmd_show_parse(inlines)
 628         let info = { 'disp': [],
 629                    \ 'msgs': [],
 630                    \ 'folds': [],
 631                    \ 'foldtext': {} }
 632         let msg = {}
 633         let hdr = {}
 634
 635         let in_message = 0
 636         let in_header = 0
 637         let in_body = 0
 638         let in_part = ''
 639
 640         let body_start = -1
 641         let part_start = -1
 642
 643         let mode_type = ''
 644         let mode_start = -1
 645
 646         let inlnum = 0
 647         for line in a:inlines
 648                 let inlnum = inlnum + 1
 649                 let foldinfo = []
 650
 651                 if strlen(in_part)
 652                         let part_end = 0
 653
 654                         if match(line, g:notmuch_show_part_end_regexp) != -1
 655                                 let part_end = len(info['disp'])
 656                         else
 657                                 call add(info['disp'], line)
 658                         endif
 659
 660                         if in_part == 'text/plain'
 661                                 if !part_end && mode_type == ''
 662                                         if match(line, g:notmuch_show_signature_regexp) != -1
 663                                                 let mode_type = 'sig'
 664                                                 let mode_start = len(info['disp'])
 665                                         elseif match(line, g:notmuch_show_citation_regexp) != -1
 666                                                 let mode_type = 'cit'
 667                                                 let mode_start = len(info['disp'])
 668                                         endif
 669                                 elseif mode_type == 'cit'
 670                                         if part_end || match(line, g:notmuch_show_citation_regexp) == -1
 671                                                 let outlnum = len(info['disp'])
 672                                                 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
 673                                                                \ printf('[ %d-line citation.  Press "c" to show. ]', outlnum - mode_start) ]
 674                                                 let mode_type = ''
 675                                         endif
 676                                 elseif mode_type == 'sig'
 677                                         let outlnum = len(info['disp'])
 678                                         if (outlnum - mode_start) > g:notmuch_show_signature_lines_max
 679                                                 let mode_type = ''
 680                                         elseif part_end
 681                                                 let foldinfo = [ mode_type, mode_start, outlnum-1, len(info['msgs']),
 682                                                                \ printf('[ %d-line signature.  Press "s" to show. ]', outlnum - mode_start) ]
 683                                                 let mode_type = ''
 684                                         endif
 685                                 endif
 686                         endif
 687
 688                         if part_end
 689                                 " FIXME: this is a hack for handling two folds being added for one line
 690                                 "         we should handle addinga fold in a function
 691                                 if len(foldinfo) && foldinfo[1] < foldinfo[2]
 692                                         call add(info['folds'], foldinfo[0:3])
 693                                         let info['foldtext'][foldinfo[1]] = foldinfo[4]
 694                                 endif
 695
 696                                 let foldinfo = [ 'text', part_start, part_end, len(info['msgs']),
 697                                                \ printf('[ %d-line %s.  Press "p" to show. ]', part_end - part_start, in_part) ]
 698                                 let in_part = ''
 699                                 call add(info['disp'], '')
 700                         endif
 701
 702                 elseif in_body
 703                         if !has_key(msg,'body_start')
 704                                 let msg['body_start'] = len(info['disp']) + 1
 705                         endif
 706                         if match(line, g:notmuch_show_body_end_regexp) != -1
 707                                 let body_end = len(info['disp'])
 708                                 let foldinfo = [ 'bdy', body_start, body_end, len(info['msgs']),
 709                                                \ printf('[ BODY %d - %d lines ]', len(info['msgs']), body_end - body_start) ]
 710
 711                                 let in_body = 0
 712
 713                         elseif match(line, g:notmuch_show_part_begin_regexp) != -1
 714                                 let m = matchlist(line, 'ID: \(\d\+\), Content-type: \(\S\+\)')
 715                                 let in_part = 'unknown'
 716                                 if len(m)
 717                                         let in_part = m[2]
 718                                 endif
 719                                 call add(info['disp'],
 720                                          \ printf('--- %s ---', in_part))
 721                                 let part_start = len(info['disp']) + 1
 722                         endif
 723
 724                 elseif in_header
 725                         if in_header == 1
 726                                 let msg['descr'] = line
 727                                 call add(info['disp'], line)
 728                                 let in_header = 2
 729                                 let msg['hdr_start'] = len(info['disp']) + 1
 730
 731                         else
 732                                 if match(line, g:notmuch_show_header_end_regexp) != -1
 733                                         let hdr_start = msg['hdr_start']+1
 734                                         let hdr_end = len(info['disp'])
 735                                         let foldinfo = [ 'hdr', hdr_start, hdr_end, len(info['msgs']),
 736                                                \ printf('[ %d-line headers.  Press "h" to show. ]', hdr_end + 1 - hdr_start) ]
 737                                         let msg['header'] = hdr
 738                                         let in_header = 0
 739                                         let hdr = {}
 740                                 else
 741                                         let m = matchlist(line, '^\(\w\+\):\s*\(.*\)$')
 742                                         if len(m)
 743                                                 let hdr[m[1]] = m[2]
 744                                                 if match(g:notmuch_show_headers, m[1]) != -1
 745                                                         call add(info['disp'], line)
 746                                                 endif
 747                                         endif
 748                                 endif
 749                         endif
 750
 751                 elseif in_message
 752                         if match(line, g:notmuch_show_message_end_regexp) != -1
 753                                 let msg['end'] = len(info['disp'])
 754                                 call add(info['disp'], '')
 755
 756                                 let foldinfo = [ 'msg', msg['start'], msg['end'], len(info['msgs']),
 757                                                \ printf('[ MSG %d - %s ]', len(info['msgs']), msg['descr']) ]
 758
 759                                 call add(info['msgs'], msg)
 760                                 let msg = {}
 761                                 let in_message = 0
 762                                 let in_header = 0
 763                                 let in_body = 0
 764                                 let in_part = ''
 765
 766                         elseif match(line, g:notmuch_show_header_begin_regexp) != -1
 767                                 let in_header = 1
 768                                 continue
 769
 770                         elseif match(line, g:notmuch_show_body_begin_regexp) != -1
 771                                 let body_start = len(info['disp']) + 1
 772                                 let in_body = 1
 773                                 continue
 774                         endif
 775
 776                 else
 777                         if match(line, g:notmuch_show_message_begin_regexp) != -1
 778                                 let msg['start'] = len(info['disp']) + 1
 779
 780                                 let m = matchlist(line, g:notmuch_show_message_parse_regexp)
 781                                 if len(m)
 782                                         let msg['id'] = m[1]
 783                                         let msg['depth'] = m[2]
 784                                         let msg['match'] = m[3]
 785                                         let msg['filename'] = m[4]
 786                                 endif
 787
 788                                 let in_message = 1
 789                         endif
 790                 endif
 791
 792                 if len(foldinfo) && foldinfo[1] < foldinfo[2]
 793                         call add(info['folds'], foldinfo[0:3])
 794                         let info['foldtext'][foldinfo[1]] = foldinfo[4]
 795                 endif
 796         endfor
 797         return info
 798 endfunction
 799
 800 function! s:NM_cmd_show_mkfolds()
 801         let info = b:nm_raw_info
 802
 803         for afold in info['folds']
 804                 exec printf('%d,%dfold', afold[1], afold[2])
 805                 let state = 'open'
 806                 if (afold[0] == 'sig' && g:notmuch_show_fold_signatures)
 807                  \ || (afold[0] == 'cit' && g:notmuch_show_fold_citations)
 808                  \ || (afold[0] == 'bdy' && g:notmuch_show_fold_bodies)
 809                  \ || (afold[0] == 'hdr' && g:notmuch_show_fold_headers)
 810                         let state = 'close'
 811                 elseif afold[0] == 'msg'
 812                         let idx = afold[3]
 813                         let msg = info['msgs'][idx]
 814                         if has_key(msg,'match') && msg['match'] == '0'
 815                                 let state = 'close'
 816                         endif
 817                 endif
 818                 exec printf('%dfold%s', afold[1], state)
 819         endfor
 820 endfunction
 821
 822 function! s:NM_cmd_show_mksyntax()
 823         let info = b:nm_raw_info
 824         let cnt = 0
 825         for msg in info['msgs']
 826                 let cnt = cnt + 1
 827                 let start = msg['start']
 828                 let hdr_start = msg['hdr_start']
 829                 let body_start = msg['body_start']
 830                 let end = msg['end']
 831                 exec printf('syntax region nmShowMsg%dDesc start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgDesc', cnt, start, start+1)
 832                 exec printf('syntax region nmShowMsg%dHead start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgHead', cnt, hdr_start, body_start)
 833                 exec printf('syntax region nmShowMsg%dBody start=''\%%%dl'' end=''\%%%dl'' contains=@nmShowMsgBody', cnt, body_start, end)
 834         endfor
 835 endfunction
 836
 837 function! NM_cmd_show_foldtext()
 838         let foldtext = b:nm_raw_info['foldtext']
 839         return foldtext[v:foldstart]
 840 endfunction
 841
 842
 843 " --- notmuch helper functions {{{1
 844
 845 function! s:NM_newBuffer(type, content)
 846         enew
 847         setlocal buftype=nofile readonly modifiable
 848         silent put=a:content
 849         keepjumps 0d
 850         setlocal nomodifiable
 851         set scrolloff=0
 852         set sidescrolloff=0
 853         execute printf('set filetype=notmuch-%s', a:type)
 854         execute printf('set syntax=notmuch-%s', a:type)
 855         let b:nm_type = a:type
 856 endfunction
 857
 858 function! s:NM_shell_escape(word)
 859         let word = substitute(a:word, '''', '\\''', 'g')
 860         return '''' . word . ''''
 861 endfunction
 862
 863 function! s:NM_run(args)
 864         let words = a:args
 865         call map(words, 's:NM_shell_escape(v:val)')
 866         let cmd = g:notmuch_cmd . ' ' . join(words) . '< /dev/null'
 867
 868         let start = reltime()
 869         let out = system(cmd)
 870         let err = v:shell_error
 871         let delta = reltime(start)
 872
 873         if exists('g:notmuch_debug') && g:notmuch_debug
 874                 echo printf('[%s] {%s} %s', reltimestr(delta), string(err), string(cmd))
 875         endif
 876
 877         if err
 878                 echohl Error
 879                 echo substitute(out, '\n*$', '', '')
 880                 echohl None
 881                 return ''
 882         else
 883                 return out
 884         endif
 885 endfunction
 886
 887 " --- external mail handling helpers {{{1
 888
 889 function! s:NM_new_mail()
 890         echo 'not implemented'
 891 endfunction
 892
 893 " --- other helpers {{{1
 894
 895 function! s:NM_kill_this_buffer()
 896         if exists('b:nm_prev_bufnr')
 897                 setlocal bufhidden=delete
 898                 exec printf(":buffer %d", b:nm_prev_bufnr)
 899         else
 900                 echo "This is the last buffer; use :q<CR> to quit."
 901         endif
 902 endfunction
 903
 904 function! s:NM_search_expand(arg)
 905         let word = expand(a:arg)
 906         let prev_bufnr = bufnr('%')
 907         setlocal bufhidden=hide
 908         call <SID>NM_cmd_search([word])
 909         setlocal bufhidden=delete
 910         let b:nm_prev_bufnr = prev_bufnr
 911 endfunction
 912
 913 function! s:NM_add_remove_tags(filter, prefix, tags)
 914         let filter = len(a:filter) ? a:filter : [<SID>NM_search_thread_id()]
 915         if !len(filter)
 916                 echoe 'Eeek! I couldn''t find the thead id!'
 917         endif
 918         call map(a:tags, 'a:prefix . v:val')
 919         let args = ['tag']
 920         call extend(args, a:tags)
 921         call add(args, '--')
 922         call extend(args, filter)
 923         " TODO: handle errors
 924         call <SID>NM_run(args)
 925 endfunction
 926
 927 function! s:NM_add_remove_tags_on_screen(online, prefix, tags)
 928         setlocal modifiable
 929         if a:prefix == '-'
 930                 for tagname in a:tags
 931                         exec printf('silent! %ss/(\([^)]*\)\<%s\>\([^)]*\))$/(\1\2)/', string(a:online), tagname)
 932                 endfor
 933         else
 934                 for tagname in a:tags
 935                         exec printf('silent! %ss/(\([^)]*\)\([^)]*\))$/(\1 %s)/', string(a:online), tagname)
 936                 endfor
 937         endif
 938         setlocal nomodifiable
 939 endfunction
 940
 941 " --- process and set the defaults {{{1
 942
 943 function! NM_set_defaults(force)
 944         for [key, dflt] in items(s:notmuch_defaults)
 945                 let cmd = ''
 946                 if !a:force && exists(key) && type(dflt) == type(eval(key))
 947                         continue
 948                 elseif type(dflt) == type(0)
 949                         let cmd = printf('let %s = %d', key, dflt)
 950                 elseif type(dflt) == type('')
 951                         let cmd = printf('let %s = ''%s''', key, dflt)
 952                 " FIXME: not sure why this didn't work when dflt is an array
 953                 "elseif type(dflt) == type([])
 954                 "        let cmd = printf('let %s = %s', key, string(dflt))
 955                 else
 956                         echoe printf('E: Unknown type in NM_set_defaults(%d) using [%s,%s]',
 957                                                 \ a:force, key, string(dflt))
 958                         continue
 959                 endif
 960                 exec cmd
 961         endfor
 962 endfunction
 963 call NM_set_defaults(0)
 964
 965 " for some reason NM_set_defaults() didn't work for arrays...
 966 if !exists('g:notmuch_show_headers')
 967         let g:notmuch_show_headers = s:notmuch_show_headers_defaults
 968 endif
 969 if !exists('g:notmuch_initial_search_words')
 970         let g:notmuch_initial_search_words = s:notmuch_initial_search_words_defaults
 971 endif
 972 if !exists('g:notmuch_folders')
 973         let g:notmuch_folders = s:notmuch_folders_defaults
 974 endif
 975
 976
 977 " --- assign keymaps {{{1
 978
 979 function! s:NM_set_map(maps)
 980         nmapclear
 981         for [key, code] in items(a:maps)
 982                 exec printf('nnoremap <buffer> %s %s', key, code)
 983         endfor
 984         " --- this is a hack for development :)
 985         nnoremap ,nmr :source ~/.vim/plugin/notmuch.vim<CR>:call NotMuch('')<CR>
 986 endfunction
 987
 988 " --- command handler {{{1
 989
 990 function! NotMuch(args)
 991         let args = a:args
 992         if !strlen(args)
 993                 let args = 'folders'
 994         endif
 995
 996         let words = split(args)
 997         if words[0] == 'folders'
 998                 let words = words[1:]
 999                 call <SID>NM_cmd_folders(words)
1000         elseif words[0] == 'search'
1001                 if len(words) > 1
1002                         let words = words[1:]
1003                 elseif exists('b:nm_search_words')
1004                         let words = b:nm_search_words
1005                 else
1006                         let words = g:notmuch_initial_search_words
1007                 endif
1008                 call <SID>NM_cmd_search(words)
1009
1010         elseif words[0] == 'show'
1011                 echoe 'show is not yet implemented.'
1012         endif
1013 endfunction
1014 function! CompleteNotMuch(arg_lead, cmd_line, cursor_pos)
1015         return []
1016 endfunction
1017
1018
1019 " --- glue {{{1
1020
1021 command! -nargs=* -complete=customlist,CompleteNotMuch NotMuch call NotMuch(<q-args>)
1022 cabbrev  notmuch <c-r>=(getcmdtype()==':' && getcmdpos()==1 ? 'NotMuch' : 'notmuch')<CR>
1023
1024 " vim: set ft=vim ts=8 sw=8 et foldmethod=marker :